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

Fix: Update shallow routing docs #11894

Merged
merged 1 commit into from
Apr 15, 2020
Merged

Fix: Update shallow routing docs #11894

merged 1 commit into from
Apr 15, 2020

Conversation

gndelia
Copy link
Contributor

@gndelia gndelia commented Apr 14, 2020 •
edited
Loading

This is to fix #11513

The second parameter of Router.push can be undefined (because it's optional), but not null, and the examples are using null.

So this PR updates the docs to use undefined instead

edit: I wonder if the docs should mention that, if passing undefined as the second argument (as it's optional) it will be initialized to the same value as the first argument

@gndelia gndelia requested a review from Timer as a code owner April 14, 2020 21:46
@ijjk
Copy link
Member

ijjk commented Apr 14, 2020

Stats from current PR

Default Server Mode (Decrease detected ✓)
General
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
buildDuration 10.2s 10.2s -16ms
nodeModulesSize 55.5 MB 55.5 MB ✓
Page Load Tests Overall decrease ⚠️
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
/ failed reqs 0 0 ✓
/ total time (seconds) 2.015 2.015 ✓
/ avg req/sec 1240.81 1240.88 ⚠️ +0.07
/error-in-render failed reqs 0 0 ✓
/error-in-render total time (seconds) 1.202 1.266 ⚠️ +0.06
/error-in-render avg req/sec 2080.18 1975.39 -104.79
Client Bundles (main, webpack, commons)
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
main-HASH.js gzip 6.25 kB 6.25 kB ✓
webpack-HASH.js gzip 746 B 746 B ✓
de003c3a9d30..f272.js gzip 10.3 kB 10.3 kB ✓
framework.HASH.js gzip 39.1 kB 39.1 kB ✓
Overall change 56.4 kB 56.4 kB ✓
Client Bundles (main, webpack, commons) Modern
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
main-HASH.module.js gzip 4.78 kB 4.78 kB ✓
webpack-HASH..dule.js gzip 746 B 746 B ✓
de003c3a9d30..dule.js gzip 6.84 kB 6.84 kB ✓
framework.HA..dule.js gzip 39.1 kB 39.1 kB ✓
Overall change 51.5 kB 51.5 kB ✓
Legacy Client Bundles (polyfills)
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
polyfills-HASH.js gzip 26.3 kB 26.3 kB ✓
Overall change 26.3 kB 26.3 kB ✓
Client Pages
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
_app.js gzip 1.24 kB 1.24 kB ✓
_error.js gzip 3.15 kB 3.15 kB ✓
hooks.js gzip 664 B 664 B ✓
index.js gzip 222 B 222 B ✓
link.js gzip 2.06 kB 2.06 kB ✓
routerDirect.js gzip 279 B 279 B ✓
withRouter.js gzip 278 B 278 B ✓
Overall change 7.88 kB 7.88 kB ✓
Client Pages Modern
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
_app.module.js gzip 594 B 594 B ✓
_error.module.js gzip 2.08 kB 2.08 kB ✓
hooks.module.js gzip 370 B 370 B ✓
index.module.js gzip 212 B 212 B ✓
link.module.js gzip 1.51 kB 1.51 kB ✓
routerDirect..dule.js gzip 271 B 271 B ✓
withRouter.m..dule.js gzip 270 B 270 B ✓
Overall change 5.3 kB 5.3 kB ✓
Client Build Manifests
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
_buildManifest.js gzip 61 B 61 B ✓
_buildManife..dule.js gzip 61 B 61 B ✓
Overall change 122 B 122 B ✓
Rendered Page Sizes
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
index.html gzip 930 B 930 B ✓
link.html gzip 937 B 937 B ✓
withRouter.html gzip 924 B 924 B ✓
Overall change 2.79 kB 2.79 kB ✓
Serverless Mode
General
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
buildDuration 11s 10.8s -205ms
nodeModulesSize 55.5 MB 55.5 MB ✓
Client Bundles (main, webpack, commons)
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
main-HASH.js gzip 6.25 kB 6.25 kB ✓
webpack-HASH.js gzip 746 B 746 B ✓
de003c3a9d30..f272.js gzip 10.3 kB 10.3 kB ✓
framework.HASH.js gzip 39.1 kB 39.1 kB ✓
Overall change 56.4 kB 56.4 kB ✓
Client Bundles (main, webpack, commons) Modern
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
main-HASH.module.js gzip 4.78 kB 4.78 kB ✓
webpack-HASH..dule.js gzip 746 B 746 B ✓
de003c3a9d30..dule.js gzip 6.84 kB 6.84 kB ✓
framework.HA..dule.js gzip 39.1 kB 39.1 kB ✓
Overall change 51.5 kB 51.5 kB ✓
Legacy Client Bundles (polyfills)
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
polyfills-HASH.js gzip 26.3 kB 26.3 kB ✓
Overall change 26.3 kB 26.3 kB ✓
Client Pages
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
_app.js gzip 1.24 kB 1.24 kB ✓
_error.js gzip 3.15 kB 3.15 kB ✓
hooks.js gzip 664 B 664 B ✓
index.js gzip 222 B 222 B ✓
link.js gzip 2.06 kB 2.06 kB ✓
routerDirect.js gzip 279 B 279 B ✓
withRouter.js gzip 278 B 278 B ✓
Overall change 7.88 kB 7.88 kB ✓
Client Pages Modern
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
_app.module.js gzip 594 B 594 B ✓
_error.module.js gzip 2.08 kB 2.08 kB ✓
hooks.module.js gzip 370 B 370 B ✓
index.module.js gzip 212 B 212 B ✓
link.module.js gzip 1.51 kB 1.51 kB ✓
routerDirect..dule.js gzip 271 B 271 B ✓
withRouter.m..dule.js gzip 270 B 270 B ✓
Overall change 5.3 kB 5.3 kB ✓
Client Build Manifests
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
_buildManifest.js gzip 61 B 61 B ✓
_buildManife..dule.js gzip 61 B 61 B ✓
Overall change 122 B 122 B ✓
Serverless bundles
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
_error.js 557 kB 557 kB ✓
404.html 4.18 kB 4.18 kB ✓
hooks.html 3.81 kB 3.81 kB ✓
index.js 557 kB 557 kB ✓
link.js 594 kB 594 kB ✓
routerDirect.js 586 kB 586 kB ✓
withRouter.js 586 kB 586 kB ✓
Overall change 2.89 MB 2.89 MB ✓

@gndelia gndelia force-pushed the update-docs-for-shallow-routing branch from 8dfb439 to 27a5887 Compare April 14, 2020 23:36
@gndelia gndelia force-pushed the update-docs-for-shallow-routing branch from 27a5887 to 09679f5 Compare April 14, 2020 23:38
@ijjk
Copy link
Member

ijjk commented Apr 14, 2020

Failing test suites

test/integration/cli/test/index.test.js

  • CLI Usage > dev > NODE_OPTIONS='--inspect'
Expand output

● CLI Usage › dev › NODE_OPTIONS='--inspect'

expect(received).toMatch(expected)

Matcher error: received value must be a string

Received has value: undefined

   96 |         env: { NODE_OPTIONS: '--inspect' },
   97 |       })
>  98 |       expect(output).toMatch(new RegExp(`ready on http://localhost:${port}`))
      |                      ^
   99 |     })
  100 | 
  101 |     test('-p', async () => {

  at Object.<anonymous> (integration/cli/test/index.test.js:98:22)

@ijjk
Copy link
Member

ijjk commented Apr 14, 2020

Stats from current PR

Default Server Mode (Increase detected ⚠️)
General
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
buildDuration 11.1s 11.4s ⚠️ +355ms
nodeModulesSize 55.5 MB 55.5 MB ✓
Page Load Tests Overall increase ✓
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
/ failed reqs 0 0 ✓
/ total time (seconds) 2.165 2.184 ⚠️ +0.02
/ avg req/sec 1154.99 1144.91 -10.08
/error-in-render failed reqs 0 0 ✓
/error-in-render total time (seconds) 1.359 1.293 -0.07
/error-in-render avg req/sec 1838.94 1933.08 ⚠️ +94.14
Client Bundles (main, webpack, commons)
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
main-HASH.js gzip 6.25 kB 6.25 kB ✓
webpack-HASH.js gzip 746 B 746 B ✓
de003c3a9d30..93a0.js gzip 10.3 kB 10.3 kB ✓
framework.HASH.js gzip 39.1 kB 39.1 kB ✓
Overall change 56.4 kB 56.4 kB ✓
Client Bundles (main, webpack, commons) Modern
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
main-HASH.module.js gzip 4.78 kB 4.78 kB ✓
webpack-HASH..dule.js gzip 746 B 746 B ✓
de003c3a9d30..dule.js gzip 6.84 kB 6.84 kB ✓
framework.HA..dule.js gzip 39.1 kB 39.1 kB ✓
Overall change 51.5 kB 51.5 kB ✓
Legacy Client Bundles (polyfills)
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
polyfills-HASH.js gzip 26.3 kB 26.3 kB ✓
Overall change 26.3 kB 26.3 kB ✓
Client Pages
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
_app.js gzip 1.24 kB 1.24 kB ✓
_error.js gzip 3.15 kB 3.15 kB ✓
hooks.js gzip 664 B 664 B ✓
index.js gzip 222 B 222 B ✓
link.js gzip 2.06 kB 2.06 kB ✓
routerDirect.js gzip 279 B 279 B ✓
withRouter.js gzip 278 B 278 B ✓
Overall change 7.88 kB 7.88 kB ✓
Client Pages Modern
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
_app.module.js gzip 594 B 594 B ✓
_error.module.js gzip 2.08 kB 2.08 kB ✓
hooks.module.js gzip 370 B 370 B ✓
index.module.js gzip 212 B 212 B ✓
link.module.js gzip 1.51 kB 1.51 kB ✓
routerDirect..dule.js gzip 271 B 271 B ✓
withRouter.m..dule.js gzip 270 B 270 B ✓
Overall change 5.3 kB 5.3 kB ✓
Client Build Manifests
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
_buildManifest.js gzip 61 B 61 B ✓
_buildManife..dule.js gzip 61 B 61 B ✓
Overall change 122 B 122 B ✓
Rendered Page Sizes
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
index.html gzip 925 B 925 B ✓
link.html gzip 934 B 934 B ✓
withRouter.html gzip 921 B 921 B ✓
Overall change 2.78 kB 2.78 kB ✓
Serverless Mode
General
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
buildDuration 12s 12.4s ⚠️ +396ms
nodeModulesSize 55.5 MB 55.5 MB ✓
Client Bundles (main, webpack, commons)
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
main-HASH.js gzip 6.25 kB 6.25 kB ✓
webpack-HASH.js gzip 746 B 746 B ✓
de003c3a9d30..93a0.js gzip 10.3 kB 10.3 kB ✓
framework.HASH.js gzip 39.1 kB 39.1 kB ✓
Overall change 56.4 kB 56.4 kB ✓
Client Bundles (main, webpack, commons) Modern
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
main-HASH.module.js gzip 4.78 kB 4.78 kB ✓
webpack-HASH..dule.js gzip 746 B 746 B ✓
de003c3a9d30..dule.js gzip 6.84 kB 6.84 kB ✓
framework.HA..dule.js gzip 39.1 kB 39.1 kB ✓
Overall change 51.5 kB 51.5 kB ✓
Legacy Client Bundles (polyfills)
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
polyfills-HASH.js gzip 26.3 kB 26.3 kB ✓
Overall change 26.3 kB 26.3 kB ✓
Client Pages
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
_app.js gzip 1.24 kB 1.24 kB ✓
_error.js gzip 3.15 kB 3.15 kB ✓
hooks.js gzip 664 B 664 B ✓
index.js gzip 222 B 222 B ✓
link.js gzip 2.06 kB 2.06 kB ✓
routerDirect.js gzip 279 B 279 B ✓
withRouter.js gzip 278 B 278 B ✓
Overall change 7.88 kB 7.88 kB ✓
Client Pages Modern
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
_app.module.js gzip 594 B 594 B ✓
_error.module.js gzip 2.08 kB 2.08 kB ✓
hooks.module.js gzip 370 B 370 B ✓
index.module.js gzip 212 B 212 B ✓
link.module.js gzip 1.51 kB 1.51 kB ✓
routerDirect..dule.js gzip 271 B 271 B ✓
withRouter.m..dule.js gzip 270 B 270 B ✓
Overall change 5.3 kB 5.3 kB ✓
Client Build Manifests
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
_buildManifest.js gzip 61 B 61 B ✓
_buildManife..dule.js gzip 61 B 61 B ✓
Overall change 122 B 122 B ✓
Serverless bundles
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
_error.js 557 kB 557 kB ✓
404.html 4.18 kB 4.18 kB ✓
hooks.html 3.81 kB 3.81 kB ✓
index.js 557 kB 557 kB ✓
link.js 594 kB 594 kB ✓
routerDirect.js 586 kB 586 kB ✓
withRouter.js 586 kB 586 kB ✓
Overall change 2.89 MB 2.89 MB ✓

@ijjk
Copy link
Member

ijjk commented Apr 14, 2020

Stats from current PR

Default Server Mode (Increase detected ⚠️)
General
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
buildDuration 10.2s 10.1s -102ms
nodeModulesSize 55.5 MB 55.5 MB ✓
Page Load Tests Overall increase ✓
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
/ failed reqs 0 0 ✓
/ total time (seconds) 2.058 1.937 -0.12
/ avg req/sec 1214.61 1290.57 ⚠️ +75.96
/error-in-render failed reqs 0 0 ✓
/error-in-render total time (seconds) 1.01 0.957 -0.05
/error-in-render avg req/sec 2474.6 2612.09 ⚠️ +137.49
Client Bundles (main, webpack, commons)
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
main-HASH.js gzip 6.25 kB 6.25 kB ✓
webpack-HASH.js gzip 746 B 746 B ✓
de003c3a9d30..93a0.js gzip 10.3 kB 10.3 kB ✓
framework.HASH.js gzip 39.1 kB 39.1 kB ✓
Overall change 56.4 kB 56.4 kB ✓
Client Bundles (main, webpack, commons) Modern
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
main-HASH.module.js gzip 4.78 kB 4.78 kB ✓
webpack-HASH..dule.js gzip 746 B 746 B ✓
de003c3a9d30..dule.js gzip 6.84 kB 6.84 kB ✓
framework.HA..dule.js gzip 39.1 kB 39.1 kB ✓
Overall change 51.5 kB 51.5 kB ✓
Legacy Client Bundles (polyfills)
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
polyfills-HASH.js gzip 26.3 kB 26.3 kB ✓
Overall change 26.3 kB 26.3 kB ✓
Client Pages
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
_app.js gzip 1.24 kB 1.24 kB ✓
_error.js gzip 3.15 kB 3.15 kB ✓
hooks.js gzip 664 B 664 B ✓
index.js gzip 222 B 222 B ✓
link.js gzip 2.06 kB 2.06 kB ✓
routerDirect.js gzip 279 B 279 B ✓
withRouter.js gzip 278 B 278 B ✓
Overall change 7.88 kB 7.88 kB ✓
Client Pages Modern
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
_app.module.js gzip 594 B 594 B ✓
_error.module.js gzip 2.08 kB 2.08 kB ✓
hooks.module.js gzip 370 B 370 B ✓
index.module.js gzip 212 B 212 B ✓
link.module.js gzip 1.51 kB 1.51 kB ✓
routerDirect..dule.js gzip 271 B 271 B ✓
withRouter.m..dule.js gzip 270 B 270 B ✓
Overall change 5.3 kB 5.3 kB ✓
Client Build Manifests
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
_buildManifest.js gzip 61 B 61 B ✓
_buildManife..dule.js gzip 61 B 61 B ✓
Overall change 122 B 122 B ✓
Rendered Page Sizes
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
index.html gzip 925 B 925 B ✓
link.html gzip 934 B 934 B ✓
withRouter.html gzip 922 B 922 B ✓
Overall change 2.78 kB 2.78 kB ✓
Serverless Mode
General
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
buildDuration 10.9s 10.8s -121ms
nodeModulesSize 55.5 MB 55.5 MB ✓
Client Bundles (main, webpack, commons)
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
main-HASH.js gzip 6.25 kB 6.25 kB ✓
webpack-HASH.js gzip 746 B 746 B ✓
de003c3a9d30..93a0.js gzip 10.3 kB 10.3 kB ✓
framework.HASH.js gzip 39.1 kB 39.1 kB ✓
Overall change 56.4 kB 56.4 kB ✓
Client Bundles (main, webpack, commons) Modern
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
main-HASH.module.js gzip 4.78 kB 4.78 kB ✓
webpack-HASH..dule.js gzip 746 B 746 B ✓
de003c3a9d30..dule.js gzip 6.84 kB 6.84 kB ✓
framework.HA..dule.js gzip 39.1 kB 39.1 kB ✓
Overall change 51.5 kB 51.5 kB ✓
Legacy Client Bundles (polyfills)
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
polyfills-HASH.js gzip 26.3 kB 26.3 kB ✓
Overall change 26.3 kB 26.3 kB ✓
Client Pages
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
_app.js gzip 1.24 kB 1.24 kB ✓
_error.js gzip 3.15 kB 3.15 kB ✓
hooks.js gzip 664 B 664 B ✓
index.js gzip 222 B 222 B ✓
link.js gzip 2.06 kB 2.06 kB ✓
routerDirect.js gzip 279 B 279 B ✓
withRouter.js gzip 278 B 278 B ✓
Overall change 7.88 kB 7.88 kB ✓
Client Pages Modern
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
_app.module.js gzip 594 B 594 B ✓
_error.module.js gzip 2.08 kB 2.08 kB ✓
hooks.module.js gzip 370 B 370 B ✓
index.module.js gzip 212 B 212 B ✓
link.module.js gzip 1.51 kB 1.51 kB ✓
routerDirect..dule.js gzip 271 B 271 B ✓
withRouter.m..dule.js gzip 270 B 270 B ✓
Overall change 5.3 kB 5.3 kB ✓
Client Build Manifests
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
_buildManifest.js gzip 61 B 61 B ✓
_buildManife..dule.js gzip 61 B 61 B ✓
Overall change 122 B 122 B ✓
Serverless bundles
zeit/next.js canary gndelia/next.js update-docs-for-shallow-routing Change
_error.js 557 kB 557 kB ✓
404.html 4.18 kB 4.18 kB ✓
hooks.html 3.81 kB 3.81 kB ✓
index.js 557 kB 557 kB ✓
link.js 594 kB 594 kB ✓
routerDirect.js 586 kB 586 kB ✓
withRouter.js 586 kB 586 kB ✓
Overall change 2.89 MB 2.89 MB ✓

@Timer Timer added this to the 9.3.6 milestone Apr 15, 2020
@Timer Timer merged commit 6202a7f into vercel:canary Apr 15, 2020
This was referenced May 1, 2020
Closed
Closed
@vercel vercel locked as resolved and limited conversation to collaborators Jan 31, 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

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
9.3.6
Development

Successfully merging this pull request may close these issues.

Shallow routing example throws TypeError: Cannot read property 'auth' of null
3 participants
@gndelia @ijjk @Timer