feat: new command 'openAngularLog' for opening log file from editor

Add a new command for opening the Angular log file right from the editor.

Author: kyliau

client/src/commands.ts

@@ -8,41 +8,67 @@
 
 import * as vscode from 'vscode';
 import * as lsp from 'vscode-languageclient';
+import {ServerOptions} from '../../common/out/initialize';
 
 /**
  * Represent a vscode command with an ID and an impl function `execute`.
  */
 interface Command {
   id: string;
-  execute(): Promise<vscode.Disposable>;
+  execute(): Promise<unknown>;
 }
 
 /**
  * Restart the language server by killing the process then spanwing a new one.
  * @param client language client
+ * @param context extension context for adding disposables
  */
-function restartNgServer(client: lsp.LanguageClient): Command {
+function restartNgServer(client: lsp.LanguageClient, context: vscode.ExtensionContext): Command {
   return {
     id: 'angular.restartNgServer',
     async execute() {
       await client.stop();
-      return client.start();
+      context.subscriptions.push(client.start());
+    },
+  };
+}
+
+/**
+ * Open the current server log file in a new editor.
+ */
+function openLogFile(client: lsp.LanguageClient): Command {
+  return {
+    id: 'angular.openLogFile',
+    async execute() {
+      const serverOptions: ServerOptions|undefined = client.initializeResult?.serverOptions;
+      if (!serverOptions?.logFile) {
+        // TODO: We could show a MessageItem to help users automatically update
+        // the configuration option then restart the server, but we currently do
+        // not reload the server options when restarting the server.
+        vscode.window.showErrorMessage(
+            `Angular Server logging is off. Please set 'angular.log' and reload the window.`);
+        return;
+      }
+      const document = await vscode.workspace.openTextDocument(serverOptions.logFile);
+      return vscode.window.showTextDocument(document);
     },
   };
 }
 
 /**
  * Register all supported vscode commands for the Angular extension.
  * @param client language client
+ * @param context extension context for adding disposables
  */
-export function registerCommands(client: lsp.LanguageClient): vscode.Disposable[] {
+export function registerCommands(
+    client: lsp.LanguageClient, context: vscode.ExtensionContext): void {
   const commands: Command[] = [
-    restartNgServer(client),
+    restartNgServer(client, context),
+    openLogFile(client),
   ];
 
-  const disposables = commands.map((command) => {
-    return vscode.commands.registerCommand(command.id, command.execute);
-  });
-
-  return disposables;
+  for (const command of commands) {
+    const disposable = vscode.commands.registerCommand(command.id, command.execute);
+    context.subscriptions.push(disposable);
+  }
 }

client/src/extension.ts

@@ -53,7 +53,8 @@ export function activate(context: vscode.ExtensionContext) {
 
   // Push the disposable to the context's subscriptions so that the
   // client can be deactivated on extension deactivation
-  context.subscriptions.push(...registerCommands(client), client.start());
+  registerCommands(client, context);
+  context.subscriptions.push(client.start());
 
   client.onDidChangeState((e: lsp.StateChangeEvent) => {
     if (e.newState === lsp.State.Running) {

common/initialize.ts

@@ -0,0 +1,11 @@
+/**
+ * @license
+ * Copyright Google Inc. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://angular.io/license
+ */
+
+export interface ServerOptions {
+  logFile?: string;
+}

integration/lsp/viewengine_spec.ts

@@ -114,7 +114,7 @@ describe('initialization', () => {
     });
     client.listen();
     const response = await initializeServer(client);
-    expect(response).toEqual({
+    expect(response).toEqual(jasmine.objectContaining({
       capabilities: {
         textDocumentSync: 2,
         completionProvider: {
@@ -130,7 +130,7 @@ describe('initialization', () => {
           },
         },
       },
-    });
+    }));
     client.dispose();
   });
 });

package.json

@@ -22,6 +22,11 @@
         "command": "angular.restartNgServer",
         "title": "Restart Angular Language server",
         "category": "Angular"
+      },
+      {
+        "command": "angular.openLogFile",
+        "title": "Open Angular Server log",
+        "category": "Angular"
       }
     ],
     "configuration": {

server/src/session.ts

@@ -9,6 +9,7 @@
 import * as ts from 'typescript/lib/tsserverlibrary';
 import * as lsp from 'vscode-languageserver';
 
+import {ServerOptions} from '../../common/out/initialize';
 import * as notification from '../../common/out/notifications';
 
 import {tsCompletionEntryToLspCompletionItem} from './completion';
@@ -247,6 +248,9 @@ export class Session {
   }
 
   private onInitialize(params: lsp.InitializeParams): lsp.InitializeResult {
+    const serverOptions: ServerOptions = {
+      logFile: this.logger.getLogFileName(),
+    };
     return {
       capabilities: {
         textDocumentSync: lsp.TextDocumentSyncKind.Incremental,
@@ -263,6 +267,7 @@ export class Session {
           workspaceFolders: {supported: true},
         },
       },
+      serverOptions,
     };
   }