chore: refactor ensureTerminal to return a Terminal

Author: karthiknadig

src/client/common/terminal/service.ts

@@ -141,9 +141,9 @@ export class TerminalService implements ITerminalService, Disposable {
         }
     }
     // TODO: Debt switch to Promise<Terminal> ---> breaks 20 tests
-    public async ensureTerminal(preserveFocus: boolean = true): Promise<void> {
+    public async ensureTerminal(preserveFocus: boolean = true): Promise<Terminal> {
         if (this.terminal) {
-            return;
+            return this.terminal;
         }
 
         if (useEnvExtension()) {
@@ -174,7 +174,7 @@ export class TerminalService implements ITerminalService, Disposable {
         }
 
         this.sendTelemetry().ignoreErrors();
-        return;
+        return this.terminal;
     }
     private terminalCloseHandler(terminal: Terminal) {
         if (terminal === this.terminal) {

src/client/common/terminal/types.ts

@@ -56,6 +56,14 @@ export interface ITerminalService extends IDisposable {
     sendText(text: string): Promise<void>;
     executeCommand(commandLine: string, isPythonShell: boolean): Promise<TerminalShellExecution | undefined>;
     show(preserveFocus?: boolean): Promise<void>;
+    /**
+     * Ensures that a terminal exists, creating one if necessary.
+     *
+     * @param {boolean} [preserveFocus] Whether the editor should keep focus after the terminal is shown. Defaults to `true`.
+     * @returns {Promise<Terminal>} The terminal instance.
+     * @memberof ITerminalService
+     */
+    ensureTerminal(preserveFocus?: boolean): Promise<Terminal>;
 }
 
 export const ITerminalServiceFactory = Symbol('ITerminalServiceFactory');