Pre-Restart Experiments

JustinGrote · JustinGrote · commit 06b416f6db76 · 2024-11-01T16:53:16.000-07:00
diff --git a/src/logging.ts b/src/logging.ts
@@ -1,13 +1,12 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-import { LogOutputChannel, Uri, Disposable, LogLevel, window, commands, Event } from "vscode";
+import { LogOutputChannel, LogLevel, window, Event } from "vscode";
 
 /** Interface for logging operations. New features should use this interface for the "type" of logger.
  *  This will allow for easy mocking of the logger during unit tests.
  */
 export interface ILogger {
-    logDirectoryPath: Uri;
     write(message: string, ...additionalMessages: string[]): void;
     writeAndShowInformation(message: string, ...additionalMessages: string[]): Promise<void>;
     writeDiagnostic(message: string, ...additionalMessages: string[]): void;
@@ -22,39 +21,16 @@ export interface ILogger {
 }
 
 export class Logger implements ILogger {
-    public logDirectoryPath: Uri; // The folder for all the logs
-    private commands: Disposable[];
     // Log output channel handles all the verbosity management so we don't have to.
     private logChannel: LogOutputChannel;
     public get logLevel(): LogLevel { return this.logChannel.logLevel;}
 
-    constructor(logPath: Uri, logChannel?: LogOutputChannel) {
+    constructor(logChannel?: LogOutputChannel) {
         this.logChannel = logChannel ?? window.createOutputChannel("PowerShell", {log: true});
-        // We have to override the scheme because it defaults to
-        // 'vscode-userdata' which breaks UNC paths.
-        this.logDirectoryPath = logPath;
-
-        // Early logging of the log paths for debugging.
-        if (this.logLevel > LogLevel.Off) {
-            this.logChannel.trace(`Log directory: ${this.logDirectoryPath.fsPath}`);
-        }
-
-        this.commands = [
-            commands.registerCommand(
-                "PowerShell.ShowLogs",
-                () => { this.showLogPanel(); }),
-
-            commands.registerCommand(
-                "PowerShell.OpenLogFolder",
-                async () => { await this.openLogFolder(); }),
-        ];
     }
 
     public dispose(): void {
         this.logChannel.dispose();
-        for (const command of this.commands) {
-            command.dispose();
-        }
     }
 
     private writeAtLevel(logLevel: LogLevel, message: string, ...additionalMessages: string[]): void {
@@ -137,14 +113,10 @@ export class Logger implements ILogger {
         }
     }
 
-    private showLogPanel(): void {
+    public showLogPanel(): void {
         this.logChannel.show();
     }
 
-    private async openLogFolder(): Promise<void> {
-        await commands.executeCommand("openFolder", this.logDirectoryPath, true);
-    }
-
     private async writeLine(message: string, level: LogLevel = LogLevel.Info): Promise<void> {
         return new Promise<void>((resolve) => {
             switch (level) {
@@ -163,12 +135,13 @@ export class Logger implements ILogger {
 
 /** Parses logs received via the legacy OutputChannel to LogOutputChannel with proper severity.
  *
- * HACK: This is for legacy compatability and can be removed when https://github.com/microsoft/vscode-languageserver-node/issues/1116 is merged and replaced with a normal LogOutputChannel. We don't use a middleware here because any direct logging calls like client.warn() would not be captured by middleware.
+ * HACK: This is for legacy compatability and can be removed when https://github.com/microsoft/vscode-languageserver-node/issues/1116 is merged and replaced with a normal LogOutputChannel. We don't use a middleware here because any direct logging calls like client.warn() and server-initiated messages would not be captured by middleware.
  */
 export class LanguageClientOutputChannelAdapter implements LogOutputChannel {
     private channel: LogOutputChannel;
-    constructor(channel: LogOutputChannel) {
-        this.channel = channel;
+
+    constructor(public channelName: string) {
+        this.channel = window.createOutputChannel(channelName, {log: true});
     }
 
     public appendLine(message: string): void {
@@ -229,7 +202,7 @@ export class LanguageClientOutputChannelAdapter implements LogOutputChannel {
             this.channel.error(message);
             break;
         default:
-            this.channel.trace(message);
+            this.channel.error("!UNKNOWN LOG LEVEL!: " + message);
             break;
         }
     }
@@ -284,7 +257,6 @@ export class LanguageClientOutputChannelAdapter implements LogOutputChannel {
 
 /** Overrides the severity of some LSP traces to be more logical */
 export class LanguageClientTraceFormatter extends LanguageClientOutputChannelAdapter {
-
     public override appendLine(message: string): void {
         this.append(message);
     }
@@ -293,7 +265,6 @@ export class LanguageClientTraceFormatter extends LanguageClientOutputChannelAda
         // eslint-disable-next-line prefer-const
         let [parsedMessage, level] = this.parse(message);
 
-        // Override some LSP traces to be more logical
         if (parsedMessage.startsWith("Sending ")) {
             parsedMessage = parsedMessage.replace("Sending", "▶️");
             level = LogLevel.Debug;
diff --git a/src/process.ts b/src/process.ts
@@ -30,6 +30,7 @@ export class PowerShellProcess {
         private isTemp: boolean,
         private shellIntegrationEnabled: boolean,
         private logger: ILogger,
+        private logDirectoryPath: vscode.Uri,
         private startPsesArgs: string,
         private sessionFilePath: vscode.Uri,
         private sessionSettings: Settings) {
@@ -51,7 +52,7 @@ export class PowerShellProcess {
                 : "";
 
         this.startPsesArgs +=
-            `-LogPath '${utils.escapeSingleQuotes(this.logger.logDirectoryPath.fsPath)}' ` +
+            `-LogPath '${utils.escapeSingleQuotes(this.logDirectoryPath.fsPath)}' ` +
             `-SessionDetailsPath '${utils.escapeSingleQuotes(this.sessionFilePath.fsPath)}' ` +
             `-FeatureFlags @(${featureFlags}) `;
 
diff --git a/src/session.ts b/src/session.ts
@@ -5,16 +5,17 @@ import net = require("net");
 import path = require("path");
 import vscode = require("vscode");
 import TelemetryReporter, { TelemetryEventProperties, TelemetryEventMeasurements } from "@vscode/extension-telemetry";
-import { Message } from "vscode-jsonrpc";
-import { ILogger, LanguageClientOutputChannelAdapter, LanguageClientTraceFormatter } from "./logging";
+import { Message, Trace } from "vscode-jsonrpc";
+import { ILogger } from "./logging";
 import { PowerShellProcess } from "./process";
 import { Settings, changeSetting, getSettings, getEffectiveConfigurationTarget, validateCwdSetting } from "./settings";
 import utils = require("./utils");
 
 import {
     CloseAction, CloseHandlerResult, DocumentSelector, ErrorAction, ErrorHandlerResult,
     LanguageClientOptions, Middleware, NotificationType,
-    RequestType0, ResolveCodeLensSignature
+    RequestType0, ResolveCodeLensSignature,
+    RevealOutputChannelOn,
 } from "vscode-languageclient";
 import { LanguageClient, StreamInfo } from "vscode-languageclient/node";
 
@@ -93,28 +94,7 @@ export class SessionManager implements Middleware {
     private startCancellationTokenSource: vscode.CancellationTokenSource | undefined;
     private suppressRestartPrompt = false;
     private versionDetails: IPowerShellVersionDetails | undefined;
-
-    private _outputChannel?: vscode.LogOutputChannel;
-    /** Omnisharp and PSES messages sent via LSP are surfaced here. */
-    private get outputChannel(): vscode.LogOutputChannel | undefined {
-        return vscode.workspace.getConfiguration("powershell.developer").get<boolean>("traceLsp", false)
-            ? this._outputChannel
-                ??= new LanguageClientOutputChannelAdapter(
-                    vscode.window.createOutputChannel("PowerShell: Editor Services", { log: true })
-                )
-            : undefined;
-    }
-
-    private _traceOutputChannel?: vscode.LogOutputChannel;
-    /** The LanguageClient LSP message trace is surfaced here. */
-    private get traceOutputChannel(): vscode.LogOutputChannel | undefined {
-        return vscode.workspace.getConfiguration("powershell.developer").get<boolean>("traceLsp", false)
-            ? this._traceOutputChannel
-            ??= new LanguageClientTraceFormatter(
-                    vscode.window.createOutputChannel("PowerShell: Trace LSP", { log: true })
-                )
-            : undefined;
-    }
+    private traceLogLevelHandler?: vscode.Disposable;
 
     constructor(
         private extensionContext: vscode.ExtensionContext,
@@ -126,7 +106,6 @@ export class SessionManager implements Middleware {
         hostVersion: string,
         publisher: string,
         private telemetryReporter: TelemetryReporter) {
-
         // Create the language status item
         this.languageStatusItem = this.createStatusBarItem();
         // We have to override the scheme because it defaults to
@@ -299,6 +278,8 @@ export class SessionManager implements Middleware {
         this.startCancellationTokenSource?.dispose();
         this.startCancellationTokenSource = undefined;
         this.sessionDetails = undefined;
+        this.traceLogLevelHandler?.dispose();
+        this.traceLogLevelHandler = undefined;
 
         this.setSessionStatus("Not Started", SessionStatus.NotStarted);
     }
@@ -375,6 +356,7 @@ export class SessionManager implements Middleware {
                 true,
                 false,
                 this.logger,
+                this.extensionContext.logUri,
                 this.getEditorServicesArgs(bundledModulesPath, this.PowerShellExeDetails) + "-DebugServiceOnly ",
                 this.getNewSessionFilePath(),
                 this.sessionSettings);
@@ -585,6 +567,7 @@ export class SessionManager implements Middleware {
                 false,
                 this.shellIntegrationEnabled,
                 this.logger,
+                this.extensionContext.logUri,
                 this.getEditorServicesArgs(bundledModulesPath, powerShellExeDetails),
                 this.getNewSessionFilePath(),
                 this.sessionSettings);
@@ -669,6 +652,7 @@ export class SessionManager implements Middleware {
                         });
                 });
         };
+
         const clientOptions: LanguageClientOptions = {
             documentSelector: this.documentSelector,
             synchronize: {
@@ -705,8 +689,9 @@ export class SessionManager implements Middleware {
                 },
             },
             middleware: this,
-            traceOutputChannel: this.traceOutputChannel,
-            outputChannel: this.outputChannel
+            // traceOutputChannel: traceOutputChannel,
+            // outputChannel: outputChannel,
+            revealOutputChannelOn: RevealOutputChannelOn.Never
         };
 
         const languageClient = new LanguageClient("powershell", "PowerShell Editor Services Client", connectFunc, clientOptions);
@@ -759,6 +744,19 @@ export class SessionManager implements Middleware {
         return languageClient;
     }
 
+    /** Synchronizes a vscode LogOutputChannel log level to the LSP trace setting to minimize traffic */
+    private async setLspTrace(languageClient: LanguageClient, level: vscode.LogLevel): Promise<void> {
+        this.logger.writeVerbose("LSP Trace level changed to: " + level.toString());
+        if (level == vscode.LogLevel.Trace) {
+            return languageClient.setTrace(Trace.Verbose);
+        } else if (level == vscode.LogLevel.Debug) {
+            return languageClient.setTrace(Trace.Messages);
+        } else {
+            return languageClient.setTrace(Trace.Off);
+        }
+    }
+
+
     private async getBundledModulesPath(): Promise<string> {
         // Because the extension is always at `<root>/out/main.js`
         let bundledModulesPath = path.resolve(__dirname, "../modules");
