@stringsync/splates 0.0.53 → 0.0.54

package/server.ts

@@ -1,287 +0,0 @@
-import {
-	BoxShell,
-	type BoxStanding,
-	CoordinatorBox,
-	coordinatorMoved,
-	deployKey,
-	machineMove,
-	neededCreds,
-} from "@stringsync/splates-server/coordinator";
-import { SYSTEM_STORES } from "@stringsync/splates-server/creds";
-import { fail } from "@stringsync/splates-server/exit";
-import {
-	DEFAULT_PORT,
-	RUNNING,
-	type SplatesDeps,
-	serveDev,
-} from "@stringsync/splates-server/server";
-import { LOCAL_SLOTS } from "@stringsync/splates-server/workers";
-import { cli } from "webappwiz/cmd";
-import { z } from "zod";
-import { splatesInfra } from "./infra";
-
-/**
- * `splates server`, which the root cli mounts after `splates log`: bare, it
- * runs the server here; its other commands deploy it onto a box of the user's
- * own and look after that box.
- */
-export const splatesServer = cli<SplatesDeps>("server")
-	.description(
-		"the splates server: run it on this machine, or deploy it to an always-on box in your own AWS account, which the Pulumi project `splates server infra init` writes makes, reached by SSH alone",
-	)
-	.fallback("run");
-
-splatesServer
-	.command("run")
-	.description(
-		"serve every splates project on this machine as a web page, from wherever it is run: the page picks the project it shows, adds one by its path, running `splates init` there, and shows its queued and started tasks, where queued tasks can be added, updated, reordered or removed; it brings each project's records forward as it opens it. A server that crashes starts again after 2s, then 4s, 8s and 16s, and is left down after five crashes in a row that each came within a minute of its start",
-	)
-	.option("port", z.coerce.number(), {
-		default: DEFAULT_PORT,
-		description: "port to listen on, or the next open one above it",
-	})
-	.option("allow-hosts", z.string(), {
-		default: "",
-		description:
-			"comma-separated host names the page may also be reached by, like a tunnel's; put Cloudflare Access in front of them with --access-team and --access-aud",
-	})
-	.option("access-team", z.string(), {
-		default: "",
-		description:
-			"the Cloudflare Access team in front of --allow-hosts, as in <team>.cloudflareaccess.com; with --access-aud, those hosts answer only to a verified Access token, and may then use conversations and terminals",
-	})
-	.option("access-aud", z.string(), {
-		default: "",
-		description: "the AUD tag of that Access application",
-	})
-	.option("tunnel", z.string(), {
-		default: "",
-		description:
-			"the public host name of a tunnel to run, with cloudflared or the tunnel provider named by splates.config.ts in the repository it is run in, if any, which is allowed as a host too; refused without --access-team and --access-aud, so a tunnel never exposes the page unauthenticated. With none of the tunnel and Access flags, the tunnel `splates tunnel setup` saved runs, if any",
-	})
-	.option("tunnel-name", z.string(), {
-		default: "",
-		description:
-			"the named tunnel cloudflared runs for --tunnel, by default the one its own config names; not with a tunnel provider of splates.config.ts",
-	})
-	.option("ports-host", z.string(), {
-		default: "",
-		description:
-			"the wildcard base host to serve task ports under, saved for this machine so a bare `splates server` serves it too: each port a task's processes listen on opens at https://<task>-<port>.<base>, to whoever Cloudflare Access lets in, and is refused without Access; routing *.<base> here, its DNS and TLS, are yours. `none` forgets it, leaving each task port forwarded to a port on this machine's loopback alone",
-	})
-	.option("worker-slots", z.coerce.number().int().min(1), {
-		default: LOCAL_SLOTS,
-		description:
-			"how many agents that other agents started (with `splates add --agent`, or a lane's orchestrator handing out tasks) this machine's worker runs at once; past them, each new or resumed one waits in the queue, first come, first served, which `splates worker queue` shows and reorders. An agent you start runs at once on any worker up, taking no slot. Read as the server starts its worker, which a restart from the page leaves running",
-	})
-	.option("keepalive", z.boolean(), {
-		default: false,
-		description:
-			"keep a machine left to serve awake while the server runs: on macOS with `caffeinate`, on power or idle, though closing a laptop's lid still sleeps it; on Linux with a systemd-inhibit lock on sleep and idle, which the server serves on without, saying so, where systemd is missing or refuses it. Refused on other platforms",
-	})
-	.option("slot", z.boolean(), {
-		default: false,
-		description:
-			"serve this checkout's splates at https://<word>.<zone>, a slot of its own on the zone `splates tunnel setup` uses, behind the same Access policy, so several run side by side and a phone opens each by name: a task's worktree keeps its word, as fox, until the task merges or is removed, which stops its server; run again, it stops the tree's last server first. Refused in a splates repository's main tree, which every agent shares. A slot keeps its own projects in ~/.splates/slots/<word>, apart from yours, starting with a throwaway project there; not with the tunnel and Access flags",
-	})
-	.action((opts, ctx) => serveDev(ctx, opts));
-
-splatesServer.mount("infra", splatesInfra);
-
-splatesServer
-	.command("deploy")
-	.description(
-		"deploy the server to the box its Pulumi stack made (`splates server infra init`, then `pulumi up`), over SSH, with splates of this release installed for the user splates. The SSH key and the host key come from the stack and the instance's console. It checks what the deploy needs, brings the box's splates to this release, and exits `blocked`, naming each, until the box's Parameter Store holds the creds the stack should have put there; then gives each project a clone there with its deploy key from Parameter Store. Then it asks every agent of this machine's `splates server` to checkpoint and stops it, carries the server's records (no creds: the box reads its own through its instance role) to the box, starts `splates server` there for good under systemd, and joins this machine to it as a worker, kept up by a LaunchAgent, where each task carries on in its worktree here. This machine's records go aside, kept, and its `splates` reaches the box from then on. Run again once the server runs on the box, it brings the box's splates to this release and restarts it there",
-	)
-	.option("dry-run", z.boolean(), {
-		default: false,
-		description:
-			"stop once the box is ready, before this machine's server stops or anything here changes; once the server runs on the box, change nothing",
-	})
-	.option("dev", z.string(), {
-		default: `http://localhost:${DEFAULT_PORT}`,
-		description: "this machine's `splates server`, which the deploy stops",
-	})
-	.action(async (opts, ctx) => {
-		const moved = await machineMove({
-			ps: ctx.ps,
-			fs: ctx.fs,
-			log: ctx.log,
-			version: RUNNING,
-			dev: opts.dev,
-			stores: ctx.secrets ?? SYSTEM_STORES,
-			...(ctx.fetch === undefined ? {} : { fetch: ctx.fetch }),
-		}).run({ dryRun: opts["dry-run"] });
-		if (moved.status === "blocked") {
-			fail(
-				"blocked",
-				[
-					"The box's Parameter Store lacks these. Set each (the Pulumi stack makes them: `pulumi up`), then deploy again:",
-					...moved.needs.map((name) => `  ${name}`),
-				].join("\n"),
-				{ needs: moved.needs },
-			);
-		}
-		if (moved.status === "deployed") {
-			ctx.log.info(
-				`the server runs on the box at ${moved.ipv4}: deploy again without --dry-run to bring it to ${moved.version}`,
-			);
-			return;
-		}
-		if (moved.status === "updated") {
-			ctx.log.info(
-				`the server on the box at ${moved.ipv4} runs ${moved.version} now`,
-			);
-			return;
-		}
-		if (moved.status === "ready") {
-			ctx.log.info(
-				`the box is ready to serve ${moved.projects.join(", ")} through ${moved.host}: deploy again without --dry-run`,
-			);
-			return;
-		}
-		ctx.log.info(
-			[
-				`the server runs on the box: https://${moved.host}`,
-				`this machine is its worker ${ctx.ps.hostname}, kept up by ${moved.worker}`,
-				`its own records are kept aside in ${moved.aside} and each project's .git/splates.moved`,
-			].join("\n"),
-		);
-	});
-
-splatesServer
-	.command("status")
-	.description(
-		"print where the server runs, here or deployed to its box, and the box as its cloud has it",
-	)
-	.option("json", z.boolean(), { default: false, description: "emit JSON" })
-	.action(async (opts, ctx) => {
-		const deployed = await coordinatorMoved({
-			fs: ctx.fs,
-			ps: ctx.ps,
-			home: box(ctx).home,
-		});
-		const standing = await box(ctx).status();
-		if (opts.json) {
-			ctx.log.info(JSON.stringify({ deployed, box: standing }));
-			return;
-		}
-		ctx.log.info(
-			[
-				`runs:     ${deployed ? "on the box" : "on this machine"}`,
-				...(standing === null
-					? [
-							"box:      none: `splates server infra init` writes the Pulumi project, `pulumi up` there makes it",
-						]
-					: [
-							`address:  ${standing.ipv4}`,
-							`instance: ${standing.instanceId} (role ${standing.roleName})`,
-							`host:     ${standing.host}`,
-							"ssh:      splates server ssh",
-						]),
-			].join("\n"),
-		);
-	});
-
-splatesServer
-	.command("ssh")
-	.description(
-		"open a root shell on the box over SSH, with the key its Pulumi stack made, or run the command given there",
-	)
-	.rest("command", z.string(), {
-		description: "what to run on the box; by default a shell",
-	})
-	.passThroughOptions()
-	.action(async (opts, ctx) => {
-		const standing = await box(ctx).status();
-		if (standing === null) {
-			fail(
-				"not_found",
-				"no box: `splates server infra init` writes the Pulumi project, `pulumi up` there makes it",
-			);
-		}
-		const { exitCode } = await ctx.ps.spawn(
-			shell(ctx, standing).login(opts.command),
-		);
-		ctx.ps.exit(exitCode);
-	});
-
-splatesServer
-	.command("destroy")
-	.description(
-		"unmake the box and everything its Pulumi stack made (its role, snapshots, creds, tunnel and deploy keys), lifting the box's termination protection first: anything only on the box is lost. The stack and its config stay, so the setup's Make the box step, or `splates server deploy`, makes it again. Without --yes, says what it would destroy",
-	)
-	.option("yes", z.boolean(), {
-		default: false,
-		description: "destroy without asking",
-	})
-	.action(async (opts, ctx) => {
-		const infra = await box(ctx).infra();
-		if (infra === null) {
-			fail(
-				"not_found",
-				"no infra project here: nothing to destroy, since `splates server infra init` has not written one",
-			);
-		}
-		const standing = await box(ctx).status();
-		const what =
-			standing === null
-				? `what the stack in ${infra.dir} made`
-				: `the box at ${standing.ipv4} (${standing.instanceId}) and everything the stack in ${infra.dir} made`;
-		if (!opts.yes) {
-			fail(
-				"usage",
-				`this destroys ${what}, and anything only on the box is lost: run again with --yes`,
-				{ dir: infra.dir, box: standing },
-			);
-		}
-		ctx.log.info(`Destroying ${what}, a few minutes…`);
-		await box(ctx).destroy();
-		ctx.log.info(
-			"Destroyed. The stack and its config stay for making it again.",
-		);
-	});
-
-splatesServer
-	.command("needs")
-	.description(
-		"kept for `splates server deploy`, which runs it on the box: print the name of each cred this box's store lacks of those the server needs, one per line",
-	)
-	.rest("roots", z.string(), {
-		description: "each project's clone on this machine",
-	})
-	.action(async (opts, ctx) => {
-		const missing = await neededCreds(ctx.secrets ?? SYSTEM_STORES, opts.roots);
-		for (const name of missing) {
-			ctx.log.info(name);
-		}
-	});
-
-splatesServer
-	.command("deploy-key")
-	.description(
-		"kept for `splates server deploy`, which runs it on the box: print the deploy key of the project whose clone is <root>",
-	)
-	.arg("root", z.string(), {
-		description: "the project's clone on this machine",
-	})
-	.action(async (opts, ctx) => {
-		const key = await deployKey(ctx.secrets ?? SYSTEM_STORES, opts.root);
-		if (key === undefined) {
-			fail("not_found", `no deploy key kept for ${opts.root}`);
-		}
-		ctx.log.info(key);
-	});
-
-function box(ctx: SplatesDeps): CoordinatorBox {
-	return new CoordinatorBox({ ps: ctx.ps, fs: ctx.fs });
-}
-
-function shell(ctx: SplatesDeps, standing: BoxStanding): BoxShell {
-	return new BoxShell({
-		ps: ctx.ps,
-		ipv4: standing.ipv4,
-		key: standing.key,
-		knownHosts: `${box(ctx).home}/coordinator/known_hosts`,
-	});
-}

package/setup.ts

@@ -1,233 +0,0 @@
-import { dirname } from "node:path";
-import { SYSTEM_STORES } from "@stringsync/splates-server/creds";
-import { fail } from "@stringsync/splates-server/exit";
-import { splatesHome } from "@stringsync/splates-server/models";
-import { Projects } from "@stringsync/splates-server/projects";
-import type { SplatesDeps } from "@stringsync/splates-server/server";
-import {
-	SETUP_AREAS,
-	Setup,
-	type SetupProgress,
-	type StepProgress,
-	type StepStatus,
-	setupProjectAt,
-	type UndoPlan,
-} from "@stringsync/splates-server/setup";
-import {
-	fetchWorkerBudget,
-	fetchWorkers,
-	putWorkerLimit,
-} from "@stringsync/splates-server/workers";
-import type { Logger } from "webappwiz/log";
-import { color } from "webappwiz/log";
-import type { Ps } from "webappwiz/system";
-
-/** What `splates setup` was asked for. */
-export interface SetupOptions {
-	/** A step's id, or empty for every area's progress. */
-	step: string;
-	json: boolean;
-	skip: boolean;
-	unskip: boolean;
-	/** Print what undoing the area `step` names would do. */
-	undo: boolean;
-}
-
-/**
- * `splates setup [step]`: progress by area and the one next step, or one step's
- * why and instructions, after skipping or unskipping it when asked.
- */
-export async function setup(
-	deps: SplatesDeps,
-	opts: SetupOptions,
-): Promise<void> {
-	if (opts.step === "" && (opts.skip || opts.unskip || opts.undo)) {
-		fail("usage", "--skip and --unskip name a step, --undo an area", {});
-	}
-	if (opts.undo && (opts.skip || opts.unskip)) {
-		fail("usage", "--undo names an area, not a step to skip", {
-			area: opts.step,
-		});
-	}
-	if (opts.skip && opts.unskip) {
-		fail("usage", "--skip or --unskip, not both", { step: opts.step });
-	}
-	const machine = await setupOf(deps);
-	const { log } = deps;
-	if (opts.undo) {
-		const plan = await machine.undoPlan(opts.step);
-		if (opts.json) {
-			log.info(JSON.stringify(plan, null, 2));
-			return;
-		}
-		printUndo(log, plan);
-		return;
-	}
-	if (opts.step !== "") {
-		machine.step(opts.step);
-		if (opts.skip) {
-			await machine.skip(opts.step);
-		} else if (opts.unskip) {
-			await machine.unskip(opts.step);
-		}
-	}
-	const progress = await machine.read();
-	if (opts.step === "") {
-		if (opts.json) {
-			log.info(JSON.stringify(progress, null, 2));
-			return;
-		}
-		printProgress(log, progress);
-		return;
-	}
-	const step = progress.areas
-		.flatMap((area) => area.steps)
-		.find((each) => each.id === opts.step) as StepProgress;
-	if (opts.json) {
-		log.info(JSON.stringify(step, null, 2));
-		return;
-	}
-	printStep(log, step);
-}
-
-/**
- * This machine's setup, read through `deps`, for the project `--project`
- * names or the repository the working directory is in, if either.
- */
-export async function setupOf(deps: SplatesDeps): Promise<Setup> {
-	const { fs, ps, secrets = SYSTEM_STORES, fetch } = deps;
-	const root =
-		deps.project === undefined
-			? await repoRoot(ps)
-			: (await Projects.ofMachine(deps).named(deps.project)).root;
-	return new Setup(
-		{
-			fs,
-			ps,
-			home: splatesHome(ps),
-			device: secrets.device,
-			fetch,
-			// Only a server this agent runs under, or is pointed at, can be asked.
-			workers: deps.ps.env("SPLATES_DEV")
-				? () => fetchWorkers({ dev: "", log: deps.log, ps: deps.ps })
-				: undefined,
-			workerBudget: deps.ps.env("SPLATES_DEV")
-				? {
-						report: () =>
-							fetchWorkerBudget({ dev: "", log: deps.log, ps: deps.ps }),
-						set: (limit, dollars) =>
-							putWorkerLimit(limit, dollars, {
-								dev: "",
-								log: deps.log,
-								ps: deps.ps,
-							}),
-					}
-				: undefined,
-			project: root === null ? undefined : setupProjectAt(root, { fs, ps }),
-		},
-		SETUP_AREAS,
-	);
-}
-
-/** The main tree of the repository the working directory is in, or null. */
-async function repoRoot(ps: Ps): Promise<string | null> {
-	const { exitCode, stdout } = await ps.spawnCapture([
-		"git",
-		"-C",
-		ps.cwd(),
-		"rev-parse",
-		"--path-format=absolute",
-		"--git-common-dir",
-	]);
-	return exitCode === 0 ? dirname(stdout.trim()) : null;
-}
-
-const MARKS: Record<StepStatus, string> = {
-	done: color.green("✓"),
-	skipped: color.dim("-"),
-	ready: color.yellow("○"),
-	waiting: color.dim("○"),
-};
-
-function printProgress(log: Logger, progress: SetupProgress): void {
-	for (const area of progress.areas) {
-		const counts = [
-			`${area.done}/${area.steps.length} done`,
-			area.skipped > 0 ? `${area.skipped} skipped` : "",
-		].filter(Boolean);
-		log.info(`${color.bold(area.title)}  ${color.dim(counts.join(", "))}`);
-		for (const step of area.steps) {
-			const notes = [
-				step.optional ? "optional" : "",
-				step.status === "waiting" ? `after ${step.after.join(", ")}` : "",
-				step.problem ?? "",
-				step.warning === null ? "" : "to put right",
-			].filter(Boolean);
-			log.info(
-				`  ${MARKS[step.status]} ${step.id}  ${step.title}${notes.length > 0 ? color.dim(`  ${notes.join("; ")}`) : ""}`,
-			);
-		}
-	}
-	const steps = progress.areas.flatMap((area) => area.steps);
-	const next = steps.find((step) => step.id === progress.next);
-	for (const step of steps.filter((each) => each.warning !== null)) {
-		log.info(
-			`${color.yellow("put right:")} ${step.title}  ${color.dim(`splates setup ${step.id}`)}`,
-		);
-	}
-	log.info(
-		next === undefined
-			? color.green("nothing left to set up")
-			: `next: ${next.title}  ${color.dim(`splates setup ${next.id}`)}`,
-	);
-}
-
-function printStep(log: Logger, step: StepProgress): void {
-	log.info(
-		`${color.bold(step.title)}  ${color.dim(`${step.status}${step.optional ? ", optional" : ""}`)}`,
-	);
-	log.info(step.why);
-	if (step.detail !== null) {
-		log.info(step.detail);
-	}
-	if (step.warning !== null) {
-		log.info(`${color.yellow("put right:")} ${step.warning}`);
-	}
-	log.info(`you:    ${step.user}`);
-	log.info(`agent:  ${step.agent}`);
-	if (step.after.length > 0) {
-		log.info(`after:  ${step.after.join(", ")}`);
-	}
-	if (step.problem !== null) {
-		log.info(`${color.red("problem:")} ${step.problem}`);
-	}
-}
-
-function printUndo(log: Logger, plan: UndoPlan): void {
-	log.info(`${color.bold(`Undo ${plan.title}`)}  ${color.dim(plan.area)}`);
-	if (plan.refused !== null) {
-		log.info(`${color.red("refused:")} ${plan.refused}`);
-		return;
-	}
-	for (const step of plan.steps) {
-		const started = step.done ? "" : `  ${color.yellow("started")}`;
-		log.info(`  ${step.title}  ${color.dim(step.id)}${started}`);
-		for (const line of step.removes) {
-			log.info(`    removes  ${line}`);
-		}
-		for (const line of step.leaves) {
-			log.info(`    leaves   ${line}`);
-		}
-	}
-	for (const cred of plan.creds) {
-		log.info(
-			cred.keptFor === null
-				? `  forgets ${cred.name}`
-				: `  keeps   ${cred.name}  ${color.dim(`${cred.keptFor} still uses it`)}`,
-		);
-	}
-	if (plan.confirm !== null) {
-		log.info(`  the page asks for ${plan.confirm} to be typed`);
-	}
-	log.info(color.dim("the Setup page's Undo does it, after the user confirms"));
-}

package/slots.ts

@@ -1,65 +0,0 @@
-import { type Held, Slots } from "@stringsync/splates-server/ports";
-import type { SplatesDeps } from "@stringsync/splates-server/server";
-import { cli } from "webappwiz/cmd";
-import { z } from "zod";
-
-/** `splates slots`, which the root cli mounts after `splates tunnel`. */
-export const splatesSlots = cli<SplatesDeps>("slots").description(
-	"the words `splates server --slot` hands out on this machine, each held by the tree that claimed it: a task's worktree holds its word until the task merges or is removed, which stops its server and gives the word back",
-);
-
-splatesSlots
-	.command("list")
-	.description(
-		"print each claimed word, the tree holding it, its server's pid while one runs, and whether it is orphaned: its tree gone, or a splates repository's main tree, which every agent shares",
-	)
-	.option("json", z.boolean(), { default: false, description: "emit JSON" })
-	.action(async (opts, ctx) => {
-		const held = await Slots.ofMachine(ctx).status();
-		if (opts.json) {
-			ctx.log.info(
-				JSON.stringify(
-					held.map(({ slot, tree, pid, orphaned }) => ({
-						word: slot.word,
-						tree,
-						pid,
-						orphaned,
-					})),
-				),
-			);
-			return;
-		}
-		if (held.length === 0) {
-			ctx.log.info("no slot is claimed");
-			return;
-		}
-		ctx.log.info(held.map(heldLine).join("\n"));
-	});
-
-splatesSlots
-	.command("prune")
-	.description(
-		"free every orphaned word, stopping its server, so another tree can claim it; the slots a task's worktree holds are that task's, and left alone. The way to free a slot: never kill another tree's server or edit ~/.splates/slots.json",
-	)
-	.action(async (_opts, ctx) => {
-		const freed = await Slots.ofMachine(ctx).prune();
-		if (freed.length === 0) {
-			ctx.log.info(
-				"nothing to prune: each claimed word is held by a task's worktree",
-			);
-			return;
-		}
-		ctx.log.info(
-			freed
-				.map(
-					({ slot, tree, pid }) =>
-						`freed ${slot.word} ${slot.emoji} from ${tree}${pid === null ? "" : `, its server (pid ${pid}) stopped`}`,
-				)
-				.join("\n"),
-		);
-	});
-
-function heldLine({ slot, tree, pid, orphaned }: Held): string {
-	const server = pid === null ? "no server" : `server pid ${pid}`;
-	return `${slot.word} ${slot.emoji}  ${tree}  ${server}${orphaned ? "  orphaned: `splates slots prune` frees it" : ""}`;
-}