feat(shared): Do not allow telemetry errors to bubble up #6640
Conversation
🦋 Changeset detectedLatest commit: bbedda4 The changes in this PR will be included in the next version bump. This PR includes changesets to release 19 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
WalkthroughWraps telemetry recording paths in try/catch to prevent exceptions from bubbling, adds tests verifying non-throwing behavior, and adds a changeset entry for a patch release of @clerk/shared. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
participant App
participant Collector as TelemetryCollector
participant Buffer as Buffer/Queue
participant Logger as Console
rect rgba(200,235,255,0.25)
note over App,Collector: record(event)
App->>Collector: record(event)
activate Collector
Collector->>Collector: try { prepare payload, sample decision, buffer, maybe flush }
alt success
Collector->>Buffer: buffer(event)
Collector-->>App: return
else error
Collector->>Logger: "[clerk/telemetry] Error recording telemetry event" + Error
Collector-->>App: return
end
deactivate Collector
end
rect rgba(225,255,200,0.25)
note over App,Collector: recordLog(entry)
App->>Collector: recordLog(entry)
activate Collector
Collector->>Collector: try { validate, normalize ts, construct log, buffer, maybe flush }
alt success
Collector->>Buffer: buffer(log)
Collector-->>App: return
else error
Collector->>Logger: "[clerk/telemetry] Error recording telemetry log entry" + Error
Collector-->>App: return
end
deactivate Collector
end
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Assessment against linked issues
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ Finishing Touches
🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
Status, Documentation and Community
|
@clerk/agent-toolkit
@clerk/astro
@clerk/backend
@clerk/chrome-extension
@clerk/clerk-js
@clerk/dev-cli
@clerk/elements
@clerk/clerk-expo
@clerk/expo-passkeys
@clerk/express
@clerk/fastify
@clerk/localizations
@clerk/nextjs
@clerk/nuxt
@clerk/clerk-react
@clerk/react-router
@clerk/remix
@clerk/shared
@clerk/tanstack-react-start
@clerk/testing
@clerk/themes
@clerk/types
@clerk/upgrade
@clerk/vue
commit: |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (6)
packages/shared/src/telemetry/collector.ts (6)
179-193: Good: wraprecordin try/catch; minor logging refinements recommendedCatching all errors prevents propagation as intended. To reduce noise in consumer consoles and avoid leaking details in production, consider:
- Logging only in debug mode.
- Narrowing the caught error to
unknownand printing a concise message.- Including the event name to aid triage.
Suggested change:
- } catch (error) { - console.error('[clerk/telemetry] Error recording telemetry event', error); - } + } catch (err: unknown) { + if (this.isDebug && typeof console !== 'undefined') { + const e = err instanceof Error ? err : new Error(String(err)); + console.warn('[clerk/telemetry] Error recording telemetry event', { + event: event?.event, + message: e.message, + }); + } + }
203-206:#shouldRecordLoggate is a no-op; align behavior with JSDoc or remove the checkRight now
#shouldRecordLogalways returnstrue, so this early return never triggers. Either:
- Gate logs (e.g.,
return this.isEnabled && !this.isDebug) if you truly want “logging is enabled and not in debug mode”, or- Update the JSDoc to remove that claim and drop the check for clarity.
If you decide to gate, consider:
// outside this hunk (method definition) #shouldRecordLog(_entry: TelemetryLogEntry): boolean { // Always allow when telemetry is enabled; avoid logging during debug runs to keep consoles quiet. return this.isEnabled && !this.isDebug; }
219-228: Validation now over-filters due to timestamp check; remove the timestamp predicateWith the fallback to
new Date()(previous comment), the timestamp is always valid. Keep the validation focused onlevelandmessageto avoid silently dropping logs.- if (!levelIsValid || !messageIsValid || normalizedTimestamp === null) { + if (!levelIsValid || !messageIsValid) { if (this.isDebug && typeof console !== 'undefined') { console.warn('[clerk/telemetry] Dropping invalid telemetry log entry', { levelIsValid, messageIsValid, - timestampIsValid: normalizedTimestamp !== null, + timestampIsValid: true, }); } return; }
233-241: Consider including a minimal correlation identifier and avoid leaking context keysTwo small improvements:
- If you have an instance or request correlation ID available (e.g.,
iid), consider including it to aid debugging.#sanitizeContextis good, but you might want to prune obviously sensitive keys (e.g., password, token) if they slip through. Even best-effort redaction helps.No blocker; just considerations for operating telemetry at scale.
Happy to add a small redaction helper with a denylist and unit tests.
246-248: Narrow catch variable and gate logging behind debug to avoid noisy consolesSame rationale as for
record. Keep errors silent in production but visible whenCLERK_TELEMETRY_DEBUGis on.- } catch (error) { - console.error('[clerk/telemetry] Error recording telemetry log entry', error); - } + } catch (err: unknown) { + if (this.isDebug && typeof console !== 'undefined') { + const e = err instanceof Error ? err : new Error(String(err)); + console.warn('[clerk/telemetry] Error recording telemetry log entry', { + level: entry?.level, + message: e.message, + }); + } + }
178-194: Add unit tests to lock in “errors never bubble up” behaviorTo prevent regressions for USER-3312:
record: when#preparePayloador#scheduleFlushthrows, no exception escapes and nothing is enqueued.recordLog: invalidlevel, empty message, missing/invalid timestamp → entry is handled according to the new rules (default timestamp), and no exception escapes.I can draft tests with stubs for
#preparePayload,#scheduleFlush, andfetch.Do you want me to open a follow-up PR with Jest tests covering these cases?
Also applies to: 201-248
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
.changeset/thirty-cars-beg.md(1 hunks)packages/shared/src/telemetry/collector.ts(2 hunks)
🧰 Additional context used
📓 Path-based instructions (7)
.changeset/**
📄 CodeRabbit inference engine (.cursor/rules/monorepo.mdc)
Automated releases must use Changesets.
Files:
.changeset/thirty-cars-beg.md
**/*.{js,jsx,ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
**/*.{js,jsx,ts,tsx}: All code must pass ESLint checks with the project's configuration
Follow established naming conventions (PascalCase for components, camelCase for variables)
Maintain comprehensive JSDoc comments for public APIs
Use dynamic imports for optional features
All public APIs must be documented with JSDoc
Provide meaningful error messages to developers
Include error recovery suggestions where applicable
Log errors appropriately for debugging
Lazy load components and features when possible
Implement proper caching strategies
Use efficient data structures and algorithms
Profile and optimize critical paths
Validate all inputs and sanitize outputs
Implement proper logging with different levels
Files:
packages/shared/src/telemetry/collector.ts
**/*.{js,jsx,ts,tsx,json,css,scss,md,yaml,yml}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Use Prettier for consistent code formatting
Files:
packages/shared/src/telemetry/collector.ts
packages/**/*.{ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
TypeScript is required for all packages
Files:
packages/shared/src/telemetry/collector.ts
packages/**/*.{ts,tsx,d.ts}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Packages should export TypeScript types alongside runtime code
Files:
packages/shared/src/telemetry/collector.ts
**/*.{ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Use proper TypeScript error types
**/*.{ts,tsx}: Always define explicit return types for functions, especially public APIs
Use proper type annotations for variables and parameters where inference isn't clear
Avoidanytype - preferunknownwhen type is uncertain, then narrow with type guards
Useinterfacefor object shapes that might be extended
Usetypefor unions, primitives, and computed types
Preferreadonlyproperties for immutable data structures
Useprivatefor internal implementation details
Useprotectedfor inheritance hierarchies
Usepublicexplicitly for clarity in public APIs
Preferreadonlyfor properties that shouldn't change after construction
Prefer composition and interfaces over deep inheritance chains
Use mixins for shared behavior across unrelated classes
Implement dependency injection for loose coupling
Let TypeScript infer when types are obvious
Useconst assertionsfor literal types:as const
Usesatisfiesoperator for type checking without widening
Use mapped types for transforming object types
Use conditional types for type-level logic
Leverage template literal types for string manipulation
Use ES6 imports/exports consistently
Use default exports sparingly, prefer named exports
Use type-only imports:import type { ... } from ...
Noanytypes without justification
Proper error handling with typed errors
Consistent use ofreadonlyfor immutable data
Proper generic constraints
No unused type parameters
Proper use of utility types instead of manual type construction
Type-only imports where possible
Proper tree-shaking friendly exports
No circular dependencies
Efficient type computations (avoid deep recursion)
Files:
packages/shared/src/telemetry/collector.ts
**/*.{js,ts,tsx,jsx}
📄 CodeRabbit inference engine (.cursor/rules/monorepo.mdc)
Support multiple Clerk environment variables (CLERK_, NEXT_PUBLIC_CLERK_, etc.) for configuration.
Files:
packages/shared/src/telemetry/collector.ts
🧬 Code graph analysis (1)
packages/shared/src/telemetry/collector.ts (3)
packages/clerk-js/src/core/modules/debug/types.ts (1)
VALID_LOG_LEVELS(9-9)packages/clerk-js/src/core/clerk.ts (2)
sdkMetadata(271-273)sdkMetadata(275-277)packages/react/src/isomorphicClerk.ts (1)
sdkMetadata(264-266)
🔇 Additional comments (3)
.changeset/thirty-cars-beg.md (1)
1-6: Changeset looks correct for a patch to @clerk/sharedThe package name and bump type are valid; message is concise and matches the PR intent.
packages/shared/src/telemetry/collector.ts (2)
207-209: Telemetry collector’s log levels are correctly aligned with its own typesThe
TelemetryLogEntryinterface (packages/types/src/telemetry.ts:49–51) explicitly includes'trace', and the collector’sVALID_LOG_LEVELSset inpackages/shared/src/telemetry/collector.tsmirrors that union (['error','warn','info','debug','trace']). TheDebugLogLeveltype in clerk-js is a separate, debug-specific enum (['error','warn','info','debug']) and is not the source of truth for telemetry log levels. No changes are necessary here; the original comment conflates two distinct domains.Likely an incorrect or invalid review comment.
207-217: Suggestion to ignore –timestampis always a required numberThe
TelemetryLogEntryinterface (packages/types/src/telemetry.ts:56) declaresreadonly timestamp: number;so:
- A missing timestamp cannot occur under the declared type.
- The existing guard correctly handles the only valid runtime form (a
number).- Accepting
Dateinstances or defaulting tonew Date()would be out of spec and unnecessary.Please disregard the proposed changes around timestamp normalization.
Likely an incorrect or invalid review comment.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
packages/shared/src/__tests__/telemetry.logs.test.ts (3)
141-169: Stabilize network behavior in tests by mocking fetch and assert a single callThese tests currently rely on the real fetch polyfill. For deterministic, fast, and offline-safe tests, set a resolved mock and assert the exact call count.
Apply this diff:
test('recordLog() method handles circular references in context gracefully', () => { const collector = new TelemetryCollector({ publishableKey: TEST_PK }); + // Avoid real network and make the test deterministic + fetchSpy.mockResolvedValue({ ok: true } as any); + const circularContext = (() => { const obj: any = { test: 'value' }; obj.self = obj; return obj; })(); @@ jest.runAllTimers(); - expect(fetchSpy).toHaveBeenCalled(); + expect(fetchSpy).toHaveBeenCalledTimes(1); const [url, init] = fetchSpy.mock.calls[0]; expect(String(url)).toMatch('/v1/logs');
171-204: Make this test cover a truly “non-circular but non-serializable” contextAs written, this case also includes a circular reference, overlapping with the previous test. Swap the circular part with a BigInt (JSON.stringify throws on BigInt), so we uniquely cover a different non-serializable shape.
Apply this diff:
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; - })(), - }; + const nonSerializableContext = { + function: () => 'test', + undefined: undefined, + symbol: Symbol('test'), + // BigInt cannot be serialized to JSON and will throw + bigint: 10n, + } as const; expect(() => { collector.recordLog({ level: 'info', message: 'test message', timestamp: Date.now(), context: nonSerializableContext, }); }).not.toThrow(); jest.runAllTimers(); - expect(fetchSpy).toHaveBeenCalled(); + expect(fetchSpy).toHaveBeenCalledTimes(1);
205-221: Optionally verify debug warnings for invalid log entriesWhen debug is enabled, invalid entries should emit a console.warn. Consider adding a small companion test to assert this behavior so we don’t regress the developer-facing diagnostics.
Example (new test block):
test('logs a warning in debug mode for invalid timestamp', () => { const consoleWarnSpy = jest.spyOn(console, 'warn').mockImplementation(() => {}); const collector = new TelemetryCollector({ publishableKey: TEST_PK, debug: true }); collector.recordLog({ level: 'info', message: 'test message', // invalid timestamp timestamp: Number.NaN, }); jest.runAllTimers(); expect(consoleWarnSpy).toHaveBeenCalledWith( '[clerk/telemetry] Dropping invalid telemetry log entry', expect.objectContaining({ levelIsValid: true, messageIsValid: true, timestampIsValid: false, }), ); consoleWarnSpy.mockRestore(); });packages/shared/src/__tests__/telemetry.test.ts (1)
422-452: Make the “continues operation” test deterministic and assert payload integrity
- Mock fetch to avoid real network and to capture the posted body.
- Strengthen the assertion to ensure only the healthy event is sent after the failure.
Apply this diff:
test('record() method handles errors gracefully and continues operation', () => { const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(() => {}); const collector = new TelemetryCollector({ publishableKey: TEST_PK, }); + // Capture the posted event batches and avoid real network + const postedBodies: any[] = []; + fetchSpy.mockImplementation((_, options: RequestInit) => { + try { + postedBodies.push(JSON.parse(String(options.body))); + } catch { + // ignore parse errors in test harness + } + return Promise.resolve({ ok: true } as any); + }); + const problematicPayload = (() => { const obj: any = { test: 'value' }; obj.self = obj; return obj; })(); @@ expect(() => { collector.record({ event: 'TEST_EVENT', payload: { normal: 'data' } }); }).not.toThrow(); jest.runAllTimers(); - expect(fetchSpy).toHaveBeenCalled(); + expect(fetchSpy).toHaveBeenCalledTimes(1); + expect(postedBodies[0]).toEqual( + expect.objectContaining({ + events: [ + expect.objectContaining({ + event: 'TEST_EVENT', + payload: { normal: 'data' }, + }), + ], + }), + ); consoleErrorSpy.mockRestore(); });
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
packages/shared/src/__tests__/telemetry.logs.test.ts(1 hunks)packages/shared/src/__tests__/telemetry.test.ts(1 hunks)
🧰 Additional context used
📓 Path-based instructions (8)
**/*.{js,jsx,ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
**/*.{js,jsx,ts,tsx}: All code must pass ESLint checks with the project's configuration
Follow established naming conventions (PascalCase for components, camelCase for variables)
Maintain comprehensive JSDoc comments for public APIs
Use dynamic imports for optional features
All public APIs must be documented with JSDoc
Provide meaningful error messages to developers
Include error recovery suggestions where applicable
Log errors appropriately for debugging
Lazy load components and features when possible
Implement proper caching strategies
Use efficient data structures and algorithms
Profile and optimize critical paths
Validate all inputs and sanitize outputs
Implement proper logging with different levels
Files:
packages/shared/src/__tests__/telemetry.test.tspackages/shared/src/__tests__/telemetry.logs.test.ts
**/*.{js,jsx,ts,tsx,json,css,scss,md,yaml,yml}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Use Prettier for consistent code formatting
Files:
packages/shared/src/__tests__/telemetry.test.tspackages/shared/src/__tests__/telemetry.logs.test.ts
packages/**/*.{ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
TypeScript is required for all packages
Files:
packages/shared/src/__tests__/telemetry.test.tspackages/shared/src/__tests__/telemetry.logs.test.ts
packages/**/*.{ts,tsx,d.ts}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Packages should export TypeScript types alongside runtime code
Files:
packages/shared/src/__tests__/telemetry.test.tspackages/shared/src/__tests__/telemetry.logs.test.ts
**/*.{ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Use proper TypeScript error types
**/*.{ts,tsx}: Always define explicit return types for functions, especially public APIs
Use proper type annotations for variables and parameters where inference isn't clear
Avoidanytype - preferunknownwhen type is uncertain, then narrow with type guards
Useinterfacefor object shapes that might be extended
Usetypefor unions, primitives, and computed types
Preferreadonlyproperties for immutable data structures
Useprivatefor internal implementation details
Useprotectedfor inheritance hierarchies
Usepublicexplicitly for clarity in public APIs
Preferreadonlyfor properties that shouldn't change after construction
Prefer composition and interfaces over deep inheritance chains
Use mixins for shared behavior across unrelated classes
Implement dependency injection for loose coupling
Let TypeScript infer when types are obvious
Useconst assertionsfor literal types:as const
Usesatisfiesoperator for type checking without widening
Use mapped types for transforming object types
Use conditional types for type-level logic
Leverage template literal types for string manipulation
Use ES6 imports/exports consistently
Use default exports sparingly, prefer named exports
Use type-only imports:import type { ... } from ...
Noanytypes without justification
Proper error handling with typed errors
Consistent use ofreadonlyfor immutable data
Proper generic constraints
No unused type parameters
Proper use of utility types instead of manual type construction
Type-only imports where possible
Proper tree-shaking friendly exports
No circular dependencies
Efficient type computations (avoid deep recursion)
Files:
packages/shared/src/__tests__/telemetry.test.tspackages/shared/src/__tests__/telemetry.logs.test.ts
packages/**/*.{test,spec}.{js,jsx,ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/monorepo.mdc)
Unit tests should use Jest or Vitest as the test runner.
Files:
packages/shared/src/__tests__/telemetry.test.tspackages/shared/src/__tests__/telemetry.logs.test.ts
**/*.{js,ts,tsx,jsx}
📄 CodeRabbit inference engine (.cursor/rules/monorepo.mdc)
Support multiple Clerk environment variables (CLERK_, NEXT_PUBLIC_CLERK_, etc.) for configuration.
Files:
packages/shared/src/__tests__/telemetry.test.tspackages/shared/src/__tests__/telemetry.logs.test.ts
**/__tests__/**/*.{ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/typescript.mdc)
**/__tests__/**/*.{ts,tsx}: Create type-safe test builders/factories
Use branded types for test isolation
Implement proper mock types that match interfaces
Files:
packages/shared/src/__tests__/telemetry.test.tspackages/shared/src/__tests__/telemetry.logs.test.ts
🧬 Code graph analysis (2)
packages/shared/src/__tests__/telemetry.test.ts (1)
packages/shared/src/telemetry/collector.ts (1)
TelemetryCollector(102-450)
packages/shared/src/__tests__/telemetry.logs.test.ts (2)
packages/shared/src/telemetry/collector.ts (1)
TelemetryCollector(102-450)packages/types/src/telemetry.ts (1)
TelemetryCollector(60-65)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (12)
- GitHub Check: Integration Tests (nextjs, chrome, 15)
- GitHub Check: Integration Tests (billing, chrome)
- GitHub Check: Integration Tests (nextjs, chrome, 14)
- GitHub Check: Integration Tests (react-router, chrome)
- GitHub Check: Integration Tests (quickstart, chrome)
- GitHub Check: Integration Tests (machine, chrome)
- GitHub Check: Integration Tests (sessions, chrome)
- GitHub Check: Integration Tests (ap-flows, chrome)
- GitHub Check: Integration Tests (elements, chrome)
- GitHub Check: Integration Tests (generic, chrome)
- GitHub Check: Integration Tests (localhost, chrome)
- GitHub Check: Unit Tests (22, **)
🔇 Additional comments (1)
packages/shared/src/__tests__/telemetry.test.ts (1)
396-421: Good coverage to ensure exceptions don’t escape record()Asserting a precise console.error signature with an Error instance directly validates the new try/catch path. Looks good.
Description
Make sure we catch all errors from public methods of the Telemetry collector
Fixes: USER-3312
Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change
Summary by CodeRabbit
Bug Fixes
Chores
Tests