consolidate tokenId creation logic

Author: jacekradko

packages/clerk-js/src/core/resources/Session.ts

@@ -27,6 +27,7 @@ import type {
 
 import { unixEpochToDate } from '@/utils/date';
 import { debugLogger } from '@/utils/debug';
+import { buildTokenId } from '@/utils/tokenId';
 import {
   convertJSONToPublicKeyRequestOptions,
   serializePublicKeyCredentialAssertion,
@@ -144,7 +145,7 @@ export class Session extends BaseResource implements SessionResource {
   #getCacheId(template?: string, organizationId?: string | null) {
     const resolvedOrganizationId =
       typeof organizationId === 'undefined' ? this.lastActiveOrganizationId : organizationId;
-    return [this.id, template, resolvedOrganizationId].filter(Boolean).join('-');
+    return buildTokenId(this.id, template, resolvedOrganizationId);
   }
 
   startVerification = async ({ level }: SessionVerifyCreateParams): Promise<SessionVerificationResource> => {

packages/clerk-js/src/core/tokenCache.ts

@@ -1,6 +1,7 @@
 import type { TokenResource } from '@clerk/types';
 
 import { debugLogger } from '@/utils/debug';
+import { buildTokenId } from '@/utils/tokenId';
 
 import { Token } from './resources/internal';
 
@@ -141,14 +142,6 @@ export class TokenCacheKey {
   }
 }
 
-/**
- * Generates a unique token identifier from session context.
- * Format: `sessionId-template-organizationId` (omitting falsy values).
- */
-const computeTokenId = (sessionId: string, template?: string, organizationId?: string | null): string => {
-  return [sessionId, template, organizationId].filter(Boolean).join('-');
-};
-
 /**
  * Message format for BroadcastChannel token synchronization between tabs.
  */
@@ -231,7 +224,7 @@ const MemoryTokenCache = (prefix = KEY_PREFIX): TokenCache => {
    * Validates token ID, parses JWT, and updates cache if token is newer than existing entry.
    */
   const handleBroadcastMessage = async ({ data }: MessageEvent<SessionTokenEvent>) => {
-    const expectedTokenId = computeTokenId(data.sessionId, data.template, data.organizationId);
+    const expectedTokenId = buildTokenId(data.sessionId, data.template, data.organizationId);
     if (data.tokenId !== expectedTokenId) {
       debugLogger.warn(
         'Ignoring token broadcast with mismatched tokenId',
@@ -318,7 +311,7 @@ const MemoryTokenCache = (prefix = KEY_PREFIX): TokenCache => {
     setInternal(entry);
 
     if (broadcast && channel) {
-      const expectedTokenId = computeTokenId(broadcast.sessionId, broadcast.template, broadcast.organizationId);
+      const expectedTokenId = buildTokenId(broadcast.sessionId, broadcast.template, broadcast.organizationId);
       if (entry.tokenId !== expectedTokenId) {
         return;
       }

packages/clerk-js/src/utils/__tests__/tokenId.test.ts

@@ -0,0 +1,37 @@
+import { describe, expect, it } from 'vitest';
+
+import { buildTokenId } from '../tokenId';
+
+describe('buildTokenId', () => {
+  it('should build token ID with only sessionId', () => {
+    expect(buildTokenId('sess_123')).toBe('sess_123');
+  });
+
+  it('should build token ID with sessionId and template', () => {
+    expect(buildTokenId('sess_123', 'custom')).toBe('sess_123-custom');
+  });
+
+  it('should build token ID with sessionId and organizationId', () => {
+    expect(buildTokenId('sess_123', undefined, 'org_456')).toBe('sess_123-org_456');
+  });
+
+  it('should build token ID with all parameters', () => {
+    expect(buildTokenId('sess_123', 'custom', 'org_456')).toBe('sess_123-custom-org_456');
+  });
+
+  it('should omit null organizationId', () => {
+    expect(buildTokenId('sess_123', 'custom', null)).toBe('sess_123-custom');
+  });
+
+  it('should omit undefined template', () => {
+    expect(buildTokenId('sess_123', undefined, 'org_456')).toBe('sess_123-org_456');
+  });
+
+  it('should handle empty string values by omitting them', () => {
+    expect(buildTokenId('sess_123', '', '')).toBe('sess_123');
+  });
+
+  it('should handle all optional parameters being undefined', () => {
+    expect(buildTokenId('sess_123', undefined, undefined)).toBe('sess_123');
+  });
+});

packages/clerk-js/src/utils/index.ts

@@ -23,6 +23,7 @@ export * from './props';
 export * from './queryStateParams';
 export * from './querystring';
 export * from './runtime';
+export * from './tokenId';
 export * from './url';
 export * from './web3';
 export * from './windowNavigate';

packages/clerk-js/src/utils/tokenId.ts

@@ -0,0 +1,15 @@
+/**
+ * Generates a unique token identifier from session context by combining sessionId,
+ * optional template, and optional organizationId with hyphens, omitting falsy values.
+ *
+ * @example
+ * ```typescript
+ * buildTokenId('sess_123') // 'sess_123'
+ * buildTokenId('sess_123', 'custom') // 'sess_123-custom'
+ * buildTokenId('sess_123', 'custom', 'org_456') // 'sess_123-custom-org_456'
+ * buildTokenId('sess_123', undefined, 'org_456') // 'sess_123-org_456'
+ * ```
+ */
+export const buildTokenId = (sessionId: string, template?: string, organizationId?: string | null): string => {
+  return [sessionId, template, organizationId].filter(Boolean).join('-');
+};