feat: add "no server side rendering" guard to protect routes that should not be rendered in SSR #1277
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
…ot be rendered in SSR * used for the checkout receipt page that should only be rendered in the users browser
MaxKless
previously approved these changes
Sep 16, 2022
jometzner
previously approved these changes
Sep 17, 2022
SGrueber
previously approved these changes
Sep 19, 2022
dhhyi
requested changes
Sep 19, 2022
shauke
force-pushed
the
feature/server-side-rendering-guard
branch
from
fbe4cac to
765a2cd
Compare
shauke
changed the title
dhhyi
approved these changes
Sep 21, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
PR Type
[x] Feature
What Is the Current Behavior?
Currently the checkout receipt page is not protected by any guard. It is rendered on the server side as well as on the browser side. Since some information is missing on the server side, e.g. authentication (apiToken cookie) and user information, the needed data cannot be fetched and only an empty page can be rendered.
With the relatively simple logic of the standard checkout receipt page this is not a big problem and the page is rendered as a more or less empty page without errors in SSR and returned to the browser that will than render the page with the full content since here the needed user authentication is available.
In projects though it can happen that more information is handled for this page and it can happen that this is not implemented in a SSR safe way resulting in errors or timeouts.
What Is the New Behavior?
With the introduced
NoServerSideRenderingGuardit is now possible to protect certain routes from being rendered at all in SSR and instead returning a simple loading animation page. Back in the browser this page will then be completely rendered without problems.This functionality is used to protect all checkout pages from being rendered in SSR.
Does this PR Introduce a Breaking Change?
[x] No
Other Information
AB#79644