Update Advanced Error Page section in custom-error-page.md #32873
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
Update More Advanced Error Page Customizing section in custom-error-page.md, by using `getServerSideProps` instead of `getInitialProps`.
glenngijsberts
requested review from
huozhi,
ijjk,
leerob,
padmaia,
shuding,
styfle and
timneutkens
as code owners
ijjk
requested changes
Dec 29, 2021
There was a problem hiding this comment.
Hi, getServerSideProps isn't fully compatible as a replacement for getInitialProps with _error here as we don't provide the err in the context passed to getServerSideProps so I don't think we should update to recommend this in the documentation here currently.
|
@ijjk right, was already thinking something like that is the case. WDYT about adding a "caveats" section with this info included? Like there is for |
|
Yeah might be good to add a caveat mentioning that |
|
@glenngijsberts are you interested in updating the Caveats section? |
|
@balazsorban44 @ijjk yes! I'll make sure to update that, and i'll close this :) |
1 task
kodiakhq bot
pushed a commit
that referenced
this pull request
Jan 10, 2022
## Desscription This is a follow up of #32873. As discussed in #32873, currently it's not recommended to use getServerSideProps in the `Error` component, so this PR will add that caveat to the documentation page, like `Document` and `App` also have. ## Documentation / Examples - [x] Make sure the linting passes by running `yarn lint`
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.
Description
Update More Advanced Error Page Customizing section in custom-error-page.md, by using
getServerSidePropsinstead ofgetInitialProps.Tested locally in my own project and seems to be working as expected. However, on the same docs page there is an example that is using
getServerSidePropsfor the page where theErrorcomponent is being used so i'm wondering: is there a reason why the example of the customErrorpage isn't usinggetServerSideProps? I was thinking that it maybe had the same constraint as the customDocument&Apppages, where Next.js Data Fetching methods likegetServerSidePropsare not supported.If there are no constraints, this update seems good to me, because it aligns with the latest practices of Next.js. Otherwise maybe a good idea to add the same line as https://nextjs.org/docs/advanced-features/custom-app#caveats where it says that those data fetching methods are not supported.
Documentation / Examples
yarn lint