feat(clerk-js): Enhance BroadcastChannel logging #7150
Conversation
🦋 Changeset detectedLatest commit: 07d9531 The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 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.
|
WalkthroughA per-instance tab identifier (tabId) is introduced and threaded through logging and broadcast paths in the token cache for cross-tab diagnostic tracing. The broadcast payload structure remains unchanged while diagnostic telemetry gains tabId context. Changes
Sequence DiagramsequenceDiagram
participant Instance as Token Cache<br/>(Instance)
participant Log as Diagnostic<br/>Logging
participant Broadcast as Broadcast<br/>Channel
rect rgb(245, 250, 255)
Note over Instance: Initialization
Instance->>Instance: Generate tabId
Instance->>Instance: Store in MemoryTokenCache
end
rect rgb(245, 250, 255)
Note over Instance: Token Operations
Instance->>Log: Log token mismatch (includes tabId)
Instance->>Log: Log validation failure (includes tabId)
Instance->>Log: Log entry comparison (includes tabId)
end
rect rgb(245, 250, 255)
Note over Instance: Broadcasting
Instance->>Broadcast: Send token update (payload unchanged)
Note over Log: Log broadcast event (includes tabId)
Broadcast->>Instance: Receive broadcast
Note over Log: Record tabId in decision logging
end
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Disabled knowledge base sources:
📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
⏰ 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). (23)
Comment |
![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 (1)
packages/clerk-js/src/core/tokenCache.ts (1)
134-136: Consider adding explicit return type annotation.The
generateTabIdfunction lacks an explicit return type. While TypeScript can infer: string, adding it explicitly improves code clarity and aligns with the coding guideline for explicit return types.-const generateTabId = (): string => { +const generateTabId = (): string => { return Math.random().toString(36).slice(2); };Note: The current implementation without the explicit type is already valid, but the explicit annotation is a best practice.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
packages/clerk-js/src/core/tokenCache.ts(8 hunks)
🧰 Additional context used
📓 Path-based instructions (6)
**/*.{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/clerk-js/src/core/tokenCache.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/clerk-js/src/core/tokenCache.ts
packages/**/*.{ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
TypeScript is required for all packages
Files:
packages/clerk-js/src/core/tokenCache.ts
packages/**/*.{ts,tsx,d.ts}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Packages should export TypeScript types alongside runtime code
Files:
packages/clerk-js/src/core/tokenCache.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/clerk-js/src/core/tokenCache.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/clerk-js/src/core/tokenCache.ts
⏰ 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). (5)
- GitHub Check: check-major-bump
- GitHub Check: pr-title-lint
- GitHub Check: semgrep-cloud-platform/scan
- GitHub Check: semgrep-cloud-platform/scan
- GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (1)
packages/clerk-js/src/core/tokenCache.ts (1)
145-145: LGTM! Tab identifier successfully integrated for diagnostic tracing.The per-instance
tabIdis properly initialized and consistently threaded through all relevant logging paths. This enhancement will significantly improve cross-tab diagnostic capabilities by:
- Identifying which tab generated or received each broadcast event
- Tracing token updates across multiple tabs using the existing traceId + new tabId
- Debugging race conditions and timing issues in multi-tab scenarios
The implementation correctly keeps
tabIdout of the broadcast payload itself (SessionTokenEvent), using it only for local diagnostic logging, which avoids any protocol changes.Also applies to: 221-221, 236-236, 247-247, 261-261, 270-270, 280-280, 372-372
@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: |
|
Found 2 test failures on Blacksmith runners:
|
Description
Introduced a
generateTabIdhelper inMemoryTokenCacheso each tab instance gets a stable random identifier, stored once per cache and reused across BroadcastChannel interactions. The ID is threaded through the existing debug logging paths to make multi-tab token updates easier to trace.Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.