Merged
6 changes: 6 additions & 0 deletions .changeset/protect-check-spinner-widget-visibility.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/shared': patch
'@clerk/ui': patch
---

Polish the Protect check card: the loading spinner now hides while a challenge widget (e.g. Turnstile) is visible instead of spinning alongside it, only appears after a short delay so near-instant checks never flash it, and the card no longer reserves empty space above the spinner before a widget has rendered.
Original file line numberDiff line numberDiff line change
Expand Up@@ -63,26 +63,30 @@ describe('executeProtectCheck', () => {
expect(result).toBe('proof-token-123');
});

it('passes only the spec-defined fields (token, uiHints, signal) — NOT the full resource', async () => {
it('passes only the spec-defined fields (token, uiHints, signal, setWidgetVisible) — NOT the full resource', async () => {
const fn = vi.fn().mockResolvedValue('proof');
vi.doMock('https://protect.example.com/sdk-args.js', () => ({ default: fn }));

const container = fakeContainer();
const controller = new AbortController();
// The visibility handshake: the script calls this before revealing UI so the host can
// drop its own spinner first; the promise resolves once the host has applied the change.
const setWidgetVisible = vi.fn().mockResolvedValue(undefined);
await executeProtectCheck(
protectCheck({
sdkUrl: 'https://protect.example.com/sdk-args.js',
token: 'opaque-challenge-token',
uiHints: { reason: 'device_new' },
}),
container,
{ signal: controller.signal },
{ signal: controller.signal, setWidgetVisible },
);

expect(fn).toHaveBeenCalledWith(container, {
token: 'opaque-challenge-token',
uiHints: { reason: 'device_new' },
signal: controller.signal,
setWidgetVisible,
});
});
});
Expand Down
15 changes: 13 additions & 2 deletions packages/shared/src/internal/clerk-js/protectCheck.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,16 @@ import { ClerkRuntimeError } from '../../error';
import type { ProtectCheckResource } from '../../types';

export interface ExecuteProtectCheckOptions {
/**
* Host-provided visibility handshake, forwarded to the script verbatim as
* `setWidgetVisible` in the init payload. The script calls it right before revealing UI in
* the container (and with `false` once its widget is done); the returned promise resolves
* only after the host has applied the change to the DOM (e.g. removed its own loading
* spinner), so the script can sequence its reveal without a frame of overlap. A script that
* knows its widget is imminent may call it immediately to avoid a spinner flash. Scripts
* must treat the field as optional — older hosts don't provide it.
*/
setWidgetVisible?: (visible: boolean) => Promise<void>;
/**
* Signals that the caller no longer needs the proof token (component unmounted, user
* navigated away, etc.). When the signal aborts:
Expand All@@ -22,6 +32,7 @@ interface ScriptInitOptions {
token: string;
uiHints?: Record<string, string>;
signal?: AbortSignal;
setWidgetVisible?: (visible: boolean) => Promise<void>;
}

type ScriptDefault = (container: HTMLDivElement, init: ScriptInitOptions) => Promise<string>;
Expand DownExpand Up@@ -88,7 +99,7 @@ export async function executeProtectCheck(
container: HTMLDivElement,
options: ExecuteProtectCheckOptions = {},
): Promise<string> {
const { signal } = options;
const { signal, setWidgetVisible } = options;
const { sdkUrl, token, uiHints } = protectCheck;

const validated = assertValidSdkUrl(sdkUrl);
Expand DownExpand Up@@ -123,7 +134,7 @@ export async function executeProtectCheck(

let proofToken: string;
try {
proofToken = await (mod.default as ScriptDefault)(container, { token, uiHints, signal });
proofToken = await (mod.default as ScriptDefault)(container, { token, uiHints, signal, setWidgetVisible });
} catch (err) {
// Distinguish abort-induced rejections from genuine script errors: only relabel as
// `protect_check_aborted` when the error looks like an abort (`AbortError`), otherwise
Expand Down
25 changes: 15 additions & 10 deletions packages/ui/src/components/SignIn/SignInProtectCheck.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ import {
Spinner,
useLocalizations,
} from '../../customizables';
import { useSpinDelay } from '../../hooks';
import { useProtectCheckRunner } from '../../hooks/useProtectCheckRunner';
import { useRouter } from '../../router';

Expand DownExpand Up@@ -63,7 +64,7 @@ function SignInProtectCheckInternal(): JSX.Element {
const { setActive } = useClerk();
const { afterSignInUrl, navigateOnSetActive } = useSignInContext();

const { containerRef, isRunning, hasError, retry } = useProtectCheckRunner<SignInResource>({
const { containerRef, isRunning, isWidgetVisible, hasError, retry } = useProtectCheckRunner<SignInResource>({
getProtectCheck: () => signIn.protectCheck,
getResource: () => signIn,
reload: () => signIn.reload(),
Expand All@@ -88,6 +89,13 @@ function SignInProtectCheckInternal(): JSX.Element {
},
});

// Debounce the spinner's entrance so a near-instant check (or a script that signals its
// widget immediately) never flashes it — the card header alone carries the first ~300ms.
// The error and widget-visibility gates stay OUTSIDE the delay hook below: its minimum
// visible duration must never outrank the handshake's "spinner is gone when the promise
// resolves" guarantee, nor keep a spinner next to the retry button.
const showSpinner = useSpinDelay(isRunning, { delay: 300 });

return (
<Flow.Part part='protectCheck'>
<Card.Root>
Expand All@@ -105,21 +113,18 @@ function SignInProtectCheckInternal(): JSX.Element {
ref={containerRef}
id='clerk-protect-check'
aria-busy={isRunning}
style={{ display: 'block', alignSelf: 'center', minHeight: '60px' }}
// Out of flow while empty so the collapsed container adds no reserved height or flex-gap
// gutter above the spinner (same idiom as CaptchaElement's `gapless` mode).
style={{ display: 'block', alignSelf: 'center', position: isWidgetVisible ? 'static' : 'absolute' }}
/>
{isRunning && !hasError ? (
<Flex
direction='col'
center
gap={4}
aria-live='polite'
>
{showSpinner && !hasError && !isWidgetVisible ? (
<Flex center>
<Spinner
size='lg'
colorScheme='primary'
elementDescriptor={descriptors.spinner}
aria-label={t(localizationKeys('signIn.protectCheck.loading'))}
/>
<Box>{t(localizationKeys('signIn.protectCheck.loading'))}</Box>
</Flex>
) : null}
{hasError ? (
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { ClerkAPIResponseError, ClerkRuntimeError } from '@clerk/shared/error';
import type { SignInResource } from '@clerk/shared/types';
import { waitFor } from '@testing-library/react';
import { act, waitFor } from '@testing-library/react';
import { beforeEach, describe, expect, it, vi } from 'vitest';

import { bindCreateFixtures } from '@/test/create-fixtures';
Expand DownExpand Up@@ -250,6 +250,197 @@ describe('SignInProtectCheck', () => {
});
});

describe('challenge widget visibility', () => {
// Visibility is driven by the script, not observed from the DOM: executeProtectCheck hands
// the script a `setWidgetVisible` callback in its init payload, and the script calls it
// right before revealing UI in the container (and with `false` once the widget is done).
const renderWithPendingChallenge = async () => {
const { wrapper } = await createFixtures(f => {
f.startSignInWithProtectCheck();
});
let container: HTMLDivElement | undefined;
let setWidgetVisible: ((visible: boolean) => Promise<void>) | undefined;
mockExecute.mockImplementation((_protectCheck, el, opts) => {
container = el as HTMLDivElement;
setWidgetVisible = opts?.setWidgetVisible;
return new Promise(() => {}); // never resolves; the check stays running
});
const utils = render(<SignInProtectCheck />, { wrapper });
await waitFor(() => expect(mockExecute).toHaveBeenCalled());
return { ...utils, container: container!, setWidgetVisible: setWidgetVisible! };
};

it('waits a beat before showing the spinner so near-instant checks never flash it', async () => {
const { queryByLabelText, findByLabelText } = await renderWithPendingChallenge();

// Inside the spin-delay window nothing shows yet (the card header is already
// adequate feedback); the spinner only joins once the wait is genuinely long.
expect(queryByLabelText(/loading/i)).not.toBeInTheDocument();
expect(await findByLabelText(/loading/i)).toBeInTheDocument();
});

it('never shows the spinner for a check that completes before the delay', async () => {
const { wrapper, fixtures } = await createFixtures(f => {
f.startSignInWithProtectCheck();
});
mockExecute.mockResolvedValue('proof-fast');
fixtures.signIn.submitProtectCheck.mockResolvedValue({
status: 'needs_first_factor',
protectCheck: null,
createdSessionId: null,
} as unknown as SignInResource);

const { queryByLabelText } = render(<SignInProtectCheck />, { wrapper });

await waitFor(() => expect(fixtures.router.navigate).toHaveBeenCalledWith('../factor-one'));
expect(queryByLabelText(/loading/i)).not.toBeInTheDocument();
// The delayed timer must not fire the spinner after the run has already ended.
await new Promise(resolve => setTimeout(resolve, 400));
expect(queryByLabelText(/loading/i)).not.toBeInTheDocument();
});

it('drops the spinner immediately on failure, minDuration notwithstanding', async () => {
const { wrapper } = await createFixtures(f => {
f.startSignInWithProtectCheck();
});
let rejectRun: ((err: Error) => void) | undefined;
mockExecute.mockImplementation(
() =>
new Promise((_, reject) => {
rejectRun = reject;
}),
);

const { findByRole, findByLabelText, queryByLabelText } = render(<SignInProtectCheck />, { wrapper });
expect(await findByLabelText(/loading/i)).toBeInTheDocument();

rejectRun!(
new ClerkRuntimeError('Protect check script execution failed', { code: 'protect_check_execution_failed' }),
);

// The retry control and the spinner must not coexist — the error gate outranks
// the spin-delay's minimum-visible duration.
await findByRole('button', { name: /try again/i });
expect(queryByLabelText(/loading/i)).not.toBeInTheDocument();
});

it('hides the spinner while the script signals a visible widget and restores it on the counter-signal', async () => {
const { setWidgetVisible, queryByText, queryByLabelText, findByLabelText } = await renderWithPendingChallenge();

// Invisible phase (SDK loading / executing): the spinner is the progress indicator.
expect(await findByLabelText(/loading/i)).toBeInTheDocument();
// The label lives on the spinner itself — no visible "Loading" text (design-system
// consistency; see the dogfooding thread).
expect(queryByText(/loading/i)).not.toBeInTheDocument();

// The script announces its widget. By the time the promise resolves, the spinner must
// ALREADY be out of the DOM — that's the contract that lets the script reveal its UI
// without a frame of overlap.
let spinnerGoneAtResolve = false;
await act(async () => {
await setWidgetVisible(true);
spinnerGoneAtResolve = queryByLabelText(/loading/i) === null;
});
expect(spinnerGoneAtResolve).toBe(true);

// Widget done (e.g. solved, proof verification in flight): spinner takes back over.
await act(async () => {
await setWidgetVisible(false);
});
expect(await findByLabelText(/loading/i)).toBeInTheDocument();
});

it('keeps the empty challenge container out of the layout until the script signals visibility', async () => {
const { container, setWidgetVisible } = await renderWithPendingChallenge();

// No reserved height and no flex-gap slot while there is nothing to show.
expect(container.style.minHeight).toBe('');
expect(container.style.position).toBe('absolute');

await act(async () => {
await setWidgetVisible(true);
});
expect(container.style.position).toBe('static');
});

it('ignores visibility signals from an abandoned run', async () => {
const { wrapper } = await createFixtures(f => {
f.startSignInWithProtectCheck();
});
let staleSetWidgetVisible: ((visible: boolean) => Promise<void>) | undefined;
let rejectRun: ((err: Error) => void) | undefined;
mockExecute
.mockImplementationOnce((_protectCheck, _el, opts) => {
staleSetWidgetVisible = opts?.setWidgetVisible;
return new Promise((_, reject) => {
rejectRun = reject;
});
})
.mockImplementation(() => new Promise(() => {})); // retry run stays pending

const { findByRole, findByLabelText, queryByLabelText } = render(<SignInProtectCheck />, { wrapper });
await waitFor(() => expect(mockExecute).toHaveBeenCalled());

rejectRun!(
new ClerkRuntimeError('Protect check script execution failed', { code: 'protect_check_execution_failed' }),
);
const retryButton = await findByRole('button', { name: /try again/i });
fireEvent.click(retryButton);
await waitFor(() => expect(mockExecute).toHaveBeenCalledTimes(2));
expect(await findByLabelText(/loading/i)).toBeInTheDocument();

// The failed run's script is a zombie (the abort signal is best-effort); a late signal
// from it must not flip visibility under the active run.
await act(async () => {
await staleSetWidgetVisible!(true);
});
expect(queryByLabelText(/loading/i)).toBeInTheDocument();
});

it('clears leftovers from a failed run so the retry starts with the spinner', async () => {
const { wrapper } = await createFixtures(f => {
f.startSignInWithProtectCheck();
});
let container: HTMLDivElement | undefined;
let setWidgetVisible: ((visible: boolean) => Promise<void>) | undefined;
let rejectRun: ((err: Error) => void) | undefined;
mockExecute
.mockImplementationOnce((_protectCheck, el, opts) => {
container = el as HTMLDivElement;
setWidgetVisible = opts?.setWidgetVisible;
return new Promise((_, reject) => {
rejectRun = reject;
});
})
.mockImplementation((_protectCheck, el) => {
container = el as HTMLDivElement;
return new Promise(() => {}); // retry run stays pending
});

const { findByRole, findByLabelText, queryByLabelText } = render(<SignInProtectCheck />, { wrapper });
await waitFor(() => expect(mockExecute).toHaveBeenCalled());

// A widget shows, then the run fails (e.g. turnstile error-callback).
container!.appendChild(document.createElement('div'));
await act(async () => {
await setWidgetVisible!(true);
});
expect(queryByLabelText(/loading/i)).not.toBeInTheDocument();
rejectRun!(
new ClerkRuntimeError('Protect check script execution failed', { code: 'protect_check_execution_failed' }),
);

const retryButton = await findByRole('button', { name: /try again/i });
fireEvent.click(retryButton);

// The new run owns the container: stale widget removed, spinner back — with no
// counter-signal from the dead script.
await waitFor(() => expect(mockExecute).toHaveBeenCalledTimes(2));
expect(container!.childNodes.length).toBe(0);
expect(await findByLabelText(/loading/i)).toBeInTheDocument();
});
});

it('shows a retry control after a failure and re-runs the challenge when clicked', async () => {
const { wrapper, fixtures } = await createFixtures(f => {
f.startSignInWithProtectCheck();
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
Merged
6 changes: 6 additions & 0 deletions .changeset/protect-check-spinner-widget-visibility.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/shared': patch
'@clerk/ui': patch
---

Polish the Protect check card: the loading spinner now hides while a challenge widget (e.g. Turnstile) is visible instead of spinning alongside it, only appears after a short delay so near-instant checks never flash it, and the card no longer reserves empty space above the spinner before a widget has rendered.
Original file line numberDiff line numberDiff line change
Expand Up@@ -63,26 +63,30 @@ describe('executeProtectCheck', () => {
expect(result).toBe('proof-token-123');
});

it('passes only the spec-defined fields (token, uiHints, signal) — NOT the full resource', async () => {
it('passes only the spec-defined fields (token, uiHints, signal, setWidgetVisible) — NOT the full resource', async () => {
const fn = vi.fn().mockResolvedValue('proof');
vi.doMock('https://protect.example.com/sdk-args.js', () => ({ default: fn }));

const container = fakeContainer();
const controller = new AbortController();
// The visibility handshake: the script calls this before revealing UI so the host can
// drop its own spinner first; the promise resolves once the host has applied the change.
const setWidgetVisible = vi.fn().mockResolvedValue(undefined);
await executeProtectCheck(
protectCheck({
sdkUrl: 'https://protect.example.com/sdk-args.js',
token: 'opaque-challenge-token',
uiHints: { reason: 'device_new' },
}),
container,
{ signal: controller.signal },
{ signal: controller.signal, setWidgetVisible },
);

expect(fn).toHaveBeenCalledWith(container, {
token: 'opaque-challenge-token',
uiHints: { reason: 'device_new' },
signal: controller.signal,
setWidgetVisible,
});
});
});
Expand Down
15 changes: 13 additions & 2 deletions packages/shared/src/internal/clerk-js/protectCheck.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,16 @@ import { ClerkRuntimeError } from '../../error';
import type { ProtectCheckResource } from '../../types';

export interface ExecuteProtectCheckOptions {
/**
* Host-provided visibility handshake, forwarded to the script verbatim as
* `setWidgetVisible` in the init payload. The script calls it right before revealing UI in
* the container (and with `false` once its widget is done); the returned promise resolves
* only after the host has applied the change to the DOM (e.g. removed its own loading
* spinner), so the script can sequence its reveal without a frame of overlap. A script that
* knows its widget is imminent may call it immediately to avoid a spinner flash. Scripts
* must treat the field as optional — older hosts don't provide it.
*/
setWidgetVisible?: (visible: boolean) => Promise<void>;
/**
* Signals that the caller no longer needs the proof token (component unmounted, user
* navigated away, etc.). When the signal aborts:
Expand All@@ -22,6 +32,7 @@ interface ScriptInitOptions {
token: string;
uiHints?: Record<string, string>;
signal?: AbortSignal;
setWidgetVisible?: (visible: boolean) => Promise<void>;
}

type ScriptDefault = (container: HTMLDivElement, init: ScriptInitOptions) => Promise<string>;
Expand DownExpand Up@@ -88,7 +99,7 @@ export async function executeProtectCheck(
container: HTMLDivElement,
options: ExecuteProtectCheckOptions = {},
): Promise<string> {
const { signal } = options;
const { signal, setWidgetVisible } = options;
const { sdkUrl, token, uiHints } = protectCheck;

const validated = assertValidSdkUrl(sdkUrl);
Expand DownExpand Up@@ -123,7 +134,7 @@ export async function executeProtectCheck(

let proofToken: string;
try {
proofToken = await (mod.default as ScriptDefault)(container, { token, uiHints, signal });
proofToken = await (mod.default as ScriptDefault)(container, { token, uiHints, signal, setWidgetVisible });
} catch (err) {
// Distinguish abort-induced rejections from genuine script errors: only relabel as
// `protect_check_aborted` when the error looks like an abort (`AbortError`), otherwise
Expand Down
25 changes: 15 additions & 10 deletions packages/ui/src/components/SignIn/SignInProtectCheck.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ import {
Spinner,
useLocalizations,
} from '../../customizables';
import { useSpinDelay } from '../../hooks';
import { useProtectCheckRunner } from '../../hooks/useProtectCheckRunner';
import { useRouter } from '../../router';

Expand DownExpand Up@@ -63,7 +64,7 @@ function SignInProtectCheckInternal(): JSX.Element {
const { setActive } = useClerk();
const { afterSignInUrl, navigateOnSetActive } = useSignInContext();

const { containerRef, isRunning, hasError, retry } = useProtectCheckRunner<SignInResource>({
const { containerRef, isRunning, isWidgetVisible, hasError, retry } = useProtectCheckRunner<SignInResource>({
getProtectCheck: () => signIn.protectCheck,
getResource: () => signIn,
reload: () => signIn.reload(),
Expand All@@ -88,6 +89,13 @@ function SignInProtectCheckInternal(): JSX.Element {
},
});

// Debounce the spinner's entrance so a near-instant check (or a script that signals its
// widget immediately) never flashes it — the card header alone carries the first ~300ms.
// The error and widget-visibility gates stay OUTSIDE the delay hook below: its minimum
// visible duration must never outrank the handshake's "spinner is gone when the promise
// resolves" guarantee, nor keep a spinner next to the retry button.
const showSpinner = useSpinDelay(isRunning, { delay: 300 });

return (
<Flow.Part part='protectCheck'>
<Card.Root>
Expand All@@ -105,21 +113,18 @@ function SignInProtectCheckInternal(): JSX.Element {
ref={containerRef}
id='clerk-protect-check'
aria-busy={isRunning}
style={{ display: 'block', alignSelf: 'center', minHeight: '60px' }}
// Out of flow while empty so the collapsed container adds no reserved height or flex-gap
// gutter above the spinner (same idiom as CaptchaElement's `gapless` mode).
style={{ display: 'block', alignSelf: 'center', position: isWidgetVisible ? 'static' : 'absolute' }}
/>
{isRunning && !hasError ? (
<Flex
direction='col'
center
gap={4}
aria-live='polite'
>
{showSpinner && !hasError && !isWidgetVisible ? (
<Flex center>
<Spinner
size='lg'
colorScheme='primary'
elementDescriptor={descriptors.spinner}
aria-label={t(localizationKeys('signIn.protectCheck.loading'))}
/>
<Box>{t(localizationKeys('signIn.protectCheck.loading'))}</Box>
</Flex>
) : null}
{hasError ? (
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { ClerkAPIResponseError, ClerkRuntimeError } from '@clerk/shared/error';
import type { SignInResource } from '@clerk/shared/types';
import { waitFor } from '@testing-library/react';
import { act, waitFor } from '@testing-library/react';
import { beforeEach, describe, expect, it, vi } from 'vitest';

import { bindCreateFixtures } from '@/test/create-fixtures';
Expand DownExpand Up@@ -250,6 +250,197 @@ describe('SignInProtectCheck', () => {
});
});

describe('challenge widget visibility', () => {
// Visibility is driven by the script, not observed from the DOM: executeProtectCheck hands
// the script a `setWidgetVisible` callback in its init payload, and the script calls it
// right before revealing UI in the container (and with `false` once the widget is done).
const renderWithPendingChallenge = async () => {
const { wrapper } = await createFixtures(f => {
f.startSignInWithProtectCheck();
});
let container: HTMLDivElement | undefined;
let setWidgetVisible: ((visible: boolean) => Promise<void>) | undefined;
mockExecute.mockImplementation((_protectCheck, el, opts) => {
container = el as HTMLDivElement;
setWidgetVisible = opts?.setWidgetVisible;
return new Promise(() => {}); // never resolves; the check stays running
});
const utils = render(<SignInProtectCheck />, { wrapper });
await waitFor(() => expect(mockExecute).toHaveBeenCalled());
return { ...utils, container: container!, setWidgetVisible: setWidgetVisible! };
};

it('waits a beat before showing the spinner so near-instant checks never flash it', async () => {
const { queryByLabelText, findByLabelText } = await renderWithPendingChallenge();

// Inside the spin-delay window nothing shows yet (the card header is already
// adequate feedback); the spinner only joins once the wait is genuinely long.
expect(queryByLabelText(/loading/i)).not.toBeInTheDocument();
expect(await findByLabelText(/loading/i)).toBeInTheDocument();
});

it('never shows the spinner for a check that completes before the delay', async () => {
const { wrapper, fixtures } = await createFixtures(f => {
f.startSignInWithProtectCheck();
});
mockExecute.mockResolvedValue('proof-fast');
fixtures.signIn.submitProtectCheck.mockResolvedValue({
status: 'needs_first_factor',
protectCheck: null,
createdSessionId: null,
} as unknown as SignInResource);

const { queryByLabelText } = render(<SignInProtectCheck />, { wrapper });

await waitFor(() => expect(fixtures.router.navigate).toHaveBeenCalledWith('../factor-one'));
expect(queryByLabelText(/loading/i)).not.toBeInTheDocument();
// The delayed timer must not fire the spinner after the run has already ended.
await new Promise(resolve => setTimeout(resolve, 400));
expect(queryByLabelText(/loading/i)).not.toBeInTheDocument();
});

it('drops the spinner immediately on failure, minDuration notwithstanding', async () => {
const { wrapper } = await createFixtures(f => {
f.startSignInWithProtectCheck();
});
let rejectRun: ((err: Error) => void) | undefined;
mockExecute.mockImplementation(
() =>
new Promise((_, reject) => {
rejectRun = reject;
}),
);

const { findByRole, findByLabelText, queryByLabelText } = render(<SignInProtectCheck />, { wrapper });
expect(await findByLabelText(/loading/i)).toBeInTheDocument();

rejectRun!(
new ClerkRuntimeError('Protect check script execution failed', { code: 'protect_check_execution_failed' }),
);

// The retry control and the spinner must not coexist — the error gate outranks
// the spin-delay's minimum-visible duration.
await findByRole('button', { name: /try again/i });
expect(queryByLabelText(/loading/i)).not.toBeInTheDocument();
});

it('hides the spinner while the script signals a visible widget and restores it on the counter-signal', async () => {
const { setWidgetVisible, queryByText, queryByLabelText, findByLabelText } = await renderWithPendingChallenge();

// Invisible phase (SDK loading / executing): the spinner is the progress indicator.
expect(await findByLabelText(/loading/i)).toBeInTheDocument();
// The label lives on the spinner itself — no visible "Loading" text (design-system
// consistency; see the dogfooding thread).
expect(queryByText(/loading/i)).not.toBeInTheDocument();

// The script announces its widget. By the time the promise resolves, the spinner must
// ALREADY be out of the DOM — that's the contract that lets the script reveal its UI
// without a frame of overlap.
let spinnerGoneAtResolve = false;
await act(async () => {
await setWidgetVisible(true);
spinnerGoneAtResolve = queryByLabelText(/loading/i) === null;
});
expect(spinnerGoneAtResolve).toBe(true);

// Widget done (e.g. solved, proof verification in flight): spinner takes back over.
await act(async () => {
await setWidgetVisible(false);
});
expect(await findByLabelText(/loading/i)).toBeInTheDocument();
});

it('keeps the empty challenge container out of the layout until the script signals visibility', async () => {
const { container, setWidgetVisible } = await renderWithPendingChallenge();

// No reserved height and no flex-gap slot while there is nothing to show.
expect(container.style.minHeight).toBe('');
expect(container.style.position).toBe('absolute');

await act(async () => {
await setWidgetVisible(true);
});
expect(container.style.position).toBe('static');
});

it('ignores visibility signals from an abandoned run', async () => {
const { wrapper } = await createFixtures(f => {
f.startSignInWithProtectCheck();
});
let staleSetWidgetVisible: ((visible: boolean) => Promise<void>) | undefined;
let rejectRun: ((err: Error) => void) | undefined;
mockExecute
.mockImplementationOnce((_protectCheck, _el, opts) => {
staleSetWidgetVisible = opts?.setWidgetVisible;
return new Promise((_, reject) => {
rejectRun = reject;
});
})
.mockImplementation(() => new Promise(() => {})); // retry run stays pending

const { findByRole, findByLabelText, queryByLabelText } = render(<SignInProtectCheck />, { wrapper });
await waitFor(() => expect(mockExecute).toHaveBeenCalled());

rejectRun!(
new ClerkRuntimeError('Protect check script execution failed', { code: 'protect_check_execution_failed' }),
);
const retryButton = await findByRole('button', { name: /try again/i });
fireEvent.click(retryButton);
await waitFor(() => expect(mockExecute).toHaveBeenCalledTimes(2));
expect(await findByLabelText(/loading/i)).toBeInTheDocument();

// The failed run's script is a zombie (the abort signal is best-effort); a late signal
// from it must not flip visibility under the active run.
await act(async () => {
await staleSetWidgetVisible!(true);
});
expect(queryByLabelText(/loading/i)).toBeInTheDocument();
});

it('clears leftovers from a failed run so the retry starts with the spinner', async () => {
const { wrapper } = await createFixtures(f => {
f.startSignInWithProtectCheck();
});
let container: HTMLDivElement | undefined;
let setWidgetVisible: ((visible: boolean) => Promise<void>) | undefined;
let rejectRun: ((err: Error) => void) | undefined;
mockExecute
.mockImplementationOnce((_protectCheck, el, opts) => {
container = el as HTMLDivElement;
setWidgetVisible = opts?.setWidgetVisible;
return new Promise((_, reject) => {
rejectRun = reject;
});
})
.mockImplementation((_protectCheck, el) => {
container = el as HTMLDivElement;
return new Promise(() => {}); // retry run stays pending
});

const { findByRole, findByLabelText, queryByLabelText } = render(<SignInProtectCheck />, { wrapper });
await waitFor(() => expect(mockExecute).toHaveBeenCalled());

// A widget shows, then the run fails (e.g. turnstile error-callback).
container!.appendChild(document.createElement('div'));
await act(async () => {
await setWidgetVisible!(true);
});
expect(queryByLabelText(/loading/i)).not.toBeInTheDocument();
rejectRun!(
new ClerkRuntimeError('Protect check script execution failed', { code: 'protect_check_execution_failed' }),
);

const retryButton = await findByRole('button', { name: /try again/i });
fireEvent.click(retryButton);

// The new run owns the container: stale widget removed, spinner back — with no
// counter-signal from the dead script.
await waitFor(() => expect(mockExecute).toHaveBeenCalledTimes(2));
expect(container!.childNodes.length).toBe(0);
expect(await findByLabelText(/loading/i)).toBeInTheDocument();
});
});

it('shows a retry control after a failure and re-runs the challenge when clicked', async () => {
const { wrapper, fixtures } = await createFixtures(f => {
f.startSignInWithProtectCheck();
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
Merged
6 changes: 6 additions & 0 deletions .changeset/protect-check-spinner-widget-visibility.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/shared': patch
'@clerk/ui': patch
---

Polish the Protect check card: the loading spinner now hides while a challenge widget (e.g. Turnstile) is visible instead of spinning alongside it, only appears after a short delay so near-instant checks never flash it, and the card no longer reserves empty space above the spinner before a widget has rendered.
Original file line numberDiff line numberDiff line change
Expand Up@@ -63,26 +63,30 @@ describe('executeProtectCheck', () => {
expect(result).toBe('proof-token-123');
});

it('passes only the spec-defined fields (token, uiHints, signal) — NOT the full resource', async () => {
it('passes only the spec-defined fields (token, uiHints, signal, setWidgetVisible) — NOT the full resource', async () => {
const fn = vi.fn().mockResolvedValue('proof');
vi.doMock('https://protect.example.com/sdk-args.js', () => ({ default: fn }));

const container = fakeContainer();
const controller = new AbortController();
// The visibility handshake: the script calls this before revealing UI so the host can
// drop its own spinner first; the promise resolves once the host has applied the change.
const setWidgetVisible = vi.fn().mockResolvedValue(undefined);
await executeProtectCheck(
protectCheck({
sdkUrl: 'https://protect.example.com/sdk-args.js',
token: 'opaque-challenge-token',
uiHints: { reason: 'device_new' },
}),
container,
{ signal: controller.signal },
{ signal: controller.signal, setWidgetVisible },
);

expect(fn).toHaveBeenCalledWith(container, {
token: 'opaque-challenge-token',
uiHints: { reason: 'device_new' },
signal: controller.signal,
setWidgetVisible,
});
});
});
Expand Down
15 changes: 13 additions & 2 deletions packages/shared/src/internal/clerk-js/protectCheck.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,16 @@ import { ClerkRuntimeError } from '../../error';
import type { ProtectCheckResource } from '../../types';

export interface ExecuteProtectCheckOptions {
/**
* Host-provided visibility handshake, forwarded to the script verbatim as
* `setWidgetVisible` in the init payload. The script calls it right before revealing UI in
* the container (and with `false` once its widget is done); the returned promise resolves
* only after the host has applied the change to the DOM (e.g. removed its own loading
* spinner), so the script can sequence its reveal without a frame of overlap. A script that
* knows its widget is imminent may call it immediately to avoid a spinner flash. Scripts
* must treat the field as optional — older hosts don't provide it.
*/
setWidgetVisible?: (visible: boolean) => Promise<void>;
/**
* Signals that the caller no longer needs the proof token (component unmounted, user
* navigated away, etc.). When the signal aborts:
Expand All@@ -22,6 +32,7 @@ interface ScriptInitOptions {
token: string;
uiHints?: Record<string, string>;
signal?: AbortSignal;
setWidgetVisible?: (visible: boolean) => Promise<void>;
}

type ScriptDefault = (container: HTMLDivElement, init: ScriptInitOptions) => Promise<string>;
Expand DownExpand Up@@ -88,7 +99,7 @@ export async function executeProtectCheck(
container: HTMLDivElement,
options: ExecuteProtectCheckOptions = {},
): Promise<string> {
const { signal } = options;
const { signal, setWidgetVisible } = options;
const { sdkUrl, token, uiHints } = protectCheck;

const validated = assertValidSdkUrl(sdkUrl);
Expand DownExpand Up@@ -123,7 +134,7 @@ export async function executeProtectCheck(

let proofToken: string;
try {
proofToken = await (mod.default as ScriptDefault)(container, { token, uiHints, signal });
proofToken = await (mod.default as ScriptDefault)(container, { token, uiHints, signal, setWidgetVisible });
} catch (err) {
// Distinguish abort-induced rejections from genuine script errors: only relabel as
// `protect_check_aborted` when the error looks like an abort (`AbortError`), otherwise
Expand Down
25 changes: 15 additions & 10 deletions packages/ui/src/components/SignIn/SignInProtectCheck.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ import {
Spinner,
useLocalizations,
} from '../../customizables';
import { useSpinDelay } from '../../hooks';
import { useProtectCheckRunner } from '../../hooks/useProtectCheckRunner';
import { useRouter } from '../../router';

Expand DownExpand Up@@ -63,7 +64,7 @@ function SignInProtectCheckInternal(): JSX.Element {
const { setActive } = useClerk();
const { afterSignInUrl, navigateOnSetActive } = useSignInContext();

const { containerRef, isRunning, hasError, retry } = useProtectCheckRunner<SignInResource>({
const { containerRef, isRunning, isWidgetVisible, hasError, retry } = useProtectCheckRunner<SignInResource>({
getProtectCheck: () => signIn.protectCheck,
getResource: () => signIn,
reload: () => signIn.reload(),
Expand All@@ -88,6 +89,13 @@ function SignInProtectCheckInternal(): JSX.Element {
},
});

// Debounce the spinner's entrance so a near-instant check (or a script that signals its
// widget immediately) never flashes it — the card header alone carries the first ~300ms.
// The error and widget-visibility gates stay OUTSIDE the delay hook below: its minimum
// visible duration must never outrank the handshake's "spinner is gone when the promise
// resolves" guarantee, nor keep a spinner next to the retry button.
const showSpinner = useSpinDelay(isRunning, { delay: 300 });

return (
<Flow.Part part='protectCheck'>
<Card.Root>
Expand All@@ -105,21 +113,18 @@ function SignInProtectCheckInternal(): JSX.Element {
ref={containerRef}
id='clerk-protect-check'
aria-busy={isRunning}
style={{ display: 'block', alignSelf: 'center', minHeight: '60px' }}
// Out of flow while empty so the collapsed container adds no reserved height or flex-gap
// gutter above the spinner (same idiom as CaptchaElement's `gapless` mode).
style={{ display: 'block', alignSelf: 'center', position: isWidgetVisible ? 'static' : 'absolute' }}
/>
{isRunning && !hasError ? (
<Flex
direction='col'
center
gap={4}
aria-live='polite'
>
{showSpinner && !hasError && !isWidgetVisible ? (
<Flex center>
<Spinner
size='lg'
colorScheme='primary'
elementDescriptor={descriptors.spinner}
aria-label={t(localizationKeys('signIn.protectCheck.loading'))}
/>
<Box>{t(localizationKeys('signIn.protectCheck.loading'))}</Box>
</Flex>
) : null}
{hasError ? (
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { ClerkAPIResponseError, ClerkRuntimeError } from '@clerk/shared/error';
import type { SignInResource } from '@clerk/shared/types';
import { waitFor } from '@testing-library/react';
import { act, waitFor } from '@testing-library/react';
import { beforeEach, describe, expect, it, vi } from 'vitest';

import { bindCreateFixtures } from '@/test/create-fixtures';
Expand DownExpand Up@@ -250,6 +250,197 @@ describe('SignInProtectCheck', () => {
});
});

describe('challenge widget visibility', () => {
// Visibility is driven by the script, not observed from the DOM: executeProtectCheck hands
// the script a `setWidgetVisible` callback in its init payload, and the script calls it
// right before revealing UI in the container (and with `false` once the widget is done).
const renderWithPendingChallenge = async () => {
const { wrapper } = await createFixtures(f => {
f.startSignInWithProtectCheck();
});
let container: HTMLDivElement | undefined;
let setWidgetVisible: ((visible: boolean) => Promise<void>) | undefined;
mockExecute.mockImplementation((_protectCheck, el, opts) => {
container = el as HTMLDivElement;
setWidgetVisible = opts?.setWidgetVisible;
return new Promise(() => {}); // never resolves; the check stays running
});
const utils = render(<SignInProtectCheck />, { wrapper });
await waitFor(() => expect(mockExecute).toHaveBeenCalled());
return { ...utils, container: container!, setWidgetVisible: setWidgetVisible! };
};

it('waits a beat before showing the spinner so near-instant checks never flash it', async () => {
const { queryByLabelText, findByLabelText } = await renderWithPendingChallenge();

// Inside the spin-delay window nothing shows yet (the card header is already
// adequate feedback); the spinner only joins once the wait is genuinely long.
expect(queryByLabelText(/loading/i)).not.toBeInTheDocument();
expect(await findByLabelText(/loading/i)).toBeInTheDocument();
});

it('never shows the spinner for a check that completes before the delay', async () => {
const { wrapper, fixtures } = await createFixtures(f => {
f.startSignInWithProtectCheck();
});
mockExecute.mockResolvedValue('proof-fast');
fixtures.signIn.submitProtectCheck.mockResolvedValue({
status: 'needs_first_factor',
protectCheck: null,
createdSessionId: null,
} as unknown as SignInResource);

const { queryByLabelText } = render(<SignInProtectCheck />, { wrapper });

await waitFor(() => expect(fixtures.router.navigate).toHaveBeenCalledWith('../factor-one'));
expect(queryByLabelText(/loading/i)).not.toBeInTheDocument();
// The delayed timer must not fire the spinner after the run has already ended.
await new Promise(resolve => setTimeout(resolve, 400));
expect(queryByLabelText(/loading/i)).not.toBeInTheDocument();
});

it('drops the spinner immediately on failure, minDuration notwithstanding', async () => {
const { wrapper } = await createFixtures(f => {
f.startSignInWithProtectCheck();
});
let rejectRun: ((err: Error) => void) | undefined;
mockExecute.mockImplementation(
() =>
new Promise((_, reject) => {
rejectRun = reject;
}),
);

const { findByRole, findByLabelText, queryByLabelText } = render(<SignInProtectCheck />, { wrapper });
expect(await findByLabelText(/loading/i)).toBeInTheDocument();

rejectRun!(
new ClerkRuntimeError('Protect check script execution failed', { code: 'protect_check_execution_failed' }),
);

// The retry control and the spinner must not coexist — the error gate outranks
// the spin-delay's minimum-visible duration.
await findByRole('button', { name: /try again/i });
expect(queryByLabelText(/loading/i)).not.toBeInTheDocument();
});

it('hides the spinner while the script signals a visible widget and restores it on the counter-signal', async () => {
const { setWidgetVisible, queryByText, queryByLabelText, findByLabelText } = await renderWithPendingChallenge();

// Invisible phase (SDK loading / executing): the spinner is the progress indicator.
expect(await findByLabelText(/loading/i)).toBeInTheDocument();
// The label lives on the spinner itself — no visible "Loading" text (design-system
// consistency; see the dogfooding thread).
expect(queryByText(/loading/i)).not.toBeInTheDocument();

// The script announces its widget. By the time the promise resolves, the spinner must
// ALREADY be out of the DOM — that's the contract that lets the script reveal its UI
// without a frame of overlap.
let spinnerGoneAtResolve = false;
await act(async () => {
await setWidgetVisible(true);
spinnerGoneAtResolve = queryByLabelText(/loading/i) === null;
});
expect(spinnerGoneAtResolve).toBe(true);

// Widget done (e.g. solved, proof verification in flight): spinner takes back over.
await act(async () => {
await setWidgetVisible(false);
});
expect(await findByLabelText(/loading/i)).toBeInTheDocument();
});

it('keeps the empty challenge container out of the layout until the script signals visibility', async () => {
const { container, setWidgetVisible } = await renderWithPendingChallenge();

// No reserved height and no flex-gap slot while there is nothing to show.
expect(container.style.minHeight).toBe('');
expect(container.style.position).toBe('absolute');

await act(async () => {
await setWidgetVisible(true);
});
expect(container.style.position).toBe('static');
});

it('ignores visibility signals from an abandoned run', async () => {
const { wrapper } = await createFixtures(f => {
f.startSignInWithProtectCheck();
});
let staleSetWidgetVisible: ((visible: boolean) => Promise<void>) | undefined;
let rejectRun: ((err: Error) => void) | undefined;
mockExecute
.mockImplementationOnce((_protectCheck, _el, opts) => {
staleSetWidgetVisible = opts?.setWidgetVisible;
return new Promise((_, reject) => {
rejectRun = reject;
});
})
.mockImplementation(() => new Promise(() => {})); // retry run stays pending

const { findByRole, findByLabelText, queryByLabelText } = render(<SignInProtectCheck />, { wrapper });
await waitFor(() => expect(mockExecute).toHaveBeenCalled());

rejectRun!(
new ClerkRuntimeError('Protect check script execution failed', { code: 'protect_check_execution_failed' }),
);
const retryButton = await findByRole('button', { name: /try again/i });
fireEvent.click(retryButton);
await waitFor(() => expect(mockExecute).toHaveBeenCalledTimes(2));
expect(await findByLabelText(/loading/i)).toBeInTheDocument();

// The failed run's script is a zombie (the abort signal is best-effort); a late signal
// from it must not flip visibility under the active run.
await act(async () => {
await staleSetWidgetVisible!(true);
});
expect(queryByLabelText(/loading/i)).toBeInTheDocument();
});

it('clears leftovers from a failed run so the retry starts with the spinner', async () => {
const { wrapper } = await createFixtures(f => {
f.startSignInWithProtectCheck();
});
let container: HTMLDivElement | undefined;
let setWidgetVisible: ((visible: boolean) => Promise<void>) | undefined;
let rejectRun: ((err: Error) => void) | undefined;
mockExecute
.mockImplementationOnce((_protectCheck, el, opts) => {
container = el as HTMLDivElement;
setWidgetVisible = opts?.setWidgetVisible;
return new Promise((_, reject) => {
rejectRun = reject;
});
})
.mockImplementation((_protectCheck, el) => {
container = el as HTMLDivElement;
return new Promise(() => {}); // retry run stays pending
});

const { findByRole, findByLabelText, queryByLabelText } = render(<SignInProtectCheck />, { wrapper });
await waitFor(() => expect(mockExecute).toHaveBeenCalled());

// A widget shows, then the run fails (e.g. turnstile error-callback).
container!.appendChild(document.createElement('div'));
await act(async () => {
await setWidgetVisible!(true);
});
expect(queryByLabelText(/loading/i)).not.toBeInTheDocument();
rejectRun!(
new ClerkRuntimeError('Protect check script execution failed', { code: 'protect_check_execution_failed' }),
);

const retryButton = await findByRole('button', { name: /try again/i });
fireEvent.click(retryButton);

// The new run owns the container: stale widget removed, spinner back — with no
// counter-signal from the dead script.
await waitFor(() => expect(mockExecute).toHaveBeenCalledTimes(2));
expect(container!.childNodes.length).toBe(0);
expect(await findByLabelText(/loading/i)).toBeInTheDocument();
});
});

it('shows a retry control after a failure and re-runs the challenge when clicked', async () => {
const { wrapper, fixtures } = await createFixtures(f => {
f.startSignInWithProtectCheck();
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
Merged
6 changes: 6 additions & 0 deletions .changeset/protect-check-spinner-widget-visibility.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/shared': patch
'@clerk/ui': patch
---

Polish the Protect check card: the loading spinner now hides while a challenge widget (e.g. Turnstile) is visible instead of spinning alongside it, only appears after a short delay so near-instant checks never flash it, and the card no longer reserves empty space above the spinner before a widget has rendered.
Original file line numberDiff line numberDiff line change
Expand Up@@ -63,26 +63,30 @@ describe('executeProtectCheck', () => {
expect(result).toBe('proof-token-123');
});

it('passes only the spec-defined fields (token, uiHints, signal) — NOT the full resource', async () => {
it('passes only the spec-defined fields (token, uiHints, signal, setWidgetVisible) — NOT the full resource', async () => {
const fn = vi.fn().mockResolvedValue('proof');
vi.doMock('https://protect.example.com/sdk-args.js', () => ({ default: fn }));

const container = fakeContainer();
const controller = new AbortController();
// The visibility handshake: the script calls this before revealing UI so the host can
// drop its own spinner first; the promise resolves once the host has applied the change.
const setWidgetVisible = vi.fn().mockResolvedValue(undefined);
await executeProtectCheck(
protectCheck({
sdkUrl: 'https://protect.example.com/sdk-args.js',
token: 'opaque-challenge-token',
uiHints: { reason: 'device_new' },
}),
container,
{ signal: controller.signal },
{ signal: controller.signal, setWidgetVisible },
);

expect(fn).toHaveBeenCalledWith(container, {
token: 'opaque-challenge-token',
uiHints: { reason: 'device_new' },
signal: controller.signal,
setWidgetVisible,
});
});
});
Expand Down
15 changes: 13 additions & 2 deletions packages/shared/src/internal/clerk-js/protectCheck.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,16 @@ import { ClerkRuntimeError } from '../../error';
import type { ProtectCheckResource } from '../../types';

export interface ExecuteProtectCheckOptions {
/**
* Host-provided visibility handshake, forwarded to the script verbatim as
* `setWidgetVisible` in the init payload. The script calls it right before revealing UI in
* the container (and with `false` once its widget is done); the returned promise resolves
* only after the host has applied the change to the DOM (e.g. removed its own loading
* spinner), so the script can sequence its reveal without a frame of overlap. A script that
* knows its widget is imminent may call it immediately to avoid a spinner flash. Scripts
* must treat the field as optional — older hosts don't provide it.
*/
setWidgetVisible?: (visible: boolean) => Promise<void>;
/**
* Signals that the caller no longer needs the proof token (component unmounted, user
* navigated away, etc.). When the signal aborts:
Expand All@@ -22,6 +32,7 @@ interface ScriptInitOptions {
token: string;
uiHints?: Record<string, string>;
signal?: AbortSignal;
setWidgetVisible?: (visible: boolean) => Promise<void>;
}

type ScriptDefault = (container: HTMLDivElement, init: ScriptInitOptions) => Promise<string>;
Expand DownExpand Up@@ -88,7 +99,7 @@ export async function executeProtectCheck(
container: HTMLDivElement,
options: ExecuteProtectCheckOptions = {},
): Promise<string> {
const { signal } = options;
const { signal, setWidgetVisible } = options;
const { sdkUrl, token, uiHints } = protectCheck;

const validated = assertValidSdkUrl(sdkUrl);
Expand DownExpand Up@@ -123,7 +134,7 @@ export async function executeProtectCheck(

let proofToken: string;
try {
proofToken = await (mod.default as ScriptDefault)(container, { token, uiHints, signal });
proofToken = await (mod.default as ScriptDefault)(container, { token, uiHints, signal, setWidgetVisible });
} catch (err) {
// Distinguish abort-induced rejections from genuine script errors: only relabel as
// `protect_check_aborted` when the error looks like an abort (`AbortError`), otherwise
Expand Down
25 changes: 15 additions & 10 deletions packages/ui/src/components/SignIn/SignInProtectCheck.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ import {
Spinner,
useLocalizations,
} from '../../customizables';
import { useSpinDelay } from '../../hooks';
import { useProtectCheckRunner } from '../../hooks/useProtectCheckRunner';
import { useRouter } from '../../router';

Expand DownExpand Up@@ -63,7 +64,7 @@ function SignInProtectCheckInternal(): JSX.Element {
const { setActive } = useClerk();
const { afterSignInUrl, navigateOnSetActive } = useSignInContext();

const { containerRef, isRunning, hasError, retry } = useProtectCheckRunner<SignInResource>({
const { containerRef, isRunning, isWidgetVisible, hasError, retry } = useProtectCheckRunner<SignInResource>({
getProtectCheck: () => signIn.protectCheck,
getResource: () => signIn,
reload: () => signIn.reload(),
Expand All@@ -88,6 +89,13 @@ function SignInProtectCheckInternal(): JSX.Element {
},
});

// Debounce the spinner's entrance so a near-instant check (or a script that signals its
// widget immediately) never flashes it — the card header alone carries the first ~300ms.
// The error and widget-visibility gates stay OUTSIDE the delay hook below: its minimum
// visible duration must never outrank the handshake's "spinner is gone when the promise
// resolves" guarantee, nor keep a spinner next to the retry button.
const showSpinner = useSpinDelay(isRunning, { delay: 300 });

return (
<Flow.Part part='protectCheck'>
<Card.Root>
Expand All@@ -105,21 +113,18 @@ function SignInProtectCheckInternal(): JSX.Element {
ref={containerRef}
id='clerk-protect-check'
aria-busy={isRunning}
style={{ display: 'block', alignSelf: 'center', minHeight: '60px' }}
// Out of flow while empty so the collapsed container adds no reserved height or flex-gap
// gutter above the spinner (same idiom as CaptchaElement's `gapless` mode).
style={{ display: 'block', alignSelf: 'center', position: isWidgetVisible ? 'static' : 'absolute' }}
/>
{isRunning && !hasError ? (
<Flex
direction='col'
center
gap={4}
aria-live='polite'
>
{showSpinner && !hasError && !isWidgetVisible ? (
<Flex center>
<Spinner
size='lg'
colorScheme='primary'
elementDescriptor={descriptors.spinner}
aria-label={t(localizationKeys('signIn.protectCheck.loading'))}
/>
<Box>{t(localizationKeys('signIn.protectCheck.loading'))}</Box>
</Flex>
) : null}
{hasError ? (
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { ClerkAPIResponseError, ClerkRuntimeError } from '@clerk/shared/error';
import type { SignInResource } from '@clerk/shared/types';
import { waitFor } from '@testing-library/react';
import { act, waitFor } from '@testing-library/react';
import { beforeEach, describe, expect, it, vi } from 'vitest';

import { bindCreateFixtures } from '@/test/create-fixtures';
Expand DownExpand Up@@ -250,6 +250,197 @@ describe('SignInProtectCheck', () => {
});
});

describe('challenge widget visibility', () => {
// Visibility is driven by the script, not observed from the DOM: executeProtectCheck hands
// the script a `setWidgetVisible` callback in its init payload, and the script calls it
// right before revealing UI in the container (and with `false` once the widget is done).
const renderWithPendingChallenge = async () => {
const { wrapper } = await createFixtures(f => {
f.startSignInWithProtectCheck();
});
let container: HTMLDivElement | undefined;
let setWidgetVisible: ((visible: boolean) => Promise<void>) | undefined;
mockExecute.mockImplementation((_protectCheck, el, opts) => {
container = el as HTMLDivElement;
setWidgetVisible = opts?.setWidgetVisible;
return new Promise(() => {}); // never resolves; the check stays running
});
const utils = render(<SignInProtectCheck />, { wrapper });
await waitFor(() => expect(mockExecute).toHaveBeenCalled());
return { ...utils, container: container!, setWidgetVisible: setWidgetVisible! };
};

it('waits a beat before showing the spinner so near-instant checks never flash it', async () => {
const { queryByLabelText, findByLabelText } = await renderWithPendingChallenge();

// Inside the spin-delay window nothing shows yet (the card header is already
// adequate feedback); the spinner only joins once the wait is genuinely long.
expect(queryByLabelText(/loading/i)).not.toBeInTheDocument();
expect(await findByLabelText(/loading/i)).toBeInTheDocument();
});

it('never shows the spinner for a check that completes before the delay', async () => {
const { wrapper, fixtures } = await createFixtures(f => {
f.startSignInWithProtectCheck();
});
mockExecute.mockResolvedValue('proof-fast');
fixtures.signIn.submitProtectCheck.mockResolvedValue({
status: 'needs_first_factor',
protectCheck: null,
createdSessionId: null,
} as unknown as SignInResource);

const { queryByLabelText } = render(<SignInProtectCheck />, { wrapper });

await waitFor(() => expect(fixtures.router.navigate).toHaveBeenCalledWith('../factor-one'));
expect(queryByLabelText(/loading/i)).not.toBeInTheDocument();
// The delayed timer must not fire the spinner after the run has already ended.
await new Promise(resolve => setTimeout(resolve, 400));
expect(queryByLabelText(/loading/i)).not.toBeInTheDocument();
});

it('drops the spinner immediately on failure, minDuration notwithstanding', async () => {
const { wrapper } = await createFixtures(f => {
f.startSignInWithProtectCheck();
});
let rejectRun: ((err: Error) => void) | undefined;
mockExecute.mockImplementation(
() =>
new Promise((_, reject) => {
rejectRun = reject;
}),
);

const { findByRole, findByLabelText, queryByLabelText } = render(<SignInProtectCheck />, { wrapper });
expect(await findByLabelText(/loading/i)).toBeInTheDocument();

rejectRun!(
new ClerkRuntimeError('Protect check script execution failed', { code: 'protect_check_execution_failed' }),
);

// The retry control and the spinner must not coexist — the error gate outranks
// the spin-delay's minimum-visible duration.
await findByRole('button', { name: /try again/i });
expect(queryByLabelText(/loading/i)).not.toBeInTheDocument();
});

it('hides the spinner while the script signals a visible widget and restores it on the counter-signal', async () => {
const { setWidgetVisible, queryByText, queryByLabelText, findByLabelText } = await renderWithPendingChallenge();

// Invisible phase (SDK loading / executing): the spinner is the progress indicator.
expect(await findByLabelText(/loading/i)).toBeInTheDocument();
// The label lives on the spinner itself — no visible "Loading" text (design-system
// consistency; see the dogfooding thread).
expect(queryByText(/loading/i)).not.toBeInTheDocument();

// The script announces its widget. By the time the promise resolves, the spinner must
// ALREADY be out of the DOM — that's the contract that lets the script reveal its UI
// without a frame of overlap.
let spinnerGoneAtResolve = false;
await act(async () => {
await setWidgetVisible(true);
spinnerGoneAtResolve = queryByLabelText(/loading/i) === null;
});
expect(spinnerGoneAtResolve).toBe(true);

// Widget done (e.g. solved, proof verification in flight): spinner takes back over.
await act(async () => {
await setWidgetVisible(false);
});
expect(await findByLabelText(/loading/i)).toBeInTheDocument();
});

it('keeps the empty challenge container out of the layout until the script signals visibility', async () => {
const { container, setWidgetVisible } = await renderWithPendingChallenge();

// No reserved height and no flex-gap slot while there is nothing to show.
expect(container.style.minHeight).toBe('');
expect(container.style.position).toBe('absolute');

await act(async () => {
await setWidgetVisible(true);
});
expect(container.style.position).toBe('static');
});

it('ignores visibility signals from an abandoned run', async () => {
const { wrapper } = await createFixtures(f => {
f.startSignInWithProtectCheck();
});
let staleSetWidgetVisible: ((visible: boolean) => Promise<void>) | undefined;
let rejectRun: ((err: Error) => void) | undefined;
mockExecute
.mockImplementationOnce((_protectCheck, _el, opts) => {
staleSetWidgetVisible = opts?.setWidgetVisible;
return new Promise((_, reject) => {
rejectRun = reject;
});
})
.mockImplementation(() => new Promise(() => {})); // retry run stays pending

const { findByRole, findByLabelText, queryByLabelText } = render(<SignInProtectCheck />, { wrapper });
await waitFor(() => expect(mockExecute).toHaveBeenCalled());

rejectRun!(
new ClerkRuntimeError('Protect check script execution failed', { code: 'protect_check_execution_failed' }),
);
const retryButton = await findByRole('button', { name: /try again/i });
fireEvent.click(retryButton);
await waitFor(() => expect(mockExecute).toHaveBeenCalledTimes(2));
expect(await findByLabelText(/loading/i)).toBeInTheDocument();

// The failed run's script is a zombie (the abort signal is best-effort); a late signal
// from it must not flip visibility under the active run.
await act(async () => {
await staleSetWidgetVisible!(true);
});
expect(queryByLabelText(/loading/i)).toBeInTheDocument();
});

it('clears leftovers from a failed run so the retry starts with the spinner', async () => {
const { wrapper } = await createFixtures(f => {
f.startSignInWithProtectCheck();
});
let container: HTMLDivElement | undefined;
let setWidgetVisible: ((visible: boolean) => Promise<void>) | undefined;
let rejectRun: ((err: Error) => void) | undefined;
mockExecute
.mockImplementationOnce((_protectCheck, el, opts) => {
container = el as HTMLDivElement;
setWidgetVisible = opts?.setWidgetVisible;
return new Promise((_, reject) => {
rejectRun = reject;
});
})
.mockImplementation((_protectCheck, el) => {
container = el as HTMLDivElement;
return new Promise(() => {}); // retry run stays pending
});

const { findByRole, findByLabelText, queryByLabelText } = render(<SignInProtectCheck />, { wrapper });
await waitFor(() => expect(mockExecute).toHaveBeenCalled());

// A widget shows, then the run fails (e.g. turnstile error-callback).
container!.appendChild(document.createElement('div'));
await act(async () => {
await setWidgetVisible!(true);
});
expect(queryByLabelText(/loading/i)).not.toBeInTheDocument();
rejectRun!(
new ClerkRuntimeError('Protect check script execution failed', { code: 'protect_check_execution_failed' }),
);

const retryButton = await findByRole('button', { name: /try again/i });
fireEvent.click(retryButton);

// The new run owns the container: stale widget removed, spinner back — with no
// counter-signal from the dead script.
await waitFor(() => expect(mockExecute).toHaveBeenCalledTimes(2));
expect(container!.childNodes.length).toBe(0);
expect(await findByLabelText(/loading/i)).toBeInTheDocument();
});
});

it('shows a retry control after a failure and re-runs the challenge when clicked', async () => {
const { wrapper, fixtures } = await createFixtures(f => {
f.startSignInWithProtectCheck();
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
Merged
6 changes: 6 additions & 0 deletions .changeset/protect-check-spinner-widget-visibility.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/shared': patch
'@clerk/ui': patch
---

Polish the Protect check card: the loading spinner now hides while a challenge widget (e.g. Turnstile) is visible instead of spinning alongside it, only appears after a short delay so near-instant checks never flash it, and the card no longer reserves empty space above the spinner before a widget has rendered.
Original file line numberDiff line numberDiff line change
Expand Up@@ -63,26 +63,30 @@ describe('executeProtectCheck', () => {
expect(result).toBe('proof-token-123');
});

it('passes only the spec-defined fields (token, uiHints, signal) — NOT the full resource', async () => {
it('passes only the spec-defined fields (token, uiHints, signal, setWidgetVisible) — NOT the full resource', async () => {
const fn = vi.fn().mockResolvedValue('proof');
vi.doMock('https://protect.example.com/sdk-args.js', () => ({ default: fn }));

const container = fakeContainer();
const controller = new AbortController();
// The visibility handshake: the script calls this before revealing UI so the host can
// drop its own spinner first; the promise resolves once the host has applied the change.
const setWidgetVisible = vi.fn().mockResolvedValue(undefined);
await executeProtectCheck(
protectCheck({
sdkUrl: 'https://protect.example.com/sdk-args.js',
token: 'opaque-challenge-token',
uiHints: { reason: 'device_new' },
}),
container,
{ signal: controller.signal },
{ signal: controller.signal, setWidgetVisible },
);

expect(fn).toHaveBeenCalledWith(container, {
token: 'opaque-challenge-token',
uiHints: { reason: 'device_new' },
signal: controller.signal,
setWidgetVisible,
});
});
});
Expand Down
15 changes: 13 additions & 2 deletions packages/shared/src/internal/clerk-js/protectCheck.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,16 @@ import { ClerkRuntimeError } from '../../error';
import type { ProtectCheckResource } from '../../types';

export interface ExecuteProtectCheckOptions {
/**
* Host-provided visibility handshake, forwarded to the script verbatim as
* `setWidgetVisible` in the init payload. The script calls it right before revealing UI in
* the container (and with `false` once its widget is done); the returned promise resolves
* only after the host has applied the change to the DOM (e.g. removed its own loading
* spinner), so the script can sequence its reveal without a frame of overlap. A script that
* knows its widget is imminent may call it immediately to avoid a spinner flash. Scripts
* must treat the field as optional — older hosts don't provide it.
*/
setWidgetVisible?: (visible: boolean) => Promise<void>;
/**
* Signals that the caller no longer needs the proof token (component unmounted, user
* navigated away, etc.). When the signal aborts:
Expand All@@ -22,6 +32,7 @@ interface ScriptInitOptions {
token: string;
uiHints?: Record<string, string>;
signal?: AbortSignal;
setWidgetVisible?: (visible: boolean) => Promise<void>;
}

type ScriptDefault = (container: HTMLDivElement, init: ScriptInitOptions) => Promise<string>;
Expand DownExpand Up@@ -88,7 +99,7 @@ export async function executeProtectCheck(
container: HTMLDivElement,
options: ExecuteProtectCheckOptions = {},
): Promise<string> {
const { signal } = options;
const { signal, setWidgetVisible } = options;
const { sdkUrl, token, uiHints } = protectCheck;

const validated = assertValidSdkUrl(sdkUrl);
Expand DownExpand Up@@ -123,7 +134,7 @@ export async function executeProtectCheck(

let proofToken: string;
try {
proofToken = await (mod.default as ScriptDefault)(container, { token, uiHints, signal });
proofToken = await (mod.default as ScriptDefault)(container, { token, uiHints, signal, setWidgetVisible });
} catch (err) {
// Distinguish abort-induced rejections from genuine script errors: only relabel as
// `protect_check_aborted` when the error looks like an abort (`AbortError`), otherwise
Expand Down
25 changes: 15 additions & 10 deletions packages/ui/src/components/SignIn/SignInProtectCheck.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ import {
Spinner,
useLocalizations,
} from '../../customizables';
import { useSpinDelay } from '../../hooks';
import { useProtectCheckRunner } from '../../hooks/useProtectCheckRunner';
import { useRouter } from '../../router';

Expand DownExpand Up@@ -63,7 +64,7 @@ function SignInProtectCheckInternal(): JSX.Element {
const { setActive } = useClerk();
const { afterSignInUrl, navigateOnSetActive } = useSignInContext();

const { containerRef, isRunning, hasError, retry } = useProtectCheckRunner<SignInResource>({
const { containerRef, isRunning, isWidgetVisible, hasError, retry } = useProtectCheckRunner<SignInResource>({
getProtectCheck: () => signIn.protectCheck,
getResource: () => signIn,
reload: () => signIn.reload(),
Expand All@@ -88,6 +89,13 @@ function SignInProtectCheckInternal(): JSX.Element {
},
});

// Debounce the spinner's entrance so a near-instant check (or a script that signals its
// widget immediately) never flashes it — the card header alone carries the first ~300ms.
// The error and widget-visibility gates stay OUTSIDE the delay hook below: its minimum
// visible duration must never outrank the handshake's "spinner is gone when the promise
// resolves" guarantee, nor keep a spinner next to the retry button.
const showSpinner = useSpinDelay(isRunning, { delay: 300 });

return (
<Flow.Part part='protectCheck'>
<Card.Root>
Expand All@@ -105,21 +113,18 @@ function SignInProtectCheckInternal(): JSX.Element {
ref={containerRef}
id='clerk-protect-check'
aria-busy={isRunning}
style={{ display: 'block', alignSelf: 'center', minHeight: '60px' }}
// Out of flow while empty so the collapsed container adds no reserved height or flex-gap
// gutter above the spinner (same idiom as CaptchaElement's `gapless` mode).
style={{ display: 'block', alignSelf: 'center', position: isWidgetVisible ? 'static' : 'absolute' }}
/>
{isRunning && !hasError ? (
<Flex
direction='col'
center
gap={4}
aria-live='polite'
>
{showSpinner && !hasError && !isWidgetVisible ? (
<Flex center>
<Spinner
size='lg'
colorScheme='primary'
elementDescriptor={descriptors.spinner}
aria-label={t(localizationKeys('signIn.protectCheck.loading'))}
/>
<Box>{t(localizationKeys('signIn.protectCheck.loading'))}</Box>
</Flex>
) : null}
{hasError ? (
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { ClerkAPIResponseError, ClerkRuntimeError } from '@clerk/shared/error';
import type { SignInResource } from '@clerk/shared/types';
import { waitFor } from '@testing-library/react';
import { act, waitFor } from '@testing-library/react';
import { beforeEach, describe, expect, it, vi } from 'vitest';

import { bindCreateFixtures } from '@/test/create-fixtures';
Expand DownExpand Up@@ -250,6 +250,197 @@ describe('SignInProtectCheck', () => {
});
});

describe('challenge widget visibility', () => {
// Visibility is driven by the script, not observed from the DOM: executeProtectCheck hands
// the script a `setWidgetVisible` callback in its init payload, and the script calls it
// right before revealing UI in the container (and with `false` once the widget is done).
const renderWithPendingChallenge = async () => {
const { wrapper } = await createFixtures(f => {
f.startSignInWithProtectCheck();
});
let container: HTMLDivElement | undefined;
let setWidgetVisible: ((visible: boolean) => Promise<void>) | undefined;
mockExecute.mockImplementation((_protectCheck, el, opts) => {
container = el as HTMLDivElement;
setWidgetVisible = opts?.setWidgetVisible;
return new Promise(() => {}); // never resolves; the check stays running
});
const utils = render(<SignInProtectCheck />, { wrapper });
await waitFor(() => expect(mockExecute).toHaveBeenCalled());
return { ...utils, container: container!, setWidgetVisible: setWidgetVisible! };
};

it('waits a beat before showing the spinner so near-instant checks never flash it', async () => {
const { queryByLabelText, findByLabelText } = await renderWithPendingChallenge();

// Inside the spin-delay window nothing shows yet (the card header is already
// adequate feedback); the spinner only joins once the wait is genuinely long.
expect(queryByLabelText(/loading/i)).not.toBeInTheDocument();
expect(await findByLabelText(/loading/i)).toBeInTheDocument();
});

it('never shows the spinner for a check that completes before the delay', async () => {
const { wrapper, fixtures } = await createFixtures(f => {
f.startSignInWithProtectCheck();
});
mockExecute.mockResolvedValue('proof-fast');
fixtures.signIn.submitProtectCheck.mockResolvedValue({
status: 'needs_first_factor',
protectCheck: null,
createdSessionId: null,
} as unknown as SignInResource);

const { queryByLabelText } = render(<SignInProtectCheck />, { wrapper });

await waitFor(() => expect(fixtures.router.navigate).toHaveBeenCalledWith('../factor-one'));
expect(queryByLabelText(/loading/i)).not.toBeInTheDocument();
// The delayed timer must not fire the spinner after the run has already ended.
await new Promise(resolve => setTimeout(resolve, 400));
expect(queryByLabelText(/loading/i)).not.toBeInTheDocument();
});

it('drops the spinner immediately on failure, minDuration notwithstanding', async () => {
const { wrapper } = await createFixtures(f => {
f.startSignInWithProtectCheck();
});
let rejectRun: ((err: Error) => void) | undefined;
mockExecute.mockImplementation(
() =>
new Promise((_, reject) => {
rejectRun = reject;
}),
);

const { findByRole, findByLabelText, queryByLabelText } = render(<SignInProtectCheck />, { wrapper });
expect(await findByLabelText(/loading/i)).toBeInTheDocument();

rejectRun!(
new ClerkRuntimeError('Protect check script execution failed', { code: 'protect_check_execution_failed' }),
);

// The retry control and the spinner must not coexist — the error gate outranks
// the spin-delay's minimum-visible duration.
await findByRole('button', { name: /try again/i });
expect(queryByLabelText(/loading/i)).not.toBeInTheDocument();
});

it('hides the spinner while the script signals a visible widget and restores it on the counter-signal', async () => {
const { setWidgetVisible, queryByText, queryByLabelText, findByLabelText } = await renderWithPendingChallenge();

// Invisible phase (SDK loading / executing): the spinner is the progress indicator.
expect(await findByLabelText(/loading/i)).toBeInTheDocument();
// The label lives on the spinner itself — no visible "Loading" text (design-system
// consistency; see the dogfooding thread).
expect(queryByText(/loading/i)).not.toBeInTheDocument();

// The script announces its widget. By the time the promise resolves, the spinner must
// ALREADY be out of the DOM — that's the contract that lets the script reveal its UI
// without a frame of overlap.
let spinnerGoneAtResolve = false;
await act(async () => {
await setWidgetVisible(true);
spinnerGoneAtResolve = queryByLabelText(/loading/i) === null;
});
expect(spinnerGoneAtResolve).toBe(true);

// Widget done (e.g. solved, proof verification in flight): spinner takes back over.
await act(async () => {
await setWidgetVisible(false);
});
expect(await findByLabelText(/loading/i)).toBeInTheDocument();
});

it('keeps the empty challenge container out of the layout until the script signals visibility', async () => {
const { container, setWidgetVisible } = await renderWithPendingChallenge();

// No reserved height and no flex-gap slot while there is nothing to show.
expect(container.style.minHeight).toBe('');
expect(container.style.position).toBe('absolute');

await act(async () => {
await setWidgetVisible(true);
});
expect(container.style.position).toBe('static');
});

it('ignores visibility signals from an abandoned run', async () => {
const { wrapper } = await createFixtures(f => {
f.startSignInWithProtectCheck();
});
let staleSetWidgetVisible: ((visible: boolean) => Promise<void>) | undefined;
let rejectRun: ((err: Error) => void) | undefined;
mockExecute
.mockImplementationOnce((_protectCheck, _el, opts) => {
staleSetWidgetVisible = opts?.setWidgetVisible;
return new Promise((_, reject) => {
rejectRun = reject;
});
})
.mockImplementation(() => new Promise(() => {})); // retry run stays pending

const { findByRole, findByLabelText, queryByLabelText } = render(<SignInProtectCheck />, { wrapper });
await waitFor(() => expect(mockExecute).toHaveBeenCalled());

rejectRun!(
new ClerkRuntimeError('Protect check script execution failed', { code: 'protect_check_execution_failed' }),
);
const retryButton = await findByRole('button', { name: /try again/i });
fireEvent.click(retryButton);
await waitFor(() => expect(mockExecute).toHaveBeenCalledTimes(2));
expect(await findByLabelText(/loading/i)).toBeInTheDocument();

// The failed run's script is a zombie (the abort signal is best-effort); a late signal
// from it must not flip visibility under the active run.
await act(async () => {
await staleSetWidgetVisible!(true);
});
expect(queryByLabelText(/loading/i)).toBeInTheDocument();
});

it('clears leftovers from a failed run so the retry starts with the spinner', async () => {
const { wrapper } = await createFixtures(f => {
f.startSignInWithProtectCheck();
});
let container: HTMLDivElement | undefined;
let setWidgetVisible: ((visible: boolean) => Promise<void>) | undefined;
let rejectRun: ((err: Error) => void) | undefined;
mockExecute
.mockImplementationOnce((_protectCheck, el, opts) => {
container = el as HTMLDivElement;
setWidgetVisible = opts?.setWidgetVisible;
return new Promise((_, reject) => {
rejectRun = reject;
});
})
.mockImplementation((_protectCheck, el) => {
container = el as HTMLDivElement;
return new Promise(() => {}); // retry run stays pending
});

const { findByRole, findByLabelText, queryByLabelText } = render(<SignInProtectCheck />, { wrapper });
await waitFor(() => expect(mockExecute).toHaveBeenCalled());

// A widget shows, then the run fails (e.g. turnstile error-callback).
container!.appendChild(document.createElement('div'));
await act(async () => {
await setWidgetVisible!(true);
});
expect(queryByLabelText(/loading/i)).not.toBeInTheDocument();
rejectRun!(
new ClerkRuntimeError('Protect check script execution failed', { code: 'protect_check_execution_failed' }),
);

const retryButton = await findByRole('button', { name: /try again/i });
fireEvent.click(retryButton);

// The new run owns the container: stale widget removed, spinner back — with no
// counter-signal from the dead script.
await waitFor(() => expect(mockExecute).toHaveBeenCalledTimes(2));
expect(container!.childNodes.length).toBe(0);
expect(await findByLabelText(/loading/i)).toBeInTheDocument();
});
});

it('shows a retry control after a failure and re-runs the challenge when clicked', async () => {
const { wrapper, fixtures } = await createFixtures(f => {
f.startSignInWithProtectCheck();
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
Merged
6 changes: 6 additions & 0 deletions .changeset/protect-check-spinner-widget-visibility.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/shared': patch
'@clerk/ui': patch
---

Polish the Protect check card: the loading spinner now hides while a challenge widget (e.g. Turnstile) is visible instead of spinning alongside it, only appears after a short delay so near-instant checks never flash it, and the card no longer reserves empty space above the spinner before a widget has rendered.
Original file line numberDiff line numberDiff line change
Expand Up@@ -63,26 +63,30 @@ describe('executeProtectCheck', () => {
expect(result).toBe('proof-token-123');
});

it('passes only the spec-defined fields (token, uiHints, signal) — NOT the full resource', async () => {
it('passes only the spec-defined fields (token, uiHints, signal, setWidgetVisible) — NOT the full resource', async () => {
const fn = vi.fn().mockResolvedValue('proof');
vi.doMock('https://protect.example.com/sdk-args.js', () => ({ default: fn }));

const container = fakeContainer();
const controller = new AbortController();
// The visibility handshake: the script calls this before revealing UI so the host can
// drop its own spinner first; the promise resolves once the host has applied the change.
const setWidgetVisible = vi.fn().mockResolvedValue(undefined);
await executeProtectCheck(
protectCheck({
sdkUrl: 'https://protect.example.com/sdk-args.js',
token: 'opaque-challenge-token',
uiHints: { reason: 'device_new' },
}),
container,
{ signal: controller.signal },
{ signal: controller.signal, setWidgetVisible },
);

expect(fn).toHaveBeenCalledWith(container, {
token: 'opaque-challenge-token',
uiHints: { reason: 'device_new' },
signal: controller.signal,
setWidgetVisible,
});
});
});
Expand Down
15 changes: 13 additions & 2 deletions packages/shared/src/internal/clerk-js/protectCheck.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,16 @@ import { ClerkRuntimeError } from '../../error';
import type { ProtectCheckResource } from '../../types';

export interface ExecuteProtectCheckOptions {
/**
* Host-provided visibility handshake, forwarded to the script verbatim as
* `setWidgetVisible` in the init payload. The script calls it right before revealing UI in
* the container (and with `false` once its widget is done); the returned promise resolves
* only after the host has applied the change to the DOM (e.g. removed its own loading
* spinner), so the script can sequence its reveal without a frame of overlap. A script that
* knows its widget is imminent may call it immediately to avoid a spinner flash. Scripts
* must treat the field as optional — older hosts don't provide it.
*/
setWidgetVisible?: (visible: boolean) => Promise<void>;
/**
* Signals that the caller no longer needs the proof token (component unmounted, user
* navigated away, etc.). When the signal aborts:
Expand All@@ -22,6 +32,7 @@ interface ScriptInitOptions {
token: string;
uiHints?: Record<string, string>;
signal?: AbortSignal;
setWidgetVisible?: (visible: boolean) => Promise<void>;
}

type ScriptDefault = (container: HTMLDivElement, init: ScriptInitOptions) => Promise<string>;
Expand DownExpand Up@@ -88,7 +99,7 @@ export async function executeProtectCheck(
container: HTMLDivElement,
options: ExecuteProtectCheckOptions = {},
): Promise<string> {
const { signal } = options;
const { signal, setWidgetVisible } = options;
const { sdkUrl, token, uiHints } = protectCheck;

const validated = assertValidSdkUrl(sdkUrl);
Expand DownExpand Up@@ -123,7 +134,7 @@ export async function executeProtectCheck(

let proofToken: string;
try {
proofToken = await (mod.default as ScriptDefault)(container, { token, uiHints, signal });
proofToken = await (mod.default as ScriptDefault)(container, { token, uiHints, signal, setWidgetVisible });
} catch (err) {
// Distinguish abort-induced rejections from genuine script errors: only relabel as
// `protect_check_aborted` when the error looks like an abort (`AbortError`), otherwise
Expand Down
25 changes: 15 additions & 10 deletions packages/ui/src/components/SignIn/SignInProtectCheck.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ import {
Spinner,
useLocalizations,
} from '../../customizables';
import { useSpinDelay } from '../../hooks';
import { useProtectCheckRunner } from '../../hooks/useProtectCheckRunner';
import { useRouter } from '../../router';

Expand DownExpand Up@@ -63,7 +64,7 @@ function SignInProtectCheckInternal(): JSX.Element {
const { setActive } = useClerk();
const { afterSignInUrl, navigateOnSetActive } = useSignInContext();

const { containerRef, isRunning, hasError, retry } = useProtectCheckRunner<SignInResource>({
const { containerRef, isRunning, isWidgetVisible, hasError, retry } = useProtectCheckRunner<SignInResource>({
getProtectCheck: () => signIn.protectCheck,
getResource: () => signIn,
reload: () => signIn.reload(),
Expand All@@ -88,6 +89,13 @@ function SignInProtectCheckInternal(): JSX.Element {
},
});

// Debounce the spinner's entrance so a near-instant check (or a script that signals its
// widget immediately) never flashes it — the card header alone carries the first ~300ms.
// The error and widget-visibility gates stay OUTSIDE the delay hook below: its minimum
// visible duration must never outrank the handshake's "spinner is gone when the promise
// resolves" guarantee, nor keep a spinner next to the retry button.
const showSpinner = useSpinDelay(isRunning, { delay: 300 });

return (
<Flow.Part part='protectCheck'>
<Card.Root>
Expand All@@ -105,21 +113,18 @@ function SignInProtectCheckInternal(): JSX.Element {
ref={containerRef}
id='clerk-protect-check'
aria-busy={isRunning}
style={{ display: 'block', alignSelf: 'center', minHeight: '60px' }}
// Out of flow while empty so the collapsed container adds no reserved height or flex-gap
// gutter above the spinner (same idiom as CaptchaElement's `gapless` mode).
style={{ display: 'block', alignSelf: 'center', position: isWidgetVisible ? 'static' : 'absolute' }}
/>
{isRunning && !hasError ? (
<Flex
direction='col'
center
gap={4}
aria-live='polite'
>
{showSpinner && !hasError && !isWidgetVisible ? (
<Flex center>
<Spinner
size='lg'
colorScheme='primary'
elementDescriptor={descriptors.spinner}
aria-label={t(localizationKeys('signIn.protectCheck.loading'))}
/>
<Box>{t(localizationKeys('signIn.protectCheck.loading'))}</Box>
</Flex>
) : null}
{hasError ? (
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { ClerkAPIResponseError, ClerkRuntimeError } from '@clerk/shared/error';
import type { SignInResource } from '@clerk/shared/types';
import { waitFor } from '@testing-library/react';
import { act, waitFor } from '@testing-library/react';
import { beforeEach, describe, expect, it, vi } from 'vitest';

import { bindCreateFixtures } from '@/test/create-fixtures';
Expand DownExpand Up@@ -250,6 +250,197 @@ describe('SignInProtectCheck', () => {
});
});

describe('challenge widget visibility', () => {
// Visibility is driven by the script, not observed from the DOM: executeProtectCheck hands
// the script a `setWidgetVisible` callback in its init payload, and the script calls it
// right before revealing UI in the container (and with `false` once the widget is done).
const renderWithPendingChallenge = async () => {
const { wrapper } = await createFixtures(f => {
f.startSignInWithProtectCheck();
});
let container: HTMLDivElement | undefined;
let setWidgetVisible: ((visible: boolean) => Promise<void>) | undefined;
mockExecute.mockImplementation((_protectCheck, el, opts) => {
container = el as HTMLDivElement;
setWidgetVisible = opts?.setWidgetVisible;
return new Promise(() => {}); // never resolves; the check stays running
});
const utils = render(<SignInProtectCheck />, { wrapper });
await waitFor(() => expect(mockExecute).toHaveBeenCalled());
return { ...utils, container: container!, setWidgetVisible: setWidgetVisible! };
};

it('waits a beat before showing the spinner so near-instant checks never flash it', async () => {
const { queryByLabelText, findByLabelText } = await renderWithPendingChallenge();

// Inside the spin-delay window nothing shows yet (the card header is already
// adequate feedback); the spinner only joins once the wait is genuinely long.
expect(queryByLabelText(/loading/i)).not.toBeInTheDocument();
expect(await findByLabelText(/loading/i)).toBeInTheDocument();
});

it('never shows the spinner for a check that completes before the delay', async () => {
const { wrapper, fixtures } = await createFixtures(f => {
f.startSignInWithProtectCheck();
});
mockExecute.mockResolvedValue('proof-fast');
fixtures.signIn.submitProtectCheck.mockResolvedValue({
status: 'needs_first_factor',
protectCheck: null,
createdSessionId: null,
} as unknown as SignInResource);

const { queryByLabelText } = render(<SignInProtectCheck />, { wrapper });

await waitFor(() => expect(fixtures.router.navigate).toHaveBeenCalledWith('../factor-one'));
expect(queryByLabelText(/loading/i)).not.toBeInTheDocument();
// The delayed timer must not fire the spinner after the run has already ended.
await new Promise(resolve => setTimeout(resolve, 400));
expect(queryByLabelText(/loading/i)).not.toBeInTheDocument();
});

it('drops the spinner immediately on failure, minDuration notwithstanding', async () => {
const { wrapper } = await createFixtures(f => {
f.startSignInWithProtectCheck();
});
let rejectRun: ((err: Error) => void) | undefined;
mockExecute.mockImplementation(
() =>
new Promise((_, reject) => {
rejectRun = reject;
}),
);

const { findByRole, findByLabelText, queryByLabelText } = render(<SignInProtectCheck />, { wrapper });
expect(await findByLabelText(/loading/i)).toBeInTheDocument();

rejectRun!(
new ClerkRuntimeError('Protect check script execution failed', { code: 'protect_check_execution_failed' }),
);

// The retry control and the spinner must not coexist — the error gate outranks
// the spin-delay's minimum-visible duration.
await findByRole('button', { name: /try again/i });
expect(queryByLabelText(/loading/i)).not.toBeInTheDocument();
});

it('hides the spinner while the script signals a visible widget and restores it on the counter-signal', async () => {
const { setWidgetVisible, queryByText, queryByLabelText, findByLabelText } = await renderWithPendingChallenge();

// Invisible phase (SDK loading / executing): the spinner is the progress indicator.
expect(await findByLabelText(/loading/i)).toBeInTheDocument();
// The label lives on the spinner itself — no visible "Loading" text (design-system
// consistency; see the dogfooding thread).
expect(queryByText(/loading/i)).not.toBeInTheDocument();

// The script announces its widget. By the time the promise resolves, the spinner must
// ALREADY be out of the DOM — that's the contract that lets the script reveal its UI
// without a frame of overlap.
let spinnerGoneAtResolve = false;
await act(async () => {
await setWidgetVisible(true);
spinnerGoneAtResolve = queryByLabelText(/loading/i) === null;
});
expect(spinnerGoneAtResolve).toBe(true);

// Widget done (e.g. solved, proof verification in flight): spinner takes back over.
await act(async () => {
await setWidgetVisible(false);
});
expect(await findByLabelText(/loading/i)).toBeInTheDocument();
});

it('keeps the empty challenge container out of the layout until the script signals visibility', async () => {
const { container, setWidgetVisible } = await renderWithPendingChallenge();

// No reserved height and no flex-gap slot while there is nothing to show.
expect(container.style.minHeight).toBe('');
expect(container.style.position).toBe('absolute');

await act(async () => {
await setWidgetVisible(true);
});
expect(container.style.position).toBe('static');
});

it('ignores visibility signals from an abandoned run', async () => {
const { wrapper } = await createFixtures(f => {
f.startSignInWithProtectCheck();
});
let staleSetWidgetVisible: ((visible: boolean) => Promise<void>) | undefined;
let rejectRun: ((err: Error) => void) | undefined;
mockExecute
.mockImplementationOnce((_protectCheck, _el, opts) => {
staleSetWidgetVisible = opts?.setWidgetVisible;
return new Promise((_, reject) => {
rejectRun = reject;
});
})
.mockImplementation(() => new Promise(() => {})); // retry run stays pending

const { findByRole, findByLabelText, queryByLabelText } = render(<SignInProtectCheck />, { wrapper });
await waitFor(() => expect(mockExecute).toHaveBeenCalled());

rejectRun!(
new ClerkRuntimeError('Protect check script execution failed', { code: 'protect_check_execution_failed' }),
);
const retryButton = await findByRole('button', { name: /try again/i });
fireEvent.click(retryButton);
await waitFor(() => expect(mockExecute).toHaveBeenCalledTimes(2));
expect(await findByLabelText(/loading/i)).toBeInTheDocument();

// The failed run's script is a zombie (the abort signal is best-effort); a late signal
// from it must not flip visibility under the active run.
await act(async () => {
await staleSetWidgetVisible!(true);
});
expect(queryByLabelText(/loading/i)).toBeInTheDocument();
});

it('clears leftovers from a failed run so the retry starts with the spinner', async () => {
const { wrapper } = await createFixtures(f => {
f.startSignInWithProtectCheck();
});
let container: HTMLDivElement | undefined;
let setWidgetVisible: ((visible: boolean) => Promise<void>) | undefined;
let rejectRun: ((err: Error) => void) | undefined;
mockExecute
.mockImplementationOnce((_protectCheck, el, opts) => {
container = el as HTMLDivElement;
setWidgetVisible = opts?.setWidgetVisible;
return new Promise((_, reject) => {
rejectRun = reject;
});
})
.mockImplementation((_protectCheck, el) => {
container = el as HTMLDivElement;
return new Promise(() => {}); // retry run stays pending
});

const { findByRole, findByLabelText, queryByLabelText } = render(<SignInProtectCheck />, { wrapper });
await waitFor(() => expect(mockExecute).toHaveBeenCalled());

// A widget shows, then the run fails (e.g. turnstile error-callback).
container!.appendChild(document.createElement('div'));
await act(async () => {
await setWidgetVisible!(true);
});
expect(queryByLabelText(/loading/i)).not.toBeInTheDocument();
rejectRun!(
new ClerkRuntimeError('Protect check script execution failed', { code: 'protect_check_execution_failed' }),
);

const retryButton = await findByRole('button', { name: /try again/i });
fireEvent.click(retryButton);

// The new run owns the container: stale widget removed, spinner back — with no
// counter-signal from the dead script.
await waitFor(() => expect(mockExecute).toHaveBeenCalledTimes(2));
expect(container!.childNodes.length).toBe(0);
expect(await findByLabelText(/loading/i)).toBeInTheDocument();
});
});

it('shows a retry control after a failure and re-runs the challenge when clicked', async () => {
const { wrapper, fixtures } = await createFixtures(f => {
f.startSignInWithProtectCheck();
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
Merged
6 changes: 6 additions & 0 deletions .changeset/protect-check-spinner-widget-visibility.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/shared': patch
'@clerk/ui': patch
---

Polish the Protect check card: the loading spinner now hides while a challenge widget (e.g. Turnstile) is visible instead of spinning alongside it, only appears after a short delay so near-instant checks never flash it, and the card no longer reserves empty space above the spinner before a widget has rendered.
Original file line numberDiff line numberDiff line change
Expand Up@@ -63,26 +63,30 @@ describe('executeProtectCheck', () => {
expect(result).toBe('proof-token-123');
});

it('passes only the spec-defined fields (token, uiHints, signal) — NOT the full resource', async () => {
it('passes only the spec-defined fields (token, uiHints, signal, setWidgetVisible) — NOT the full resource', async () => {
const fn = vi.fn().mockResolvedValue('proof');
vi.doMock('https://protect.example.com/sdk-args.js', () => ({ default: fn }));

const container = fakeContainer();
const controller = new AbortController();
// The visibility handshake: the script calls this before revealing UI so the host can
// drop its own spinner first; the promise resolves once the host has applied the change.
const setWidgetVisible = vi.fn().mockResolvedValue(undefined);
await executeProtectCheck(
protectCheck({
sdkUrl: 'https://protect.example.com/sdk-args.js',
token: 'opaque-challenge-token',
uiHints: { reason: 'device_new' },
}),
container,
{ signal: controller.signal },
{ signal: controller.signal, setWidgetVisible },
);

expect(fn).toHaveBeenCalledWith(container, {
token: 'opaque-challenge-token',
uiHints: { reason: 'device_new' },
signal: controller.signal,
setWidgetVisible,
});
});
});
Expand Down
15 changes: 13 additions & 2 deletions packages/shared/src/internal/clerk-js/protectCheck.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,16 @@ import { ClerkRuntimeError } from '../../error';
import type { ProtectCheckResource } from '../../types';

export interface ExecuteProtectCheckOptions {
/**
* Host-provided visibility handshake, forwarded to the script verbatim as
* `setWidgetVisible` in the init payload. The script calls it right before revealing UI in
* the container (and with `false` once its widget is done); the returned promise resolves
* only after the host has applied the change to the DOM (e.g. removed its own loading
* spinner), so the script can sequence its reveal without a frame of overlap. A script that
* knows its widget is imminent may call it immediately to avoid a spinner flash. Scripts
* must treat the field as optional — older hosts don't provide it.
*/
setWidgetVisible?: (visible: boolean) => Promise<void>;
/**
* Signals that the caller no longer needs the proof token (component unmounted, user
* navigated away, etc.). When the signal aborts:
Expand All@@ -22,6 +32,7 @@ interface ScriptInitOptions {
token: string;
uiHints?: Record<string, string>;
signal?: AbortSignal;
setWidgetVisible?: (visible: boolean) => Promise<void>;
}

type ScriptDefault = (container: HTMLDivElement, init: ScriptInitOptions) => Promise<string>;
Expand DownExpand Up@@ -88,7 +99,7 @@ export async function executeProtectCheck(
container: HTMLDivElement,
options: ExecuteProtectCheckOptions = {},
): Promise<string> {
const { signal } = options;
const { signal, setWidgetVisible } = options;
const { sdkUrl, token, uiHints } = protectCheck;

const validated = assertValidSdkUrl(sdkUrl);
Expand DownExpand Up@@ -123,7 +134,7 @@ export async function executeProtectCheck(

let proofToken: string;
try {
proofToken = await (mod.default as ScriptDefault)(container, { token, uiHints, signal });
proofToken = await (mod.default as ScriptDefault)(container, { token, uiHints, signal, setWidgetVisible });
} catch (err) {
// Distinguish abort-induced rejections from genuine script errors: only relabel as
// `protect_check_aborted` when the error looks like an abort (`AbortError`), otherwise
Expand Down
25 changes: 15 additions & 10 deletions packages/ui/src/components/SignIn/SignInProtectCheck.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ import {
Spinner,
useLocalizations,
} from '../../customizables';
import { useSpinDelay } from '../../hooks';
import { useProtectCheckRunner } from '../../hooks/useProtectCheckRunner';
import { useRouter } from '../../router';

Expand DownExpand Up@@ -63,7 +64,7 @@ function SignInProtectCheckInternal(): JSX.Element {
const { setActive } = useClerk();
const { afterSignInUrl, navigateOnSetActive } = useSignInContext();

const { containerRef, isRunning, hasError, retry } = useProtectCheckRunner<SignInResource>({
const { containerRef, isRunning, isWidgetVisible, hasError, retry } = useProtectCheckRunner<SignInResource>({
getProtectCheck: () => signIn.protectCheck,
getResource: () => signIn,
reload: () => signIn.reload(),
Expand All@@ -88,6 +89,13 @@ function SignInProtectCheckInternal(): JSX.Element {
},
});

// Debounce the spinner's entrance so a near-instant check (or a script that signals its
// widget immediately) never flashes it — the card header alone carries the first ~300ms.
// The error and widget-visibility gates stay OUTSIDE the delay hook below: its minimum
// visible duration must never outrank the handshake's "spinner is gone when the promise
// resolves" guarantee, nor keep a spinner next to the retry button.
const showSpinner = useSpinDelay(isRunning, { delay: 300 });

return (
<Flow.Part part='protectCheck'>
<Card.Root>
Expand All@@ -105,21 +113,18 @@ function SignInProtectCheckInternal(): JSX.Element {
ref={containerRef}
id='clerk-protect-check'
aria-busy={isRunning}
style={{ display: 'block', alignSelf: 'center', minHeight: '60px' }}
// Out of flow while empty so the collapsed container adds no reserved height or flex-gap
// gutter above the spinner (same idiom as CaptchaElement's `gapless` mode).
style={{ display: 'block', alignSelf: 'center', position: isWidgetVisible ? 'static' : 'absolute' }}
/>
{isRunning && !hasError ? (
<Flex
direction='col'
center
gap={4}
aria-live='polite'
>
{showSpinner && !hasError && !isWidgetVisible ? (
<Flex center>
<Spinner
size='lg'
colorScheme='primary'
elementDescriptor={descriptors.spinner}
aria-label={t(localizationKeys('signIn.protectCheck.loading'))}
/>
<Box>{t(localizationKeys('signIn.protectCheck.loading'))}</Box>
</Flex>
) : null}
{hasError ? (
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { ClerkAPIResponseError, ClerkRuntimeError } from '@clerk/shared/error';
import type { SignInResource } from '@clerk/shared/types';
import { waitFor } from '@testing-library/react';
import { act, waitFor } from '@testing-library/react';
import { beforeEach, describe, expect, it, vi } from 'vitest';

import { bindCreateFixtures } from '@/test/create-fixtures';
Expand DownExpand Up@@ -250,6 +250,197 @@ describe('SignInProtectCheck', () => {
});
});

describe('challenge widget visibility', () => {
// Visibility is driven by the script, not observed from the DOM: executeProtectCheck hands
// the script a `setWidgetVisible` callback in its init payload, and the script calls it
// right before revealing UI in the container (and with `false` once the widget is done).
const renderWithPendingChallenge = async () => {
const { wrapper } = await createFixtures(f => {
f.startSignInWithProtectCheck();
});
let container: HTMLDivElement | undefined;
let setWidgetVisible: ((visible: boolean) => Promise<void>) | undefined;
mockExecute.mockImplementation((_protectCheck, el, opts) => {
container = el as HTMLDivElement;
setWidgetVisible = opts?.setWidgetVisible;
return new Promise(() => {}); // never resolves; the check stays running
});
const utils = render(<SignInProtectCheck />, { wrapper });
await waitFor(() => expect(mockExecute).toHaveBeenCalled());
return { ...utils, container: container!, setWidgetVisible: setWidgetVisible! };
};

it('waits a beat before showing the spinner so near-instant checks never flash it', async () => {
const { queryByLabelText, findByLabelText } = await renderWithPendingChallenge();

// Inside the spin-delay window nothing shows yet (the card header is already
// adequate feedback); the spinner only joins once the wait is genuinely long.
expect(queryByLabelText(/loading/i)).not.toBeInTheDocument();
expect(await findByLabelText(/loading/i)).toBeInTheDocument();
});

it('never shows the spinner for a check that completes before the delay', async () => {
const { wrapper, fixtures } = await createFixtures(f => {
f.startSignInWithProtectCheck();
});
mockExecute.mockResolvedValue('proof-fast');
fixtures.signIn.submitProtectCheck.mockResolvedValue({
status: 'needs_first_factor',
protectCheck: null,
createdSessionId: null,
} as unknown as SignInResource);

const { queryByLabelText } = render(<SignInProtectCheck />, { wrapper });

await waitFor(() => expect(fixtures.router.navigate).toHaveBeenCalledWith('../factor-one'));
expect(queryByLabelText(/loading/i)).not.toBeInTheDocument();
// The delayed timer must not fire the spinner after the run has already ended.
await new Promise(resolve => setTimeout(resolve, 400));
expect(queryByLabelText(/loading/i)).not.toBeInTheDocument();
});

it('drops the spinner immediately on failure, minDuration notwithstanding', async () => {
const { wrapper } = await createFixtures(f => {
f.startSignInWithProtectCheck();
});
let rejectRun: ((err: Error) => void) | undefined;
mockExecute.mockImplementation(
() =>
new Promise((_, reject) => {
rejectRun = reject;
}),
);

const { findByRole, findByLabelText, queryByLabelText } = render(<SignInProtectCheck />, { wrapper });
expect(await findByLabelText(/loading/i)).toBeInTheDocument();

rejectRun!(
new ClerkRuntimeError('Protect check script execution failed', { code: 'protect_check_execution_failed' }),
);

// The retry control and the spinner must not coexist — the error gate outranks
// the spin-delay's minimum-visible duration.
await findByRole('button', { name: /try again/i });
expect(queryByLabelText(/loading/i)).not.toBeInTheDocument();
});

it('hides the spinner while the script signals a visible widget and restores it on the counter-signal', async () => {
const { setWidgetVisible, queryByText, queryByLabelText, findByLabelText } = await renderWithPendingChallenge();

// Invisible phase (SDK loading / executing): the spinner is the progress indicator.
expect(await findByLabelText(/loading/i)).toBeInTheDocument();
// The label lives on the spinner itself — no visible "Loading" text (design-system
// consistency; see the dogfooding thread).
expect(queryByText(/loading/i)).not.toBeInTheDocument();

// The script announces its widget. By the time the promise resolves, the spinner must
// ALREADY be out of the DOM — that's the contract that lets the script reveal its UI
// without a frame of overlap.
let spinnerGoneAtResolve = false;
await act(async () => {
await setWidgetVisible(true);
spinnerGoneAtResolve = queryByLabelText(/loading/i) === null;
});
expect(spinnerGoneAtResolve).toBe(true);

// Widget done (e.g. solved, proof verification in flight): spinner takes back over.
await act(async () => {
await setWidgetVisible(false);
});
expect(await findByLabelText(/loading/i)).toBeInTheDocument();
});

it('keeps the empty challenge container out of the layout until the script signals visibility', async () => {
const { container, setWidgetVisible } = await renderWithPendingChallenge();

// No reserved height and no flex-gap slot while there is nothing to show.
expect(container.style.minHeight).toBe('');
expect(container.style.position).toBe('absolute');

await act(async () => {
await setWidgetVisible(true);
});
expect(container.style.position).toBe('static');
});

it('ignores visibility signals from an abandoned run', async () => {
const { wrapper } = await createFixtures(f => {
f.startSignInWithProtectCheck();
});
let staleSetWidgetVisible: ((visible: boolean) => Promise<void>) | undefined;
let rejectRun: ((err: Error) => void) | undefined;
mockExecute
.mockImplementationOnce((_protectCheck, _el, opts) => {
staleSetWidgetVisible = opts?.setWidgetVisible;
return new Promise((_, reject) => {
rejectRun = reject;
});
})
.mockImplementation(() => new Promise(() => {})); // retry run stays pending

const { findByRole, findByLabelText, queryByLabelText } = render(<SignInProtectCheck />, { wrapper });
await waitFor(() => expect(mockExecute).toHaveBeenCalled());

rejectRun!(
new ClerkRuntimeError('Protect check script execution failed', { code: 'protect_check_execution_failed' }),
);
const retryButton = await findByRole('button', { name: /try again/i });
fireEvent.click(retryButton);
await waitFor(() => expect(mockExecute).toHaveBeenCalledTimes(2));
expect(await findByLabelText(/loading/i)).toBeInTheDocument();

// The failed run's script is a zombie (the abort signal is best-effort); a late signal
// from it must not flip visibility under the active run.
await act(async () => {
await staleSetWidgetVisible!(true);
});
expect(queryByLabelText(/loading/i)).toBeInTheDocument();
});

it('clears leftovers from a failed run so the retry starts with the spinner', async () => {
const { wrapper } = await createFixtures(f => {
f.startSignInWithProtectCheck();
});
let container: HTMLDivElement | undefined;
let setWidgetVisible: ((visible: boolean) => Promise<void>) | undefined;
let rejectRun: ((err: Error) => void) | undefined;
mockExecute
.mockImplementationOnce((_protectCheck, el, opts) => {
container = el as HTMLDivElement;
setWidgetVisible = opts?.setWidgetVisible;
return new Promise((_, reject) => {
rejectRun = reject;
});
})
.mockImplementation((_protectCheck, el) => {
container = el as HTMLDivElement;
return new Promise(() => {}); // retry run stays pending
});

const { findByRole, findByLabelText, queryByLabelText } = render(<SignInProtectCheck />, { wrapper });
await waitFor(() => expect(mockExecute).toHaveBeenCalled());

// A widget shows, then the run fails (e.g. turnstile error-callback).
container!.appendChild(document.createElement('div'));
await act(async () => {
await setWidgetVisible!(true);
});
expect(queryByLabelText(/loading/i)).not.toBeInTheDocument();
rejectRun!(
new ClerkRuntimeError('Protect check script execution failed', { code: 'protect_check_execution_failed' }),
);

const retryButton = await findByRole('button', { name: /try again/i });
fireEvent.click(retryButton);

// The new run owns the container: stale widget removed, spinner back — with no
// counter-signal from the dead script.
await waitFor(() => expect(mockExecute).toHaveBeenCalledTimes(2));
expect(container!.childNodes.length).toBe(0);
expect(await findByLabelText(/loading/i)).toBeInTheDocument();
});
});

it('shows a retry control after a failure and re-runs the challenge when clicked', async () => {
const { wrapper, fixtures } = await createFixtures(f => {
f.startSignInWithProtectCheck();
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
Merged
6 changes: 6 additions & 0 deletions .changeset/protect-check-spinner-widget-visibility.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/shared': patch
'@clerk/ui': patch
---

Polish the Protect check card: the loading spinner now hides while a challenge widget (e.g. Turnstile) is visible instead of spinning alongside it, only appears after a short delay so near-instant checks never flash it, and the card no longer reserves empty space above the spinner before a widget has rendered.
Original file line numberDiff line numberDiff line change
Expand Up@@ -63,26 +63,30 @@ describe('executeProtectCheck', () => {
expect(result).toBe('proof-token-123');
});

it('passes only the spec-defined fields (token, uiHints, signal) — NOT the full resource', async () => {
it('passes only the spec-defined fields (token, uiHints, signal, setWidgetVisible) — NOT the full resource', async () => {
const fn = vi.fn().mockResolvedValue('proof');
vi.doMock('https://protect.example.com/sdk-args.js', () => ({ default: fn }));

const container = fakeContainer();
const controller = new AbortController();
// The visibility handshake: the script calls this before revealing UI so the host can
// drop its own spinner first; the promise resolves once the host has applied the change.
const setWidgetVisible = vi.fn().mockResolvedValue(undefined);
await executeProtectCheck(
protectCheck({
sdkUrl: 'https://protect.example.com/sdk-args.js',
token: 'opaque-challenge-token',
uiHints: { reason: 'device_new' },
}),
container,
{ signal: controller.signal },
{ signal: controller.signal, setWidgetVisible },
);

expect(fn).toHaveBeenCalledWith(container, {
token: 'opaque-challenge-token',
uiHints: { reason: 'device_new' },
signal: controller.signal,
setWidgetVisible,
});
});
});
Expand Down
15 changes: 13 additions & 2 deletions packages/shared/src/internal/clerk-js/protectCheck.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,16 @@ import { ClerkRuntimeError } from '../../error';
import type { ProtectCheckResource } from '../../types';

export interface ExecuteProtectCheckOptions {
/**
* Host-provided visibility handshake, forwarded to the script verbatim as
* `setWidgetVisible` in the init payload. The script calls it right before revealing UI in
* the container (and with `false` once its widget is done); the returned promise resolves
* only after the host has applied the change to the DOM (e.g. removed its own loading
* spinner), so the script can sequence its reveal without a frame of overlap. A script that
* knows its widget is imminent may call it immediately to avoid a spinner flash. Scripts
* must treat the field as optional — older hosts don't provide it.
*/
setWidgetVisible?: (visible: boolean) => Promise<void>;
/**
* Signals that the caller no longer needs the proof token (component unmounted, user
* navigated away, etc.). When the signal aborts:
Expand All@@ -22,6 +32,7 @@ interface ScriptInitOptions {
token: string;
uiHints?: Record<string, string>;
signal?: AbortSignal;
setWidgetVisible?: (visible: boolean) => Promise<void>;
}

type ScriptDefault = (container: HTMLDivElement, init: ScriptInitOptions) => Promise<string>;
Expand DownExpand Up@@ -88,7 +99,7 @@ export async function executeProtectCheck(
container: HTMLDivElement,
options: ExecuteProtectCheckOptions = {},
): Promise<string> {
const { signal } = options;
const { signal, setWidgetVisible } = options;
const { sdkUrl, token, uiHints } = protectCheck;

const validated = assertValidSdkUrl(sdkUrl);
Expand DownExpand Up@@ -123,7 +134,7 @@ export async function executeProtectCheck(

let proofToken: string;
try {
proofToken = await (mod.default as ScriptDefault)(container, { token, uiHints, signal });
proofToken = await (mod.default as ScriptDefault)(container, { token, uiHints, signal, setWidgetVisible });
} catch (err) {
// Distinguish abort-induced rejections from genuine script errors: only relabel as
// `protect_check_aborted` when the error looks like an abort (`AbortError`), otherwise
Expand Down
25 changes: 15 additions & 10 deletions packages/ui/src/components/SignIn/SignInProtectCheck.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ import {
Spinner,
useLocalizations,
} from '../../customizables';
import { useSpinDelay } from '../../hooks';
import { useProtectCheckRunner } from '../../hooks/useProtectCheckRunner';
import { useRouter } from '../../router';

Expand DownExpand Up@@ -63,7 +64,7 @@ function SignInProtectCheckInternal(): JSX.Element {
const { setActive } = useClerk();
const { afterSignInUrl, navigateOnSetActive } = useSignInContext();

const { containerRef, isRunning, hasError, retry } = useProtectCheckRunner<SignInResource>({
const { containerRef, isRunning, isWidgetVisible, hasError, retry } = useProtectCheckRunner<SignInResource>({
getProtectCheck: () => signIn.protectCheck,
getResource: () => signIn,
reload: () => signIn.reload(),
Expand All@@ -88,6 +89,13 @@ function SignInProtectCheckInternal(): JSX.Element {
},
});

// Debounce the spinner's entrance so a near-instant check (or a script that signals its
// widget immediately) never flashes it — the card header alone carries the first ~300ms.
// The error and widget-visibility gates stay OUTSIDE the delay hook below: its minimum
// visible duration must never outrank the handshake's "spinner is gone when the promise
// resolves" guarantee, nor keep a spinner next to the retry button.
const showSpinner = useSpinDelay(isRunning, { delay: 300 });

return (
<Flow.Part part='protectCheck'>
<Card.Root>
Expand All@@ -105,21 +113,18 @@ function SignInProtectCheckInternal(): JSX.Element {
ref={containerRef}
id='clerk-protect-check'
aria-busy={isRunning}
style={{ display: 'block', alignSelf: 'center', minHeight: '60px' }}
// Out of flow while empty so the collapsed container adds no reserved height or flex-gap
// gutter above the spinner (same idiom as CaptchaElement's `gapless` mode).
style={{ display: 'block', alignSelf: 'center', position: isWidgetVisible ? 'static' : 'absolute' }}
/>
{isRunning && !hasError ? (
<Flex
direction='col'
center
gap={4}
aria-live='polite'
>
{showSpinner && !hasError && !isWidgetVisible ? (
<Flex center>
<Spinner
size='lg'
colorScheme='primary'
elementDescriptor={descriptors.spinner}
aria-label={t(localizationKeys('signIn.protectCheck.loading'))}
/>
<Box>{t(localizationKeys('signIn.protectCheck.loading'))}</Box>
</Flex>
) : null}
{hasError ? (
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { ClerkAPIResponseError, ClerkRuntimeError } from '@clerk/shared/error';
import type { SignInResource } from '@clerk/shared/types';
import { waitFor } from '@testing-library/react';
import { act, waitFor } from '@testing-library/react';
import { beforeEach, describe, expect, it, vi } from 'vitest';

import { bindCreateFixtures } from '@/test/create-fixtures';
Expand DownExpand Up@@ -250,6 +250,197 @@ describe('SignInProtectCheck', () => {
});
});

describe('challenge widget visibility', () => {
// Visibility is driven by the script, not observed from the DOM: executeProtectCheck hands
// the script a `setWidgetVisible` callback in its init payload, and the script calls it
// right before revealing UI in the container (and with `false` once the widget is done).
const renderWithPendingChallenge = async () => {
const { wrapper } = await createFixtures(f => {
f.startSignInWithProtectCheck();
});
let container: HTMLDivElement | undefined;
let setWidgetVisible: ((visible: boolean) => Promise<void>) | undefined;
mockExecute.mockImplementation((_protectCheck, el, opts) => {
container = el as HTMLDivElement;
setWidgetVisible = opts?.setWidgetVisible;
return new Promise(() => {}); // never resolves; the check stays running
});
const utils = render(<SignInProtectCheck />, { wrapper });
await waitFor(() => expect(mockExecute).toHaveBeenCalled());
return { ...utils, container: container!, setWidgetVisible: setWidgetVisible! };
};

it('waits a beat before showing the spinner so near-instant checks never flash it', async () => {
const { queryByLabelText, findByLabelText } = await renderWithPendingChallenge();

// Inside the spin-delay window nothing shows yet (the card header is already
// adequate feedback); the spinner only joins once the wait is genuinely long.
expect(queryByLabelText(/loading/i)).not.toBeInTheDocument();
expect(await findByLabelText(/loading/i)).toBeInTheDocument();
});

it('never shows the spinner for a check that completes before the delay', async () => {
const { wrapper, fixtures } = await createFixtures(f => {
f.startSignInWithProtectCheck();
});
mockExecute.mockResolvedValue('proof-fast');
fixtures.signIn.submitProtectCheck.mockResolvedValue({
status: 'needs_first_factor',
protectCheck: null,
createdSessionId: null,
} as unknown as SignInResource);

const { queryByLabelText } = render(<SignInProtectCheck />, { wrapper });

await waitFor(() => expect(fixtures.router.navigate).toHaveBeenCalledWith('../factor-one'));
expect(queryByLabelText(/loading/i)).not.toBeInTheDocument();
// The delayed timer must not fire the spinner after the run has already ended.
await new Promise(resolve => setTimeout(resolve, 400));
expect(queryByLabelText(/loading/i)).not.toBeInTheDocument();
});

it('drops the spinner immediately on failure, minDuration notwithstanding', async () => {
const { wrapper } = await createFixtures(f => {
f.startSignInWithProtectCheck();
});
let rejectRun: ((err: Error) => void) | undefined;
mockExecute.mockImplementation(
() =>
new Promise((_, reject) => {
rejectRun = reject;
}),
);

const { findByRole, findByLabelText, queryByLabelText } = render(<SignInProtectCheck />, { wrapper });
expect(await findByLabelText(/loading/i)).toBeInTheDocument();

rejectRun!(
new ClerkRuntimeError('Protect check script execution failed', { code: 'protect_check_execution_failed' }),
);

// The retry control and the spinner must not coexist — the error gate outranks
// the spin-delay's minimum-visible duration.
await findByRole('button', { name: /try again/i });
expect(queryByLabelText(/loading/i)).not.toBeInTheDocument();
});

it('hides the spinner while the script signals a visible widget and restores it on the counter-signal', async () => {
const { setWidgetVisible, queryByText, queryByLabelText, findByLabelText } = await renderWithPendingChallenge();

// Invisible phase (SDK loading / executing): the spinner is the progress indicator.
expect(await findByLabelText(/loading/i)).toBeInTheDocument();
// The label lives on the spinner itself — no visible "Loading" text (design-system
// consistency; see the dogfooding thread).
expect(queryByText(/loading/i)).not.toBeInTheDocument();

// The script announces its widget. By the time the promise resolves, the spinner must
// ALREADY be out of the DOM — that's the contract that lets the script reveal its UI
// without a frame of overlap.
let spinnerGoneAtResolve = false;
await act(async () => {
await setWidgetVisible(true);
spinnerGoneAtResolve = queryByLabelText(/loading/i) === null;
});
expect(spinnerGoneAtResolve).toBe(true);

// Widget done (e.g. solved, proof verification in flight): spinner takes back over.
await act(async () => {
await setWidgetVisible(false);
});
expect(await findByLabelText(/loading/i)).toBeInTheDocument();
});

it('keeps the empty challenge container out of the layout until the script signals visibility', async () => {
const { container, setWidgetVisible } = await renderWithPendingChallenge();

// No reserved height and no flex-gap slot while there is nothing to show.
expect(container.style.minHeight).toBe('');
expect(container.style.position).toBe('absolute');

await act(async () => {
await setWidgetVisible(true);
});
expect(container.style.position).toBe('static');
});

it('ignores visibility signals from an abandoned run', async () => {
const { wrapper } = await createFixtures(f => {
f.startSignInWithProtectCheck();
});
let staleSetWidgetVisible: ((visible: boolean) => Promise<void>) | undefined;
let rejectRun: ((err: Error) => void) | undefined;
mockExecute
.mockImplementationOnce((_protectCheck, _el, opts) => {
staleSetWidgetVisible = opts?.setWidgetVisible;
return new Promise((_, reject) => {
rejectRun = reject;
});
})
.mockImplementation(() => new Promise(() => {})); // retry run stays pending

const { findByRole, findByLabelText, queryByLabelText } = render(<SignInProtectCheck />, { wrapper });
await waitFor(() => expect(mockExecute).toHaveBeenCalled());

rejectRun!(
new ClerkRuntimeError('Protect check script execution failed', { code: 'protect_check_execution_failed' }),
);
const retryButton = await findByRole('button', { name: /try again/i });
fireEvent.click(retryButton);
await waitFor(() => expect(mockExecute).toHaveBeenCalledTimes(2));
expect(await findByLabelText(/loading/i)).toBeInTheDocument();

// The failed run's script is a zombie (the abort signal is best-effort); a late signal
// from it must not flip visibility under the active run.
await act(async () => {
await staleSetWidgetVisible!(true);
});
expect(queryByLabelText(/loading/i)).toBeInTheDocument();
});

it('clears leftovers from a failed run so the retry starts with the spinner', async () => {
const { wrapper } = await createFixtures(f => {
f.startSignInWithProtectCheck();
});
let container: HTMLDivElement | undefined;
let setWidgetVisible: ((visible: boolean) => Promise<void>) | undefined;
let rejectRun: ((err: Error) => void) | undefined;
mockExecute
.mockImplementationOnce((_protectCheck, el, opts) => {
container = el as HTMLDivElement;
setWidgetVisible = opts?.setWidgetVisible;
return new Promise((_, reject) => {
rejectRun = reject;
});
})
.mockImplementation((_protectCheck, el) => {
container = el as HTMLDivElement;
return new Promise(() => {}); // retry run stays pending
});

const { findByRole, findByLabelText, queryByLabelText } = render(<SignInProtectCheck />, { wrapper });
await waitFor(() => expect(mockExecute).toHaveBeenCalled());

// A widget shows, then the run fails (e.g. turnstile error-callback).
container!.appendChild(document.createElement('div'));
await act(async () => {
await setWidgetVisible!(true);
});
expect(queryByLabelText(/loading/i)).not.toBeInTheDocument();
rejectRun!(
new ClerkRuntimeError('Protect check script execution failed', { code: 'protect_check_execution_failed' }),
);

const retryButton = await findByRole('button', { name: /try again/i });
fireEvent.click(retryButton);

// The new run owns the container: stale widget removed, spinner back — with no
// counter-signal from the dead script.
await waitFor(() => expect(mockExecute).toHaveBeenCalledTimes(2));
expect(container!.childNodes.length).toBe(0);
expect(await findByLabelText(/loading/i)).toBeInTheDocument();
});
});

it('shows a retry control after a failure and re-runs the challenge when clicked', async () => {
const { wrapper, fixtures } = await createFixtures(f => {
f.startSignInWithProtectCheck();
Expand Down
Loading
Loading