Update test suite

Author: heatlikeheatwave

packages/nextjs/src/__tests__/keyless-custom-headers.test.ts

@@ -134,6 +134,7 @@ describe('keyless-custom-headers', () => {
         xPort: '3000',
         xProtocol: 'https',
         xClerkAuthStatus: 'signed-out',
+        isCI: true,
       };
 
       const result = formatMetadataHeaders(metadata);
@@ -149,6 +150,7 @@ describe('keyless-custom-headers', () => {
       expect(result.get('Clerk-X-Port')).toBe('3000');
       expect(result.get('Clerk-X-Protocol')).toBe('https');
       expect(result.get('Clerk-Auth-Status')).toBe('signed-out');
+      expect(result.get('Clerk-Is-CI')).toBe('true');
     });
 
     it('should handle missing optional fields gracefully', () => {
@@ -159,6 +161,7 @@ describe('keyless-custom-headers', () => {
         xPort: '3000',
         xProtocol: 'https',
         xClerkAuthStatus: 'signed-out',
+        isCI: false,
         // Missing: nodeVersion, nextVersion, npmConfigUserAgent, port
       };
 
@@ -177,6 +180,7 @@ describe('keyless-custom-headers', () => {
       expect(result.get('Clerk-Next-Version')).toBeNull();
       expect(result.get('Clerk-NPM-Config-User-Agent')).toBeNull();
       expect(result.get('Clerk-Node-Port')).toBeNull();
+      expect(result.get('Clerk-Is-CI')).toBeNull();
     });
 
     it('should handle undefined values for optional fields', () => {
@@ -191,6 +195,7 @@ describe('keyless-custom-headers', () => {
         xPort: 'test-x-port',
         xProtocol: 'test-x-protocol',
         xClerkAuthStatus: 'test-auth-status',
+        isCI: false,
       };
 
       const result = formatMetadataHeaders(metadata);
@@ -208,6 +213,7 @@ describe('keyless-custom-headers', () => {
       expect(result.get('Clerk-X-Port')).toBe('test-x-port');
       expect(result.get('Clerk-X-Protocol')).toBe('test-x-protocol');
       expect(result.get('Clerk-Auth-Status')).toBe('test-auth-status');
+      expect(result.get('Clerk-Is-CI')).toBeNull();
     });
 
     it('should handle empty string values', () => {
@@ -222,6 +228,7 @@ describe('keyless-custom-headers', () => {
         xPort: '',
         xProtocol: '',
         xClerkAuthStatus: '',
+        isCI: false,
       };
 
       const result = formatMetadataHeaders(metadata);
@@ -237,6 +244,7 @@ describe('keyless-custom-headers', () => {
       expect(result.get('Clerk-X-Port')).toBeNull();
       expect(result.get('Clerk-X-Protocol')).toBeNull();
       expect(result.get('Clerk-Auth-Status')).toBeNull();
+      expect(result.get('Clerk-Is-CI')).toBeNull();
     });
   });
 
@@ -334,6 +342,7 @@ describe('keyless-custom-headers', () => {
         xHost: 'example.com',
         xProtocol: 'https',
         xClerkAuthStatus: 'signed-out',
+        isCI: false,
       });
 
       // Restore original values
@@ -419,6 +428,88 @@ describe('keyless-custom-headers', () => {
       expect(result.xHost).toBe('forwarded-test-host.example.com');
       expect(result.xProtocol).toBe('https');
     });
+
+    it('should detect CI environment with truthy values', async () => {
+      const truthyValues = ['1', 'true', '0.1'];
+      const ciPlatforms = ['CI', 'GITHUB_ACTIONS', 'VERCEL'];
+
+      for (const platform of ciPlatforms) {
+        for (const value of truthyValues) {
+          vi.unstubAllEnvs();
+          vi.stubEnv(platform, value);
+
+          // Recreate headers mock for each iteration to avoid state pollution
+          mockHeaders.mockImplementation(async () => createMockHeaders());
+
+          const result = await collectKeylessMetadata();
+          expect(result.isCI).toBe(true);
+        }
+      }
+    });
+
+    it('should not detect CI environment with falsy values', async () => {
+      const falsyValues = ['0', 'false', ''];
+      const ciPlatforms = ['CI', 'GITHUB_ACTIONS'];
+
+      for (const platform of ciPlatforms) {
+        for (const value of falsyValues) {
+          vi.unstubAllEnvs();
+          vi.stubEnv(platform, value);
+
+          // Recreate headers mock for each iteration to avoid state pollution
+          mockHeaders.mockImplementation(async () => createMockHeaders());
+
+          const result = await collectKeylessMetadata();
+          expect(result.isCI).toBe(false);
+        }
+      }
+    });
+
+    it('should not detect CI environment when no CI indicators are present', async () => {
+      // Clear all CI-related environment variables
+      vi.stubEnv('CI', undefined);
+      vi.stubEnv('GITHUB_ACTIONS', undefined);
+      vi.stubEnv('VERCEL', undefined);
+      vi.stubEnv('NETLIFY', undefined);
+      vi.stubEnv('CIRCLECI', undefined);
+      vi.stubEnv('TRAVIS', undefined);
+      vi.stubEnv('JENKINS_URL', undefined);
+
+      const result = await collectKeylessMetadata();
+
+      expect(result.isCI).toBe(false);
+    });
+
+    it('should only add Clerk-Is-CI header when isCI is true', () => {
+      const metadataWithCI = {
+        userAgent: 'test-user-agent',
+        host: 'test-host',
+        xHost: 'test-x-host',
+        xPort: 'test-x-port',
+        xProtocol: 'test-x-protocol',
+        xClerkAuthStatus: 'test-auth-status',
+        isCI: true,
+      };
+
+      const metadataWithoutCI = {
+        userAgent: 'test-user-agent',
+        host: 'test-host',
+        xHost: 'test-x-host',
+        xPort: 'test-x-port',
+        xProtocol: 'test-x-protocol',
+        xClerkAuthStatus: 'test-auth-status',
+        isCI: false,
+      };
+
+      const resultWithCI = formatMetadataHeaders(metadataWithCI);
+      const resultWithoutCI = formatMetadataHeaders(metadataWithoutCI);
+
+      // When isCI is true, header should be set to 'true'
+      expect(resultWithCI.get('Clerk-Is-CI')).toBe('true');
+
+      // When isCI is false, header should not be set
+      expect(resultWithoutCI.get('Clerk-Is-CI')).toBeNull();
+    });
   });
 
   it('should format metadata collected from collectKeylessMetadata correctly', async () => {
@@ -475,5 +566,67 @@ describe('keyless-custom-headers', () => {
     expect(headers.get('Clerk-X-Protocol')).toBe('https');
     expect(headers.get('Clerk-Auth-Status')).toBe('integration-status');
     expect(headers.get('Clerk-NPM-Config-User-Agent')).toBe('test-npm-agent');
+    expect(headers.get('Clerk-Is-CI')).toBeNull(); // Should be null when no CI environment is detected
+  });
+
+  it('should format metadata with CI environment detected correctly', async () => {
+    // Reset mock to ensure clean state from previous test
+    mockHeaders.mockReset();
+
+    // Setup environment with CI detection
+    vi.stubEnv('PORT', '4000');
+    vi.stubEnv('npm_config_user_agent', 'test-npm-agent');
+    vi.stubEnv('CI', '1'); // Set CI environment variable
+
+    const mockHeaderStore = new Headers({
+      'User-Agent': 'Integration-Test-Agent',
+      host: 'localhost:4000',
+      'x-forwarded-port': '4000',
+      'x-forwarded-host': 'integration-forwarded-host',
+      'x-forwarded-proto': 'https',
+      'x-clerk-auth-status': 'integration-status',
+    });
+
+    mockHeaders.mockResolvedValue({
+      get: (key: string) => mockHeaderStore.get(key) || null,
+      has: (key: string) => mockHeaderStore.has(key),
+      forEach: () => {},
+      entries: function* () {
+        const headerEntries: [string, string][] = [];
+        mockHeaderStore.forEach((value, key) => headerEntries.push([key, value]));
+        for (const entry of headerEntries) {
+          yield entry;
+        }
+      },
+      keys: function* () {
+        const headerKeys: string[] = [];
+        mockHeaderStore.forEach((_, key) => headerKeys.push(key));
+        for (const key of headerKeys) {
+          yield key;
+        }
+      },
+      values: function* () {
+        const headerValues: string[] = [];
+        mockHeaderStore.forEach(value => headerValues.push(value));
+        for (const value of headerValues) {
+          yield value;
+        }
+      },
+    } as MockHeaders);
+
+    // Collect metadata and format headers
+    const metadata = await collectKeylessMetadata();
+    const headers = formatMetadataHeaders(metadata);
+
+    // Verify the full pipeline works correctly with CI detection
+    expect(headers.get('Clerk-Client-User-Agent')).toBe('Integration-Test-Agent');
+    expect(headers.get('Clerk-Client-Host')).toBe('localhost:4000');
+    expect(headers.get('Clerk-Node-Port')).toBe('4000');
+    expect(headers.get('Clerk-X-Port')).toBe('4000');
+    expect(headers.get('Clerk-X-Host')).toBe('integration-forwarded-host');
+    expect(headers.get('Clerk-X-Protocol')).toBe('https');
+    expect(headers.get('Clerk-Auth-Status')).toBe('integration-status');
+    expect(headers.get('Clerk-NPM-Config-User-Agent')).toBe('test-npm-agent');
+    expect(headers.get('Clerk-Is-CI')).toBe('true'); // Should be 'true' when CI environment is detected
   });
 });