Rename razor.trace to razor.server.trace, and use LogLevel values, to match Roslyn (and VS Code conventions)

Author: davidwengier

CONTRIBUTING.md

@@ -39,7 +39,7 @@ https://github.com/dotnet/razor contains the server implementation.  Follow the
 
 depending on which configuration is built.  Then, launch the extension here and change the VSCode setting `razor.languageServer.directory` to point to the Razor executable path you built above and reload the window.
 
-If you need to debug the server, you can set the VSCode setting `razor.languageServer.debug` to true.  This will trigger a `Debugger.Launch()` on the server side as it starts. You can also set `razor.trace` to `Verbose` to get more log messages in the output window
+If you need to debug the server, you can set the VSCode setting `razor.languageServer.debug` to true.  This will trigger a `Debugger.Launch()` on the server side as it starts. You can also set `razor.server.trace` to `Debug` to get more log messages in the output window
 
 ### Creating VSIXs
 
@@ -52,4 +52,4 @@ To update the version of the roslyn server used by the extension do the followin
 2.  In the official build stage, look for the `Publish Assets` step.  In there you will see it publishing the `Microsoft.CodeAnalysis.LanguageServer.neutral` package with some version, e.g. `4.6.0-3.23158.4`.  Take note of that version number.
 3.  In the [package.json](package.json) inside the `defaults` section update the `roslyn` key to point to the version number you found above in step 2.
 4.  Ensure that version of the package is in the proper feeds by running `gulp updateRoslynVersion`. Note: you may need to install the [Azure Artifacts NuGet Credential Provider](https://github.com/microsoft/artifacts-credprovider#installation-on-windows) to run interactive authentication.
-5.  Build and test the change. If everything looks good, submit a PR.
+5.  Build and test the change. If everything looks good, submit a PR.

l10n/bundle.l10n.json

@@ -47,7 +47,7 @@
   "Downloading Razor Telemetry Package": "Downloading Razor Telemetry Package",
   "Cannot load Razor language server because the directory was not found: '{0}'": "Cannot load Razor language server because the directory was not found: '{0}'",
   "Could not find '{0}' in or above '{1}'.": "Could not find '{0}' in or above '{1}'.",
-  "Invalid trace setting for Razor language server. Defaulting to '{0}'": "Invalid trace setting for Razor language server. Defaulting to '{0}'",
+  "Invalid razor.server.trace setting. Defaulting to '{0}'": "Invalid razor.server.trace setting. Defaulting to '{0}'",
   "Could not find Razor Language Server executable within directory '{0}'": "Could not find Razor Language Server executable within directory '{0}'",
   "Server failed to start after retrying 5 times.": "Server failed to start after retrying 5 times.",
   "Razor Language Server failed to start unexpectedly, please check the 'Razor Log' and report an issue.": "Razor Language Server failed to start unexpectedly, please check the 'Razor Log' and report an issue.",

package.json

@@ -1751,21 +1751,20 @@
             "description": "%configuration.razor.languageServer.debug%",
             "order": 90
           },
-          "razor.trace": {
+          "razor.server.trace": {
+            "scope": "window",
             "type": "string",
-            "default": "Off",
             "enum": [
-              "Off",
-              "Messages",
-              "Verbose"
-            ],
-            "enumDescriptions": [
-              "%configuration.razor.trace.off%",
-              "%configuration.razor.trace.messages%",
-              "%configuration.razor.trace.verbose%"
+              "Trace",
+              "Debug",
+              "Information",
+              "Warning",
+              "Error",
+              "Critical",
+              "None"
             ],
-            "description": "%configuration.razor.trace%",
-            "order": 90
+            "default": "Information",
+            "description": "%configuration.razor.server.trace%"
           }
         }
       },
@@ -5696,4 +5695,4 @@
       }
     ]
   }
-}
+}

src/razor/src/diagnostics/reportIssuePanel.ts

@@ -5,7 +5,7 @@
 
 import * as vscode from 'vscode';
 import { RazorLogger } from '../razorLogger';
-import { Trace } from '../trace';
+import { LogLevel } from '../logLevel';
 import { ReportIssueCreator } from './reportIssueCreator';
 import { ReportIssueDataCollector } from './reportIssueDataCollector';
 import { ReportIssueDataCollectorFactory } from './reportIssueDataCollectorFactory';
@@ -118,7 +118,7 @@ export class ReportIssuePanel {
         }
 
         let panelBodyContent = '';
-        if (this.logger.trace.valueOf() === Trace.Verbose) {
+        if (this.logger.logLevel.valueOf() <= LogLevel.Debug) {
             const startButtonLabel = vscode.l10n.t('Start');
             const startButton = `<button onclick="startIssue()">${startButtonLabel}</button>`;
             const firstLine = vscode.l10n.t('Press {0}', startButton);
@@ -157,8 +157,8 @@ ${privacyAnchor}
 <button onclick="copyIssue()">${copyIssueContentLabel}</button>`;
         } else {
             const verbositySettingName = `<strong><em>${RazorLogger.verbositySetting}</em></strong>`;
-            const currentVerbositySettingValue = `<strong><em>${Trace[this.logger.trace]}</em></strong>`;
-            const neededVerbositySettingValue = `<strong><em>${Trace[Trace.Verbose]}</em></strong>`;
+            const currentVerbositySettingValue = `<strong><em>${LogLevel[this.logger.logLevel]}</em></strong>`;
+            const neededVerbositySettingValue = `<strong><em>${LogLevel[LogLevel.Debug]}</em></strong>`;
 
             panelBodyContent =
                 '<p>' +

src/razor/src/extension.ts

@@ -36,7 +36,7 @@ import { ProposedApisFeature } from './proposedApisFeature';
 import { RazorLanguage } from './razorLanguage';
 import { RazorLanguageConfiguration } from './razorLanguageConfiguration';
 import { RazorLanguageServerClient } from './razorLanguageServerClient';
-import { resolveRazorLanguageServerTrace } from './razorLanguageServerTraceResolver';
+import { resolveRazorLanguageServerLogLevel } from './razorLanguageServerTraceResolver';
 import { RazorLanguageServiceClient } from './razorLanguageServiceClient';
 import { RazorLogger } from './razorLogger';
 import { RazorReferenceProvider } from './reference/razorReferenceProvider';
@@ -71,14 +71,14 @@ export async function activate(
         create: <T>() => new vscode.EventEmitter<T>(),
     };
 
-    const languageServerTrace = resolveRazorLanguageServerTrace(vscodeType);
-    const logger = new RazorLogger(eventEmitterFactory, languageServerTrace);
+    const languageServerLogLevel = resolveRazorLanguageServerLogLevel(vscodeType);
+    const logger = new RazorLogger(eventEmitterFactory, languageServerLogLevel);
 
     try {
         const razorOptions: RazorLanguageServerOptions = resolveRazorLanguageServerOptions(
             vscodeType,
             languageServerDir,
-            languageServerTrace,
+            languageServerLogLevel,
             logger
         );
 

src/razor/src/trace.ts renamed to src/razor/src/logLevel.ts

@@ -3,8 +3,12 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-export enum Trace {
-    Off = 0,
-    Messages = 1,
-    Verbose = 2,
+export enum LogLevel {
+    Trace = 0,
+    Debug = 1,
+    Information = 2,
+    Warning = 3,
+    Error = 4,
+    Critical = 5,
+    None = 6,
 }

src/razor/src/razorLanguageServerClient.ts

@@ -12,7 +12,7 @@ import { LanguageClient, ServerOptions } from 'vscode-languageclient/node';
 import { RazorLanguage } from './razorLanguage';
 import { RazorLanguageServerOptions } from './razorLanguageServerOptions';
 import { resolveRazorLanguageServerOptions } from './razorLanguageServerOptionsResolver';
-import { resolveRazorLanguageServerTrace } from './razorLanguageServerTraceResolver';
+import { resolveRazorLanguageServerLogLevel } from './razorLanguageServerTraceResolver';
 import { RazorLogger } from './razorLogger';
 import { TelemetryReporter as RazorTelemetryReporter } from './telemetryReporter';
 import TelemetryReporter from '@vscode/extension-telemetry';
@@ -55,9 +55,9 @@ export class RazorLanguageServerClient implements vscode.Disposable {
     }
 
     public updateTraceLevel() {
-        const languageServerTrace = resolveRazorLanguageServerTrace(this.vscodeType);
+        const languageServerLogLevel = resolveRazorLanguageServerLogLevel(this.vscodeType);
         this.setupLanguageServer();
-        this.logger.setTraceLevel(languageServerTrace);
+        this.logger.setTraceLevel(languageServerLogLevel);
     }
 
     public onStarted(listener: () => Promise<any>) {
@@ -211,7 +211,7 @@ export class RazorLanguageServerClient implements vscode.Disposable {
     }
 
     private setupLanguageServer() {
-        const languageServerTrace = resolveRazorLanguageServerTrace(this.vscodeType);
+        const languageServerTrace = resolveRazorLanguageServerLogLevel(this.vscodeType);
         const options: RazorLanguageServerOptions = resolveRazorLanguageServerOptions(
             this.vscodeType,
             this.languageServerDir,
@@ -227,9 +227,9 @@ export class RazorLanguageServerClient implements vscode.Disposable {
 
         this.logger.logMessage(`Razor language server path: ${options.serverPath}`);
 
-        args.push('--trace');
-        args.push(options.trace.toString());
-        this.razorTelemetryReporter.reportTraceLevel(options.trace);
+        args.push('--logLevel');
+        args.push(options.logLevel.toString());
+        this.razorTelemetryReporter.reportTraceLevel(options.logLevel);
 
         if (options.debug) {
             this.razorTelemetryReporter.reportDebugLanguageServer();

src/razor/src/razorLanguageServerOptions.ts

@@ -4,12 +4,12 @@
  *--------------------------------------------------------------------------------------------*/
 
 import * as vscode from 'vscode';
-import { Trace } from './trace';
+import { LogLevel } from './logLevel';
 
 export interface RazorLanguageServerOptions {
     serverPath: string;
     outputChannel?: vscode.OutputChannel;
     debug?: boolean;
-    trace: Trace;
+    logLevel: LogLevel;
     usingOmniSharp: boolean;
 }

src/razor/src/razorLanguageServerOptionsResolver.ts

@@ -10,13 +10,13 @@ import * as vscodeAdapter from './vscodeAdapter';
 import * as vscode from 'vscode';
 import { RazorLanguageServerOptions } from './razorLanguageServerOptions';
 import { RazorLogger } from './razorLogger';
-import { Trace } from './trace';
+import { LogLevel } from './logLevel';
 import { getCSharpDevKit } from '../../utils/getCSharpDevKit';
 
 export function resolveRazorLanguageServerOptions(
     vscodeApi: vscodeAdapter.api,
     languageServerDir: string,
-    trace: Trace,
+    logLevel: LogLevel,
     logger: RazorLogger
 ) {
     const languageServerExecutablePath = findLanguageServerExecutable(languageServerDir);
@@ -28,7 +28,7 @@ export function resolveRazorLanguageServerOptions(
     return {
         serverPath: languageServerExecutablePath,
         debug: debugLanguageServer,
-        trace,
+        logLevel: logLevel,
         outputChannel: logger.outputChannel,
         usingOmniSharp,
     } as RazorLanguageServerOptions;

src/razor/src/razorLanguageServerTraceResolver.ts

@@ -3,28 +3,40 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-import { Trace } from './trace';
+import { LogLevel } from './logLevel';
 import * as vscodeAdapter from './vscodeAdapter';
 import * as vscode from 'vscode';
 
-export function resolveRazorLanguageServerTrace(vscodeApi: vscodeAdapter.api) {
-    const languageConfig = vscodeApi.workspace.getConfiguration('razor');
+export function resolveRazorLanguageServerLogLevel(vscodeApi: vscodeAdapter.api) {
+    const languageConfig = vscodeApi.workspace.getConfiguration('razor.server');
     const traceString = languageConfig.get<string>('trace');
-    const trace = parseTraceString(traceString);
+    const logLevel = parseTraceString(traceString);
 
-    return trace;
+    return logLevel;
 }
 
 function parseTraceString(traceString: string | undefined) {
     switch (traceString) {
-        case 'Off':
-            return Trace.Off;
-        case 'Messages':
-            return Trace.Messages;
-        case 'Verbose':
-            return Trace.Verbose;
+        case 'Trace':
+            return LogLevel.Trace;
+        case 'Verbose': // For importing old config values
+        case 'Debug':
+            return LogLevel.Debug;
+        case 'Messages': // For importing old config values
+        case 'Information':
+            return LogLevel.Information;
+        case 'Warning':
+            return LogLevel.Warning;
+        case 'Error':
+            return LogLevel.Error;
+        case 'Critical':
+            return LogLevel.Critical;
+        case 'Off': // For importing old config values
+        case 'None':
+            return LogLevel.None;
+
         default:
-            console.log(vscode.l10n.t("Invalid trace setting for Razor language server. Defaulting to '{0}'", 'Off'));
-            return Trace.Off;
+            console.log(vscode.l10n.t("Invalid razor.server.trace setting. Defaulting to '{0}'", 'Information'));
+            return LogLevel.Information;
     }
 }