@saptools/cf-live-trace 0.1.3 → 0.1.5

package/dist/index.js

@@ -461,15 +461,19 @@ async function ensureSshEnabled(target, dependencies = defaultCfDependencies) {
   });
 }
 async function tryStartNodeInspector(target, dependencies = defaultCfDependencies) {
+  const result = await startNodeInspector(target, dependencies);
+  return result.status === "ready";
+}
+async function startNodeInspector(target, dependencies = defaultCfDependencies) {
+  const redactor = createSecretRedactor([target.email, target.password]);
   try {
-    const redactor = createSecretRedactor([target.email, target.password]);
     const stdout = await dependencies.runCf(
       buildCfSshArgs(target.app, target.instanceIndex, ["-c", buildInspectorSignalCommand()]),
       { ...buildRunOptions(target, redactor), timeoutMs: INSPECTOR_SIGNAL_TIMEOUT_MS }
     );
-    return hasInspectorReadyMarker(stdout);
-  } catch {
-    return false;
+    return hasInspectorReadyMarker(stdout) ? { status: "ready" } : { status: "not-ready", ...optionalDetail(summarizeInspectorStartupOutput(stdout)) };
+  } catch (error) {
+    return { status: "not-ready", ...optionalDetail(redactor(formatErrorMessage(error))) };
   }
 }
 async function openInspectorTunnel(target, dependencies = defaultTunnelDependencies) {
@@ -612,6 +616,7 @@ function resolveTunnelAppName(target) {
   return appName;
 }
 async function raceForwardReadiness(handle, dependencies) {
+  const controller = new AbortController();
   let markFailed = () => {
     return;
   };
@@ -622,11 +627,14 @@ async function raceForwardReadiness(handle, dependencies) {
     handle.process.once("exit", markFailed);
     handle.process.once("error", markFailed);
   });
-  const ready = dependencies.waitForLocalPort(handle.localPort, TUNNEL_READY_TIMEOUT_MS);
-  const outcome = await Promise.race([ready, failedEarly]);
-  handle.process.removeListener("exit", markFailed);
-  handle.process.removeListener("error", markFailed);
-  return outcome;
+  const ready = dependencies.waitForLocalPort(handle.localPort, TUNNEL_READY_TIMEOUT_MS, controller.signal);
+  try {
+    return await Promise.race([ready, failedEarly]);
+  } finally {
+    controller.abort();
+    handle.process.removeListener("exit", markFailed);
+    handle.process.removeListener("error", markFailed);
+  }
 }
 function resolveCommand(command) {
   const resolvedBin = command ?? process.env["CF_LIVE_TRACE_CF_BIN"] ?? "cf";
@@ -656,12 +664,23 @@ function extractErrorDetail(error) {
   }
   return error["message"] instanceof Error ? error["message"].message : "";
 }
+function formatErrorMessage(error) {
+  const message = error instanceof Error ? error.message : String(error);
+  return message.trim().length > 0 ? message.trim() : "Unknown error";
+}
 function formatArgs(args) {
   return args.join(" ");
 }
 function hasInspectorReadyMarker(stdout) {
   return stdout.split(/\r?\n/).map((line) => line.trim()).includes("saptools-inspector-ready");
 }
+function summarizeInspectorStartupOutput(stdout) {
+  const markers = stdout.split(/\r?\n/).map((line) => line.trim()).filter((line) => line.startsWith("saptools-inspector-"));
+  return markers.length === 0 ? void 0 : markers.join("; ");
+}
+function optionalDetail(detail) {
+  return detail === void 0 || detail.length === 0 ? {} : { detail };
+}
 function findFreePort() {
   return new Promise((resolve, reject) => {
     const server = createServer();
@@ -679,29 +698,61 @@ function findFreePort() {
     });
   });
 }
-function waitForLocalPort(port, timeoutMs) {
+function waitForLocalPort(port, timeoutMs, signal) {
   const deadline = Date.now() + timeoutMs;
   return new Promise((resolve) => {
+    let activeSocket;
+    let settled = false;
+    let retryTimer;
+    const finish = (ready) => {
+      if (settled) {
+        return;
+      }
+      settled = true;
+      if (retryTimer !== void 0) {
+        clearTimeout(retryTimer);
+      }
+      activeSocket?.destroy();
+      activeSocket = void 0;
+      signal?.removeEventListener("abort", onAbort);
+      resolve(ready);
+    };
+    const onAbort = () => {
+      finish(false);
+    };
     const attempt = () => {
+      if (settled) {
+        return;
+      }
       const socket = netConnect({ host: "127.0.0.1", port });
+      activeSocket = socket;
       socket.once("connect", () => {
         socket.destroy();
-        resolve(true);
+        activeSocket = void 0;
+        finish(true);
       });
       socket.once("error", () => {
-        retryPortProbe(socket, deadline, attempt, resolve);
+        activeSocket = void 0;
+        retryPortProbe(socket, deadline, attempt, finish, (timer) => {
+          retryTimer = timer;
+        });
       });
     };
+    if (signal?.aborted === true) {
+      finish(false);
+      return;
+    }
+    signal?.addEventListener("abort", onAbort, { once: true });
     attempt();
   });
 }
-function retryPortProbe(socket, deadline, attempt, resolve) {
+function retryPortProbe(socket, deadline, attempt, finish, setRetryTimer) {
   socket.destroy();
   if (Date.now() >= deadline) {
-    resolve(false);
+    finish(false);
     return;
   }
-  setTimeout(attempt, TUNNEL_READY_POLL_MS);
+  setRetryTimer(setTimeout(attempt, TUNNEL_READY_POLL_MS));
 }
 function isRecord2(value) {
   return typeof value === "object" && value !== null && !Array.isArray(value);
@@ -816,7 +867,7 @@ var DRAIN_TRANSPORT_BODY_LIMIT = 2e4;
 var defaultDependencies = {
   prepareCfSession,
   ensureSshEnabled,
-  tryStartNodeInspector,
+  tryStartNodeInspector: startNodeInspector,
   openInspectorTunnel,
   connectInspector: connectRuntimeInspector,
   setInterval,
@@ -869,9 +920,11 @@ var LiveTraceSession = class {
     } catch (error) {
       this.log(`Live Trace startup failed for ${this.options.target.app}: ${formatError(error)}`);
       await this.stopRuntimeTrace(false);
+      const startupError = toStartupError(error);
       if (!this.shouldStop()) {
-        this.postState("error", "Runtime HTTP trace could not be started.", false, false);
+        this.postState("error", startupError.stateMessage, false, false);
       }
+      throw startupError;
     }
   }
   async startInspector(options) {
@@ -881,7 +934,7 @@ var LiveTraceSession = class {
       return;
     }
     this.postState("starting-inspector", "Requesting Node Inspector startup.", false, false);
-    await this.dependencies.tryStartNodeInspector(this.options.target);
+    this.reportInspectorStartup(await this.dependencies.tryStartNodeInspector(this.options.target));
     if (this.shouldStop()) {
       return;
     }
@@ -895,8 +948,10 @@ var LiveTraceSession = class {
       return;
     }
     if (tunnel.status !== "ready") {
-      this.postState("error", "Node Inspector is not reachable on 127.0.0.1:9229.", false, false);
-      return;
+      throw new LiveTraceStartupError(
+        "Node Inspector is not reachable on 127.0.0.1:9229.",
+        "Node Inspector is not reachable on 127.0.0.1:9229."
+      );
     }
     this.tunnelHandle = tunnel.handle;
     this.inspectorClient = await this.dependencies.connectInspector(tunnel.handle.localPort);
@@ -967,11 +1022,27 @@ var LiveTraceSession = class {
     this.stopPolling();
     this.consecutiveDrainTimeouts = 0;
     const uninstalled = await this.stopInspectorHook(uninstallRuntimeHook);
-    await this.inspectorClient?.close();
+    await this.closeInspectorClient();
+    this.stopTunnel();
+    return uninstalled;
+  }
+  async closeInspectorClient() {
+    const client = this.inspectorClient;
     this.inspectorClient = void 0;
-    this.tunnelHandle?.stop();
+    try {
+      await client?.close();
+    } catch (error) {
+      this.log(`Live Trace inspector close failed for ${this.options.target.app}: ${formatError(error)}`);
+    }
+  }
+  stopTunnel() {
+    const tunnel = this.tunnelHandle;
     this.tunnelHandle = void 0;
-    return uninstalled;
+    try {
+      tunnel?.stop();
+    } catch (error) {
+      this.log(`Live Trace tunnel cleanup failed for ${this.options.target.app}: ${formatError(error)}`);
+    }
   }
   async stopInspectorHook(uninstallRuntimeHook) {
     if (this.inspectorClient === void 0) {
@@ -1015,6 +1086,21 @@ var LiveTraceSession = class {
   log(message) {
     this.options.onLog?.(message);
   }
+  reportInspectorStartup(result) {
+    const normalized = normalizeInspectorStartupResult(result);
+    if (normalized.status === "ready") {
+      return;
+    }
+    const detail = normalized.detail === void 0 ? "" : `: ${normalized.detail}`;
+    this.log(`Node Inspector startup was not confirmed for ${this.options.target.app}${detail}`);
+  }
+};
+var LiveTraceStartupError = class extends Error {
+  constructor(message, stateMessage, cause) {
+    super(message, cause === void 0 ? void 0 : { cause });
+    this.stateMessage = stateMessage;
+  }
+  stateMessage;
 };
 function resolveStartOptions(options) {
   return {
@@ -1037,6 +1123,19 @@ function isEvaluateTimeout(error) {
   const message = error instanceof Error ? error.message : String(error);
   return message.includes("Runtime.evaluate timed out");
 }
+function toStartupError(error) {
+  if (error instanceof LiveTraceStartupError) {
+    return error;
+  }
+  return new LiveTraceStartupError(
+    "Runtime HTTP trace could not be started.",
+    "Runtime HTTP trace could not be started.",
+    error
+  );
+}
+function normalizeInspectorStartupResult(result) {
+  return typeof result === "boolean" ? { status: result ? "ready" : "not-ready" } : result;
+}
 function formatError(error) {
   const message = error instanceof Error ? error.message : String(error);
   return message.trim().length > 0 ? message.trim() : "Unknown error";
@@ -1057,6 +1156,7 @@ export {
   openInspectorTunnel,
   parseDrainResult,
   prepareCfSession,
+  startNodeInspector,
   truncatePreview,
   tryStartNodeInspector
 };