fix(cli): automatically enable headed mode when keepWindow is true (#1030)

Author: quanru

packages/cli/src/cli-utils.ts

@@ -55,7 +55,7 @@ Usage:
       },
       'keep-window': {
         type: 'boolean',
-        description: `Keep the browser window open after the script finishes. This is useful when debugging, but will consume more resources, default is ${defaultConfig.keepWindow}`,
+        description: `Keep the browser window open after the script finishes. This option automatically enables --headed mode. This is useful when debugging, but will consume more resources, default is ${defaultConfig.keepWindow}`,
       },
       'share-browser-context': {
         type: 'boolean',

packages/cli/src/config-factory.ts

@@ -147,15 +147,21 @@ export async function createConfig(
   );
 
   // Apply command line overrides with higher priority than file configuration
+  const keepWindow = options?.keepWindow ?? parsedConfig.keepWindow;
+  const headed = options?.headed ?? parsedConfig.headed;
+
+  // If keepWindow is true, automatically enable headed mode
+  const finalHeaded = keepWindow || headed;
+
   return {
     files: parsedConfig.files,
     concurrent: options?.concurrent ?? parsedConfig.concurrent,
     continueOnError: options?.continueOnError ?? parsedConfig.continueOnError,
     summary: options?.summary ?? parsedConfig.summary,
     shareBrowserContext:
       options?.shareBrowserContext ?? parsedConfig.shareBrowserContext,
-    headed: options?.headed ?? parsedConfig.headed,
-    keepWindow: options?.keepWindow ?? parsedConfig.keepWindow,
+    headed: finalHeaded,
+    keepWindow: keepWindow,
     dotenvOverride: options?.dotenvOverride ?? parsedConfig.dotenvOverride,
     dotenvDebug: options?.dotenvDebug ?? parsedConfig.dotenvDebug,
     globalConfig,
@@ -171,15 +177,21 @@ export async function createFilesConfig(
   const timestamp = Date.now();
   const defaultSummary = `summary-${timestamp}.json`;
 
+  const keepWindow = options.keepWindow ?? defaultConfig.keepWindow;
+  const headed = options.headed ?? defaultConfig.headed;
+
+  // If keepWindow is true, automatically enable headed mode
+  const finalHeaded = keepWindow || headed;
+
   return {
     files,
     concurrent: options.concurrent ?? defaultConfig.concurrent,
     continueOnError: options.continueOnError ?? defaultConfig.continueOnError,
     summary: options.summary ?? defaultSummary,
     shareBrowserContext:
       options.shareBrowserContext ?? defaultConfig.shareBrowserContext,
-    headed: options.headed ?? defaultConfig.headed,
-    keepWindow: options.keepWindow ?? defaultConfig.keepWindow,
+    headed: finalHeaded,
+    keepWindow: keepWindow,
     dotenvOverride: options.dotenvOverride ?? defaultConfig.dotenvOverride,
     dotenvDebug: options.dotenvDebug ?? defaultConfig.dotenvDebug,
     globalConfig: {

packages/cli/tests/unit-test/config-factory.test.ts

@@ -137,6 +137,50 @@ summary: "yaml-summary.json"
   });
 
   describe('createConfig', () => {
+    test('should automatically enable headed when keepWindow is true', async () => {
+      const mockYamlContent = `
+files:
+  - file1.yml
+keepWindow: true
+headed: false
+`;
+      const mockParsedYaml = {
+        files: ['file1.yml'],
+        concurrent: 1,
+        continueOnError: false,
+        headed: false,
+        keepWindow: true,
+        dotenvOverride: false,
+        dotenvDebug: false,
+        summary: 'parsed.json',
+        shareBrowserContext: false,
+      };
+      vi.mocked(readFileSync).mockReturnValue(mockYamlContent);
+      vi.mocked(yamlLoad).mockReturnValue(mockParsedYaml);
+      vi.mocked(matchYamlFiles).mockResolvedValue(['file1.yml']);
+
+      // Test 1: keepWindow from config file should enable headed
+      const result1 = await createConfig('/test/index.yml');
+      expect(result1.keepWindow).toBe(true);
+      expect(result1.headed).toBe(true);
+
+      // Test 2: keepWindow from command line should enable headed
+      const result2 = await createConfig('/test/index.yml', {
+        keepWindow: true,
+        headed: false,
+      });
+      expect(result2.keepWindow).toBe(true);
+      expect(result2.headed).toBe(true);
+
+      // Test 3: keepWindow false should not affect headed
+      const result3 = await createConfig('/test/index.yml', {
+        keepWindow: false,
+        headed: true,
+      });
+      expect(result3.keepWindow).toBe(false);
+      expect(result3.headed).toBe(true);
+    });
+
     test('should merge command-line options over config file options', async () => {
       const mockYamlContent = `
 files:
@@ -189,6 +233,43 @@ concurrent: 2
   });
 
   describe('createFilesConfig', async () => {
+    test('should automatically enable headed when keepWindow is true', async () => {
+      const patterns = ['test.yml'];
+      const expandedFiles = ['test.yml'];
+      vi.mocked(matchYamlFiles).mockResolvedValue(expandedFiles);
+
+      // Test 1: keepWindow true should enable headed
+      const result1 = await createFilesConfig(patterns, {
+        keepWindow: true,
+        headed: false,
+      });
+      expect(result1.keepWindow).toBe(true);
+      expect(result1.headed).toBe(true);
+
+      // Test 2: keepWindow true with headed undefined should enable headed
+      const result2 = await createFilesConfig(patterns, {
+        keepWindow: true,
+      });
+      expect(result2.keepWindow).toBe(true);
+      expect(result2.headed).toBe(true);
+
+      // Test 3: keepWindow false should not affect headed true
+      const result3 = await createFilesConfig(patterns, {
+        keepWindow: false,
+        headed: true,
+      });
+      expect(result3.keepWindow).toBe(false);
+      expect(result3.headed).toBe(true);
+
+      // Test 4: Both false should remain false
+      const result4 = await createFilesConfig(patterns, {
+        keepWindow: false,
+        headed: false,
+      });
+      expect(result4.keepWindow).toBe(false);
+      expect(result4.headed).toBe(false);
+    });
+
     test('should create config with default options and expand patterns', async () => {
       const patterns = ['test1.yml', 'test*.yml'];
       const expandedFiles = ['test1.yml', 'testA.yml', 'testB.yml'];