fix(core): let the middleware can get the params in the global prefix #10390

CodyTseng · 2022-10-10T15:12:59Z

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?

What is the current behavior?

Issue Number: #9776, #10566

What is the new behavior?

Does this PR introduce a breaking change?

Yes
No

Other information

coveralls · 2022-10-10T15:18:50Z

Pull Request Test Coverage Report for Build 88e8b676-a087-4894-ad55-c3b4e77ab62f

29 of 30 (96.67%) changed or added relevant lines in 5 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage increased (+0.03%) to 92.997%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
packages/microservices/server/server-kafka.ts	0	1	0.0%

Totals
Change from base Build 2f44b0f1-4e06-49ac-b845-35bef850e129:	0.03%
Covered Lines:	6401
Relevant Lines:	6883

💛 - Coveralls

packages/core/router/interfaces/exclude-route-metadata.interface.ts

mareksuscak · 2022-11-15T12:27:59Z

Does this pull request fix the issue described in #8844 (comment) by any chance? If not, can we please fix that bug in this PR please and add some tests? Please let me know if that's not possible and I'll create a separate issue and open a PR.

EDIT: here's the ticket in case you decide to fix the bug #10566

CodyTseng · 2022-11-15T14:33:39Z

@mareksuscak I think I can get this PR to fix #10566 with a few small tweaks. But I think this should be two different questions. I'm not sure if we need to open another PR.

kenji57775 · 2022-11-18T22:11:17Z

CodyTseng · 2022-11-19T16:46:39Z

@mareksuscak Hi, I tried to fix the issue described in #8844 (comment) and added some tests in this PR. I’d appreciate it if you have time to review the commit and give me some advice.

thiagomini

Thanks for your contribution, @CodyTseng, I haven't had time to look into this issue since last week. I left a few suggestions for you, and I hope you find them useful 😄

integration/nest-application/middleware/e2e/middleware.spec.ts

packages/core/middleware/middleware-module.ts

packages/core/middleware/utils.ts

CodyTseng · 2022-11-22T01:24:47Z

Thanks for your useful suggestions, @thiagomini ! I will look carefully at your suggestions and optimize the code later.

thiagomini

Hey Cody, first, I would like to thank you again for your efforts to contribute to NestJS. Nonetheless, I ask you to review the tests you've created here. I hope my explanation clarified why we should avoid testing private methods, but let me know if you are not sure yet.

packages/core/test/middleware/middleware-module.spec.ts

packages/core/test/nest-application.spec.ts

thiagomini

This LGTM (Looks good to me) now, Cody. Thanks for considering my reviews 😃

packages/core/middleware/route-info-path-extractor.ts

thiagomini · 2022-11-25T12:15:09Z

Hey @kamilmysliwiec , could you review this too?

kamilmysliwiec · 2023-02-01T12:50:58Z

Apologies for not reviewing this PR sooner.. There's a few conflicts that occurred after we introduced a new PathsExplorer class https://github.com/nestjs/nest/blob/master/packages/core/router/paths-explorer.ts. Would you be able to resolve them @CodyTseng?

CodyTseng · 2023-02-01T13:55:02Z

Of course! I will resolve the conflict later.

CodyTseng · 2023-02-01T15:04:12Z

Hey @kamilmysliwiec, I've resolved conflicts. You can review it when you have time 😊

kamilmysliwiec · 2023-02-03T08:25:45Z

I'm wondering if this PR solves this issue #9990 as well 🤔

CodyTseng · 2023-02-03T08:35:55Z

Unfortunately, this issue #9990 has not been solved in this PR.

I'm also following this issue, if I think of a suitable solution, I'd be happy to create a PR for it. I think the following method needs to be modified.

nest/packages/core/middleware/utils.ts

Lines 94 to 111 in 03efdce

    
           export function isMiddlewareRouteExcluded( 
        
             req: Record<string, any>, 
        
             excludedRoutes: ExcludeRouteMetadata[], 
        
             httpAdapter: HttpServer, 
        
           ): boolean { 
        
             if (excludedRoutes.length <= 0) { 
        
               return false; 
        
             } 
        
             const reqMethod = httpAdapter.getRequestMethod(req); 
        
             const originalUrl = httpAdapter.getRequestUrl(req); 
        
             const queryParamsIndex = originalUrl && originalUrl.indexOf('?'); 
        
             const pathname = 
        
               queryParamsIndex >= 0 
        
                 ? originalUrl.slice(0, queryParamsIndex) 
        
                 : originalUrl; 
        
             return isRouteExcluded(excludedRoutes, pathname, RequestMethod[reqMethod]); 
        
           }

packages/core/middleware/route-info-path-extractor.ts

Co-authored-by: Kamil Mysliwiec <mail@kamilmysliwiec.com>

kamilmysliwiec · 2023-02-03T09:11:52Z

LGTM

fix(core): let the middleware can get the params in the global prefix

75d5d64

test: add the middleware get the params from global prefix test

b7f458f

CodyTseng marked this pull request as ready for review October 11, 2022 07:49

zanminkian reviewed Oct 14, 2022

View reviewed changes

packages/core/router/interfaces/exclude-route-metadata.interface.ts Outdated Show resolved Hide resolved

CodyTseng added 2 commits October 15, 2022 10:50

fix(core): add leading slash to excluded paths

c437ac9

style(core): add missing period

3d16326

CodyTseng requested a review from zanminkian October 15, 2022 03:26

Merge branch 'master' into fix-middleware-global-prefix

4c4c13b

CodyTseng added 2 commits November 19, 2022 18:11

feat: version-aware middleware

cc7e829

test: update the middleware get the params from global prefix test

4a27d26

Merge branch 'nestjs:master' into fix-middleware-global-prefix

d5f434c

thiagomini reviewed Nov 21, 2022

View reviewed changes

integration/nest-application/middleware/e2e/middleware.spec.ts Outdated Show resolved Hide resolved

packages/core/middleware/middleware-module.ts Outdated Show resolved Hide resolved

packages/core/middleware/utils.ts Outdated Show resolved Hide resolved

CodyTseng added 4 commits November 23, 2022 16:07

feat: move test

fdc5f34

refactor: wrap get paths logic into a private function

758cd2d

test: global prefix options

7d1fa9a

feat: use mapToExcludeRoute() when set global prefix

60772c3

CodyTseng requested review from thiagomini and removed request for zanminkian November 23, 2022 14:58

thiagomini suggested changes Nov 23, 2022

View reviewed changes

packages/core/test/middleware/middleware-module.spec.ts Outdated Show resolved Hide resolved

packages/core/test/middleware/middleware-module.spec.ts Outdated Show resolved Hide resolved

packages/core/test/nest-application.spec.ts Outdated Show resolved Hide resolved

CodyTseng added 3 commits November 24, 2022 09:32

refactor: applicationConfig instead (instance as any).config

151a67b

style: keep up with current standards

daa2054

refactor: create a separate class to retrieve the paths

ecba3ba

CodyTseng requested a review from thiagomini November 24, 2022 06:57

thiagomini approved these changes Nov 24, 2022

View reviewed changes

packages/core/middleware/route-info-path-extractor.ts Outdated Show resolved Hide resolved

refactor: rename getPaths to extractPathsFrom

a1f17e2

kamilmysliwiec mentioned this pull request Feb 1, 2023

nestjs/core@8.4.1 breaks :param in globalPrefix #9776

Closed

15 tasks

CodyTseng force-pushed the fix-middleware-global-prefix branch from 087de17 to a1f17e2 Compare February 1, 2023 14:30

CodyTseng added 2 commits February 1, 2023 22:36

Merge branch 'master' into fix-middleware-global-prefix

25dd621

fix: duplicate identifier

33fe1d0

CodyTseng added 2 commits February 1, 2023 23:22

refactor: MiddlewareModule constructor parameters

c6dbc05

refactor: delete unused import

5e5828b

kamilmysliwiec mentioned this pull request Feb 3, 2023

Version-aware Middleware doesn't play well with global prefix #10566

Closed

15 tasks

kamilmysliwiec reviewed Feb 3, 2023

View reviewed changes

packages/core/middleware/route-info-path-extractor.ts Outdated Show resolved Hide resolved

Update packages/core/middleware/route-info-path-extractor.ts

6d64d91

Co-authored-by: Kamil Mysliwiec <mail@kamilmysliwiec.com>

kamilmysliwiec merged commit c7ac493 into nestjs:master Feb 3, 2023

micalevisk mentioned this pull request Jun 16, 2023

Middleware applied twice using setGlobalPrefix excluding route "/" #11821

Closed

15 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(core): let the middleware can get the params in the global prefix #10390

fix(core): let the middleware can get the params in the global prefix #10390

CodyTseng commented Oct 10, 2022 •

edited

coveralls commented Oct 10, 2022 •

edited

mareksuscak commented Nov 15, 2022 •

edited

CodyTseng commented Nov 15, 2022

kenji57775 commented Nov 18, 2022 •

edited

PR Checklist

PR Type

What is the current behavior?

What is the new behavior?

Does this PR introduce a breaking change?

Other information

CodyTseng commented Nov 19, 2022

thiagomini left a comment

CodyTseng commented Nov 22, 2022

thiagomini left a comment

thiagomini left a comment •

edited

thiagomini commented Nov 25, 2022 •

edited

kamilmysliwiec commented Feb 1, 2023

CodyTseng commented Feb 1, 2023

CodyTseng commented Feb 1, 2023

kamilmysliwiec commented Feb 3, 2023

CodyTseng commented Feb 3, 2023

kamilmysliwiec commented Feb 3, 2023

fix(core): let the middleware can get the params in the global prefix #10390

fix(core): let the middleware can get the params in the global prefix #10390

Conversation

CodyTseng commented Oct 10, 2022 • edited

PR Checklist

PR Type

What is the current behavior?

What is the new behavior?

Does this PR introduce a breaking change?

Other information

coveralls commented Oct 10, 2022 • edited

Pull Request Test Coverage Report for Build 88e8b676-a087-4894-ad55-c3b4e77ab62f

💛 - Coveralls

mareksuscak commented Nov 15, 2022 • edited

CodyTseng commented Nov 15, 2022

kenji57775 commented Nov 18, 2022 • edited

PR Checklist

PR Type

What is the current behavior?

What is the new behavior?

Does this PR introduce a breaking change?

Other information

CodyTseng commented Nov 19, 2022

thiagomini left a comment

Choose a reason for hiding this comment

CodyTseng commented Nov 22, 2022

thiagomini left a comment

Choose a reason for hiding this comment

thiagomini left a comment • edited

Choose a reason for hiding this comment

thiagomini commented Nov 25, 2022 • edited

kamilmysliwiec commented Feb 1, 2023

CodyTseng commented Feb 1, 2023

CodyTseng commented Feb 1, 2023

kamilmysliwiec commented Feb 3, 2023

CodyTseng commented Feb 3, 2023

kamilmysliwiec commented Feb 3, 2023

CodyTseng commented Oct 10, 2022 •

edited

coveralls commented Oct 10, 2022 •

edited

mareksuscak commented Nov 15, 2022 •

edited

kenji57775 commented Nov 18, 2022 •

edited

thiagomini left a comment •

edited

thiagomini commented Nov 25, 2022 •

edited