fix(printRoutes): ensure commonPrefix: false returns uncompressed flat routes #6275

riyap03 · 2025-08-01T18:14:31Z

Thank you for reviewing my pull request! ✨

This PR fixes the unintuitive behavior of fastify.printRoutes({ commonPrefix: false }), which was expected to print routes without any prefix grouping — but still compressed longer prefixes. That was confusing for users (like me 😅).

So I’ve added a custom printRoutes logic that ensures this flag works as expected — showing all routes in a flat structure with no compression when commonPrefix: false.

🛠️ Fixes: Issue #6009

This is my third PR to Fastify 💙 and part of my journey toward GSoC 2026. I'm learning deeply and I'm grateful for the opportunity to grow and contribute to such a wonderful project 🌱.

Checklist

I ran npm run test and all tests pass
No benchmark changes needed
No documentation updates needed
Commit message and code follow Fastify guidelines

Let me know if anything needs to be changed or improved! 💫

jean-michelet

I think the linked issue should be transferred to the find-my-way package, if relevant.

jean-michelet · 2025-08-02T06:48:58Z

eslint.config.js

@@ -13,7 +13,8 @@ module.exports = [
  }),
  {
    rules: {
-      'comma-dangle': ['error', 'never']
+      'comma-dangle': ['error', 'never'],
+      'max-len': ['error', { code: 100 }]


Why do you add this here?

Why do you add this here?
Thanks for the question! I had originally added this change in a separate PR to address issue #6029 — but it accidentally got included here while rebasing 😅

I’ve removed it from this PR now so the scope stays focused on printRoutes. Thanks for catching it! 🙏

jean-michelet · 2025-08-02T06:49:15Z

lib/customPrintRoutes.js

+    return router.prettyPrint(opts)
+  }
+
+  // ✅ fallback to raw list of routes


Avoid emojis plz, this comment is unnecessary.

Avoid emojis plz, this comment is unnecessary.

Thanks for the review!
I just wanted to clarify that the emoji in the code comment wasn’t added by me — perhaps it was already present or added by mistake during a merge.

Still, I’ll go ahead and clean it up along with the other suggestions you gave. Appreciate the feedback! 💙

This is a file you added.

This is a file you added.

You’re absolutely right — I added the file and must’ve overlooked the comment. Sorry for the confusion. I’ve now removed the emoji and cleaned it up. Thanks again for your feedback!

jean-michelet · 2025-08-02T06:49:48Z

lib/route.js

+
+
+
+
+


Suggested change

jean-michelet · 2025-08-02T06:50:27Z

lib/route.js

+
+
+


Suggested change

…t routes

riyap03 · 2025-08-02T11:10:31Z

I think the linked issue should be transferred to the find-my-way package, if relevant.

Thank you for pointing that out! 🙌
You're right — since the route printing logic comes from find-my-way, transferring the issue there sounds reasonable.
Should I go ahead and open a corresponding issue in the find-my-way repo and link it here? Let me know what you'd prefer. 🌱

metcoder95 · 2025-08-03T08:47:09Z

Can you solve the conflicts you have?

riyap03 · 2025-08-03T09:03:22Z

Can you solve the conflicts you have?

Sure, I’ll get on it and resolve the conflicts soon. Thanks for the nudge!

riyap03 · 2025-08-03T09:13:47Z

Conflicts have been resolved and the branch is now up to date with main! Let me know if there’s anything else needed 💫

metcoder95 · 2025-08-06T06:46:06Z

test/printRoutes.test.js

@@ -0,0 +1,15 @@
+const Fastify = require('fastify')
+const t = require('tap')


Please use node:test

Thanks for the catch! I’ve updated the test to use node:test instead of tap.

metcoder95 · 2025-08-06T06:46:53Z

app.js

What is this file for?

That was just for local testing. I’ve removed it now — thanks for pointing it out!

metcoder95 · 2025-08-06T06:48:22Z

test/routes-test.js

This doesn't seem to test something in particular, maybe let's focus only on test/pretty-print.test.js

You're right — I’ve deleted this file and moved relevant tests into pretty-print.test.js.

metcoder95 · 2025-08-06T06:48:33Z

test/printRoutes.test.js

Let's maybe add it to https://github.com/fastify/fastify/blob/main/test/pretty-print.test.js

Done! I’ve moved all the tests into pretty-print.test.js and deleted this file.

metcoder95 · 2025-08-06T06:48:41Z

package.json

@@ -210,6 +210,7 @@
    "abstract-logging": "^2.0.1",
    "avvio": "^9.0.0",
    "fast-json-stringify": "^6.0.0",
+    "fastify": "^5.4.0",


That addition was accidental during local testing. I’ve reverted the package.json changes now.

…t routes

riyap03 · 2025-08-06T14:13:29Z

Hey! I’ve made all the changes:

switched to node:test

removed app.js and routes-test.js

moved everything into pretty-print.test.js

cleaned up the package.json (thanks for catching that!)

Please let me know if I missed anything. I’m still learning and happy to improve this further 💫
Really grateful for your review and guidance 💙

metcoder95 · 2025-08-07T06:57:20Z

lib/route.js

 function noop () { }
+module.exports = { buildRouting, validateBodyLimitOption }


This seems duplicated

You're right — thanks for catching that! I've removed the duplicated code from lib/route.js in the latest commit. Let me know if there's anything else I should adjust.

metcoder95

Sorry for the ping and pong, just notice to smaller things to be fixed, after that it should be good to go

metcoder95 · 2025-08-10T09:19:40Z

test/pretty-print.test.js

@@ -364,3 +364,31 @@ test('pretty print - includeMeta, includeHooks', (t, done) => {
    done()
  })
 })
+// test/printRoutes-commonPrefix.test.js
+
+const assert = require('node:assert')


Let's use the assert that comes with the TestContext (the variable passed to the test callback.

metcoder95 · 2025-08-10T09:19:47Z

test/pretty-print.test.js

@@ -364,3 +364,31 @@ test('pretty print - includeMeta, includeHooks', (t, done) => {
    done()
  })
 })
+// test/printRoutes-commonPrefix.test.js


Feel free to remove it

Hi @metcoder95 ,

Thank you so much for your kindness and patience with my PRs. This is only my second PR ever, and I feel really lucky to have a mentor like you guiding me through every step.

You’re not just helping me fix code — you’re helping me grow, learn, and believe in myself a little more each day. That means more than words can say.

I’m grateful for your time, your thoughtful reviews, and your kindness. I hope to keep learning and making you proud.

With lots of respect and gratitude,
Riya 💙

jean-michelet reviewed Aug 2, 2025

View reviewed changes

riyap03 added 2 commits August 2, 2025 16:18

fix(printRoutes): ensure commonPrefix: false returns uncompressed fla…

fe3e5bc

…t routes

chore: remove unnecessary comment

cde73fe

riyap03 force-pushed the fix-printRoutes-behavior branch from ccbb2ee to cde73fe Compare August 2, 2025 10:49

riyap03 added 2 commits August 3, 2025 14:39

wip: prepare for merge with upstream/main

2a9d69d

fix: resolved merge conflict in lib/route.js

9773fdf

riyap03 and others added 2 commits August 3, 2025 14:56

chore: fix lint errors

d9f590d

Merge branch 'main' into fix-printRoutes-behavior

0526c8e

metcoder95 reviewed Aug 6, 2025

View reviewed changes

riyap03 added 5 commits August 6, 2025 19:31

chore: remove local debug file

219b33a

chore: remove redundant manual test for printRoutes

fd89f57

test: remove printRoutes.test.js after merging into pretty-print.test.js

798bcdf

chore: remove unnecessary fastify dependency

9e2c9a5

fix(printRoutes): ensure commonPrefix: false returns uncompressed fla…

ae95354

…t routes

metcoder95 reviewed Aug 7, 2025

View reviewed changes

riyap03 added 2 commits August 7, 2025 12:47

removed duplicated code

0a23b9a

Merge branch 'main' into fix-printRoutes-behavior

0d5bb0e

metcoder95 reviewed Aug 10, 2025

View reviewed changes

fix(test): use t.assert.match for regex in printRoutes test

6d310e0

		@@ -0,0 +1,15 @@
		const Fastify = require('fastify')
		const t = require('tap')

		function noop () { }
		module.exports = { buildRouting, validateBodyLimitOption }

Uh oh!

fix(printRoutes): ensure commonPrefix: false returns uncompressed flat routes #6275

Are you sure you want to change the base?

fix(printRoutes): ensure commonPrefix: false returns uncompressed flat routes #6275

Conversation

riyap03 commented Aug 1, 2025

Checklist

Uh oh!

jean-michelet left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

riyap03 commented Aug 2, 2025

Uh oh!

metcoder95 commented Aug 3, 2025

Uh oh!

riyap03 commented Aug 3, 2025

Uh oh!

riyap03 commented Aug 3, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

riyap03 commented Aug 6, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

metcoder95 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jean-michelet left a comment •

edited

Loading