feat(core): exclude route from global prefix

[Kiliandeca]

New global prefix option to exclude some routes as a string or a RouteInfo

PR Checklist

Please check if your PR fulfills the following requirements:

• The commit message follows our guidelines: https://github.com/nestjs/nest/blob/master/CONTRIBUTING.md
• Tests for the changes have been added (for bug fixes / features)
• Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[x] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[ ] Other... Please describe:

What is the current behavior?

You can specify a global route prefix but you can't exclude some routes

app.setGlobalPrefix('v1');

Issue Number: #963

What is the new behavior?

It add a new option object for the global prefix. You can exclude routes based on the path and the request method

app.setGlobalPrefix('v1', { exclude: [
  { path: '/health', method: RequestMethod.GET }
]});

You can also specify route as a string (it apply on every request method) or a mix of the 2 like so:

app.setGlobalPrefix('v1', { exclude: [
  'cats',
  { path: '/health', method: RequestMethod.GET }
]});

This is my first contribution to this awesome framework and there are probably things that need to be improved or moved so please give me some feedback.

I followed the syntax proposed in the issue (back in 2018) and I tried to follow the middleware route exclude code.

I would like to add support for wildcard parameters (like 'cats/(.*)') the same way it's done for the middleware but maybe it's better to do it step by step and create another PR ?

I can also write the doc for this if you want

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

Have a great day

[coveralls]

Pull Request Test Coverage Report for Build 1a449be6-ea80-4e4c-87fd-c417f3816f9e

• 16 of 26 (61.54%) changed or added relevant lines in 3 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage decreased (-0.2%) to 94.648%

---

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
packages/core/router/router-explorer.ts	12	22	54.55%

Totals
Change from base Build 0bd55d4e-9747-45b6-b626-b8e868f001b2:	-0.2%
Covered Lines:	4934
Relevant Lines:	5213

---

💛 - Coveralls

[jmcdo29]

Why are all of these it.only? Shouldn't they bet just it()?

[Kiliandeca]

Sorry about that, I forgot to remove them after testing

[jmcdo29]

Would it be possible to add one more test showing that RequestMethod.GET works as described?

[Kiliandeca]

Sure, I just added the test you asked and found out it wasn't working correctly with RequestMethod.GET because it's the enum 0 so I changed a line in the code as well. Now everything should be working (I hope)

[mseada94]

Hi, I think some more test cases should be added.

• Testing wildcard behaviour
• Testing exclude:cats as string and request GET /cats/foo and GET /api/v1/cats/foo
• Testing using a middleware to make sure its not being effected
  For now I am exploring the repo from mobile, so I decide to write a comment

[jmcdo29]

Looks like the failing test is due to a package installation problem. Other than that, to me, it's looking good. Let's wait to hear from Kamil too 😸

[in-live-md]

Is this PR going to be merged at some point?

[rubiin]

this looks like a great feature to have

[sindilevich]

Thank you so much, it is one of long-awaited features of Nest.js.

What do you think about testing whether a nested path can be excluded? Like so:

app.setGlobalPrefix('v1', { exclude: [
  { path: '/health/heartbeat', method: RequestMethod.GET }
]});

[kamilmysliwiec]

LGTM, thanks! This will be added in 8.0.0