@intentius/chant 0.13.1 → 0.15.0

package/src/components/cli-support.ts

@@ -0,0 +1,481 @@
+/**
+ * CLI-facing helpers over component discovery (#560, epic #551) — kept
+ * separate from ../cli/commands/{list,describe}.ts and
+ * ../cli/handlers/graph.ts so those files stay thin dispatchers and the
+ * component-specific report shaping lives alongside the rest of the
+ * component subsystem, the same way ../op/discover.ts's results are shaped
+ * inline by its own CLI callers rather than a `cli` folder inside `op/`.
+ *
+ * Surfaces components in the three places the issue asks for:
+ *  - `chant list --components` — inventory (mirrors `ListEntity`/`listCommand`).
+ *  - `chant describe <name> --components` — one component's full JSON contract
+ *    projection (mirrors `describeCommand`'s effective-config view).
+ *  - `chant graph --components` — dependency order/waves from `dependsOn`
+ *    (mirrors `computeStackGraph`/`runStackGraph`, but reuses
+ *    `resolveComponentGraph` from ../driver.ts since a component's `dependsOn`
+ *    is already a flat name list — no AttrRef-style inference needed).
+ *  - `chant build --components --generate gitlab` — generate mode (#563):
+ *    synthesize CI YAML from the same discovered declarations instead of
+ *    running them, via `generateGitlabPipeline` (../generate-gitlab.ts).
+ *  - `chant run --components <name|all>` — interpret mode (#585): dispatch
+ *    discovered component(s) through the interpret `driver.ts` on the local
+ *    executor, the CLI entrypoint the driver (#556) never had.
+ */
+
+import { discoverComponents } from "./discover";
+import { projectToJson, type Archetype } from "./component";
+import {
+  resolveComponentGraph,
+  runInterpretDriver,
+  runComponentDeploy,
+  UnknownDependencyError,
+  DependencyCycleError,
+  DriverGateUnsupportedError,
+  DriverRunFailure,
+  type DriverComponent,
+  type DriverPhase,
+  type DriverRunResult,
+} from "./driver";
+import { isLexiconPlugin, type LexiconPlugin, type ComponentPipelineOptions } from "../lexicon";
+import { buildCapabilityRegistry } from "./capability-plugin-loader";
+import type { CapabilityRegistry } from "./capability";
+import { applyConfigDefaults } from "./config-defaults";
+import { loadChantConfig, type ChantConfig } from "../config";
+
+/** One component in `chant list --components` output. */
+export interface ListedComponent {
+  name: string;
+  archetype: Archetype;
+  dependsOn: string[];
+  hasBuild: boolean;
+  phases: string[];
+  filePath: string;
+}
+
+export interface ListComponentsResult {
+  success: boolean;
+  components: ListedComponent[];
+  errors: string[];
+}
+
+/** Discover components under `path` and shape them for `chant list --components`. */
+export async function listComponents(path: string): Promise<ListComponentsResult> {
+  const result = await discoverComponents(path);
+  if (result.errors.length > 0) {
+    return { success: false, components: [], errors: result.errors.map((e) => e.message) };
+  }
+
+  const components: ListedComponent[] = [...result.components.values()]
+    .map(({ component, filePath }) => {
+      const projected = projectToJson(component) as { archetype: Archetype };
+      return {
+        name: component.name,
+        archetype: projected.archetype,
+        dependsOn: component.dependsOn,
+        hasBuild: component.build !== undefined,
+        phases: component.deploy.map((p) => p.phase),
+        filePath,
+      };
+    })
+    .sort((a, b) => a.name.localeCompare(b.name));
+
+  return { success: true, components, errors: [] };
+}
+
+/** One component's full JSON contract projection, for `chant describe <name> --components`. */
+export interface DescribedComponent {
+  name: string;
+  filePath: string;
+  /** The component's JSON contract projection (validates against component.schema.json). */
+  json: unknown;
+}
+
+export interface DescribeComponentResult {
+  success: boolean;
+  component: string;
+  described?: DescribedComponent;
+  output: string;
+}
+
+/** Find and project one named component, for `chant describe <name> --components`. */
+export async function describeComponent(path: string, name: string): Promise<DescribeComponentResult> {
+  const result = await discoverComponents(path);
+  if (result.errors.length > 0) {
+    return { success: false, component: name, output: result.errors.map((e) => e.message).join("\n") };
+  }
+
+  const found = result.components.get(name);
+  if (!found) {
+    const known = [...result.components.keys()].sort().join(", ");
+    return {
+      success: false,
+      component: name,
+      output: `No component "${name}" found.\nKnown components: ${known || "(none)"}`,
+    };
+  }
+
+  const json = projectToJson(found.component);
+  return {
+    success: true,
+    component: name,
+    described: { name, filePath: found.filePath, json },
+    output: "",
+  };
+}
+
+/** Dependency order/waves for `chant graph --components`, from every discovered component's `dependsOn`. */
+export interface ComponentGraphResult {
+  success: boolean;
+  order: string[];
+  waves: string[][];
+  edges: Array<{ from: string; to: string }>;
+  error?: string;
+}
+
+/** Compute the components' dependency graph under `path`, for `chant graph --components`. */
+export async function computeComponentGraph(path: string): Promise<ComponentGraphResult> {
+  const result = await discoverComponents(path);
+  if (result.errors.length > 0) {
+    return { success: false, order: [], waves: [], edges: [], error: result.errors.map((e) => e.message).join("\n") };
+  }
+
+  const driverComponents: DriverComponent[] = [...result.components.values()].map(({ component }) => ({
+    name: component.name,
+    dependsOn: component.dependsOn,
+    deploy: component.deploy,
+  }));
+
+  try {
+    const { order, waves } = resolveComponentGraph(driverComponents);
+    const edges: Array<{ from: string; to: string }> = [];
+    for (const c of driverComponents) {
+      for (const dep of c.dependsOn ?? []) edges.push({ from: c.name, to: dep });
+    }
+    return { success: true, order, waves, edges };
+  } catch (err) {
+    if (err instanceof UnknownDependencyError || err instanceof DependencyCycleError) {
+      return { success: false, order: [], waves: [], edges: [], error: err.message };
+    }
+    throw err;
+  }
+}
+
+/** A generate-mode target lexicon name — any lexicon whose plugin implements `generateComponentPipeline` (currently gitlab; github/forgejo as they add it). */
+export type GenerateLexicon = string;
+
+/** Result of `chant build --components --generate <lexicon>`. */
+export interface GenerateComponentsResult {
+  success: boolean;
+  /** The synthesized CI YAML, when `success` is true. */
+  yaml?: string;
+  /** Wave-ordered stage names (one entry per wave). */
+  stages?: string[];
+  /** Every generated job, for a machine-readable view (`--format json`). */
+  jobs?: Array<{ jobName: string; component: string; stage: string; needs: string[] }>;
+  error?: string;
+}
+
+/**
+ * Load a lexicon's plugin (`@intentius/chant-lexicon-<name>`) to reach its
+ * `generateComponentPipeline`. Tolerant: returns null when the package can't be
+ * resolved. Mirrors the lexicon-borne loading the capability + upstream-pin
+ * seams use, kept here so `components` doesn't depend on the `cli` plugin loader.
+ */
+async function loadLexiconPlugin(name: string): Promise<LexiconPlugin | null> {
+  let mod: Record<string, unknown>;
+  try {
+    mod = (await import(`@intentius/chant-lexicon-${name}`)) as Record<string, unknown>;
+  } catch {
+    return null;
+  }
+  for (const value of Object.values(mod)) {
+    if (isLexiconPlugin(value)) return value;
+  }
+  return null;
+}
+
+/**
+ * Generate mode (#563): discover every `Component` under `path` and
+ * synthesize a thin CI pipeline for `lexicon` that triggers each component's
+ * own composition in dependency order/waves — the same `resolveComponentGraph`
+ * order `chant graph --components`/the interpret driver use. No deploy logic
+ * is inlined into the generated YAML; a cross-cutting change goes through
+ * `options`, never per component. The CI-specific synthesis is contributed by
+ * the target lexicon's `generateComponentPipeline` (#688); core owns only the
+ * generic discovery + graph.
+ */
+export async function generateComponentsPipeline(
+  path: string,
+  lexicon: GenerateLexicon,
+  options?: ComponentPipelineOptions,
+): Promise<GenerateComponentsResult> {
+  const plugin = await loadLexiconPlugin(lexicon);
+  if (!plugin?.generateComponentPipeline) {
+    return {
+      success: false,
+      error: `Lexicon "${lexicon}" does not support generate mode (no generateComponentPipeline). GitLab is supported today; GitHub/Forgejo as they add it.`,
+    };
+  }
+
+  const result = await discoverComponents(path);
+  if (result.errors.length > 0) {
+    return { success: false, error: result.errors.map((e) => e.message).join("\n") };
+  }
+
+  const driverComponents: DriverComponent[] = [...result.components.values()].map(({ component }) => ({
+    name: component.name,
+    dependsOn: component.dependsOn,
+    deploy: component.deploy,
+  }));
+
+  try {
+    const { yaml, stages, jobs } = plugin.generateComponentPipeline(driverComponents, options);
+    return { success: true, yaml, stages, jobs };
+  } catch (err) {
+    if (err instanceof UnknownDependencyError || err instanceof DependencyCycleError) {
+      return { success: false, error: err.message };
+    }
+    throw err;
+  }
+}
+
+// ── Interpret mode: `chant run --components <name|all>` (#585) ──────────────
+
+/** Convert a discovered `Component` to the driver's leaner `DriverComponent` shape (name/dependsOn/deploy/rollback — the only fields the driver reads). */
+function toDriverComponent(component: { name: string; dependsOn: string[]; deploy: DriverPhase[]; rollback?: DriverPhase[] }): DriverComponent {
+  return {
+    name: component.name,
+    dependsOn: component.dependsOn,
+    deploy: component.deploy,
+    ...(component.rollback ? { rollback: component.rollback } : {}),
+  };
+}
+
+/**
+ * Find the first `gate` step anywhere in a component's `deploy`/`rollback`
+ * composition (including nested fan-out phases), mirroring
+ * `../op/local-executor.ts`'s `findGate`. Used as a pre-flight check so
+ * `chant run --components` fails before any step runs — matching
+ * `runOpLocal`'s behavior for Ops — rather than only failing mid-run when the
+ * driver itself reaches the gated phase (`DriverGateUnsupportedError`).
+ */
+export function findComponentGate(component: DriverComponent): { signalName: string } | undefined {
+  const search = (phases: DriverPhase[] | undefined): { signalName: string } | undefined => {
+    for (const phaseDef of phases ?? []) {
+      for (const entry of phaseDef.steps) {
+        if ((entry as { kind?: unknown }).kind === "gate") {
+          return entry as unknown as { signalName: string };
+        }
+        if (typeof (entry as DriverPhase).phase === "string" && Array.isArray((entry as DriverPhase).steps)) {
+          const nested = search([entry as DriverPhase]);
+          if (nested) return nested;
+        }
+      }
+      const fromOnFailure = search(phaseDef.onFailure);
+      if (fromOnFailure) return fromOnFailure;
+    }
+    return undefined;
+  };
+  return search(component.deploy) ?? search(component.rollback);
+}
+
+/** Options for `runComponents` (backs `chant run --components <name|all> [--env <env>]`). */
+export interface RunComponentsOptions {
+  /** Target environment name, threaded into every capability's `DeployContext.env` (default: "local"). */
+  env?: string;
+  /** Additional capability plugin package names to load on top of the built-in starter set (see `buildCapabilityRegistry`). */
+  capabilityPlugins?: string[];
+  /**
+   * Pre-built registry to dispatch through, bypassing `buildCapabilityRegistry`
+   * entirely. Real callers (the CLI handler) should leave this unset; it exists
+   * so tests can inject a registry wired to a `MockCloudExecutor` (mirroring
+   * `../components/pilots/pilots-e2e.test.ts`'s `buildRegistry`) instead of the
+   * default starter set, whose non-pilot verbs are still typed stubs that throw
+   * `CapabilityNotImplementedError` (see `./verbs/stub.ts`).
+   */
+  registry?: CapabilityRegistry;
+  /**
+   * Pre-loaded project config to resolve `sbom`/`signing`/`vulnPolicy`
+   * defaults from (#629), bypassing `loadChantConfig` entirely. Real callers
+   * (the CLI handler) should leave this unset — `runComponents` loads
+   * `chant.config.ts`/`chant.config.json` from `path` itself; this exists so
+   * tests can inject a config object directly, the same escape hatch
+   * `registry` above provides for the capability registry.
+   */
+  config?: ChantConfig;
+  /**
+   * Cross-component/cross-stack outputs to seed the run with — keyed by
+   * component name, the same shape `DriverRunResult.componentOutputs` produces.
+   * The CLI populates this from `--seed-outputs` files (an upstream CI job's
+   * dumped outputs), so a single-component run in a downstream job can resolve
+   * `stackOutput()`/`@<name>.publish.*` references to a component that already
+   * ran elsewhere. Merged with, and overridden by, outputs this run produces.
+   */
+  componentOutputs?: Record<string, Record<string, unknown>>;
+}
+
+/** Result of `chant run --components <name|all>`. */
+export interface RunComponentsResult {
+  success: boolean;
+  /** The driver's run result, when the run reached the driver (even on a failed component). */
+  run?: DriverRunResult;
+  /** Component names actually dispatched to the driver, in run order. */
+  selected: string[];
+  error?: string;
+  /** Set when a selected component (or one of its `deploy`/`rollback` phases) contains a `gate` the local executor cannot run. */
+  gateUnsupported?: { component: string; signalName: string };
+}
+
+/**
+ * Run one named component, or every discovered component (`selector ===
+ * "all"`), through the interpret driver (`../components/driver.ts`) on the
+ * local in-process executor — the CLI entrypoint the driver never had (#585,
+ * follow-up to #556). Discovers the full component set first, then either:
+ *  - `selector === "all"`: resolves the whole set's dependency order/waves
+ *    and dispatches every component through `runInterpretDriver`, matching
+ *    what the generated orchestrator Op will eventually do — the same
+ *    order `chant graph --components` reports.
+ *  - a single name: dispatches just that component via `runComponentDeploy`,
+ *    without requiring the rest of its `dependsOn` graph to be present in
+ *    this invocation. This mirrors generate mode's per-job invocation model
+ *    (`generate-gitlab.ts`) — each CI job triggers exactly one component, and
+ *    cross-job/cross-wave ordering is the CI DAG's (`needs:`) job, not this
+ *    command's; requiring the full graph here would make `chant run
+ *    --components <name>` fail for any component whose `dependsOn` names
+ *    infra outside the discovered set (e.g. a shared stack, per the
+ *    `search-service` pilot), which is exactly the common case.
+ *
+ * Pre-flights every selected component for a `gate` step and fails before any
+ * step runs (`gateUnsupported`), matching `runOpLocal`'s pre-flight
+ * `findGate` check for Ops — gated components need a durable (Temporal)
+ * backend, which is out of scope here (issue #585 scopes Temporal-backed
+ * component execution to what already exists for Ops; the epic tracks
+ * graduating a gated component to `--temporal` separately).
+ */
+/** Result of resolving a `<name|all>` selector against discovered components — shared by the local (`runComponents`) and durable (Temporal codegen, #589) entrypoints. */
+export interface ResolvedComponentTargets {
+  success: boolean;
+  targets: DriverComponent[];
+  error?: string;
+}
+
+/**
+ * Discover every component under `path` and resolve `selector` (`"all"` or a
+ * single component name) to the `DriverComponent`(s) to run, with no gate
+ * check and no dispatch — just discovery + selection, factored out of
+ * `runComponents` so the durable Temporal entrypoint (`chant run --components
+ * <name> --temporal`, #589) can reuse the exact same selection semantics
+ * without also inheriting the local executor's pre-flight gate rejection
+ * (gates are exactly what the durable path exists to support).
+ */
+export async function resolveComponentTargets(path: string, selector: string): Promise<ResolvedComponentTargets> {
+  const result = await discoverComponents(path);
+  if (result.errors.length > 0) {
+    return { success: false, targets: [], error: result.errors.map((e) => e.message).join("\n") };
+  }
+
+  const all = [...result.components.values()].map(({ component }) => toDriverComponent(component));
+
+  if (selector === "all") {
+    return { success: true, targets: all };
+  }
+
+  const found = all.find((c) => c.name === selector);
+  if (!found) {
+    const known = all.map((c) => c.name).sort().join(", ");
+    return {
+      success: false,
+      targets: [],
+      error: `Component "${selector}" not found.${known ? ` Known components: ${known}` : " No components discovered."}`,
+    };
+  }
+  return { success: true, targets: [found] };
+}
+
+export async function runComponents(
+  path: string,
+  selector: string,
+  options: RunComponentsOptions = {},
+): Promise<RunComponentsResult> {
+  const resolved = await resolveComponentTargets(path, selector);
+  if (!resolved.success) {
+    return { success: false, selected: [], error: resolved.error };
+  }
+  const targets = resolved.targets;
+
+  for (const component of targets) {
+    const gate = findComponentGate(component);
+    if (gate) {
+      return {
+        success: false,
+        selected: targets.map((c) => c.name),
+        gateUnsupported: { component: component.name, signalName: gate.signalName },
+      };
+    }
+  }
+
+  // (#629) Resolve `chant.config.ts`'s `sbom`/`signing`/`vulnPolicy` sections
+  // and fill their defaults into every recognized step (`generate-sbom`,
+  // `sign`/`attest-provenance`, `verify`, `vuln-gate`) that didn't already
+  // specify the value itself, BEFORE dispatching to the driver — the driver
+  // itself stays capability-agnostic and never reads project config (see
+  // ./config-defaults.ts's module doc). Loaded up front here (rather than just
+  // before `applyConfigDefaults`) so the same config drives which capability
+  // plugins the registry loads: a component's cloud leaves (e.g. `cfn-deploy`)
+  // are contributed by the project's active lexicons (`config.lexicons`), not
+  // baked into core — see ./capability-plugin-loader.ts.
+  const { config } = options.config ? { config: options.config } : await loadChantConfig(path);
+  const registry: CapabilityRegistry =
+    options.registry ??
+    (await buildCapabilityRegistry({
+      plugins: options.capabilityPlugins ?? config.capabilities,
+      lexicons: config.lexicons,
+    }));
+  const env = options.env ?? "local";
+  const selected = targets.map((c) => c.name);
+  const resolvedTargets = targets.map((component) => applyConfigDefaults(component, config));
+  // Cross-component/cross-stack outputs to resolve references against. Seeded
+  // from a caller (a downstream CI job passing an upstream job's dumped
+  // outputs via `--seed-outputs`); grows as this run's components complete.
+  const seedOutputs = options.componentOutputs ?? {};
+
+  try {
+    if (selector === "all") {
+      const run = await runInterpretDriver(resolvedTargets, registry, { env, componentOutputs: seedOutputs });
+      return { success: true, run, selected };
+    }
+
+    // Single-component invocation: run just this component, bypassing
+    // whole-graph `dependsOn` resolution (see docstring above). The seeded
+    // outputs stand in for the dependency components that ran in earlier jobs,
+    // so a single-component run still resolves their `stackOutput()`/publish
+    // references. `runComponentDeploy` mutates this map with this component's
+    // own outputs, which `run.componentOutputs` then exposes for `--dump-outputs`.
+    const componentOutputs = { ...seedOutputs };
+    const componentResult = await runComponentDeploy(resolvedTargets[0], { env, component: resolvedTargets[0].name }, registry, componentOutputs);
+    const run: DriverRunResult = {
+      order: selected,
+      waves: [selected],
+      results: [componentResult],
+      ok: componentResult.ok,
+      failedComponent: componentResult.ok ? undefined : componentResult.component,
+      componentOutputs,
+    };
+    return { success: componentResult.ok, run, selected };
+  } catch (err) {
+    if (err instanceof DriverRunFailure) {
+      return { success: false, run: err.result, selected, error: err.message };
+    }
+    if (err instanceof DriverGateUnsupportedError) {
+      return {
+        success: false,
+        selected,
+        gateUnsupported: { component: err.component, signalName: err.signalName },
+      };
+    }
+    if (err instanceof UnknownDependencyError || err instanceof DependencyCycleError) {
+      return { success: false, selected, error: err.message };
+    }
+    throw err;
+  }
+}