Allow the Roslyn client to log messages from Razor

Author: davidwengier

src/activateOmniSharp.ts

@@ -13,6 +13,7 @@ import { activateOmniSharpLanguageServer } from './omnisharp/omnisharpLanguageSe
 import { EventStream } from './eventStream';
 import { razorOptions } from './shared/options';
 import { activateRazorExtension } from './razor/razor';
+import { RazorLogger } from './razor/src/razorLogger';
 
 export function activateOmniSharp(
     context: vscode.ExtensionContext,
@@ -39,6 +40,7 @@ export function activateOmniSharp(
         reporter
     );
 
+    const razorLogger = new RazorLogger();
     let omnisharpRazorPromise: Promise<void> | undefined = undefined;
     if (!razorOptions.razorDevMode) {
         omnisharpRazorPromise = activateRazorExtension(
@@ -48,7 +50,8 @@ export function activateOmniSharp(
             reporter,
             undefined,
             platformInfo,
-            /* useOmnisharpServer */ true
+            /* useOmnisharpServer */ true,
+            razorLogger
         );
     }
 

src/activateRoslyn.ts

@@ -25,6 +25,7 @@ import { GlobalBrokeredServiceContainer } from '@microsoft/servicehub-framework'
 import { SolutionSnapshotProvider } from './lsptoolshost/solutionSnapshot/solutionSnapshotProvider';
 import { BuildResultDiagnostics } from './lsptoolshost/diagnostics/buildResultReporterService';
 import { getComponentFolder } from './lsptoolshost/extensions/builtInComponents';
+import { RazorLogger } from './razor/src/razorLogger';
 
 export function activateRoslyn(
     context: vscode.ExtensionContext,
@@ -39,6 +40,8 @@ export function activateRoslyn(
     const roslynLanguageServerEvents = new RoslynLanguageServerEvents();
     context.subscriptions.push(roslynLanguageServerEvents);
 
+    const razorLogger = new RazorLogger();
+
     // Activate Razor. Needs to be activated before Roslyn so commands are registered in the correct order.
     // Otherwise, if Roslyn starts up first, they could execute commands that don't yet exist on Razor's end.
     //
@@ -54,7 +57,8 @@ export function activateRoslyn(
         reporter,
         csharpDevkitExtension,
         platformInfo,
-        /* useOmnisharpServer */ false
+        /* useOmnisharpServer */ false,
+        razorLogger
     );
 
     // Setup a listener for project initialization complete before we start the server.
@@ -73,7 +77,8 @@ export function activateRoslyn(
         optionStream,
         csharpChannel,
         reporter,
-        roslynLanguageServerEvents
+        roslynLanguageServerEvents,
+        razorLogger
     );
 
     debugSessionTracker.initializeDebugSessionHandlers(context);

src/lsptoolshost/activate.ts

@@ -29,6 +29,7 @@ import { ProjectContextStatus } from './projectContext/projectContextStatus';
 import { RoslynLanguageServer } from './server/roslynLanguageServer';
 import { registerCopilotRelatedFilesProvider } from './copilot/relatedFilesProvider';
 import { registerCopilotContextProviders } from './copilot/contextProviders';
+import { RazorLogger } from '../razor/src/razorLogger';
 
 let _channel: vscode.LogOutputChannel;
 let _traceChannel: vscode.OutputChannel;
@@ -43,7 +44,8 @@ export async function activateRoslynLanguageServer(
     optionObservable: Observable<void>,
     outputChannel: vscode.LogOutputChannel,
     reporter: TelemetryReporter,
-    languageServerEvents: RoslynLanguageServerEvents
+    languageServerEvents: RoslynLanguageServerEvents,
+    razorLogger: RazorLogger
 ): Promise<RoslynLanguageServer> {
     // Create a channel for outputting general logs from the language server.
     _channel = outputChannel;
@@ -69,7 +71,8 @@ export async function activateRoslynLanguageServer(
         additionalExtensionPaths,
         languageServerEvents,
         _channel,
-        _traceChannel
+        _traceChannel,
+        razorLogger
     );
 
     registerLanguageStatusItems(context, languageServer, languageServerEvents);

src/lsptoolshost/server/roslynLanguageServer.ts

@@ -8,7 +8,14 @@ import * as path from 'path';
 import * as cp from 'child_process';
 import * as uuid from 'uuid';
 import * as net from 'net';
-import { LanguageClientOptions, MessageTransports, ProtocolRequestType, ServerOptions } from 'vscode-languageclient';
+import {
+    LanguageClientOptions,
+    LogMessageParams,
+    MessageTransports,
+    NotificationType,
+    ProtocolRequestType,
+    ServerOptions,
+} from 'vscode-languageclient';
 import {
     Trace,
     RequestType,
@@ -71,6 +78,7 @@ import {
     copilotLanguageServerExtensionAssemblyName,
     copilotLanguageServerExtensionComponentName,
 } from '../copilot/contextProviders';
+import { RazorLogger } from '../../razor/src/razorLogger';
 
 // Flag indicating if C# Devkit was installed the last time we activated.
 // Used to determine if we need to restart the server on extension changes.
@@ -80,6 +88,7 @@ export class RoslynLanguageServer {
     // These are notifications we will get from the LSP server and will forward to the Razor extension.
     private static readonly provideRazorDynamicFileInfoMethodName: string = 'razor/provideDynamicFileInfo';
     private static readonly removeRazorDynamicFileInfoMethodName: string = 'razor/removeDynamicFileInfo';
+    private static readonly razorLogMessageMethodName: string = 'razor/log';
 
     /**
      * The encoding to use when writing to and from the stream.
@@ -119,7 +128,8 @@ export class RoslynLanguageServer {
         private _context: vscode.ExtensionContext,
         private _telemetryReporter: TelemetryReporter,
         private _languageServerEvents: RoslynLanguageServerEvents,
-        private _channel: vscode.LogOutputChannel
+        private _channel: vscode.LogOutputChannel,
+        logger: RazorLogger
     ) {
         this.registerSetTrace();
         this.registerSendOpenSolution();
@@ -138,6 +148,7 @@ export class RoslynLanguageServer {
 
         // Register Razor dynamic file info handling
         this.registerDynamicFileInfo();
+        this.registerRazorLogger(logger);
 
         this.registerDebuggerAttach();
 
@@ -253,7 +264,8 @@ export class RoslynLanguageServer {
         additionalExtensionPaths: string[],
         languageServerEvents: RoslynLanguageServerEvents,
         channel: vscode.LogOutputChannel,
-        traceChannel: vscode.OutputChannel
+        traceChannel: vscode.OutputChannel,
+        razorlogger: RazorLogger
     ): Promise<RoslynLanguageServer> {
         const devKit = getCSharpDevKit();
         if (devKit) {
@@ -316,7 +328,8 @@ export class RoslynLanguageServer {
             context,
             telemetryReporter,
             languageServerEvents,
-            channel
+            channel,
+            razorlogger
         );
 
         client.registerFeature(server._onAutoInsertFeature);
@@ -832,6 +845,19 @@ export class RoslynLanguageServer {
         );
     }
 
+    private RazorLoggerNotification: NotificationType<LogMessageParams> = new NotificationType(
+        RoslynLanguageServer.razorLogMessageMethodName
+    );
+
+    private registerRazorLogger(logger: RazorLogger) {
+        this._languageClient.onNotification<LogMessageParams>(
+            this.RazorLoggerNotification,
+            (params: LogMessageParams) => {
+                logger.log(params.message, params.type);
+            }
+        );
+    }
+
     // eslint-disable-next-line @typescript-eslint/promise-function-async
     private WaitForAttachCompleteAsync(attachRequestId: string): Promise<boolean> {
         return new Promise<boolean>((resolve) => {

src/razor/razor.ts

@@ -12,6 +12,7 @@ import { EventStream } from '../eventStream';
 import TelemetryReporter from '@vscode/extension-telemetry';
 import { PlatformInformation } from '../shared/platform';
 import { showWarningMessage } from '../shared/observers/utils/showMessage';
+import { RazorLogger } from './src/razorLogger';
 
 export async function activateRazorExtension(
     context: vscode.ExtensionContext,
@@ -20,7 +21,8 @@ export async function activateRazorExtension(
     vscodeTelemetryReporter: TelemetryReporter,
     csharpDevkitExtension: vscode.Extension<any> | undefined,
     platformInfo: PlatformInformation,
-    useOmnisharpServer: boolean
+    useOmnisharpServer: boolean,
+    logger: RazorLogger
 ) {
     const razorConfig = vscode.workspace.getConfiguration('razor');
     const configuredLanguageServerDir = razorConfig.get<string>('languageServer.directory', '');
@@ -49,6 +51,7 @@ export async function activateRazorExtension(
                 vscodeTelemetryReporter,
                 csharpDevkitExtension,
                 platformInfo,
+                logger,
                 /* enableProposedApis: */ false
             );
         }

src/razor/src/extension.ts

@@ -62,15 +62,14 @@ export async function activate(
     vscodeTelemetryReporter: TelemetryReporter,
     csharpDevkitExtension: vscode.Extension<CSharpDevKitExports> | undefined,
     platformInfo: PlatformInformation,
+    logger: RazorLogger,
     enableProposedApis = false
 ) {
     const razorTelemetryReporter = new RazorTelemetryReporter(eventStream);
     const eventEmitterFactory: IEventEmitterFactory = {
         create: <T>() => new vscode.EventEmitter<T>(),
     };
 
-    const logger = new RazorLogger(eventEmitterFactory);
-
     try {
         const razorOptions: RazorLanguageServerOptions = resolveRazorLanguageServerOptions(
             vscodeType,
@@ -82,6 +81,10 @@ export async function activate(
             // TODO: We still need a document manager for Html, so need to do _some_ of the below, just not sure what yet,
             // and it needs to be able to take a roslynLanguageServerClient instead of a razorLanguageServerClient I guess.
 
+            logger.logVerbose(
+                'Razor cohosting is enabled, skipping language server activation. No rzls process will be created.'
+            );
+
             return;
         }
 

src/razor/src/razorLogger.ts

@@ -7,8 +7,8 @@ import * as fs from 'fs';
 import * as path from 'path';
 import * as vscodeAdapter from './vscodeAdapter';
 import * as vscode from 'vscode';
-import { IEventEmitterFactory } from './IEventEmitterFactory';
 import { RazorLanguageServerClient } from './razorLanguageServerClient';
+import { MessageType } from 'vscode-languageserver-protocol';
 
 export class RazorLogger implements vscodeAdapter.Disposable {
     public static readonly logName = 'Razor Log';
@@ -19,9 +19,9 @@ export class RazorLogger implements vscodeAdapter.Disposable {
 
     private readonly onLogEmitter: vscodeAdapter.EventEmitter<string>;
 
-    constructor(eventEmitterFactory: IEventEmitterFactory) {
+    constructor() {
         this.outputChannel = vscode.window.createOutputChannel(vscode.l10n.t('Razor Log'), { log: true });
-        this.onLogEmitter = eventEmitterFactory.create<string>();
+        this.onLogEmitter = new vscode.EventEmitter<string>();
         this.processTraceLevel();
 
         this.outputChannel.onDidChangeLogLevel(async () => {
@@ -96,6 +96,24 @@ export class RazorLogger implements vscodeAdapter.Disposable {
         }
     }
 
+    public log(message: string, level: MessageType) {
+        switch (level) {
+            case MessageType.Error:
+                this.logError(message, new Error(message));
+                break;
+            case MessageType.Warning:
+                this.logWarning(message);
+                break;
+            case MessageType.Info:
+                this.logMessage(message);
+                break;
+            case MessageType.Debug:
+            case MessageType.Log:
+            default:
+                this.logVerbose(message);
+        }
+    }
+
     public dispose() {
         this.outputChannel.dispose();
     }

src/razor/src/razorLoggerNotification.ts

@@ -0,0 +1,10 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { LogLevel } from 'vscode';
+
+export class RazorLoggerNotification {
+    constructor(public readonly message: string, public readonly level: LogLevel) {}
+}