svcloud 0.1.0-alpha.3

package/src/lib/run-poll.ts

@@ -0,0 +1,68 @@
+/**
+ * One poller shared by `init` (watching the provision it just started) and
+ * `runs` (watching one on request), so a run reads identically no matter
+ * which command is looking at it. Step labels are printed exactly as the
+ * server writes them (`RunStepDetail.label`, from `serialize.ts`'s
+ * `STEP_LABELS`) — re-wording them here would be the same mistake `status`
+ * is explicitly told not to make with health copy.
+ *
+ * Prints a step's line once, the moment it reaches a terminal status —
+ * never a redraw, since stdout may be a pipe.
+ */
+import type { RunDetail, RunStepStatus } from "@sv/cloud-contracts";
+
+const TERMINAL_STEP_STATUSES: ReadonlySet<RunStepStatus> = new Set(["succeeded", "failed", "skipped"]);
+const RUNNING_RUN_STATUSES: ReadonlySet<RunDetail["status"]> = new Set(["queued", "running"]);
+
+function stepLine(status: RunStepStatus): string {
+  return status === "succeeded" ? "done" : status;
+}
+
+function printNewSteps(run: RunDetail, printed: Map<string, RunStepStatus>): void {
+  for (const step of run.steps) {
+    if (printed.get(step.key) === step.status) continue;
+    if (TERMINAL_STEP_STATUSES.has(step.status)) {
+      console.log(`  ${step.label}: ${stepLine(step.status)}`);
+    }
+    printed.set(step.key, step.status);
+  }
+}
+
+function sleep(ms: number): Promise<void> {
+  return new Promise((resolve) => setTimeout(resolve, ms));
+}
+
+export interface PollOptions {
+  intervalMs?: number;
+  timeoutMs?: number;
+  /** Printed once if the timeout is hit, e.g. `svcloud runs my-app`. */
+  resumeHint: string;
+  /** Suppress step-line printing (for `--json`, which prints the final RunDetail instead). */
+  quiet?: boolean;
+}
+
+/** Resolves once the run reaches a terminal status, or the timeout is hit (whichever first). */
+export async function pollRun(fetchRun: () => Promise<RunDetail>, opts: PollOptions): Promise<RunDetail> {
+  const interval = opts.intervalMs ?? 2000;
+  const timeout = opts.timeoutMs ?? 5 * 60 * 1000;
+  const start = Date.now();
+  const printed = new Map<string, RunStepStatus>();
+
+  let run = await fetchRun();
+  if (!opts.quiet) printNewSteps(run, printed);
+
+  while (RUNNING_RUN_STATUSES.has(run.status)) {
+    if (Date.now() - start > timeout) {
+      if (!opts.quiet) {
+        console.error(
+          `Still going after ${Math.round(timeout / 1000)}s. Check back with \`${opts.resumeHint}\`.`,
+        );
+      }
+      return run;
+    }
+    await sleep(interval);
+    run = await fetchRun();
+    if (!opts.quiet) printNewSteps(run, printed);
+  }
+  return run;
+}