Add preference clear output channel #4318

dehru · 2022-07-25T19:01:35Z

What does this PR do?

This PR adds a user/workspace preference and changes the preference category they display under in the preferences UI. When set, the output channel is cleared between each common command. There are a few commands that do not output to the channel ( Like Create Soql Query ) and those do not clear the channel.

What issues does this PR fix or reference?

#941, @W-10288504@

Functionality Before

Old and New Preference Shown Below

Functionality After

Screen.Recording.2022-07-25.at.4.30.25.PM.mov

dehru · 2022-07-25T22:47:04Z

packages/salesforcedx-utils-vscode/src/commands/channelService.ts

@@ -37,6 +38,9 @@ export class ChannelService {
  }

  public streamCommandStartStop(execution: CommandExecution) {
+    if (SfdxSettingsService.getEnableClearOutputBeforeEachCommand()) {


The channel service is my first choice to attempt to handle this preference in one central location. Unfortunately, the way the channel service is used throughout the app is very inconsistent. This "streamCommandStartStop()" is used by some of the abstract executors ( SfdxCommandletExecutor, LibraryExectutor ) that are exported from salesforcedx-utils-vscode.

dehru · 2022-07-25T22:49:23Z

packages/salesforcedx-utils-vscode/src/commands/commandletExecutors.ts

@@ -161,6 +162,9 @@ export abstract class LibraryCommandletExecutor<T>
    const startTime = process.hrtime();
    const channelService = new ChannelService(this.outputChannel);
    const telemetryService = TelemetryService.getInstance();
+    if (SfdxSettingsService.getEnableClearOutputBeforeEachCommand()) {


The LibraryCommandletExecutor is exported from salesforcedx-utils-vscode and is another place that I found to check and clear the output log.

dehru · 2022-07-25T22:50:22Z

packages/salesforcedx-utils-vscode/src/constants.ts

@@ -0,0 +1,3 @@
+export const SETTING_CLEAR_OUTPUT_TAB = 'clearOutputTab';


These are now all exported by salesforcedx-utils-vscode and consumed in other modules so that the string 'salesforcedx-vscode-core' is not in 20 places in various modules of the mono-repo.

dehru · 2022-07-25T22:54:31Z

packages/salesforcedx-vscode-core/src/commands/util/sfdxCommandlet.ts

@@ -165,6 +166,9 @@ export class SfdxCommandlet<T> {
  }

  public async run(): Promise<void> {
+    if (sfdxCoreSettings.getEnableClearOutputBeforeEachCommand()) {


Adding this to the run() method here basically adds this feature to all the commands that extend SfdxCommandlet in the salesforcedx-vscode-core extension. I wish there was an elegant single cut-point elsewhere in the salesforcedx-utils-vscode module like this, but there was not.

…ithub.com/forcedotcom/salesforcedx-vscode into dehru/add-preference-clear-output-channel

randi274

Looking great, and look at those lovely unit tests! 😍 Just a few quick qs. Good for me otherwise pending QA

packages/salesforcedx-utils-vscode/src/commands/channelService.ts

randi274 · 2022-07-26T16:30:47Z

packages/salesforcedx-utils-vscode/src/constants.ts

@@ -0,0 +1,3 @@
+export const SETTING_CLEAR_OUTPUT_TAB = 'clearOutputTab';
+export const SFDX_CORE_CONFIGURATION_NAME = 'salesforcedx-vscode-core';


What's your thought here having these two identical strings with different names?

I decided that since they represent 2 different things, that we should have 2 constants, even though they are the same string.

I wanted anyone changing these in the future to be more aware of what this constant represents.

jeffb-sfdc · 2022-07-26T19:32:45Z

packages/salesforcedx-utils-vscode/src/commands/sfdxCommandlet.ts

@@ -5,6 +5,7 @@
 * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
 */
 import * as vscode from 'vscode';
+import { SfdxSettingsService } from '../settings';


I don't think this needs to be imported

jeffb-sfdc · 2022-07-26T20:08:50Z

packages/salesforcedx-utils-vscode/src/commands/notificationService.ts

@@ -112,7 +113,7 @@ export class NotificationService {
      executionName
    );
    const showCLISuccessMsg = vscode.workspace
-      .getConfiguration('salesforcedx-vscode-core')
+      .getConfiguration(SFDX_CORE_CONFIGURATION_NAME)


Since

vscode.workspace .getConfiguration(SFDX_CORE_CONFIGURATION_NAME)

is called twice, how about changing to:

const coreConfigurationName = vscode.workspace.getConfiguration(SFDX_CORE_CONFIGURATION_NAME); const showCLISuccessMsg = coreConfigurationName.get<boolean>('show-cli-success-msg', true);

..and then using coreConfigurationName on line 132 & 133.

jeffb-sfdc · 2022-07-26T20:11:49Z

packages/salesforcedx-utils-vscode/src/index.ts

@@ -41,3 +41,4 @@ export {
  getRootWorkspacePath,
  getRootWorkspaceSfdxPath
 } from './workspaces';
+export { SETTING_CLEAR_OUTPUT_TAB, SFDX_CORE_CONFIGURATION_NAME, SFDX_CORE_EXTENSION_NAME } from './constants';


the imports need to be alphabetized. I'm surprised the linter didn't catch this.

Since this is being imported from ./constants, it should be moved to line 25, before the import from ./context/...

jeffb-sfdc · 2022-07-26T20:14:33Z

...alesforcedx-vscode-apex-replay-debugger/test/vscode-integration/commands/quickLaunch.test.ts

@@ -12,6 +12,7 @@ import { MockTestOrgData, testSetup } from '@salesforce/core/lib/testSetup';
 import { notificationService } from '@salesforce/salesforcedx-utils-vscode/out/src/commands';
 import { TraceFlags } from '@salesforce/salesforcedx-utils-vscode/out/src/helpers';
 import * as utils from '@salesforce/salesforcedx-utils-vscode/out/src/index';
+import { SFDX_CORE_CONFIGURATION_NAME } from '@salesforce/salesforcedx-utils-vscode/out/src/index';


since @salesforce/salesforcedx-utils-vscode/out/src/index is already being imported, can line 15 be removed and on line 54, use utils.SFDX_CORE_CONFIGURATION_NAME?

jeffb-sfdc · 2022-07-26T20:17:42Z

packages/salesforcedx-vscode-core/src/settings/sfdxCoreSettings.ts

@@ -75,6 +74,9 @@ export class SfdxCoreSettings {
    return this.getConfigValue(CONFLICT_DETECTION_ENABLED, false);
  }

+  public getEnableClearOutputBeforeEachCommand(): boolean {
+    return this.getConfigValue(SETTING_CLEAR_OUTPUT_TAB, false);
+  }


nit pick: please add an extra carriage return after the closing curly brace.

randi274 · 2022-08-01T22:37:24Z

QA Notes:
✅ Salesforce Feature Previews renamed to Salesforce Core Configuration
✅ New setting "Clear Output Tab" added to top of Core Config
✅ When setting is enabled for the user, commands are cleared between each output
✅ When setting is disabled for the user, commands remain logged
✅ When setting is enabled for the workspace, commands are cleared between each output
✅ When setting is disabled for the workspace, commands remain logged
✅ Commands that don't output to the channel, like Create SOQL Query, do not clear the channel

Notes:

Like all settings, if the VS Code Setting for Workspace is modified but then set to false, the setting will be overridden as false even if it is set to true for the user. It's best to limit to one setting file or the other.
It's also very sensitive, and will clear the output at the start of any command (like Create Apex Class)

Dehru Cromer and others added 7 commits July 22, 2022 10:05

feat: add setting and language translations

17ccdb1

feat: add settings service and constants to utils package

57e0cd7

feat: use constants where appropriate

a7c735f

chore: fix import

ad8a81e

feat: add final changes and tests

a5462c2

chore: remove unused code

5c03345

Merge branch 'develop' into dehru/add-preference-clear-output-channel

f8ef55d

dehru marked this pull request as ready for review July 25, 2022 22:32

dehru requested a review from a team as a code owner July 25, 2022 22:32

dehru requested a review from klewis-sfdc July 25, 2022 22:32

dehru changed the title ~~[DRAFT] add preference clear output channel~~ Add preference clear output channel Jul 25, 2022

dehru commented Jul 25, 2022

View reviewed changes

Dehru Cromer added 3 commits July 26, 2022 10:01

chore: fix lint

91d3250

Merge branch 'dehru/add-preference-clear-output-channel' of https://g…

9609855

…ithub.com/forcedotcom/salesforcedx-vscode into dehru/add-preference-clear-output-channel

chore: fix lint

f45f5f4

randi274 approved these changes Jul 26, 2022

View reviewed changes

chore: remove japanese translation key

1e188d5

jeffb-sfdc reviewed Jul 26, 2022

View reviewed changes

chore: fix test variable name

b7bbdef

jeffb-sfdc reviewed Jul 26, 2022

View reviewed changes

dehru and others added 3 commits July 26, 2022 16:30

Merge branch 'develop' into dehru/add-preference-clear-output-channel

290668f

Merge branch 'develop' into dehru/add-preference-clear-output-channel

11b591b

chore: review cleanup

f1f2d7d

jeffb-sfdc approved these changes Aug 1, 2022

View reviewed changes

randi274 added 2 commits August 1, 2022 17:26

chore: whitespace cleanup

72fff9f

chore: one more

1b57559

randi274 merged commit 5dd7843 into develop Aug 1, 2022

randi274 deleted the dehru/add-preference-clear-output-channel branch August 1, 2022 22:52

randi274 mentioned this pull request Aug 2, 2022

draft: fix: stop showing output tab in unnecessary circumstances #4337

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add preference clear output channel #4318

Add preference clear output channel #4318

dehru commented Jul 25, 2022 •

edited by randi274

dehru Jul 25, 2022

dehru Jul 25, 2022

dehru Jul 25, 2022 •

edited

dehru Jul 25, 2022

randi274 left a comment

randi274 Jul 26, 2022

dehru Jul 26, 2022

jeffb-sfdc Jul 26, 2022

jeffb-sfdc Jul 26, 2022

jeffb-sfdc Jul 26, 2022 •

edited

jeffb-sfdc Jul 26, 2022

jeffb-sfdc Jul 26, 2022 •

edited

randi274 commented Aug 1, 2022

		@@ -0,0 +1,3 @@
		export const SETTING_CLEAR_OUTPUT_TAB = 'clearOutputTab';

		@@ -0,0 +1,3 @@
		export const SETTING_CLEAR_OUTPUT_TAB = 'clearOutputTab';
		export const SFDX_CORE_CONFIGURATION_NAME = 'salesforcedx-vscode-core';

Add preference clear output channel #4318

Add preference clear output channel #4318

Conversation

dehru commented Jul 25, 2022 • edited by randi274

What does this PR do?

What issues does this PR fix or reference?

Functionality Before

Functionality After

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dehru Jul 25, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

randi274 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jeffb-sfdc Jul 26, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jeffb-sfdc Jul 26, 2022 • edited

Choose a reason for hiding this comment

randi274 commented Aug 1, 2022

dehru commented Jul 25, 2022 •

edited by randi274

dehru Jul 25, 2022 •

edited

jeffb-sfdc Jul 26, 2022 •

edited

jeffb-sfdc Jul 26, 2022 •

edited