fix(elements): Fix follow-on initialization discrepancies#3377

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

Merged
tmilewski merged 4 commits into from
May 13, 2024
Merged

fix(elements): Fix follow-on initialization discrepancies #3377

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d350e89
fix(elements): Follow-on machine initialization [SDK-1746]
tmilewski May 13, 2024
bf34b2c
chore(elements): Add changeset
tmilewski May 13, 2024
46a460e
chore(elements): Remove unnecessary TS comment
tmilewski May 13, 2024
3d4491b
chore(elements): Add line item to changeset
tmilewski May 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/odd-coins-carry.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/elements': patch
---

- Bump XState from version 5.12.0 to 5.13.0
- We now maintain your current state while completing authentication redirecting rather than transitioning to a "Complete" step.
- Fixes Sign In and Sign Up machines not appropriately attaching new form machines when returning to the Sign In or Sign Up pages.
8 changes: 4 additions & 4 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion packages/elements/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -74,7 +74,7 @@
"@statelyai/inspect": "^0.3.0",
"@xstate/react": "^4.1.1",
"client-only": "^0.0.1",
"xstate": "^5.12.0"
"xstate": "^5.13.0"
},
"devDependencies": {
"@clerk/clerk-react": "5.0.4",
Expand Down
24 changes: 8 additions & 16 deletions packages/elements/src/internals/machines/sign-in/router.machine.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ import { ClerkElementsError, ClerkElementsRuntimeError } from '~/internals/error
import { ThirdPartyMachine, ThirdPartyMachineId } from '~/internals/machines/third-party';
import { shouldUseVirtualRouting } from '~/internals/machines/utils/next';

import { FormMachine } from '../form';
import { SignInResetPasswordMachine } from './reset-password.machine';
import type {
SignInRouterContext,
Expand DownExpand Up@@ -41,6 +42,7 @@ export const SignInRouterMachineId = 'SignInRouter';
export const SignInRouterMachine = setup({
actors: {
firstFactorMachine: SignInFirstFactorMachine,
formMachine: FormMachine,
resetPasswordMachine: SignInResetPasswordMachine,
startMachine: SignInStartMachine,
secondFactorMachine: SignInSecondFactorMachine,
Expand All@@ -60,8 +62,8 @@ export const SignInRouterMachine = setup({
},
navigateExternal: ({ context }, { path }: { path: string }) => context.router?.push(path),
raiseNext: raise({ type: 'NEXT' }),
setActive({ context, event }) {
if (context.exampleMode) return;
setActive: enqueueActions(({ enqueue, check, context, event }) => {
if (check('isExampleMode')) return;

const lastActiveSessionId = context.clerk.client.lastActiveSessionId;
const createdSessionId = ((event as SignInRouterNextEvent)?.resource || context.clerk.client.signIn)
Expand All@@ -71,7 +73,9 @@ export const SignInRouterMachine = setup({

const beforeEmit = () => context.router?.push(context.clerk.buildAfterSignInUrl());
void context.clerk.setActive({ session, beforeEmit });
},

enqueue.raise({ type: 'RESET' }, { delay: 2000 }); // Reset machine after 2s delay.
}),
setError: assign({
error: (_, { error }: { error?: ClerkElementsError }) => {
if (error) return error;
Expand DownExpand Up@@ -182,6 +186,7 @@ export const SignInRouterMachine = setup({
},
})),
},
RESET: '.Idle',
},
states: {
Idle: {
Expand DownExpand Up@@ -224,7 +229,6 @@ export const SignInRouterMachine = setup({
{
guard: 'isComplete',
actions: 'setActive',
target: 'Complete',
},
{
guard: 'isLoggedInAndSingleSession',
Expand DownExpand Up@@ -285,7 +289,6 @@ export const SignInRouterMachine = setup({
{
guard: 'isComplete',
actions: 'setActive',
target: 'Complete',
},
{
guard: 'statusNeedsFirstFactor',
Expand DownExpand Up@@ -323,7 +326,6 @@ export const SignInRouterMachine = setup({
{
guard: 'isComplete',
actions: 'setActive',
target: 'Complete',
},
{
guard: 'statusNeedsSecondFactor',
Expand DownExpand Up@@ -390,7 +392,6 @@ export const SignInRouterMachine = setup({
{
guard: 'isComplete',
actions: 'setActive',
target: 'Complete',
},
{
guard: 'statusNeedsNewPassword',
Expand DownExpand Up@@ -418,7 +419,6 @@ export const SignInRouterMachine = setup({
{
guard: 'isComplete',
actions: 'setActive',
target: 'Complete',
},
{
guard: 'statusNeedsFirstFactor',
Expand DownExpand Up@@ -446,7 +446,6 @@ export const SignInRouterMachine = setup({
{
guard: or(['isLoggedIn', 'isComplete', 'hasAuthenticatedViaClerkJS']),
actions: 'setActive',
target: 'Complete',
},
{
guard: 'statusNeedsIdentifier',
Expand All@@ -470,13 +469,6 @@ export const SignInRouterMachine = setup({
],
},
},
Complete: {
tags: 'route:complete',
entry: 'clearFormErrors',
after: {
5000: 'Start',
},
},
Error: {
tags: 'route:error',
on: {
Expand Down
3 changes: 3 additions & 0 deletions packages/elements/src/internals/machines/sign-in/router.types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import type {
BaseRouterNextEvent,
BaseRouterPrevEvent,
BaseRouterRedirectEvent,
BaseRouterResetEvent,
BaseRouterSetClerkEvent,
BaseRouterStartEvent,
BaseRouterTransferEvent,
Expand DownExpand Up@@ -54,6 +55,7 @@ export type SignInRouterForgotPasswordEvent = { type: 'NAVIGATE.FORGOT_PASSWORD'
export type SignInRouterErrorEvent = BaseRouterErrorEvent;
export type SignInRouterTransferEvent = BaseRouterTransferEvent;
export type SignInRouterRedirectEvent = BaseRouterRedirectEvent;
export type SignInRouterResetEvent = BaseRouterResetEvent;
export type SignInRouterLoadingEvent = BaseRouterLoadingEvent<'start' | 'verifications' | 'reset-password'>;
export type SignInRouterSetClerkEvent = BaseRouterSetClerkEvent;
export type SignInRouterSubmitEvent = { type: 'SUBMIT' };
Expand All@@ -77,6 +79,7 @@ export type SignInRouterEvents =
| SignInRouterErrorEvent
| SignInRouterTransferEvent
| SignInRouterRedirectEvent
| SignInRouterResetEvent
| SignInVerificationFactorUpdateEvent
| SignInRouterLoadingEvent
| SignInRouterSetClerkEvent
Expand Down
37 changes: 15 additions & 22 deletions packages/elements/src/internals/machines/sign-up/router.machine.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { joinURL } from '@clerk/shared/url';
import type { SignUpStatus, VerificationStatus } from '@clerk/types';
import type { NonReducibleUnknown } from 'xstate';
import { and, assign, log, not, or, raise, sendTo, setup, spawnChild } from 'xstate';
import { and, assign, enqueueActions, log, not, or, raise, sendTo, setup, spawnChild } from 'xstate';

import {
ERROR_CODES,
Expand DownExpand Up@@ -59,15 +59,20 @@ export const SignUpRouterMachine = setup({
},
navigateExternal: ({ context }, { path }: { path: string }) => context.router?.push(path),
raiseNext: raise({ type: 'NEXT' }),
setActive({ context, event }, params?: { sessionId?: string; useLastActiveSession?: boolean }) {
const session =
params?.sessionId ||
(params?.useLastActiveSession && context.clerk.client.lastActiveSessionId) ||
((event as SignUpRouterNextEvent)?.resource || context.clerk.client.signUp).createdSessionId;
setActive: (_, params?: { sessionId?: string; useLastActiveSession?: boolean }) =>
enqueueActions(({ enqueue, check, context, event }) => {
if (check('isExampleMode')) return;

const beforeEmit = () => context.router?.push(context.clerk.buildAfterSignUpUrl());
void context.clerk.setActive({ session, beforeEmit });
},
const session =
params?.sessionId ||
(params?.useLastActiveSession && context.clerk.client.lastActiveSessionId) ||
((event as SignUpRouterNextEvent)?.resource || context.clerk.client.signUp).createdSessionId;

const beforeEmit = () => context.router?.push(context.clerk.buildAfterSignUpUrl());
void context.clerk.setActive({ session, beforeEmit });

enqueue.raise({ type: 'RESET' }, { delay: 2000 }); // Reset machine after 2s delay.
}),
setError: assign({
error: (_, { error }: { error?: ClerkElementsError }) => {
if (error) return error;
Expand DownExpand Up@@ -182,6 +187,7 @@ export const SignUpRouterMachine = setup({
},
})),
},
RESET: '.Idle',
},
states: {
Idle: {
Expand DownExpand Up@@ -264,7 +270,6 @@ export const SignUpRouterMachine = setup({
{
guard: 'isStatusComplete',
actions: 'setActive',
target: 'Complete',
},
{
guard: 'statusNeedsVerification',
Expand DownExpand Up@@ -298,7 +303,6 @@ export const SignUpRouterMachine = setup({
{
guard: 'isStatusComplete',
actions: 'setActive',
target: 'Complete',
},
{
guard: 'statusNeedsVerification',
Expand DownExpand Up@@ -329,7 +333,6 @@ export const SignUpRouterMachine = setup({
type: 'setActive',
params: { sessionId: context.router?.searchParams().get(SEARCH_PARAMS.createdSession) },
}),
target: 'Complete',
},
{
guard: { type: 'hasClerkStatus', params: { status: 'verified' } },
Expand All@@ -345,7 +348,6 @@ export const SignUpRouterMachine = setup({
{
guard: 'isStatusComplete',
actions: 'setActive',
target: 'Complete',
},
{
guard: 'statusNeedsContinue',
Expand All@@ -363,13 +365,11 @@ export const SignUpRouterMachine = setup({
{
guard: 'isStatusComplete',
actions: 'setActive',
target: 'Complete',
},
{
description: 'Handle a case where the user has already been authenticated via ClerkJS',
guard: 'hasAuthenticatedViaClerkJS',
actions: { type: 'setActive', params: { useLastActiveSession: true } },
target: 'Complete',
},
{
guard: 'statusNeedsVerification',
Expand All@@ -388,13 +388,6 @@ export const SignUpRouterMachine = setup({
],
},
},
Complete: {
tags: 'route:complete',
entry: 'clearFormErrors',
after: {
5000: 'Start',
},
},
Error: {
tags: 'route:error',
on: {
Expand Down
3 changes: 3 additions & 0 deletions packages/elements/src/internals/machines/sign-up/router.types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import type {
BaseRouterNextEvent,
BaseRouterPrevEvent,
BaseRouterRedirectEvent,
BaseRouterResetEvent,
BaseRouterSetClerkEvent,
BaseRouterStartEvent,
BaseRouterTransferEvent,
Expand DownExpand Up@@ -46,6 +47,7 @@ export type SignUpRouterPrevEvent = BaseRouterPrevEvent;
export type SignUpRouterErrorEvent = BaseRouterErrorEvent;
export type SignUpRouterTransferEvent = BaseRouterTransferEvent;
export type SignUpRouterRedirectEvent = BaseRouterRedirectEvent;
export type SignUpRouterResetEvent = BaseRouterResetEvent;
export type SignUpRouterLoadingEvent = BaseRouterLoadingEvent<'start' | 'verifications' | 'continue'>;
export type SignUpRouterSetClerkEvent = BaseRouterSetClerkEvent;

Expand All@@ -64,6 +66,7 @@ export type SignUpRouterEvents =
| SignUpRouterErrorEvent
| SignUpRouterTransferEvent
| SignUpRouterRedirectEvent
| SignUpRouterResetEvent
| SignUpRouterLoadingEvent
| SignUpRouterSetClerkEvent;

Expand Down
1 change: 1 addition & 0 deletions packages/elements/src/internals/machines/types/router.types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ export type BaseRouterLoadingStep = 'start' | 'verifications' | 'continue' | 're
export type BaseRouterNextEvent<T extends ClerkResource> = { type: 'NEXT'; resource?: T };
export type BaseRouterPrevEvent = { type: 'NAVIGATE.PREVIOUS' };
export type BaseRouterStartEvent = { type: 'NAVIGATE.START' };
export type BaseRouterResetEvent = { type: 'RESET' };
export type BaseRouterErrorEvent = { type: 'ERROR'; error: Error };
export type BaseRouterTransferEvent = { type: 'TRANSFER' };
export type BaseRouterLoadingEvent<TSteps extends BaseRouterLoadingStep> = (
Expand Down
4 changes: 3 additions & 1 deletion packages/elements/src/react/sign-in/root.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,9 @@ function SignInFlowProvider({ children, exampleMode }: SignInFlowProviderProps)
actor.send(evt);
}
});
}, [clerk, exampleMode, formRef, router]);

// eslint-disable-next-line react-hooks/exhaustive-deps
}, [clerk, exampleMode, formRef?.id, !!router]);
Comment thread
tmilewski marked this conversation as resolved.

return <SignInRouterCtx.Provider actorRef={actor}>{children}</SignInRouterCtx.Provider>;
}
Expand Down
2 changes: 1 addition & 1 deletion packages/elements/src/react/sign-in/verifications.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -80,7 +80,7 @@ export function SignInStrategy({ children, name }: SignInStrategyProps) {
}

return () => {
if (factorCtx) {
if (factorCtx?.getSnapshot().status === 'active') {
Comment thread
tmilewski marked this conversation as resolved.
factorCtx.send({ type: 'STRATEGY.UNREGISTER', factor: name as unknown as SignInFactor });
}
};
Expand Down
3 changes: 2 additions & 1 deletion packages/elements/src/react/sign-up/root.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -46,7 +46,8 @@ function SignUpFlowProvider({ children, exampleMode }: SignUpFlowProviderProps)
ref.send(evt);
}
});
}, [clerk, exampleMode, formRef, router]);
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [clerk, exampleMode, formRef?.id, !!router]);

return isReady ? <SignUpRouterCtx.Provider actorRef={ref}>{children}</SignUpRouterCtx.Provider> : null;
}
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
fix(elements): Fix follow-on initialization discrepancies#3377

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

 Merged

tmilewski
merged 4 commits into

from

May 13, 2024
 Merged


fix(elements): Fix follow-on initialization discrepancies
#3377
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
d350e89

fix(elements): Follow-on machine initialization [SDK-1746]


tmilewski May 13, 2024
bf34b2c

chore(elements): Add changeset


tmilewski May 13, 2024
46a460e

chore(elements): Remove unnecessary TS comment


tmilewski May 13, 2024
3d4491b

chore(elements): Add line item to changeset


tmilewski May 13, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


7 changes: 7 additions & 0 deletions
.changeset/odd-coins-carry.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/elements': patch
---

- Bump XState from version 5.12.0 to 5.13.0
- We now maintain your current state while completing authentication redirecting rather than transitioning to a "Complete" step.
- Fixes Sign In and Sign Up machines not appropriately attaching new form machines when returning to the Sign In or Sign Up pages.

8 changes: 4 additions & 4 deletions
package-lock.json

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


2 changes: 1 addition & 1 deletion
packages/elements/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,7 +74,7 @@
 "@statelyai/inspect": "^0.3.0",
 "@xstate/react": "^4.1.1",
 "client-only": "^0.0.1",
 "xstate": "^5.12.0"
 "xstate": "^5.13.0"
 },
 "devDependencies": {
 "@clerk/clerk-react": "5.0.4",
Expand Down

24 changes: 8 additions & 16 deletions
packages/elements/src/internals/machines/sign-in/router.machine.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ import { ClerkElementsError, ClerkElementsRuntimeError } from '~/internals/error
import { ThirdPartyMachine, ThirdPartyMachineId } from '~/internals/machines/third-party';
import { shouldUseVirtualRouting } from '~/internals/machines/utils/next';

import { FormMachine } from '../form';
import { SignInResetPasswordMachine } from './reset-password.machine';
import type {
 SignInRouterContext,
Expand DownExpand Up@@ -41,6 +42,7 @@ export const SignInRouterMachineId = 'SignInRouter';
export const SignInRouterMachine = setup({
 actors: {
 firstFactorMachine: SignInFirstFactorMachine,
 formMachine: FormMachine,
 resetPasswordMachine: SignInResetPasswordMachine,
 startMachine: SignInStartMachine,
 secondFactorMachine: SignInSecondFactorMachine,
Expand All@@ -60,8 +62,8 @@ export const SignInRouterMachine = setup({
 },
 navigateExternal: ({ context }, { path }: { path: string }) => context.router?.push(path),
 raiseNext: raise({ type: 'NEXT' }),
 setActive({ context, event }) {
 if (context.exampleMode) return;
 setActive: enqueueActions(({ enqueue, check, context, event }) => {
 if (check('isExampleMode')) return;

 const lastActiveSessionId = context.clerk.client.lastActiveSessionId;
 const createdSessionId = ((event as SignInRouterNextEvent)?.resource || context.clerk.client.signIn)
Expand All@@ -71,7 +73,9 @@ export const SignInRouterMachine = setup({

 const beforeEmit = () => context.router?.push(context.clerk.buildAfterSignInUrl());
 void context.clerk.setActive({ session, beforeEmit });
 },

 enqueue.raise({ type: 'RESET' }, { delay: 2000 }); // Reset machine after 2s delay.
 }),
 setError: assign({
 error: (_, { error }: { error?: ClerkElementsError }) => {
 if (error) return error;
Expand DownExpand Up@@ -182,6 +186,7 @@ export const SignInRouterMachine = setup({
 },
 })),
 },
 RESET: '.Idle',
 },
 states: {
 Idle: {
Expand DownExpand Up@@ -224,7 +229,6 @@ export const SignInRouterMachine = setup({
 {
 guard: 'isComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'isLoggedInAndSingleSession',
Expand DownExpand Up@@ -285,7 +289,6 @@ export const SignInRouterMachine = setup({
 {
 guard: 'isComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsFirstFactor',
Expand DownExpand Up@@ -323,7 +326,6 @@ export const SignInRouterMachine = setup({
 {
 guard: 'isComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsSecondFactor',
Expand DownExpand Up@@ -390,7 +392,6 @@ export const SignInRouterMachine = setup({
 {
 guard: 'isComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsNewPassword',
Expand DownExpand Up@@ -418,7 +419,6 @@ export const SignInRouterMachine = setup({
 {
 guard: 'isComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsFirstFactor',
Expand DownExpand Up@@ -446,7 +446,6 @@ export const SignInRouterMachine = setup({
 {
 guard: or(['isLoggedIn', 'isComplete', 'hasAuthenticatedViaClerkJS']),
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsIdentifier',
Expand All@@ -470,13 +469,6 @@ export const SignInRouterMachine = setup({
 ],
 },
 },
 Complete: {
 tags: 'route:complete',
 entry: 'clearFormErrors',
 after: {
 5000: 'Start',
 },
 },
 Error: {
 tags: 'route:error',
 on: {
Expand Down

3 changes: 3 additions & 0 deletions
packages/elements/src/internals/machines/sign-in/router.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import type {
 BaseRouterNextEvent,
 BaseRouterPrevEvent,
 BaseRouterRedirectEvent,
 BaseRouterResetEvent,
 BaseRouterSetClerkEvent,
 BaseRouterStartEvent,
 BaseRouterTransferEvent,
Expand DownExpand Up@@ -54,6 +55,7 @@ export type SignInRouterForgotPasswordEvent = { type: 'NAVIGATE.FORGOT_PASSWORD'
export type SignInRouterErrorEvent = BaseRouterErrorEvent;
export type SignInRouterTransferEvent = BaseRouterTransferEvent;
export type SignInRouterRedirectEvent = BaseRouterRedirectEvent;
export type SignInRouterResetEvent = BaseRouterResetEvent;
export type SignInRouterLoadingEvent = BaseRouterLoadingEvent<'start' | 'verifications' | 'reset-password'>;
export type SignInRouterSetClerkEvent = BaseRouterSetClerkEvent;
export type SignInRouterSubmitEvent = { type: 'SUBMIT' };
Expand All@@ -77,6 +79,7 @@ export type SignInRouterEvents =
 | SignInRouterErrorEvent
 | SignInRouterTransferEvent
 | SignInRouterRedirectEvent
 | SignInRouterResetEvent
 | SignInVerificationFactorUpdateEvent
 | SignInRouterLoadingEvent
 | SignInRouterSetClerkEvent
Expand Down

37 changes: 15 additions & 22 deletions
packages/elements/src/internals/machines/sign-up/router.machine.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { joinURL } from '@clerk/shared/url';
import type { SignUpStatus, VerificationStatus } from '@clerk/types';
import type { NonReducibleUnknown } from 'xstate';
import { and, assign, log, not, or, raise, sendTo, setup, spawnChild } from 'xstate';
import { and, assign, enqueueActions, log, not, or, raise, sendTo, setup, spawnChild } from 'xstate';

import {
 ERROR_CODES,
Expand DownExpand Up@@ -59,15 +59,20 @@ export const SignUpRouterMachine = setup({
 },
 navigateExternal: ({ context }, { path }: { path: string }) => context.router?.push(path),
 raiseNext: raise({ type: 'NEXT' }),
 setActive({ context, event }, params?: { sessionId?: string; useLastActiveSession?: boolean }) {
 const session =
 params?.sessionId ||
 (params?.useLastActiveSession && context.clerk.client.lastActiveSessionId) ||
 ((event as SignUpRouterNextEvent)?.resource || context.clerk.client.signUp).createdSessionId;
 setActive: (_, params?: { sessionId?: string; useLastActiveSession?: boolean }) =>
 enqueueActions(({ enqueue, check, context, event }) => {
 if (check('isExampleMode')) return;

 const beforeEmit = () => context.router?.push(context.clerk.buildAfterSignUpUrl());
 void context.clerk.setActive({ session, beforeEmit });
 },
 const session =
 params?.sessionId ||
 (params?.useLastActiveSession && context.clerk.client.lastActiveSessionId) ||
 ((event as SignUpRouterNextEvent)?.resource || context.clerk.client.signUp).createdSessionId;

 const beforeEmit = () => context.router?.push(context.clerk.buildAfterSignUpUrl());
 void context.clerk.setActive({ session, beforeEmit });

 enqueue.raise({ type: 'RESET' }, { delay: 2000 }); // Reset machine after 2s delay.
 }),
 setError: assign({
 error: (_, { error }: { error?: ClerkElementsError }) => {
 if (error) return error;
Expand DownExpand Up@@ -182,6 +187,7 @@ export const SignUpRouterMachine = setup({
 },
 })),
 },
 RESET: '.Idle',
 },
 states: {
 Idle: {
Expand DownExpand Up@@ -264,7 +270,6 @@ export const SignUpRouterMachine = setup({
 {
 guard: 'isStatusComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsVerification',
Expand DownExpand Up@@ -298,7 +303,6 @@ export const SignUpRouterMachine = setup({
 {
 guard: 'isStatusComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsVerification',
Expand DownExpand Up@@ -329,7 +333,6 @@ export const SignUpRouterMachine = setup({
 type: 'setActive',
 params: { sessionId: context.router?.searchParams().get(SEARCH_PARAMS.createdSession) },
 }),
 target: 'Complete',
 },
 {
 guard: { type: 'hasClerkStatus', params: { status: 'verified' } },
Expand All@@ -345,7 +348,6 @@ export const SignUpRouterMachine = setup({
 {
 guard: 'isStatusComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsContinue',
Expand All@@ -363,13 +365,11 @@ export const SignUpRouterMachine = setup({
 {
 guard: 'isStatusComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 description: 'Handle a case where the user has already been authenticated via ClerkJS',
 guard: 'hasAuthenticatedViaClerkJS',
 actions: { type: 'setActive', params: { useLastActiveSession: true } },
 target: 'Complete',
 },
 {
 guard: 'statusNeedsVerification',
Expand All@@ -388,13 +388,6 @@ export const SignUpRouterMachine = setup({
 ],
 },
 },
 Complete: {
 tags: 'route:complete',
 entry: 'clearFormErrors',
 after: {
 5000: 'Start',
 },
 },
 Error: {
 tags: 'route:error',
 on: {
Expand Down

3 changes: 3 additions & 0 deletions
packages/elements/src/internals/machines/sign-up/router.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import type {
 BaseRouterNextEvent,
 BaseRouterPrevEvent,
 BaseRouterRedirectEvent,
 BaseRouterResetEvent,
 BaseRouterSetClerkEvent,
 BaseRouterStartEvent,
 BaseRouterTransferEvent,
Expand DownExpand Up@@ -46,6 +47,7 @@ export type SignUpRouterPrevEvent = BaseRouterPrevEvent;
export type SignUpRouterErrorEvent = BaseRouterErrorEvent;
export type SignUpRouterTransferEvent = BaseRouterTransferEvent;
export type SignUpRouterRedirectEvent = BaseRouterRedirectEvent;
export type SignUpRouterResetEvent = BaseRouterResetEvent;
export type SignUpRouterLoadingEvent = BaseRouterLoadingEvent<'start' | 'verifications' | 'continue'>;
export type SignUpRouterSetClerkEvent = BaseRouterSetClerkEvent;

Expand All@@ -64,6 +66,7 @@ export type SignUpRouterEvents =
 | SignUpRouterErrorEvent
 | SignUpRouterTransferEvent
 | SignUpRouterRedirectEvent
 | SignUpRouterResetEvent
 | SignUpRouterLoadingEvent
 | SignUpRouterSetClerkEvent;

Expand Down

1 change: 1 addition & 0 deletions
packages/elements/src/internals/machines/types/router.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ export type BaseRouterLoadingStep = 'start' | 'verifications' | 'continue' | 're
export type BaseRouterNextEvent<T extends ClerkResource> = { type: 'NEXT'; resource?: T };
export type BaseRouterPrevEvent = { type: 'NAVIGATE.PREVIOUS' };
export type BaseRouterStartEvent = { type: 'NAVIGATE.START' };
export type BaseRouterResetEvent = { type: 'RESET' };
export type BaseRouterErrorEvent = { type: 'ERROR'; error: Error };
export type BaseRouterTransferEvent = { type: 'TRANSFER' };
export type BaseRouterLoadingEvent<TSteps extends BaseRouterLoadingStep> = (
Expand Down

4 changes: 3 additions & 1 deletion
packages/elements/src/react/sign-in/root.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,9 @@ function SignInFlowProvider({ children, exampleMode }: SignInFlowProviderProps)
 actor.send(evt);
 }
 });
 }, [clerk, exampleMode, formRef, router]);

 // eslint-disable-next-line react-hooks/exhaustive-deps
 }, [clerk, exampleMode, formRef?.id, !!router]);
Comment thread
tmilewski marked this conversation as resolved.


 return <SignInRouterCtx.Provider actorRef={actor}>{children}</SignInRouterCtx.Provider>;
}
Expand Down

2 changes: 1 addition & 1 deletion
packages/elements/src/react/sign-in/verifications.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -80,7 +80,7 @@ export function SignInStrategy({ children, name }: SignInStrategyProps) {
 }

 return () => {
 if (factorCtx) {
 if (factorCtx?.getSnapshot().status === 'active') {
Comment thread
tmilewski marked this conversation as resolved.

 factorCtx.send({ type: 'STRATEGY.UNREGISTER', factor: name as unknown as SignInFactor });
 }
 };
Expand Down

3 changes: 2 additions & 1 deletion
packages/elements/src/react/sign-up/root.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,7 +46,8 @@ function SignUpFlowProvider({ children, exampleMode }: SignUpFlowProviderProps)
 ref.send(evt);
 }
 });
 }, [clerk, exampleMode, formRef, router]);
 // eslint-disable-next-line react-hooks/exhaustive-deps
 }, [clerk, exampleMode, formRef?.id, !!router]);

 return isReady ? <SignUpRouterCtx.Provider actorRef={ref}>{children}</SignUpRouterCtx.Provider> : null;
}
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(elements): Fix follow-on initialization discrepancies#3377

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

 Merged

tmilewski
merged 4 commits into

from

May 13, 2024
 Merged


fix(elements): Fix follow-on initialization discrepancies
#3377
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
d350e89

fix(elements): Follow-on machine initialization [SDK-1746]


tmilewski May 13, 2024
bf34b2c

chore(elements): Add changeset


tmilewski May 13, 2024
46a460e

chore(elements): Remove unnecessary TS comment


tmilewski May 13, 2024
3d4491b

chore(elements): Add line item to changeset


tmilewski May 13, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


7 changes: 7 additions & 0 deletions
.changeset/odd-coins-carry.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/elements': patch
---

- Bump XState from version 5.12.0 to 5.13.0
- We now maintain your current state while completing authentication redirecting rather than transitioning to a "Complete" step.
- Fixes Sign In and Sign Up machines not appropriately attaching new form machines when returning to the Sign In or Sign Up pages.

8 changes: 4 additions & 4 deletions
package-lock.json

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


2 changes: 1 addition & 1 deletion
packages/elements/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,7 +74,7 @@
 "@statelyai/inspect": "^0.3.0",
 "@xstate/react": "^4.1.1",
 "client-only": "^0.0.1",
 "xstate": "^5.12.0"
 "xstate": "^5.13.0"
 },
 "devDependencies": {
 "@clerk/clerk-react": "5.0.4",
Expand Down

24 changes: 8 additions & 16 deletions
packages/elements/src/internals/machines/sign-in/router.machine.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ import { ClerkElementsError, ClerkElementsRuntimeError } from '~/internals/error
import { ThirdPartyMachine, ThirdPartyMachineId } from '~/internals/machines/third-party';
import { shouldUseVirtualRouting } from '~/internals/machines/utils/next';

import { FormMachine } from '../form';
import { SignInResetPasswordMachine } from './reset-password.machine';
import type {
 SignInRouterContext,
Expand DownExpand Up@@ -41,6 +42,7 @@ export const SignInRouterMachineId = 'SignInRouter';
export const SignInRouterMachine = setup({
 actors: {
 firstFactorMachine: SignInFirstFactorMachine,
 formMachine: FormMachine,
 resetPasswordMachine: SignInResetPasswordMachine,
 startMachine: SignInStartMachine,
 secondFactorMachine: SignInSecondFactorMachine,
Expand All@@ -60,8 +62,8 @@ export const SignInRouterMachine = setup({
 },
 navigateExternal: ({ context }, { path }: { path: string }) => context.router?.push(path),
 raiseNext: raise({ type: 'NEXT' }),
 setActive({ context, event }) {
 if (context.exampleMode) return;
 setActive: enqueueActions(({ enqueue, check, context, event }) => {
 if (check('isExampleMode')) return;

 const lastActiveSessionId = context.clerk.client.lastActiveSessionId;
 const createdSessionId = ((event as SignInRouterNextEvent)?.resource || context.clerk.client.signIn)
Expand All@@ -71,7 +73,9 @@ export const SignInRouterMachine = setup({

 const beforeEmit = () => context.router?.push(context.clerk.buildAfterSignInUrl());
 void context.clerk.setActive({ session, beforeEmit });
 },

 enqueue.raise({ type: 'RESET' }, { delay: 2000 }); // Reset machine after 2s delay.
 }),
 setError: assign({
 error: (_, { error }: { error?: ClerkElementsError }) => {
 if (error) return error;
Expand DownExpand Up@@ -182,6 +186,7 @@ export const SignInRouterMachine = setup({
 },
 })),
 },
 RESET: '.Idle',
 },
 states: {
 Idle: {
Expand DownExpand Up@@ -224,7 +229,6 @@ export const SignInRouterMachine = setup({
 {
 guard: 'isComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'isLoggedInAndSingleSession',
Expand DownExpand Up@@ -285,7 +289,6 @@ export const SignInRouterMachine = setup({
 {
 guard: 'isComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsFirstFactor',
Expand DownExpand Up@@ -323,7 +326,6 @@ export const SignInRouterMachine = setup({
 {
 guard: 'isComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsSecondFactor',
Expand DownExpand Up@@ -390,7 +392,6 @@ export const SignInRouterMachine = setup({
 {
 guard: 'isComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsNewPassword',
Expand DownExpand Up@@ -418,7 +419,6 @@ export const SignInRouterMachine = setup({
 {
 guard: 'isComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsFirstFactor',
Expand DownExpand Up@@ -446,7 +446,6 @@ export const SignInRouterMachine = setup({
 {
 guard: or(['isLoggedIn', 'isComplete', 'hasAuthenticatedViaClerkJS']),
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsIdentifier',
Expand All@@ -470,13 +469,6 @@ export const SignInRouterMachine = setup({
 ],
 },
 },
 Complete: {
 tags: 'route:complete',
 entry: 'clearFormErrors',
 after: {
 5000: 'Start',
 },
 },
 Error: {
 tags: 'route:error',
 on: {
Expand Down

3 changes: 3 additions & 0 deletions
packages/elements/src/internals/machines/sign-in/router.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import type {
 BaseRouterNextEvent,
 BaseRouterPrevEvent,
 BaseRouterRedirectEvent,
 BaseRouterResetEvent,
 BaseRouterSetClerkEvent,
 BaseRouterStartEvent,
 BaseRouterTransferEvent,
Expand DownExpand Up@@ -54,6 +55,7 @@ export type SignInRouterForgotPasswordEvent = { type: 'NAVIGATE.FORGOT_PASSWORD'
export type SignInRouterErrorEvent = BaseRouterErrorEvent;
export type SignInRouterTransferEvent = BaseRouterTransferEvent;
export type SignInRouterRedirectEvent = BaseRouterRedirectEvent;
export type SignInRouterResetEvent = BaseRouterResetEvent;
export type SignInRouterLoadingEvent = BaseRouterLoadingEvent<'start' | 'verifications' | 'reset-password'>;
export type SignInRouterSetClerkEvent = BaseRouterSetClerkEvent;
export type SignInRouterSubmitEvent = { type: 'SUBMIT' };
Expand All@@ -77,6 +79,7 @@ export type SignInRouterEvents =
 | SignInRouterErrorEvent
 | SignInRouterTransferEvent
 | SignInRouterRedirectEvent
 | SignInRouterResetEvent
 | SignInVerificationFactorUpdateEvent
 | SignInRouterLoadingEvent
 | SignInRouterSetClerkEvent
Expand Down

37 changes: 15 additions & 22 deletions
packages/elements/src/internals/machines/sign-up/router.machine.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { joinURL } from '@clerk/shared/url';
import type { SignUpStatus, VerificationStatus } from '@clerk/types';
import type { NonReducibleUnknown } from 'xstate';
import { and, assign, log, not, or, raise, sendTo, setup, spawnChild } from 'xstate';
import { and, assign, enqueueActions, log, not, or, raise, sendTo, setup, spawnChild } from 'xstate';

import {
 ERROR_CODES,
Expand DownExpand Up@@ -59,15 +59,20 @@ export const SignUpRouterMachine = setup({
 },
 navigateExternal: ({ context }, { path }: { path: string }) => context.router?.push(path),
 raiseNext: raise({ type: 'NEXT' }),
 setActive({ context, event }, params?: { sessionId?: string; useLastActiveSession?: boolean }) {
 const session =
 params?.sessionId ||
 (params?.useLastActiveSession && context.clerk.client.lastActiveSessionId) ||
 ((event as SignUpRouterNextEvent)?.resource || context.clerk.client.signUp).createdSessionId;
 setActive: (_, params?: { sessionId?: string; useLastActiveSession?: boolean }) =>
 enqueueActions(({ enqueue, check, context, event }) => {
 if (check('isExampleMode')) return;

 const beforeEmit = () => context.router?.push(context.clerk.buildAfterSignUpUrl());
 void context.clerk.setActive({ session, beforeEmit });
 },
 const session =
 params?.sessionId ||
 (params?.useLastActiveSession && context.clerk.client.lastActiveSessionId) ||
 ((event as SignUpRouterNextEvent)?.resource || context.clerk.client.signUp).createdSessionId;

 const beforeEmit = () => context.router?.push(context.clerk.buildAfterSignUpUrl());
 void context.clerk.setActive({ session, beforeEmit });

 enqueue.raise({ type: 'RESET' }, { delay: 2000 }); // Reset machine after 2s delay.
 }),
 setError: assign({
 error: (_, { error }: { error?: ClerkElementsError }) => {
 if (error) return error;
Expand DownExpand Up@@ -182,6 +187,7 @@ export const SignUpRouterMachine = setup({
 },
 })),
 },
 RESET: '.Idle',
 },
 states: {
 Idle: {
Expand DownExpand Up@@ -264,7 +270,6 @@ export const SignUpRouterMachine = setup({
 {
 guard: 'isStatusComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsVerification',
Expand DownExpand Up@@ -298,7 +303,6 @@ export const SignUpRouterMachine = setup({
 {
 guard: 'isStatusComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsVerification',
Expand DownExpand Up@@ -329,7 +333,6 @@ export const SignUpRouterMachine = setup({
 type: 'setActive',
 params: { sessionId: context.router?.searchParams().get(SEARCH_PARAMS.createdSession) },
 }),
 target: 'Complete',
 },
 {
 guard: { type: 'hasClerkStatus', params: { status: 'verified' } },
Expand All@@ -345,7 +348,6 @@ export const SignUpRouterMachine = setup({
 {
 guard: 'isStatusComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsContinue',
Expand All@@ -363,13 +365,11 @@ export const SignUpRouterMachine = setup({
 {
 guard: 'isStatusComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 description: 'Handle a case where the user has already been authenticated via ClerkJS',
 guard: 'hasAuthenticatedViaClerkJS',
 actions: { type: 'setActive', params: { useLastActiveSession: true } },
 target: 'Complete',
 },
 {
 guard: 'statusNeedsVerification',
Expand All@@ -388,13 +388,6 @@ export const SignUpRouterMachine = setup({
 ],
 },
 },
 Complete: {
 tags: 'route:complete',
 entry: 'clearFormErrors',
 after: {
 5000: 'Start',
 },
 },
 Error: {
 tags: 'route:error',
 on: {
Expand Down

3 changes: 3 additions & 0 deletions
packages/elements/src/internals/machines/sign-up/router.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import type {
 BaseRouterNextEvent,
 BaseRouterPrevEvent,
 BaseRouterRedirectEvent,
 BaseRouterResetEvent,
 BaseRouterSetClerkEvent,
 BaseRouterStartEvent,
 BaseRouterTransferEvent,
Expand DownExpand Up@@ -46,6 +47,7 @@ export type SignUpRouterPrevEvent = BaseRouterPrevEvent;
export type SignUpRouterErrorEvent = BaseRouterErrorEvent;
export type SignUpRouterTransferEvent = BaseRouterTransferEvent;
export type SignUpRouterRedirectEvent = BaseRouterRedirectEvent;
export type SignUpRouterResetEvent = BaseRouterResetEvent;
export type SignUpRouterLoadingEvent = BaseRouterLoadingEvent<'start' | 'verifications' | 'continue'>;
export type SignUpRouterSetClerkEvent = BaseRouterSetClerkEvent;

Expand All@@ -64,6 +66,7 @@ export type SignUpRouterEvents =
 | SignUpRouterErrorEvent
 | SignUpRouterTransferEvent
 | SignUpRouterRedirectEvent
 | SignUpRouterResetEvent
 | SignUpRouterLoadingEvent
 | SignUpRouterSetClerkEvent;

Expand Down

1 change: 1 addition & 0 deletions
packages/elements/src/internals/machines/types/router.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ export type BaseRouterLoadingStep = 'start' | 'verifications' | 'continue' | 're
export type BaseRouterNextEvent<T extends ClerkResource> = { type: 'NEXT'; resource?: T };
export type BaseRouterPrevEvent = { type: 'NAVIGATE.PREVIOUS' };
export type BaseRouterStartEvent = { type: 'NAVIGATE.START' };
export type BaseRouterResetEvent = { type: 'RESET' };
export type BaseRouterErrorEvent = { type: 'ERROR'; error: Error };
export type BaseRouterTransferEvent = { type: 'TRANSFER' };
export type BaseRouterLoadingEvent<TSteps extends BaseRouterLoadingStep> = (
Expand Down

4 changes: 3 additions & 1 deletion
packages/elements/src/react/sign-in/root.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,9 @@ function SignInFlowProvider({ children, exampleMode }: SignInFlowProviderProps)
 actor.send(evt);
 }
 });
 }, [clerk, exampleMode, formRef, router]);

 // eslint-disable-next-line react-hooks/exhaustive-deps
 }, [clerk, exampleMode, formRef?.id, !!router]);
Comment thread
tmilewski marked this conversation as resolved.


 return <SignInRouterCtx.Provider actorRef={actor}>{children}</SignInRouterCtx.Provider>;
}
Expand Down

2 changes: 1 addition & 1 deletion
packages/elements/src/react/sign-in/verifications.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -80,7 +80,7 @@ export function SignInStrategy({ children, name }: SignInStrategyProps) {
 }

 return () => {
 if (factorCtx) {
 if (factorCtx?.getSnapshot().status === 'active') {
Comment thread
tmilewski marked this conversation as resolved.

 factorCtx.send({ type: 'STRATEGY.UNREGISTER', factor: name as unknown as SignInFactor });
 }
 };
Expand Down

3 changes: 2 additions & 1 deletion
packages/elements/src/react/sign-up/root.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,7 +46,8 @@ function SignUpFlowProvider({ children, exampleMode }: SignUpFlowProviderProps)
 ref.send(evt);
 }
 });
 }, [clerk, exampleMode, formRef, router]);
 // eslint-disable-next-line react-hooks/exhaustive-deps
 }, [clerk, exampleMode, formRef?.id, !!router]);

 return isReady ? <SignUpRouterCtx.Provider actorRef={ref}>{children}</SignUpRouterCtx.Provider> : null;
}
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(elements): Fix follow-on initialization discrepancies#3377

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

 Merged

tmilewski
merged 4 commits into

from

May 13, 2024
 Merged


fix(elements): Fix follow-on initialization discrepancies
#3377
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
d350e89

fix(elements): Follow-on machine initialization [SDK-1746]


tmilewski May 13, 2024
bf34b2c

chore(elements): Add changeset


tmilewski May 13, 2024
46a460e

chore(elements): Remove unnecessary TS comment


tmilewski May 13, 2024
3d4491b

chore(elements): Add line item to changeset


tmilewski May 13, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


7 changes: 7 additions & 0 deletions
.changeset/odd-coins-carry.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/elements': patch
---

- Bump XState from version 5.12.0 to 5.13.0
- We now maintain your current state while completing authentication redirecting rather than transitioning to a "Complete" step.
- Fixes Sign In and Sign Up machines not appropriately attaching new form machines when returning to the Sign In or Sign Up pages.

8 changes: 4 additions & 4 deletions
package-lock.json

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


2 changes: 1 addition & 1 deletion
packages/elements/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,7 +74,7 @@
 "@statelyai/inspect": "^0.3.0",
 "@xstate/react": "^4.1.1",
 "client-only": "^0.0.1",
 "xstate": "^5.12.0"
 "xstate": "^5.13.0"
 },
 "devDependencies": {
 "@clerk/clerk-react": "5.0.4",
Expand Down

24 changes: 8 additions & 16 deletions
packages/elements/src/internals/machines/sign-in/router.machine.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ import { ClerkElementsError, ClerkElementsRuntimeError } from '~/internals/error
import { ThirdPartyMachine, ThirdPartyMachineId } from '~/internals/machines/third-party';
import { shouldUseVirtualRouting } from '~/internals/machines/utils/next';

import { FormMachine } from '../form';
import { SignInResetPasswordMachine } from './reset-password.machine';
import type {
 SignInRouterContext,
Expand DownExpand Up@@ -41,6 +42,7 @@ export const SignInRouterMachineId = 'SignInRouter';
export const SignInRouterMachine = setup({
 actors: {
 firstFactorMachine: SignInFirstFactorMachine,
 formMachine: FormMachine,
 resetPasswordMachine: SignInResetPasswordMachine,
 startMachine: SignInStartMachine,
 secondFactorMachine: SignInSecondFactorMachine,
Expand All@@ -60,8 +62,8 @@ export const SignInRouterMachine = setup({
 },
 navigateExternal: ({ context }, { path }: { path: string }) => context.router?.push(path),
 raiseNext: raise({ type: 'NEXT' }),
 setActive({ context, event }) {
 if (context.exampleMode) return;
 setActive: enqueueActions(({ enqueue, check, context, event }) => {
 if (check('isExampleMode')) return;

 const lastActiveSessionId = context.clerk.client.lastActiveSessionId;
 const createdSessionId = ((event as SignInRouterNextEvent)?.resource || context.clerk.client.signIn)
Expand All@@ -71,7 +73,9 @@ export const SignInRouterMachine = setup({

 const beforeEmit = () => context.router?.push(context.clerk.buildAfterSignInUrl());
 void context.clerk.setActive({ session, beforeEmit });
 },

 enqueue.raise({ type: 'RESET' }, { delay: 2000 }); // Reset machine after 2s delay.
 }),
 setError: assign({
 error: (_, { error }: { error?: ClerkElementsError }) => {
 if (error) return error;
Expand DownExpand Up@@ -182,6 +186,7 @@ export const SignInRouterMachine = setup({
 },
 })),
 },
 RESET: '.Idle',
 },
 states: {
 Idle: {
Expand DownExpand Up@@ -224,7 +229,6 @@ export const SignInRouterMachine = setup({
 {
 guard: 'isComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'isLoggedInAndSingleSession',
Expand DownExpand Up@@ -285,7 +289,6 @@ export const SignInRouterMachine = setup({
 {
 guard: 'isComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsFirstFactor',
Expand DownExpand Up@@ -323,7 +326,6 @@ export const SignInRouterMachine = setup({
 {
 guard: 'isComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsSecondFactor',
Expand DownExpand Up@@ -390,7 +392,6 @@ export const SignInRouterMachine = setup({
 {
 guard: 'isComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsNewPassword',
Expand DownExpand Up@@ -418,7 +419,6 @@ export const SignInRouterMachine = setup({
 {
 guard: 'isComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsFirstFactor',
Expand DownExpand Up@@ -446,7 +446,6 @@ export const SignInRouterMachine = setup({
 {
 guard: or(['isLoggedIn', 'isComplete', 'hasAuthenticatedViaClerkJS']),
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsIdentifier',
Expand All@@ -470,13 +469,6 @@ export const SignInRouterMachine = setup({
 ],
 },
 },
 Complete: {
 tags: 'route:complete',
 entry: 'clearFormErrors',
 after: {
 5000: 'Start',
 },
 },
 Error: {
 tags: 'route:error',
 on: {
Expand Down

3 changes: 3 additions & 0 deletions
packages/elements/src/internals/machines/sign-in/router.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import type {
 BaseRouterNextEvent,
 BaseRouterPrevEvent,
 BaseRouterRedirectEvent,
 BaseRouterResetEvent,
 BaseRouterSetClerkEvent,
 BaseRouterStartEvent,
 BaseRouterTransferEvent,
Expand DownExpand Up@@ -54,6 +55,7 @@ export type SignInRouterForgotPasswordEvent = { type: 'NAVIGATE.FORGOT_PASSWORD'
export type SignInRouterErrorEvent = BaseRouterErrorEvent;
export type SignInRouterTransferEvent = BaseRouterTransferEvent;
export type SignInRouterRedirectEvent = BaseRouterRedirectEvent;
export type SignInRouterResetEvent = BaseRouterResetEvent;
export type SignInRouterLoadingEvent = BaseRouterLoadingEvent<'start' | 'verifications' | 'reset-password'>;
export type SignInRouterSetClerkEvent = BaseRouterSetClerkEvent;
export type SignInRouterSubmitEvent = { type: 'SUBMIT' };
Expand All@@ -77,6 +79,7 @@ export type SignInRouterEvents =
 | SignInRouterErrorEvent
 | SignInRouterTransferEvent
 | SignInRouterRedirectEvent
 | SignInRouterResetEvent
 | SignInVerificationFactorUpdateEvent
 | SignInRouterLoadingEvent
 | SignInRouterSetClerkEvent
Expand Down

37 changes: 15 additions & 22 deletions
packages/elements/src/internals/machines/sign-up/router.machine.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { joinURL } from '@clerk/shared/url';
import type { SignUpStatus, VerificationStatus } from '@clerk/types';
import type { NonReducibleUnknown } from 'xstate';
import { and, assign, log, not, or, raise, sendTo, setup, spawnChild } from 'xstate';
import { and, assign, enqueueActions, log, not, or, raise, sendTo, setup, spawnChild } from 'xstate';

import {
 ERROR_CODES,
Expand DownExpand Up@@ -59,15 +59,20 @@ export const SignUpRouterMachine = setup({
 },
 navigateExternal: ({ context }, { path }: { path: string }) => context.router?.push(path),
 raiseNext: raise({ type: 'NEXT' }),
 setActive({ context, event }, params?: { sessionId?: string; useLastActiveSession?: boolean }) {
 const session =
 params?.sessionId ||
 (params?.useLastActiveSession && context.clerk.client.lastActiveSessionId) ||
 ((event as SignUpRouterNextEvent)?.resource || context.clerk.client.signUp).createdSessionId;
 setActive: (_, params?: { sessionId?: string; useLastActiveSession?: boolean }) =>
 enqueueActions(({ enqueue, check, context, event }) => {
 if (check('isExampleMode')) return;

 const beforeEmit = () => context.router?.push(context.clerk.buildAfterSignUpUrl());
 void context.clerk.setActive({ session, beforeEmit });
 },
 const session =
 params?.sessionId ||
 (params?.useLastActiveSession && context.clerk.client.lastActiveSessionId) ||
 ((event as SignUpRouterNextEvent)?.resource || context.clerk.client.signUp).createdSessionId;

 const beforeEmit = () => context.router?.push(context.clerk.buildAfterSignUpUrl());
 void context.clerk.setActive({ session, beforeEmit });

 enqueue.raise({ type: 'RESET' }, { delay: 2000 }); // Reset machine after 2s delay.
 }),
 setError: assign({
 error: (_, { error }: { error?: ClerkElementsError }) => {
 if (error) return error;
Expand DownExpand Up@@ -182,6 +187,7 @@ export const SignUpRouterMachine = setup({
 },
 })),
 },
 RESET: '.Idle',
 },
 states: {
 Idle: {
Expand DownExpand Up@@ -264,7 +270,6 @@ export const SignUpRouterMachine = setup({
 {
 guard: 'isStatusComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsVerification',
Expand DownExpand Up@@ -298,7 +303,6 @@ export const SignUpRouterMachine = setup({
 {
 guard: 'isStatusComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsVerification',
Expand DownExpand Up@@ -329,7 +333,6 @@ export const SignUpRouterMachine = setup({
 type: 'setActive',
 params: { sessionId: context.router?.searchParams().get(SEARCH_PARAMS.createdSession) },
 }),
 target: 'Complete',
 },
 {
 guard: { type: 'hasClerkStatus', params: { status: 'verified' } },
Expand All@@ -345,7 +348,6 @@ export const SignUpRouterMachine = setup({
 {
 guard: 'isStatusComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsContinue',
Expand All@@ -363,13 +365,11 @@ export const SignUpRouterMachine = setup({
 {
 guard: 'isStatusComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 description: 'Handle a case where the user has already been authenticated via ClerkJS',
 guard: 'hasAuthenticatedViaClerkJS',
 actions: { type: 'setActive', params: { useLastActiveSession: true } },
 target: 'Complete',
 },
 {
 guard: 'statusNeedsVerification',
Expand All@@ -388,13 +388,6 @@ export const SignUpRouterMachine = setup({
 ],
 },
 },
 Complete: {
 tags: 'route:complete',
 entry: 'clearFormErrors',
 after: {
 5000: 'Start',
 },
 },
 Error: {
 tags: 'route:error',
 on: {
Expand Down

3 changes: 3 additions & 0 deletions
packages/elements/src/internals/machines/sign-up/router.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import type {
 BaseRouterNextEvent,
 BaseRouterPrevEvent,
 BaseRouterRedirectEvent,
 BaseRouterResetEvent,
 BaseRouterSetClerkEvent,
 BaseRouterStartEvent,
 BaseRouterTransferEvent,
Expand DownExpand Up@@ -46,6 +47,7 @@ export type SignUpRouterPrevEvent = BaseRouterPrevEvent;
export type SignUpRouterErrorEvent = BaseRouterErrorEvent;
export type SignUpRouterTransferEvent = BaseRouterTransferEvent;
export type SignUpRouterRedirectEvent = BaseRouterRedirectEvent;
export type SignUpRouterResetEvent = BaseRouterResetEvent;
export type SignUpRouterLoadingEvent = BaseRouterLoadingEvent<'start' | 'verifications' | 'continue'>;
export type SignUpRouterSetClerkEvent = BaseRouterSetClerkEvent;

Expand All@@ -64,6 +66,7 @@ export type SignUpRouterEvents =
 | SignUpRouterErrorEvent
 | SignUpRouterTransferEvent
 | SignUpRouterRedirectEvent
 | SignUpRouterResetEvent
 | SignUpRouterLoadingEvent
 | SignUpRouterSetClerkEvent;

Expand Down

1 change: 1 addition & 0 deletions
packages/elements/src/internals/machines/types/router.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ export type BaseRouterLoadingStep = 'start' | 'verifications' | 'continue' | 're
export type BaseRouterNextEvent<T extends ClerkResource> = { type: 'NEXT'; resource?: T };
export type BaseRouterPrevEvent = { type: 'NAVIGATE.PREVIOUS' };
export type BaseRouterStartEvent = { type: 'NAVIGATE.START' };
export type BaseRouterResetEvent = { type: 'RESET' };
export type BaseRouterErrorEvent = { type: 'ERROR'; error: Error };
export type BaseRouterTransferEvent = { type: 'TRANSFER' };
export type BaseRouterLoadingEvent<TSteps extends BaseRouterLoadingStep> = (
Expand Down

4 changes: 3 additions & 1 deletion
packages/elements/src/react/sign-in/root.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,9 @@ function SignInFlowProvider({ children, exampleMode }: SignInFlowProviderProps)
 actor.send(evt);
 }
 });
 }, [clerk, exampleMode, formRef, router]);

 // eslint-disable-next-line react-hooks/exhaustive-deps
 }, [clerk, exampleMode, formRef?.id, !!router]);
Comment thread
tmilewski marked this conversation as resolved.


 return <SignInRouterCtx.Provider actorRef={actor}>{children}</SignInRouterCtx.Provider>;
}
Expand Down

2 changes: 1 addition & 1 deletion
packages/elements/src/react/sign-in/verifications.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -80,7 +80,7 @@ export function SignInStrategy({ children, name }: SignInStrategyProps) {
 }

 return () => {
 if (factorCtx) {
 if (factorCtx?.getSnapshot().status === 'active') {
Comment thread
tmilewski marked this conversation as resolved.

 factorCtx.send({ type: 'STRATEGY.UNREGISTER', factor: name as unknown as SignInFactor });
 }
 };
Expand Down

3 changes: 2 additions & 1 deletion
packages/elements/src/react/sign-up/root.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,7 +46,8 @@ function SignUpFlowProvider({ children, exampleMode }: SignUpFlowProviderProps)
 ref.send(evt);
 }
 });
 }, [clerk, exampleMode, formRef, router]);
 // eslint-disable-next-line react-hooks/exhaustive-deps
 }, [clerk, exampleMode, formRef?.id, !!router]);

 return isReady ? <SignUpRouterCtx.Provider actorRef={ref}>{children}</SignUpRouterCtx.Provider> : null;
}
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
fix(elements): Fix follow-on initialization discrepancies#3377

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

 Merged

tmilewski
merged 4 commits into

from

May 13, 2024
 Merged


fix(elements): Fix follow-on initialization discrepancies
#3377
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
d350e89

fix(elements): Follow-on machine initialization [SDK-1746]


tmilewski May 13, 2024
bf34b2c

chore(elements): Add changeset


tmilewski May 13, 2024
46a460e

chore(elements): Remove unnecessary TS comment


tmilewski May 13, 2024
3d4491b

chore(elements): Add line item to changeset


tmilewski May 13, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


7 changes: 7 additions & 0 deletions
.changeset/odd-coins-carry.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/elements': patch
---

- Bump XState from version 5.12.0 to 5.13.0
- We now maintain your current state while completing authentication redirecting rather than transitioning to a "Complete" step.
- Fixes Sign In and Sign Up machines not appropriately attaching new form machines when returning to the Sign In or Sign Up pages.

8 changes: 4 additions & 4 deletions
package-lock.json

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


2 changes: 1 addition & 1 deletion
packages/elements/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,7 +74,7 @@
 "@statelyai/inspect": "^0.3.0",
 "@xstate/react": "^4.1.1",
 "client-only": "^0.0.1",
 "xstate": "^5.12.0"
 "xstate": "^5.13.0"
 },
 "devDependencies": {
 "@clerk/clerk-react": "5.0.4",
Expand Down

24 changes: 8 additions & 16 deletions
packages/elements/src/internals/machines/sign-in/router.machine.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ import { ClerkElementsError, ClerkElementsRuntimeError } from '~/internals/error
import { ThirdPartyMachine, ThirdPartyMachineId } from '~/internals/machines/third-party';
import { shouldUseVirtualRouting } from '~/internals/machines/utils/next';

import { FormMachine } from '../form';
import { SignInResetPasswordMachine } from './reset-password.machine';
import type {
 SignInRouterContext,
Expand DownExpand Up@@ -41,6 +42,7 @@ export const SignInRouterMachineId = 'SignInRouter';
export const SignInRouterMachine = setup({
 actors: {
 firstFactorMachine: SignInFirstFactorMachine,
 formMachine: FormMachine,
 resetPasswordMachine: SignInResetPasswordMachine,
 startMachine: SignInStartMachine,
 secondFactorMachine: SignInSecondFactorMachine,
Expand All@@ -60,8 +62,8 @@ export const SignInRouterMachine = setup({
 },
 navigateExternal: ({ context }, { path }: { path: string }) => context.router?.push(path),
 raiseNext: raise({ type: 'NEXT' }),
 setActive({ context, event }) {
 if (context.exampleMode) return;
 setActive: enqueueActions(({ enqueue, check, context, event }) => {
 if (check('isExampleMode')) return;

 const lastActiveSessionId = context.clerk.client.lastActiveSessionId;
 const createdSessionId = ((event as SignInRouterNextEvent)?.resource || context.clerk.client.signIn)
Expand All@@ -71,7 +73,9 @@ export const SignInRouterMachine = setup({

 const beforeEmit = () => context.router?.push(context.clerk.buildAfterSignInUrl());
 void context.clerk.setActive({ session, beforeEmit });
 },

 enqueue.raise({ type: 'RESET' }, { delay: 2000 }); // Reset machine after 2s delay.
 }),
 setError: assign({
 error: (_, { error }: { error?: ClerkElementsError }) => {
 if (error) return error;
Expand DownExpand Up@@ -182,6 +186,7 @@ export const SignInRouterMachine = setup({
 },
 })),
 },
 RESET: '.Idle',
 },
 states: {
 Idle: {
Expand DownExpand Up@@ -224,7 +229,6 @@ export const SignInRouterMachine = setup({
 {
 guard: 'isComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'isLoggedInAndSingleSession',
Expand DownExpand Up@@ -285,7 +289,6 @@ export const SignInRouterMachine = setup({
 {
 guard: 'isComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsFirstFactor',
Expand DownExpand Up@@ -323,7 +326,6 @@ export const SignInRouterMachine = setup({
 {
 guard: 'isComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsSecondFactor',
Expand DownExpand Up@@ -390,7 +392,6 @@ export const SignInRouterMachine = setup({
 {
 guard: 'isComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsNewPassword',
Expand DownExpand Up@@ -418,7 +419,6 @@ export const SignInRouterMachine = setup({
 {
 guard: 'isComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsFirstFactor',
Expand DownExpand Up@@ -446,7 +446,6 @@ export const SignInRouterMachine = setup({
 {
 guard: or(['isLoggedIn', 'isComplete', 'hasAuthenticatedViaClerkJS']),
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsIdentifier',
Expand All@@ -470,13 +469,6 @@ export const SignInRouterMachine = setup({
 ],
 },
 },
 Complete: {
 tags: 'route:complete',
 entry: 'clearFormErrors',
 after: {
 5000: 'Start',
 },
 },
 Error: {
 tags: 'route:error',
 on: {
Expand Down

3 changes: 3 additions & 0 deletions
packages/elements/src/internals/machines/sign-in/router.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import type {
 BaseRouterNextEvent,
 BaseRouterPrevEvent,
 BaseRouterRedirectEvent,
 BaseRouterResetEvent,
 BaseRouterSetClerkEvent,
 BaseRouterStartEvent,
 BaseRouterTransferEvent,
Expand DownExpand Up@@ -54,6 +55,7 @@ export type SignInRouterForgotPasswordEvent = { type: 'NAVIGATE.FORGOT_PASSWORD'
export type SignInRouterErrorEvent = BaseRouterErrorEvent;
export type SignInRouterTransferEvent = BaseRouterTransferEvent;
export type SignInRouterRedirectEvent = BaseRouterRedirectEvent;
export type SignInRouterResetEvent = BaseRouterResetEvent;
export type SignInRouterLoadingEvent = BaseRouterLoadingEvent<'start' | 'verifications' | 'reset-password'>;
export type SignInRouterSetClerkEvent = BaseRouterSetClerkEvent;
export type SignInRouterSubmitEvent = { type: 'SUBMIT' };
Expand All@@ -77,6 +79,7 @@ export type SignInRouterEvents =
 | SignInRouterErrorEvent
 | SignInRouterTransferEvent
 | SignInRouterRedirectEvent
 | SignInRouterResetEvent
 | SignInVerificationFactorUpdateEvent
 | SignInRouterLoadingEvent
 | SignInRouterSetClerkEvent
Expand Down

37 changes: 15 additions & 22 deletions
packages/elements/src/internals/machines/sign-up/router.machine.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { joinURL } from '@clerk/shared/url';
import type { SignUpStatus, VerificationStatus } from '@clerk/types';
import type { NonReducibleUnknown } from 'xstate';
import { and, assign, log, not, or, raise, sendTo, setup, spawnChild } from 'xstate';
import { and, assign, enqueueActions, log, not, or, raise, sendTo, setup, spawnChild } from 'xstate';

import {
 ERROR_CODES,
Expand DownExpand Up@@ -59,15 +59,20 @@ export const SignUpRouterMachine = setup({
 },
 navigateExternal: ({ context }, { path }: { path: string }) => context.router?.push(path),
 raiseNext: raise({ type: 'NEXT' }),
 setActive({ context, event }, params?: { sessionId?: string; useLastActiveSession?: boolean }) {
 const session =
 params?.sessionId ||
 (params?.useLastActiveSession && context.clerk.client.lastActiveSessionId) ||
 ((event as SignUpRouterNextEvent)?.resource || context.clerk.client.signUp).createdSessionId;
 setActive: (_, params?: { sessionId?: string; useLastActiveSession?: boolean }) =>
 enqueueActions(({ enqueue, check, context, event }) => {
 if (check('isExampleMode')) return;

 const beforeEmit = () => context.router?.push(context.clerk.buildAfterSignUpUrl());
 void context.clerk.setActive({ session, beforeEmit });
 },
 const session =
 params?.sessionId ||
 (params?.useLastActiveSession && context.clerk.client.lastActiveSessionId) ||
 ((event as SignUpRouterNextEvent)?.resource || context.clerk.client.signUp).createdSessionId;

 const beforeEmit = () => context.router?.push(context.clerk.buildAfterSignUpUrl());
 void context.clerk.setActive({ session, beforeEmit });

 enqueue.raise({ type: 'RESET' }, { delay: 2000 }); // Reset machine after 2s delay.
 }),
 setError: assign({
 error: (_, { error }: { error?: ClerkElementsError }) => {
 if (error) return error;
Expand DownExpand Up@@ -182,6 +187,7 @@ export const SignUpRouterMachine = setup({
 },
 })),
 },
 RESET: '.Idle',
 },
 states: {
 Idle: {
Expand DownExpand Up@@ -264,7 +270,6 @@ export const SignUpRouterMachine = setup({
 {
 guard: 'isStatusComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsVerification',
Expand DownExpand Up@@ -298,7 +303,6 @@ export const SignUpRouterMachine = setup({
 {
 guard: 'isStatusComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsVerification',
Expand DownExpand Up@@ -329,7 +333,6 @@ export const SignUpRouterMachine = setup({
 type: 'setActive',
 params: { sessionId: context.router?.searchParams().get(SEARCH_PARAMS.createdSession) },
 }),
 target: 'Complete',
 },
 {
 guard: { type: 'hasClerkStatus', params: { status: 'verified' } },
Expand All@@ -345,7 +348,6 @@ export const SignUpRouterMachine = setup({
 {
 guard: 'isStatusComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsContinue',
Expand All@@ -363,13 +365,11 @@ export const SignUpRouterMachine = setup({
 {
 guard: 'isStatusComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 description: 'Handle a case where the user has already been authenticated via ClerkJS',
 guard: 'hasAuthenticatedViaClerkJS',
 actions: { type: 'setActive', params: { useLastActiveSession: true } },
 target: 'Complete',
 },
 {
 guard: 'statusNeedsVerification',
Expand All@@ -388,13 +388,6 @@ export const SignUpRouterMachine = setup({
 ],
 },
 },
 Complete: {
 tags: 'route:complete',
 entry: 'clearFormErrors',
 after: {
 5000: 'Start',
 },
 },
 Error: {
 tags: 'route:error',
 on: {
Expand Down

3 changes: 3 additions & 0 deletions
packages/elements/src/internals/machines/sign-up/router.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import type {
 BaseRouterNextEvent,
 BaseRouterPrevEvent,
 BaseRouterRedirectEvent,
 BaseRouterResetEvent,
 BaseRouterSetClerkEvent,
 BaseRouterStartEvent,
 BaseRouterTransferEvent,
Expand DownExpand Up@@ -46,6 +47,7 @@ export type SignUpRouterPrevEvent = BaseRouterPrevEvent;
export type SignUpRouterErrorEvent = BaseRouterErrorEvent;
export type SignUpRouterTransferEvent = BaseRouterTransferEvent;
export type SignUpRouterRedirectEvent = BaseRouterRedirectEvent;
export type SignUpRouterResetEvent = BaseRouterResetEvent;
export type SignUpRouterLoadingEvent = BaseRouterLoadingEvent<'start' | 'verifications' | 'continue'>;
export type SignUpRouterSetClerkEvent = BaseRouterSetClerkEvent;

Expand All@@ -64,6 +66,7 @@ export type SignUpRouterEvents =
 | SignUpRouterErrorEvent
 | SignUpRouterTransferEvent
 | SignUpRouterRedirectEvent
 | SignUpRouterResetEvent
 | SignUpRouterLoadingEvent
 | SignUpRouterSetClerkEvent;

Expand Down

1 change: 1 addition & 0 deletions
packages/elements/src/internals/machines/types/router.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ export type BaseRouterLoadingStep = 'start' | 'verifications' | 'continue' | 're
export type BaseRouterNextEvent<T extends ClerkResource> = { type: 'NEXT'; resource?: T };
export type BaseRouterPrevEvent = { type: 'NAVIGATE.PREVIOUS' };
export type BaseRouterStartEvent = { type: 'NAVIGATE.START' };
export type BaseRouterResetEvent = { type: 'RESET' };
export type BaseRouterErrorEvent = { type: 'ERROR'; error: Error };
export type BaseRouterTransferEvent = { type: 'TRANSFER' };
export type BaseRouterLoadingEvent<TSteps extends BaseRouterLoadingStep> = (
Expand Down

4 changes: 3 additions & 1 deletion
packages/elements/src/react/sign-in/root.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,9 @@ function SignInFlowProvider({ children, exampleMode }: SignInFlowProviderProps)
 actor.send(evt);
 }
 });
 }, [clerk, exampleMode, formRef, router]);

 // eslint-disable-next-line react-hooks/exhaustive-deps
 }, [clerk, exampleMode, formRef?.id, !!router]);
Comment thread
tmilewski marked this conversation as resolved.


 return <SignInRouterCtx.Provider actorRef={actor}>{children}</SignInRouterCtx.Provider>;
}
Expand Down

2 changes: 1 addition & 1 deletion
packages/elements/src/react/sign-in/verifications.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -80,7 +80,7 @@ export function SignInStrategy({ children, name }: SignInStrategyProps) {
 }

 return () => {
 if (factorCtx) {
 if (factorCtx?.getSnapshot().status === 'active') {
Comment thread
tmilewski marked this conversation as resolved.

 factorCtx.send({ type: 'STRATEGY.UNREGISTER', factor: name as unknown as SignInFactor });
 }
 };
Expand Down

3 changes: 2 additions & 1 deletion
packages/elements/src/react/sign-up/root.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,7 +46,8 @@ function SignUpFlowProvider({ children, exampleMode }: SignUpFlowProviderProps)
 ref.send(evt);
 }
 });
 }, [clerk, exampleMode, formRef, router]);
 // eslint-disable-next-line react-hooks/exhaustive-deps
 }, [clerk, exampleMode, formRef?.id, !!router]);

 return isReady ? <SignUpRouterCtx.Provider actorRef={ref}>{children}</SignUpRouterCtx.Provider> : null;
}
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(elements): Fix follow-on initialization discrepancies#3377

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

 Merged

tmilewski
merged 4 commits into

from

May 13, 2024
 Merged


fix(elements): Fix follow-on initialization discrepancies
#3377
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
d350e89

fix(elements): Follow-on machine initialization [SDK-1746]


tmilewski May 13, 2024
bf34b2c

chore(elements): Add changeset


tmilewski May 13, 2024
46a460e

chore(elements): Remove unnecessary TS comment


tmilewski May 13, 2024
3d4491b

chore(elements): Add line item to changeset


tmilewski May 13, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


7 changes: 7 additions & 0 deletions
.changeset/odd-coins-carry.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/elements': patch
---

- Bump XState from version 5.12.0 to 5.13.0
- We now maintain your current state while completing authentication redirecting rather than transitioning to a "Complete" step.
- Fixes Sign In and Sign Up machines not appropriately attaching new form machines when returning to the Sign In or Sign Up pages.

8 changes: 4 additions & 4 deletions
package-lock.json

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


2 changes: 1 addition & 1 deletion
packages/elements/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,7 +74,7 @@
 "@statelyai/inspect": "^0.3.0",
 "@xstate/react": "^4.1.1",
 "client-only": "^0.0.1",
 "xstate": "^5.12.0"
 "xstate": "^5.13.0"
 },
 "devDependencies": {
 "@clerk/clerk-react": "5.0.4",
Expand Down

24 changes: 8 additions & 16 deletions
packages/elements/src/internals/machines/sign-in/router.machine.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ import { ClerkElementsError, ClerkElementsRuntimeError } from '~/internals/error
import { ThirdPartyMachine, ThirdPartyMachineId } from '~/internals/machines/third-party';
import { shouldUseVirtualRouting } from '~/internals/machines/utils/next';

import { FormMachine } from '../form';
import { SignInResetPasswordMachine } from './reset-password.machine';
import type {
 SignInRouterContext,
Expand DownExpand Up@@ -41,6 +42,7 @@ export const SignInRouterMachineId = 'SignInRouter';
export const SignInRouterMachine = setup({
 actors: {
 firstFactorMachine: SignInFirstFactorMachine,
 formMachine: FormMachine,
 resetPasswordMachine: SignInResetPasswordMachine,
 startMachine: SignInStartMachine,
 secondFactorMachine: SignInSecondFactorMachine,
Expand All@@ -60,8 +62,8 @@ export const SignInRouterMachine = setup({
 },
 navigateExternal: ({ context }, { path }: { path: string }) => context.router?.push(path),
 raiseNext: raise({ type: 'NEXT' }),
 setActive({ context, event }) {
 if (context.exampleMode) return;
 setActive: enqueueActions(({ enqueue, check, context, event }) => {
 if (check('isExampleMode')) return;

 const lastActiveSessionId = context.clerk.client.lastActiveSessionId;
 const createdSessionId = ((event as SignInRouterNextEvent)?.resource || context.clerk.client.signIn)
Expand All@@ -71,7 +73,9 @@ export const SignInRouterMachine = setup({

 const beforeEmit = () => context.router?.push(context.clerk.buildAfterSignInUrl());
 void context.clerk.setActive({ session, beforeEmit });
 },

 enqueue.raise({ type: 'RESET' }, { delay: 2000 }); // Reset machine after 2s delay.
 }),
 setError: assign({
 error: (_, { error }: { error?: ClerkElementsError }) => {
 if (error) return error;
Expand DownExpand Up@@ -182,6 +186,7 @@ export const SignInRouterMachine = setup({
 },
 })),
 },
 RESET: '.Idle',
 },
 states: {
 Idle: {
Expand DownExpand Up@@ -224,7 +229,6 @@ export const SignInRouterMachine = setup({
 {
 guard: 'isComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'isLoggedInAndSingleSession',
Expand DownExpand Up@@ -285,7 +289,6 @@ export const SignInRouterMachine = setup({
 {
 guard: 'isComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsFirstFactor',
Expand DownExpand Up@@ -323,7 +326,6 @@ export const SignInRouterMachine = setup({
 {
 guard: 'isComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsSecondFactor',
Expand DownExpand Up@@ -390,7 +392,6 @@ export const SignInRouterMachine = setup({
 {
 guard: 'isComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsNewPassword',
Expand DownExpand Up@@ -418,7 +419,6 @@ export const SignInRouterMachine = setup({
 {
 guard: 'isComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsFirstFactor',
Expand DownExpand Up@@ -446,7 +446,6 @@ export const SignInRouterMachine = setup({
 {
 guard: or(['isLoggedIn', 'isComplete', 'hasAuthenticatedViaClerkJS']),
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsIdentifier',
Expand All@@ -470,13 +469,6 @@ export const SignInRouterMachine = setup({
 ],
 },
 },
 Complete: {
 tags: 'route:complete',
 entry: 'clearFormErrors',
 after: {
 5000: 'Start',
 },
 },
 Error: {
 tags: 'route:error',
 on: {
Expand Down

3 changes: 3 additions & 0 deletions
packages/elements/src/internals/machines/sign-in/router.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import type {
 BaseRouterNextEvent,
 BaseRouterPrevEvent,
 BaseRouterRedirectEvent,
 BaseRouterResetEvent,
 BaseRouterSetClerkEvent,
 BaseRouterStartEvent,
 BaseRouterTransferEvent,
Expand DownExpand Up@@ -54,6 +55,7 @@ export type SignInRouterForgotPasswordEvent = { type: 'NAVIGATE.FORGOT_PASSWORD'
export type SignInRouterErrorEvent = BaseRouterErrorEvent;
export type SignInRouterTransferEvent = BaseRouterTransferEvent;
export type SignInRouterRedirectEvent = BaseRouterRedirectEvent;
export type SignInRouterResetEvent = BaseRouterResetEvent;
export type SignInRouterLoadingEvent = BaseRouterLoadingEvent<'start' | 'verifications' | 'reset-password'>;
export type SignInRouterSetClerkEvent = BaseRouterSetClerkEvent;
export type SignInRouterSubmitEvent = { type: 'SUBMIT' };
Expand All@@ -77,6 +79,7 @@ export type SignInRouterEvents =
 | SignInRouterErrorEvent
 | SignInRouterTransferEvent
 | SignInRouterRedirectEvent
 | SignInRouterResetEvent
 | SignInVerificationFactorUpdateEvent
 | SignInRouterLoadingEvent
 | SignInRouterSetClerkEvent
Expand Down

37 changes: 15 additions & 22 deletions
packages/elements/src/internals/machines/sign-up/router.machine.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { joinURL } from '@clerk/shared/url';
import type { SignUpStatus, VerificationStatus } from '@clerk/types';
import type { NonReducibleUnknown } from 'xstate';
import { and, assign, log, not, or, raise, sendTo, setup, spawnChild } from 'xstate';
import { and, assign, enqueueActions, log, not, or, raise, sendTo, setup, spawnChild } from 'xstate';

import {
 ERROR_CODES,
Expand DownExpand Up@@ -59,15 +59,20 @@ export const SignUpRouterMachine = setup({
 },
 navigateExternal: ({ context }, { path }: { path: string }) => context.router?.push(path),
 raiseNext: raise({ type: 'NEXT' }),
 setActive({ context, event }, params?: { sessionId?: string; useLastActiveSession?: boolean }) {
 const session =
 params?.sessionId ||
 (params?.useLastActiveSession && context.clerk.client.lastActiveSessionId) ||
 ((event as SignUpRouterNextEvent)?.resource || context.clerk.client.signUp).createdSessionId;
 setActive: (_, params?: { sessionId?: string; useLastActiveSession?: boolean }) =>
 enqueueActions(({ enqueue, check, context, event }) => {
 if (check('isExampleMode')) return;

 const beforeEmit = () => context.router?.push(context.clerk.buildAfterSignUpUrl());
 void context.clerk.setActive({ session, beforeEmit });
 },
 const session =
 params?.sessionId ||
 (params?.useLastActiveSession && context.clerk.client.lastActiveSessionId) ||
 ((event as SignUpRouterNextEvent)?.resource || context.clerk.client.signUp).createdSessionId;

 const beforeEmit = () => context.router?.push(context.clerk.buildAfterSignUpUrl());
 void context.clerk.setActive({ session, beforeEmit });

 enqueue.raise({ type: 'RESET' }, { delay: 2000 }); // Reset machine after 2s delay.
 }),
 setError: assign({
 error: (_, { error }: { error?: ClerkElementsError }) => {
 if (error) return error;
Expand DownExpand Up@@ -182,6 +187,7 @@ export const SignUpRouterMachine = setup({
 },
 })),
 },
 RESET: '.Idle',
 },
 states: {
 Idle: {
Expand DownExpand Up@@ -264,7 +270,6 @@ export const SignUpRouterMachine = setup({
 {
 guard: 'isStatusComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsVerification',
Expand DownExpand Up@@ -298,7 +303,6 @@ export const SignUpRouterMachine = setup({
 {
 guard: 'isStatusComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsVerification',
Expand DownExpand Up@@ -329,7 +333,6 @@ export const SignUpRouterMachine = setup({
 type: 'setActive',
 params: { sessionId: context.router?.searchParams().get(SEARCH_PARAMS.createdSession) },
 }),
 target: 'Complete',
 },
 {
 guard: { type: 'hasClerkStatus', params: { status: 'verified' } },
Expand All@@ -345,7 +348,6 @@ export const SignUpRouterMachine = setup({
 {
 guard: 'isStatusComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsContinue',
Expand All@@ -363,13 +365,11 @@ export const SignUpRouterMachine = setup({
 {
 guard: 'isStatusComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 description: 'Handle a case where the user has already been authenticated via ClerkJS',
 guard: 'hasAuthenticatedViaClerkJS',
 actions: { type: 'setActive', params: { useLastActiveSession: true } },
 target: 'Complete',
 },
 {
 guard: 'statusNeedsVerification',
Expand All@@ -388,13 +388,6 @@ export const SignUpRouterMachine = setup({
 ],
 },
 },
 Complete: {
 tags: 'route:complete',
 entry: 'clearFormErrors',
 after: {
 5000: 'Start',
 },
 },
 Error: {
 tags: 'route:error',
 on: {
Expand Down

3 changes: 3 additions & 0 deletions
packages/elements/src/internals/machines/sign-up/router.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import type {
 BaseRouterNextEvent,
 BaseRouterPrevEvent,
 BaseRouterRedirectEvent,
 BaseRouterResetEvent,
 BaseRouterSetClerkEvent,
 BaseRouterStartEvent,
 BaseRouterTransferEvent,
Expand DownExpand Up@@ -46,6 +47,7 @@ export type SignUpRouterPrevEvent = BaseRouterPrevEvent;
export type SignUpRouterErrorEvent = BaseRouterErrorEvent;
export type SignUpRouterTransferEvent = BaseRouterTransferEvent;
export type SignUpRouterRedirectEvent = BaseRouterRedirectEvent;
export type SignUpRouterResetEvent = BaseRouterResetEvent;
export type SignUpRouterLoadingEvent = BaseRouterLoadingEvent<'start' | 'verifications' | 'continue'>;
export type SignUpRouterSetClerkEvent = BaseRouterSetClerkEvent;

Expand All@@ -64,6 +66,7 @@ export type SignUpRouterEvents =
 | SignUpRouterErrorEvent
 | SignUpRouterTransferEvent
 | SignUpRouterRedirectEvent
 | SignUpRouterResetEvent
 | SignUpRouterLoadingEvent
 | SignUpRouterSetClerkEvent;

Expand Down

1 change: 1 addition & 0 deletions
packages/elements/src/internals/machines/types/router.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ export type BaseRouterLoadingStep = 'start' | 'verifications' | 'continue' | 're
export type BaseRouterNextEvent<T extends ClerkResource> = { type: 'NEXT'; resource?: T };
export type BaseRouterPrevEvent = { type: 'NAVIGATE.PREVIOUS' };
export type BaseRouterStartEvent = { type: 'NAVIGATE.START' };
export type BaseRouterResetEvent = { type: 'RESET' };
export type BaseRouterErrorEvent = { type: 'ERROR'; error: Error };
export type BaseRouterTransferEvent = { type: 'TRANSFER' };
export type BaseRouterLoadingEvent<TSteps extends BaseRouterLoadingStep> = (
Expand Down

4 changes: 3 additions & 1 deletion
packages/elements/src/react/sign-in/root.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,9 @@ function SignInFlowProvider({ children, exampleMode }: SignInFlowProviderProps)
 actor.send(evt);
 }
 });
 }, [clerk, exampleMode, formRef, router]);

 // eslint-disable-next-line react-hooks/exhaustive-deps
 }, [clerk, exampleMode, formRef?.id, !!router]);
Comment thread
tmilewski marked this conversation as resolved.


 return <SignInRouterCtx.Provider actorRef={actor}>{children}</SignInRouterCtx.Provider>;
}
Expand Down

2 changes: 1 addition & 1 deletion
packages/elements/src/react/sign-in/verifications.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -80,7 +80,7 @@ export function SignInStrategy({ children, name }: SignInStrategyProps) {
 }

 return () => {
 if (factorCtx) {
 if (factorCtx?.getSnapshot().status === 'active') {
Comment thread
tmilewski marked this conversation as resolved.

 factorCtx.send({ type: 'STRATEGY.UNREGISTER', factor: name as unknown as SignInFactor });
 }
 };
Expand Down

3 changes: 2 additions & 1 deletion
packages/elements/src/react/sign-up/root.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,7 +46,8 @@ function SignUpFlowProvider({ children, exampleMode }: SignUpFlowProviderProps)
 ref.send(evt);
 }
 });
 }, [clerk, exampleMode, formRef, router]);
 // eslint-disable-next-line react-hooks/exhaustive-deps
 }, [clerk, exampleMode, formRef?.id, !!router]);

 return isReady ? <SignUpRouterCtx.Provider actorRef={ref}>{children}</SignUpRouterCtx.Provider> : null;
}
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(elements): Fix follow-on initialization discrepancies#3377

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

 Merged

tmilewski
merged 4 commits into

from

May 13, 2024
 Merged


fix(elements): Fix follow-on initialization discrepancies
#3377
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
d350e89

fix(elements): Follow-on machine initialization [SDK-1746]


tmilewski May 13, 2024
bf34b2c

chore(elements): Add changeset


tmilewski May 13, 2024
46a460e

chore(elements): Remove unnecessary TS comment


tmilewski May 13, 2024
3d4491b

chore(elements): Add line item to changeset


tmilewski May 13, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


7 changes: 7 additions & 0 deletions
.changeset/odd-coins-carry.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/elements': patch
---

- Bump XState from version 5.12.0 to 5.13.0
- We now maintain your current state while completing authentication redirecting rather than transitioning to a "Complete" step.
- Fixes Sign In and Sign Up machines not appropriately attaching new form machines when returning to the Sign In or Sign Up pages.

8 changes: 4 additions & 4 deletions
package-lock.json

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


2 changes: 1 addition & 1 deletion
packages/elements/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,7 +74,7 @@
 "@statelyai/inspect": "^0.3.0",
 "@xstate/react": "^4.1.1",
 "client-only": "^0.0.1",
 "xstate": "^5.12.0"
 "xstate": "^5.13.0"
 },
 "devDependencies": {
 "@clerk/clerk-react": "5.0.4",
Expand Down

24 changes: 8 additions & 16 deletions
packages/elements/src/internals/machines/sign-in/router.machine.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ import { ClerkElementsError, ClerkElementsRuntimeError } from '~/internals/error
import { ThirdPartyMachine, ThirdPartyMachineId } from '~/internals/machines/third-party';
import { shouldUseVirtualRouting } from '~/internals/machines/utils/next';

import { FormMachine } from '../form';
import { SignInResetPasswordMachine } from './reset-password.machine';
import type {
 SignInRouterContext,
Expand DownExpand Up@@ -41,6 +42,7 @@ export const SignInRouterMachineId = 'SignInRouter';
export const SignInRouterMachine = setup({
 actors: {
 firstFactorMachine: SignInFirstFactorMachine,
 formMachine: FormMachine,
 resetPasswordMachine: SignInResetPasswordMachine,
 startMachine: SignInStartMachine,
 secondFactorMachine: SignInSecondFactorMachine,
Expand All@@ -60,8 +62,8 @@ export const SignInRouterMachine = setup({
 },
 navigateExternal: ({ context }, { path }: { path: string }) => context.router?.push(path),
 raiseNext: raise({ type: 'NEXT' }),
 setActive({ context, event }) {
 if (context.exampleMode) return;
 setActive: enqueueActions(({ enqueue, check, context, event }) => {
 if (check('isExampleMode')) return;

 const lastActiveSessionId = context.clerk.client.lastActiveSessionId;
 const createdSessionId = ((event as SignInRouterNextEvent)?.resource || context.clerk.client.signIn)
Expand All@@ -71,7 +73,9 @@ export const SignInRouterMachine = setup({

 const beforeEmit = () => context.router?.push(context.clerk.buildAfterSignInUrl());
 void context.clerk.setActive({ session, beforeEmit });
 },

 enqueue.raise({ type: 'RESET' }, { delay: 2000 }); // Reset machine after 2s delay.
 }),
 setError: assign({
 error: (_, { error }: { error?: ClerkElementsError }) => {
 if (error) return error;
Expand DownExpand Up@@ -182,6 +186,7 @@ export const SignInRouterMachine = setup({
 },
 })),
 },
 RESET: '.Idle',
 },
 states: {
 Idle: {
Expand DownExpand Up@@ -224,7 +229,6 @@ export const SignInRouterMachine = setup({
 {
 guard: 'isComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'isLoggedInAndSingleSession',
Expand DownExpand Up@@ -285,7 +289,6 @@ export const SignInRouterMachine = setup({
 {
 guard: 'isComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsFirstFactor',
Expand DownExpand Up@@ -323,7 +326,6 @@ export const SignInRouterMachine = setup({
 {
 guard: 'isComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsSecondFactor',
Expand DownExpand Up@@ -390,7 +392,6 @@ export const SignInRouterMachine = setup({
 {
 guard: 'isComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsNewPassword',
Expand DownExpand Up@@ -418,7 +419,6 @@ export const SignInRouterMachine = setup({
 {
 guard: 'isComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsFirstFactor',
Expand DownExpand Up@@ -446,7 +446,6 @@ export const SignInRouterMachine = setup({
 {
 guard: or(['isLoggedIn', 'isComplete', 'hasAuthenticatedViaClerkJS']),
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsIdentifier',
Expand All@@ -470,13 +469,6 @@ export const SignInRouterMachine = setup({
 ],
 },
 },
 Complete: {
 tags: 'route:complete',
 entry: 'clearFormErrors',
 after: {
 5000: 'Start',
 },
 },
 Error: {
 tags: 'route:error',
 on: {
Expand Down

3 changes: 3 additions & 0 deletions
packages/elements/src/internals/machines/sign-in/router.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import type {
 BaseRouterNextEvent,
 BaseRouterPrevEvent,
 BaseRouterRedirectEvent,
 BaseRouterResetEvent,
 BaseRouterSetClerkEvent,
 BaseRouterStartEvent,
 BaseRouterTransferEvent,
Expand DownExpand Up@@ -54,6 +55,7 @@ export type SignInRouterForgotPasswordEvent = { type: 'NAVIGATE.FORGOT_PASSWORD'
export type SignInRouterErrorEvent = BaseRouterErrorEvent;
export type SignInRouterTransferEvent = BaseRouterTransferEvent;
export type SignInRouterRedirectEvent = BaseRouterRedirectEvent;
export type SignInRouterResetEvent = BaseRouterResetEvent;
export type SignInRouterLoadingEvent = BaseRouterLoadingEvent<'start' | 'verifications' | 'reset-password'>;
export type SignInRouterSetClerkEvent = BaseRouterSetClerkEvent;
export type SignInRouterSubmitEvent = { type: 'SUBMIT' };
Expand All@@ -77,6 +79,7 @@ export type SignInRouterEvents =
 | SignInRouterErrorEvent
 | SignInRouterTransferEvent
 | SignInRouterRedirectEvent
 | SignInRouterResetEvent
 | SignInVerificationFactorUpdateEvent
 | SignInRouterLoadingEvent
 | SignInRouterSetClerkEvent
Expand Down

37 changes: 15 additions & 22 deletions
packages/elements/src/internals/machines/sign-up/router.machine.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { joinURL } from '@clerk/shared/url';
import type { SignUpStatus, VerificationStatus } from '@clerk/types';
import type { NonReducibleUnknown } from 'xstate';
import { and, assign, log, not, or, raise, sendTo, setup, spawnChild } from 'xstate';
import { and, assign, enqueueActions, log, not, or, raise, sendTo, setup, spawnChild } from 'xstate';

import {
 ERROR_CODES,
Expand DownExpand Up@@ -59,15 +59,20 @@ export const SignUpRouterMachine = setup({
 },
 navigateExternal: ({ context }, { path }: { path: string }) => context.router?.push(path),
 raiseNext: raise({ type: 'NEXT' }),
 setActive({ context, event }, params?: { sessionId?: string; useLastActiveSession?: boolean }) {
 const session =
 params?.sessionId ||
 (params?.useLastActiveSession && context.clerk.client.lastActiveSessionId) ||
 ((event as SignUpRouterNextEvent)?.resource || context.clerk.client.signUp).createdSessionId;
 setActive: (_, params?: { sessionId?: string; useLastActiveSession?: boolean }) =>
 enqueueActions(({ enqueue, check, context, event }) => {
 if (check('isExampleMode')) return;

 const beforeEmit = () => context.router?.push(context.clerk.buildAfterSignUpUrl());
 void context.clerk.setActive({ session, beforeEmit });
 },
 const session =
 params?.sessionId ||
 (params?.useLastActiveSession && context.clerk.client.lastActiveSessionId) ||
 ((event as SignUpRouterNextEvent)?.resource || context.clerk.client.signUp).createdSessionId;

 const beforeEmit = () => context.router?.push(context.clerk.buildAfterSignUpUrl());
 void context.clerk.setActive({ session, beforeEmit });

 enqueue.raise({ type: 'RESET' }, { delay: 2000 }); // Reset machine after 2s delay.
 }),
 setError: assign({
 error: (_, { error }: { error?: ClerkElementsError }) => {
 if (error) return error;
Expand DownExpand Up@@ -182,6 +187,7 @@ export const SignUpRouterMachine = setup({
 },
 })),
 },
 RESET: '.Idle',
 },
 states: {
 Idle: {
Expand DownExpand Up@@ -264,7 +270,6 @@ export const SignUpRouterMachine = setup({
 {
 guard: 'isStatusComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsVerification',
Expand DownExpand Up@@ -298,7 +303,6 @@ export const SignUpRouterMachine = setup({
 {
 guard: 'isStatusComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsVerification',
Expand DownExpand Up@@ -329,7 +333,6 @@ export const SignUpRouterMachine = setup({
 type: 'setActive',
 params: { sessionId: context.router?.searchParams().get(SEARCH_PARAMS.createdSession) },
 }),
 target: 'Complete',
 },
 {
 guard: { type: 'hasClerkStatus', params: { status: 'verified' } },
Expand All@@ -345,7 +348,6 @@ export const SignUpRouterMachine = setup({
 {
 guard: 'isStatusComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsContinue',
Expand All@@ -363,13 +365,11 @@ export const SignUpRouterMachine = setup({
 {
 guard: 'isStatusComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 description: 'Handle a case where the user has already been authenticated via ClerkJS',
 guard: 'hasAuthenticatedViaClerkJS',
 actions: { type: 'setActive', params: { useLastActiveSession: true } },
 target: 'Complete',
 },
 {
 guard: 'statusNeedsVerification',
Expand All@@ -388,13 +388,6 @@ export const SignUpRouterMachine = setup({
 ],
 },
 },
 Complete: {
 tags: 'route:complete',
 entry: 'clearFormErrors',
 after: {
 5000: 'Start',
 },
 },
 Error: {
 tags: 'route:error',
 on: {
Expand Down

3 changes: 3 additions & 0 deletions
packages/elements/src/internals/machines/sign-up/router.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import type {
 BaseRouterNextEvent,
 BaseRouterPrevEvent,
 BaseRouterRedirectEvent,
 BaseRouterResetEvent,
 BaseRouterSetClerkEvent,
 BaseRouterStartEvent,
 BaseRouterTransferEvent,
Expand DownExpand Up@@ -46,6 +47,7 @@ export type SignUpRouterPrevEvent = BaseRouterPrevEvent;
export type SignUpRouterErrorEvent = BaseRouterErrorEvent;
export type SignUpRouterTransferEvent = BaseRouterTransferEvent;
export type SignUpRouterRedirectEvent = BaseRouterRedirectEvent;
export type SignUpRouterResetEvent = BaseRouterResetEvent;
export type SignUpRouterLoadingEvent = BaseRouterLoadingEvent<'start' | 'verifications' | 'continue'>;
export type SignUpRouterSetClerkEvent = BaseRouterSetClerkEvent;

Expand All@@ -64,6 +66,7 @@ export type SignUpRouterEvents =
 | SignUpRouterErrorEvent
 | SignUpRouterTransferEvent
 | SignUpRouterRedirectEvent
 | SignUpRouterResetEvent
 | SignUpRouterLoadingEvent
 | SignUpRouterSetClerkEvent;

Expand Down

1 change: 1 addition & 0 deletions
packages/elements/src/internals/machines/types/router.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ export type BaseRouterLoadingStep = 'start' | 'verifications' | 'continue' | 're
export type BaseRouterNextEvent<T extends ClerkResource> = { type: 'NEXT'; resource?: T };
export type BaseRouterPrevEvent = { type: 'NAVIGATE.PREVIOUS' };
export type BaseRouterStartEvent = { type: 'NAVIGATE.START' };
export type BaseRouterResetEvent = { type: 'RESET' };
export type BaseRouterErrorEvent = { type: 'ERROR'; error: Error };
export type BaseRouterTransferEvent = { type: 'TRANSFER' };
export type BaseRouterLoadingEvent<TSteps extends BaseRouterLoadingStep> = (
Expand Down

4 changes: 3 additions & 1 deletion
packages/elements/src/react/sign-in/root.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,9 @@ function SignInFlowProvider({ children, exampleMode }: SignInFlowProviderProps)
 actor.send(evt);
 }
 });
 }, [clerk, exampleMode, formRef, router]);

 // eslint-disable-next-line react-hooks/exhaustive-deps
 }, [clerk, exampleMode, formRef?.id, !!router]);
Comment thread
tmilewski marked this conversation as resolved.


 return <SignInRouterCtx.Provider actorRef={actor}>{children}</SignInRouterCtx.Provider>;
}
Expand Down

2 changes: 1 addition & 1 deletion
packages/elements/src/react/sign-in/verifications.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -80,7 +80,7 @@ export function SignInStrategy({ children, name }: SignInStrategyProps) {
 }

 return () => {
 if (factorCtx) {
 if (factorCtx?.getSnapshot().status === 'active') {
Comment thread
tmilewski marked this conversation as resolved.

 factorCtx.send({ type: 'STRATEGY.UNREGISTER', factor: name as unknown as SignInFactor });
 }
 };
Expand Down

3 changes: 2 additions & 1 deletion
packages/elements/src/react/sign-up/root.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,7 +46,8 @@ function SignUpFlowProvider({ children, exampleMode }: SignUpFlowProviderProps)
 ref.send(evt);
 }
 });
 }, [clerk, exampleMode, formRef, router]);
 // eslint-disable-next-line react-hooks/exhaustive-deps
 }, [clerk, exampleMode, formRef?.id, !!router]);

 return isReady ? <SignUpRouterCtx.Provider actorRef={ref}>{children}</SignUpRouterCtx.Provider> : null;
}
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
fix(elements): Fix follow-on initialization discrepancies#3377

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

 Merged

tmilewski
merged 4 commits into

from

May 13, 2024
 Merged


fix(elements): Fix follow-on initialization discrepancies
#3377
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
d350e89

fix(elements): Follow-on machine initialization [SDK-1746]


tmilewski May 13, 2024
bf34b2c

chore(elements): Add changeset


tmilewski May 13, 2024
46a460e

chore(elements): Remove unnecessary TS comment


tmilewski May 13, 2024
3d4491b

chore(elements): Add line item to changeset


tmilewski May 13, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


7 changes: 7 additions & 0 deletions
.changeset/odd-coins-carry.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/elements': patch
---

- Bump XState from version 5.12.0 to 5.13.0
- We now maintain your current state while completing authentication redirecting rather than transitioning to a "Complete" step.
- Fixes Sign In and Sign Up machines not appropriately attaching new form machines when returning to the Sign In or Sign Up pages.

8 changes: 4 additions & 4 deletions
package-lock.json

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


2 changes: 1 addition & 1 deletion
packages/elements/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,7 +74,7 @@
 "@statelyai/inspect": "^0.3.0",
 "@xstate/react": "^4.1.1",
 "client-only": "^0.0.1",
 "xstate": "^5.12.0"
 "xstate": "^5.13.0"
 },
 "devDependencies": {
 "@clerk/clerk-react": "5.0.4",
Expand Down

24 changes: 8 additions & 16 deletions
packages/elements/src/internals/machines/sign-in/router.machine.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ import { ClerkElementsError, ClerkElementsRuntimeError } from '~/internals/error
import { ThirdPartyMachine, ThirdPartyMachineId } from '~/internals/machines/third-party';
import { shouldUseVirtualRouting } from '~/internals/machines/utils/next';

import { FormMachine } from '../form';
import { SignInResetPasswordMachine } from './reset-password.machine';
import type {
 SignInRouterContext,
Expand DownExpand Up@@ -41,6 +42,7 @@ export const SignInRouterMachineId = 'SignInRouter';
export const SignInRouterMachine = setup({
 actors: {
 firstFactorMachine: SignInFirstFactorMachine,
 formMachine: FormMachine,
 resetPasswordMachine: SignInResetPasswordMachine,
 startMachine: SignInStartMachine,
 secondFactorMachine: SignInSecondFactorMachine,
Expand All@@ -60,8 +62,8 @@ export const SignInRouterMachine = setup({
 },
 navigateExternal: ({ context }, { path }: { path: string }) => context.router?.push(path),
 raiseNext: raise({ type: 'NEXT' }),
 setActive({ context, event }) {
 if (context.exampleMode) return;
 setActive: enqueueActions(({ enqueue, check, context, event }) => {
 if (check('isExampleMode')) return;

 const lastActiveSessionId = context.clerk.client.lastActiveSessionId;
 const createdSessionId = ((event as SignInRouterNextEvent)?.resource || context.clerk.client.signIn)
Expand All@@ -71,7 +73,9 @@ export const SignInRouterMachine = setup({

 const beforeEmit = () => context.router?.push(context.clerk.buildAfterSignInUrl());
 void context.clerk.setActive({ session, beforeEmit });
 },

 enqueue.raise({ type: 'RESET' }, { delay: 2000 }); // Reset machine after 2s delay.
 }),
 setError: assign({
 error: (_, { error }: { error?: ClerkElementsError }) => {
 if (error) return error;
Expand DownExpand Up@@ -182,6 +186,7 @@ export const SignInRouterMachine = setup({
 },
 })),
 },
 RESET: '.Idle',
 },
 states: {
 Idle: {
Expand DownExpand Up@@ -224,7 +229,6 @@ export const SignInRouterMachine = setup({
 {
 guard: 'isComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'isLoggedInAndSingleSession',
Expand DownExpand Up@@ -285,7 +289,6 @@ export const SignInRouterMachine = setup({
 {
 guard: 'isComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsFirstFactor',
Expand DownExpand Up@@ -323,7 +326,6 @@ export const SignInRouterMachine = setup({
 {
 guard: 'isComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsSecondFactor',
Expand DownExpand Up@@ -390,7 +392,6 @@ export const SignInRouterMachine = setup({
 {
 guard: 'isComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsNewPassword',
Expand DownExpand Up@@ -418,7 +419,6 @@ export const SignInRouterMachine = setup({
 {
 guard: 'isComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsFirstFactor',
Expand DownExpand Up@@ -446,7 +446,6 @@ export const SignInRouterMachine = setup({
 {
 guard: or(['isLoggedIn', 'isComplete', 'hasAuthenticatedViaClerkJS']),
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsIdentifier',
Expand All@@ -470,13 +469,6 @@ export const SignInRouterMachine = setup({
 ],
 },
 },
 Complete: {
 tags: 'route:complete',
 entry: 'clearFormErrors',
 after: {
 5000: 'Start',
 },
 },
 Error: {
 tags: 'route:error',
 on: {
Expand Down

3 changes: 3 additions & 0 deletions
packages/elements/src/internals/machines/sign-in/router.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import type {
 BaseRouterNextEvent,
 BaseRouterPrevEvent,
 BaseRouterRedirectEvent,
 BaseRouterResetEvent,
 BaseRouterSetClerkEvent,
 BaseRouterStartEvent,
 BaseRouterTransferEvent,
Expand DownExpand Up@@ -54,6 +55,7 @@ export type SignInRouterForgotPasswordEvent = { type: 'NAVIGATE.FORGOT_PASSWORD'
export type SignInRouterErrorEvent = BaseRouterErrorEvent;
export type SignInRouterTransferEvent = BaseRouterTransferEvent;
export type SignInRouterRedirectEvent = BaseRouterRedirectEvent;
export type SignInRouterResetEvent = BaseRouterResetEvent;
export type SignInRouterLoadingEvent = BaseRouterLoadingEvent<'start' | 'verifications' | 'reset-password'>;
export type SignInRouterSetClerkEvent = BaseRouterSetClerkEvent;
export type SignInRouterSubmitEvent = { type: 'SUBMIT' };
Expand All@@ -77,6 +79,7 @@ export type SignInRouterEvents =
 | SignInRouterErrorEvent
 | SignInRouterTransferEvent
 | SignInRouterRedirectEvent
 | SignInRouterResetEvent
 | SignInVerificationFactorUpdateEvent
 | SignInRouterLoadingEvent
 | SignInRouterSetClerkEvent
Expand Down

37 changes: 15 additions & 22 deletions
packages/elements/src/internals/machines/sign-up/router.machine.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { joinURL } from '@clerk/shared/url';
import type { SignUpStatus, VerificationStatus } from '@clerk/types';
import type { NonReducibleUnknown } from 'xstate';
import { and, assign, log, not, or, raise, sendTo, setup, spawnChild } from 'xstate';
import { and, assign, enqueueActions, log, not, or, raise, sendTo, setup, spawnChild } from 'xstate';

import {
 ERROR_CODES,
Expand DownExpand Up@@ -59,15 +59,20 @@ export const SignUpRouterMachine = setup({
 },
 navigateExternal: ({ context }, { path }: { path: string }) => context.router?.push(path),
 raiseNext: raise({ type: 'NEXT' }),
 setActive({ context, event }, params?: { sessionId?: string; useLastActiveSession?: boolean }) {
 const session =
 params?.sessionId ||
 (params?.useLastActiveSession && context.clerk.client.lastActiveSessionId) ||
 ((event as SignUpRouterNextEvent)?.resource || context.clerk.client.signUp).createdSessionId;
 setActive: (_, params?: { sessionId?: string; useLastActiveSession?: boolean }) =>
 enqueueActions(({ enqueue, check, context, event }) => {
 if (check('isExampleMode')) return;

 const beforeEmit = () => context.router?.push(context.clerk.buildAfterSignUpUrl());
 void context.clerk.setActive({ session, beforeEmit });
 },
 const session =
 params?.sessionId ||
 (params?.useLastActiveSession && context.clerk.client.lastActiveSessionId) ||
 ((event as SignUpRouterNextEvent)?.resource || context.clerk.client.signUp).createdSessionId;

 const beforeEmit = () => context.router?.push(context.clerk.buildAfterSignUpUrl());
 void context.clerk.setActive({ session, beforeEmit });

 enqueue.raise({ type: 'RESET' }, { delay: 2000 }); // Reset machine after 2s delay.
 }),
 setError: assign({
 error: (_, { error }: { error?: ClerkElementsError }) => {
 if (error) return error;
Expand DownExpand Up@@ -182,6 +187,7 @@ export const SignUpRouterMachine = setup({
 },
 })),
 },
 RESET: '.Idle',
 },
 states: {
 Idle: {
Expand DownExpand Up@@ -264,7 +270,6 @@ export const SignUpRouterMachine = setup({
 {
 guard: 'isStatusComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsVerification',
Expand DownExpand Up@@ -298,7 +303,6 @@ export const SignUpRouterMachine = setup({
 {
 guard: 'isStatusComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsVerification',
Expand DownExpand Up@@ -329,7 +333,6 @@ export const SignUpRouterMachine = setup({
 type: 'setActive',
 params: { sessionId: context.router?.searchParams().get(SEARCH_PARAMS.createdSession) },
 }),
 target: 'Complete',
 },
 {
 guard: { type: 'hasClerkStatus', params: { status: 'verified' } },
Expand All@@ -345,7 +348,6 @@ export const SignUpRouterMachine = setup({
 {
 guard: 'isStatusComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 guard: 'statusNeedsContinue',
Expand All@@ -363,13 +365,11 @@ export const SignUpRouterMachine = setup({
 {
 guard: 'isStatusComplete',
 actions: 'setActive',
 target: 'Complete',
 },
 {
 description: 'Handle a case where the user has already been authenticated via ClerkJS',
 guard: 'hasAuthenticatedViaClerkJS',
 actions: { type: 'setActive', params: { useLastActiveSession: true } },
 target: 'Complete',
 },
 {
 guard: 'statusNeedsVerification',
Expand All@@ -388,13 +388,6 @@ export const SignUpRouterMachine = setup({
 ],
 },
 },
 Complete: {
 tags: 'route:complete',
 entry: 'clearFormErrors',
 after: {
 5000: 'Start',
 },
 },
 Error: {
 tags: 'route:error',
 on: {
Expand Down

3 changes: 3 additions & 0 deletions
packages/elements/src/internals/machines/sign-up/router.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import type {
 BaseRouterNextEvent,
 BaseRouterPrevEvent,
 BaseRouterRedirectEvent,
 BaseRouterResetEvent,
 BaseRouterSetClerkEvent,
 BaseRouterStartEvent,
 BaseRouterTransferEvent,
Expand DownExpand Up@@ -46,6 +47,7 @@ export type SignUpRouterPrevEvent = BaseRouterPrevEvent;
export type SignUpRouterErrorEvent = BaseRouterErrorEvent;
export type SignUpRouterTransferEvent = BaseRouterTransferEvent;
export type SignUpRouterRedirectEvent = BaseRouterRedirectEvent;
export type SignUpRouterResetEvent = BaseRouterResetEvent;
export type SignUpRouterLoadingEvent = BaseRouterLoadingEvent<'start' | 'verifications' | 'continue'>;
export type SignUpRouterSetClerkEvent = BaseRouterSetClerkEvent;

Expand All@@ -64,6 +66,7 @@ export type SignUpRouterEvents =
 | SignUpRouterErrorEvent
 | SignUpRouterTransferEvent
 | SignUpRouterRedirectEvent
 | SignUpRouterResetEvent
 | SignUpRouterLoadingEvent
 | SignUpRouterSetClerkEvent;

Expand Down

1 change: 1 addition & 0 deletions
packages/elements/src/internals/machines/types/router.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ export type BaseRouterLoadingStep = 'start' | 'verifications' | 'continue' | 're
export type BaseRouterNextEvent<T extends ClerkResource> = { type: 'NEXT'; resource?: T };
export type BaseRouterPrevEvent = { type: 'NAVIGATE.PREVIOUS' };
export type BaseRouterStartEvent = { type: 'NAVIGATE.START' };
export type BaseRouterResetEvent = { type: 'RESET' };
export type BaseRouterErrorEvent = { type: 'ERROR'; error: Error };
export type BaseRouterTransferEvent = { type: 'TRANSFER' };
export type BaseRouterLoadingEvent<TSteps extends BaseRouterLoadingStep> = (
Expand Down

4 changes: 3 additions & 1 deletion
packages/elements/src/react/sign-in/root.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,9 @@ function SignInFlowProvider({ children, exampleMode }: SignInFlowProviderProps)
 actor.send(evt);
 }
 });
 }, [clerk, exampleMode, formRef, router]);

 // eslint-disable-next-line react-hooks/exhaustive-deps
 }, [clerk, exampleMode, formRef?.id, !!router]);
Comment thread
tmilewski marked this conversation as resolved.


 return <SignInRouterCtx.Provider actorRef={actor}>{children}</SignInRouterCtx.Provider>;
}
Expand Down

2 changes: 1 addition & 1 deletion
packages/elements/src/react/sign-in/verifications.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -80,7 +80,7 @@ export function SignInStrategy({ children, name }: SignInStrategyProps) {
 }

 return () => {
 if (factorCtx) {
 if (factorCtx?.getSnapshot().status === 'active') {
Comment thread
tmilewski marked this conversation as resolved.

 factorCtx.send({ type: 'STRATEGY.UNREGISTER', factor: name as unknown as SignInFactor });
 }
 };
Expand Down

3 changes: 2 additions & 1 deletion
packages/elements/src/react/sign-up/root.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,7 +46,8 @@ function SignUpFlowProvider({ children, exampleMode }: SignUpFlowProviderProps)
 ref.send(evt);
 }
 });
 }, [clerk, exampleMode, formRef, router]);
 // eslint-disable-next-line react-hooks/exhaustive-deps
 }, [clerk, exampleMode, formRef?.id, !!router]);

 return isReady ? <SignUpRouterCtx.Provider actorRef={ref}>{children}</SignUpRouterCtx.Provider> : null;
}
Expand Down