fix: throwing "FST_ERR_DUPLICATED_ROUTE" error instead of raw error by Rantoledo · Pull Request #5621 · fastify/fastify

Rantoledo · 2024-08-07T10:39:58Z

Came across this small bug during unit tests in my project.

I have a unit test that catches various errors that lean on Fastify error codes, and I had a case where I expected to get the FST_ERR_DUPLICATED_ROUTE instance, but got raw Error instance:

const fastify = require('fastify')({
    logger: true
})

fastify.get('/:param2', (request, reply) => {
    reply.type('application/json').code(200)
    return { hello: 'example' }
})

fastify.head('/:param1',  (request, reply) => {
    reply.type('application/json').code(200)
    return { hello: 'other' }
})

fastify.addHook('onReady', async function hook () {
    console.log(fastify.printRoutes())
})

fastify.listen().then(console.log)

In this case, we expect to get FST_ERR_DUPLICATED_ROUTE error, because we're adding HEAD method of the same route after Fastify added it (after adding the GET method on the same route).

instead, we're getting the Error instance:

Error: Method 'HEAD' already declared for route '/:' with constraints '{}'
    at Router._on (/Users/toledor/playground/head-issue/node_modules/find-my-way/index.js:287:13)
    at Router.on (/Users/toledor/playground/head-issue/node_modules/find-my-way/index.js:139:10)
    at Object.addNewRoute (/Users/toledor/playground/head-issue/node_modules/fastify/lib/route.js:365:16)
    at Object.route (/Users/toledor/playground/head-issue/node_modules/fastify/lib/route.js:265:19)
    at Object.prepareRoute (/Users/toledor/playground/head-issue/node_modules/fastify/lib/route.js:167:18)
    at Object._head [as head] (/Users/toledor/playground/head-issue/node_modules/fastify/fastify.js:265:34)
    at Object.<anonymous> (/Users/toledor/playground/head-issue/index.js:62:9)
    at Module._compile (node:internal/modules/cjs/loader:1504:14)
    at Module._extensions..js (node:internal/modules/cjs/loader:1588:10)
    at Module.load (node:internal/modules/cjs/loader:1282:32)

This happens because find-my-way throws the error message: "Method '${opts.method}' already declared for route '<pattern>'", and it's been compared to "Method '${opts.method}' already declared for route '${opts.url}'", in our case opts.url = /:param1, but the pattern equals to :/.

Solution:
Unfortunately, fastify does not possess the pattern, so IMO the best way is to drop the opts.url.

After changes we do get the right error:

FastifyError [Error]: Method 'HEAD' already declared for route '/:param1'
    at Object.addNewRoute (/Users/toledor/playground/head-issue/node_modules/fastify/lib/route.js:378:19)
    at Object.route (/Users/toledor/playground/head-issue/node_modules/fastify/lib/route.js:265:19)
    at Object.prepareRoute (/Users/toledor/playground/head-issue/node_modules/fastify/lib/route.js:167:18)
    at Object._head [as head] (/Users/toledor/playground/head-issue/node_modules/fastify/fastify.js:265:34)
    at Object.<anonymous> (/Users/toledor/playground/head-issue/index.js:62:9)
    at Module._compile (node:internal/modules/cjs/loader:1504:14)
    at Module._extensions..js (node:internal/modules/cjs/loader:1588:10)
    at Module.load (node:internal/modules/cjs/loader:1282:32)
    at Module._load (node:internal/modules/cjs/loader:1098:12)
    at TracingChannel.traceSync (node:diagnostics_channel:315:14) {
  code: 'FST_ERR_DUPLICATED_ROUTE',
  statusCode: 500
}

Eomm

Would you mind to add a test?

Rantoledo · 2024-08-07T12:55:25Z

Would you mind to add a test?

I would love to.
But I didn't find any relevant test among the available tests, so I thought it was unnecessary.
What test should I add? can you describe it in general?

jsumners · 2024-08-07T13:20:06Z

You should add a test that fails without this change.

Eomm · 2024-08-07T13:21:30Z

What test should I add? can you describe it in general?

The example in the PR's description can be converted to a test and that would be good to go!

Rantoledo · 2024-08-07T13:31:46Z

What test should I add? can you describe it in general?

The example in the PR's description can be converted to a test and that would be good to go!

Working on that...

Rantoledo · 2024-08-07T14:14:12Z

Added 1 test and modified another that is relevant (kinda).

climba03003

You should update your fork main branch and rebase on top of it.
Your current version is way to far from the current main, we can hardly merge it.

Rantoledo · 2024-08-07T17:21:34Z

You should update your fork main branch and rebase on top of it. Your current version is way to far from the current main, we can hardly merge it.

can you please give me a general idea of how I should do that?
I already did git pull on the main branch, and made sure it's up to date.
then, checked out to my branch, made the changes, pushed to my branch, and opened a pull request.

rebased with updated main

…github.com/Rantoledo/fastify into fix-throwing-error-due-to-duplicated-route

Rantoledo · 2024-08-07T18:23:44Z

You should update your fork main branch and rebase on top of it. Your current version is way to far from the current main, we can hardly merge it.

I managed to pull it off, finally.
Sorry for the mess.
Let me know if there's anything else needed.

lib/route.js

climba03003

LGTM.
I think it is better for find-my-way to provides .code inside the error which can be easier to inspect and check.

test/throw.test.js

test/route.8.test.js

climba03003

SLGTM.

Rantoledo · 2024-08-08T10:09:46Z

Done changing test according to @climba03003.

Eomm

Good job!

…5621) (cherry picked from commit 309d9da)

Rantoledo · 2024-08-08T17:11:30Z

Good job!

thanks!

… of raw error (#5624) * fix: throwing "FST_ERR_DUPLICATED_ROUTE" error instead of raw error (#5621) (cherry picked from commit 309d9da) * trigger test Signed-off-by: Manuel Spigolon <behemoth89@gmail.com> --------- Signed-off-by: Manuel Spigolon <behemoth89@gmail.com> Co-authored-by: Ran Toledo <toledoran@gmail.com> Co-authored-by: Manuel Spigolon <behemoth89@gmail.com>

github-actions · 2025-08-09T00:32:35Z

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.

removed opts.url from comparison string to error message

86d8153

Eomm reviewed Aug 7, 2024

View reviewed changes

Eomm added bugfix Issue or PR that should land as semver patch backport 4.x Issue or pr that should be backported to Fastify v4 labels Aug 7, 2024

Added relevant tests

52dc237

climba03003 requested changes Aug 7, 2024

View reviewed changes

Ran Toledo added 4 commits August 7, 2024 20:43

removed opts.url from comparison string to error message

28486e7

Added relevant tests

996fc95

rebased with updated main

applied eslint on route 8 file

0f4dde7

Merge branch 'fix-throwing-error-due-to-duplicated-route' of https://…

2b6c555

…github.com/Rantoledo/fastify into fix-throwing-error-due-to-duplicated-route

Rantoledo requested review from Eomm and climba03003 August 7, 2024 18:23

jsumners reviewed Aug 7, 2024

View reviewed changes

lib/route.js Show resolved Hide resolved

climba03003 approved these changes Aug 8, 2024

View reviewed changes

climba03003 reviewed Aug 8, 2024

View reviewed changes

test/throw.test.js Outdated Show resolved Hide resolved

test/route.8.test.js Outdated Show resolved Hide resolved

changed tests to compare fastify error codes

ba892f0

climba03003 approved these changes Aug 8, 2024

View reviewed changes

jsumners approved these changes Aug 8, 2024

View reviewed changes

Eomm approved these changes Aug 8, 2024

View reviewed changes

Eomm merged commit 309d9da into fastify:main Aug 8, 2024

github-actions bot pushed a commit that referenced this pull request Aug 8, 2024

fix: throwing "FST_ERR_DUPLICATED_ROUTE" error instead of raw error (#…

6c2cdf7

…5621) (cherry picked from commit 309d9da)

github-actions bot mentioned this pull request Aug 8, 2024

[Backport 4.x] fix: throwing "FST_ERR_DUPLICATED_ROUTE" error instead of raw error #5624

Merged

lholmquist mentioned this pull request Oct 31, 2024

[Snyk] Upgrade fastify from 4.21.0 to 5.0.0 nodeshift/faas-js-runtime#370

Closed

github-actions bot locked as resolved and limited conversation to collaborators Aug 9, 2025

Uh oh!

Conversation

Rantoledo commented Aug 7, 2024

Uh oh!

Eomm left a comment

Choose a reason for hiding this comment

Uh oh!

Rantoledo commented Aug 7, 2024

Uh oh!

jsumners commented Aug 7, 2024

Uh oh!

Eomm commented Aug 7, 2024

Uh oh!

Rantoledo commented Aug 7, 2024

Uh oh!

Rantoledo commented Aug 7, 2024

Uh oh!

climba03003 left a comment

Choose a reason for hiding this comment

Uh oh!

Rantoledo commented Aug 7, 2024

Uh oh!

Rantoledo commented Aug 7, 2024

Uh oh!

Uh oh!

climba03003 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

climba03003 left a comment

Choose a reason for hiding this comment

Uh oh!

Rantoledo commented Aug 8, 2024

Uh oh!

Eomm left a comment

Choose a reason for hiding this comment

Uh oh!

Rantoledo commented Aug 8, 2024

Uh oh!

github-actions bot commented Aug 9, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants