fix: exclude tracesDir option from launchOptions fixture (#24086)

Fixes #23645
microsoft · Jul 6, 2023 · 9af2b51 · 9af2b51
1 parent 3536e81
commit 9af2b51
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 2 deletions.
diff --git a/packages/playwright-test/types/test.d.ts b/packages/playwright-test/types/test.d.ts
@@ -3530,7 +3530,7 @@ export interface PlaywrightWorkerOptions {
    * ```
    *
    */
-  launchOptions: LaunchOptions;
+  launchOptions: Omit<LaunchOptions, 'tracesDir'>;
   /**
    * **Usage**
    *

diff --git a/tests/playwright-test/config.spec.ts b/tests/playwright-test/config.spec.ts
@@ -480,3 +480,20 @@ test('should have correct types for the config', async ({ runTSC }) => {
   });
   expect(result.exitCode).toBe(0);
 });
+
+test('should not allow tracesDir in launchOptions', async ({ runTSC }) => {
+  const result = await runTSC({
+    'playwright.config.ts': `
+      import { defineConfig } from '@playwright/test';
+
+      export default defineConfig({
+        use: {
+          launchOptions: {
+            tracesDir: 'foo',
+          },
+        },
+      });
+  `
+  });
+  expect(result.exitCode).not.toBe(0);
+});
diff --git a/utils/generate_types/overrides-test.d.ts b/utils/generate_types/overrides-test.d.ts
@@ -203,7 +203,7 @@ export interface PlaywrightWorkerOptions {
   defaultBrowserType: BrowserName;
   headless: boolean;
   channel: BrowserChannel | undefined;
-  launchOptions: LaunchOptions;
+  launchOptions: Omit<LaunchOptions, 'tracesDir'>;
   connectOptions: ConnectOptions | undefined;
   screenshot: ScreenshotMode | { mode: ScreenshotMode } & Pick<PageScreenshotOptions, 'fullPage' | 'omitBackground'>;
   trace: TraceMode | /** deprecated */ 'retry-with-trace' | { mode: TraceMode, snapshots?: boolean, screenshots?: boolean, sources?: boolean, attachments?: boolean };