Make server.findRescriptBinary async

Author: mediremi

server/src/constants.ts

@@ -29,12 +29,6 @@ export let bscBinName = "bsc";
 
 export let nodeModulesBinDir = path.join("node_modules", ".bin");
 
-// can't use the native bsb/rescript since we might need the watcher -w flag, which is only in the JS wrapper
-export let rescriptNodePartialPath = path.join(
-  nodeModulesBinDir,
-  rescriptBinName
-);
-
 export let bsbLock = ".bsb.lock";
 export let bsconfigPartialPath = "bsconfig.json";
 export let rescriptJsonPartialPath = "rescript.json";

server/src/server.ts

@@ -56,16 +56,14 @@ let codeActionsFromDiagnostics: codeActions.filesCodeActions = {};
 // will be properly defined later depending on the mode (stdio/node-rpc)
 let send: (msg: p.Message) => void = (_) => {};
 
-let findRescriptBinary = (projectRootPath: p.DocumentUri | null) =>
-  config.extensionConfiguration.binaryPath == null
-    ? lookup.findFilePathFromProjectRoot(
-        projectRootPath,
-        path.join(c.nodeModulesBinDir, c.rescriptBinName)
-      )
-    : utils.findBinary(
-        config.extensionConfiguration.binaryPath,
-        c.rescriptBinName
-      );
+let findRescriptBinary = async (projectRootPath: p.DocumentUri | null): Promise<string | null> => {
+  if (config.extensionConfiguration.binaryPath != null &&
+    fs.existsSync(path.join(config.extensionConfiguration.binaryPath, "rescript"))) {
+      return path.join(config.extensionConfiguration.binaryPath, "rescript")
+  }
+
+  return utils.findRescriptBinary(projectRootPath)
+}
 
 let createInterfaceRequest = new v.RequestType<
   p.TextDocumentIdentifier,
@@ -305,7 +303,7 @@ let openedFile = async (fileUri: string, fileContent: string) => {
       // TODO: sometime stale .bsb.lock dangling. bsb -w knows .bsb.lock is
       // stale. Use that logic
       // TODO: close watcher when lang-server shuts down
-      if (findRescriptBinary(projectRootPath) != null) {
+      if (await findRescriptBinary(projectRootPath) != null) {
         let payload: clientSentBuildAction = {
           title: c.startBuildAction,
           projectRootPath: projectRootPath,
@@ -1311,7 +1309,7 @@ async function onMessage(msg: p.Message) {
       // TODO: close watcher when lang-server shuts down. However, by Node's
       // default, these subprocesses are automatically killed when this
       // language-server process exits
-      let rescriptBinaryPath = findRescriptBinary(projectRootPath);
+      let rescriptBinaryPath = await findRescriptBinary(projectRootPath);
       if (rescriptBinaryPath != null) {
         let bsbProcess = utils.runBuildWatcherUsingValidBuildPath(
           rescriptBinaryPath,

server/src/utils.ts

@@ -76,27 +76,12 @@ export let findProjectRootOfFile = (
   }
 };
 
-// Check if binaryName exists inside binaryDirPath and return the joined path.
-export let findBinary = (
-  binaryDirPath: p.DocumentUri | null,
-  binaryName: string
-): p.DocumentUri | null => {
-  if (binaryDirPath == null) {
-    return null;
-  }
-  let binaryPath: p.DocumentUri = path.join(binaryDirPath, binaryName);
-  if (fs.existsSync(binaryPath)) {
-    return binaryPath;
-  } else {
-    return null;
-  }
-};
 // If ReScript < 12.0.0-alpha.13, then we want `{project_root}/node_modules/rescript/{c.platformDir}/{binary}`.
 // Otherwise, we want to dynamically import `{project_root}/node_modules/rescript` and from `binPaths` get the relevant binary.
 // We won't know which version is in the project root until we read and parse `{project_root}/node_modules/rescript/package.json`
 let findBinaryAsync = async (
   projectRootPath: p.DocumentUri | null,
-  binary: "bsc.exe" | "rescript-editor-analysis.exe"
+  binary: "bsc.exe" | "rescript-editor-analysis.exe" | "rescript"
 ) => {
   if (config.extensionConfiguration.platformPath != null) {
     return path.join(config.extensionConfiguration.platformPath, binary);
@@ -111,16 +96,22 @@ let findBinaryAsync = async (
   }
 
   let rescriptVersion = null;
+  let rescriptJSWrapperPath = null
   try {
     const rescriptPackageJSONPath = path.join(rescriptDir, "package.json");
     const rescriptPackageJSON = JSON.parse(await fsAsync.readFile(rescriptPackageJSONPath, "utf-8"));
     rescriptVersion = rescriptPackageJSON.version
+    rescriptJSWrapperPath = rescriptPackageJSON.bin.rescript
   } catch (error) {
     return null
   }
 
   let binaryPath: string | null = null
-  if (semver.gte(rescriptVersion, "12.0.0-alpha.13")) {
+  if (binary == "rescript") {
+    // Can't use the native bsb/rescript since we might need the watcher -w
+    // flag, which is only in the JS wrapper
+    binaryPath = path.join(rescriptDir, rescriptJSWrapperPath)
+  } else if (semver.gte(rescriptVersion, "12.0.0-alpha.13")) {
     // TODO: export `binPaths` from `rescript` package so that we don't need to
     // copy the logic for figuring out `target`.
     const target = `${process.platform}-${process.arch}`;
@@ -143,6 +134,9 @@ let findBinaryAsync = async (
   }
 }
 
+export let findRescriptBinary = (projectRootPath: p.DocumentUri | null) =>
+  findBinaryAsync(projectRootPath, "rescript");
+
 export let findBscExeBinary = (projectRootPath: p.DocumentUri | null) =>
   findBinaryAsync(projectRootPath, "bsc.exe");