fix: error throwing in reply by juanlet · Pull Request #6299 · fastify/fastify

juanlet · 2025-08-24T01:07:10Z

Description

Instantiate FST_ERR_REP_READABLE_STREAM_LOCKED with new in sendWebStream, matching other thrown Fastify errors.

Checklist

run npm run test && npm run benchmark --if-present
tests are included (see test/reply-web-stream-locked.test.js)
documentation N/A
commit follows DCO and code of conduct

Signed-off-by: Juan L. <[email protected]> Signed-off-by: Juan Letamendia <[email protected]>

metcoder95

Tests seems not happy

Eomm

Checking the fastify/error docs, the fix seems legit!

gurgunday

We are currently using a combination of both

Using new is a little faster with fastify-error as it internally checks if 'new' was used:

Node.js v22.18.0
node test.mjs
Running benchmark...
┌─────────┬─────────────────────────────┬──────────────────┬──────────────────┬────────────────────────┬────────────────────────┬─────────┐
│ (index) │ Task name                   │ Latency avg (ns) │ Latency med (ns) │ Throughput avg (ops/s) │ Throughput med (ops/s) │ Samples │
├─────────┼─────────────────────────────┼──────────────────┼──────────────────┼────────────────────────┼────────────────────────┼─────────┤
│ 0       │ 'new FST_ERR_HELLO_WORLD()' │ '3060.9 ± 0.50%' │ '3000.0 ± 41.00' │ '331807 ± 0.06%'       │ '333333 ± 4619'        │ 32671   │
│ 1       │ 'FST_ERR_HELLO_WORLD()'     │ '3352.6 ± 0.41%' │ '3292.0 ± 42.00' │ '302058 ± 0.07%'       │ '303767 ± 3827'        │ 29828   │
└─────────┴─────────────────────────────┴──────────────────┴──────────────────┴────────────────────────┴────────────────────────┴─────────┘
node test.mjs
Running benchmark...
┌─────────┬─────────────────────────────┬──────────────────┬──────────────────┬────────────────────────┬────────────────────────┬─────────┐
│ (index) │ Task name                   │ Latency avg (ns) │ Latency med (ns) │ Throughput avg (ops/s) │ Throughput med (ops/s) │ Samples │
├─────────┼─────────────────────────────┼──────────────────┼──────────────────┼────────────────────────┼────────────────────────┼─────────┤
│ 0       │ 'new FST_ERR_HELLO_WORLD()' │ '3203.0 ± 0.32%' │ '3083.0 ± 42.00' │ '321557 ± 0.02%'       │ '324359 ± 4480'        │ 312208  │
│ 1       │ 'FST_ERR_HELLO_WORLD()'     │ '3349.8 ± 0.84%' │ '3292.0 ± 42.00' │ '302262 ± 0.01%'       │ '303767 ± 3926'        │ 298526  │
└─────────┴─────────────────────────────┴──────────────────┴──────────────────┴────────────────────────┴────────────────────────┴─────────┘
node test.mjs
Running benchmark...
┌─────────┬─────────────────────────────┬──────────────────┬──────────────────┬────────────────────────┬────────────────────────┬─────────┐
│ (index) │ Task name                   │ Latency avg (ns) │ Latency med (ns) │ Throughput avg (ops/s) │ Throughput med (ops/s) │ Samples │
├─────────┼─────────────────────────────┼──────────────────┼──────────────────┼────────────────────────┼────────────────────────┼─────────┤
│ 0       │ 'new FST_ERR_HELLO_WORLD()' │ '3051.4 ± 0.12%' │ '3041.0 ± 42.00' │ '329605 ± 0.01%'       │ '328839 ± 4494'        │ 327722  │
│ 1       │ 'FST_ERR_HELLO_WORLD()'     │ '3329.1 ± 0.13%' │ '3292.0 ± 42.00' │ '302065 ± 0.01%'       │ '303767 ± 3926'        │ 300383  │
└─────────┴─────────────────────────────┴──────────────────┴──────────────────┴────────────────────────┴────────────────────────┴─────────┘
node test.mjs
Running benchmark...
┌─────────┬─────────────────────────────┬──────────────────┬──────────────────┬────────────────────────┬────────────────────────┬─────────┐
│ (index) │ Task name                   │ Latency avg (ns) │ Latency med (ns) │ Throughput avg (ops/s) │ Throughput med (ops/s) │ Samples │
├─────────┼─────────────────────────────┼──────────────────┼──────────────────┼────────────────────────┼────────────────────────┼─────────┤
│ 0       │ 'new FST_ERR_HELLO_WORLD()' │ '3106.9 ± 0.19%' │ '3041.0 ± 41.00' │ '327357 ± 0.02%'       │ '328839 ± 4494'        │ 321861  │
│ 1       │ 'FST_ERR_HELLO_WORLD()'     │ '3350.2 ± 0.19%' │ '3291.0 ± 41.00' │ '302658 ± 0.02%'       │ '303859 ± 3833'        │ 298491  │
└─────────┴─────────────────────────────┴──────────────────┴──────────────────┴────────────────────────┴────────────────────────┴─────────┘
node test.mjs
Running benchmark...
┌─────────┬─────────────────────────────┬──────────────────┬──────────────────┬────────────────────────┬────────────────────────┬─────────┐
│ (index) │ Task name                   │ Latency avg (ns) │ Latency med (ns) │ Throughput avg (ops/s) │ Throughput med (ops/s) │ Samples │
├─────────┼─────────────────────────────┼──────────────────┼──────────────────┼────────────────────────┼────────────────────────┼─────────┤
│ 0       │ 'FST_ERR_HELLO_WORLD()'     │ '3359.3 ± 0.15%' │ '3292.0 ± 42.00' │ '301922 ± 0.02%'       │ '303767 ± 3926'        │ 297679  │
│ 1       │ 'new FST_ERR_HELLO_WORLD()' │ '3104.5 ± 0.64%' │ '3041.0 ± 41.00' │ '327729 ± 0.02%'       │ '328839 ± 4494'        │ 322115  │
└─────────┴─────────────────────────────┴──────────────────┴──────────────────┴────────────────────────┴────────────────────────┴─────────┘
node test.mjs
Running benchmark...
┌─────────┬─────────────────────────────┬──────────────────┬──────────────────┬────────────────────────┬────────────────────────┬─────────┐
│ (index) │ Task name                   │ Latency avg (ns) │ Latency med (ns) │ Throughput avg (ops/s) │ Throughput med (ops/s) │ Samples │
├─────────┼─────────────────────────────┼──────────────────┼──────────────────┼────────────────────────┼────────────────────────┼─────────┤
│ 0       │ 'new FST_ERR_HELLO_WORLD()' │ '3062.3 ± 0.14%' │ '3000.0 ± 42.00' │ '329698 ± 0.01%'       │ '333333 ± 4733'        │ 326554  │
│ 1       │ 'FST_ERR_HELLO_WORLD()'     │ '3325.5 ± 0.15%' │ '3292.0 ± 42.00' │ '302632 ± 0.01%'       │ '303767 ± 3926'        │ 300705  │
└─────────┴─────────────────────────────┴──────────────────┴──────────────────┴────────────────────────┴────────────────────────┴─────────┘

Benchmark

import { Bench } from 'tinybench';
import createError from '@fastify/error';

// --- Setup ---
// First, we create a custom error constructor using the factory.
// This is typically done once when your application starts.
const FST_ERR_HELLO_WORLD = createError(
  'FST_ERR_HELLO_WORLD',
  'Hello, %s!',
  500
);

const bench = new Bench({ time: 1000 });
let err = null;

// --- Benchmarking Scenarios ---

bench
  // Scenario 1: Using 'new' with the created error constructor.
  .add('new FST_ERR_HELLO_WORLD()', () => {
    err = new FST_ERR_HELLO_WORLD('world');
  })

  // Scenario 2: Calling the constructor directly as a function.
  .add('FST_ERR_HELLO_WORLD()', () => {
    err = FST_ERR_HELLO_WORLD('world');
  })

async function runBenchmark() {
  console.log('Running benchmark...');
  await bench.run();

  console.table(bench.table());
}

runBenchmark();

Please fix the test to use node:test

gurgunday · 2025-08-25T11:38:29Z

I think we don't need the test here

… error-parameter for setErrorHandler and errorHandler to unknown, but configurable via generic TError (fastify#6308) * types: loosen setErrorHandler and errorHandler types * set TError to unknown add generic to errorHandler * fix * remove obsolte type tst * add unit test, fix potential issue --------- Co-authored-by: Jean <[email protected]> build(deps-dev): remove @fastify/pre-commit (fastify#6319) `@fastify/pre-commit` isn't configured or used in this repo as there is no `pre-commit` object in package.json. It won't run regardless as scripts are disabled. Signed-off-by: Frazer Smith <[email protected]> Co-authored-by: Aras Abbasi <[email protected]> ci: improve citgm workflows (fastify#6334) * ci: improve citgm workflows * fix remark docs: explain stream error handling (fastify#5746) * docs: explain stream error handling * Update docs/Reference/Server.md Co-authored-by: Matteo Collina <[email protected]> Signed-off-by: James Sumners <[email protected]> * Apply suggestions from code review Co-authored-by: Frazer Smith <[email protected]> Signed-off-by: Denys Otrishko <[email protected]> * docs: explain stream error handling * fix test --------- Signed-off-by: James Sumners <[email protected]> Signed-off-by: Denys Otrishko <[email protected]> Signed-off-by: Aras Abbasi <[email protected]> Co-authored-by: James Sumners <[email protected]> Co-authored-by: Matteo Collina <[email protected]> Co-authored-by: Frazer Smith <[email protected]> Co-authored-by: Aras Abbasi <[email protected]> fix: error throwing in reply (fastify#6299) * fix: instantiate readable stream error * Create reply-web-stream-locked.test.js Signed-off-by: Juan L. <[email protected]> Signed-off-by: Juan Letamendia <[email protected]> * fix test --------- Signed-off-by: Juan L. <[email protected]> Signed-off-by: Juan Letamendia <[email protected]> Co-authored-by: Aras Abbasi <[email protected]> docs: create 2 frst chapters of the tutorial docs: nit docs: create a fastify server docs: create basic routes docs: improve chapter 4 refactor: improve readability and quote examples docs: decoration chapter public part docs: decoration chapter public part fix: typo fix: typo fix: markdown lint docs: document internals docs: validatio nand serialization docs: move section mapping reminder with routes declarations docs: add hooks chapter docs: remove internals involved sections docs: add error handling chapter fix: copilot suggestions

github-actions · 2026-03-21T00:41:21Z

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

juanlet added 2 commits August 23, 2025 21:29

fix: instantiate readable stream error

f24d5f8

Create reply-web-stream-locked.test.js

aa10cf5

Signed-off-by: Juan L. <[email protected]> Signed-off-by: Juan Letamendia <[email protected]>

metcoder95 reviewed Aug 24, 2025

View reviewed changes

Eomm reviewed Aug 24, 2025

View reviewed changes

Comment thread test/reply-web-stream-locked.test.js Outdated

Eomm added the bugfix Issue or PR that should land as semver patch label Aug 24, 2025

Eomm changed the title ~~Bugfix/fix error throwing in reply~~ fix: error throwing in reply Aug 24, 2025

jsumners reviewed Aug 25, 2025

View reviewed changes

Comment thread lib/reply.js

gurgunday requested changes Aug 25, 2025

View reviewed changes

Uzlopak added 3 commits September 26, 2025 00:33

fix test

6c565ef

Merge branch 'main' into bugfix/fix-error-throwing-in-reply.js

c2b9a60

Merge branch 'main' into bugfix/fix-error-throwing-in-reply.js

c31b454

Uzlopak requested a review from gurgunday September 25, 2025 22:34

gurgunday approved these changes Sep 26, 2025

View reviewed changes

Uzlopak merged commit 329e40f into fastify:main Sep 26, 2025
30 checks passed

github-actions Bot locked as resolved and limited conversation to collaborators Mar 21, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix: error throwing in reply#6299

fix: error throwing in reply#6299
Uzlopak merged 5 commits into
fastify:mainfrom
juanlet:bugfix/fix-error-throwing-in-reply.js

juanlet commented Aug 24, 2025 •

edited

Loading

Uh oh!

metcoder95 left a comment

Uh oh!

Eomm left a comment

Uh oh!

Uh oh!

Uh oh!

gurgunday left a comment

Uh oh!

gurgunday commented Aug 25, 2025

Uh oh!

Uh oh!

github-actions Bot commented Mar 21, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Uh oh!

Uh oh!

Conversation

juanlet commented Aug 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Uh oh!

metcoder95 left a comment

Choose a reason for hiding this comment

Uh oh!

Eomm left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

gurgunday left a comment

Choose a reason for hiding this comment

Uh oh!

gurgunday commented Aug 25, 2025

Uh oh!

Uh oh!

github-actions Bot commented Mar 21, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

juanlet commented Aug 24, 2025 •

edited

Loading