@saptools/cf-events 0.1.4 → 0.2.1

package/dist/cli.js

@@ -39,8 +39,11 @@ function parseDuration(raw) {
   }
   return amount * unitMs;
 }
+function toCfAuditTimestamp(date) {
+  return date.toISOString().replace(/\.\d{3}Z$/, "Z");
+}
 function durationToCreatedAfter(raw, now) {
-  return new Date(now.getTime() - parseDuration(raw)).toISOString();
+  return toCfAuditTimestamp(new Date(now.getTime() - parseDuration(raw)));
 }
 function parseTypeFilter(raw) {
   if (raw === void 0) {
@@ -88,6 +91,39 @@ function summarizeCrashes(appName, events) {
     crashes
   };
 }
+function crashAppName(event) {
+  if (event.target.name.length > 0) {
+    return event.target.name;
+  }
+  if (event.target.guid.length > 0) {
+    return event.target.guid;
+  }
+  return "(unknown app)";
+}
+function summarizeSpaceCrashes(selector, events) {
+  const byApp = /* @__PURE__ */ new Map();
+  for (const event of events.filter(isCrashEvent)) {
+    const appName = crashAppName(event);
+    byApp.set(appName, [...byApp.get(appName) ?? [], event]);
+  }
+  const apps = [...byApp.entries()].map(([appName, appEvents]) => summarizeCrashes(appName, appEvents)).map(({ appName, crashCount, lastCrashAt, lastCrashReason, crashes }) => ({
+    appName,
+    crashCount,
+    lastCrashAt,
+    lastCrashReason,
+    crashes
+  })).sort((left, right) => {
+    const byTime = (right.lastCrashAt ?? "").localeCompare(left.lastCrashAt ?? "");
+    return byTime === 0 ? left.appName.localeCompare(right.appName) : byTime;
+  });
+  return {
+    scope: "space",
+    selector,
+    crashCount: apps.reduce((sum, app) => sum + app.crashCount, 0),
+    lastCrashAt: apps[0]?.lastCrashAt,
+    apps
+  };
+}
 
 // src/format.ts
 var EVENT_LABELS = {
@@ -188,6 +224,34 @@ function formatEventsReport(appName, events, now) {
     ...events.map((event) => formatEventLine(event, now))
   ].join("\n");
 }
+function eventTargetLabel(event) {
+  if (event.target.name.length > 0) {
+    return event.target.name;
+  }
+  if (event.target.type.length > 0) {
+    return event.target.type;
+  }
+  return event.target.guid.length > 0 ? event.target.guid : "(unknown target)";
+}
+function formatSpaceEventLine(event, now) {
+  const actor = event.actor.name.length > 0 ? event.actor.name : event.actor.type;
+  return [
+    `  ${event.createdAt.padEnd(26)}`,
+    formatRelativeTime(event.createdAt, now).padEnd(11),
+    describeEventType(event.type).padEnd(24),
+    eventTargetLabel(event).padEnd(18),
+    actor.length > 0 ? actor : "(unknown actor)"
+  ].join("  ");
+}
+function formatSpaceEventsReport(selector, events, now) {
+  if (events.length === 0) {
+    return `No audit events found for space ${selector}.`;
+  }
+  return [
+    `Audit events for space ${selector} (${events.length.toString()}):`,
+    ...events.map((event) => formatSpaceEventLine(event, now))
+  ].join("\n");
+}
 function formatSshStatusReport(status, now) {
   const sessionLines = status.sessions.map((session) => {
     const tag = session.likelyActive ? "[active]" : "[past]  ";
@@ -212,7 +276,7 @@ function formatSshStatusReport(status, now) {
     "  are inferred from recent ssh-authorized audit events."
   ].join("\n");
 }
-function formatCrashReport(summary, now) {
+function formatAppCrashReport(summary, now) {
   if (summary.crashCount === 0) {
     return `No crashes found for ${summary.appName}.`;
   }
@@ -233,6 +297,35 @@ function formatCrashReport(summary, now) {
     ...crashLines
   ].join("\n");
 }
+function formatSpaceCrashReport(summary, now) {
+  if (summary.crashCount === 0) {
+    return `No crashes found for space ${summary.selector}.`;
+  }
+  const appLines = summary.apps.flatMap((app) => [
+    `  ${app.appName} (${app.crashCount.toString()})`,
+    ...app.crashes.map((crash) => {
+      const index = crash.index === void 0 ? "-" : `#${crash.index.toString()}`;
+      const reason = crash.reason ?? "unknown";
+      const exit = crash.exitStatus === void 0 ? "" : `  exit ${crash.exitStatus.toString()}`;
+      return `    ${crash.at}  instance ${index}  ${reason}${exit}`;
+    })
+  ]);
+  return [
+    `Crash report for space ${summary.selector}`,
+    "",
+    `  Crashes: ${summary.crashCount.toString()}`,
+    `  Apps affected: ${summary.apps.length.toString()}`,
+    ...summary.lastCrashAt === void 0 ? [] : [`  Last crash: ${summary.lastCrashAt} (${formatRelativeTime(summary.lastCrashAt, now)})`],
+    "",
+    ...appLines
+  ].join("\n");
+}
+function formatCrashReport(summary, now) {
+  if ("scope" in summary) {
+    return formatSpaceCrashReport(summary, now);
+  }
+  return formatAppCrashReport(summary, now);
+}
 function formatInstanceLine(instance) {
   return [
     `  #${instance.index.toString()}`.padEnd(6),
@@ -278,6 +371,12 @@ function asRecord(value) {
 function asArray(value) {
   return Array.isArray(value) ? value : [];
 }
+function requireArray(value, message) {
+  if (!Array.isArray(value)) {
+    throw new Error(message);
+  }
+  return value;
+}
 function asString(value) {
   return typeof value === "string" ? value : "";
 }
@@ -327,7 +426,7 @@ function mapProcessStat(value) {
 }
 function buildAuditEventsPath(input, perPage) {
   const params = new URLSearchParams();
-  params.set("target_guids", input.appGuid);
+  applyAuditEventScope(params, input.scope);
   params.set("order_by", "-created_at");
   params.set("per_page", perPage.toString());
   if (input.types !== void 0 && input.types.length > 0) {
@@ -338,6 +437,60 @@ function buildAuditEventsPath(input, perPage) {
   }
   return `/v3/audit_events?${params.toString()}`;
 }
+function applyAuditEventScope(params, scope) {
+  if (scope.kind === "app") {
+    params.set("target_guids", scope.appGuid);
+    return;
+  }
+  params.set("space_guids", scope.spaceGuid);
+}
+async function resolveOrganizationGuid(orgName, curl) {
+  const params = new URLSearchParams();
+  params.set("names", orgName);
+  const body = asRecord(parseJson(await curl(`/v3/organizations?${params.toString()}`)));
+  const first = asRecord(asArray(body["resources"])[0]);
+  const guid = asString(first["guid"]);
+  if (guid.length === 0) {
+    throw new Error(`Could not resolve the GUID for organization "${orgName}".`);
+  }
+  return guid;
+}
+async function resolveSpaceGuid(spaceName, orgGuid, curl) {
+  const params = new URLSearchParams();
+  params.set("names", spaceName);
+  params.set("organization_guids", orgGuid);
+  const body = asRecord(parseJson(await curl(`/v3/spaces?${params.toString()}`)));
+  const first = asRecord(asArray(body["resources"])[0]);
+  const guid = asString(first["guid"]);
+  if (guid.length === 0) {
+    throw new Error(`Could not resolve the GUID for space "${spaceName}".`);
+  }
+  return guid;
+}
+function formatCfApiError(error) {
+  const record = asRecord(error);
+  const title = asString(record["title"]);
+  const detail = asString(record["detail"]);
+  if (title.length > 0 && detail.length > 0) {
+    return `${title}: ${detail}`;
+  }
+  if (title.length > 0) {
+    return title;
+  }
+  if (detail.length > 0) {
+    return detail;
+  }
+  const code = asNumber(record["code"]);
+  return code === void 0 ? "unknown CF API error" : `code ${code.toString()}`;
+}
+function throwIfCfApiErrors(body) {
+  const errors = asRecord(body)["errors"];
+  if (errors === void 0) {
+    return;
+  }
+  const details = requireArray(errors, "The CF API returned an invalid errors response.").map(formatCfApiError).filter((detail) => detail.length > 0);
+  throw new Error(`CF API error ${details.length > 0 ? details.join("; ") : "unknown CF API error"}`);
+}
 function nextPagePath(body) {
   const next = asRecord(asRecord(asRecord(body)["pagination"])["next"]);
   const href = next["href"];
@@ -358,7 +511,11 @@ async function fetchAuditEvents(input, curl) {
   let path = buildAuditEventsPath(input, perPage);
   while (path !== void 0 && events.length < limit) {
     const body = parseJson(await curl(path));
-    for (const resource of asArray(asRecord(body)["resources"])) {
+    throwIfCfApiErrors(body);
+    for (const resource of requireArray(
+      asRecord(body)["resources"],
+      "The CF API returned an invalid audit events response: missing resources array."
+    )) {
       events.push(mapAuditEvent(resource));
       if (events.length >= limit) {
         break;
@@ -626,7 +783,12 @@ function extractSafeCliDetail(error) {
 }
 
 // src/selector.ts
-var SELECTOR_USAGE = 'use "region/org/space/app" or a bare app name';
+var SELECTOR_USAGE = 'use "region/org/space", "region/org/space/app", or a bare app name';
+function assertNonEmpty(raw, parts, shape) {
+  if (parts.some((part) => part.length === 0)) {
+    throw new Error(`Invalid selector "${raw}": every ${shape} segment must be non-empty.`);
+  }
+}
 function parseSelector(raw) {
   const trimmed = raw.trim();
   if (trimmed.length === 0) {
@@ -640,12 +802,21 @@ function parseSelector(raw) {
     }
     return { kind: "appName", appName };
   }
+  if (parts.length === 3) {
+    assertNonEmpty(raw, parts, "region/org/space");
+    const [regionKey, orgName, spaceName] = parts;
+    return { kind: "spacePath", regionKey: regionKey ?? "", orgName: orgName ?? "", spaceName: spaceName ?? "" };
+  }
   if (parts.length === 4) {
+    assertNonEmpty(raw, parts, "region/org/space/app");
     const [regionKey, orgName, spaceName, appName] = parts;
-    if (regionKey === void 0 || orgName === void 0 || spaceName === void 0 || appName === void 0 || regionKey.length === 0 || orgName.length === 0 || spaceName.length === 0 || appName.length === 0) {
-      throw new Error(`Invalid selector "${raw}": every region/org/space/app segment must be non-empty.`);
-    }
-    return { kind: "explicit", regionKey, orgName, spaceName, appName };
+    return {
+      kind: "appPath",
+      regionKey: regionKey ?? "",
+      orgName: orgName ?? "",
+      spaceName: spaceName ?? "",
+      appName: appName ?? ""
+    };
   }
   throw new Error(`Invalid selector "${raw}": ${SELECTOR_USAGE}.`);
 }
@@ -659,6 +830,7 @@ async function resolveSelector(raw) {
       );
     }
     return {
+      kind: "app",
       raw,
       regionKey: current.regionKey ?? "",
       apiEndpoint: current.apiEndpoint,
@@ -673,7 +845,18 @@ async function resolveSelector(raw) {
       `Unknown region "${parsed.regionKey}". Use a bare app name (requires current CF target) or a known region key.`
     );
   }
+  if (parsed.kind === "spacePath") {
+    return {
+      kind: "space",
+      raw,
+      regionKey: parsed.regionKey,
+      apiEndpoint,
+      orgName: parsed.orgName,
+      spaceName: parsed.spaceName
+    };
+  }
   return {
+    kind: "app",
     raw,
     regionKey: parsed.regionKey,
     apiEndpoint,
@@ -724,10 +907,12 @@ function createCfClient(curl) {
     fetchAuditEvents: (input) => fetchAuditEvents(input, curl),
     fetchApp: (appGuid) => fetchApp(appGuid, curl),
     fetchSshEnabled: (appGuid) => fetchSshEnabled(appGuid, curl),
-    fetchWebProcessStats: (appGuid) => fetchWebProcessStats(appGuid, curl)
+    fetchWebProcessStats: (appGuid) => fetchWebProcessStats(appGuid, curl),
+    resolveOrganizationGuid: (orgName) => resolveOrganizationGuid(orgName, curl),
+    resolveSpaceGuid: (spaceName, orgGuid) => resolveSpaceGuid(spaceName, orgGuid, curl)
   };
 }
-async function defaultWithCfApp(selector, credentials, work) {
+async function defaultWithCfTarget(selector, credentials, work) {
   return await withCfSession(async (ctx) => {
     await prepareCfCliSession(
       {
@@ -738,15 +923,14 @@ async function defaultWithCfApp(selector, credentials, work) {
       },
       ctx
     );
-    const appGuid = await cfAppGuid(selector.appName, ctx);
     const client = createCfClient((path) => cfCurl(path, ctx));
-    return await work({ appGuid, client });
+    return await work({ selector, client, resolveAppGuid: (appName) => cfAppGuid(appName, ctx) });
   });
 }
 function createDefaultDependencies() {
   return {
     resolveSelector,
-    withCfApp: defaultWithCfApp,
+    withCfTarget: defaultWithCfTarget,
     now: () => /* @__PURE__ */ new Date()
   };
 }
@@ -756,6 +940,24 @@ async function delay(ms, signal) {
   } catch {
   }
 }
+function requireAppSelector(selector, command) {
+  if (selector.kind === "app") {
+    return selector;
+  }
+  throw new Error(
+    `The ${command} command requires an app selector. Use region/org/space/app or a bare app name.`
+  );
+}
+async function resolveAuditScope(session) {
+  if (session.selector.kind === "app") {
+    return { kind: "app", appGuid: await session.resolveAppGuid(session.selector.appName) };
+  }
+  const orgGuid = await session.client.resolveOrganizationGuid(session.selector.orgName);
+  return {
+    kind: "space",
+    spaceGuid: await session.client.resolveSpaceGuid(session.selector.spaceName, orgGuid)
+  };
+}
 var CfEventsRuntime = class {
   deps;
   constructor(deps = createDefaultDependencies()) {
@@ -763,9 +965,9 @@ var CfEventsRuntime = class {
   }
   async fetchEvents(raw, credentials, options) {
     const selector = await this.deps.resolveSelector(raw);
-    return await this.deps.withCfApp(selector, credentials, async ({ appGuid, client }) => {
-      return await client.fetchAuditEvents({
-        appGuid,
+    return await this.deps.withCfTarget(selector, credentials, async (session) => {
+      return await session.client.fetchAuditEvents({
+        scope: await resolveAuditScope(session),
         types: options.types.length > 0 ? options.types : void 0,
         createdAfter: this.resolveCreatedAfter(options.since),
         limit: options.limit
@@ -773,12 +975,13 @@ var CfEventsRuntime = class {
     });
   }
   async getSshStatus(raw, credentials, since) {
-    const selector = await this.deps.resolveSelector(raw);
-    return await this.deps.withCfApp(selector, credentials, async ({ appGuid, client }) => {
+    const selector = requireAppSelector(await this.deps.resolveSelector(raw), "ssh-status");
+    return await this.deps.withCfTarget(selector, credentials, async ({ client, resolveAppGuid }) => {
+      const appGuid = await resolveAppGuid(selector.appName);
       const [sshEnabled, events] = await Promise.all([
         client.fetchSshEnabled(appGuid),
         client.fetchAuditEvents({
-          appGuid,
+          scope: { kind: "app", appGuid },
           types: [...SSH_EVENT_TYPES],
           createdAfter: durationToCreatedAfter(since, this.deps.now()),
           limit: SSH_STATUS_EVENT_LIMIT
@@ -795,24 +998,28 @@ var CfEventsRuntime = class {
   }
   async getCrashes(raw, credentials, options) {
     const selector = await this.deps.resolveSelector(raw);
-    return await this.deps.withCfApp(selector, credentials, async ({ appGuid, client }) => {
-      const events = await client.fetchAuditEvents({
-        appGuid,
+    return await this.deps.withCfTarget(selector, credentials, async (session) => {
+      const events = await session.client.fetchAuditEvents({
+        scope: await resolveAuditScope(session),
         types: [...CRASH_EVENT_TYPES],
         createdAfter: this.resolveCreatedAfter(options.since),
         limit: options.limit
       });
-      return summarizeCrashes(selector.appName, events);
+      if (selector.kind === "app") {
+        return summarizeCrashes(selector.appName, events);
+      }
+      return summarizeSpaceCrashes(`${selector.regionKey}/${selector.orgName}/${selector.spaceName}`, events);
     });
   }
   async getStatus(raw, credentials) {
-    const selector = await this.deps.resolveSelector(raw);
-    return await this.deps.withCfApp(selector, credentials, async ({ appGuid, client }) => {
+    const selector = requireAppSelector(await this.deps.resolveSelector(raw), "status");
+    return await this.deps.withCfTarget(selector, credentials, async ({ client, resolveAppGuid }) => {
+      const appGuid = await resolveAppGuid(selector.appName);
       const [app, instances, sshEnabled, recent] = await Promise.all([
         client.fetchApp(appGuid),
         client.fetchWebProcessStats(appGuid),
         client.fetchSshEnabled(appGuid),
-        client.fetchAuditEvents({ appGuid, types: void 0, createdAfter: void 0, limit: 1 })
+        client.fetchAuditEvents({ scope: { kind: "app", appGuid }, types: void 0, createdAfter: void 0, limit: 1 })
       ]);
       return {
         appName: selector.appName,
@@ -826,12 +1033,13 @@ var CfEventsRuntime = class {
   }
   async watchEvents(raw, credentials, options, onEvent, signal) {
     const selector = await this.deps.resolveSelector(raw);
-    await this.deps.withCfApp(selector, credentials, async ({ appGuid, client }) => {
+    await this.deps.withCfTarget(selector, credentials, async (session) => {
+      const scope = await resolveAuditScope(session);
       const seen = /* @__PURE__ */ new Set();
       let cursor = durationToCreatedAfter(options.lookback, this.deps.now());
       while (!signal.aborted) {
-        const events = await client.fetchAuditEvents({
-          appGuid,
+        const events = await session.client.fetchAuditEvents({
+          scope,
           types: options.types.length > 0 ? options.types : void 0,
           createdAfter: cursor,
           limit: WATCH_FETCH_LIMIT
@@ -893,6 +1101,13 @@ function parsePositiveInteger(value, optionName) {
 function appLabel(selector) {
   return (selector.split("/").at(-1) ?? selector).trim();
 }
+function isSpaceSelector(selector) {
+  return parseSelector(selector).kind === "spacePath";
+}
+function spaceLabel(selector) {
+  const parsed = parseSelector(selector);
+  return parsed.kind === "spacePath" ? `${parsed.regionKey}/${parsed.orgName}/${parsed.spaceName}` : selector;
+}
 function resolveSelectorArgument(selector) {
   return selector;
 }
@@ -920,7 +1135,7 @@ async function runEvents(selector, flags) {
     writeJson(events);
     return;
   }
-  writeOut(formatEventsReport(appLabel(resolvedSelector), events, /* @__PURE__ */ new Date()));
+  writeOut(isSpaceSelector(resolvedSelector) ? formatSpaceEventsReport(spaceLabel(resolvedSelector), events, /* @__PURE__ */ new Date()) : formatEventsReport(appLabel(resolvedSelector), events, /* @__PURE__ */ new Date()));
 }
 async function runSshStatus(selector, flags) {
   const resolvedSelector = resolveSelectorArgument(selector);
@@ -959,12 +1174,12 @@ async function runStatus(selector, flags) {
   }
   writeOut(formatStatusReport(health, /* @__PURE__ */ new Date()));
 }
-function emitWatchEvent(event, asJson) {
+function emitWatchEvent(event, asJson, spaceScope) {
   if (asJson) {
     writeJsonLine(event);
     return;
   }
-  writeOut(formatEventLine(event, /* @__PURE__ */ new Date()));
+  writeOut(spaceScope ? formatSpaceEventLine(event, /* @__PURE__ */ new Date()) : formatEventLine(event, /* @__PURE__ */ new Date()));
 }
 async function runWatch(selector, flags) {
   const resolvedSelector = resolveSelectorArgument(selector);
@@ -978,6 +1193,7 @@ async function runWatch(selector, flags) {
     controller.abort();
   });
   const asJson = flags.json === true;
+  const spaceScope = isSpaceSelector(resolvedSelector);
   try {
     process2.stderr.write(`Watching ${resolvedSelector} for new audit events. Press Ctrl+C to stop.
 `);
@@ -990,7 +1206,7 @@ async function runWatch(selector, flags) {
         types: parseTypeFilter(flags.type)
       },
       (event) => {
-        emitWatchEvent(event, asJson);
+        emitWatchEvent(event, asJson, spaceScope);
       },
       controller.signal
     );
@@ -1036,7 +1252,7 @@ function buildProgram() {
   const program = new Command();
   program.name("cf-events").description("Inspect SAP BTP Cloud Foundry application audit events and SSH/debug sessions").version(readPackageVersion(), "-V, --version", "Print the cf-events package version");
   addCommonOptions(
-    program.command("events").description("List recent audit events for an app").argument("<selector>", "region/org/space/app or a bare app name")
+    program.command("events").description("List recent audit events for an app or all apps in a space").argument("<selector>", "region/org/space, region/org/space/app, or a bare app name")
   ).option(
     "--limit <count>",
     "Maximum number of events to return",
@@ -1050,7 +1266,7 @@ function buildProgram() {
     await runSshStatus(selector, flags);
   });
   addCommonOptions(
-    program.command("crashes").description("Summarize recent crash events for an app").argument("<selector>", "region/org/space/app or a bare app name")
+    program.command("crashes").description("Summarize recent crash events for an app or all apps in a space").argument("<selector>", "region/org/space, region/org/space/app, or a bare app name")
   ).option(
     "--limit <count>",
     "Maximum number of crash events to inspect",
@@ -1064,7 +1280,7 @@ function buildProgram() {
     await runStatus(selector, flags);
   });
   addCommonOptions(
-    program.command("watch").description("Poll for new audit events and print them as they appear").argument("<selector>", "region/org/space/app or a bare app name")
+    program.command("watch").description("Poll for new audit events for an app or all apps in a space").argument("<selector>", "region/org/space, region/org/space/app, or a bare app name")
   ).option(
     "--interval <ms>",
     "Polling interval in milliseconds",