Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/calm-codes-share.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/clerk-js": patch
---

Prevent overlapping verification preparations from triggering duplicate verification sends during sign-in, sign-up, and when verifying an email address, phone number, or web3 wallet from the user profile.
43 changes: 40 additions & 3 deletions packages/clerk-js/src/core/resources/Base.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,8 +25,18 @@ export type BaseFetchOptions = ClerkResourceReloadParams & {
export type BaseMutateParams = {
action?: string;
body?: any;
coalesce?: boolean;
method?: HTTPMethod;
path?: string;
signal?: AbortSignal;
};

const COALESCED_POST_TTL_MS = 30_000;

type PendingCoalescedPost<T> = {
promise: Promise<T>;
controller: AbortController;
expiresAt: number;
};

function assertProductionKeysOnDev(statusCode: number, payloadErrors?: ClerkAPIErrorJSON[]) {
Expand DownExpand Up@@ -58,6 +68,8 @@ export abstract class BaseResource {
id?: string;
pathRoot = '';

#pendingCoalescedPosts?: Map<string, PendingCoalescedPost<this>>;

static get fapiClient(): FapiClient {
return BaseResource.clerk.getFapiClient();
}
Expand DownExpand Up@@ -217,9 +229,9 @@ export abstract class BaseResource {
}

protected async _baseMutate<J extends ClerkResourceJSON | null>(params: BaseMutateParams): Promise<this> {
const { action, body, method, path } = params;
const { action, body, method, path, signal } = params;
// TODO @userland-errors:
const json = await BaseResource._fetch<J>({ method, path: path || this.path(action), body });
const json = await BaseResource._fetch<J>({ method, path: path || this.path(action), body, signal });
return this.fromJSON((json?.response || json) as J);
}

Expand All@@ -230,7 +242,32 @@ export abstract class BaseResource {
}

protected async _basePost<J extends ClerkResourceJSON | null>(params: BaseMutateParams = {}): Promise<this> {
return this._baseMutate<J>({ ...params, method: 'POST' });
if (!params.coalesce) {
return this._baseMutate<J>({ ...params, method: 'POST' });
}

const key = this.#coalescedPostKey(params);
const posts = (this.#pendingCoalescedPosts ??= new Map());
const pending = posts.get(key);
if (pending && Date.now() < pending.expiresAt) {
return pending.promise;
}

const controller = new AbortController();
const promise = this._baseMutate<J>({ ...params, method: 'POST', signal: controller.signal }).finally(() => {
if (posts.get(key)?.promise === promise) {
posts.delete(key);
}
});
posts.set(key, { promise, controller, expiresAt: Date.now() + COALESCED_POST_TTL_MS });
return promise;
}

#coalescedPostKey(params: BaseMutateParams): string {
const body = Object.entries(params.body ?? {})
.filter(([, value]) => value !== undefined)
.sort(([left], [right]) => (left < right ? -1 : 1));
return JSON.stringify([this.id, params.path, params.action, body]);
Comment thread
coderabbitai[bot] marked this conversation as resolved.
}

protected async _basePostBypass<J extends ClerkResourceJSON>(params: BaseMutateParams = {}): Promise<this> {
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/src/core/resources/EmailAddress.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,7 @@ export class EmailAddress extends BaseResource implements EmailAddressResource {
prepareVerification = (params: PrepareEmailAddressVerificationParams): Promise<this> => {
return this._basePost<EmailAddressJSON>({
action: 'prepare_verification',
coalesce: true,
body: { ...params },
});
};
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/src/core/resources/PhoneNumber.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,7 @@ export class PhoneNumber extends BaseResource implements PhoneNumberResource {
prepareVerification = (): Promise<PhoneNumberResource> => {
return this._basePost<PhoneNumberJSON>({
action: 'prepare_verification',
coalesce: true,
body: { strategy: 'phone_code' },
});
};
Expand Down
12 changes: 12 additions & 0 deletions packages/clerk-js/src/core/resources/SignIn.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -265,6 +265,7 @@ export class SignIn extends BaseResource implements SignInResource {
return this._basePost({
body: { ...config, strategy: params.strategy },
action: 'prepare_first_factor',
coalesce: true,
});
};

Expand DownExpand Up@@ -356,6 +357,7 @@ export class SignIn extends BaseResource implements SignInResource {
return this._basePost({
body: params,
action: 'prepare_second_factor',
coalesce: true,
});
};

Expand DownExpand Up@@ -883,6 +885,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { emailAddressId, strategy: 'reset_password_email_code' },
action: 'prepare_first_factor',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -926,6 +929,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { phoneNumberId, strategy: 'reset_password_phone_code' },
action: 'prepare_first_factor',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1083,6 +1087,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { emailAddressId: emailCodeFactor.emailAddressId, strategy: 'email_code' },
action: 'prepare_first_factor',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1135,6 +1140,7 @@ class SignInFuture implements SignInFutureResource {
strategy: 'email_link',
},
action: 'prepare_first_factor',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1187,6 +1193,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { phoneNumberId: phoneCodeFactor.phoneNumberId, strategy: 'phone_code', channel },
action: 'prepare_first_factor',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1252,6 +1259,7 @@ class SignInFuture implements SignInFutureResource {
strategy: 'enterprise_sso',
},
action: 'prepare_first_factor',
coalesce: true,
});
}

Expand DownExpand Up@@ -1319,6 +1327,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { web3WalletId: web3FirstFactor.web3WalletId, strategy },
action: 'prepare_first_factor',
coalesce: true,
});

const { message } = this.firstFactorVerification;
Expand DownExpand Up@@ -1390,6 +1399,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { strategy: 'passkey' },
action: 'prepare_first_factor',
coalesce: true,
});
}

Expand DownExpand Up@@ -1442,6 +1452,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { phoneNumberId, strategy: 'phone_code' },
action: 'prepare_second_factor',
coalesce: true,
});
});
}
Expand All@@ -1468,6 +1479,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { emailAddressId, strategy: 'email_code' },
action: 'prepare_second_factor',
coalesce: true,
});
});
}
Expand Down
5 changes: 5 additions & 0 deletions packages/clerk-js/src/core/resources/SignUp.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -188,6 +188,7 @@ export class SignUp extends BaseResource implements SignUpResource {
return this._basePost({
body: params,
action: 'prepare_verification',
coalesce: true,
});
};

Expand DownExpand Up@@ -973,6 +974,7 @@ class SignUpFuture implements SignUpFutureResource {
await this.#resource.__internal_basePost({
body: { strategy: 'email_code' },
action: 'prepare_verification',
coalesce: true,
});
});
}
Expand All@@ -993,6 +995,7 @@ class SignUpFuture implements SignUpFutureResource {
await this.#resource.__internal_basePost({
body: { strategy: 'phone_code', channel },
action: 'prepare_verification',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1020,6 +1023,7 @@ class SignUpFuture implements SignUpFutureResource {
await this.#resource.__internal_basePost({
body: { strategy: 'email_link', redirectUrl: absoluteVerificationUrl },
action: 'prepare_verification',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1163,6 +1167,7 @@ class SignUpFuture implements SignUpFutureResource {
await this.#resource.__internal_basePost({
body: { strategy },
action: 'prepare_verification',
coalesce: true,
});

const { message } = this.#resource.verifications.web3Wallet;
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/src/core/resources/Web3Wallet.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,7 @@ export class Web3Wallet extends BaseResource implements Web3WalletResource {
prepareVerification = (params: PrepareWeb3WalletVerificationParams): Promise<this> => {
return this._basePost<Web3WalletJSON>({
action: 'prepare_verification',
coalesce: true,
body: { ...params },
});
};
Expand Down
123 changes: 123 additions & 0 deletions packages/clerk-js/src/core/resources/__tests__/EmailAddress.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
import type { EmailAddressJSON } from '@clerk/shared/types';
import { createDeferredPromise } from '@clerk/shared/utils';
import { afterEach, describe, expect, it, vi } from 'vitest';

import { BaseResource, EmailAddress } from '../internal';

describe('EmailAddress', () => {
describe('prepareVerification', () => {
afterEach(() => {
vi.clearAllMocks();
});

it('coalesces concurrent identical preparations', async () => {
const deferred = createDeferredPromise<any>();
const mockFetch = vi.fn().mockReturnValue(deferred.promise);
// @ts-ignore
BaseResource._fetch = mockFetch;

const emailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const params = { strategy: 'email_code' as const };

const first = emailAddress.prepareVerification(params);
const second = emailAddress.prepareVerification(params);

expect(mockFetch).toHaveBeenCalledTimes(1);

deferred.resolve({
response: { id: 'email_123' },
});
await Promise.all([first, second]);
});

it('does not coalesce preparations with different strategies or params', async () => {
const mockFetch = vi.fn().mockResolvedValue({
response: { id: 'email_123' },
});
BaseResource._fetch = mockFetch;

const emailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');

await Promise.all([
emailAddress.prepareVerification({ strategy: 'email_code' }),
emailAddress.prepareVerification({ strategy: 'email_link', redirectUrl: '/verify-one' }),
emailAddress.prepareVerification({ strategy: 'email_link', redirectUrl: '/verify-two' }),
]);

expect(mockFetch).toHaveBeenCalledTimes(3);
});

it('starts a new preparation after the previous request succeeds', async () => {
const mockFetch = vi.fn().mockResolvedValue({
response: { id: 'email_123' },
});
// @ts-ignore
BaseResource._fetch = mockFetch;

const emailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const params = { strategy: 'email_code' as const };

await emailAddress.prepareVerification(params);
await emailAddress.prepareVerification(params);

expect(mockFetch).toHaveBeenCalledTimes(2);
});

it('starts a new preparation after the previous request fails', async () => {
const mockFetch = vi
.fn()
.mockRejectedValueOnce(new Error('prepare failed'))
.mockResolvedValueOnce({
response: { id: 'email_123' },
});
BaseResource._fetch = mockFetch;

const emailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const params = { strategy: 'email_code' as const };

await expect(emailAddress.prepareVerification(params)).rejects.toThrow('prepare failed');
await emailAddress.prepareVerification(params);

expect(mockFetch).toHaveBeenCalledTimes(2);
});

it('does not coalesce preparations across EmailAddress instances', async () => {
const deferred = createDeferredPromise<any>();
const mockFetch = vi.fn().mockReturnValue(deferred.promise);
BaseResource._fetch = mockFetch;

const firstEmailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const secondEmailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const params = { strategy: 'email_code' as const };

const first = firstEmailAddress.prepareVerification(params);
const second = secondEmailAddress.prepareVerification(params);

expect(mockFetch).toHaveBeenCalledTimes(2);

deferred.resolve({
response: { id: 'email_123' },
});
await Promise.all([first, second]);
});

it('does not coalesce concurrent verification attempts', async () => {
const deferred = createDeferredPromise<any>();
const mockFetch = vi.fn().mockReturnValue(deferred.promise);
BaseResource._fetch = mockFetch;

const emailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const params = { code: '123456' };

const first = emailAddress.attemptVerification(params);
const second = emailAddress.attemptVerification(params);

expect(mockFetch).toHaveBeenCalledTimes(2);

deferred.resolve({
response: { id: 'email_123' },
});
await Promise.all([first, second]);
});
});
});
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
fix(js): Coalesce concurrent first/second factor preparations by tmilewski · Pull Request #9225 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/calm-codes-share.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/clerk-js": patch
---

Prevent overlapping verification preparations from triggering duplicate verification sends during sign-in, sign-up, and when verifying an email address, phone number, or web3 wallet from the user profile.
43 changes: 40 additions & 3 deletions packages/clerk-js/src/core/resources/Base.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,8 +25,18 @@ export type BaseFetchOptions = ClerkResourceReloadParams & {
export type BaseMutateParams = {
action?: string;
body?: any;
coalesce?: boolean;
method?: HTTPMethod;
path?: string;
signal?: AbortSignal;
};

const COALESCED_POST_TTL_MS = 30_000;

type PendingCoalescedPost<T> = {
promise: Promise<T>;
controller: AbortController;
expiresAt: number;
};

function assertProductionKeysOnDev(statusCode: number, payloadErrors?: ClerkAPIErrorJSON[]) {
Expand DownExpand Up@@ -58,6 +68,8 @@ export abstract class BaseResource {
id?: string;
pathRoot = '';

#pendingCoalescedPosts?: Map<string, PendingCoalescedPost<this>>;

static get fapiClient(): FapiClient {
return BaseResource.clerk.getFapiClient();
}
Expand DownExpand Up@@ -217,9 +229,9 @@ export abstract class BaseResource {
}

protected async _baseMutate<J extends ClerkResourceJSON | null>(params: BaseMutateParams): Promise<this> {
const { action, body, method, path } = params;
const { action, body, method, path, signal } = params;
// TODO @userland-errors:
const json = await BaseResource._fetch<J>({ method, path: path || this.path(action), body });
const json = await BaseResource._fetch<J>({ method, path: path || this.path(action), body, signal });
return this.fromJSON((json?.response || json) as J);
}

Expand All@@ -230,7 +242,32 @@ export abstract class BaseResource {
}

protected async _basePost<J extends ClerkResourceJSON | null>(params: BaseMutateParams = {}): Promise<this> {
return this._baseMutate<J>({ ...params, method: 'POST' });
if (!params.coalesce) {
return this._baseMutate<J>({ ...params, method: 'POST' });
}

const key = this.#coalescedPostKey(params);
const posts = (this.#pendingCoalescedPosts ??= new Map());
const pending = posts.get(key);
if (pending && Date.now() < pending.expiresAt) {
return pending.promise;
}

const controller = new AbortController();
const promise = this._baseMutate<J>({ ...params, method: 'POST', signal: controller.signal }).finally(() => {
if (posts.get(key)?.promise === promise) {
posts.delete(key);
}
});
posts.set(key, { promise, controller, expiresAt: Date.now() + COALESCED_POST_TTL_MS });
return promise;
}

#coalescedPostKey(params: BaseMutateParams): string {
const body = Object.entries(params.body ?? {})
.filter(([, value]) => value !== undefined)
.sort(([left], [right]) => (left < right ? -1 : 1));
return JSON.stringify([this.id, params.path, params.action, body]);
Comment thread
coderabbitai[bot] marked this conversation as resolved.
}

protected async _basePostBypass<J extends ClerkResourceJSON>(params: BaseMutateParams = {}): Promise<this> {
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/src/core/resources/EmailAddress.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,7 @@ export class EmailAddress extends BaseResource implements EmailAddressResource {
prepareVerification = (params: PrepareEmailAddressVerificationParams): Promise<this> => {
return this._basePost<EmailAddressJSON>({
action: 'prepare_verification',
coalesce: true,
body: { ...params },
});
};
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/src/core/resources/PhoneNumber.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,7 @@ export class PhoneNumber extends BaseResource implements PhoneNumberResource {
prepareVerification = (): Promise<PhoneNumberResource> => {
return this._basePost<PhoneNumberJSON>({
action: 'prepare_verification',
coalesce: true,
body: { strategy: 'phone_code' },
});
};
Expand Down
12 changes: 12 additions & 0 deletions packages/clerk-js/src/core/resources/SignIn.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -265,6 +265,7 @@ export class SignIn extends BaseResource implements SignInResource {
return this._basePost({
body: { ...config, strategy: params.strategy },
action: 'prepare_first_factor',
coalesce: true,
});
};

Expand DownExpand Up@@ -356,6 +357,7 @@ export class SignIn extends BaseResource implements SignInResource {
return this._basePost({
body: params,
action: 'prepare_second_factor',
coalesce: true,
});
};

Expand DownExpand Up@@ -883,6 +885,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { emailAddressId, strategy: 'reset_password_email_code' },
action: 'prepare_first_factor',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -926,6 +929,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { phoneNumberId, strategy: 'reset_password_phone_code' },
action: 'prepare_first_factor',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1083,6 +1087,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { emailAddressId: emailCodeFactor.emailAddressId, strategy: 'email_code' },
action: 'prepare_first_factor',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1135,6 +1140,7 @@ class SignInFuture implements SignInFutureResource {
strategy: 'email_link',
},
action: 'prepare_first_factor',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1187,6 +1193,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { phoneNumberId: phoneCodeFactor.phoneNumberId, strategy: 'phone_code', channel },
action: 'prepare_first_factor',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1252,6 +1259,7 @@ class SignInFuture implements SignInFutureResource {
strategy: 'enterprise_sso',
},
action: 'prepare_first_factor',
coalesce: true,
});
}

Expand DownExpand Up@@ -1319,6 +1327,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { web3WalletId: web3FirstFactor.web3WalletId, strategy },
action: 'prepare_first_factor',
coalesce: true,
});

const { message } = this.firstFactorVerification;
Expand DownExpand Up@@ -1390,6 +1399,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { strategy: 'passkey' },
action: 'prepare_first_factor',
coalesce: true,
});
}

Expand DownExpand Up@@ -1442,6 +1452,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { phoneNumberId, strategy: 'phone_code' },
action: 'prepare_second_factor',
coalesce: true,
});
});
}
Expand All@@ -1468,6 +1479,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { emailAddressId, strategy: 'email_code' },
action: 'prepare_second_factor',
coalesce: true,
});
});
}
Expand Down
5 changes: 5 additions & 0 deletions packages/clerk-js/src/core/resources/SignUp.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -188,6 +188,7 @@ export class SignUp extends BaseResource implements SignUpResource {
return this._basePost({
body: params,
action: 'prepare_verification',
coalesce: true,
});
};

Expand DownExpand Up@@ -973,6 +974,7 @@ class SignUpFuture implements SignUpFutureResource {
await this.#resource.__internal_basePost({
body: { strategy: 'email_code' },
action: 'prepare_verification',
coalesce: true,
});
});
}
Expand All@@ -993,6 +995,7 @@ class SignUpFuture implements SignUpFutureResource {
await this.#resource.__internal_basePost({
body: { strategy: 'phone_code', channel },
action: 'prepare_verification',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1020,6 +1023,7 @@ class SignUpFuture implements SignUpFutureResource {
await this.#resource.__internal_basePost({
body: { strategy: 'email_link', redirectUrl: absoluteVerificationUrl },
action: 'prepare_verification',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1163,6 +1167,7 @@ class SignUpFuture implements SignUpFutureResource {
await this.#resource.__internal_basePost({
body: { strategy },
action: 'prepare_verification',
coalesce: true,
});

const { message } = this.#resource.verifications.web3Wallet;
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/src/core/resources/Web3Wallet.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,7 @@ export class Web3Wallet extends BaseResource implements Web3WalletResource {
prepareVerification = (params: PrepareWeb3WalletVerificationParams): Promise<this> => {
return this._basePost<Web3WalletJSON>({
action: 'prepare_verification',
coalesce: true,
body: { ...params },
});
};
Expand Down
123 changes: 123 additions & 0 deletions packages/clerk-js/src/core/resources/__tests__/EmailAddress.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
import type { EmailAddressJSON } from '@clerk/shared/types';
import { createDeferredPromise } from '@clerk/shared/utils';
import { afterEach, describe, expect, it, vi } from 'vitest';

import { BaseResource, EmailAddress } from '../internal';

describe('EmailAddress', () => {
describe('prepareVerification', () => {
afterEach(() => {
vi.clearAllMocks();
});

it('coalesces concurrent identical preparations', async () => {
const deferred = createDeferredPromise<any>();
const mockFetch = vi.fn().mockReturnValue(deferred.promise);
// @ts-ignore
BaseResource._fetch = mockFetch;

const emailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const params = { strategy: 'email_code' as const };

const first = emailAddress.prepareVerification(params);
const second = emailAddress.prepareVerification(params);

expect(mockFetch).toHaveBeenCalledTimes(1);

deferred.resolve({
response: { id: 'email_123' },
});
await Promise.all([first, second]);
});

it('does not coalesce preparations with different strategies or params', async () => {
const mockFetch = vi.fn().mockResolvedValue({
response: { id: 'email_123' },
});
BaseResource._fetch = mockFetch;

const emailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');

await Promise.all([
emailAddress.prepareVerification({ strategy: 'email_code' }),
emailAddress.prepareVerification({ strategy: 'email_link', redirectUrl: '/verify-one' }),
emailAddress.prepareVerification({ strategy: 'email_link', redirectUrl: '/verify-two' }),
]);

expect(mockFetch).toHaveBeenCalledTimes(3);
});

it('starts a new preparation after the previous request succeeds', async () => {
const mockFetch = vi.fn().mockResolvedValue({
response: { id: 'email_123' },
});
// @ts-ignore
BaseResource._fetch = mockFetch;

const emailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const params = { strategy: 'email_code' as const };

await emailAddress.prepareVerification(params);
await emailAddress.prepareVerification(params);

expect(mockFetch).toHaveBeenCalledTimes(2);
});

it('starts a new preparation after the previous request fails', async () => {
const mockFetch = vi
.fn()
.mockRejectedValueOnce(new Error('prepare failed'))
.mockResolvedValueOnce({
response: { id: 'email_123' },
});
BaseResource._fetch = mockFetch;

const emailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const params = { strategy: 'email_code' as const };

await expect(emailAddress.prepareVerification(params)).rejects.toThrow('prepare failed');
await emailAddress.prepareVerification(params);

expect(mockFetch).toHaveBeenCalledTimes(2);
});

it('does not coalesce preparations across EmailAddress instances', async () => {
const deferred = createDeferredPromise<any>();
const mockFetch = vi.fn().mockReturnValue(deferred.promise);
BaseResource._fetch = mockFetch;

const firstEmailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const secondEmailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const params = { strategy: 'email_code' as const };

const first = firstEmailAddress.prepareVerification(params);
const second = secondEmailAddress.prepareVerification(params);

expect(mockFetch).toHaveBeenCalledTimes(2);

deferred.resolve({
response: { id: 'email_123' },
});
await Promise.all([first, second]);
});

it('does not coalesce concurrent verification attempts', async () => {
const deferred = createDeferredPromise<any>();
const mockFetch = vi.fn().mockReturnValue(deferred.promise);
BaseResource._fetch = mockFetch;

const emailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const params = { code: '123456' };

const first = emailAddress.attemptVerification(params);
const second = emailAddress.attemptVerification(params);

expect(mockFetch).toHaveBeenCalledTimes(2);

deferred.resolve({
response: { id: 'email_123' },
});
await Promise.all([first, second]);
});
});
});
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' fix(js): Coalesce concurrent first/second factor preparations by tmilewski · Pull Request #9225 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/calm-codes-share.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/clerk-js": patch
---

Prevent overlapping verification preparations from triggering duplicate verification sends during sign-in, sign-up, and when verifying an email address, phone number, or web3 wallet from the user profile.
43 changes: 40 additions & 3 deletions packages/clerk-js/src/core/resources/Base.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,8 +25,18 @@ export type BaseFetchOptions = ClerkResourceReloadParams & {
export type BaseMutateParams = {
action?: string;
body?: any;
coalesce?: boolean;
method?: HTTPMethod;
path?: string;
signal?: AbortSignal;
};

const COALESCED_POST_TTL_MS = 30_000;

type PendingCoalescedPost<T> = {
promise: Promise<T>;
controller: AbortController;
expiresAt: number;
};

function assertProductionKeysOnDev(statusCode: number, payloadErrors?: ClerkAPIErrorJSON[]) {
Expand DownExpand Up@@ -58,6 +68,8 @@ export abstract class BaseResource {
id?: string;
pathRoot = '';

#pendingCoalescedPosts?: Map<string, PendingCoalescedPost<this>>;

static get fapiClient(): FapiClient {
return BaseResource.clerk.getFapiClient();
}
Expand DownExpand Up@@ -217,9 +229,9 @@ export abstract class BaseResource {
}

protected async _baseMutate<J extends ClerkResourceJSON | null>(params: BaseMutateParams): Promise<this> {
const { action, body, method, path } = params;
const { action, body, method, path, signal } = params;
// TODO @userland-errors:
const json = await BaseResource._fetch<J>({ method, path: path || this.path(action), body });
const json = await BaseResource._fetch<J>({ method, path: path || this.path(action), body, signal });
return this.fromJSON((json?.response || json) as J);
}

Expand All@@ -230,7 +242,32 @@ export abstract class BaseResource {
}

protected async _basePost<J extends ClerkResourceJSON | null>(params: BaseMutateParams = {}): Promise<this> {
return this._baseMutate<J>({ ...params, method: 'POST' });
if (!params.coalesce) {
return this._baseMutate<J>({ ...params, method: 'POST' });
}

const key = this.#coalescedPostKey(params);
const posts = (this.#pendingCoalescedPosts ??= new Map());
const pending = posts.get(key);
if (pending && Date.now() < pending.expiresAt) {
return pending.promise;
}

const controller = new AbortController();
const promise = this._baseMutate<J>({ ...params, method: 'POST', signal: controller.signal }).finally(() => {
if (posts.get(key)?.promise === promise) {
posts.delete(key);
}
});
posts.set(key, { promise, controller, expiresAt: Date.now() + COALESCED_POST_TTL_MS });
return promise;
}

#coalescedPostKey(params: BaseMutateParams): string {
const body = Object.entries(params.body ?? {})
.filter(([, value]) => value !== undefined)
.sort(([left], [right]) => (left < right ? -1 : 1));
return JSON.stringify([this.id, params.path, params.action, body]);
Comment thread
coderabbitai[bot] marked this conversation as resolved.
}

protected async _basePostBypass<J extends ClerkResourceJSON>(params: BaseMutateParams = {}): Promise<this> {
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/src/core/resources/EmailAddress.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,7 @@ export class EmailAddress extends BaseResource implements EmailAddressResource {
prepareVerification = (params: PrepareEmailAddressVerificationParams): Promise<this> => {
return this._basePost<EmailAddressJSON>({
action: 'prepare_verification',
coalesce: true,
body: { ...params },
});
};
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/src/core/resources/PhoneNumber.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,7 @@ export class PhoneNumber extends BaseResource implements PhoneNumberResource {
prepareVerification = (): Promise<PhoneNumberResource> => {
return this._basePost<PhoneNumberJSON>({
action: 'prepare_verification',
coalesce: true,
body: { strategy: 'phone_code' },
});
};
Expand Down
12 changes: 12 additions & 0 deletions packages/clerk-js/src/core/resources/SignIn.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -265,6 +265,7 @@ export class SignIn extends BaseResource implements SignInResource {
return this._basePost({
body: { ...config, strategy: params.strategy },
action: 'prepare_first_factor',
coalesce: true,
});
};

Expand DownExpand Up@@ -356,6 +357,7 @@ export class SignIn extends BaseResource implements SignInResource {
return this._basePost({
body: params,
action: 'prepare_second_factor',
coalesce: true,
});
};

Expand DownExpand Up@@ -883,6 +885,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { emailAddressId, strategy: 'reset_password_email_code' },
action: 'prepare_first_factor',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -926,6 +929,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { phoneNumberId, strategy: 'reset_password_phone_code' },
action: 'prepare_first_factor',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1083,6 +1087,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { emailAddressId: emailCodeFactor.emailAddressId, strategy: 'email_code' },
action: 'prepare_first_factor',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1135,6 +1140,7 @@ class SignInFuture implements SignInFutureResource {
strategy: 'email_link',
},
action: 'prepare_first_factor',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1187,6 +1193,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { phoneNumberId: phoneCodeFactor.phoneNumberId, strategy: 'phone_code', channel },
action: 'prepare_first_factor',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1252,6 +1259,7 @@ class SignInFuture implements SignInFutureResource {
strategy: 'enterprise_sso',
},
action: 'prepare_first_factor',
coalesce: true,
});
}

Expand DownExpand Up@@ -1319,6 +1327,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { web3WalletId: web3FirstFactor.web3WalletId, strategy },
action: 'prepare_first_factor',
coalesce: true,
});

const { message } = this.firstFactorVerification;
Expand DownExpand Up@@ -1390,6 +1399,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { strategy: 'passkey' },
action: 'prepare_first_factor',
coalesce: true,
});
}

Expand DownExpand Up@@ -1442,6 +1452,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { phoneNumberId, strategy: 'phone_code' },
action: 'prepare_second_factor',
coalesce: true,
});
});
}
Expand All@@ -1468,6 +1479,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { emailAddressId, strategy: 'email_code' },
action: 'prepare_second_factor',
coalesce: true,
});
});
}
Expand Down
5 changes: 5 additions & 0 deletions packages/clerk-js/src/core/resources/SignUp.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -188,6 +188,7 @@ export class SignUp extends BaseResource implements SignUpResource {
return this._basePost({
body: params,
action: 'prepare_verification',
coalesce: true,
});
};

Expand DownExpand Up@@ -973,6 +974,7 @@ class SignUpFuture implements SignUpFutureResource {
await this.#resource.__internal_basePost({
body: { strategy: 'email_code' },
action: 'prepare_verification',
coalesce: true,
});
});
}
Expand All@@ -993,6 +995,7 @@ class SignUpFuture implements SignUpFutureResource {
await this.#resource.__internal_basePost({
body: { strategy: 'phone_code', channel },
action: 'prepare_verification',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1020,6 +1023,7 @@ class SignUpFuture implements SignUpFutureResource {
await this.#resource.__internal_basePost({
body: { strategy: 'email_link', redirectUrl: absoluteVerificationUrl },
action: 'prepare_verification',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1163,6 +1167,7 @@ class SignUpFuture implements SignUpFutureResource {
await this.#resource.__internal_basePost({
body: { strategy },
action: 'prepare_verification',
coalesce: true,
});

const { message } = this.#resource.verifications.web3Wallet;
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/src/core/resources/Web3Wallet.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,7 @@ export class Web3Wallet extends BaseResource implements Web3WalletResource {
prepareVerification = (params: PrepareWeb3WalletVerificationParams): Promise<this> => {
return this._basePost<Web3WalletJSON>({
action: 'prepare_verification',
coalesce: true,
body: { ...params },
});
};
Expand Down
123 changes: 123 additions & 0 deletions packages/clerk-js/src/core/resources/__tests__/EmailAddress.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
import type { EmailAddressJSON } from '@clerk/shared/types';
import { createDeferredPromise } from '@clerk/shared/utils';
import { afterEach, describe, expect, it, vi } from 'vitest';

import { BaseResource, EmailAddress } from '../internal';

describe('EmailAddress', () => {
describe('prepareVerification', () => {
afterEach(() => {
vi.clearAllMocks();
});

it('coalesces concurrent identical preparations', async () => {
const deferred = createDeferredPromise<any>();
const mockFetch = vi.fn().mockReturnValue(deferred.promise);
// @ts-ignore
BaseResource._fetch = mockFetch;

const emailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const params = { strategy: 'email_code' as const };

const first = emailAddress.prepareVerification(params);
const second = emailAddress.prepareVerification(params);

expect(mockFetch).toHaveBeenCalledTimes(1);

deferred.resolve({
response: { id: 'email_123' },
});
await Promise.all([first, second]);
});

it('does not coalesce preparations with different strategies or params', async () => {
const mockFetch = vi.fn().mockResolvedValue({
response: { id: 'email_123' },
});
BaseResource._fetch = mockFetch;

const emailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');

await Promise.all([
emailAddress.prepareVerification({ strategy: 'email_code' }),
emailAddress.prepareVerification({ strategy: 'email_link', redirectUrl: '/verify-one' }),
emailAddress.prepareVerification({ strategy: 'email_link', redirectUrl: '/verify-two' }),
]);

expect(mockFetch).toHaveBeenCalledTimes(3);
});

it('starts a new preparation after the previous request succeeds', async () => {
const mockFetch = vi.fn().mockResolvedValue({
response: { id: 'email_123' },
});
// @ts-ignore
BaseResource._fetch = mockFetch;

const emailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const params = { strategy: 'email_code' as const };

await emailAddress.prepareVerification(params);
await emailAddress.prepareVerification(params);

expect(mockFetch).toHaveBeenCalledTimes(2);
});

it('starts a new preparation after the previous request fails', async () => {
const mockFetch = vi
.fn()
.mockRejectedValueOnce(new Error('prepare failed'))
.mockResolvedValueOnce({
response: { id: 'email_123' },
});
BaseResource._fetch = mockFetch;

const emailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const params = { strategy: 'email_code' as const };

await expect(emailAddress.prepareVerification(params)).rejects.toThrow('prepare failed');
await emailAddress.prepareVerification(params);

expect(mockFetch).toHaveBeenCalledTimes(2);
});

it('does not coalesce preparations across EmailAddress instances', async () => {
const deferred = createDeferredPromise<any>();
const mockFetch = vi.fn().mockReturnValue(deferred.promise);
BaseResource._fetch = mockFetch;

const firstEmailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const secondEmailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const params = { strategy: 'email_code' as const };

const first = firstEmailAddress.prepareVerification(params);
const second = secondEmailAddress.prepareVerification(params);

expect(mockFetch).toHaveBeenCalledTimes(2);

deferred.resolve({
response: { id: 'email_123' },
});
await Promise.all([first, second]);
});

it('does not coalesce concurrent verification attempts', async () => {
const deferred = createDeferredPromise<any>();
const mockFetch = vi.fn().mockReturnValue(deferred.promise);
BaseResource._fetch = mockFetch;

const emailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const params = { code: '123456' };

const first = emailAddress.attemptVerification(params);
const second = emailAddress.attemptVerification(params);

expect(mockFetch).toHaveBeenCalledTimes(2);

deferred.resolve({
response: { id: 'email_123' },
});
await Promise.all([first, second]);
});
});
});
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' fix(js): Coalesce concurrent first/second factor preparations by tmilewski · Pull Request #9225 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/calm-codes-share.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/clerk-js": patch
---

Prevent overlapping verification preparations from triggering duplicate verification sends during sign-in, sign-up, and when verifying an email address, phone number, or web3 wallet from the user profile.
43 changes: 40 additions & 3 deletions packages/clerk-js/src/core/resources/Base.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,8 +25,18 @@ export type BaseFetchOptions = ClerkResourceReloadParams & {
export type BaseMutateParams = {
action?: string;
body?: any;
coalesce?: boolean;
method?: HTTPMethod;
path?: string;
signal?: AbortSignal;
};

const COALESCED_POST_TTL_MS = 30_000;

type PendingCoalescedPost<T> = {
promise: Promise<T>;
controller: AbortController;
expiresAt: number;
};

function assertProductionKeysOnDev(statusCode: number, payloadErrors?: ClerkAPIErrorJSON[]) {
Expand DownExpand Up@@ -58,6 +68,8 @@ export abstract class BaseResource {
id?: string;
pathRoot = '';

#pendingCoalescedPosts?: Map<string, PendingCoalescedPost<this>>;

static get fapiClient(): FapiClient {
return BaseResource.clerk.getFapiClient();
}
Expand DownExpand Up@@ -217,9 +229,9 @@ export abstract class BaseResource {
}

protected async _baseMutate<J extends ClerkResourceJSON | null>(params: BaseMutateParams): Promise<this> {
const { action, body, method, path } = params;
const { action, body, method, path, signal } = params;
// TODO @userland-errors:
const json = await BaseResource._fetch<J>({ method, path: path || this.path(action), body });
const json = await BaseResource._fetch<J>({ method, path: path || this.path(action), body, signal });
return this.fromJSON((json?.response || json) as J);
}

Expand All@@ -230,7 +242,32 @@ export abstract class BaseResource {
}

protected async _basePost<J extends ClerkResourceJSON | null>(params: BaseMutateParams = {}): Promise<this> {
return this._baseMutate<J>({ ...params, method: 'POST' });
if (!params.coalesce) {
return this._baseMutate<J>({ ...params, method: 'POST' });
}

const key = this.#coalescedPostKey(params);
const posts = (this.#pendingCoalescedPosts ??= new Map());
const pending = posts.get(key);
if (pending && Date.now() < pending.expiresAt) {
return pending.promise;
}

const controller = new AbortController();
const promise = this._baseMutate<J>({ ...params, method: 'POST', signal: controller.signal }).finally(() => {
if (posts.get(key)?.promise === promise) {
posts.delete(key);
}
});
posts.set(key, { promise, controller, expiresAt: Date.now() + COALESCED_POST_TTL_MS });
return promise;
}

#coalescedPostKey(params: BaseMutateParams): string {
const body = Object.entries(params.body ?? {})
.filter(([, value]) => value !== undefined)
.sort(([left], [right]) => (left < right ? -1 : 1));
return JSON.stringify([this.id, params.path, params.action, body]);
Comment thread
coderabbitai[bot] marked this conversation as resolved.
}

protected async _basePostBypass<J extends ClerkResourceJSON>(params: BaseMutateParams = {}): Promise<this> {
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/src/core/resources/EmailAddress.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,7 @@ export class EmailAddress extends BaseResource implements EmailAddressResource {
prepareVerification = (params: PrepareEmailAddressVerificationParams): Promise<this> => {
return this._basePost<EmailAddressJSON>({
action: 'prepare_verification',
coalesce: true,
body: { ...params },
});
};
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/src/core/resources/PhoneNumber.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,7 @@ export class PhoneNumber extends BaseResource implements PhoneNumberResource {
prepareVerification = (): Promise<PhoneNumberResource> => {
return this._basePost<PhoneNumberJSON>({
action: 'prepare_verification',
coalesce: true,
body: { strategy: 'phone_code' },
});
};
Expand Down
12 changes: 12 additions & 0 deletions packages/clerk-js/src/core/resources/SignIn.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -265,6 +265,7 @@ export class SignIn extends BaseResource implements SignInResource {
return this._basePost({
body: { ...config, strategy: params.strategy },
action: 'prepare_first_factor',
coalesce: true,
});
};

Expand DownExpand Up@@ -356,6 +357,7 @@ export class SignIn extends BaseResource implements SignInResource {
return this._basePost({
body: params,
action: 'prepare_second_factor',
coalesce: true,
});
};

Expand DownExpand Up@@ -883,6 +885,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { emailAddressId, strategy: 'reset_password_email_code' },
action: 'prepare_first_factor',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -926,6 +929,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { phoneNumberId, strategy: 'reset_password_phone_code' },
action: 'prepare_first_factor',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1083,6 +1087,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { emailAddressId: emailCodeFactor.emailAddressId, strategy: 'email_code' },
action: 'prepare_first_factor',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1135,6 +1140,7 @@ class SignInFuture implements SignInFutureResource {
strategy: 'email_link',
},
action: 'prepare_first_factor',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1187,6 +1193,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { phoneNumberId: phoneCodeFactor.phoneNumberId, strategy: 'phone_code', channel },
action: 'prepare_first_factor',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1252,6 +1259,7 @@ class SignInFuture implements SignInFutureResource {
strategy: 'enterprise_sso',
},
action: 'prepare_first_factor',
coalesce: true,
});
}

Expand DownExpand Up@@ -1319,6 +1327,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { web3WalletId: web3FirstFactor.web3WalletId, strategy },
action: 'prepare_first_factor',
coalesce: true,
});

const { message } = this.firstFactorVerification;
Expand DownExpand Up@@ -1390,6 +1399,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { strategy: 'passkey' },
action: 'prepare_first_factor',
coalesce: true,
});
}

Expand DownExpand Up@@ -1442,6 +1452,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { phoneNumberId, strategy: 'phone_code' },
action: 'prepare_second_factor',
coalesce: true,
});
});
}
Expand All@@ -1468,6 +1479,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { emailAddressId, strategy: 'email_code' },
action: 'prepare_second_factor',
coalesce: true,
});
});
}
Expand Down
5 changes: 5 additions & 0 deletions packages/clerk-js/src/core/resources/SignUp.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -188,6 +188,7 @@ export class SignUp extends BaseResource implements SignUpResource {
return this._basePost({
body: params,
action: 'prepare_verification',
coalesce: true,
});
};

Expand DownExpand Up@@ -973,6 +974,7 @@ class SignUpFuture implements SignUpFutureResource {
await this.#resource.__internal_basePost({
body: { strategy: 'email_code' },
action: 'prepare_verification',
coalesce: true,
});
});
}
Expand All@@ -993,6 +995,7 @@ class SignUpFuture implements SignUpFutureResource {
await this.#resource.__internal_basePost({
body: { strategy: 'phone_code', channel },
action: 'prepare_verification',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1020,6 +1023,7 @@ class SignUpFuture implements SignUpFutureResource {
await this.#resource.__internal_basePost({
body: { strategy: 'email_link', redirectUrl: absoluteVerificationUrl },
action: 'prepare_verification',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1163,6 +1167,7 @@ class SignUpFuture implements SignUpFutureResource {
await this.#resource.__internal_basePost({
body: { strategy },
action: 'prepare_verification',
coalesce: true,
});

const { message } = this.#resource.verifications.web3Wallet;
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/src/core/resources/Web3Wallet.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,7 @@ export class Web3Wallet extends BaseResource implements Web3WalletResource {
prepareVerification = (params: PrepareWeb3WalletVerificationParams): Promise<this> => {
return this._basePost<Web3WalletJSON>({
action: 'prepare_verification',
coalesce: true,
body: { ...params },
});
};
Expand Down
123 changes: 123 additions & 0 deletions packages/clerk-js/src/core/resources/__tests__/EmailAddress.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
import type { EmailAddressJSON } from '@clerk/shared/types';
import { createDeferredPromise } from '@clerk/shared/utils';
import { afterEach, describe, expect, it, vi } from 'vitest';

import { BaseResource, EmailAddress } from '../internal';

describe('EmailAddress', () => {
describe('prepareVerification', () => {
afterEach(() => {
vi.clearAllMocks();
});

it('coalesces concurrent identical preparations', async () => {
const deferred = createDeferredPromise<any>();
const mockFetch = vi.fn().mockReturnValue(deferred.promise);
// @ts-ignore
BaseResource._fetch = mockFetch;

const emailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const params = { strategy: 'email_code' as const };

const first = emailAddress.prepareVerification(params);
const second = emailAddress.prepareVerification(params);

expect(mockFetch).toHaveBeenCalledTimes(1);

deferred.resolve({
response: { id: 'email_123' },
});
await Promise.all([first, second]);
});

it('does not coalesce preparations with different strategies or params', async () => {
const mockFetch = vi.fn().mockResolvedValue({
response: { id: 'email_123' },
});
BaseResource._fetch = mockFetch;

const emailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');

await Promise.all([
emailAddress.prepareVerification({ strategy: 'email_code' }),
emailAddress.prepareVerification({ strategy: 'email_link', redirectUrl: '/verify-one' }),
emailAddress.prepareVerification({ strategy: 'email_link', redirectUrl: '/verify-two' }),
]);

expect(mockFetch).toHaveBeenCalledTimes(3);
});

it('starts a new preparation after the previous request succeeds', async () => {
const mockFetch = vi.fn().mockResolvedValue({
response: { id: 'email_123' },
});
// @ts-ignore
BaseResource._fetch = mockFetch;

const emailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const params = { strategy: 'email_code' as const };

await emailAddress.prepareVerification(params);
await emailAddress.prepareVerification(params);

expect(mockFetch).toHaveBeenCalledTimes(2);
});

it('starts a new preparation after the previous request fails', async () => {
const mockFetch = vi
.fn()
.mockRejectedValueOnce(new Error('prepare failed'))
.mockResolvedValueOnce({
response: { id: 'email_123' },
});
BaseResource._fetch = mockFetch;

const emailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const params = { strategy: 'email_code' as const };

await expect(emailAddress.prepareVerification(params)).rejects.toThrow('prepare failed');
await emailAddress.prepareVerification(params);

expect(mockFetch).toHaveBeenCalledTimes(2);
});

it('does not coalesce preparations across EmailAddress instances', async () => {
const deferred = createDeferredPromise<any>();
const mockFetch = vi.fn().mockReturnValue(deferred.promise);
BaseResource._fetch = mockFetch;

const firstEmailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const secondEmailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const params = { strategy: 'email_code' as const };

const first = firstEmailAddress.prepareVerification(params);
const second = secondEmailAddress.prepareVerification(params);

expect(mockFetch).toHaveBeenCalledTimes(2);

deferred.resolve({
response: { id: 'email_123' },
});
await Promise.all([first, second]);
});

it('does not coalesce concurrent verification attempts', async () => {
const deferred = createDeferredPromise<any>();
const mockFetch = vi.fn().mockReturnValue(deferred.promise);
BaseResource._fetch = mockFetch;

const emailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const params = { code: '123456' };

const first = emailAddress.attemptVerification(params);
const second = emailAddress.attemptVerification(params);

expect(mockFetch).toHaveBeenCalledTimes(2);

deferred.resolve({
response: { id: 'email_123' },
});
await Promise.all([first, second]);
});
});
});
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' fix(js): Coalesce concurrent first/second factor preparations by tmilewski · Pull Request #9225 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/calm-codes-share.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/clerk-js": patch
---

Prevent overlapping verification preparations from triggering duplicate verification sends during sign-in, sign-up, and when verifying an email address, phone number, or web3 wallet from the user profile.
43 changes: 40 additions & 3 deletions packages/clerk-js/src/core/resources/Base.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,8 +25,18 @@ export type BaseFetchOptions = ClerkResourceReloadParams & {
export type BaseMutateParams = {
action?: string;
body?: any;
coalesce?: boolean;
method?: HTTPMethod;
path?: string;
signal?: AbortSignal;
};

const COALESCED_POST_TTL_MS = 30_000;

type PendingCoalescedPost<T> = {
promise: Promise<T>;
controller: AbortController;
expiresAt: number;
};

function assertProductionKeysOnDev(statusCode: number, payloadErrors?: ClerkAPIErrorJSON[]) {
Expand DownExpand Up@@ -58,6 +68,8 @@ export abstract class BaseResource {
id?: string;
pathRoot = '';

#pendingCoalescedPosts?: Map<string, PendingCoalescedPost<this>>;

static get fapiClient(): FapiClient {
return BaseResource.clerk.getFapiClient();
}
Expand DownExpand Up@@ -217,9 +229,9 @@ export abstract class BaseResource {
}

protected async _baseMutate<J extends ClerkResourceJSON | null>(params: BaseMutateParams): Promise<this> {
const { action, body, method, path } = params;
const { action, body, method, path, signal } = params;
// TODO @userland-errors:
const json = await BaseResource._fetch<J>({ method, path: path || this.path(action), body });
const json = await BaseResource._fetch<J>({ method, path: path || this.path(action), body, signal });
return this.fromJSON((json?.response || json) as J);
}

Expand All@@ -230,7 +242,32 @@ export abstract class BaseResource {
}

protected async _basePost<J extends ClerkResourceJSON | null>(params: BaseMutateParams = {}): Promise<this> {
return this._baseMutate<J>({ ...params, method: 'POST' });
if (!params.coalesce) {
return this._baseMutate<J>({ ...params, method: 'POST' });
}

const key = this.#coalescedPostKey(params);
const posts = (this.#pendingCoalescedPosts ??= new Map());
const pending = posts.get(key);
if (pending && Date.now() < pending.expiresAt) {
return pending.promise;
}

const controller = new AbortController();
const promise = this._baseMutate<J>({ ...params, method: 'POST', signal: controller.signal }).finally(() => {
if (posts.get(key)?.promise === promise) {
posts.delete(key);
}
});
posts.set(key, { promise, controller, expiresAt: Date.now() + COALESCED_POST_TTL_MS });
return promise;
}

#coalescedPostKey(params: BaseMutateParams): string {
const body = Object.entries(params.body ?? {})
.filter(([, value]) => value !== undefined)
.sort(([left], [right]) => (left < right ? -1 : 1));
return JSON.stringify([this.id, params.path, params.action, body]);
Comment thread
coderabbitai[bot] marked this conversation as resolved.
}

protected async _basePostBypass<J extends ClerkResourceJSON>(params: BaseMutateParams = {}): Promise<this> {
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/src/core/resources/EmailAddress.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,7 @@ export class EmailAddress extends BaseResource implements EmailAddressResource {
prepareVerification = (params: PrepareEmailAddressVerificationParams): Promise<this> => {
return this._basePost<EmailAddressJSON>({
action: 'prepare_verification',
coalesce: true,
body: { ...params },
});
};
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/src/core/resources/PhoneNumber.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,7 @@ export class PhoneNumber extends BaseResource implements PhoneNumberResource {
prepareVerification = (): Promise<PhoneNumberResource> => {
return this._basePost<PhoneNumberJSON>({
action: 'prepare_verification',
coalesce: true,
body: { strategy: 'phone_code' },
});
};
Expand Down
12 changes: 12 additions & 0 deletions packages/clerk-js/src/core/resources/SignIn.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -265,6 +265,7 @@ export class SignIn extends BaseResource implements SignInResource {
return this._basePost({
body: { ...config, strategy: params.strategy },
action: 'prepare_first_factor',
coalesce: true,
});
};

Expand DownExpand Up@@ -356,6 +357,7 @@ export class SignIn extends BaseResource implements SignInResource {
return this._basePost({
body: params,
action: 'prepare_second_factor',
coalesce: true,
});
};

Expand DownExpand Up@@ -883,6 +885,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { emailAddressId, strategy: 'reset_password_email_code' },
action: 'prepare_first_factor',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -926,6 +929,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { phoneNumberId, strategy: 'reset_password_phone_code' },
action: 'prepare_first_factor',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1083,6 +1087,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { emailAddressId: emailCodeFactor.emailAddressId, strategy: 'email_code' },
action: 'prepare_first_factor',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1135,6 +1140,7 @@ class SignInFuture implements SignInFutureResource {
strategy: 'email_link',
},
action: 'prepare_first_factor',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1187,6 +1193,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { phoneNumberId: phoneCodeFactor.phoneNumberId, strategy: 'phone_code', channel },
action: 'prepare_first_factor',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1252,6 +1259,7 @@ class SignInFuture implements SignInFutureResource {
strategy: 'enterprise_sso',
},
action: 'prepare_first_factor',
coalesce: true,
});
}

Expand DownExpand Up@@ -1319,6 +1327,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { web3WalletId: web3FirstFactor.web3WalletId, strategy },
action: 'prepare_first_factor',
coalesce: true,
});

const { message } = this.firstFactorVerification;
Expand DownExpand Up@@ -1390,6 +1399,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { strategy: 'passkey' },
action: 'prepare_first_factor',
coalesce: true,
});
}

Expand DownExpand Up@@ -1442,6 +1452,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { phoneNumberId, strategy: 'phone_code' },
action: 'prepare_second_factor',
coalesce: true,
});
});
}
Expand All@@ -1468,6 +1479,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { emailAddressId, strategy: 'email_code' },
action: 'prepare_second_factor',
coalesce: true,
});
});
}
Expand Down
5 changes: 5 additions & 0 deletions packages/clerk-js/src/core/resources/SignUp.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -188,6 +188,7 @@ export class SignUp extends BaseResource implements SignUpResource {
return this._basePost({
body: params,
action: 'prepare_verification',
coalesce: true,
});
};

Expand DownExpand Up@@ -973,6 +974,7 @@ class SignUpFuture implements SignUpFutureResource {
await this.#resource.__internal_basePost({
body: { strategy: 'email_code' },
action: 'prepare_verification',
coalesce: true,
});
});
}
Expand All@@ -993,6 +995,7 @@ class SignUpFuture implements SignUpFutureResource {
await this.#resource.__internal_basePost({
body: { strategy: 'phone_code', channel },
action: 'prepare_verification',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1020,6 +1023,7 @@ class SignUpFuture implements SignUpFutureResource {
await this.#resource.__internal_basePost({
body: { strategy: 'email_link', redirectUrl: absoluteVerificationUrl },
action: 'prepare_verification',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1163,6 +1167,7 @@ class SignUpFuture implements SignUpFutureResource {
await this.#resource.__internal_basePost({
body: { strategy },
action: 'prepare_verification',
coalesce: true,
});

const { message } = this.#resource.verifications.web3Wallet;
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/src/core/resources/Web3Wallet.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,7 @@ export class Web3Wallet extends BaseResource implements Web3WalletResource {
prepareVerification = (params: PrepareWeb3WalletVerificationParams): Promise<this> => {
return this._basePost<Web3WalletJSON>({
action: 'prepare_verification',
coalesce: true,
body: { ...params },
});
};
Expand Down
123 changes: 123 additions & 0 deletions packages/clerk-js/src/core/resources/__tests__/EmailAddress.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
import type { EmailAddressJSON } from '@clerk/shared/types';
import { createDeferredPromise } from '@clerk/shared/utils';
import { afterEach, describe, expect, it, vi } from 'vitest';

import { BaseResource, EmailAddress } from '../internal';

describe('EmailAddress', () => {
describe('prepareVerification', () => {
afterEach(() => {
vi.clearAllMocks();
});

it('coalesces concurrent identical preparations', async () => {
const deferred = createDeferredPromise<any>();
const mockFetch = vi.fn().mockReturnValue(deferred.promise);
// @ts-ignore
BaseResource._fetch = mockFetch;

const emailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const params = { strategy: 'email_code' as const };

const first = emailAddress.prepareVerification(params);
const second = emailAddress.prepareVerification(params);

expect(mockFetch).toHaveBeenCalledTimes(1);

deferred.resolve({
response: { id: 'email_123' },
});
await Promise.all([first, second]);
});

it('does not coalesce preparations with different strategies or params', async () => {
const mockFetch = vi.fn().mockResolvedValue({
response: { id: 'email_123' },
});
BaseResource._fetch = mockFetch;

const emailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');

await Promise.all([
emailAddress.prepareVerification({ strategy: 'email_code' }),
emailAddress.prepareVerification({ strategy: 'email_link', redirectUrl: '/verify-one' }),
emailAddress.prepareVerification({ strategy: 'email_link', redirectUrl: '/verify-two' }),
]);

expect(mockFetch).toHaveBeenCalledTimes(3);
});

it('starts a new preparation after the previous request succeeds', async () => {
const mockFetch = vi.fn().mockResolvedValue({
response: { id: 'email_123' },
});
// @ts-ignore
BaseResource._fetch = mockFetch;

const emailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const params = { strategy: 'email_code' as const };

await emailAddress.prepareVerification(params);
await emailAddress.prepareVerification(params);

expect(mockFetch).toHaveBeenCalledTimes(2);
});

it('starts a new preparation after the previous request fails', async () => {
const mockFetch = vi
.fn()
.mockRejectedValueOnce(new Error('prepare failed'))
.mockResolvedValueOnce({
response: { id: 'email_123' },
});
BaseResource._fetch = mockFetch;

const emailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const params = { strategy: 'email_code' as const };

await expect(emailAddress.prepareVerification(params)).rejects.toThrow('prepare failed');
await emailAddress.prepareVerification(params);

expect(mockFetch).toHaveBeenCalledTimes(2);
});

it('does not coalesce preparations across EmailAddress instances', async () => {
const deferred = createDeferredPromise<any>();
const mockFetch = vi.fn().mockReturnValue(deferred.promise);
BaseResource._fetch = mockFetch;

const firstEmailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const secondEmailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const params = { strategy: 'email_code' as const };

const first = firstEmailAddress.prepareVerification(params);
const second = secondEmailAddress.prepareVerification(params);

expect(mockFetch).toHaveBeenCalledTimes(2);

deferred.resolve({
response: { id: 'email_123' },
});
await Promise.all([first, second]);
});

it('does not coalesce concurrent verification attempts', async () => {
const deferred = createDeferredPromise<any>();
const mockFetch = vi.fn().mockReturnValue(deferred.promise);
BaseResource._fetch = mockFetch;

const emailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const params = { code: '123456' };

const first = emailAddress.attemptVerification(params);
const second = emailAddress.attemptVerification(params);

expect(mockFetch).toHaveBeenCalledTimes(2);

deferred.resolve({
response: { id: 'email_123' },
});
await Promise.all([first, second]);
});
});
});
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' fix(js): Coalesce concurrent first/second factor preparations by tmilewski · Pull Request #9225 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/calm-codes-share.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/clerk-js": patch
---

Prevent overlapping verification preparations from triggering duplicate verification sends during sign-in, sign-up, and when verifying an email address, phone number, or web3 wallet from the user profile.
43 changes: 40 additions & 3 deletions packages/clerk-js/src/core/resources/Base.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,8 +25,18 @@ export type BaseFetchOptions = ClerkResourceReloadParams & {
export type BaseMutateParams = {
action?: string;
body?: any;
coalesce?: boolean;
method?: HTTPMethod;
path?: string;
signal?: AbortSignal;
};

const COALESCED_POST_TTL_MS = 30_000;

type PendingCoalescedPost<T> = {
promise: Promise<T>;
controller: AbortController;
expiresAt: number;
};

function assertProductionKeysOnDev(statusCode: number, payloadErrors?: ClerkAPIErrorJSON[]) {
Expand DownExpand Up@@ -58,6 +68,8 @@ export abstract class BaseResource {
id?: string;
pathRoot = '';

#pendingCoalescedPosts?: Map<string, PendingCoalescedPost<this>>;

static get fapiClient(): FapiClient {
return BaseResource.clerk.getFapiClient();
}
Expand DownExpand Up@@ -217,9 +229,9 @@ export abstract class BaseResource {
}

protected async _baseMutate<J extends ClerkResourceJSON | null>(params: BaseMutateParams): Promise<this> {
const { action, body, method, path } = params;
const { action, body, method, path, signal } = params;
// TODO @userland-errors:
const json = await BaseResource._fetch<J>({ method, path: path || this.path(action), body });
const json = await BaseResource._fetch<J>({ method, path: path || this.path(action), body, signal });
return this.fromJSON((json?.response || json) as J);
}

Expand All@@ -230,7 +242,32 @@ export abstract class BaseResource {
}

protected async _basePost<J extends ClerkResourceJSON | null>(params: BaseMutateParams = {}): Promise<this> {
return this._baseMutate<J>({ ...params, method: 'POST' });
if (!params.coalesce) {
return this._baseMutate<J>({ ...params, method: 'POST' });
}

const key = this.#coalescedPostKey(params);
const posts = (this.#pendingCoalescedPosts ??= new Map());
const pending = posts.get(key);
if (pending && Date.now() < pending.expiresAt) {
return pending.promise;
}

const controller = new AbortController();
const promise = this._baseMutate<J>({ ...params, method: 'POST', signal: controller.signal }).finally(() => {
if (posts.get(key)?.promise === promise) {
posts.delete(key);
}
});
posts.set(key, { promise, controller, expiresAt: Date.now() + COALESCED_POST_TTL_MS });
return promise;
}

#coalescedPostKey(params: BaseMutateParams): string {
const body = Object.entries(params.body ?? {})
.filter(([, value]) => value !== undefined)
.sort(([left], [right]) => (left < right ? -1 : 1));
return JSON.stringify([this.id, params.path, params.action, body]);
Comment thread
coderabbitai[bot] marked this conversation as resolved.
}

protected async _basePostBypass<J extends ClerkResourceJSON>(params: BaseMutateParams = {}): Promise<this> {
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/src/core/resources/EmailAddress.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,7 @@ export class EmailAddress extends BaseResource implements EmailAddressResource {
prepareVerification = (params: PrepareEmailAddressVerificationParams): Promise<this> => {
return this._basePost<EmailAddressJSON>({
action: 'prepare_verification',
coalesce: true,
body: { ...params },
});
};
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/src/core/resources/PhoneNumber.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,7 @@ export class PhoneNumber extends BaseResource implements PhoneNumberResource {
prepareVerification = (): Promise<PhoneNumberResource> => {
return this._basePost<PhoneNumberJSON>({
action: 'prepare_verification',
coalesce: true,
body: { strategy: 'phone_code' },
});
};
Expand Down
12 changes: 12 additions & 0 deletions packages/clerk-js/src/core/resources/SignIn.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -265,6 +265,7 @@ export class SignIn extends BaseResource implements SignInResource {
return this._basePost({
body: { ...config, strategy: params.strategy },
action: 'prepare_first_factor',
coalesce: true,
});
};

Expand DownExpand Up@@ -356,6 +357,7 @@ export class SignIn extends BaseResource implements SignInResource {
return this._basePost({
body: params,
action: 'prepare_second_factor',
coalesce: true,
});
};

Expand DownExpand Up@@ -883,6 +885,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { emailAddressId, strategy: 'reset_password_email_code' },
action: 'prepare_first_factor',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -926,6 +929,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { phoneNumberId, strategy: 'reset_password_phone_code' },
action: 'prepare_first_factor',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1083,6 +1087,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { emailAddressId: emailCodeFactor.emailAddressId, strategy: 'email_code' },
action: 'prepare_first_factor',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1135,6 +1140,7 @@ class SignInFuture implements SignInFutureResource {
strategy: 'email_link',
},
action: 'prepare_first_factor',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1187,6 +1193,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { phoneNumberId: phoneCodeFactor.phoneNumberId, strategy: 'phone_code', channel },
action: 'prepare_first_factor',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1252,6 +1259,7 @@ class SignInFuture implements SignInFutureResource {
strategy: 'enterprise_sso',
},
action: 'prepare_first_factor',
coalesce: true,
});
}

Expand DownExpand Up@@ -1319,6 +1327,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { web3WalletId: web3FirstFactor.web3WalletId, strategy },
action: 'prepare_first_factor',
coalesce: true,
});

const { message } = this.firstFactorVerification;
Expand DownExpand Up@@ -1390,6 +1399,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { strategy: 'passkey' },
action: 'prepare_first_factor',
coalesce: true,
});
}

Expand DownExpand Up@@ -1442,6 +1452,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { phoneNumberId, strategy: 'phone_code' },
action: 'prepare_second_factor',
coalesce: true,
});
});
}
Expand All@@ -1468,6 +1479,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { emailAddressId, strategy: 'email_code' },
action: 'prepare_second_factor',
coalesce: true,
});
});
}
Expand Down
5 changes: 5 additions & 0 deletions packages/clerk-js/src/core/resources/SignUp.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -188,6 +188,7 @@ export class SignUp extends BaseResource implements SignUpResource {
return this._basePost({
body: params,
action: 'prepare_verification',
coalesce: true,
});
};

Expand DownExpand Up@@ -973,6 +974,7 @@ class SignUpFuture implements SignUpFutureResource {
await this.#resource.__internal_basePost({
body: { strategy: 'email_code' },
action: 'prepare_verification',
coalesce: true,
});
});
}
Expand All@@ -993,6 +995,7 @@ class SignUpFuture implements SignUpFutureResource {
await this.#resource.__internal_basePost({
body: { strategy: 'phone_code', channel },
action: 'prepare_verification',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1020,6 +1023,7 @@ class SignUpFuture implements SignUpFutureResource {
await this.#resource.__internal_basePost({
body: { strategy: 'email_link', redirectUrl: absoluteVerificationUrl },
action: 'prepare_verification',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1163,6 +1167,7 @@ class SignUpFuture implements SignUpFutureResource {
await this.#resource.__internal_basePost({
body: { strategy },
action: 'prepare_verification',
coalesce: true,
});

const { message } = this.#resource.verifications.web3Wallet;
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/src/core/resources/Web3Wallet.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,7 @@ export class Web3Wallet extends BaseResource implements Web3WalletResource {
prepareVerification = (params: PrepareWeb3WalletVerificationParams): Promise<this> => {
return this._basePost<Web3WalletJSON>({
action: 'prepare_verification',
coalesce: true,
body: { ...params },
});
};
Expand Down
123 changes: 123 additions & 0 deletions packages/clerk-js/src/core/resources/__tests__/EmailAddress.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
import type { EmailAddressJSON } from '@clerk/shared/types';
import { createDeferredPromise } from '@clerk/shared/utils';
import { afterEach, describe, expect, it, vi } from 'vitest';

import { BaseResource, EmailAddress } from '../internal';

describe('EmailAddress', () => {
describe('prepareVerification', () => {
afterEach(() => {
vi.clearAllMocks();
});

it('coalesces concurrent identical preparations', async () => {
const deferred = createDeferredPromise<any>();
const mockFetch = vi.fn().mockReturnValue(deferred.promise);
// @ts-ignore
BaseResource._fetch = mockFetch;

const emailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const params = { strategy: 'email_code' as const };

const first = emailAddress.prepareVerification(params);
const second = emailAddress.prepareVerification(params);

expect(mockFetch).toHaveBeenCalledTimes(1);

deferred.resolve({
response: { id: 'email_123' },
});
await Promise.all([first, second]);
});

it('does not coalesce preparations with different strategies or params', async () => {
const mockFetch = vi.fn().mockResolvedValue({
response: { id: 'email_123' },
});
BaseResource._fetch = mockFetch;

const emailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');

await Promise.all([
emailAddress.prepareVerification({ strategy: 'email_code' }),
emailAddress.prepareVerification({ strategy: 'email_link', redirectUrl: '/verify-one' }),
emailAddress.prepareVerification({ strategy: 'email_link', redirectUrl: '/verify-two' }),
]);

expect(mockFetch).toHaveBeenCalledTimes(3);
});

it('starts a new preparation after the previous request succeeds', async () => {
const mockFetch = vi.fn().mockResolvedValue({
response: { id: 'email_123' },
});
// @ts-ignore
BaseResource._fetch = mockFetch;

const emailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const params = { strategy: 'email_code' as const };

await emailAddress.prepareVerification(params);
await emailAddress.prepareVerification(params);

expect(mockFetch).toHaveBeenCalledTimes(2);
});

it('starts a new preparation after the previous request fails', async () => {
const mockFetch = vi
.fn()
.mockRejectedValueOnce(new Error('prepare failed'))
.mockResolvedValueOnce({
response: { id: 'email_123' },
});
BaseResource._fetch = mockFetch;

const emailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const params = { strategy: 'email_code' as const };

await expect(emailAddress.prepareVerification(params)).rejects.toThrow('prepare failed');
await emailAddress.prepareVerification(params);

expect(mockFetch).toHaveBeenCalledTimes(2);
});

it('does not coalesce preparations across EmailAddress instances', async () => {
const deferred = createDeferredPromise<any>();
const mockFetch = vi.fn().mockReturnValue(deferred.promise);
BaseResource._fetch = mockFetch;

const firstEmailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const secondEmailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const params = { strategy: 'email_code' as const };

const first = firstEmailAddress.prepareVerification(params);
const second = secondEmailAddress.prepareVerification(params);

expect(mockFetch).toHaveBeenCalledTimes(2);

deferred.resolve({
response: { id: 'email_123' },
});
await Promise.all([first, second]);
});

it('does not coalesce concurrent verification attempts', async () => {
const deferred = createDeferredPromise<any>();
const mockFetch = vi.fn().mockReturnValue(deferred.promise);
BaseResource._fetch = mockFetch;

const emailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const params = { code: '123456' };

const first = emailAddress.attemptVerification(params);
const second = emailAddress.attemptVerification(params);

expect(mockFetch).toHaveBeenCalledTimes(2);

deferred.resolve({
response: { id: 'email_123' },
});
await Promise.all([first, second]);
});
});
});
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' fix(js): Coalesce concurrent first/second factor preparations by tmilewski · Pull Request #9225 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/calm-codes-share.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/clerk-js": patch
---

Prevent overlapping verification preparations from triggering duplicate verification sends during sign-in, sign-up, and when verifying an email address, phone number, or web3 wallet from the user profile.
43 changes: 40 additions & 3 deletions packages/clerk-js/src/core/resources/Base.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,8 +25,18 @@ export type BaseFetchOptions = ClerkResourceReloadParams & {
export type BaseMutateParams = {
action?: string;
body?: any;
coalesce?: boolean;
method?: HTTPMethod;
path?: string;
signal?: AbortSignal;
};

const COALESCED_POST_TTL_MS = 30_000;

type PendingCoalescedPost<T> = {
promise: Promise<T>;
controller: AbortController;
expiresAt: number;
};

function assertProductionKeysOnDev(statusCode: number, payloadErrors?: ClerkAPIErrorJSON[]) {
Expand DownExpand Up@@ -58,6 +68,8 @@ export abstract class BaseResource {
id?: string;
pathRoot = '';

#pendingCoalescedPosts?: Map<string, PendingCoalescedPost<this>>;

static get fapiClient(): FapiClient {
return BaseResource.clerk.getFapiClient();
}
Expand DownExpand Up@@ -217,9 +229,9 @@ export abstract class BaseResource {
}

protected async _baseMutate<J extends ClerkResourceJSON | null>(params: BaseMutateParams): Promise<this> {
const { action, body, method, path } = params;
const { action, body, method, path, signal } = params;
// TODO @userland-errors:
const json = await BaseResource._fetch<J>({ method, path: path || this.path(action), body });
const json = await BaseResource._fetch<J>({ method, path: path || this.path(action), body, signal });
return this.fromJSON((json?.response || json) as J);
}

Expand All@@ -230,7 +242,32 @@ export abstract class BaseResource {
}

protected async _basePost<J extends ClerkResourceJSON | null>(params: BaseMutateParams = {}): Promise<this> {
return this._baseMutate<J>({ ...params, method: 'POST' });
if (!params.coalesce) {
return this._baseMutate<J>({ ...params, method: 'POST' });
}

const key = this.#coalescedPostKey(params);
const posts = (this.#pendingCoalescedPosts ??= new Map());
const pending = posts.get(key);
if (pending && Date.now() < pending.expiresAt) {
return pending.promise;
}

const controller = new AbortController();
const promise = this._baseMutate<J>({ ...params, method: 'POST', signal: controller.signal }).finally(() => {
if (posts.get(key)?.promise === promise) {
posts.delete(key);
}
});
posts.set(key, { promise, controller, expiresAt: Date.now() + COALESCED_POST_TTL_MS });
return promise;
}

#coalescedPostKey(params: BaseMutateParams): string {
const body = Object.entries(params.body ?? {})
.filter(([, value]) => value !== undefined)
.sort(([left], [right]) => (left < right ? -1 : 1));
return JSON.stringify([this.id, params.path, params.action, body]);
Comment thread
coderabbitai[bot] marked this conversation as resolved.
}

protected async _basePostBypass<J extends ClerkResourceJSON>(params: BaseMutateParams = {}): Promise<this> {
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/src/core/resources/EmailAddress.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,7 @@ export class EmailAddress extends BaseResource implements EmailAddressResource {
prepareVerification = (params: PrepareEmailAddressVerificationParams): Promise<this> => {
return this._basePost<EmailAddressJSON>({
action: 'prepare_verification',
coalesce: true,
body: { ...params },
});
};
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/src/core/resources/PhoneNumber.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,7 @@ export class PhoneNumber extends BaseResource implements PhoneNumberResource {
prepareVerification = (): Promise<PhoneNumberResource> => {
return this._basePost<PhoneNumberJSON>({
action: 'prepare_verification',
coalesce: true,
body: { strategy: 'phone_code' },
});
};
Expand Down
12 changes: 12 additions & 0 deletions packages/clerk-js/src/core/resources/SignIn.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -265,6 +265,7 @@ export class SignIn extends BaseResource implements SignInResource {
return this._basePost({
body: { ...config, strategy: params.strategy },
action: 'prepare_first_factor',
coalesce: true,
});
};

Expand DownExpand Up@@ -356,6 +357,7 @@ export class SignIn extends BaseResource implements SignInResource {
return this._basePost({
body: params,
action: 'prepare_second_factor',
coalesce: true,
});
};

Expand DownExpand Up@@ -883,6 +885,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { emailAddressId, strategy: 'reset_password_email_code' },
action: 'prepare_first_factor',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -926,6 +929,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { phoneNumberId, strategy: 'reset_password_phone_code' },
action: 'prepare_first_factor',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1083,6 +1087,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { emailAddressId: emailCodeFactor.emailAddressId, strategy: 'email_code' },
action: 'prepare_first_factor',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1135,6 +1140,7 @@ class SignInFuture implements SignInFutureResource {
strategy: 'email_link',
},
action: 'prepare_first_factor',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1187,6 +1193,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { phoneNumberId: phoneCodeFactor.phoneNumberId, strategy: 'phone_code', channel },
action: 'prepare_first_factor',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1252,6 +1259,7 @@ class SignInFuture implements SignInFutureResource {
strategy: 'enterprise_sso',
},
action: 'prepare_first_factor',
coalesce: true,
});
}

Expand DownExpand Up@@ -1319,6 +1327,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { web3WalletId: web3FirstFactor.web3WalletId, strategy },
action: 'prepare_first_factor',
coalesce: true,
});

const { message } = this.firstFactorVerification;
Expand DownExpand Up@@ -1390,6 +1399,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { strategy: 'passkey' },
action: 'prepare_first_factor',
coalesce: true,
});
}

Expand DownExpand Up@@ -1442,6 +1452,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { phoneNumberId, strategy: 'phone_code' },
action: 'prepare_second_factor',
coalesce: true,
});
});
}
Expand All@@ -1468,6 +1479,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { emailAddressId, strategy: 'email_code' },
action: 'prepare_second_factor',
coalesce: true,
});
});
}
Expand Down
5 changes: 5 additions & 0 deletions packages/clerk-js/src/core/resources/SignUp.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -188,6 +188,7 @@ export class SignUp extends BaseResource implements SignUpResource {
return this._basePost({
body: params,
action: 'prepare_verification',
coalesce: true,
});
};

Expand DownExpand Up@@ -973,6 +974,7 @@ class SignUpFuture implements SignUpFutureResource {
await this.#resource.__internal_basePost({
body: { strategy: 'email_code' },
action: 'prepare_verification',
coalesce: true,
});
});
}
Expand All@@ -993,6 +995,7 @@ class SignUpFuture implements SignUpFutureResource {
await this.#resource.__internal_basePost({
body: { strategy: 'phone_code', channel },
action: 'prepare_verification',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1020,6 +1023,7 @@ class SignUpFuture implements SignUpFutureResource {
await this.#resource.__internal_basePost({
body: { strategy: 'email_link', redirectUrl: absoluteVerificationUrl },
action: 'prepare_verification',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1163,6 +1167,7 @@ class SignUpFuture implements SignUpFutureResource {
await this.#resource.__internal_basePost({
body: { strategy },
action: 'prepare_verification',
coalesce: true,
});

const { message } = this.#resource.verifications.web3Wallet;
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/src/core/resources/Web3Wallet.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,7 @@ export class Web3Wallet extends BaseResource implements Web3WalletResource {
prepareVerification = (params: PrepareWeb3WalletVerificationParams): Promise<this> => {
return this._basePost<Web3WalletJSON>({
action: 'prepare_verification',
coalesce: true,
body: { ...params },
});
};
Expand Down
123 changes: 123 additions & 0 deletions packages/clerk-js/src/core/resources/__tests__/EmailAddress.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
import type { EmailAddressJSON } from '@clerk/shared/types';
import { createDeferredPromise } from '@clerk/shared/utils';
import { afterEach, describe, expect, it, vi } from 'vitest';

import { BaseResource, EmailAddress } from '../internal';

describe('EmailAddress', () => {
describe('prepareVerification', () => {
afterEach(() => {
vi.clearAllMocks();
});

it('coalesces concurrent identical preparations', async () => {
const deferred = createDeferredPromise<any>();
const mockFetch = vi.fn().mockReturnValue(deferred.promise);
// @ts-ignore
BaseResource._fetch = mockFetch;

const emailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const params = { strategy: 'email_code' as const };

const first = emailAddress.prepareVerification(params);
const second = emailAddress.prepareVerification(params);

expect(mockFetch).toHaveBeenCalledTimes(1);

deferred.resolve({
response: { id: 'email_123' },
});
await Promise.all([first, second]);
});

it('does not coalesce preparations with different strategies or params', async () => {
const mockFetch = vi.fn().mockResolvedValue({
response: { id: 'email_123' },
});
BaseResource._fetch = mockFetch;

const emailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');

await Promise.all([
emailAddress.prepareVerification({ strategy: 'email_code' }),
emailAddress.prepareVerification({ strategy: 'email_link', redirectUrl: '/verify-one' }),
emailAddress.prepareVerification({ strategy: 'email_link', redirectUrl: '/verify-two' }),
]);

expect(mockFetch).toHaveBeenCalledTimes(3);
});

it('starts a new preparation after the previous request succeeds', async () => {
const mockFetch = vi.fn().mockResolvedValue({
response: { id: 'email_123' },
});
// @ts-ignore
BaseResource._fetch = mockFetch;

const emailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const params = { strategy: 'email_code' as const };

await emailAddress.prepareVerification(params);
await emailAddress.prepareVerification(params);

expect(mockFetch).toHaveBeenCalledTimes(2);
});

it('starts a new preparation after the previous request fails', async () => {
const mockFetch = vi
.fn()
.mockRejectedValueOnce(new Error('prepare failed'))
.mockResolvedValueOnce({
response: { id: 'email_123' },
});
BaseResource._fetch = mockFetch;

const emailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const params = { strategy: 'email_code' as const };

await expect(emailAddress.prepareVerification(params)).rejects.toThrow('prepare failed');
await emailAddress.prepareVerification(params);

expect(mockFetch).toHaveBeenCalledTimes(2);
});

it('does not coalesce preparations across EmailAddress instances', async () => {
const deferred = createDeferredPromise<any>();
const mockFetch = vi.fn().mockReturnValue(deferred.promise);
BaseResource._fetch = mockFetch;

const firstEmailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const secondEmailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const params = { strategy: 'email_code' as const };

const first = firstEmailAddress.prepareVerification(params);
const second = secondEmailAddress.prepareVerification(params);

expect(mockFetch).toHaveBeenCalledTimes(2);

deferred.resolve({
response: { id: 'email_123' },
});
await Promise.all([first, second]);
});

it('does not coalesce concurrent verification attempts', async () => {
const deferred = createDeferredPromise<any>();
const mockFetch = vi.fn().mockReturnValue(deferred.promise);
BaseResource._fetch = mockFetch;

const emailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const params = { code: '123456' };

const first = emailAddress.attemptVerification(params);
const second = emailAddress.attemptVerification(params);

expect(mockFetch).toHaveBeenCalledTimes(2);

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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/calm-codes-share.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/clerk-js": patch
---

Prevent overlapping verification preparations from triggering duplicate verification sends during sign-in, sign-up, and when verifying an email address, phone number, or web3 wallet from the user profile.
43 changes: 40 additions & 3 deletions packages/clerk-js/src/core/resources/Base.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,8 +25,18 @@ export type BaseFetchOptions = ClerkResourceReloadParams & {
export type BaseMutateParams = {
action?: string;
body?: any;
coalesce?: boolean;
method?: HTTPMethod;
path?: string;
signal?: AbortSignal;
};

const COALESCED_POST_TTL_MS = 30_000;

type PendingCoalescedPost<T> = {
promise: Promise<T>;
controller: AbortController;
expiresAt: number;
};

function assertProductionKeysOnDev(statusCode: number, payloadErrors?: ClerkAPIErrorJSON[]) {
Expand DownExpand Up@@ -58,6 +68,8 @@ export abstract class BaseResource {
id?: string;
pathRoot = '';

#pendingCoalescedPosts?: Map<string, PendingCoalescedPost<this>>;

static get fapiClient(): FapiClient {
return BaseResource.clerk.getFapiClient();
}
Expand DownExpand Up@@ -217,9 +229,9 @@ export abstract class BaseResource {
}

protected async _baseMutate<J extends ClerkResourceJSON | null>(params: BaseMutateParams): Promise<this> {
const { action, body, method, path } = params;
const { action, body, method, path, signal } = params;
// TODO @userland-errors:
const json = await BaseResource._fetch<J>({ method, path: path || this.path(action), body });
const json = await BaseResource._fetch<J>({ method, path: path || this.path(action), body, signal });
return this.fromJSON((json?.response || json) as J);
}

Expand All@@ -230,7 +242,32 @@ export abstract class BaseResource {
}

protected async _basePost<J extends ClerkResourceJSON | null>(params: BaseMutateParams = {}): Promise<this> {
return this._baseMutate<J>({ ...params, method: 'POST' });
if (!params.coalesce) {
return this._baseMutate<J>({ ...params, method: 'POST' });
}

const key = this.#coalescedPostKey(params);
const posts = (this.#pendingCoalescedPosts ??= new Map());
const pending = posts.get(key);
if (pending && Date.now() < pending.expiresAt) {
return pending.promise;
}

const controller = new AbortController();
const promise = this._baseMutate<J>({ ...params, method: 'POST', signal: controller.signal }).finally(() => {
if (posts.get(key)?.promise === promise) {
posts.delete(key);
}
});
posts.set(key, { promise, controller, expiresAt: Date.now() + COALESCED_POST_TTL_MS });
return promise;
}

#coalescedPostKey(params: BaseMutateParams): string {
const body = Object.entries(params.body ?? {})
.filter(([, value]) => value !== undefined)
.sort(([left], [right]) => (left < right ? -1 : 1));
return JSON.stringify([this.id, params.path, params.action, body]);
Comment thread
coderabbitai[bot] marked this conversation as resolved.
}

protected async _basePostBypass<J extends ClerkResourceJSON>(params: BaseMutateParams = {}): Promise<this> {
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/src/core/resources/EmailAddress.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,7 @@ export class EmailAddress extends BaseResource implements EmailAddressResource {
prepareVerification = (params: PrepareEmailAddressVerificationParams): Promise<this> => {
return this._basePost<EmailAddressJSON>({
action: 'prepare_verification',
coalesce: true,
body: { ...params },
});
};
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/src/core/resources/PhoneNumber.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,7 @@ export class PhoneNumber extends BaseResource implements PhoneNumberResource {
prepareVerification = (): Promise<PhoneNumberResource> => {
return this._basePost<PhoneNumberJSON>({
action: 'prepare_verification',
coalesce: true,
body: { strategy: 'phone_code' },
});
};
Expand Down
12 changes: 12 additions & 0 deletions packages/clerk-js/src/core/resources/SignIn.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -265,6 +265,7 @@ export class SignIn extends BaseResource implements SignInResource {
return this._basePost({
body: { ...config, strategy: params.strategy },
action: 'prepare_first_factor',
coalesce: true,
});
};

Expand DownExpand Up@@ -356,6 +357,7 @@ export class SignIn extends BaseResource implements SignInResource {
return this._basePost({
body: params,
action: 'prepare_second_factor',
coalesce: true,
});
};

Expand DownExpand Up@@ -883,6 +885,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { emailAddressId, strategy: 'reset_password_email_code' },
action: 'prepare_first_factor',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -926,6 +929,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { phoneNumberId, strategy: 'reset_password_phone_code' },
action: 'prepare_first_factor',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1083,6 +1087,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { emailAddressId: emailCodeFactor.emailAddressId, strategy: 'email_code' },
action: 'prepare_first_factor',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1135,6 +1140,7 @@ class SignInFuture implements SignInFutureResource {
strategy: 'email_link',
},
action: 'prepare_first_factor',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1187,6 +1193,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { phoneNumberId: phoneCodeFactor.phoneNumberId, strategy: 'phone_code', channel },
action: 'prepare_first_factor',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1252,6 +1259,7 @@ class SignInFuture implements SignInFutureResource {
strategy: 'enterprise_sso',
},
action: 'prepare_first_factor',
coalesce: true,
});
}

Expand DownExpand Up@@ -1319,6 +1327,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { web3WalletId: web3FirstFactor.web3WalletId, strategy },
action: 'prepare_first_factor',
coalesce: true,
});

const { message } = this.firstFactorVerification;
Expand DownExpand Up@@ -1390,6 +1399,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { strategy: 'passkey' },
action: 'prepare_first_factor',
coalesce: true,
});
}

Expand DownExpand Up@@ -1442,6 +1452,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { phoneNumberId, strategy: 'phone_code' },
action: 'prepare_second_factor',
coalesce: true,
});
});
}
Expand All@@ -1468,6 +1479,7 @@ class SignInFuture implements SignInFutureResource {
await this.#resource.__internal_basePost({
body: { emailAddressId, strategy: 'email_code' },
action: 'prepare_second_factor',
coalesce: true,
});
});
}
Expand Down
5 changes: 5 additions & 0 deletions packages/clerk-js/src/core/resources/SignUp.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -188,6 +188,7 @@ export class SignUp extends BaseResource implements SignUpResource {
return this._basePost({
body: params,
action: 'prepare_verification',
coalesce: true,
});
};

Expand DownExpand Up@@ -973,6 +974,7 @@ class SignUpFuture implements SignUpFutureResource {
await this.#resource.__internal_basePost({
body: { strategy: 'email_code' },
action: 'prepare_verification',
coalesce: true,
});
});
}
Expand All@@ -993,6 +995,7 @@ class SignUpFuture implements SignUpFutureResource {
await this.#resource.__internal_basePost({
body: { strategy: 'phone_code', channel },
action: 'prepare_verification',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1020,6 +1023,7 @@ class SignUpFuture implements SignUpFutureResource {
await this.#resource.__internal_basePost({
body: { strategy: 'email_link', redirectUrl: absoluteVerificationUrl },
action: 'prepare_verification',
coalesce: true,
});
});
}
Expand DownExpand Up@@ -1163,6 +1167,7 @@ class SignUpFuture implements SignUpFutureResource {
await this.#resource.__internal_basePost({
body: { strategy },
action: 'prepare_verification',
coalesce: true,
});

const { message } = this.#resource.verifications.web3Wallet;
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/src/core/resources/Web3Wallet.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,7 @@ export class Web3Wallet extends BaseResource implements Web3WalletResource {
prepareVerification = (params: PrepareWeb3WalletVerificationParams): Promise<this> => {
return this._basePost<Web3WalletJSON>({
action: 'prepare_verification',
coalesce: true,
body: { ...params },
});
};
Expand Down
123 changes: 123 additions & 0 deletions packages/clerk-js/src/core/resources/__tests__/EmailAddress.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
import type { EmailAddressJSON } from '@clerk/shared/types';
import { createDeferredPromise } from '@clerk/shared/utils';
import { afterEach, describe, expect, it, vi } from 'vitest';

import { BaseResource, EmailAddress } from '../internal';

describe('EmailAddress', () => {
describe('prepareVerification', () => {
afterEach(() => {
vi.clearAllMocks();
});

it('coalesces concurrent identical preparations', async () => {
const deferred = createDeferredPromise<any>();
const mockFetch = vi.fn().mockReturnValue(deferred.promise);
// @ts-ignore
BaseResource._fetch = mockFetch;

const emailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const params = { strategy: 'email_code' as const };

const first = emailAddress.prepareVerification(params);
const second = emailAddress.prepareVerification(params);

expect(mockFetch).toHaveBeenCalledTimes(1);

deferred.resolve({
response: { id: 'email_123' },
});
await Promise.all([first, second]);
});

it('does not coalesce preparations with different strategies or params', async () => {
const mockFetch = vi.fn().mockResolvedValue({
response: { id: 'email_123' },
});
BaseResource._fetch = mockFetch;

const emailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');

await Promise.all([
emailAddress.prepareVerification({ strategy: 'email_code' }),
emailAddress.prepareVerification({ strategy: 'email_link', redirectUrl: '/verify-one' }),
emailAddress.prepareVerification({ strategy: 'email_link', redirectUrl: '/verify-two' }),
]);

expect(mockFetch).toHaveBeenCalledTimes(3);
});

it('starts a new preparation after the previous request succeeds', async () => {
const mockFetch = vi.fn().mockResolvedValue({
response: { id: 'email_123' },
});
// @ts-ignore
BaseResource._fetch = mockFetch;

const emailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const params = { strategy: 'email_code' as const };

await emailAddress.prepareVerification(params);
await emailAddress.prepareVerification(params);

expect(mockFetch).toHaveBeenCalledTimes(2);
});

it('starts a new preparation after the previous request fails', async () => {
const mockFetch = vi
.fn()
.mockRejectedValueOnce(new Error('prepare failed'))
.mockResolvedValueOnce({
response: { id: 'email_123' },
});
BaseResource._fetch = mockFetch;

const emailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const params = { strategy: 'email_code' as const };

await expect(emailAddress.prepareVerification(params)).rejects.toThrow('prepare failed');
await emailAddress.prepareVerification(params);

expect(mockFetch).toHaveBeenCalledTimes(2);
});

it('does not coalesce preparations across EmailAddress instances', async () => {
const deferred = createDeferredPromise<any>();
const mockFetch = vi.fn().mockReturnValue(deferred.promise);
BaseResource._fetch = mockFetch;

const firstEmailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const secondEmailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const params = { strategy: 'email_code' as const };

const first = firstEmailAddress.prepareVerification(params);
const second = secondEmailAddress.prepareVerification(params);

expect(mockFetch).toHaveBeenCalledTimes(2);

deferred.resolve({
response: { id: 'email_123' },
});
await Promise.all([first, second]);
});

it('does not coalesce concurrent verification attempts', async () => {
const deferred = createDeferredPromise<any>();
const mockFetch = vi.fn().mockReturnValue(deferred.promise);
BaseResource._fetch = mockFetch;

const emailAddress = new EmailAddress({ id: 'email_123' } as EmailAddressJSON, '/me/email_addresses');
const params = { code: '123456' };

const first = emailAddress.attemptVerification(params);
const second = emailAddress.attemptVerification(params);

expect(mockFetch).toHaveBeenCalledTimes(2);

deferred.resolve({
response: { id: 'email_123' },
});
await Promise.all([first, second]);
});
});
});
Loading
Loading