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

Update: Add error message when for getServerSideProps invalid return value #35887

Conversation

samueldusek
Copy link
Contributor

@samueldusek samueldusek commented Apr 4, 2022

I would like to add appropriate error message for the getServerSideProps function when the user tries to return object from that function containing something else than props object. I.e.:

return {
  props: {
    title: "title",
  },
  name: "name",
  address: "address",
}

Currenty, when the situation like that occurs, the user is provided with error message containing following link:

https://nextjs.org/docs/messages/invalid-getstaticprops-value

This link leads to page with content about getStaticProps function.

I believe that this might be confusing for some developers. Thus, I would like to propose this change after which the user will be presented with following link:

https://nextjs.org/docs/messages/invalid-getserversideprops-value

This link that leads to to newly created page with this content, that I believe is more appropriate for this kind of error.

Bug

  • Errors have helpful link attached, see contributing.md

@ijjk

This comment has been minimized.

@ijjk

This comment has been minimized.

@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 for the PR!

@ijjk

This comment has been minimized.

@ijjk
Copy link
Member

ijjk commented Apr 6, 2022

Stats from current PR

Default Build (Increase detected ⚠️)
General Overall increase ⚠️
vercel/next.js canary samueldusek/next.js update/getserversideprops-invalid-return-value-format Change
buildDuration 15.3s 15.4s ⚠️ +29ms
buildDurationCached 6s 6.1s ⚠️ +107ms
nodeModulesSize 477 MB 477 MB ⚠️ +177 B
Page Load Tests Overall increase ✓
vercel/next.js canary samueldusek/next.js update/getserversideprops-invalid-return-value-format Change
/ failed reqs 0 0
/ total time (seconds) 2.95 2.964 ⚠️ +0.01
/ avg req/sec 847.32 843.51 ⚠️ -3.81
/error-in-render failed reqs 0 0
/error-in-render total time (seconds) 1.199 1.187 -0.01
/error-in-render avg req/sec 2084.33 2107.03 +22.7
Client Bundles (main, webpack)
vercel/next.js canary samueldusek/next.js update/getserversideprops-invalid-return-value-format Change
925.HASH.js gzip 179 B 179 B
framework-HASH.js gzip 42 kB 42 kB
main-HASH.js gzip 28 kB 28 kB
webpack-HASH.js gzip 1.44 kB 1.44 kB
Overall change 71.7 kB 71.7 kB
Legacy Client Bundles (polyfills)
vercel/next.js canary samueldusek/next.js update/getserversideprops-invalid-return-value-format Change
polyfills-HASH.js gzip 31 kB 31 kB
Overall change 31 kB 31 kB
Client Pages
vercel/next.js canary samueldusek/next.js update/getserversideprops-invalid-return-value-format 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 3.05 kB 3.05 kB
head-HASH.js gzip 351 B 351 B
hooks-HASH.js gzip 920 B 920 B
image-HASH.js gzip 5.64 kB 5.64 kB
index-HASH.js gzip 263 B 263 B
link-HASH.js gzip 2.32 kB 2.32 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.9 kB 15.9 kB
Client Build Manifests
vercel/next.js canary samueldusek/next.js update/getserversideprops-invalid-return-value-format Change
_buildManifest.js gzip 459 B 459 B
Overall change 459 B 459 B
Rendered Page Sizes
vercel/next.js canary samueldusek/next.js update/getserversideprops-invalid-return-value-format Change
index.html gzip 531 B 531 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 samueldusek/next.js update/getserversideprops-invalid-return-value-format Change
buildDuration 18.1s 18.2s ⚠️ +94ms
buildDurationCached 6s 6s -39ms
nodeModulesSize 477 MB 477 MB ⚠️ +177 B
Page Load Tests Overall increase ✓
vercel/next.js canary samueldusek/next.js update/getserversideprops-invalid-return-value-format Change
/ failed reqs 0 0
/ total time (seconds) 2.961 2.97 ⚠️ +0.01
/ avg req/sec 844.38 841.87 ⚠️ -2.51
/error-in-render failed reqs 0 0
/error-in-render total time (seconds) 1.193 1.178 -0.02
/error-in-render avg req/sec 2095.12 2121.61 +26.49
Client Bundles (main, webpack)
vercel/next.js canary samueldusek/next.js update/getserversideprops-invalid-return-value-format Change
925.HASH.js gzip 178 B 178 B
framework-HASH.js gzip 42.3 kB 42.3 kB
main-HASH.js gzip 28.3 kB 28.3 kB
webpack-HASH.js gzip 1.45 kB 1.45 kB
Overall change 72.2 kB 72.2 kB
Legacy Client Bundles (polyfills)
vercel/next.js canary samueldusek/next.js update/getserversideprops-invalid-return-value-format Change
polyfills-HASH.js gzip 31 kB 31 kB
Overall change 31 kB 31 kB
Client Pages
vercel/next.js canary samueldusek/next.js update/getserversideprops-invalid-return-value-format 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 325 B 325 B
dynamic-HASH.js gzip 3.03 kB 3.03 kB
head-HASH.js gzip 351 B 351 B
hooks-HASH.js gzip 921 B 921 B
image-HASH.js gzip 5.7 kB 5.7 kB
index-HASH.js gzip 261 B 261 B
link-HASH.js gzip 2.38 kB 2.38 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.9 kB 15.9 kB
Client Build Manifests
vercel/next.js canary samueldusek/next.js update/getserversideprops-invalid-return-value-format Change
_buildManifest.js gzip 459 B 459 B
Overall change 459 B 459 B
Rendered Page Sizes
vercel/next.js canary samueldusek/next.js update/getserversideprops-invalid-return-value-format Change
index.html gzip 531 B 531 B
link.html gzip 544 B 544 B
withRouter.html gzip 526 B 526 B
Overall change 1.6 kB 1.6 kB
Commit: 29058e0

@ijjk ijjk merged commit cb565d6 into vercel:canary Apr 6, 2022
colinhacks pushed a commit to colinhacks/next.js that referenced this pull request Apr 14, 2022
@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 7, 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

2 participants