chore: revert "feat: pause at test end or error when debugging" (#719) (#770)

Author: dgozman

src/extension.ts

@@ -33,7 +33,6 @@ import { ansi2html } from './ansi2html';
 import { LocatorsView } from './locatorsView';
 import { pathToFileURL } from 'url';
 import { TestConfig } from './playwrightTestServer';
-import { findTestEndPosition } from './babelHighlightUtil';
 
 const stackUtils = new StackUtils({
   cwd: '/ensure_absolute_paths'
@@ -60,20 +59,14 @@ export class Extension implements RunHooks {
 
   private _testController: vscodeTypes.TestController;
   private _workspaceObserver: WorkspaceObserver;
-  private _testUnderDebug: {
-    testItem: vscodeTypes.TestItem | undefined;
-    testCase: reporterTypes.TestCase;
-    disposables: vscodeTypes.Disposable[];
-  } | undefined;
+  private _testItemUnderDebug: vscodeTypes.TestItem | undefined;
   private _lastBeganTest?: reporterTypes.TestCase;
   private _activeSteps = new Map<reporterTypes.TestStep, StepInfo>();
   private _completedSteps = new Map<reporterTypes.TestStep, StepInfo>();
   private _testRun: vscodeTypes.TestRun | undefined;
   private _models: TestModelCollection;
   private _activeStepDecorationType: vscodeTypes.TextEditorDecorationType;
   private _completedStepDecorationType: vscodeTypes.TextEditorDecorationType;
-  private _pausedOnErrorDecorationType: vscodeTypes.TextEditorDecorationType;
-  private _pausedAtEndDecorationType: vscodeTypes.TextEditorDecorationType;
   private _debugHighlight: DebugHighlight;
   private _isUnderTest: boolean;
   private _reusedBrowser: ReusedBrowser;
@@ -115,21 +108,6 @@ export class Extension implements RunHooks {
       },
     });
 
-    this._pausedAtEndDecorationType = this._vscode.window.createTextEditorDecorationType({
-      isWholeLine: true,
-      backgroundColor: { id: 'editor.wordHighlightStrongBackground' },
-      borderColor: { id: 'editor.wordHighlightStrongBorder' },
-      after: {
-        color: { id: 'editorCodeLens.foreground' },
-        contentText: ' \u2014 paused\u2026',
-      },
-    });
-    this._pausedOnErrorDecorationType = this._vscode.window.createTextEditorDecorationType({
-      isWholeLine: true,
-      backgroundColor: { id: 'editor.wordHighlightStrongBackground' },
-      borderColor: { id: 'editor.wordHighlightStrongBorder' },
-    });
-
     this._logger = this._vscode.window.createOutputChannel('Playwright', { log: true });
     this._settingsModel = new SettingsModel(vscode, context);
     this._reusedBrowser = new ReusedBrowser(this._vscode, this._logger, this._settingsModel, this._envProvider.bind(this));
@@ -142,7 +120,6 @@ export class Extension implements RunHooks {
       envProvider: this._envProvider.bind(this),
       onStdOut: this._debugHighlight.onStdOut.bind(this._debugHighlight),
       requestWatchRun: this._runWatchedTests.bind(this),
-      testPausedHandler: this._onTestPaused.bind(this),
       logger: this._logger,
     });
     this._testController = vscode.tests.createTestController('playwright', 'Playwright');
@@ -240,7 +217,7 @@ export class Extension implements RunHooks {
         const model = this._models.selectedModel();
         if (!model)
           return vscode.window.showWarningMessage(messageNoPlaywrightTestsFound);
-        const openTestCase = this._testUnderDebug?.testCase ?? (this._settingsModel.showBrowser.get() ? this._lastBeganTest : undefined);
+        const openTestCase = this._settingsModel.showBrowser.get() ? this._lastBeganTest : undefined;
         const project = openTestCase ? ancestorProject(openTestCase) : model.enabledProjects()[0]?.project;
         await this._reusedBrowser.record(model, project);
       }),
@@ -649,20 +626,15 @@ export class Extension implements RunHooks {
           this._showTraceOnTestProgress(testItem);
         if (mode === 'debug') {
           // Debugging is always single-workers.
-          this._cleanupItemUnderDebug();
-          this._testUnderDebug = {
-            testItem,
-            testCase: test,
-            disposables: [],
-          };
+          this._testItemUnderDebug = testItem;
         }
       },
 
       onTestEnd: (test: reporterTypes.TestCase, result: reporterTypes.TestResult) => {
         if (result.errors.find(e => e.message?.includes(`Error: browserType.launch: Executable doesn't exist`)))
           browserDoesNotExist = true;
 
-        this._cleanupItemUnderDebug();
+        this._testItemUnderDebug = undefined;
         this._activeSteps.clear();
         this._executionLinesChanged();
 
@@ -725,7 +697,6 @@ export class Extension implements RunHooks {
 
     if (mode === 'debug') {
       await model.debugTests(request, testListener, testRun.token);
-      this._cleanupItemUnderDebug();
     } else {
       // Force trace viewer update to surface check version errors.
       await this._models.selectedModel()?.updateTraceViewer(mode === 'run')?.willRunTests();
@@ -890,44 +861,12 @@ test('test', async ({ page }) => {
   }
 
   private _errorInDebugger(errorStack: string, location: reporterTypes.Location) {
-    if (!this._testRun || !this._testUnderDebug?.testItem)
+    if (!this._testRun || !this._testItemUnderDebug)
       return;
     const testMessage = this._testMessageFromText(errorStack);
     testMessage.location = this._asLocation(location);
-    this._testRun.failed(this._testUnderDebug.testItem, testMessage);
-    this._cleanupItemUnderDebug();
-  }
-
-  private _cleanupItemUnderDebug() {
-    for (const disposable of this._testUnderDebug?.disposables || [])
-      disposable.dispose();
-    this._testUnderDebug = undefined;
-  }
-
-  private async _onTestPaused(params: { errors: reporterTypes.TestError[] }) {
-    if (!this._testUnderDebug)
-      return;
-    const errors = params.errors.filter(e => !!e.message);
-    if (!errors.length) {
-      const location = this._testUnderDebug.testCase.location;
-      const document = await this._vscode.workspace.openTextDocument(location.file);
-      const testEndPosition = findTestEndPosition(document.getText(), uriToPath(document.uri), location) ?? location;
-      const range = this._asRange(testEndPosition);
-      const editor = await this._vscode.window.showTextDocument(document, { selection: range });
-      editor.setDecorations(this._pausedAtEndDecorationType, [{ range }]);
-      this._testUnderDebug.disposables.push({ dispose: () => editor.setDecorations(this._pausedAtEndDecorationType, []) });
-    } else {
-      if (this._testRun && this._testUnderDebug.testItem)
-        this._testRun.failed(this._testUnderDebug.testItem, errors.map(error => this._testMessageForTestError(error)));
-      const error = errors.find(e => e.location);
-      if (error?.location) {
-        const range = this._asRange(error.location);
-        const document = await this._vscode.workspace.openTextDocument(error.location.file);
-        const editor = await this._vscode.window.showTextDocument(document, { selection: range });
-        editor.setDecorations(this._pausedOnErrorDecorationType, [{ range }]);
-        this._testUnderDebug.disposables.push({ dispose: () => editor.setDecorations(this._pausedOnErrorDecorationType, []) });
-      }
-    }
+    this._testRun.failed(this._testItemUnderDebug, testMessage);
+    this._testItemUnderDebug = undefined;
   }
 
   private _executionLinesChanged() {

src/playwrightTestServer.ts

@@ -51,7 +51,6 @@ export type PlaywrightTestOptions = {
   isUnderTest: boolean;
   envProvider: (configFile: string) => NodeJS.ProcessEnv;
   onStdOut: vscodeTypes.Event<string>;
-  testPausedHandler: (params: { errors: reporterTypes.TestError[] }) => void;
   logger: vscodeTypes.LogOutputChannel;
 };
 
@@ -298,7 +297,6 @@ export class PlaywrightTestServer {
       token = debugEnd.token;
 
       const paths = this._normalizePaths();
-      const kMinTestPausedVersion = 1.58;
 
       await this._vscode.debug.startDebugging(undefined, {
         type: 'pwa-node',
@@ -314,8 +312,8 @@ export class PlaywrightTestServer {
           // Reset VSCode's options that affect nested Electron.
           ELECTRON_RUN_AS_NODE: undefined,
           FORCE_COLOR: '1',
-          PW_TEST_SOURCE_TRANSFORM: this._model.config.version < kMinTestPausedVersion ? require.resolve('./debugTransform') : undefined,
-          PW_TEST_SOURCE_TRANSFORM_SCOPE: this._model.config.version < kMinTestPausedVersion ? testDirs.join(pathSeparator) : undefined,
+          PW_TEST_SOURCE_TRANSFORM: require.resolve('./debugTransform'),
+          PW_TEST_SOURCE_TRANSFORM_SCOPE: testDirs.join(pathSeparator),
           PWDEBUG: 'console',
         },
         program: paths.cli,
@@ -333,7 +331,7 @@ export class PlaywrightTestServer {
       if (token?.isCancellationRequested)
         return;
 
-      const { locations, testIds, isSingleTest } = this._model.narrowDownLocations(request);
+      const { locations, testIds } = this._model.narrowDownLocations(request);
       if (!locations && !testIds)
         return;
 
@@ -350,15 +348,12 @@ export class PlaywrightTestServer {
         locations: locationPatterns,
         testIds,
         timeout: 0,
-        pauseAtEnd: isSingleTest,
-        pauseOnError: true,
         ...runOptions,
       };
 
       disposables.push(token.onCancellationRequested(() => {
         debugTestServer!.stopTestsNoReply({});
       }));
-      disposables.push(debugTestServer.onTestPaused(params => this._options.testPausedHandler(params)));
       this._wireTestServer(debugTestServer, reporter, token, disposables);
       try {
         await debugTestServer.runTests(options);

src/testModel.ts

@@ -55,7 +55,6 @@ export type TestModelEmbedder = {
   envProvider: (configFile: string) => NodeJS.ProcessEnv;
   onStdOut: vscodeTypes.Event<string>;
   requestWatchRun: (files: string[], testItems: vscodeTypes.TestItem[]) => void;
-  testPausedHandler: (params: { errors: reporterTypes.TestError[] }) => any;
   logger: vscodeTypes.LogOutputChannel;
 };