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

Add deprecated JSDoc comments for the previous middleware signature #35448

Merged

Conversation

lfades
Copy link
Member

@lfades lfades commented Mar 19, 2022

Something I noticed while using Middleware is that the older and no longer working methods are still accessible for the event with 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

  • 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

@ijjk

This comment has been minimized.

Co-authored-by: JJ Kasper <jj@jjsweb.site>
@ijjk

This comment has been minimized.

@Naveed-Iftikhar
Copy link

Naveed-Iftikhar commented Mar 21, 2022 via email

@lfades lfades requested a review from ijjk March 27, 2022 04:27
@ijjk

This comment has been minimized.

Copy link
Member

@ijjk ijjk left a comment

Choose a reason for hiding this comment

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

Thanks!

@ijjk
Copy link
Member

ijjk commented Mar 28, 2022

Stats from current PR

Default Build (Increase detected ⚠️)
General Overall increase ⚠️
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 ⚠️ +692 B
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 ⚠️ +85ms
buildDurationCached 6.2s 6.2s ⚠️ +3ms
nodeModulesSize 467 MB 467 MB ⚠️ +692 B
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 ⚠️ +0.02
/ avg req/sec 840.46 833.52 ⚠️ -6.94
/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
Commit: 913f93c

@kodiakhq kodiakhq bot merged commit 5d1f33f into vercel:canary Mar 28, 2022
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 28, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants