@joshuafolkken/kit 1.1383.0 → 1.1435.0

package/scripts/followup/git-followup-finish.ts

@@ -1,4 +1,5 @@
 import { git_next_issues } from '#scripts/issue/git-next-issues'
+import { issue_watch } from '#scripts/issue/issue-watch'
 import { review_attest } from '#scripts/review/review-attest'
 import { review_stamps } from '#scripts/review/review-stamps'
 import { run_hold } from '#scripts/run/hold/run-hold'
@@ -67,11 +68,24 @@ async function clear_review_target(should_merge: boolean): Promise<void> {
 	}
 }
 
-// The two review records are one step of the tail: both are cleared by a merged run and neither is
-// worth reporting on its own.
+// The issue watch ends with the run it watched: a record left behind would make the next run's hook
+// poll an issue that is no longer its own.
+async function clear_issue_watch(should_merge: boolean): Promise<void> {
+	if (!should_merge) return
+
+	try {
+		await issue_watch.clear_here()
+	} catch {
+		/* the next `josh run:entry` replaces the record */
+	}
+}
+
+// The review records and the issue watch are one step of the tail: all are cleared by a merged run
+// and none is worth reporting on its own.
 async function clear_review_records(should_merge: boolean): Promise<void> {
 	clear_round_one_snapshot(should_merge)
 	await clear_review_target(should_merge)
+	await clear_issue_watch(should_merge)
 }
 
 // The working-tree hold a typed entry point claims before it starts is released here, on the one seam every `fullrun` — and every child of an `epicrun` or a `queue` —

package/scripts/followup/git-followup-workflow.ts

@@ -3,6 +3,7 @@ import { parseArgs } from 'node:util'
 import { git_branch } from '#scripts/git/git-branch'
 import { git_error } from '#scripts/git/git-error'
 import { issue_number_shape } from '#scripts/issue/issue-number-shape'
+import { issue_watch_gate } from '#scripts/issue/issue-watch-gate'
 import { cli_body } from '#scripts/josh/cli-body'
 import { josh_environment_file } from '#scripts/josh/josh-environment-file'
 import { git_notify, type GitNotifyConfig } from '#scripts/notify/git-notify'
@@ -151,9 +152,11 @@ async function assert_review_attested(should_merge: boolean): Promise<void> {
 
 	const verdict = await review_attest.check_here()
 
-	if (is_merge_permitted(verdict.status)) return
+	if (!is_merge_permitted(verdict.status)) throw new Error(review_attest.refusal_message(verdict))
+
+	const refusal = await issue_watch_gate.review_refusal_here()
 
-	throw new Error(review_attest.refusal_message(verdict))
+	if (refusal !== undefined) throw new Error(refusal)
 }
 
 // Recording a review round as a prose request leaves the recurrence ledger blind whenever it is

package/scripts/followup/git-pr-followup-checks.ts

@@ -4,9 +4,11 @@ import {
 	DEFAULT_STABLE_READS,
 	git_pr_checks,
 	WATCH_CONFIRMED_STABLE_READS,
+	type SnapshotObserver,
 } from '#scripts/gh/git-pr-checks'
 import { is_coderabbit_check } from '#scripts/gh/git-pr-checks-eval'
 import { CHECK_STATUS_PASS, type PrStateSnapshot } from '#scripts/gh/git-pr-checks-parse'
+import { issue_watch_gate } from '#scripts/issue/issue-watch-gate'
 import { json_value } from '#scripts/lib/json-value'
 
 // The check wait and the notes read off its snapshot — split out of `git-pr-followup.ts` when it
@@ -75,12 +77,15 @@ async function handle_watch_failure(branch_name: string, error: unknown): Promis
 // reads the wait still needs. A timed-out watch (`timed_out: true`) never spanned the pending→settled
 // window, so it must keep the full stable-read window rather than claim the confirmation. A rethrown
 // failure — the empty-rollup case — never reaches a caller, so it needs no answer here.
-async function watch_before_polling(branch_name: string): Promise<boolean> {
+async function watch_before_polling(
+	branch_name: string,
+	observe: SnapshotObserver | undefined,
+): Promise<boolean> {
 	console.info('')
 	console.info('📊 Watching PR checks...')
 
 	try {
-		const result = await git_gh_command.pr_checks_watch(branch_name)
+		const result = await git_gh_command.pr_checks_watch(branch_name, observe)
 
 		return !result.timed_out
 	} catch (error) {
@@ -95,14 +100,23 @@ async function watch_before_polling(branch_name: string): Promise<boolean> {
 // once rather than twice — which removes the extra interval `followup` spent re-proving a settled run.
 // A skipped or fallen-through watch keeps `DEFAULT_STABLE_READS`, and a check that turned red is still
 // caught: the poll evaluates the full merge gate and throws on failure before any stable read counts.
+// `observe` is shown each poll's snapshot, the watch's included — the run's `pr-checks` line
+// (joshuafolkken/kit#3770).
 async function run_checks(input: {
 	branch_name: string
 	is_skip_watch: boolean
+	observe?: SnapshotObserver
 }): Promise<PrStateSnapshot> {
-	const is_watch_confirmed = !input.is_skip_watch && (await watch_before_polling(input.branch_name))
+	const is_watch_confirmed =
+		!input.is_skip_watch && (await watch_before_polling(input.branch_name, input.observe))
 	const stable_reads = is_watch_confirmed ? WATCH_CONFIRMED_STABLE_READS : DEFAULT_STABLE_READS
 
-	return await git_pr_checks.wait_for_pr_success(input.branch_name, stable_reads)
+	return await git_pr_checks.wait_for_pr_success(
+		input.branch_name,
+		stable_reads,
+		issue_watch_gate.assert_read_here,
+		input.observe,
+	)
 }
 
 // Temporary: record every CodeRabbit check that was not passing when the merge gate

package/scripts/followup/git-pr-followup-wrapup.ts

@@ -1,5 +1,6 @@
 import { epic_close } from '#scripts/epic/epic-close'
 import { git_gh_command } from '#scripts/gh/git-gh-command'
+import { issue_watch_gate } from '#scripts/issue/issue-watch-gate'
 import { git_notify, type GitNotifyConfig } from '#scripts/notify/git-notify'
 import { git_followup_cleanup } from './git-followup-cleanup'
 import { git_followup_issue_close } from './git-followup-issue-close'
@@ -232,8 +233,12 @@ async function run_tail_steps(input: WrapupInput): Promise<void> {
 	])
 }
 
+// The last look at the issue before the merge: the CI poll checked it on every iteration, but a
+// person's update can land between that poll and this step, and only the seconds after this read are
+// left unwatched.
 async function run_wrapup(input: WrapupInput, log: StageLog): Promise<void> {
 	if (input.should_merge && input.is_merged !== true) {
+		await issue_watch_gate.assert_read_here()
 		await git_gh_command.pr_merge(input.branch_name)
 		lap(log, STAGE.merge)
 	}

package/scripts/followup/git-pr-followup.ts

@@ -10,6 +10,7 @@ import {
 	type TelegramSendInput,
 	type TelegramTaskType,
 } from '#scripts/notify/telegram-notify'
+import { followup_checks_event } from './followup-checks-event'
 import { git_followup_merged } from './git-followup-merged'
 import { git_followup_pending } from './git-followup-pending'
 import { git_followup_stages, type StageLog } from './git-followup-stages'
@@ -229,6 +230,7 @@ async function run_review_checks(
 	input: FollowupInput,
 	context: TelegramContext,
 	log: StageLog,
+	issue_number: string | undefined,
 ): Promise<{ notes: Array<string>; managed: Array<string> }> {
 	if (input.is_merged === true) return { notes: [], managed: [] }
 
@@ -238,6 +240,7 @@ async function run_review_checks(
 	const snapshot = await run_checks({
 		branch_name: input.branch_name,
 		is_skip_watch: input.is_skip_watch,
+		observe: followup_checks_event.observer_of(issue_number, context.pr_url),
 	})
 
 	lap(log, STAGE.checks_wait)
@@ -278,7 +281,7 @@ async function run_stages(input: FollowupInput, log: StageLog): Promise<string |
 	const { issue_number, closes_number, context } = await read_run_context(input)
 
 	lap(log, STAGE.closes_and_context)
-	const checks = await run_review_checks(input, context, log)
+	const checks = await run_review_checks(input, context, log, issue_number)
 	const is_completion_recorded = await notify_unless_recorded(input, issue_number, context, checks)
 
 	lap(log, STAGE.telegram)

package/scripts/fresh-machine/fresh-machine-cli.ts

@@ -0,0 +1,204 @@
+#!/usr/bin/env tsx
+import { mkdirSync, readdirSync, readFileSync } from 'node:fs'
+import path from 'node:path'
+import { fileURLToPath } from 'node:url'
+import { parseArgs } from 'node:util'
+import { claude_token } from '#scripts/auth/claude-token'
+import { gh_cli_token } from '#scripts/gh/gh-cli-token'
+import { git_gh_exec } from '#scripts/gh/git-gh-exec'
+import { PROJECT_ROOT } from '#scripts/init/init-paths'
+import { self_sync_guard } from '#scripts/self-sync-guard/self-sync-guard-logic'
+import { KIT_PACKAGE_NAME } from '#scripts/version/kit-descriptor'
+import { fresh_machine_docker } from './fresh-machine-docker'
+import { fresh_machine_log } from './fresh-machine-log'
+import { fresh_machine_patterns } from './fresh-machine-patterns'
+import { fresh_machine_run, type RunRequest } from './fresh-machine-run'
+import { fresh_machine_spec, type Scenario } from './fresh-machine-spec'
+
+// `josh fresh:run <pattern>` / `josh fresh:run --spec <file>` — run one scenario on a machine that
+// has nothing installed, and keep what happened as a log.
+
+const ARGV_OFFSET = 2
+const FAILURE_EXIT_CODE = 1
+const USAGE =
+	'Usage: josh fresh:run <pattern> | --spec <file.json> [--package-version <version>] [--log-dir <dir>] [--rebuild] | --list'
+// The scratch directory kit's distributed `.gitignore` already ignores, so a log is never committed
+// from kit or from a consumer toolkit.
+const DEFAULT_LOG_DIRECTORY = '.claude/tmp/fresh-machine'
+const NO_GITHUB_TOKEN =
+	'This scenario uses GitHub and `gh auth token` printed no token. Run `gh auth login` on this machine first.'
+const NO_CLAUDE_TOKEN = `This scenario uses Claude Code and neither the macOS keychain nor ${claude_token.VARIABLE} holds a token. ${claude_token.SETUP_HINT}`
+// The patterns install kit by name, while the tarball and the published version are those of the
+// checkout the command is run from — in a toolkit's checkout the two would be different packages.
+const NOT_A_KIT_CHECKOUT = `The named patterns install ${KIT_PACKAGE_NAME} and run from its checkout only. Write this package's scenario as a JSON file and pass it with --spec.`
+const OWNED_REPOSITORIES = 'user/repos?affiliation=owner&per_page=100'
+const REPOSITORY_NAMES = '.[].name'
+
+// The option names are the CLI's, so the type is read off the parser rather than restated.
+// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+function parse(argv: ReadonlyArray<string>) {
+	return parseArgs({
+		args: [...argv],
+		allowPositionals: true,
+		options: {
+			spec: { type: 'string' },
+			'package-version': { type: 'string' },
+			'log-dir': { type: 'string' },
+			rebuild: { type: 'boolean' },
+			list: { type: 'boolean' },
+		},
+	})
+}
+
+type CliValues = ReturnType<typeof parse>['values']
+
+function pattern_of(name: string): Scenario | undefined {
+	const scenario = fresh_machine_patterns.find(name)
+
+	if (scenario === undefined) return undefined
+
+	const is_kit_checkout = self_sync_guard.read_package_name(PROJECT_ROOT) === KIT_PACKAGE_NAME
+
+	if (!is_kit_checkout) throw new Error(NOT_A_KIT_CHECKOUT)
+
+	return scenario
+}
+
+function scenario_of(values: CliValues, pattern: string | undefined): Scenario | undefined {
+	if (values.spec !== undefined) {
+		return fresh_machine_spec.parse(readFileSync(path.resolve(PROJECT_ROOT, values.spec), 'utf8'))
+	}
+
+	return pattern === undefined ? undefined : pattern_of(pattern)
+}
+
+// A GitHub run's name is also the repository it creates under the account of the token, and the
+// logs of this checkout are not the only place such a run was started from.
+function repositories_of(scenario: Scenario): Array<string> {
+	if (!scenario.requires_github) return []
+
+	const names = git_gh_exec.exec_gh_api_sync({
+		path: OWNED_REPOSITORIES,
+		should_paginate: true,
+		jq_filter: REPOSITORY_NAMES,
+	})
+
+	return names.split('\n').filter((name) => name !== '')
+}
+
+function request_of(
+	scenario: Scenario,
+	values: CliValues,
+	secrets: Record<string, string>,
+): RunRequest {
+	const log_directory = path.resolve(PROJECT_ROOT, values['log-dir'] ?? DEFAULT_LOG_DIRECTORY)
+
+	mkdirSync(log_directory, { recursive: true })
+
+	const run_name = fresh_machine_log.next_name(scenario.name, {
+		logs: readdirSync(log_directory),
+		repositories: repositories_of(scenario),
+	})
+
+	return {
+		scenario,
+		run_name,
+		log_path: path.join(log_directory, fresh_machine_log.file_name(run_name)),
+		package_version: values['package-version'],
+		secrets,
+		is_rebuild: values.rebuild === true,
+	}
+}
+
+function refuse(message: string): number {
+	console.error(message)
+
+	return FAILURE_EXIT_CODE
+}
+
+// One secret a scenario asks for: where its value is read on the host, and what to say when there is
+// none. Every one is read before Docker starts, so a missing token stops the run with nothing built.
+interface Secret {
+	variable: string
+	is_required: (scenario: Scenario) => boolean
+	read: () => string | undefined
+	missing: string
+}
+
+const SECRETS: ReadonlyArray<Secret> = [
+	{
+		variable: fresh_machine_docker.TOKEN_VARIABLE,
+		is_required: (scenario) => scenario.requires_github,
+		read: gh_cli_token.get,
+		missing: NO_GITHUB_TOKEN,
+	},
+	{
+		variable: claude_token.VARIABLE,
+		is_required: (scenario) => scenario.requires_claude,
+		read: claude_token.read,
+		missing: NO_CLAUDE_TOKEN,
+	},
+]
+
+// The values found, by variable name, and the message of the first secret that has none.
+interface Secrets {
+	values: Record<string, string>
+	missing: string | undefined
+}
+
+function secrets_of(scenario: Scenario): Secrets {
+	const required = SECRETS.filter((secret) => secret.is_required(scenario))
+	const read = required.map((secret) => ({ secret, value: secret.read() }))
+	const found = read.flatMap(({ secret, value }) =>
+		value === undefined ? [] : [[secret.variable, value] as const],
+	)
+
+	return {
+		values: Object.fromEntries(found),
+		missing: read.find(({ value }) => value === undefined)?.secret.missing,
+	}
+}
+
+async function run_scenario(scenario: Scenario, values: CliValues): Promise<number> {
+	const secrets = secrets_of(scenario)
+
+	if (secrets.missing !== undefined) return refuse(secrets.missing)
+
+	const request = request_of(scenario, values, secrets.values)
+	const exit_code = await fresh_machine_run.run(request)
+
+	console.info(`Log: ${request.log_path}`)
+
+	return exit_code
+}
+
+async function run(argv: ReadonlyArray<string>): Promise<number> {
+	const { values, positionals } = parse(argv)
+	const patterns = fresh_machine_patterns.names().join('\n')
+
+	if (values.list === true) {
+		console.info(patterns)
+
+		return 0
+	}
+
+	const scenario = scenario_of(values, positionals[0])
+
+	if (scenario === undefined) return refuse(`${USAGE}\n\nPatterns:\n${patterns}`)
+
+	return await run_scenario(scenario, values)
+}
+
+async function main(argv: ReadonlyArray<string>): Promise<void> {
+	try {
+		process.exitCode = await run(argv)
+	} catch (error) {
+		process.exitCode = refuse(error instanceof Error ? error.message : String(error))
+	}
+}
+
+const fresh_machine_cli = { run }
+
+if (process.argv[1] === fileURLToPath(import.meta.url)) await main(process.argv.slice(ARGV_OFFSET))
+
+export { fresh_machine_cli }

package/scripts/fresh-machine/fresh-machine-docker.ts

@@ -0,0 +1,65 @@
+import { fresh_machine_script } from './fresh-machine-script'
+
+// The two docker invocations of `josh fresh:run`, as argument lists. A token is passed by name only
+// (`--env GH_TOKEN`): docker reads its value from the environment of the client, so it is in no
+// argument, no image layer and no printed command.
+
+const TOKEN_VARIABLE = 'GH_TOKEN'
+const ENV_FLAG = '--env'
+const VOLUME_FLAG = '--volume'
+
+interface ContainerRun {
+	image: string
+	run_name: string
+	script: string
+	seed_directory: string
+	pack_directory: string
+	// The packed checkout's file name inside `pack_directory`, for a tarball scenario.
+	tarball: string | undefined
+	package_version: string | undefined
+	// The variables whose values the client's environment carries into the container.
+	secret_names: ReadonlyArray<string>
+}
+
+// The Dockerfile arrives on stdin (`-`), so the build has no context to copy a host file from.
+function build_arguments(image: string, is_rebuild: boolean): Array<string> {
+	const cache = is_rebuild ? ['--no-cache'] : []
+
+	return ['build', '--progress', 'plain', ...cache, '--tag', image, '-']
+}
+
+function variables(container: ContainerRun): Array<string> {
+	const { tarball } = container
+	const tarball_path = tarball === undefined ? '' : `${fresh_machine_script.PACK_MOUNT}/${tarball}`
+	const assignments = [
+		`RUN_NAME=${container.run_name}`,
+		`PACKAGE_TARBALL=${tarball_path}`,
+		`PACKAGE_VERSION=${container.package_version ?? ''}`,
+		...container.secret_names,
+	]
+
+	return assignments.flatMap((assignment) => [ENV_FLAG, assignment])
+}
+
+// `bash -i` is the new terminal the prerequisites guide asks for: it reads the profile the pnpm
+// installer edited, which a non-interactive shell on Debian returns from before reaching.
+function run_arguments(container: ContainerRun): Array<string> {
+	return [
+		'run',
+		'--rm',
+		...variables(container),
+		VOLUME_FLAG,
+		`${container.seed_directory}:${fresh_machine_script.SEED_MOUNT}:ro`,
+		VOLUME_FLAG,
+		`${container.pack_directory}:${fresh_machine_script.PACK_MOUNT}:ro`,
+		container.image,
+		'bash',
+		'-ic',
+		container.script,
+	]
+}
+
+const fresh_machine_docker = { build_arguments, run_arguments, TOKEN_VARIABLE }
+
+export { fresh_machine_docker }
+export type { ContainerRun }

package/scripts/fresh-machine/fresh-machine-image.ts

@@ -0,0 +1,62 @@
+// The "fresh machine" of `josh fresh:run`: a Debian image with curl and without Node.js, pnpm, git or
+// gh, on which a normal user runs the Linux route of `docs/setup/prerequisites.md` and nothing else.
+// The Dockerfile is built here rather than kept as a file because `docs/` is not in the published
+// package and a consumer toolkit builds the same machine; `fresh-machine-image.test.ts` holds the
+// commands below to the guide's own lines.
+
+const BASE_IMAGE = 'buildpack-deps:bookworm-curl'
+const MACHINE_USER = 'dev'
+const HOME_DIRECTORY = `/home/${MACHINE_USER}`
+const TAG_PREFIX = 'josh-fresh-machine'
+
+// `docs/setup/prerequisites.md` → "Linux and macOS". The first line runs in the shell a new machine
+// starts with; the guide then says to open a new terminal, which is what `NEW_TERMINAL` does.
+const INSTALL_PNPM = 'curl -fsSL https://get.pnpm.io/install.sh | sh -'
+const NEW_TERMINAL_COMMANDS = ['pnpm runtime set node 22 -g', 'node --version']
+
+// The guide sends a Linux reader to the gh installation page; these are that page's Debian steps,
+// run as root in place of `sudo`, with the curl the image already has. git comes from the same
+// package manager, and so does procps: kit's lane commands read processes with its ps and pgrep, which
+// the slim base image does not ship. Only a GitHub scenario's machine has any of them.
+const KEYRING = '/etc/apt/keyrings/githubcli-archive-keyring.gpg'
+const APT_UPDATE = 'apt-get update'
+const GITHUB_TOOLS = [
+	APT_UPDATE,
+	'apt-get install -y git procps',
+	'mkdir -p -m 755 /etc/apt/keyrings',
+	`curl -fsSL https://cli.github.com/packages/githubcli-archive-keyring.gpg -o ${KEYRING}`,
+	`chmod go+r ${KEYRING}`,
+	`echo "deb [arch=$(dpkg --print-architecture) signed-by=${KEYRING}] https://cli.github.com/packages stable main" > /etc/apt/sources.list.d/github-cli.list`,
+	APT_UPDATE,
+	'apt-get install -y gh',
+].join(' && ')
+
+function new_terminal(command: string): string {
+	return `RUN bash -ic '${command}'`
+}
+
+// `SHELL` is the one line the guide does not have: the pnpm installer reads it to pick the profile
+// it edits, and a container build does not set it.
+function dockerfile(requires_github: boolean): string {
+	const github_tools = requires_github ? [`RUN ${GITHUB_TOOLS}`] : []
+
+	return [
+		`FROM ${BASE_IMAGE}`,
+		...github_tools,
+		`RUN useradd --create-home --shell /bin/bash ${MACHINE_USER}`,
+		`USER ${MACHINE_USER}`,
+		`WORKDIR ${HOME_DIRECTORY}`,
+		'ENV SHELL=/bin/bash',
+		`RUN ${INSTALL_PNPM}`,
+		...NEW_TERMINAL_COMMANDS.map((command) => new_terminal(command)),
+		'',
+	].join('\n')
+}
+
+function tag(requires_github: boolean): string {
+	return `${TAG_PREFIX}:${requires_github ? 'github' : 'base'}`
+}
+
+const fresh_machine_image = { dockerfile, tag }
+
+export { fresh_machine_image }

package/scripts/fresh-machine/fresh-machine-log.ts

@@ -0,0 +1,61 @@
+// The two rules a `josh fresh:run` log follows: a run never reuses a name, and no token passed to
+// the container reaches the file.
+
+const LOG_EXTENSION = '.log'
+const FIRST_RUN = 1
+
+// What already carries a run's name: the logs of the directory this run writes to and, for a GitHub
+// scenario, the account's repositories — another checkout, or a lane worktree since removed, numbers
+// from its own logs and leaves repositories this directory has no log of.
+interface TakenNames {
+	logs: ReadonlyArray<string>
+	repositories: ReadonlyArray<string>
+}
+
+function logged_names(logs: ReadonlyArray<string>): Array<string> {
+	return logs
+		.filter((file) => file.endsWith(LOG_EXTENSION))
+		.map((file) => file.slice(0, -LOG_EXTENSION.length))
+}
+
+function run_number(scenario_name: string, run_name: string): number | undefined {
+	const prefix = `${scenario_name}-`
+
+	if (!run_name.startsWith(prefix)) return undefined
+
+	const digits = run_name.slice(prefix.length)
+
+	return /^\d+$/u.test(digits) ? Number(digits) : undefined
+}
+
+// The name is the project directory and, for a GitHub scenario, the repository `josh start` creates.
+// It is numbered past every earlier log and repository, so a rerun leaves the last run's repository
+// in place.
+function next_name(scenario_name: string, taken_names: TakenNames): string {
+	const taken = [...logged_names(taken_names.logs), ...taken_names.repositories]
+		.map((run_name) => run_number(scenario_name, run_name))
+		.filter((number) => number !== undefined)
+	const next = taken.length === 0 ? FIRST_RUN : Math.max(...taken) + 1
+
+	return `${scenario_name}-${String(next)}`
+}
+
+function file_name(run_name: string): string {
+	return `${run_name}${LOG_EXTENSION}`
+}
+
+function redact(line: string, secrets: ReadonlyArray<string>): string {
+	const present = secrets.filter((secret) => secret !== '')
+	let redacted = line
+
+	for (const secret of present) {
+		redacted = redacted.replaceAll(secret, '[REDACTED]')
+	}
+
+	return redacted
+}
+
+const fresh_machine_log = { next_name, file_name, redact }
+
+export { fresh_machine_log }
+export type { TakenNames }