feat(clerk-js,ui): Introduce setup MFA session task#7626

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
octoper merged 3 commits into from
Feb 3, 2026
Merged

feat(clerk-js,ui): Introduce setup MFA session task #7626

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
433ff6c
wip
octoper Jan 13, 2026
d8166a6
chore(localizations): Fix localization generate script
octoper Feb 3, 2026
ec92505
chore(ui): Guard username access
octoper Feb 3, 2026
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
12 changes: 12 additions & 0 deletions .changeset/great-bats-attack.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
---
'@clerk/tanstack-react-start': minor
'@clerk/localizations': minor
'@clerk/react-router': minor
'@clerk/clerk-js': minor
'@clerk/nextjs': minor
'@clerk/shared': minor
'@clerk/react': minor
'@clerk/ui': minor
---

Introducing `setup_mfa` session task
8 changes: 8 additions & 0 deletions integration/presets/envs.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -158,6 +158,13 @@ const withSessionTasksResetPassword = base
.setEnvVariable('private', 'CLERK_SECRET_KEY', instanceKeys.get('with-session-tasks-reset-password').sk)
.setEnvVariable('public', 'CLERK_PUBLISHABLE_KEY', instanceKeys.get('with-session-tasks-reset-password').pk);

const withSessionTasksSetupMfa = base
.clone()
.setId('withSessionTasksSetupMfa')
.setEnvVariable('private', 'CLERK_SECRET_KEY', instanceKeys.get('with-session-tasks-setup-mfa').sk)
.setEnvVariable('public', 'CLERK_PUBLISHABLE_KEY', instanceKeys.get('with-session-tasks-setup-mfa').pk)
.setEnvVariable('private', 'CLERK_ENCRYPTION_KEY', constants.E2E_CLERK_ENCRYPTION_KEY || 'a-key');

const withBillingJwtV2 = base
.clone()
.setId('withBillingJwtV2')
Expand DownExpand Up@@ -216,6 +223,7 @@ export const envs = {
withSessionTasks,
withSessionTasksResetPassword,
withSharedUIVariant,
withSessionTasksSetupMfa,
withSignInOrUpEmailLinksFlow,
withSignInOrUpFlow,
withSignInOrUpwithRestrictedModeFlow,
Expand Down
1 change: 1 addition & 0 deletions integration/presets/longRunningApps.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@ export const createLongRunningApps = () => {
{ id: 'next.appRouter.withSignInOrUpEmailLinksFlow', config: next.appRouter, env: envs.withSignInOrUpEmailLinksFlow },
{ id: 'next.appRouter.withSessionTasks', config: next.appRouter, env: envs.withSessionTasks },
{ id: 'next.appRouter.withSessionTasksResetPassword', config: next.appRouter, env: envs.withSessionTasksResetPassword },
{ id: 'next.appRouter.withSessionTasksSetupMfa', config: next.appRouter, env: envs.withSessionTasksSetupMfa },
{ id: 'next.appRouter.withLegalConsent', config: next.appRouter, env: envs.withLegalConsent },
{ id: 'next.appRouter.withNeedsClientTrust', config: next.appRouter, env: envs.withNeedsClientTrust },
{ id: 'next.appRouter.withSharedUIVariant', config: next.appRouter, env: envs.withSharedUIVariant },
Expand Down
206 changes: 206 additions & 0 deletions integration/tests/session-tasks-setup-mfa.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,206 @@
import { expect, test } from '@playwright/test';

import { appConfigs } from '../presets';
import { createTestUtils, testAgainstRunningApps } from '../testUtils';
import { stringPhoneNumber } from '../testUtils/phoneUtils';
import { fakerPhoneNumber } from '../testUtils/usersService';

testAgainstRunningApps({ withEnv: [appConfigs.envs.withSessionTasksSetupMfa] })(
'session tasks setup-mfa flow @nextjs',
({ app }) => {
test.describe.configure({ mode: 'serial' });

test.afterAll(async () => {
await app.teardown();
});

test.afterEach(async ({ page, context }) => {
const u = createTestUtils({ app, page, context });
await u.page.signOut();
await u.page.context().clearCookies();
});

test('setup MFA with new phone number - happy path', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });
const user = u.services.users.createFakeUser({
fictionalEmail: true,
withPassword: true,
});
await u.services.users.createBapiUser(user);

await u.po.signIn.goTo();
await u.po.signIn.waitForMounted();
await u.po.signIn.signInWithEmailAndInstantPassword({ email: user.email, password: user.password });
await u.po.expect.toBeSignedIn();

await u.page.goToRelative('/page-protected');

await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });

await u.page.getByRole('button', { name: /sms code/i }).click();

const testPhoneNumber = fakerPhoneNumber();
await u.po.signIn.getPhoneNumberInput().fill(testPhoneNumber);
await u.page.getByRole('button', { name: /continue/i }).click();

await u.po.signIn.enterTestOtpCode();

await u.page.getByText(/save these backup codes/i).waitFor({ state: 'visible', timeout: 10000 });

await u.po.signIn.continue();

await u.page.waitForAppUrl('/page-protected');
await u.po.expect.toBeSignedIn();

await user.deleteIfExists();
});

test('setup MFA with existing phone number - happy path', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });
const user = u.services.users.createFakeUser({
fictionalEmail: true,
withPhoneNumber: true,
withPassword: true,
});
await u.services.users.createBapiUser(user);

await u.po.signIn.goTo();
await u.po.signIn.waitForMounted();
await u.po.signIn.signInWithEmailAndInstantPassword({ email: user.email, password: user.password });
await u.po.expect.toBeSignedIn();

await u.page.goToRelative('/page-protected');

await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });

await u.page.getByRole('button', { name: /sms code/i }).click();

const formattedPhoneNumber = stringPhoneNumber(user.phoneNumber);
await u.page
.getByRole('button', {
name: formattedPhoneNumber,
})
.click();

await u.page.getByText(/save these backup codes/i).waitFor({ state: 'visible', timeout: 10000 });

await u.po.signIn.continue();

await u.page.waitForAppUrl('/page-protected');
await u.po.expect.toBeSignedIn();

await user.deleteIfExists();
});

test('setup MFA with invalid phone number - error handling', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });
const user = u.services.users.createFakeUser({
fictionalEmail: true,
withPassword: true,
});
await u.services.users.createBapiUser(user);

await u.po.signIn.goTo();
await u.po.signIn.waitForMounted();
await u.po.signIn.signInWithEmailAndInstantPassword({ email: user.email, password: user.password });
await u.po.expect.toBeSignedIn();

await u.page.goToRelative('/page-protected');

await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });

await u.page.getByRole('button', { name: /sms code/i }).click();

const invalidPhoneNumber = '123091293193091311';
await u.po.signIn.getPhoneNumberInput().fill(invalidPhoneNumber);
await u.po.signIn.continue();
// we need to improve this error message
await expect(u.page.getByTestId('form-feedback-error')).toBeVisible();

const validPhoneNumber = fakerPhoneNumber();
await u.po.signIn.getPhoneNumberInput().fill(validPhoneNumber);
await u.po.signIn.continue();

await u.po.signIn.enterTestOtpCode();

await u.page.getByText(/save these backup codes/i).waitFor({ state: 'visible', timeout: 10000 });

await u.po.signIn.continue();

await u.page.waitForAppUrl('/page-protected');
await u.po.expect.toBeSignedIn();

await user.deleteIfExists();
});

test('setup MFA with invalid verification code - error handling', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });
const user = u.services.users.createFakeUser({
fictionalEmail: true,
withPassword: true,
});
await u.services.users.createBapiUser(user);

await u.po.signIn.goTo();
await u.po.signIn.waitForMounted();
await u.po.signIn.signInWithEmailAndInstantPassword({ email: user.email, password: user.password });
await u.po.expect.toBeSignedIn();

await u.page.goToRelative('/page-protected');

await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });

await u.page.getByRole('button', { name: /sms code/i }).click();

const testPhoneNumber = fakerPhoneNumber();
await u.po.signIn.getPhoneNumberInput().fill(testPhoneNumber);
await u.po.signIn.continue();

await u.po.signIn.enterOtpCode('111111', {
awaitRequests: false,
});

await expect(u.page.getByTestId('form-feedback-error')).toBeVisible();

await user.deleteIfExists();
});

test('can navigate back during MFA setup', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });
const user = u.services.users.createFakeUser({
fictionalEmail: true,
withPhoneNumber: true,
withPassword: true,
});
await u.services.users.createBapiUser(user);

await u.po.signIn.goTo();
await u.po.signIn.waitForMounted();
await u.po.signIn.signInWithEmailAndInstantPassword({ email: user.email, password: user.password });
await u.po.expect.toBeSignedIn();

await u.page.goToRelative('/page-protected');

await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });

await u.page.getByRole('button', { name: /sms code/i }).click();

const formattedPhoneNumber = stringPhoneNumber(user.phoneNumber);
await u.page
.getByRole('button', {
name: formattedPhoneNumber,
})
.waitFor({ state: 'visible' });

await u.page
.getByRole('button', { name: /cancel/i })
.first()
.click();

await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });
await u.page.getByRole('button', { name: /sms code/i }).waitFor({ state: 'visible' });

await user.deleteIfExists();
});
},
);
10 changes: 10 additions & 0 deletions packages/clerk-js/sandbox/app.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,7 @@ const AVAILABLE_COMPONENTS = [
'oauthConsent',
'taskChooseOrganization',
'taskResetPassword',
'taskSetupMFA',
] as const;
type AvailableComponent = (typeof AVAILABLE_COMPONENTS)[number];

Expand DownExpand Up@@ -137,6 +138,7 @@ const componentControls: Record<AvailableComponent, ComponentPropsControl> = {
oauthConsent: buildComponentControls('oauthConsent'),
taskChooseOrganization: buildComponentControls('taskChooseOrganization'),
taskResetPassword: buildComponentControls('taskResetPassword'),
taskSetupMFA: buildComponentControls('taskSetupMFA'),
};

declare global {
Expand DownExpand Up@@ -419,6 +421,14 @@ void (async () => {
},
);
},
'/task-setup-mfa': () => {
Clerk.mountTaskSetupMfa(
app,
componentControls.taskSetupMFA.getProps() ?? {
redirectUrlComplete: '/user-profile',
},
);
},
'/open-sign-in': () => {
mountOpenSignInButton(app, componentControls.signIn.getProps() ?? {});
},
Expand Down
8 changes: 8 additions & 0 deletions packages/clerk-js/sandbox/template.html
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -169,6 +169,14 @@
TaskChooseOrganization
</a>
</li>
<li class="relative">
<a
class="relative isolate flex w-full rounded-md border border-white px-2 py-[0.4375rem] text-sm hover:bg-gray-50 aria-[current]:bg-gray-50"
href="/task-setup-mfa"
>
TaskSetupMFA
</a>
</li>
<li class="relative">
<a
class="relative isolate flex w-full rounded-md border border-white px-2 py-[0.4375rem] text-sm hover:bg-gray-50 aria-[current]:bg-gray-50"
Expand Down
23 changes: 23 additions & 0 deletions packages/clerk-js/src/core/clerk.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -113,6 +113,7 @@ import type {
SignUpResource,
TaskChooseOrganizationProps,
TaskResetPasswordProps,
TaskSetupMFAProps,
TasksRedirectOptions,
UnsubscribeCallback,
UserAvatarProps,
Expand DownExpand Up@@ -1439,6 +1440,28 @@ export class Clerk implements ClerkInterface {
void this.#clerkUi?.then(ui => ui.ensureMounted()).then(controls => controls.unmountComponent({ node }));
};

public mountTaskSetupMfa = (node: HTMLDivElement, props?: TaskSetupMFAProps) => {
this.assertComponentsReady(this.#clerkUi);

const component = 'TaskSetupMFA';
void this.#clerkUi
.then(ui => ui.ensureMounted())
.then(controls =>
controls.mountComponent({
name: component,
appearanceKey: 'taskSetupMfa',
node,
props,
}),
);

this.telemetry?.record(eventPrebuiltComponentMounted('TaskSetupMfa', props));
};

public unmountTaskSetupMfa = (node: HTMLDivElement) => {
void this.#clerkUi?.then(ui => ui.ensureMounted()).then(controls => controls.unmountComponent({ node }));
};

/**
* `setActive` can be used to set the active session and/or organization.
*/
Expand Down
2 changes: 1 addition & 1 deletion packages/localizations/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -59,7 +59,7 @@
"dev": "tsup --watch",
"format": "node ../../scripts/format-package.mjs",
"format:check": "node ../../scripts/format-package.mjs --check",
"generate": "tsc src/utils/generate.ts && node src/utils/generate.js && prettier --write src/*.ts",
"generate": "tsc -p tsconfig.generate.json && node --experimental-vm-modules src/utils/generate.js && rimraf tmp && prettier --write src/*.ts",
"lint": "eslint src",
"lint:attw": "attw --pack . --profile node16"
},
Expand Down
Loading
Loading
, '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
feat(clerk-js,ui): Introduce setup MFA session task#7626

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

octoper
merged 3 commits into

from

Feb 3, 2026
 Merged


feat(clerk-js,ui): Introduce setup MFA session task
#7626
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
433ff6c

wip


octoper Jan 13, 2026
d8166a6

chore(localizations): Fix localization generate script


octoper Feb 3, 2026
ec92505

chore(ui): Guard username access


octoper Feb 3, 2026

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


12 changes: 12 additions & 0 deletions
.changeset/great-bats-attack.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
---
'@clerk/tanstack-react-start': minor
'@clerk/localizations': minor
'@clerk/react-router': minor
'@clerk/clerk-js': minor
'@clerk/nextjs': minor
'@clerk/shared': minor
'@clerk/react': minor
'@clerk/ui': minor
---

Introducing `setup_mfa` session task

8 changes: 8 additions & 0 deletions
integration/presets/envs.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -158,6 +158,13 @@ const withSessionTasksResetPassword = base
 .setEnvVariable('private', 'CLERK_SECRET_KEY', instanceKeys.get('with-session-tasks-reset-password').sk)
 .setEnvVariable('public', 'CLERK_PUBLISHABLE_KEY', instanceKeys.get('with-session-tasks-reset-password').pk);

const withSessionTasksSetupMfa = base
 .clone()
 .setId('withSessionTasksSetupMfa')
 .setEnvVariable('private', 'CLERK_SECRET_KEY', instanceKeys.get('with-session-tasks-setup-mfa').sk)
 .setEnvVariable('public', 'CLERK_PUBLISHABLE_KEY', instanceKeys.get('with-session-tasks-setup-mfa').pk)
 .setEnvVariable('private', 'CLERK_ENCRYPTION_KEY', constants.E2E_CLERK_ENCRYPTION_KEY || 'a-key');

const withBillingJwtV2 = base
 .clone()
 .setId('withBillingJwtV2')
Expand DownExpand Up@@ -216,6 +223,7 @@ export const envs = {
 withSessionTasks,
 withSessionTasksResetPassword,
 withSharedUIVariant,
 withSessionTasksSetupMfa,
 withSignInOrUpEmailLinksFlow,
 withSignInOrUpFlow,
 withSignInOrUpwithRestrictedModeFlow,
Expand Down

1 change: 1 addition & 0 deletions
integration/presets/longRunningApps.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@ export const createLongRunningApps = () => {
 { id: 'next.appRouter.withSignInOrUpEmailLinksFlow', config: next.appRouter, env: envs.withSignInOrUpEmailLinksFlow },
 { id: 'next.appRouter.withSessionTasks', config: next.appRouter, env: envs.withSessionTasks },
 { id: 'next.appRouter.withSessionTasksResetPassword', config: next.appRouter, env: envs.withSessionTasksResetPassword },
 { id: 'next.appRouter.withSessionTasksSetupMfa', config: next.appRouter, env: envs.withSessionTasksSetupMfa },
 { id: 'next.appRouter.withLegalConsent', config: next.appRouter, env: envs.withLegalConsent },
 { id: 'next.appRouter.withNeedsClientTrust', config: next.appRouter, env: envs.withNeedsClientTrust },
 { id: 'next.appRouter.withSharedUIVariant', config: next.appRouter, env: envs.withSharedUIVariant },
Expand Down

206 changes: 206 additions & 0 deletions
integration/tests/session-tasks-setup-mfa.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,206 @@
import { expect, test } from '@playwright/test';

import { appConfigs } from '../presets';
import { createTestUtils, testAgainstRunningApps } from '../testUtils';
import { stringPhoneNumber } from '../testUtils/phoneUtils';
import { fakerPhoneNumber } from '../testUtils/usersService';

testAgainstRunningApps({ withEnv: [appConfigs.envs.withSessionTasksSetupMfa] })(
 'session tasks setup-mfa flow @nextjs',
 ({ app }) => {
 test.describe.configure({ mode: 'serial' });

 test.afterAll(async () => {
 await app.teardown();
 });

 test.afterEach(async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.page.signOut();
 await u.page.context().clearCookies();
 });

 test('setup MFA with new phone number - happy path', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 const user = u.services.users.createFakeUser({
 fictionalEmail: true,
 withPassword: true,
 });
 await u.services.users.createBapiUser(user);

 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: user.email, password: user.password });
 await u.po.expect.toBeSignedIn();

 await u.page.goToRelative('/page-protected');

 await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });

 await u.page.getByRole('button', { name: /sms code/i }).click();

 const testPhoneNumber = fakerPhoneNumber();
 await u.po.signIn.getPhoneNumberInput().fill(testPhoneNumber);
 await u.page.getByRole('button', { name: /continue/i }).click();

 await u.po.signIn.enterTestOtpCode();

 await u.page.getByText(/save these backup codes/i).waitFor({ state: 'visible', timeout: 10000 });

 await u.po.signIn.continue();

 await u.page.waitForAppUrl('/page-protected');
 await u.po.expect.toBeSignedIn();

 await user.deleteIfExists();
 });

 test('setup MFA with existing phone number - happy path', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 const user = u.services.users.createFakeUser({
 fictionalEmail: true,
 withPhoneNumber: true,
 withPassword: true,
 });
 await u.services.users.createBapiUser(user);

 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: user.email, password: user.password });
 await u.po.expect.toBeSignedIn();

 await u.page.goToRelative('/page-protected');

 await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });

 await u.page.getByRole('button', { name: /sms code/i }).click();

 const formattedPhoneNumber = stringPhoneNumber(user.phoneNumber);
 await u.page
 .getByRole('button', {
 name: formattedPhoneNumber,
 })
 .click();

 await u.page.getByText(/save these backup codes/i).waitFor({ state: 'visible', timeout: 10000 });

 await u.po.signIn.continue();

 await u.page.waitForAppUrl('/page-protected');
 await u.po.expect.toBeSignedIn();

 await user.deleteIfExists();
 });

 test('setup MFA with invalid phone number - error handling', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 const user = u.services.users.createFakeUser({
 fictionalEmail: true,
 withPassword: true,
 });
 await u.services.users.createBapiUser(user);

 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: user.email, password: user.password });
 await u.po.expect.toBeSignedIn();

 await u.page.goToRelative('/page-protected');

 await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });

 await u.page.getByRole('button', { name: /sms code/i }).click();

 const invalidPhoneNumber = '123091293193091311';
 await u.po.signIn.getPhoneNumberInput().fill(invalidPhoneNumber);
 await u.po.signIn.continue();
 // we need to improve this error message
 await expect(u.page.getByTestId('form-feedback-error')).toBeVisible();

 const validPhoneNumber = fakerPhoneNumber();
 await u.po.signIn.getPhoneNumberInput().fill(validPhoneNumber);
 await u.po.signIn.continue();

 await u.po.signIn.enterTestOtpCode();

 await u.page.getByText(/save these backup codes/i).waitFor({ state: 'visible', timeout: 10000 });

 await u.po.signIn.continue();

 await u.page.waitForAppUrl('/page-protected');
 await u.po.expect.toBeSignedIn();

 await user.deleteIfExists();
 });

 test('setup MFA with invalid verification code - error handling', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 const user = u.services.users.createFakeUser({
 fictionalEmail: true,
 withPassword: true,
 });
 await u.services.users.createBapiUser(user);

 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: user.email, password: user.password });
 await u.po.expect.toBeSignedIn();

 await u.page.goToRelative('/page-protected');

 await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });

 await u.page.getByRole('button', { name: /sms code/i }).click();

 const testPhoneNumber = fakerPhoneNumber();
 await u.po.signIn.getPhoneNumberInput().fill(testPhoneNumber);
 await u.po.signIn.continue();

 await u.po.signIn.enterOtpCode('111111', {
 awaitRequests: false,
 });

 await expect(u.page.getByTestId('form-feedback-error')).toBeVisible();

 await user.deleteIfExists();
 });

 test('can navigate back during MFA setup', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 const user = u.services.users.createFakeUser({
 fictionalEmail: true,
 withPhoneNumber: true,
 withPassword: true,
 });
 await u.services.users.createBapiUser(user);

 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: user.email, password: user.password });
 await u.po.expect.toBeSignedIn();

 await u.page.goToRelative('/page-protected');

 await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });

 await u.page.getByRole('button', { name: /sms code/i }).click();

 const formattedPhoneNumber = stringPhoneNumber(user.phoneNumber);
 await u.page
 .getByRole('button', {
 name: formattedPhoneNumber,
 })
 .waitFor({ state: 'visible' });

 await u.page
 .getByRole('button', { name: /cancel/i })
 .first()
 .click();

 await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });
 await u.page.getByRole('button', { name: /sms code/i }).waitFor({ state: 'visible' });

 await user.deleteIfExists();
 });
 },
);

10 changes: 10 additions & 0 deletions
packages/clerk-js/sandbox/app.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,7 @@ const AVAILABLE_COMPONENTS = [
 'oauthConsent',
 'taskChooseOrganization',
 'taskResetPassword',
 'taskSetupMFA',
] as const;
type AvailableComponent = (typeof AVAILABLE_COMPONENTS)[number];

Expand DownExpand Up@@ -137,6 +138,7 @@ const componentControls: Record<AvailableComponent, ComponentPropsControl> = {
 oauthConsent: buildComponentControls('oauthConsent'),
 taskChooseOrganization: buildComponentControls('taskChooseOrganization'),
 taskResetPassword: buildComponentControls('taskResetPassword'),
 taskSetupMFA: buildComponentControls('taskSetupMFA'),
};

declare global {
Expand DownExpand Up@@ -419,6 +421,14 @@ void (async () => {
 },
 );
 },
 '/task-setup-mfa': () => {
 Clerk.mountTaskSetupMfa(
 app,
 componentControls.taskSetupMFA.getProps() ?? {
 redirectUrlComplete: '/user-profile',
 },
 );
 },
 '/open-sign-in': () => {
 mountOpenSignInButton(app, componentControls.signIn.getProps() ?? {});
 },
Expand Down

8 changes: 8 additions & 0 deletions
packages/clerk-js/sandbox/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -169,6 +169,14 @@
 TaskChooseOrganization
 </a>
 </li>
 <li class="relative">
 <a
 class="relative isolate flex w-full rounded-md border border-white px-2 py-[0.4375rem] text-sm hover:bg-gray-50 aria-[current]:bg-gray-50"
 href="/task-setup-mfa"
 >
 TaskSetupMFA
 </a>
 </li>
 <li class="relative">
 <a
 class="relative isolate flex w-full rounded-md border border-white px-2 py-[0.4375rem] text-sm hover:bg-gray-50 aria-[current]:bg-gray-50"
Expand Down

23 changes: 23 additions & 0 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -113,6 +113,7 @@ import type {
 SignUpResource,
 TaskChooseOrganizationProps,
 TaskResetPasswordProps,
 TaskSetupMFAProps,
 TasksRedirectOptions,
 UnsubscribeCallback,
 UserAvatarProps,
Expand DownExpand Up@@ -1439,6 +1440,28 @@ export class Clerk implements ClerkInterface {
 void this.#clerkUi?.then(ui => ui.ensureMounted()).then(controls => controls.unmountComponent({ node }));
 };

 public mountTaskSetupMfa = (node: HTMLDivElement, props?: TaskSetupMFAProps) => {
 this.assertComponentsReady(this.#clerkUi);

 const component = 'TaskSetupMFA';
 void this.#clerkUi
 .then(ui => ui.ensureMounted())
 .then(controls =>
 controls.mountComponent({
 name: component,
 appearanceKey: 'taskSetupMfa',
 node,
 props,
 }),
 );

 this.telemetry?.record(eventPrebuiltComponentMounted('TaskSetupMfa', props));
 };

 public unmountTaskSetupMfa = (node: HTMLDivElement) => {
 void this.#clerkUi?.then(ui => ui.ensureMounted()).then(controls => controls.unmountComponent({ node }));
 };

 /**
 * `setActive` can be used to set the active session and/or organization.
 */
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -59,7 +59,7 @@
 "dev": "tsup --watch",
 "format": "node ../../scripts/format-package.mjs",
 "format:check": "node ../../scripts/format-package.mjs --check",
 "generate": "tsc src/utils/generate.ts && node src/utils/generate.js && prettier --write src/*.ts",
 "generate": "tsc -p tsconfig.generate.json && node --experimental-vm-modules src/utils/generate.js && rimraf tmp && prettier --write src/*.ts",
 "lint": "eslint src",
 "lint:attw": "attw --pack . --profile node16"
 },
Expand Down
Loading
Loading

, '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
feat(clerk-js,ui): Introduce setup MFA session task#7626

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

octoper
merged 3 commits into

from

Feb 3, 2026
 Merged


feat(clerk-js,ui): Introduce setup MFA session task
#7626
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
433ff6c

wip


octoper Jan 13, 2026
d8166a6

chore(localizations): Fix localization generate script


octoper Feb 3, 2026
ec92505

chore(ui): Guard username access


octoper Feb 3, 2026

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


12 changes: 12 additions & 0 deletions
.changeset/great-bats-attack.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
---
'@clerk/tanstack-react-start': minor
'@clerk/localizations': minor
'@clerk/react-router': minor
'@clerk/clerk-js': minor
'@clerk/nextjs': minor
'@clerk/shared': minor
'@clerk/react': minor
'@clerk/ui': minor
---

Introducing `setup_mfa` session task

8 changes: 8 additions & 0 deletions
integration/presets/envs.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -158,6 +158,13 @@ const withSessionTasksResetPassword = base
 .setEnvVariable('private', 'CLERK_SECRET_KEY', instanceKeys.get('with-session-tasks-reset-password').sk)
 .setEnvVariable('public', 'CLERK_PUBLISHABLE_KEY', instanceKeys.get('with-session-tasks-reset-password').pk);

const withSessionTasksSetupMfa = base
 .clone()
 .setId('withSessionTasksSetupMfa')
 .setEnvVariable('private', 'CLERK_SECRET_KEY', instanceKeys.get('with-session-tasks-setup-mfa').sk)
 .setEnvVariable('public', 'CLERK_PUBLISHABLE_KEY', instanceKeys.get('with-session-tasks-setup-mfa').pk)
 .setEnvVariable('private', 'CLERK_ENCRYPTION_KEY', constants.E2E_CLERK_ENCRYPTION_KEY || 'a-key');

const withBillingJwtV2 = base
 .clone()
 .setId('withBillingJwtV2')
Expand DownExpand Up@@ -216,6 +223,7 @@ export const envs = {
 withSessionTasks,
 withSessionTasksResetPassword,
 withSharedUIVariant,
 withSessionTasksSetupMfa,
 withSignInOrUpEmailLinksFlow,
 withSignInOrUpFlow,
 withSignInOrUpwithRestrictedModeFlow,
Expand Down

1 change: 1 addition & 0 deletions
integration/presets/longRunningApps.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@ export const createLongRunningApps = () => {
 { id: 'next.appRouter.withSignInOrUpEmailLinksFlow', config: next.appRouter, env: envs.withSignInOrUpEmailLinksFlow },
 { id: 'next.appRouter.withSessionTasks', config: next.appRouter, env: envs.withSessionTasks },
 { id: 'next.appRouter.withSessionTasksResetPassword', config: next.appRouter, env: envs.withSessionTasksResetPassword },
 { id: 'next.appRouter.withSessionTasksSetupMfa', config: next.appRouter, env: envs.withSessionTasksSetupMfa },
 { id: 'next.appRouter.withLegalConsent', config: next.appRouter, env: envs.withLegalConsent },
 { id: 'next.appRouter.withNeedsClientTrust', config: next.appRouter, env: envs.withNeedsClientTrust },
 { id: 'next.appRouter.withSharedUIVariant', config: next.appRouter, env: envs.withSharedUIVariant },
Expand Down

206 changes: 206 additions & 0 deletions
integration/tests/session-tasks-setup-mfa.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,206 @@
import { expect, test } from '@playwright/test';

import { appConfigs } from '../presets';
import { createTestUtils, testAgainstRunningApps } from '../testUtils';
import { stringPhoneNumber } from '../testUtils/phoneUtils';
import { fakerPhoneNumber } from '../testUtils/usersService';

testAgainstRunningApps({ withEnv: [appConfigs.envs.withSessionTasksSetupMfa] })(
 'session tasks setup-mfa flow @nextjs',
 ({ app }) => {
 test.describe.configure({ mode: 'serial' });

 test.afterAll(async () => {
 await app.teardown();
 });

 test.afterEach(async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.page.signOut();
 await u.page.context().clearCookies();
 });

 test('setup MFA with new phone number - happy path', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 const user = u.services.users.createFakeUser({
 fictionalEmail: true,
 withPassword: true,
 });
 await u.services.users.createBapiUser(user);

 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: user.email, password: user.password });
 await u.po.expect.toBeSignedIn();

 await u.page.goToRelative('/page-protected');

 await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });

 await u.page.getByRole('button', { name: /sms code/i }).click();

 const testPhoneNumber = fakerPhoneNumber();
 await u.po.signIn.getPhoneNumberInput().fill(testPhoneNumber);
 await u.page.getByRole('button', { name: /continue/i }).click();

 await u.po.signIn.enterTestOtpCode();

 await u.page.getByText(/save these backup codes/i).waitFor({ state: 'visible', timeout: 10000 });

 await u.po.signIn.continue();

 await u.page.waitForAppUrl('/page-protected');
 await u.po.expect.toBeSignedIn();

 await user.deleteIfExists();
 });

 test('setup MFA with existing phone number - happy path', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 const user = u.services.users.createFakeUser({
 fictionalEmail: true,
 withPhoneNumber: true,
 withPassword: true,
 });
 await u.services.users.createBapiUser(user);

 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: user.email, password: user.password });
 await u.po.expect.toBeSignedIn();

 await u.page.goToRelative('/page-protected');

 await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });

 await u.page.getByRole('button', { name: /sms code/i }).click();

 const formattedPhoneNumber = stringPhoneNumber(user.phoneNumber);
 await u.page
 .getByRole('button', {
 name: formattedPhoneNumber,
 })
 .click();

 await u.page.getByText(/save these backup codes/i).waitFor({ state: 'visible', timeout: 10000 });

 await u.po.signIn.continue();

 await u.page.waitForAppUrl('/page-protected');
 await u.po.expect.toBeSignedIn();

 await user.deleteIfExists();
 });

 test('setup MFA with invalid phone number - error handling', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 const user = u.services.users.createFakeUser({
 fictionalEmail: true,
 withPassword: true,
 });
 await u.services.users.createBapiUser(user);

 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: user.email, password: user.password });
 await u.po.expect.toBeSignedIn();

 await u.page.goToRelative('/page-protected');

 await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });

 await u.page.getByRole('button', { name: /sms code/i }).click();

 const invalidPhoneNumber = '123091293193091311';
 await u.po.signIn.getPhoneNumberInput().fill(invalidPhoneNumber);
 await u.po.signIn.continue();
 // we need to improve this error message
 await expect(u.page.getByTestId('form-feedback-error')).toBeVisible();

 const validPhoneNumber = fakerPhoneNumber();
 await u.po.signIn.getPhoneNumberInput().fill(validPhoneNumber);
 await u.po.signIn.continue();

 await u.po.signIn.enterTestOtpCode();

 await u.page.getByText(/save these backup codes/i).waitFor({ state: 'visible', timeout: 10000 });

 await u.po.signIn.continue();

 await u.page.waitForAppUrl('/page-protected');
 await u.po.expect.toBeSignedIn();

 await user.deleteIfExists();
 });

 test('setup MFA with invalid verification code - error handling', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 const user = u.services.users.createFakeUser({
 fictionalEmail: true,
 withPassword: true,
 });
 await u.services.users.createBapiUser(user);

 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: user.email, password: user.password });
 await u.po.expect.toBeSignedIn();

 await u.page.goToRelative('/page-protected');

 await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });

 await u.page.getByRole('button', { name: /sms code/i }).click();

 const testPhoneNumber = fakerPhoneNumber();
 await u.po.signIn.getPhoneNumberInput().fill(testPhoneNumber);
 await u.po.signIn.continue();

 await u.po.signIn.enterOtpCode('111111', {
 awaitRequests: false,
 });

 await expect(u.page.getByTestId('form-feedback-error')).toBeVisible();

 await user.deleteIfExists();
 });

 test('can navigate back during MFA setup', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 const user = u.services.users.createFakeUser({
 fictionalEmail: true,
 withPhoneNumber: true,
 withPassword: true,
 });
 await u.services.users.createBapiUser(user);

 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: user.email, password: user.password });
 await u.po.expect.toBeSignedIn();

 await u.page.goToRelative('/page-protected');

 await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });

 await u.page.getByRole('button', { name: /sms code/i }).click();

 const formattedPhoneNumber = stringPhoneNumber(user.phoneNumber);
 await u.page
 .getByRole('button', {
 name: formattedPhoneNumber,
 })
 .waitFor({ state: 'visible' });

 await u.page
 .getByRole('button', { name: /cancel/i })
 .first()
 .click();

 await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });
 await u.page.getByRole('button', { name: /sms code/i }).waitFor({ state: 'visible' });

 await user.deleteIfExists();
 });
 },
);

10 changes: 10 additions & 0 deletions
packages/clerk-js/sandbox/app.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,7 @@ const AVAILABLE_COMPONENTS = [
 'oauthConsent',
 'taskChooseOrganization',
 'taskResetPassword',
 'taskSetupMFA',
] as const;
type AvailableComponent = (typeof AVAILABLE_COMPONENTS)[number];

Expand DownExpand Up@@ -137,6 +138,7 @@ const componentControls: Record<AvailableComponent, ComponentPropsControl> = {
 oauthConsent: buildComponentControls('oauthConsent'),
 taskChooseOrganization: buildComponentControls('taskChooseOrganization'),
 taskResetPassword: buildComponentControls('taskResetPassword'),
 taskSetupMFA: buildComponentControls('taskSetupMFA'),
};

declare global {
Expand DownExpand Up@@ -419,6 +421,14 @@ void (async () => {
 },
 );
 },
 '/task-setup-mfa': () => {
 Clerk.mountTaskSetupMfa(
 app,
 componentControls.taskSetupMFA.getProps() ?? {
 redirectUrlComplete: '/user-profile',
 },
 );
 },
 '/open-sign-in': () => {
 mountOpenSignInButton(app, componentControls.signIn.getProps() ?? {});
 },
Expand Down

8 changes: 8 additions & 0 deletions
packages/clerk-js/sandbox/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -169,6 +169,14 @@
 TaskChooseOrganization
 </a>
 </li>
 <li class="relative">
 <a
 class="relative isolate flex w-full rounded-md border border-white px-2 py-[0.4375rem] text-sm hover:bg-gray-50 aria-[current]:bg-gray-50"
 href="/task-setup-mfa"
 >
 TaskSetupMFA
 </a>
 </li>
 <li class="relative">
 <a
 class="relative isolate flex w-full rounded-md border border-white px-2 py-[0.4375rem] text-sm hover:bg-gray-50 aria-[current]:bg-gray-50"
Expand Down

23 changes: 23 additions & 0 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -113,6 +113,7 @@ import type {
 SignUpResource,
 TaskChooseOrganizationProps,
 TaskResetPasswordProps,
 TaskSetupMFAProps,
 TasksRedirectOptions,
 UnsubscribeCallback,
 UserAvatarProps,
Expand DownExpand Up@@ -1439,6 +1440,28 @@ export class Clerk implements ClerkInterface {
 void this.#clerkUi?.then(ui => ui.ensureMounted()).then(controls => controls.unmountComponent({ node }));
 };

 public mountTaskSetupMfa = (node: HTMLDivElement, props?: TaskSetupMFAProps) => {
 this.assertComponentsReady(this.#clerkUi);

 const component = 'TaskSetupMFA';
 void this.#clerkUi
 .then(ui => ui.ensureMounted())
 .then(controls =>
 controls.mountComponent({
 name: component,
 appearanceKey: 'taskSetupMfa',
 node,
 props,
 }),
 );

 this.telemetry?.record(eventPrebuiltComponentMounted('TaskSetupMfa', props));
 };

 public unmountTaskSetupMfa = (node: HTMLDivElement) => {
 void this.#clerkUi?.then(ui => ui.ensureMounted()).then(controls => controls.unmountComponent({ node }));
 };

 /**
 * `setActive` can be used to set the active session and/or organization.
 */
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -59,7 +59,7 @@
 "dev": "tsup --watch",
 "format": "node ../../scripts/format-package.mjs",
 "format:check": "node ../../scripts/format-package.mjs --check",
 "generate": "tsc src/utils/generate.ts && node src/utils/generate.js && prettier --write src/*.ts",
 "generate": "tsc -p tsconfig.generate.json && node --experimental-vm-modules src/utils/generate.js && rimraf tmp && prettier --write src/*.ts",
 "lint": "eslint src",
 "lint:attw": "attw --pack . --profile node16"
 },
Expand Down
Loading
Loading

, '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
feat(clerk-js,ui): Introduce setup MFA session task#7626

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

octoper
merged 3 commits into

from

Feb 3, 2026
 Merged


feat(clerk-js,ui): Introduce setup MFA session task
#7626
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
433ff6c

wip


octoper Jan 13, 2026
d8166a6

chore(localizations): Fix localization generate script


octoper Feb 3, 2026
ec92505

chore(ui): Guard username access


octoper Feb 3, 2026

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


12 changes: 12 additions & 0 deletions
.changeset/great-bats-attack.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
---
'@clerk/tanstack-react-start': minor
'@clerk/localizations': minor
'@clerk/react-router': minor
'@clerk/clerk-js': minor
'@clerk/nextjs': minor
'@clerk/shared': minor
'@clerk/react': minor
'@clerk/ui': minor
---

Introducing `setup_mfa` session task

8 changes: 8 additions & 0 deletions
integration/presets/envs.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -158,6 +158,13 @@ const withSessionTasksResetPassword = base
 .setEnvVariable('private', 'CLERK_SECRET_KEY', instanceKeys.get('with-session-tasks-reset-password').sk)
 .setEnvVariable('public', 'CLERK_PUBLISHABLE_KEY', instanceKeys.get('with-session-tasks-reset-password').pk);

const withSessionTasksSetupMfa = base
 .clone()
 .setId('withSessionTasksSetupMfa')
 .setEnvVariable('private', 'CLERK_SECRET_KEY', instanceKeys.get('with-session-tasks-setup-mfa').sk)
 .setEnvVariable('public', 'CLERK_PUBLISHABLE_KEY', instanceKeys.get('with-session-tasks-setup-mfa').pk)
 .setEnvVariable('private', 'CLERK_ENCRYPTION_KEY', constants.E2E_CLERK_ENCRYPTION_KEY || 'a-key');

const withBillingJwtV2 = base
 .clone()
 .setId('withBillingJwtV2')
Expand DownExpand Up@@ -216,6 +223,7 @@ export const envs = {
 withSessionTasks,
 withSessionTasksResetPassword,
 withSharedUIVariant,
 withSessionTasksSetupMfa,
 withSignInOrUpEmailLinksFlow,
 withSignInOrUpFlow,
 withSignInOrUpwithRestrictedModeFlow,
Expand Down

1 change: 1 addition & 0 deletions
integration/presets/longRunningApps.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@ export const createLongRunningApps = () => {
 { id: 'next.appRouter.withSignInOrUpEmailLinksFlow', config: next.appRouter, env: envs.withSignInOrUpEmailLinksFlow },
 { id: 'next.appRouter.withSessionTasks', config: next.appRouter, env: envs.withSessionTasks },
 { id: 'next.appRouter.withSessionTasksResetPassword', config: next.appRouter, env: envs.withSessionTasksResetPassword },
 { id: 'next.appRouter.withSessionTasksSetupMfa', config: next.appRouter, env: envs.withSessionTasksSetupMfa },
 { id: 'next.appRouter.withLegalConsent', config: next.appRouter, env: envs.withLegalConsent },
 { id: 'next.appRouter.withNeedsClientTrust', config: next.appRouter, env: envs.withNeedsClientTrust },
 { id: 'next.appRouter.withSharedUIVariant', config: next.appRouter, env: envs.withSharedUIVariant },
Expand Down

206 changes: 206 additions & 0 deletions
integration/tests/session-tasks-setup-mfa.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,206 @@
import { expect, test } from '@playwright/test';

import { appConfigs } from '../presets';
import { createTestUtils, testAgainstRunningApps } from '../testUtils';
import { stringPhoneNumber } from '../testUtils/phoneUtils';
import { fakerPhoneNumber } from '../testUtils/usersService';

testAgainstRunningApps({ withEnv: [appConfigs.envs.withSessionTasksSetupMfa] })(
 'session tasks setup-mfa flow @nextjs',
 ({ app }) => {
 test.describe.configure({ mode: 'serial' });

 test.afterAll(async () => {
 await app.teardown();
 });

 test.afterEach(async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.page.signOut();
 await u.page.context().clearCookies();
 });

 test('setup MFA with new phone number - happy path', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 const user = u.services.users.createFakeUser({
 fictionalEmail: true,
 withPassword: true,
 });
 await u.services.users.createBapiUser(user);

 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: user.email, password: user.password });
 await u.po.expect.toBeSignedIn();

 await u.page.goToRelative('/page-protected');

 await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });

 await u.page.getByRole('button', { name: /sms code/i }).click();

 const testPhoneNumber = fakerPhoneNumber();
 await u.po.signIn.getPhoneNumberInput().fill(testPhoneNumber);
 await u.page.getByRole('button', { name: /continue/i }).click();

 await u.po.signIn.enterTestOtpCode();

 await u.page.getByText(/save these backup codes/i).waitFor({ state: 'visible', timeout: 10000 });

 await u.po.signIn.continue();

 await u.page.waitForAppUrl('/page-protected');
 await u.po.expect.toBeSignedIn();

 await user.deleteIfExists();
 });

 test('setup MFA with existing phone number - happy path', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 const user = u.services.users.createFakeUser({
 fictionalEmail: true,
 withPhoneNumber: true,
 withPassword: true,
 });
 await u.services.users.createBapiUser(user);

 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: user.email, password: user.password });
 await u.po.expect.toBeSignedIn();

 await u.page.goToRelative('/page-protected');

 await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });

 await u.page.getByRole('button', { name: /sms code/i }).click();

 const formattedPhoneNumber = stringPhoneNumber(user.phoneNumber);
 await u.page
 .getByRole('button', {
 name: formattedPhoneNumber,
 })
 .click();

 await u.page.getByText(/save these backup codes/i).waitFor({ state: 'visible', timeout: 10000 });

 await u.po.signIn.continue();

 await u.page.waitForAppUrl('/page-protected');
 await u.po.expect.toBeSignedIn();

 await user.deleteIfExists();
 });

 test('setup MFA with invalid phone number - error handling', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 const user = u.services.users.createFakeUser({
 fictionalEmail: true,
 withPassword: true,
 });
 await u.services.users.createBapiUser(user);

 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: user.email, password: user.password });
 await u.po.expect.toBeSignedIn();

 await u.page.goToRelative('/page-protected');

 await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });

 await u.page.getByRole('button', { name: /sms code/i }).click();

 const invalidPhoneNumber = '123091293193091311';
 await u.po.signIn.getPhoneNumberInput().fill(invalidPhoneNumber);
 await u.po.signIn.continue();
 // we need to improve this error message
 await expect(u.page.getByTestId('form-feedback-error')).toBeVisible();

 const validPhoneNumber = fakerPhoneNumber();
 await u.po.signIn.getPhoneNumberInput().fill(validPhoneNumber);
 await u.po.signIn.continue();

 await u.po.signIn.enterTestOtpCode();

 await u.page.getByText(/save these backup codes/i).waitFor({ state: 'visible', timeout: 10000 });

 await u.po.signIn.continue();

 await u.page.waitForAppUrl('/page-protected');
 await u.po.expect.toBeSignedIn();

 await user.deleteIfExists();
 });

 test('setup MFA with invalid verification code - error handling', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 const user = u.services.users.createFakeUser({
 fictionalEmail: true,
 withPassword: true,
 });
 await u.services.users.createBapiUser(user);

 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: user.email, password: user.password });
 await u.po.expect.toBeSignedIn();

 await u.page.goToRelative('/page-protected');

 await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });

 await u.page.getByRole('button', { name: /sms code/i }).click();

 const testPhoneNumber = fakerPhoneNumber();
 await u.po.signIn.getPhoneNumberInput().fill(testPhoneNumber);
 await u.po.signIn.continue();

 await u.po.signIn.enterOtpCode('111111', {
 awaitRequests: false,
 });

 await expect(u.page.getByTestId('form-feedback-error')).toBeVisible();

 await user.deleteIfExists();
 });

 test('can navigate back during MFA setup', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 const user = u.services.users.createFakeUser({
 fictionalEmail: true,
 withPhoneNumber: true,
 withPassword: true,
 });
 await u.services.users.createBapiUser(user);

 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: user.email, password: user.password });
 await u.po.expect.toBeSignedIn();

 await u.page.goToRelative('/page-protected');

 await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });

 await u.page.getByRole('button', { name: /sms code/i }).click();

 const formattedPhoneNumber = stringPhoneNumber(user.phoneNumber);
 await u.page
 .getByRole('button', {
 name: formattedPhoneNumber,
 })
 .waitFor({ state: 'visible' });

 await u.page
 .getByRole('button', { name: /cancel/i })
 .first()
 .click();

 await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });
 await u.page.getByRole('button', { name: /sms code/i }).waitFor({ state: 'visible' });

 await user.deleteIfExists();
 });
 },
);

10 changes: 10 additions & 0 deletions
packages/clerk-js/sandbox/app.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,7 @@ const AVAILABLE_COMPONENTS = [
 'oauthConsent',
 'taskChooseOrganization',
 'taskResetPassword',
 'taskSetupMFA',
] as const;
type AvailableComponent = (typeof AVAILABLE_COMPONENTS)[number];

Expand DownExpand Up@@ -137,6 +138,7 @@ const componentControls: Record<AvailableComponent, ComponentPropsControl> = {
 oauthConsent: buildComponentControls('oauthConsent'),
 taskChooseOrganization: buildComponentControls('taskChooseOrganization'),
 taskResetPassword: buildComponentControls('taskResetPassword'),
 taskSetupMFA: buildComponentControls('taskSetupMFA'),
};

declare global {
Expand DownExpand Up@@ -419,6 +421,14 @@ void (async () => {
 },
 );
 },
 '/task-setup-mfa': () => {
 Clerk.mountTaskSetupMfa(
 app,
 componentControls.taskSetupMFA.getProps() ?? {
 redirectUrlComplete: '/user-profile',
 },
 );
 },
 '/open-sign-in': () => {
 mountOpenSignInButton(app, componentControls.signIn.getProps() ?? {});
 },
Expand Down

8 changes: 8 additions & 0 deletions
packages/clerk-js/sandbox/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -169,6 +169,14 @@
 TaskChooseOrganization
 </a>
 </li>
 <li class="relative">
 <a
 class="relative isolate flex w-full rounded-md border border-white px-2 py-[0.4375rem] text-sm hover:bg-gray-50 aria-[current]:bg-gray-50"
 href="/task-setup-mfa"
 >
 TaskSetupMFA
 </a>
 </li>
 <li class="relative">
 <a
 class="relative isolate flex w-full rounded-md border border-white px-2 py-[0.4375rem] text-sm hover:bg-gray-50 aria-[current]:bg-gray-50"
Expand Down

23 changes: 23 additions & 0 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -113,6 +113,7 @@ import type {
 SignUpResource,
 TaskChooseOrganizationProps,
 TaskResetPasswordProps,
 TaskSetupMFAProps,
 TasksRedirectOptions,
 UnsubscribeCallback,
 UserAvatarProps,
Expand DownExpand Up@@ -1439,6 +1440,28 @@ export class Clerk implements ClerkInterface {
 void this.#clerkUi?.then(ui => ui.ensureMounted()).then(controls => controls.unmountComponent({ node }));
 };

 public mountTaskSetupMfa = (node: HTMLDivElement, props?: TaskSetupMFAProps) => {
 this.assertComponentsReady(this.#clerkUi);

 const component = 'TaskSetupMFA';
 void this.#clerkUi
 .then(ui => ui.ensureMounted())
 .then(controls =>
 controls.mountComponent({
 name: component,
 appearanceKey: 'taskSetupMfa',
 node,
 props,
 }),
 );

 this.telemetry?.record(eventPrebuiltComponentMounted('TaskSetupMfa', props));
 };

 public unmountTaskSetupMfa = (node: HTMLDivElement) => {
 void this.#clerkUi?.then(ui => ui.ensureMounted()).then(controls => controls.unmountComponent({ node }));
 };

 /**
 * `setActive` can be used to set the active session and/or organization.
 */
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -59,7 +59,7 @@
 "dev": "tsup --watch",
 "format": "node ../../scripts/format-package.mjs",
 "format:check": "node ../../scripts/format-package.mjs --check",
 "generate": "tsc src/utils/generate.ts && node src/utils/generate.js && prettier --write src/*.ts",
 "generate": "tsc -p tsconfig.generate.json && node --experimental-vm-modules src/utils/generate.js && rimraf tmp && prettier --write src/*.ts",
 "lint": "eslint src",
 "lint:attw": "attw --pack . --profile node16"
 },
Expand Down
Loading
Loading

, '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
feat(clerk-js,ui): Introduce setup MFA session task#7626

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

octoper
merged 3 commits into

from

Feb 3, 2026
 Merged


feat(clerk-js,ui): Introduce setup MFA session task
#7626
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
433ff6c

wip


octoper Jan 13, 2026
d8166a6

chore(localizations): Fix localization generate script


octoper Feb 3, 2026
ec92505

chore(ui): Guard username access


octoper Feb 3, 2026

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


12 changes: 12 additions & 0 deletions
.changeset/great-bats-attack.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
---
'@clerk/tanstack-react-start': minor
'@clerk/localizations': minor
'@clerk/react-router': minor
'@clerk/clerk-js': minor
'@clerk/nextjs': minor
'@clerk/shared': minor
'@clerk/react': minor
'@clerk/ui': minor
---

Introducing `setup_mfa` session task

8 changes: 8 additions & 0 deletions
integration/presets/envs.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -158,6 +158,13 @@ const withSessionTasksResetPassword = base
 .setEnvVariable('private', 'CLERK_SECRET_KEY', instanceKeys.get('with-session-tasks-reset-password').sk)
 .setEnvVariable('public', 'CLERK_PUBLISHABLE_KEY', instanceKeys.get('with-session-tasks-reset-password').pk);

const withSessionTasksSetupMfa = base
 .clone()
 .setId('withSessionTasksSetupMfa')
 .setEnvVariable('private', 'CLERK_SECRET_KEY', instanceKeys.get('with-session-tasks-setup-mfa').sk)
 .setEnvVariable('public', 'CLERK_PUBLISHABLE_KEY', instanceKeys.get('with-session-tasks-setup-mfa').pk)
 .setEnvVariable('private', 'CLERK_ENCRYPTION_KEY', constants.E2E_CLERK_ENCRYPTION_KEY || 'a-key');

const withBillingJwtV2 = base
 .clone()
 .setId('withBillingJwtV2')
Expand DownExpand Up@@ -216,6 +223,7 @@ export const envs = {
 withSessionTasks,
 withSessionTasksResetPassword,
 withSharedUIVariant,
 withSessionTasksSetupMfa,
 withSignInOrUpEmailLinksFlow,
 withSignInOrUpFlow,
 withSignInOrUpwithRestrictedModeFlow,
Expand Down

1 change: 1 addition & 0 deletions
integration/presets/longRunningApps.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@ export const createLongRunningApps = () => {
 { id: 'next.appRouter.withSignInOrUpEmailLinksFlow', config: next.appRouter, env: envs.withSignInOrUpEmailLinksFlow },
 { id: 'next.appRouter.withSessionTasks', config: next.appRouter, env: envs.withSessionTasks },
 { id: 'next.appRouter.withSessionTasksResetPassword', config: next.appRouter, env: envs.withSessionTasksResetPassword },
 { id: 'next.appRouter.withSessionTasksSetupMfa', config: next.appRouter, env: envs.withSessionTasksSetupMfa },
 { id: 'next.appRouter.withLegalConsent', config: next.appRouter, env: envs.withLegalConsent },
 { id: 'next.appRouter.withNeedsClientTrust', config: next.appRouter, env: envs.withNeedsClientTrust },
 { id: 'next.appRouter.withSharedUIVariant', config: next.appRouter, env: envs.withSharedUIVariant },
Expand Down

206 changes: 206 additions & 0 deletions
integration/tests/session-tasks-setup-mfa.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,206 @@
import { expect, test } from '@playwright/test';

import { appConfigs } from '../presets';
import { createTestUtils, testAgainstRunningApps } from '../testUtils';
import { stringPhoneNumber } from '../testUtils/phoneUtils';
import { fakerPhoneNumber } from '../testUtils/usersService';

testAgainstRunningApps({ withEnv: [appConfigs.envs.withSessionTasksSetupMfa] })(
 'session tasks setup-mfa flow @nextjs',
 ({ app }) => {
 test.describe.configure({ mode: 'serial' });

 test.afterAll(async () => {
 await app.teardown();
 });

 test.afterEach(async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.page.signOut();
 await u.page.context().clearCookies();
 });

 test('setup MFA with new phone number - happy path', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 const user = u.services.users.createFakeUser({
 fictionalEmail: true,
 withPassword: true,
 });
 await u.services.users.createBapiUser(user);

 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: user.email, password: user.password });
 await u.po.expect.toBeSignedIn();

 await u.page.goToRelative('/page-protected');

 await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });

 await u.page.getByRole('button', { name: /sms code/i }).click();

 const testPhoneNumber = fakerPhoneNumber();
 await u.po.signIn.getPhoneNumberInput().fill(testPhoneNumber);
 await u.page.getByRole('button', { name: /continue/i }).click();

 await u.po.signIn.enterTestOtpCode();

 await u.page.getByText(/save these backup codes/i).waitFor({ state: 'visible', timeout: 10000 });

 await u.po.signIn.continue();

 await u.page.waitForAppUrl('/page-protected');
 await u.po.expect.toBeSignedIn();

 await user.deleteIfExists();
 });

 test('setup MFA with existing phone number - happy path', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 const user = u.services.users.createFakeUser({
 fictionalEmail: true,
 withPhoneNumber: true,
 withPassword: true,
 });
 await u.services.users.createBapiUser(user);

 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: user.email, password: user.password });
 await u.po.expect.toBeSignedIn();

 await u.page.goToRelative('/page-protected');

 await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });

 await u.page.getByRole('button', { name: /sms code/i }).click();

 const formattedPhoneNumber = stringPhoneNumber(user.phoneNumber);
 await u.page
 .getByRole('button', {
 name: formattedPhoneNumber,
 })
 .click();

 await u.page.getByText(/save these backup codes/i).waitFor({ state: 'visible', timeout: 10000 });

 await u.po.signIn.continue();

 await u.page.waitForAppUrl('/page-protected');
 await u.po.expect.toBeSignedIn();

 await user.deleteIfExists();
 });

 test('setup MFA with invalid phone number - error handling', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 const user = u.services.users.createFakeUser({
 fictionalEmail: true,
 withPassword: true,
 });
 await u.services.users.createBapiUser(user);

 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: user.email, password: user.password });
 await u.po.expect.toBeSignedIn();

 await u.page.goToRelative('/page-protected');

 await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });

 await u.page.getByRole('button', { name: /sms code/i }).click();

 const invalidPhoneNumber = '123091293193091311';
 await u.po.signIn.getPhoneNumberInput().fill(invalidPhoneNumber);
 await u.po.signIn.continue();
 // we need to improve this error message
 await expect(u.page.getByTestId('form-feedback-error')).toBeVisible();

 const validPhoneNumber = fakerPhoneNumber();
 await u.po.signIn.getPhoneNumberInput().fill(validPhoneNumber);
 await u.po.signIn.continue();

 await u.po.signIn.enterTestOtpCode();

 await u.page.getByText(/save these backup codes/i).waitFor({ state: 'visible', timeout: 10000 });

 await u.po.signIn.continue();

 await u.page.waitForAppUrl('/page-protected');
 await u.po.expect.toBeSignedIn();

 await user.deleteIfExists();
 });

 test('setup MFA with invalid verification code - error handling', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 const user = u.services.users.createFakeUser({
 fictionalEmail: true,
 withPassword: true,
 });
 await u.services.users.createBapiUser(user);

 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: user.email, password: user.password });
 await u.po.expect.toBeSignedIn();

 await u.page.goToRelative('/page-protected');

 await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });

 await u.page.getByRole('button', { name: /sms code/i }).click();

 const testPhoneNumber = fakerPhoneNumber();
 await u.po.signIn.getPhoneNumberInput().fill(testPhoneNumber);
 await u.po.signIn.continue();

 await u.po.signIn.enterOtpCode('111111', {
 awaitRequests: false,
 });

 await expect(u.page.getByTestId('form-feedback-error')).toBeVisible();

 await user.deleteIfExists();
 });

 test('can navigate back during MFA setup', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 const user = u.services.users.createFakeUser({
 fictionalEmail: true,
 withPhoneNumber: true,
 withPassword: true,
 });
 await u.services.users.createBapiUser(user);

 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: user.email, password: user.password });
 await u.po.expect.toBeSignedIn();

 await u.page.goToRelative('/page-protected');

 await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });

 await u.page.getByRole('button', { name: /sms code/i }).click();

 const formattedPhoneNumber = stringPhoneNumber(user.phoneNumber);
 await u.page
 .getByRole('button', {
 name: formattedPhoneNumber,
 })
 .waitFor({ state: 'visible' });

 await u.page
 .getByRole('button', { name: /cancel/i })
 .first()
 .click();

 await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });
 await u.page.getByRole('button', { name: /sms code/i }).waitFor({ state: 'visible' });

 await user.deleteIfExists();
 });
 },
);

10 changes: 10 additions & 0 deletions
packages/clerk-js/sandbox/app.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,7 @@ const AVAILABLE_COMPONENTS = [
 'oauthConsent',
 'taskChooseOrganization',
 'taskResetPassword',
 'taskSetupMFA',
] as const;
type AvailableComponent = (typeof AVAILABLE_COMPONENTS)[number];

Expand DownExpand Up@@ -137,6 +138,7 @@ const componentControls: Record<AvailableComponent, ComponentPropsControl> = {
 oauthConsent: buildComponentControls('oauthConsent'),
 taskChooseOrganization: buildComponentControls('taskChooseOrganization'),
 taskResetPassword: buildComponentControls('taskResetPassword'),
 taskSetupMFA: buildComponentControls('taskSetupMFA'),
};

declare global {
Expand DownExpand Up@@ -419,6 +421,14 @@ void (async () => {
 },
 );
 },
 '/task-setup-mfa': () => {
 Clerk.mountTaskSetupMfa(
 app,
 componentControls.taskSetupMFA.getProps() ?? {
 redirectUrlComplete: '/user-profile',
 },
 );
 },
 '/open-sign-in': () => {
 mountOpenSignInButton(app, componentControls.signIn.getProps() ?? {});
 },
Expand Down

8 changes: 8 additions & 0 deletions
packages/clerk-js/sandbox/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -169,6 +169,14 @@
 TaskChooseOrganization
 </a>
 </li>
 <li class="relative">
 <a
 class="relative isolate flex w-full rounded-md border border-white px-2 py-[0.4375rem] text-sm hover:bg-gray-50 aria-[current]:bg-gray-50"
 href="/task-setup-mfa"
 >
 TaskSetupMFA
 </a>
 </li>
 <li class="relative">
 <a
 class="relative isolate flex w-full rounded-md border border-white px-2 py-[0.4375rem] text-sm hover:bg-gray-50 aria-[current]:bg-gray-50"
Expand Down

23 changes: 23 additions & 0 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -113,6 +113,7 @@ import type {
 SignUpResource,
 TaskChooseOrganizationProps,
 TaskResetPasswordProps,
 TaskSetupMFAProps,
 TasksRedirectOptions,
 UnsubscribeCallback,
 UserAvatarProps,
Expand DownExpand Up@@ -1439,6 +1440,28 @@ export class Clerk implements ClerkInterface {
 void this.#clerkUi?.then(ui => ui.ensureMounted()).then(controls => controls.unmountComponent({ node }));
 };

 public mountTaskSetupMfa = (node: HTMLDivElement, props?: TaskSetupMFAProps) => {
 this.assertComponentsReady(this.#clerkUi);

 const component = 'TaskSetupMFA';
 void this.#clerkUi
 .then(ui => ui.ensureMounted())
 .then(controls =>
 controls.mountComponent({
 name: component,
 appearanceKey: 'taskSetupMfa',
 node,
 props,
 }),
 );

 this.telemetry?.record(eventPrebuiltComponentMounted('TaskSetupMfa', props));
 };

 public unmountTaskSetupMfa = (node: HTMLDivElement) => {
 void this.#clerkUi?.then(ui => ui.ensureMounted()).then(controls => controls.unmountComponent({ node }));
 };

 /**
 * `setActive` can be used to set the active session and/or organization.
 */
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -59,7 +59,7 @@
 "dev": "tsup --watch",
 "format": "node ../../scripts/format-package.mjs",
 "format:check": "node ../../scripts/format-package.mjs --check",
 "generate": "tsc src/utils/generate.ts && node src/utils/generate.js && prettier --write src/*.ts",
 "generate": "tsc -p tsconfig.generate.json && node --experimental-vm-modules src/utils/generate.js && rimraf tmp && prettier --write src/*.ts",
 "lint": "eslint src",
 "lint:attw": "attw --pack . --profile node16"
 },
Expand Down
Loading
Loading

, '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
feat(clerk-js,ui): Introduce setup MFA session task#7626

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

octoper
merged 3 commits into

from

Feb 3, 2026
 Merged


feat(clerk-js,ui): Introduce setup MFA session task
#7626
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
433ff6c

wip


octoper Jan 13, 2026
d8166a6

chore(localizations): Fix localization generate script


octoper Feb 3, 2026
ec92505

chore(ui): Guard username access


octoper Feb 3, 2026

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


12 changes: 12 additions & 0 deletions
.changeset/great-bats-attack.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
---
'@clerk/tanstack-react-start': minor
'@clerk/localizations': minor
'@clerk/react-router': minor
'@clerk/clerk-js': minor
'@clerk/nextjs': minor
'@clerk/shared': minor
'@clerk/react': minor
'@clerk/ui': minor
---

Introducing `setup_mfa` session task

8 changes: 8 additions & 0 deletions
integration/presets/envs.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -158,6 +158,13 @@ const withSessionTasksResetPassword = base
 .setEnvVariable('private', 'CLERK_SECRET_KEY', instanceKeys.get('with-session-tasks-reset-password').sk)
 .setEnvVariable('public', 'CLERK_PUBLISHABLE_KEY', instanceKeys.get('with-session-tasks-reset-password').pk);

const withSessionTasksSetupMfa = base
 .clone()
 .setId('withSessionTasksSetupMfa')
 .setEnvVariable('private', 'CLERK_SECRET_KEY', instanceKeys.get('with-session-tasks-setup-mfa').sk)
 .setEnvVariable('public', 'CLERK_PUBLISHABLE_KEY', instanceKeys.get('with-session-tasks-setup-mfa').pk)
 .setEnvVariable('private', 'CLERK_ENCRYPTION_KEY', constants.E2E_CLERK_ENCRYPTION_KEY || 'a-key');

const withBillingJwtV2 = base
 .clone()
 .setId('withBillingJwtV2')
Expand DownExpand Up@@ -216,6 +223,7 @@ export const envs = {
 withSessionTasks,
 withSessionTasksResetPassword,
 withSharedUIVariant,
 withSessionTasksSetupMfa,
 withSignInOrUpEmailLinksFlow,
 withSignInOrUpFlow,
 withSignInOrUpwithRestrictedModeFlow,
Expand Down

1 change: 1 addition & 0 deletions
integration/presets/longRunningApps.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@ export const createLongRunningApps = () => {
 { id: 'next.appRouter.withSignInOrUpEmailLinksFlow', config: next.appRouter, env: envs.withSignInOrUpEmailLinksFlow },
 { id: 'next.appRouter.withSessionTasks', config: next.appRouter, env: envs.withSessionTasks },
 { id: 'next.appRouter.withSessionTasksResetPassword', config: next.appRouter, env: envs.withSessionTasksResetPassword },
 { id: 'next.appRouter.withSessionTasksSetupMfa', config: next.appRouter, env: envs.withSessionTasksSetupMfa },
 { id: 'next.appRouter.withLegalConsent', config: next.appRouter, env: envs.withLegalConsent },
 { id: 'next.appRouter.withNeedsClientTrust', config: next.appRouter, env: envs.withNeedsClientTrust },
 { id: 'next.appRouter.withSharedUIVariant', config: next.appRouter, env: envs.withSharedUIVariant },
Expand Down

206 changes: 206 additions & 0 deletions
integration/tests/session-tasks-setup-mfa.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,206 @@
import { expect, test } from '@playwright/test';

import { appConfigs } from '../presets';
import { createTestUtils, testAgainstRunningApps } from '../testUtils';
import { stringPhoneNumber } from '../testUtils/phoneUtils';
import { fakerPhoneNumber } from '../testUtils/usersService';

testAgainstRunningApps({ withEnv: [appConfigs.envs.withSessionTasksSetupMfa] })(
 'session tasks setup-mfa flow @nextjs',
 ({ app }) => {
 test.describe.configure({ mode: 'serial' });

 test.afterAll(async () => {
 await app.teardown();
 });

 test.afterEach(async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.page.signOut();
 await u.page.context().clearCookies();
 });

 test('setup MFA with new phone number - happy path', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 const user = u.services.users.createFakeUser({
 fictionalEmail: true,
 withPassword: true,
 });
 await u.services.users.createBapiUser(user);

 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: user.email, password: user.password });
 await u.po.expect.toBeSignedIn();

 await u.page.goToRelative('/page-protected');

 await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });

 await u.page.getByRole('button', { name: /sms code/i }).click();

 const testPhoneNumber = fakerPhoneNumber();
 await u.po.signIn.getPhoneNumberInput().fill(testPhoneNumber);
 await u.page.getByRole('button', { name: /continue/i }).click();

 await u.po.signIn.enterTestOtpCode();

 await u.page.getByText(/save these backup codes/i).waitFor({ state: 'visible', timeout: 10000 });

 await u.po.signIn.continue();

 await u.page.waitForAppUrl('/page-protected');
 await u.po.expect.toBeSignedIn();

 await user.deleteIfExists();
 });

 test('setup MFA with existing phone number - happy path', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 const user = u.services.users.createFakeUser({
 fictionalEmail: true,
 withPhoneNumber: true,
 withPassword: true,
 });
 await u.services.users.createBapiUser(user);

 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: user.email, password: user.password });
 await u.po.expect.toBeSignedIn();

 await u.page.goToRelative('/page-protected');

 await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });

 await u.page.getByRole('button', { name: /sms code/i }).click();

 const formattedPhoneNumber = stringPhoneNumber(user.phoneNumber);
 await u.page
 .getByRole('button', {
 name: formattedPhoneNumber,
 })
 .click();

 await u.page.getByText(/save these backup codes/i).waitFor({ state: 'visible', timeout: 10000 });

 await u.po.signIn.continue();

 await u.page.waitForAppUrl('/page-protected');
 await u.po.expect.toBeSignedIn();

 await user.deleteIfExists();
 });

 test('setup MFA with invalid phone number - error handling', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 const user = u.services.users.createFakeUser({
 fictionalEmail: true,
 withPassword: true,
 });
 await u.services.users.createBapiUser(user);

 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: user.email, password: user.password });
 await u.po.expect.toBeSignedIn();

 await u.page.goToRelative('/page-protected');

 await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });

 await u.page.getByRole('button', { name: /sms code/i }).click();

 const invalidPhoneNumber = '123091293193091311';
 await u.po.signIn.getPhoneNumberInput().fill(invalidPhoneNumber);
 await u.po.signIn.continue();
 // we need to improve this error message
 await expect(u.page.getByTestId('form-feedback-error')).toBeVisible();

 const validPhoneNumber = fakerPhoneNumber();
 await u.po.signIn.getPhoneNumberInput().fill(validPhoneNumber);
 await u.po.signIn.continue();

 await u.po.signIn.enterTestOtpCode();

 await u.page.getByText(/save these backup codes/i).waitFor({ state: 'visible', timeout: 10000 });

 await u.po.signIn.continue();

 await u.page.waitForAppUrl('/page-protected');
 await u.po.expect.toBeSignedIn();

 await user.deleteIfExists();
 });

 test('setup MFA with invalid verification code - error handling', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 const user = u.services.users.createFakeUser({
 fictionalEmail: true,
 withPassword: true,
 });
 await u.services.users.createBapiUser(user);

 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: user.email, password: user.password });
 await u.po.expect.toBeSignedIn();

 await u.page.goToRelative('/page-protected');

 await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });

 await u.page.getByRole('button', { name: /sms code/i }).click();

 const testPhoneNumber = fakerPhoneNumber();
 await u.po.signIn.getPhoneNumberInput().fill(testPhoneNumber);
 await u.po.signIn.continue();

 await u.po.signIn.enterOtpCode('111111', {
 awaitRequests: false,
 });

 await expect(u.page.getByTestId('form-feedback-error')).toBeVisible();

 await user.deleteIfExists();
 });

 test('can navigate back during MFA setup', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 const user = u.services.users.createFakeUser({
 fictionalEmail: true,
 withPhoneNumber: true,
 withPassword: true,
 });
 await u.services.users.createBapiUser(user);

 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: user.email, password: user.password });
 await u.po.expect.toBeSignedIn();

 await u.page.goToRelative('/page-protected');

 await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });

 await u.page.getByRole('button', { name: /sms code/i }).click();

 const formattedPhoneNumber = stringPhoneNumber(user.phoneNumber);
 await u.page
 .getByRole('button', {
 name: formattedPhoneNumber,
 })
 .waitFor({ state: 'visible' });

 await u.page
 .getByRole('button', { name: /cancel/i })
 .first()
 .click();

 await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });
 await u.page.getByRole('button', { name: /sms code/i }).waitFor({ state: 'visible' });

 await user.deleteIfExists();
 });
 },
);

10 changes: 10 additions & 0 deletions
packages/clerk-js/sandbox/app.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,7 @@ const AVAILABLE_COMPONENTS = [
 'oauthConsent',
 'taskChooseOrganization',
 'taskResetPassword',
 'taskSetupMFA',
] as const;
type AvailableComponent = (typeof AVAILABLE_COMPONENTS)[number];

Expand DownExpand Up@@ -137,6 +138,7 @@ const componentControls: Record<AvailableComponent, ComponentPropsControl> = {
 oauthConsent: buildComponentControls('oauthConsent'),
 taskChooseOrganization: buildComponentControls('taskChooseOrganization'),
 taskResetPassword: buildComponentControls('taskResetPassword'),
 taskSetupMFA: buildComponentControls('taskSetupMFA'),
};

declare global {
Expand DownExpand Up@@ -419,6 +421,14 @@ void (async () => {
 },
 );
 },
 '/task-setup-mfa': () => {
 Clerk.mountTaskSetupMfa(
 app,
 componentControls.taskSetupMFA.getProps() ?? {
 redirectUrlComplete: '/user-profile',
 },
 );
 },
 '/open-sign-in': () => {
 mountOpenSignInButton(app, componentControls.signIn.getProps() ?? {});
 },
Expand Down

8 changes: 8 additions & 0 deletions
packages/clerk-js/sandbox/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -169,6 +169,14 @@
 TaskChooseOrganization
 </a>
 </li>
 <li class="relative">
 <a
 class="relative isolate flex w-full rounded-md border border-white px-2 py-[0.4375rem] text-sm hover:bg-gray-50 aria-[current]:bg-gray-50"
 href="/task-setup-mfa"
 >
 TaskSetupMFA
 </a>
 </li>
 <li class="relative">
 <a
 class="relative isolate flex w-full rounded-md border border-white px-2 py-[0.4375rem] text-sm hover:bg-gray-50 aria-[current]:bg-gray-50"
Expand Down

23 changes: 23 additions & 0 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -113,6 +113,7 @@ import type {
 SignUpResource,
 TaskChooseOrganizationProps,
 TaskResetPasswordProps,
 TaskSetupMFAProps,
 TasksRedirectOptions,
 UnsubscribeCallback,
 UserAvatarProps,
Expand DownExpand Up@@ -1439,6 +1440,28 @@ export class Clerk implements ClerkInterface {
 void this.#clerkUi?.then(ui => ui.ensureMounted()).then(controls => controls.unmountComponent({ node }));
 };

 public mountTaskSetupMfa = (node: HTMLDivElement, props?: TaskSetupMFAProps) => {
 this.assertComponentsReady(this.#clerkUi);

 const component = 'TaskSetupMFA';
 void this.#clerkUi
 .then(ui => ui.ensureMounted())
 .then(controls =>
 controls.mountComponent({
 name: component,
 appearanceKey: 'taskSetupMfa',
 node,
 props,
 }),
 );

 this.telemetry?.record(eventPrebuiltComponentMounted('TaskSetupMfa', props));
 };

 public unmountTaskSetupMfa = (node: HTMLDivElement) => {
 void this.#clerkUi?.then(ui => ui.ensureMounted()).then(controls => controls.unmountComponent({ node }));
 };

 /**
 * `setActive` can be used to set the active session and/or organization.
 */
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -59,7 +59,7 @@
 "dev": "tsup --watch",
 "format": "node ../../scripts/format-package.mjs",
 "format:check": "node ../../scripts/format-package.mjs --check",
 "generate": "tsc src/utils/generate.ts && node src/utils/generate.js && prettier --write src/*.ts",
 "generate": "tsc -p tsconfig.generate.json && node --experimental-vm-modules src/utils/generate.js && rimraf tmp && prettier --write src/*.ts",
 "lint": "eslint src",
 "lint:attw": "attw --pack . --profile node16"
 },
Expand Down
Loading
Loading

, '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
feat(clerk-js,ui): Introduce setup MFA session task#7626

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

octoper
merged 3 commits into

from

Feb 3, 2026
 Merged


feat(clerk-js,ui): Introduce setup MFA session task
#7626
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
433ff6c

wip


octoper Jan 13, 2026
d8166a6

chore(localizations): Fix localization generate script


octoper Feb 3, 2026
ec92505

chore(ui): Guard username access


octoper Feb 3, 2026

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


12 changes: 12 additions & 0 deletions
.changeset/great-bats-attack.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
---
'@clerk/tanstack-react-start': minor
'@clerk/localizations': minor
'@clerk/react-router': minor
'@clerk/clerk-js': minor
'@clerk/nextjs': minor
'@clerk/shared': minor
'@clerk/react': minor
'@clerk/ui': minor
---

Introducing `setup_mfa` session task

8 changes: 8 additions & 0 deletions
integration/presets/envs.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -158,6 +158,13 @@ const withSessionTasksResetPassword = base
 .setEnvVariable('private', 'CLERK_SECRET_KEY', instanceKeys.get('with-session-tasks-reset-password').sk)
 .setEnvVariable('public', 'CLERK_PUBLISHABLE_KEY', instanceKeys.get('with-session-tasks-reset-password').pk);

const withSessionTasksSetupMfa = base
 .clone()
 .setId('withSessionTasksSetupMfa')
 .setEnvVariable('private', 'CLERK_SECRET_KEY', instanceKeys.get('with-session-tasks-setup-mfa').sk)
 .setEnvVariable('public', 'CLERK_PUBLISHABLE_KEY', instanceKeys.get('with-session-tasks-setup-mfa').pk)
 .setEnvVariable('private', 'CLERK_ENCRYPTION_KEY', constants.E2E_CLERK_ENCRYPTION_KEY || 'a-key');

const withBillingJwtV2 = base
 .clone()
 .setId('withBillingJwtV2')
Expand DownExpand Up@@ -216,6 +223,7 @@ export const envs = {
 withSessionTasks,
 withSessionTasksResetPassword,
 withSharedUIVariant,
 withSessionTasksSetupMfa,
 withSignInOrUpEmailLinksFlow,
 withSignInOrUpFlow,
 withSignInOrUpwithRestrictedModeFlow,
Expand Down

1 change: 1 addition & 0 deletions
integration/presets/longRunningApps.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@ export const createLongRunningApps = () => {
 { id: 'next.appRouter.withSignInOrUpEmailLinksFlow', config: next.appRouter, env: envs.withSignInOrUpEmailLinksFlow },
 { id: 'next.appRouter.withSessionTasks', config: next.appRouter, env: envs.withSessionTasks },
 { id: 'next.appRouter.withSessionTasksResetPassword', config: next.appRouter, env: envs.withSessionTasksResetPassword },
 { id: 'next.appRouter.withSessionTasksSetupMfa', config: next.appRouter, env: envs.withSessionTasksSetupMfa },
 { id: 'next.appRouter.withLegalConsent', config: next.appRouter, env: envs.withLegalConsent },
 { id: 'next.appRouter.withNeedsClientTrust', config: next.appRouter, env: envs.withNeedsClientTrust },
 { id: 'next.appRouter.withSharedUIVariant', config: next.appRouter, env: envs.withSharedUIVariant },
Expand Down

206 changes: 206 additions & 0 deletions
integration/tests/session-tasks-setup-mfa.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,206 @@
import { expect, test } from '@playwright/test';

import { appConfigs } from '../presets';
import { createTestUtils, testAgainstRunningApps } from '../testUtils';
import { stringPhoneNumber } from '../testUtils/phoneUtils';
import { fakerPhoneNumber } from '../testUtils/usersService';

testAgainstRunningApps({ withEnv: [appConfigs.envs.withSessionTasksSetupMfa] })(
 'session tasks setup-mfa flow @nextjs',
 ({ app }) => {
 test.describe.configure({ mode: 'serial' });

 test.afterAll(async () => {
 await app.teardown();
 });

 test.afterEach(async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.page.signOut();
 await u.page.context().clearCookies();
 });

 test('setup MFA with new phone number - happy path', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 const user = u.services.users.createFakeUser({
 fictionalEmail: true,
 withPassword: true,
 });
 await u.services.users.createBapiUser(user);

 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: user.email, password: user.password });
 await u.po.expect.toBeSignedIn();

 await u.page.goToRelative('/page-protected');

 await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });

 await u.page.getByRole('button', { name: /sms code/i }).click();

 const testPhoneNumber = fakerPhoneNumber();
 await u.po.signIn.getPhoneNumberInput().fill(testPhoneNumber);
 await u.page.getByRole('button', { name: /continue/i }).click();

 await u.po.signIn.enterTestOtpCode();

 await u.page.getByText(/save these backup codes/i).waitFor({ state: 'visible', timeout: 10000 });

 await u.po.signIn.continue();

 await u.page.waitForAppUrl('/page-protected');
 await u.po.expect.toBeSignedIn();

 await user.deleteIfExists();
 });

 test('setup MFA with existing phone number - happy path', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 const user = u.services.users.createFakeUser({
 fictionalEmail: true,
 withPhoneNumber: true,
 withPassword: true,
 });
 await u.services.users.createBapiUser(user);

 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: user.email, password: user.password });
 await u.po.expect.toBeSignedIn();

 await u.page.goToRelative('/page-protected');

 await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });

 await u.page.getByRole('button', { name: /sms code/i }).click();

 const formattedPhoneNumber = stringPhoneNumber(user.phoneNumber);
 await u.page
 .getByRole('button', {
 name: formattedPhoneNumber,
 })
 .click();

 await u.page.getByText(/save these backup codes/i).waitFor({ state: 'visible', timeout: 10000 });

 await u.po.signIn.continue();

 await u.page.waitForAppUrl('/page-protected');
 await u.po.expect.toBeSignedIn();

 await user.deleteIfExists();
 });

 test('setup MFA with invalid phone number - error handling', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 const user = u.services.users.createFakeUser({
 fictionalEmail: true,
 withPassword: true,
 });
 await u.services.users.createBapiUser(user);

 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: user.email, password: user.password });
 await u.po.expect.toBeSignedIn();

 await u.page.goToRelative('/page-protected');

 await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });

 await u.page.getByRole('button', { name: /sms code/i }).click();

 const invalidPhoneNumber = '123091293193091311';
 await u.po.signIn.getPhoneNumberInput().fill(invalidPhoneNumber);
 await u.po.signIn.continue();
 // we need to improve this error message
 await expect(u.page.getByTestId('form-feedback-error')).toBeVisible();

 const validPhoneNumber = fakerPhoneNumber();
 await u.po.signIn.getPhoneNumberInput().fill(validPhoneNumber);
 await u.po.signIn.continue();

 await u.po.signIn.enterTestOtpCode();

 await u.page.getByText(/save these backup codes/i).waitFor({ state: 'visible', timeout: 10000 });

 await u.po.signIn.continue();

 await u.page.waitForAppUrl('/page-protected');
 await u.po.expect.toBeSignedIn();

 await user.deleteIfExists();
 });

 test('setup MFA with invalid verification code - error handling', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 const user = u.services.users.createFakeUser({
 fictionalEmail: true,
 withPassword: true,
 });
 await u.services.users.createBapiUser(user);

 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: user.email, password: user.password });
 await u.po.expect.toBeSignedIn();

 await u.page.goToRelative('/page-protected');

 await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });

 await u.page.getByRole('button', { name: /sms code/i }).click();

 const testPhoneNumber = fakerPhoneNumber();
 await u.po.signIn.getPhoneNumberInput().fill(testPhoneNumber);
 await u.po.signIn.continue();

 await u.po.signIn.enterOtpCode('111111', {
 awaitRequests: false,
 });

 await expect(u.page.getByTestId('form-feedback-error')).toBeVisible();

 await user.deleteIfExists();
 });

 test('can navigate back during MFA setup', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 const user = u.services.users.createFakeUser({
 fictionalEmail: true,
 withPhoneNumber: true,
 withPassword: true,
 });
 await u.services.users.createBapiUser(user);

 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: user.email, password: user.password });
 await u.po.expect.toBeSignedIn();

 await u.page.goToRelative('/page-protected');

 await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });

 await u.page.getByRole('button', { name: /sms code/i }).click();

 const formattedPhoneNumber = stringPhoneNumber(user.phoneNumber);
 await u.page
 .getByRole('button', {
 name: formattedPhoneNumber,
 })
 .waitFor({ state: 'visible' });

 await u.page
 .getByRole('button', { name: /cancel/i })
 .first()
 .click();

 await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });
 await u.page.getByRole('button', { name: /sms code/i }).waitFor({ state: 'visible' });

 await user.deleteIfExists();
 });
 },
);

10 changes: 10 additions & 0 deletions
packages/clerk-js/sandbox/app.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,7 @@ const AVAILABLE_COMPONENTS = [
 'oauthConsent',
 'taskChooseOrganization',
 'taskResetPassword',
 'taskSetupMFA',
] as const;
type AvailableComponent = (typeof AVAILABLE_COMPONENTS)[number];

Expand DownExpand Up@@ -137,6 +138,7 @@ const componentControls: Record<AvailableComponent, ComponentPropsControl> = {
 oauthConsent: buildComponentControls('oauthConsent'),
 taskChooseOrganization: buildComponentControls('taskChooseOrganization'),
 taskResetPassword: buildComponentControls('taskResetPassword'),
 taskSetupMFA: buildComponentControls('taskSetupMFA'),
};

declare global {
Expand DownExpand Up@@ -419,6 +421,14 @@ void (async () => {
 },
 );
 },
 '/task-setup-mfa': () => {
 Clerk.mountTaskSetupMfa(
 app,
 componentControls.taskSetupMFA.getProps() ?? {
 redirectUrlComplete: '/user-profile',
 },
 );
 },
 '/open-sign-in': () => {
 mountOpenSignInButton(app, componentControls.signIn.getProps() ?? {});
 },
Expand Down

8 changes: 8 additions & 0 deletions
packages/clerk-js/sandbox/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -169,6 +169,14 @@
 TaskChooseOrganization
 </a>
 </li>
 <li class="relative">
 <a
 class="relative isolate flex w-full rounded-md border border-white px-2 py-[0.4375rem] text-sm hover:bg-gray-50 aria-[current]:bg-gray-50"
 href="/task-setup-mfa"
 >
 TaskSetupMFA
 </a>
 </li>
 <li class="relative">
 <a
 class="relative isolate flex w-full rounded-md border border-white px-2 py-[0.4375rem] text-sm hover:bg-gray-50 aria-[current]:bg-gray-50"
Expand Down

23 changes: 23 additions & 0 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -113,6 +113,7 @@ import type {
 SignUpResource,
 TaskChooseOrganizationProps,
 TaskResetPasswordProps,
 TaskSetupMFAProps,
 TasksRedirectOptions,
 UnsubscribeCallback,
 UserAvatarProps,
Expand DownExpand Up@@ -1439,6 +1440,28 @@ export class Clerk implements ClerkInterface {
 void this.#clerkUi?.then(ui => ui.ensureMounted()).then(controls => controls.unmountComponent({ node }));
 };

 public mountTaskSetupMfa = (node: HTMLDivElement, props?: TaskSetupMFAProps) => {
 this.assertComponentsReady(this.#clerkUi);

 const component = 'TaskSetupMFA';
 void this.#clerkUi
 .then(ui => ui.ensureMounted())
 .then(controls =>
 controls.mountComponent({
 name: component,
 appearanceKey: 'taskSetupMfa',
 node,
 props,
 }),
 );

 this.telemetry?.record(eventPrebuiltComponentMounted('TaskSetupMfa', props));
 };

 public unmountTaskSetupMfa = (node: HTMLDivElement) => {
 void this.#clerkUi?.then(ui => ui.ensureMounted()).then(controls => controls.unmountComponent({ node }));
 };

 /**
 * `setActive` can be used to set the active session and/or organization.
 */
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -59,7 +59,7 @@
 "dev": "tsup --watch",
 "format": "node ../../scripts/format-package.mjs",
 "format:check": "node ../../scripts/format-package.mjs --check",
 "generate": "tsc src/utils/generate.ts && node src/utils/generate.js && prettier --write src/*.ts",
 "generate": "tsc -p tsconfig.generate.json && node --experimental-vm-modules src/utils/generate.js && rimraf tmp && prettier --write src/*.ts",
 "lint": "eslint src",
 "lint:attw": "attw --pack . --profile node16"
 },
Expand Down
Loading
Loading

, '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
feat(clerk-js,ui): Introduce setup MFA session task#7626

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

octoper
merged 3 commits into

from

Feb 3, 2026
 Merged


feat(clerk-js,ui): Introduce setup MFA session task
#7626
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
433ff6c

wip


octoper Jan 13, 2026
d8166a6

chore(localizations): Fix localization generate script


octoper Feb 3, 2026
ec92505

chore(ui): Guard username access


octoper Feb 3, 2026

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


12 changes: 12 additions & 0 deletions
.changeset/great-bats-attack.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
---
'@clerk/tanstack-react-start': minor
'@clerk/localizations': minor
'@clerk/react-router': minor
'@clerk/clerk-js': minor
'@clerk/nextjs': minor
'@clerk/shared': minor
'@clerk/react': minor
'@clerk/ui': minor
---

Introducing `setup_mfa` session task

8 changes: 8 additions & 0 deletions
integration/presets/envs.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -158,6 +158,13 @@ const withSessionTasksResetPassword = base
 .setEnvVariable('private', 'CLERK_SECRET_KEY', instanceKeys.get('with-session-tasks-reset-password').sk)
 .setEnvVariable('public', 'CLERK_PUBLISHABLE_KEY', instanceKeys.get('with-session-tasks-reset-password').pk);

const withSessionTasksSetupMfa = base
 .clone()
 .setId('withSessionTasksSetupMfa')
 .setEnvVariable('private', 'CLERK_SECRET_KEY', instanceKeys.get('with-session-tasks-setup-mfa').sk)
 .setEnvVariable('public', 'CLERK_PUBLISHABLE_KEY', instanceKeys.get('with-session-tasks-setup-mfa').pk)
 .setEnvVariable('private', 'CLERK_ENCRYPTION_KEY', constants.E2E_CLERK_ENCRYPTION_KEY || 'a-key');

const withBillingJwtV2 = base
 .clone()
 .setId('withBillingJwtV2')
Expand DownExpand Up@@ -216,6 +223,7 @@ export const envs = {
 withSessionTasks,
 withSessionTasksResetPassword,
 withSharedUIVariant,
 withSessionTasksSetupMfa,
 withSignInOrUpEmailLinksFlow,
 withSignInOrUpFlow,
 withSignInOrUpwithRestrictedModeFlow,
Expand Down

1 change: 1 addition & 0 deletions
integration/presets/longRunningApps.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@ export const createLongRunningApps = () => {
 { id: 'next.appRouter.withSignInOrUpEmailLinksFlow', config: next.appRouter, env: envs.withSignInOrUpEmailLinksFlow },
 { id: 'next.appRouter.withSessionTasks', config: next.appRouter, env: envs.withSessionTasks },
 { id: 'next.appRouter.withSessionTasksResetPassword', config: next.appRouter, env: envs.withSessionTasksResetPassword },
 { id: 'next.appRouter.withSessionTasksSetupMfa', config: next.appRouter, env: envs.withSessionTasksSetupMfa },
 { id: 'next.appRouter.withLegalConsent', config: next.appRouter, env: envs.withLegalConsent },
 { id: 'next.appRouter.withNeedsClientTrust', config: next.appRouter, env: envs.withNeedsClientTrust },
 { id: 'next.appRouter.withSharedUIVariant', config: next.appRouter, env: envs.withSharedUIVariant },
Expand Down

206 changes: 206 additions & 0 deletions
integration/tests/session-tasks-setup-mfa.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,206 @@
import { expect, test } from '@playwright/test';

import { appConfigs } from '../presets';
import { createTestUtils, testAgainstRunningApps } from '../testUtils';
import { stringPhoneNumber } from '../testUtils/phoneUtils';
import { fakerPhoneNumber } from '../testUtils/usersService';

testAgainstRunningApps({ withEnv: [appConfigs.envs.withSessionTasksSetupMfa] })(
 'session tasks setup-mfa flow @nextjs',
 ({ app }) => {
 test.describe.configure({ mode: 'serial' });

 test.afterAll(async () => {
 await app.teardown();
 });

 test.afterEach(async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.page.signOut();
 await u.page.context().clearCookies();
 });

 test('setup MFA with new phone number - happy path', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 const user = u.services.users.createFakeUser({
 fictionalEmail: true,
 withPassword: true,
 });
 await u.services.users.createBapiUser(user);

 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: user.email, password: user.password });
 await u.po.expect.toBeSignedIn();

 await u.page.goToRelative('/page-protected');

 await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });

 await u.page.getByRole('button', { name: /sms code/i }).click();

 const testPhoneNumber = fakerPhoneNumber();
 await u.po.signIn.getPhoneNumberInput().fill(testPhoneNumber);
 await u.page.getByRole('button', { name: /continue/i }).click();

 await u.po.signIn.enterTestOtpCode();

 await u.page.getByText(/save these backup codes/i).waitFor({ state: 'visible', timeout: 10000 });

 await u.po.signIn.continue();

 await u.page.waitForAppUrl('/page-protected');
 await u.po.expect.toBeSignedIn();

 await user.deleteIfExists();
 });

 test('setup MFA with existing phone number - happy path', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 const user = u.services.users.createFakeUser({
 fictionalEmail: true,
 withPhoneNumber: true,
 withPassword: true,
 });
 await u.services.users.createBapiUser(user);

 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: user.email, password: user.password });
 await u.po.expect.toBeSignedIn();

 await u.page.goToRelative('/page-protected');

 await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });

 await u.page.getByRole('button', { name: /sms code/i }).click();

 const formattedPhoneNumber = stringPhoneNumber(user.phoneNumber);
 await u.page
 .getByRole('button', {
 name: formattedPhoneNumber,
 })
 .click();

 await u.page.getByText(/save these backup codes/i).waitFor({ state: 'visible', timeout: 10000 });

 await u.po.signIn.continue();

 await u.page.waitForAppUrl('/page-protected');
 await u.po.expect.toBeSignedIn();

 await user.deleteIfExists();
 });

 test('setup MFA with invalid phone number - error handling', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 const user = u.services.users.createFakeUser({
 fictionalEmail: true,
 withPassword: true,
 });
 await u.services.users.createBapiUser(user);

 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: user.email, password: user.password });
 await u.po.expect.toBeSignedIn();

 await u.page.goToRelative('/page-protected');

 await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });

 await u.page.getByRole('button', { name: /sms code/i }).click();

 const invalidPhoneNumber = '123091293193091311';
 await u.po.signIn.getPhoneNumberInput().fill(invalidPhoneNumber);
 await u.po.signIn.continue();
 // we need to improve this error message
 await expect(u.page.getByTestId('form-feedback-error')).toBeVisible();

 const validPhoneNumber = fakerPhoneNumber();
 await u.po.signIn.getPhoneNumberInput().fill(validPhoneNumber);
 await u.po.signIn.continue();

 await u.po.signIn.enterTestOtpCode();

 await u.page.getByText(/save these backup codes/i).waitFor({ state: 'visible', timeout: 10000 });

 await u.po.signIn.continue();

 await u.page.waitForAppUrl('/page-protected');
 await u.po.expect.toBeSignedIn();

 await user.deleteIfExists();
 });

 test('setup MFA with invalid verification code - error handling', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 const user = u.services.users.createFakeUser({
 fictionalEmail: true,
 withPassword: true,
 });
 await u.services.users.createBapiUser(user);

 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: user.email, password: user.password });
 await u.po.expect.toBeSignedIn();

 await u.page.goToRelative('/page-protected');

 await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });

 await u.page.getByRole('button', { name: /sms code/i }).click();

 const testPhoneNumber = fakerPhoneNumber();
 await u.po.signIn.getPhoneNumberInput().fill(testPhoneNumber);
 await u.po.signIn.continue();

 await u.po.signIn.enterOtpCode('111111', {
 awaitRequests: false,
 });

 await expect(u.page.getByTestId('form-feedback-error')).toBeVisible();

 await user.deleteIfExists();
 });

 test('can navigate back during MFA setup', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 const user = u.services.users.createFakeUser({
 fictionalEmail: true,
 withPhoneNumber: true,
 withPassword: true,
 });
 await u.services.users.createBapiUser(user);

 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: user.email, password: user.password });
 await u.po.expect.toBeSignedIn();

 await u.page.goToRelative('/page-protected');

 await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });

 await u.page.getByRole('button', { name: /sms code/i }).click();

 const formattedPhoneNumber = stringPhoneNumber(user.phoneNumber);
 await u.page
 .getByRole('button', {
 name: formattedPhoneNumber,
 })
 .waitFor({ state: 'visible' });

 await u.page
 .getByRole('button', { name: /cancel/i })
 .first()
 .click();

 await u.page.getByText(/set up two-step verification/i).waitFor({ state: 'visible' });
 await u.page.getByRole('button', { name: /sms code/i }).waitFor({ state: 'visible' });

 await user.deleteIfExists();
 });
 },
);

10 changes: 10 additions & 0 deletions
packages/clerk-js/sandbox/app.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,7 @@ const AVAILABLE_COMPONENTS = [
 'oauthConsent',
 'taskChooseOrganization',
 'taskResetPassword',
 'taskSetupMFA',
] as const;
type AvailableComponent = (typeof AVAILABLE_COMPONENTS)[number];

Expand DownExpand Up@@ -137,6 +138,7 @@ const componentControls: Record<AvailableComponent, ComponentPropsControl> = {
 oauthConsent: buildComponentControls('oauthConsent'),
 taskChooseOrganization: buildComponentControls('taskChooseOrganization'),
 taskResetPassword: buildComponentControls('taskResetPassword'),
 taskSetupMFA: buildComponentControls('taskSetupMFA'),
};

declare global {
Expand DownExpand Up@@ -419,6 +421,14 @@ void (async () => {
 },
 );
 },
 '/task-setup-mfa': () => {
 Clerk.mountTaskSetupMfa(
 app,
 componentControls.taskSetupMFA.getProps() ?? {
 redirectUrlComplete: '/user-profile',
 },
 );
 },
 '/open-sign-in': () => {
 mountOpenSignInButton(app, componentControls.signIn.getProps() ?? {});
 },
Expand Down

8 changes: 8 additions & 0 deletions
packages/clerk-js/sandbox/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -169,6 +169,14 @@
 TaskChooseOrganization
 </a>
 </li>
 <li class="relative">
 <a
 class="relative isolate flex w-full rounded-md border border-white px-2 py-[0.4375rem] text-sm hover:bg-gray-50 aria-[current]:bg-gray-50"
 href="/task-setup-mfa"
 >
 TaskSetupMFA
 </a>
 </li>
 <li class="relative">
 <a
 class="relative isolate flex w-full rounded-md border border-white px-2 py-[0.4375rem] text-sm hover:bg-gray-50 aria-[current]:bg-gray-50"
Expand Down

23 changes: 23 additions & 0 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -113,6 +113,7 @@ import type {
 SignUpResource,
 TaskChooseOrganizationProps,
 TaskResetPasswordProps,
 TaskSetupMFAProps,
 TasksRedirectOptions,
 UnsubscribeCallback,
 UserAvatarProps,
Expand DownExpand Up@@ -1439,6 +1440,28 @@ export class Clerk implements ClerkInterface {
 void this.#clerkUi?.then(ui => ui.ensureMounted()).then(controls => controls.unmountComponent({ node }));
 };

 public mountTaskSetupMfa = (node: HTMLDivElement, props?: TaskSetupMFAProps) => {
 this.assertComponentsReady(this.#clerkUi);

 const component = 'TaskSetupMFA';
 void this.#clerkUi
 .then(ui => ui.ensureMounted())
 .then(controls =>
 controls.mountComponent({
 name: component,
 appearanceKey: 'taskSetupMfa',
 node,
 props,
 }),
 );

 this.telemetry?.record(eventPrebuiltComponentMounted('TaskSetupMfa', props));
 };

 public unmountTaskSetupMfa = (node: HTMLDivElement) => {
 void this.#clerkUi?.then(ui => ui.ensureMounted()).then(controls => controls.unmountComponent({ node }));
 };

 /**
 * `setActive` can be used to set the active session and/or organization.
 */
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -59,7 +59,7 @@
 "dev": "tsup --watch",
 "format": "node ../../scripts/format-package.mjs",
 "format:check": "node ../../scripts/format-package.mjs --check",
 "generate": "tsc src/utils/generate.ts && node src/utils/generate.js && prettier --write src/*.ts",
 "generate": "tsc -p tsconfig.generate.json && node --experimental-vm-modules src/utils/generate.js && rimraf tmp && prettier --write src/*.ts",
 "lint": "eslint src",
 "lint:attw": "attw --pack . --profile node16"
 },
Expand Down
Loading
Loading