fix(backend): Support storing multiple local keys in JWK cache #6993
Conversation
- Changed `loadClerkJWKFromLocal` to `loadClerkJwkFromPem` for loading keys in PEM format. - Updated key loading logic in `verifyHandshakeToken` and `verifyToken` functions. - Enhanced caching mechanism to avoid collisions with remote keys by prefixing local keys with "local-".
🦋 Changeset detectedLatest commit: 18fdacd 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.
|
WalkthroughUpdates JWT key loading and caching to use kid-scoped PEM-based keys and per-kid cache entries; replaces the local JWK loader with a PEM loader, updates verification and handshake flows, adjusts tests and fixtures, and adds a Simplify type re-export. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
actor Client
participant Backend as verifyToken()
participant Keys as keys.ts
participant Cache as JWK Cache
participant JWKS as Remote JWKS
participant JWT as verifyJwt()
Client->>Backend: verifyToken(token, { jwtKey?, kid, ... })
alt jwtKey (PEM) provided
Backend->>Keys: loadClerkJwkFromPem({ kid, pem })
Keys->>Cache: get("local-" + kid)
alt Cache hit
Cache-->>Keys: JsonWebKey
else Cache miss
Keys->>Keys: parse PEM → build JWK (kid: "local-" + kid)
Keys->>Cache: set("local-" + kid, JWK)
end
Keys-->>Backend: JsonWebKey
else No PEM provided
Backend->>Keys: loadClerkJWKFromRemote({ ..., kid })
Keys->>Cache: get(kid)
alt Cache hit
Cache-->>Keys: JsonWebKey
else Cache miss
Keys->>JWKS: fetch JWKS
JWKS-->>Keys: { keys[] }
loop for each key
Keys->>Cache: set(key.kid, key)
end
Keys->>Cache: get(kid)
end
Keys-->>Backend: JsonWebKey
end
Backend->>JWT: verifyJwt(token, { key })
JWT-->>Backend: verification result
Backend-->>Client: result
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 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 as they are similar to previous 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). (3)
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/backend/src/tokens/keys.ts (1)
52-86: Add explicit note aboutlocal-prefix in JSDocEnhance the existing JSDoc on
loadClerkJwkFromPemto mention that the returned JWK’skidis prefixed with"local-"to avoid cache collisions:/** * Loads a local PEM key usually from process.env and transforms it to JsonWebKey format. * The result is cached on the module level to avoid unnecessary computations in subsequent invocations. + * + * Note: the returned JWK’s `kid` will be prefixed with "local-". + * For example, passing `kid: "test"` yields `kid: "local-test"`. */
📜 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 (8)
.changeset/fix-multi-instance-jwt-caching.md(1 hunks)packages/backend/src/fixtures/index.ts(1 hunks)packages/backend/src/tokens/__tests__/keys.test.ts(2 hunks)packages/backend/src/tokens/handshake.ts(3 hunks)packages/backend/src/tokens/keys.ts(3 hunks)packages/backend/src/tokens/verify.ts(3 hunks)packages/shared/src/types/index.ts(1 hunks)packages/shared/src/types/utils.ts(1 hunks)
🧰 Additional context used
📓 Path-based instructions (11)
.changeset/**
📄 CodeRabbit inference engine (.cursor/rules/monorepo.mdc)
Automated releases must use Changesets.
Files:
.changeset/fix-multi-instance-jwt-caching.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/backend/src/fixtures/index.tspackages/backend/src/tokens/__tests__/keys.test.tspackages/shared/src/types/index.tspackages/backend/src/tokens/handshake.tspackages/shared/src/types/utils.tspackages/backend/src/tokens/verify.tspackages/backend/src/tokens/keys.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/backend/src/fixtures/index.tspackages/backend/src/tokens/__tests__/keys.test.tspackages/shared/src/types/index.tspackages/backend/src/tokens/handshake.tspackages/shared/src/types/utils.tspackages/backend/src/tokens/verify.tspackages/backend/src/tokens/keys.ts
packages/**/*.{ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
TypeScript is required for all packages
Files:
packages/backend/src/fixtures/index.tspackages/backend/src/tokens/__tests__/keys.test.tspackages/shared/src/types/index.tspackages/backend/src/tokens/handshake.tspackages/shared/src/types/utils.tspackages/backend/src/tokens/verify.tspackages/backend/src/tokens/keys.ts
packages/**/*.{ts,tsx,d.ts}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Packages should export TypeScript types alongside runtime code
Files:
packages/backend/src/fixtures/index.tspackages/backend/src/tokens/__tests__/keys.test.tspackages/shared/src/types/index.tspackages/backend/src/tokens/handshake.tspackages/shared/src/types/utils.tspackages/backend/src/tokens/verify.tspackages/backend/src/tokens/keys.ts
packages/**/index.{js,ts}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Use tree-shaking friendly exports
Files:
packages/backend/src/fixtures/index.tspackages/shared/src/types/index.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/backend/src/fixtures/index.tspackages/backend/src/tokens/__tests__/keys.test.tspackages/shared/src/types/index.tspackages/backend/src/tokens/handshake.tspackages/shared/src/types/utils.tspackages/backend/src/tokens/verify.tspackages/backend/src/tokens/keys.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/backend/src/fixtures/index.tspackages/backend/src/tokens/__tests__/keys.test.tspackages/shared/src/types/index.tspackages/backend/src/tokens/handshake.tspackages/shared/src/types/utils.tspackages/backend/src/tokens/verify.tspackages/backend/src/tokens/keys.ts
**/index.ts
📄 CodeRabbit inference engine (.cursor/rules/react.mdc)
Use index.ts files for clean imports but avoid deep barrel exports
Avoid barrel files (index.ts re-exports) as they can cause circular dependencies
Files:
packages/backend/src/fixtures/index.tspackages/shared/src/types/index.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/backend/src/tokens/__tests__/keys.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/backend/src/tokens/__tests__/keys.test.ts
🧬 Code graph analysis (4)
packages/backend/src/tokens/__tests__/keys.test.ts (2)
packages/backend/src/tokens/keys.ts (1)
loadClerkJwkFromPem(52-86)packages/backend/src/fixtures/index.ts (3)
mockPEMKey(51-52)mockPEMJwk(54-60)mockPEMJwtKey(62-71)
packages/backend/src/tokens/handshake.ts (1)
packages/backend/src/tokens/keys.ts (1)
loadClerkJwkFromPem(52-86)
packages/backend/src/tokens/verify.ts (3)
packages/shared/src/types/utils.ts (1)
Simplify(5-7)packages/backend/src/jwt/verifyJwt.ts (1)
VerifyJwtOptions(100-122)packages/backend/src/tokens/keys.ts (2)
LoadClerkJWKFromRemoteOptions(91-118)loadClerkJwkFromPem(52-86)
packages/backend/src/tokens/keys.ts (2)
packages/backend/src/errors.ts (1)
TokenVerificationError(41-69)packages/backend/src/constants.ts (2)
API_URL(1-1)API_VERSION(2-2)
⏰ 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). (3)
- GitHub Check: semgrep-cloud-platform/scan
- GitHub Check: Analyze (javascript-typescript)
- GitHub Check: semgrep-cloud-platform/scan
🔇 Additional comments (12)
packages/shared/src/types/utils.ts (1)
1-7: LGTM! Clean type utility with proper attribution.The
Simplifytype is a well-established pattern for flattening intersection types to improve IDE hints. The reference to type-fest provides helpful context..changeset/fix-multi-instance-jwt-caching.md (1)
1-14: LGTM! Clear documentation of the fix.The changeset accurately describes both the problem (cache collision in multi-instance scenarios) and the solution (per-kid caching). This will help users understand the impact of the change.
packages/backend/src/tokens/keys.ts (2)
33-36: LGTM! Cache key parameterization enables per-kid caching.The addition of the
cacheKeyparameter provides the flexibility needed to implement per-kid caching, which is the core fix for the multi-instance issue.
131-173: LGTM! Per-kid caching in remote JWKS correctly fixes the multi-instance bug.Line 153's change from caching all keys under a single entry to caching each key by its own
kidis the core fix. This ensures that multiple instances with different JWKS won't collide in the cache.packages/backend/src/fixtures/index.ts (1)
54-60: LGTM! Fixture correctly reflects the prefixed kid output.The change from
kid: 'local'tokid: 'local-test-kid'aligns with the new behavior whereloadClerkJwkFromPemreturns a JWK with the "local-" prefix. This fixture represents the expected output of the loader function.packages/shared/src/types/index.ts (1)
1-1: LGTM! Clean type re-export following best practices.The use of
export type { ... }correctly indicates this is a type-only export, enabling proper tree-shaking and avoiding runtime overhead.packages/backend/src/tokens/handshake.ts (2)
10-10: LGTM! Import updated to use PEM-based loader.The import change from
loadClerkJWKFromLocaltoloadClerkJwkFromPemaligns with the renamed and refactored key loading API.
68-72: LGTM! Handshake flow correctly uses the new PEM-based loader.The call to
loadClerkJwkFromPem({ kid, pem: jwtKey })properly passes:
- The
kidfrom the token header (line 64) for cache key construction- The
jwtKeyas thepemparameter for key materialThis maintains the same functionality while enabling per-kid caching.
packages/backend/src/tokens/__tests__/keys.test.ts (2)
15-17: LGTM! Import and constant updates align with the new API.The import change to
loadClerkJwkFromPemand the addition of theMOCK_KIDconstant improve test clarity and consistency.
40-81: Excellent test coverage for per-kid caching behavior!These new tests thoroughly validate the core fix:
- Lines 40-55: Verifies separate cache entries for different kids with different PEMs
- Lines 57-62: Confirms caching works (same object reference returned)
- Lines 64-67: Validates the "local-" prefix to prevent collisions
- Lines 69-81: Tests the edge case where the same PEM is used with different kids
This comprehensive coverage ensures the multi-instance caching fix works correctly and prevents regressions.
packages/backend/src/tokens/verify.ts (2)
2-2: LGTM! Simplify wrapper improves type ergonomics.Wrapping
VerifyTokenOptionswithSimplifyflattens the intersection type, making IDE hints more readable without changing the runtime behavior or type semantics. This is a recommended practice for complex composed types.Also applies to: 26-34
127-134: LGTM! Token verification correctly uses the new PEM-based loader.The changes integrate cleanly with the new caching strategy:
- Line 127: Explicit
JsonWebKeytype annotation improves type safety- Line 130:
loadClerkJwkFromPem({ kid, pem: options.jwtKey })properly passes the kid from the token header for per-kid caching- Line 133: Remote path unchanged, maintaining backward compatibility
@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: |
Co-authored-by: panteliselef <[email protected]>
Description
Fixed JWT public key caching in
verifyToken()to support multi-instance scenarios. Public keys are now correctly cached perkidfrom the token header instead of using a single shared cache key.loadClerkJWKFromLocaltoloadClerkJwkFromPemfor loading keys in PEM format.verifyHandshakeTokenandverifyTokenfunctions.Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change
Summary by CodeRabbit
Bug Fixes
Refactor
Tests