@bastani/atomic 0.8.31-alpha.5 → 0.9.0-alpha.2

package/dist/builtin/workflows/src/runs/shared/worktree-setup.ts

@@ -0,0 +1,335 @@
+import { spawnSync } from "node:child_process";
+import * as fs from "node:fs";
+import * as os from "node:os";
+import * as path from "node:path";
+import { APP_NAME } from "@bastani/atomic";
+import { runGit, runGitChecked } from "./worktree-git.js";
+import type {
+	CreateWorktreesOptions,
+	RepoState,
+	ResolvedWorktreeSetupHook,
+	WorktreeInfo,
+	WorktreeSetup,
+	WorktreeSetupHookConfig,
+	WorktreeSetupHookInput,
+	WorktreeSetupHookOutput,
+	WorktreeTaskCwdConflict,
+} from "./worktree-types.js";
+
+const DEFAULT_WORKTREE_SETUP_HOOK_TIMEOUT_MS = 30000;
+
+function resolveRepoState(cwd: string): RepoState {
+	const cwdRelative = resolveRepoCwdRelative(cwd);
+	const toplevel = runGitChecked(cwd, ["rev-parse", "--show-toplevel"]).trim();
+
+	const status = runGitChecked(toplevel, ["status", "--porcelain"]);
+	if (status.trim().length > 0) {
+		throw new Error("worktree isolation requires a clean git working tree. Commit or stash changes first.");
+	}
+
+	const baseCommit = runGitChecked(toplevel, ["rev-parse", "HEAD"]).trim();
+	return { toplevel, cwdRelative, baseCommit };
+}
+
+function normalizeComparableCwd(cwd: string): string {
+	const resolved = path.resolve(cwd);
+	try {
+		return fs.realpathSync(resolved);
+	} catch {
+		// Use the unresolved absolute path when realpath resolution is unavailable.
+		return resolved;
+	}
+}
+
+export function findWorktreeTaskCwdConflict(
+	tasks: ReadonlyArray<{ agent: string; cwd?: string }>,
+	sharedCwd: string,
+): WorktreeTaskCwdConflict | undefined {
+	const normalizedSharedCwd = normalizeComparableCwd(sharedCwd);
+	for (let index = 0; index < tasks.length; index++) {
+		const task = tasks[index]!;
+		if (!task.cwd) continue;
+		const taskCwd = path.isAbsolute(task.cwd) ? task.cwd : path.resolve(sharedCwd, task.cwd);
+		if (normalizeComparableCwd(taskCwd) === normalizedSharedCwd) continue;
+		return { index, agent: task.agent, cwd: task.cwd };
+	}
+	return undefined;
+}
+
+export function formatWorktreeTaskCwdConflict(
+	conflict: WorktreeTaskCwdConflict,
+	sharedCwd: string,
+): string {
+	return `worktree isolation uses the shared cwd (${sharedCwd}); task ${conflict.index + 1} (${conflict.agent}) sets cwd to ${conflict.cwd}. Remove task-level cwd overrides or disable worktree.`;
+}
+
+function buildWorktreeBranch(runId: string, index: number): string {
+	return `${APP_NAME}-parallel-${runId}-${index}`;
+}
+
+function buildWorktreePath(runId: string, index: number): string {
+	return path.join(os.tmpdir(), `${APP_NAME}-worktree-${runId}-${index}`);
+}
+
+function resolveRepoCwdRelative(cwd: string): string {
+	const repoCheck = runGit(cwd, ["rev-parse", "--is-inside-work-tree"]);
+	if (repoCheck.status !== 0 || repoCheck.stdout.trim() !== "true") {
+		throw new Error("worktree isolation requires a git repository");
+	}
+	const rawPrefix = runGitChecked(cwd, ["rev-parse", "--show-prefix"]).trim();
+	const normalizedPrefix = rawPrefix
+		? path.normalize(rawPrefix.replace(/[\\/]+$/, ""))
+		: "";
+	return normalizedPrefix === "." ? "" : normalizedPrefix;
+}
+
+export function resolveExpectedWorktreeAgentCwd(cwd: string, runId: string, index: number): string {
+	const cwdRelative = resolveRepoCwdRelative(cwd);
+	const worktreePath = buildWorktreePath(runId, index);
+	return cwdRelative ? path.join(worktreePath, cwdRelative) : worktreePath;
+}
+
+function linkNodeModulesIfPresent(toplevel: string, worktreePath: string): boolean {
+	const nodeModulesPath = path.join(toplevel, "node_modules");
+	const nodeModulesLinkPath = path.join(worktreePath, "node_modules");
+	if (!fs.existsSync(nodeModulesPath) || fs.existsSync(nodeModulesLinkPath)) return false;
+	try {
+		fs.symlinkSync(nodeModulesPath, nodeModulesLinkPath);
+		return true;
+	} catch {
+		// Symlink creation is optional (e.g., unsupported filesystems on CI runners).
+		return false;
+	}
+}
+
+function parseHookTimeout(timeoutMs: number | undefined): number {
+	if (timeoutMs === undefined) return DEFAULT_WORKTREE_SETUP_HOOK_TIMEOUT_MS;
+	if (!Number.isInteger(timeoutMs) || timeoutMs <= 0) {
+		throw new Error("worktree setup hook timeout must be an integer greater than 0");
+	}
+	return timeoutMs;
+}
+
+function resolveWorktreeSetupHook(
+	repoRoot: string,
+	config: WorktreeSetupHookConfig | undefined,
+): ResolvedWorktreeSetupHook | undefined {
+	if (!config) return undefined;
+	const hookPath = config.hookPath.trim();
+	if (!hookPath) {
+		throw new Error("worktree setup hook path cannot be empty");
+	}
+
+	const expandedHookPath = hookPath.startsWith("~/") ? path.join(os.homedir(), hookPath.slice(2)) : hookPath;
+	let resolvedPath: string;
+	if (path.isAbsolute(expandedHookPath)) {
+		resolvedPath = expandedHookPath;
+	} else if (expandedHookPath.includes("/") || expandedHookPath.includes("\\")) {
+		resolvedPath = path.resolve(repoRoot, expandedHookPath);
+	} else {
+		throw new Error("worktree setup hook must be an absolute path or a repo-relative path");
+	}
+
+	if (!fs.existsSync(resolvedPath)) {
+		throw new Error(`worktree setup hook not found: ${resolvedPath}`);
+	}
+	if (fs.statSync(resolvedPath).isDirectory()) {
+		throw new Error(`worktree setup hook must be a file, got directory: ${resolvedPath}`);
+	}
+
+	return {
+		hookPath: resolvedPath,
+		timeoutMs: parseHookTimeout(config.timeoutMs),
+	};
+}
+
+function normalizeSyntheticPath(worktreePath: string, rawPath: string): string {
+	const trimmed = rawPath.trim();
+	if (!trimmed) throw new Error("synthetic path cannot be empty");
+	if (path.isAbsolute(trimmed)) throw new Error(`synthetic path must be relative: ${rawPath}`);
+
+	const resolved = path.resolve(worktreePath, trimmed);
+	const relative = path.relative(worktreePath, resolved);
+	if (!relative || relative === ".") {
+		throw new Error(`synthetic path cannot target the worktree root: ${rawPath}`);
+	}
+	if (relative === ".." || relative.startsWith(`..${path.sep}`) || path.isAbsolute(relative)) {
+		throw new Error(`synthetic path escapes the worktree root: ${rawPath}`);
+	}
+	return path.normalize(relative);
+}
+
+function hasTrackedEntries(worktreePath: string, relativePath: string): boolean {
+	const result = runGit(worktreePath, ["ls-files", "--", relativePath]);
+	return result.status === 0 && result.stdout.trim().length > 0;
+}
+
+function parseWorktreeSetupHookOutput(rawStdout: string): WorktreeSetupHookOutput {
+	const trimmed = rawStdout.trim();
+	if (!trimmed) {
+		throw new Error("worktree setup hook returned empty stdout; expected JSON object");
+	}
+	let parsed: unknown;
+	try {
+		parsed = JSON.parse(trimmed);
+	} catch (error) {
+		const message = error instanceof Error ? error.message : String(error);
+		throw new Error(`worktree setup hook returned invalid JSON: ${message}`);
+	}
+	if (!parsed || typeof parsed !== "object" || Array.isArray(parsed)) {
+		throw new Error("worktree setup hook stdout must be a JSON object");
+	}
+	return parsed as WorktreeSetupHookOutput;
+}
+
+function runWorktreeSetupHook(
+	hook: ResolvedWorktreeSetupHook,
+	input: WorktreeSetupHookInput,
+): string[] {
+	const result = spawnSync(hook.hookPath, [], {
+		cwd: input.worktreePath,
+		encoding: "utf-8",
+		input: JSON.stringify(input),
+		timeout: hook.timeoutMs,
+		shell: false,
+	});
+
+	if (result.error) {
+		const code = "code" in result.error ? result.error.code : undefined;
+		if (code === "ETIMEDOUT") {
+			throw new Error(`worktree setup hook timed out after ${hook.timeoutMs}ms`);
+		}
+		throw new Error(`worktree setup hook failed: ${result.error.message}`);
+	}
+
+	if (result.status !== 0) {
+		const details = result.stderr.trim() || result.stdout.trim() || "no output";
+		throw new Error(`worktree setup hook failed with exit code ${result.status}: ${details}`);
+	}
+
+	const output = parseWorktreeSetupHookOutput(result.stdout);
+	if (output.syntheticPaths === undefined) return [];
+	if (!Array.isArray(output.syntheticPaths)) {
+		throw new Error("worktree setup hook output field 'syntheticPaths' must be an array of relative paths");
+	}
+
+	const uniquePaths = new Set<string>();
+	for (const candidate of output.syntheticPaths) {
+		if (typeof candidate !== "string") {
+			throw new Error("worktree setup hook output field 'syntheticPaths' must contain only strings");
+		}
+		const normalizedPath = normalizeSyntheticPath(input.worktreePath, candidate);
+		if (hasTrackedEntries(input.worktreePath, normalizedPath)) {
+			throw new Error(`worktree setup hook cannot mark tracked paths as synthetic: ${normalizedPath}`);
+		}
+		uniquePaths.add(normalizedPath);
+	}
+	return [...uniquePaths];
+}
+
+function createSingleWorktree(
+	toplevel: string,
+	cwdRelative: string,
+	runId: string,
+	index: number,
+	baseCommit: string,
+	setupHook: ResolvedWorktreeSetupHook | undefined,
+	agent: string | undefined,
+): WorktreeInfo {
+	const branch = buildWorktreeBranch(runId, index);
+	const worktreePath = buildWorktreePath(runId, index);
+	const add = runGit(toplevel, ["worktree", "add", worktreePath, "-b", branch, "HEAD"]);
+	if (add.status !== 0) {
+		const message = add.stderr.trim() || add.stdout.trim() || `failed to create worktree ${worktreePath}`;
+		throw new Error(message);
+	}
+
+	const agentCwd = cwdRelative ? path.join(worktreePath, cwdRelative) : worktreePath;
+	try {
+		const nodeModulesLinked = linkNodeModulesIfPresent(toplevel, worktreePath);
+		const syntheticPaths = nodeModulesLinked ? ["node_modules"] : [];
+
+		if (setupHook) {
+			const hookSyntheticPaths = runWorktreeSetupHook(setupHook, {
+				version: 1,
+				repoRoot: toplevel,
+				worktreePath,
+				agentCwd,
+				branch,
+				index,
+				runId,
+				baseCommit,
+				agent,
+			});
+			syntheticPaths.push(...hookSyntheticPaths);
+		}
+
+		return {
+			path: worktreePath,
+			agentCwd,
+			branch,
+			index,
+			nodeModulesLinked,
+			syntheticPaths,
+		};
+	} catch (error) {
+		try { runGitChecked(toplevel, ["worktree", "remove", "--force", worktreePath]); } catch {
+			// Best-effort rollback; preserve the original setup failure.
+		}
+		try { runGitChecked(toplevel, ["branch", "-D", branch]); } catch {
+			// Best-effort rollback; preserve the original setup failure.
+		}
+		throw error;
+	}
+}
+
+function cleanupSingleWorktree(repoCwd: string, worktree: WorktreeInfo): void {
+	try { runGitChecked(repoCwd, ["worktree", "remove", "--force", worktree.path]); } catch {
+		// Cleanup is best-effort to avoid masking caller errors.
+	}
+	try { runGitChecked(repoCwd, ["branch", "-D", worktree.branch]); } catch {
+		// Cleanup is best-effort to avoid masking caller errors.
+	}
+}
+
+export function createWorktrees(cwd: string, runId: string, count: number, options?: CreateWorktreesOptions): WorktreeSetup {
+	const repo = resolveRepoState(cwd);
+	const setupHook = resolveWorktreeSetupHook(repo.toplevel, options?.setupHook);
+	const worktrees: WorktreeInfo[] = [];
+
+	try {
+		for (let index = 0; index < count; index++) {
+			worktrees.push(createSingleWorktree(
+				repo.toplevel,
+				repo.cwdRelative,
+				runId,
+				index,
+				repo.baseCommit,
+				setupHook,
+				options?.agents?.[index],
+			));
+		}
+	} catch (error) {
+		cleanupWorktrees({
+			cwd: repo.toplevel,
+			worktrees,
+			baseCommit: repo.baseCommit,
+		});
+		throw error;
+	}
+
+	return {
+		cwd: repo.toplevel,
+		worktrees,
+		baseCommit: repo.baseCommit,
+	};
+}
+
+export function cleanupWorktrees(setup: WorktreeSetup): void {
+	for (let index = setup.worktrees.length - 1; index >= 0; index--) {
+		cleanupSingleWorktree(setup.cwd, setup.worktrees[index]!);
+	}
+	try { runGitChecked(setup.cwd, ["worktree", "prune"]); } catch {
+		// Pruning is best-effort cleanup.
+	}
+}

package/dist/builtin/workflows/src/runs/shared/worktree-types.ts

@@ -0,0 +1,92 @@
+export interface WorktreeSetup {
+	cwd: string;
+	worktrees: WorktreeInfo[];
+	baseCommit: string;
+}
+
+export interface WorktreeInfo {
+	path: string;
+	agentCwd: string;
+	branch: string;
+	index: number;
+	nodeModulesLinked: boolean;
+	syntheticPaths: string[];
+}
+
+export interface WorktreeDiff {
+	index: number;
+	agent: string;
+	branch: string;
+	diffStat: string;
+	filesChanged: number;
+	insertions: number;
+	deletions: number;
+	patchPath: string;
+}
+
+export interface WorktreeTaskCwdConflict {
+	index: number;
+	agent: string;
+	cwd: string;
+}
+
+export interface WorktreeSetupHookConfig {
+	hookPath: string;
+	timeoutMs?: number;
+}
+
+export interface CreateWorktreesOptions {
+	agents?: string[];
+	setupHook?: WorktreeSetupHookConfig;
+}
+
+export interface ResolvedWorktreeSetupHook {
+	hookPath: string;
+	timeoutMs: number;
+}
+
+export interface WorktreeSetupHookInput {
+	version: 1;
+	repoRoot: string;
+	worktreePath: string;
+	agentCwd: string;
+	branch: string;
+	index: number;
+	runId: string;
+	baseCommit: string;
+	agent?: string;
+}
+
+export interface WorktreeSetupHookOutput {
+	syntheticPaths?: string[];
+}
+
+export interface GitResult {
+	stdout: string;
+	stderr: string;
+	status: number | null;
+	error?: Error;
+}
+
+export interface GitWorktreeSetupOptions {
+	gitWorktreeDir: string;
+	baseBranch?: string;
+	cwd: string;
+}
+
+export interface GitWorktreeSetupResult {
+	/** Root checkout path that was requested/created/reused. */
+	worktreeRoot: string;
+	/** Effective workflow cwd, preserving the caller's repo-relative subdirectory inside the worktree. */
+	cwd: string;
+	/** Invoking checkout root reported by Git. */
+	repositoryRoot: string;
+	/** Whether this call created a new linked worktree. Existing roots are reused as-is. */
+	created: boolean;
+}
+
+export interface RepoState {
+	toplevel: string;
+	cwdRelative: string;
+	baseCommit: string;
+}