Replace chokidar

Author: nojaf

server/src/incrementalCompilation.ts

@@ -8,7 +8,6 @@ import * as p from "vscode-languageserver-protocol";
 import * as cp from "node:child_process";
 import config, { send } from "./config";
 import * as c from "./constants";
-import * as chokidar from "chokidar";
 import { fileCodeActions } from "./codeActions";
 import { projectsFiles } from "./projectFiles";
 
@@ -91,38 +90,29 @@ const incrementallyCompiledFileInfo: Map<
 const hasReportedFeatureFailedError: Set<string> = new Set();
 const originalTypeFileToFilePath: Map<string, string> = new Map();
 
-let incrementalFilesWatcher = chokidar
-  .watch([], {
-    awaitWriteFinish: {
-      stabilityThreshold: 1,
-    },
-  })
-  .on("all", (e, changedPath) => {
-    if (e !== "change" && e !== "unlink") return;
-    const filePath = originalTypeFileToFilePath.get(changedPath);
-    if (filePath != null) {
-      const entry = incrementallyCompiledFileInfo.get(filePath);
-      if (entry != null) {
+export function incrementalCompilationFileChanged(changedPath: string) {
+  const filePath = originalTypeFileToFilePath.get(changedPath);
+  if (filePath != null) {
+    const entry = incrementallyCompiledFileInfo.get(filePath);
+    if (entry != null) {
+      if (debug()) {
+        console.log("[watcher] Cleaning up incremental files for " + filePath);
+      }
+      if (entry.compilation != null) {
         if (debug()) {
-          console.log(
-            "[watcher] Cleaning up incremental files for " + filePath
-          );
-        }
-        if (entry.compilation != null) {
-          if (debug()) {
-            console.log("[watcher] Was compiling, killing");
-          }
-          clearTimeout(entry.compilation.timeout);
-          entry.killCompilationListeners.forEach((cb) => cb());
-          entry.compilation = null;
+          console.log("[watcher] Was compiling, killing");
         }
-        cleanUpIncrementalFiles(
-          entry.file.sourceFilePath,
-          entry.project.rootPath
-        );
+        clearTimeout(entry.compilation.timeout);
+        entry.killCompilationListeners.forEach((cb) => cb());
+        entry.compilation = null;
       }
+      cleanUpIncrementalFiles(
+        entry.file.sourceFilePath,
+        entry.project.rootPath
+      );
     }
-  });
+  }
+}
 
 export function removeIncrementalFileFolder(
   projectRootPath: string,
@@ -464,10 +454,6 @@ function triggerIncrementalCompilationOfFile(
     incrementalFileCacheEntry.project.callArgs = figureOutBscArgs(
       incrementalFileCacheEntry
     );
-    // Set up watcher for relevant cmt/cmti
-    incrementalFilesWatcher.add([
-      incrementalFileCacheEntry.file.originalTypeFileLocation,
-    ]);
     originalTypeFileToFilePath.set(
       incrementalFileCacheEntry.file.originalTypeFileLocation,
       incrementalFileCacheEntry.file.sourceFilePath
@@ -777,7 +763,6 @@ export function handleClosedFile(filePath: string) {
   cleanUpIncrementalFiles(filePath, entry.project.rootPath);
   incrementallyCompiledFileInfo.delete(filePath);
   originalTypeFileToFilePath.delete(entry.file.originalTypeFileLocation);
-  incrementalFilesWatcher.unwatch([entry.file.originalTypeFileLocation]);
 }
 
 export function getCodeActionsFromIncrementalCompilation(

server/src/server.ts

@@ -4,8 +4,8 @@ import * as v from "vscode-languageserver";
 import * as rpc from "vscode-jsonrpc/node";
 import * as path from "path";
 import fs from "fs";
-// TODO: check DidChangeWatchedFilesNotification.
 import {
+  DidChangeWatchedFilesNotification,
   DidOpenTextDocumentNotification,
   DidChangeTextDocumentNotification,
   DidCloseTextDocumentNotification,
@@ -14,6 +14,7 @@ import {
   InlayHintParams,
   CodeLensParams,
   SignatureHelpParams,
+  InitializedNotification,
 } from "vscode-languageserver-protocol";
 import * as lookup from "./lookup";
 import * as utils from "./utils";
@@ -27,6 +28,10 @@ import * as ic from "./incrementalCompilation";
 import config, { extensionConfiguration } from "./config";
 import { projectsFiles } from "./projectFiles";
 
+// Absolute paths to all the workspace folders
+// Configured during the initialize request
+const workspaceFolders = new Set<string>();
+
 // This holds client capabilities specific to our extension, and not necessarily
 // related to the LS protocol. It's for enabling/disabling features that might
 // work in one client, like VSCode, but perhaps not in others, like vim.
@@ -208,21 +213,18 @@ let deleteProjectConfigCache = (rootPath: string) => {
   }
 };
 
-let compilerLogsWatcher = chokidar
-  .watch([], {
-    awaitWriteFinish: {
-      stabilityThreshold: 1,
-    },
-  })
-  .on("all", (_e, changedPath) => {
-    if (changedPath.includes("build.ninja")) {
+function onWorkspaceDidChangeWatchedFiles(
+  params: p.DidChangeWatchedFilesParams
+) {
+  params.changes.forEach((change) => {
+    if (change.uri.includes("build.ninja")) {
       if (config.extensionConfiguration.cache?.projectConfig?.enable === true) {
-        let projectRoot = utils.findProjectRootOfFile(changedPath);
+        let projectRoot = utils.findProjectRootOfFile(change.uri);
         if (projectRoot != null) {
           syncProjectConfigCache(projectRoot);
         }
       }
-    } else {
+    } else if (change.uri.includes("compiler.log")) {
       try {
         sendUpdatedDiagnostics();
         sendCompilationFinishedMessage();
@@ -235,13 +237,11 @@ let compilerLogsWatcher = chokidar
       } catch {
         console.log("Error while sending updated diagnostics");
       }
+    } else {
+      ic.incrementalCompilationFileChanged(fileURLToPath(change.uri));
     }
   });
-
-let stopWatchingCompilerLog = () => {
-  // TODO: cleanup of compilerLogs?
-  compilerLogsWatcher.close();
-};
+}
 
 type clientSentBuildAction = {
   title: string;
@@ -279,15 +279,6 @@ let openedFile = (fileUri: string, fileContent: string) => {
           : false,
       };
       projectsFiles.set(projectRootPath, projectRootState);
-      compilerLogsWatcher.add(
-        path.join(projectRootPath, c.compilerLogPartialPath)
-      );
-      if (config.extensionConfiguration.cache?.projectConfig?.enable === true) {
-        compilerLogsWatcher.add(
-          path.join(projectRootPath, c.buildNinjaPartialPath)
-        );
-        syncProjectConfigCache(projectRootPath);
-      }
     }
     let root = projectsFiles.get(projectRootPath)!;
     root.openFiles.add(filePath);
@@ -363,12 +354,6 @@ let closedFile = (fileUri: string) => {
       root.openFiles.delete(filePath);
       // clear diagnostics too if no open files open in said project
       if (root.openFiles.size === 0) {
-        compilerLogsWatcher.unwatch(
-          path.join(projectRootPath, c.compilerLogPartialPath)
-        );
-        compilerLogsWatcher.unwatch(
-          path.join(projectRootPath, c.buildNinjaPartialPath)
-        );
         deleteProjectConfigCache(projectRootPath);
         deleteProjectDiagnostics(projectRootPath);
         if (root.bsbWatcherByEditor !== null) {
@@ -1050,7 +1035,7 @@ function onMessage(msg: p.Message) {
       } else {
         process.exit(1);
       }
-    } else if (msg.method === "initialized") {
+    } else if (msg.method === InitializedNotification.method) {
       /*
       The initialized notification is sent from the client to the server after the client received the result of the initialize request
       but before the client is sending any other request or notification to the server.
@@ -1059,27 +1044,32 @@ function onMessage(msg: p.Message) {
       We use this to register the file watchers for the project.
       The client can watch files for us and send us events via the `workspace/didChangeWatchedFiles`
       */
-      const watchers =
-        Array.from(projectsFiles.keys()).flatMap(projectRootPath => [
+      const watchers = Array.from(workspaceFolders).flatMap(
+        (projectRootPath) => [
           {
             globPattern: path.join(projectRootPath, c.compilerLogPartialPath),
-            kind: p.WatchKind.Change | p.WatchKind.Create,
+            kind: p.WatchKind.Change | p.WatchKind.Create | p.WatchKind.Delete,
           },
           {
             globPattern: path.join(projectRootPath, c.buildNinjaPartialPath),
-            kind: p.WatchKind.Change | p.WatchKind.Create,
+            kind: p.WatchKind.Change | p.WatchKind.Create | p.WatchKind.Delete,
           },
-        ])
-      const registrationParams : p.RegistrationParams = {
-        registrations:[
           {
-            id: "rescript_file_watcher",
-            method: p.DidChangeWatchedFilesNotification.method,
-            registerOptions: {
-              watchers
-            }
+            globPattern: `${path.join(projectRootPath, c.compilerDirPartialPath)}/**/*.{cmt,cmi}`,
+            kind: p.WatchKind.Change | p.WatchKind.Delete,
           }
         ]
+      );
+      const registrationParams: p.RegistrationParams = {
+        registrations: [
+          {
+            id: "rescript_file_watcher",
+            method: DidChangeWatchedFilesNotification.method,
+            registerOptions: {
+              watchers,
+            },
+          },
+        ],
       };
       const req: p.RequestMessage = {
         jsonrpc: c.jsonrpcVersion,
@@ -1088,6 +1078,9 @@ function onMessage(msg: p.Message) {
         params: registrationParams,
       };
       send(req);
+    } else if (msg.method === DidChangeWatchedFilesNotification.method) {
+      const params = msg.params as p.DidChangeWatchedFilesParams;
+      onWorkspaceDidChangeWatchedFiles(params);
     } else if (msg.method === DidOpenTextDocumentNotification.method) {
       let params = msg.params as p.DidOpenTextDocumentParams;
       openedFile(params.textDocument.uri, params.textDocument.text);
@@ -1133,6 +1126,10 @@ function onMessage(msg: p.Message) {
     } else if (msg.method === "initialize") {
       // Save initial configuration, if present
       let initParams = msg.params as InitializeParams;
+      for (const workspaceFolder of initParams.workspaceFolders || []) {
+        const workspaceRootPath = fileURLToPath(workspaceFolder.uri);
+        workspaceFolders.add(workspaceRootPath);
+      }
       let initialConfiguration = initParams.initializationOptions
         ?.extensionConfiguration as extensionConfiguration | undefined;
 
@@ -1244,8 +1241,6 @@ function onMessage(msg: p.Message) {
       } else {
         shutdownRequestAlreadyReceived = true;
         // TODO: recheck logic around init/shutdown...
-        stopWatchingCompilerLog();
-        // TODO: delete bsb watchers
 
         if (pullConfigurationPeriodically != null) {
           clearInterval(pullConfigurationPeriodically);