Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions .changeset/flat-trains-add.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---
30 changes: 30 additions & 0 deletions packages/clerk-js/sandbox/README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,3 +39,33 @@ scenario.setScenario(scenario.UserButtonLoggedIn);
```

Like `setProps`, this command will persist the active scenario to the URL.

### Protect challenge flow

To test Clerk Protect challenge handling without running a real Protect decision
service, activate the Protect challenge scenario:

```js
scenario.setScenario('ProtectChallenge');
```

Then visit `/sign-in` or `/sign-up`. The scenario mocks FAPI responses that
return `protect_check`, loads a sandbox SDK challenge module, submits the proof
token, and continues the flow.

You can also open `/sign-in?scenario=ProtectChallenge` or
`/sign-up?scenario=ProtectChallenge` directly.

For visual testing, add `protectChallengeMode=manual` to pause the flow until
you click the sandbox challenge button:

- `/sign-in?scenario=ProtectChallenge&protectChallengeMode=manual`
- `/sign-up?scenario=ProtectChallenge&protectChallengeMode=manual`

To render the real Cloudflare Turnstile widget inside the protect-check card
(production pixels, mocked proof token), add `protectChallengeWidget=turnstile`.
This uses Cloudflare's universal test sitekeys — always-passing in auto mode,
force-interactive in manual mode — and loads the Turnstile script from
Cloudflare's CDN, which is the scenario's only network dependency:

- `/sign-in?scenario=ProtectChallenge&protectChallengeMode=manual&protectChallengeWidget=turnstile`
117 changes: 117 additions & 0 deletions packages/clerk-js/sandbox/integration/protect-challenge.spec.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
import { clerk } from '@clerk/testing/playwright';
import { expect, test } from '@playwright/test';

const primaryButtonElement = '.cl-formButtonPrimary';
const sdkChallengeUrl = 'https://protect.example.test/sdk-challenge.js';

/**
* These tests encode the INTENDED post-resolution behavior: after a protect
* check resolves, the user is routed to the next step (or the session is
* activated for the `complete` case). They are currently expected to fail:
* on the base branch the flow never advances once the check clears — the
* protect-check card unmounts and no navigation/`setActive` happens (see the
* review thread on #8329). When that is fixed, these flip to "unexpected
* pass" — delete the `test.fail()` annotations to start enforcing.
*/
const BLOCKED_BY_POST_RESOLUTION_NAVIGATION_BUG =
'blocked by protect-check post-resolution navigation bug on the base branch';

function isProtectCheckSubmit(method: string) {
return method === 'PATCH' || method === 'POST';
}

test('sign up resolves a Protect challenge and continues to email verification', async ({ page }) => {
test.fail(true, BLOCKED_BY_POST_RESOLUTION_NAVIGATION_BUG);
await page.goto('/sign-up?scenario=ProtectChallenge');
await clerk.loaded({ page });

await page.locator('#emailAddress-field').fill(`protect-sign-up-${Date.now()}@example.com`);

const sdkRequest = page.waitForRequest(sdkChallengeUrl);
const protectCheckPatch = page.waitForRequest(
request =>
isProtectCheckSubmit(request.method()) &&
request.url().includes('/v1/client/sign_ups/') &&
request.url().includes('/protect_check'),
);

await page.locator(primaryButtonElement).click();

await sdkRequest;
await protectCheckPatch;

await expect(page).toHaveURL(/verify-email-address/);
await expect(page.getByText('Verify your email')).toBeVisible();
});

test('sign up can pause on a manual Protect challenge', async ({ page }) => {
test.fail(true, BLOCKED_BY_POST_RESOLUTION_NAVIGATION_BUG);
await page.goto('/sign-up?scenario=ProtectChallenge&protectChallengeMode=manual');
await clerk.loaded({ page });

let submittedProtectCheck = false;
page.on('request', request => {
if (
isProtectCheckSubmit(request.method()) &&
request.url().includes('/v1/client/sign_ups/') &&
request.url().includes('/protect_check')
) {
submittedProtectCheck = true;
}
});

await page.locator('#emailAddress-field').fill(`protect-manual-sign-up-${Date.now()}@example.com`);

const sdkRequest = page.waitForRequest(sdkChallengeUrl);
await page.locator(primaryButtonElement).click();
await sdkRequest;

await expect(page.getByTestId('protect-challenge-sdk')).toBeVisible();
await expect(page.getByTestId('protect-challenge-complete')).toBeVisible();
expect(submittedProtectCheck).toBe(false);

const protectCheckPatch = page.waitForRequest(
request =>
isProtectCheckSubmit(request.method()) &&
request.url().includes('/v1/client/sign_ups/') &&
request.url().includes('/protect_check'),
);

await page.getByTestId('protect-challenge-complete').click();
await protectCheckPatch;

await expect(page).toHaveURL(/verify-email-address/);
await expect(page.getByText('Verify your email')).toBeVisible();
});

test('sign in resolves a Protect challenge and creates a session', async ({ page }) => {
test.fail(true, BLOCKED_BY_POST_RESOLUTION_NAVIGATION_BUG);
await page.goto('/sign-in?scenario=ProtectChallenge');
await clerk.loaded({ page });

await page.locator('#identifier-field').fill('protect-sign-in@example.com');
await page.locator(primaryButtonElement).click();
await expect(page).toHaveURL(/factor-one/);

await page.locator('#password-field').fill('Password123!');

const sdkRequest = page.waitForRequest(sdkChallengeUrl);
const protectCheckPatch = page.waitForRequest(
request =>
isProtectCheckSubmit(request.method()) &&
request.url().includes('/v1/client/sign_ins/') &&
request.url().includes('/protect_check'),
);

await page.locator(primaryButtonElement).click();

await sdkRequest;
await protectCheckPatch;

// Assert a real hydrated user (the mock session carries a full UserJSON),
// not just a non-null placeholder. Bounded poll rather than
// page.waitForFunction: a test-level timeout is not covered by the
// test.fail() annotation above, but a failed assertion is.
await expect.poll(() => page.evaluate(() => window.Clerk?.user?.id ?? null), { timeout: 10_000 }).toBeTruthy();
await expect(page.locator('.cl-signIn-root')).toBeHidden();
});
1 change: 1 addition & 0 deletions packages/clerk-js/sandbox/scenarios/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,3 +5,4 @@ export { OrgProfileSeatLimit } from './org-profile-seat-limit';
export { PricingTableSBB } from './pricing-table-sbb';
export { AnnualOnlyPlans } from './annual-only-plans';
export { XProviderEnabled } from './x-provider-enabled';
export { ProtectChallenge } from './protect-challenge';
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
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;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
test(js): add ProtectChallenge sandbox scenario for protect-check flows by mwickett · Pull Request #9072 · clerk/javascript · GitHub
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions .changeset/flat-trains-add.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---
30 changes: 30 additions & 0 deletions packages/clerk-js/sandbox/README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,3 +39,33 @@ scenario.setScenario(scenario.UserButtonLoggedIn);
```

Like `setProps`, this command will persist the active scenario to the URL.

### Protect challenge flow

To test Clerk Protect challenge handling without running a real Protect decision
service, activate the Protect challenge scenario:

```js
scenario.setScenario('ProtectChallenge');
```

Then visit `/sign-in` or `/sign-up`. The scenario mocks FAPI responses that
return `protect_check`, loads a sandbox SDK challenge module, submits the proof
token, and continues the flow.

You can also open `/sign-in?scenario=ProtectChallenge` or
`/sign-up?scenario=ProtectChallenge` directly.

For visual testing, add `protectChallengeMode=manual` to pause the flow until
you click the sandbox challenge button:

- `/sign-in?scenario=ProtectChallenge&protectChallengeMode=manual`
- `/sign-up?scenario=ProtectChallenge&protectChallengeMode=manual`

To render the real Cloudflare Turnstile widget inside the protect-check card
(production pixels, mocked proof token), add `protectChallengeWidget=turnstile`.
This uses Cloudflare's universal test sitekeys — always-passing in auto mode,
force-interactive in manual mode — and loads the Turnstile script from
Cloudflare's CDN, which is the scenario's only network dependency:

- `/sign-in?scenario=ProtectChallenge&protectChallengeMode=manual&protectChallengeWidget=turnstile`
117 changes: 117 additions & 0 deletions packages/clerk-js/sandbox/integration/protect-challenge.spec.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
import { clerk } from '@clerk/testing/playwright';
import { expect, test } from '@playwright/test';

const primaryButtonElement = '.cl-formButtonPrimary';
const sdkChallengeUrl = 'https://protect.example.test/sdk-challenge.js';

/**
* These tests encode the INTENDED post-resolution behavior: after a protect
* check resolves, the user is routed to the next step (or the session is
* activated for the `complete` case). They are currently expected to fail:
* on the base branch the flow never advances once the check clears — the
* protect-check card unmounts and no navigation/`setActive` happens (see the
* review thread on #8329). When that is fixed, these flip to "unexpected
* pass" — delete the `test.fail()` annotations to start enforcing.
*/
const BLOCKED_BY_POST_RESOLUTION_NAVIGATION_BUG =
'blocked by protect-check post-resolution navigation bug on the base branch';

function isProtectCheckSubmit(method: string) {
return method === 'PATCH' || method === 'POST';
}

test('sign up resolves a Protect challenge and continues to email verification', async ({ page }) => {
test.fail(true, BLOCKED_BY_POST_RESOLUTION_NAVIGATION_BUG);
await page.goto('/sign-up?scenario=ProtectChallenge');
await clerk.loaded({ page });

await page.locator('#emailAddress-field').fill(`protect-sign-up-${Date.now()}@example.com`);

const sdkRequest = page.waitForRequest(sdkChallengeUrl);
const protectCheckPatch = page.waitForRequest(
request =>
isProtectCheckSubmit(request.method()) &&
request.url().includes('/v1/client/sign_ups/') &&
request.url().includes('/protect_check'),
);

await page.locator(primaryButtonElement).click();

await sdkRequest;
await protectCheckPatch;

await expect(page).toHaveURL(/verify-email-address/);
await expect(page.getByText('Verify your email')).toBeVisible();
});

test('sign up can pause on a manual Protect challenge', async ({ page }) => {
test.fail(true, BLOCKED_BY_POST_RESOLUTION_NAVIGATION_BUG);
await page.goto('/sign-up?scenario=ProtectChallenge&protectChallengeMode=manual');
await clerk.loaded({ page });

let submittedProtectCheck = false;
page.on('request', request => {
if (
isProtectCheckSubmit(request.method()) &&
request.url().includes('/v1/client/sign_ups/') &&
request.url().includes('/protect_check')
) {
submittedProtectCheck = true;
}
});

await page.locator('#emailAddress-field').fill(`protect-manual-sign-up-${Date.now()}@example.com`);

const sdkRequest = page.waitForRequest(sdkChallengeUrl);
await page.locator(primaryButtonElement).click();
await sdkRequest;

await expect(page.getByTestId('protect-challenge-sdk')).toBeVisible();
await expect(page.getByTestId('protect-challenge-complete')).toBeVisible();
expect(submittedProtectCheck).toBe(false);

const protectCheckPatch = page.waitForRequest(
request =>
isProtectCheckSubmit(request.method()) &&
request.url().includes('/v1/client/sign_ups/') &&
request.url().includes('/protect_check'),
);

await page.getByTestId('protect-challenge-complete').click();
await protectCheckPatch;

await expect(page).toHaveURL(/verify-email-address/);
await expect(page.getByText('Verify your email')).toBeVisible();
});

test('sign in resolves a Protect challenge and creates a session', async ({ page }) => {
test.fail(true, BLOCKED_BY_POST_RESOLUTION_NAVIGATION_BUG);
await page.goto('/sign-in?scenario=ProtectChallenge');
await clerk.loaded({ page });

await page.locator('#identifier-field').fill('protect-sign-in@example.com');
await page.locator(primaryButtonElement).click();
await expect(page).toHaveURL(/factor-one/);

await page.locator('#password-field').fill('Password123!');

const sdkRequest = page.waitForRequest(sdkChallengeUrl);
const protectCheckPatch = page.waitForRequest(
request =>
isProtectCheckSubmit(request.method()) &&
request.url().includes('/v1/client/sign_ins/') &&
request.url().includes('/protect_check'),
);

await page.locator(primaryButtonElement).click();

await sdkRequest;
await protectCheckPatch;

// Assert a real hydrated user (the mock session carries a full UserJSON),
// not just a non-null placeholder. Bounded poll rather than
// page.waitForFunction: a test-level timeout is not covered by the
// test.fail() annotation above, but a failed assertion is.
await expect.poll(() => page.evaluate(() => window.Clerk?.user?.id ?? null), { timeout: 10_000 }).toBeTruthy();
await expect(page.locator('.cl-signIn-root')).toBeHidden();
});
1 change: 1 addition & 0 deletions packages/clerk-js/sandbox/scenarios/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,3 +5,4 @@ export { OrgProfileSeatLimit } from './org-profile-seat-limit';
export { PricingTableSBB } from './pricing-table-sbb';
export { AnnualOnlyPlans } from './annual-only-plans';
export { XProviderEnabled } from './x-provider-enabled';
export { ProtectChallenge } from './protect-challenge';
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' test(js): add ProtectChallenge sandbox scenario for protect-check flows by mwickett · Pull Request #9072 · clerk/javascript · GitHub
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions .changeset/flat-trains-add.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---
30 changes: 30 additions & 0 deletions packages/clerk-js/sandbox/README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,3 +39,33 @@ scenario.setScenario(scenario.UserButtonLoggedIn);
```

Like `setProps`, this command will persist the active scenario to the URL.

### Protect challenge flow

To test Clerk Protect challenge handling without running a real Protect decision
service, activate the Protect challenge scenario:

```js
scenario.setScenario('ProtectChallenge');
```

Then visit `/sign-in` or `/sign-up`. The scenario mocks FAPI responses that
return `protect_check`, loads a sandbox SDK challenge module, submits the proof
token, and continues the flow.

You can also open `/sign-in?scenario=ProtectChallenge` or
`/sign-up?scenario=ProtectChallenge` directly.

For visual testing, add `protectChallengeMode=manual` to pause the flow until
you click the sandbox challenge button:

- `/sign-in?scenario=ProtectChallenge&protectChallengeMode=manual`
- `/sign-up?scenario=ProtectChallenge&protectChallengeMode=manual`

To render the real Cloudflare Turnstile widget inside the protect-check card
(production pixels, mocked proof token), add `protectChallengeWidget=turnstile`.
This uses Cloudflare's universal test sitekeys — always-passing in auto mode,
force-interactive in manual mode — and loads the Turnstile script from
Cloudflare's CDN, which is the scenario's only network dependency:

- `/sign-in?scenario=ProtectChallenge&protectChallengeMode=manual&protectChallengeWidget=turnstile`
117 changes: 117 additions & 0 deletions packages/clerk-js/sandbox/integration/protect-challenge.spec.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
import { clerk } from '@clerk/testing/playwright';
import { expect, test } from '@playwright/test';

const primaryButtonElement = '.cl-formButtonPrimary';
const sdkChallengeUrl = 'https://protect.example.test/sdk-challenge.js';

/**
* These tests encode the INTENDED post-resolution behavior: after a protect
* check resolves, the user is routed to the next step (or the session is
* activated for the `complete` case). They are currently expected to fail:
* on the base branch the flow never advances once the check clears — the
* protect-check card unmounts and no navigation/`setActive` happens (see the
* review thread on #8329). When that is fixed, these flip to "unexpected
* pass" — delete the `test.fail()` annotations to start enforcing.
*/
const BLOCKED_BY_POST_RESOLUTION_NAVIGATION_BUG =
'blocked by protect-check post-resolution navigation bug on the base branch';

function isProtectCheckSubmit(method: string) {
return method === 'PATCH' || method === 'POST';
}

test('sign up resolves a Protect challenge and continues to email verification', async ({ page }) => {
test.fail(true, BLOCKED_BY_POST_RESOLUTION_NAVIGATION_BUG);
await page.goto('/sign-up?scenario=ProtectChallenge');
await clerk.loaded({ page });

await page.locator('#emailAddress-field').fill(`protect-sign-up-${Date.now()}@example.com`);

const sdkRequest = page.waitForRequest(sdkChallengeUrl);
const protectCheckPatch = page.waitForRequest(
request =>
isProtectCheckSubmit(request.method()) &&
request.url().includes('/v1/client/sign_ups/') &&
request.url().includes('/protect_check'),
);

await page.locator(primaryButtonElement).click();

await sdkRequest;
await protectCheckPatch;

await expect(page).toHaveURL(/verify-email-address/);
await expect(page.getByText('Verify your email')).toBeVisible();
});

test('sign up can pause on a manual Protect challenge', async ({ page }) => {
test.fail(true, BLOCKED_BY_POST_RESOLUTION_NAVIGATION_BUG);
await page.goto('/sign-up?scenario=ProtectChallenge&protectChallengeMode=manual');
await clerk.loaded({ page });

let submittedProtectCheck = false;
page.on('request', request => {
if (
isProtectCheckSubmit(request.method()) &&
request.url().includes('/v1/client/sign_ups/') &&
request.url().includes('/protect_check')
) {
submittedProtectCheck = true;
}
});

await page.locator('#emailAddress-field').fill(`protect-manual-sign-up-${Date.now()}@example.com`);

const sdkRequest = page.waitForRequest(sdkChallengeUrl);
await page.locator(primaryButtonElement).click();
await sdkRequest;

await expect(page.getByTestId('protect-challenge-sdk')).toBeVisible();
await expect(page.getByTestId('protect-challenge-complete')).toBeVisible();
expect(submittedProtectCheck).toBe(false);

const protectCheckPatch = page.waitForRequest(
request =>
isProtectCheckSubmit(request.method()) &&
request.url().includes('/v1/client/sign_ups/') &&
request.url().includes('/protect_check'),
);

await page.getByTestId('protect-challenge-complete').click();
await protectCheckPatch;

await expect(page).toHaveURL(/verify-email-address/);
await expect(page.getByText('Verify your email')).toBeVisible();
});

test('sign in resolves a Protect challenge and creates a session', async ({ page }) => {
test.fail(true, BLOCKED_BY_POST_RESOLUTION_NAVIGATION_BUG);
await page.goto('/sign-in?scenario=ProtectChallenge');
await clerk.loaded({ page });

await page.locator('#identifier-field').fill('protect-sign-in@example.com');
await page.locator(primaryButtonElement).click();
await expect(page).toHaveURL(/factor-one/);

await page.locator('#password-field').fill('Password123!');

const sdkRequest = page.waitForRequest(sdkChallengeUrl);
const protectCheckPatch = page.waitForRequest(
request =>
isProtectCheckSubmit(request.method()) &&
request.url().includes('/v1/client/sign_ins/') &&
request.url().includes('/protect_check'),
);

await page.locator(primaryButtonElement).click();

await sdkRequest;
await protectCheckPatch;

// Assert a real hydrated user (the mock session carries a full UserJSON),
// not just a non-null placeholder. Bounded poll rather than
// page.waitForFunction: a test-level timeout is not covered by the
// test.fail() annotation above, but a failed assertion is.
await expect.poll(() => page.evaluate(() => window.Clerk?.user?.id ?? null), { timeout: 10_000 }).toBeTruthy();
await expect(page.locator('.cl-signIn-root')).toBeHidden();
});
1 change: 1 addition & 0 deletions packages/clerk-js/sandbox/scenarios/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,3 +5,4 @@ export { OrgProfileSeatLimit } from './org-profile-seat-limit';
export { PricingTableSBB } from './pricing-table-sbb';
export { AnnualOnlyPlans } from './annual-only-plans';
export { XProviderEnabled } from './x-provider-enabled';
export { ProtectChallenge } from './protect-challenge';
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' test(js): add ProtectChallenge sandbox scenario for protect-check flows by mwickett · Pull Request #9072 · clerk/javascript · GitHub
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions .changeset/flat-trains-add.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---
30 changes: 30 additions & 0 deletions packages/clerk-js/sandbox/README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,3 +39,33 @@ scenario.setScenario(scenario.UserButtonLoggedIn);
```

Like `setProps`, this command will persist the active scenario to the URL.

### Protect challenge flow

To test Clerk Protect challenge handling without running a real Protect decision
service, activate the Protect challenge scenario:

```js
scenario.setScenario('ProtectChallenge');
```

Then visit `/sign-in` or `/sign-up`. The scenario mocks FAPI responses that
return `protect_check`, loads a sandbox SDK challenge module, submits the proof
token, and continues the flow.

You can also open `/sign-in?scenario=ProtectChallenge` or
`/sign-up?scenario=ProtectChallenge` directly.

For visual testing, add `protectChallengeMode=manual` to pause the flow until
you click the sandbox challenge button:

- `/sign-in?scenario=ProtectChallenge&protectChallengeMode=manual`
- `/sign-up?scenario=ProtectChallenge&protectChallengeMode=manual`

To render the real Cloudflare Turnstile widget inside the protect-check card
(production pixels, mocked proof token), add `protectChallengeWidget=turnstile`.
This uses Cloudflare's universal test sitekeys — always-passing in auto mode,
force-interactive in manual mode — and loads the Turnstile script from
Cloudflare's CDN, which is the scenario's only network dependency:

- `/sign-in?scenario=ProtectChallenge&protectChallengeMode=manual&protectChallengeWidget=turnstile`
117 changes: 117 additions & 0 deletions packages/clerk-js/sandbox/integration/protect-challenge.spec.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
import { clerk } from '@clerk/testing/playwright';
import { expect, test } from '@playwright/test';

const primaryButtonElement = '.cl-formButtonPrimary';
const sdkChallengeUrl = 'https://protect.example.test/sdk-challenge.js';

/**
* These tests encode the INTENDED post-resolution behavior: after a protect
* check resolves, the user is routed to the next step (or the session is
* activated for the `complete` case). They are currently expected to fail:
* on the base branch the flow never advances once the check clears — the
* protect-check card unmounts and no navigation/`setActive` happens (see the
* review thread on #8329). When that is fixed, these flip to "unexpected
* pass" — delete the `test.fail()` annotations to start enforcing.
*/
const BLOCKED_BY_POST_RESOLUTION_NAVIGATION_BUG =
'blocked by protect-check post-resolution navigation bug on the base branch';

function isProtectCheckSubmit(method: string) {
return method === 'PATCH' || method === 'POST';
}

test('sign up resolves a Protect challenge and continues to email verification', async ({ page }) => {
test.fail(true, BLOCKED_BY_POST_RESOLUTION_NAVIGATION_BUG);
await page.goto('/sign-up?scenario=ProtectChallenge');
await clerk.loaded({ page });

await page.locator('#emailAddress-field').fill(`protect-sign-up-${Date.now()}@example.com`);

const sdkRequest = page.waitForRequest(sdkChallengeUrl);
const protectCheckPatch = page.waitForRequest(
request =>
isProtectCheckSubmit(request.method()) &&
request.url().includes('/v1/client/sign_ups/') &&
request.url().includes('/protect_check'),
);

await page.locator(primaryButtonElement).click();

await sdkRequest;
await protectCheckPatch;

await expect(page).toHaveURL(/verify-email-address/);
await expect(page.getByText('Verify your email')).toBeVisible();
});

test('sign up can pause on a manual Protect challenge', async ({ page }) => {
test.fail(true, BLOCKED_BY_POST_RESOLUTION_NAVIGATION_BUG);
await page.goto('/sign-up?scenario=ProtectChallenge&protectChallengeMode=manual');
await clerk.loaded({ page });

let submittedProtectCheck = false;
page.on('request', request => {
if (
isProtectCheckSubmit(request.method()) &&
request.url().includes('/v1/client/sign_ups/') &&
request.url().includes('/protect_check')
) {
submittedProtectCheck = true;
}
});

await page.locator('#emailAddress-field').fill(`protect-manual-sign-up-${Date.now()}@example.com`);

const sdkRequest = page.waitForRequest(sdkChallengeUrl);
await page.locator(primaryButtonElement).click();
await sdkRequest;

await expect(page.getByTestId('protect-challenge-sdk')).toBeVisible();
await expect(page.getByTestId('protect-challenge-complete')).toBeVisible();
expect(submittedProtectCheck).toBe(false);

const protectCheckPatch = page.waitForRequest(
request =>
isProtectCheckSubmit(request.method()) &&
request.url().includes('/v1/client/sign_ups/') &&
request.url().includes('/protect_check'),
);

await page.getByTestId('protect-challenge-complete').click();
await protectCheckPatch;

await expect(page).toHaveURL(/verify-email-address/);
await expect(page.getByText('Verify your email')).toBeVisible();
});

test('sign in resolves a Protect challenge and creates a session', async ({ page }) => {
test.fail(true, BLOCKED_BY_POST_RESOLUTION_NAVIGATION_BUG);
await page.goto('/sign-in?scenario=ProtectChallenge');
await clerk.loaded({ page });

await page.locator('#identifier-field').fill('protect-sign-in@example.com');
await page.locator(primaryButtonElement).click();
await expect(page).toHaveURL(/factor-one/);

await page.locator('#password-field').fill('Password123!');

const sdkRequest = page.waitForRequest(sdkChallengeUrl);
const protectCheckPatch = page.waitForRequest(
request =>
isProtectCheckSubmit(request.method()) &&
request.url().includes('/v1/client/sign_ins/') &&
request.url().includes('/protect_check'),
);

await page.locator(primaryButtonElement).click();

await sdkRequest;
await protectCheckPatch;

// Assert a real hydrated user (the mock session carries a full UserJSON),
// not just a non-null placeholder. Bounded poll rather than
// page.waitForFunction: a test-level timeout is not covered by the
// test.fail() annotation above, but a failed assertion is.
await expect.poll(() => page.evaluate(() => window.Clerk?.user?.id ?? null), { timeout: 10_000 }).toBeTruthy();
await expect(page.locator('.cl-signIn-root')).toBeHidden();
});
1 change: 1 addition & 0 deletions packages/clerk-js/sandbox/scenarios/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,3 +5,4 @@ export { OrgProfileSeatLimit } from './org-profile-seat-limit';
export { PricingTableSBB } from './pricing-table-sbb';
export { AnnualOnlyPlans } from './annual-only-plans';
export { XProviderEnabled } from './x-provider-enabled';
export { ProtectChallenge } from './protect-challenge';
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' test(js): add ProtectChallenge sandbox scenario for protect-check flows by mwickett · Pull Request #9072 · clerk/javascript · GitHub
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions .changeset/flat-trains-add.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---
30 changes: 30 additions & 0 deletions packages/clerk-js/sandbox/README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,3 +39,33 @@ scenario.setScenario(scenario.UserButtonLoggedIn);
```

Like `setProps`, this command will persist the active scenario to the URL.

### Protect challenge flow

To test Clerk Protect challenge handling without running a real Protect decision
service, activate the Protect challenge scenario:

```js
scenario.setScenario('ProtectChallenge');
```

Then visit `/sign-in` or `/sign-up`. The scenario mocks FAPI responses that
return `protect_check`, loads a sandbox SDK challenge module, submits the proof
token, and continues the flow.

You can also open `/sign-in?scenario=ProtectChallenge` or
`/sign-up?scenario=ProtectChallenge` directly.

For visual testing, add `protectChallengeMode=manual` to pause the flow until
you click the sandbox challenge button:

- `/sign-in?scenario=ProtectChallenge&protectChallengeMode=manual`
- `/sign-up?scenario=ProtectChallenge&protectChallengeMode=manual`

To render the real Cloudflare Turnstile widget inside the protect-check card
(production pixels, mocked proof token), add `protectChallengeWidget=turnstile`.
This uses Cloudflare's universal test sitekeys — always-passing in auto mode,
force-interactive in manual mode — and loads the Turnstile script from
Cloudflare's CDN, which is the scenario's only network dependency:

- `/sign-in?scenario=ProtectChallenge&protectChallengeMode=manual&protectChallengeWidget=turnstile`
117 changes: 117 additions & 0 deletions packages/clerk-js/sandbox/integration/protect-challenge.spec.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
import { clerk } from '@clerk/testing/playwright';
import { expect, test } from '@playwright/test';

const primaryButtonElement = '.cl-formButtonPrimary';
const sdkChallengeUrl = 'https://protect.example.test/sdk-challenge.js';

/**
* These tests encode the INTENDED post-resolution behavior: after a protect
* check resolves, the user is routed to the next step (or the session is
* activated for the `complete` case). They are currently expected to fail:
* on the base branch the flow never advances once the check clears — the
* protect-check card unmounts and no navigation/`setActive` happens (see the
* review thread on #8329). When that is fixed, these flip to "unexpected
* pass" — delete the `test.fail()` annotations to start enforcing.
*/
const BLOCKED_BY_POST_RESOLUTION_NAVIGATION_BUG =
'blocked by protect-check post-resolution navigation bug on the base branch';

function isProtectCheckSubmit(method: string) {
return method === 'PATCH' || method === 'POST';
}

test('sign up resolves a Protect challenge and continues to email verification', async ({ page }) => {
test.fail(true, BLOCKED_BY_POST_RESOLUTION_NAVIGATION_BUG);
await page.goto('/sign-up?scenario=ProtectChallenge');
await clerk.loaded({ page });

await page.locator('#emailAddress-field').fill(`protect-sign-up-${Date.now()}@example.com`);

const sdkRequest = page.waitForRequest(sdkChallengeUrl);
const protectCheckPatch = page.waitForRequest(
request =>
isProtectCheckSubmit(request.method()) &&
request.url().includes('/v1/client/sign_ups/') &&
request.url().includes('/protect_check'),
);

await page.locator(primaryButtonElement).click();

await sdkRequest;
await protectCheckPatch;

await expect(page).toHaveURL(/verify-email-address/);
await expect(page.getByText('Verify your email')).toBeVisible();
});

test('sign up can pause on a manual Protect challenge', async ({ page }) => {
test.fail(true, BLOCKED_BY_POST_RESOLUTION_NAVIGATION_BUG);
await page.goto('/sign-up?scenario=ProtectChallenge&protectChallengeMode=manual');
await clerk.loaded({ page });

let submittedProtectCheck = false;
page.on('request', request => {
if (
isProtectCheckSubmit(request.method()) &&
request.url().includes('/v1/client/sign_ups/') &&
request.url().includes('/protect_check')
) {
submittedProtectCheck = true;
}
});

await page.locator('#emailAddress-field').fill(`protect-manual-sign-up-${Date.now()}@example.com`);

const sdkRequest = page.waitForRequest(sdkChallengeUrl);
await page.locator(primaryButtonElement).click();
await sdkRequest;

await expect(page.getByTestId('protect-challenge-sdk')).toBeVisible();
await expect(page.getByTestId('protect-challenge-complete')).toBeVisible();
expect(submittedProtectCheck).toBe(false);

const protectCheckPatch = page.waitForRequest(
request =>
isProtectCheckSubmit(request.method()) &&
request.url().includes('/v1/client/sign_ups/') &&
request.url().includes('/protect_check'),
);

await page.getByTestId('protect-challenge-complete').click();
await protectCheckPatch;

await expect(page).toHaveURL(/verify-email-address/);
await expect(page.getByText('Verify your email')).toBeVisible();
});

test('sign in resolves a Protect challenge and creates a session', async ({ page }) => {
test.fail(true, BLOCKED_BY_POST_RESOLUTION_NAVIGATION_BUG);
await page.goto('/sign-in?scenario=ProtectChallenge');
await clerk.loaded({ page });

await page.locator('#identifier-field').fill('protect-sign-in@example.com');
await page.locator(primaryButtonElement).click();
await expect(page).toHaveURL(/factor-one/);

await page.locator('#password-field').fill('Password123!');

const sdkRequest = page.waitForRequest(sdkChallengeUrl);
const protectCheckPatch = page.waitForRequest(
request =>
isProtectCheckSubmit(request.method()) &&
request.url().includes('/v1/client/sign_ins/') &&
request.url().includes('/protect_check'),
);

await page.locator(primaryButtonElement).click();

await sdkRequest;
await protectCheckPatch;

// Assert a real hydrated user (the mock session carries a full UserJSON),
// not just a non-null placeholder. Bounded poll rather than
// page.waitForFunction: a test-level timeout is not covered by the
// test.fail() annotation above, but a failed assertion is.
await expect.poll(() => page.evaluate(() => window.Clerk?.user?.id ?? null), { timeout: 10_000 }).toBeTruthy();
await expect(page.locator('.cl-signIn-root')).toBeHidden();
});
1 change: 1 addition & 0 deletions packages/clerk-js/sandbox/scenarios/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,3 +5,4 @@ export { OrgProfileSeatLimit } from './org-profile-seat-limit';
export { PricingTableSBB } from './pricing-table-sbb';
export { AnnualOnlyPlans } from './annual-only-plans';
export { XProviderEnabled } from './x-provider-enabled';
export { ProtectChallenge } from './protect-challenge';
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' test(js): add ProtectChallenge sandbox scenario for protect-check flows by mwickett · Pull Request #9072 · clerk/javascript · GitHub
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions .changeset/flat-trains-add.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---
30 changes: 30 additions & 0 deletions packages/clerk-js/sandbox/README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,3 +39,33 @@ scenario.setScenario(scenario.UserButtonLoggedIn);
```

Like `setProps`, this command will persist the active scenario to the URL.

### Protect challenge flow

To test Clerk Protect challenge handling without running a real Protect decision
service, activate the Protect challenge scenario:

```js
scenario.setScenario('ProtectChallenge');
```

Then visit `/sign-in` or `/sign-up`. The scenario mocks FAPI responses that
return `protect_check`, loads a sandbox SDK challenge module, submits the proof
token, and continues the flow.

You can also open `/sign-in?scenario=ProtectChallenge` or
`/sign-up?scenario=ProtectChallenge` directly.

For visual testing, add `protectChallengeMode=manual` to pause the flow until
you click the sandbox challenge button:

- `/sign-in?scenario=ProtectChallenge&protectChallengeMode=manual`
- `/sign-up?scenario=ProtectChallenge&protectChallengeMode=manual`

To render the real Cloudflare Turnstile widget inside the protect-check card
(production pixels, mocked proof token), add `protectChallengeWidget=turnstile`.
This uses Cloudflare's universal test sitekeys — always-passing in auto mode,
force-interactive in manual mode — and loads the Turnstile script from
Cloudflare's CDN, which is the scenario's only network dependency:

- `/sign-in?scenario=ProtectChallenge&protectChallengeMode=manual&protectChallengeWidget=turnstile`
117 changes: 117 additions & 0 deletions packages/clerk-js/sandbox/integration/protect-challenge.spec.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
import { clerk } from '@clerk/testing/playwright';
import { expect, test } from '@playwright/test';

const primaryButtonElement = '.cl-formButtonPrimary';
const sdkChallengeUrl = 'https://protect.example.test/sdk-challenge.js';

/**
* These tests encode the INTENDED post-resolution behavior: after a protect
* check resolves, the user is routed to the next step (or the session is
* activated for the `complete` case). They are currently expected to fail:
* on the base branch the flow never advances once the check clears — the
* protect-check card unmounts and no navigation/`setActive` happens (see the
* review thread on #8329). When that is fixed, these flip to "unexpected
* pass" — delete the `test.fail()` annotations to start enforcing.
*/
const BLOCKED_BY_POST_RESOLUTION_NAVIGATION_BUG =
'blocked by protect-check post-resolution navigation bug on the base branch';

function isProtectCheckSubmit(method: string) {
return method === 'PATCH' || method === 'POST';
}

test('sign up resolves a Protect challenge and continues to email verification', async ({ page }) => {
test.fail(true, BLOCKED_BY_POST_RESOLUTION_NAVIGATION_BUG);
await page.goto('/sign-up?scenario=ProtectChallenge');
await clerk.loaded({ page });

await page.locator('#emailAddress-field').fill(`protect-sign-up-${Date.now()}@example.com`);

const sdkRequest = page.waitForRequest(sdkChallengeUrl);
const protectCheckPatch = page.waitForRequest(
request =>
isProtectCheckSubmit(request.method()) &&
request.url().includes('/v1/client/sign_ups/') &&
request.url().includes('/protect_check'),
);

await page.locator(primaryButtonElement).click();

await sdkRequest;
await protectCheckPatch;

await expect(page).toHaveURL(/verify-email-address/);
await expect(page.getByText('Verify your email')).toBeVisible();
});

test('sign up can pause on a manual Protect challenge', async ({ page }) => {
test.fail(true, BLOCKED_BY_POST_RESOLUTION_NAVIGATION_BUG);
await page.goto('/sign-up?scenario=ProtectChallenge&protectChallengeMode=manual');
await clerk.loaded({ page });

let submittedProtectCheck = false;
page.on('request', request => {
if (
isProtectCheckSubmit(request.method()) &&
request.url().includes('/v1/client/sign_ups/') &&
request.url().includes('/protect_check')
) {
submittedProtectCheck = true;
}
});

await page.locator('#emailAddress-field').fill(`protect-manual-sign-up-${Date.now()}@example.com`);

const sdkRequest = page.waitForRequest(sdkChallengeUrl);
await page.locator(primaryButtonElement).click();
await sdkRequest;

await expect(page.getByTestId('protect-challenge-sdk')).toBeVisible();
await expect(page.getByTestId('protect-challenge-complete')).toBeVisible();
expect(submittedProtectCheck).toBe(false);

const protectCheckPatch = page.waitForRequest(
request =>
isProtectCheckSubmit(request.method()) &&
request.url().includes('/v1/client/sign_ups/') &&
request.url().includes('/protect_check'),
);

await page.getByTestId('protect-challenge-complete').click();
await protectCheckPatch;

await expect(page).toHaveURL(/verify-email-address/);
await expect(page.getByText('Verify your email')).toBeVisible();
});

test('sign in resolves a Protect challenge and creates a session', async ({ page }) => {
test.fail(true, BLOCKED_BY_POST_RESOLUTION_NAVIGATION_BUG);
await page.goto('/sign-in?scenario=ProtectChallenge');
await clerk.loaded({ page });

await page.locator('#identifier-field').fill('protect-sign-in@example.com');
await page.locator(primaryButtonElement).click();
await expect(page).toHaveURL(/factor-one/);

await page.locator('#password-field').fill('Password123!');

const sdkRequest = page.waitForRequest(sdkChallengeUrl);
const protectCheckPatch = page.waitForRequest(
request =>
isProtectCheckSubmit(request.method()) &&
request.url().includes('/v1/client/sign_ins/') &&
request.url().includes('/protect_check'),
);

await page.locator(primaryButtonElement).click();

await sdkRequest;
await protectCheckPatch;

// Assert a real hydrated user (the mock session carries a full UserJSON),
// not just a non-null placeholder. Bounded poll rather than
// page.waitForFunction: a test-level timeout is not covered by the
// test.fail() annotation above, but a failed assertion is.
await expect.poll(() => page.evaluate(() => window.Clerk?.user?.id ?? null), { timeout: 10_000 }).toBeTruthy();
await expect(page.locator('.cl-signIn-root')).toBeHidden();
});
1 change: 1 addition & 0 deletions packages/clerk-js/sandbox/scenarios/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,3 +5,4 @@ export { OrgProfileSeatLimit } from './org-profile-seat-limit';
export { PricingTableSBB } from './pricing-table-sbb';
export { AnnualOnlyPlans } from './annual-only-plans';
export { XProviderEnabled } from './x-provider-enabled';
export { ProtectChallenge } from './protect-challenge';
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' test(js): add ProtectChallenge sandbox scenario for protect-check flows by mwickett · Pull Request #9072 · clerk/javascript · GitHub
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions .changeset/flat-trains-add.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---
30 changes: 30 additions & 0 deletions packages/clerk-js/sandbox/README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,3 +39,33 @@ scenario.setScenario(scenario.UserButtonLoggedIn);
```

Like `setProps`, this command will persist the active scenario to the URL.

### Protect challenge flow

To test Clerk Protect challenge handling without running a real Protect decision
service, activate the Protect challenge scenario:

```js
scenario.setScenario('ProtectChallenge');
```

Then visit `/sign-in` or `/sign-up`. The scenario mocks FAPI responses that
return `protect_check`, loads a sandbox SDK challenge module, submits the proof
token, and continues the flow.

You can also open `/sign-in?scenario=ProtectChallenge` or
`/sign-up?scenario=ProtectChallenge` directly.

For visual testing, add `protectChallengeMode=manual` to pause the flow until
you click the sandbox challenge button:

- `/sign-in?scenario=ProtectChallenge&protectChallengeMode=manual`
- `/sign-up?scenario=ProtectChallenge&protectChallengeMode=manual`

To render the real Cloudflare Turnstile widget inside the protect-check card
(production pixels, mocked proof token), add `protectChallengeWidget=turnstile`.
This uses Cloudflare's universal test sitekeys — always-passing in auto mode,
force-interactive in manual mode — and loads the Turnstile script from
Cloudflare's CDN, which is the scenario's only network dependency:

- `/sign-in?scenario=ProtectChallenge&protectChallengeMode=manual&protectChallengeWidget=turnstile`
117 changes: 117 additions & 0 deletions packages/clerk-js/sandbox/integration/protect-challenge.spec.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
import { clerk } from '@clerk/testing/playwright';
import { expect, test } from '@playwright/test';

const primaryButtonElement = '.cl-formButtonPrimary';
const sdkChallengeUrl = 'https://protect.example.test/sdk-challenge.js';

/**
* These tests encode the INTENDED post-resolution behavior: after a protect
* check resolves, the user is routed to the next step (or the session is
* activated for the `complete` case). They are currently expected to fail:
* on the base branch the flow never advances once the check clears — the
* protect-check card unmounts and no navigation/`setActive` happens (see the
* review thread on #8329). When that is fixed, these flip to "unexpected
* pass" — delete the `test.fail()` annotations to start enforcing.
*/
const BLOCKED_BY_POST_RESOLUTION_NAVIGATION_BUG =
'blocked by protect-check post-resolution navigation bug on the base branch';

function isProtectCheckSubmit(method: string) {
return method === 'PATCH' || method === 'POST';
}

test('sign up resolves a Protect challenge and continues to email verification', async ({ page }) => {
test.fail(true, BLOCKED_BY_POST_RESOLUTION_NAVIGATION_BUG);
await page.goto('/sign-up?scenario=ProtectChallenge');
await clerk.loaded({ page });

await page.locator('#emailAddress-field').fill(`protect-sign-up-${Date.now()}@example.com`);

const sdkRequest = page.waitForRequest(sdkChallengeUrl);
const protectCheckPatch = page.waitForRequest(
request =>
isProtectCheckSubmit(request.method()) &&
request.url().includes('/v1/client/sign_ups/') &&
request.url().includes('/protect_check'),
);

await page.locator(primaryButtonElement).click();

await sdkRequest;
await protectCheckPatch;

await expect(page).toHaveURL(/verify-email-address/);
await expect(page.getByText('Verify your email')).toBeVisible();
});

test('sign up can pause on a manual Protect challenge', async ({ page }) => {
test.fail(true, BLOCKED_BY_POST_RESOLUTION_NAVIGATION_BUG);
await page.goto('/sign-up?scenario=ProtectChallenge&protectChallengeMode=manual');
await clerk.loaded({ page });

let submittedProtectCheck = false;
page.on('request', request => {
if (
isProtectCheckSubmit(request.method()) &&
request.url().includes('/v1/client/sign_ups/') &&
request.url().includes('/protect_check')
) {
submittedProtectCheck = true;
}
});

await page.locator('#emailAddress-field').fill(`protect-manual-sign-up-${Date.now()}@example.com`);

const sdkRequest = page.waitForRequest(sdkChallengeUrl);
await page.locator(primaryButtonElement).click();
await sdkRequest;

await expect(page.getByTestId('protect-challenge-sdk')).toBeVisible();
await expect(page.getByTestId('protect-challenge-complete')).toBeVisible();
expect(submittedProtectCheck).toBe(false);

const protectCheckPatch = page.waitForRequest(
request =>
isProtectCheckSubmit(request.method()) &&
request.url().includes('/v1/client/sign_ups/') &&
request.url().includes('/protect_check'),
);

await page.getByTestId('protect-challenge-complete').click();
await protectCheckPatch;

await expect(page).toHaveURL(/verify-email-address/);
await expect(page.getByText('Verify your email')).toBeVisible();
});

test('sign in resolves a Protect challenge and creates a session', async ({ page }) => {
test.fail(true, BLOCKED_BY_POST_RESOLUTION_NAVIGATION_BUG);
await page.goto('/sign-in?scenario=ProtectChallenge');
await clerk.loaded({ page });

await page.locator('#identifier-field').fill('protect-sign-in@example.com');
await page.locator(primaryButtonElement).click();
await expect(page).toHaveURL(/factor-one/);

await page.locator('#password-field').fill('Password123!');

const sdkRequest = page.waitForRequest(sdkChallengeUrl);
const protectCheckPatch = page.waitForRequest(
request =>
isProtectCheckSubmit(request.method()) &&
request.url().includes('/v1/client/sign_ins/') &&
request.url().includes('/protect_check'),
);

await page.locator(primaryButtonElement).click();

await sdkRequest;
await protectCheckPatch;

// Assert a real hydrated user (the mock session carries a full UserJSON),
// not just a non-null placeholder. Bounded poll rather than
// page.waitForFunction: a test-level timeout is not covered by the
// test.fail() annotation above, but a failed assertion is.
await expect.poll(() => page.evaluate(() => window.Clerk?.user?.id ?? null), { timeout: 10_000 }).toBeTruthy();
await expect(page.locator('.cl-signIn-root')).toBeHidden();
});
1 change: 1 addition & 0 deletions packages/clerk-js/sandbox/scenarios/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,3 +5,4 @@ export { OrgProfileSeatLimit } from './org-profile-seat-limit';
export { PricingTableSBB } from './pricing-table-sbb';
export { AnnualOnlyPlans } from './annual-only-plans';
export { XProviderEnabled } from './x-provider-enabled';
export { ProtectChallenge } from './protect-challenge';
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); test(js): add ProtectChallenge sandbox scenario for protect-check flows by mwickett · Pull Request #9072 · clerk/javascript · GitHub
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions .changeset/flat-trains-add.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---
30 changes: 30 additions & 0 deletions packages/clerk-js/sandbox/README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,3 +39,33 @@ scenario.setScenario(scenario.UserButtonLoggedIn);
```

Like `setProps`, this command will persist the active scenario to the URL.

### Protect challenge flow

To test Clerk Protect challenge handling without running a real Protect decision
service, activate the Protect challenge scenario:

```js
scenario.setScenario('ProtectChallenge');
```

Then visit `/sign-in` or `/sign-up`. The scenario mocks FAPI responses that
return `protect_check`, loads a sandbox SDK challenge module, submits the proof
token, and continues the flow.

You can also open `/sign-in?scenario=ProtectChallenge` or
`/sign-up?scenario=ProtectChallenge` directly.

For visual testing, add `protectChallengeMode=manual` to pause the flow until
you click the sandbox challenge button:

- `/sign-in?scenario=ProtectChallenge&protectChallengeMode=manual`
- `/sign-up?scenario=ProtectChallenge&protectChallengeMode=manual`

To render the real Cloudflare Turnstile widget inside the protect-check card
(production pixels, mocked proof token), add `protectChallengeWidget=turnstile`.
This uses Cloudflare's universal test sitekeys — always-passing in auto mode,
force-interactive in manual mode — and loads the Turnstile script from
Cloudflare's CDN, which is the scenario's only network dependency:

- `/sign-in?scenario=ProtectChallenge&protectChallengeMode=manual&protectChallengeWidget=turnstile`
117 changes: 117 additions & 0 deletions packages/clerk-js/sandbox/integration/protect-challenge.spec.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
import { clerk } from '@clerk/testing/playwright';
import { expect, test } from '@playwright/test';

const primaryButtonElement = '.cl-formButtonPrimary';
const sdkChallengeUrl = 'https://protect.example.test/sdk-challenge.js';

/**
* These tests encode the INTENDED post-resolution behavior: after a protect
* check resolves, the user is routed to the next step (or the session is
* activated for the `complete` case). They are currently expected to fail:
* on the base branch the flow never advances once the check clears — the
* protect-check card unmounts and no navigation/`setActive` happens (see the
* review thread on #8329). When that is fixed, these flip to "unexpected
* pass" — delete the `test.fail()` annotations to start enforcing.
*/
const BLOCKED_BY_POST_RESOLUTION_NAVIGATION_BUG =
'blocked by protect-check post-resolution navigation bug on the base branch';

function isProtectCheckSubmit(method: string) {
return method === 'PATCH' || method === 'POST';
}

test('sign up resolves a Protect challenge and continues to email verification', async ({ page }) => {
test.fail(true, BLOCKED_BY_POST_RESOLUTION_NAVIGATION_BUG);
await page.goto('/sign-up?scenario=ProtectChallenge');
await clerk.loaded({ page });

await page.locator('#emailAddress-field').fill(`protect-sign-up-${Date.now()}@example.com`);

const sdkRequest = page.waitForRequest(sdkChallengeUrl);
const protectCheckPatch = page.waitForRequest(
request =>
isProtectCheckSubmit(request.method()) &&
request.url().includes('/v1/client/sign_ups/') &&
request.url().includes('/protect_check'),
);

await page.locator(primaryButtonElement).click();

await sdkRequest;
await protectCheckPatch;

await expect(page).toHaveURL(/verify-email-address/);
await expect(page.getByText('Verify your email')).toBeVisible();
});

test('sign up can pause on a manual Protect challenge', async ({ page }) => {
test.fail(true, BLOCKED_BY_POST_RESOLUTION_NAVIGATION_BUG);
await page.goto('/sign-up?scenario=ProtectChallenge&protectChallengeMode=manual');
await clerk.loaded({ page });

let submittedProtectCheck = false;
page.on('request', request => {
if (
isProtectCheckSubmit(request.method()) &&
request.url().includes('/v1/client/sign_ups/') &&
request.url().includes('/protect_check')
) {
submittedProtectCheck = true;
}
});

await page.locator('#emailAddress-field').fill(`protect-manual-sign-up-${Date.now()}@example.com`);

const sdkRequest = page.waitForRequest(sdkChallengeUrl);
await page.locator(primaryButtonElement).click();
await sdkRequest;

await expect(page.getByTestId('protect-challenge-sdk')).toBeVisible();
await expect(page.getByTestId('protect-challenge-complete')).toBeVisible();
expect(submittedProtectCheck).toBe(false);

const protectCheckPatch = page.waitForRequest(
request =>
isProtectCheckSubmit(request.method()) &&
request.url().includes('/v1/client/sign_ups/') &&
request.url().includes('/protect_check'),
);

await page.getByTestId('protect-challenge-complete').click();
await protectCheckPatch;

await expect(page).toHaveURL(/verify-email-address/);
await expect(page.getByText('Verify your email')).toBeVisible();
});

test('sign in resolves a Protect challenge and creates a session', async ({ page }) => {
test.fail(true, BLOCKED_BY_POST_RESOLUTION_NAVIGATION_BUG);
await page.goto('/sign-in?scenario=ProtectChallenge');
await clerk.loaded({ page });

await page.locator('#identifier-field').fill('protect-sign-in@example.com');
await page.locator(primaryButtonElement).click();
await expect(page).toHaveURL(/factor-one/);

await page.locator('#password-field').fill('Password123!');

const sdkRequest = page.waitForRequest(sdkChallengeUrl);
const protectCheckPatch = page.waitForRequest(
request =>
isProtectCheckSubmit(request.method()) &&
request.url().includes('/v1/client/sign_ins/') &&
request.url().includes('/protect_check'),
);

await page.locator(primaryButtonElement).click();

await sdkRequest;
await protectCheckPatch;

// Assert a real hydrated user (the mock session carries a full UserJSON),
// not just a non-null placeholder. Bounded poll rather than
// page.waitForFunction: a test-level timeout is not covered by the
// test.fail() annotation above, but a failed assertion is.
await expect.poll(() => page.evaluate(() => window.Clerk?.user?.id ?? null), { timeout: 10_000 }).toBeTruthy();
await expect(page.locator('.cl-signIn-root')).toBeHidden();
});
1 change: 1 addition & 0 deletions packages/clerk-js/sandbox/scenarios/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,3 +5,4 @@ export { OrgProfileSeatLimit } from './org-profile-seat-limit';
export { PricingTableSBB } from './pricing-table-sbb';
export { AnnualOnlyPlans } from './annual-only-plans';
export { XProviderEnabled } from './x-provider-enabled';
export { ProtectChallenge } from './protect-challenge';
Loading
Loading