Check for hideFromUser before activating current terminal (#12942) (#…

…12956) * Check for hideFromUser before activating current terminal * Add tests * Tweak logic
Karthik Nadig (karthiknadig) · Aug 5, 2020 · Jul 9, 2020 · Jul 9, 2020 · Jul 10, 2020 · Jul 11, 2020
commit 0ef5ed69d9b65e31efa1f6e276b78fb73429045a
diff --git a/news/2 Fixes/11122.md b/news/2 Fixes/11122.md
@@ -0,0 +1 @@
+Check for hideFromUser before activating current terminal.
diff --git a/src/client/providers/terminalProvider.ts b/src/client/providers/terminalProvider.ts
@@ -24,13 +24,15 @@ export class TerminalProvider implements Disposable {
         const configuration = this.serviceContainer.get<IConfigurationService>(IConfigurationService);
         const pythonSettings = configuration.getSettings(this.activeResourceService.getActiveResource());
 
-        if (pythonSettings.terminal.activateEnvInCurrentTerminal) {
-            if (currentTerminal) {
+        if (currentTerminal && pythonSettings.terminal.activateEnvInCurrentTerminal) {
+            const hideFromUser =
+                'hideFromUser' in currentTerminal.creationOptions && currentTerminal.creationOptions.hideFromUser;
+            if (!hideFromUser) {
                 const terminalActivator = this.serviceContainer.get<ITerminalActivator>(ITerminalActivator);
                 await terminalActivator.activateEnvironmentInTerminal(currentTerminal, { preserveFocus: true });
             }
             sendTelemetryEvent(EventName.ACTIVATE_ENV_IN_CURRENT_TERMINAL, undefined, {
-                isTerminalVisible: currentTerminal ? true : false
+                isTerminalVisible: !hideFromUser
             });
         }
     }

diff --git a/src/test/providers/terminal.unit.test.ts b/src/test/providers/terminal.unit.test.ts
@@ -122,6 +122,11 @@ suite('Terminal Provider', () => {
                 .returns(() => activeResourceService.object);
 
             terminal = TypeMoq.Mock.ofType<Terminal>();
+            terminal
+                .setup((c) => c.creationOptions)
+                .returns(() => {
+                    return { hideFromUser: false };
+                });
         });
 
         test('If terminal.activateCurrentTerminal setting is set, provided terminal should be activated', async () => {
@@ -168,6 +173,34 @@ suite('Terminal Provider', () => {
             configService.verifyAll();
         });
 
+        test('If terminal.activateCurrentTerminal setting is set, but hideFromUser is true, provided terminal should not be activated', async () => {
+            terminalSettings.setup((t) => t.activateEnvInCurrentTerminal).returns(() => true);
+            configService
+                .setup((c) => c.getSettings(resource))
+                .returns(() => pythonSettings.object)
+                .verifiable(TypeMoq.Times.once());
+            activeResourceService
+                .setup((a) => a.getActiveResource())
+                .returns(() => resource)
+                .verifiable(TypeMoq.Times.once());
+
+            terminal
+                .setup((c) => c.creationOptions)
+                .returns(() => {
+                    return { hideFromUser: true };
+                });
+
+            terminalProvider = new TerminalProvider(serviceContainer.object);
+            await terminalProvider.initialize(terminal.object);
+
+            terminalActivator.verify(
+                (a) => a.activateEnvironmentInTerminal(TypeMoq.It.isAny(), TypeMoq.It.isAny()),
+                TypeMoq.Times.never()
+            );
+            activeResourceService.verifyAll();
+            configService.verifyAll();
+        });
+
         test('terminal.activateCurrentTerminal setting is set but provided terminal is undefined', async () => {
             terminalSettings.setup((t) => t.activateEnvInCurrentTerminal).returns(() => true);
             configService
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Check for hideFromUser before activating current terminal.