Make the cursor focus switch automatically to the terminal after laun… (microsoft/vscode-python#17884)

djplt · wesm · commit f41425086a80 · 2024-03-28T15:03:47.000-05:00
* Make the cursor focus switch automatically to the terminal after launching a python process with configurability (microsoft/vscode-python#14851) * Add focus on terminal to code execution manager
diff --git a/extensions/positron-python/news/1 Enhancements/14851.md b/extensions/positron-python/news/1 Enhancements/14851.md
@@ -0,0 +1 @@
+Make cursor focus switch automatically to the terminal after launching a python process with configuration option. (Thanks [djplt](https://github.com/djplt))
diff --git a/extensions/positron-python/package.json b/extensions/positron-python/package.json
@@ -945,6 +945,12 @@
                     "scope": "resource",
                     "type": "boolean"
                 },
+                "python.terminal.focusAfterLaunch": {
+                    "default": false,
+                    "description": "When launching a python process, whether to focus on the terminal.",
+                    "scope": "resource",
+                    "type": "boolean"
+                },
                 "python.terminal.launchArgs": {
                     "default": [],
                     "description": "Python launch arguments to use when executing a file in the terminal.",
diff --git a/extensions/positron-python/src/client/common/application/commands.ts b/extensions/positron-python/src/client/common/application/commands.ts
@@ -27,6 +27,7 @@ interface ICommandNameWithoutArgumentTypeMapping {
     ['workbench.action.debug.stop']: [];
     ['workbench.action.reloadWindow']: [];
     ['workbench.action.closeActiveEditor']: [];
+    ['workbench.action.terminal.focus']: [];
     ['editor.action.formatDocument']: [];
     ['editor.action.rename']: [];
     [Commands.ViewOutput]: [];
diff --git a/extensions/positron-python/src/client/common/configSettings.ts b/extensions/positron-python/src/client/common/configSettings.ts
@@ -465,6 +465,7 @@ export class PythonSettings implements IPythonSettings {
             ? this.terminal
             : {
                   executeInFileDir: true,
+                  focusAfterLaunch: false,
                   launchArgs: [],
                   activateEnvironment: true,
                   activateEnvInCurrentTerminal: false,
diff --git a/extensions/positron-python/src/client/common/types.ts b/extensions/positron-python/src/client/common/types.ts
@@ -276,6 +276,7 @@ export interface IFormattingSettings {
 
 export interface ITerminalSettings {
     readonly executeInFileDir: boolean;
+    readonly focusAfterLaunch: boolean;
     readonly launchArgs: string[];
     readonly activateEnvironment: boolean;
     readonly activateEnvInCurrentTerminal: boolean;
diff --git a/extensions/positron-python/src/client/debugger/extension/adapter/activator.ts b/extensions/positron-python/src/client/debugger/extension/adapter/activator.ts
@@ -2,11 +2,12 @@
 // Licensed under the MIT License.
 
 'use strict';
-
+import { Uri } from 'vscode';
 import { inject, injectable } from 'inversify';
 import { IExtensionSingleActivationService } from '../../../activation/types';
 import { IDebugService } from '../../../common/application/types';
-import { IDisposableRegistry } from '../../../common/types';
+import { IConfigurationService, IDisposableRegistry } from '../../../common/types';
+import { ICommandManager } from '../../../common/application/types';
 import { DebuggerTypeName } from '../../constants';
 import { IAttachProcessProviderFactory } from '../attachQuickPick/types';
 import { IDebugAdapterDescriptorFactory, IDebugSessionLoggingFactory, IOutdatedDebuggerPromptFactory } from '../types';
@@ -16,6 +17,8 @@ export class DebugAdapterActivator implements IExtensionSingleActivationService
     public readonly supportedWorkspaceTypes = { untrustedWorkspace: false, virtualWorkspace: false };
     constructor(
         @inject(IDebugService) private readonly debugService: IDebugService,
+        @inject(IConfigurationService) private readonly configSettings: IConfigurationService,
+        @inject(ICommandManager) private commandManager: ICommandManager,
         @inject(IDebugAdapterDescriptorFactory) private descriptorFactory: IDebugAdapterDescriptorFactory,
         @inject(IDebugSessionLoggingFactory) private debugSessionLoggingFactory: IDebugSessionLoggingFactory,
         @inject(IOutdatedDebuggerPromptFactory) private debuggerPromptFactory: IOutdatedDebuggerPromptFactory,
@@ -32,8 +35,19 @@ export class DebugAdapterActivator implements IExtensionSingleActivationService
         this.disposables.push(
             this.debugService.registerDebugAdapterTrackerFactory(DebuggerTypeName, this.debuggerPromptFactory),
         );
+
         this.disposables.push(
             this.debugService.registerDebugAdapterDescriptorFactory(DebuggerTypeName, this.descriptorFactory),
         );
+        this.disposables.push(
+            this.debugService.onDidStartDebugSession((debugSession) => {
+                if (this.shouldTerminalFocusOnStart(debugSession.workspaceFolder?.uri))
+                    this.commandManager.executeCommand('workbench.action.terminal.focus');
+            }),
+        );
+    }
+
+    private shouldTerminalFocusOnStart(uri: Uri | undefined): boolean {
+        return this.configSettings.getSettings(uri)?.terminal.focusAfterLaunch;
     }
 }
diff --git a/extensions/positron-python/src/client/terminals/codeExecution/codeExecutionManager.ts b/extensions/positron-python/src/client/terminals/codeExecution/codeExecutionManager.ts
@@ -10,7 +10,7 @@ import { ICommandManager, IDocumentManager } from '../../common/application/type
 import { Commands } from '../../common/constants';
 import '../../common/extensions';
 import { IFileSystem } from '../../common/platform/types';
-import { IDisposableRegistry, Resource } from '../../common/types';
+import { IDisposableRegistry, IConfigurationService, Resource } from '../../common/types';
 import { noop } from '../../common/utils/misc';
 import { IServiceContainer } from '../../ioc/types';
 import { traceError } from '../../logging';
@@ -26,6 +26,7 @@ export class CodeExecutionManager implements ICodeExecutionManager {
         @inject(IDocumentManager) private documentManager: IDocumentManager,
         @inject(IDisposableRegistry) private disposableRegistry: Disposable[],
         @inject(IFileSystem) private fileSystem: IFileSystem,
+        @inject(IConfigurationService) private readonly configSettings: IConfigurationService,
         @inject(IServiceContainer) private serviceContainer: IServiceContainer,
     ) {}
 
@@ -38,22 +39,32 @@ export class CodeExecutionManager implements ICodeExecutionManager {
             this.disposableRegistry.push(
                 this.commandManager.registerCommand(cmd as any, async (file: Resource) => {
                     const trigger = cmd === Commands.Exec_In_Terminal ? 'command' : 'icon';
-                    await this.executeFileInTerminal(file, trigger).catch((ex) =>
-                        traceError('Failed to execute file in terminal', ex),
-                    );
+                    await this.executeFileInTerminal(file, trigger)
+                        .then(() => {
+                            if (this.shouldTerminalFocusOnStart(file))
+                                this.commandManager.executeCommand('workbench.action.terminal.focus');
+                        })
+                        .catch((ex) => traceError('Failed to execute file in terminal', ex));
                 }),
             );
         });
         this.disposableRegistry.push(
-            this.commandManager.registerCommand(
-                Commands.Exec_Selection_In_Terminal,
-                this.executeSelectionInTerminal.bind(this),
-            ),
+            this.commandManager.registerCommand(Commands.Exec_Selection_In_Terminal as any, async (file: Resource) => {
+                await this.executeSelectionInTerminal().then(() => {
+                    if (this.shouldTerminalFocusOnStart(file))
+                        this.commandManager.executeCommand('workbench.action.terminal.focus');
+                });
+            }),
         );
         this.disposableRegistry.push(
             this.commandManager.registerCommand(
-                Commands.Exec_Selection_In_Django_Shell,
-                this.executeSelectionInDjangoShell.bind(this),
+                Commands.Exec_Selection_In_Django_Shell as any,
+                async (file: Resource) => {
+                    await this.executeSelectionInDjangoShell().then(() => {
+                        if (this.shouldTerminalFocusOnStart(file))
+                            this.commandManager.executeCommand('workbench.action.terminal.focus');
+                    });
+                },
             ),
         );
     }
@@ -115,4 +126,8 @@ export class CodeExecutionManager implements ICodeExecutionManager {
 
         await executionService.execute(normalizedCode, activeEditor!.document.uri);
     }
+
+    private shouldTerminalFocusOnStart(uri: Uri | undefined): boolean {
+        return this.configSettings.getSettings(uri)?.terminal.focusAfterLaunch;
+    }
 }
diff --git a/extensions/positron-python/src/test/debugger/extension/adapter/activator.unit.test.ts b/extensions/positron-python/src/test/debugger/extension/adapter/activator.unit.test.ts
@@ -6,10 +6,11 @@
 import * as assert from 'assert';
 import { anything, instance, mock, verify, when } from 'ts-mockito';
 import { IExtensionSingleActivationService } from '../../../../client/activation/types';
+import { CommandManager } from '../../../../client/common/application/commandManager';
 import { DebugService } from '../../../../client/common/application/debugService';
-import { IDebugService } from '../../../../client/common/application/types';
+import { ICommandManager, IDebugService } from '../../../../client/common/application/types';
 import { ConfigurationService } from '../../../../client/common/configuration/service';
-import { IDisposableRegistry, IPythonSettings } from '../../../../client/common/types';
+import { IConfigurationService, IDisposableRegistry, IPythonSettings } from '../../../../client/common/types';
 import { DebugAdapterActivator } from '../../../../client/debugger/extension/adapter/activator';
 import { DebugAdapterDescriptorFactory } from '../../../../client/debugger/extension/adapter/factory';
 import { DebugSessionLoggingFactory } from '../../../../client/debugger/extension/adapter/logging';
@@ -27,27 +28,36 @@ import { noop } from '../../../core';
 suite('Debugging - Adapter Factory and logger Registration', () => {
     let activator: IExtensionSingleActivationService;
     let debugService: IDebugService;
+    let commandManager: ICommandManager;
     let descriptorFactory: IDebugAdapterDescriptorFactory;
     let loggingFactory: IDebugSessionLoggingFactory;
     let debuggerPromptFactory: IOutdatedDebuggerPromptFactory;
     let disposableRegistry: IDisposableRegistry;
     let attachFactory: IAttachProcessProviderFactory;
+    let configService: IConfigurationService;
 
     setup(() => {
-        const configurationService = mock(ConfigurationService);
+        attachFactory = mock(AttachProcessProviderFactory);
+
+        debugService = mock(DebugService);
+        when(debugService.onDidStartDebugSession).thenReturn(() => noop as any);
+
+        commandManager = mock(CommandManager);
 
-        when(configurationService.getSettings(undefined)).thenReturn(({
+        configService = mock(ConfigurationService);
+        when(configService.getSettings(undefined)).thenReturn(({
             experiments: { enabled: true },
         } as any) as IPythonSettings);
-        attachFactory = mock(AttachProcessProviderFactory);
 
-        debugService = mock(DebugService);
         descriptorFactory = mock(DebugAdapterDescriptorFactory);
         loggingFactory = mock(DebugSessionLoggingFactory);
         debuggerPromptFactory = mock(OutdatedDebuggerPromptFactory);
         disposableRegistry = [];
+
         activator = new DebugAdapterActivator(
             instance(debugService),
+            instance(configService),
+            instance(commandManager),
             instance(descriptorFactory),
             instance(loggingFactory),
             instance(debuggerPromptFactory),
@@ -72,9 +82,10 @@ suite('Debugging - Adapter Factory and logger Registration', () => {
         const disposable = { dispose: noop };
         when(debugService.registerDebugAdapterTrackerFactory(anything(), anything())).thenReturn(disposable);
         when(debugService.registerDebugAdapterDescriptorFactory(anything(), anything())).thenReturn(disposable);
+        when(debugService.onDidStartDebugSession).thenReturn(() => disposable);
 
         await activator.activate();
 
-        assert.deepEqual(disposableRegistry, [disposable, disposable, disposable]);
+        assert.deepEqual(disposableRegistry, [disposable, disposable, disposable, disposable]);
     });
 });
diff --git a/extensions/positron-python/src/test/terminals/codeExecution/codeExecutionManager.unit.test.ts b/extensions/positron-python/src/test/terminals/codeExecution/codeExecutionManager.unit.test.ts
@@ -10,6 +10,7 @@ import { IFileSystem } from '../../../client/common/platform/types';
 import { IServiceContainer } from '../../../client/ioc/types';
 import { CodeExecutionManager } from '../../../client/terminals/codeExecution/codeExecutionManager';
 import { ICodeExecutionHelper, ICodeExecutionManager, ICodeExecutionService } from '../../../client/terminals/types';
+import { IConfigurationService } from '../../../client/common/types';
 
 suite('Terminal - Code Execution Manager', () => {
     let executionManager: ICodeExecutionManager;
@@ -18,6 +19,7 @@ suite('Terminal - Code Execution Manager', () => {
     let disposables: Disposable[] = [];
     let serviceContainer: TypeMoq.IMock<IServiceContainer>;
     let documentManager: TypeMoq.IMock<IDocumentManager>;
+    let configService: TypeMoq.IMock<IConfigurationService>;
     let fileSystem: TypeMoq.IMock<IFileSystem>;
     setup(() => {
         fileSystem = TypeMoq.Mock.ofType<IFileSystem>();
@@ -33,11 +35,13 @@ suite('Terminal - Code Execution Manager', () => {
         documentManager = TypeMoq.Mock.ofType<IDocumentManager>();
         commandManager = TypeMoq.Mock.ofType<ICommandManager>(undefined, TypeMoq.MockBehavior.Strict);
         serviceContainer = TypeMoq.Mock.ofType<IServiceContainer>();
+        configService = TypeMoq.Mock.ofType<IConfigurationService>();
         executionManager = new CodeExecutionManager(
             commandManager.object,
             documentManager.object,
             disposables,
             fileSystem.object,
+            configService.object,
             serviceContainer.object,
         );
     });

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Make cursor focus switch automatically to the terminal after launching a python process with configuration option. (Thanks [djplt](https://github.com/djplt))`