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/clean-dev-browsers.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Fix dev browser recovery by clearing stale partitioned and non-partitioned dev browser cookie variants before minting a new dev browser.
147 changes: 147 additions & 0 deletions packages/clerk-js/src/core/auth/cookies/__tests__/devBrowser.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,147 @@
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import { createDevBrowserCookie } from '../devBrowser';

const { cookieStore, removeCalls, setCalls } = vi.hoisted(() => ({
cookieStore: new Map<string, string>(),
removeCalls: [] as Array<{ name: string; attributes?: object }>,
setCalls: [] as Array<{ name: string; value: string; attributes?: object }>,
}));

vi.mock('@clerk/shared/cookie', () => ({
createCookieHandler: (name: string) => ({
get: () => cookieStore.get(name),
remove: (attributes?: object) => {
removeCalls.push({ name, attributes });
cookieStore.delete(name);
},
set: (value: string, attributes?: object) => {
setCalls.push({ name, value, attributes });
cookieStore.set(name, value);
},
}),
}));

describe('createDevBrowserCookie', () => {
const cookieSuffix = 'test-suffix';
const suffixedCookieName = '__clerk_db_jwt_test-suffix';
const unsuffixedCookieName = '__clerk_db_jwt';
const devBrowser = 'test-dev-browser';
const now = new Date('2024-01-01T00:00:00.000Z');
const expires = new Date('2025-01-01T00:00:00.000Z');
const defaultOptions = { usePartitionedCookies: () => false };

beforeEach(() => {
vi.useFakeTimers();
vi.setSystemTime(now);
cookieStore.clear();
removeCalls.length = 0;
setCalls.length = 0;
});

afterEach(() => {
vi.useRealTimers();
vi.unstubAllGlobals();
});

it('removes current, non-partitioned, and partitioned cookie variants for both dev browser cookie names', () => {
const cookieHandler = createDevBrowserCookie(cookieSuffix, defaultOptions);

cookieHandler.remove();

expect(removeCalls).toEqual([
{
name: suffixedCookieName,
attributes: {
sameSite: 'Lax',
secure: false,
partitioned: false,
},
},
{ name: suffixedCookieName, attributes: undefined },
{
name: suffixedCookieName,
attributes: {
sameSite: 'None',
secure: true,
partitioned: true,
},
},
{
name: unsuffixedCookieName,
attributes: {
sameSite: 'Lax',
secure: false,
partitioned: false,
},
},
{ name: unsuffixedCookieName, attributes: undefined },
{
name: unsuffixedCookieName,
attributes: {
sameSite: 'None',
secure: true,
partitioned: true,
},
},
]);
});

it('clears stale partitioned cookie variants before writing a new dev browser', () => {
const cookieHandler = createDevBrowserCookie(cookieSuffix, defaultOptions);

cookieHandler.set(devBrowser);

expect(removeCalls).toContainEqual({
name: suffixedCookieName,
attributes: {
sameSite: 'None',
secure: true,
partitioned: true,
},
});
expect(removeCalls).toContainEqual({
name: unsuffixedCookieName,
attributes: {
sameSite: 'None',
secure: true,
partitioned: true,
},
});
expect(setCalls).toEqual([
{
name: suffixedCookieName,
value: devBrowser,
attributes: {
expires,
sameSite: 'Lax',
secure: false,
partitioned: false,
},
},
{
name: unsuffixedCookieName,
value: devBrowser,
attributes: {
expires,
sameSite: 'Lax',
secure: false,
partitioned: false,
},
},
]);
});

it('reads the suffixed cookie before falling back to the unsuffixed cookie', () => {
const cookieHandler = createDevBrowserCookie(cookieSuffix, defaultOptions);

cookieStore.set(unsuffixedCookieName, 'unsuffixed-value');
cookieStore.set(suffixedCookieName, 'suffixed-value');

expect(cookieHandler.get()).toBe('suffixed-value');

cookieStore.delete(suffixedCookieName);

expect(cookieHandler.get()).toBe('unsuffixed-value');
});
});
38 changes: 20 additions & 18 deletions packages/clerk-js/src/core/auth/cookies/devBrowser.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,12 @@ const getCookieAttributes = (options: DevBrowserCookieOptions) => {
return { sameSite, secure, partitioned } as const;
};

const partitionedCookieAttributes = {
sameSite: 'None',
secure: true,
partitioned: true,
} as const;

/**
* Create a long-lived JS cookie to store the dev browser token
* ONLY for development instances.
Expand All@@ -40,33 +46,29 @@ export const createDevBrowserCookie = (

const get = () => suffixedDevBrowserCookie.get() || devBrowserCookie.get();

const removeAll = () => {
const attributes = getCookieAttributes(options);

for (const cookie of [suffixedDevBrowserCookie, devBrowserCookie]) {
cookie.remove(attributes);
cookie.remove();
cookie.remove(partitionedCookieAttributes);
}
};

const set = (devBrowser: string) => {
const expires = addYears(Date.now(), 1);
const { sameSite, secure, partitioned } = getCookieAttributes(options);

// Remove old non-partitioned cookies — the browser treats partitioned and
// non-partitioned cookies with the same name as distinct cookies.
if (partitioned) {
suffixedDevBrowserCookie.remove();
devBrowserCookie.remove();
}
// Remove stale variants before writing. The environment may not be loaded
// yet, so the current partitioned-cookies setting cannot be trusted.
removeAll();

suffixedDevBrowserCookie.set(devBrowser, { expires, sameSite, secure, partitioned });
devBrowserCookie.set(devBrowser, { expires, sameSite, secure, partitioned });
};

const remove = () => {
const attributes = getCookieAttributes(options);
suffixedDevBrowserCookie.remove(attributes);
devBrowserCookie.remove(attributes);

// Also remove non-partitioned variants — the browser treats partitioned and
// non-partitioned cookies with the same name as distinct cookies.
if (attributes.partitioned) {
suffixedDevBrowserCookie.remove();
devBrowserCookie.remove();
}
};
const remove = () => removeAll();

return {
get,
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): dev browser partitioned cookie cleanup by brkalow · Pull Request #8538 · 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/clean-dev-browsers.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Fix dev browser recovery by clearing stale partitioned and non-partitioned dev browser cookie variants before minting a new dev browser.
147 changes: 147 additions & 0 deletions packages/clerk-js/src/core/auth/cookies/__tests__/devBrowser.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,147 @@
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import { createDevBrowserCookie } from '../devBrowser';

const { cookieStore, removeCalls, setCalls } = vi.hoisted(() => ({
cookieStore: new Map<string, string>(),
removeCalls: [] as Array<{ name: string; attributes?: object }>,
setCalls: [] as Array<{ name: string; value: string; attributes?: object }>,
}));

vi.mock('@clerk/shared/cookie', () => ({
createCookieHandler: (name: string) => ({
get: () => cookieStore.get(name),
remove: (attributes?: object) => {
removeCalls.push({ name, attributes });
cookieStore.delete(name);
},
set: (value: string, attributes?: object) => {
setCalls.push({ name, value, attributes });
cookieStore.set(name, value);
},
}),
}));

describe('createDevBrowserCookie', () => {
const cookieSuffix = 'test-suffix';
const suffixedCookieName = '__clerk_db_jwt_test-suffix';
const unsuffixedCookieName = '__clerk_db_jwt';
const devBrowser = 'test-dev-browser';
const now = new Date('2024-01-01T00:00:00.000Z');
const expires = new Date('2025-01-01T00:00:00.000Z');
const defaultOptions = { usePartitionedCookies: () => false };

beforeEach(() => {
vi.useFakeTimers();
vi.setSystemTime(now);
cookieStore.clear();
removeCalls.length = 0;
setCalls.length = 0;
});

afterEach(() => {
vi.useRealTimers();
vi.unstubAllGlobals();
});

it('removes current, non-partitioned, and partitioned cookie variants for both dev browser cookie names', () => {
const cookieHandler = createDevBrowserCookie(cookieSuffix, defaultOptions);

cookieHandler.remove();

expect(removeCalls).toEqual([
{
name: suffixedCookieName,
attributes: {
sameSite: 'Lax',
secure: false,
partitioned: false,
},
},
{ name: suffixedCookieName, attributes: undefined },
{
name: suffixedCookieName,
attributes: {
sameSite: 'None',
secure: true,
partitioned: true,
},
},
{
name: unsuffixedCookieName,
attributes: {
sameSite: 'Lax',
secure: false,
partitioned: false,
},
},
{ name: unsuffixedCookieName, attributes: undefined },
{
name: unsuffixedCookieName,
attributes: {
sameSite: 'None',
secure: true,
partitioned: true,
},
},
]);
});

it('clears stale partitioned cookie variants before writing a new dev browser', () => {
const cookieHandler = createDevBrowserCookie(cookieSuffix, defaultOptions);

cookieHandler.set(devBrowser);

expect(removeCalls).toContainEqual({
name: suffixedCookieName,
attributes: {
sameSite: 'None',
secure: true,
partitioned: true,
},
});
expect(removeCalls).toContainEqual({
name: unsuffixedCookieName,
attributes: {
sameSite: 'None',
secure: true,
partitioned: true,
},
});
expect(setCalls).toEqual([
{
name: suffixedCookieName,
value: devBrowser,
attributes: {
expires,
sameSite: 'Lax',
secure: false,
partitioned: false,
},
},
{
name: unsuffixedCookieName,
value: devBrowser,
attributes: {
expires,
sameSite: 'Lax',
secure: false,
partitioned: false,
},
},
]);
});

it('reads the suffixed cookie before falling back to the unsuffixed cookie', () => {
const cookieHandler = createDevBrowserCookie(cookieSuffix, defaultOptions);

cookieStore.set(unsuffixedCookieName, 'unsuffixed-value');
cookieStore.set(suffixedCookieName, 'suffixed-value');

expect(cookieHandler.get()).toBe('suffixed-value');

cookieStore.delete(suffixedCookieName);

expect(cookieHandler.get()).toBe('unsuffixed-value');
});
});
38 changes: 20 additions & 18 deletions packages/clerk-js/src/core/auth/cookies/devBrowser.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,12 @@ const getCookieAttributes = (options: DevBrowserCookieOptions) => {
return { sameSite, secure, partitioned } as const;
};

const partitionedCookieAttributes = {
sameSite: 'None',
secure: true,
partitioned: true,
} as const;

/**
* Create a long-lived JS cookie to store the dev browser token
* ONLY for development instances.
Expand All@@ -40,33 +46,29 @@ export const createDevBrowserCookie = (

const get = () => suffixedDevBrowserCookie.get() || devBrowserCookie.get();

const removeAll = () => {
const attributes = getCookieAttributes(options);

for (const cookie of [suffixedDevBrowserCookie, devBrowserCookie]) {
cookie.remove(attributes);
cookie.remove();
cookie.remove(partitionedCookieAttributes);
}
};

const set = (devBrowser: string) => {
const expires = addYears(Date.now(), 1);
const { sameSite, secure, partitioned } = getCookieAttributes(options);

// Remove old non-partitioned cookies — the browser treats partitioned and
// non-partitioned cookies with the same name as distinct cookies.
if (partitioned) {
suffixedDevBrowserCookie.remove();
devBrowserCookie.remove();
}
// Remove stale variants before writing. The environment may not be loaded
// yet, so the current partitioned-cookies setting cannot be trusted.
removeAll();

suffixedDevBrowserCookie.set(devBrowser, { expires, sameSite, secure, partitioned });
devBrowserCookie.set(devBrowser, { expires, sameSite, secure, partitioned });
};

const remove = () => {
const attributes = getCookieAttributes(options);
suffixedDevBrowserCookie.remove(attributes);
devBrowserCookie.remove(attributes);

// Also remove non-partitioned variants — the browser treats partitioned and
// non-partitioned cookies with the same name as distinct cookies.
if (attributes.partitioned) {
suffixedDevBrowserCookie.remove();
devBrowserCookie.remove();
}
};
const remove = () => removeAll();

return {
get,
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): dev browser partitioned cookie cleanup by brkalow · Pull Request #8538 · 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/clean-dev-browsers.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Fix dev browser recovery by clearing stale partitioned and non-partitioned dev browser cookie variants before minting a new dev browser.
147 changes: 147 additions & 0 deletions packages/clerk-js/src/core/auth/cookies/__tests__/devBrowser.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,147 @@
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import { createDevBrowserCookie } from '../devBrowser';

const { cookieStore, removeCalls, setCalls } = vi.hoisted(() => ({
cookieStore: new Map<string, string>(),
removeCalls: [] as Array<{ name: string; attributes?: object }>,
setCalls: [] as Array<{ name: string; value: string; attributes?: object }>,
}));

vi.mock('@clerk/shared/cookie', () => ({
createCookieHandler: (name: string) => ({
get: () => cookieStore.get(name),
remove: (attributes?: object) => {
removeCalls.push({ name, attributes });
cookieStore.delete(name);
},
set: (value: string, attributes?: object) => {
setCalls.push({ name, value, attributes });
cookieStore.set(name, value);
},
}),
}));

describe('createDevBrowserCookie', () => {
const cookieSuffix = 'test-suffix';
const suffixedCookieName = '__clerk_db_jwt_test-suffix';
const unsuffixedCookieName = '__clerk_db_jwt';
const devBrowser = 'test-dev-browser';
const now = new Date('2024-01-01T00:00:00.000Z');
const expires = new Date('2025-01-01T00:00:00.000Z');
const defaultOptions = { usePartitionedCookies: () => false };

beforeEach(() => {
vi.useFakeTimers();
vi.setSystemTime(now);
cookieStore.clear();
removeCalls.length = 0;
setCalls.length = 0;
});

afterEach(() => {
vi.useRealTimers();
vi.unstubAllGlobals();
});

it('removes current, non-partitioned, and partitioned cookie variants for both dev browser cookie names', () => {
const cookieHandler = createDevBrowserCookie(cookieSuffix, defaultOptions);

cookieHandler.remove();

expect(removeCalls).toEqual([
{
name: suffixedCookieName,
attributes: {
sameSite: 'Lax',
secure: false,
partitioned: false,
},
},
{ name: suffixedCookieName, attributes: undefined },
{
name: suffixedCookieName,
attributes: {
sameSite: 'None',
secure: true,
partitioned: true,
},
},
{
name: unsuffixedCookieName,
attributes: {
sameSite: 'Lax',
secure: false,
partitioned: false,
},
},
{ name: unsuffixedCookieName, attributes: undefined },
{
name: unsuffixedCookieName,
attributes: {
sameSite: 'None',
secure: true,
partitioned: true,
},
},
]);
});

it('clears stale partitioned cookie variants before writing a new dev browser', () => {
const cookieHandler = createDevBrowserCookie(cookieSuffix, defaultOptions);

cookieHandler.set(devBrowser);

expect(removeCalls).toContainEqual({
name: suffixedCookieName,
attributes: {
sameSite: 'None',
secure: true,
partitioned: true,
},
});
expect(removeCalls).toContainEqual({
name: unsuffixedCookieName,
attributes: {
sameSite: 'None',
secure: true,
partitioned: true,
},
});
expect(setCalls).toEqual([
{
name: suffixedCookieName,
value: devBrowser,
attributes: {
expires,
sameSite: 'Lax',
secure: false,
partitioned: false,
},
},
{
name: unsuffixedCookieName,
value: devBrowser,
attributes: {
expires,
sameSite: 'Lax',
secure: false,
partitioned: false,
},
},
]);
});

it('reads the suffixed cookie before falling back to the unsuffixed cookie', () => {
const cookieHandler = createDevBrowserCookie(cookieSuffix, defaultOptions);

cookieStore.set(unsuffixedCookieName, 'unsuffixed-value');
cookieStore.set(suffixedCookieName, 'suffixed-value');

expect(cookieHandler.get()).toBe('suffixed-value');

cookieStore.delete(suffixedCookieName);

expect(cookieHandler.get()).toBe('unsuffixed-value');
});
});
38 changes: 20 additions & 18 deletions packages/clerk-js/src/core/auth/cookies/devBrowser.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,12 @@ const getCookieAttributes = (options: DevBrowserCookieOptions) => {
return { sameSite, secure, partitioned } as const;
};

const partitionedCookieAttributes = {
sameSite: 'None',
secure: true,
partitioned: true,
} as const;

/**
* Create a long-lived JS cookie to store the dev browser token
* ONLY for development instances.
Expand All@@ -40,33 +46,29 @@ export const createDevBrowserCookie = (

const get = () => suffixedDevBrowserCookie.get() || devBrowserCookie.get();

const removeAll = () => {
const attributes = getCookieAttributes(options);

for (const cookie of [suffixedDevBrowserCookie, devBrowserCookie]) {
cookie.remove(attributes);
cookie.remove();
cookie.remove(partitionedCookieAttributes);
}
};

const set = (devBrowser: string) => {
const expires = addYears(Date.now(), 1);
const { sameSite, secure, partitioned } = getCookieAttributes(options);

// Remove old non-partitioned cookies — the browser treats partitioned and
// non-partitioned cookies with the same name as distinct cookies.
if (partitioned) {
suffixedDevBrowserCookie.remove();
devBrowserCookie.remove();
}
// Remove stale variants before writing. The environment may not be loaded
// yet, so the current partitioned-cookies setting cannot be trusted.
removeAll();

suffixedDevBrowserCookie.set(devBrowser, { expires, sameSite, secure, partitioned });
devBrowserCookie.set(devBrowser, { expires, sameSite, secure, partitioned });
};

const remove = () => {
const attributes = getCookieAttributes(options);
suffixedDevBrowserCookie.remove(attributes);
devBrowserCookie.remove(attributes);

// Also remove non-partitioned variants — the browser treats partitioned and
// non-partitioned cookies with the same name as distinct cookies.
if (attributes.partitioned) {
suffixedDevBrowserCookie.remove();
devBrowserCookie.remove();
}
};
const remove = () => removeAll();

return {
get,
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): dev browser partitioned cookie cleanup by brkalow · Pull Request #8538 · 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/clean-dev-browsers.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Fix dev browser recovery by clearing stale partitioned and non-partitioned dev browser cookie variants before minting a new dev browser.
147 changes: 147 additions & 0 deletions packages/clerk-js/src/core/auth/cookies/__tests__/devBrowser.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,147 @@
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import { createDevBrowserCookie } from '../devBrowser';

const { cookieStore, removeCalls, setCalls } = vi.hoisted(() => ({
cookieStore: new Map<string, string>(),
removeCalls: [] as Array<{ name: string; attributes?: object }>,
setCalls: [] as Array<{ name: string; value: string; attributes?: object }>,
}));

vi.mock('@clerk/shared/cookie', () => ({
createCookieHandler: (name: string) => ({
get: () => cookieStore.get(name),
remove: (attributes?: object) => {
removeCalls.push({ name, attributes });
cookieStore.delete(name);
},
set: (value: string, attributes?: object) => {
setCalls.push({ name, value, attributes });
cookieStore.set(name, value);
},
}),
}));

describe('createDevBrowserCookie', () => {
const cookieSuffix = 'test-suffix';
const suffixedCookieName = '__clerk_db_jwt_test-suffix';
const unsuffixedCookieName = '__clerk_db_jwt';
const devBrowser = 'test-dev-browser';
const now = new Date('2024-01-01T00:00:00.000Z');
const expires = new Date('2025-01-01T00:00:00.000Z');
const defaultOptions = { usePartitionedCookies: () => false };

beforeEach(() => {
vi.useFakeTimers();
vi.setSystemTime(now);
cookieStore.clear();
removeCalls.length = 0;
setCalls.length = 0;
});

afterEach(() => {
vi.useRealTimers();
vi.unstubAllGlobals();
});

it('removes current, non-partitioned, and partitioned cookie variants for both dev browser cookie names', () => {
const cookieHandler = createDevBrowserCookie(cookieSuffix, defaultOptions);

cookieHandler.remove();

expect(removeCalls).toEqual([
{
name: suffixedCookieName,
attributes: {
sameSite: 'Lax',
secure: false,
partitioned: false,
},
},
{ name: suffixedCookieName, attributes: undefined },
{
name: suffixedCookieName,
attributes: {
sameSite: 'None',
secure: true,
partitioned: true,
},
},
{
name: unsuffixedCookieName,
attributes: {
sameSite: 'Lax',
secure: false,
partitioned: false,
},
},
{ name: unsuffixedCookieName, attributes: undefined },
{
name: unsuffixedCookieName,
attributes: {
sameSite: 'None',
secure: true,
partitioned: true,
},
},
]);
});

it('clears stale partitioned cookie variants before writing a new dev browser', () => {
const cookieHandler = createDevBrowserCookie(cookieSuffix, defaultOptions);

cookieHandler.set(devBrowser);

expect(removeCalls).toContainEqual({
name: suffixedCookieName,
attributes: {
sameSite: 'None',
secure: true,
partitioned: true,
},
});
expect(removeCalls).toContainEqual({
name: unsuffixedCookieName,
attributes: {
sameSite: 'None',
secure: true,
partitioned: true,
},
});
expect(setCalls).toEqual([
{
name: suffixedCookieName,
value: devBrowser,
attributes: {
expires,
sameSite: 'Lax',
secure: false,
partitioned: false,
},
},
{
name: unsuffixedCookieName,
value: devBrowser,
attributes: {
expires,
sameSite: 'Lax',
secure: false,
partitioned: false,
},
},
]);
});

it('reads the suffixed cookie before falling back to the unsuffixed cookie', () => {
const cookieHandler = createDevBrowserCookie(cookieSuffix, defaultOptions);

cookieStore.set(unsuffixedCookieName, 'unsuffixed-value');
cookieStore.set(suffixedCookieName, 'suffixed-value');

expect(cookieHandler.get()).toBe('suffixed-value');

cookieStore.delete(suffixedCookieName);

expect(cookieHandler.get()).toBe('unsuffixed-value');
});
});
38 changes: 20 additions & 18 deletions packages/clerk-js/src/core/auth/cookies/devBrowser.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,12 @@ const getCookieAttributes = (options: DevBrowserCookieOptions) => {
return { sameSite, secure, partitioned } as const;
};

const partitionedCookieAttributes = {
sameSite: 'None',
secure: true,
partitioned: true,
} as const;

/**
* Create a long-lived JS cookie to store the dev browser token
* ONLY for development instances.
Expand All@@ -40,33 +46,29 @@ export const createDevBrowserCookie = (

const get = () => suffixedDevBrowserCookie.get() || devBrowserCookie.get();

const removeAll = () => {
const attributes = getCookieAttributes(options);

for (const cookie of [suffixedDevBrowserCookie, devBrowserCookie]) {
cookie.remove(attributes);
cookie.remove();
cookie.remove(partitionedCookieAttributes);
}
};

const set = (devBrowser: string) => {
const expires = addYears(Date.now(), 1);
const { sameSite, secure, partitioned } = getCookieAttributes(options);

// Remove old non-partitioned cookies — the browser treats partitioned and
// non-partitioned cookies with the same name as distinct cookies.
if (partitioned) {
suffixedDevBrowserCookie.remove();
devBrowserCookie.remove();
}
// Remove stale variants before writing. The environment may not be loaded
// yet, so the current partitioned-cookies setting cannot be trusted.
removeAll();

suffixedDevBrowserCookie.set(devBrowser, { expires, sameSite, secure, partitioned });
devBrowserCookie.set(devBrowser, { expires, sameSite, secure, partitioned });
};

const remove = () => {
const attributes = getCookieAttributes(options);
suffixedDevBrowserCookie.remove(attributes);
devBrowserCookie.remove(attributes);

// Also remove non-partitioned variants — the browser treats partitioned and
// non-partitioned cookies with the same name as distinct cookies.
if (attributes.partitioned) {
suffixedDevBrowserCookie.remove();
devBrowserCookie.remove();
}
};
const remove = () => removeAll();

return {
get,
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): dev browser partitioned cookie cleanup by brkalow · Pull Request #8538 · 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/clean-dev-browsers.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Fix dev browser recovery by clearing stale partitioned and non-partitioned dev browser cookie variants before minting a new dev browser.
147 changes: 147 additions & 0 deletions packages/clerk-js/src/core/auth/cookies/__tests__/devBrowser.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,147 @@
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import { createDevBrowserCookie } from '../devBrowser';

const { cookieStore, removeCalls, setCalls } = vi.hoisted(() => ({
cookieStore: new Map<string, string>(),
removeCalls: [] as Array<{ name: string; attributes?: object }>,
setCalls: [] as Array<{ name: string; value: string; attributes?: object }>,
}));

vi.mock('@clerk/shared/cookie', () => ({
createCookieHandler: (name: string) => ({
get: () => cookieStore.get(name),
remove: (attributes?: object) => {
removeCalls.push({ name, attributes });
cookieStore.delete(name);
},
set: (value: string, attributes?: object) => {
setCalls.push({ name, value, attributes });
cookieStore.set(name, value);
},
}),
}));

describe('createDevBrowserCookie', () => {
const cookieSuffix = 'test-suffix';
const suffixedCookieName = '__clerk_db_jwt_test-suffix';
const unsuffixedCookieName = '__clerk_db_jwt';
const devBrowser = 'test-dev-browser';
const now = new Date('2024-01-01T00:00:00.000Z');
const expires = new Date('2025-01-01T00:00:00.000Z');
const defaultOptions = { usePartitionedCookies: () => false };

beforeEach(() => {
vi.useFakeTimers();
vi.setSystemTime(now);
cookieStore.clear();
removeCalls.length = 0;
setCalls.length = 0;
});

afterEach(() => {
vi.useRealTimers();
vi.unstubAllGlobals();
});

it('removes current, non-partitioned, and partitioned cookie variants for both dev browser cookie names', () => {
const cookieHandler = createDevBrowserCookie(cookieSuffix, defaultOptions);

cookieHandler.remove();

expect(removeCalls).toEqual([
{
name: suffixedCookieName,
attributes: {
sameSite: 'Lax',
secure: false,
partitioned: false,
},
},
{ name: suffixedCookieName, attributes: undefined },
{
name: suffixedCookieName,
attributes: {
sameSite: 'None',
secure: true,
partitioned: true,
},
},
{
name: unsuffixedCookieName,
attributes: {
sameSite: 'Lax',
secure: false,
partitioned: false,
},
},
{ name: unsuffixedCookieName, attributes: undefined },
{
name: unsuffixedCookieName,
attributes: {
sameSite: 'None',
secure: true,
partitioned: true,
},
},
]);
});

it('clears stale partitioned cookie variants before writing a new dev browser', () => {
const cookieHandler = createDevBrowserCookie(cookieSuffix, defaultOptions);

cookieHandler.set(devBrowser);

expect(removeCalls).toContainEqual({
name: suffixedCookieName,
attributes: {
sameSite: 'None',
secure: true,
partitioned: true,
},
});
expect(removeCalls).toContainEqual({
name: unsuffixedCookieName,
attributes: {
sameSite: 'None',
secure: true,
partitioned: true,
},
});
expect(setCalls).toEqual([
{
name: suffixedCookieName,
value: devBrowser,
attributes: {
expires,
sameSite: 'Lax',
secure: false,
partitioned: false,
},
},
{
name: unsuffixedCookieName,
value: devBrowser,
attributes: {
expires,
sameSite: 'Lax',
secure: false,
partitioned: false,
},
},
]);
});

it('reads the suffixed cookie before falling back to the unsuffixed cookie', () => {
const cookieHandler = createDevBrowserCookie(cookieSuffix, defaultOptions);

cookieStore.set(unsuffixedCookieName, 'unsuffixed-value');
cookieStore.set(suffixedCookieName, 'suffixed-value');

expect(cookieHandler.get()).toBe('suffixed-value');

cookieStore.delete(suffixedCookieName);

expect(cookieHandler.get()).toBe('unsuffixed-value');
});
});
38 changes: 20 additions & 18 deletions packages/clerk-js/src/core/auth/cookies/devBrowser.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,12 @@ const getCookieAttributes = (options: DevBrowserCookieOptions) => {
return { sameSite, secure, partitioned } as const;
};

const partitionedCookieAttributes = {
sameSite: 'None',
secure: true,
partitioned: true,
} as const;

/**
* Create a long-lived JS cookie to store the dev browser token
* ONLY for development instances.
Expand All@@ -40,33 +46,29 @@ export const createDevBrowserCookie = (

const get = () => suffixedDevBrowserCookie.get() || devBrowserCookie.get();

const removeAll = () => {
const attributes = getCookieAttributes(options);

for (const cookie of [suffixedDevBrowserCookie, devBrowserCookie]) {
cookie.remove(attributes);
cookie.remove();
cookie.remove(partitionedCookieAttributes);
}
};

const set = (devBrowser: string) => {
const expires = addYears(Date.now(), 1);
const { sameSite, secure, partitioned } = getCookieAttributes(options);

// Remove old non-partitioned cookies — the browser treats partitioned and
// non-partitioned cookies with the same name as distinct cookies.
if (partitioned) {
suffixedDevBrowserCookie.remove();
devBrowserCookie.remove();
}
// Remove stale variants before writing. The environment may not be loaded
// yet, so the current partitioned-cookies setting cannot be trusted.
removeAll();

suffixedDevBrowserCookie.set(devBrowser, { expires, sameSite, secure, partitioned });
devBrowserCookie.set(devBrowser, { expires, sameSite, secure, partitioned });
};

const remove = () => {
const attributes = getCookieAttributes(options);
suffixedDevBrowserCookie.remove(attributes);
devBrowserCookie.remove(attributes);

// Also remove non-partitioned variants — the browser treats partitioned and
// non-partitioned cookies with the same name as distinct cookies.
if (attributes.partitioned) {
suffixedDevBrowserCookie.remove();
devBrowserCookie.remove();
}
};
const remove = () => removeAll();

return {
get,
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): dev browser partitioned cookie cleanup by brkalow · Pull Request #8538 · 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/clean-dev-browsers.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Fix dev browser recovery by clearing stale partitioned and non-partitioned dev browser cookie variants before minting a new dev browser.
147 changes: 147 additions & 0 deletions packages/clerk-js/src/core/auth/cookies/__tests__/devBrowser.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,147 @@
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import { createDevBrowserCookie } from '../devBrowser';

const { cookieStore, removeCalls, setCalls } = vi.hoisted(() => ({
cookieStore: new Map<string, string>(),
removeCalls: [] as Array<{ name: string; attributes?: object }>,
setCalls: [] as Array<{ name: string; value: string; attributes?: object }>,
}));

vi.mock('@clerk/shared/cookie', () => ({
createCookieHandler: (name: string) => ({
get: () => cookieStore.get(name),
remove: (attributes?: object) => {
removeCalls.push({ name, attributes });
cookieStore.delete(name);
},
set: (value: string, attributes?: object) => {
setCalls.push({ name, value, attributes });
cookieStore.set(name, value);
},
}),
}));

describe('createDevBrowserCookie', () => {
const cookieSuffix = 'test-suffix';
const suffixedCookieName = '__clerk_db_jwt_test-suffix';
const unsuffixedCookieName = '__clerk_db_jwt';
const devBrowser = 'test-dev-browser';
const now = new Date('2024-01-01T00:00:00.000Z');
const expires = new Date('2025-01-01T00:00:00.000Z');
const defaultOptions = { usePartitionedCookies: () => false };

beforeEach(() => {
vi.useFakeTimers();
vi.setSystemTime(now);
cookieStore.clear();
removeCalls.length = 0;
setCalls.length = 0;
});

afterEach(() => {
vi.useRealTimers();
vi.unstubAllGlobals();
});

it('removes current, non-partitioned, and partitioned cookie variants for both dev browser cookie names', () => {
const cookieHandler = createDevBrowserCookie(cookieSuffix, defaultOptions);

cookieHandler.remove();

expect(removeCalls).toEqual([
{
name: suffixedCookieName,
attributes: {
sameSite: 'Lax',
secure: false,
partitioned: false,
},
},
{ name: suffixedCookieName, attributes: undefined },
{
name: suffixedCookieName,
attributes: {
sameSite: 'None',
secure: true,
partitioned: true,
},
},
{
name: unsuffixedCookieName,
attributes: {
sameSite: 'Lax',
secure: false,
partitioned: false,
},
},
{ name: unsuffixedCookieName, attributes: undefined },
{
name: unsuffixedCookieName,
attributes: {
sameSite: 'None',
secure: true,
partitioned: true,
},
},
]);
});

it('clears stale partitioned cookie variants before writing a new dev browser', () => {
const cookieHandler = createDevBrowserCookie(cookieSuffix, defaultOptions);

cookieHandler.set(devBrowser);

expect(removeCalls).toContainEqual({
name: suffixedCookieName,
attributes: {
sameSite: 'None',
secure: true,
partitioned: true,
},
});
expect(removeCalls).toContainEqual({
name: unsuffixedCookieName,
attributes: {
sameSite: 'None',
secure: true,
partitioned: true,
},
});
expect(setCalls).toEqual([
{
name: suffixedCookieName,
value: devBrowser,
attributes: {
expires,
sameSite: 'Lax',
secure: false,
partitioned: false,
},
},
{
name: unsuffixedCookieName,
value: devBrowser,
attributes: {
expires,
sameSite: 'Lax',
secure: false,
partitioned: false,
},
},
]);
});

it('reads the suffixed cookie before falling back to the unsuffixed cookie', () => {
const cookieHandler = createDevBrowserCookie(cookieSuffix, defaultOptions);

cookieStore.set(unsuffixedCookieName, 'unsuffixed-value');
cookieStore.set(suffixedCookieName, 'suffixed-value');

expect(cookieHandler.get()).toBe('suffixed-value');

cookieStore.delete(suffixedCookieName);

expect(cookieHandler.get()).toBe('unsuffixed-value');
});
});
38 changes: 20 additions & 18 deletions packages/clerk-js/src/core/auth/cookies/devBrowser.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,12 @@ const getCookieAttributes = (options: DevBrowserCookieOptions) => {
return { sameSite, secure, partitioned } as const;
};

const partitionedCookieAttributes = {
sameSite: 'None',
secure: true,
partitioned: true,
} as const;

/**
* Create a long-lived JS cookie to store the dev browser token
* ONLY for development instances.
Expand All@@ -40,33 +46,29 @@ export const createDevBrowserCookie = (

const get = () => suffixedDevBrowserCookie.get() || devBrowserCookie.get();

const removeAll = () => {
const attributes = getCookieAttributes(options);

for (const cookie of [suffixedDevBrowserCookie, devBrowserCookie]) {
cookie.remove(attributes);
cookie.remove();
cookie.remove(partitionedCookieAttributes);
}
};

const set = (devBrowser: string) => {
const expires = addYears(Date.now(), 1);
const { sameSite, secure, partitioned } = getCookieAttributes(options);

// Remove old non-partitioned cookies — the browser treats partitioned and
// non-partitioned cookies with the same name as distinct cookies.
if (partitioned) {
suffixedDevBrowserCookie.remove();
devBrowserCookie.remove();
}
// Remove stale variants before writing. The environment may not be loaded
// yet, so the current partitioned-cookies setting cannot be trusted.
removeAll();

suffixedDevBrowserCookie.set(devBrowser, { expires, sameSite, secure, partitioned });
devBrowserCookie.set(devBrowser, { expires, sameSite, secure, partitioned });
};

const remove = () => {
const attributes = getCookieAttributes(options);
suffixedDevBrowserCookie.remove(attributes);
devBrowserCookie.remove(attributes);

// Also remove non-partitioned variants — the browser treats partitioned and
// non-partitioned cookies with the same name as distinct cookies.
if (attributes.partitioned) {
suffixedDevBrowserCookie.remove();
devBrowserCookie.remove();
}
};
const remove = () => removeAll();

return {
get,
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): dev browser partitioned cookie cleanup by brkalow · Pull Request #8538 · 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/clean-dev-browsers.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Fix dev browser recovery by clearing stale partitioned and non-partitioned dev browser cookie variants before minting a new dev browser.
147 changes: 147 additions & 0 deletions packages/clerk-js/src/core/auth/cookies/__tests__/devBrowser.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,147 @@
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import { createDevBrowserCookie } from '../devBrowser';

const { cookieStore, removeCalls, setCalls } = vi.hoisted(() => ({
cookieStore: new Map<string, string>(),
removeCalls: [] as Array<{ name: string; attributes?: object }>,
setCalls: [] as Array<{ name: string; value: string; attributes?: object }>,
}));

vi.mock('@clerk/shared/cookie', () => ({
createCookieHandler: (name: string) => ({
get: () => cookieStore.get(name),
remove: (attributes?: object) => {
removeCalls.push({ name, attributes });
cookieStore.delete(name);
},
set: (value: string, attributes?: object) => {
setCalls.push({ name, value, attributes });
cookieStore.set(name, value);
},
}),
}));

describe('createDevBrowserCookie', () => {
const cookieSuffix = 'test-suffix';
const suffixedCookieName = '__clerk_db_jwt_test-suffix';
const unsuffixedCookieName = '__clerk_db_jwt';
const devBrowser = 'test-dev-browser';
const now = new Date('2024-01-01T00:00:00.000Z');
const expires = new Date('2025-01-01T00:00:00.000Z');
const defaultOptions = { usePartitionedCookies: () => false };

beforeEach(() => {
vi.useFakeTimers();
vi.setSystemTime(now);
cookieStore.clear();
removeCalls.length = 0;
setCalls.length = 0;
});

afterEach(() => {
vi.useRealTimers();
vi.unstubAllGlobals();
});

it('removes current, non-partitioned, and partitioned cookie variants for both dev browser cookie names', () => {
const cookieHandler = createDevBrowserCookie(cookieSuffix, defaultOptions);

cookieHandler.remove();

expect(removeCalls).toEqual([
{
name: suffixedCookieName,
attributes: {
sameSite: 'Lax',
secure: false,
partitioned: false,
},
},
{ name: suffixedCookieName, attributes: undefined },
{
name: suffixedCookieName,
attributes: {
sameSite: 'None',
secure: true,
partitioned: true,
},
},
{
name: unsuffixedCookieName,
attributes: {
sameSite: 'Lax',
secure: false,
partitioned: false,
},
},
{ name: unsuffixedCookieName, attributes: undefined },
{
name: unsuffixedCookieName,
attributes: {
sameSite: 'None',
secure: true,
partitioned: true,
},
},
]);
});

it('clears stale partitioned cookie variants before writing a new dev browser', () => {
const cookieHandler = createDevBrowserCookie(cookieSuffix, defaultOptions);

cookieHandler.set(devBrowser);

expect(removeCalls).toContainEqual({
name: suffixedCookieName,
attributes: {
sameSite: 'None',
secure: true,
partitioned: true,
},
});
expect(removeCalls).toContainEqual({
name: unsuffixedCookieName,
attributes: {
sameSite: 'None',
secure: true,
partitioned: true,
},
});
expect(setCalls).toEqual([
{
name: suffixedCookieName,
value: devBrowser,
attributes: {
expires,
sameSite: 'Lax',
secure: false,
partitioned: false,
},
},
{
name: unsuffixedCookieName,
value: devBrowser,
attributes: {
expires,
sameSite: 'Lax',
secure: false,
partitioned: false,
},
},
]);
});

it('reads the suffixed cookie before falling back to the unsuffixed cookie', () => {
const cookieHandler = createDevBrowserCookie(cookieSuffix, defaultOptions);

cookieStore.set(unsuffixedCookieName, 'unsuffixed-value');
cookieStore.set(suffixedCookieName, 'suffixed-value');

expect(cookieHandler.get()).toBe('suffixed-value');

cookieStore.delete(suffixedCookieName);

expect(cookieHandler.get()).toBe('unsuffixed-value');
});
});
38 changes: 20 additions & 18 deletions packages/clerk-js/src/core/auth/cookies/devBrowser.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,12 @@ const getCookieAttributes = (options: DevBrowserCookieOptions) => {
return { sameSite, secure, partitioned } as const;
};

const partitionedCookieAttributes = {
sameSite: 'None',
secure: true,
partitioned: true,
} as const;

/**
* Create a long-lived JS cookie to store the dev browser token
* ONLY for development instances.
Expand All@@ -40,33 +46,29 @@ export const createDevBrowserCookie = (

const get = () => suffixedDevBrowserCookie.get() || devBrowserCookie.get();

const removeAll = () => {
const attributes = getCookieAttributes(options);

for (const cookie of [suffixedDevBrowserCookie, devBrowserCookie]) {
cookie.remove(attributes);
cookie.remove();
cookie.remove(partitionedCookieAttributes);
}
};

const set = (devBrowser: string) => {
const expires = addYears(Date.now(), 1);
const { sameSite, secure, partitioned } = getCookieAttributes(options);

// Remove old non-partitioned cookies — the browser treats partitioned and
// non-partitioned cookies with the same name as distinct cookies.
if (partitioned) {
suffixedDevBrowserCookie.remove();
devBrowserCookie.remove();
}
// Remove stale variants before writing. The environment may not be loaded
// yet, so the current partitioned-cookies setting cannot be trusted.
removeAll();

suffixedDevBrowserCookie.set(devBrowser, { expires, sameSite, secure, partitioned });
devBrowserCookie.set(devBrowser, { expires, sameSite, secure, partitioned });
};

const remove = () => {
const attributes = getCookieAttributes(options);
suffixedDevBrowserCookie.remove(attributes);
devBrowserCookie.remove(attributes);

// Also remove non-partitioned variants — the browser treats partitioned and
// non-partitioned cookies with the same name as distinct cookies.
if (attributes.partitioned) {
suffixedDevBrowserCookie.remove();
devBrowserCookie.remove();
}
};
const remove = () => removeAll();

return {
get,
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): dev browser partitioned cookie cleanup by brkalow · Pull Request #8538 · 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/clean-dev-browsers.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Fix dev browser recovery by clearing stale partitioned and non-partitioned dev browser cookie variants before minting a new dev browser.
147 changes: 147 additions & 0 deletions packages/clerk-js/src/core/auth/cookies/__tests__/devBrowser.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,147 @@
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import { createDevBrowserCookie } from '../devBrowser';

const { cookieStore, removeCalls, setCalls } = vi.hoisted(() => ({
cookieStore: new Map<string, string>(),
removeCalls: [] as Array<{ name: string; attributes?: object }>,
setCalls: [] as Array<{ name: string; value: string; attributes?: object }>,
}));

vi.mock('@clerk/shared/cookie', () => ({
createCookieHandler: (name: string) => ({
get: () => cookieStore.get(name),
remove: (attributes?: object) => {
removeCalls.push({ name, attributes });
cookieStore.delete(name);
},
set: (value: string, attributes?: object) => {
setCalls.push({ name, value, attributes });
cookieStore.set(name, value);
},
}),
}));

describe('createDevBrowserCookie', () => {
const cookieSuffix = 'test-suffix';
const suffixedCookieName = '__clerk_db_jwt_test-suffix';
const unsuffixedCookieName = '__clerk_db_jwt';
const devBrowser = 'test-dev-browser';
const now = new Date('2024-01-01T00:00:00.000Z');
const expires = new Date('2025-01-01T00:00:00.000Z');
const defaultOptions = { usePartitionedCookies: () => false };

beforeEach(() => {
vi.useFakeTimers();
vi.setSystemTime(now);
cookieStore.clear();
removeCalls.length = 0;
setCalls.length = 0;
});

afterEach(() => {
vi.useRealTimers();
vi.unstubAllGlobals();
});

it('removes current, non-partitioned, and partitioned cookie variants for both dev browser cookie names', () => {
const cookieHandler = createDevBrowserCookie(cookieSuffix, defaultOptions);

cookieHandler.remove();

expect(removeCalls).toEqual([
{
name: suffixedCookieName,
attributes: {
sameSite: 'Lax',
secure: false,
partitioned: false,
},
},
{ name: suffixedCookieName, attributes: undefined },
{
name: suffixedCookieName,
attributes: {
sameSite: 'None',
secure: true,
partitioned: true,
},
},
{
name: unsuffixedCookieName,
attributes: {
sameSite: 'Lax',
secure: false,
partitioned: false,
},
},
{ name: unsuffixedCookieName, attributes: undefined },
{
name: unsuffixedCookieName,
attributes: {
sameSite: 'None',
secure: true,
partitioned: true,
},
},
]);
});

it('clears stale partitioned cookie variants before writing a new dev browser', () => {
const cookieHandler = createDevBrowserCookie(cookieSuffix, defaultOptions);

cookieHandler.set(devBrowser);

expect(removeCalls).toContainEqual({
name: suffixedCookieName,
attributes: {
sameSite: 'None',
secure: true,
partitioned: true,
},
});
expect(removeCalls).toContainEqual({
name: unsuffixedCookieName,
attributes: {
sameSite: 'None',
secure: true,
partitioned: true,
},
});
expect(setCalls).toEqual([
{
name: suffixedCookieName,
value: devBrowser,
attributes: {
expires,
sameSite: 'Lax',
secure: false,
partitioned: false,
},
},
{
name: unsuffixedCookieName,
value: devBrowser,
attributes: {
expires,
sameSite: 'Lax',
secure: false,
partitioned: false,
},
},
]);
});

it('reads the suffixed cookie before falling back to the unsuffixed cookie', () => {
const cookieHandler = createDevBrowserCookie(cookieSuffix, defaultOptions);

cookieStore.set(unsuffixedCookieName, 'unsuffixed-value');
cookieStore.set(suffixedCookieName, 'suffixed-value');

expect(cookieHandler.get()).toBe('suffixed-value');

cookieStore.delete(suffixedCookieName);

expect(cookieHandler.get()).toBe('unsuffixed-value');
});
});
38 changes: 20 additions & 18 deletions packages/clerk-js/src/core/auth/cookies/devBrowser.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,12 @@ const getCookieAttributes = (options: DevBrowserCookieOptions) => {
return { sameSite, secure, partitioned } as const;
};

const partitionedCookieAttributes = {
sameSite: 'None',
secure: true,
partitioned: true,
} as const;

/**
* Create a long-lived JS cookie to store the dev browser token
* ONLY for development instances.
Expand All@@ -40,33 +46,29 @@ export const createDevBrowserCookie = (

const get = () => suffixedDevBrowserCookie.get() || devBrowserCookie.get();

const removeAll = () => {
const attributes = getCookieAttributes(options);

for (const cookie of [suffixedDevBrowserCookie, devBrowserCookie]) {
cookie.remove(attributes);
cookie.remove();
cookie.remove(partitionedCookieAttributes);
}
};

const set = (devBrowser: string) => {
const expires = addYears(Date.now(), 1);
const { sameSite, secure, partitioned } = getCookieAttributes(options);

// Remove old non-partitioned cookies — the browser treats partitioned and
// non-partitioned cookies with the same name as distinct cookies.
if (partitioned) {
suffixedDevBrowserCookie.remove();
devBrowserCookie.remove();
}
// Remove stale variants before writing. The environment may not be loaded
// yet, so the current partitioned-cookies setting cannot be trusted.
removeAll();

suffixedDevBrowserCookie.set(devBrowser, { expires, sameSite, secure, partitioned });
devBrowserCookie.set(devBrowser, { expires, sameSite, secure, partitioned });
};

const remove = () => {
const attributes = getCookieAttributes(options);
suffixedDevBrowserCookie.remove(attributes);
devBrowserCookie.remove(attributes);

// Also remove non-partitioned variants — the browser treats partitioned and
// non-partitioned cookies with the same name as distinct cookies.
if (attributes.partitioned) {
suffixedDevBrowserCookie.remove();
devBrowserCookie.remove();
}
};
const remove = () => removeAll();

return {
get,
Expand Down
Loading