Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(platform-express) respect custom parser middlewares in Express 5 #14640

Merged

Conversation

luddwichr
Copy link
Contributor

Express 5 made the router public API again and renamed the field from app._router to app.router. This broke the detection mechanism whether a middleware named "jsonParser" or "urlencodedParser" is already registered or not.
Unfortunately, #14574 only fixed the issue partially. This commit now uses app.router everywhere.
To avoid future regressions a test was added to verify the expected behavior.

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • 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?

The express adapter overwrites existing middlewares called jsonParser and urlencodedParser with its on parsers.

This regression was caused by updating from Express 4 to 5. Express 5 exposes the router via app.router, while Express 4 exposed it via app._router.

#14574 provided a partial fix, but one check was missed.

What is the new behavior?

The express adapter respects existing middlewares called jsonParser and urlencodedParser.

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

…Express 5

Express 5 made the router public API again and renamed the field from app._router to app.router.
This broke the detection mechanism whether a middleware named "jsonParser" or "urlencodedParser"
is already registered or not.
Unfortunately, nestjs#14574 only fixed the issue partially.
This commit now uses app.router everywhere.
To avoid future regressions a test was added to verify the expected behavior.
…Express 5

Express 5 made the router public API again and renamed the field from app._router to app.router.
This broke the detection mechanism whether a middleware named "jsonParser" or "urlencodedParser"
is already registered or not.
Unfortunately, nestjs#14574 only fixed the issue partially.
This commit now uses app.router everywhere.
To avoid future regressions a test was added to verify the expected behavior.
@kamilmysliwiec
Copy link
Member

All unit tests are failing atm

import * as express from 'express';
import * as sinon from 'sinon';

afterEach(() => sinon.restore());
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

move afterEach to the inside of the describe block

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed it myself & merged the PR in

@kamilmysliwiec kamilmysliwiec merged commit eb2668d into nestjs:master Feb 17, 2025
3 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants