print-routes options and print-plugins #637

bcomnes · 2023-06-21T18:49:26Z

This adds a method, common-prefix and include-hooks flags to the print-routes command, and also implements a print-plugins flag, with no flags.

Feedback wanted!

Checklist

run npm run test and npm run benchmark
tests and/or benchmarks are included
documentation is changed or added
commit message and code follows the Developer's Certification of Origin
and the Code of conduct

mcollina

lgtm

bcomnes · 2023-06-21T20:20:11Z

test/print-routes.test.js

@@ -19,20 +20,16 @@ test('should print routes', async t => {

  await fastify.close()
  t.ok(spy.called)
-  t.same(spy.args, [['debug', '└── / (GET)\n    / (HEAD)\n    / (POST)\n']])
+  t.same(spy.args, [['debug', '└── / (GET, HEAD, POST)\n']])
 })

 test('should print routes via cli', async t => {


This test seemed to do the exact same thing as the prior test, so I re-wrote it to actually run through the CLI. Hope this is right.

bcomnes · 2023-06-21T22:25:09Z

@mcollina Looks like tests aren't passing on windows because of the inline ENV var setting on the typescript esm unit test:

fastify-cli/package.json

Line 12 in f111b25

    
           "unit:template-ts-esm": "TS_NODE_PROJECT=./templates/app-ts-esm/tsconfig.json tap templates/app-ts-esm/test/**/*.test.ts --no-coverage --node-arg=--loader=ts-node/esm --timeout 100",

Want me to add cross-env to devDeps and make that work in the windows CI as well?

EDIT: I wen't ahead and added it.

bcomnes · 2023-06-21T22:39:42Z

test/generate-esm.test.js

@@ -33,7 +33,7 @@ javascriptTemplate.type = 'module'
 javascriptTemplate.tap = {
  coverage: false
 }
-javascriptTemplate.devDependencies['c8'] = cliPkg.devDependencies['c8']


Lint:fix did this

bcomnes · 2023-06-22T00:08:19Z

There seems to be some kind of spurious timeout in some of these tests.

mcollina · 2023-06-29T10:02:25Z

It seems the failures are relevant:

test/generate.test.js 1> run 'npm test' to execute the unit tests
 FAIL  test/print-plugins.test.js
 ✖ timeout!

  test: test/print-plugins.test.js should plugins routes via cli
  expired: test/print-plugins.test.js

 FAIL  test/print-plugins.test.js
 ✖ timeout!

bcomnes · 2023-06-29T14:43:01Z

Oh shoot I missed those. Looking: #639

This adds flags for method, commonPrefix and includeHooks options in the printRoutes method. Closes fastify#635

It runs the printPlugins method and prints the results. No arguments. Closes fastify#636

Better flakey CI skip test logic Add timeout Try awaiting in the same async function? Skip in CI Re-enable in darwin Return close promise Fix tests

bcomnes · 2023-07-20T23:39:39Z

Ok @mcollina got this green. A couple of those tests are still flakey. I tried to re-order some event ordering tests but it still doesn't seem to fix it.

Also once this lands with those test fixes, maybe rebase one of the dependabot PRs to re-activate it.

big-kahuna-burger · 2023-11-27T06:01:36Z

@bcomnes
Check #681

bcomnes · 2023-11-27T14:38:00Z

@bcomnes

Check #681

Great! Thank you

bcomnes changed the title ~~Route options and plugin print~~ print-route options and plugin print Jun 21, 2023

bcomnes changed the title ~~print-route options and plugin print~~ print-routes options and print-plugins Jun 21, 2023

mcollina approved these changes Jun 21, 2023

View reviewed changes

bcomnes commented Jun 21, 2023

View reviewed changes

bcomnes force-pushed the route-options-and-plugin-print branch from e6b53d7 to b69cca6 Compare June 21, 2023 22:36

bcomnes commented Jun 21, 2023

View reviewed changes

bcomnes force-pushed the route-options-and-plugin-print branch 2 times, most recently from 7aaa697 to 3c5411e Compare June 21, 2023 23:45

Add printRoutes flags

cd34f63

This adds flags for method, commonPrefix and includeHooks options in the printRoutes method. Closes fastify#635

bcomnes force-pushed the route-options-and-plugin-print branch from 3c5411e to 6dc6dd5 Compare July 20, 2023 16:49

Add print-plugins command

6832715

It runs the printPlugins method and prints the results. No arguments. Closes fastify#636

bcomnes force-pushed the route-options-and-plugin-print branch 10 times, most recently from 5507b7e to 38d8ca3 Compare July 20, 2023 23:17

Fix flakey tests

9345205

Better flakey CI skip test logic Add timeout Try awaiting in the same async function? Skip in CI Re-enable in darwin Return close promise Fix tests

bcomnes force-pushed the route-options-and-plugin-print branch from 38d8ca3 to 9345205 Compare July 20, 2023 23:32

mcollina merged commit af2e457 into fastify:master Jul 21, 2023

Summonshr mentioned this pull request Jun 29, 2024

[Snyk] Upgrade fastify-cli from 5.7.1 to 5.9.0 Summonshr/fastify-test#3

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

print-routes options and print-plugins #637

print-routes options and print-plugins #637

bcomnes commented Jun 21, 2023

mcollina left a comment

bcomnes Jun 21, 2023

bcomnes commented Jun 21, 2023 •

edited

Loading

bcomnes Jun 21, 2023

bcomnes commented Jun 22, 2023

mcollina commented Jun 29, 2023

bcomnes commented Jun 29, 2023 •

edited

Loading

bcomnes commented Jul 20, 2023 •

edited

Loading

big-kahuna-burger commented Nov 27, 2023 •

edited

Loading

bcomnes commented Nov 27, 2023

print-routes options and print-plugins #637

print-routes options and print-plugins #637

Conversation

bcomnes commented Jun 21, 2023

Checklist

mcollina left a comment

Choose a reason for hiding this comment

bcomnes Jun 21, 2023

Choose a reason for hiding this comment

bcomnes commented Jun 21, 2023 • edited Loading

bcomnes Jun 21, 2023

Choose a reason for hiding this comment

bcomnes commented Jun 22, 2023

mcollina commented Jun 29, 2023

bcomnes commented Jun 29, 2023 • edited Loading

bcomnes commented Jul 20, 2023 • edited Loading

big-kahuna-burger commented Nov 27, 2023 • edited Loading

bcomnes commented Nov 27, 2023

bcomnes commented Jun 21, 2023 •

edited

Loading

bcomnes commented Jun 29, 2023 •

edited

Loading

bcomnes commented Jul 20, 2023 •

edited

Loading

big-kahuna-burger commented Nov 27, 2023 •

edited

Loading