feat(electron): Report SDK version to FAPI via query param (#8847)

Author: jeremy-clerk

packages/electron/src/global.d.ts

@@ -1,10 +1,10 @@
 import type { TokenCache } from './shared/types';
 
-declare const PACKAGE_NAME: string;
-declare const PACKAGE_VERSION: string;
-declare const __DEV__: boolean;
-
 declare global {
+  const PACKAGE_NAME: string;
+  const PACKAGE_VERSION: string;
+  const __DEV__: boolean;
+
   interface Window {
     __clerk_internal_electron?: {
       tokenCache: TokenCache;

packages/electron/src/react/__tests__/ClerkProvider.test.tsx

@@ -90,10 +90,25 @@ describe('Electron ClerkProvider', () => {
 
     expect(request.credentials).toBe('omit');
     expect(request.url.searchParams.get('_is_native')).toBe('1');
+    expect(request.url.searchParams.get('_electron_sdk_version')).toBe('0.0.0-test');
     expect(request.headers.get('Authorization')).toBe('Bearer client-jwt');
     expect(tokenCache.getToken).toHaveBeenCalledWith('__clerk_client_jwt');
   });
 
+  it('adds the Electron SDK version query param when there is no cached token', async () => {
+    tokenCache.getToken.mockResolvedValue(null);
+    renderToStaticMarkup(<ClerkProvider publishableKey='pk_test_version_header'>App</ClerkProvider>);
+
+    const request = {
+      headers: new Headers(),
+      url: new URL('https://api.clerk.test/v1/client'),
+    };
+    await beforeRequest?.(request);
+
+    expect(request.url.searchParams.get('_electron_sdk_version')).toBe('0.0.0-test');
+    expect(request.headers.has('Authorization')).toBe(false);
+  });
+
   it('stores Authorization response headers in the Electron token cache', async () => {
     renderToStaticMarkup(<ClerkProvider publishableKey='pk_test_after_response'>App</ClerkProvider>);
 

packages/electron/src/react/create-clerk-instance.ts

@@ -16,6 +16,7 @@ export function createClerkInstance(publishableKey: string): ClerkInstance {
   clerk.__internal_onBeforeRequest(async request => {
     request.credentials = 'omit';
     request.url?.searchParams.append('_is_native', '1');
+    request.url?.searchParams.append('_electron_sdk_version', PACKAGE_VERSION);
 
     const token = await window.__clerk_internal_electron?.tokenCache.getToken(CLERK_CLIENT_JWT_KEY);
     if (token) {

packages/electron/vitest.config.mts

@@ -0,0 +1,7 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    setupFiles: './vitest.setup.mts',
+  },
+});

packages/electron/vitest.setup.mts

@@ -0,0 +1,3 @@
+globalThis.PACKAGE_NAME = '@clerk/electron';
+globalThis.PACKAGE_VERSION = '0.0.0-test';
+globalThis.__DEV__ = false;