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

Prevent a cross-tab broadcast failure from evicting a freshly cached session token. Previously, if broadcasting a token update to other tabs threw (for example when the `BroadcastChannel` was racing a close), the token that was just cached got dropped and the next `getToken()` made an unnecessary network request. The broadcast is now isolated so a failure no longer discards a valid cached token.
36 changes: 36 additions & 0 deletions packages/clerk-js/src/core/__tests__/tokenCache.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -506,6 +506,42 @@ describe('SessionTokenCache', () => {
});
});

describe('broadcast resilience', () => {
it('a failing postMessage does not evict the freshly cached token', async () => {
// A broadcast failure (postMessage throwing, e.g. InvalidStateError when the
// channel races a close) is a side effect that must not evict the freshly
// cached token or force an unnecessary refetch (SDK-119).
mockBroadcastChannel.postMessage.mockImplementationOnce(() => {
throw new Error('channel closed');
});

const futureExp = Math.floor(Date.now() / 1000) + 3600;
const tokenResolver = Promise.resolve({
getRawString: () => mockJwt,
jwt: { claims: { exp: futureExp, iat: 1675876730, sid: 'session_123' } },
} as any);

expect(() =>
SessionTokenCache.set({
tokenId: 'session_123',
tokenResolver,
}),
).not.toThrow();

await tokenResolver;
// Flush the cache write's .then (broadcast) and .catch microtasks. Fake timers
// are active in this suite, so flush microtasks rather than using a setTimeout.
for (let i = 0; i < 5; i++) {
await Promise.resolve();
}

// The broadcast was attempted and threw, but the token must stay cached.
expect(mockBroadcastChannel.postMessage).toHaveBeenCalledTimes(1);
expect(SessionTokenCache.size()).toBe(1);
expect(SessionTokenCache.get({ tokenId: 'session_123' })).toBeDefined();
});
});

describe('clear()', () => {
it('removes all entries and clears timeouts', async () => {
const futureExp = Math.floor(Date.now() / 1000) + 3600;
Expand Down
66 changes: 38 additions & 28 deletions packages/clerk-js/src/core/tokenCache.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -433,40 +433,50 @@ const MemoryTokenCache = (prefix = KEY_PREFIX): TokenCache => {

const channel = broadcastChannel;
if (channel && options.broadcast) {
const tokenRaw = newToken.getRawString();
if (tokenRaw && claims.sid) {
const sessionId = claims.sid;
const organizationId = claims.org_id || (claims.o as any)?.id;
const template = TokenId.extractTemplate(entry.tokenId, sessionId, organizationId);

const expectedTokenId = TokenId.build(sessionId, template, organizationId);
if (entry.tokenId === expectedTokenId) {
const traceId = `bc_${Date.now()}_${Math.random().toString(36).substring(2, 11)}`;

debugLogger.info(
'Broadcasting token update to other tabs',
{
// Best-effort side effect: a broadcast failure (e.g. postMessage racing a
// channel close) must not reach the outer catch and evict the cached token (SDK-119).
try {
const tokenRaw = newToken.getRawString();
if (tokenRaw && claims.sid) {
const sessionId = claims.sid;
const organizationId = claims.org_id || (claims.o as any)?.id;
const template = TokenId.extractTemplate(entry.tokenId, sessionId, organizationId);

const expectedTokenId = TokenId.build(sessionId, template, organizationId);
if (entry.tokenId === expectedTokenId) {
const traceId = `bc_${Date.now()}_${Math.random().toString(36).substring(2, 11)}`;

debugLogger.info(
'Broadcasting token update to other tabs',
{
organizationId,
sessionId,
tabId,
template,
tokenId: entry.tokenId,
traceId,
},
'tokenCache',
);

const message: SessionTokenEvent = {
organizationId,
sessionId,
tabId,
template,
tokenId: entry.tokenId,
tokenRaw,
traceId,
},
'tokenCache',
);

const message: SessionTokenEvent = {
organizationId,
sessionId,
template,
tokenId: entry.tokenId,
tokenRaw,
traceId,
};

channel.postMessage(message);
};

channel.postMessage(message);
}
}
} catch (error) {
debugLogger.warn(
'Failed to broadcast token update to other tabs',
{ error, tabId, tokenId: entry.tokenId },
'tokenCache',
);
}
}
})
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): prevent broadcast failure from evicting a cached session token by jacekradko · Pull Request #8969 · 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/tokencache-broadcast-eviction.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Prevent a cross-tab broadcast failure from evicting a freshly cached session token. Previously, if broadcasting a token update to other tabs threw (for example when the `BroadcastChannel` was racing a close), the token that was just cached got dropped and the next `getToken()` made an unnecessary network request. The broadcast is now isolated so a failure no longer discards a valid cached token.
36 changes: 36 additions & 0 deletions packages/clerk-js/src/core/__tests__/tokenCache.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -506,6 +506,42 @@ describe('SessionTokenCache', () => {
});
});

describe('broadcast resilience', () => {
it('a failing postMessage does not evict the freshly cached token', async () => {
// A broadcast failure (postMessage throwing, e.g. InvalidStateError when the
// channel races a close) is a side effect that must not evict the freshly
// cached token or force an unnecessary refetch (SDK-119).
mockBroadcastChannel.postMessage.mockImplementationOnce(() => {
throw new Error('channel closed');
});

const futureExp = Math.floor(Date.now() / 1000) + 3600;
const tokenResolver = Promise.resolve({
getRawString: () => mockJwt,
jwt: { claims: { exp: futureExp, iat: 1675876730, sid: 'session_123' } },
} as any);

expect(() =>
SessionTokenCache.set({
tokenId: 'session_123',
tokenResolver,
}),
).not.toThrow();

await tokenResolver;
// Flush the cache write's .then (broadcast) and .catch microtasks. Fake timers
// are active in this suite, so flush microtasks rather than using a setTimeout.
for (let i = 0; i < 5; i++) {
await Promise.resolve();
}

// The broadcast was attempted and threw, but the token must stay cached.
expect(mockBroadcastChannel.postMessage).toHaveBeenCalledTimes(1);
expect(SessionTokenCache.size()).toBe(1);
expect(SessionTokenCache.get({ tokenId: 'session_123' })).toBeDefined();
});
});

describe('clear()', () => {
it('removes all entries and clears timeouts', async () => {
const futureExp = Math.floor(Date.now() / 1000) + 3600;
Expand Down
66 changes: 38 additions & 28 deletions packages/clerk-js/src/core/tokenCache.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -433,40 +433,50 @@ const MemoryTokenCache = (prefix = KEY_PREFIX): TokenCache => {

const channel = broadcastChannel;
if (channel && options.broadcast) {
const tokenRaw = newToken.getRawString();
if (tokenRaw && claims.sid) {
const sessionId = claims.sid;
const organizationId = claims.org_id || (claims.o as any)?.id;
const template = TokenId.extractTemplate(entry.tokenId, sessionId, organizationId);

const expectedTokenId = TokenId.build(sessionId, template, organizationId);
if (entry.tokenId === expectedTokenId) {
const traceId = `bc_${Date.now()}_${Math.random().toString(36).substring(2, 11)}`;

debugLogger.info(
'Broadcasting token update to other tabs',
{
// Best-effort side effect: a broadcast failure (e.g. postMessage racing a
// channel close) must not reach the outer catch and evict the cached token (SDK-119).
try {
const tokenRaw = newToken.getRawString();
if (tokenRaw && claims.sid) {
const sessionId = claims.sid;
const organizationId = claims.org_id || (claims.o as any)?.id;
const template = TokenId.extractTemplate(entry.tokenId, sessionId, organizationId);

const expectedTokenId = TokenId.build(sessionId, template, organizationId);
if (entry.tokenId === expectedTokenId) {
const traceId = `bc_${Date.now()}_${Math.random().toString(36).substring(2, 11)}`;

debugLogger.info(
'Broadcasting token update to other tabs',
{
organizationId,
sessionId,
tabId,
template,
tokenId: entry.tokenId,
traceId,
},
'tokenCache',
);

const message: SessionTokenEvent = {
organizationId,
sessionId,
tabId,
template,
tokenId: entry.tokenId,
tokenRaw,
traceId,
},
'tokenCache',
);

const message: SessionTokenEvent = {
organizationId,
sessionId,
template,
tokenId: entry.tokenId,
tokenRaw,
traceId,
};

channel.postMessage(message);
};

channel.postMessage(message);
}
}
} catch (error) {
debugLogger.warn(
'Failed to broadcast token update to other tabs',
{ error, tabId, tokenId: entry.tokenId },
'tokenCache',
);
}
}
})
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): prevent broadcast failure from evicting a cached session token by jacekradko · Pull Request #8969 · 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/tokencache-broadcast-eviction.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Prevent a cross-tab broadcast failure from evicting a freshly cached session token. Previously, if broadcasting a token update to other tabs threw (for example when the `BroadcastChannel` was racing a close), the token that was just cached got dropped and the next `getToken()` made an unnecessary network request. The broadcast is now isolated so a failure no longer discards a valid cached token.
36 changes: 36 additions & 0 deletions packages/clerk-js/src/core/__tests__/tokenCache.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -506,6 +506,42 @@ describe('SessionTokenCache', () => {
});
});

describe('broadcast resilience', () => {
it('a failing postMessage does not evict the freshly cached token', async () => {
// A broadcast failure (postMessage throwing, e.g. InvalidStateError when the
// channel races a close) is a side effect that must not evict the freshly
// cached token or force an unnecessary refetch (SDK-119).
mockBroadcastChannel.postMessage.mockImplementationOnce(() => {
throw new Error('channel closed');
});

const futureExp = Math.floor(Date.now() / 1000) + 3600;
const tokenResolver = Promise.resolve({
getRawString: () => mockJwt,
jwt: { claims: { exp: futureExp, iat: 1675876730, sid: 'session_123' } },
} as any);

expect(() =>
SessionTokenCache.set({
tokenId: 'session_123',
tokenResolver,
}),
).not.toThrow();

await tokenResolver;
// Flush the cache write's .then (broadcast) and .catch microtasks. Fake timers
// are active in this suite, so flush microtasks rather than using a setTimeout.
for (let i = 0; i < 5; i++) {
await Promise.resolve();
}

// The broadcast was attempted and threw, but the token must stay cached.
expect(mockBroadcastChannel.postMessage).toHaveBeenCalledTimes(1);
expect(SessionTokenCache.size()).toBe(1);
expect(SessionTokenCache.get({ tokenId: 'session_123' })).toBeDefined();
});
});

describe('clear()', () => {
it('removes all entries and clears timeouts', async () => {
const futureExp = Math.floor(Date.now() / 1000) + 3600;
Expand Down
66 changes: 38 additions & 28 deletions packages/clerk-js/src/core/tokenCache.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -433,40 +433,50 @@ const MemoryTokenCache = (prefix = KEY_PREFIX): TokenCache => {

const channel = broadcastChannel;
if (channel && options.broadcast) {
const tokenRaw = newToken.getRawString();
if (tokenRaw && claims.sid) {
const sessionId = claims.sid;
const organizationId = claims.org_id || (claims.o as any)?.id;
const template = TokenId.extractTemplate(entry.tokenId, sessionId, organizationId);

const expectedTokenId = TokenId.build(sessionId, template, organizationId);
if (entry.tokenId === expectedTokenId) {
const traceId = `bc_${Date.now()}_${Math.random().toString(36).substring(2, 11)}`;

debugLogger.info(
'Broadcasting token update to other tabs',
{
// Best-effort side effect: a broadcast failure (e.g. postMessage racing a
// channel close) must not reach the outer catch and evict the cached token (SDK-119).
try {
const tokenRaw = newToken.getRawString();
if (tokenRaw && claims.sid) {
const sessionId = claims.sid;
const organizationId = claims.org_id || (claims.o as any)?.id;
const template = TokenId.extractTemplate(entry.tokenId, sessionId, organizationId);

const expectedTokenId = TokenId.build(sessionId, template, organizationId);
if (entry.tokenId === expectedTokenId) {
const traceId = `bc_${Date.now()}_${Math.random().toString(36).substring(2, 11)}`;

debugLogger.info(
'Broadcasting token update to other tabs',
{
organizationId,
sessionId,
tabId,
template,
tokenId: entry.tokenId,
traceId,
},
'tokenCache',
);

const message: SessionTokenEvent = {
organizationId,
sessionId,
tabId,
template,
tokenId: entry.tokenId,
tokenRaw,
traceId,
},
'tokenCache',
);

const message: SessionTokenEvent = {
organizationId,
sessionId,
template,
tokenId: entry.tokenId,
tokenRaw,
traceId,
};

channel.postMessage(message);
};

channel.postMessage(message);
}
}
} catch (error) {
debugLogger.warn(
'Failed to broadcast token update to other tabs',
{ error, tabId, tokenId: entry.tokenId },
'tokenCache',
);
}
}
})
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): prevent broadcast failure from evicting a cached session token by jacekradko · Pull Request #8969 · 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/tokencache-broadcast-eviction.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Prevent a cross-tab broadcast failure from evicting a freshly cached session token. Previously, if broadcasting a token update to other tabs threw (for example when the `BroadcastChannel` was racing a close), the token that was just cached got dropped and the next `getToken()` made an unnecessary network request. The broadcast is now isolated so a failure no longer discards a valid cached token.
36 changes: 36 additions & 0 deletions packages/clerk-js/src/core/__tests__/tokenCache.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -506,6 +506,42 @@ describe('SessionTokenCache', () => {
});
});

describe('broadcast resilience', () => {
it('a failing postMessage does not evict the freshly cached token', async () => {
// A broadcast failure (postMessage throwing, e.g. InvalidStateError when the
// channel races a close) is a side effect that must not evict the freshly
// cached token or force an unnecessary refetch (SDK-119).
mockBroadcastChannel.postMessage.mockImplementationOnce(() => {
throw new Error('channel closed');
});

const futureExp = Math.floor(Date.now() / 1000) + 3600;
const tokenResolver = Promise.resolve({
getRawString: () => mockJwt,
jwt: { claims: { exp: futureExp, iat: 1675876730, sid: 'session_123' } },
} as any);

expect(() =>
SessionTokenCache.set({
tokenId: 'session_123',
tokenResolver,
}),
).not.toThrow();

await tokenResolver;
// Flush the cache write's .then (broadcast) and .catch microtasks. Fake timers
// are active in this suite, so flush microtasks rather than using a setTimeout.
for (let i = 0; i < 5; i++) {
await Promise.resolve();
}

// The broadcast was attempted and threw, but the token must stay cached.
expect(mockBroadcastChannel.postMessage).toHaveBeenCalledTimes(1);
expect(SessionTokenCache.size()).toBe(1);
expect(SessionTokenCache.get({ tokenId: 'session_123' })).toBeDefined();
});
});

describe('clear()', () => {
it('removes all entries and clears timeouts', async () => {
const futureExp = Math.floor(Date.now() / 1000) + 3600;
Expand Down
66 changes: 38 additions & 28 deletions packages/clerk-js/src/core/tokenCache.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -433,40 +433,50 @@ const MemoryTokenCache = (prefix = KEY_PREFIX): TokenCache => {

const channel = broadcastChannel;
if (channel && options.broadcast) {
const tokenRaw = newToken.getRawString();
if (tokenRaw && claims.sid) {
const sessionId = claims.sid;
const organizationId = claims.org_id || (claims.o as any)?.id;
const template = TokenId.extractTemplate(entry.tokenId, sessionId, organizationId);

const expectedTokenId = TokenId.build(sessionId, template, organizationId);
if (entry.tokenId === expectedTokenId) {
const traceId = `bc_${Date.now()}_${Math.random().toString(36).substring(2, 11)}`;

debugLogger.info(
'Broadcasting token update to other tabs',
{
// Best-effort side effect: a broadcast failure (e.g. postMessage racing a
// channel close) must not reach the outer catch and evict the cached token (SDK-119).
try {
const tokenRaw = newToken.getRawString();
if (tokenRaw && claims.sid) {
const sessionId = claims.sid;
const organizationId = claims.org_id || (claims.o as any)?.id;
const template = TokenId.extractTemplate(entry.tokenId, sessionId, organizationId);

const expectedTokenId = TokenId.build(sessionId, template, organizationId);
if (entry.tokenId === expectedTokenId) {
const traceId = `bc_${Date.now()}_${Math.random().toString(36).substring(2, 11)}`;

debugLogger.info(
'Broadcasting token update to other tabs',
{
organizationId,
sessionId,
tabId,
template,
tokenId: entry.tokenId,
traceId,
},
'tokenCache',
);

const message: SessionTokenEvent = {
organizationId,
sessionId,
tabId,
template,
tokenId: entry.tokenId,
tokenRaw,
traceId,
},
'tokenCache',
);

const message: SessionTokenEvent = {
organizationId,
sessionId,
template,
tokenId: entry.tokenId,
tokenRaw,
traceId,
};

channel.postMessage(message);
};

channel.postMessage(message);
}
}
} catch (error) {
debugLogger.warn(
'Failed to broadcast token update to other tabs',
{ error, tabId, tokenId: entry.tokenId },
'tokenCache',
);
}
}
})
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): prevent broadcast failure from evicting a cached session token by jacekradko · Pull Request #8969 · 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/tokencache-broadcast-eviction.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Prevent a cross-tab broadcast failure from evicting a freshly cached session token. Previously, if broadcasting a token update to other tabs threw (for example when the `BroadcastChannel` was racing a close), the token that was just cached got dropped and the next `getToken()` made an unnecessary network request. The broadcast is now isolated so a failure no longer discards a valid cached token.
36 changes: 36 additions & 0 deletions packages/clerk-js/src/core/__tests__/tokenCache.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -506,6 +506,42 @@ describe('SessionTokenCache', () => {
});
});

describe('broadcast resilience', () => {
it('a failing postMessage does not evict the freshly cached token', async () => {
// A broadcast failure (postMessage throwing, e.g. InvalidStateError when the
// channel races a close) is a side effect that must not evict the freshly
// cached token or force an unnecessary refetch (SDK-119).
mockBroadcastChannel.postMessage.mockImplementationOnce(() => {
throw new Error('channel closed');
});

const futureExp = Math.floor(Date.now() / 1000) + 3600;
const tokenResolver = Promise.resolve({
getRawString: () => mockJwt,
jwt: { claims: { exp: futureExp, iat: 1675876730, sid: 'session_123' } },
} as any);

expect(() =>
SessionTokenCache.set({
tokenId: 'session_123',
tokenResolver,
}),
).not.toThrow();

await tokenResolver;
// Flush the cache write's .then (broadcast) and .catch microtasks. Fake timers
// are active in this suite, so flush microtasks rather than using a setTimeout.
for (let i = 0; i < 5; i++) {
await Promise.resolve();
}

// The broadcast was attempted and threw, but the token must stay cached.
expect(mockBroadcastChannel.postMessage).toHaveBeenCalledTimes(1);
expect(SessionTokenCache.size()).toBe(1);
expect(SessionTokenCache.get({ tokenId: 'session_123' })).toBeDefined();
});
});

describe('clear()', () => {
it('removes all entries and clears timeouts', async () => {
const futureExp = Math.floor(Date.now() / 1000) + 3600;
Expand Down
66 changes: 38 additions & 28 deletions packages/clerk-js/src/core/tokenCache.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -433,40 +433,50 @@ const MemoryTokenCache = (prefix = KEY_PREFIX): TokenCache => {

const channel = broadcastChannel;
if (channel && options.broadcast) {
const tokenRaw = newToken.getRawString();
if (tokenRaw && claims.sid) {
const sessionId = claims.sid;
const organizationId = claims.org_id || (claims.o as any)?.id;
const template = TokenId.extractTemplate(entry.tokenId, sessionId, organizationId);

const expectedTokenId = TokenId.build(sessionId, template, organizationId);
if (entry.tokenId === expectedTokenId) {
const traceId = `bc_${Date.now()}_${Math.random().toString(36).substring(2, 11)}`;

debugLogger.info(
'Broadcasting token update to other tabs',
{
// Best-effort side effect: a broadcast failure (e.g. postMessage racing a
// channel close) must not reach the outer catch and evict the cached token (SDK-119).
try {
const tokenRaw = newToken.getRawString();
if (tokenRaw && claims.sid) {
const sessionId = claims.sid;
const organizationId = claims.org_id || (claims.o as any)?.id;
const template = TokenId.extractTemplate(entry.tokenId, sessionId, organizationId);

const expectedTokenId = TokenId.build(sessionId, template, organizationId);
if (entry.tokenId === expectedTokenId) {
const traceId = `bc_${Date.now()}_${Math.random().toString(36).substring(2, 11)}`;

debugLogger.info(
'Broadcasting token update to other tabs',
{
organizationId,
sessionId,
tabId,
template,
tokenId: entry.tokenId,
traceId,
},
'tokenCache',
);

const message: SessionTokenEvent = {
organizationId,
sessionId,
tabId,
template,
tokenId: entry.tokenId,
tokenRaw,
traceId,
},
'tokenCache',
);

const message: SessionTokenEvent = {
organizationId,
sessionId,
template,
tokenId: entry.tokenId,
tokenRaw,
traceId,
};

channel.postMessage(message);
};

channel.postMessage(message);
}
}
} catch (error) {
debugLogger.warn(
'Failed to broadcast token update to other tabs',
{ error, tabId, tokenId: entry.tokenId },
'tokenCache',
);
}
}
})
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): prevent broadcast failure from evicting a cached session token by jacekradko · Pull Request #8969 · 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/tokencache-broadcast-eviction.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Prevent a cross-tab broadcast failure from evicting a freshly cached session token. Previously, if broadcasting a token update to other tabs threw (for example when the `BroadcastChannel` was racing a close), the token that was just cached got dropped and the next `getToken()` made an unnecessary network request. The broadcast is now isolated so a failure no longer discards a valid cached token.
36 changes: 36 additions & 0 deletions packages/clerk-js/src/core/__tests__/tokenCache.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -506,6 +506,42 @@ describe('SessionTokenCache', () => {
});
});

describe('broadcast resilience', () => {
it('a failing postMessage does not evict the freshly cached token', async () => {
// A broadcast failure (postMessage throwing, e.g. InvalidStateError when the
// channel races a close) is a side effect that must not evict the freshly
// cached token or force an unnecessary refetch (SDK-119).
mockBroadcastChannel.postMessage.mockImplementationOnce(() => {
throw new Error('channel closed');
});

const futureExp = Math.floor(Date.now() / 1000) + 3600;
const tokenResolver = Promise.resolve({
getRawString: () => mockJwt,
jwt: { claims: { exp: futureExp, iat: 1675876730, sid: 'session_123' } },
} as any);

expect(() =>
SessionTokenCache.set({
tokenId: 'session_123',
tokenResolver,
}),
).not.toThrow();

await tokenResolver;
// Flush the cache write's .then (broadcast) and .catch microtasks. Fake timers
// are active in this suite, so flush microtasks rather than using a setTimeout.
for (let i = 0; i < 5; i++) {
await Promise.resolve();
}

// The broadcast was attempted and threw, but the token must stay cached.
expect(mockBroadcastChannel.postMessage).toHaveBeenCalledTimes(1);
expect(SessionTokenCache.size()).toBe(1);
expect(SessionTokenCache.get({ tokenId: 'session_123' })).toBeDefined();
});
});

describe('clear()', () => {
it('removes all entries and clears timeouts', async () => {
const futureExp = Math.floor(Date.now() / 1000) + 3600;
Expand Down
66 changes: 38 additions & 28 deletions packages/clerk-js/src/core/tokenCache.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -433,40 +433,50 @@ const MemoryTokenCache = (prefix = KEY_PREFIX): TokenCache => {

const channel = broadcastChannel;
if (channel && options.broadcast) {
const tokenRaw = newToken.getRawString();
if (tokenRaw && claims.sid) {
const sessionId = claims.sid;
const organizationId = claims.org_id || (claims.o as any)?.id;
const template = TokenId.extractTemplate(entry.tokenId, sessionId, organizationId);

const expectedTokenId = TokenId.build(sessionId, template, organizationId);
if (entry.tokenId === expectedTokenId) {
const traceId = `bc_${Date.now()}_${Math.random().toString(36).substring(2, 11)}`;

debugLogger.info(
'Broadcasting token update to other tabs',
{
// Best-effort side effect: a broadcast failure (e.g. postMessage racing a
// channel close) must not reach the outer catch and evict the cached token (SDK-119).
try {
const tokenRaw = newToken.getRawString();
if (tokenRaw && claims.sid) {
const sessionId = claims.sid;
const organizationId = claims.org_id || (claims.o as any)?.id;
const template = TokenId.extractTemplate(entry.tokenId, sessionId, organizationId);

const expectedTokenId = TokenId.build(sessionId, template, organizationId);
if (entry.tokenId === expectedTokenId) {
const traceId = `bc_${Date.now()}_${Math.random().toString(36).substring(2, 11)}`;

debugLogger.info(
'Broadcasting token update to other tabs',
{
organizationId,
sessionId,
tabId,
template,
tokenId: entry.tokenId,
traceId,
},
'tokenCache',
);

const message: SessionTokenEvent = {
organizationId,
sessionId,
tabId,
template,
tokenId: entry.tokenId,
tokenRaw,
traceId,
},
'tokenCache',
);

const message: SessionTokenEvent = {
organizationId,
sessionId,
template,
tokenId: entry.tokenId,
tokenRaw,
traceId,
};

channel.postMessage(message);
};

channel.postMessage(message);
}
}
} catch (error) {
debugLogger.warn(
'Failed to broadcast token update to other tabs',
{ error, tabId, tokenId: entry.tokenId },
'tokenCache',
);
}
}
})
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): prevent broadcast failure from evicting a cached session token by jacekradko · Pull Request #8969 · 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/tokencache-broadcast-eviction.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Prevent a cross-tab broadcast failure from evicting a freshly cached session token. Previously, if broadcasting a token update to other tabs threw (for example when the `BroadcastChannel` was racing a close), the token that was just cached got dropped and the next `getToken()` made an unnecessary network request. The broadcast is now isolated so a failure no longer discards a valid cached token.
36 changes: 36 additions & 0 deletions packages/clerk-js/src/core/__tests__/tokenCache.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -506,6 +506,42 @@ describe('SessionTokenCache', () => {
});
});

describe('broadcast resilience', () => {
it('a failing postMessage does not evict the freshly cached token', async () => {
// A broadcast failure (postMessage throwing, e.g. InvalidStateError when the
// channel races a close) is a side effect that must not evict the freshly
// cached token or force an unnecessary refetch (SDK-119).
mockBroadcastChannel.postMessage.mockImplementationOnce(() => {
throw new Error('channel closed');
});

const futureExp = Math.floor(Date.now() / 1000) + 3600;
const tokenResolver = Promise.resolve({
getRawString: () => mockJwt,
jwt: { claims: { exp: futureExp, iat: 1675876730, sid: 'session_123' } },
} as any);

expect(() =>
SessionTokenCache.set({
tokenId: 'session_123',
tokenResolver,
}),
).not.toThrow();

await tokenResolver;
// Flush the cache write's .then (broadcast) and .catch microtasks. Fake timers
// are active in this suite, so flush microtasks rather than using a setTimeout.
for (let i = 0; i < 5; i++) {
await Promise.resolve();
}

// The broadcast was attempted and threw, but the token must stay cached.
expect(mockBroadcastChannel.postMessage).toHaveBeenCalledTimes(1);
expect(SessionTokenCache.size()).toBe(1);
expect(SessionTokenCache.get({ tokenId: 'session_123' })).toBeDefined();
});
});

describe('clear()', () => {
it('removes all entries and clears timeouts', async () => {
const futureExp = Math.floor(Date.now() / 1000) + 3600;
Expand Down
66 changes: 38 additions & 28 deletions packages/clerk-js/src/core/tokenCache.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -433,40 +433,50 @@ const MemoryTokenCache = (prefix = KEY_PREFIX): TokenCache => {

const channel = broadcastChannel;
if (channel && options.broadcast) {
const tokenRaw = newToken.getRawString();
if (tokenRaw && claims.sid) {
const sessionId = claims.sid;
const organizationId = claims.org_id || (claims.o as any)?.id;
const template = TokenId.extractTemplate(entry.tokenId, sessionId, organizationId);

const expectedTokenId = TokenId.build(sessionId, template, organizationId);
if (entry.tokenId === expectedTokenId) {
const traceId = `bc_${Date.now()}_${Math.random().toString(36).substring(2, 11)}`;

debugLogger.info(
'Broadcasting token update to other tabs',
{
// Best-effort side effect: a broadcast failure (e.g. postMessage racing a
// channel close) must not reach the outer catch and evict the cached token (SDK-119).
try {
const tokenRaw = newToken.getRawString();
if (tokenRaw && claims.sid) {
const sessionId = claims.sid;
const organizationId = claims.org_id || (claims.o as any)?.id;
const template = TokenId.extractTemplate(entry.tokenId, sessionId, organizationId);

const expectedTokenId = TokenId.build(sessionId, template, organizationId);
if (entry.tokenId === expectedTokenId) {
const traceId = `bc_${Date.now()}_${Math.random().toString(36).substring(2, 11)}`;

debugLogger.info(
'Broadcasting token update to other tabs',
{
organizationId,
sessionId,
tabId,
template,
tokenId: entry.tokenId,
traceId,
},
'tokenCache',
);

const message: SessionTokenEvent = {
organizationId,
sessionId,
tabId,
template,
tokenId: entry.tokenId,
tokenRaw,
traceId,
},
'tokenCache',
);

const message: SessionTokenEvent = {
organizationId,
sessionId,
template,
tokenId: entry.tokenId,
tokenRaw,
traceId,
};

channel.postMessage(message);
};

channel.postMessage(message);
}
}
} catch (error) {
debugLogger.warn(
'Failed to broadcast token update to other tabs',
{ error, tabId, tokenId: entry.tokenId },
'tokenCache',
);
}
}
})
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): prevent broadcast failure from evicting a cached session token by jacekradko · Pull Request #8969 · 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/tokencache-broadcast-eviction.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Prevent a cross-tab broadcast failure from evicting a freshly cached session token. Previously, if broadcasting a token update to other tabs threw (for example when the `BroadcastChannel` was racing a close), the token that was just cached got dropped and the next `getToken()` made an unnecessary network request. The broadcast is now isolated so a failure no longer discards a valid cached token.
36 changes: 36 additions & 0 deletions packages/clerk-js/src/core/__tests__/tokenCache.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -506,6 +506,42 @@ describe('SessionTokenCache', () => {
});
});

describe('broadcast resilience', () => {
it('a failing postMessage does not evict the freshly cached token', async () => {
// A broadcast failure (postMessage throwing, e.g. InvalidStateError when the
// channel races a close) is a side effect that must not evict the freshly
// cached token or force an unnecessary refetch (SDK-119).
mockBroadcastChannel.postMessage.mockImplementationOnce(() => {
throw new Error('channel closed');
});

const futureExp = Math.floor(Date.now() / 1000) + 3600;
const tokenResolver = Promise.resolve({
getRawString: () => mockJwt,
jwt: { claims: { exp: futureExp, iat: 1675876730, sid: 'session_123' } },
} as any);

expect(() =>
SessionTokenCache.set({
tokenId: 'session_123',
tokenResolver,
}),
).not.toThrow();

await tokenResolver;
// Flush the cache write's .then (broadcast) and .catch microtasks. Fake timers
// are active in this suite, so flush microtasks rather than using a setTimeout.
for (let i = 0; i < 5; i++) {
await Promise.resolve();
}

// The broadcast was attempted and threw, but the token must stay cached.
expect(mockBroadcastChannel.postMessage).toHaveBeenCalledTimes(1);
expect(SessionTokenCache.size()).toBe(1);
expect(SessionTokenCache.get({ tokenId: 'session_123' })).toBeDefined();
});
});

describe('clear()', () => {
it('removes all entries and clears timeouts', async () => {
const futureExp = Math.floor(Date.now() / 1000) + 3600;
Expand Down
66 changes: 38 additions & 28 deletions packages/clerk-js/src/core/tokenCache.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -433,40 +433,50 @@ const MemoryTokenCache = (prefix = KEY_PREFIX): TokenCache => {

const channel = broadcastChannel;
if (channel && options.broadcast) {
const tokenRaw = newToken.getRawString();
if (tokenRaw && claims.sid) {
const sessionId = claims.sid;
const organizationId = claims.org_id || (claims.o as any)?.id;
const template = TokenId.extractTemplate(entry.tokenId, sessionId, organizationId);

const expectedTokenId = TokenId.build(sessionId, template, organizationId);
if (entry.tokenId === expectedTokenId) {
const traceId = `bc_${Date.now()}_${Math.random().toString(36).substring(2, 11)}`;

debugLogger.info(
'Broadcasting token update to other tabs',
{
// Best-effort side effect: a broadcast failure (e.g. postMessage racing a
// channel close) must not reach the outer catch and evict the cached token (SDK-119).
try {
const tokenRaw = newToken.getRawString();
if (tokenRaw && claims.sid) {
const sessionId = claims.sid;
const organizationId = claims.org_id || (claims.o as any)?.id;
const template = TokenId.extractTemplate(entry.tokenId, sessionId, organizationId);

const expectedTokenId = TokenId.build(sessionId, template, organizationId);
if (entry.tokenId === expectedTokenId) {
const traceId = `bc_${Date.now()}_${Math.random().toString(36).substring(2, 11)}`;

debugLogger.info(
'Broadcasting token update to other tabs',
{
organizationId,
sessionId,
tabId,
template,
tokenId: entry.tokenId,
traceId,
},
'tokenCache',
);

const message: SessionTokenEvent = {
organizationId,
sessionId,
tabId,
template,
tokenId: entry.tokenId,
tokenRaw,
traceId,
},
'tokenCache',
);

const message: SessionTokenEvent = {
organizationId,
sessionId,
template,
tokenId: entry.tokenId,
tokenRaw,
traceId,
};

channel.postMessage(message);
};

channel.postMessage(message);
}
}
} catch (error) {
debugLogger.warn(
'Failed to broadcast token update to other tabs',
{ error, tabId, tokenId: entry.tokenId },
'tokenCache',
);
}
}
})
Expand Down
Loading