Add deprecated JSDoc comments for the previous middleware signature #35448
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lfades
requested review from
timneutkens,
ijjk,
shuding and
huozhi
as code owners
This comment has been minimized.
This comment has been minimized.
ijjk
reviewed
Mar 19, 2022
Co-authored-by: JJ Kasper <jj@jjsweb.site>
lfades
commented
Mar 21, 2022
ijjk
reviewed
Mar 21, 2022
This comment has been minimized.
This comment has been minimized.
|
NAVEED
…On Sat, Mar 19, 2022, 5:29 AM Luis Alvarez D. ***@***.***> wrote:
Something I noticed while using Middleware is that the older and no longer
working methods are still accessible for the event with autocompletion
and because of their types, and the way of knowing they're deprecated is by
running the app and seeing the error message, this should improve that when
coding in tools like VS Code.
Feature
- Implements an existing feature request or RFC. Make sure the feature
request has been accepted for implementation before opening a PR.
- Related issues linked using fixes #number
- Integration tests added
- Documentation added
- Telemetry added. In case of a feature if it's used or not.
- Errors have helpful link attached, see contributing.md
Documentation / Examples
- Make sure the linting passes by running yarn lint
------------------------------
You can view, comment on, or merge this pull request online at:
#35448
Commit Summary
- 7342447
<7342447>
Added deprecated messages
- 6da6827
<6da6827>
Clean up
File Changes
(1 file <https://github.com/vercel/next.js/pull/35448/files>)
- *M* packages/next/server/web/spec-extension/fetch-event.ts
<https://github.com/vercel/next.js/pull/35448/files#diff-63fa1faae0d66463d0f89d2880b46dc16892fb225f0a8e9bdea4efc3093501bc>
(25)
Patch Links:
- https://github.com/vercel/next.js/pull/35448.patch
- https://github.com/vercel/next.js/pull/35448.diff
—
Reply to this email directly, view it on GitHub
<#35448>, or unsubscribe
<https://github.com/notifications/unsubscribe-auth/ATXSTG5XRFOUVTSJPN26JCLVAUNYLANCNFSM5RDG2FWQ>
.
You are receiving this because you are subscribed to this thread.Message
ID: ***@***.***>
|
This comment has been minimized.
This comment has been minimized.
ijjk
reviewed
Mar 28, 2022
ijjk
reviewed
Mar 28, 2022
Stats from current PRDefault Build (Increase detected
|
| vercel/next.js canary | lfades/next.js add-jsdoc-deprecated-to-middleware-event | Change | |
|---|---|---|---|
| buildDuration | 15.5s | 15.5s | -8ms |
| buildDurationCached | 6.1s | 6.1s | -71ms |
| nodeModulesSize | 467 MB | 467 MB |
Page Load Tests Overall increase ✓
| vercel/next.js canary | lfades/next.js add-jsdoc-deprecated-to-middleware-event | Change | |
|---|---|---|---|
| / failed reqs | 0 | 0 | ✓ |
| / total time (seconds) | 3.024 | 3.001 | -0.02 |
| / avg req/sec | 826.65 | 833.12 | +6.47 |
| /error-in-render failed reqs | 0 | 0 | ✓ |
| /error-in-render total time (seconds) | 1.239 | 1.222 | -0.02 |
| /error-in-render avg req/sec | 2018.54 | 2046.6 | +28.06 |
Client Bundles (main, webpack)
| vercel/next.js canary | lfades/next.js add-jsdoc-deprecated-to-middleware-event | Change | |
|---|---|---|---|
| 925.HASH.js gzip | 179 B | 179 B | ✓ |
| framework-HASH.js gzip | 42 kB | 42 kB | ✓ |
| main-HASH.js gzip | 27.9 kB | 27.9 kB | ✓ |
| webpack-HASH.js gzip | 1.44 kB | 1.44 kB | ✓ |
| Overall change | 71.6 kB | 71.6 kB | ✓ |
Legacy Client Bundles (polyfills)
| vercel/next.js canary | lfades/next.js add-jsdoc-deprecated-to-middleware-event | Change | |
|---|---|---|---|
| polyfills-HASH.js gzip | 31 kB | 31 kB | ✓ |
| Overall change | 31 kB | 31 kB | ✓ |
Client Pages
| vercel/next.js canary | lfades/next.js add-jsdoc-deprecated-to-middleware-event | Change | |
|---|---|---|---|
| _app-HASH.js gzip | 1.36 kB | 1.36 kB | ✓ |
| _error-HASH.js gzip | 192 B | 192 B | ✓ |
| amp-HASH.js gzip | 309 B | 309 B | ✓ |
| css-HASH.js gzip | 327 B | 327 B | ✓ |
| dynamic-HASH.js gzip | 2.57 kB | 2.57 kB | ✓ |
| head-HASH.js gzip | 351 B | 351 B | ✓ |
| hooks-HASH.js gzip | 920 B | 920 B | ✓ |
| image-HASH.js gzip | 5.48 kB | 5.48 kB | ✓ |
| index-HASH.js gzip | 263 B | 263 B | ✓ |
| link-HASH.js gzip | 2.26 kB | 2.26 kB | ✓ |
| routerDirect..HASH.js gzip | 320 B | 320 B | ✓ |
| script-HASH.js gzip | 387 B | 387 B | ✓ |
| withRouter-HASH.js gzip | 319 B | 319 B | ✓ |
| 85e02e95b279..7e3.css gzip | 107 B | 107 B | ✓ |
| Overall change | 15.2 kB | 15.2 kB | ✓ |
Client Build Manifests
| vercel/next.js canary | lfades/next.js add-jsdoc-deprecated-to-middleware-event | Change | |
|---|---|---|---|
| _buildManifest.js gzip | 460 B | 460 B | ✓ |
| Overall change | 460 B | 460 B | ✓ |
Rendered Page Sizes
| vercel/next.js canary | lfades/next.js add-jsdoc-deprecated-to-middleware-event | Change | |
|---|---|---|---|
| index.html gzip | 532 B | 532 B | ✓ |
| link.html gzip | 545 B | 545 B | ✓ |
| withRouter.html gzip | 525 B | 525 B | ✓ |
| Overall change | 1.6 kB | 1.6 kB | ✓ |
Default Build with SWC (Increase detected ⚠️ )
General Overall increase ⚠️
| vercel/next.js canary | lfades/next.js add-jsdoc-deprecated-to-middleware-event | Change | |
|---|---|---|---|
| buildDuration | 18.9s | 19s | |
| buildDurationCached | 6.2s | 6.2s | |
| nodeModulesSize | 467 MB | 467 MB |
Page Load Tests Overall increase ✓
| vercel/next.js canary | lfades/next.js add-jsdoc-deprecated-to-middleware-event | Change | |
|---|---|---|---|
| / failed reqs | 0 | 0 | ✓ |
| / total time (seconds) | 2.975 | 2.999 | |
| / avg req/sec | 840.46 | 833.52 | |
| /error-in-render failed reqs | 0 | 0 | ✓ |
| /error-in-render total time (seconds) | 1.246 | 1.235 | -0.01 |
| /error-in-render avg req/sec | 2006.53 | 2024.51 | +17.98 |
Client Bundles (main, webpack)
| vercel/next.js canary | lfades/next.js add-jsdoc-deprecated-to-middleware-event | Change | |
|---|---|---|---|
| 925.HASH.js gzip | 178 B | 178 B | ✓ |
| framework-HASH.js gzip | 42.3 kB | 42.3 kB | ✓ |
| main-HASH.js gzip | 28.2 kB | 28.2 kB | ✓ |
| webpack-HASH.js gzip | 1.45 kB | 1.45 kB | ✓ |
| Overall change | 72.1 kB | 72.1 kB | ✓ |
Legacy Client Bundles (polyfills)
| vercel/next.js canary | lfades/next.js add-jsdoc-deprecated-to-middleware-event | Change | |
|---|---|---|---|
| polyfills-HASH.js gzip | 31 kB | 31 kB | ✓ |
| Overall change | 31 kB | 31 kB | ✓ |
Client Pages
| vercel/next.js canary | lfades/next.js add-jsdoc-deprecated-to-middleware-event | Change | |
|---|---|---|---|
| _app-HASH.js gzip | 1.35 kB | 1.35 kB | ✓ |
| _error-HASH.js gzip | 179 B | 179 B | ✓ |
| amp-HASH.js gzip | 313 B | 313 B | ✓ |
| css-HASH.js gzip | 324 B | 324 B | ✓ |
| dynamic-HASH.js gzip | 2.56 kB | 2.56 kB | ✓ |
| head-HASH.js gzip | 351 B | 351 B | ✓ |
| hooks-HASH.js gzip | 921 B | 921 B | ✓ |
| image-HASH.js gzip | 5.59 kB | 5.59 kB | ✓ |
| index-HASH.js gzip | 261 B | 261 B | ✓ |
| link-HASH.js gzip | 2.33 kB | 2.33 kB | ✓ |
| routerDirect..HASH.js gzip | 322 B | 322 B | ✓ |
| script-HASH.js gzip | 388 B | 388 B | ✓ |
| withRouter-HASH.js gzip | 317 B | 317 B | ✓ |
| 85e02e95b279..7e3.css gzip | 107 B | 107 B | ✓ |
| Overall change | 15.3 kB | 15.3 kB | ✓ |
Client Build Manifests
| vercel/next.js canary | lfades/next.js add-jsdoc-deprecated-to-middleware-event | Change | |
|---|---|---|---|
| _buildManifest.js gzip | 458 B | 458 B | ✓ |
| Overall change | 458 B | 458 B | ✓ |
Rendered Page Sizes
| vercel/next.js canary | lfades/next.js add-jsdoc-deprecated-to-middleware-event | Change | |
|---|---|---|---|
| index.html gzip | 532 B | 532 B | ✓ |
| link.html gzip | 547 B | 547 B | ✓ |
| withRouter.html gzip | 528 B | 528 B | ✓ |
| Overall change | 1.61 kB | 1.61 kB | ✓ |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Something I noticed while using Middleware is that the older and no longer working methods are still accessible for the
eventwith autocompletion because of their types, and the way of knowing they're deprecated is by running the app and seeing the error message, this should improve that when coding in tools like VS Code.Feature
fixes #numbercontributing.mdDocumentation / Examples
yarn lint