@saptools/cf-debugger 0.1.7 → 0.1.9

package/dist/index.js

@@ -18,12 +18,67 @@ var CfDebuggerError = class extends Error {
 import { mkdir as mkdir3, rm } from "fs/promises";
 import process4 from "process";
 
+// src/cloud-foundry/commands.ts
+import { execFile as execFile2 } from "child_process";
+import { promisify as promisify2 } from "util";
+
+// src/regions.ts
+var REGION_API_ENDPOINTS = {
+  ae01: "https://api.cf.ae01.hana.ondemand.com",
+  ap01: "https://api.cf.ap01.hana.ondemand.com",
+  ap10: "https://api.cf.ap10.hana.ondemand.com",
+  ap11: "https://api.cf.ap11.hana.ondemand.com",
+  ap12: "https://api.cf.ap12.hana.ondemand.com",
+  ap20: "https://api.cf.ap20.hana.ondemand.com",
+  ap21: "https://api.cf.ap21.hana.ondemand.com",
+  ap30: "https://api.cf.ap30.hana.ondemand.com",
+  br10: "https://api.cf.br10.hana.ondemand.com",
+  br20: "https://api.cf.br20.hana.ondemand.com",
+  br30: "https://api.cf.br30.hana.ondemand.com",
+  ca10: "https://api.cf.ca10.hana.ondemand.com",
+  ca20: "https://api.cf.ca20.hana.ondemand.com",
+  ch20: "https://api.cf.ch20.hana.ondemand.com",
+  eu10: "https://api.cf.eu10.hana.ondemand.com",
+  eu11: "https://api.cf.eu11.hana.ondemand.com",
+  eu12: "https://api.cf.eu12.hana.ondemand.com",
+  eu20: "https://api.cf.eu20.hana.ondemand.com",
+  eu21: "https://api.cf.eu21.hana.ondemand.com",
+  eu30: "https://api.cf.eu30.hana.ondemand.com",
+  eu31: "https://api.cf.eu31.hana.ondemand.com",
+  in30: "https://api.cf.in30.hana.ondemand.com",
+  jp10: "https://api.cf.jp10.hana.ondemand.com",
+  jp20: "https://api.cf.jp20.hana.ondemand.com",
+  jp30: "https://api.cf.jp30.hana.ondemand.com",
+  kr30: "https://api.cf.kr30.hana.ondemand.com",
+  us10: "https://api.cf.us10.hana.ondemand.com",
+  us11: "https://api.cf.us11.hana.ondemand.com",
+  us20: "https://api.cf.us20.hana.ondemand.com",
+  us21: "https://api.cf.us21.hana.ondemand.com",
+  us30: "https://api.cf.us30.hana.ondemand.com",
+  us31: "https://api.cf.us31.hana.ondemand.com"
+};
+function resolveApiEndpoint(regionKey, override) {
+  if (override !== void 0 && override !== "") {
+    return override;
+  }
+  const endpoint = REGION_API_ENDPOINTS[regionKey];
+  if (endpoint === void 0) {
+    throw new Error(
+      `Unknown region key: ${regionKey}. Pass \`apiEndpoint\` explicitly to override.`
+    );
+  }
+  return endpoint;
+}
+function listKnownRegionKeys() {
+  return Object.keys(REGION_API_ENDPOINTS);
+}
+
 // src/cloud-foundry/execute.ts
 import { execFile } from "child_process";
 import { promisify } from "util";
 var execFileAsync = promisify(execFile);
 var MAX_BUFFER = 16 * 1024 * 1024;
-var CF_CLI_TIMEOUT_MS = 3e4;
+var DEFAULT_CF_COMMAND_TIMEOUT_MS = 18e4;
 var REDACTED_ARG = "<redacted>";
 function buildEnv(cfHome) {
   return { ...process.env, CF_HOME: cfHome };
@@ -46,7 +101,7 @@ function formatArgsForError(args) {
   }
   return args.map((arg, index) => index === 0 ? arg : REDACTED_ARG).join(" ");
 }
-async function runCf(args, context, timeoutMs = CF_CLI_TIMEOUT_MS) {
+async function runCf(args, context, timeoutMs = DEFAULT_CF_COMMAND_TIMEOUT_MS) {
   try {
     const { stdout } = await execFileAsync(resolveBin(context), [...args], {
       env: buildEnv(context.cfHome),
@@ -68,8 +123,9 @@ async function runCf(args, context, timeoutMs = CF_CLI_TIMEOUT_MS) {
 }
 
 // src/cloud-foundry/commands.ts
-var CF_RESTART_TIMEOUT_MS = 12e4;
+var execFileAsync2 = promisify2(execFile2);
 var CF_AUTH_MAX_ATTEMPTS = 3;
+var CURRENT_TARGET_TIMEOUT_MS = 3e4;
 async function cfApi(apiEndpoint, context) {
   await runCf(["api", apiEndpoint], context);
 }
@@ -133,13 +189,74 @@ async function cfEnableSsh(appName, context) {
   }
 }
 async function cfRestartApp(appName, context) {
-  await runCf(["restart", appName], context, CF_RESTART_TIMEOUT_MS);
+  await runCf(["restart", appName], context);
+}
+async function readCurrentCfTarget(options = {}) {
+  try {
+    const { stdout } = await execFileAsync2(options.command ?? process.env["CF_DEBUGGER_CF_BIN"] ?? "cf", ["target"], {
+      env: options.env ?? process.env,
+      maxBuffer: 16 * 1024 * 1024,
+      timeout: options.timeoutMs ?? CURRENT_TARGET_TIMEOUT_MS
+    });
+    return parseCurrentCfTarget(stdout);
+  } catch (error) {
+    const message = error instanceof Error ? error.message : String(error);
+    throw new CfDebuggerError("CF_TARGET_FAILED", `cf target failed: ${message}`);
+  }
+}
+function parseCurrentCfTarget(stdout) {
+  const fields = parseTargetFields(stdout);
+  const apiEndpoint = fields.get("api endpoint");
+  const org = fields.get("org");
+  const space = fields.get("space");
+  if (!isPresent(apiEndpoint) || !isPresent(org) || !isPresent(space)) {
+    return void 0;
+  }
+  const region = regionKeyForApiEndpoint(apiEndpoint);
+  return {
+    apiEndpoint,
+    ...region === void 0 ? {} : { region },
+    org,
+    space
+  };
+}
+function requireCurrentCfRegion(target, instruction = "Pass --region explicitly.") {
+  if (target.region !== void 0) {
+    return target.region;
+  }
+  throw new CfDebuggerError(
+    "CF_TARGET_FAILED",
+    `Current CF API endpoint "${target.apiEndpoint}" does not match a known SAP region. ${instruction}`
+  );
+}
+function parseTargetFields(stdout) {
+  return new Map(
+    stdout.split("\n").map((line) => {
+      const separator = line.indexOf(":");
+      if (separator < 0) {
+        return void 0;
+      }
+      return [
+        line.slice(0, separator).trim().toLowerCase(),
+        line.slice(separator + 1).trim()
+      ];
+    }).filter((field) => field !== void 0)
+  );
+}
+function regionKeyForApiEndpoint(apiEndpoint) {
+  const normalized = normalizeApiEndpoint(apiEndpoint);
+  return listKnownRegionKeys().find((key) => normalizeApiEndpoint(resolveApiEndpoint(key)) === normalized);
+}
+function normalizeApiEndpoint(apiEndpoint) {
+  return apiEndpoint.trim().replace(/\/+$/, "").toLowerCase();
+}
+function isPresent(value) {
+  return value !== void 0 && value.length > 0;
 }
 
 // src/cloud-foundry/ssh.ts
 import { spawn } from "child_process";
-var CF_SSH_SIGNAL_TIMEOUT_MS = 15e3;
-async function cfSshOneShot(appName, command, context) {
+async function cfSshOneShot(appName, command, context, timeoutMs = DEFAULT_CF_COMMAND_TIMEOUT_MS) {
   return await new Promise((resolve) => {
     const child = spawn(resolveBin(context), ["ssh", appName, "-c", command], {
       env: buildEnv(context.cfHome),
@@ -156,18 +273,20 @@ async function cfSshOneShot(appName, command, context) {
         child.kill();
       } catch {
       }
-      resolve({ exitCode: null, stderr: stderrBuf });
-    }, CF_SSH_SIGNAL_TIMEOUT_MS);
+      resolve({ exitCode: null, stderr: stderrBuf, timedOutAfterMs: timeoutMs });
+    }, timeoutMs);
     child.stderr.on("data", (data) => {
       stderrBuf += data.toString();
     });
-    child.on("close", (code) => {
+    child.on("close", (code, signal) => {
       if (settled) {
         return;
       }
       settled = true;
       clearTimeout(timeout);
-      resolve({ exitCode: code, stderr: stderrBuf });
+      resolve(
+        signal === null ? { exitCode: code, stderr: stderrBuf } : { exitCode: code, stderr: stderrBuf, signal }
+      );
     });
     child.on("error", (err) => {
       if (settled) {
@@ -214,13 +333,13 @@ function sessionCfHomeDir(sessionId) {
 }
 
 // src/network/ports.ts
-import { execFile as execFile2 } from "child_process";
+import { execFile as execFile3 } from "child_process";
 import { createConnection, createServer } from "net";
-import { promisify as promisify2 } from "util";
-var execFileAsync2 = promisify2(execFile2);
+import { promisify as promisify3 } from "util";
+var execFileAsync3 = promisify3(execFile3);
 async function findListeningPidsWithNetstat(port) {
   try {
-    const { stdout } = await execFileAsync2("netstat", ["-ano"]);
+    const { stdout } = await execFileAsync3("netstat", ["-ano"]);
     const pids = /* @__PURE__ */ new Set();
     for (const line of stdout.split("\n")) {
       if (!line.includes(`:${port.toString()}`) || !line.includes("LISTENING")) {
@@ -243,7 +362,7 @@ async function findListeningPidsWithNetstat(port) {
 }
 async function findListeningPidsWithLsof(port) {
   try {
-    const { stdout } = await execFileAsync2("lsof", ["-nP", "-t", "-i", `tcp:${port.toString()}`, "-sTCP:LISTEN"]);
+    const { stdout } = await execFileAsync3("lsof", ["-nP", "-t", "-i", `tcp:${port.toString()}`, "-sTCP:LISTEN"]);
     return stdout.trim().split("\n").filter((line) => line.length > 0).map((line) => Number.parseInt(line, 10)).filter((pid) => !Number.isNaN(pid));
   } catch {
     return [];
@@ -309,7 +428,7 @@ async function killProcessOnPort(port) {
       const pids = await findListeningPidsWithNetstat(port);
       for (const pid of pids) {
         try {
-          await execFileAsync2("taskkill", ["/F", "/PID", pid.toString()]);
+          await execFileAsync3("taskkill", ["/F", "/PID", pid.toString()]);
         } catch {
         }
       }
@@ -318,7 +437,7 @@ async function killProcessOnPort(port) {
     return;
   }
   try {
-    const { stdout } = await execFileAsync2("lsof", ["-t", "-i", `tcp:${portStr}`]);
+    const { stdout } = await execFileAsync3("lsof", ["-t", "-i", `tcp:${portStr}`]);
     const lines = stdout.trim().split("\n").filter((line) => line.length > 0);
     for (const line of lines) {
       const pid = Number.parseInt(line, 10);
@@ -334,57 +453,6 @@ async function killProcessOnPort(port) {
   }
 }
 
-// src/regions.ts
-var REGION_API_ENDPOINTS = {
-  ae01: "https://api.cf.ae01.hana.ondemand.com",
-  ap01: "https://api.cf.ap01.hana.ondemand.com",
-  ap10: "https://api.cf.ap10.hana.ondemand.com",
-  ap11: "https://api.cf.ap11.hana.ondemand.com",
-  ap12: "https://api.cf.ap12.hana.ondemand.com",
-  ap20: "https://api.cf.ap20.hana.ondemand.com",
-  ap21: "https://api.cf.ap21.hana.ondemand.com",
-  ap30: "https://api.cf.ap30.hana.ondemand.com",
-  br10: "https://api.cf.br10.hana.ondemand.com",
-  br20: "https://api.cf.br20.hana.ondemand.com",
-  br30: "https://api.cf.br30.hana.ondemand.com",
-  ca10: "https://api.cf.ca10.hana.ondemand.com",
-  ca20: "https://api.cf.ca20.hana.ondemand.com",
-  ch20: "https://api.cf.ch20.hana.ondemand.com",
-  eu10: "https://api.cf.eu10.hana.ondemand.com",
-  eu11: "https://api.cf.eu11.hana.ondemand.com",
-  eu12: "https://api.cf.eu12.hana.ondemand.com",
-  eu20: "https://api.cf.eu20.hana.ondemand.com",
-  eu21: "https://api.cf.eu21.hana.ondemand.com",
-  eu30: "https://api.cf.eu30.hana.ondemand.com",
-  eu31: "https://api.cf.eu31.hana.ondemand.com",
-  in30: "https://api.cf.in30.hana.ondemand.com",
-  jp10: "https://api.cf.jp10.hana.ondemand.com",
-  jp20: "https://api.cf.jp20.hana.ondemand.com",
-  jp30: "https://api.cf.jp30.hana.ondemand.com",
-  kr30: "https://api.cf.kr30.hana.ondemand.com",
-  us10: "https://api.cf.us10.hana.ondemand.com",
-  us11: "https://api.cf.us11.hana.ondemand.com",
-  us20: "https://api.cf.us20.hana.ondemand.com",
-  us21: "https://api.cf.us21.hana.ondemand.com",
-  us30: "https://api.cf.us30.hana.ondemand.com",
-  us31: "https://api.cf.us31.hana.ondemand.com"
-};
-function resolveApiEndpoint(regionKey, override) {
-  if (override !== void 0 && override !== "") {
-    return override;
-  }
-  const endpoint = REGION_API_ENDPOINTS[regionKey];
-  if (endpoint === void 0) {
-    throw new Error(
-      `Unknown region key: ${regionKey}. Pass \`apiEndpoint\` explicitly to override.`
-    );
-  }
-  return endpoint;
-}
-function listKnownRegionKeys() {
-  return Object.keys(REGION_API_ENDPOINTS);
-}
-
 // src/session-state/store.ts
 import { randomUUID } from "crypto";
 import { mkdir as mkdir2, readFile, rename, writeFile } from "fs/promises";
@@ -679,7 +747,7 @@ async function removeSession(sessionId) {
 }
 
 // src/debug-session/constants.ts
-var DEFAULT_TUNNEL_READY_TIMEOUT_MS = 3e4;
+var DEFAULT_TUNNEL_READY_TIMEOUT_MS = 18e4;
 var POST_USR1_DELAY_MS = 300;
 var PORT_CLEANUP_DELAY_MS = 600;
 var CHILD_SIGTERM_GRACE_MS = 2e3;
@@ -742,6 +810,19 @@ async function killProcessGroupOrProc(child, timeoutMs = CHILD_SIGTERM_GRACE_MS)
 }
 
 // src/debug-session/start.ts
+function signalFailureDetail(result) {
+  if (result.timedOutAfterMs !== void 0) {
+    return `timed out after ${(result.timedOutAfterMs / 1e3).toString()}s`;
+  }
+  const stderr = result.stderr.trim();
+  if (stderr.length > 0) {
+    return stderr;
+  }
+  if (result.signal !== void 0) {
+    return `terminated by signal ${result.signal}`;
+  }
+  return `exit code ${String(result.exitCode)}`;
+}
 function checkAbort(signal) {
   if (signal?.aborted) {
     throw new CfDebuggerError("ABORTED", "Operation aborted by caller");
@@ -801,10 +882,9 @@ async function signalRemoteNode(options, context, sessionId, emit) {
     if (signalResult.exitCode === 0) {
       return;
     }
-    const detail = signalResult.stderr.trim().length > 0 ? signalResult.stderr.trim() : `exit code ${String(signalResult.exitCode)}`;
     throw new CfDebuggerError(
       "USR1_SIGNAL_FAILED",
-      `Failed to send SIGUSR1 to the Node.js process on ${options.app}: ${detail}`,
+      `Failed to send SIGUSR1 to the Node.js process on ${options.app}: ${signalFailureDetail(signalResult)}`,
       signalResult.stderr
     );
   }
@@ -831,10 +911,9 @@ async function retryRemoteSignal(options, context, sessionId, emit) {
   if (retrySignalResult.exitCode === 0) {
     return;
   }
-  const detail = retrySignalResult.stderr.trim().length > 0 ? retrySignalResult.stderr.trim() : `exit code ${String(retrySignalResult.exitCode)}`;
   throw new CfDebuggerError(
     "USR1_SIGNAL_FAILED",
-    `Failed to send SIGUSR1 to the Node.js process on ${options.app} after enabling SSH: ${detail}`,
+    `Failed to send SIGUSR1 to the Node.js process on ${options.app} after enabling SSH: ${signalFailureDetail(retrySignalResult)}`,
     retrySignalResult.stderr
   );
 }
@@ -1036,6 +1115,9 @@ export {
   getSession,
   listKnownRegionKeys,
   listSessions,
+  parseCurrentCfTarget,
+  readCurrentCfTarget,
+  requireCurrentCfRegion,
   resolveApiEndpoint,
   sessionKeyString,
   startDebugger,