@saptools/cf-debugger 0.1.8 → 0.1.10

package/dist/cli.js

@@ -4,9 +4,60 @@
 import process6 from "process";
 import { Command } from "commander";
 
-// src/debug-session/start.ts
-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/types.ts
 var CfDebuggerError = class extends Error {
@@ -72,7 +123,9 @@ async function runCf(args, context, timeoutMs = DEFAULT_CF_COMMAND_TIMEOUT_MS) {
 }
 
 // src/cloud-foundry/commands.ts
+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);
 }
@@ -138,6 +191,68 @@ async function cfEnableSsh(appName, context) {
 async function cfRestartApp(appName, context) {
   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";
@@ -197,6 +312,10 @@ function spawnSshTunnel(appName, localPort, remotePort, context) {
   });
 }
 
+// src/debug-session/start.ts
+import { mkdir as mkdir3, rm } from "fs/promises";
+import process4 from "process";
+
 // src/paths.ts
 import { homedir } from "os";
 import { join } from "path";
@@ -218,13 +337,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")) {
@@ -247,7 +366,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 [];
@@ -313,7 +432,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 {
         }
       }
@@ -322,7 +441,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);
@@ -338,54 +457,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;
-}
-
 // src/session-state/store.ts
 import { randomUUID } from "crypto";
 import { mkdir as mkdir2, readFile, rename, writeFile } from "fs/promises";
@@ -1084,11 +1155,23 @@ function logStatus(verbose, status, message) {
 `);
   }
 }
-async function handleStart(opts) {
-  const region = readRequiredOption(opts.region, "--region");
-  const org = readRequiredOption(opts.org, "--org");
-  const space = readRequiredOption(opts.space, "--space");
-  const app = readRequiredOption(opts.app, "--app");
+function mergeSelector(selector, opts) {
+  if (selector === void 0) {
+    return opts;
+  }
+  const parts = selector.split("/");
+  if (parts.length === 4) {
+    return { ...opts, region: opts.region ?? parts[0], org: opts.org ?? parts[1], space: opts.space ?? parts[2], app: opts.app ?? parts[3] };
+  }
+  if (parts.length === 1) {
+    return { ...opts, app: opts.app ?? parts[0] };
+  }
+  throw new CfDebuggerError("UNSAFE_INPUT", "Invalid app selector format. Expected <app> or <region>/<org>/<space>/<app>.");
+}
+async function handleStart(selector, rawOpts) {
+  const opts = mergeSelector(selector, rawOpts);
+  const app = readRequiredOption(opts.app, "--app or selector");
+  const key = await resolveSessionKey({ ...opts, app });
   const verbose = opts.verbose ?? false;
   const preferredPort = parseOptionalPort(opts.port);
   const tunnelReadyTimeoutMs = parseOptionalTimeout(opts.timeout);
@@ -1109,9 +1192,9 @@ Aborting startup for ${app}...
   let handle;
   try {
     handle = await startDebugger({
-      region,
-      org,
-      space,
+      region: key.region,
+      org: key.org,
+      space: key.space,
       app,
       verbose,
       signal: abortController.signal,
@@ -1126,7 +1209,7 @@ Aborting startup for ${app}...
     process6.off("SIGTERM", startupSigterm);
   }
   process6.stdout.write(
-    `Debugger ready for ${app} (${region}/${org}/${space}).
+    `Debugger ready for ${app} (${key.region}/${key.org}/${key.space}).
   Local port:  ${handle.session.localPort.toString()}
   Remote port: ${handle.session.remotePort.toString()}
   Session id:  ${handle.session.sessionId}
@@ -1164,25 +1247,68 @@ Stopping debugger for ${app}...
   await dispose();
   process6.exit(code ?? 0);
 }
-function resolveKeyFromOpts(opts) {
-  if (opts.region !== void 0 && opts.org !== void 0 && opts.space !== void 0 && opts.app !== void 0) {
+function hasText(value) {
+  return optionalText(value) !== void 0;
+}
+function optionalText(value) {
+  const trimmed = value?.trim();
+  return trimmed === void 0 || trimmed.length === 0 ? void 0 : trimmed;
+}
+function currentCfOptions() {
+  const command = process6.env["CF_DEBUGGER_CF_BIN"];
+  return command === void 0 ? void 0 : { command };
+}
+async function resolveSessionKey(opts) {
+  const app = readRequiredOption(opts.app, "--app or selector");
+  const region = optionalText(opts.region);
+  const org = optionalText(opts.org);
+  const space = optionalText(opts.space);
+  if (region !== void 0 && org !== void 0 && space !== void 0) {
     return {
-      region: opts.region,
-      org: opts.org,
-      space: opts.space,
-      app: opts.app
+      region,
+      org,
+      space,
+      app
     };
   }
-  return void 0;
+  const current = await readCurrentCfTarget(currentCfOptions()).catch((error) => {
+    throw new CfDebuggerError(
+      "CF_TARGET_FAILED",
+      "No current CF target found. Run `cf target -o <org> -s <space>` or pass --region/--org/--space.",
+      error instanceof Error ? error.message : String(error)
+    );
+  });
+  if (current === void 0) {
+    throw new CfDebuggerError(
+      "CF_TARGET_FAILED",
+      "No current CF target found. Run `cf target -o <org> -s <space>` or pass --region/--org/--space."
+    );
+  }
+  return {
+    region: region ?? requireCurrentCfRegion(current),
+    org: org ?? current.org,
+    space: space ?? current.space,
+    app
+  };
 }
-async function handleStop(opts) {
+async function resolveOptionalSessionKey(opts) {
+  if (!hasText(opts.app)) {
+    if (hasText(opts.region) || hasText(opts.org) || hasText(opts.space)) {
+      readRequiredOption(opts.app, "--app");
+    }
+    return void 0;
+  }
+  return await resolveSessionKey(opts);
+}
+async function handleStop(selector, rawOpts) {
+  const opts = mergeSelector(selector, rawOpts);
   if (opts.all === true) {
     const count = await stopAllDebuggers();
     process6.stdout.write(`Stopped ${count.toString()} session(s).
 `);
     return;
   }
-  const key = resolveKeyFromOpts(opts);
+  const key = await resolveOptionalSessionKey(opts);
   const result = await stopDebugger({
     ...opts.sessionId === void 0 ? {} : { sessionId: opts.sessionId },
     ...key === void 0 ? {} : { key }
@@ -1201,30 +1327,26 @@ async function handleList() {
   process6.stdout.write(`${JSON.stringify(sessions, null, 2)}
 `);
 }
-async function handleStatus(opts) {
-  const session = await getSession({
-    region: opts.region,
-    org: opts.org,
-    space: opts.space,
-    app: opts.app
-  });
+async function handleStatus(selector, rawOpts) {
+  const opts = mergeSelector(selector, rawOpts);
+  const session = await getSession(await resolveSessionKey(opts));
   process6.stdout.write(`${JSON.stringify(session ?? null, null, 2)}
 `);
 }
 async function main(argv) {
   const program = new Command();
   program.name("cf-debugger").description("Open an SSH debug tunnel to a SAP BTP Cloud Foundry app's Node.js inspector");
-  program.command("start").description("Open a debug tunnel for one app").requiredOption("--region <key>", "CF region key (e.g. eu10)").requiredOption("--org <name>", "CF org name").requiredOption("--space <name>", "CF space name").requiredOption("--app <name>", "CF app name").option("--port <number>", "Preferred local port (auto-assigned if omitted)").option("--timeout <seconds>", "Tunnel-ready timeout in seconds (default: 180)").option("--verbose", "Print status transitions", false).action(async (opts) => {
-    await handleStart(opts);
+  program.command("start").description("Open a debug tunnel for one app").argument("[selector]", "Optional app selector: `<app>` or `region/org/space/app`").option("--region <key>", "CF region key (default: current cf target)").option("--org <name>", "CF org name (default: current cf target)").option("--space <name>", "CF space name (default: current cf target)").option("--app <name>", "CF app name").option("--port <number>", "Preferred local port (auto-assigned if omitted)").option("--timeout <seconds>", "Tunnel-ready timeout in seconds (default: 180)").option("--verbose", "Print status transitions", false).action(async (selector, opts) => {
+    await handleStart(selector, opts);
   });
-  program.command("stop").description("Stop one session (by key or id) or all sessions with --all").option("--region <key>").option("--org <name>").option("--space <name>").option("--app <name>").option("--session-id <id>").option("--all", "Stop every active session", false).action(async (opts) => {
-    await handleStop(opts);
+  program.command("stop").description("Stop one session (by key or id) or all sessions with --all").argument("[selector]", "Optional app selector: `<app>` or `region/org/space/app`").option("--region <key>").option("--org <name>").option("--space <name>").option("--app <name>").option("--session-id <id>").option("--all", "Stop every active session", false).action(async (selector, opts) => {
+    await handleStop(selector, opts);
   });
   program.command("list").description("Print every active debugger session as JSON").action(async () => {
     await handleList();
   });
-  program.command("status").description("Print one session by key as JSON (null if not active)").requiredOption("--region <key>").requiredOption("--org <name>").requiredOption("--space <name>").requiredOption("--app <name>").action(async (opts) => {
-    await handleStatus(opts);
+  program.command("status").description("Print one session by key as JSON (null if not active)").argument("[selector]", "Optional app selector: `<app>` or `region/org/space/app`").option("--region <key>").option("--org <name>").option("--space <name>").option("--app <name>").action(async (selector, opts) => {
+    await handleStatus(selector, opts);
   });
   await program.parseAsync([...argv]);
 }