fix(elements): Progressive sign up ticket flow#4318

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
brkalow merged 3 commits into from
Oct 14, 2024
Merged

fix(elements): Progressive sign up ticket flow #4318

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4766abc
Fix progressive sign up ticket flow
brkalow Oct 11, 2024
3aa6b57
adds changeset
brkalow Oct 11, 2024
8d3279e
Align machine ID with other steps
brkalow Oct 11, 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
5 changes: 5 additions & 0 deletions .changeset/tender-badgers-rule.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/elements": patch
---

Fixes a bug during a ticket-based sign-up where the form could not be submitted if additional fields were needed.
2 changes: 1 addition & 1 deletion packages/elements/src/internals/machines/form/form.machine.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -169,7 +169,7 @@ export const FormMachine = setup({

if (field) {
field.checked = event.field.checked;
field.disabled = event.field.disabled || false;
field.disabled = event.field.disabled ?? field.disabled;

@brkalowbrkalowOct 11, 2024

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if this matters in practice (field shouldn't get updated if disabled), but if this does happen, we want to retain the existing disabled value.

field.value = event.field.value;

context.fields.set(event.field.name, field);
Expand Down
4 changes: 2 additions & 2 deletions packages/elements/src/internals/machines/shared/shared.actions.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ import type {
SignUpContinueContext,
SignUpContinueEvents,
SignUpStartContext,
SignUpStartRedirectEvent,
SignUpStartEvents,
SignUpVerificationContext,
SignUpVerificationEvents,
} from '~/internals/machines/sign-up';
Expand All@@ -33,7 +33,7 @@ type SendToLoadingProps = {
| SignInVerificationEvents
| SignInResetPasswordEvents
| ThirdPartyMachineEvent
| SignUpStartRedirectEvent
| SignUpStartEvents
| SignUpContinueEvents
| SignUpVerificationEvents;
};
Expand Down
5 changes: 5 additions & 0 deletions packages/elements/src/internals/machines/shared/shared.types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,9 @@ import type {
SignInStrategy,
} from '@clerk/types';
import type { SetRequired, Simplify } from 'type-fest';
import type { ActorRefFrom } from 'xstate';

import type { FormMachine } from '../form';

export type WithClerk<T = Record<string, unknown>> = { clerk: LoadedClerk } & T;
export type WithClient<T = Record<string, unknown>> = { client: LoadedClerk['client'] } & T;
Expand DownExpand Up@@ -33,3 +36,5 @@ export type AuthenticateWithRedirectSamlParams = Simplify<
// ================= Strategies ================= //

export type SignInStrategyName = SignInStrategy | 'oauth' | 'web3';

export type SetFormEvent = { type: 'SET_FORM'; formRef: ActorRefFrom<typeof FormMachine> };
7 changes: 5 additions & 2 deletions packages/elements/src/internals/machines/sign-up/router.machine.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -343,8 +343,10 @@ export const SignUpRouterMachine = setup({
},
on: {
'RESET.STEP': {
target: 'Start',
reenter: true,
Comment on lines -346 to -347

@brkalowbrkalowOct 11, 2024

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was causing the child machine to be re-created, and subsequently it would move right back to Attempting because of the presence of the ticket. For RESET.STEP specifically, we want to update the formRef of the child machine as this even is fired when the form machine is re-created.

@brkalowbrkalowOct 11, 2024

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There might be a better spot to put this that makes the intent more explicit. The underlying attempt actor was getting canceled, and subsequently re-created, by the reinitialization of the start machine. Changing this to only updating the form ref (which is what triggers RESET.STEP) solved the re-initialization issue.

actions: enqueueActions(({ enqueue, context }) => {
enqueue('clearFormErrors');
enqueue.sendTo('start', { type: 'SET_FORM', formRef: context.formRef });
}),
},
NEXT: [
{
Expand All@@ -355,6 +357,7 @@ export const SignUpRouterMachine = setup({
guard: and(['hasTicket', 'statusNeedsContinue']),
actions: { type: 'navigateInternal', params: { path: '/' } },
target: 'Start',
reenter: true,
},
{
guard: 'statusNeedsVerification',
Expand Down
23 changes: 21 additions & 2 deletions packages/elements/src/internals/machines/sign-up/start.machine.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
import type { SignUpResource, Web3Strategy } from '@clerk/types';
import { assertEvent, enqueueActions, fromPromise, not, sendTo, setup } from 'xstate';
import type { DoneActorEvent } from 'xstate';
import { and, assertEvent, assign, enqueueActions, fromPromise, not, sendTo, setup } from 'xstate';

import { SIGN_UP_DEFAULT_BASE_PATH } from '~/internals/constants';
import { ClerkElementsRuntimeError } from '~/internals/errors';
import type { FormFields } from '~/internals/machines/form';
import type { SetFormEvent } from '~/internals/machines/shared';
import { sendToLoading } from '~/internals/machines/shared';
import { fieldsToSignUpParams } from '~/internals/machines/sign-up/utils';
import { ThirdPartyMachine } from '~/internals/machines/third-party';
Expand DownExpand Up@@ -48,8 +50,14 @@ export const SignUpStartMachine = setup({
thirdParty: ThirdPartyMachine,
},
actions: {
sendToNext: ({ context }) => context.parent.send({ type: 'NEXT' }),
sendToNext: ({ context, event }) =>
context.parent.send({ type: 'NEXT', resource: (event as unknown as DoneActorEvent<SignUpResource>).output }),
sendToLoading,
setFormRef: assign(({ event }) => {
return {
formRef: (event as unknown as SetFormEvent).formRef,
};
}),
setFormDisabledTicketFields: enqueueActions(({ context, enqueue }) => {
if (!context.ticket) {
return;
Expand DownExpand Up@@ -90,6 +98,8 @@ export const SignUpStartMachine = setup({
},
},
guards: {
isMissingRequirements: ({ context }) =>
context.parent.getSnapshot().context.clerk?.client?.signUp?.status === 'missing_requirements',
hasTicket: ({ context }) => Boolean(context.ticket),
isExampleMode: ({ context }) => Boolean(context.parent.getSnapshot().context.exampleMode),
},
Expand All@@ -105,11 +115,20 @@ export const SignUpStartMachine = setup({
}),
entry: 'setDefaultFormValues',
initial: 'Init',
on: {
SET_FORM: {
actions: 'setFormRef',
},
},
states: {
Init: {
description:
'Handle ticket, if present; Else, default to Pending state. Per tickets, `Attempting` makes a `signUp.create` request allowing for an incomplete sign up to contain progressively filled fields on the Start step.',
always: [
{
guard: and(['hasTicket', 'isMissingRequirements']),
target: 'Pending',
},
Comment on lines +128 to +131

@brkalowbrkalowOct 11, 2024

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When the sign up attempt is missing requirements, users need to be able to submit the form, so we move to Pending

{
guard: 'hasTicket',
target: 'Attempting',
Expand Down
3 changes: 2 additions & 1 deletion packages/elements/src/internals/machines/sign-up/start.types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import type { ActorRefFrom, ErrorActorEvent } from 'xstate';

import type { FormMachine } from '~/internals/machines/form';

import type { SetFormEvent } from '../shared';
import type { SignInRouterMachineActorRef } from './router.types';

// ---------------------------------- Tags ---------------------------------- //
Expand All@@ -24,7 +25,7 @@ export type SignUpStartRedirectEvent =
| SignUpStartRedirectSamlEvent
| SignUpStartRedirectWeb3Event;

export type SignUpStartEvents = ErrorActorEvent | SignUpStartSubmitEvent | SignUpStartRedirectEvent;
export type SignUpStartEvents = ErrorActorEvent | SignUpStartSubmitEvent | SignUpStartRedirectEvent | SetFormEvent;

// ---------------------------------- Input ---------------------------------- //

Expand Down
10 changes: 5 additions & 5 deletions packages/elements/src/react/sign-up/context/router.context.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
import type { ActorRefFrom, AnyActorRef, AnyStateMachine, SnapshotFrom } from 'xstate';

import type {
TSignUpContinueMachine,
TSignUpRouterMachine,
TSignUpStartMachine,
TSignUpVerificationMachine,
import {
type TSignUpContinueMachine,
type TSignUpRouterMachine,
type TSignUpStartMachine,
type TSignUpVerificationMachine,
} from '~/internals/machines/sign-up';
import { createContextFromActorRef } from '~/react/utils/create-context-from-actor-ref';

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): Progressive sign up ticket flow#4318

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

brkalow
merged 3 commits into

from

Oct 14, 2024
 Merged


fix(elements): Progressive sign up ticket flow
#4318
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
4766abc

Fix progressive sign up ticket flow


brkalow Oct 11, 2024
3aa6b57

adds changeset


brkalow Oct 11, 2024
8d3279e

Align machine ID with other steps


brkalow Oct 11, 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


5 changes: 5 additions & 0 deletions
.changeset/tender-badgers-rule.md

View file


Open in desktop

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

Fixes a bug during a ticket-based sign-up where the form could not be submitted if additional fields were needed.

2 changes: 1 addition & 1 deletion
packages/elements/src/internals/machines/form/form.machine.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -169,7 +169,7 @@ export const FormMachine = setup({

 if (field) {
 field.checked = event.field.checked;
 field.disabled = event.field.disabled || false;
 field.disabled = event.field.disabled ?? field.disabled;
@brkalowbrkalowOct 11, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if this matters in practice (field shouldn't get updated if disabled), but if this does happen, we want to retain the existing disabled value.
 field.value = event.field.value;

 context.fields.set(event.field.name, field);
Expand Down

4 changes: 2 additions & 2 deletions
packages/elements/src/internals/machines/shared/shared.actions.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ import type {
 SignUpContinueContext,
 SignUpContinueEvents,
 SignUpStartContext,
SignUpStartRedirectEvent,
SignUpStartEvents,
 SignUpVerificationContext,
 SignUpVerificationEvents,
} from '~/internals/machines/sign-up';
Expand All@@ -33,7 +33,7 @@ type SendToLoadingProps = {
 | SignInVerificationEvents
 | SignInResetPasswordEvents
 | ThirdPartyMachineEvent
 | SignUpStartRedirectEvent
 | SignUpStartEvents
 | SignUpContinueEvents
 | SignUpVerificationEvents;
};
Expand Down

5 changes: 5 additions & 0 deletions
packages/elements/src/internals/machines/shared/shared.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,9 @@ import type {
 SignInStrategy,
} from '@clerk/types';
import type { SetRequired, Simplify } from 'type-fest';
import type { ActorRefFrom } from 'xstate';

import type { FormMachine } from '../form';

export type WithClerk<T = Record<string, unknown>> = { clerk: LoadedClerk } & T;
export type WithClient<T = Record<string, unknown>> = { client: LoadedClerk['client'] } & T;
Expand DownExpand Up@@ -33,3 +36,5 @@ export type AuthenticateWithRedirectSamlParams = Simplify<
// ================= Strategies ================= //

export type SignInStrategyName = SignInStrategy | 'oauth' | 'web3';

export type SetFormEvent = { type: 'SET_FORM'; formRef: ActorRefFrom<typeof FormMachine> };

7 changes: 5 additions & 2 deletions
packages/elements/src/internals/machines/sign-up/router.machine.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -343,8 +343,10 @@ export const SignUpRouterMachine = setup({
 },
 on: {
 'RESET.STEP': {
 target: 'Start',
 reenter: true,

Comment on lines

-346
 to 
-347

@brkalowbrkalowOct 11, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was causing the child machine to be re-created, and subsequently it would move right back to Attempting because of the presence of the ticket. For RESET.STEP specifically, we want to update the formRef of the child machine as this even is fired when the form machine is re-created.
@brkalowbrkalowOct 11, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There might be a better spot to put this that makes the intent more explicit. The underlying attempt actor was getting canceled, and subsequently re-created, by the reinitialization of the start machine. Changing this to only updating the form ref (which is what triggers RESET.STEP) solved the re-initialization issue.
 actions: enqueueActions(({ enqueue, context }) => {
 enqueue('clearFormErrors');
 enqueue.sendTo('start', { type: 'SET_FORM', formRef: context.formRef });
 }),
 },
 NEXT: [
 {
Expand All@@ -355,6 +357,7 @@ export const SignUpRouterMachine = setup({
 guard: and(['hasTicket', 'statusNeedsContinue']),
 actions: { type: 'navigateInternal', params: { path: '/' } },
 target: 'Start',
 reenter: true,
 },
 {
 guard: 'statusNeedsVerification',
Expand Down

23 changes: 21 additions & 2 deletions
packages/elements/src/internals/machines/sign-up/start.machine.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
import type { SignUpResource, Web3Strategy } from '@clerk/types';
import { assertEvent, enqueueActions, fromPromise, not, sendTo, setup } from 'xstate';
import type { DoneActorEvent } from 'xstate';
import { and, assertEvent, assign, enqueueActions, fromPromise, not, sendTo, setup } from 'xstate';

import { SIGN_UP_DEFAULT_BASE_PATH } from '~/internals/constants';
import { ClerkElementsRuntimeError } from '~/internals/errors';
import type { FormFields } from '~/internals/machines/form';
import type { SetFormEvent } from '~/internals/machines/shared';
import { sendToLoading } from '~/internals/machines/shared';
import { fieldsToSignUpParams } from '~/internals/machines/sign-up/utils';
import { ThirdPartyMachine } from '~/internals/machines/third-party';
Expand DownExpand Up@@ -48,8 +50,14 @@ export const SignUpStartMachine = setup({
 thirdParty: ThirdPartyMachine,
 },
 actions: {
 sendToNext: ({ context }) => context.parent.send({ type: 'NEXT' }),
 sendToNext: ({ context, event }) =>
 context.parent.send({ type: 'NEXT', resource: (event as unknown as DoneActorEvent<SignUpResource>).output }),
 sendToLoading,
 setFormRef: assign(({ event }) => {
 return {
 formRef: (event as unknown as SetFormEvent).formRef,
 };
 }),
 setFormDisabledTicketFields: enqueueActions(({ context, enqueue }) => {
 if (!context.ticket) {
 return;
Expand DownExpand Up@@ -90,6 +98,8 @@ export const SignUpStartMachine = setup({
 },
 },
 guards: {
 isMissingRequirements: ({ context }) =>
 context.parent.getSnapshot().context.clerk?.client?.signUp?.status === 'missing_requirements',
 hasTicket: ({ context }) => Boolean(context.ticket),
 isExampleMode: ({ context }) => Boolean(context.parent.getSnapshot().context.exampleMode),
 },
Expand All@@ -105,11 +115,20 @@ export const SignUpStartMachine = setup({
 }),
 entry: 'setDefaultFormValues',
 initial: 'Init',
 on: {
 SET_FORM: {
 actions: 'setFormRef',
 },
 },
 states: {
 Init: {
 description:
 'Handle ticket, if present; Else, default to Pending state. Per tickets, `Attempting` makes a `signUp.create` request allowing for an incomplete sign up to contain progressively filled fields on the Start step.',
 always: [
 {
 guard: and(['hasTicket', 'isMissingRequirements']),
 target: 'Pending',
 },

Comment on lines

+128
 to 
+131

@brkalowbrkalowOct 11, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When the sign up attempt is missing requirements, users need to be able to submit the form, so we move to Pending
 {
 guard: 'hasTicket',
 target: 'Attempting',
Expand Down

3 changes: 2 additions & 1 deletion
packages/elements/src/internals/machines/sign-up/start.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import type { ActorRefFrom, ErrorActorEvent } from 'xstate';

import type { FormMachine } from '~/internals/machines/form';

import type { SetFormEvent } from '../shared';
import type { SignInRouterMachineActorRef } from './router.types';

// ---------------------------------- Tags ---------------------------------- //
Expand All@@ -24,7 +25,7 @@ export type SignUpStartRedirectEvent =
 | SignUpStartRedirectSamlEvent
 | SignUpStartRedirectWeb3Event;

export type SignUpStartEvents = ErrorActorEvent | SignUpStartSubmitEvent | SignUpStartRedirectEvent;
export type SignUpStartEvents = ErrorActorEvent | SignUpStartSubmitEvent | SignUpStartRedirectEvent | SetFormEvent;

// ---------------------------------- Input ---------------------------------- //

Expand Down

10 changes: 5 additions & 5 deletions
packages/elements/src/react/sign-up/context/router.context.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
import type { ActorRefFrom, AnyActorRef, AnyStateMachine, SnapshotFrom } from 'xstate';

import type {
 TSignUpContinueMachine,
 TSignUpRouterMachine,
 TSignUpStartMachine,
 TSignUpVerificationMachine,
import {
type TSignUpContinueMachine,
type TSignUpRouterMachine,
type TSignUpStartMachine,
type TSignUpVerificationMachine,
} from '~/internals/machines/sign-up';
import { createContextFromActorRef } from '~/react/utils/create-context-from-actor-ref';

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): Progressive sign up ticket flow#4318

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

brkalow
merged 3 commits into

from

Oct 14, 2024
 Merged


fix(elements): Progressive sign up ticket flow
#4318
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
4766abc

Fix progressive sign up ticket flow


brkalow Oct 11, 2024
3aa6b57

adds changeset


brkalow Oct 11, 2024
8d3279e

Align machine ID with other steps


brkalow Oct 11, 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


5 changes: 5 additions & 0 deletions
.changeset/tender-badgers-rule.md

View file


Open in desktop

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

Fixes a bug during a ticket-based sign-up where the form could not be submitted if additional fields were needed.

2 changes: 1 addition & 1 deletion
packages/elements/src/internals/machines/form/form.machine.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -169,7 +169,7 @@ export const FormMachine = setup({

 if (field) {
 field.checked = event.field.checked;
 field.disabled = event.field.disabled || false;
 field.disabled = event.field.disabled ?? field.disabled;
@brkalowbrkalowOct 11, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if this matters in practice (field shouldn't get updated if disabled), but if this does happen, we want to retain the existing disabled value.
 field.value = event.field.value;

 context.fields.set(event.field.name, field);
Expand Down

4 changes: 2 additions & 2 deletions
packages/elements/src/internals/machines/shared/shared.actions.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ import type {
 SignUpContinueContext,
 SignUpContinueEvents,
 SignUpStartContext,
SignUpStartRedirectEvent,
SignUpStartEvents,
 SignUpVerificationContext,
 SignUpVerificationEvents,
} from '~/internals/machines/sign-up';
Expand All@@ -33,7 +33,7 @@ type SendToLoadingProps = {
 | SignInVerificationEvents
 | SignInResetPasswordEvents
 | ThirdPartyMachineEvent
 | SignUpStartRedirectEvent
 | SignUpStartEvents
 | SignUpContinueEvents
 | SignUpVerificationEvents;
};
Expand Down

5 changes: 5 additions & 0 deletions
packages/elements/src/internals/machines/shared/shared.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,9 @@ import type {
 SignInStrategy,
} from '@clerk/types';
import type { SetRequired, Simplify } from 'type-fest';
import type { ActorRefFrom } from 'xstate';

import type { FormMachine } from '../form';

export type WithClerk<T = Record<string, unknown>> = { clerk: LoadedClerk } & T;
export type WithClient<T = Record<string, unknown>> = { client: LoadedClerk['client'] } & T;
Expand DownExpand Up@@ -33,3 +36,5 @@ export type AuthenticateWithRedirectSamlParams = Simplify<
// ================= Strategies ================= //

export type SignInStrategyName = SignInStrategy | 'oauth' | 'web3';

export type SetFormEvent = { type: 'SET_FORM'; formRef: ActorRefFrom<typeof FormMachine> };

7 changes: 5 additions & 2 deletions
packages/elements/src/internals/machines/sign-up/router.machine.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -343,8 +343,10 @@ export const SignUpRouterMachine = setup({
 },
 on: {
 'RESET.STEP': {
 target: 'Start',
 reenter: true,

Comment on lines

-346
 to 
-347

@brkalowbrkalowOct 11, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was causing the child machine to be re-created, and subsequently it would move right back to Attempting because of the presence of the ticket. For RESET.STEP specifically, we want to update the formRef of the child machine as this even is fired when the form machine is re-created.
@brkalowbrkalowOct 11, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There might be a better spot to put this that makes the intent more explicit. The underlying attempt actor was getting canceled, and subsequently re-created, by the reinitialization of the start machine. Changing this to only updating the form ref (which is what triggers RESET.STEP) solved the re-initialization issue.
 actions: enqueueActions(({ enqueue, context }) => {
 enqueue('clearFormErrors');
 enqueue.sendTo('start', { type: 'SET_FORM', formRef: context.formRef });
 }),
 },
 NEXT: [
 {
Expand All@@ -355,6 +357,7 @@ export const SignUpRouterMachine = setup({
 guard: and(['hasTicket', 'statusNeedsContinue']),
 actions: { type: 'navigateInternal', params: { path: '/' } },
 target: 'Start',
 reenter: true,
 },
 {
 guard: 'statusNeedsVerification',
Expand Down

23 changes: 21 additions & 2 deletions
packages/elements/src/internals/machines/sign-up/start.machine.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
import type { SignUpResource, Web3Strategy } from '@clerk/types';
import { assertEvent, enqueueActions, fromPromise, not, sendTo, setup } from 'xstate';
import type { DoneActorEvent } from 'xstate';
import { and, assertEvent, assign, enqueueActions, fromPromise, not, sendTo, setup } from 'xstate';

import { SIGN_UP_DEFAULT_BASE_PATH } from '~/internals/constants';
import { ClerkElementsRuntimeError } from '~/internals/errors';
import type { FormFields } from '~/internals/machines/form';
import type { SetFormEvent } from '~/internals/machines/shared';
import { sendToLoading } from '~/internals/machines/shared';
import { fieldsToSignUpParams } from '~/internals/machines/sign-up/utils';
import { ThirdPartyMachine } from '~/internals/machines/third-party';
Expand DownExpand Up@@ -48,8 +50,14 @@ export const SignUpStartMachine = setup({
 thirdParty: ThirdPartyMachine,
 },
 actions: {
 sendToNext: ({ context }) => context.parent.send({ type: 'NEXT' }),
 sendToNext: ({ context, event }) =>
 context.parent.send({ type: 'NEXT', resource: (event as unknown as DoneActorEvent<SignUpResource>).output }),
 sendToLoading,
 setFormRef: assign(({ event }) => {
 return {
 formRef: (event as unknown as SetFormEvent).formRef,
 };
 }),
 setFormDisabledTicketFields: enqueueActions(({ context, enqueue }) => {
 if (!context.ticket) {
 return;
Expand DownExpand Up@@ -90,6 +98,8 @@ export const SignUpStartMachine = setup({
 },
 },
 guards: {
 isMissingRequirements: ({ context }) =>
 context.parent.getSnapshot().context.clerk?.client?.signUp?.status === 'missing_requirements',
 hasTicket: ({ context }) => Boolean(context.ticket),
 isExampleMode: ({ context }) => Boolean(context.parent.getSnapshot().context.exampleMode),
 },
Expand All@@ -105,11 +115,20 @@ export const SignUpStartMachine = setup({
 }),
 entry: 'setDefaultFormValues',
 initial: 'Init',
 on: {
 SET_FORM: {
 actions: 'setFormRef',
 },
 },
 states: {
 Init: {
 description:
 'Handle ticket, if present; Else, default to Pending state. Per tickets, `Attempting` makes a `signUp.create` request allowing for an incomplete sign up to contain progressively filled fields on the Start step.',
 always: [
 {
 guard: and(['hasTicket', 'isMissingRequirements']),
 target: 'Pending',
 },

Comment on lines

+128
 to 
+131

@brkalowbrkalowOct 11, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When the sign up attempt is missing requirements, users need to be able to submit the form, so we move to Pending
 {
 guard: 'hasTicket',
 target: 'Attempting',
Expand Down

3 changes: 2 additions & 1 deletion
packages/elements/src/internals/machines/sign-up/start.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import type { ActorRefFrom, ErrorActorEvent } from 'xstate';

import type { FormMachine } from '~/internals/machines/form';

import type { SetFormEvent } from '../shared';
import type { SignInRouterMachineActorRef } from './router.types';

// ---------------------------------- Tags ---------------------------------- //
Expand All@@ -24,7 +25,7 @@ export type SignUpStartRedirectEvent =
 | SignUpStartRedirectSamlEvent
 | SignUpStartRedirectWeb3Event;

export type SignUpStartEvents = ErrorActorEvent | SignUpStartSubmitEvent | SignUpStartRedirectEvent;
export type SignUpStartEvents = ErrorActorEvent | SignUpStartSubmitEvent | SignUpStartRedirectEvent | SetFormEvent;

// ---------------------------------- Input ---------------------------------- //

Expand Down

10 changes: 5 additions & 5 deletions
packages/elements/src/react/sign-up/context/router.context.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
import type { ActorRefFrom, AnyActorRef, AnyStateMachine, SnapshotFrom } from 'xstate';

import type {
 TSignUpContinueMachine,
 TSignUpRouterMachine,
 TSignUpStartMachine,
 TSignUpVerificationMachine,
import {
type TSignUpContinueMachine,
type TSignUpRouterMachine,
type TSignUpStartMachine,
type TSignUpVerificationMachine,
} from '~/internals/machines/sign-up';
import { createContextFromActorRef } from '~/react/utils/create-context-from-actor-ref';

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): Progressive sign up ticket flow#4318

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

brkalow
merged 3 commits into

from

Oct 14, 2024
 Merged


fix(elements): Progressive sign up ticket flow
#4318
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
4766abc

Fix progressive sign up ticket flow


brkalow Oct 11, 2024
3aa6b57

adds changeset


brkalow Oct 11, 2024
8d3279e

Align machine ID with other steps


brkalow Oct 11, 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


5 changes: 5 additions & 0 deletions
.changeset/tender-badgers-rule.md

View file


Open in desktop

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

Fixes a bug during a ticket-based sign-up where the form could not be submitted if additional fields were needed.

2 changes: 1 addition & 1 deletion
packages/elements/src/internals/machines/form/form.machine.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -169,7 +169,7 @@ export const FormMachine = setup({

 if (field) {
 field.checked = event.field.checked;
 field.disabled = event.field.disabled || false;
 field.disabled = event.field.disabled ?? field.disabled;
@brkalowbrkalowOct 11, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if this matters in practice (field shouldn't get updated if disabled), but if this does happen, we want to retain the existing disabled value.
 field.value = event.field.value;

 context.fields.set(event.field.name, field);
Expand Down

4 changes: 2 additions & 2 deletions
packages/elements/src/internals/machines/shared/shared.actions.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ import type {
 SignUpContinueContext,
 SignUpContinueEvents,
 SignUpStartContext,
SignUpStartRedirectEvent,
SignUpStartEvents,
 SignUpVerificationContext,
 SignUpVerificationEvents,
} from '~/internals/machines/sign-up';
Expand All@@ -33,7 +33,7 @@ type SendToLoadingProps = {
 | SignInVerificationEvents
 | SignInResetPasswordEvents
 | ThirdPartyMachineEvent
 | SignUpStartRedirectEvent
 | SignUpStartEvents
 | SignUpContinueEvents
 | SignUpVerificationEvents;
};
Expand Down

5 changes: 5 additions & 0 deletions
packages/elements/src/internals/machines/shared/shared.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,9 @@ import type {
 SignInStrategy,
} from '@clerk/types';
import type { SetRequired, Simplify } from 'type-fest';
import type { ActorRefFrom } from 'xstate';

import type { FormMachine } from '../form';

export type WithClerk<T = Record<string, unknown>> = { clerk: LoadedClerk } & T;
export type WithClient<T = Record<string, unknown>> = { client: LoadedClerk['client'] } & T;
Expand DownExpand Up@@ -33,3 +36,5 @@ export type AuthenticateWithRedirectSamlParams = Simplify<
// ================= Strategies ================= //

export type SignInStrategyName = SignInStrategy | 'oauth' | 'web3';

export type SetFormEvent = { type: 'SET_FORM'; formRef: ActorRefFrom<typeof FormMachine> };

7 changes: 5 additions & 2 deletions
packages/elements/src/internals/machines/sign-up/router.machine.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -343,8 +343,10 @@ export const SignUpRouterMachine = setup({
 },
 on: {
 'RESET.STEP': {
 target: 'Start',
 reenter: true,

Comment on lines

-346
 to 
-347

@brkalowbrkalowOct 11, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was causing the child machine to be re-created, and subsequently it would move right back to Attempting because of the presence of the ticket. For RESET.STEP specifically, we want to update the formRef of the child machine as this even is fired when the form machine is re-created.
@brkalowbrkalowOct 11, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There might be a better spot to put this that makes the intent more explicit. The underlying attempt actor was getting canceled, and subsequently re-created, by the reinitialization of the start machine. Changing this to only updating the form ref (which is what triggers RESET.STEP) solved the re-initialization issue.
 actions: enqueueActions(({ enqueue, context }) => {
 enqueue('clearFormErrors');
 enqueue.sendTo('start', { type: 'SET_FORM', formRef: context.formRef });
 }),
 },
 NEXT: [
 {
Expand All@@ -355,6 +357,7 @@ export const SignUpRouterMachine = setup({
 guard: and(['hasTicket', 'statusNeedsContinue']),
 actions: { type: 'navigateInternal', params: { path: '/' } },
 target: 'Start',
 reenter: true,
 },
 {
 guard: 'statusNeedsVerification',
Expand Down

23 changes: 21 additions & 2 deletions
packages/elements/src/internals/machines/sign-up/start.machine.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
import type { SignUpResource, Web3Strategy } from '@clerk/types';
import { assertEvent, enqueueActions, fromPromise, not, sendTo, setup } from 'xstate';
import type { DoneActorEvent } from 'xstate';
import { and, assertEvent, assign, enqueueActions, fromPromise, not, sendTo, setup } from 'xstate';

import { SIGN_UP_DEFAULT_BASE_PATH } from '~/internals/constants';
import { ClerkElementsRuntimeError } from '~/internals/errors';
import type { FormFields } from '~/internals/machines/form';
import type { SetFormEvent } from '~/internals/machines/shared';
import { sendToLoading } from '~/internals/machines/shared';
import { fieldsToSignUpParams } from '~/internals/machines/sign-up/utils';
import { ThirdPartyMachine } from '~/internals/machines/third-party';
Expand DownExpand Up@@ -48,8 +50,14 @@ export const SignUpStartMachine = setup({
 thirdParty: ThirdPartyMachine,
 },
 actions: {
 sendToNext: ({ context }) => context.parent.send({ type: 'NEXT' }),
 sendToNext: ({ context, event }) =>
 context.parent.send({ type: 'NEXT', resource: (event as unknown as DoneActorEvent<SignUpResource>).output }),
 sendToLoading,
 setFormRef: assign(({ event }) => {
 return {
 formRef: (event as unknown as SetFormEvent).formRef,
 };
 }),
 setFormDisabledTicketFields: enqueueActions(({ context, enqueue }) => {
 if (!context.ticket) {
 return;
Expand DownExpand Up@@ -90,6 +98,8 @@ export const SignUpStartMachine = setup({
 },
 },
 guards: {
 isMissingRequirements: ({ context }) =>
 context.parent.getSnapshot().context.clerk?.client?.signUp?.status === 'missing_requirements',
 hasTicket: ({ context }) => Boolean(context.ticket),
 isExampleMode: ({ context }) => Boolean(context.parent.getSnapshot().context.exampleMode),
 },
Expand All@@ -105,11 +115,20 @@ export const SignUpStartMachine = setup({
 }),
 entry: 'setDefaultFormValues',
 initial: 'Init',
 on: {
 SET_FORM: {
 actions: 'setFormRef',
 },
 },
 states: {
 Init: {
 description:
 'Handle ticket, if present; Else, default to Pending state. Per tickets, `Attempting` makes a `signUp.create` request allowing for an incomplete sign up to contain progressively filled fields on the Start step.',
 always: [
 {
 guard: and(['hasTicket', 'isMissingRequirements']),
 target: 'Pending',
 },

Comment on lines

+128
 to 
+131

@brkalowbrkalowOct 11, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When the sign up attempt is missing requirements, users need to be able to submit the form, so we move to Pending
 {
 guard: 'hasTicket',
 target: 'Attempting',
Expand Down

3 changes: 2 additions & 1 deletion
packages/elements/src/internals/machines/sign-up/start.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import type { ActorRefFrom, ErrorActorEvent } from 'xstate';

import type { FormMachine } from '~/internals/machines/form';

import type { SetFormEvent } from '../shared';
import type { SignInRouterMachineActorRef } from './router.types';

// ---------------------------------- Tags ---------------------------------- //
Expand All@@ -24,7 +25,7 @@ export type SignUpStartRedirectEvent =
 | SignUpStartRedirectSamlEvent
 | SignUpStartRedirectWeb3Event;

export type SignUpStartEvents = ErrorActorEvent | SignUpStartSubmitEvent | SignUpStartRedirectEvent;
export type SignUpStartEvents = ErrorActorEvent | SignUpStartSubmitEvent | SignUpStartRedirectEvent | SetFormEvent;

// ---------------------------------- Input ---------------------------------- //

Expand Down

10 changes: 5 additions & 5 deletions
packages/elements/src/react/sign-up/context/router.context.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
import type { ActorRefFrom, AnyActorRef, AnyStateMachine, SnapshotFrom } from 'xstate';

import type {
 TSignUpContinueMachine,
 TSignUpRouterMachine,
 TSignUpStartMachine,
 TSignUpVerificationMachine,
import {
type TSignUpContinueMachine,
type TSignUpRouterMachine,
type TSignUpStartMachine,
type TSignUpVerificationMachine,
} from '~/internals/machines/sign-up';
import { createContextFromActorRef } from '~/react/utils/create-context-from-actor-ref';

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): Progressive sign up ticket flow#4318

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

brkalow
merged 3 commits into

from

Oct 14, 2024
 Merged


fix(elements): Progressive sign up ticket flow
#4318
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
4766abc

Fix progressive sign up ticket flow


brkalow Oct 11, 2024
3aa6b57

adds changeset


brkalow Oct 11, 2024
8d3279e

Align machine ID with other steps


brkalow Oct 11, 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


5 changes: 5 additions & 0 deletions
.changeset/tender-badgers-rule.md

View file


Open in desktop

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

Fixes a bug during a ticket-based sign-up where the form could not be submitted if additional fields were needed.

2 changes: 1 addition & 1 deletion
packages/elements/src/internals/machines/form/form.machine.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -169,7 +169,7 @@ export const FormMachine = setup({

 if (field) {
 field.checked = event.field.checked;
 field.disabled = event.field.disabled || false;
 field.disabled = event.field.disabled ?? field.disabled;
@brkalowbrkalowOct 11, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if this matters in practice (field shouldn't get updated if disabled), but if this does happen, we want to retain the existing disabled value.
 field.value = event.field.value;

 context.fields.set(event.field.name, field);
Expand Down

4 changes: 2 additions & 2 deletions
packages/elements/src/internals/machines/shared/shared.actions.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ import type {
 SignUpContinueContext,
 SignUpContinueEvents,
 SignUpStartContext,
SignUpStartRedirectEvent,
SignUpStartEvents,
 SignUpVerificationContext,
 SignUpVerificationEvents,
} from '~/internals/machines/sign-up';
Expand All@@ -33,7 +33,7 @@ type SendToLoadingProps = {
 | SignInVerificationEvents
 | SignInResetPasswordEvents
 | ThirdPartyMachineEvent
 | SignUpStartRedirectEvent
 | SignUpStartEvents
 | SignUpContinueEvents
 | SignUpVerificationEvents;
};
Expand Down

5 changes: 5 additions & 0 deletions
packages/elements/src/internals/machines/shared/shared.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,9 @@ import type {
 SignInStrategy,
} from '@clerk/types';
import type { SetRequired, Simplify } from 'type-fest';
import type { ActorRefFrom } from 'xstate';

import type { FormMachine } from '../form';

export type WithClerk<T = Record<string, unknown>> = { clerk: LoadedClerk } & T;
export type WithClient<T = Record<string, unknown>> = { client: LoadedClerk['client'] } & T;
Expand DownExpand Up@@ -33,3 +36,5 @@ export type AuthenticateWithRedirectSamlParams = Simplify<
// ================= Strategies ================= //

export type SignInStrategyName = SignInStrategy | 'oauth' | 'web3';

export type SetFormEvent = { type: 'SET_FORM'; formRef: ActorRefFrom<typeof FormMachine> };

7 changes: 5 additions & 2 deletions
packages/elements/src/internals/machines/sign-up/router.machine.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -343,8 +343,10 @@ export const SignUpRouterMachine = setup({
 },
 on: {
 'RESET.STEP': {
 target: 'Start',
 reenter: true,

Comment on lines

-346
 to 
-347

@brkalowbrkalowOct 11, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was causing the child machine to be re-created, and subsequently it would move right back to Attempting because of the presence of the ticket. For RESET.STEP specifically, we want to update the formRef of the child machine as this even is fired when the form machine is re-created.
@brkalowbrkalowOct 11, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There might be a better spot to put this that makes the intent more explicit. The underlying attempt actor was getting canceled, and subsequently re-created, by the reinitialization of the start machine. Changing this to only updating the form ref (which is what triggers RESET.STEP) solved the re-initialization issue.
 actions: enqueueActions(({ enqueue, context }) => {
 enqueue('clearFormErrors');
 enqueue.sendTo('start', { type: 'SET_FORM', formRef: context.formRef });
 }),
 },
 NEXT: [
 {
Expand All@@ -355,6 +357,7 @@ export const SignUpRouterMachine = setup({
 guard: and(['hasTicket', 'statusNeedsContinue']),
 actions: { type: 'navigateInternal', params: { path: '/' } },
 target: 'Start',
 reenter: true,
 },
 {
 guard: 'statusNeedsVerification',
Expand Down

23 changes: 21 additions & 2 deletions
packages/elements/src/internals/machines/sign-up/start.machine.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
import type { SignUpResource, Web3Strategy } from '@clerk/types';
import { assertEvent, enqueueActions, fromPromise, not, sendTo, setup } from 'xstate';
import type { DoneActorEvent } from 'xstate';
import { and, assertEvent, assign, enqueueActions, fromPromise, not, sendTo, setup } from 'xstate';

import { SIGN_UP_DEFAULT_BASE_PATH } from '~/internals/constants';
import { ClerkElementsRuntimeError } from '~/internals/errors';
import type { FormFields } from '~/internals/machines/form';
import type { SetFormEvent } from '~/internals/machines/shared';
import { sendToLoading } from '~/internals/machines/shared';
import { fieldsToSignUpParams } from '~/internals/machines/sign-up/utils';
import { ThirdPartyMachine } from '~/internals/machines/third-party';
Expand DownExpand Up@@ -48,8 +50,14 @@ export const SignUpStartMachine = setup({
 thirdParty: ThirdPartyMachine,
 },
 actions: {
 sendToNext: ({ context }) => context.parent.send({ type: 'NEXT' }),
 sendToNext: ({ context, event }) =>
 context.parent.send({ type: 'NEXT', resource: (event as unknown as DoneActorEvent<SignUpResource>).output }),
 sendToLoading,
 setFormRef: assign(({ event }) => {
 return {
 formRef: (event as unknown as SetFormEvent).formRef,
 };
 }),
 setFormDisabledTicketFields: enqueueActions(({ context, enqueue }) => {
 if (!context.ticket) {
 return;
Expand DownExpand Up@@ -90,6 +98,8 @@ export const SignUpStartMachine = setup({
 },
 },
 guards: {
 isMissingRequirements: ({ context }) =>
 context.parent.getSnapshot().context.clerk?.client?.signUp?.status === 'missing_requirements',
 hasTicket: ({ context }) => Boolean(context.ticket),
 isExampleMode: ({ context }) => Boolean(context.parent.getSnapshot().context.exampleMode),
 },
Expand All@@ -105,11 +115,20 @@ export const SignUpStartMachine = setup({
 }),
 entry: 'setDefaultFormValues',
 initial: 'Init',
 on: {
 SET_FORM: {
 actions: 'setFormRef',
 },
 },
 states: {
 Init: {
 description:
 'Handle ticket, if present; Else, default to Pending state. Per tickets, `Attempting` makes a `signUp.create` request allowing for an incomplete sign up to contain progressively filled fields on the Start step.',
 always: [
 {
 guard: and(['hasTicket', 'isMissingRequirements']),
 target: 'Pending',
 },

Comment on lines

+128
 to 
+131

@brkalowbrkalowOct 11, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When the sign up attempt is missing requirements, users need to be able to submit the form, so we move to Pending
 {
 guard: 'hasTicket',
 target: 'Attempting',
Expand Down

3 changes: 2 additions & 1 deletion
packages/elements/src/internals/machines/sign-up/start.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import type { ActorRefFrom, ErrorActorEvent } from 'xstate';

import type { FormMachine } from '~/internals/machines/form';

import type { SetFormEvent } from '../shared';
import type { SignInRouterMachineActorRef } from './router.types';

// ---------------------------------- Tags ---------------------------------- //
Expand All@@ -24,7 +25,7 @@ export type SignUpStartRedirectEvent =
 | SignUpStartRedirectSamlEvent
 | SignUpStartRedirectWeb3Event;

export type SignUpStartEvents = ErrorActorEvent | SignUpStartSubmitEvent | SignUpStartRedirectEvent;
export type SignUpStartEvents = ErrorActorEvent | SignUpStartSubmitEvent | SignUpStartRedirectEvent | SetFormEvent;

// ---------------------------------- Input ---------------------------------- //

Expand Down

10 changes: 5 additions & 5 deletions
packages/elements/src/react/sign-up/context/router.context.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
import type { ActorRefFrom, AnyActorRef, AnyStateMachine, SnapshotFrom } from 'xstate';

import type {
 TSignUpContinueMachine,
 TSignUpRouterMachine,
 TSignUpStartMachine,
 TSignUpVerificationMachine,
import {
type TSignUpContinueMachine,
type TSignUpRouterMachine,
type TSignUpStartMachine,
type TSignUpVerificationMachine,
} from '~/internals/machines/sign-up';
import { createContextFromActorRef } from '~/react/utils/create-context-from-actor-ref';

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): Progressive sign up ticket flow#4318

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

brkalow
merged 3 commits into

from

Oct 14, 2024
 Merged


fix(elements): Progressive sign up ticket flow
#4318
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
4766abc

Fix progressive sign up ticket flow


brkalow Oct 11, 2024
3aa6b57

adds changeset


brkalow Oct 11, 2024
8d3279e

Align machine ID with other steps


brkalow Oct 11, 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


5 changes: 5 additions & 0 deletions
.changeset/tender-badgers-rule.md

View file


Open in desktop

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

Fixes a bug during a ticket-based sign-up where the form could not be submitted if additional fields were needed.

2 changes: 1 addition & 1 deletion
packages/elements/src/internals/machines/form/form.machine.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -169,7 +169,7 @@ export const FormMachine = setup({

 if (field) {
 field.checked = event.field.checked;
 field.disabled = event.field.disabled || false;
 field.disabled = event.field.disabled ?? field.disabled;
@brkalowbrkalowOct 11, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if this matters in practice (field shouldn't get updated if disabled), but if this does happen, we want to retain the existing disabled value.
 field.value = event.field.value;

 context.fields.set(event.field.name, field);
Expand Down

4 changes: 2 additions & 2 deletions
packages/elements/src/internals/machines/shared/shared.actions.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ import type {
 SignUpContinueContext,
 SignUpContinueEvents,
 SignUpStartContext,
SignUpStartRedirectEvent,
SignUpStartEvents,
 SignUpVerificationContext,
 SignUpVerificationEvents,
} from '~/internals/machines/sign-up';
Expand All@@ -33,7 +33,7 @@ type SendToLoadingProps = {
 | SignInVerificationEvents
 | SignInResetPasswordEvents
 | ThirdPartyMachineEvent
 | SignUpStartRedirectEvent
 | SignUpStartEvents
 | SignUpContinueEvents
 | SignUpVerificationEvents;
};
Expand Down

5 changes: 5 additions & 0 deletions
packages/elements/src/internals/machines/shared/shared.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,9 @@ import type {
 SignInStrategy,
} from '@clerk/types';
import type { SetRequired, Simplify } from 'type-fest';
import type { ActorRefFrom } from 'xstate';

import type { FormMachine } from '../form';

export type WithClerk<T = Record<string, unknown>> = { clerk: LoadedClerk } & T;
export type WithClient<T = Record<string, unknown>> = { client: LoadedClerk['client'] } & T;
Expand DownExpand Up@@ -33,3 +36,5 @@ export type AuthenticateWithRedirectSamlParams = Simplify<
// ================= Strategies ================= //

export type SignInStrategyName = SignInStrategy | 'oauth' | 'web3';

export type SetFormEvent = { type: 'SET_FORM'; formRef: ActorRefFrom<typeof FormMachine> };

7 changes: 5 additions & 2 deletions
packages/elements/src/internals/machines/sign-up/router.machine.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -343,8 +343,10 @@ export const SignUpRouterMachine = setup({
 },
 on: {
 'RESET.STEP': {
 target: 'Start',
 reenter: true,

Comment on lines

-346
 to 
-347

@brkalowbrkalowOct 11, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was causing the child machine to be re-created, and subsequently it would move right back to Attempting because of the presence of the ticket. For RESET.STEP specifically, we want to update the formRef of the child machine as this even is fired when the form machine is re-created.
@brkalowbrkalowOct 11, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There might be a better spot to put this that makes the intent more explicit. The underlying attempt actor was getting canceled, and subsequently re-created, by the reinitialization of the start machine. Changing this to only updating the form ref (which is what triggers RESET.STEP) solved the re-initialization issue.
 actions: enqueueActions(({ enqueue, context }) => {
 enqueue('clearFormErrors');
 enqueue.sendTo('start', { type: 'SET_FORM', formRef: context.formRef });
 }),
 },
 NEXT: [
 {
Expand All@@ -355,6 +357,7 @@ export const SignUpRouterMachine = setup({
 guard: and(['hasTicket', 'statusNeedsContinue']),
 actions: { type: 'navigateInternal', params: { path: '/' } },
 target: 'Start',
 reenter: true,
 },
 {
 guard: 'statusNeedsVerification',
Expand Down

23 changes: 21 additions & 2 deletions
packages/elements/src/internals/machines/sign-up/start.machine.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
import type { SignUpResource, Web3Strategy } from '@clerk/types';
import { assertEvent, enqueueActions, fromPromise, not, sendTo, setup } from 'xstate';
import type { DoneActorEvent } from 'xstate';
import { and, assertEvent, assign, enqueueActions, fromPromise, not, sendTo, setup } from 'xstate';

import { SIGN_UP_DEFAULT_BASE_PATH } from '~/internals/constants';
import { ClerkElementsRuntimeError } from '~/internals/errors';
import type { FormFields } from '~/internals/machines/form';
import type { SetFormEvent } from '~/internals/machines/shared';
import { sendToLoading } from '~/internals/machines/shared';
import { fieldsToSignUpParams } from '~/internals/machines/sign-up/utils';
import { ThirdPartyMachine } from '~/internals/machines/third-party';
Expand DownExpand Up@@ -48,8 +50,14 @@ export const SignUpStartMachine = setup({
 thirdParty: ThirdPartyMachine,
 },
 actions: {
 sendToNext: ({ context }) => context.parent.send({ type: 'NEXT' }),
 sendToNext: ({ context, event }) =>
 context.parent.send({ type: 'NEXT', resource: (event as unknown as DoneActorEvent<SignUpResource>).output }),
 sendToLoading,
 setFormRef: assign(({ event }) => {
 return {
 formRef: (event as unknown as SetFormEvent).formRef,
 };
 }),
 setFormDisabledTicketFields: enqueueActions(({ context, enqueue }) => {
 if (!context.ticket) {
 return;
Expand DownExpand Up@@ -90,6 +98,8 @@ export const SignUpStartMachine = setup({
 },
 },
 guards: {
 isMissingRequirements: ({ context }) =>
 context.parent.getSnapshot().context.clerk?.client?.signUp?.status === 'missing_requirements',
 hasTicket: ({ context }) => Boolean(context.ticket),
 isExampleMode: ({ context }) => Boolean(context.parent.getSnapshot().context.exampleMode),
 },
Expand All@@ -105,11 +115,20 @@ export const SignUpStartMachine = setup({
 }),
 entry: 'setDefaultFormValues',
 initial: 'Init',
 on: {
 SET_FORM: {
 actions: 'setFormRef',
 },
 },
 states: {
 Init: {
 description:
 'Handle ticket, if present; Else, default to Pending state. Per tickets, `Attempting` makes a `signUp.create` request allowing for an incomplete sign up to contain progressively filled fields on the Start step.',
 always: [
 {
 guard: and(['hasTicket', 'isMissingRequirements']),
 target: 'Pending',
 },

Comment on lines

+128
 to 
+131

@brkalowbrkalowOct 11, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When the sign up attempt is missing requirements, users need to be able to submit the form, so we move to Pending
 {
 guard: 'hasTicket',
 target: 'Attempting',
Expand Down

3 changes: 2 additions & 1 deletion
packages/elements/src/internals/machines/sign-up/start.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import type { ActorRefFrom, ErrorActorEvent } from 'xstate';

import type { FormMachine } from '~/internals/machines/form';

import type { SetFormEvent } from '../shared';
import type { SignInRouterMachineActorRef } from './router.types';

// ---------------------------------- Tags ---------------------------------- //
Expand All@@ -24,7 +25,7 @@ export type SignUpStartRedirectEvent =
 | SignUpStartRedirectSamlEvent
 | SignUpStartRedirectWeb3Event;

export type SignUpStartEvents = ErrorActorEvent | SignUpStartSubmitEvent | SignUpStartRedirectEvent;
export type SignUpStartEvents = ErrorActorEvent | SignUpStartSubmitEvent | SignUpStartRedirectEvent | SetFormEvent;

// ---------------------------------- Input ---------------------------------- //

Expand Down

10 changes: 5 additions & 5 deletions
packages/elements/src/react/sign-up/context/router.context.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
import type { ActorRefFrom, AnyActorRef, AnyStateMachine, SnapshotFrom } from 'xstate';

import type {
 TSignUpContinueMachine,
 TSignUpRouterMachine,
 TSignUpStartMachine,
 TSignUpVerificationMachine,
import {
type TSignUpContinueMachine,
type TSignUpRouterMachine,
type TSignUpStartMachine,
type TSignUpVerificationMachine,
} from '~/internals/machines/sign-up';
import { createContextFromActorRef } from '~/react/utils/create-context-from-actor-ref';

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): Progressive sign up ticket flow#4318

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

brkalow
merged 3 commits into

from

Oct 14, 2024
 Merged


fix(elements): Progressive sign up ticket flow
#4318
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
4766abc

Fix progressive sign up ticket flow


brkalow Oct 11, 2024
3aa6b57

adds changeset


brkalow Oct 11, 2024
8d3279e

Align machine ID with other steps


brkalow Oct 11, 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


5 changes: 5 additions & 0 deletions
.changeset/tender-badgers-rule.md

View file


Open in desktop

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

Fixes a bug during a ticket-based sign-up where the form could not be submitted if additional fields were needed.

2 changes: 1 addition & 1 deletion
packages/elements/src/internals/machines/form/form.machine.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -169,7 +169,7 @@ export const FormMachine = setup({

 if (field) {
 field.checked = event.field.checked;
 field.disabled = event.field.disabled || false;
 field.disabled = event.field.disabled ?? field.disabled;
@brkalowbrkalowOct 11, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if this matters in practice (field shouldn't get updated if disabled), but if this does happen, we want to retain the existing disabled value.
 field.value = event.field.value;

 context.fields.set(event.field.name, field);
Expand Down

4 changes: 2 additions & 2 deletions
packages/elements/src/internals/machines/shared/shared.actions.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ import type {
 SignUpContinueContext,
 SignUpContinueEvents,
 SignUpStartContext,
SignUpStartRedirectEvent,
SignUpStartEvents,
 SignUpVerificationContext,
 SignUpVerificationEvents,
} from '~/internals/machines/sign-up';
Expand All@@ -33,7 +33,7 @@ type SendToLoadingProps = {
 | SignInVerificationEvents
 | SignInResetPasswordEvents
 | ThirdPartyMachineEvent
 | SignUpStartRedirectEvent
 | SignUpStartEvents
 | SignUpContinueEvents
 | SignUpVerificationEvents;
};
Expand Down

5 changes: 5 additions & 0 deletions
packages/elements/src/internals/machines/shared/shared.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,9 @@ import type {
 SignInStrategy,
} from '@clerk/types';
import type { SetRequired, Simplify } from 'type-fest';
import type { ActorRefFrom } from 'xstate';

import type { FormMachine } from '../form';

export type WithClerk<T = Record<string, unknown>> = { clerk: LoadedClerk } & T;
export type WithClient<T = Record<string, unknown>> = { client: LoadedClerk['client'] } & T;
Expand DownExpand Up@@ -33,3 +36,5 @@ export type AuthenticateWithRedirectSamlParams = Simplify<
// ================= Strategies ================= //

export type SignInStrategyName = SignInStrategy | 'oauth' | 'web3';

export type SetFormEvent = { type: 'SET_FORM'; formRef: ActorRefFrom<typeof FormMachine> };

7 changes: 5 additions & 2 deletions
packages/elements/src/internals/machines/sign-up/router.machine.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -343,8 +343,10 @@ export const SignUpRouterMachine = setup({
 },
 on: {
 'RESET.STEP': {
 target: 'Start',
 reenter: true,

Comment on lines

-346
 to 
-347

@brkalowbrkalowOct 11, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was causing the child machine to be re-created, and subsequently it would move right back to Attempting because of the presence of the ticket. For RESET.STEP specifically, we want to update the formRef of the child machine as this even is fired when the form machine is re-created.
@brkalowbrkalowOct 11, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There might be a better spot to put this that makes the intent more explicit. The underlying attempt actor was getting canceled, and subsequently re-created, by the reinitialization of the start machine. Changing this to only updating the form ref (which is what triggers RESET.STEP) solved the re-initialization issue.
 actions: enqueueActions(({ enqueue, context }) => {
 enqueue('clearFormErrors');
 enqueue.sendTo('start', { type: 'SET_FORM', formRef: context.formRef });
 }),
 },
 NEXT: [
 {
Expand All@@ -355,6 +357,7 @@ export const SignUpRouterMachine = setup({
 guard: and(['hasTicket', 'statusNeedsContinue']),
 actions: { type: 'navigateInternal', params: { path: '/' } },
 target: 'Start',
 reenter: true,
 },
 {
 guard: 'statusNeedsVerification',
Expand Down

23 changes: 21 additions & 2 deletions
packages/elements/src/internals/machines/sign-up/start.machine.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
import type { SignUpResource, Web3Strategy } from '@clerk/types';
import { assertEvent, enqueueActions, fromPromise, not, sendTo, setup } from 'xstate';
import type { DoneActorEvent } from 'xstate';
import { and, assertEvent, assign, enqueueActions, fromPromise, not, sendTo, setup } from 'xstate';

import { SIGN_UP_DEFAULT_BASE_PATH } from '~/internals/constants';
import { ClerkElementsRuntimeError } from '~/internals/errors';
import type { FormFields } from '~/internals/machines/form';
import type { SetFormEvent } from '~/internals/machines/shared';
import { sendToLoading } from '~/internals/machines/shared';
import { fieldsToSignUpParams } from '~/internals/machines/sign-up/utils';
import { ThirdPartyMachine } from '~/internals/machines/third-party';
Expand DownExpand Up@@ -48,8 +50,14 @@ export const SignUpStartMachine = setup({
 thirdParty: ThirdPartyMachine,
 },
 actions: {
 sendToNext: ({ context }) => context.parent.send({ type: 'NEXT' }),
 sendToNext: ({ context, event }) =>
 context.parent.send({ type: 'NEXT', resource: (event as unknown as DoneActorEvent<SignUpResource>).output }),
 sendToLoading,
 setFormRef: assign(({ event }) => {
 return {
 formRef: (event as unknown as SetFormEvent).formRef,
 };
 }),
 setFormDisabledTicketFields: enqueueActions(({ context, enqueue }) => {
 if (!context.ticket) {
 return;
Expand DownExpand Up@@ -90,6 +98,8 @@ export const SignUpStartMachine = setup({
 },
 },
 guards: {
 isMissingRequirements: ({ context }) =>
 context.parent.getSnapshot().context.clerk?.client?.signUp?.status === 'missing_requirements',
 hasTicket: ({ context }) => Boolean(context.ticket),
 isExampleMode: ({ context }) => Boolean(context.parent.getSnapshot().context.exampleMode),
 },
Expand All@@ -105,11 +115,20 @@ export const SignUpStartMachine = setup({
 }),
 entry: 'setDefaultFormValues',
 initial: 'Init',
 on: {
 SET_FORM: {
 actions: 'setFormRef',
 },
 },
 states: {
 Init: {
 description:
 'Handle ticket, if present; Else, default to Pending state. Per tickets, `Attempting` makes a `signUp.create` request allowing for an incomplete sign up to contain progressively filled fields on the Start step.',
 always: [
 {
 guard: and(['hasTicket', 'isMissingRequirements']),
 target: 'Pending',
 },

Comment on lines

+128
 to 
+131

@brkalowbrkalowOct 11, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When the sign up attempt is missing requirements, users need to be able to submit the form, so we move to Pending
 {
 guard: 'hasTicket',
 target: 'Attempting',
Expand Down

3 changes: 2 additions & 1 deletion
packages/elements/src/internals/machines/sign-up/start.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import type { ActorRefFrom, ErrorActorEvent } from 'xstate';

import type { FormMachine } from '~/internals/machines/form';

import type { SetFormEvent } from '../shared';
import type { SignInRouterMachineActorRef } from './router.types';

// ---------------------------------- Tags ---------------------------------- //
Expand All@@ -24,7 +25,7 @@ export type SignUpStartRedirectEvent =
 | SignUpStartRedirectSamlEvent
 | SignUpStartRedirectWeb3Event;

export type SignUpStartEvents = ErrorActorEvent | SignUpStartSubmitEvent | SignUpStartRedirectEvent;
export type SignUpStartEvents = ErrorActorEvent | SignUpStartSubmitEvent | SignUpStartRedirectEvent | SetFormEvent;

// ---------------------------------- Input ---------------------------------- //

Expand Down

10 changes: 5 additions & 5 deletions
packages/elements/src/react/sign-up/context/router.context.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
import type { ActorRefFrom, AnyActorRef, AnyStateMachine, SnapshotFrom } from 'xstate';

import type {
 TSignUpContinueMachine,
 TSignUpRouterMachine,
 TSignUpStartMachine,
 TSignUpVerificationMachine,
import {
type TSignUpContinueMachine,
type TSignUpRouterMachine,
type TSignUpStartMachine,
type TSignUpVerificationMachine,
} from '~/internals/machines/sign-up';
import { createContextFromActorRef } from '~/react/utils/create-context-from-actor-ref';

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): Progressive sign up ticket flow#4318

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

brkalow
merged 3 commits into

from

Oct 14, 2024
 Merged


fix(elements): Progressive sign up ticket flow
#4318
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
4766abc

Fix progressive sign up ticket flow


brkalow Oct 11, 2024
3aa6b57

adds changeset


brkalow Oct 11, 2024
8d3279e

Align machine ID with other steps


brkalow Oct 11, 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


5 changes: 5 additions & 0 deletions
.changeset/tender-badgers-rule.md

View file


Open in desktop

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

Fixes a bug during a ticket-based sign-up where the form could not be submitted if additional fields were needed.

2 changes: 1 addition & 1 deletion
packages/elements/src/internals/machines/form/form.machine.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -169,7 +169,7 @@ export const FormMachine = setup({

 if (field) {
 field.checked = event.field.checked;
 field.disabled = event.field.disabled || false;
 field.disabled = event.field.disabled ?? field.disabled;
@brkalowbrkalowOct 11, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if this matters in practice (field shouldn't get updated if disabled), but if this does happen, we want to retain the existing disabled value.
 field.value = event.field.value;

 context.fields.set(event.field.name, field);
Expand Down

4 changes: 2 additions & 2 deletions
packages/elements/src/internals/machines/shared/shared.actions.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ import type {
 SignUpContinueContext,
 SignUpContinueEvents,
 SignUpStartContext,
SignUpStartRedirectEvent,
SignUpStartEvents,
 SignUpVerificationContext,
 SignUpVerificationEvents,
} from '~/internals/machines/sign-up';
Expand All@@ -33,7 +33,7 @@ type SendToLoadingProps = {
 | SignInVerificationEvents
 | SignInResetPasswordEvents
 | ThirdPartyMachineEvent
 | SignUpStartRedirectEvent
 | SignUpStartEvents
 | SignUpContinueEvents
 | SignUpVerificationEvents;
};
Expand Down

5 changes: 5 additions & 0 deletions
packages/elements/src/internals/machines/shared/shared.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,9 @@ import type {
 SignInStrategy,
} from '@clerk/types';
import type { SetRequired, Simplify } from 'type-fest';
import type { ActorRefFrom } from 'xstate';

import type { FormMachine } from '../form';

export type WithClerk<T = Record<string, unknown>> = { clerk: LoadedClerk } & T;
export type WithClient<T = Record<string, unknown>> = { client: LoadedClerk['client'] } & T;
Expand DownExpand Up@@ -33,3 +36,5 @@ export type AuthenticateWithRedirectSamlParams = Simplify<
// ================= Strategies ================= //

export type SignInStrategyName = SignInStrategy | 'oauth' | 'web3';

export type SetFormEvent = { type: 'SET_FORM'; formRef: ActorRefFrom<typeof FormMachine> };

7 changes: 5 additions & 2 deletions
packages/elements/src/internals/machines/sign-up/router.machine.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -343,8 +343,10 @@ export const SignUpRouterMachine = setup({
 },
 on: {
 'RESET.STEP': {
 target: 'Start',
 reenter: true,

Comment on lines

-346
 to 
-347

@brkalowbrkalowOct 11, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was causing the child machine to be re-created, and subsequently it would move right back to Attempting because of the presence of the ticket. For RESET.STEP specifically, we want to update the formRef of the child machine as this even is fired when the form machine is re-created.
@brkalowbrkalowOct 11, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There might be a better spot to put this that makes the intent more explicit. The underlying attempt actor was getting canceled, and subsequently re-created, by the reinitialization of the start machine. Changing this to only updating the form ref (which is what triggers RESET.STEP) solved the re-initialization issue.
 actions: enqueueActions(({ enqueue, context }) => {
 enqueue('clearFormErrors');
 enqueue.sendTo('start', { type: 'SET_FORM', formRef: context.formRef });
 }),
 },
 NEXT: [
 {
Expand All@@ -355,6 +357,7 @@ export const SignUpRouterMachine = setup({
 guard: and(['hasTicket', 'statusNeedsContinue']),
 actions: { type: 'navigateInternal', params: { path: '/' } },
 target: 'Start',
 reenter: true,
 },
 {
 guard: 'statusNeedsVerification',
Expand Down

23 changes: 21 additions & 2 deletions
packages/elements/src/internals/machines/sign-up/start.machine.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
import type { SignUpResource, Web3Strategy } from '@clerk/types';
import { assertEvent, enqueueActions, fromPromise, not, sendTo, setup } from 'xstate';
import type { DoneActorEvent } from 'xstate';
import { and, assertEvent, assign, enqueueActions, fromPromise, not, sendTo, setup } from 'xstate';

import { SIGN_UP_DEFAULT_BASE_PATH } from '~/internals/constants';
import { ClerkElementsRuntimeError } from '~/internals/errors';
import type { FormFields } from '~/internals/machines/form';
import type { SetFormEvent } from '~/internals/machines/shared';
import { sendToLoading } from '~/internals/machines/shared';
import { fieldsToSignUpParams } from '~/internals/machines/sign-up/utils';
import { ThirdPartyMachine } from '~/internals/machines/third-party';
Expand DownExpand Up@@ -48,8 +50,14 @@ export const SignUpStartMachine = setup({
 thirdParty: ThirdPartyMachine,
 },
 actions: {
 sendToNext: ({ context }) => context.parent.send({ type: 'NEXT' }),
 sendToNext: ({ context, event }) =>
 context.parent.send({ type: 'NEXT', resource: (event as unknown as DoneActorEvent<SignUpResource>).output }),
 sendToLoading,
 setFormRef: assign(({ event }) => {
 return {
 formRef: (event as unknown as SetFormEvent).formRef,
 };
 }),
 setFormDisabledTicketFields: enqueueActions(({ context, enqueue }) => {
 if (!context.ticket) {
 return;
Expand DownExpand Up@@ -90,6 +98,8 @@ export const SignUpStartMachine = setup({
 },
 },
 guards: {
 isMissingRequirements: ({ context }) =>
 context.parent.getSnapshot().context.clerk?.client?.signUp?.status === 'missing_requirements',
 hasTicket: ({ context }) => Boolean(context.ticket),
 isExampleMode: ({ context }) => Boolean(context.parent.getSnapshot().context.exampleMode),
 },
Expand All@@ -105,11 +115,20 @@ export const SignUpStartMachine = setup({
 }),
 entry: 'setDefaultFormValues',
 initial: 'Init',
 on: {
 SET_FORM: {
 actions: 'setFormRef',
 },
 },
 states: {
 Init: {
 description:
 'Handle ticket, if present; Else, default to Pending state. Per tickets, `Attempting` makes a `signUp.create` request allowing for an incomplete sign up to contain progressively filled fields on the Start step.',
 always: [
 {
 guard: and(['hasTicket', 'isMissingRequirements']),
 target: 'Pending',
 },

Comment on lines

+128
 to 
+131

@brkalowbrkalowOct 11, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When the sign up attempt is missing requirements, users need to be able to submit the form, so we move to Pending
 {
 guard: 'hasTicket',
 target: 'Attempting',
Expand Down

3 changes: 2 additions & 1 deletion
packages/elements/src/internals/machines/sign-up/start.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import type { ActorRefFrom, ErrorActorEvent } from 'xstate';

import type { FormMachine } from '~/internals/machines/form';

import type { SetFormEvent } from '../shared';
import type { SignInRouterMachineActorRef } from './router.types';

// ---------------------------------- Tags ---------------------------------- //
Expand All@@ -24,7 +25,7 @@ export type SignUpStartRedirectEvent =
 | SignUpStartRedirectSamlEvent
 | SignUpStartRedirectWeb3Event;

export type SignUpStartEvents = ErrorActorEvent | SignUpStartSubmitEvent | SignUpStartRedirectEvent;
export type SignUpStartEvents = ErrorActorEvent | SignUpStartSubmitEvent | SignUpStartRedirectEvent | SetFormEvent;

// ---------------------------------- Input ---------------------------------- //

Expand Down

10 changes: 5 additions & 5 deletions
packages/elements/src/react/sign-up/context/router.context.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
import type { ActorRefFrom, AnyActorRef, AnyStateMachine, SnapshotFrom } from 'xstate';

import type {
 TSignUpContinueMachine,
 TSignUpRouterMachine,
 TSignUpStartMachine,
 TSignUpVerificationMachine,
import {
type TSignUpContinueMachine,
type TSignUpRouterMachine,
type TSignUpStartMachine,
type TSignUpVerificationMachine,
} from '~/internals/machines/sign-up';
import { createContextFromActorRef } from '~/react/utils/create-context-from-actor-ref';

Expand Down