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.

Sign up for GitHub

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

Jump to bottom

Mark this.router protected #23573

Merged
merged 4 commits into from Mar 31, 2021
Merged

Mark this.router protected #23573

merged 4 commits into from Mar 31, 2021
+25 −16

Conversation

timneutkens
Copy link
Member

Seems that some people (#23558) are using Next.js internals based on the typings that TS generates automatically even though these values are not documented / should not be used in applications. This ensures the router value on Server is not used by accident.

Bug

  • Related issues linked using fixes #number
  • Integration tests added

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.

Documentation / Examples

  • Make sure the linting passes

@timneutkens
Mark this.router protected
d7cf1f3 
Seems that some people (vercel#23558) are using Next.js internals based on the typings that TS generates automatically even though these values are not documented / should not be used in applications. This ensures the router value on Server is not used by accident.
@timneutkens timneutkens mentioned this pull request Mar 31, 2021
Closed
@ijjk
Copy link
Member

ijjk commented Mar 31, 2021

Stats from current PR

Default Server Mode (Decrease detected ✓)
General Overall increase ⚠️
vercel/next.js canary timneutkens/next.js add/make-router-protected Change
buildDuration 10.6s 10.3s -287ms
nodeModulesSize 45.9 MB 45.9 MB ⚠️ +608 B
Page Load Tests Overall decrease ⚠️
vercel/next.js canary timneutkens/next.js add/make-router-protected Change
/ failed reqs 0 0 ✓
/ total time (seconds) 1.653 1.802 ⚠️ +0.15
/ avg req/sec 1512.3 1387.68 ⚠️ -124.62
/error-in-render failed reqs 0 0 ✓
/error-in-render total time (seconds) 1.075 1.105 ⚠️ +0.03
/error-in-render avg req/sec 2326.65 2262.39 ⚠️ -64.26
Client Bundles (main, webpack, commons)
vercel/next.js canary timneutkens/next.js add/make-router-protected Change
677f882d2ed8..7edd.js gzip 13.4 kB 13.4 kB ✓
framework.HASH.js gzip 39 kB 39 kB ✓
main-HASH.js gzip 7.12 kB 7.12 kB ✓
webpack-HASH.js gzip 751 B 751 B ✓
Overall change 60.2 kB 60.2 kB ✓
Legacy Client Bundles (polyfills)
vercel/next.js canary timneutkens/next.js add/make-router-protected Change
polyfills-HASH.js gzip 31.3 kB 31.3 kB ✓
Overall change 31.3 kB 31.3 kB ✓
Client Pages
vercel/next.js canary timneutkens/next.js add/make-router-protected Change
_app-8fbabfc..6440.js gzip 1.28 kB 1.28 kB ✓
_error-af59f..582f.js gzip 3.46 kB 3.46 kB ✓
amp-9716187d..0aa8.js gzip 536 B 536 B ✓
hooks-107e90..74c7.js gzip 888 B 888 B ✓
index-ac435c..ecf2.js gzip 227 B 227 B ✓
link-c31053f..c329.js gzip 1.64 kB 1.64 kB ✓
routerDirect..dc9d.js gzip 303 B 303 B ✓
withRouter-6..0e02.js gzip 302 B 302 B ✓
Overall change 8.64 kB 8.64 kB ✓
Client Build Manifests
vercel/next.js canary timneutkens/next.js add/make-router-protected Change
_buildManifest.js gzip 370 B 370 B ✓
Overall change 370 B 370 B ✓
Rendered Page Sizes
vercel/next.js canary timneutkens/next.js add/make-router-protected Change
index.html gzip 613 B 613 B ✓
link.html gzip 621 B 621 B ✓
withRouter.html gzip 608 B 608 B ✓
Overall change 1.84 kB 1.84 kB ✓
Serverless Mode
General Overall increase ⚠️
vercel/next.js canary timneutkens/next.js add/make-router-protected Change
buildDuration 12.4s 12.2s -247ms
nodeModulesSize 45.9 MB 45.9 MB ⚠️ +608 B
Client Bundles (main, webpack, commons)
vercel/next.js canary timneutkens/next.js add/make-router-protected Change
677f882d2ed8..7edd.js gzip 13.4 kB 13.4 kB ✓
framework.HASH.js gzip 39 kB 39 kB ✓
main-HASH.js gzip 7.12 kB 7.12 kB ✓
webpack-HASH.js gzip 751 B 751 B ✓
Overall change 60.2 kB 60.2 kB ✓
Legacy Client Bundles (polyfills)
vercel/next.js canary timneutkens/next.js add/make-router-protected Change
polyfills-HASH.js gzip 31.3 kB 31.3 kB ✓
Overall change 31.3 kB 31.3 kB ✓
Client Pages
vercel/next.js canary timneutkens/next.js add/make-router-protected Change
_app-8fbabfc..6440.js gzip 1.28 kB 1.28 kB ✓
_error-af59f..582f.js gzip 3.46 kB 3.46 kB ✓
amp-9716187d..0aa8.js gzip 536 B 536 B ✓
hooks-107e90..74c7.js gzip 888 B 888 B ✓
index-ac435c..ecf2.js gzip 227 B 227 B ✓
link-c31053f..c329.js gzip 1.64 kB 1.64 kB ✓
routerDirect..dc9d.js gzip 303 B 303 B ✓
withRouter-6..0e02.js gzip 302 B 302 B ✓
Overall change 8.64 kB 8.64 kB ✓
Client Build Manifests
vercel/next.js canary timneutkens/next.js add/make-router-protected Change
_buildManifest.js gzip 370 B 370 B ✓
Overall change 370 B 370 B ✓
Serverless bundles
vercel/next.js canary timneutkens/next.js add/make-router-protected Change
_error.js 1.36 MB 1.36 MB ✓
404.html 2.67 kB 2.67 kB ✓
500.html 2.65 kB 2.65 kB ✓
amp.amp.html 10.6 kB 10.6 kB ✓
amp.html 1.86 kB 1.86 kB ✓
hooks.html 1.92 kB 1.92 kB ✓
index.js 1.36 MB 1.36 MB ✓
link.js 1.42 MB 1.42 MB ✓
routerDirect.js 1.41 MB 1.41 MB ✓
withRouter.js 1.41 MB 1.41 MB ✓
Overall change 6.99 MB 6.99 MB ✓
Webpack 5 Mode (Increase detected ⚠️)
General Overall increase ⚠️
vercel/next.js canary timneutkens/next.js add/make-router-protected Change
buildDuration 12.4s 12.7s ⚠️ +296ms
nodeModulesSize 45.9 MB 45.9 MB ⚠️ +608 B
Page Load Tests Overall increase ✓
vercel/next.js canary timneutkens/next.js add/make-router-protected Change
/ failed reqs 0 0 ✓
/ total time (seconds) 1.79 1.724 -0.07
/ avg req/sec 1396.3 1449.9 +53.6
/error-in-render failed reqs 0 0 ✓
/error-in-render total time (seconds) 1.116 1.138 ⚠️ +0.02
/error-in-render avg req/sec 2239.16 2197.16 ⚠️ -42
Client Bundles (main, webpack, commons)
vercel/next.js canary timneutkens/next.js add/make-router-protected Change
597-e27c5352..db8c.js gzip 13.3 kB 13.3 kB ✓
778-84582755..aa9b.js gzip 7.05 kB 7.05 kB ✓
framework.HASH.js gzip 39.3 kB 39.3 kB ✓
main-HASH.js gzip 151 B 151 B ✓
webpack-HASH.js gzip 993 B 993 B ✓
Overall change 60.8 kB 60.8 kB ✓
Legacy Client Bundles (polyfills)
vercel/next.js canary timneutkens/next.js add/make-router-protected Change
polyfills-HASH.js gzip 31.1 kB 31.1 kB ✓
Overall change 31.1 kB 31.1 kB ✓
Client Pages
vercel/next.js canary timneutkens/next.js add/make-router-protected Change
_app-5cc66b2..6f03.js gzip 1.3 kB 1.3 kB ✓
_error-b58c1..9b8e.js gzip 3.4 kB 3.4 kB ✓
amp-89a5460c..567f.js gzip 558 B 558 B ✓
hooks-8c2e74..be37.js gzip 924 B 924 B ✓
index-fec729..83b2.js gzip 243 B 243 B ✓
link-dd34d9b..0ade.js gzip 1.66 kB 1.66 kB ✓
routerDirect..5759.js gzip 336 B 336 B ✓
withRouter-1..98bf.js gzip 334 B 334 B ✓
Overall change 8.76 kB 8.76 kB ✓
Client Build Manifests
vercel/next.js canary timneutkens/next.js add/make-router-protected Change
_buildManifest.js gzip 349 B 349 B ✓
Overall change 349 B 349 B ✓
Rendered Page Sizes
vercel/next.js canary timneutkens/next.js add/make-router-protected Change
index.html gzip 610 B 610 B ✓
link.html gzip 615 B 615 B ✓
withRouter.html gzip 605 B 605 B ✓
Overall change 1.83 kB 1.83 kB ✓

Diffs

Diff for index.html 
@@ -43,7 +43,7 @@
         "props": { "pageProps": {} },
         "page": "/",
         "query": {},
-        "buildId": "WfLuY0uO8IGn-I2up_xCF",
+        "buildId": "EPMbBYcbtpl7oYRM9Dy5v",
         "isFallback": false,
         "gip": true
       }
@@ -77,11 +77,11 @@
       async=""
     ></script>
     <script
-      src="/_next/static/WfLuY0uO8IGn-I2up_xCF/_buildManifest.js"
+      src="/_next/static/EPMbBYcbtpl7oYRM9Dy5v/_buildManifest.js"
       async=""
     ></script>
     <script
-      src="/_next/static/WfLuY0uO8IGn-I2up_xCF/_ssgManifest.js"
+      src="/_next/static/EPMbBYcbtpl7oYRM9Dy5v/_ssgManifest.js"
       async=""
     ></script>
   </body>
Diff for link.html 
@@ -48,7 +48,7 @@
         "props": { "pageProps": {} },
         "page": "/link",
         "query": {},
-        "buildId": "WfLuY0uO8IGn-I2up_xCF",
+        "buildId": "EPMbBYcbtpl7oYRM9Dy5v",
         "isFallback": false,
         "gip": true
       }
@@ -82,11 +82,11 @@
       async=""
     ></script>
     <script
-      src="/_next/static/WfLuY0uO8IGn-I2up_xCF/_buildManifest.js"
+      src="/_next/static/EPMbBYcbtpl7oYRM9Dy5v/_buildManifest.js"
       async=""
     ></script>
     <script
-      src="/_next/static/WfLuY0uO8IGn-I2up_xCF/_ssgManifest.js"
+      src="/_next/static/EPMbBYcbtpl7oYRM9Dy5v/_ssgManifest.js"
       async=""
     ></script>
   </body>
Diff for withRouter.html 
@@ -43,7 +43,7 @@
         "props": { "pageProps": {} },
         "page": "/withRouter",
         "query": {},
-        "buildId": "WfLuY0uO8IGn-I2up_xCF",
+        "buildId": "EPMbBYcbtpl7oYRM9Dy5v",
         "isFallback": false,
         "gip": true
       }
@@ -77,11 +77,11 @@
       async=""
     ></script>
     <script
-      src="/_next/static/WfLuY0uO8IGn-I2up_xCF/_buildManifest.js"
+      src="/_next/static/EPMbBYcbtpl7oYRM9Dy5v/_buildManifest.js"
       async=""
     ></script>
     <script
-      src="/_next/static/WfLuY0uO8IGn-I2up_xCF/_ssgManifest.js"
+      src="/_next/static/EPMbBYcbtpl7oYRM9Dy5v/_ssgManifest.js"
       async=""
     ></script>
   </body>
Commit: 89a73e5

@ijjk ijjk merged commit 0d5baf2 into vercel:canary Mar 31, 2021
SokratisVidros pushed a commit to SokratisVidros/next.js that referenced this pull request Apr 20, 2021
@timneutkens @ijjk @SokratisVidros
Mark this.router protected (vercel#23573)
20e2107 
* Mark this.router protected

Seems that some people (vercel#23558) are using Next.js internals based on the typings that TS generates automatically even though these values are not documented / should not be used in applications. This ensures the router value on Server is not used by accident.

* Mark all variables as protected

vercel#23349

* fix type error

Co-authored-by: JJ Kasper <jj@jjsweb.site>
@snyk-bot snyk-bot mentioned this pull request Apr 25, 2021
Merged
flybayer pushed a commit to blitz-js/next.js that referenced this pull request Apr 29, 2021
@timneutkens @ijjk
Mark this.router protected (vercel#23573)
3746de7 
* Mark this.router protected

Seems that some people (vercel#23558) are using Next.js internals based on the typings that TS generates automatically even though these values are not documented / should not be used in applications. This ensures the router value on Server is not used by accident.

* Mark all variables as protected

vercel#23349

* fix type error

Co-authored-by: JJ Kasper <jj@jjsweb.site>
@vercel vercel locked as resolved and limited conversation to collaborators Jan 28, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@Timer Timer Timer approved these changes

@ijjk ijjk ijjk approved these changes

@divmain divmain Awaiting requested review from divmain

@lfades lfades Awaiting requested review from lfades

@shuding shuding Awaiting requested review from shuding shuding is a code owner

Assignees
No one assigned
Labels
type: next
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@timneutkens @ijjk @Timer