From 3a00500268bff1fee5e4bbbcc228cf563565e546 Mon Sep 17 00:00:00 2001
From: Eric Chen <erichen@microsoft.com>
Date: Fri, 17 Apr 2020 11:44:52 +0800
Subject: [PATCH] fix: delay update diagnostics for graph initialization

---
 src/extension.ts                         | 36 ++++++++++++++++--------
 src/intelliSense/digitalTwinConstants.ts |  1 +
 src/intelliSense/intelliSenseUtility.ts  |  8 ++++++
 3 files changed, 34 insertions(+), 11 deletions(-)

diff --git a/src/extension.ts b/src/extension.ts
index 07c4d69..07ce11d 100644
--- a/src/extension.ts
+++ b/src/extension.ts
@@ -85,7 +85,7 @@ function initCommand(
 function initIntelliSense(context: vscode.ExtensionContext): void {
   // init DigitalTwin graph
   IntelliSenseUtility.initGraph(context);
-  // register providers of completionItem and hover
+  // register provider
   const selector: vscode.DocumentSelector = {
     language: "json",
     scheme: "file",
@@ -98,26 +98,35 @@ function initIntelliSense(context: vscode.ExtensionContext): void {
     ),
   );
   // register diagnostic
-  let pendingDiagnostic: NodeJS.Timer;
   const diagnosticCollection: vscode.DiagnosticCollection = vscode.languages.createDiagnosticCollection(
     Constants.CHANNEL_NAME,
   );
+  context.subscriptions.push(diagnosticCollection);
+  let pendingDiagnostic: NodeJS.Timer;
   const diagnosticProvider = new DigitalTwinDiagnosticProvider();
   const activeTextEditor: vscode.TextEditor | undefined = vscode.window.activeTextEditor;
-  if (activeTextEditor) {
-    diagnosticProvider.updateDiagnostics(activeTextEditor.document, diagnosticCollection);
+  if (activeTextEditor && IntelliSenseUtility.isDigitalTwinFile(activeTextEditor.document)) {
+    // delay for DigitalTwin graph initialization
+    pendingDiagnostic = setTimeout(
+      () => diagnosticProvider.updateDiagnostics(activeTextEditor.document, diagnosticCollection),
+      Constants.DEFAULT_TIMER_MS,
+    );
   }
-  context.subscriptions.push(diagnosticCollection);
   context.subscriptions.push(
-    vscode.window.onDidChangeActiveTextEditor((event) => {
-      if (event) {
-        diagnosticProvider.updateDiagnostics(event.document, diagnosticCollection);
+    vscode.window.onDidChangeActiveTextEditor((editor: vscode.TextEditor | undefined) => {
+      // only update diagnostics if it is a new document
+      if (
+        editor &&
+        IntelliSenseUtility.isDigitalTwinFile(editor.document) &&
+        !diagnosticCollection.has(editor.document.uri)
+      ) {
+        diagnosticProvider.updateDiagnostics(editor.document, diagnosticCollection);
       }
     }),
   );
   context.subscriptions.push(
-    vscode.workspace.onDidChangeTextDocument((event) => {
-      if (event) {
+    vscode.workspace.onDidChangeTextDocument((event: vscode.TextDocumentChangeEvent) => {
+      if (IntelliSenseUtility.isDigitalTwinFile(event.document)) {
         if (pendingDiagnostic) {
           clearTimeout(pendingDiagnostic);
         }
@@ -129,6 +138,11 @@ function initIntelliSense(context: vscode.ExtensionContext): void {
     }),
   );
   context.subscriptions.push(
-    vscode.workspace.onDidCloseTextDocument((document) => diagnosticCollection.delete(document.uri)),
+    vscode.workspace.onDidCloseTextDocument((document: vscode.TextDocument) => {
+      if (IntelliSenseUtility.isDigitalTwinFile(document)) {
+        diagnosticCollection.delete(document.uri);
+      }
+    }),
   );
+  // TODO(erichen): add telemetry for opened file
 }
diff --git a/src/intelliSense/digitalTwinConstants.ts b/src/intelliSense/digitalTwinConstants.ts
index 077fd03..87eb7d3 100644
--- a/src/intelliSense/digitalTwinConstants.ts
+++ b/src/intelliSense/digitalTwinConstants.ts
@@ -29,6 +29,7 @@ export enum DiagnosticMessage {
  * Constants for DigitalTwin IntelliSense
  */
 export class DigitalTwinConstants {
+  public static readonly LANGUAGE_ID = "json";
   public static readonly SCHEMA_SEPARATOR = "#";
   public static readonly BASE_CLASS = "Entity";
   public static readonly NAME = "name";
diff --git a/src/intelliSense/intelliSenseUtility.ts b/src/intelliSense/intelliSenseUtility.ts
index eb2732d..7af9d87 100644
--- a/src/intelliSense/intelliSenseUtility.ts
+++ b/src/intelliSense/intelliSenseUtility.ts
@@ -214,6 +214,14 @@ export class IntelliSenseUtility {
     return outerProperty ? IntelliSenseUtility.parseProperty(outerProperty) : undefined;
   }
 
+  /**
+   * check if text document is a DigitalTwin file
+   * @param document text document
+   */
+  public static isDigitalTwinFile(document: vscode.TextDocument): boolean {
+    return document.languageId === DigitalTwinConstants.LANGUAGE_ID;
+  }
+
   private static graph: DigitalTwinGraph;
   private constructor() {}
 }