fix: reset loading status when the language service fails to load the project. (#468)

Currently, the loading indicator remains in pending state when the language service fails to load the project.
Typescript project server doesn't send any event when the language service fails to load the project.

This commit refactors the loading indicator to reset state when any error occurs while opening the document.

Author: andrius-pra

client/src/extension.ts

@@ -50,32 +50,33 @@ 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(),
-  );
-
-  client.onReady().then(() => {
-    const projectLoadingTasks = new Map<string, {resolve: () => void}>();
-
-    client.onNotification(projectLoadingNotification.start, (projectName: string) => {
-      vscode.window.withProgress(
-          {
-            location: vscode.ProgressLocation.Window,
-            title: 'Initializing Angular language features',
-          },
-          () => new Promise((resolve) => {
-            projectLoadingTasks.set(projectName, {resolve});
-          }));
-    });
-
-    client.onNotification(projectLoadingNotification.finish, (projectName: string) => {
-      const task = projectLoadingTasks.get(projectName);
-      if (task) {
-        task.resolve();
-        projectLoadingTasks.delete(projectName);
-      }
-    });
+  context.subscriptions.push(...registerCommands(client), client.start());
+
+  client.onDidChangeState((e) => {
+    let task: {resolve: () => void}|undefined;
+    if (e.newState == lsp.State.Running) {
+      client.onNotification(projectLoadingNotification.start, () => {
+        if (task) {
+          task.resolve();
+          task = undefined;
+        }
+        vscode.window.withProgress(
+            {
+              location: vscode.ProgressLocation.Window,
+              title: 'Initializing Angular language features',
+            },
+            () => new Promise((resolve) => {
+              task = {resolve};
+            }));
+      });
+
+      client.onNotification(projectLoadingNotification.finish, () => {
+        if (task) {
+          task.resolve();
+          task = undefined;
+        }
+      });
+    }
   });
 }
 

client/src/protocol.ts

@@ -6,9 +6,9 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
-import {NotificationType} from 'vscode-languageclient';
+import {NotificationType0} from 'vscode-languageclient';
 
 export const projectLoadingNotification = {
-  start: new NotificationType<string, string>('angular-language-service/projectLoadingStart'),
-  finish: new NotificationType<string, string>('angular-language-service/projectLoadingFinish')
-};
+  start: new NotificationType0<string>('angular-language-service/projectLoadingStart'),
+  finish: new NotificationType0<string>('angular-language-service/projectLoadingFinish')
+};

integration/lsp/smoke_spec.ts

@@ -54,7 +54,9 @@ describe('Angular Language Service', () => {
     });
     server.on('message', (data: Message) => {
       if (isNotificationMessage(data)) {
-        console.log('[server]', data.params.message);
+        const toLog = ['[server]', data.method];
+        if (data.params && data.params.message) toLog.push(data.params.message);
+        console.log(...toLog);
       } else {
         responseEmitter.emit('response', data);
       }

server/src/protocol.ts

@@ -6,9 +6,9 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
-import {NotificationType} from 'vscode-languageserver';
+import {NotificationType0} from 'vscode-languageserver';
 
 export const projectLoadingNotification = {
-  start: new NotificationType<string, string>('angular-language-service/projectLoadingStart'),
-  finish: new NotificationType<string, string>('angular-language-service/projectLoadingFinish')
+  start: new NotificationType0<string>('angular-language-service/projectLoadingStart'),
+  finish: new NotificationType0<string>('angular-language-service/projectLoadingFinish')
 };

server/src/session.ts

@@ -39,6 +39,7 @@ export class Session {
   private readonly connection: lsp.IConnection;
   private readonly projectService: ProjectService;
   private diagnosticsTimeout: NodeJS.Timeout|null = null;
+  private isProjectLoading = false;
 
   constructor(options: SessionOptions) {
     // Create a connection for the server. The connection uses Node's IPC as a transport.
@@ -79,14 +80,17 @@ export class Session {
   private handleProjectServiceEvent(event: ts.server.ProjectServiceEvent) {
     switch (event.eventName) {
       case ts.server.ProjectLoadingStartEvent:
-        this.connection.sendNotification(
-            projectLoadingNotification.start, event.data.project.projectName);
+        this.isProjectLoading = true;
+        this.connection.sendNotification(projectLoadingNotification.start);
         break;
       case ts.server.ProjectLoadingFinishEvent: {
         const {project} = event.data;
         // Disable language service if project is not Angular
         this.checkIsAngularProject(project);
-        this.connection.sendNotification(projectLoadingNotification.finish, project.projectName);
+        if (this.isProjectLoading) {
+          this.isProjectLoading = false;
+          this.connection.sendNotification(projectLoadingNotification.finish);
+        }
         break;
       }
       case ts.server.ProjectsUpdatedInBackgroundEvent:
@@ -172,24 +176,35 @@ export class Session {
     // is up-to-date when a file is first opened in the editor.
     // In this case, we should not pass fileContent to projectService.
     const fileContent = undefined;
-    const result = this.projectService.openClientFile(filePath, fileContent, scriptKind);
+    try {
+      const result = this.projectService.openClientFile(filePath, fileContent, scriptKind);
 
-    const {configFileName, configFileErrors} = result;
-    if (configFileErrors && configFileErrors.length) {
-      // configFileErrors is an empty array even if there's no error, so check length.
-      this.connection.console.error(configFileErrors.map(e => e.messageText).join('\n'));
-    }
-    if (!configFileName) {
-      this.connection.console.error(`No config file for ${filePath}`);
-      return;
-    }
-    const project = this.projectService.findProject(configFileName);
-    if (!project) {
-      this.connection.console.error(`Failed to find project for ${filePath}`);
-      return;
-    }
-    if (project.languageServiceEnabled) {
-      project.refreshDiagnostics();  // Show initial diagnostics
+      const {configFileName, configFileErrors} = result;
+      if (configFileErrors && configFileErrors.length) {
+        // configFileErrors is an empty array even if there's no error, so check length.
+        this.connection.console.error(configFileErrors.map(e => e.messageText).join('\n'));
+      }
+      if (!configFileName) {
+        this.connection.console.error(`No config file for ${filePath}`);
+        return;
+      }
+      const project = this.projectService.findProject(configFileName);
+      if (!project) {
+        this.connection.console.error(`Failed to find project for ${filePath}`);
+        return;
+      }
+      if (project.languageServiceEnabled) {
+        project.refreshDiagnostics();  // Show initial diagnostics
+      }
+    } catch (error) {
+      if (this.isProjectLoading) {
+        this.isProjectLoading = false;
+        this.connection.sendNotification(projectLoadingNotification.finish);
+      }
+      if (error.stack) {
+        this.error(error.stack);
+      }
+      throw error;
     }
   }