Add flag for verbosity to disable messages by default

Some of these messages dont need to be shown.

Author: nagilson

vscode-dotnet-runtime-extension/src/extension.ts

@@ -98,6 +98,7 @@ namespace configKeys
     export const cacheTimeToLiveMultiplier = 'cacheTimeToLiveMultiplier';
     export const showResetDataCommand = 'showResetDataCommand';
     export const suppressOutput = 'suppressOutput';
+    export const highVerbosity = 'highVerbosity';
 }
 
 namespace commandKeys
@@ -155,6 +156,7 @@ export function activate(vsCodeContext: vscode.ExtensionContext, extensionContex
 
     const allowInvalidPathSetting = extensionConfiguration.get<boolean>(configKeys.allowInvalidPaths);
     const suppressOutput = extensionConfiguration.get<boolean>(configKeys.suppressOutput) ?? false;
+    const highVerbosity = extensionConfiguration.get<boolean>(configKeys.highVerbosity) ?? false;
     const isExtensionTelemetryEnabled = enableExtensionTelemetry(extensionConfiguration, configKeys.enableTelemetry);
     const displayWorker = extensionContext ? extensionContext.displayWorker : new WindowDisplayWorker();
 
@@ -175,7 +177,7 @@ export function activate(vsCodeContext: vscode.ExtensionContext, extensionContex
         packageJson
     } as IEventStreamContext;
     const [globalEventStream, outputChannel, loggingObserver,
-        eventStreamObservers, telemetryObserver, _] = registerEventStream(eventStreamContext, vsCodeExtensionContext, utilContext, suppressOutput);
+        eventStreamObservers, telemetryObserver, _] = registerEventStream(eventStreamContext, vsCodeExtensionContext, utilContext, suppressOutput, highVerbosity);
 
 
     // Setting up command-shared classes for Runtime & SDK Acquisition

vscode-dotnet-runtime-library/src/EventStream/EventStreamEvents.ts

@@ -331,16 +331,19 @@ abstract class DotnetAcquisitionFinalErrorBase extends DotnetAcquisitionError
 export class DotnetGlobalSDKAcquisitionError extends DotnetAcquisitionFinalErrorBase
 {
     public eventName = 'DotnetGlobalSDKAcquisitionError';
+    public verboseOutputOnly = true;
 }
 
 export class DotnetRuntimeFinalAcquisitionError extends DotnetAcquisitionFinalErrorBase
 {
     public eventName = 'DotnetRuntimeFinalAcquisitionError';
+    public verboseOutputOnly = true;
 }
 
 export class DotnetASPNetRuntimeFinalAcquisitionError extends DotnetAcquisitionFinalErrorBase
 {
     public eventName = 'DotnetASPNetRuntimeFinalAcquisitionError';
+    public verboseOutputOnly = true;
 }
 
 export abstract class DotnetNonAcquisitionError extends IEvent
@@ -828,6 +831,7 @@ export class DotnetInstallScriptAcquisitionCompleted extends DotnetAcquisitionSu
 export class DotnetExistingPathResolutionCompleted extends DotnetAcquisitionSuccessEvent
 {
     public readonly eventName = 'DotnetExistingPathResolutionCompleted';
+    public verboseOutputOnly = true;
 
     constructor(public readonly resolvedPath: string) { super(); }
 
@@ -1673,9 +1677,17 @@ export class DotnetAcquisitionPartialInstallation extends DotnetAcquisitionMessa
 export class DotnetAcquisitionInProgress extends IEvent
 {
     public readonly type = EventType.DotnetAcquisitionInProgress;
+    public verboseOutputOnly = true;
 
     public readonly eventName = 'DotnetAcquisitionInProgress';
-    constructor(public readonly install: DotnetInstall, public readonly requestingExtensionId: string | null) { super(); }
+    constructor(public readonly install: DotnetInstall, public readonly requestingExtensionId: string | null)
+    {
+        super();
+        if (requestingExtensionId === 'user')
+        {
+            this.verboseOutputOnly = false;
+        }
+    }
 
     public getProperties()
     {
@@ -1691,8 +1703,15 @@ export class DotnetAcquisitionAlreadyInstalled extends IEvent
 {
     public readonly eventName = 'DotnetAcquisitionAlreadyInstalled';
     public readonly type = EventType.DotnetAcquisitionAlreadyInstalled;
-
-    constructor(public readonly install: DotnetInstall, public readonly requestingExtensionId: string | null) { super(); }
+    public verboseOutputOnly = true;
+    constructor(public readonly install: DotnetInstall, public readonly requestingExtensionId: string | null)
+    {
+        super();
+        if (requestingExtensionId === 'user')
+        {
+            this.verboseOutputOnly = false;
+        }
+    }
 
     public getProperties()
     {

vscode-dotnet-runtime-library/src/EventStream/EventStreamRegistration.ts

@@ -36,7 +36,7 @@ export interface IEventStreamContext
 }
 
 export function registerEventStream(context: IEventStreamContext, extensionContext: IVSCodeExtensionContext,
-    utilityContext: IUtilityContext, suppressOutput = false): [EventStream, vscode.OutputChannel, LoggingObserver, IEventStreamObserver[], TelemetryObserver | null, ModalEventRepublisher]
+    utilityContext: IUtilityContext, suppressOutput = false, highVerbosity = false): [EventStream, vscode.OutputChannel, LoggingObserver, IEventStreamObserver[], TelemetryObserver | null, ModalEventRepublisher]
 {
     const outputChannel = vscode.window.createOutputChannel(context.displayChannelName);
     if (!fs.existsSync(context.logPath))
@@ -49,7 +49,7 @@ export function registerEventStream(context: IEventStreamContext, extensionConte
     const eventStreamObservers: IEventStreamObserver[] =
         [
             new StatusBarObserver(vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Left, Number.MIN_VALUE), context.showLogCommand),
-            new OutputChannelObserver(outputChannel, suppressOutput),
+            new OutputChannelObserver(outputChannel, suppressOutput, highVerbosity),
             loggingObserver
         ];
 

vscode-dotnet-runtime-library/src/EventStream/OutputChannelObserver.ts

@@ -27,14 +27,15 @@ export class OutputChannelObserver implements IEventStreamObserver
     private readonly inProgressDownloads: string[] = [];
     private downloadProgressInterval: NodeJS.Timeout | undefined;
 
-    constructor(private readonly outputChannel: IOutputChannel, private readonly suppressOutput: boolean = false)
+    constructor(private readonly outputChannel: IOutputChannel, private readonly suppressOutput: boolean = false, private readonly highVerbosity: boolean = false)
     {
     }
 
 
     public post(event: IEvent): void
     {
-        if (this.suppressOutput)
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+        if (this.suppressOutput || ((event as any)?.verboseOutputOnly && this.highVerbosity))
         {
             return;
         }

vscode-dotnet-runtime-library/src/test/unit/OutputChannelObserver.test.ts

@@ -4,7 +4,7 @@
 *--------------------------------------------------------------------------------------------*/
 import * as chai from 'chai';
 import { DotnetInstall } from '../../Acquisition/DotnetInstall';
-import { DotnetAcquisitionCompleted, DotnetAcquisitionStarted, DotnetExistingPathResolutionCompleted, DotnetFileIntegrityFailureEvent } from '../../EventStream/EventStreamEvents';
+import { DotnetAcquisitionCompleted, DotnetAcquisitionStarted, DotnetASPNetRuntimeFinalAcquisitionError, DotnetExistingPathResolutionCompleted, DotnetFileIntegrityFailureEvent } from '../../EventStream/EventStreamEvents';
 import { OutputChannelObserver } from '../../EventStream/OutputChannelObserver';
 import { MockOutputChannel } from '../mocks/MockOutputChannel';
 
@@ -67,4 +67,20 @@ suite('OutputChannelObserver Unit Tests', function ()
         assert.isNotEmpty(mockOutputChannel.appendedLines, 'Output should be written with default behavior');
         assert.include(mockOutputChannel.appendedLines.join(''), 'Test warning message', 'The warning message should be in the output');
     }).timeout(defaultTimeoutTime);
+
+    test('It handles verbose-only events based on highVerbosity setting', async () =>
+    {
+        const mockOutputChannel1 = new MockOutputChannel();
+        const mockOutputChannel2 = new MockOutputChannel();
+        const observerVerbose = new OutputChannelObserver(mockOutputChannel1, false, true);
+        const observerNonVerbose = new OutputChannelObserver(mockOutputChannel2, false, false);
+
+        const verboseEvent = new DotnetASPNetRuntimeFinalAcquisitionError(new Error('Test error message'), '', { installId: '8.0~x64', isGlobal: false, architecture: 'x64', version: '8.0', installMode: 'runtime' } as DotnetInstall);
+
+        observerVerbose.post(verboseEvent);
+        observerNonVerbose.post(verboseEvent);
+
+        assert.include(mockOutputChannel1.appendedLines, 'Test error', 'Verbose-only events should display when highVerbosity is true');
+        assert.notInclude(mockOutputChannel2.appendedLines, 'Test error', 'Verbose-only events should not display when highVerbosity is false');
+    }).timeout(defaultTimeoutTime);
 });