Don't open output panel after each save when rebuilding on save (#9781)

Kartik Raj · kimadeline · web-flow · commit 4cf1e5cb14a4 · 2020-01-27T11:22:31.000-08:00
* Added tests

* News entry

* Update news/2 Fixes/9603.md

Co-Authored-By: Kim-Adeline Miguel &lt;51720070+kimadeline@users.noreply.github.com&gt;

* Swap back two methods in the constructor

Co-authored-by: Kim-Adeline Miguel &lt;51720070+kimadeline@users.noreply.github.com&gt;
diff --git a/news/2 Fixes/9603.md b/news/2 Fixes/9603.md
@@ -0,0 +1 @@
+Don't open output panel after each save when rebuilding on save.
diff --git a/src/client/workspaceSymbols/main.ts b/src/client/workspaceSymbols/main.ts
@@ -72,7 +72,7 @@ export class WorkspaceSymbols implements Disposable {
     private registerCommands() {
         this.disposables.push(
             this.commandMgr.registerCommand(Commands.Build_Workspace_Symbols, async (rebuild: boolean = true, token?: CancellationToken) => {
-                const promises = this.buildWorkspaceSymbols(rebuild, token);
+                const promises = this.buildWorkspaceSymbols(rebuild, token, true);
                 return Promise.all(promises);
             })
         );
@@ -88,7 +88,7 @@ export class WorkspaceSymbols implements Disposable {
     }
 
     // tslint:disable-next-line:no-any
-    private buildWorkspaceSymbols(rebuild: boolean = true, token?: CancellationToken): Promise<any>[] {
+    private buildWorkspaceSymbols(rebuild: boolean = true, token?: CancellationToken, show = false): Promise<any>[] {
         if (token && token.isCancellationRequested) {
             return [];
         }
@@ -114,7 +114,9 @@ export class WorkspaceSymbols implements Disposable {
                     return;
                 } catch (error) {
                     if (!isNotInstalledError(error)) {
-                        this.outputChannel.show();
+                        if (show) {
+                            this.outputChannel.show();
+                        }
                         return;
                     }
                 }
diff --git a/src/test/workspaceSymbols/main.unit.test.ts b/src/test/workspaceSymbols/main.unit.test.ts
@@ -4,17 +4,17 @@
 'use strict';
 
 import * as assert from 'assert';
-import { use } from 'chai';
+import { expect, use } from 'chai';
 import * as chaiAsPromised from 'chai-as-promised';
-import { anyString, anything, instance, mock, when } from 'ts-mockito';
+import { anyString, anything, instance, mock, reset, verify, when } from 'ts-mockito';
 import { EventEmitter, TextDocument, Uri, WorkspaceFolder } from 'vscode';
 import { ApplicationShell } from '../../client/common/application/applicationShell';
 import { CommandManager } from '../../client/common/application/commandManager';
 import { DocumentManager } from '../../client/common/application/documentManager';
 import { IApplicationShell, ICommandManager, IDocumentManager, IWorkspaceService } from '../../client/common/application/types';
 import { WorkspaceService } from '../../client/common/application/workspace';
 import { ConfigurationService } from '../../client/common/configuration/service';
-import { STANDARD_OUTPUT_CHANNEL } from '../../client/common/constants';
+import { Commands, STANDARD_OUTPUT_CHANNEL } from '../../client/common/constants';
 import { FileSystem } from '../../client/common/platform/fileSystem';
 import { IFileSystem } from '../../client/common/platform/types';
 import { ProcessService } from '../../client/common/process/proc';
@@ -160,6 +160,56 @@ suite('Workspace symbols main', () => {
         assert.equal(shellOutput, 'Generating Tags');
     });
 
+    test('Should not show output channel when rebuilding on save', async () => {
+        when(workspaceService.workspaceFolders).thenReturn(workspaceFolders);
+        when(workspaceService.getWorkspaceFolder(anything())).thenReturn(workspaceFolders[0]);
+        when(configurationService.getSettings(anything())).thenReturn({
+            workspaceSymbols: {
+                ctagsPath,
+                enabled: true,
+                exclusionPatterns: [],
+                rebuildOnFileSave: true,
+                tagFilePath: 'foo'
+            }
+        } as any);
+        reset(applicationShell);
+        when(applicationShell.setStatusBarMessage(anyString(), anything())).thenThrow(new Error('Generating workspace tags failed with Error'));
+
+        workspaceSymbols = new WorkspaceSymbols(instance(serviceContainer));
+        eventEmitter.fire({ uri: Uri.file('folder') } as any);
+        await sleep(1);
+
+        verify(outputChannel.show()).never();
+    });
+
+    test('Output channel is shown when using Command `Build Workspace symbols`', async () => {
+        let buildWorkspaceSymbolsHandler!: Function;
+        when(workspaceService.workspaceFolders).thenReturn(workspaceFolders);
+        when(workspaceService.getWorkspaceFolder(anything())).thenReturn(workspaceFolders[0]);
+        when(configurationService.getSettings(anything())).thenReturn({
+            workspaceSymbols: {
+                ctagsPath,
+                enabled: true,
+                exclusionPatterns: [],
+                rebuildOnFileSave: true,
+                tagFilePath: 'foo'
+            }
+        } as any);
+        reset(commandManager);
+        when(commandManager.registerCommand(anything(), anything())).thenCall((commandID, cb) => {
+            expect(commandID).to.equal(Commands.Build_Workspace_Symbols);
+            buildWorkspaceSymbolsHandler = cb;
+            return mockDisposable;
+        });
+        reset(applicationShell);
+        when(applicationShell.setStatusBarMessage(anyString(), anything())).thenThrow(new Error('Generating workspace tags failed with Error'));
+
+        workspaceSymbols = new WorkspaceSymbols(instance(serviceContainer));
+        await buildWorkspaceSymbolsHandler();
+
+        verify(outputChannel.show()).once();
+    });
+
     test('Should not rebuild on save if the setting is disabled', () => {
         when(workspaceService.workspaceFolders).thenReturn(workspaceFolders);
         when(configurationService.getSettings(anything())).thenReturn({

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Don't open output panel after each save when rebuilding on save.`