fix(Perf): better microservices launch

Author: JulienChampagnol

app/stores/back.js

@@ -92,17 +92,11 @@ export const useBackStore = defineStore("back", {
         additionalProperties: true,
       };
       const params = { COMMAND_BACK, NUXT_ROOT_PATH, args };
-      const start = Date.now()
-      console.log("[GEODE] PERF test begin launch", start)
       console.log("[GEODE] params", params);
       return appStore.request(
         { schema, params },
         {
           response_function: (response) => {
-            const end = Date.now()
-            console.log("[GEODE] PERF test end launch", end)
-            console.log("[GEODE] PERF test diff", end - start)
-
             console.log(`[GEODE] Back launched on port ${response.port}`);
             this.default_local_port = response.port;
           },

app/stores/viewer.js

@@ -143,16 +143,10 @@ export const useViewerStore = defineStore(
 
       const params = { COMMAND_VIEWER, NUXT_ROOT_PATH, args };
       console.log("[VIEWER] params", params);
-      const start = Date.now()
-      console.log("[VIEWER] PERF test begin launch", start)
       return appStore.request(
         { schema, params },
         {
           response_function: (response) => {
-            const end = Date.now()
-            console.log("[VIEWER] PERF end launch", end)
-            console.log("[VIEWER] PERF test diff", end - start)
-
             console.log(`[VIEWER] Viewer launched on port ${response.port}`);
             default_local_port.value = response.port;
           },

app/utils/local/microservices.js

@@ -8,13 +8,14 @@ import back_schemas from "@geode/opengeodeweb-back/opengeodeweb_back_schemas.jso
 import { getPort } from "get-port-please";
 import pTimeout from "p-timeout";
 
-// Local imports
+// Local imports 
 import { commandExistsSync, waitForReady } from "./scripts.js";
 import { microservicesMetadatasPath, projectMicroservices } from "./cleanup.js";
 import { executablePath } from "./path.js";
 
-const DEFAULT_TIMEOUT_SECONDS = 60;
 const MILLISECONDS_PER_SECOND = 1000;
+const DEFAULT_TIMEOUT_SECONDS = 30;
+const MAX_ERROR_BUFFER_BYTES = 64 * 1024;
 
 function getAvailablePort() {
   return getPort({
@@ -23,40 +24,46 @@ function getAvailablePort() {
   });
 }
 
+function resolveCommand(execPath, execName) {
+  const command = commandExistsSync(execName)
+    ? execName
+    : executablePath(execPath, execName);
+  return command;
+}
+
 async function runScript(
   execPath,
   execName,
   args,
   expectedResponse,
   timeoutSeconds = DEFAULT_TIMEOUT_SECONDS,
 ) {
-  let command = "";
-  if (commandExistsSync(execName)) {
-    command = execName;
-  } else {
-    command = path.join(executablePath(execPath, execName));
-  }
+  const command = resolveCommand(execPath, execName);
   console.log("runScript", command, args);
 
-  const child = child_process.spawn(process.platform === "win32" ? command : `"${command}"`, args, {
-    encoding: "utf8",
-    shell: true,
+  const child = child_process.spawn(command, args, {
+    stdio: ["ignore", "pipe", "pipe"],
   });
-  child.stdout.on("data", (data) => console.log(`[${execName}] ${data.toString()}`));
-  child.stderr.on("data", (data) => console.log(`[${execName}] ${data.toString()}`));
 
-  child.on("close", (code) => console.log(`[${execName}] exited with code ${code}`));
-  child.on("kill", () => {
-    console.log(`[${execName}] process killed`);
-  });
   child.name = command.replace(/^.*[\\/]/u, "");
 
+  child.on("spawn", () => {
+    console.log(`[${child.name}] spawned, pid=${child.pid}`);
+  });
+
+  const controller = new AbortController();
+  const timer = setTimeout(
+    () => controller.abort(),
+    timeoutSeconds * MILLISECONDS_PER_SECOND,
+  );
+  if (typeof timer.unref === "function") timer.unref();
+
   try {
-    return await pTimeout(waitForReady(child, expectedResponse), {
-      milliseconds: timeoutSeconds * MILLISECONDS_PER_SECOND,
-      message: `Timed out after ${timeoutSeconds} seconds`,
-    });
+    const result = await waitForReady(child, expectedResponse, controller.signal);
+    clearTimeout(timer);
+    return result;
   } catch (error) {
+    clearTimeout(timer);
     child.kill();
     throw error;
   }
@@ -73,11 +80,11 @@ async function runBack(execName, execPath, args = {}) {
   }
   const port = await getAvailablePort();
   const backArgs = [
-    `--port ${port}`,
-    `--data_folder_path ${projectFolderPath}`,
-    `--upload_folder_path ${uploadFolderPath}`,
-    `--allowed_origin http://localhost:*`,
-    `--timeout ${0}`,
+    "--port", String(port),
+    "--data_folder_path", projectFolderPath,
+    "--upload_folder_path", uploadFolderPath,
+    "--allowed_origin", "http://localhost:*",
+    "--timeout", "0",
   ];
   if (process.env.NODE_ENV === "development" || !process.env.NODE_ENV) {
     backArgs.push("--debug");
@@ -94,9 +101,9 @@ async function runViewer(execName, execPath, args = {}) {
   }
   const port = await getAvailablePort();
   const viewerArgs = [
-    `--port ${port}`,
-    `--data_folder_path ${projectFolderPath}`,
-    `--timeout ${0}`,
+    "--port", String(port),
+    "--data_folder_path", projectFolderPath,
+    "--timeout", "0",
   ];
   console.log("runViewer", execPath, execName, viewerArgs);
   await runScript(execPath, execName, viewerArgs, "Starting factory");

app/utils/local/scripts.js

@@ -1,11 +1,13 @@
 // Node imports
-import child_process from "node:child_process";
 import fs from "node:fs";
 import { on } from "node:events";
 import path from "node:path";
+import readline from "node:readline";
 
 import { appMode } from "./app_mode.js";
 
+const MAX_ERROR_BUFFER_BYTES = 64 * 1024;
+
 function commandExistsSync(execName) {
   const envPath = process.env.PATH || "";
   return envPath.split(path.delimiter).some((dir) => {
@@ -14,13 +16,67 @@ function commandExistsSync(execName) {
   });
 }
 
-async function waitForReady(child, expectedResponse) {
-  for await (const [data] of on(child.stdout, "data")) {
-    if (data.toString().includes(expectedResponse)) {
-      return child;
-    }
-  }
-  throw new Error("Process closed before signal");
+function waitForReady(child, expectedResponse, signal) {
+  return new Promise((resolve, reject) => {
+    const readlineStdout = readline.createInterface({ input: child.stdout });
+    const readlineStderr = readline.createInterface({ input: child.stderr });
+
+    let recentOutput = "";
+    const recordOutput = (line) => {
+      recentOutput = (recentOutput + line + "\n").slice(-MAX_ERROR_BUFFER_BYTES);
+    };
+
+    const cleanup = () => {
+      readlineStdout.removeAllListeners();
+      readlineStdout.close();
+      readlineStderr.removeAllListeners();
+      readlineStderr.close();
+      child.removeListener("error", onError);
+      child.removeListener("close", onClose);
+      if (signal) signal.removeEventListener("abort", onAbort);
+    };
+
+    const onLine = (line) => {
+      console.log(`[${child.name}] ${line}`);
+      recordOutput(line);
+      if (line.includes(expectedResponse)) {
+        cleanup();
+        resolve(child);
+      }
+    };
+
+    const onErrLine = (line) => {
+      console.log(`[${child.name}] ${line}`);
+      recordOutput(line);
+    };
+
+    const onError = (err) => {
+      cleanup();
+      reject(err);
+    };
+
+    const onClose = (code) => {
+      console.log(`[${child.name}] exited with code ${code}`);
+      cleanup();
+      reject(
+        new Error(
+          `[${child.name}] exited with code ${code} before becoming ready.` +
+          (recentOutput ? `\nRecent output:\n${recentOutput}` : ""),
+        ),
+      );
+    };
+
+    const onAbort = () => {
+      cleanup();
+      reject(new Error(`[${child.name}] timed out waiting for "${expectedResponse}"`));
+    };
+
+    readlineStdout.on("line", onLine);
+    readlineStderr.on("line", onErrLine);
+    child.once("error", onError);
+    child.once("close", onClose);
+    if (signal) signal.addEventListener("abort", onAbort, { once: true });
+  })
 }
 
 async function waitNuxt(nuxtProcess) {