fix: default show channel output to false

forcedotcom · Aug 4, 2022 · b2da3c8 · b2da3c8
1 parent ebfd416
commit b2da3c8
Show file tree

Hide file tree

Showing 18 changed files with 42 additions and 27 deletions.
diff --git a/packages/salesforcedx-utils-vscode/src/commands/channelService.ts b/packages/salesforcedx-utils-vscode/src/commands/channelService.ts
@@ -17,6 +17,7 @@ export class ChannelService {
 
   public constructor(channel: OutputChannel) {
     this.channel = channel;
+    this.channel.show(true);
   }
 
   public static getInstance(channelName: string) {

diff --git a/packages/salesforcedx-utils-vscode/src/commands/commandletExecutors.ts b/packages/salesforcedx-utils-vscode/src/commands/commandletExecutors.ts
@@ -124,23 +124,23 @@ export abstract class LibraryCommandletExecutor<T>
   private cancelled: boolean = false;
   private readonly executionName: string;
   private readonly logName: string;
-  private readonly outputChannel: vscode.OutputChannel;
-  protected showChannelOutput = true;
+  private readonly channelService: ChannelService;
+  protected showChannelOutput = false;
   protected readonly telemetry = new TelemetryBuilder();
 
   /**
    * @param executionName Name visible to user while executing.
    * @param logName Name for logging purposes such as telemetry.
-   * @param outputChannel VS Code output channel to report execution status to.
+   * @param channelService ChannelService to report
    */
   constructor(
     executionName: string,
     logName: string,
-    outputChannel: vscode.OutputChannel
+    channelService: ChannelService
   ) {
     this.executionName = executionName;
     this.logName = logName;
-    this.outputChannel = outputChannel;
+    this.channelService = channelService;
   }
 
   /**
@@ -160,13 +160,12 @@ export abstract class LibraryCommandletExecutor<T>
 
   public async execute(response: ContinueResponse<T>): Promise<void> {
     const startTime = process.hrtime();
-    const channelService = new ChannelService(this.outputChannel);
     const telemetryService = TelemetryService.getInstance();
     if (SfdxSettingsService.getEnableClearOutputBeforeEachCommand()) {
       channelService.clear();
     }
 
-    channelService.showCommandWithTimestamp(
+    this.channelService.showCommandWithTimestamp(
       `${nls.localize('channel_starting_message')}${this.executionName}\n`
     );
 
@@ -192,18 +191,18 @@ export abstract class LibraryCommandletExecutor<T>
           return this.run(response, progress, token);
         }
       );
-      channelService.showCommandWithTimestamp(
+      this.channelService.showCommandWithTimestamp(
         `${nls.localize('channel_end')} ${this.executionName}`
       );
 
       if (this.showChannelOutput) {
-        channelService.showChannelOutput();
+        this.channelService.showChannelOutput();
       }
 
       if (!this.cancelled) {
         if (success) {
           notificationService
-            .showSuccessfulExecution(this.executionName, channelService)
+            .showSuccessfulExecution(this.executionName, this.channelService)
             .catch(e => console.error(e));
         } else {
           notificationService.showFailedExecution(this.executionName);
@@ -221,8 +220,8 @@ export abstract class LibraryCommandletExecutor<T>
     } catch (e) {
       telemetryService.sendException(e.name, e.message);
       notificationService.showFailedExecution(this.executionName);
-      channelService.appendLine(e.message);
-      channelService.showChannelOutput();
+      this.channelService.appendLine(e.message);
+      this.channelService.showChannelOutput();
     }
   }
 

diff --git a/packages/salesforcedx-vscode-apex-replay-debugger/src/channels/index.ts b/packages/salesforcedx-vscode-apex-replay-debugger/src/channels/index.ts
@@ -5,10 +5,9 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 import { ChannelService } from '@salesforce/salesforcedx-utils-vscode/out/src/commands';
-import * as vscode from 'vscode';
 import { nls } from '../messages';
 
-export const OUTPUT_CHANNEL = vscode.window.createOutputChannel(
+export const OUTPUT_CHANNEL = ChannelService.getInstance(
   nls.localize('channel_name')
 );
-export const channelService = new ChannelService(OUTPUT_CHANNEL);
+export const channelService = OUTPUT_CHANNEL;
diff --git a/packages/salesforcedx-vscode-apex-replay-debugger/src/commands/quickLaunch.ts b/packages/salesforcedx-vscode-apex-replay-debugger/src/commands/quickLaunch.ts
@@ -148,6 +148,9 @@ export class QuickLaunch {
 }
 
 export class TestDebuggerExecutor extends LibraryCommandletExecutor<string[]> {
+
+  protected showChannelOutput = true;
+
   constructor() {
     super(
       nls.localize('debug_test_exec_name'),

diff --git a/packages/salesforcedx-vscode-apex/src/channels/index.ts b/packages/salesforcedx-vscode-apex/src/channels/index.ts
@@ -5,10 +5,9 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 import { ChannelService } from '@salesforce/salesforcedx-utils-vscode/out/src/commands';
-import * as vscode from 'vscode';
 import { nls } from '../messages';
 
-export const OUTPUT_CHANNEL = vscode.window.createOutputChannel(
+export const OUTPUT_CHANNEL = ChannelService.getInstance(
   nls.localize('channel_name')
 );
-export const channelService = new ChannelService(OUTPUT_CHANNEL);
+export const channelService = OUTPUT_CHANNEL;
diff --git a/packages/salesforcedx-vscode-apex/src/commands/forceApexTestSuite.ts b/packages/salesforcedx-vscode-apex/src/commands/forceApexTestSuite.ts
@@ -152,6 +152,7 @@ export class ApexLibraryTestSuiteBuilder extends LibraryCommandletExecutor<
   public static diagnostics = vscode.languages.createDiagnosticCollection(
     'apex-errors'
   );
+  protected showChannelOutput = true;
 
   constructor() {
     super(

diff --git a/packages/salesforcedx-vscode-core/src/channels/index.ts b/packages/salesforcedx-vscode-core/src/channels/index.ts
@@ -5,10 +5,9 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 import { ChannelService } from '@salesforce/salesforcedx-utils-vscode/out/src/commands';
-import * as vscode from 'vscode';
 import { nls } from '../messages';
 
-export const OUTPUT_CHANNEL = vscode.window.createOutputChannel(
+export const OUTPUT_CHANNEL = ChannelService.getInstance(
   nls.localize('channel_name')
 );
-export const channelService = new ChannelService(OUTPUT_CHANNEL);
+export const channelService = OUTPUT_CHANNEL;
diff --git a/packages/salesforcedx-vscode-core/src/commands/auth/forceAuthAccessTokenLogin.ts b/packages/salesforcedx-vscode-core/src/commands/auth/forceAuthAccessTokenLogin.ts
@@ -21,6 +21,9 @@ import {
 export class ForceAuthAccessTokenExecutor extends LibraryCommandletExecutor<
   AccessTokenParams
 > {
+
+  protected showChannelOutput = true;
+
   constructor() {
     super(
       nls.localize('force_auth_access_token_authorize_org_text'),

diff --git a/packages/salesforcedx-vscode-core/src/commands/auth/forceAuthDevHub.ts b/packages/salesforcedx-vscode-core/src/commands/auth/forceAuthDevHub.ts
@@ -54,7 +54,6 @@ export class ForceAuthDevHubContainerExecutor extends ForceAuthWebLoginContainer
 }
 
 export class ForceAuthDevHubExecutor extends SfdxCommandletExecutor<{}> {
-  protected showChannelOutput = false;
 
   public build(data: {}): Command {
     const command = new SfdxCommandBuilder().withDescription(

diff --git a/packages/salesforcedx-vscode-core/src/commands/auth/forceAuthLogout.ts b/packages/salesforcedx-vscode-core/src/commands/auth/forceAuthLogout.ts
@@ -31,7 +31,6 @@ import { ScratchOrgLogoutParamsGatherer } from './authParamsGatherer';
 export class ForceAuthLogoutAll extends SfdxCommandletExecutor<{}> {
   public static withoutShowingChannel(): ForceAuthLogoutAll {
     const instance = new ForceAuthLogoutAll();
-    instance.showChannelOutput = false;
     return instance;
   }
 
@@ -60,12 +59,16 @@ export async function forceAuthLogoutAll() {
 }
 
 export class AuthLogoutDefault extends LibraryCommandletExecutor<string> {
+
+  protected showChannelOutput = true;
+
   constructor() {
     super(
       nls.localize('force_auth_logout_default_text'),
       'force_auth_logout_default',
       OUTPUT_CHANNEL
     );
+
   }
 
   public async run(

diff --git a/packages/salesforcedx-vscode-core/src/commands/auth/forceAuthWebLogin.ts b/packages/salesforcedx-vscode-core/src/commands/auth/forceAuthWebLogin.ts
@@ -46,7 +46,6 @@ export interface DeviceCodeResponse {
 export class ForceAuthWebLoginContainerExecutor extends SfdxCommandletExecutor<
   AuthParams
 > {
-  protected showChannelOutput = false;
   protected deviceCodeReceived = false;
   protected stdOut = '';
 
@@ -147,7 +146,6 @@ export class ForceAuthWebLoginContainerExecutor extends SfdxCommandletExecutor<
 export class ForceAuthWebLoginExecutor extends SfdxCommandletExecutor<
   AuthParams
 > {
-  protected showChannelOutput = false;
 
   public build(data: AuthParams): Command {
     const command = new SfdxCommandBuilder().withDescription(

diff --git a/packages/salesforcedx-vscode-core/src/commands/forceConfigSet.ts b/packages/salesforcedx-vscode-core/src/commands/forceConfigSet.ts
@@ -18,7 +18,6 @@ import {
 
 export class ForceConfigSetExecutor extends SfdxCommandletExecutor<{}> {
   private usernameOrAlias: string;
-  protected showChannelOutput = false;
 
   public constructor(usernameOrAlias: string) {
     super();

diff --git a/packages/salesforcedx-vscode-core/src/commands/forceCreateManifest.ts b/packages/salesforcedx-vscode-core/src/commands/forceCreateManifest.ts
@@ -25,6 +25,8 @@ const MANIFEST_SAVE_PROMPT = 'manifest_input_save_prompt';
 export class ManifestCreateExecutor extends LibraryCommandletExecutor<string> {
   private sourcePaths: string[];
   private responseText: string | undefined;
+  protected showChannelOutput = true;
+
   constructor(sourcePaths: string[], responseText: string | undefined) {
     super(
       nls.localize(CREATE_MANIFEST_EXECUTOR),

diff --git a/packages/salesforcedx-vscode-core/src/commands/forceOrgOpen.ts b/packages/salesforcedx-vscode-core/src/commands/forceOrgOpen.ts
@@ -101,7 +101,7 @@ export class ForceOrgOpenContainerExecutor extends SfdxCommandletExecutor<{}> {
 }
 
 export class ForceOrgOpenExecutor extends SfdxCommandletExecutor<{}> {
-  protected showChannelOutput = false;
+
   public build(data: {}): Command {
     return new SfdxCommandBuilder()
       .withDescription(nls.localize('force_org_open_default_scratch_org_text'))

diff --git a/packages/salesforcedx-vscode-core/src/commands/forceRenameLightningComponent.ts b/packages/salesforcedx-vscode-core/src/commands/forceRenameLightningComponent.ts
@@ -30,6 +30,8 @@ const TEST_FOLDER = '__tests__';
 
 export class RenameLwcComponentExecutor extends LibraryCommandletExecutor<ComponentName> {
   private sourceFsPath: string;
+  protected showChannelOutput = true;
+
   constructor(sourceFsPath: string) {
     super(
       nls.localize(RENAME_LIGHTNING_COMPONENT_EXECUTOR),

diff --git a/packages/salesforcedx-vscode-core/src/commands/functions/forceFunctionInvoke.ts b/packages/salesforcedx-vscode-core/src/commands/functions/forceFunctionInvoke.ts
@@ -27,6 +27,9 @@ import { ContinueResponse } from '@salesforce/salesforcedx-utils-vscode/out/src/
 import * as fs from 'fs';
 
 export class ForceFunctionInvoke extends LibraryCommandletExecutor<string> {
+
+  protected showChannelOutput = true;
+
   constructor(debug: boolean = false) {
     super(
       nls.localize('force_function_invoke_text'),

diff --git a/...rcedx-vscode-core/src/commands/functions/forceFunctionStart/ForceFunctionStartExecutor.ts b/...rcedx-vscode-core/src/commands/functions/forceFunctionStart/ForceFunctionStartExecutor.ts
@@ -26,6 +26,8 @@ export abstract class ForceFunctionStartExecutor extends LibraryCommandletExecut
 > {
   protected UNEXPECTED_ERROR_KEY = 'force_function_start_unexpected_error';
 
+  protected showChannelOutput = true;
+
   constructor(startMessageKey: string, logName: string) {
     super(nls.localize(startMessageKey), logName, OUTPUT_CHANNEL);
     this.cancellable = true;

diff --git a/packages/salesforcedx-vscode-core/src/commands/templates/forceFunctionCreate.ts b/packages/salesforcedx-vscode-core/src/commands/templates/forceFunctionCreate.ts
@@ -41,6 +41,9 @@ const LOG_NAME = 'force_function_create';
 export class ForceFunctionCreateExecutor extends LibraryCommandletExecutor<
   any
 > {
+
+  protected showChannelOutput = true;
+
   constructor() {
     super(nls.localize('force_function_create_text'), LOG_NAME, OUTPUT_CHANNEL);
   }