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
11 changes: 11 additions & 0 deletions .changeset/safari-itp-sign-out-cookie-refresh.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
---
'@clerk/clerk-js': patch
---

Apply the Safari ITP cookie refresh on sign-out.

Signing out re-issues the client cookie from a fetch, which Safari's ITP caps at 7 days. The client outlives sign-out, and it is what Client Trust uses to recognize a known device, so the cap meant a user who signed out and came back more than a week later was treated as being on a new device and challenged for a second factor.

`signOut()` now routes its redirect through `/v1/client/touch` when the client cookie is close to expiring, the same workaround `setActive()` already applies after sign-in. The redirect is left unchanged when no refresh is needed.

This covers `signOut()` calls that navigate to a redirect URL, including `<UserButton />` and `<SignOutButton />`. Passing your own callback to `signOut(callback)` still navigates on your behalf and is not decorated.
46 changes: 46 additions & 0 deletions packages/clerk-js/src/core/__tests__/clerk.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1169,6 +1169,13 @@ describe('Clerk singleton', () => {
const mockSession1 = { id: '1', remove: vi.fn(), status: 'active', user: {}, getToken: vi.fn() };
const mockSession2 = { id: '2', remove: vi.fn(), status: 'active', user: {}, getToken: vi.fn() };
const mockSession3 = { id: '3', remove: vi.fn(), status: 'pending', user: {}, getToken: vi.fn() };
// Sign-out consults these to decide whether to route the redirect through
// /v1/client/touch. Default to "no refresh needed" so the existing cases
// assert against the plain redirect URL.
const clientTouchDefaults = {
isEligibleForTouch: () => false,
buildTouchUrl: () => 'https://clerk.example.com/v1/client/touch',
};

beforeEach(() => {
mockClientDestroy.mockReset();
Expand DownExpand Up@@ -1198,6 +1205,7 @@ describe('Clerk singleton', () => {
it('signs out all sessions if no sessionId is passed and multiple sessions have authenticated status', async () => {
mockClientFetch.mockReturnValue(
Promise.resolve({
...clientTouchDefaults,
signedInSessions: [mockSession1, mockSession2, mockSession3],
sessions: [mockSession1, mockSession2, mockSession3],
destroy: mockClientDestroy,
Expand All@@ -1221,6 +1229,7 @@ describe('Clerk singleton', () => {
async status => {
mockClientFetch.mockReturnValue(
Promise.resolve({
...clientTouchDefaults,
signedInSessions: [{ ...mockSession1, status }],
sessions: [{ ...mockSession1, status }],
destroy: mockClientDestroy,
Expand All@@ -1244,6 +1253,7 @@ describe('Clerk singleton', () => {
it('only removes the session that corresponds to the passed sessionId if it is not the current', async () => {
mockClientFetch.mockReturnValue(
Promise.resolve({
...clientTouchDefaults,
signedInSessions: [mockSession1, mockSession2, mockSession3],
sessions: [mockSession1, mockSession2, mockSession3],
destroy: mockClientDestroy,
Expand All@@ -1264,6 +1274,7 @@ describe('Clerk singleton', () => {
it('removes and signs out the session that corresponds to the passed sessionId if it is the current', async () => {
mockClientFetch.mockReturnValue(
Promise.resolve({
...clientTouchDefaults,
signedInSessions: [mockSession1, mockSession2, mockSession3],
sessions: [mockSession1, mockSession2, mockSession3],
destroy: mockClientDestroy,
Expand All@@ -1284,6 +1295,7 @@ describe('Clerk singleton', () => {
it('removes and signs out the session and redirects to the provided redirectUrl ', async () => {
mockClientFetch.mockReturnValue(
Promise.resolve({
...clientTouchDefaults,
signedInSessions: [mockSession1, mockSession2, mockSession3],
sessions: [mockSession1, mockSession2, mockSession3],
destroy: mockClientDestroy,
Expand All@@ -1300,6 +1312,40 @@ describe('Clerk singleton', () => {
expect(sut.navigate).toHaveBeenCalledWith('/after-sign-out');
});
});

it('routes the redirect through /v1/client/touch when the client cookie is close to expiring', async () => {
mockClientFetch.mockReturnValue(
Promise.resolve({
signedInSessions: [mockSession1],
sessions: [mockSession1],
destroy: mockClientDestroy,
removeSessions: mockClientRemoveSessions,
isEligibleForTouch: () => true,
// Encodes the nested URL the way the real Client.buildTouchUrl() does, so a
// destination carrying its own query or hash survives the round trip.
buildTouchUrl: ({ redirectUrl }: { redirectUrl: URL }) => {
const touchUrl = new URL('https://clerk.example.com/v1/client/touch');
touchUrl.searchParams.set('redirect_url', redirectUrl.toString());
return touchUrl.toString();
},
}),
);

const sut = new Clerk(productionPublishableKey);
sut.navigate = vi.fn();
await sut.load();
await sut.signOut({ redirectUrl: '/after-sign-out?tab=security#settings' });

await waitFor(() => {
expect(mockClientRemoveSessions).toHaveBeenCalled();
const navigatedTo = new URL((sut.navigate as ReturnType<typeof vi.fn>).mock.calls[0][0]);
expect(navigatedTo.pathname).toEqual('/v1/client/touch');
// The user still lands on the original destination, via the touch redirect.
expect(navigatedTo.searchParams.get('redirect_url')).toEqual(
new URL('/after-sign-out?tab=security#settings', mockWindowLocation.href).toString(),
);
});
});
});

describe('.navigate(to)', () => {
Expand Down
37 changes: 23 additions & 14 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -656,6 +656,25 @@ export class Clerk implements ClerkInterface {
return Boolean(!this.#options.signUpUrl && this.#options.signInUrl && !isAbsoluteUrl(this.#options.signInUrl));
}

/**
* Routes `url` through `/v1/client/touch` when the client cookie is close to expiring,
* and returns it unchanged otherwise.
*
* In practice this only adds a redirect on Safari. A cookie re-issued from a fetch is
* capped at 7 days by ITP; every other browser gets the full 400 days and is never
* eligible. Touch is a top-level navigation, which ITP does not cap, so it restores
* the full lifetime.
*/
#decorateUrlWithTouch(url: string): string {
// In React Native, window exists but window.location does not, so the URL cannot be
// resolved to an absolute one. ITP does not apply there either.
if (!inBrowser() || typeof window.location === 'undefined' || !this.client?.isEligibleForTouch()) {
return url;
}

return this.buildUrlWithAuth(this.client.buildTouchUrl({ redirectUrl: new URL(url, window.location.href) }));
}

public signOut: SignOut = async (callbackOrOptions?: SignOutCallback | SignOutOptions, options?: SignOutOptions) => {
if (!this.client || this.client.sessions.length === 0) {
return;
Expand DownExpand Up@@ -696,7 +715,9 @@ export class Clerk implements ClerkInterface {
if (signOutCallback) {
await signOutCallback();
} else {
await this.navigate(redirectUrl);
// The client outlives sign-out and is what Client Trust uses to recognize a
// returning device, so the re-issued cookie has to keep its full lifetime.
await this.navigate(this.#decorateUrlWithTouch(redirectUrl));
}
});

Expand DownExpand Up@@ -1826,21 +1847,9 @@ export class Clerk implements ClerkInterface {
// Track whether decorateUrl was called for dev-mode warning
let decorateUrlCalled = false;

/**
* Creates a URL that goes through the /v1/client/touch endpoint when Safari ITP fix is needed.
* This allows the session cookie to be refreshed via a full page navigation, bypassing
* Safari's 7-day cap on cookies set via fetch/XHR.
*/
const decorateUrl = (url: string): string => {
decorateUrlCalled = true;

if (!this.client?.isEligibleForTouch()) {
return url;
}

const absoluteUrl = new URL(url, window.location.href);
const touchUrl = this.client.buildTouchUrl({ redirectUrl: absoluteUrl });
return this.buildUrlWithAuth(touchUrl);
return this.#decorateUrlWithTouch(url);
};

await setActiveNavigate({ session: newSession, decorateUrl });
Expand Down
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(clerk-js): apply the Safari ITP cookie refresh on sign-out by dmoerner · Pull Request #9254 · 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
11 changes: 11 additions & 0 deletions .changeset/safari-itp-sign-out-cookie-refresh.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
---
'@clerk/clerk-js': patch
---

Apply the Safari ITP cookie refresh on sign-out.

Signing out re-issues the client cookie from a fetch, which Safari's ITP caps at 7 days. The client outlives sign-out, and it is what Client Trust uses to recognize a known device, so the cap meant a user who signed out and came back more than a week later was treated as being on a new device and challenged for a second factor.

`signOut()` now routes its redirect through `/v1/client/touch` when the client cookie is close to expiring, the same workaround `setActive()` already applies after sign-in. The redirect is left unchanged when no refresh is needed.

This covers `signOut()` calls that navigate to a redirect URL, including `<UserButton />` and `<SignOutButton />`. Passing your own callback to `signOut(callback)` still navigates on your behalf and is not decorated.
46 changes: 46 additions & 0 deletions packages/clerk-js/src/core/__tests__/clerk.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1169,6 +1169,13 @@ describe('Clerk singleton', () => {
const mockSession1 = { id: '1', remove: vi.fn(), status: 'active', user: {}, getToken: vi.fn() };
const mockSession2 = { id: '2', remove: vi.fn(), status: 'active', user: {}, getToken: vi.fn() };
const mockSession3 = { id: '3', remove: vi.fn(), status: 'pending', user: {}, getToken: vi.fn() };
// Sign-out consults these to decide whether to route the redirect through
// /v1/client/touch. Default to "no refresh needed" so the existing cases
// assert against the plain redirect URL.
const clientTouchDefaults = {
isEligibleForTouch: () => false,
buildTouchUrl: () => 'https://clerk.example.com/v1/client/touch',
};

beforeEach(() => {
mockClientDestroy.mockReset();
Expand DownExpand Up@@ -1198,6 +1205,7 @@ describe('Clerk singleton', () => {
it('signs out all sessions if no sessionId is passed and multiple sessions have authenticated status', async () => {
mockClientFetch.mockReturnValue(
Promise.resolve({
...clientTouchDefaults,
signedInSessions: [mockSession1, mockSession2, mockSession3],
sessions: [mockSession1, mockSession2, mockSession3],
destroy: mockClientDestroy,
Expand All@@ -1221,6 +1229,7 @@ describe('Clerk singleton', () => {
async status => {
mockClientFetch.mockReturnValue(
Promise.resolve({
...clientTouchDefaults,
signedInSessions: [{ ...mockSession1, status }],
sessions: [{ ...mockSession1, status }],
destroy: mockClientDestroy,
Expand All@@ -1244,6 +1253,7 @@ describe('Clerk singleton', () => {
it('only removes the session that corresponds to the passed sessionId if it is not the current', async () => {
mockClientFetch.mockReturnValue(
Promise.resolve({
...clientTouchDefaults,
signedInSessions: [mockSession1, mockSession2, mockSession3],
sessions: [mockSession1, mockSession2, mockSession3],
destroy: mockClientDestroy,
Expand All@@ -1264,6 +1274,7 @@ describe('Clerk singleton', () => {
it('removes and signs out the session that corresponds to the passed sessionId if it is the current', async () => {
mockClientFetch.mockReturnValue(
Promise.resolve({
...clientTouchDefaults,
signedInSessions: [mockSession1, mockSession2, mockSession3],
sessions: [mockSession1, mockSession2, mockSession3],
destroy: mockClientDestroy,
Expand All@@ -1284,6 +1295,7 @@ describe('Clerk singleton', () => {
it('removes and signs out the session and redirects to the provided redirectUrl ', async () => {
mockClientFetch.mockReturnValue(
Promise.resolve({
...clientTouchDefaults,
signedInSessions: [mockSession1, mockSession2, mockSession3],
sessions: [mockSession1, mockSession2, mockSession3],
destroy: mockClientDestroy,
Expand All@@ -1300,6 +1312,40 @@ describe('Clerk singleton', () => {
expect(sut.navigate).toHaveBeenCalledWith('/after-sign-out');
});
});

it('routes the redirect through /v1/client/touch when the client cookie is close to expiring', async () => {
mockClientFetch.mockReturnValue(
Promise.resolve({
signedInSessions: [mockSession1],
sessions: [mockSession1],
destroy: mockClientDestroy,
removeSessions: mockClientRemoveSessions,
isEligibleForTouch: () => true,
// Encodes the nested URL the way the real Client.buildTouchUrl() does, so a
// destination carrying its own query or hash survives the round trip.
buildTouchUrl: ({ redirectUrl }: { redirectUrl: URL }) => {
const touchUrl = new URL('https://clerk.example.com/v1/client/touch');
touchUrl.searchParams.set('redirect_url', redirectUrl.toString());
return touchUrl.toString();
},
}),
);

const sut = new Clerk(productionPublishableKey);
sut.navigate = vi.fn();
await sut.load();
await sut.signOut({ redirectUrl: '/after-sign-out?tab=security#settings' });

await waitFor(() => {
expect(mockClientRemoveSessions).toHaveBeenCalled();
const navigatedTo = new URL((sut.navigate as ReturnType<typeof vi.fn>).mock.calls[0][0]);
expect(navigatedTo.pathname).toEqual('/v1/client/touch');
// The user still lands on the original destination, via the touch redirect.
expect(navigatedTo.searchParams.get('redirect_url')).toEqual(
new URL('/after-sign-out?tab=security#settings', mockWindowLocation.href).toString(),
);
});
});
});

describe('.navigate(to)', () => {
Expand Down
37 changes: 23 additions & 14 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -656,6 +656,25 @@ export class Clerk implements ClerkInterface {
return Boolean(!this.#options.signUpUrl && this.#options.signInUrl && !isAbsoluteUrl(this.#options.signInUrl));
}

/**
* Routes `url` through `/v1/client/touch` when the client cookie is close to expiring,
* and returns it unchanged otherwise.
*
* In practice this only adds a redirect on Safari. A cookie re-issued from a fetch is
* capped at 7 days by ITP; every other browser gets the full 400 days and is never
* eligible. Touch is a top-level navigation, which ITP does not cap, so it restores
* the full lifetime.
*/
#decorateUrlWithTouch(url: string): string {
// In React Native, window exists but window.location does not, so the URL cannot be
// resolved to an absolute one. ITP does not apply there either.
if (!inBrowser() || typeof window.location === 'undefined' || !this.client?.isEligibleForTouch()) {
return url;
}

return this.buildUrlWithAuth(this.client.buildTouchUrl({ redirectUrl: new URL(url, window.location.href) }));
}

public signOut: SignOut = async (callbackOrOptions?: SignOutCallback | SignOutOptions, options?: SignOutOptions) => {
if (!this.client || this.client.sessions.length === 0) {
return;
Expand DownExpand Up@@ -696,7 +715,9 @@ export class Clerk implements ClerkInterface {
if (signOutCallback) {
await signOutCallback();
} else {
await this.navigate(redirectUrl);
// The client outlives sign-out and is what Client Trust uses to recognize a
// returning device, so the re-issued cookie has to keep its full lifetime.
await this.navigate(this.#decorateUrlWithTouch(redirectUrl));
}
});

Expand DownExpand Up@@ -1826,21 +1847,9 @@ export class Clerk implements ClerkInterface {
// Track whether decorateUrl was called for dev-mode warning
let decorateUrlCalled = false;

/**
* Creates a URL that goes through the /v1/client/touch endpoint when Safari ITP fix is needed.
* This allows the session cookie to be refreshed via a full page navigation, bypassing
* Safari's 7-day cap on cookies set via fetch/XHR.
*/
const decorateUrl = (url: string): string => {
decorateUrlCalled = true;

if (!this.client?.isEligibleForTouch()) {
return url;
}

const absoluteUrl = new URL(url, window.location.href);
const touchUrl = this.client.buildTouchUrl({ redirectUrl: absoluteUrl });
return this.buildUrlWithAuth(touchUrl);
return this.#decorateUrlWithTouch(url);
};

await setActiveNavigate({ session: newSession, decorateUrl });
Expand Down
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(clerk-js): apply the Safari ITP cookie refresh on sign-out by dmoerner · Pull Request #9254 · 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
11 changes: 11 additions & 0 deletions .changeset/safari-itp-sign-out-cookie-refresh.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
---
'@clerk/clerk-js': patch
---

Apply the Safari ITP cookie refresh on sign-out.

Signing out re-issues the client cookie from a fetch, which Safari's ITP caps at 7 days. The client outlives sign-out, and it is what Client Trust uses to recognize a known device, so the cap meant a user who signed out and came back more than a week later was treated as being on a new device and challenged for a second factor.

`signOut()` now routes its redirect through `/v1/client/touch` when the client cookie is close to expiring, the same workaround `setActive()` already applies after sign-in. The redirect is left unchanged when no refresh is needed.

This covers `signOut()` calls that navigate to a redirect URL, including `<UserButton />` and `<SignOutButton />`. Passing your own callback to `signOut(callback)` still navigates on your behalf and is not decorated.
46 changes: 46 additions & 0 deletions packages/clerk-js/src/core/__tests__/clerk.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1169,6 +1169,13 @@ describe('Clerk singleton', () => {
const mockSession1 = { id: '1', remove: vi.fn(), status: 'active', user: {}, getToken: vi.fn() };
const mockSession2 = { id: '2', remove: vi.fn(), status: 'active', user: {}, getToken: vi.fn() };
const mockSession3 = { id: '3', remove: vi.fn(), status: 'pending', user: {}, getToken: vi.fn() };
// Sign-out consults these to decide whether to route the redirect through
// /v1/client/touch. Default to "no refresh needed" so the existing cases
// assert against the plain redirect URL.
const clientTouchDefaults = {
isEligibleForTouch: () => false,
buildTouchUrl: () => 'https://clerk.example.com/v1/client/touch',
};

beforeEach(() => {
mockClientDestroy.mockReset();
Expand DownExpand Up@@ -1198,6 +1205,7 @@ describe('Clerk singleton', () => {
it('signs out all sessions if no sessionId is passed and multiple sessions have authenticated status', async () => {
mockClientFetch.mockReturnValue(
Promise.resolve({
...clientTouchDefaults,
signedInSessions: [mockSession1, mockSession2, mockSession3],
sessions: [mockSession1, mockSession2, mockSession3],
destroy: mockClientDestroy,
Expand All@@ -1221,6 +1229,7 @@ describe('Clerk singleton', () => {
async status => {
mockClientFetch.mockReturnValue(
Promise.resolve({
...clientTouchDefaults,
signedInSessions: [{ ...mockSession1, status }],
sessions: [{ ...mockSession1, status }],
destroy: mockClientDestroy,
Expand All@@ -1244,6 +1253,7 @@ describe('Clerk singleton', () => {
it('only removes the session that corresponds to the passed sessionId if it is not the current', async () => {
mockClientFetch.mockReturnValue(
Promise.resolve({
...clientTouchDefaults,
signedInSessions: [mockSession1, mockSession2, mockSession3],
sessions: [mockSession1, mockSession2, mockSession3],
destroy: mockClientDestroy,
Expand All@@ -1264,6 +1274,7 @@ describe('Clerk singleton', () => {
it('removes and signs out the session that corresponds to the passed sessionId if it is the current', async () => {
mockClientFetch.mockReturnValue(
Promise.resolve({
...clientTouchDefaults,
signedInSessions: [mockSession1, mockSession2, mockSession3],
sessions: [mockSession1, mockSession2, mockSession3],
destroy: mockClientDestroy,
Expand All@@ -1284,6 +1295,7 @@ describe('Clerk singleton', () => {
it('removes and signs out the session and redirects to the provided redirectUrl ', async () => {
mockClientFetch.mockReturnValue(
Promise.resolve({
...clientTouchDefaults,
signedInSessions: [mockSession1, mockSession2, mockSession3],
sessions: [mockSession1, mockSession2, mockSession3],
destroy: mockClientDestroy,
Expand All@@ -1300,6 +1312,40 @@ describe('Clerk singleton', () => {
expect(sut.navigate).toHaveBeenCalledWith('/after-sign-out');
});
});

it('routes the redirect through /v1/client/touch when the client cookie is close to expiring', async () => {
mockClientFetch.mockReturnValue(
Promise.resolve({
signedInSessions: [mockSession1],
sessions: [mockSession1],
destroy: mockClientDestroy,
removeSessions: mockClientRemoveSessions,
isEligibleForTouch: () => true,
// Encodes the nested URL the way the real Client.buildTouchUrl() does, so a
// destination carrying its own query or hash survives the round trip.
buildTouchUrl: ({ redirectUrl }: { redirectUrl: URL }) => {
const touchUrl = new URL('https://clerk.example.com/v1/client/touch');
touchUrl.searchParams.set('redirect_url', redirectUrl.toString());
return touchUrl.toString();
},
}),
);

const sut = new Clerk(productionPublishableKey);
sut.navigate = vi.fn();
await sut.load();
await sut.signOut({ redirectUrl: '/after-sign-out?tab=security#settings' });

await waitFor(() => {
expect(mockClientRemoveSessions).toHaveBeenCalled();
const navigatedTo = new URL((sut.navigate as ReturnType<typeof vi.fn>).mock.calls[0][0]);
expect(navigatedTo.pathname).toEqual('/v1/client/touch');
// The user still lands on the original destination, via the touch redirect.
expect(navigatedTo.searchParams.get('redirect_url')).toEqual(
new URL('/after-sign-out?tab=security#settings', mockWindowLocation.href).toString(),
);
});
});
});

describe('.navigate(to)', () => {
Expand Down
37 changes: 23 additions & 14 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -656,6 +656,25 @@ export class Clerk implements ClerkInterface {
return Boolean(!this.#options.signUpUrl && this.#options.signInUrl && !isAbsoluteUrl(this.#options.signInUrl));
}

/**
* Routes `url` through `/v1/client/touch` when the client cookie is close to expiring,
* and returns it unchanged otherwise.
*
* In practice this only adds a redirect on Safari. A cookie re-issued from a fetch is
* capped at 7 days by ITP; every other browser gets the full 400 days and is never
* eligible. Touch is a top-level navigation, which ITP does not cap, so it restores
* the full lifetime.
*/
#decorateUrlWithTouch(url: string): string {
// In React Native, window exists but window.location does not, so the URL cannot be
// resolved to an absolute one. ITP does not apply there either.
if (!inBrowser() || typeof window.location === 'undefined' || !this.client?.isEligibleForTouch()) {
return url;
}

return this.buildUrlWithAuth(this.client.buildTouchUrl({ redirectUrl: new URL(url, window.location.href) }));
}

public signOut: SignOut = async (callbackOrOptions?: SignOutCallback | SignOutOptions, options?: SignOutOptions) => {
if (!this.client || this.client.sessions.length === 0) {
return;
Expand DownExpand Up@@ -696,7 +715,9 @@ export class Clerk implements ClerkInterface {
if (signOutCallback) {
await signOutCallback();
} else {
await this.navigate(redirectUrl);
// The client outlives sign-out and is what Client Trust uses to recognize a
// returning device, so the re-issued cookie has to keep its full lifetime.
await this.navigate(this.#decorateUrlWithTouch(redirectUrl));
}
});

Expand DownExpand Up@@ -1826,21 +1847,9 @@ export class Clerk implements ClerkInterface {
// Track whether decorateUrl was called for dev-mode warning
let decorateUrlCalled = false;

/**
* Creates a URL that goes through the /v1/client/touch endpoint when Safari ITP fix is needed.
* This allows the session cookie to be refreshed via a full page navigation, bypassing
* Safari's 7-day cap on cookies set via fetch/XHR.
*/
const decorateUrl = (url: string): string => {
decorateUrlCalled = true;

if (!this.client?.isEligibleForTouch()) {
return url;
}

const absoluteUrl = new URL(url, window.location.href);
const touchUrl = this.client.buildTouchUrl({ redirectUrl: absoluteUrl });
return this.buildUrlWithAuth(touchUrl);
return this.#decorateUrlWithTouch(url);
};

await setActiveNavigate({ session: newSession, decorateUrl });
Expand Down
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(clerk-js): apply the Safari ITP cookie refresh on sign-out by dmoerner · Pull Request #9254 · 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
11 changes: 11 additions & 0 deletions .changeset/safari-itp-sign-out-cookie-refresh.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
---
'@clerk/clerk-js': patch
---

Apply the Safari ITP cookie refresh on sign-out.

Signing out re-issues the client cookie from a fetch, which Safari's ITP caps at 7 days. The client outlives sign-out, and it is what Client Trust uses to recognize a known device, so the cap meant a user who signed out and came back more than a week later was treated as being on a new device and challenged for a second factor.

`signOut()` now routes its redirect through `/v1/client/touch` when the client cookie is close to expiring, the same workaround `setActive()` already applies after sign-in. The redirect is left unchanged when no refresh is needed.

This covers `signOut()` calls that navigate to a redirect URL, including `<UserButton />` and `<SignOutButton />`. Passing your own callback to `signOut(callback)` still navigates on your behalf and is not decorated.
46 changes: 46 additions & 0 deletions packages/clerk-js/src/core/__tests__/clerk.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1169,6 +1169,13 @@ describe('Clerk singleton', () => {
const mockSession1 = { id: '1', remove: vi.fn(), status: 'active', user: {}, getToken: vi.fn() };
const mockSession2 = { id: '2', remove: vi.fn(), status: 'active', user: {}, getToken: vi.fn() };
const mockSession3 = { id: '3', remove: vi.fn(), status: 'pending', user: {}, getToken: vi.fn() };
// Sign-out consults these to decide whether to route the redirect through
// /v1/client/touch. Default to "no refresh needed" so the existing cases
// assert against the plain redirect URL.
const clientTouchDefaults = {
isEligibleForTouch: () => false,
buildTouchUrl: () => 'https://clerk.example.com/v1/client/touch',
};

beforeEach(() => {
mockClientDestroy.mockReset();
Expand DownExpand Up@@ -1198,6 +1205,7 @@ describe('Clerk singleton', () => {
it('signs out all sessions if no sessionId is passed and multiple sessions have authenticated status', async () => {
mockClientFetch.mockReturnValue(
Promise.resolve({
...clientTouchDefaults,
signedInSessions: [mockSession1, mockSession2, mockSession3],
sessions: [mockSession1, mockSession2, mockSession3],
destroy: mockClientDestroy,
Expand All@@ -1221,6 +1229,7 @@ describe('Clerk singleton', () => {
async status => {
mockClientFetch.mockReturnValue(
Promise.resolve({
...clientTouchDefaults,
signedInSessions: [{ ...mockSession1, status }],
sessions: [{ ...mockSession1, status }],
destroy: mockClientDestroy,
Expand All@@ -1244,6 +1253,7 @@ describe('Clerk singleton', () => {
it('only removes the session that corresponds to the passed sessionId if it is not the current', async () => {
mockClientFetch.mockReturnValue(
Promise.resolve({
...clientTouchDefaults,
signedInSessions: [mockSession1, mockSession2, mockSession3],
sessions: [mockSession1, mockSession2, mockSession3],
destroy: mockClientDestroy,
Expand All@@ -1264,6 +1274,7 @@ describe('Clerk singleton', () => {
it('removes and signs out the session that corresponds to the passed sessionId if it is the current', async () => {
mockClientFetch.mockReturnValue(
Promise.resolve({
...clientTouchDefaults,
signedInSessions: [mockSession1, mockSession2, mockSession3],
sessions: [mockSession1, mockSession2, mockSession3],
destroy: mockClientDestroy,
Expand All@@ -1284,6 +1295,7 @@ describe('Clerk singleton', () => {
it('removes and signs out the session and redirects to the provided redirectUrl ', async () => {
mockClientFetch.mockReturnValue(
Promise.resolve({
...clientTouchDefaults,
signedInSessions: [mockSession1, mockSession2, mockSession3],
sessions: [mockSession1, mockSession2, mockSession3],
destroy: mockClientDestroy,
Expand All@@ -1300,6 +1312,40 @@ describe('Clerk singleton', () => {
expect(sut.navigate).toHaveBeenCalledWith('/after-sign-out');
});
});

it('routes the redirect through /v1/client/touch when the client cookie is close to expiring', async () => {
mockClientFetch.mockReturnValue(
Promise.resolve({
signedInSessions: [mockSession1],
sessions: [mockSession1],
destroy: mockClientDestroy,
removeSessions: mockClientRemoveSessions,
isEligibleForTouch: () => true,
// Encodes the nested URL the way the real Client.buildTouchUrl() does, so a
// destination carrying its own query or hash survives the round trip.
buildTouchUrl: ({ redirectUrl }: { redirectUrl: URL }) => {
const touchUrl = new URL('https://clerk.example.com/v1/client/touch');
touchUrl.searchParams.set('redirect_url', redirectUrl.toString());
return touchUrl.toString();
},
}),
);

const sut = new Clerk(productionPublishableKey);
sut.navigate = vi.fn();
await sut.load();
await sut.signOut({ redirectUrl: '/after-sign-out?tab=security#settings' });

await waitFor(() => {
expect(mockClientRemoveSessions).toHaveBeenCalled();
const navigatedTo = new URL((sut.navigate as ReturnType<typeof vi.fn>).mock.calls[0][0]);
expect(navigatedTo.pathname).toEqual('/v1/client/touch');
// The user still lands on the original destination, via the touch redirect.
expect(navigatedTo.searchParams.get('redirect_url')).toEqual(
new URL('/after-sign-out?tab=security#settings', mockWindowLocation.href).toString(),
);
});
});
});

describe('.navigate(to)', () => {
Expand Down
37 changes: 23 additions & 14 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -656,6 +656,25 @@ export class Clerk implements ClerkInterface {
return Boolean(!this.#options.signUpUrl && this.#options.signInUrl && !isAbsoluteUrl(this.#options.signInUrl));
}

/**
* Routes `url` through `/v1/client/touch` when the client cookie is close to expiring,
* and returns it unchanged otherwise.
*
* In practice this only adds a redirect on Safari. A cookie re-issued from a fetch is
* capped at 7 days by ITP; every other browser gets the full 400 days and is never
* eligible. Touch is a top-level navigation, which ITP does not cap, so it restores
* the full lifetime.
*/
#decorateUrlWithTouch(url: string): string {
// In React Native, window exists but window.location does not, so the URL cannot be
// resolved to an absolute one. ITP does not apply there either.
if (!inBrowser() || typeof window.location === 'undefined' || !this.client?.isEligibleForTouch()) {
return url;
}

return this.buildUrlWithAuth(this.client.buildTouchUrl({ redirectUrl: new URL(url, window.location.href) }));
}

public signOut: SignOut = async (callbackOrOptions?: SignOutCallback | SignOutOptions, options?: SignOutOptions) => {
if (!this.client || this.client.sessions.length === 0) {
return;
Expand DownExpand Up@@ -696,7 +715,9 @@ export class Clerk implements ClerkInterface {
if (signOutCallback) {
await signOutCallback();
} else {
await this.navigate(redirectUrl);
// The client outlives sign-out and is what Client Trust uses to recognize a
// returning device, so the re-issued cookie has to keep its full lifetime.
await this.navigate(this.#decorateUrlWithTouch(redirectUrl));
}
});

Expand DownExpand Up@@ -1826,21 +1847,9 @@ export class Clerk implements ClerkInterface {
// Track whether decorateUrl was called for dev-mode warning
let decorateUrlCalled = false;

/**
* Creates a URL that goes through the /v1/client/touch endpoint when Safari ITP fix is needed.
* This allows the session cookie to be refreshed via a full page navigation, bypassing
* Safari's 7-day cap on cookies set via fetch/XHR.
*/
const decorateUrl = (url: string): string => {
decorateUrlCalled = true;

if (!this.client?.isEligibleForTouch()) {
return url;
}

const absoluteUrl = new URL(url, window.location.href);
const touchUrl = this.client.buildTouchUrl({ redirectUrl: absoluteUrl });
return this.buildUrlWithAuth(touchUrl);
return this.#decorateUrlWithTouch(url);
};

await setActiveNavigate({ session: newSession, decorateUrl });
Expand Down
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(clerk-js): apply the Safari ITP cookie refresh on sign-out by dmoerner · Pull Request #9254 · 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
11 changes: 11 additions & 0 deletions .changeset/safari-itp-sign-out-cookie-refresh.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
---
'@clerk/clerk-js': patch
---

Apply the Safari ITP cookie refresh on sign-out.

Signing out re-issues the client cookie from a fetch, which Safari's ITP caps at 7 days. The client outlives sign-out, and it is what Client Trust uses to recognize a known device, so the cap meant a user who signed out and came back more than a week later was treated as being on a new device and challenged for a second factor.

`signOut()` now routes its redirect through `/v1/client/touch` when the client cookie is close to expiring, the same workaround `setActive()` already applies after sign-in. The redirect is left unchanged when no refresh is needed.

This covers `signOut()` calls that navigate to a redirect URL, including `<UserButton />` and `<SignOutButton />`. Passing your own callback to `signOut(callback)` still navigates on your behalf and is not decorated.
46 changes: 46 additions & 0 deletions packages/clerk-js/src/core/__tests__/clerk.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1169,6 +1169,13 @@ describe('Clerk singleton', () => {
const mockSession1 = { id: '1', remove: vi.fn(), status: 'active', user: {}, getToken: vi.fn() };
const mockSession2 = { id: '2', remove: vi.fn(), status: 'active', user: {}, getToken: vi.fn() };
const mockSession3 = { id: '3', remove: vi.fn(), status: 'pending', user: {}, getToken: vi.fn() };
// Sign-out consults these to decide whether to route the redirect through
// /v1/client/touch. Default to "no refresh needed" so the existing cases
// assert against the plain redirect URL.
const clientTouchDefaults = {
isEligibleForTouch: () => false,
buildTouchUrl: () => 'https://clerk.example.com/v1/client/touch',
};

beforeEach(() => {
mockClientDestroy.mockReset();
Expand DownExpand Up@@ -1198,6 +1205,7 @@ describe('Clerk singleton', () => {
it('signs out all sessions if no sessionId is passed and multiple sessions have authenticated status', async () => {
mockClientFetch.mockReturnValue(
Promise.resolve({
...clientTouchDefaults,
signedInSessions: [mockSession1, mockSession2, mockSession3],
sessions: [mockSession1, mockSession2, mockSession3],
destroy: mockClientDestroy,
Expand All@@ -1221,6 +1229,7 @@ describe('Clerk singleton', () => {
async status => {
mockClientFetch.mockReturnValue(
Promise.resolve({
...clientTouchDefaults,
signedInSessions: [{ ...mockSession1, status }],
sessions: [{ ...mockSession1, status }],
destroy: mockClientDestroy,
Expand All@@ -1244,6 +1253,7 @@ describe('Clerk singleton', () => {
it('only removes the session that corresponds to the passed sessionId if it is not the current', async () => {
mockClientFetch.mockReturnValue(
Promise.resolve({
...clientTouchDefaults,
signedInSessions: [mockSession1, mockSession2, mockSession3],
sessions: [mockSession1, mockSession2, mockSession3],
destroy: mockClientDestroy,
Expand All@@ -1264,6 +1274,7 @@ describe('Clerk singleton', () => {
it('removes and signs out the session that corresponds to the passed sessionId if it is the current', async () => {
mockClientFetch.mockReturnValue(
Promise.resolve({
...clientTouchDefaults,
signedInSessions: [mockSession1, mockSession2, mockSession3],
sessions: [mockSession1, mockSession2, mockSession3],
destroy: mockClientDestroy,
Expand All@@ -1284,6 +1295,7 @@ describe('Clerk singleton', () => {
it('removes and signs out the session and redirects to the provided redirectUrl ', async () => {
mockClientFetch.mockReturnValue(
Promise.resolve({
...clientTouchDefaults,
signedInSessions: [mockSession1, mockSession2, mockSession3],
sessions: [mockSession1, mockSession2, mockSession3],
destroy: mockClientDestroy,
Expand All@@ -1300,6 +1312,40 @@ describe('Clerk singleton', () => {
expect(sut.navigate).toHaveBeenCalledWith('/after-sign-out');
});
});

it('routes the redirect through /v1/client/touch when the client cookie is close to expiring', async () => {
mockClientFetch.mockReturnValue(
Promise.resolve({
signedInSessions: [mockSession1],
sessions: [mockSession1],
destroy: mockClientDestroy,
removeSessions: mockClientRemoveSessions,
isEligibleForTouch: () => true,
// Encodes the nested URL the way the real Client.buildTouchUrl() does, so a
// destination carrying its own query or hash survives the round trip.
buildTouchUrl: ({ redirectUrl }: { redirectUrl: URL }) => {
const touchUrl = new URL('https://clerk.example.com/v1/client/touch');
touchUrl.searchParams.set('redirect_url', redirectUrl.toString());
return touchUrl.toString();
},
}),
);

const sut = new Clerk(productionPublishableKey);
sut.navigate = vi.fn();
await sut.load();
await sut.signOut({ redirectUrl: '/after-sign-out?tab=security#settings' });

await waitFor(() => {
expect(mockClientRemoveSessions).toHaveBeenCalled();
const navigatedTo = new URL((sut.navigate as ReturnType<typeof vi.fn>).mock.calls[0][0]);
expect(navigatedTo.pathname).toEqual('/v1/client/touch');
// The user still lands on the original destination, via the touch redirect.
expect(navigatedTo.searchParams.get('redirect_url')).toEqual(
new URL('/after-sign-out?tab=security#settings', mockWindowLocation.href).toString(),
);
});
});
});

describe('.navigate(to)', () => {
Expand Down
37 changes: 23 additions & 14 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -656,6 +656,25 @@ export class Clerk implements ClerkInterface {
return Boolean(!this.#options.signUpUrl && this.#options.signInUrl && !isAbsoluteUrl(this.#options.signInUrl));
}

/**
* Routes `url` through `/v1/client/touch` when the client cookie is close to expiring,
* and returns it unchanged otherwise.
*
* In practice this only adds a redirect on Safari. A cookie re-issued from a fetch is
* capped at 7 days by ITP; every other browser gets the full 400 days and is never
* eligible. Touch is a top-level navigation, which ITP does not cap, so it restores
* the full lifetime.
*/
#decorateUrlWithTouch(url: string): string {
// In React Native, window exists but window.location does not, so the URL cannot be
// resolved to an absolute one. ITP does not apply there either.
if (!inBrowser() || typeof window.location === 'undefined' || !this.client?.isEligibleForTouch()) {
return url;
}

return this.buildUrlWithAuth(this.client.buildTouchUrl({ redirectUrl: new URL(url, window.location.href) }));
}

public signOut: SignOut = async (callbackOrOptions?: SignOutCallback | SignOutOptions, options?: SignOutOptions) => {
if (!this.client || this.client.sessions.length === 0) {
return;
Expand DownExpand Up@@ -696,7 +715,9 @@ export class Clerk implements ClerkInterface {
if (signOutCallback) {
await signOutCallback();
} else {
await this.navigate(redirectUrl);
// The client outlives sign-out and is what Client Trust uses to recognize a
// returning device, so the re-issued cookie has to keep its full lifetime.
await this.navigate(this.#decorateUrlWithTouch(redirectUrl));
}
});

Expand DownExpand Up@@ -1826,21 +1847,9 @@ export class Clerk implements ClerkInterface {
// Track whether decorateUrl was called for dev-mode warning
let decorateUrlCalled = false;

/**
* Creates a URL that goes through the /v1/client/touch endpoint when Safari ITP fix is needed.
* This allows the session cookie to be refreshed via a full page navigation, bypassing
* Safari's 7-day cap on cookies set via fetch/XHR.
*/
const decorateUrl = (url: string): string => {
decorateUrlCalled = true;

if (!this.client?.isEligibleForTouch()) {
return url;
}

const absoluteUrl = new URL(url, window.location.href);
const touchUrl = this.client.buildTouchUrl({ redirectUrl: absoluteUrl });
return this.buildUrlWithAuth(touchUrl);
return this.#decorateUrlWithTouch(url);
};

await setActiveNavigate({ session: newSession, decorateUrl });
Expand Down
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(clerk-js): apply the Safari ITP cookie refresh on sign-out by dmoerner · Pull Request #9254 · 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
11 changes: 11 additions & 0 deletions .changeset/safari-itp-sign-out-cookie-refresh.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
---
'@clerk/clerk-js': patch
---

Apply the Safari ITP cookie refresh on sign-out.

Signing out re-issues the client cookie from a fetch, which Safari's ITP caps at 7 days. The client outlives sign-out, and it is what Client Trust uses to recognize a known device, so the cap meant a user who signed out and came back more than a week later was treated as being on a new device and challenged for a second factor.

`signOut()` now routes its redirect through `/v1/client/touch` when the client cookie is close to expiring, the same workaround `setActive()` already applies after sign-in. The redirect is left unchanged when no refresh is needed.

This covers `signOut()` calls that navigate to a redirect URL, including `<UserButton />` and `<SignOutButton />`. Passing your own callback to `signOut(callback)` still navigates on your behalf and is not decorated.
46 changes: 46 additions & 0 deletions packages/clerk-js/src/core/__tests__/clerk.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1169,6 +1169,13 @@ describe('Clerk singleton', () => {
const mockSession1 = { id: '1', remove: vi.fn(), status: 'active', user: {}, getToken: vi.fn() };
const mockSession2 = { id: '2', remove: vi.fn(), status: 'active', user: {}, getToken: vi.fn() };
const mockSession3 = { id: '3', remove: vi.fn(), status: 'pending', user: {}, getToken: vi.fn() };
// Sign-out consults these to decide whether to route the redirect through
// /v1/client/touch. Default to "no refresh needed" so the existing cases
// assert against the plain redirect URL.
const clientTouchDefaults = {
isEligibleForTouch: () => false,
buildTouchUrl: () => 'https://clerk.example.com/v1/client/touch',
};

beforeEach(() => {
mockClientDestroy.mockReset();
Expand DownExpand Up@@ -1198,6 +1205,7 @@ describe('Clerk singleton', () => {
it('signs out all sessions if no sessionId is passed and multiple sessions have authenticated status', async () => {
mockClientFetch.mockReturnValue(
Promise.resolve({
...clientTouchDefaults,
signedInSessions: [mockSession1, mockSession2, mockSession3],
sessions: [mockSession1, mockSession2, mockSession3],
destroy: mockClientDestroy,
Expand All@@ -1221,6 +1229,7 @@ describe('Clerk singleton', () => {
async status => {
mockClientFetch.mockReturnValue(
Promise.resolve({
...clientTouchDefaults,
signedInSessions: [{ ...mockSession1, status }],
sessions: [{ ...mockSession1, status }],
destroy: mockClientDestroy,
Expand All@@ -1244,6 +1253,7 @@ describe('Clerk singleton', () => {
it('only removes the session that corresponds to the passed sessionId if it is not the current', async () => {
mockClientFetch.mockReturnValue(
Promise.resolve({
...clientTouchDefaults,
signedInSessions: [mockSession1, mockSession2, mockSession3],
sessions: [mockSession1, mockSession2, mockSession3],
destroy: mockClientDestroy,
Expand All@@ -1264,6 +1274,7 @@ describe('Clerk singleton', () => {
it('removes and signs out the session that corresponds to the passed sessionId if it is the current', async () => {
mockClientFetch.mockReturnValue(
Promise.resolve({
...clientTouchDefaults,
signedInSessions: [mockSession1, mockSession2, mockSession3],
sessions: [mockSession1, mockSession2, mockSession3],
destroy: mockClientDestroy,
Expand All@@ -1284,6 +1295,7 @@ describe('Clerk singleton', () => {
it('removes and signs out the session and redirects to the provided redirectUrl ', async () => {
mockClientFetch.mockReturnValue(
Promise.resolve({
...clientTouchDefaults,
signedInSessions: [mockSession1, mockSession2, mockSession3],
sessions: [mockSession1, mockSession2, mockSession3],
destroy: mockClientDestroy,
Expand All@@ -1300,6 +1312,40 @@ describe('Clerk singleton', () => {
expect(sut.navigate).toHaveBeenCalledWith('/after-sign-out');
});
});

it('routes the redirect through /v1/client/touch when the client cookie is close to expiring', async () => {
mockClientFetch.mockReturnValue(
Promise.resolve({
signedInSessions: [mockSession1],
sessions: [mockSession1],
destroy: mockClientDestroy,
removeSessions: mockClientRemoveSessions,
isEligibleForTouch: () => true,
// Encodes the nested URL the way the real Client.buildTouchUrl() does, so a
// destination carrying its own query or hash survives the round trip.
buildTouchUrl: ({ redirectUrl }: { redirectUrl: URL }) => {
const touchUrl = new URL('https://clerk.example.com/v1/client/touch');
touchUrl.searchParams.set('redirect_url', redirectUrl.toString());
return touchUrl.toString();
},
}),
);

const sut = new Clerk(productionPublishableKey);
sut.navigate = vi.fn();
await sut.load();
await sut.signOut({ redirectUrl: '/after-sign-out?tab=security#settings' });

await waitFor(() => {
expect(mockClientRemoveSessions).toHaveBeenCalled();
const navigatedTo = new URL((sut.navigate as ReturnType<typeof vi.fn>).mock.calls[0][0]);
expect(navigatedTo.pathname).toEqual('/v1/client/touch');
// The user still lands on the original destination, via the touch redirect.
expect(navigatedTo.searchParams.get('redirect_url')).toEqual(
new URL('/after-sign-out?tab=security#settings', mockWindowLocation.href).toString(),
);
});
});
});

describe('.navigate(to)', () => {
Expand Down
37 changes: 23 additions & 14 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -656,6 +656,25 @@ export class Clerk implements ClerkInterface {
return Boolean(!this.#options.signUpUrl && this.#options.signInUrl && !isAbsoluteUrl(this.#options.signInUrl));
}

/**
* Routes `url` through `/v1/client/touch` when the client cookie is close to expiring,
* and returns it unchanged otherwise.
*
* In practice this only adds a redirect on Safari. A cookie re-issued from a fetch is
* capped at 7 days by ITP; every other browser gets the full 400 days and is never
* eligible. Touch is a top-level navigation, which ITP does not cap, so it restores
* the full lifetime.
*/
#decorateUrlWithTouch(url: string): string {
// In React Native, window exists but window.location does not, so the URL cannot be
// resolved to an absolute one. ITP does not apply there either.
if (!inBrowser() || typeof window.location === 'undefined' || !this.client?.isEligibleForTouch()) {
return url;
}

return this.buildUrlWithAuth(this.client.buildTouchUrl({ redirectUrl: new URL(url, window.location.href) }));
}

public signOut: SignOut = async (callbackOrOptions?: SignOutCallback | SignOutOptions, options?: SignOutOptions) => {
if (!this.client || this.client.sessions.length === 0) {
return;
Expand DownExpand Up@@ -696,7 +715,9 @@ export class Clerk implements ClerkInterface {
if (signOutCallback) {
await signOutCallback();
} else {
await this.navigate(redirectUrl);
// The client outlives sign-out and is what Client Trust uses to recognize a
// returning device, so the re-issued cookie has to keep its full lifetime.
await this.navigate(this.#decorateUrlWithTouch(redirectUrl));
}
});

Expand DownExpand Up@@ -1826,21 +1847,9 @@ export class Clerk implements ClerkInterface {
// Track whether decorateUrl was called for dev-mode warning
let decorateUrlCalled = false;

/**
* Creates a URL that goes through the /v1/client/touch endpoint when Safari ITP fix is needed.
* This allows the session cookie to be refreshed via a full page navigation, bypassing
* Safari's 7-day cap on cookies set via fetch/XHR.
*/
const decorateUrl = (url: string): string => {
decorateUrlCalled = true;

if (!this.client?.isEligibleForTouch()) {
return url;
}

const absoluteUrl = new URL(url, window.location.href);
const touchUrl = this.client.buildTouchUrl({ redirectUrl: absoluteUrl });
return this.buildUrlWithAuth(touchUrl);
return this.#decorateUrlWithTouch(url);
};

await setActiveNavigate({ session: newSession, decorateUrl });
Expand Down
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(clerk-js): apply the Safari ITP cookie refresh on sign-out by dmoerner · Pull Request #9254 · 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
11 changes: 11 additions & 0 deletions .changeset/safari-itp-sign-out-cookie-refresh.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
---
'@clerk/clerk-js': patch
---

Apply the Safari ITP cookie refresh on sign-out.

Signing out re-issues the client cookie from a fetch, which Safari's ITP caps at 7 days. The client outlives sign-out, and it is what Client Trust uses to recognize a known device, so the cap meant a user who signed out and came back more than a week later was treated as being on a new device and challenged for a second factor.

`signOut()` now routes its redirect through `/v1/client/touch` when the client cookie is close to expiring, the same workaround `setActive()` already applies after sign-in. The redirect is left unchanged when no refresh is needed.

This covers `signOut()` calls that navigate to a redirect URL, including `<UserButton />` and `<SignOutButton />`. Passing your own callback to `signOut(callback)` still navigates on your behalf and is not decorated.
46 changes: 46 additions & 0 deletions packages/clerk-js/src/core/__tests__/clerk.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1169,6 +1169,13 @@ describe('Clerk singleton', () => {
const mockSession1 = { id: '1', remove: vi.fn(), status: 'active', user: {}, getToken: vi.fn() };
const mockSession2 = { id: '2', remove: vi.fn(), status: 'active', user: {}, getToken: vi.fn() };
const mockSession3 = { id: '3', remove: vi.fn(), status: 'pending', user: {}, getToken: vi.fn() };
// Sign-out consults these to decide whether to route the redirect through
// /v1/client/touch. Default to "no refresh needed" so the existing cases
// assert against the plain redirect URL.
const clientTouchDefaults = {
isEligibleForTouch: () => false,
buildTouchUrl: () => 'https://clerk.example.com/v1/client/touch',
};

beforeEach(() => {
mockClientDestroy.mockReset();
Expand DownExpand Up@@ -1198,6 +1205,7 @@ describe('Clerk singleton', () => {
it('signs out all sessions if no sessionId is passed and multiple sessions have authenticated status', async () => {
mockClientFetch.mockReturnValue(
Promise.resolve({
...clientTouchDefaults,
signedInSessions: [mockSession1, mockSession2, mockSession3],
sessions: [mockSession1, mockSession2, mockSession3],
destroy: mockClientDestroy,
Expand All@@ -1221,6 +1229,7 @@ describe('Clerk singleton', () => {
async status => {
mockClientFetch.mockReturnValue(
Promise.resolve({
...clientTouchDefaults,
signedInSessions: [{ ...mockSession1, status }],
sessions: [{ ...mockSession1, status }],
destroy: mockClientDestroy,
Expand All@@ -1244,6 +1253,7 @@ describe('Clerk singleton', () => {
it('only removes the session that corresponds to the passed sessionId if it is not the current', async () => {
mockClientFetch.mockReturnValue(
Promise.resolve({
...clientTouchDefaults,
signedInSessions: [mockSession1, mockSession2, mockSession3],
sessions: [mockSession1, mockSession2, mockSession3],
destroy: mockClientDestroy,
Expand All@@ -1264,6 +1274,7 @@ describe('Clerk singleton', () => {
it('removes and signs out the session that corresponds to the passed sessionId if it is the current', async () => {
mockClientFetch.mockReturnValue(
Promise.resolve({
...clientTouchDefaults,
signedInSessions: [mockSession1, mockSession2, mockSession3],
sessions: [mockSession1, mockSession2, mockSession3],
destroy: mockClientDestroy,
Expand All@@ -1284,6 +1295,7 @@ describe('Clerk singleton', () => {
it('removes and signs out the session and redirects to the provided redirectUrl ', async () => {
mockClientFetch.mockReturnValue(
Promise.resolve({
...clientTouchDefaults,
signedInSessions: [mockSession1, mockSession2, mockSession3],
sessions: [mockSession1, mockSession2, mockSession3],
destroy: mockClientDestroy,
Expand All@@ -1300,6 +1312,40 @@ describe('Clerk singleton', () => {
expect(sut.navigate).toHaveBeenCalledWith('/after-sign-out');
});
});

it('routes the redirect through /v1/client/touch when the client cookie is close to expiring', async () => {
mockClientFetch.mockReturnValue(
Promise.resolve({
signedInSessions: [mockSession1],
sessions: [mockSession1],
destroy: mockClientDestroy,
removeSessions: mockClientRemoveSessions,
isEligibleForTouch: () => true,
// Encodes the nested URL the way the real Client.buildTouchUrl() does, so a
// destination carrying its own query or hash survives the round trip.
buildTouchUrl: ({ redirectUrl }: { redirectUrl: URL }) => {
const touchUrl = new URL('https://clerk.example.com/v1/client/touch');
touchUrl.searchParams.set('redirect_url', redirectUrl.toString());
return touchUrl.toString();
},
}),
);

const sut = new Clerk(productionPublishableKey);
sut.navigate = vi.fn();
await sut.load();
await sut.signOut({ redirectUrl: '/after-sign-out?tab=security#settings' });

await waitFor(() => {
expect(mockClientRemoveSessions).toHaveBeenCalled();
const navigatedTo = new URL((sut.navigate as ReturnType<typeof vi.fn>).mock.calls[0][0]);
expect(navigatedTo.pathname).toEqual('/v1/client/touch');
// The user still lands on the original destination, via the touch redirect.
expect(navigatedTo.searchParams.get('redirect_url')).toEqual(
new URL('/after-sign-out?tab=security#settings', mockWindowLocation.href).toString(),
);
});
});
});

describe('.navigate(to)', () => {
Expand Down
37 changes: 23 additions & 14 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -656,6 +656,25 @@ export class Clerk implements ClerkInterface {
return Boolean(!this.#options.signUpUrl && this.#options.signInUrl && !isAbsoluteUrl(this.#options.signInUrl));
}

/**
* Routes `url` through `/v1/client/touch` when the client cookie is close to expiring,
* and returns it unchanged otherwise.
*
* In practice this only adds a redirect on Safari. A cookie re-issued from a fetch is
* capped at 7 days by ITP; every other browser gets the full 400 days and is never
* eligible. Touch is a top-level navigation, which ITP does not cap, so it restores
* the full lifetime.
*/
#decorateUrlWithTouch(url: string): string {
// In React Native, window exists but window.location does not, so the URL cannot be
// resolved to an absolute one. ITP does not apply there either.
if (!inBrowser() || typeof window.location === 'undefined' || !this.client?.isEligibleForTouch()) {
return url;
}

return this.buildUrlWithAuth(this.client.buildTouchUrl({ redirectUrl: new URL(url, window.location.href) }));
}

public signOut: SignOut = async (callbackOrOptions?: SignOutCallback | SignOutOptions, options?: SignOutOptions) => {
if (!this.client || this.client.sessions.length === 0) {
return;
Expand DownExpand Up@@ -696,7 +715,9 @@ export class Clerk implements ClerkInterface {
if (signOutCallback) {
await signOutCallback();
} else {
await this.navigate(redirectUrl);
// The client outlives sign-out and is what Client Trust uses to recognize a
// returning device, so the re-issued cookie has to keep its full lifetime.
await this.navigate(this.#decorateUrlWithTouch(redirectUrl));
}
});

Expand DownExpand Up@@ -1826,21 +1847,9 @@ export class Clerk implements ClerkInterface {
// Track whether decorateUrl was called for dev-mode warning
let decorateUrlCalled = false;

/**
* Creates a URL that goes through the /v1/client/touch endpoint when Safari ITP fix is needed.
* This allows the session cookie to be refreshed via a full page navigation, bypassing
* Safari's 7-day cap on cookies set via fetch/XHR.
*/
const decorateUrl = (url: string): string => {
decorateUrlCalled = true;

if (!this.client?.isEligibleForTouch()) {
return url;
}

const absoluteUrl = new URL(url, window.location.href);
const touchUrl = this.client.buildTouchUrl({ redirectUrl: absoluteUrl });
return this.buildUrlWithAuth(touchUrl);
return this.#decorateUrlWithTouch(url);
};

await setActiveNavigate({ session: newSession, decorateUrl });
Expand Down
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(clerk-js): apply the Safari ITP cookie refresh on sign-out by dmoerner · Pull Request #9254 · 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
11 changes: 11 additions & 0 deletions .changeset/safari-itp-sign-out-cookie-refresh.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
---
'@clerk/clerk-js': patch
---

Apply the Safari ITP cookie refresh on sign-out.

Signing out re-issues the client cookie from a fetch, which Safari's ITP caps at 7 days. The client outlives sign-out, and it is what Client Trust uses to recognize a known device, so the cap meant a user who signed out and came back more than a week later was treated as being on a new device and challenged for a second factor.

`signOut()` now routes its redirect through `/v1/client/touch` when the client cookie is close to expiring, the same workaround `setActive()` already applies after sign-in. The redirect is left unchanged when no refresh is needed.

This covers `signOut()` calls that navigate to a redirect URL, including `<UserButton />` and `<SignOutButton />`. Passing your own callback to `signOut(callback)` still navigates on your behalf and is not decorated.
46 changes: 46 additions & 0 deletions packages/clerk-js/src/core/__tests__/clerk.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1169,6 +1169,13 @@ describe('Clerk singleton', () => {
const mockSession1 = { id: '1', remove: vi.fn(), status: 'active', user: {}, getToken: vi.fn() };
const mockSession2 = { id: '2', remove: vi.fn(), status: 'active', user: {}, getToken: vi.fn() };
const mockSession3 = { id: '3', remove: vi.fn(), status: 'pending', user: {}, getToken: vi.fn() };
// Sign-out consults these to decide whether to route the redirect through
// /v1/client/touch. Default to "no refresh needed" so the existing cases
// assert against the plain redirect URL.
const clientTouchDefaults = {
isEligibleForTouch: () => false,
buildTouchUrl: () => 'https://clerk.example.com/v1/client/touch',
};

beforeEach(() => {
mockClientDestroy.mockReset();
Expand DownExpand Up@@ -1198,6 +1205,7 @@ describe('Clerk singleton', () => {
it('signs out all sessions if no sessionId is passed and multiple sessions have authenticated status', async () => {
mockClientFetch.mockReturnValue(
Promise.resolve({
...clientTouchDefaults,
signedInSessions: [mockSession1, mockSession2, mockSession3],
sessions: [mockSession1, mockSession2, mockSession3],
destroy: mockClientDestroy,
Expand All@@ -1221,6 +1229,7 @@ describe('Clerk singleton', () => {
async status => {
mockClientFetch.mockReturnValue(
Promise.resolve({
...clientTouchDefaults,
signedInSessions: [{ ...mockSession1, status }],
sessions: [{ ...mockSession1, status }],
destroy: mockClientDestroy,
Expand All@@ -1244,6 +1253,7 @@ describe('Clerk singleton', () => {
it('only removes the session that corresponds to the passed sessionId if it is not the current', async () => {
mockClientFetch.mockReturnValue(
Promise.resolve({
...clientTouchDefaults,
signedInSessions: [mockSession1, mockSession2, mockSession3],
sessions: [mockSession1, mockSession2, mockSession3],
destroy: mockClientDestroy,
Expand All@@ -1264,6 +1274,7 @@ describe('Clerk singleton', () => {
it('removes and signs out the session that corresponds to the passed sessionId if it is the current', async () => {
mockClientFetch.mockReturnValue(
Promise.resolve({
...clientTouchDefaults,
signedInSessions: [mockSession1, mockSession2, mockSession3],
sessions: [mockSession1, mockSession2, mockSession3],
destroy: mockClientDestroy,
Expand All@@ -1284,6 +1295,7 @@ describe('Clerk singleton', () => {
it('removes and signs out the session and redirects to the provided redirectUrl ', async () => {
mockClientFetch.mockReturnValue(
Promise.resolve({
...clientTouchDefaults,
signedInSessions: [mockSession1, mockSession2, mockSession3],
sessions: [mockSession1, mockSession2, mockSession3],
destroy: mockClientDestroy,
Expand All@@ -1300,6 +1312,40 @@ describe('Clerk singleton', () => {
expect(sut.navigate).toHaveBeenCalledWith('/after-sign-out');
});
});

it('routes the redirect through /v1/client/touch when the client cookie is close to expiring', async () => {
mockClientFetch.mockReturnValue(
Promise.resolve({
signedInSessions: [mockSession1],
sessions: [mockSession1],
destroy: mockClientDestroy,
removeSessions: mockClientRemoveSessions,
isEligibleForTouch: () => true,
// Encodes the nested URL the way the real Client.buildTouchUrl() does, so a
// destination carrying its own query or hash survives the round trip.
buildTouchUrl: ({ redirectUrl }: { redirectUrl: URL }) => {
const touchUrl = new URL('https://clerk.example.com/v1/client/touch');
touchUrl.searchParams.set('redirect_url', redirectUrl.toString());
return touchUrl.toString();
},
}),
);

const sut = new Clerk(productionPublishableKey);
sut.navigate = vi.fn();
await sut.load();
await sut.signOut({ redirectUrl: '/after-sign-out?tab=security#settings' });

await waitFor(() => {
expect(mockClientRemoveSessions).toHaveBeenCalled();
const navigatedTo = new URL((sut.navigate as ReturnType<typeof vi.fn>).mock.calls[0][0]);
expect(navigatedTo.pathname).toEqual('/v1/client/touch');
// The user still lands on the original destination, via the touch redirect.
expect(navigatedTo.searchParams.get('redirect_url')).toEqual(
new URL('/after-sign-out?tab=security#settings', mockWindowLocation.href).toString(),
);
});
});
});

describe('.navigate(to)', () => {
Expand Down
37 changes: 23 additions & 14 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -656,6 +656,25 @@ export class Clerk implements ClerkInterface {
return Boolean(!this.#options.signUpUrl && this.#options.signInUrl && !isAbsoluteUrl(this.#options.signInUrl));
}

/**
* Routes `url` through `/v1/client/touch` when the client cookie is close to expiring,
* and returns it unchanged otherwise.
*
* In practice this only adds a redirect on Safari. A cookie re-issued from a fetch is
* capped at 7 days by ITP; every other browser gets the full 400 days and is never
* eligible. Touch is a top-level navigation, which ITP does not cap, so it restores
* the full lifetime.
*/
#decorateUrlWithTouch(url: string): string {
// In React Native, window exists but window.location does not, so the URL cannot be
// resolved to an absolute one. ITP does not apply there either.
if (!inBrowser() || typeof window.location === 'undefined' || !this.client?.isEligibleForTouch()) {
return url;
}

return this.buildUrlWithAuth(this.client.buildTouchUrl({ redirectUrl: new URL(url, window.location.href) }));
}

public signOut: SignOut = async (callbackOrOptions?: SignOutCallback | SignOutOptions, options?: SignOutOptions) => {
if (!this.client || this.client.sessions.length === 0) {
return;
Expand DownExpand Up@@ -696,7 +715,9 @@ export class Clerk implements ClerkInterface {
if (signOutCallback) {
await signOutCallback();
} else {
await this.navigate(redirectUrl);
// The client outlives sign-out and is what Client Trust uses to recognize a
// returning device, so the re-issued cookie has to keep its full lifetime.
await this.navigate(this.#decorateUrlWithTouch(redirectUrl));
}
});

Expand DownExpand Up@@ -1826,21 +1847,9 @@ export class Clerk implements ClerkInterface {
// Track whether decorateUrl was called for dev-mode warning
let decorateUrlCalled = false;

/**
* Creates a URL that goes through the /v1/client/touch endpoint when Safari ITP fix is needed.
* This allows the session cookie to be refreshed via a full page navigation, bypassing
* Safari's 7-day cap on cookies set via fetch/XHR.
*/
const decorateUrl = (url: string): string => {
decorateUrlCalled = true;

if (!this.client?.isEligibleForTouch()) {
return url;
}

const absoluteUrl = new URL(url, window.location.href);
const touchUrl = this.client.buildTouchUrl({ redirectUrl: absoluteUrl });
return this.buildUrlWithAuth(touchUrl);
return this.#decorateUrlWithTouch(url);
};

await setActiveNavigate({ session: newSession, decorateUrl });
Expand Down
Loading