feat: SessionAuth SSR support (initialSessionAuthContext) #789
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
sasha240100
changed the title
sasha240100
changed the title
sasha240100
changed the title
This was referenced Jan 24, 2024
porcellus
requested changes
Jan 25, 2024
sasha240100
changed the title
rishabhpoddar
suggested changes
Jan 26, 2024
| @@ -13,6 +13,7 @@ | |||
| * under the License. | |||
| */ | |||
| "use strict"; | |||
| "use client"; // Important for NextJS support (SessionAuth is a client component) | |||
There was a problem hiding this comment.
We should create a separate file /recipe/session/clientcomponents/sessionauth.js
| @@ -57,6 +57,7 @@ describe("ThirdPartyPasswordless.SignInAndUp", () => { | |||
| }); | |||
|
|
|||
There was a problem hiding this comment.
we need to add an e2e test that uses SessionAuth without calling the init function and make sure that it works (in the context of SSR)
| @@ -155,6 +156,34 @@ describe("SessionAuth", () => { | |||
|
|
|||
| result.unmount(); | |||
| }); | |||
|
|
|||
| test("set initial SSR context (initialSessionAuthContext)", async () => { | |||
There was a problem hiding this comment.
add some more tests please
| const initialContext: SessionContextType = props.initialSessionAuthContext | ||
| ? { | ||
| ...props.initialSessionAuthContext, | ||
| invalidClaims: [], // invalidClaims is currently unsupported on server (SSR) |
There was a problem hiding this comment.
Suggested change
| invalidClaims: [], // invalidClaims is currently unsupported on server (SSR) | |
| invalidClaims: [], // invalidClaims is currently unsupported on server (SSR), | |
| isContextFromSSR: true, |
rishabhpoddar
merged commit f99aef2
into
supertokens:sessionauth-ssr
2 of 3 checks passed
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.
Summary of change
Adds
initialSessionAuthContextsupport forSessionAuthcomponent.initialSessionAuthContextis an initial state that Session provider uses to create a context.initialSessionAuthContextproperty toSessionAuthPropsisContextFromSSRtoLoadedSessionContextthat signals if a session context is provided from a server or computed on the client.isContextFromSSR: truewhen uses initial context preloaded from server (SSR). This meansinvalidClaims[]andaccessDeniedValidatorErrorare not yet evaluated and the client should not trust the data (as discussed with @porcellus )isContextFromSSR: falsewhen uses a client generated context (ex: after client rerender)Related issues
Test Plan
Tested locally on a NextJS implementation using supertokens. Tested scenarios include:
<SessionAuth />rendering with children that consume context (userId) -> Renders on server side, no flash or hydration issuesrequireAuth: falseon server component. -><SessionAuth />provides an empty session context and renders childrenDocumentation changes
TODO.
(If relevant, please create a PR in our docs repo, or create a checklist here highlighting the necessary changes)
Checklist for important updates
frontendDriverInterfaceSupported.jsonfile has been updated (if needed)package.jsonpackage-lock.jsonlib/ts/version.tsnpm run build-prettygit tag) in the formatvX.Y.Z, and then find the latest branch (git branch --all) whoseX.Yis greater than the latest released tag.someFunc: function () {..}).size-limitsection ofpackage.jsonwith the size limit set to the current size rounded up.rollup.config.mjsRemaining TODOs for this PR
getInitialSessionAuthContextsupport tosupertokens-node