feat(shared): Do not allow telemetry errors to bubble up#6640

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
brkalow merged 4 commits into from
Aug 26, 2025
Merged

feat(shared): Do not allow telemetry errors to bubble up #6640

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
539d73c
feat(shared): Do not allow telemetry errors to bubble up
jacekradko Aug 26, 2025
bb4c3ee
changeset
jacekradko Aug 26, 2025
e3990c9
add tests
jacekradko Aug 26, 2025
bbedda4
wip
jacekradko Aug 26, 2025
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/thirty-cars-beg.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/shared': patch
---

Do not allow errors in telemetry to bubble up
89 changes: 82 additions & 7 deletions packages/shared/src/__tests__/telemetry.logs.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,7 +49,6 @@ describe('TelemetryCollector.recordLog', () => {
expect(log.iid).toBeUndefined();
expect(log.ts).toBe(new Date(ts).toISOString());
expect(log.pk).toBe(TEST_PK);
// Function and undefined stripped out
expect(log.payload).toEqual({ a: 1 });
});

Expand All@@ -62,7 +61,6 @@ describe('TelemetryCollector.recordLog', () => {
timestamp: Date.now(),
};

// undefined context
fetchSpy.mockClear();
collector.recordLog({ ...base, context: undefined } as any);
jest.runAllTimers();
Expand All@@ -71,7 +69,6 @@ describe('TelemetryCollector.recordLog', () => {
let body = JSON.parse(initOptions1.body as string);
expect(body.logs[0].payload).toBeNull();

// array context
fetchSpy.mockClear();
collector.recordLog({ ...base, context: [1, 2, 3] } as any);
jest.runAllTimers();
Expand All@@ -80,7 +77,6 @@ describe('TelemetryCollector.recordLog', () => {
body = JSON.parse(initOptions2.body as string);
expect(body.logs[0].payload).toBeNull();

// circular context
fetchSpy.mockClear();
const circular: any = { foo: 'bar' };
circular.self = circular;
Expand All@@ -95,7 +91,6 @@ describe('TelemetryCollector.recordLog', () => {
test('drops invalid entries: missing id, invalid level, empty message, invalid timestamp', () => {
const collector = new TelemetryCollector({ publishableKey: TEST_PK });

// invalid level
fetchSpy.mockClear();
collector.recordLog({
level: 'fatal' as unknown as any,
Expand All@@ -105,7 +100,6 @@ describe('TelemetryCollector.recordLog', () => {
jest.runAllTimers();
expect(fetchSpy).not.toHaveBeenCalled();

// empty message
fetchSpy.mockClear();
collector.recordLog({
level: 'debug',
Expand All@@ -115,7 +109,6 @@ describe('TelemetryCollector.recordLog', () => {
jest.runAllTimers();
expect(fetchSpy).not.toHaveBeenCalled();

// invalid timestamp (NaN)
fetchSpy.mockClear();
collector.recordLog({
level: 'warn',
Expand DownExpand Up@@ -144,4 +137,86 @@ describe('TelemetryCollector.recordLog', () => {
const body = JSON.parse(initOptions4.body as string);
expect(body.logs[0].ts).toBe(new Date(tsString).toISOString());
});

describe('error handling', () => {
test('recordLog() method handles circular references in context gracefully', () => {
const collector = new TelemetryCollector({ publishableKey: TEST_PK });

const circularContext = (() => {
const obj: any = { test: 'value' };
obj.self = obj;
return obj;
})();

expect(() => {
collector.recordLog({
level: 'info',
message: 'test message',
timestamp: Date.now(),
context: circularContext,
});
}).not.toThrow();

jest.runAllTimers();
expect(fetchSpy).toHaveBeenCalled();

const [url, init] = fetchSpy.mock.calls[0];
expect(String(url)).toMatch('/v1/logs');

const initOptions = init as RequestInit;
const body = JSON.parse(initOptions.body as string);
expect(body.logs[0].payload).toBeNull();
});

test('recordLog() method handles non-serializable context gracefully', () => {
const collector = new TelemetryCollector({ publishableKey: TEST_PK });

const nonSerializableContext = {
function: () => 'test',
undefined: undefined,
symbol: Symbol('test'),
circular: (() => {
const obj: any = { test: 'value' };
obj.self = obj;
return obj;
})(),
};

expect(() => {
collector.recordLog({
level: 'info',
message: 'test message',
timestamp: Date.now(),
context: nonSerializableContext,
});
}).not.toThrow();

jest.runAllTimers();
expect(fetchSpy).toHaveBeenCalled();

const [url, init] = fetchSpy.mock.calls[0];
expect(String(url)).toMatch('/v1/logs');

const initOptions = init as RequestInit;
const body = JSON.parse(initOptions.body as string);
expect(body.logs[0].payload).toBeNull();
});

test('recordLog() method handles invalid timestamp gracefully', () => {
const collector = new TelemetryCollector({ publishableKey: TEST_PK });

const invalidTimestamp = new Date('invalid date');

expect(() => {
collector.recordLog({
level: 'info',
message: 'test message',
timestamp: invalidTimestamp.getTime(),
});
}).not.toThrow();

jest.runAllTimers();
expect(fetchSpy).not.toHaveBeenCalled();
});
});
});
59 changes: 59 additions & 0 deletions packages/shared/src/__tests__/telemetry.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -392,4 +392,63 @@ describe('TelemetryCollector', () => {
fetchSpy.mockRestore();
});
});

describe('error handling', () => {
test('record() method does not bubble up errors from internal operations', () => {
const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(() => {});

const collector = new TelemetryCollector({
publishableKey: TEST_PK,
});

const circularPayload = (() => {
const obj: any = { test: 'value' };
obj.self = obj;
return obj;
})();

expect(() => {
collector.record({ event: 'TEST_EVENT', payload: circularPayload });
}).not.toThrow();

expect(consoleErrorSpy).toHaveBeenCalledWith(
'[clerk/telemetry] Error recording telemetry event',
expect.any(Error),
);

consoleErrorSpy.mockRestore();
});

test('record() method handles errors gracefully and continues operation', () => {
const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(() => {});

const collector = new TelemetryCollector({
publishableKey: TEST_PK,
});

const problematicPayload = (() => {
const obj: any = { test: 'value' };
obj.self = obj;
return obj;
})();

expect(() => {
collector.record({ event: 'TEST_EVENT', payload: problematicPayload });
}).not.toThrow();

expect(consoleErrorSpy).toHaveBeenCalledWith(
'[clerk/telemetry] Error recording telemetry event',
expect.any(Error),
);

expect(() => {
collector.record({ event: 'TEST_EVENT', payload: { normal: 'data' } });
}).not.toThrow();

jest.runAllTimers();
expect(fetchSpy).toHaveBeenCalled();

consoleErrorSpy.mockRestore();
});
});
});
91 changes: 49 additions & 42 deletions packages/shared/src/telemetry/collector.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -176,17 +176,21 @@ export class TelemetryCollector implements TelemetryCollectorInterface {
}

record(event: TelemetryEventRaw): void {
const preparedPayload = this.#preparePayload(event.event, event.payload);
try {
const preparedPayload = this.#preparePayload(event.event, event.payload);

this.#logEvent(preparedPayload.event, preparedPayload);
this.#logEvent(preparedPayload.event, preparedPayload);

if (!this.#shouldRecord(preparedPayload, event.eventSamplingRate)) {
return;
}
if (!this.#shouldRecord(preparedPayload, event.eventSamplingRate)) {
return;
}

this.#buffer.push({ kind: 'event', value: preparedPayload });
this.#buffer.push({ kind: 'event', value: preparedPayload });

this.#scheduleFlush();
this.#scheduleFlush();
} catch (error) {
console.error('[clerk/telemetry] Error recording telemetry event', error);
}
}

/**
Expand All@@ -195,49 +199,53 @@ export class TelemetryCollector implements TelemetryCollectorInterface {
* @param entry - The telemetry log entry to record.
*/
recordLog(entry: TelemetryLogEntry): void {
if (!this.#shouldRecordLog(entry)) {
return;
}
try {
if (!this.#shouldRecordLog(entry)) {
return;
}

const levelIsValid = typeof entry?.level === 'string' && VALID_LOG_LEVELS.has(entry.level);
const messageIsValid = typeof entry?.message === 'string' && entry.message.trim().length > 0;
const levelIsValid = typeof entry?.level === 'string' && VALID_LOG_LEVELS.has(entry.level);
const messageIsValid = typeof entry?.message === 'string' && entry.message.trim().length > 0;

let normalizedTimestamp: Date | null = null;
const timestampInput: unknown = (entry as unknown as { timestamp?: unknown })?.timestamp;
if (typeof timestampInput === 'number' || typeof timestampInput === 'string') {
const candidate = new Date(timestampInput);
if (!Number.isNaN(candidate.getTime())) {
normalizedTimestamp = candidate;
let normalizedTimestamp: Date | null = null;
const timestampInput: unknown = (entry as unknown as { timestamp?: unknown })?.timestamp;
if (typeof timestampInput === 'number' || typeof timestampInput === 'string') {
const candidate = new Date(timestampInput);
if (!Number.isNaN(candidate.getTime())) {
normalizedTimestamp = candidate;
}
}
}

if (!levelIsValid || !messageIsValid || normalizedTimestamp === null) {
if (this.isDebug && typeof console !== 'undefined') {
console.warn('[clerk/telemetry] Dropping invalid telemetry log entry', {
levelIsValid,
messageIsValid,
timestampIsValid: normalizedTimestamp !== null,
});
if (!levelIsValid || !messageIsValid || normalizedTimestamp === null) {
if (this.isDebug && typeof console !== 'undefined') {
console.warn('[clerk/telemetry] Dropping invalid telemetry log entry', {
levelIsValid,
messageIsValid,
timestampIsValid: normalizedTimestamp !== null,
});
}
return;
}
return;
}

const sdkMetadata = this.#getSDKMetadata();
const sdkMetadata = this.#getSDKMetadata();

const logData: TelemetryLogData = {
sdk: sdkMetadata.name,
sdkv: sdkMetadata.version,
cv: this.#metadata.clerkVersion ?? '',
lvl: entry.level,
msg: entry.message,
ts: normalizedTimestamp.toISOString(),
pk: this.#metadata.publishableKey || null,
payload: this.#sanitizeContext(entry.context),
};
const logData: TelemetryLogData = {
sdk: sdkMetadata.name,
sdkv: sdkMetadata.version,
cv: this.#metadata.clerkVersion ?? '',
lvl: entry.level,
msg: entry.message,
ts: normalizedTimestamp.toISOString(),
pk: this.#metadata.publishableKey || null,
payload: this.#sanitizeContext(entry.context),
};

this.#buffer.push({ kind: 'log', value: logData });
this.#buffer.push({ kind: 'log', value: logData });

this.#scheduleFlush();
this.#scheduleFlush();
} catch (error) {
console.error('[clerk/telemetry] Error recording telemetry log entry', error);
}
}

#shouldRecord(preparedPayload: TelemetryEvent, eventSamplingRate?: number) {
Expand DownExpand Up@@ -271,7 +279,6 @@ export class TelemetryCollector implements TelemetryCollectorInterface {
this.#flush();
return;
}

const isBufferFull = this.#buffer.length >= this.#config.maxBufferSize;
if (isBufferFull) {
// If the buffer is full, flush immediately to make sure we minimize the chance of event loss.
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat(shared): Do not allow telemetry errors to bubble up#6640

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

brkalow
merged 4 commits into

from

Aug 26, 2025
 Merged


feat(shared): Do not allow telemetry errors to bubble up
#6640
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
539d73c

feat(shared): Do not allow telemetry errors to bubble up


jacekradko Aug 26, 2025
bb4c3ee

changeset


jacekradko Aug 26, 2025
e3990c9

add tests


jacekradko Aug 26, 2025
bbedda4

wip


jacekradko Aug 26, 2025

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/thirty-cars-beg.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/shared': patch
---

Do not allow errors in telemetry to bubble up

89 changes: 82 additions & 7 deletions
packages/shared/src/__tests__/telemetry.logs.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -49,7 +49,6 @@ describe('TelemetryCollector.recordLog', () => {
 expect(log.iid).toBeUndefined();
 expect(log.ts).toBe(new Date(ts).toISOString());
 expect(log.pk).toBe(TEST_PK);
 // Function and undefined stripped out
 expect(log.payload).toEqual({ a: 1 });
 });

Expand All@@ -62,7 +61,6 @@ describe('TelemetryCollector.recordLog', () => {
 timestamp: Date.now(),
 };

 // undefined context
 fetchSpy.mockClear();
 collector.recordLog({ ...base, context: undefined } as any);
 jest.runAllTimers();
Expand All@@ -71,7 +69,6 @@ describe('TelemetryCollector.recordLog', () => {
 let body = JSON.parse(initOptions1.body as string);
 expect(body.logs[0].payload).toBeNull();

 // array context
 fetchSpy.mockClear();
 collector.recordLog({ ...base, context: [1, 2, 3] } as any);
 jest.runAllTimers();
Expand All@@ -80,7 +77,6 @@ describe('TelemetryCollector.recordLog', () => {
 body = JSON.parse(initOptions2.body as string);
 expect(body.logs[0].payload).toBeNull();

 // circular context
 fetchSpy.mockClear();
 const circular: any = { foo: 'bar' };
 circular.self = circular;
Expand All@@ -95,7 +91,6 @@ describe('TelemetryCollector.recordLog', () => {
 test('drops invalid entries: missing id, invalid level, empty message, invalid timestamp', () => {
 const collector = new TelemetryCollector({ publishableKey: TEST_PK });

 // invalid level
 fetchSpy.mockClear();
 collector.recordLog({
 level: 'fatal' as unknown as any,
Expand All@@ -105,7 +100,6 @@ describe('TelemetryCollector.recordLog', () => {
 jest.runAllTimers();
 expect(fetchSpy).not.toHaveBeenCalled();

 // empty message
 fetchSpy.mockClear();
 collector.recordLog({
 level: 'debug',
Expand All@@ -115,7 +109,6 @@ describe('TelemetryCollector.recordLog', () => {
 jest.runAllTimers();
 expect(fetchSpy).not.toHaveBeenCalled();

 // invalid timestamp (NaN)
 fetchSpy.mockClear();
 collector.recordLog({
 level: 'warn',
Expand DownExpand Up@@ -144,4 +137,86 @@ describe('TelemetryCollector.recordLog', () => {
 const body = JSON.parse(initOptions4.body as string);
 expect(body.logs[0].ts).toBe(new Date(tsString).toISOString());
 });

 describe('error handling', () => {
 test('recordLog() method handles circular references in context gracefully', () => {
 const collector = new TelemetryCollector({ publishableKey: TEST_PK });

 const circularContext = (() => {
 const obj: any = { test: 'value' };
 obj.self = obj;
 return obj;
 })();

 expect(() => {
 collector.recordLog({
 level: 'info',
 message: 'test message',
 timestamp: Date.now(),
 context: circularContext,
 });
 }).not.toThrow();

 jest.runAllTimers();
 expect(fetchSpy).toHaveBeenCalled();

 const [url, init] = fetchSpy.mock.calls[0];
 expect(String(url)).toMatch('/v1/logs');

 const initOptions = init as RequestInit;
 const body = JSON.parse(initOptions.body as string);
 expect(body.logs[0].payload).toBeNull();
 });

 test('recordLog() method handles non-serializable context gracefully', () => {
 const collector = new TelemetryCollector({ publishableKey: TEST_PK });

 const nonSerializableContext = {
 function: () => 'test',
 undefined: undefined,
 symbol: Symbol('test'),
 circular: (() => {
 const obj: any = { test: 'value' };
 obj.self = obj;
 return obj;
 })(),
 };

 expect(() => {
 collector.recordLog({
 level: 'info',
 message: 'test message',
 timestamp: Date.now(),
 context: nonSerializableContext,
 });
 }).not.toThrow();

 jest.runAllTimers();
 expect(fetchSpy).toHaveBeenCalled();

 const [url, init] = fetchSpy.mock.calls[0];
 expect(String(url)).toMatch('/v1/logs');

 const initOptions = init as RequestInit;
 const body = JSON.parse(initOptions.body as string);
 expect(body.logs[0].payload).toBeNull();
 });

 test('recordLog() method handles invalid timestamp gracefully', () => {
 const collector = new TelemetryCollector({ publishableKey: TEST_PK });

 const invalidTimestamp = new Date('invalid date');

 expect(() => {
 collector.recordLog({
 level: 'info',
 message: 'test message',
 timestamp: invalidTimestamp.getTime(),
 });
 }).not.toThrow();

 jest.runAllTimers();
 expect(fetchSpy).not.toHaveBeenCalled();
 });
 });
});

59 changes: 59 additions & 0 deletions
packages/shared/src/__tests__/telemetry.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -392,4 +392,63 @@ describe('TelemetryCollector', () => {
 fetchSpy.mockRestore();
 });
 });

 describe('error handling', () => {
 test('record() method does not bubble up errors from internal operations', () => {
 const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(() => {});

 const collector = new TelemetryCollector({
 publishableKey: TEST_PK,
 });

 const circularPayload = (() => {
 const obj: any = { test: 'value' };
 obj.self = obj;
 return obj;
 })();

 expect(() => {
 collector.record({ event: 'TEST_EVENT', payload: circularPayload });
 }).not.toThrow();

 expect(consoleErrorSpy).toHaveBeenCalledWith(
 '[clerk/telemetry] Error recording telemetry event',
 expect.any(Error),
 );

 consoleErrorSpy.mockRestore();
 });

 test('record() method handles errors gracefully and continues operation', () => {
 const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(() => {});

 const collector = new TelemetryCollector({
 publishableKey: TEST_PK,
 });

 const problematicPayload = (() => {
 const obj: any = { test: 'value' };
 obj.self = obj;
 return obj;
 })();

 expect(() => {
 collector.record({ event: 'TEST_EVENT', payload: problematicPayload });
 }).not.toThrow();

 expect(consoleErrorSpy).toHaveBeenCalledWith(
 '[clerk/telemetry] Error recording telemetry event',
 expect.any(Error),
 );

 expect(() => {
 collector.record({ event: 'TEST_EVENT', payload: { normal: 'data' } });
 }).not.toThrow();

 jest.runAllTimers();
 expect(fetchSpy).toHaveBeenCalled();

 consoleErrorSpy.mockRestore();
 });
 });
});

91 changes: 49 additions & 42 deletions
packages/shared/src/telemetry/collector.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -176,17 +176,21 @@ export class TelemetryCollector implements TelemetryCollectorInterface {
 }

 record(event: TelemetryEventRaw): void {
 const preparedPayload = this.#preparePayload(event.event, event.payload);
 try {
 const preparedPayload = this.#preparePayload(event.event, event.payload);

 this.#logEvent(preparedPayload.event, preparedPayload);
this.#logEvent(preparedPayload.event, preparedPayload);

 if (!this.#shouldRecord(preparedPayload, event.eventSamplingRate)) {
 return;
 }
if (!this.#shouldRecord(preparedPayload, event.eventSamplingRate)) {
return;
}

 this.#buffer.push({ kind: 'event', value: preparedPayload });
this.#buffer.push({ kind: 'event', value: preparedPayload });

 this.#scheduleFlush();
 this.#scheduleFlush();
 } catch (error) {
 console.error('[clerk/telemetry] Error recording telemetry event', error);
 }
 }

 /**
Expand All@@ -195,49 +199,53 @@ export class TelemetryCollector implements TelemetryCollectorInterface {
 * @param entry - The telemetry log entry to record.
 */
 recordLog(entry: TelemetryLogEntry): void {
 if (!this.#shouldRecordLog(entry)) {
 return;
 }
 try {
 if (!this.#shouldRecordLog(entry)) {
 return;
 }

 const levelIsValid = typeof entry?.level === 'string' && VALID_LOG_LEVELS.has(entry.level);
 const messageIsValid = typeof entry?.message === 'string' && entry.message.trim().length > 0;
const levelIsValid = typeof entry?.level === 'string' && VALID_LOG_LEVELS.has(entry.level);
const messageIsValid = typeof entry?.message === 'string' && entry.message.trim().length > 0;

 let normalizedTimestamp: Date | null = null;
 const timestampInput: unknown = (entry as unknown as { timestamp?: unknown })?.timestamp;
 if (typeof timestampInput === 'number' || typeof timestampInput === 'string') {
 const candidate = new Date(timestampInput);
 if (!Number.isNaN(candidate.getTime())) {
 normalizedTimestamp = candidate;
 let normalizedTimestamp: Date | null = null;
 const timestampInput: unknown = (entry as unknown as { timestamp?: unknown })?.timestamp;
 if (typeof timestampInput === 'number' || typeof timestampInput === 'string') {
 const candidate = new Date(timestampInput);
 if (!Number.isNaN(candidate.getTime())) {
 normalizedTimestamp = candidate;
 }
 }
 }

 if (!levelIsValid || !messageIsValid || normalizedTimestamp === null) {
 if (this.isDebug && typeof console !== 'undefined') {
 console.warn('[clerk/telemetry] Dropping invalid telemetry log entry', {
 levelIsValid,
 messageIsValid,
 timestampIsValid: normalizedTimestamp !== null,
 });
 if (!levelIsValid || !messageIsValid || normalizedTimestamp === null) {
 if (this.isDebug && typeof console !== 'undefined') {
 console.warn('[clerk/telemetry] Dropping invalid telemetry log entry', {
 levelIsValid,
 messageIsValid,
 timestampIsValid: normalizedTimestamp !== null,
 });
 }
 return;
 }
 return;
 }

 const sdkMetadata = this.#getSDKMetadata();
const sdkMetadata = this.#getSDKMetadata();

 const logData: TelemetryLogData = {
 sdk: sdkMetadata.name,
 sdkv: sdkMetadata.version,
 cv: this.#metadata.clerkVersion ?? '',
 lvl: entry.level,
 msg: entry.message,
 ts: normalizedTimestamp.toISOString(),
 pk: this.#metadata.publishableKey || null,
 payload: this.#sanitizeContext(entry.context),
 };
const logData: TelemetryLogData = {
sdk: sdkMetadata.name,
sdkv: sdkMetadata.version,
cv: this.#metadata.clerkVersion ?? '',
lvl: entry.level,
msg: entry.message,
ts: normalizedTimestamp.toISOString(),
pk: this.#metadata.publishableKey || null,
payload: this.#sanitizeContext(entry.context),
};

 this.#buffer.push({ kind: 'log', value: logData });
this.#buffer.push({ kind: 'log', value: logData });

 this.#scheduleFlush();
 this.#scheduleFlush();
 } catch (error) {
 console.error('[clerk/telemetry] Error recording telemetry log entry', error);
 }
 }

 #shouldRecord(preparedPayload: TelemetryEvent, eventSamplingRate?: number) {
Expand DownExpand Up@@ -271,7 +279,6 @@ export class TelemetryCollector implements TelemetryCollectorInterface {
 this.#flush();
 return;
 }

 const isBufferFull = this.#buffer.length >= this.#config.maxBufferSize;
 if (isBufferFull) {
 // If the buffer is full, flush immediately to make sure we minimize the chance of event loss.
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(shared): Do not allow telemetry errors to bubble up#6640

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

brkalow
merged 4 commits into

from

Aug 26, 2025
 Merged


feat(shared): Do not allow telemetry errors to bubble up
#6640
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
539d73c

feat(shared): Do not allow telemetry errors to bubble up


jacekradko Aug 26, 2025
bb4c3ee

changeset


jacekradko Aug 26, 2025
e3990c9

add tests


jacekradko Aug 26, 2025
bbedda4

wip


jacekradko Aug 26, 2025

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/thirty-cars-beg.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/shared': patch
---

Do not allow errors in telemetry to bubble up

89 changes: 82 additions & 7 deletions
packages/shared/src/__tests__/telemetry.logs.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -49,7 +49,6 @@ describe('TelemetryCollector.recordLog', () => {
 expect(log.iid).toBeUndefined();
 expect(log.ts).toBe(new Date(ts).toISOString());
 expect(log.pk).toBe(TEST_PK);
 // Function and undefined stripped out
 expect(log.payload).toEqual({ a: 1 });
 });

Expand All@@ -62,7 +61,6 @@ describe('TelemetryCollector.recordLog', () => {
 timestamp: Date.now(),
 };

 // undefined context
 fetchSpy.mockClear();
 collector.recordLog({ ...base, context: undefined } as any);
 jest.runAllTimers();
Expand All@@ -71,7 +69,6 @@ describe('TelemetryCollector.recordLog', () => {
 let body = JSON.parse(initOptions1.body as string);
 expect(body.logs[0].payload).toBeNull();

 // array context
 fetchSpy.mockClear();
 collector.recordLog({ ...base, context: [1, 2, 3] } as any);
 jest.runAllTimers();
Expand All@@ -80,7 +77,6 @@ describe('TelemetryCollector.recordLog', () => {
 body = JSON.parse(initOptions2.body as string);
 expect(body.logs[0].payload).toBeNull();

 // circular context
 fetchSpy.mockClear();
 const circular: any = { foo: 'bar' };
 circular.self = circular;
Expand All@@ -95,7 +91,6 @@ describe('TelemetryCollector.recordLog', () => {
 test('drops invalid entries: missing id, invalid level, empty message, invalid timestamp', () => {
 const collector = new TelemetryCollector({ publishableKey: TEST_PK });

 // invalid level
 fetchSpy.mockClear();
 collector.recordLog({
 level: 'fatal' as unknown as any,
Expand All@@ -105,7 +100,6 @@ describe('TelemetryCollector.recordLog', () => {
 jest.runAllTimers();
 expect(fetchSpy).not.toHaveBeenCalled();

 // empty message
 fetchSpy.mockClear();
 collector.recordLog({
 level: 'debug',
Expand All@@ -115,7 +109,6 @@ describe('TelemetryCollector.recordLog', () => {
 jest.runAllTimers();
 expect(fetchSpy).not.toHaveBeenCalled();

 // invalid timestamp (NaN)
 fetchSpy.mockClear();
 collector.recordLog({
 level: 'warn',
Expand DownExpand Up@@ -144,4 +137,86 @@ describe('TelemetryCollector.recordLog', () => {
 const body = JSON.parse(initOptions4.body as string);
 expect(body.logs[0].ts).toBe(new Date(tsString).toISOString());
 });

 describe('error handling', () => {
 test('recordLog() method handles circular references in context gracefully', () => {
 const collector = new TelemetryCollector({ publishableKey: TEST_PK });

 const circularContext = (() => {
 const obj: any = { test: 'value' };
 obj.self = obj;
 return obj;
 })();

 expect(() => {
 collector.recordLog({
 level: 'info',
 message: 'test message',
 timestamp: Date.now(),
 context: circularContext,
 });
 }).not.toThrow();

 jest.runAllTimers();
 expect(fetchSpy).toHaveBeenCalled();

 const [url, init] = fetchSpy.mock.calls[0];
 expect(String(url)).toMatch('/v1/logs');

 const initOptions = init as RequestInit;
 const body = JSON.parse(initOptions.body as string);
 expect(body.logs[0].payload).toBeNull();
 });

 test('recordLog() method handles non-serializable context gracefully', () => {
 const collector = new TelemetryCollector({ publishableKey: TEST_PK });

 const nonSerializableContext = {
 function: () => 'test',
 undefined: undefined,
 symbol: Symbol('test'),
 circular: (() => {
 const obj: any = { test: 'value' };
 obj.self = obj;
 return obj;
 })(),
 };

 expect(() => {
 collector.recordLog({
 level: 'info',
 message: 'test message',
 timestamp: Date.now(),
 context: nonSerializableContext,
 });
 }).not.toThrow();

 jest.runAllTimers();
 expect(fetchSpy).toHaveBeenCalled();

 const [url, init] = fetchSpy.mock.calls[0];
 expect(String(url)).toMatch('/v1/logs');

 const initOptions = init as RequestInit;
 const body = JSON.parse(initOptions.body as string);
 expect(body.logs[0].payload).toBeNull();
 });

 test('recordLog() method handles invalid timestamp gracefully', () => {
 const collector = new TelemetryCollector({ publishableKey: TEST_PK });

 const invalidTimestamp = new Date('invalid date');

 expect(() => {
 collector.recordLog({
 level: 'info',
 message: 'test message',
 timestamp: invalidTimestamp.getTime(),
 });
 }).not.toThrow();

 jest.runAllTimers();
 expect(fetchSpy).not.toHaveBeenCalled();
 });
 });
});

59 changes: 59 additions & 0 deletions
packages/shared/src/__tests__/telemetry.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -392,4 +392,63 @@ describe('TelemetryCollector', () => {
 fetchSpy.mockRestore();
 });
 });

 describe('error handling', () => {
 test('record() method does not bubble up errors from internal operations', () => {
 const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(() => {});

 const collector = new TelemetryCollector({
 publishableKey: TEST_PK,
 });

 const circularPayload = (() => {
 const obj: any = { test: 'value' };
 obj.self = obj;
 return obj;
 })();

 expect(() => {
 collector.record({ event: 'TEST_EVENT', payload: circularPayload });
 }).not.toThrow();

 expect(consoleErrorSpy).toHaveBeenCalledWith(
 '[clerk/telemetry] Error recording telemetry event',
 expect.any(Error),
 );

 consoleErrorSpy.mockRestore();
 });

 test('record() method handles errors gracefully and continues operation', () => {
 const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(() => {});

 const collector = new TelemetryCollector({
 publishableKey: TEST_PK,
 });

 const problematicPayload = (() => {
 const obj: any = { test: 'value' };
 obj.self = obj;
 return obj;
 })();

 expect(() => {
 collector.record({ event: 'TEST_EVENT', payload: problematicPayload });
 }).not.toThrow();

 expect(consoleErrorSpy).toHaveBeenCalledWith(
 '[clerk/telemetry] Error recording telemetry event',
 expect.any(Error),
 );

 expect(() => {
 collector.record({ event: 'TEST_EVENT', payload: { normal: 'data' } });
 }).not.toThrow();

 jest.runAllTimers();
 expect(fetchSpy).toHaveBeenCalled();

 consoleErrorSpy.mockRestore();
 });
 });
});

91 changes: 49 additions & 42 deletions
packages/shared/src/telemetry/collector.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -176,17 +176,21 @@ export class TelemetryCollector implements TelemetryCollectorInterface {
 }

 record(event: TelemetryEventRaw): void {
 const preparedPayload = this.#preparePayload(event.event, event.payload);
 try {
 const preparedPayload = this.#preparePayload(event.event, event.payload);

 this.#logEvent(preparedPayload.event, preparedPayload);
this.#logEvent(preparedPayload.event, preparedPayload);

 if (!this.#shouldRecord(preparedPayload, event.eventSamplingRate)) {
 return;
 }
if (!this.#shouldRecord(preparedPayload, event.eventSamplingRate)) {
return;
}

 this.#buffer.push({ kind: 'event', value: preparedPayload });
this.#buffer.push({ kind: 'event', value: preparedPayload });

 this.#scheduleFlush();
 this.#scheduleFlush();
 } catch (error) {
 console.error('[clerk/telemetry] Error recording telemetry event', error);
 }
 }

 /**
Expand All@@ -195,49 +199,53 @@ export class TelemetryCollector implements TelemetryCollectorInterface {
 * @param entry - The telemetry log entry to record.
 */
 recordLog(entry: TelemetryLogEntry): void {
 if (!this.#shouldRecordLog(entry)) {
 return;
 }
 try {
 if (!this.#shouldRecordLog(entry)) {
 return;
 }

 const levelIsValid = typeof entry?.level === 'string' && VALID_LOG_LEVELS.has(entry.level);
 const messageIsValid = typeof entry?.message === 'string' && entry.message.trim().length > 0;
const levelIsValid = typeof entry?.level === 'string' && VALID_LOG_LEVELS.has(entry.level);
const messageIsValid = typeof entry?.message === 'string' && entry.message.trim().length > 0;

 let normalizedTimestamp: Date | null = null;
 const timestampInput: unknown = (entry as unknown as { timestamp?: unknown })?.timestamp;
 if (typeof timestampInput === 'number' || typeof timestampInput === 'string') {
 const candidate = new Date(timestampInput);
 if (!Number.isNaN(candidate.getTime())) {
 normalizedTimestamp = candidate;
 let normalizedTimestamp: Date | null = null;
 const timestampInput: unknown = (entry as unknown as { timestamp?: unknown })?.timestamp;
 if (typeof timestampInput === 'number' || typeof timestampInput === 'string') {
 const candidate = new Date(timestampInput);
 if (!Number.isNaN(candidate.getTime())) {
 normalizedTimestamp = candidate;
 }
 }
 }

 if (!levelIsValid || !messageIsValid || normalizedTimestamp === null) {
 if (this.isDebug && typeof console !== 'undefined') {
 console.warn('[clerk/telemetry] Dropping invalid telemetry log entry', {
 levelIsValid,
 messageIsValid,
 timestampIsValid: normalizedTimestamp !== null,
 });
 if (!levelIsValid || !messageIsValid || normalizedTimestamp === null) {
 if (this.isDebug && typeof console !== 'undefined') {
 console.warn('[clerk/telemetry] Dropping invalid telemetry log entry', {
 levelIsValid,
 messageIsValid,
 timestampIsValid: normalizedTimestamp !== null,
 });
 }
 return;
 }
 return;
 }

 const sdkMetadata = this.#getSDKMetadata();
const sdkMetadata = this.#getSDKMetadata();

 const logData: TelemetryLogData = {
 sdk: sdkMetadata.name,
 sdkv: sdkMetadata.version,
 cv: this.#metadata.clerkVersion ?? '',
 lvl: entry.level,
 msg: entry.message,
 ts: normalizedTimestamp.toISOString(),
 pk: this.#metadata.publishableKey || null,
 payload: this.#sanitizeContext(entry.context),
 };
const logData: TelemetryLogData = {
sdk: sdkMetadata.name,
sdkv: sdkMetadata.version,
cv: this.#metadata.clerkVersion ?? '',
lvl: entry.level,
msg: entry.message,
ts: normalizedTimestamp.toISOString(),
pk: this.#metadata.publishableKey || null,
payload: this.#sanitizeContext(entry.context),
};

 this.#buffer.push({ kind: 'log', value: logData });
this.#buffer.push({ kind: 'log', value: logData });

 this.#scheduleFlush();
 this.#scheduleFlush();
 } catch (error) {
 console.error('[clerk/telemetry] Error recording telemetry log entry', error);
 }
 }

 #shouldRecord(preparedPayload: TelemetryEvent, eventSamplingRate?: number) {
Expand DownExpand Up@@ -271,7 +279,6 @@ export class TelemetryCollector implements TelemetryCollectorInterface {
 this.#flush();
 return;
 }

 const isBufferFull = this.#buffer.length >= this.#config.maxBufferSize;
 if (isBufferFull) {
 // If the buffer is full, flush immediately to make sure we minimize the chance of event loss.
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(shared): Do not allow telemetry errors to bubble up#6640

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

brkalow
merged 4 commits into

from

Aug 26, 2025
 Merged


feat(shared): Do not allow telemetry errors to bubble up
#6640
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
539d73c

feat(shared): Do not allow telemetry errors to bubble up


jacekradko Aug 26, 2025
bb4c3ee

changeset


jacekradko Aug 26, 2025
e3990c9

add tests


jacekradko Aug 26, 2025
bbedda4

wip


jacekradko Aug 26, 2025

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/thirty-cars-beg.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/shared': patch
---

Do not allow errors in telemetry to bubble up

89 changes: 82 additions & 7 deletions
packages/shared/src/__tests__/telemetry.logs.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -49,7 +49,6 @@ describe('TelemetryCollector.recordLog', () => {
 expect(log.iid).toBeUndefined();
 expect(log.ts).toBe(new Date(ts).toISOString());
 expect(log.pk).toBe(TEST_PK);
 // Function and undefined stripped out
 expect(log.payload).toEqual({ a: 1 });
 });

Expand All@@ -62,7 +61,6 @@ describe('TelemetryCollector.recordLog', () => {
 timestamp: Date.now(),
 };

 // undefined context
 fetchSpy.mockClear();
 collector.recordLog({ ...base, context: undefined } as any);
 jest.runAllTimers();
Expand All@@ -71,7 +69,6 @@ describe('TelemetryCollector.recordLog', () => {
 let body = JSON.parse(initOptions1.body as string);
 expect(body.logs[0].payload).toBeNull();

 // array context
 fetchSpy.mockClear();
 collector.recordLog({ ...base, context: [1, 2, 3] } as any);
 jest.runAllTimers();
Expand All@@ -80,7 +77,6 @@ describe('TelemetryCollector.recordLog', () => {
 body = JSON.parse(initOptions2.body as string);
 expect(body.logs[0].payload).toBeNull();

 // circular context
 fetchSpy.mockClear();
 const circular: any = { foo: 'bar' };
 circular.self = circular;
Expand All@@ -95,7 +91,6 @@ describe('TelemetryCollector.recordLog', () => {
 test('drops invalid entries: missing id, invalid level, empty message, invalid timestamp', () => {
 const collector = new TelemetryCollector({ publishableKey: TEST_PK });

 // invalid level
 fetchSpy.mockClear();
 collector.recordLog({
 level: 'fatal' as unknown as any,
Expand All@@ -105,7 +100,6 @@ describe('TelemetryCollector.recordLog', () => {
 jest.runAllTimers();
 expect(fetchSpy).not.toHaveBeenCalled();

 // empty message
 fetchSpy.mockClear();
 collector.recordLog({
 level: 'debug',
Expand All@@ -115,7 +109,6 @@ describe('TelemetryCollector.recordLog', () => {
 jest.runAllTimers();
 expect(fetchSpy).not.toHaveBeenCalled();

 // invalid timestamp (NaN)
 fetchSpy.mockClear();
 collector.recordLog({
 level: 'warn',
Expand DownExpand Up@@ -144,4 +137,86 @@ describe('TelemetryCollector.recordLog', () => {
 const body = JSON.parse(initOptions4.body as string);
 expect(body.logs[0].ts).toBe(new Date(tsString).toISOString());
 });

 describe('error handling', () => {
 test('recordLog() method handles circular references in context gracefully', () => {
 const collector = new TelemetryCollector({ publishableKey: TEST_PK });

 const circularContext = (() => {
 const obj: any = { test: 'value' };
 obj.self = obj;
 return obj;
 })();

 expect(() => {
 collector.recordLog({
 level: 'info',
 message: 'test message',
 timestamp: Date.now(),
 context: circularContext,
 });
 }).not.toThrow();

 jest.runAllTimers();
 expect(fetchSpy).toHaveBeenCalled();

 const [url, init] = fetchSpy.mock.calls[0];
 expect(String(url)).toMatch('/v1/logs');

 const initOptions = init as RequestInit;
 const body = JSON.parse(initOptions.body as string);
 expect(body.logs[0].payload).toBeNull();
 });

 test('recordLog() method handles non-serializable context gracefully', () => {
 const collector = new TelemetryCollector({ publishableKey: TEST_PK });

 const nonSerializableContext = {
 function: () => 'test',
 undefined: undefined,
 symbol: Symbol('test'),
 circular: (() => {
 const obj: any = { test: 'value' };
 obj.self = obj;
 return obj;
 })(),
 };

 expect(() => {
 collector.recordLog({
 level: 'info',
 message: 'test message',
 timestamp: Date.now(),
 context: nonSerializableContext,
 });
 }).not.toThrow();

 jest.runAllTimers();
 expect(fetchSpy).toHaveBeenCalled();

 const [url, init] = fetchSpy.mock.calls[0];
 expect(String(url)).toMatch('/v1/logs');

 const initOptions = init as RequestInit;
 const body = JSON.parse(initOptions.body as string);
 expect(body.logs[0].payload).toBeNull();
 });

 test('recordLog() method handles invalid timestamp gracefully', () => {
 const collector = new TelemetryCollector({ publishableKey: TEST_PK });

 const invalidTimestamp = new Date('invalid date');

 expect(() => {
 collector.recordLog({
 level: 'info',
 message: 'test message',
 timestamp: invalidTimestamp.getTime(),
 });
 }).not.toThrow();

 jest.runAllTimers();
 expect(fetchSpy).not.toHaveBeenCalled();
 });
 });
});

59 changes: 59 additions & 0 deletions
packages/shared/src/__tests__/telemetry.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -392,4 +392,63 @@ describe('TelemetryCollector', () => {
 fetchSpy.mockRestore();
 });
 });

 describe('error handling', () => {
 test('record() method does not bubble up errors from internal operations', () => {
 const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(() => {});

 const collector = new TelemetryCollector({
 publishableKey: TEST_PK,
 });

 const circularPayload = (() => {
 const obj: any = { test: 'value' };
 obj.self = obj;
 return obj;
 })();

 expect(() => {
 collector.record({ event: 'TEST_EVENT', payload: circularPayload });
 }).not.toThrow();

 expect(consoleErrorSpy).toHaveBeenCalledWith(
 '[clerk/telemetry] Error recording telemetry event',
 expect.any(Error),
 );

 consoleErrorSpy.mockRestore();
 });

 test('record() method handles errors gracefully and continues operation', () => {
 const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(() => {});

 const collector = new TelemetryCollector({
 publishableKey: TEST_PK,
 });

 const problematicPayload = (() => {
 const obj: any = { test: 'value' };
 obj.self = obj;
 return obj;
 })();

 expect(() => {
 collector.record({ event: 'TEST_EVENT', payload: problematicPayload });
 }).not.toThrow();

 expect(consoleErrorSpy).toHaveBeenCalledWith(
 '[clerk/telemetry] Error recording telemetry event',
 expect.any(Error),
 );

 expect(() => {
 collector.record({ event: 'TEST_EVENT', payload: { normal: 'data' } });
 }).not.toThrow();

 jest.runAllTimers();
 expect(fetchSpy).toHaveBeenCalled();

 consoleErrorSpy.mockRestore();
 });
 });
});

91 changes: 49 additions & 42 deletions
packages/shared/src/telemetry/collector.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -176,17 +176,21 @@ export class TelemetryCollector implements TelemetryCollectorInterface {
 }

 record(event: TelemetryEventRaw): void {
 const preparedPayload = this.#preparePayload(event.event, event.payload);
 try {
 const preparedPayload = this.#preparePayload(event.event, event.payload);

 this.#logEvent(preparedPayload.event, preparedPayload);
this.#logEvent(preparedPayload.event, preparedPayload);

 if (!this.#shouldRecord(preparedPayload, event.eventSamplingRate)) {
 return;
 }
if (!this.#shouldRecord(preparedPayload, event.eventSamplingRate)) {
return;
}

 this.#buffer.push({ kind: 'event', value: preparedPayload });
this.#buffer.push({ kind: 'event', value: preparedPayload });

 this.#scheduleFlush();
 this.#scheduleFlush();
 } catch (error) {
 console.error('[clerk/telemetry] Error recording telemetry event', error);
 }
 }

 /**
Expand All@@ -195,49 +199,53 @@ export class TelemetryCollector implements TelemetryCollectorInterface {
 * @param entry - The telemetry log entry to record.
 */
 recordLog(entry: TelemetryLogEntry): void {
 if (!this.#shouldRecordLog(entry)) {
 return;
 }
 try {
 if (!this.#shouldRecordLog(entry)) {
 return;
 }

 const levelIsValid = typeof entry?.level === 'string' && VALID_LOG_LEVELS.has(entry.level);
 const messageIsValid = typeof entry?.message === 'string' && entry.message.trim().length > 0;
const levelIsValid = typeof entry?.level === 'string' && VALID_LOG_LEVELS.has(entry.level);
const messageIsValid = typeof entry?.message === 'string' && entry.message.trim().length > 0;

 let normalizedTimestamp: Date | null = null;
 const timestampInput: unknown = (entry as unknown as { timestamp?: unknown })?.timestamp;
 if (typeof timestampInput === 'number' || typeof timestampInput === 'string') {
 const candidate = new Date(timestampInput);
 if (!Number.isNaN(candidate.getTime())) {
 normalizedTimestamp = candidate;
 let normalizedTimestamp: Date | null = null;
 const timestampInput: unknown = (entry as unknown as { timestamp?: unknown })?.timestamp;
 if (typeof timestampInput === 'number' || typeof timestampInput === 'string') {
 const candidate = new Date(timestampInput);
 if (!Number.isNaN(candidate.getTime())) {
 normalizedTimestamp = candidate;
 }
 }
 }

 if (!levelIsValid || !messageIsValid || normalizedTimestamp === null) {
 if (this.isDebug && typeof console !== 'undefined') {
 console.warn('[clerk/telemetry] Dropping invalid telemetry log entry', {
 levelIsValid,
 messageIsValid,
 timestampIsValid: normalizedTimestamp !== null,
 });
 if (!levelIsValid || !messageIsValid || normalizedTimestamp === null) {
 if (this.isDebug && typeof console !== 'undefined') {
 console.warn('[clerk/telemetry] Dropping invalid telemetry log entry', {
 levelIsValid,
 messageIsValid,
 timestampIsValid: normalizedTimestamp !== null,
 });
 }
 return;
 }
 return;
 }

 const sdkMetadata = this.#getSDKMetadata();
const sdkMetadata = this.#getSDKMetadata();

 const logData: TelemetryLogData = {
 sdk: sdkMetadata.name,
 sdkv: sdkMetadata.version,
 cv: this.#metadata.clerkVersion ?? '',
 lvl: entry.level,
 msg: entry.message,
 ts: normalizedTimestamp.toISOString(),
 pk: this.#metadata.publishableKey || null,
 payload: this.#sanitizeContext(entry.context),
 };
const logData: TelemetryLogData = {
sdk: sdkMetadata.name,
sdkv: sdkMetadata.version,
cv: this.#metadata.clerkVersion ?? '',
lvl: entry.level,
msg: entry.message,
ts: normalizedTimestamp.toISOString(),
pk: this.#metadata.publishableKey || null,
payload: this.#sanitizeContext(entry.context),
};

 this.#buffer.push({ kind: 'log', value: logData });
this.#buffer.push({ kind: 'log', value: logData });

 this.#scheduleFlush();
 this.#scheduleFlush();
 } catch (error) {
 console.error('[clerk/telemetry] Error recording telemetry log entry', error);
 }
 }

 #shouldRecord(preparedPayload: TelemetryEvent, eventSamplingRate?: number) {
Expand DownExpand Up@@ -271,7 +279,6 @@ export class TelemetryCollector implements TelemetryCollectorInterface {
 this.#flush();
 return;
 }

 const isBufferFull = this.#buffer.length >= this.#config.maxBufferSize;
 if (isBufferFull) {
 // If the buffer is full, flush immediately to make sure we minimize the chance of event loss.
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
feat(shared): Do not allow telemetry errors to bubble up#6640

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

brkalow
merged 4 commits into

from

Aug 26, 2025
 Merged


feat(shared): Do not allow telemetry errors to bubble up
#6640
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
539d73c

feat(shared): Do not allow telemetry errors to bubble up


jacekradko Aug 26, 2025
bb4c3ee

changeset


jacekradko Aug 26, 2025
e3990c9

add tests


jacekradko Aug 26, 2025
bbedda4

wip


jacekradko Aug 26, 2025

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/thirty-cars-beg.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/shared': patch
---

Do not allow errors in telemetry to bubble up

89 changes: 82 additions & 7 deletions
packages/shared/src/__tests__/telemetry.logs.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -49,7 +49,6 @@ describe('TelemetryCollector.recordLog', () => {
 expect(log.iid).toBeUndefined();
 expect(log.ts).toBe(new Date(ts).toISOString());
 expect(log.pk).toBe(TEST_PK);
 // Function and undefined stripped out
 expect(log.payload).toEqual({ a: 1 });
 });

Expand All@@ -62,7 +61,6 @@ describe('TelemetryCollector.recordLog', () => {
 timestamp: Date.now(),
 };

 // undefined context
 fetchSpy.mockClear();
 collector.recordLog({ ...base, context: undefined } as any);
 jest.runAllTimers();
Expand All@@ -71,7 +69,6 @@ describe('TelemetryCollector.recordLog', () => {
 let body = JSON.parse(initOptions1.body as string);
 expect(body.logs[0].payload).toBeNull();

 // array context
 fetchSpy.mockClear();
 collector.recordLog({ ...base, context: [1, 2, 3] } as any);
 jest.runAllTimers();
Expand All@@ -80,7 +77,6 @@ describe('TelemetryCollector.recordLog', () => {
 body = JSON.parse(initOptions2.body as string);
 expect(body.logs[0].payload).toBeNull();

 // circular context
 fetchSpy.mockClear();
 const circular: any = { foo: 'bar' };
 circular.self = circular;
Expand All@@ -95,7 +91,6 @@ describe('TelemetryCollector.recordLog', () => {
 test('drops invalid entries: missing id, invalid level, empty message, invalid timestamp', () => {
 const collector = new TelemetryCollector({ publishableKey: TEST_PK });

 // invalid level
 fetchSpy.mockClear();
 collector.recordLog({
 level: 'fatal' as unknown as any,
Expand All@@ -105,7 +100,6 @@ describe('TelemetryCollector.recordLog', () => {
 jest.runAllTimers();
 expect(fetchSpy).not.toHaveBeenCalled();

 // empty message
 fetchSpy.mockClear();
 collector.recordLog({
 level: 'debug',
Expand All@@ -115,7 +109,6 @@ describe('TelemetryCollector.recordLog', () => {
 jest.runAllTimers();
 expect(fetchSpy).not.toHaveBeenCalled();

 // invalid timestamp (NaN)
 fetchSpy.mockClear();
 collector.recordLog({
 level: 'warn',
Expand DownExpand Up@@ -144,4 +137,86 @@ describe('TelemetryCollector.recordLog', () => {
 const body = JSON.parse(initOptions4.body as string);
 expect(body.logs[0].ts).toBe(new Date(tsString).toISOString());
 });

 describe('error handling', () => {
 test('recordLog() method handles circular references in context gracefully', () => {
 const collector = new TelemetryCollector({ publishableKey: TEST_PK });

 const circularContext = (() => {
 const obj: any = { test: 'value' };
 obj.self = obj;
 return obj;
 })();

 expect(() => {
 collector.recordLog({
 level: 'info',
 message: 'test message',
 timestamp: Date.now(),
 context: circularContext,
 });
 }).not.toThrow();

 jest.runAllTimers();
 expect(fetchSpy).toHaveBeenCalled();

 const [url, init] = fetchSpy.mock.calls[0];
 expect(String(url)).toMatch('/v1/logs');

 const initOptions = init as RequestInit;
 const body = JSON.parse(initOptions.body as string);
 expect(body.logs[0].payload).toBeNull();
 });

 test('recordLog() method handles non-serializable context gracefully', () => {
 const collector = new TelemetryCollector({ publishableKey: TEST_PK });

 const nonSerializableContext = {
 function: () => 'test',
 undefined: undefined,
 symbol: Symbol('test'),
 circular: (() => {
 const obj: any = { test: 'value' };
 obj.self = obj;
 return obj;
 })(),
 };

 expect(() => {
 collector.recordLog({
 level: 'info',
 message: 'test message',
 timestamp: Date.now(),
 context: nonSerializableContext,
 });
 }).not.toThrow();

 jest.runAllTimers();
 expect(fetchSpy).toHaveBeenCalled();

 const [url, init] = fetchSpy.mock.calls[0];
 expect(String(url)).toMatch('/v1/logs');

 const initOptions = init as RequestInit;
 const body = JSON.parse(initOptions.body as string);
 expect(body.logs[0].payload).toBeNull();
 });

 test('recordLog() method handles invalid timestamp gracefully', () => {
 const collector = new TelemetryCollector({ publishableKey: TEST_PK });

 const invalidTimestamp = new Date('invalid date');

 expect(() => {
 collector.recordLog({
 level: 'info',
 message: 'test message',
 timestamp: invalidTimestamp.getTime(),
 });
 }).not.toThrow();

 jest.runAllTimers();
 expect(fetchSpy).not.toHaveBeenCalled();
 });
 });
});

59 changes: 59 additions & 0 deletions
packages/shared/src/__tests__/telemetry.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -392,4 +392,63 @@ describe('TelemetryCollector', () => {
 fetchSpy.mockRestore();
 });
 });

 describe('error handling', () => {
 test('record() method does not bubble up errors from internal operations', () => {
 const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(() => {});

 const collector = new TelemetryCollector({
 publishableKey: TEST_PK,
 });

 const circularPayload = (() => {
 const obj: any = { test: 'value' };
 obj.self = obj;
 return obj;
 })();

 expect(() => {
 collector.record({ event: 'TEST_EVENT', payload: circularPayload });
 }).not.toThrow();

 expect(consoleErrorSpy).toHaveBeenCalledWith(
 '[clerk/telemetry] Error recording telemetry event',
 expect.any(Error),
 );

 consoleErrorSpy.mockRestore();
 });

 test('record() method handles errors gracefully and continues operation', () => {
 const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(() => {});

 const collector = new TelemetryCollector({
 publishableKey: TEST_PK,
 });

 const problematicPayload = (() => {
 const obj: any = { test: 'value' };
 obj.self = obj;
 return obj;
 })();

 expect(() => {
 collector.record({ event: 'TEST_EVENT', payload: problematicPayload });
 }).not.toThrow();

 expect(consoleErrorSpy).toHaveBeenCalledWith(
 '[clerk/telemetry] Error recording telemetry event',
 expect.any(Error),
 );

 expect(() => {
 collector.record({ event: 'TEST_EVENT', payload: { normal: 'data' } });
 }).not.toThrow();

 jest.runAllTimers();
 expect(fetchSpy).toHaveBeenCalled();

 consoleErrorSpy.mockRestore();
 });
 });
});

91 changes: 49 additions & 42 deletions
packages/shared/src/telemetry/collector.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -176,17 +176,21 @@ export class TelemetryCollector implements TelemetryCollectorInterface {
 }

 record(event: TelemetryEventRaw): void {
 const preparedPayload = this.#preparePayload(event.event, event.payload);
 try {
 const preparedPayload = this.#preparePayload(event.event, event.payload);

 this.#logEvent(preparedPayload.event, preparedPayload);
this.#logEvent(preparedPayload.event, preparedPayload);

 if (!this.#shouldRecord(preparedPayload, event.eventSamplingRate)) {
 return;
 }
if (!this.#shouldRecord(preparedPayload, event.eventSamplingRate)) {
return;
}

 this.#buffer.push({ kind: 'event', value: preparedPayload });
this.#buffer.push({ kind: 'event', value: preparedPayload });

 this.#scheduleFlush();
 this.#scheduleFlush();
 } catch (error) {
 console.error('[clerk/telemetry] Error recording telemetry event', error);
 }
 }

 /**
Expand All@@ -195,49 +199,53 @@ export class TelemetryCollector implements TelemetryCollectorInterface {
 * @param entry - The telemetry log entry to record.
 */
 recordLog(entry: TelemetryLogEntry): void {
 if (!this.#shouldRecordLog(entry)) {
 return;
 }
 try {
 if (!this.#shouldRecordLog(entry)) {
 return;
 }

 const levelIsValid = typeof entry?.level === 'string' && VALID_LOG_LEVELS.has(entry.level);
 const messageIsValid = typeof entry?.message === 'string' && entry.message.trim().length > 0;
const levelIsValid = typeof entry?.level === 'string' && VALID_LOG_LEVELS.has(entry.level);
const messageIsValid = typeof entry?.message === 'string' && entry.message.trim().length > 0;

 let normalizedTimestamp: Date | null = null;
 const timestampInput: unknown = (entry as unknown as { timestamp?: unknown })?.timestamp;
 if (typeof timestampInput === 'number' || typeof timestampInput === 'string') {
 const candidate = new Date(timestampInput);
 if (!Number.isNaN(candidate.getTime())) {
 normalizedTimestamp = candidate;
 let normalizedTimestamp: Date | null = null;
 const timestampInput: unknown = (entry as unknown as { timestamp?: unknown })?.timestamp;
 if (typeof timestampInput === 'number' || typeof timestampInput === 'string') {
 const candidate = new Date(timestampInput);
 if (!Number.isNaN(candidate.getTime())) {
 normalizedTimestamp = candidate;
 }
 }
 }

 if (!levelIsValid || !messageIsValid || normalizedTimestamp === null) {
 if (this.isDebug && typeof console !== 'undefined') {
 console.warn('[clerk/telemetry] Dropping invalid telemetry log entry', {
 levelIsValid,
 messageIsValid,
 timestampIsValid: normalizedTimestamp !== null,
 });
 if (!levelIsValid || !messageIsValid || normalizedTimestamp === null) {
 if (this.isDebug && typeof console !== 'undefined') {
 console.warn('[clerk/telemetry] Dropping invalid telemetry log entry', {
 levelIsValid,
 messageIsValid,
 timestampIsValid: normalizedTimestamp !== null,
 });
 }
 return;
 }
 return;
 }

 const sdkMetadata = this.#getSDKMetadata();
const sdkMetadata = this.#getSDKMetadata();

 const logData: TelemetryLogData = {
 sdk: sdkMetadata.name,
 sdkv: sdkMetadata.version,
 cv: this.#metadata.clerkVersion ?? '',
 lvl: entry.level,
 msg: entry.message,
 ts: normalizedTimestamp.toISOString(),
 pk: this.#metadata.publishableKey || null,
 payload: this.#sanitizeContext(entry.context),
 };
const logData: TelemetryLogData = {
sdk: sdkMetadata.name,
sdkv: sdkMetadata.version,
cv: this.#metadata.clerkVersion ?? '',
lvl: entry.level,
msg: entry.message,
ts: normalizedTimestamp.toISOString(),
pk: this.#metadata.publishableKey || null,
payload: this.#sanitizeContext(entry.context),
};

 this.#buffer.push({ kind: 'log', value: logData });
this.#buffer.push({ kind: 'log', value: logData });

 this.#scheduleFlush();
 this.#scheduleFlush();
 } catch (error) {
 console.error('[clerk/telemetry] Error recording telemetry log entry', error);
 }
 }

 #shouldRecord(preparedPayload: TelemetryEvent, eventSamplingRate?: number) {
Expand DownExpand Up@@ -271,7 +279,6 @@ export class TelemetryCollector implements TelemetryCollectorInterface {
 this.#flush();
 return;
 }

 const isBufferFull = this.#buffer.length >= this.#config.maxBufferSize;
 if (isBufferFull) {
 // If the buffer is full, flush immediately to make sure we minimize the chance of event loss.
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(shared): Do not allow telemetry errors to bubble up#6640

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

brkalow
merged 4 commits into

from

Aug 26, 2025
 Merged


feat(shared): Do not allow telemetry errors to bubble up
#6640
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
539d73c

feat(shared): Do not allow telemetry errors to bubble up


jacekradko Aug 26, 2025
bb4c3ee

changeset


jacekradko Aug 26, 2025
e3990c9

add tests


jacekradko Aug 26, 2025
bbedda4

wip


jacekradko Aug 26, 2025

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/thirty-cars-beg.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/shared': patch
---

Do not allow errors in telemetry to bubble up

89 changes: 82 additions & 7 deletions
packages/shared/src/__tests__/telemetry.logs.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -49,7 +49,6 @@ describe('TelemetryCollector.recordLog', () => {
 expect(log.iid).toBeUndefined();
 expect(log.ts).toBe(new Date(ts).toISOString());
 expect(log.pk).toBe(TEST_PK);
 // Function and undefined stripped out
 expect(log.payload).toEqual({ a: 1 });
 });

Expand All@@ -62,7 +61,6 @@ describe('TelemetryCollector.recordLog', () => {
 timestamp: Date.now(),
 };

 // undefined context
 fetchSpy.mockClear();
 collector.recordLog({ ...base, context: undefined } as any);
 jest.runAllTimers();
Expand All@@ -71,7 +69,6 @@ describe('TelemetryCollector.recordLog', () => {
 let body = JSON.parse(initOptions1.body as string);
 expect(body.logs[0].payload).toBeNull();

 // array context
 fetchSpy.mockClear();
 collector.recordLog({ ...base, context: [1, 2, 3] } as any);
 jest.runAllTimers();
Expand All@@ -80,7 +77,6 @@ describe('TelemetryCollector.recordLog', () => {
 body = JSON.parse(initOptions2.body as string);
 expect(body.logs[0].payload).toBeNull();

 // circular context
 fetchSpy.mockClear();
 const circular: any = { foo: 'bar' };
 circular.self = circular;
Expand All@@ -95,7 +91,6 @@ describe('TelemetryCollector.recordLog', () => {
 test('drops invalid entries: missing id, invalid level, empty message, invalid timestamp', () => {
 const collector = new TelemetryCollector({ publishableKey: TEST_PK });

 // invalid level
 fetchSpy.mockClear();
 collector.recordLog({
 level: 'fatal' as unknown as any,
Expand All@@ -105,7 +100,6 @@ describe('TelemetryCollector.recordLog', () => {
 jest.runAllTimers();
 expect(fetchSpy).not.toHaveBeenCalled();

 // empty message
 fetchSpy.mockClear();
 collector.recordLog({
 level: 'debug',
Expand All@@ -115,7 +109,6 @@ describe('TelemetryCollector.recordLog', () => {
 jest.runAllTimers();
 expect(fetchSpy).not.toHaveBeenCalled();

 // invalid timestamp (NaN)
 fetchSpy.mockClear();
 collector.recordLog({
 level: 'warn',
Expand DownExpand Up@@ -144,4 +137,86 @@ describe('TelemetryCollector.recordLog', () => {
 const body = JSON.parse(initOptions4.body as string);
 expect(body.logs[0].ts).toBe(new Date(tsString).toISOString());
 });

 describe('error handling', () => {
 test('recordLog() method handles circular references in context gracefully', () => {
 const collector = new TelemetryCollector({ publishableKey: TEST_PK });

 const circularContext = (() => {
 const obj: any = { test: 'value' };
 obj.self = obj;
 return obj;
 })();

 expect(() => {
 collector.recordLog({
 level: 'info',
 message: 'test message',
 timestamp: Date.now(),
 context: circularContext,
 });
 }).not.toThrow();

 jest.runAllTimers();
 expect(fetchSpy).toHaveBeenCalled();

 const [url, init] = fetchSpy.mock.calls[0];
 expect(String(url)).toMatch('/v1/logs');

 const initOptions = init as RequestInit;
 const body = JSON.parse(initOptions.body as string);
 expect(body.logs[0].payload).toBeNull();
 });

 test('recordLog() method handles non-serializable context gracefully', () => {
 const collector = new TelemetryCollector({ publishableKey: TEST_PK });

 const nonSerializableContext = {
 function: () => 'test',
 undefined: undefined,
 symbol: Symbol('test'),
 circular: (() => {
 const obj: any = { test: 'value' };
 obj.self = obj;
 return obj;
 })(),
 };

 expect(() => {
 collector.recordLog({
 level: 'info',
 message: 'test message',
 timestamp: Date.now(),
 context: nonSerializableContext,
 });
 }).not.toThrow();

 jest.runAllTimers();
 expect(fetchSpy).toHaveBeenCalled();

 const [url, init] = fetchSpy.mock.calls[0];
 expect(String(url)).toMatch('/v1/logs');

 const initOptions = init as RequestInit;
 const body = JSON.parse(initOptions.body as string);
 expect(body.logs[0].payload).toBeNull();
 });

 test('recordLog() method handles invalid timestamp gracefully', () => {
 const collector = new TelemetryCollector({ publishableKey: TEST_PK });

 const invalidTimestamp = new Date('invalid date');

 expect(() => {
 collector.recordLog({
 level: 'info',
 message: 'test message',
 timestamp: invalidTimestamp.getTime(),
 });
 }).not.toThrow();

 jest.runAllTimers();
 expect(fetchSpy).not.toHaveBeenCalled();
 });
 });
});

59 changes: 59 additions & 0 deletions
packages/shared/src/__tests__/telemetry.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -392,4 +392,63 @@ describe('TelemetryCollector', () => {
 fetchSpy.mockRestore();
 });
 });

 describe('error handling', () => {
 test('record() method does not bubble up errors from internal operations', () => {
 const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(() => {});

 const collector = new TelemetryCollector({
 publishableKey: TEST_PK,
 });

 const circularPayload = (() => {
 const obj: any = { test: 'value' };
 obj.self = obj;
 return obj;
 })();

 expect(() => {
 collector.record({ event: 'TEST_EVENT', payload: circularPayload });
 }).not.toThrow();

 expect(consoleErrorSpy).toHaveBeenCalledWith(
 '[clerk/telemetry] Error recording telemetry event',
 expect.any(Error),
 );

 consoleErrorSpy.mockRestore();
 });

 test('record() method handles errors gracefully and continues operation', () => {
 const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(() => {});

 const collector = new TelemetryCollector({
 publishableKey: TEST_PK,
 });

 const problematicPayload = (() => {
 const obj: any = { test: 'value' };
 obj.self = obj;
 return obj;
 })();

 expect(() => {
 collector.record({ event: 'TEST_EVENT', payload: problematicPayload });
 }).not.toThrow();

 expect(consoleErrorSpy).toHaveBeenCalledWith(
 '[clerk/telemetry] Error recording telemetry event',
 expect.any(Error),
 );

 expect(() => {
 collector.record({ event: 'TEST_EVENT', payload: { normal: 'data' } });
 }).not.toThrow();

 jest.runAllTimers();
 expect(fetchSpy).toHaveBeenCalled();

 consoleErrorSpy.mockRestore();
 });
 });
});

91 changes: 49 additions & 42 deletions
packages/shared/src/telemetry/collector.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -176,17 +176,21 @@ export class TelemetryCollector implements TelemetryCollectorInterface {
 }

 record(event: TelemetryEventRaw): void {
 const preparedPayload = this.#preparePayload(event.event, event.payload);
 try {
 const preparedPayload = this.#preparePayload(event.event, event.payload);

 this.#logEvent(preparedPayload.event, preparedPayload);
this.#logEvent(preparedPayload.event, preparedPayload);

 if (!this.#shouldRecord(preparedPayload, event.eventSamplingRate)) {
 return;
 }
if (!this.#shouldRecord(preparedPayload, event.eventSamplingRate)) {
return;
}

 this.#buffer.push({ kind: 'event', value: preparedPayload });
this.#buffer.push({ kind: 'event', value: preparedPayload });

 this.#scheduleFlush();
 this.#scheduleFlush();
 } catch (error) {
 console.error('[clerk/telemetry] Error recording telemetry event', error);
 }
 }

 /**
Expand All@@ -195,49 +199,53 @@ export class TelemetryCollector implements TelemetryCollectorInterface {
 * @param entry - The telemetry log entry to record.
 */
 recordLog(entry: TelemetryLogEntry): void {
 if (!this.#shouldRecordLog(entry)) {
 return;
 }
 try {
 if (!this.#shouldRecordLog(entry)) {
 return;
 }

 const levelIsValid = typeof entry?.level === 'string' && VALID_LOG_LEVELS.has(entry.level);
 const messageIsValid = typeof entry?.message === 'string' && entry.message.trim().length > 0;
const levelIsValid = typeof entry?.level === 'string' && VALID_LOG_LEVELS.has(entry.level);
const messageIsValid = typeof entry?.message === 'string' && entry.message.trim().length > 0;

 let normalizedTimestamp: Date | null = null;
 const timestampInput: unknown = (entry as unknown as { timestamp?: unknown })?.timestamp;
 if (typeof timestampInput === 'number' || typeof timestampInput === 'string') {
 const candidate = new Date(timestampInput);
 if (!Number.isNaN(candidate.getTime())) {
 normalizedTimestamp = candidate;
 let normalizedTimestamp: Date | null = null;
 const timestampInput: unknown = (entry as unknown as { timestamp?: unknown })?.timestamp;
 if (typeof timestampInput === 'number' || typeof timestampInput === 'string') {
 const candidate = new Date(timestampInput);
 if (!Number.isNaN(candidate.getTime())) {
 normalizedTimestamp = candidate;
 }
 }
 }

 if (!levelIsValid || !messageIsValid || normalizedTimestamp === null) {
 if (this.isDebug && typeof console !== 'undefined') {
 console.warn('[clerk/telemetry] Dropping invalid telemetry log entry', {
 levelIsValid,
 messageIsValid,
 timestampIsValid: normalizedTimestamp !== null,
 });
 if (!levelIsValid || !messageIsValid || normalizedTimestamp === null) {
 if (this.isDebug && typeof console !== 'undefined') {
 console.warn('[clerk/telemetry] Dropping invalid telemetry log entry', {
 levelIsValid,
 messageIsValid,
 timestampIsValid: normalizedTimestamp !== null,
 });
 }
 return;
 }
 return;
 }

 const sdkMetadata = this.#getSDKMetadata();
const sdkMetadata = this.#getSDKMetadata();

 const logData: TelemetryLogData = {
 sdk: sdkMetadata.name,
 sdkv: sdkMetadata.version,
 cv: this.#metadata.clerkVersion ?? '',
 lvl: entry.level,
 msg: entry.message,
 ts: normalizedTimestamp.toISOString(),
 pk: this.#metadata.publishableKey || null,
 payload: this.#sanitizeContext(entry.context),
 };
const logData: TelemetryLogData = {
sdk: sdkMetadata.name,
sdkv: sdkMetadata.version,
cv: this.#metadata.clerkVersion ?? '',
lvl: entry.level,
msg: entry.message,
ts: normalizedTimestamp.toISOString(),
pk: this.#metadata.publishableKey || null,
payload: this.#sanitizeContext(entry.context),
};

 this.#buffer.push({ kind: 'log', value: logData });
this.#buffer.push({ kind: 'log', value: logData });

 this.#scheduleFlush();
 this.#scheduleFlush();
 } catch (error) {
 console.error('[clerk/telemetry] Error recording telemetry log entry', error);
 }
 }

 #shouldRecord(preparedPayload: TelemetryEvent, eventSamplingRate?: number) {
Expand DownExpand Up@@ -271,7 +279,6 @@ export class TelemetryCollector implements TelemetryCollectorInterface {
 this.#flush();
 return;
 }

 const isBufferFull = this.#buffer.length >= this.#config.maxBufferSize;
 if (isBufferFull) {
 // If the buffer is full, flush immediately to make sure we minimize the chance of event loss.
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(shared): Do not allow telemetry errors to bubble up#6640

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

brkalow
merged 4 commits into

from

Aug 26, 2025
 Merged


feat(shared): Do not allow telemetry errors to bubble up
#6640
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
539d73c

feat(shared): Do not allow telemetry errors to bubble up


jacekradko Aug 26, 2025
bb4c3ee

changeset


jacekradko Aug 26, 2025
e3990c9

add tests


jacekradko Aug 26, 2025
bbedda4

wip


jacekradko Aug 26, 2025

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/thirty-cars-beg.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/shared': patch
---

Do not allow errors in telemetry to bubble up

89 changes: 82 additions & 7 deletions
packages/shared/src/__tests__/telemetry.logs.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -49,7 +49,6 @@ describe('TelemetryCollector.recordLog', () => {
 expect(log.iid).toBeUndefined();
 expect(log.ts).toBe(new Date(ts).toISOString());
 expect(log.pk).toBe(TEST_PK);
 // Function and undefined stripped out
 expect(log.payload).toEqual({ a: 1 });
 });

Expand All@@ -62,7 +61,6 @@ describe('TelemetryCollector.recordLog', () => {
 timestamp: Date.now(),
 };

 // undefined context
 fetchSpy.mockClear();
 collector.recordLog({ ...base, context: undefined } as any);
 jest.runAllTimers();
Expand All@@ -71,7 +69,6 @@ describe('TelemetryCollector.recordLog', () => {
 let body = JSON.parse(initOptions1.body as string);
 expect(body.logs[0].payload).toBeNull();

 // array context
 fetchSpy.mockClear();
 collector.recordLog({ ...base, context: [1, 2, 3] } as any);
 jest.runAllTimers();
Expand All@@ -80,7 +77,6 @@ describe('TelemetryCollector.recordLog', () => {
 body = JSON.parse(initOptions2.body as string);
 expect(body.logs[0].payload).toBeNull();

 // circular context
 fetchSpy.mockClear();
 const circular: any = { foo: 'bar' };
 circular.self = circular;
Expand All@@ -95,7 +91,6 @@ describe('TelemetryCollector.recordLog', () => {
 test('drops invalid entries: missing id, invalid level, empty message, invalid timestamp', () => {
 const collector = new TelemetryCollector({ publishableKey: TEST_PK });

 // invalid level
 fetchSpy.mockClear();
 collector.recordLog({
 level: 'fatal' as unknown as any,
Expand All@@ -105,7 +100,6 @@ describe('TelemetryCollector.recordLog', () => {
 jest.runAllTimers();
 expect(fetchSpy).not.toHaveBeenCalled();

 // empty message
 fetchSpy.mockClear();
 collector.recordLog({
 level: 'debug',
Expand All@@ -115,7 +109,6 @@ describe('TelemetryCollector.recordLog', () => {
 jest.runAllTimers();
 expect(fetchSpy).not.toHaveBeenCalled();

 // invalid timestamp (NaN)
 fetchSpy.mockClear();
 collector.recordLog({
 level: 'warn',
Expand DownExpand Up@@ -144,4 +137,86 @@ describe('TelemetryCollector.recordLog', () => {
 const body = JSON.parse(initOptions4.body as string);
 expect(body.logs[0].ts).toBe(new Date(tsString).toISOString());
 });

 describe('error handling', () => {
 test('recordLog() method handles circular references in context gracefully', () => {
 const collector = new TelemetryCollector({ publishableKey: TEST_PK });

 const circularContext = (() => {
 const obj: any = { test: 'value' };
 obj.self = obj;
 return obj;
 })();

 expect(() => {
 collector.recordLog({
 level: 'info',
 message: 'test message',
 timestamp: Date.now(),
 context: circularContext,
 });
 }).not.toThrow();

 jest.runAllTimers();
 expect(fetchSpy).toHaveBeenCalled();

 const [url, init] = fetchSpy.mock.calls[0];
 expect(String(url)).toMatch('/v1/logs');

 const initOptions = init as RequestInit;
 const body = JSON.parse(initOptions.body as string);
 expect(body.logs[0].payload).toBeNull();
 });

 test('recordLog() method handles non-serializable context gracefully', () => {
 const collector = new TelemetryCollector({ publishableKey: TEST_PK });

 const nonSerializableContext = {
 function: () => 'test',
 undefined: undefined,
 symbol: Symbol('test'),
 circular: (() => {
 const obj: any = { test: 'value' };
 obj.self = obj;
 return obj;
 })(),
 };

 expect(() => {
 collector.recordLog({
 level: 'info',
 message: 'test message',
 timestamp: Date.now(),
 context: nonSerializableContext,
 });
 }).not.toThrow();

 jest.runAllTimers();
 expect(fetchSpy).toHaveBeenCalled();

 const [url, init] = fetchSpy.mock.calls[0];
 expect(String(url)).toMatch('/v1/logs');

 const initOptions = init as RequestInit;
 const body = JSON.parse(initOptions.body as string);
 expect(body.logs[0].payload).toBeNull();
 });

 test('recordLog() method handles invalid timestamp gracefully', () => {
 const collector = new TelemetryCollector({ publishableKey: TEST_PK });

 const invalidTimestamp = new Date('invalid date');

 expect(() => {
 collector.recordLog({
 level: 'info',
 message: 'test message',
 timestamp: invalidTimestamp.getTime(),
 });
 }).not.toThrow();

 jest.runAllTimers();
 expect(fetchSpy).not.toHaveBeenCalled();
 });
 });
});

59 changes: 59 additions & 0 deletions
packages/shared/src/__tests__/telemetry.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -392,4 +392,63 @@ describe('TelemetryCollector', () => {
 fetchSpy.mockRestore();
 });
 });

 describe('error handling', () => {
 test('record() method does not bubble up errors from internal operations', () => {
 const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(() => {});

 const collector = new TelemetryCollector({
 publishableKey: TEST_PK,
 });

 const circularPayload = (() => {
 const obj: any = { test: 'value' };
 obj.self = obj;
 return obj;
 })();

 expect(() => {
 collector.record({ event: 'TEST_EVENT', payload: circularPayload });
 }).not.toThrow();

 expect(consoleErrorSpy).toHaveBeenCalledWith(
 '[clerk/telemetry] Error recording telemetry event',
 expect.any(Error),
 );

 consoleErrorSpy.mockRestore();
 });

 test('record() method handles errors gracefully and continues operation', () => {
 const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(() => {});

 const collector = new TelemetryCollector({
 publishableKey: TEST_PK,
 });

 const problematicPayload = (() => {
 const obj: any = { test: 'value' };
 obj.self = obj;
 return obj;
 })();

 expect(() => {
 collector.record({ event: 'TEST_EVENT', payload: problematicPayload });
 }).not.toThrow();

 expect(consoleErrorSpy).toHaveBeenCalledWith(
 '[clerk/telemetry] Error recording telemetry event',
 expect.any(Error),
 );

 expect(() => {
 collector.record({ event: 'TEST_EVENT', payload: { normal: 'data' } });
 }).not.toThrow();

 jest.runAllTimers();
 expect(fetchSpy).toHaveBeenCalled();

 consoleErrorSpy.mockRestore();
 });
 });
});

91 changes: 49 additions & 42 deletions
packages/shared/src/telemetry/collector.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -176,17 +176,21 @@ export class TelemetryCollector implements TelemetryCollectorInterface {
 }

 record(event: TelemetryEventRaw): void {
 const preparedPayload = this.#preparePayload(event.event, event.payload);
 try {
 const preparedPayload = this.#preparePayload(event.event, event.payload);

 this.#logEvent(preparedPayload.event, preparedPayload);
this.#logEvent(preparedPayload.event, preparedPayload);

 if (!this.#shouldRecord(preparedPayload, event.eventSamplingRate)) {
 return;
 }
if (!this.#shouldRecord(preparedPayload, event.eventSamplingRate)) {
return;
}

 this.#buffer.push({ kind: 'event', value: preparedPayload });
this.#buffer.push({ kind: 'event', value: preparedPayload });

 this.#scheduleFlush();
 this.#scheduleFlush();
 } catch (error) {
 console.error('[clerk/telemetry] Error recording telemetry event', error);
 }
 }

 /**
Expand All@@ -195,49 +199,53 @@ export class TelemetryCollector implements TelemetryCollectorInterface {
 * @param entry - The telemetry log entry to record.
 */
 recordLog(entry: TelemetryLogEntry): void {
 if (!this.#shouldRecordLog(entry)) {
 return;
 }
 try {
 if (!this.#shouldRecordLog(entry)) {
 return;
 }

 const levelIsValid = typeof entry?.level === 'string' && VALID_LOG_LEVELS.has(entry.level);
 const messageIsValid = typeof entry?.message === 'string' && entry.message.trim().length > 0;
const levelIsValid = typeof entry?.level === 'string' && VALID_LOG_LEVELS.has(entry.level);
const messageIsValid = typeof entry?.message === 'string' && entry.message.trim().length > 0;

 let normalizedTimestamp: Date | null = null;
 const timestampInput: unknown = (entry as unknown as { timestamp?: unknown })?.timestamp;
 if (typeof timestampInput === 'number' || typeof timestampInput === 'string') {
 const candidate = new Date(timestampInput);
 if (!Number.isNaN(candidate.getTime())) {
 normalizedTimestamp = candidate;
 let normalizedTimestamp: Date | null = null;
 const timestampInput: unknown = (entry as unknown as { timestamp?: unknown })?.timestamp;
 if (typeof timestampInput === 'number' || typeof timestampInput === 'string') {
 const candidate = new Date(timestampInput);
 if (!Number.isNaN(candidate.getTime())) {
 normalizedTimestamp = candidate;
 }
 }
 }

 if (!levelIsValid || !messageIsValid || normalizedTimestamp === null) {
 if (this.isDebug && typeof console !== 'undefined') {
 console.warn('[clerk/telemetry] Dropping invalid telemetry log entry', {
 levelIsValid,
 messageIsValid,
 timestampIsValid: normalizedTimestamp !== null,
 });
 if (!levelIsValid || !messageIsValid || normalizedTimestamp === null) {
 if (this.isDebug && typeof console !== 'undefined') {
 console.warn('[clerk/telemetry] Dropping invalid telemetry log entry', {
 levelIsValid,
 messageIsValid,
 timestampIsValid: normalizedTimestamp !== null,
 });
 }
 return;
 }
 return;
 }

 const sdkMetadata = this.#getSDKMetadata();
const sdkMetadata = this.#getSDKMetadata();

 const logData: TelemetryLogData = {
 sdk: sdkMetadata.name,
 sdkv: sdkMetadata.version,
 cv: this.#metadata.clerkVersion ?? '',
 lvl: entry.level,
 msg: entry.message,
 ts: normalizedTimestamp.toISOString(),
 pk: this.#metadata.publishableKey || null,
 payload: this.#sanitizeContext(entry.context),
 };
const logData: TelemetryLogData = {
sdk: sdkMetadata.name,
sdkv: sdkMetadata.version,
cv: this.#metadata.clerkVersion ?? '',
lvl: entry.level,
msg: entry.message,
ts: normalizedTimestamp.toISOString(),
pk: this.#metadata.publishableKey || null,
payload: this.#sanitizeContext(entry.context),
};

 this.#buffer.push({ kind: 'log', value: logData });
this.#buffer.push({ kind: 'log', value: logData });

 this.#scheduleFlush();
 this.#scheduleFlush();
 } catch (error) {
 console.error('[clerk/telemetry] Error recording telemetry log entry', error);
 }
 }

 #shouldRecord(preparedPayload: TelemetryEvent, eventSamplingRate?: number) {
Expand DownExpand Up@@ -271,7 +279,6 @@ export class TelemetryCollector implements TelemetryCollectorInterface {
 this.#flush();
 return;
 }

 const isBufferFull = this.#buffer.length >= this.#config.maxBufferSize;
 if (isBufferFull) {
 // If the buffer is full, flush immediately to make sure we minimize the chance of event loss.
Expand Down

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

Skip to content
feat(shared): Do not allow telemetry errors to bubble up#6640

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

brkalow
merged 4 commits into

from

Aug 26, 2025
 Merged


feat(shared): Do not allow telemetry errors to bubble up
#6640
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
539d73c

feat(shared): Do not allow telemetry errors to bubble up


jacekradko Aug 26, 2025
bb4c3ee

changeset


jacekradko Aug 26, 2025
e3990c9

add tests


jacekradko Aug 26, 2025
bbedda4

wip


jacekradko Aug 26, 2025

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/thirty-cars-beg.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/shared': patch
---

Do not allow errors in telemetry to bubble up

89 changes: 82 additions & 7 deletions
packages/shared/src/__tests__/telemetry.logs.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -49,7 +49,6 @@ describe('TelemetryCollector.recordLog', () => {
 expect(log.iid).toBeUndefined();
 expect(log.ts).toBe(new Date(ts).toISOString());
 expect(log.pk).toBe(TEST_PK);
 // Function and undefined stripped out
 expect(log.payload).toEqual({ a: 1 });
 });

Expand All@@ -62,7 +61,6 @@ describe('TelemetryCollector.recordLog', () => {
 timestamp: Date.now(),
 };

 // undefined context
 fetchSpy.mockClear();
 collector.recordLog({ ...base, context: undefined } as any);
 jest.runAllTimers();
Expand All@@ -71,7 +69,6 @@ describe('TelemetryCollector.recordLog', () => {
 let body = JSON.parse(initOptions1.body as string);
 expect(body.logs[0].payload).toBeNull();

 // array context
 fetchSpy.mockClear();
 collector.recordLog({ ...base, context: [1, 2, 3] } as any);
 jest.runAllTimers();
Expand All@@ -80,7 +77,6 @@ describe('TelemetryCollector.recordLog', () => {
 body = JSON.parse(initOptions2.body as string);
 expect(body.logs[0].payload).toBeNull();

 // circular context
 fetchSpy.mockClear();
 const circular: any = { foo: 'bar' };
 circular.self = circular;
Expand All@@ -95,7 +91,6 @@ describe('TelemetryCollector.recordLog', () => {
 test('drops invalid entries: missing id, invalid level, empty message, invalid timestamp', () => {
 const collector = new TelemetryCollector({ publishableKey: TEST_PK });

 // invalid level
 fetchSpy.mockClear();
 collector.recordLog({
 level: 'fatal' as unknown as any,
Expand All@@ -105,7 +100,6 @@ describe('TelemetryCollector.recordLog', () => {
 jest.runAllTimers();
 expect(fetchSpy).not.toHaveBeenCalled();

 // empty message
 fetchSpy.mockClear();
 collector.recordLog({
 level: 'debug',
Expand All@@ -115,7 +109,6 @@ describe('TelemetryCollector.recordLog', () => {
 jest.runAllTimers();
 expect(fetchSpy).not.toHaveBeenCalled();

 // invalid timestamp (NaN)
 fetchSpy.mockClear();
 collector.recordLog({
 level: 'warn',
Expand DownExpand Up@@ -144,4 +137,86 @@ describe('TelemetryCollector.recordLog', () => {
 const body = JSON.parse(initOptions4.body as string);
 expect(body.logs[0].ts).toBe(new Date(tsString).toISOString());
 });

 describe('error handling', () => {
 test('recordLog() method handles circular references in context gracefully', () => {
 const collector = new TelemetryCollector({ publishableKey: TEST_PK });

 const circularContext = (() => {
 const obj: any = { test: 'value' };
 obj.self = obj;
 return obj;
 })();

 expect(() => {
 collector.recordLog({
 level: 'info',
 message: 'test message',
 timestamp: Date.now(),
 context: circularContext,
 });
 }).not.toThrow();

 jest.runAllTimers();
 expect(fetchSpy).toHaveBeenCalled();

 const [url, init] = fetchSpy.mock.calls[0];
 expect(String(url)).toMatch('/v1/logs');

 const initOptions = init as RequestInit;
 const body = JSON.parse(initOptions.body as string);
 expect(body.logs[0].payload).toBeNull();
 });

 test('recordLog() method handles non-serializable context gracefully', () => {
 const collector = new TelemetryCollector({ publishableKey: TEST_PK });

 const nonSerializableContext = {
 function: () => 'test',
 undefined: undefined,
 symbol: Symbol('test'),
 circular: (() => {
 const obj: any = { test: 'value' };
 obj.self = obj;
 return obj;
 })(),
 };

 expect(() => {
 collector.recordLog({
 level: 'info',
 message: 'test message',
 timestamp: Date.now(),
 context: nonSerializableContext,
 });
 }).not.toThrow();

 jest.runAllTimers();
 expect(fetchSpy).toHaveBeenCalled();

 const [url, init] = fetchSpy.mock.calls[0];
 expect(String(url)).toMatch('/v1/logs');

 const initOptions = init as RequestInit;
 const body = JSON.parse(initOptions.body as string);
 expect(body.logs[0].payload).toBeNull();
 });

 test('recordLog() method handles invalid timestamp gracefully', () => {
 const collector = new TelemetryCollector({ publishableKey: TEST_PK });

 const invalidTimestamp = new Date('invalid date');

 expect(() => {
 collector.recordLog({
 level: 'info',
 message: 'test message',
 timestamp: invalidTimestamp.getTime(),
 });
 }).not.toThrow();

 jest.runAllTimers();
 expect(fetchSpy).not.toHaveBeenCalled();
 });
 });
});

59 changes: 59 additions & 0 deletions
packages/shared/src/__tests__/telemetry.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -392,4 +392,63 @@ describe('TelemetryCollector', () => {
 fetchSpy.mockRestore();
 });
 });

 describe('error handling', () => {
 test('record() method does not bubble up errors from internal operations', () => {
 const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(() => {});

 const collector = new TelemetryCollector({
 publishableKey: TEST_PK,
 });

 const circularPayload = (() => {
 const obj: any = { test: 'value' };
 obj.self = obj;
 return obj;
 })();

 expect(() => {
 collector.record({ event: 'TEST_EVENT', payload: circularPayload });
 }).not.toThrow();

 expect(consoleErrorSpy).toHaveBeenCalledWith(
 '[clerk/telemetry] Error recording telemetry event',
 expect.any(Error),
 );

 consoleErrorSpy.mockRestore();
 });

 test('record() method handles errors gracefully and continues operation', () => {
 const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(() => {});

 const collector = new TelemetryCollector({
 publishableKey: TEST_PK,
 });

 const problematicPayload = (() => {
 const obj: any = { test: 'value' };
 obj.self = obj;
 return obj;
 })();

 expect(() => {
 collector.record({ event: 'TEST_EVENT', payload: problematicPayload });
 }).not.toThrow();

 expect(consoleErrorSpy).toHaveBeenCalledWith(
 '[clerk/telemetry] Error recording telemetry event',
 expect.any(Error),
 );

 expect(() => {
 collector.record({ event: 'TEST_EVENT', payload: { normal: 'data' } });
 }).not.toThrow();

 jest.runAllTimers();
 expect(fetchSpy).toHaveBeenCalled();

 consoleErrorSpy.mockRestore();
 });
 });
});

91 changes: 49 additions & 42 deletions
packages/shared/src/telemetry/collector.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -176,17 +176,21 @@ export class TelemetryCollector implements TelemetryCollectorInterface {
 }

 record(event: TelemetryEventRaw): void {
 const preparedPayload = this.#preparePayload(event.event, event.payload);
 try {
 const preparedPayload = this.#preparePayload(event.event, event.payload);

 this.#logEvent(preparedPayload.event, preparedPayload);
this.#logEvent(preparedPayload.event, preparedPayload);

 if (!this.#shouldRecord(preparedPayload, event.eventSamplingRate)) {
 return;
 }
if (!this.#shouldRecord(preparedPayload, event.eventSamplingRate)) {
return;
}

 this.#buffer.push({ kind: 'event', value: preparedPayload });
this.#buffer.push({ kind: 'event', value: preparedPayload });

 this.#scheduleFlush();
 this.#scheduleFlush();
 } catch (error) {
 console.error('[clerk/telemetry] Error recording telemetry event', error);
 }
 }

 /**
Expand All@@ -195,49 +199,53 @@ export class TelemetryCollector implements TelemetryCollectorInterface {
 * @param entry - The telemetry log entry to record.
 */
 recordLog(entry: TelemetryLogEntry): void {
 if (!this.#shouldRecordLog(entry)) {
 return;
 }
 try {
 if (!this.#shouldRecordLog(entry)) {
 return;
 }

 const levelIsValid = typeof entry?.level === 'string' && VALID_LOG_LEVELS.has(entry.level);
 const messageIsValid = typeof entry?.message === 'string' && entry.message.trim().length > 0;
const levelIsValid = typeof entry?.level === 'string' && VALID_LOG_LEVELS.has(entry.level);
const messageIsValid = typeof entry?.message === 'string' && entry.message.trim().length > 0;

 let normalizedTimestamp: Date | null = null;
 const timestampInput: unknown = (entry as unknown as { timestamp?: unknown })?.timestamp;
 if (typeof timestampInput === 'number' || typeof timestampInput === 'string') {
 const candidate = new Date(timestampInput);
 if (!Number.isNaN(candidate.getTime())) {
 normalizedTimestamp = candidate;
 let normalizedTimestamp: Date | null = null;
 const timestampInput: unknown = (entry as unknown as { timestamp?: unknown })?.timestamp;
 if (typeof timestampInput === 'number' || typeof timestampInput === 'string') {
 const candidate = new Date(timestampInput);
 if (!Number.isNaN(candidate.getTime())) {
 normalizedTimestamp = candidate;
 }
 }
 }

 if (!levelIsValid || !messageIsValid || normalizedTimestamp === null) {
 if (this.isDebug && typeof console !== 'undefined') {
 console.warn('[clerk/telemetry] Dropping invalid telemetry log entry', {
 levelIsValid,
 messageIsValid,
 timestampIsValid: normalizedTimestamp !== null,
 });
 if (!levelIsValid || !messageIsValid || normalizedTimestamp === null) {
 if (this.isDebug && typeof console !== 'undefined') {
 console.warn('[clerk/telemetry] Dropping invalid telemetry log entry', {
 levelIsValid,
 messageIsValid,
 timestampIsValid: normalizedTimestamp !== null,
 });
 }
 return;
 }
 return;
 }

 const sdkMetadata = this.#getSDKMetadata();
const sdkMetadata = this.#getSDKMetadata();

 const logData: TelemetryLogData = {
 sdk: sdkMetadata.name,
 sdkv: sdkMetadata.version,
 cv: this.#metadata.clerkVersion ?? '',
 lvl: entry.level,
 msg: entry.message,
 ts: normalizedTimestamp.toISOString(),
 pk: this.#metadata.publishableKey || null,
 payload: this.#sanitizeContext(entry.context),
 };
const logData: TelemetryLogData = {
sdk: sdkMetadata.name,
sdkv: sdkMetadata.version,
cv: this.#metadata.clerkVersion ?? '',
lvl: entry.level,
msg: entry.message,
ts: normalizedTimestamp.toISOString(),
pk: this.#metadata.publishableKey || null,
payload: this.#sanitizeContext(entry.context),
};

 this.#buffer.push({ kind: 'log', value: logData });
this.#buffer.push({ kind: 'log', value: logData });

 this.#scheduleFlush();
 this.#scheduleFlush();
 } catch (error) {
 console.error('[clerk/telemetry] Error recording telemetry log entry', error);
 }
 }

 #shouldRecord(preparedPayload: TelemetryEvent, eventSamplingRate?: number) {
Expand DownExpand Up@@ -271,7 +279,6 @@ export class TelemetryCollector implements TelemetryCollectorInterface {
 this.#flush();
 return;
 }

 const isBufferFull = this.#buffer.length >= this.#config.maxBufferSize;
 if (isBufferFull) {
 // If the buffer is full, flush immediately to make sure we minimize the chance of event loss.
Expand Down