fix(debug): on legacy cli driver mode (#485)

microsoft · May 20, 2024 · 83a4180 · 83a4180
1 parent 308b053
commit 83a4180
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 8 deletions.
diff --git a/playwright.config.ts b/playwright.config.ts
@@ -44,14 +44,14 @@ const config: PlaywrightTestConfig<WorkerOptions> = {
     {
       name: 'legacy',
       use: {
-        overridePlaywrightVersion: 1.42,
+        overridePlaywrightVersion: 1.43,
         showBrowser: false,
       }
     },
     {
       name: 'legacy-reuse',
       use: {
-        overridePlaywrightVersion: 1.42,
+        overridePlaywrightVersion: 1.43,
         showBrowser: true,
       }
     },

diff --git a/src/playwrightTestCLI.ts b/src/playwrightTestCLI.ts
@@ -153,15 +153,15 @@ export class PlaywrightTestCLI {
       return;
     const testDirs = this._model.enabledProjects().map(p => p.project.testDir);
     const escapedLocations = locations.map(escapeRegex);
-    const args = ['test',
+    const args: string[] = ['test',
       '-c', configFile,
       ...escapedLocations,
       options.headed ? '--headed' : '',
       ...this._model.enabledProjectsFilter().map(p => `--project=${p}`),
       '--repeat-each', '1',
       '--retries', '0',
       '--timeout', '0',
-      '--workers', options.workers,
+      '--workers', String(options.workers),
     ].filter(Boolean);
     if (parametrizedTestTitle)
       args.push(`--grep=${escapeRegex(parametrizedTestTitle)}`);

diff --git a/tests/debug-tests.spec.ts b/tests/debug-tests.spec.ts
@@ -15,7 +15,7 @@
  */
 
 import { expect, test, escapedPathSep } from './utils';
-import { TestRun } from './mock/vscode';
+import { TestRun, DebugSession } from './mock/vscode';
 
 test('should debug all tests', async ({ activate }) => {
   const { vscode } = await activate({
@@ -177,3 +177,25 @@ test('should end test run when stopping the debugging', async ({ activate }, tes
 
   testRun.token.source.cancel();
 });
+
+test('should pass all args as string[] when debugging', async ({ activate }) => {
+  test.info().annotations.push({ type: 'issue', description: 'https://github.com/microsoft/playwright/issues/30829' });
+  const { vscode, testController } = await activate({
+    'playwright.config.js': `module.exports = { testDir: 'tests' }`,
+    'tests/test.spec.ts': `
+      import { test } from '@playwright/test';
+      test('pass', () => {});
+    `,
+  });
+
+  await testController.expandTestItems(/test.spec/);
+  const testItems = testController.findTestItems(/pass/);
+
+  const profile = testController.debugProfile();
+  const onDidStartDebugSession = new Promise<DebugSession>(resolve => vscode.debug.onDidStartDebugSession(resolve));
+  const onDidTerminateDebugSession = new Promise(resolve => vscode.debug.onDidTerminateDebugSession(resolve));
+  profile.run(testItems);
+  const session = await onDidStartDebugSession;
+  expect(session.configuration.args.filter(arg => typeof arg !== 'string')).toEqual([]);
+  await onDidTerminateDebugSession;
+});
diff --git a/tests/mock/vscode.ts b/tests/mock/vscode.ts
@@ -633,8 +633,8 @@ type DebugConfiguration  = {
 };
 
 class Debug {
-  private _didStartDebugSession = new EventEmitter();
-  private _didTerminateDebugSession = new EventEmitter();
+  private _didStartDebugSession = new EventEmitter<DebugSession>();
+  private _didTerminateDebugSession = new EventEmitter<DebugSession>();
   readonly onDidStartDebugSession = this._didStartDebugSession.event;
   readonly onDidTerminateDebugSession = this._didTerminateDebugSession.event;
   output = '';
@@ -673,6 +673,7 @@ class Debug {
       });
     });
     this._debuggerProcess.stderr.on('data', data => this.output += data.toString());
+    this._debuggerProcess.on('exit', () => this._didTerminateDebugSession.fire(session));
     return true;
   }
 
@@ -716,7 +717,7 @@ class Debug {
   }
 }
 
-class DebugSession {
+export class DebugSession {
   constructor(
     readonly id: string,
     readonly type: string,