fix debug restart (#24438)

eleanorjboyd · web-flow · commit 29d4f357bbd4 · 2024-11-14T12:07:11.000-08:00
fixes #24437 also tested and fixes microsoft/vscode-python-debugger#338
diff --git a/src/client/common/application/debugService.ts b/src/client/common/application/debugService.ts
@@ -13,6 +13,7 @@ import {
     DebugConsole,
     DebugSession,
     DebugSessionCustomEvent,
+    DebugSessionOptions,
     Disposable,
     Event,
     WorkspaceFolder,
@@ -57,7 +58,7 @@ export class DebugService implements IDebugService {
     public startDebugging(
         folder: WorkspaceFolder | undefined,
         nameOrConfiguration: string | DebugConfiguration,
-        parentSession?: DebugSession,
+        parentSession?: DebugSession | DebugSessionOptions,
     ): Thenable<boolean> {
         return debug.startDebugging(folder, nameOrConfiguration, parentSession);
     }
diff --git a/src/client/testing/common/debugLauncher.ts b/src/client/testing/common/debugLauncher.ts
@@ -1,6 +1,6 @@
 import { inject, injectable, named } from 'inversify';
 import * as path from 'path';
-import { DebugConfiguration, l10n, Uri, WorkspaceFolder, DebugSession } from 'vscode';
+import { DebugConfiguration, l10n, Uri, WorkspaceFolder, DebugSession, DebugSessionOptions } from 'vscode';
 import { IApplicationShell, IDebugService } from '../../common/application/types';
 import { EXTENSION_ROOT_DIR } from '../../common/constants';
 import * as internalScripts from '../../common/process/internal/scripts';
@@ -32,7 +32,11 @@ export class DebugLauncher implements ITestDebugLauncher {
         this.configService = this.serviceContainer.get<IConfigurationService>(IConfigurationService);
     }
 
-    public async launchDebugger(options: LaunchOptions, callback?: () => void): Promise<void> {
+    public async launchDebugger(
+        options: LaunchOptions,
+        callback?: () => void,
+        sessionOptions?: DebugSessionOptions,
+    ): Promise<void> {
         const deferred = createDeferred<void>();
         let hasCallbackBeenCalled = false;
         if (options.token && options.token.isCancellationRequested) {
@@ -57,7 +61,7 @@ export class DebugLauncher implements ITestDebugLauncher {
         const debugManager = this.serviceContainer.get<IDebugService>(IDebugService);
 
         let activatedDebugSession: DebugSession | undefined;
-        debugManager.startDebugging(workspaceFolder, launchArgs).then(() => {
+        debugManager.startDebugging(workspaceFolder, launchArgs, sessionOptions).then(() => {
             // Save the debug session after it is started so we can check if it is the one that was terminated.
             activatedDebugSession = debugManager.activeDebugSession;
         });
diff --git a/src/client/testing/common/types.ts b/src/client/testing/common/types.ts
@@ -1,4 +1,4 @@
-import { CancellationToken, Disposable, OutputChannel, Uri } from 'vscode';
+import { CancellationToken, DebugSessionOptions, Disposable, OutputChannel, Uri } from 'vscode';
 import { Product } from '../../common/types';
 import { TestSettingsPropertyNames } from '../configuration/types';
 import { TestProvider } from '../types';
@@ -89,7 +89,7 @@ export interface ITestConfigurationManagerFactory {
 }
 export const ITestDebugLauncher = Symbol('ITestDebugLauncher');
 export interface ITestDebugLauncher {
-    launchDebugger(options: LaunchOptions, callback?: () => void): Promise<void>;
+    launchDebugger(options: LaunchOptions, callback?: () => void, sessionOptions?: DebugSessionOptions): Promise<void>;
 }
 
 export const IUnitTestSocketServer = Symbol('IUnitTestSocketServer');
diff --git a/src/client/testing/testController/pytest/pytestExecutionAdapter.ts b/src/client/testing/testController/pytest/pytestExecutionAdapter.ts
@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-import { CancellationTokenSource, TestRun, TestRunProfileKind, Uri } from 'vscode';
+import { CancellationTokenSource, DebugSessionOptions, TestRun, TestRunProfileKind, Uri } from 'vscode';
 import * as path from 'path';
 import { ChildProcess } from 'child_process';
 import { IConfigurationService, ITestOutputChannel } from '../../../common/types';
@@ -167,10 +167,17 @@ export class PytestTestExecutionAdapter implements ITestExecutionAdapter {
                     runTestIdsPort: testIdsFileName,
                     pytestPort: resultNamedPipeName,
                 };
+                const sessionOptions: DebugSessionOptions = {
+                    testRun: runInstance,
+                };
                 traceInfo(`Running DEBUG pytest with arguments: ${testArgs} for workspace ${uri.fsPath} \r\n`);
-                await debugLauncher!.launchDebugger(launchOptions, () => {
-                    serverCancel.cancel();
-                });
+                await debugLauncher!.launchDebugger(
+                    launchOptions,
+                    () => {
+                        serverCancel.cancel();
+                    },
+                    sessionOptions,
+                );
             } else {
                 // deferredTillExecClose is resolved when all stdout and stderr is read
                 const deferredTillExecClose: Deferred<void> = utils.createTestingDeferred();
diff --git a/src/client/testing/testController/unittest/testExecutionAdapter.ts b/src/client/testing/testController/unittest/testExecutionAdapter.ts
@@ -2,7 +2,7 @@
 // Licensed under the MIT License.
 
 import * as path from 'path';
-import { CancellationTokenSource, TestRun, TestRunProfileKind, Uri } from 'vscode';
+import { CancellationTokenSource, DebugSessionOptions, TestRun, TestRunProfileKind, Uri } from 'vscode';
 import { ChildProcess } from 'child_process';
 import { IConfigurationService, ITestOutputChannel } from '../../../common/types';
 import { Deferred, createDeferred } from '../../../common/utils/async';
@@ -166,15 +166,22 @@ export class UnittestTestExecutionAdapter implements ITestExecutionAdapter {
                     runTestIdsPort: testIdsFileName,
                     pytestPort: resultNamedPipeName, // change this from pytest
                 };
+                const sessionOptions: DebugSessionOptions = {
+                    testRun: runInstance,
+                };
                 traceInfo(`Running DEBUG unittest for workspace ${options.cwd} with arguments: ${args}\r\n`);
 
                 if (debugLauncher === undefined) {
                     traceError('Debug launcher is not defined');
                     throw new Error('Debug launcher is not defined');
                 }
-                await debugLauncher.launchDebugger(launchOptions, () => {
-                    serverCancel.cancel();
-                });
+                await debugLauncher.launchDebugger(
+                    launchOptions,
+                    () => {
+                        serverCancel.cancel();
+                    },
+                    sessionOptions,
+                );
             } else {
                 // This means it is running the test
                 traceInfo(`Running unittests for workspace ${cwd} with arguments: ${args}\r\n`);
diff --git a/src/test/testing/common/debugLauncher.unit.test.ts b/src/test/testing/common/debugLauncher.unit.test.ts
@@ -129,7 +129,9 @@ suite('Unit Tests - Debug Launcher', () => {
         const deferred = createDeferred<void>();
 
         debugService
-            .setup((d) => d.startDebugging(TypeMoq.It.isValue(workspaceFolder), TypeMoq.It.isValue(expected)))
+            .setup((d) =>
+                d.startDebugging(TypeMoq.It.isValue(workspaceFolder), TypeMoq.It.isValue(expected), undefined),
+            )
             .returns((_wspc: WorkspaceFolder, _expectedParam: DebugConfiguration) => {
                 deferred.resolve();
                 return Promise.resolve(undefined as any);
@@ -299,7 +301,7 @@ suite('Unit Tests - Debug Launcher', () => {
         });
         test(`Must not launch debugger if cancelled ${testTitleSuffix}`, async () => {
             debugService
-                .setup((d) => d.startDebugging(TypeMoq.It.isAny(), TypeMoq.It.isAny()))
+                .setup((d) => d.startDebugging(TypeMoq.It.isAny(), TypeMoq.It.isAny(), TypeMoq.It.isAny()))
                 .returns(() => {
                     return Promise.resolve(undefined as any);
                 })
diff --git a/src/test/testing/testController/pytest/pytestExecutionAdapter.unit.test.ts b/src/test/testing/testController/pytest/pytestExecutionAdapter.unit.test.ts
@@ -2,7 +2,7 @@
 //  Copyright (c) Microsoft Corporation. All rights reserved.
 //  Licensed under the MIT License.
 import * as assert from 'assert';
-import { TestRun, Uri, TestRunProfileKind } from 'vscode';
+import { TestRun, Uri, TestRunProfileKind, DebugSessionOptions } from 'vscode';
 import * as typeMoq from 'typemoq';
 import * as sinon from 'sinon';
 import * as path from 'path';
@@ -238,7 +238,7 @@ suite('pytest test execution adapter', () => {
         const deferred3 = createDeferred();
         utilsWriteTestIdsFileStub.callsFake(() => Promise.resolve('testIdPipe-mockName'));
         debugLauncher
-            .setup((dl) => dl.launchDebugger(typeMoq.It.isAny(), typeMoq.It.isAny()))
+            .setup((dl) => dl.launchDebugger(typeMoq.It.isAny(), typeMoq.It.isAny(), typeMoq.It.isAny()))
             .returns(async (_opts, callback) => {
                 traceInfo('stubs launch debugger');
                 if (typeof callback === 'function') {
@@ -273,6 +273,10 @@ suite('pytest test execution adapter', () => {
                         return true;
                     }),
                     typeMoq.It.isAny(),
+                    typeMoq.It.is<DebugSessionOptions>((sessionOptions) => {
+                        assert.equal(sessionOptions.testRun, testRun.object);
+                        return true;
+                    }),
                 ),
             typeMoq.Times.once(),
         );
diff --git a/src/test/testing/testController/testCancellationRunAdapters.unit.test.ts b/src/test/testing/testController/testCancellationRunAdapters.unit.test.ts
@@ -185,7 +185,7 @@ suite('Execution Flow Run Adapters', () => {
 
             // debugLauncher mocked
             debugLauncher
-                .setup((dl) => dl.launchDebugger(typeMoq.It.isAny(), typeMoq.It.isAny()))
+                .setup((dl) => dl.launchDebugger(typeMoq.It.isAny(), typeMoq.It.isAny(), typeMoq.It.isAny()))
                 .callback((_options, callback) => {
                     if (callback) {
                         callback();
diff --git a/src/test/testing/testController/unittest/testExecutionAdapter.unit.test.ts b/src/test/testing/testController/unittest/testExecutionAdapter.unit.test.ts
@@ -2,7 +2,7 @@
 //  Copyright (c) Microsoft Corporation. All rights reserved.
 //  Licensed under the MIT License.
 import * as assert from 'assert';
-import { TestRun, TestRunProfileKind, Uri } from 'vscode';
+import { DebugSessionOptions, TestRun, TestRunProfileKind, Uri } from 'vscode';
 import * as typeMoq from 'typemoq';
 import * as sinon from 'sinon';
 import * as path from 'path';
@@ -237,7 +237,7 @@ suite('Unittest test execution adapter', () => {
         const deferred3 = createDeferred();
         utilsWriteTestIdsFileStub.callsFake(() => Promise.resolve('testIdPipe-mockName'));
         debugLauncher
-            .setup((dl) => dl.launchDebugger(typeMoq.It.isAny(), typeMoq.It.isAny()))
+            .setup((dl) => dl.launchDebugger(typeMoq.It.isAny(), typeMoq.It.isAny(), typeMoq.It.isAny()))
             .returns(async (_opts, callback) => {
                 traceInfo('stubs launch debugger');
                 if (typeof callback === 'function') {
@@ -271,6 +271,10 @@ suite('Unittest test execution adapter', () => {
                         return true;
                     }),
                     typeMoq.It.isAny(),
+                    typeMoq.It.is<DebugSessionOptions>((sessionOptions) => {
+                        assert.equal(sessionOptions.testRun, testRun.object);
+                        return true;
+                    }),
                 ),
             typeMoq.Times.once(),
         );

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { CancellationToken, Disposable, OutputChannel, Uri } from 'vscode';`
	`1`	`+import { CancellationToken, DebugSessionOptions, Disposable, OutputChannel, Uri } from 'vscode';`
`2`	`2`	`import { Product } from '../../common/types';`
`3`	`3`	`import { TestSettingsPropertyNames } from '../configuration/types';`
`4`	`4`	`import { TestProvider } from '../types';`
`@@ -89,7 +89,7 @@ export interface ITestConfigurationManagerFactory {`
`89`	`89`	`}`
`90`	`90`	`export const ITestDebugLauncher = Symbol('ITestDebugLauncher');`
`91`	`91`	`export interface ITestDebugLauncher {`
`92`		`- launchDebugger(options: LaunchOptions, callback?: () => void): Promise<void>;`
	`92`	`+ launchDebugger(options: LaunchOptions, callback?: () => void, sessionOptions?: DebugSessionOptions): Promise<void>;`
`93`	`93`	`}`
`94`	`94`
`95`	`95`	`export const IUnitTestSocketServer = Symbol('IUnitTestSocketServer');`