Compare commits
5 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 6c4e4bf67d | |||
| 0a9f86a102 | |||
| c8a150fee7 | |||
| ccfb08f4d5 | |||
| 006bbe6b0c |
@@ -0,0 +1,39 @@
|
|||||||
|
---
|
||||||
|
description: Every repo has AGENTS.md starting with the damem recall header; durable context lives in .agents/memory (flat, one fact per file) and .agents/skills
|
||||||
|
---
|
||||||
|
|
||||||
|
Standing convention (2026-10-12): every repo has an `AGENTS.md` whose first
|
||||||
|
lines are exactly the damem header (cunarist/damem):
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
At the start of every new session, run `damem recall` in the terminal and treat
|
||||||
|
its output as the context for this repository. If the `damem` command is not
|
||||||
|
found, read [INSTALL.md](https://github.com/cunarist/damem/blob/main/INSTALL.md)
|
||||||
|
and follow it before reasoning or responding.
|
||||||
|
```
|
||||||
|
|
||||||
|
Below it: `# AGENTS.md`, then `## Project` (what the repo is, runtime,
|
||||||
|
toolchain, where it came from) and `## Rules` (short bullets, each pointing at
|
||||||
|
a memory where the reason lives). No `CLAUDE.md`, `GEMINI.md`, or other
|
||||||
|
per-agent files; `AGENTS.md` is the single entry point.
|
||||||
|
|
||||||
|
## `.agents/` layout
|
||||||
|
|
||||||
|
- `memory/*.md`: one fact per file, flat (subdirectories are not listed),
|
||||||
|
frontmatter with a one-line `description` that states the fact. Link
|
||||||
|
related notes with double-bracket wiki links using the file name without
|
||||||
|
`.md`; a link to a missing note fails `damem doctor`.
|
||||||
|
- `skills/<name>/SKILL.md`: frontmatter `name` and `description` (when to use
|
||||||
|
it), body says how. Helper scripts live next to it and are Python 3.12+.
|
||||||
|
- `scratch/`: holds a `.gitignore` containing `*`.
|
||||||
|
- Every memory and `SKILL.md` stays under 8 KB.
|
||||||
|
|
||||||
|
## Keeping it right
|
||||||
|
|
||||||
|
- Update an existing note instead of adding a near-duplicate; delete notes
|
||||||
|
that turn out wrong.
|
||||||
|
- Write a note when the user corrects something, states a preference, or
|
||||||
|
when understanding something took reading many files.
|
||||||
|
- Run `damem doctor` before finishing and fix what it reports.
|
||||||
|
- Changing anything outside `.agents/` (source, config, `AGENTS.md`) follows
|
||||||
|
the normal branch and PR flow ([[git-pr-workflow]]).
|
||||||
@@ -0,0 +1,39 @@
|
|||||||
|
---
|
||||||
|
description: Child processes use plain node:child_process spawn (explicit stdio, uid/gid, whole env); src/processes/child.ts has exitCode (128+signo) and echo; no execFile maxBuffer
|
||||||
|
---
|
||||||
|
|
||||||
|
Every call site calls `spawn` from `node:child_process` itself, with
|
||||||
|
everything explicit:
|
||||||
|
|
||||||
|
- **`uid`/`gid`** of the profile for anything an agent profile runs (each
|
||||||
|
profile is its own UID, 20000+). Never drop them.
|
||||||
|
- **`env`** is the whole environment the child gets (a sanitized one for
|
||||||
|
agents); nothing from the coordinator is merged in.
|
||||||
|
- **`stdio`**: stdin is `"ignore"` so an agent CLI never waits on input
|
||||||
|
(only `codex login --with-api-key` pipes the token in). Output that is not
|
||||||
|
read is `"ignore"`; output that is read is `"pipe"` and streamed.
|
||||||
|
- No `execFile`/`exec`: their `maxBuffer` (1 MiB) kills a chatty child. Read
|
||||||
|
piped streams incrementally instead.
|
||||||
|
|
||||||
|
`src/processes/child.ts` holds what the call sites share:
|
||||||
|
|
||||||
|
- **`exitCode(child)`**: call it right after `spawn`. It settles on `exit`
|
||||||
|
(not `close`, which a daemonized grandchild can hold open), maps a signal to
|
||||||
|
`128 + signo` as a shell does, and rejects on a failed start. The rejection
|
||||||
|
is pre-caught so it is not reported as unhandled before the caller awaits it.
|
||||||
|
- **`echo(stream, chunk)`**: writes and waits for `drain` when the buffer is
|
||||||
|
full, so echoing never outruns a slow reader.
|
||||||
|
|
||||||
|
Tests use `spawnSync` for short commands.
|
||||||
|
|
||||||
|
Other port details:
|
||||||
|
|
||||||
|
- **`src/common/errors.ts`** `isNotFound` checks `ENOENT` (file) or `ESRCH` (process).
|
||||||
|
- Temporary files are an exclusive `wx` create with mode `0600`.
|
||||||
|
- `src/common/json.ts` holds type guards used instead of `as` casts on parsed JSON.
|
||||||
|
- `process` and `Buffer` must come from `node:` imports:
|
||||||
|
`no-restricted-globals` in `scripts/project-lint.ts` enforces it
|
||||||
|
([[lint-parity-never-shrinks]]).
|
||||||
|
|
||||||
|
Related: how each agent CLI reports bad credentials is in
|
||||||
|
[[agent-cli-auth-failures]].
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
---
|
||||||
|
description: bot-agents lint has prefer-readonly-parameter-types and the size/complexity rules off (Deno had no limits) and no overrides; nothing else
|
||||||
|
---
|
||||||
|
|
||||||
|
The repo follows [[lint-config-shape]] with one recorded exception, present
|
||||||
|
when the migration PR was approved:
|
||||||
|
|
||||||
|
- `typescript/prefer-readonly-parameter-types` is `"off"` in
|
||||||
|
`scripts/project-lint.ts`, as in the explicit-types template, because
|
||||||
|
Node/web types (`Response`, `Stats`, `RequestInit`) can never satisfy it.
|
||||||
|
- `vite.config.ts` has no `overrides`. The `scripts/**` override for
|
||||||
|
`typescript/no-unsafe-enum-comparison` was removed (2026-10-16):
|
||||||
|
`scripts/project-lint.ts` compares node types with `AST_NODE_TYPES` members
|
||||||
|
from `@typescript-eslint/types` instead of string literals
|
||||||
|
([[lint-overrides-policy]]).
|
||||||
|
|
||||||
|
Size and complexity limits match Deno, which had none here, so every Oxlint
|
||||||
|
limit rule is `"off"` ([[lint-config-shape]]). `src/run/index.ts` and `src/post/index.ts` keep
|
||||||
|
main's single-file layout (2026-10-17 revert of the size splits). Sequential
|
||||||
|
awaits in loops became recursion or a `reduce` chain (`no-await-in-loop`) to
|
||||||
|
stay sequential. Add no other opt-out without the user.
|
||||||
@@ -0,0 +1,35 @@
|
|||||||
|
---
|
||||||
|
description: bot-agents migration decisions: live @main action for six repos, JSON profiles, Node 24.2+, lints with eslint-plugin-import-structure and explicit-types (concrete, absence)
|
||||||
|
---
|
||||||
|
|
||||||
|
Decisions for `commons/bot-agents` (Capsulizers Gitea), from the Deno to
|
||||||
|
Node + Vite+ migration (PR #20, `node-migration`, 2026-10-15/16):
|
||||||
|
|
||||||
|
- **Live action.** Six consumer repos use `commons/bot-agents@main`, so a merge
|
||||||
|
switches all of them at once. It changes only through a PR and a careful
|
||||||
|
review. Suggested before merging a risky change: tag the current `main`
|
||||||
|
(e.g. `deno-final`) as a rollback target and canary the branch from one
|
||||||
|
consumer (`uses: .../commons/bot-agents@<branch>`) on a throwaway PR.
|
||||||
|
- **Profiles are JSON.** `profiles.yml` became `profiles.json` with the same
|
||||||
|
content (encrypted `v1:` values unchanged), read with `JSON.parse`. That
|
||||||
|
removed the only runtime dependency (`@std/yaml`); keep it free of runtime
|
||||||
|
dependencies (`@eslint/core` and the other devDependencies serve only the
|
||||||
|
tooling).
|
||||||
|
- **Node 24.2+**, not 22: `src/post/index.ts` uses `import.meta.main`. There is no
|
||||||
|
`engines` (user decision 2026-10-18): the `node:24-bookworm` job image
|
||||||
|
decides the version ([[bot-agents-runtime-no-build]]).
|
||||||
|
- **Published lint plugins** (2026-10-18, after they reached npm):
|
||||||
|
`eslint-plugin-import-structure` (`modules` config) and
|
||||||
|
`eslint-plugin-explicit-types` (`concrete` and `absence` configs) are
|
||||||
|
devDependencies, enabled in `vite.config.ts`. explicit-types' `naming`
|
||||||
|
config is left off: its `upper-snake-string-unions` and
|
||||||
|
`no-upper-snake-object-keys` rules fire on wire tokens this repo does not
|
||||||
|
name (profile types such as `"claude"`, failure reasons posted to Gitea,
|
||||||
|
environment variable names), which cannot change without changing
|
||||||
|
behavior. Open question for the user. `eslint-plugin-lit-robust` does not apply
|
||||||
|
(no Lit).
|
||||||
|
- **Stricter input checks were accepted** in the migration: Gitea `/user` and
|
||||||
|
comment responses, the runtime manifest, and the outcome's profile type are
|
||||||
|
validated; some type errors became `TypeError` with the same messages.
|
||||||
|
- Merging is the user's call; the `bot` account's approval is required first
|
||||||
|
([[git-pr-workflow]]).
|
||||||
@@ -0,0 +1,31 @@
|
|||||||
|
---
|
||||||
|
description: The action runs src/<phase>.ts directly with node on node:24-bookworm (no build); protect-source.sh copies only src/*.ts, package.json, profiles.json, prompt.md
|
||||||
|
---
|
||||||
|
|
||||||
|
`action.yml` is a composite action running three phases as
|
||||||
|
`node "<source>/src/{prepare,run,post}.ts"`. Node's built-in type stripping
|
||||||
|
runs the TypeScript; there is **no build step, no bundle, and no runtime
|
||||||
|
dependency**. Hence `tsconfig.json` has `erasableSyntaxOnly` and
|
||||||
|
`allowImportingTsExtensions`: only erasable syntax (no `enum`, no parameter
|
||||||
|
properties, no decorators) and relative `.ts` imports.
|
||||||
|
|
||||||
|
- **Image:** the steps assume the `node:24-bookworm` job container. Node must
|
||||||
|
be 24.2+ for `import.meta.main` in `src/post/index.ts`. That image is the only Node
|
||||||
|
pin (`package.json` has no `engines`); `check.yml` prints `node --version`
|
||||||
|
to confirm the cached image's minor.
|
||||||
|
- **Root-owned source copy:** `scripts/protect-source.sh` copies the action
|
||||||
|
into `$RUNNER_TEMP` so an agent editing the checkout can't swap a later
|
||||||
|
phase. It copies exactly `src/*.ts`, `package.json` (`"type": "module"`
|
||||||
|
makes Node load the sources as ES modules), `profiles.json`, and
|
||||||
|
`prompt.md`. **A new runtime file or subdirectory must be added there**, or
|
||||||
|
it is missing at run time. Runtime code in `src/` is flat; a subfolder would
|
||||||
|
not be copied. The only subfolder, `src/testing/`, is test-only.
|
||||||
|
- `tests/entrypoints.test.ts` runs each phase under real Node with a cleared
|
||||||
|
environment and expects its first "X is not set" error, which proves the
|
||||||
|
whole import graph loads without a build. Keep it in sync with the phases.
|
||||||
|
- **None of the app build conventions apply here:** no `vp build`, no
|
||||||
|
frontend or Rust/Tauri output paths, no Containerfile, no decorators
|
||||||
|
plugin, no lit-check, no generated JS. Don't add any of them.
|
||||||
|
- **CI** (`.gitea/workflows/check.yml`) runs on the self-hosted runner's
|
||||||
|
default image as root: `npm ci`, `npx vp check`, `npx vp test`. It does not
|
||||||
|
use `setup-vp`. YAML stays declarative ([[yaml-stays-declarative]]).
|
||||||
@@ -0,0 +1,25 @@
|
|||||||
|
---
|
||||||
|
description: Isolation and credential tests need root and use test.skipIf(!IS_ROOT); locally 5 skip, CI runs as root so all 66 run; verify isolation changes in node:24-bookworm as root
|
||||||
|
---
|
||||||
|
|
||||||
|
Some tests exercise real UID isolation, process cleanup, and the prepare phase's
|
||||||
|
credential cleanup. They need root and are written as
|
||||||
|
`test.skipIf(!IS_ROOT)(...)` (`IS_ROOT` from `#testing`), so they show
|
||||||
|
as skipped instead of silently passing.
|
||||||
|
|
||||||
|
- As a normal user `vp test` passes 61 and skips 5. In CI (self-hosted
|
||||||
|
runner, root) all 66 run.
|
||||||
|
- When changing `isolation.ts`, `runtime.ts`, `credentials.ts`, `prepare/index.ts`,
|
||||||
|
or `child.ts`, run the suite as root in `node:24-bookworm` (e.g. a
|
||||||
|
container with the repo mounted) before pushing; a green non-root run
|
||||||
|
proves nothing about those paths.
|
||||||
|
- The migration also ran an end-to-end smoke as root with fake
|
||||||
|
`codex`/`claude`/`npx` binaries and a fake Gitea through
|
||||||
|
`protect-source.sh` -> `prepare/index.ts` -> `run/index.ts` -> `post/index.ts`; repeat that
|
||||||
|
for changes to the phase flow ([[bot-agents-runtime-no-build]]).
|
||||||
|
- `src/testing/index.ts` holds the shared test helpers (user IDs, temp dirs,
|
||||||
|
`runCommand`) behind the `#testing` alias. Every test imports it as
|
||||||
|
`#testing`. It imports no source module, so `tests/` (which may not use
|
||||||
|
`../`) never reaches internals. Tests follow
|
||||||
|
[[tests-layout-vitest]] (unit tests next to their code in `src/`, repo-level ones in
|
||||||
|
`tests/`).
|
||||||
@@ -0,0 +1,51 @@
|
|||||||
|
---
|
||||||
|
description: Work on a branch, plain imperative commits without AI trailers, one PR with the Claude Code footer, review until approved, never merge yourself; squash only
|
||||||
|
---
|
||||||
|
|
||||||
|
## Branches and commits
|
||||||
|
|
||||||
|
- Never push to `main`. Every change goes through a branch and a PR, even a
|
||||||
|
one-line fix.
|
||||||
|
- Commit messages are plain imperative sentences ("Port the import-check
|
||||||
|
rules to an ESLint plugin"). No conventional-commit prefixes, no AI
|
||||||
|
trailers (`Co-Authored-By: Claude`, "Generated with ..."), no emoji.
|
||||||
|
- When several agents share a branch, each works in its own `git worktree`,
|
||||||
|
runs `git pull --rebase` before pushing, and retries a rejected push after
|
||||||
|
rebasing. Remove the worktree and temp branch afterwards.
|
||||||
|
- `vp check`, `vp test`, and the build pass locally before every push.
|
||||||
|
|
||||||
|
## Pull requests
|
||||||
|
|
||||||
|
- One PR per repo for a migration, everything included (size-rule refactors
|
||||||
|
too).
|
||||||
|
- The body covers: summary, what changed, deviations and risks, verification
|
||||||
|
done, and open questions. It ends with exactly this line:
|
||||||
|
|
||||||
|
```
|
||||||
|
🤖 Generated with [Claude Code](https://claude.com/claude-code)
|
||||||
|
```
|
||||||
|
|
||||||
|
- Then run the review cycle (skill `review-cycle`): on Capsulizers Gitea repos
|
||||||
|
that have `.gitea/workflows/agents.yml`, comment `@bot` and address the `bot`
|
||||||
|
account's review; elsewhere, a subagent reviews the diff and posts the
|
||||||
|
review as a PR comment. Repeat until fully approved, then ask the user to
|
||||||
|
review.
|
||||||
|
|
||||||
|
## Merging
|
||||||
|
|
||||||
|
- **Never merge on your own.** The user merges, unless they explicitly allow
|
||||||
|
it for one specific PR.
|
||||||
|
- GitHub repos are squash-merge only, so a PR lands as one commit titled after
|
||||||
|
the PR.
|
||||||
|
- Also never, without the user: publish, archive a repo, or delete a branch
|
||||||
|
the user may still use.
|
||||||
|
|
||||||
|
## Hosts
|
||||||
|
|
||||||
|
- **cunarist** and **temeddix**: GitHub only, CI in `.github/workflows`, use
|
||||||
|
the `gh` CLI.
|
||||||
|
- **Capsulizers**: Gitea at git.capsulizers.com (Gitea 1.26), CI in
|
||||||
|
`.gitea/workflows`, PRs through the Gitea API. Push and open PRs as the
|
||||||
|
user's own account (credentials in the user's environment; source them in a
|
||||||
|
subshell and never print them); `bot` is a separate review account. The
|
||||||
|
org's codified rules live in the `commons/code-rules` README.
|
||||||
@@ -0,0 +1,105 @@
|
|||||||
|
---
|
||||||
|
description: An alias owns its target (folder index.ts = folder and below, any other file = that file); no overlap; outside an area only the exact alias reaches it; ../ is banned in every file; locally, aliases target only direct src/ subfolders
|
||||||
|
---
|
||||||
|
|
||||||
|
## `#` aliases own their targets
|
||||||
|
|
||||||
|
Shared code is imported through Node subpath imports declared in
|
||||||
|
`package.json` `imports`. Node, TypeScript, Vite, Vite+'s config bundler, and
|
||||||
|
Oxlint's plugin loader all resolve them natively, so `.ts` source runs
|
||||||
|
unbuilt. `vp pack` inlines them, so they never reach package consumers.
|
||||||
|
|
||||||
|
One rule for every file, never tied to folder or file names (user rule
|
||||||
|
2026-10-17; it replaces the earlier "aliases only point at direct `src/`
|
||||||
|
subfolders" rule as the general rule, and the "import-structure plugin
|
||||||
|
checks only aliased folders" scope; this repo keeps the stricter rule as a
|
||||||
|
local convention, see the last section):
|
||||||
|
|
||||||
|
- **An alias may point anywhere** and owns its target. An alias to a
|
||||||
|
folder's `index.ts` owns that folder and everything below it; an alias to
|
||||||
|
any other file owns only that file.
|
||||||
|
- **No overlap.** No file may be owned by 2 aliases: no alias inside another
|
||||||
|
alias's area, and no 2 aliases with the same target. The import-structure
|
||||||
|
plugin's `enforce-layer-order` reports it once at the top of every file 2
|
||||||
|
aliases claim. Fix by merging the aliases or moving files apart.
|
||||||
|
- **Outside an area, only the exact alias reaches it.** A deeper alias
|
||||||
|
specifier (`#a/one.ts`, `no-barrel-bypass`) and a relative path into the
|
||||||
|
area (`./a/one.ts`, `no-relative-bypass`; `./b/f.ts` to a file alias,
|
||||||
|
`prefer-alias-import`, fixed to the alias) are bypasses.
|
||||||
|
- **Inside an area, relative imports of siblings and subfolders are free.**
|
||||||
|
- **A `../` import is banned in every file**, owned or not (`no-parent-import`).
|
||||||
|
Runtime file URLs (`new URL("../prompt.md", import.meta.url)`) are not
|
||||||
|
imports and are allowed.
|
||||||
|
Anything above a file needs an alias.
|
||||||
|
- **Files no alias owns** need no `index.ts` and no alias, and import `./`
|
||||||
|
siblings and subfolders freely.
|
||||||
|
- Unchanged: no `/*` subpath patterns, the key order of `imports` is the
|
||||||
|
layer order `enforce-layer-order` checks (add a new alias at the right
|
||||||
|
layer), and entry files are `index.ts` only.
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
"imports": {
|
||||||
|
"#a": "./a/index.ts", // owns a/**
|
||||||
|
"#f": "./b/f.ts", // owns only b/f.ts
|
||||||
|
"#a-sub": "./a/sub/index.ts", // no: inside #a
|
||||||
|
"#a2": "./a/index.ts" // no: same target as #a
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
```ts
|
||||||
|
// in main.ts, which no alias owns
|
||||||
|
import { a } from "#a"; // yes
|
||||||
|
import { one } from "#a/one.ts"; // no: deeper alias specifier
|
||||||
|
import { one } from "./a/one.ts"; // no: relative path into #a
|
||||||
|
import { f } from "#f"; // yes
|
||||||
|
import { f } from "./b/f.ts"; // no: relative path to a file alias
|
||||||
|
import { g } from "./b/g.ts"; // yes: unowned
|
||||||
|
// in a/one.ts, owned by #a
|
||||||
|
import { two } from "./two.ts"; // yes: sibling
|
||||||
|
import { deep } from "./sub/deep.ts"; // yes: subfolder of the same area
|
||||||
|
import { x } from "../x.ts"; // no: no ../ anywhere
|
||||||
|
```
|
||||||
|
|
||||||
|
- Aliases point at `.ts` files only. There is no `#package` alias
|
||||||
|
([[ts-only-files-and-imports]]).
|
||||||
|
- Lint `jsPlugins` entries in `vite.config.ts` stay path strings, even when
|
||||||
|
the file has an alias.
|
||||||
|
- Keep test-only helpers in their own alias (e.g. `#testing`) so they never
|
||||||
|
land in a bundle.
|
||||||
|
|
||||||
|
## Barrels
|
||||||
|
|
||||||
|
- An area used from outside exposes its API through its alias target, and
|
||||||
|
callers import the alias (`#ui`), not files inside it.
|
||||||
|
- Barrels are also the standard fix for `import/max-dependencies`: one barrel
|
||||||
|
import replaces many direct ones ([[lint-overrides-policy]]).
|
||||||
|
- `import/no-cycle` is on; a barrel must not create a cycle.
|
||||||
|
|
||||||
|
Relative imports are written with the `.ts` extension.
|
||||||
|
|
||||||
|
## `scripts/` is flat (user rule, 2026-10-16)
|
||||||
|
|
||||||
|
- `scripts/` has no subfolders and no `index.ts`.
|
||||||
|
- Each tool is one file, `scripts/<name>.ts`, imported directly by file:
|
||||||
|
`import projectLint from "./scripts/project-lint.ts";` in
|
||||||
|
`vite.config.ts`. No alias owns `scripts/`, so these `./` imports are free.
|
||||||
|
- Code in a former `scripts/<tool>/` folder is merged or renamed into flat
|
||||||
|
`scripts/<name>.ts` files. Non-TS assets (HTML, images, fixtures) move to
|
||||||
|
where they belong (next to the tool's output, `.agents/`, or a gitignored
|
||||||
|
scratch dir). A subfolder that is really an app moves under an alias.
|
||||||
|
|
||||||
|
## Local convention: aliases target direct `src/` subfolders
|
||||||
|
|
||||||
|
This is a convention of this repo only, stricter than the general rule above
|
||||||
|
(which the published import-structure plugin checks and which allows more).
|
||||||
|
It is not a plugin rule.
|
||||||
|
|
||||||
|
- Every `package.json` `imports` alias points only at the `index.ts` of a
|
||||||
|
direct subfolder of `src/`, e.g. `"#helpers": "./src/helpers/index.ts"`.
|
||||||
|
No alias to a single file, a deeper folder, or anything outside `src/`.
|
||||||
|
Here the aliases are `#prepare`, `#run`, `#post`, `#agents`, `#processes`, `#runtime`, `#profiles`,
|
||||||
|
`#common`, and `#testing`, in that layer order.
|
||||||
|
- Code outside `src/` (`scripts/`, `tests/`, `vite.config.ts`) gets no alias
|
||||||
|
of its own and imports its own files by `./` relative paths. It reaches
|
||||||
|
`src/` only through the aliases, since `../` is banned.
|
||||||
|
- No lint rule checks this; check `imports` by hand when adding an alias.
|
||||||
@@ -0,0 +1,48 @@
|
|||||||
|
---
|
||||||
|
description: vite.config.ts lint uses Oxlint categories at error with Deno size limits, names no rule itself, and spreads configs from the plugins and scripts/project-lint.ts
|
||||||
|
---
|
||||||
|
|
||||||
|
The lint config is short and category-driven (user decisions 2026-10-14/15):
|
||||||
|
turn on whole categories, then list only what parity or a real need adds.
|
||||||
|
|
||||||
|
```ts
|
||||||
|
lint: {
|
||||||
|
plugins: ["typescript", "unicorn", "oxc", "import"],
|
||||||
|
jsPlugins: ["eslint-plugin-explicit-types", "./scripts/project-lint.ts"],
|
||||||
|
categories: { correctness: "error", suspicious: "error", pedantic: "error", perf: "error" },
|
||||||
|
rules: { ...explicitTypes.configs.concrete.rules, ...projectLint.configs.project.rules },
|
||||||
|
ignorePatterns: ["src/generated/**"], // generated files only, see below
|
||||||
|
options: { typeAware: true, typeCheck: true, maxWarnings: 0, reportUnusedDisableDirectives: "error" },
|
||||||
|
},
|
||||||
|
```
|
||||||
|
|
||||||
|
- **Categories:** `correctness`, `suspicious`, `pedantic`, `perf` at `error`.
|
||||||
|
`style` and `restriction` are never turned on wholesale; pick single rules
|
||||||
|
from them in `configs.project`. Extra rules that categories bring are fine.
|
||||||
|
- **Size limits match Deno** (2026-10-17, replaces the 2026-10-16 "default
|
||||||
|
limits stay"): repos behave as they did on Deno. bot-agents ran `deno lint`
|
||||||
|
with no config, so it had no size or complexity limit, and every Oxlint
|
||||||
|
limit rule (`complexity`, `max-lines`, `max-params`, `id-length`,
|
||||||
|
`no-nested-ternary`, `max-lines-per-function`, `max-classes-per-file`,
|
||||||
|
`max-depth`, `max-nested-callbacks`, `max-statements`,
|
||||||
|
`import/max-dependencies`, `unicorn/max-nested-calls`) is `"off"` in
|
||||||
|
`configs.project`. No file is split for size. Do not add new opt-outs
|
||||||
|
anywhere without asking the user.
|
||||||
|
- **`vite.config.ts` names no rule.** Every rule id, built-in ones included,
|
||||||
|
lives in `configs.project` of `scripts/project-lint.ts`
|
||||||
|
([[project-lint-plugin]]). `vite.config.ts` only spreads configs.
|
||||||
|
- **Published plugins are consumed through their configs**: ESLint flat config
|
||||||
|
uses `plugin.configs.<name>`; Oxlint lists the package in `jsPlugins` and
|
||||||
|
spreads `plugin.configs.<name>.rules`, since Oxlint plugins carry no configs.
|
||||||
|
Use the configs equivalent to what the repo enabled under Deno.
|
||||||
|
- **`maxWarnings: 0`** keeps Deno's "every diagnostic fails" behaviour.
|
||||||
|
- **`ignorePatterns`** is only for generated files (compiled output, codegen).
|
||||||
|
Hand-written code is never ignored.
|
||||||
|
- **No lint disable comments**: [[lint-no-disable-comments]].
|
||||||
|
- **Parity:** [[lint-parity-never-shrinks]]. **Naming:** [[naming-id-match]].
|
||||||
|
- Don't add a second import sorter; the import-structure plugin's
|
||||||
|
`enforce-import-order` is the only one, and Oxfmt's `sortImports` stays off.
|
||||||
|
|
||||||
|
`perf` came last: in the template it flagged nine `.includes` on constant
|
||||||
|
arrays, fixed as `ReadonlySet` + `.has()` rather than by turning a rule off.
|
||||||
|
That is the expected response to any new rule: change the code.
|
||||||
@@ -0,0 +1,30 @@
|
|||||||
|
---
|
||||||
|
description: Every eslint-/oxlint-disable or -enable comment is banned in every form; three checks enforce it together, keep all three
|
||||||
|
---
|
||||||
|
|
||||||
|
Banned (2026-10-16): `eslint-disable`, `eslint-disable-line`,
|
||||||
|
`eslint-disable-next-line`, `eslint-enable`, and the same with `oxlint-`, as
|
||||||
|
line or block comments, anywhere in the repo. Fix the code; if the code truly
|
||||||
|
can't be fixed, ask the user, don't silence the rule. Old
|
||||||
|
`deno-lint-ignore` lines are removed during the migration and their cause
|
||||||
|
fixed.
|
||||||
|
|
||||||
|
Oxlint (1.87) has no `noInlineConfig` and no `eslint-comments` rules, and
|
||||||
|
`respectEslintDisableDirectives: false` only ignores `eslint-*` directives. So
|
||||||
|
three checks enforce the ban together, and none is redundant:
|
||||||
|
|
||||||
|
1. `project/no-disable-comments` (custom, in `scripts/project-lint.ts`) fails
|
||||||
|
any directive.
|
||||||
|
2. `unicorn/no-abusive-eslint-disable` fails a directive that names no rule,
|
||||||
|
which would otherwise silence the custom rule on its own line.
|
||||||
|
3. `options.reportUnusedDisableDirectives: "error"` fails a directive naming
|
||||||
|
`project/no-disable-comments` (the custom rule skips that one, so the
|
||||||
|
directive silences nothing and is reported as unused).
|
||||||
|
|
||||||
|
Every form was probed and fails `vp check`.
|
||||||
|
|
||||||
|
A rule that fires on legitimate code is a rule problem: change the rule or its
|
||||||
|
options in `configs.project` with the user's agreement, not the call site.
|
||||||
|
Known example: rule records are `Map`s keyed by id rather than object
|
||||||
|
literals with kebab-case keys, which keeps naming rules happy without any
|
||||||
|
directive.
|
||||||
@@ -0,0 +1,33 @@
|
|||||||
|
---
|
||||||
|
description: No lint overrides for source files; narrow ones only for scripts/**; generated files go in ignorePatterns; size limits match Deno, so nothing is split for size
|
||||||
|
---
|
||||||
|
|
||||||
|
Final policy (2026-10-16). The user considers per-file `overrides` bad
|
||||||
|
practice.
|
||||||
|
|
||||||
|
- **Source files: never.** No `overrides` entry may target `src/**` or any
|
||||||
|
other hand-written production or test code.
|
||||||
|
- **The one exception** is in lint-plugin repos: `import/max-dependencies`
|
||||||
|
off for `src/rules/index.ts`, the rule registry, which must import every
|
||||||
|
rule. It is not a precedent for apps.
|
||||||
|
- **`scripts/**`:** a narrow override is allowed when a tooling script truly
|
||||||
|
needs it, e.g. `no-console` in a CLI script.
|
||||||
|
- **Generated files:** list them in `ignorePatterns`, never `overrides`.
|
||||||
|
- **Anything else needs the user's approval first.** When the user is away,
|
||||||
|
don't add it: refactor, or leave the violation failing and log the question.
|
||||||
|
|
||||||
|
## Fix the code instead
|
||||||
|
|
||||||
|
Category rule violations are fixed in the code without behavior change,
|
||||||
|
covered by the tests, inside the same migration PR; e.g. `prefer-set-has`
|
||||||
|
becomes `const K: ReadonlySet<string> = new Set([...])` with `.has`.
|
||||||
|
|
||||||
|
Size and complexity limits are not refactored for: they match what Deno
|
||||||
|
enforced (2026-10-17, replacing the earlier "refactor to Oxlint's defaults"),
|
||||||
|
which for bot-agents is none, so those rules are `"off"`
|
||||||
|
([[lint-config-shape]]).
|
||||||
|
|
||||||
|
Alias rule: an alias may point anywhere and owns its target (a folder's
|
||||||
|
`index.ts` owns the folder and below, any other file owns only itself); no
|
||||||
|
two aliases may own the same file, and `../` is banned everywhere
|
||||||
|
([[imports-aliases-barrels]]).
|
||||||
@@ -0,0 +1,46 @@
|
|||||||
|
---
|
||||||
|
description: Lint coverage never drops below what Deno enforced; every Deno rule maps to an Oxlint rule, a plugin rule, the compiler, or our own rule
|
||||||
|
---
|
||||||
|
|
||||||
|
Hard rule (2026-10-12): after the move, a repo has at least the lint coverage
|
||||||
|
it had under Deno: built-in rules (the `recommended` and `jsr` tags plus
|
||||||
|
opt-ins like `camelcase`, `eqeqeq`, `guard-for-in`, `no-console`,
|
||||||
|
`no-eval`, `no-throw-literal`, `no-non-null-assertion`,
|
||||||
|
`verbatim-module-syntax`), `@hugoalh` rules, and the custom plugins. Rules may
|
||||||
|
be added, never lost. Formatting may change. "Gap" is not an acceptable end
|
||||||
|
state: a Deno rule Oxlint lacks is replaced by a plugin rule or our own rule in
|
||||||
|
[[project-lint-plugin]].
|
||||||
|
|
||||||
|
Before removing any line from `configs.project`, find what else covers it.
|
||||||
|
|
||||||
|
## How the template mapped Deno's 97 rules
|
||||||
|
|
||||||
|
- **Same rule** in `configs.project` at `error`.
|
||||||
|
- **Renamed equivalent:** `no-new-symbol` → `no-new-native-nonconstructor`;
|
||||||
|
`no-window` → `no-restricted-globals: ["error", "window"]`;
|
||||||
|
`ban-untagged-ignore` → `unicorn/no-abusive-eslint-disable`;
|
||||||
|
`ban-unused-ignore`, `ban-unknown-rule-code` →
|
||||||
|
`reportUnusedDisableDirectives`; `camelcase` → built-in `id-match`
|
||||||
|
([[naming-id-match]]).
|
||||||
|
- **Caught by the parser or `typeCheck`:** `no-dupe-args`, `no-octal`,
|
||||||
|
`no-await-in-sync-fn`, `no-import-assertions` (TS2880), `no-sloppy-imports`
|
||||||
|
(TS2835), `verbatim-module-syntax` (TS1484).
|
||||||
|
- **`no-slow-types`:** `isolatedDeclarations`, enforced by `vp pack` (TS9010)
|
||||||
|
in packages.
|
||||||
|
- **Vacuous:** JSX rules (no `.tsx` exists) and Deno-only rules.
|
||||||
|
- **`@hugoalh` rules** map to Oxlint built-ins in `configs.project`.
|
||||||
|
- **deno-import-check's CLI cycle check** → `import/no-cycle`.
|
||||||
|
|
||||||
|
The template's list in `configs.project` is the baseline to copy: `curly`,
|
||||||
|
`guard-for-in`, `no-console`, `no-empty`, `no-regex-spaces`,
|
||||||
|
`no-restricted-globals`, `no-var`, `prefer-const`, `import/no-cycle`,
|
||||||
|
`import/no-relative-parent-imports`, `typescript/adjacent-overload-signatures`,
|
||||||
|
`typescript/consistent-type-imports`, `typescript/no-empty-interface`,
|
||||||
|
`typescript/no-explicit-any`, `typescript/no-namespace`,
|
||||||
|
`typescript/no-non-null-assertion`, the two `project/*` rules,
|
||||||
|
`unicorn/no-abusive-eslint-disable`, `id-match`, and
|
||||||
|
`typescript/switch-exhaustiveness-check` with
|
||||||
|
`considerDefaultExhaustiveForUnions`.
|
||||||
|
|
||||||
|
Each migration PR states its parity mapping (or links the template's table in
|
||||||
|
cunarist/eslint-plugin-explicit-types#1) so the user can check it.
|
||||||
@@ -0,0 +1,48 @@
|
|||||||
|
---
|
||||||
|
description: Deno's camelcase is Oxlint id-match ^_*[^_]*_*$|^[^a-z]*$; leading _ for unused vars; rename snake_case imports; PascalCase types; single-letter type params
|
||||||
|
---
|
||||||
|
|
||||||
|
Oxlint has no `camelcase`. Its built-in `id-match` replaces it, set in
|
||||||
|
`configs.project` (user decision 2026-10-16, replacing a ~400-line port):
|
||||||
|
|
||||||
|
```ts
|
||||||
|
"id-match": ["error", "^_*[^_]*_*$|^[^a-z]*$", {
|
||||||
|
properties: false, classFields: false, onlyDeclarations: false,
|
||||||
|
ignoreDestructuring: true,
|
||||||
|
}],
|
||||||
|
```
|
||||||
|
|
||||||
|
**Meaning** (Deno's `is_underscored`): after trimming leading and trailing
|
||||||
|
underscores, the name has no `_`, **or** the name has no lowercase ASCII
|
||||||
|
letter. `id-match` can't tell what kind of name it sees, so one regex accepts
|
||||||
|
every valid style; other rules decide which style goes where.
|
||||||
|
|
||||||
|
```ts
|
||||||
|
const userName = 1; // ok
|
||||||
|
class UserStore {} // ok here; pascal-case-types enforces PascalCase
|
||||||
|
const MAX_SIZE = 10; // ok: no lowercase, so UPPER_SNAKE passes
|
||||||
|
const _unused = 1; // ok: leading _ marks an unused binding
|
||||||
|
const user_name = 1; // error
|
||||||
|
```
|
||||||
|
|
||||||
|
- **Leading underscores stay allowed** for unused parameters and variables
|
||||||
|
(`items.map((_item, index) => index)`). The user considered banning them and
|
||||||
|
kept them for exactly this.
|
||||||
|
- **Rename snake_case imports at the import** (user wants this flagged):
|
||||||
|
`import { parse_args as parseArgs } from "some-lib";`
|
||||||
|
- `declare` lines and snake_case globals are rare and accepted as they are.
|
||||||
|
- **Types:** classes, interfaces, type aliases, enums are PascalCase
|
||||||
|
(`pascal-case-types` from explicit-types' `naming` config); string-union
|
||||||
|
members are UPPER_SNAKE_CASE; no `enum`.
|
||||||
|
- **Type parameters:** the user wants single capital letters (`T`, `K`), not
|
||||||
|
`Item`; explicit-types PR 2 adds `single-capital-type-params` to `naming`.
|
||||||
|
Write new code that way already.
|
||||||
|
- No autofix exists for `id-match`; rename by hand.
|
||||||
|
|
||||||
|
**Known differences from Deno's `camelcase`** (against its 130 test cases):
|
||||||
|
it misses 9 (unquoted object keys like `{ bar_baz: 1 }` and `{ bar_baz }`,
|
||||||
|
shorthand destructuring in parameters, `{ a_b: a_b }`,
|
||||||
|
`{ foo: bar_baz = 1 }`) and over-reports 17 (non-renamed imports, assignments
|
||||||
|
to unresolved globals, 11 ambient `declare` cases). Beyond Deno it also checks
|
||||||
|
type parameters, interface and type-literal members, class methods, and
|
||||||
|
labels. The user accepted these differences.
|
||||||
@@ -0,0 +1,40 @@
|
|||||||
|
---
|
||||||
|
description: package.json keys follow Oxfmt's standard order (vp check --fix); standard fields only; no peerDependencies or packageManager
|
||||||
|
---
|
||||||
|
|
||||||
|
## Key order (2026-10-16)
|
||||||
|
|
||||||
|
Oxfmt's standard `package.json` sorting is accepted: there is no
|
||||||
|
`fmt: { sortPackageJson: false }`, and `vp check --fix` sets the order. This
|
||||||
|
replaces the earlier hand-written order (metadata, `scripts`, `exports`,
|
||||||
|
`imports`, `devDependencies`, `dependencies`).
|
||||||
|
|
||||||
|
The `imports` key order can carry meaning: the import-structure plugin's
|
||||||
|
`enforce-layer-order` reads it as the layer order. Never reorder it casually.
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
- **Standard fields only.** App repos have no `engines` field (user decision
|
||||||
|
2026-10-18; images pin Node, [[toolchain-node-vite-plus]]). Published
|
||||||
|
packages keep `engines` with only `node` (never `engines.bun`).
|
||||||
|
A tool-owned key (`eslint-doc-generator`) is allowed only because the tool
|
||||||
|
reads nothing else and no other config file is allowed.
|
||||||
|
- **No `packageManager`.** npm is detected from `package-lock.json`.
|
||||||
|
- **No `peerDependencies`, ever** (user preference, 2026-10-14). If something
|
||||||
|
is needed at runtime, it goes in `dependencies`.
|
||||||
|
- **`dependencies`** = what runs or is type-referenced at runtime by consumers
|
||||||
|
(the lit-robust plugin ships `parse5`, `oxc-parser`, `oxc-resolver`, and
|
||||||
|
`@eslint/core` for its public types; they stay external, never bundled).
|
||||||
|
- **`devDependencies`** = everything else: `vite-plus`, `eslint`,
|
||||||
|
`@typescript-eslint/parser`, `eslint-doc-generator`, `esbuild`,
|
||||||
|
`typescript-6`, `@types/node`. ESLint is a devDependency only; plugins need
|
||||||
|
nothing from it at runtime.
|
||||||
|
|
||||||
|
Refresh the lockfile with `npm install` (or `npm install
|
||||||
|
--package-lock-only` for a version bump) and commit it with the change.
|
||||||
|
|
||||||
|
Alias rule: an alias may point anywhere and owns its target (a folder's
|
||||||
|
`index.ts` owns the folder and everything below it; any other file owns only
|
||||||
|
itself). No two aliases may own the same file, outside an area only the exact
|
||||||
|
alias reaches it, and `../` is banned in every file
|
||||||
|
([[imports-aliases-barrels]]).
|
||||||
@@ -0,0 +1,56 @@
|
|||||||
|
---
|
||||||
|
description: scripts/project-lint.ts is the repo-local plugin "project" holding the repo's rule list (typed DummyRuleMap) and repo-only rules; never published, no tests
|
||||||
|
---
|
||||||
|
|
||||||
|
Every repo has `scripts/project-lint.ts`, copied from
|
||||||
|
`cunarist/eslint-plugin-explicit-types` and extended. It is a repo-local
|
||||||
|
Oxlint plugin with `meta.name` `"project"`, loaded through `jsPlugins` in
|
||||||
|
`vite.config.ts`. It holds:
|
||||||
|
|
||||||
|
- **`configs.project.rules`**: the repo's whole rule list beyond the published
|
||||||
|
plugin configs: Deno parity rules, extras, per-rule options, and opt-outs,
|
||||||
|
built-in Oxlint ids included (`curly`, `id-match`, `import/no-cycle`, ...).
|
||||||
|
- **Custom rules**, enabled as `project/<rule>`. Every repo has
|
||||||
|
`no-disable-comments` and `no-asset-imports`; bot-agents has no others.
|
||||||
|
|
||||||
|
`scripts/` stays flat; don't add `scripts/rules/`. If the plugin ever needs
|
||||||
|
more files, they sit flat beside it and share the prefix
|
||||||
|
(`project-lint-modules.ts`, ...); `scripts/project-lint.ts` keeps the plugin
|
||||||
|
object and the rule list.
|
||||||
|
|
||||||
|
```ts
|
||||||
|
import type { DummyRuleMap } from "vite-plus/lint";
|
||||||
|
|
||||||
|
const rules: DummyRuleMap = {
|
||||||
|
"id-match": ["error", "^_*[^_]*_*$|^[^a-z]*$", {/* ... */}],
|
||||||
|
curly: "error",
|
||||||
|
"project/no-disable-comments": "error",
|
||||||
|
};
|
||||||
|
|
||||||
|
const plugin = {
|
||||||
|
meta: { name: "project" },
|
||||||
|
rules: { "no-disable-comments": noDisableCommentsRule /* ... */ },
|
||||||
|
configs: { project: { rules } },
|
||||||
|
};
|
||||||
|
export default plugin;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Why `DummyRuleMap` and an unannotated plugin (decided 2026-10-15)
|
||||||
|
|
||||||
|
- `DummyRuleMap` (re-exported by `vite-plus/lint`) is Oxlint's type for
|
||||||
|
`OxlintConfig.rules`. Despite the name it lists every built-in rule with its
|
||||||
|
options, so a typo in a rule id or option is a type error, not just a CI
|
||||||
|
failure. Without it, TypeScript widens `"error"` to `string`; `as const`
|
||||||
|
doesn't help because Oxlint wants mutable tuples.
|
||||||
|
- `@eslint/core`'s `Plugin` is too loose to read back: `configs` is optional,
|
||||||
|
any key may be missing, and a config may be an array, so
|
||||||
|
`projectLint.configs.project.rules` fails in `vite.config.ts` (and `!` is
|
||||||
|
banned). Optional chaining still leaves the array case.
|
||||||
|
- Oxlint's own `Plugin` type (`vite-plus/lint/plugins`) has no `configs`.
|
||||||
|
- Two hand-written interfaces worked but were dropped as noise; a plain
|
||||||
|
config object was rejected because custom rules need the plugin form anyway
|
||||||
|
and every repo should look the same.
|
||||||
|
|
||||||
|
`scripts/` is tooling, not production code: never packed or published, and
|
||||||
|
no tests. Narrow `overrides` for `scripts/**` are allowed when a script truly
|
||||||
|
needs one (e.g. `no-console`); see [[lint-overrides-policy]].
|
||||||
@@ -0,0 +1,39 @@
|
|||||||
|
---
|
||||||
|
description: Vitest via vp test; unit tests sit next to code as *.test.ts, regression/integration tests in tests/ via the public entry (through its # alias, never ../); scripts/ has no tests
|
||||||
|
---
|
||||||
|
|
||||||
|
Decided 2026-10-14 for all repos.
|
||||||
|
|
||||||
|
- **Runner:** Vitest through `vp test`. Import test APIs from
|
||||||
|
`vite-plus/test` (`describe`, `expect`, `it`).
|
||||||
|
- **Unit tests** sit next to the code: `src/foo/bar.ts` is tested in
|
||||||
|
`src/foo/bar.test.ts`. Vitest's default include finds them; no `test`
|
||||||
|
config needed. Packages publish only `dist/`, so colocated tests cost nothing
|
||||||
|
in the tarball.
|
||||||
|
- **Regression and integration tests** live in the top-level `tests/` folder
|
||||||
|
and use only the public entry point, imported through its `#` alias (e.g.
|
||||||
|
`#plugin` for `./src/plugin/index.ts`), never internals and never `../`,
|
||||||
|
which is banned in every file. `vp test tests` runs just these
|
||||||
|
([[imports-aliases-barrels]]). In bot-agents, `tests/` imports only
|
||||||
|
`#testing` (`./src/testing/index.ts`), plain helpers that import no source
|
||||||
|
module.
|
||||||
|
- **No in-source tests** (`import.meta.vitest`).
|
||||||
|
- **`scripts/` gets no tests** (2026-10-15): it is repo tooling, not
|
||||||
|
production code (`project-lint.ts`, `protect-source.sh`).
|
||||||
|
- Test files follow every lint rule; no relaxed overrides for tests.
|
||||||
|
|
||||||
|
## Migrating Deno tests
|
||||||
|
|
||||||
|
`Deno.test` suites were converted by a codemod
|
||||||
|
(`~/.local/share/deno-migration/src/convert.ts` on the user's machine), then
|
||||||
|
its TODOs finished by hand. Watch for:
|
||||||
|
|
||||||
|
- `@std/assert` → `expect` (`assertEquals` → `toStrictEqual` or `toBe`,
|
||||||
|
`assertThrows` → `toThrow`, `assertRejects` → `rejects.toThrow`);
|
||||||
|
- `Deno.*` file, env, and process APIs → `node:fs`, `process.env`,
|
||||||
|
`node:child_process`;
|
||||||
|
- `t.step` → nested `describe`/`it`;
|
||||||
|
- sanitizer options, which Vitest doesn't have.
|
||||||
|
|
||||||
|
A migration PR must keep every test case; a dropped case is lost coverage.
|
||||||
|
Tests must pass locally before any push.
|
||||||
@@ -0,0 +1,61 @@
|
|||||||
|
---
|
||||||
|
description: Node.js (no engines in apps; images pin 24) with Vite+ (vp) and npm; only package.json, tsconfig.json, vite.config.ts plus a committed package-lock.json
|
||||||
|
---
|
||||||
|
|
||||||
|
## The stack
|
||||||
|
|
||||||
|
- **Runtime:** Node.js. App repos have no `engines` field (user decision
|
||||||
|
2026-10-18): the container or runner image decides the version, so the
|
||||||
|
Containerfile base image (`node:24-alpine`) and CI's `node-version: "24"`
|
||||||
|
are the pins. Published packages (the lint plugins) keep their own
|
||||||
|
`engines.node` floor. `npm run lit-check` runs
|
||||||
|
`node scripts/lit-check.ts`, which needs Node 22.18+ (unflagged type
|
||||||
|
stripping and `module.registerHooks`); Node 24 satisfies it. Without
|
||||||
|
`engines` or a `.node-version`, local `vp` uses its default Node
|
||||||
|
(`vp env default`). bot-agents has no Containerfile or setup step: the
|
||||||
|
self-hosted runner's `node:24-bookworm` job image runs the action and its
|
||||||
|
checks, and `src/post/index.ts` needs 24.2+ (`import.meta.main`).
|
||||||
|
- **Bun is not supported** (dropped 2026-10-15). No Bun CI legs, docs, or
|
||||||
|
runtime branches. Oxlint's `RuleTester` refuses to run under Bun anyway, and
|
||||||
|
`vp` brings its own Node, the way uv brings its own Python.
|
||||||
|
- **Toolchain:** Vite+ (`vite-plus` devDependency, command `vp`): Vite,
|
||||||
|
Vitest, Oxlint, Oxfmt, type checking, tsdown.
|
||||||
|
- **Package manager:** npm everywhere. `package-lock.json` is committed in
|
||||||
|
apps _and_ libraries (user agreed 2026-10-14: `npm ci` needs it). There is no
|
||||||
|
`packageManager` field; Vite+ detects npm from the lockfile.
|
||||||
|
|
||||||
|
## Config files
|
||||||
|
|
||||||
|
Exactly three, plus the lockfile: `package.json`, `tsconfig.json`,
|
||||||
|
`vite.config.ts`. No `.oxlintrc.json`, `.prettierrc`, `eslint.config.*`,
|
||||||
|
`vitest.config.*`, `.npmrc`, or `tsdown.config.*`. Tool options go into
|
||||||
|
`vite.config.ts` keys (`lint`, `fmt`, `test`, `pack`) or, when a tool only
|
||||||
|
reads `package.json` (eslint-doc-generator), into a `package.json` key.
|
||||||
|
The target is a short `vite.config.ts`, around 30 lines (not strict).
|
||||||
|
|
||||||
|
## Commands
|
||||||
|
|
||||||
|
| Command | Does |
|
||||||
|
| ------------------------ | ---------------------------------------------------------- |
|
||||||
|
| `vp check` | format check, Oxlint (type-aware), and type check together |
|
||||||
|
| `vp check --fix` | the same, applying formatting and safe fixes |
|
||||||
|
| `vp test` | Vitest; `vp test tests` runs only the top-level `tests/` |
|
||||||
|
| `vp build` | Vite production build (apps) |
|
||||||
|
| `vp dev` | Vite dev server (apps) |
|
||||||
|
| `vp pack` | tsdown library build into `dist/` (packages) |
|
||||||
|
| `npm ci` / `npm install` | install; never another package manager |
|
||||||
|
|
||||||
|
`vp check`, `vp test`, and the build (`vp build` or `vp pack`) must all pass
|
||||||
|
before any push. CI installs the toolchain with `voidzero-dev/setup-vp`.
|
||||||
|
|
||||||
|
## Gotchas found during the migration
|
||||||
|
|
||||||
|
- `vp check` does **not** report `isolatedDeclarations` errors (TS9010); only
|
||||||
|
`vp pack` does, so packages run `vp pack` in CI on every PR.
|
||||||
|
- Oxfmt sorts `package.json` keys by default; that order is accepted, so
|
||||||
|
there is no `fmt` option for it ([[package-json-shape]]).
|
||||||
|
- Oxlint and Oxfmt skip what `.gitignore` lists; that is the only reason
|
||||||
|
`dist/` and `node_modules/` are not linted. Keep build output gitignored.
|
||||||
|
- Vite+ bundles `vite.config.ts` itself and resolves `#` imports in it.
|
||||||
|
- Oxlint loads a `.ts` plugin file directly on Node 24 (`jsPlugins`), so
|
||||||
|
repo-local lint plugins need no build step.
|
||||||
@@ -0,0 +1,59 @@
|
|||||||
|
---
|
||||||
|
description: Every file is .ts (no js/mjs/cjs/jsx/tsx, configs included); imports name only .ts files or .js/.mts/.mjs package subpaths; CSS comes from HTML, JSON/SVG become .ts modules
|
||||||
|
---
|
||||||
|
|
||||||
|
The user's rule, from the Deno days and restated for Node (2026-10-12): "No
|
||||||
|
JS, not even JSX/TSX, only TS." Source, scripts, tests, and configs are all
|
||||||
|
plain `.ts`. Build output in a gitignored folder is the only JS.
|
||||||
|
|
||||||
|
`tsconfig.json`: no `allowJs`, no `jsx`, and exactly this strictness set (user
|
||||||
|
decision, 2026-10-18): `strict` (written out), `noUncheckedIndexedAccess`,
|
||||||
|
`noPropertyAccessFromIndexSignature`, `noImplicitReturns`, `noUnusedLocals`,
|
||||||
|
`noUnusedParameters`, `noImplicitOverride`, `noFallthroughCasesInSwitch`,
|
||||||
|
`erasableSyntaxOnly`, and `allowUnreachableCode: false` plus
|
||||||
|
`allowUnusedLabels: false` (user decision, 2026-10-18; on in the Deno setup),
|
||||||
|
plus the mechanical `verbatimModuleSyntax`, `allowImportingTsExtensions`, and
|
||||||
|
`noEmit` (packages also keep `declaration` and `isolatedDeclarations`).
|
||||||
|
`exactOptionalPropertyTypes` is off everywhere: write `{ key: maybeUndefined }`
|
||||||
|
rather than leaving the key out to please it. If a tool or framework seems to
|
||||||
|
need a JS or TSX file, stop and flag it instead of adding one.
|
||||||
|
|
||||||
|
## No asset imports (2026-10-14, widened 2026-10-16 and 2026-10-17)
|
||||||
|
|
||||||
|
`project/no-asset-imports` (in `scripts/project-lint.ts`; it was
|
||||||
|
`no-non-ts-imports` before 2026-10-16) fails:
|
||||||
|
|
||||||
|
- a relative, absolute, `#`, or package-subpath specifier whose last segment
|
||||||
|
has an extension other than `.ts`, `.js`, `.mts`, or `.mjs`: `.css`,
|
||||||
|
`.json`, `.svg`, `.jsx`, `.tsx`, and every other asset;
|
||||||
|
- any `?query` suffix (`?raw`, `?url`, `?inline`);
|
||||||
|
- any import attributes (`with { type: "json" }`, `with { type: "text" }`).
|
||||||
|
|
||||||
|
`.js`, `.mts`, and `.mjs` are allowed (user decision, 2026-10-17) for package
|
||||||
|
subpaths such as `lit/decorators.js` or `pdfjs-dist/legacy/build/pdf.mjs`;
|
||||||
|
our own files are still `.ts` only. `.jsx` and `.tsx` stay banned. Bare
|
||||||
|
packages (`lit`, `@types/json-schema`, `lodash.debounce`), `#` aliases, and
|
||||||
|
`node:` builtins pass. `@fortawesome/x/svgs/a.svg` fails.
|
||||||
|
|
||||||
|
```ts
|
||||||
|
import "./theme.css"; // no
|
||||||
|
import data from "./scenes.json" with { type: "json" }; // no
|
||||||
|
import icon from "./lock.svg?raw"; // no
|
||||||
|
import { scenes } from "#data/scenes"; // yes: scenes.ts
|
||||||
|
```
|
||||||
|
|
||||||
|
## What to do instead
|
||||||
|
|
||||||
|
- **CSS:** load it from HTML with `<link rel="stylesheet" href="...">`. Never
|
||||||
|
import CSS from TS, not even for Vite. (This also removes most of the
|
||||||
|
`import/no-unassigned-import` hits the `suspicious` category reports.)
|
||||||
|
- **JSON data:** turn it into a `.ts` module exporting a typed constant.
|
||||||
|
- **SVG:** a `.ts` module exporting the markup.
|
||||||
|
- **`package.json` fields at runtime:** never `import pkg from
|
||||||
|
"./package.json"` and there is no `#package` alias. Write the value out in
|
||||||
|
`.ts` and add a test in `tests/` that reads `package.json` with `node:fs`
|
||||||
|
and fails on drift (the plugin repos do this for `meta.name`/`meta.version`).
|
||||||
|
- **Reading a file is not importing it.** `readFileSync` + `JSON.parse` is
|
||||||
|
fine in tooling and tests.
|
||||||
|
- **A tool's CLI file:** prefer the package entry or spawning the package's
|
||||||
|
bin over importing `pkg/cli.js`, which runs the CLI as a side effect.
|
||||||
@@ -0,0 +1,53 @@
|
|||||||
|
---
|
||||||
|
description: Ask one decision at a time with a code example, follow ESLint/ecosystem conventions and ask before deviating, keep config minimal, and never block when the user is away
|
||||||
|
---
|
||||||
|
|
||||||
|
## Asking
|
||||||
|
|
||||||
|
- **One question at a time.** Each decision question stands alone, with the
|
||||||
|
options and a recommendation.
|
||||||
|
- **Show code.** The user is new to the ESLint ecosystem and asked for
|
||||||
|
example code blocks whenever possible (2026-10-14): before/after snippets
|
||||||
|
or config examples, not prose alone.
|
||||||
|
|
||||||
|
```ts
|
||||||
|
// A. per-file override // B. refactor with a barrel
|
||||||
|
overrides: [{ files: [...] }] import { a, b } from "#ui";
|
||||||
|
```
|
||||||
|
|
||||||
|
- **Keep answers short.** State the decision and what changed; detail belongs
|
||||||
|
in `.agents/memory/`, not chat.
|
||||||
|
- The user often probes with "why?" and "is this the simplest form?". Have
|
||||||
|
the reason ready, and prefer the option with fewer lines, fewer files, and
|
||||||
|
fewer custom types when the result is equivalent.
|
||||||
|
|
||||||
|
## Conventions over invention
|
||||||
|
|
||||||
|
- Follow ESLint's and the wider ecosystem's conventions (typescript-eslint,
|
||||||
|
unicorn as references): `docs/rules/<rule>.md`, one plugin per package,
|
||||||
|
flat configs at `plugin.configs`, `meta.docs.url`, `index.ts` entries.
|
||||||
|
- **Any deviation is a question, not a default**, even one carried over from
|
||||||
|
the Deno version. The user was unhappy when rule docs were quietly placed in
|
||||||
|
`src/` ("You should have asked me about this though. We should respect
|
||||||
|
ESLint's way").
|
||||||
|
- Before finishing structural work, compare against well-known projects and
|
||||||
|
list every difference for the user.
|
||||||
|
|
||||||
|
## When the user is away
|
||||||
|
|
||||||
|
- **Never block on the user.** No approval requests, no waiting. Pick the
|
||||||
|
conservative option consistent with these notes, write the choice and its
|
||||||
|
reason in the PR or report, and continue. (An idle approval request once
|
||||||
|
cost hours; the user was emphatic.)
|
||||||
|
- Log open questions where the user will look: the PR body, and the shared
|
||||||
|
questions file the coordinator names (during the migration,
|
||||||
|
`~/.local/share/deno-migration/morning-questions.md`).
|
||||||
|
- Hard limits still hold without asking: no merging, no publishing, no
|
||||||
|
archiving, no pushing to `main`, no external state changes.
|
||||||
|
|
||||||
|
## Working style the user expects from agents
|
||||||
|
|
||||||
|
- Keep the main conversation free: repo edits, commits, and long checks run
|
||||||
|
in background subagents.
|
||||||
|
- Fan independent work out to many parallel subagents (more than five when it
|
||||||
|
splits), each in its own worktree when they share a branch.
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
*
|
||||||
@@ -0,0 +1,40 @@
|
|||||||
|
---
|
||||||
|
name: review-cycle
|
||||||
|
description: After opening a PR, run review rounds until fully approved; @bot on Capsulizers Gitea repos, an adversarial subagent review posted as a PR comment elsewhere; then hand to the user, never merge
|
||||||
|
---
|
||||||
|
|
||||||
|
Every PR gets reviewed before the user sees it. Repeat rounds until the
|
||||||
|
review is a full approval (cap: 6 rounds; if still not approved, stop and
|
||||||
|
report what remains). Never approve to finish early, and never merge.
|
||||||
|
|
||||||
|
## Capsulizers repos (git.capsulizers.com) with `.gitea/workflows/agents.yml`
|
||||||
|
|
||||||
|
1. Comment `@bot` on the PR through the Gitea API, as the user's own account
|
||||||
|
(credentials from the user's environment, sourced in a subshell, never
|
||||||
|
printed).
|
||||||
|
2. Wait for the review from the `bot` account (poll about every 2 minutes,
|
||||||
|
up to about 30 minutes per round).
|
||||||
|
3. For each point: fix valid ones with commits on the PR branch; reply
|
||||||
|
briefly with reasons to ones that are wrong.
|
||||||
|
4. Re-run `vp check`, the build, and `vp test`, push, and comment `@bot`
|
||||||
|
again. Done when the bot approves.
|
||||||
|
|
||||||
|
## Other repos (GitHub, or Gitea without the bot)
|
||||||
|
|
||||||
|
1. Have a separate subagent review the **full PR diff** adversarially:
|
||||||
|
correctness, behavior changes, missed Deno APIs, broken build paths, lint
|
||||||
|
parity, and violations of the repo's `.agents/memory` rules.
|
||||||
|
2. Post the review as a PR comment headed `Automated review (round N)`,
|
||||||
|
ending with exactly one verdict line: `VERDICT: APPROVED` or
|
||||||
|
`VERDICT: CHANGES REQUESTED`.
|
||||||
|
3. Address every point with commits, re-run checks, push, and reply to the
|
||||||
|
review comment summarizing the fixes.
|
||||||
|
4. Next round reviews from scratch, not just the fixes. Done when a round's
|
||||||
|
verdict is `APPROVED`.
|
||||||
|
|
||||||
|
## After approval
|
||||||
|
|
||||||
|
- Ask the user to review (or, when the user is away, list the PR and any open
|
||||||
|
questions in the report and the questions file). Don't wait idle.
|
||||||
|
- The user merges (squash). Don't merge even after approval unless the user
|
||||||
|
explicitly allowed it for this PR.
|
||||||
@@ -10,7 +10,7 @@ jobs:
|
|||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
# The action runs on this same image; src/post.ts needs Node 24.2+.
|
# The action runs on this same image; src/post/index.ts needs Node 24.2+.
|
||||||
- run: node --version
|
- run: node --version
|
||||||
|
|
||||||
- run: npm ci
|
- run: npm ci
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
At the start of every new session, run `damem recall` and treat its output as
|
At the start of every new session, run `damem recall` in the terminal and treat
|
||||||
the repository context. If `damem` is unavailable, read and follow
|
its output as the context for this repository. If the `damem` command is not
|
||||||
[its installation instructions](https://github.com/cunarist/damem/blob/main/INSTALL.md)
|
found, read [INSTALL.md](https://github.com/cunarist/damem/blob/main/INSTALL.md)
|
||||||
before reasoning or responding.
|
and follow it before reasoning or responding.
|
||||||
|
|
||||||
# Pull requests
|
# Pull requests
|
||||||
|
|
||||||
@@ -13,11 +13,41 @@ explicit permission.
|
|||||||
# Runtime and checks
|
# Runtime and checks
|
||||||
|
|
||||||
The action's TypeScript runs directly on the job image's Node.js (24.2 or
|
The action's TypeScript runs directly on the job image's Node.js (24.2 or
|
||||||
newer), which strips the types itself: there is no build step and no runtime
|
newer; `package.json` has no `engines`, the `node:24-bookworm` image pins it),
|
||||||
|
which strips the types itself: there is no build step and no runtime
|
||||||
dependency. Keep the sources to erasable syntax and `.ts` imports, which
|
dependency. Keep the sources to erasable syntax and `.ts` imports, which
|
||||||
`tsconfig.json` enforces. Checks use Vite+: `vp check` formats, lints, and
|
`tsconfig.json` enforces. Its strictness set is fixed and leaves
|
||||||
type-checks, and `vp test` runs Vitest. Unit tests sit next to the code as
|
`exactOptionalPropertyTypes` off
|
||||||
`src/*.test.ts`; repository-level tests live in `tests/`.
|
([.agents/memory/ts-only-files-and-imports.md](.agents/memory/ts-only-files-and-imports.md)).
|
||||||
|
Checks use Vite+: `vp check` formats, lints, and type-checks, and `vp test`
|
||||||
|
runs Vitest. Unit tests sit next to the code as `*.test.ts` in `src/`;
|
||||||
|
repository-level tests live in `tests/`.
|
||||||
|
|
||||||
|
A `#` alias in `package.json` `imports` may point anywhere and owns its
|
||||||
|
target: an alias to a folder's `index.ts` owns that folder and everything
|
||||||
|
below it; an alias to any other file owns only that file. No overlap: no file
|
||||||
|
may be owned by 2 aliases, so no alias inside another alias's area and no 2
|
||||||
|
aliases with the same target. Outside an area, only the exact alias reaches
|
||||||
|
it; a deeper alias specifier or a relative path into the area is a bypass.
|
||||||
|
Inside an area, relative imports of siblings and subfolders are free. A `../`
|
||||||
|
import is banned in every file, owned or not
|
||||||
|
(`import/no-relative-parent-imports`); runtime file URLs such as
|
||||||
|
`new URL("../prompt.md", import.meta.url)` are paths, not imports, and stay.
|
||||||
|
Files no alias owns need no `index.ts` and no alias, and import `./` siblings
|
||||||
|
and subfolders freely. Every top-level entry of `src/` is an aliased module
|
||||||
|
folder. The aliases, in layer order, are the three phases `#prepare`, `#run`,
|
||||||
|
and `#post`, then `#agents` (Codex,
|
||||||
|
Claude Code and OpenCode specifics), `#processes` (child processes and the
|
||||||
|
isolated profile users), `#runtime` (the prepared runtime and its
|
||||||
|
credentials), `#profiles`, `#common` (error and JSON checks), and `#testing`
|
||||||
|
(test helpers), each with a `src/<name>/index.ts` barrel. A phase's
|
||||||
|
`index.ts` is also its entry point, which `action.yml` runs as
|
||||||
|
`node src/<phase>/index.ts`. Tests that use the test
|
||||||
|
helpers import `#testing`, and `tests/` imports `src/` only through it. Local convention, stricter than the general rule above: in
|
||||||
|
this repo, aliases point only at a direct subfolder of `src/`
|
||||||
|
(`"#helpers": "./src/helpers/index.ts"`), and code outside `src/` uses `./`
|
||||||
|
relative imports. `scripts/` is flat: one file per tool, no subfolders and no `index.ts`, imported directly by file path
|
||||||
|
([.agents/memory/imports-aliases-barrels.md](.agents/memory/imports-aliases-barrels.md)).
|
||||||
|
|
||||||
The only config files are `package.json`, `tsconfig.json`, and
|
The only config files are `package.json`, `tsconfig.json`, and
|
||||||
`vite.config.ts`, plus `package-lock.json`. Repo-local lint rules and the rule
|
`vite.config.ts`, plus `package-lock.json`. Repo-local lint rules and the rule
|
||||||
@@ -25,6 +55,5 @@ list live in `scripts/project-lint.ts`. Lint disable comments are not allowed;
|
|||||||
fix the source instead.
|
fix the source instead.
|
||||||
|
|
||||||
The composite action uses npm only to install the externally distributed
|
The composite action uses npm only to install the externally distributed
|
||||||
Claude Code, Codex, and OpenCode command-line tools, plus Deno for agents that
|
Claude Code, Codex, and OpenCode command-line tools; do not treat those
|
||||||
check Deno-based repositories; do not treat those vendor executables as
|
vendor executables as repository TypeScript dependencies.
|
||||||
repository TypeScript dependencies.
|
|
||||||
|
|||||||
+5
-6
@@ -16,11 +16,10 @@ runs:
|
|||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
token: ${{ gitea.token }}
|
token: ${{ gitea.token }}
|
||||||
# This step assumes this is `node:24-bookworm` container. The action runs
|
# This step assumes this is `node:24-bookworm` container. The action runs
|
||||||
# its TypeScript on that Node directly; Deno stays for the agents, which
|
# its TypeScript on that Node directly.
|
||||||
# still check Deno-based repositories with it.
|
|
||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
shell: bash
|
shell: bash
|
||||||
run: npm install -g @openai/codex @anthropic-ai/claude-code opencode-ai deno
|
run: npm install -g @openai/codex @anthropic-ai/claude-code opencode-ai
|
||||||
# A local action lives inside the writable checkout. Execute a root-owned
|
# A local action lives inside the writable checkout. Execute a root-owned
|
||||||
# copy so an agent changing this repository cannot replace a later phase.
|
# copy so an agent changing this repository cannot replace a later phase.
|
||||||
- name: Protect action source
|
- name: Protect action source
|
||||||
@@ -36,7 +35,7 @@ runs:
|
|||||||
- name: Prepare credentials
|
- name: Prepare credentials
|
||||||
id: prepare
|
id: prepare
|
||||||
shell: bash
|
shell: bash
|
||||||
run: node "${{ steps.source.outputs.path }}/src/prepare.ts"
|
run: node "${{ steps.source.outputs.path }}/src/prepare/index.ts"
|
||||||
env:
|
env:
|
||||||
ACTION_PATH: ${{ steps.source.outputs.path }}
|
ACTION_PATH: ${{ steps.source.outputs.path }}
|
||||||
BOT_AGENTS_MASTER_KEY: ${{ inputs.master-key }}
|
BOT_AGENTS_MASTER_KEY: ${{ inputs.master-key }}
|
||||||
@@ -44,7 +43,7 @@ runs:
|
|||||||
- name: Run bot
|
- name: Run bot
|
||||||
id: agent
|
id: agent
|
||||||
shell: bash
|
shell: bash
|
||||||
run: node "${{ steps.source.outputs.path }}/src/run.ts"
|
run: node "${{ steps.source.outputs.path }}/src/run/index.ts"
|
||||||
env:
|
env:
|
||||||
BOT_AGENTS_MANIFEST: ${{ steps.prepare.outputs.manifest }}
|
BOT_AGENTS_MANIFEST: ${{ steps.prepare.outputs.manifest }}
|
||||||
GITEA_TOKEN: ${{ gitea.token }}
|
GITEA_TOKEN: ${{ gitea.token }}
|
||||||
@@ -57,7 +56,7 @@ runs:
|
|||||||
id: post
|
id: post
|
||||||
if: always() && steps.prepare.outputs.manifest != ''
|
if: always() && steps.prepare.outputs.manifest != ''
|
||||||
shell: bash
|
shell: bash
|
||||||
run: node "${{ steps.source.outputs.path }}/src/post.ts"
|
run: node "${{ steps.source.outputs.path }}/src/post/index.ts"
|
||||||
env:
|
env:
|
||||||
BOT_AGENTS_MANIFEST: ${{ steps.prepare.outputs.manifest }}
|
BOT_AGENTS_MANIFEST: ${{ steps.prepare.outputs.manifest }}
|
||||||
GITEA_API_URL: ${{ gitea.api_url }}
|
GITEA_API_URL: ${{ gitea.api_url }}
|
||||||
|
|||||||
Generated
+28
-3
@@ -9,11 +9,10 @@
|
|||||||
"@eslint/core": "^0.17.0",
|
"@eslint/core": "^0.17.0",
|
||||||
"@types/node": "^24.19.2",
|
"@types/node": "^24.19.2",
|
||||||
"@typescript-eslint/types": "^8.71.2",
|
"@typescript-eslint/types": "^8.71.2",
|
||||||
|
"eslint-plugin-explicit-types": "^0.6.1",
|
||||||
|
"eslint-plugin-import-structure": "^0.10.2",
|
||||||
"vite-plus": "^1.2.0",
|
"vite-plus": "^1.2.0",
|
||||||
"yaml": "^2.9.1"
|
"yaml": "^2.9.1"
|
||||||
},
|
|
||||||
"engines": {
|
|
||||||
"node": ">=24.2"
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/@babel/code-frame": {
|
"node_modules/@babel/code-frame": {
|
||||||
@@ -1890,6 +1889,32 @@
|
|||||||
"dev": true,
|
"dev": true,
|
||||||
"license": "MIT"
|
"license": "MIT"
|
||||||
},
|
},
|
||||||
|
"node_modules/eslint-plugin-explicit-types": {
|
||||||
|
"version": "0.6.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/eslint-plugin-explicit-types/-/eslint-plugin-explicit-types-0.6.1.tgz",
|
||||||
|
"integrity": "sha512-8JU2Ceoi1aLbhYo4LHwb9Eone/pJuMnzVP1ZlGJn/ETxVzJQFziRnJwOF2dRmInn9dGqvwq05dc3o5tVyTGP2Q==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT",
|
||||||
|
"dependencies": {
|
||||||
|
"@eslint/core": "^0.17.0"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">=22.18"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/eslint-plugin-import-structure": {
|
||||||
|
"version": "0.10.2",
|
||||||
|
"resolved": "https://registry.npmjs.org/eslint-plugin-import-structure/-/eslint-plugin-import-structure-0.10.2.tgz",
|
||||||
|
"integrity": "sha512-jvx4sccxEdURGXrDtBJZtCHiKqELkHRVlLrMU5bVZIjglN0U464Joopcfn6JvmNB2zyIh2FkolaJQJaKkvy6Xw==",
|
||||||
|
"dev": true,
|
||||||
|
"license": "MIT",
|
||||||
|
"dependencies": {
|
||||||
|
"@eslint/core": "^0.17.0"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">=22.18"
|
||||||
|
}
|
||||||
|
},
|
||||||
"node_modules/estree-walker": {
|
"node_modules/estree-walker": {
|
||||||
"version": "3.0.3",
|
"version": "3.0.3",
|
||||||
"resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-3.0.3.tgz",
|
"resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-3.0.3.tgz",
|
||||||
|
|||||||
+13
-3
@@ -1,15 +1,25 @@
|
|||||||
{
|
{
|
||||||
"name": "bot-agents",
|
"name": "bot-agents",
|
||||||
"description": "A Gitea composite action that runs a coding agent for approved issue and pull request automation.",
|
|
||||||
"private": true,
|
"private": true,
|
||||||
|
"description": "A Gitea composite action that runs a coding agent for approved issue and pull request automation.",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"engines": {
|
"imports": {
|
||||||
"node": ">=24.2"
|
"#prepare": "./src/prepare/index.ts",
|
||||||
|
"#run": "./src/run/index.ts",
|
||||||
|
"#post": "./src/post/index.ts",
|
||||||
|
"#agents": "./src/agents/index.ts",
|
||||||
|
"#processes": "./src/processes/index.ts",
|
||||||
|
"#runtime": "./src/runtime/index.ts",
|
||||||
|
"#profiles": "./src/profiles/index.ts",
|
||||||
|
"#common": "./src/common/index.ts",
|
||||||
|
"#testing": "./src/testing/index.ts"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@eslint/core": "^0.17.0",
|
"@eslint/core": "^0.17.0",
|
||||||
"@types/node": "^24.19.2",
|
"@types/node": "^24.19.2",
|
||||||
"@typescript-eslint/types": "^8.71.2",
|
"@typescript-eslint/types": "^8.71.2",
|
||||||
|
"eslint-plugin-explicit-types": "^0.6.1",
|
||||||
|
"eslint-plugin-import-structure": "^0.10.2",
|
||||||
"vite-plus": "^1.2.0",
|
"vite-plus": "^1.2.0",
|
||||||
"yaml": "^2.9.1"
|
"yaml": "^2.9.1"
|
||||||
}
|
}
|
||||||
|
|||||||
+65
-31
@@ -1,8 +1,7 @@
|
|||||||
/**
|
/**
|
||||||
* `project` — lint rules this repository holds its own source to. Deno lint
|
* `project` — lint rules this repository holds its own source to, on top of
|
||||||
* ran here with its `recommended` rules and no plugins; the Oxlint categories
|
* the Oxlint categories in `vite.config.ts`. Its rules of its own are
|
||||||
* in `vite.config.ts` plus the rule list below keep at least that coverage.
|
* `no-disable-comments` and `no-asset-imports`.
|
||||||
* Its rules of its own are `no-disable-comments` and `no-non-ts-imports`.
|
|
||||||
*
|
*
|
||||||
* Loaded by `vite.config.ts` as an Oxlint `jsPlugins` entry.
|
* Loaded by `vite.config.ts` as an Oxlint `jsPlugins` entry.
|
||||||
*
|
*
|
||||||
@@ -10,7 +9,7 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
import type { LanguageOptions, RuleDefinition, RuleVisitor, TextSourceCode } from "@eslint/core";
|
import type { LanguageOptions, RuleDefinition, RuleVisitor, TextSourceCode } from "@eslint/core";
|
||||||
import type { TSESTree } from "@typescript-eslint/types";
|
import { AST_NODE_TYPES, type TSESTree } from "@typescript-eslint/types";
|
||||||
import type { DummyRuleMap } from "vite-plus/lint";
|
import type { DummyRuleMap } from "vite-plus/lint";
|
||||||
|
|
||||||
/** The source code both hosts hand a rule, with the comment list. */
|
/** The source code both hosts hand a rule, with the comment list. */
|
||||||
@@ -73,11 +72,19 @@ const noDisableCommentsRule: ProjectRule = {
|
|||||||
const PATH_SPECIFIER_PATTERN: RegExp = /^[./#]/u;
|
const PATH_SPECIFIER_PATTERN: RegExp = /^[./#]/u;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Whether `source` names something other than a `.ts` module: a query string
|
* Script module extensions an import may name: our `.ts` files and `.js`,
|
||||||
* such as `?raw`, or a final path segment with any other extension. Bare
|
* `.mts`, or `.mjs` package subpaths. `.cts`, `.cjs`, `.tsx`, and `.jsx` are
|
||||||
* package names are left alone, dots and all, as are extensionless paths.
|
* not among them.
|
||||||
*/
|
*/
|
||||||
function isNonTsSource(source: string): boolean {
|
const SCRIPT_EXTENSIONS: ReadonlySet<string> = new Set([".ts", ".js", ".mts", ".mjs"]);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether `source` names an asset rather than a script module: a query string
|
||||||
|
* such as `?raw`, or a final path segment whose extension, from its last dot,
|
||||||
|
* is not `.ts`, `.js`, `.mts`, or `.mjs`. Bare package names are left alone,
|
||||||
|
* dots and all, as are extensionless paths.
|
||||||
|
*/
|
||||||
|
function isAssetSource(source: string): boolean {
|
||||||
if (source.includes("?")) {
|
if (source.includes("?")) {
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
@@ -92,30 +99,34 @@ function isNonTsSource(source: string): boolean {
|
|||||||
if (lastSegment === "." || lastSegment === ".." || !lastSegment.includes(".")) {
|
if (lastSegment === "." || lastSegment === ".." || !lastSegment.includes(".")) {
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
return !lastSegment.endsWith(".ts");
|
const extension: string = lastSegment.slice(lastSegment.lastIndexOf("."));
|
||||||
|
return !SCRIPT_EXTENSIONS.has(extension);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* `no-non-ts-imports` — rejects importing anything but a `.ts` module: a
|
* `no-asset-imports` — rejects importing anything but a script module: a
|
||||||
* source path, static or a dynamic `import()` with a string literal, ending in
|
* source path, static or a dynamic `import()` with a string literal, ending in
|
||||||
* another extension (`.css`, `.json`, `.svg`, `.js`, `.tsx`) or carrying a
|
* an extension other than `.ts`, `.js`, `.mts`, or `.mjs` (`.css`, `.json`,
|
||||||
* query string (`?raw`, `?url`), and any import or export with import
|
* `.svg`, `.jsx`, `.tsx`, `.cjs`) or carrying a query string (`?raw`, `?url`),
|
||||||
* attributes. Bare package names, `#` aliases, and `node:` builtins without an
|
* and any import or export with import attributes. `.js`, `.mts`, and `.mjs`
|
||||||
* extension pass; package subpaths are checked like paths.
|
* cover package subpaths such as `lit/decorators.js` or
|
||||||
|
* `pdfjs-dist/legacy/build/pdf.mjs`; our own files are still `.ts` only. Bare
|
||||||
|
* package names, `#` aliases, and `node:` builtins
|
||||||
|
* without an extension pass; package subpaths are checked like paths.
|
||||||
*/
|
*/
|
||||||
const noNonTsImportsRule: ProjectRule = {
|
const noAssetImportsRule: ProjectRule = {
|
||||||
meta: {
|
meta: {
|
||||||
type: "problem",
|
type: "problem",
|
||||||
docs: { description: "Disallow importing modules other than .ts files" },
|
docs: { description: "Disallow importing assets instead of .ts, .js, .mts, or .mjs modules" },
|
||||||
schema: [],
|
schema: [],
|
||||||
messages: {
|
messages: {
|
||||||
extension: "Only .ts modules may be imported.",
|
extension: "Only .ts, .js, .mts and .mjs modules may be imported.",
|
||||||
attributes: "Import attributes are not allowed.",
|
attributes: "Import attributes are not allowed.",
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
create(context) {
|
create(context) {
|
||||||
function checkSource(source: TSESTree.StringLiteral): void {
|
function checkSource(source: TSESTree.StringLiteral): void {
|
||||||
if (isNonTsSource(source.value)) {
|
if (isAssetSource(source.value)) {
|
||||||
context.report({ node: source, messageId: "extension" });
|
context.report({ node: source, messageId: "extension" });
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -138,7 +149,7 @@ const noNonTsImportsRule: ProjectRule = {
|
|||||||
ExportNamedDeclaration: checkDeclaration,
|
ExportNamedDeclaration: checkDeclaration,
|
||||||
ExportAllDeclaration: checkDeclaration,
|
ExportAllDeclaration: checkDeclaration,
|
||||||
ImportExpression(node: TSESTree.ImportExpression): void {
|
ImportExpression(node: TSESTree.ImportExpression): void {
|
||||||
if (node.source.type === "Literal" && typeof node.source.value === "string") {
|
if (node.source.type === AST_NODE_TYPES.Literal && typeof node.source.value === "string") {
|
||||||
checkSource(node.source);
|
checkSource(node.source);
|
||||||
}
|
}
|
||||||
if (node.options !== null) {
|
if (node.options !== null) {
|
||||||
@@ -150,10 +161,9 @@ const noNonTsImportsRule: ProjectRule = {
|
|||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This repository's own rule list, spread by `vite.config.ts`: Deno's
|
* This repository's own rule list, spread by `vite.config.ts`: rules that
|
||||||
* `recommended` rules that sit outside the Oxlint categories, plus the
|
* sit outside the Oxlint categories, plus the template's extras. Built-in
|
||||||
* template's extras. Built-in Oxlint rule ids sit here too, so
|
* Oxlint rule ids sit here too, so `vite.config.ts` lists no rule by name.
|
||||||
* `vite.config.ts` lists no rule by name.
|
|
||||||
*/
|
*/
|
||||||
const rules: DummyRuleMap = {
|
const rules: DummyRuleMap = {
|
||||||
// The explicit-types template's `camelcase` stand-in: no `_` inside a name
|
// The explicit-types template's `camelcase` stand-in: no `_` inside a name
|
||||||
@@ -164,7 +174,7 @@ const rules: DummyRuleMap = {
|
|||||||
"^_*[^_]*_*$|^[^a-z]*$",
|
"^_*[^_]*_*$|^[^a-z]*$",
|
||||||
{ properties: false, classFields: false, onlyDeclarations: false, ignoreDestructuring: true },
|
{ properties: false, classFields: false, onlyDeclarations: false, ignoreDestructuring: true },
|
||||||
],
|
],
|
||||||
// Deno's `recommended` rules outside the categories.
|
// Rules outside the categories.
|
||||||
"no-array-constructor": "error",
|
"no-array-constructor": "error",
|
||||||
"no-case-declarations": "error",
|
"no-case-declarations": "error",
|
||||||
"no-empty": "error",
|
"no-empty": "error",
|
||||||
@@ -189,8 +199,7 @@ const rules: DummyRuleMap = {
|
|||||||
"typescript/prefer-as-const": "error",
|
"typescript/prefer-as-const": "error",
|
||||||
"typescript/prefer-namespace-keyword": "error",
|
"typescript/prefer-namespace-keyword": "error",
|
||||||
"typescript/triple-slash-reference": "error",
|
"typescript/triple-slash-reference": "error",
|
||||||
// Deno's `no-window`, `no-process-global`, and `no-node-globals`: on Node,
|
// On Node, these come from an explicit `node:` import instead of the global scope.
|
||||||
// these come from an explicit `node:` import instead of the global scope.
|
|
||||||
"no-restricted-globals": [
|
"no-restricted-globals": [
|
||||||
"error",
|
"error",
|
||||||
"window",
|
"window",
|
||||||
@@ -202,14 +211,39 @@ const rules: DummyRuleMap = {
|
|||||||
],
|
],
|
||||||
// The explicit-types template's extras.
|
// The explicit-types template's extras.
|
||||||
"import/no-cycle": "error",
|
"import/no-cycle": "error",
|
||||||
|
// `../` is banned in every file; anything above a file needs a `#` alias.
|
||||||
|
"import/no-relative-parent-imports": "error",
|
||||||
"typescript/consistent-type-imports": "error",
|
"typescript/consistent-type-imports": "error",
|
||||||
"typescript/no-import-type-side-effects": "error",
|
"typescript/no-import-type-side-effects": "error",
|
||||||
"typescript/no-non-null-assertion": "error",
|
"typescript/no-non-null-assertion": "error",
|
||||||
// Deno's `ban-untagged-ignore` and `ban-unused-ignore`, made stricter: no
|
// No disable comments at all.
|
||||||
// disable comments at all.
|
|
||||||
"project/no-disable-comments": "error",
|
"project/no-disable-comments": "error",
|
||||||
"project/no-non-ts-imports": "error",
|
"project/no-asset-imports": "error",
|
||||||
"unicorn/no-abusive-eslint-disable": "error",
|
"unicorn/no-abusive-eslint-disable": "error",
|
||||||
|
// Size and complexity limits match Deno's: this repo's `deno lint` ran the
|
||||||
|
// `recommended` set with no config file, so no size or complexity rule
|
||||||
|
// applied and none applies here. Each Oxlint limit rule, from a category or
|
||||||
|
// not, is off:
|
||||||
|
// - `complexity`: Deno had no `max-complexity`.
|
||||||
|
// - `max-lines`: Deno had no `max-file-lines`.
|
||||||
|
// - `max-params`: Deno had no `max-params`.
|
||||||
|
// - `id-length`: Deno had no `max-identifier-length`.
|
||||||
|
// - `no-nested-ternary`: Deno had no `max-nest-ternaries`.
|
||||||
|
// - `max-lines-per-function`, `max-classes-per-file`, `max-depth`,
|
||||||
|
// `max-nested-callbacks`, `max-statements`, `import/max-dependencies`,
|
||||||
|
// `unicorn/max-nested-calls`: Deno had none of these.
|
||||||
|
complexity: "off",
|
||||||
|
"max-lines": "off",
|
||||||
|
"max-params": "off",
|
||||||
|
"id-length": "off",
|
||||||
|
"no-nested-ternary": "off",
|
||||||
|
"max-lines-per-function": "off",
|
||||||
|
"max-classes-per-file": "off",
|
||||||
|
"max-depth": "off",
|
||||||
|
"max-nested-callbacks": "off",
|
||||||
|
"max-statements": "off",
|
||||||
|
"import/max-dependencies": "off",
|
||||||
|
"unicorn/max-nested-calls": "off",
|
||||||
// Pedantic, but Node's and the web's own types (`Response`, `Stats`,
|
// Pedantic, but Node's and the web's own types (`Response`, `Stats`,
|
||||||
// `RequestInit`) are mutable, so no parameter of theirs can pass; the
|
// `RequestInit`) are mutable, so no parameter of theirs can pass; the
|
||||||
// explicit-types template and the app repos turn it off too.
|
// explicit-types template and the app repos turn it off too.
|
||||||
@@ -224,7 +258,7 @@ const plugin = {
|
|||||||
meta: { name: "project" },
|
meta: { name: "project" },
|
||||||
rules: {
|
rules: {
|
||||||
"no-disable-comments": noDisableCommentsRule,
|
"no-disable-comments": noDisableCommentsRule,
|
||||||
"no-non-ts-imports": noNonTsImportsRule,
|
"no-asset-imports": noAssetImportsRule,
|
||||||
},
|
},
|
||||||
configs: { project: { rules } },
|
configs: { project: { rules } },
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -2,9 +2,9 @@
|
|||||||
set -euo pipefail
|
set -euo pipefail
|
||||||
|
|
||||||
path=$(mktemp -d "${RUNNER_TEMP}/bot-agents-source-XXXXXX")
|
path=$(mktemp -d "${RUNNER_TEMP}/bot-agents-source-XXXXXX")
|
||||||
mkdir "${path}/src"
|
cp -a "${ACTION_PATH}/src" "${path}/"
|
||||||
cp -a "${ACTION_PATH}"/src/*.ts "${path}/src/"
|
# package.json makes Node load the TypeScript sources as ES modules and
|
||||||
# package.json makes Node load the TypeScript sources as ES modules.
|
# resolves their `#` aliases.
|
||||||
cp -a "${ACTION_PATH}/package.json" "${ACTION_PATH}/profiles.json" "${ACTION_PATH}/prompt.md" "${path}/"
|
cp -a "${ACTION_PATH}/package.json" "${ACTION_PATH}/profiles.json" "${ACTION_PATH}/prompt.md" "${path}/"
|
||||||
chmod -R go-w "${path}"
|
chmod -R go-w "${path}"
|
||||||
printf 'path=%s\n' "${path}" >> "${GITHUB_OUTPUT}"
|
printf 'path=%s\n' "${path}" >> "${GITHUB_OUTPUT}"
|
||||||
|
|||||||
@@ -1,119 +0,0 @@
|
|||||||
// Runs Claude Code for one profile and returns its final result text.
|
|
||||||
import { createInterface } from "node:readline";
|
|
||||||
import type { Readable } from "node:stream";
|
|
||||||
|
|
||||||
import { isClaudeAuthFailure } from "./auth.ts";
|
|
||||||
import type { ClaudeFailureFields } from "./auth.ts";
|
|
||||||
import { chunks } from "./command.ts";
|
|
||||||
import { agentCommand } from "./isolation.ts";
|
|
||||||
import { isObject } from "./json.ts";
|
|
||||||
import type { JsonObject } from "./json.ts";
|
|
||||||
import { AgentAuthError, agentEnvironment } from "./profiles.ts";
|
|
||||||
import { PROCESS_ENV, WORKSPACE } from "./run-context.ts";
|
|
||||||
import type { RuntimeProfile } from "./runtime.ts";
|
|
||||||
|
|
||||||
// Claude Code's stream-json `result` event, in its own field names.
|
|
||||||
type ClaudeResult = ClaudeFailureFields &
|
|
||||||
Partial<Record<"is_error", boolean>> & {
|
|
||||||
subtype: string;
|
|
||||||
};
|
|
||||||
|
|
||||||
// Echoes stderr as it arrives and resolves with all of it.
|
|
||||||
async function copyError(stream: Readable): Promise<string> {
|
|
||||||
const decoder = new TextDecoder();
|
|
||||||
let error = "";
|
|
||||||
for await (const chunk of chunks(stream)) {
|
|
||||||
const text = decoder.decode(chunk, { stream: true });
|
|
||||||
error += text;
|
|
||||||
console.error(text);
|
|
||||||
}
|
|
||||||
return error + decoder.decode();
|
|
||||||
}
|
|
||||||
|
|
||||||
// Prints the visible text of each streamed message part.
|
|
||||||
function printParts(event: JsonObject): void {
|
|
||||||
const content = isObject(event.message) ? event.message.content : undefined;
|
|
||||||
for (const part of Array.isArray(content) ? content : []) {
|
|
||||||
if (isObject(part)) {
|
|
||||||
const text = part.thinking ?? part.text ?? part.name;
|
|
||||||
if (typeof text === "string" && text !== "") {
|
|
||||||
console.log(text);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
function toResult(event: JsonObject): ClaudeResult {
|
|
||||||
const { is_error: isError, result, subtype, api_error_status: apiErrorStatus } = event;
|
|
||||||
return {
|
|
||||||
...(typeof isError === "boolean" && { is_error: isError }),
|
|
||||||
...(typeof result === "string" && { result }),
|
|
||||||
subtype: String(subtype),
|
|
||||||
...((typeof apiErrorStatus === "number" || apiErrorStatus === null) && {
|
|
||||||
api_error_status: apiErrorStatus,
|
|
||||||
}),
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
// Prints each streamed message part and returns the final `result` event.
|
|
||||||
async function readEvents(stream: Readable): Promise<ClaudeResult | undefined> {
|
|
||||||
let result: ClaudeResult | undefined;
|
|
||||||
for await (const line of createInterface({ input: stream, crlfDelay: Infinity })) {
|
|
||||||
if (line !== "") {
|
|
||||||
const event: unknown = JSON.parse(line);
|
|
||||||
if (isObject(event)) {
|
|
||||||
printParts(event);
|
|
||||||
if (event.type === "result") {
|
|
||||||
result = toResult(event);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return result;
|
|
||||||
}
|
|
||||||
|
|
||||||
function checkResult(result: ClaudeResult | undefined, error: string): string {
|
|
||||||
if (result?.is_error === true) {
|
|
||||||
const failure = new Error(result.result ?? `claude ended with ${result.subtype}`);
|
|
||||||
if (isClaudeAuthFailure(result)) {
|
|
||||||
throw new AgentAuthError("claude sign-in failed", { cause: failure });
|
|
||||||
}
|
|
||||||
throw failure;
|
|
||||||
}
|
|
||||||
if (result?.result === undefined) {
|
|
||||||
throw new Error(error.trim() || `claude ended with ${result?.subtype ?? "no result"}`);
|
|
||||||
}
|
|
||||||
return result.result;
|
|
||||||
}
|
|
||||||
|
|
||||||
export async function runClaude(
|
|
||||||
profile: RuntimeProfile,
|
|
||||||
token: string,
|
|
||||||
prompt: string,
|
|
||||||
): Promise<string> {
|
|
||||||
const args = [
|
|
||||||
"--print",
|
|
||||||
"--dangerously-skip-permissions",
|
|
||||||
"--model",
|
|
||||||
profile.model,
|
|
||||||
"--output-format",
|
|
||||||
"stream-json",
|
|
||||||
"--verbose",
|
|
||||||
prompt,
|
|
||||||
];
|
|
||||||
const claude = agentCommand(profile, "claude", args, {
|
|
||||||
cwd: WORKSPACE,
|
|
||||||
env: { ...agentEnvironment(PROCESS_ENV, profile, token), IS_SANDBOX: "1" },
|
|
||||||
clearEnv: true,
|
|
||||||
stdout: "piped",
|
|
||||||
stderr: "piped",
|
|
||||||
}).spawn();
|
|
||||||
const errorText = copyError(claude.stderr);
|
|
||||||
const result = await readEvents(claude.stdout);
|
|
||||||
const [status, error] = await Promise.all([claude.status, errorText]);
|
|
||||||
const body = checkResult(result, error);
|
|
||||||
if (!status.success) {
|
|
||||||
throw new Error(error.trim() || `claude exited with ${status.code}`);
|
|
||||||
}
|
|
||||||
return body;
|
|
||||||
}
|
|
||||||
@@ -1,174 +0,0 @@
|
|||||||
// Signs Codex in for one profile, runs it, and returns its result file path.
|
|
||||||
import process from "node:process";
|
|
||||||
import type { Readable } from "node:stream";
|
|
||||||
import { text } from "node:stream/consumers";
|
|
||||||
import { setTimeout as sleep } from "node:timers/promises";
|
|
||||||
|
|
||||||
import { isCodexAuthFailure, retryInvalidToken } from "./auth.ts";
|
|
||||||
import type { CodexAuthentication } from "./auth.ts";
|
|
||||||
import { chunks, endWith, writeChunk } from "./command.ts";
|
|
||||||
import type { CommandStatus } from "./command.ts";
|
|
||||||
import { agentCommand } from "./isolation.ts";
|
|
||||||
import { AgentAuthError, agentEnvironment, withProfile } from "./profiles.ts";
|
|
||||||
import {
|
|
||||||
makeProfileFile,
|
|
||||||
postAuthorComment,
|
|
||||||
PROCESS_ENV,
|
|
||||||
runAgentCommand,
|
|
||||||
WORKSPACE,
|
|
||||||
} from "./run-context.ts";
|
|
||||||
import type { RuntimeProfile } from "./runtime.ts";
|
|
||||||
|
|
||||||
interface CodexAttempt {
|
|
||||||
status: CommandStatus;
|
|
||||||
error: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
async function collectText(stream: Readable, append: (chunk: string) => void): Promise<void> {
|
|
||||||
const decoder = new TextDecoder();
|
|
||||||
for await (const chunk of chunks(stream)) {
|
|
||||||
append(decoder.decode(chunk, { stream: true }));
|
|
||||||
}
|
|
||||||
append(decoder.decode());
|
|
||||||
}
|
|
||||||
|
|
||||||
// Polls every 100 ms until the login prints something, failing if it exits first.
|
|
||||||
async function pollForInstructions(
|
|
||||||
shownText: () => string,
|
|
||||||
status: Promise<CommandStatus>,
|
|
||||||
): Promise<void> {
|
|
||||||
if (shownText().trim() !== "") {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
const exited = await Promise.race([status.then(() => true), sleep(100, false)]);
|
|
||||||
if (exited) {
|
|
||||||
throw new AgentAuthError("AI bot login produced no instructions");
|
|
||||||
}
|
|
||||||
await pollForInstructions(shownText, status);
|
|
||||||
}
|
|
||||||
|
|
||||||
async function codexDeviceLogin(
|
|
||||||
profile: RuntimeProfile,
|
|
||||||
environment: Record<string, string>,
|
|
||||||
): Promise<void> {
|
|
||||||
const login = agentCommand(profile, "codex", ["login", "--device-auth"], {
|
|
||||||
cwd: WORKSPACE,
|
|
||||||
env: environment,
|
|
||||||
clearEnv: true,
|
|
||||||
stdout: "piped",
|
|
||||||
stderr: "piped",
|
|
||||||
}).spawn();
|
|
||||||
let shown = "";
|
|
||||||
const append = (chunk: string): void => {
|
|
||||||
shown += chunk;
|
|
||||||
};
|
|
||||||
const drained = Promise.all([
|
|
||||||
collectText(login.stdout, append),
|
|
||||||
collectText(login.stderr, append),
|
|
||||||
]);
|
|
||||||
await sleep(3000);
|
|
||||||
await pollForInstructions(() => shown, login.status);
|
|
||||||
await postAuthorComment(withProfile(shown, profile));
|
|
||||||
const [result] = await Promise.all([login.status, drained]);
|
|
||||||
if (!result.success) {
|
|
||||||
throw new AgentAuthError(`codex login exited with ${result.code}`);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
async function codexApiLogin(
|
|
||||||
profile: RuntimeProfile,
|
|
||||||
environment: Record<string, string>,
|
|
||||||
token: string,
|
|
||||||
): Promise<void> {
|
|
||||||
const login = agentCommand(profile, "codex", ["login", "--with-api-key"], {
|
|
||||||
cwd: WORKSPACE,
|
|
||||||
env: environment,
|
|
||||||
clearEnv: true,
|
|
||||||
stdin: "piped",
|
|
||||||
stderr: "piped",
|
|
||||||
}).spawn();
|
|
||||||
await endWith(login.stdin, `${token}\n`);
|
|
||||||
const [status, error] = await Promise.all([login.status, text(login.stderr)]);
|
|
||||||
if (!status.success) {
|
|
||||||
throw new Error(error.trim() || `codex login exited with ${status.code}`);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
async function signIn(
|
|
||||||
profile: RuntimeProfile,
|
|
||||||
environment: Record<string, string>,
|
|
||||||
authentication: CodexAuthentication,
|
|
||||||
): Promise<void> {
|
|
||||||
if (authentication.kind === "api-key") {
|
|
||||||
await codexApiLogin(profile, environment, authentication.token);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
const loggedIn = await agentCommand(profile, "codex", ["login", "status"], {
|
|
||||||
cwd: WORKSPACE,
|
|
||||||
env: environment,
|
|
||||||
clearEnv: true,
|
|
||||||
}).output();
|
|
||||||
if (!loggedIn.success) {
|
|
||||||
await codexDeviceLogin(profile, environment);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
async function execCodex(
|
|
||||||
profile: RuntimeProfile,
|
|
||||||
environment: Record<string, string>,
|
|
||||||
prompt: string,
|
|
||||||
outputPath: string,
|
|
||||||
): Promise<CodexAttempt> {
|
|
||||||
const args = [
|
|
||||||
"exec",
|
|
||||||
"--model",
|
|
||||||
profile.model,
|
|
||||||
"--dangerously-bypass-approvals-and-sandbox",
|
|
||||||
"--output-last-message",
|
|
||||||
outputPath,
|
|
||||||
prompt,
|
|
||||||
];
|
|
||||||
const codex = agentCommand(profile, "codex", args, {
|
|
||||||
cwd: WORKSPACE,
|
|
||||||
env: environment,
|
|
||||||
clearEnv: true,
|
|
||||||
stdout: "inherit",
|
|
||||||
stderr: "piped",
|
|
||||||
}).spawn();
|
|
||||||
const decoder = new TextDecoder();
|
|
||||||
let error = "";
|
|
||||||
for await (const chunk of chunks(codex.stderr)) {
|
|
||||||
await writeChunk(process.stderr, chunk);
|
|
||||||
error += decoder.decode(chunk, { stream: true });
|
|
||||||
}
|
|
||||||
error += decoder.decode();
|
|
||||||
// Codex echoes the prompt, whose comments may quote auth errors.
|
|
||||||
return { status: await codex.status, error: error.replaceAll(prompt, "") };
|
|
||||||
}
|
|
||||||
|
|
||||||
export async function runCodex(
|
|
||||||
profile: RuntimeProfile,
|
|
||||||
prompt: string,
|
|
||||||
authentication: CodexAuthentication,
|
|
||||||
): Promise<string> {
|
|
||||||
const token = authentication.kind === "api-key" ? authentication.token : undefined;
|
|
||||||
const environment = agentEnvironment(PROCESS_ENV, profile, token);
|
|
||||||
await signIn(profile, environment, authentication);
|
|
||||||
const outputPath = await makeProfileFile(profile, "result.md");
|
|
||||||
const attempt = (): Promise<CodexAttempt> => execCodex(profile, environment, prompt, outputPath);
|
|
||||||
const result =
|
|
||||||
authentication.kind === "api-key"
|
|
||||||
? await attempt()
|
|
||||||
: await retryInvalidToken(attempt, async () => {
|
|
||||||
await runAgentCommand(profile, "codex", ["logout"]);
|
|
||||||
await codexDeviceLogin(profile, environment);
|
|
||||||
});
|
|
||||||
if (!result.status.success) {
|
|
||||||
const failure = new Error(result.error.trim() || `codex exited with ${result.status.code}`);
|
|
||||||
if (isCodexAuthFailure(result.error)) {
|
|
||||||
throw new AgentAuthError("codex sign-in failed", { cause: failure });
|
|
||||||
}
|
|
||||||
throw failure;
|
|
||||||
}
|
|
||||||
return outputPath;
|
|
||||||
}
|
|
||||||
@@ -1,46 +0,0 @@
|
|||||||
// Runs OpenCode for one profile and returns its final visible text.
|
|
||||||
import process from "node:process";
|
|
||||||
|
|
||||||
import { chunks, writeChunk } from "./command.ts";
|
|
||||||
import { agentCommand } from "./isolation.ts";
|
|
||||||
import {
|
|
||||||
collectOpenCodeOutput,
|
|
||||||
openCodeArgs,
|
|
||||||
openCodeError,
|
|
||||||
parseOpenCodeEvents,
|
|
||||||
} from "./opencode.ts";
|
|
||||||
import { agentEnvironment } from "./profiles.ts";
|
|
||||||
import { PROCESS_ENV, WORKSPACE } from "./run-context.ts";
|
|
||||||
import type { RuntimeProfile } from "./runtime.ts";
|
|
||||||
|
|
||||||
export async function runOpenCode(
|
|
||||||
profile: RuntimeProfile,
|
|
||||||
token: string,
|
|
||||||
prompt: string,
|
|
||||||
): Promise<string> {
|
|
||||||
const child = agentCommand(profile, "opencode", openCodeArgs(profile.model, prompt), {
|
|
||||||
cwd: WORKSPACE,
|
|
||||||
env: agentEnvironment(PROCESS_ENV, profile, token),
|
|
||||||
clearEnv: true,
|
|
||||||
stdout: "piped",
|
|
||||||
stderr: "piped",
|
|
||||||
}).spawn();
|
|
||||||
const collected = collectOpenCodeOutput(
|
|
||||||
chunks(child.stdout),
|
|
||||||
chunks(child.stderr),
|
|
||||||
async (chunk) => {
|
|
||||||
await writeChunk(process.stdout, chunk);
|
|
||||||
},
|
|
||||||
async (chunk) => {
|
|
||||||
await writeChunk(process.stderr, chunk);
|
|
||||||
},
|
|
||||||
);
|
|
||||||
const [status, streams] = await Promise.all([child.status, collected]);
|
|
||||||
const error = streams.stderr.trim();
|
|
||||||
if (!status.success) {
|
|
||||||
throw (
|
|
||||||
openCodeError(streams.stdout) ?? new Error(error || `opencode exited with ${status.code}`)
|
|
||||||
);
|
|
||||||
}
|
|
||||||
return parseOpenCodeEvents(streams.stdout);
|
|
||||||
}
|
|
||||||
@@ -1,30 +0,0 @@
|
|||||||
// Dispatches one attempt to the agent CLI its profile names.
|
|
||||||
import { runClaude } from "./agent-claude.ts";
|
|
||||||
import { runCodex } from "./agent-codex.ts";
|
|
||||||
import { runOpenCode } from "./agent-opencode.ts";
|
|
||||||
import { codexAuthentication } from "./auth.ts";
|
|
||||||
import type { CodexAuthentication } from "./auth.ts";
|
|
||||||
import type { RuntimeProfile } from "./runtime.ts";
|
|
||||||
|
|
||||||
export interface AgentAnswer {
|
|
||||||
body?: string;
|
|
||||||
resultPath?: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Runs the selected agent; Codex leaves its answer in a file, the others return it.
|
|
||||||
export async function runAgent(
|
|
||||||
profile: RuntimeProfile,
|
|
||||||
token: string | undefined,
|
|
||||||
prompt: string,
|
|
||||||
authentication: CodexAuthentication | null,
|
|
||||||
): Promise<AgentAnswer> {
|
|
||||||
if (profile.type === "claude") {
|
|
||||||
return { body: await runClaude(profile, token ?? "", prompt) };
|
|
||||||
}
|
|
||||||
if (profile.type === "codex") {
|
|
||||||
return {
|
|
||||||
resultPath: await runCodex(profile, prompt, authentication ?? codexAuthentication(token)),
|
|
||||||
};
|
|
||||||
}
|
|
||||||
return { body: await runOpenCode(profile, token ?? "", prompt) };
|
|
||||||
}
|
|
||||||
@@ -1,5 +1,7 @@
|
|||||||
import { expect, test } from "vite-plus/test";
|
|
||||||
import { mkdir, readFile, rm, stat, symlink, writeFile } from "node:fs/promises";
|
import { mkdir, readFile, rm, stat, symlink, writeFile } from "node:fs/promises";
|
||||||
|
import { expect, test } from "vite-plus/test";
|
||||||
|
|
||||||
|
import { currentGid, currentUid, IS_WINDOWS, makeTempDir } from "#testing";
|
||||||
|
|
||||||
import {
|
import {
|
||||||
codexAuthentication,
|
codexAuthentication,
|
||||||
@@ -9,7 +11,6 @@ import {
|
|||||||
retryInvalidToken,
|
retryInvalidToken,
|
||||||
stageCodexAuth,
|
stageCodexAuth,
|
||||||
} from "./auth.ts";
|
} from "./auth.ts";
|
||||||
import { currentGid, currentUid, IS_WINDOWS, makeTempDir } from "./testing.ts";
|
|
||||||
|
|
||||||
test("retries once after an invalid refresh token", async () => {
|
test("retries once after an invalid refresh token", async () => {
|
||||||
let attempts = 0;
|
let attempts = 0;
|
||||||
@@ -17,7 +18,7 @@ test("retries once after an invalid refresh token", async () => {
|
|||||||
const result = await retryInvalidToken(
|
const result = await retryInvalidToken(
|
||||||
() =>
|
() =>
|
||||||
Promise.resolve({
|
Promise.resolve({
|
||||||
status: { success: false },
|
code: 1,
|
||||||
error: attempts++ === 0 ? "ERROR: invalid_refresh_token" : "still failed",
|
error: attempts++ === 0 ? "ERROR: invalid_refresh_token" : "still failed",
|
||||||
}),
|
}),
|
||||||
() => {
|
() => {
|
||||||
@@ -40,7 +41,7 @@ test("does not retry an unrelated failure", async () => {
|
|||||||
() => {
|
() => {
|
||||||
attempts++;
|
attempts++;
|
||||||
return Promise.resolve({
|
return Promise.resolve({
|
||||||
status: { success: false },
|
code: 1,
|
||||||
error: "rate limited",
|
error: "rate limited",
|
||||||
});
|
});
|
||||||
},
|
},
|
||||||
@@ -86,7 +87,7 @@ test("re-logs in after the job 9837 revoked-session stderr", async () => {
|
|||||||
const result = await retryInvalidToken(
|
const result = await retryInvalidToken(
|
||||||
() =>
|
() =>
|
||||||
Promise.resolve({
|
Promise.resolve({
|
||||||
status: { success: attempts++ > 0 },
|
code: attempts++ > 0 ? 0 : 1,
|
||||||
error: attempts === 1 ? REVOKED_CODEX.join("\n") : "",
|
error: attempts === 1 ? REVOKED_CODEX.join("\n") : "",
|
||||||
}),
|
}),
|
||||||
() => {
|
() => {
|
||||||
@@ -95,16 +96,16 @@ test("re-logs in after the job 9837 revoked-session stderr", async () => {
|
|||||||
},
|
},
|
||||||
);
|
);
|
||||||
|
|
||||||
expect({ relogins, success: result.status.success }).toStrictEqual({
|
expect({ relogins, code: result.code }).toStrictEqual({
|
||||||
relogins: 1,
|
relogins: 1,
|
||||||
success: true,
|
code: 0,
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
test("recognizes a rejected Claude OAuth token", () => {
|
test("recognizes a rejected Claude OAuth token", () => {
|
||||||
expect(
|
expect(
|
||||||
isClaudeAuthFailure({
|
isClaudeAuthFailure({
|
||||||
api_error_status: 401,
|
apiErrorStatus: 401,
|
||||||
result: "Failed to authenticate. API Error: 401 OAuth access token is invalid.",
|
result: "Failed to authenticate. API Error: 401 OAuth access token is invalid.",
|
||||||
}),
|
}),
|
||||||
).toBe(true);
|
).toBe(true);
|
||||||
@@ -113,7 +114,7 @@ test("recognizes a rejected Claude OAuth token", () => {
|
|||||||
result: "OAuth token has expired. Please obtain a new token or refresh your existing token.",
|
result: "OAuth token has expired. Please obtain a new token or refresh your existing token.",
|
||||||
}),
|
}),
|
||||||
).toBe(true);
|
).toBe(true);
|
||||||
expect(isClaudeAuthFailure({ api_error_status: 429, result: "API Error: 429" })).toBe(false);
|
expect(isClaudeAuthFailure({ apiErrorStatus: 429, result: "API Error: 429" })).toBe(false);
|
||||||
});
|
});
|
||||||
|
|
||||||
test("selects API-key login only for a configured Codex token", () => {
|
test("selects API-key login only for a configured Codex token", () => {
|
||||||
@@ -12,10 +12,18 @@ import {
|
|||||||
} from "node:fs/promises";
|
} from "node:fs/promises";
|
||||||
import { dirname, join } from "node:path";
|
import { dirname, join } from "node:path";
|
||||||
|
|
||||||
import { isNotFound } from "./errors.ts";
|
import { isNotFound, isObject } from "#common";
|
||||||
import { isObject } from "./json.ts";
|
|
||||||
|
|
||||||
export type CodexAuthentication = { kind: "api-key"; token: string } | { kind: "persistent" };
|
interface CodexApiKey {
|
||||||
|
kind: "api-key";
|
||||||
|
token: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface CodexPersistent {
|
||||||
|
kind: "persistent";
|
||||||
|
}
|
||||||
|
|
||||||
|
export type CodexAuthentication = CodexApiKey | CodexPersistent;
|
||||||
|
|
||||||
export function codexAuthentication(token?: string): CodexAuthentication {
|
export function codexAuthentication(token?: string): CodexAuthentication {
|
||||||
return token === undefined ? { kind: "persistent" } : { kind: "api-key", token };
|
return token === undefined ? { kind: "persistent" } : { kind: "api-key", token };
|
||||||
@@ -34,41 +42,38 @@ export function isCodexAuthFailure(error: string): boolean {
|
|||||||
// stream-json result, e.g. "Failed to authenticate. API Error: 401 OAuth
|
// stream-json result, e.g. "Failed to authenticate. API Error: 401 OAuth
|
||||||
// access token is invalid." with api_error_status 401.
|
// access token is invalid." with api_error_status 401.
|
||||||
// The fields of Claude Code's stream-json `result` event that tell a sign-in
|
// The fields of Claude Code's stream-json `result` event that tell a sign-in
|
||||||
// failure apart, under their own names.
|
// failure apart, as `apiErrorStatus` and `result`.
|
||||||
export type ClaudeFailureFields = Partial<Record<"api_error_status", number | null>> & {
|
export interface ClaudeFailureFields {
|
||||||
|
apiErrorStatus?: number;
|
||||||
result?: string;
|
result?: string;
|
||||||
};
|
}
|
||||||
|
|
||||||
export function isClaudeAuthFailure(result: ClaudeFailureFields): boolean {
|
export function isClaudeAuthFailure(result: ClaudeFailureFields): boolean {
|
||||||
return (
|
return (
|
||||||
result.api_error_status === 401 ||
|
result.apiErrorStatus === 401 ||
|
||||||
/failed to authenticate|oauth (?:access )?token (?:is invalid|has expired)|invalid api key|authentication_error|please run \/login|not logged in/iu.test(
|
/failed to authenticate|oauth (?:access )?token (?:is invalid|has expired)|invalid api key|authentication_error|please run \/login|not logged in/iu.test(
|
||||||
result.result ?? "",
|
result.result ?? "",
|
||||||
)
|
)
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
export async function retryInvalidToken<T extends { status: { success: boolean }; error: string }>(
|
export interface CommandResult {
|
||||||
|
code: number;
|
||||||
|
error: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function retryInvalidToken<T extends CommandResult>(
|
||||||
attempt: () => Promise<T>,
|
attempt: () => Promise<T>,
|
||||||
relogin: () => Promise<void>,
|
relogin: () => Promise<void>,
|
||||||
): Promise<T> {
|
): Promise<T> {
|
||||||
let result = await attempt();
|
let result = await attempt();
|
||||||
if (!result.status.success && isCodexAuthFailure(result.error)) {
|
if (result.code !== 0 && isCodexAuthFailure(result.error)) {
|
||||||
await relogin();
|
await relogin();
|
||||||
result = await attempt();
|
result = await attempt();
|
||||||
}
|
}
|
||||||
return result;
|
return result;
|
||||||
}
|
}
|
||||||
|
|
||||||
function hasCodexTokens(tokens: unknown): boolean {
|
|
||||||
return (
|
|
||||||
isObject(tokens) &&
|
|
||||||
["access_token", "refresh_token", "id_token", "account_id"].every(
|
|
||||||
(name) => typeof tokens[name] === "string" && tokens[name] !== "",
|
|
||||||
)
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
async function readCodexAuth(path: string): Promise<string> {
|
async function readCodexAuth(path: string): Promise<string> {
|
||||||
const stat = await lstat(path);
|
const stat = await lstat(path);
|
||||||
if (!stat.isFile() || stat.isSymbolicLink()) {
|
if (!stat.isFile() || stat.isSymbolicLink()) {
|
||||||
@@ -84,11 +89,15 @@ async function readCodexAuth(path: string): Promise<string> {
|
|||||||
} catch {
|
} catch {
|
||||||
throw new Error("invalid Codex login");
|
throw new Error("invalid Codex login");
|
||||||
}
|
}
|
||||||
|
const tokens = isObject(value) ? value["tokens"] : undefined;
|
||||||
if (
|
if (
|
||||||
!isObject(value) ||
|
!isObject(value) ||
|
||||||
typeof value.auth_mode !== "string" ||
|
typeof value["auth_mode"] !== "string" ||
|
||||||
value.auth_mode === "" ||
|
value["auth_mode"] === "" ||
|
||||||
!hasCodexTokens(value.tokens)
|
!isObject(tokens) ||
|
||||||
|
!["access_token", "refresh_token", "id_token", "account_id"].every(
|
||||||
|
(name) => typeof tokens[name] === "string" && tokens[name] !== "",
|
||||||
|
)
|
||||||
) {
|
) {
|
||||||
throw new Error("invalid Codex login");
|
throw new Error("invalid Codex login");
|
||||||
}
|
}
|
||||||
@@ -116,7 +125,7 @@ export async function stageCodexAuth(
|
|||||||
return stagedPath;
|
return stagedPath;
|
||||||
}
|
}
|
||||||
|
|
||||||
// Creates an empty private file under a fresh name, as Deno.makeTempFile did.
|
// Creates an empty private file under a fresh name.
|
||||||
async function makeTempFile(directory: string): Promise<string> {
|
async function makeTempFile(directory: string): Promise<string> {
|
||||||
const path = join(directory, `.tmp-${randomUUID()}`);
|
const path = join(directory, `.tmp-${randomUUID()}`);
|
||||||
const handle = await open(path, "wx", 0o600);
|
const handle = await open(path, "wx", 0o600);
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
// Agent command-line specifics: Codex and Claude Code sign-in handling and
|
||||||
|
// OpenCode's arguments and output.
|
||||||
|
export {
|
||||||
|
codexAuthentication,
|
||||||
|
isClaudeAuthFailure,
|
||||||
|
isCodexAuthFailure,
|
||||||
|
persistCodexAuth,
|
||||||
|
retryInvalidToken,
|
||||||
|
stageCodexAuth,
|
||||||
|
} from "./auth.ts";
|
||||||
|
export type { ClaudeFailureFields, CodexAuthentication, CommandResult } from "./auth.ts";
|
||||||
|
export {
|
||||||
|
collectOpenCodeOutput,
|
||||||
|
openCodeArgs,
|
||||||
|
openCodeError,
|
||||||
|
parseOpenCodeEvents,
|
||||||
|
} from "./opencode.ts";
|
||||||
@@ -1,11 +1,13 @@
|
|||||||
import { assert, expect, test } from "vite-plus/test";
|
import { assert, expect, test } from "vite-plus/test";
|
||||||
|
|
||||||
|
import { AgentAuthError } from "#profiles";
|
||||||
|
|
||||||
import {
|
import {
|
||||||
collectOpenCodeOutput,
|
collectOpenCodeOutput,
|
||||||
openCodeArgs,
|
openCodeArgs,
|
||||||
openCodeError,
|
openCodeError,
|
||||||
parseOpenCodeEvents,
|
parseOpenCodeEvents,
|
||||||
} from "./opencode.ts";
|
} from "./opencode.ts";
|
||||||
import { AgentAuthError } from "./profiles.ts";
|
|
||||||
|
|
||||||
test("builds a non-interactive auto-approved OpenCode command", () => {
|
test("builds a non-interactive auto-approved OpenCode command", () => {
|
||||||
expect(openCodeArgs("openrouter/qwen/qwen3.8-27b", "Review this")).toStrictEqual([
|
expect(openCodeArgs("openrouter/qwen/qwen3.8-27b", "Review this")).toStrictEqual([
|
||||||
@@ -99,5 +101,5 @@ test("surfaces an OpenCode error event instead of empty output", () => {
|
|||||||
expect(() => parseOpenCodeEvents(openRouterError(429, "Rate limit exceeded"))).toThrow(
|
expect(() => parseOpenCodeEvents(openRouterError(429, "Rate limit exceeded"))).toThrow(
|
||||||
"API error 429",
|
"API error 429",
|
||||||
);
|
);
|
||||||
expect(openCodeError('{"type":"text","part":{"text":"ok"}}')).toBe(undefined);
|
expect(openCodeError('{"type":"text","part":{"text":"ok"}}')).toBeNull();
|
||||||
});
|
});
|
||||||
@@ -1,5 +1,5 @@
|
|||||||
import { isObject } from "./json.ts";
|
import { isObject } from "#common";
|
||||||
import { AgentAuthError } from "./profiles.ts";
|
import { AgentAuthError } from "#profiles";
|
||||||
|
|
||||||
export function openCodeArgs(model: string, prompt: string): string[] {
|
export function openCodeArgs(model: string, prompt: string): string[] {
|
||||||
return ["run", "--format", "json", "--auto", "--model", model, prompt];
|
return ["run", "--format", "json", "--auto", "--model", model, prompt];
|
||||||
@@ -7,13 +7,21 @@ export function openCodeArgs(model: string, prompt: string): string[] {
|
|||||||
|
|
||||||
type ChunkWriter = (chunk: Uint8Array) => void | Promise<void>;
|
type ChunkWriter = (chunk: Uint8Array) => void | Promise<void>;
|
||||||
|
|
||||||
|
interface OpenCodeOutput {
|
||||||
|
stdout: string;
|
||||||
|
stderr: string;
|
||||||
|
}
|
||||||
|
|
||||||
export async function collectOpenCodeOutput(
|
export async function collectOpenCodeOutput(
|
||||||
stdout: AsyncIterable<Uint8Array>,
|
stdout: AsyncIterable<Uint8Array>,
|
||||||
stderr: AsyncIterable<Uint8Array>,
|
stderr: AsyncIterable<Uint8Array>,
|
||||||
writeStdout: ChunkWriter,
|
writeStdout: ChunkWriter,
|
||||||
writeStderr: ChunkWriter,
|
writeStderr: ChunkWriter,
|
||||||
): Promise<{ stdout: string; stderr: string }> {
|
): Promise<OpenCodeOutput> {
|
||||||
const collect = async (stream: AsyncIterable<Uint8Array>, write: ChunkWriter) => {
|
const collect = async (
|
||||||
|
stream: AsyncIterable<Uint8Array>,
|
||||||
|
write: ChunkWriter,
|
||||||
|
): Promise<string> => {
|
||||||
const chunks: Uint8Array[] = [];
|
const chunks: Uint8Array[] = [];
|
||||||
for await (const chunk of stream) {
|
for await (const chunk of stream) {
|
||||||
chunks.push(chunk);
|
chunks.push(chunk);
|
||||||
@@ -38,8 +46,8 @@ export async function collectOpenCodeOutput(
|
|||||||
// OpenCode reports provider failures, including a rejected OpenRouter key
|
// OpenCode reports provider failures, including a rejected OpenRouter key
|
||||||
// (401 "User not found."), as a JSON error event on stdout and exits 1 with an
|
// (401 "User not found."), as a JSON error event on stdout and exits 1 with an
|
||||||
// empty stderr.
|
// empty stderr.
|
||||||
export function openCodeError(output: string): Error | undefined {
|
export function openCodeError(output: string): Error | null {
|
||||||
let failure: Error | undefined;
|
let failure: Error | null = null;
|
||||||
for (const line of output.split("\n")) {
|
for (const line of output.split("\n")) {
|
||||||
if (line.trim() === "") continue;
|
if (line.trim() === "") continue;
|
||||||
let event: unknown;
|
let event: unknown;
|
||||||
@@ -69,7 +77,7 @@ export function openCodeError(output: string): Error | undefined {
|
|||||||
}
|
}
|
||||||
|
|
||||||
export function parseOpenCodeEvents(output: string): string {
|
export function parseOpenCodeEvents(output: string): string {
|
||||||
let result: string | undefined;
|
let result: string | null = null;
|
||||||
for (const line of output.split("\n")) {
|
for (const line of output.split("\n")) {
|
||||||
if (line.trim() === "") continue;
|
if (line.trim() === "") continue;
|
||||||
const event: unknown = JSON.parse(line);
|
const event: unknown = JSON.parse(line);
|
||||||
@@ -79,7 +87,7 @@ export function parseOpenCodeEvents(output: string): string {
|
|||||||
const { text } = part;
|
const { text } = part;
|
||||||
if (typeof text === "string" && text.trim() !== "") result = text;
|
if (typeof text === "string" && text.trim() !== "") result = text;
|
||||||
}
|
}
|
||||||
if (result === undefined) {
|
if (result === null) {
|
||||||
throw openCodeError(output) ?? new Error("OpenCode produced no text output");
|
throw openCodeError(output) ?? new Error("OpenCode produced no text output");
|
||||||
}
|
}
|
||||||
return result;
|
return result;
|
||||||
-160
@@ -1,160 +0,0 @@
|
|||||||
// A child process with the call shapes the runner was reviewed with: `output()`
|
|
||||||
// collects both streams, `spawn()` hands them out, and `clearEnv` passes only
|
|
||||||
// the given environment. Streams default as Deno's did: stdin is inherited,
|
|
||||||
// stdout and stderr are piped for `output()` and inherited for `spawn()`.
|
|
||||||
import { spawn as spawnProcess } from "node:child_process";
|
|
||||||
import type { ChildProcess, StdioOptions } from "node:child_process";
|
|
||||||
import { Buffer } from "node:buffer";
|
|
||||||
import { constants } from "node:os";
|
|
||||||
import process from "node:process";
|
|
||||||
import type { Readable, Writable } from "node:stream";
|
|
||||||
import { buffer } from "node:stream/consumers";
|
|
||||||
import { finished } from "node:stream/promises";
|
|
||||||
|
|
||||||
export type StdioMode = "inherit" | "piped" | "null";
|
|
||||||
|
|
||||||
export interface CommandOptions {
|
|
||||||
args?: string[];
|
|
||||||
cwd?: string;
|
|
||||||
env?: Record<string, string>;
|
|
||||||
clearEnv?: boolean;
|
|
||||||
uid?: number;
|
|
||||||
gid?: number;
|
|
||||||
stdin?: StdioMode;
|
|
||||||
stdout?: StdioMode;
|
|
||||||
stderr?: StdioMode;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface CommandStatus {
|
|
||||||
success: boolean;
|
|
||||||
code: number;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface CommandOutput extends CommandStatus {
|
|
||||||
stdout: Uint8Array;
|
|
||||||
stderr: Uint8Array;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface CommandChild {
|
|
||||||
status: Promise<CommandStatus>;
|
|
||||||
stdin: Writable;
|
|
||||||
stdout: Readable;
|
|
||||||
stderr: Readable;
|
|
||||||
}
|
|
||||||
|
|
||||||
const STDIO: Record<StdioMode, "inherit" | "pipe" | "ignore"> = {
|
|
||||||
inherit: "inherit",
|
|
||||||
piped: "pipe",
|
|
||||||
null: "ignore",
|
|
||||||
};
|
|
||||||
|
|
||||||
function signalNumber(signal: NodeJS.Signals): number {
|
|
||||||
return constants.signals[signal];
|
|
||||||
}
|
|
||||||
|
|
||||||
function startProcess(
|
|
||||||
command: string,
|
|
||||||
options: CommandOptions,
|
|
||||||
outputDefault: StdioMode,
|
|
||||||
): ChildProcess {
|
|
||||||
const stdio: StdioOptions = [
|
|
||||||
STDIO[options.stdin ?? "inherit"],
|
|
||||||
STDIO[options.stdout ?? outputDefault],
|
|
||||||
STDIO[options.stderr ?? outputDefault],
|
|
||||||
];
|
|
||||||
const environment = options.clearEnv === true ? options.env : { ...process.env, ...options.env };
|
|
||||||
return spawnProcess(command, options.args ?? [], {
|
|
||||||
stdio,
|
|
||||||
...(options.cwd !== undefined && { cwd: options.cwd }),
|
|
||||||
...(environment !== undefined && { env: environment }),
|
|
||||||
...(options.uid !== undefined && { uid: options.uid }),
|
|
||||||
...(options.gid !== undefined && { gid: options.gid }),
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
// Settles when the process exits, before its streams close, as Deno's did. A
|
|
||||||
// signal-killed process reports 128 plus the signal number, as a shell does.
|
|
||||||
function waitForStatus(child: ChildProcess): Promise<CommandStatus> {
|
|
||||||
return new Promise((resolve, reject) => {
|
|
||||||
child.once("error", reject);
|
|
||||||
child.once("exit", (code, signal) => {
|
|
||||||
const exitCode = code ?? (signal === null ? 1 : 128 + signalNumber(signal));
|
|
||||||
resolve({ success: exitCode === 0, code: exitCode });
|
|
||||||
});
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
function piped<T>(stream: T | null, name: string): T {
|
|
||||||
if (stream === null) {
|
|
||||||
throw new TypeError(`${name} is not piped`);
|
|
||||||
}
|
|
||||||
return stream;
|
|
||||||
}
|
|
||||||
|
|
||||||
function collect(stream: Readable | null): Promise<Uint8Array> {
|
|
||||||
return stream === null ? Promise.resolve(new Uint8Array()) : buffer(stream);
|
|
||||||
}
|
|
||||||
|
|
||||||
// A stream's chunks as bytes, whether or not it has an encoding set.
|
|
||||||
export async function* chunks(stream: Readable): AsyncGenerator<Uint8Array> {
|
|
||||||
for await (const chunk of stream) {
|
|
||||||
const value: unknown = chunk;
|
|
||||||
if (value instanceof Uint8Array) {
|
|
||||||
yield value;
|
|
||||||
} else if (typeof value === "string") {
|
|
||||||
yield Buffer.from(value);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
export function spawn(command: string, options: CommandOptions = {}): CommandChild {
|
|
||||||
const child = startProcess(command, options, "inherit");
|
|
||||||
const status = waitForStatus(child);
|
|
||||||
// A failed start rejects `status`; the caller sees it once it awaits that.
|
|
||||||
status.catch(() => {});
|
|
||||||
return {
|
|
||||||
status,
|
|
||||||
get stdin(): Writable {
|
|
||||||
return piped(child.stdin, "stdin");
|
|
||||||
},
|
|
||||||
get stdout(): Readable {
|
|
||||||
return piped(child.stdout, "stdout");
|
|
||||||
},
|
|
||||||
get stderr(): Readable {
|
|
||||||
return piped(child.stderr, "stderr");
|
|
||||||
},
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
export async function output(
|
|
||||||
command: string,
|
|
||||||
options: CommandOptions = {},
|
|
||||||
): Promise<CommandOutput> {
|
|
||||||
const child = startProcess(command, options, "piped");
|
|
||||||
const [status, stdout, stderr] = await Promise.all([
|
|
||||||
waitForStatus(child),
|
|
||||||
collect(child.stdout),
|
|
||||||
collect(child.stderr),
|
|
||||||
]);
|
|
||||||
return { ...status, stdout, stderr };
|
|
||||||
}
|
|
||||||
|
|
||||||
// Writes one chunk and settles once the stream has taken it, as Deno's
|
|
||||||
// `Deno.stdout.write` did.
|
|
||||||
export async function writeChunk(stream: Writable, chunk: Uint8Array): Promise<void> {
|
|
||||||
await new Promise<void>((resolve, reject) => {
|
|
||||||
stream.write(chunk, (error) => {
|
|
||||||
if (error) {
|
|
||||||
reject(error);
|
|
||||||
} else {
|
|
||||||
resolve();
|
|
||||||
}
|
|
||||||
});
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
// Writes the last chunk and settles once the stream has flushed and closed.
|
|
||||||
export async function endWith(stream: Writable, chunk: string): Promise<void> {
|
|
||||||
stream.end(chunk);
|
|
||||||
await finished(stream);
|
|
||||||
}
|
|
||||||
@@ -1,5 +1,4 @@
|
|||||||
// Node reports a missing file as ENOENT and a missing process as ESRCH, where
|
// A missing file or a missing process: Node reports them as ENOENT and ESRCH.
|
||||||
// Deno threw `Deno.errors.NotFound` for both.
|
|
||||||
export function isNotFound(error: unknown): boolean {
|
export function isNotFound(error: unknown): boolean {
|
||||||
if (!(error instanceof Error) || !("code" in error)) {
|
if (!(error instanceof Error) || !("code" in error)) {
|
||||||
return false;
|
return false;
|
||||||
@@ -0,0 +1,4 @@
|
|||||||
|
// Helpers every phase shares: error and JSON value checks.
|
||||||
|
export { isNotFound } from "./errors.ts";
|
||||||
|
export { isMapping, isObject } from "./json.ts";
|
||||||
|
export type { JsonObject } from "./json.ts";
|
||||||
@@ -1,5 +1,5 @@
|
|||||||
// Type guards for values read from JSON, which arrive as `unknown`.
|
// Type guards for values read from JSON, which arrive as `unknown`.
|
||||||
export type JsonObject = Record<string, unknown>;
|
export type JsonObject = NodeJS.Dict<unknown>;
|
||||||
|
|
||||||
// Any non-null object, arrays included: reading a missing key yields undefined.
|
// Any non-null object, arrays included: reading a missing key yields undefined.
|
||||||
export function isObject(value: unknown): value is JsonObject {
|
export function isObject(value: unknown): value is JsonObject {
|
||||||
@@ -1,114 +0,0 @@
|
|||||||
// Reads what the agent phase left behind: its outcome, and the review and
|
|
||||||
// anchors files it wrote into a profile home.
|
|
||||||
import type { Stats } from "node:fs";
|
|
||||||
import { lstat, readFile } from "node:fs/promises";
|
|
||||||
import { join } from "node:path";
|
|
||||||
|
|
||||||
import { isNotFound } from "./errors.ts";
|
|
||||||
import { isObject } from "./json.ts";
|
|
||||||
import { isFailureReason, isProfileType } from "./profiles.ts";
|
|
||||||
import type { ProfileFailure } from "./profiles.ts";
|
|
||||||
import type { RuntimeManifest, RuntimeOutcome } from "./runtime.ts";
|
|
||||||
|
|
||||||
export interface Anchor {
|
|
||||||
path: string;
|
|
||||||
line: number;
|
|
||||||
side: "new" | "old";
|
|
||||||
body: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
function parseAnchor(entry: unknown, at: string): Anchor {
|
|
||||||
if (!isObject(entry)) {
|
|
||||||
throw new TypeError(`${at}: not an object`);
|
|
||||||
}
|
|
||||||
const { path, line, side = "new", body } = entry;
|
|
||||||
if (typeof path !== "string" || path === "") {
|
|
||||||
throw new TypeError(`${at}.path: expected a repository path`);
|
|
||||||
}
|
|
||||||
if (typeof line !== "number" || !Number.isInteger(line) || line < 1) {
|
|
||||||
throw new TypeError(`${at}.line: expected a line number`);
|
|
||||||
}
|
|
||||||
if (side !== "new" && side !== "old") {
|
|
||||||
throw new Error(`${at}.side: expected "new" or "old"`);
|
|
||||||
}
|
|
||||||
if (typeof body !== "string" || body.trim() === "") {
|
|
||||||
throw new TypeError(`${at}.body: expected the finding`);
|
|
||||||
}
|
|
||||||
return { path, line, side, body };
|
|
||||||
}
|
|
||||||
|
|
||||||
export function parseAnchors(text: string, sourcePath: string): Anchor[] {
|
|
||||||
const entries: unknown = JSON.parse(text);
|
|
||||||
if (!Array.isArray(entries)) {
|
|
||||||
throw new TypeError(`${sourcePath}: not an array`);
|
|
||||||
}
|
|
||||||
return entries.map((entry: unknown, index) => parseAnchor(entry, `${sourcePath}[${index}]`));
|
|
||||||
}
|
|
||||||
|
|
||||||
// Only known labels reach the comment, never raw agent output.
|
|
||||||
function knownFailures(failures: unknown): ProfileFailure[] {
|
|
||||||
return (Array.isArray(failures) ? failures : []).flatMap((entry: unknown) => {
|
|
||||||
if (!isObject(entry)) {
|
|
||||||
return [];
|
|
||||||
}
|
|
||||||
const { type, model, reason } = entry;
|
|
||||||
return isProfileType(type) && typeof model === "string" && isFailureReason(reason)
|
|
||||||
? [{ type, model, reason }]
|
|
||||||
: [];
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
export async function readOutcome(path: string): Promise<RuntimeOutcome> {
|
|
||||||
const value: unknown = JSON.parse(await readFile(path, "utf8"));
|
|
||||||
if (!isObject(value) || !("ok" in value)) {
|
|
||||||
throw new Error("invalid agent outcome");
|
|
||||||
}
|
|
||||||
if (value.ok === false) {
|
|
||||||
return { ok: false, failures: knownFailures(value.failures) };
|
|
||||||
}
|
|
||||||
const { ok, body, reviewPath, anchorsPath, profile } = value;
|
|
||||||
if (
|
|
||||||
ok !== true ||
|
|
||||||
typeof body !== "string" ||
|
|
||||||
typeof reviewPath !== "string" ||
|
|
||||||
typeof anchorsPath !== "string" ||
|
|
||||||
!isObject(profile) ||
|
|
||||||
!isProfileType(profile.type) ||
|
|
||||||
typeof profile.model !== "string"
|
|
||||||
) {
|
|
||||||
throw new Error("invalid agent outcome");
|
|
||||||
}
|
|
||||||
return {
|
|
||||||
ok: true,
|
|
||||||
body,
|
|
||||||
reviewPath,
|
|
||||||
anchorsPath,
|
|
||||||
profile: { type: profile.type, model: profile.model },
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
export async function readAgentArtifact(
|
|
||||||
manifest: RuntimeManifest,
|
|
||||||
path: string,
|
|
||||||
name: string,
|
|
||||||
): Promise<string | null> {
|
|
||||||
const profile = manifest.profiles.find((entry) => join(entry.home, name) === path);
|
|
||||||
if (profile === undefined) throw new Error(`${name}: outside profile home`);
|
|
||||||
let stat: Stats;
|
|
||||||
try {
|
|
||||||
stat = await lstat(path);
|
|
||||||
} catch (error) {
|
|
||||||
if (isNotFound(error)) return null;
|
|
||||||
throw error;
|
|
||||||
}
|
|
||||||
if (
|
|
||||||
!stat.isFile() ||
|
|
||||||
stat.isSymbolicLink() ||
|
|
||||||
stat.uid !== profile.uid ||
|
|
||||||
(stat.mode & 0o077) !== 0
|
|
||||||
) {
|
|
||||||
throw new Error(`${name}: expected a profile-owned regular private file`);
|
|
||||||
}
|
|
||||||
const text = await readFile(path, "utf8");
|
|
||||||
return text === "" ? null : text;
|
|
||||||
}
|
|
||||||
-185
@@ -1,185 +0,0 @@
|
|||||||
import { readFile, rm } from "node:fs/promises";
|
|
||||||
import process from "node:process";
|
|
||||||
|
|
||||||
import { isNotFound } from "./errors.ts";
|
|
||||||
import { parseAnchors, readAgentArtifact, readOutcome } from "./post-artifacts.ts";
|
|
||||||
import type { Anchor } from "./post-artifacts.ts";
|
|
||||||
import { failureFooter, withProfile } from "./profiles.ts";
|
|
||||||
import type { ProfileFailure } from "./profiles.ts";
|
|
||||||
import { readRuntimeManifest } from "./runtime.ts";
|
|
||||||
import type { RuntimeManifest, RuntimeOutcome } from "./runtime.ts";
|
|
||||||
|
|
||||||
export interface PostContext {
|
|
||||||
apiUrl: string;
|
|
||||||
repository: string;
|
|
||||||
issueIndex: string;
|
|
||||||
eventName: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
type SuccessOutcome = Extract<RuntimeOutcome, { ok: true }>;
|
|
||||||
|
|
||||||
type GiteaRequest = (path: string, body: unknown) => Promise<void>;
|
|
||||||
|
|
||||||
// The reviewer's view of one issue or pull request.
|
|
||||||
interface Publisher {
|
|
||||||
context: PostContext;
|
|
||||||
request: GiteaRequest;
|
|
||||||
postComment(body: string): Promise<void>;
|
|
||||||
}
|
|
||||||
|
|
||||||
const ANSI = new RegExp(`${String.fromCodePoint(27)}\\[[0-9;]*[A-Za-z]`, "gu");
|
|
||||||
const stripAnsi = (text: string): string => text.replace(ANSI, "");
|
|
||||||
const VERDICTS: Record<string, [event: string, mark: string]> = {
|
|
||||||
Approved: ["APPROVED", "✅"],
|
|
||||||
"Changes requested": ["REQUEST_CHANGES", "🛑"],
|
|
||||||
};
|
|
||||||
const failureComment = (failures: ProfileFailure[]): string =>
|
|
||||||
`AI bot failed.\n\n${failureFooter(failures)}`;
|
|
||||||
|
|
||||||
class GiteaRequestError extends Error {}
|
|
||||||
|
|
||||||
function giteaRequest(apiUrl: string, reviewerToken: string, fetcher: typeof fetch): GiteaRequest {
|
|
||||||
return async (path, body) => {
|
|
||||||
let response: Response;
|
|
||||||
try {
|
|
||||||
response = await fetcher(`${apiUrl}/${path}`, {
|
|
||||||
method: "POST",
|
|
||||||
headers: {
|
|
||||||
Authorization: `token ${reviewerToken}`,
|
|
||||||
"Content-Type": "application/json",
|
|
||||||
},
|
|
||||||
body: JSON.stringify(body),
|
|
||||||
});
|
|
||||||
} catch (error) {
|
|
||||||
const detail = error instanceof Error ? error.message : String(error);
|
|
||||||
throw new GiteaRequestError(`${path}: ${detail}`, { cause: error });
|
|
||||||
}
|
|
||||||
if (!response.ok) {
|
|
||||||
throw new GiteaRequestError(`${path}: ${response.status} ${await response.text()}`);
|
|
||||||
}
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
async function readSuccess(
|
|
||||||
manifest: RuntimeManifest,
|
|
||||||
publisher: Publisher,
|
|
||||||
): Promise<SuccessOutcome> {
|
|
||||||
let outcome: RuntimeOutcome;
|
|
||||||
try {
|
|
||||||
outcome = await readOutcome(manifest.outcomeFile);
|
|
||||||
} catch (error) {
|
|
||||||
await publisher.postComment(failureComment([]));
|
|
||||||
throw new Error("agent phase failed", { cause: error });
|
|
||||||
}
|
|
||||||
if (!outcome.ok) {
|
|
||||||
await publisher.postComment(failureComment(outcome.failures));
|
|
||||||
throw new Error("agent phase failed");
|
|
||||||
}
|
|
||||||
return outcome;
|
|
||||||
}
|
|
||||||
|
|
||||||
async function postReview(
|
|
||||||
publisher: Publisher,
|
|
||||||
outcome: SuccessOutcome,
|
|
||||||
review: string,
|
|
||||||
anchors: Anchor[],
|
|
||||||
): Promise<void> {
|
|
||||||
const { context, request } = publisher;
|
|
||||||
const [verdict = "", ...rest] = review.split("\n");
|
|
||||||
const [event, mark] = VERDICTS[verdict.trim()] ?? ["COMMENT", "💬"];
|
|
||||||
const send = async (entries: Anchor[]): Promise<void> => {
|
|
||||||
await request(`repos/${context.repository}/pulls/${context.issueIndex}/reviews`, {
|
|
||||||
body: stripAnsi(
|
|
||||||
withProfile([`${mark} ${verdict.trim()}`, ...rest].join("\n"), outcome.profile),
|
|
||||||
),
|
|
||||||
event,
|
|
||||||
comments: entries.map(({ path, line, side, body }) => ({
|
|
||||||
path,
|
|
||||||
body: stripAnsi(withProfile(body, outcome.profile)),
|
|
||||||
new_position: side === "new" ? line : 0,
|
|
||||||
old_position: side === "old" ? line : 0,
|
|
||||||
})),
|
|
||||||
});
|
|
||||||
};
|
|
||||||
await send(anchors).catch(async (error: unknown) => {
|
|
||||||
if (anchors.length === 0) throw error;
|
|
||||||
console.error(
|
|
||||||
`inline comments rejected: ${error instanceof Error ? error.message : String(error)}`,
|
|
||||||
);
|
|
||||||
await send([]);
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
async function publishResult(
|
|
||||||
manifest: RuntimeManifest,
|
|
||||||
outcome: SuccessOutcome,
|
|
||||||
publisher: Publisher,
|
|
||||||
): Promise<void> {
|
|
||||||
const review = await readAgentArtifact(manifest, outcome.reviewPath, "review.md");
|
|
||||||
if (review === null) {
|
|
||||||
if (publisher.context.eventName === "pull_request") {
|
|
||||||
throw new Error("agent did not write a pull request review");
|
|
||||||
}
|
|
||||||
await publisher.postComment(withProfile(outcome.body, outcome.profile));
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
const anchorText = await readAgentArtifact(manifest, outcome.anchorsPath, "anchors.json");
|
|
||||||
const anchors = anchorText === null ? [] : parseAnchors(anchorText, outcome.anchorsPath);
|
|
||||||
await postReview(publisher, outcome, review, anchors);
|
|
||||||
}
|
|
||||||
|
|
||||||
async function publish(
|
|
||||||
manifest: RuntimeManifest,
|
|
||||||
context: PostContext,
|
|
||||||
fetcher: typeof fetch,
|
|
||||||
): Promise<void> {
|
|
||||||
const reviewerToken = (await readFile(manifest.reviewerFile, "utf8")).trim();
|
|
||||||
const request = giteaRequest(context.apiUrl, reviewerToken, fetcher);
|
|
||||||
const publisher: Publisher = {
|
|
||||||
context,
|
|
||||||
request,
|
|
||||||
postComment: async (body) => {
|
|
||||||
await request(`repos/${context.repository}/issues/${context.issueIndex}/comments`, {
|
|
||||||
body: stripAnsi(body),
|
|
||||||
});
|
|
||||||
},
|
|
||||||
};
|
|
||||||
const outcome = await readSuccess(manifest, publisher);
|
|
||||||
try {
|
|
||||||
await publishResult(manifest, outcome, publisher);
|
|
||||||
} catch (error) {
|
|
||||||
if (error instanceof GiteaRequestError) throw error;
|
|
||||||
await publisher.postComment(failureComment([{ ...outcome.profile, reason: "failed" }]));
|
|
||||||
throw error;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
export async function postRuntime(
|
|
||||||
manifestPath: string,
|
|
||||||
context: PostContext,
|
|
||||||
fetcher: typeof fetch = fetch,
|
|
||||||
): Promise<void> {
|
|
||||||
const manifest = await readRuntimeManifest(manifestPath);
|
|
||||||
try {
|
|
||||||
await publish(manifest, context, fetcher);
|
|
||||||
} finally {
|
|
||||||
await rm(manifest.runtimeDir, { recursive: true }).catch((error: unknown) => {
|
|
||||||
if (!isNotFound(error)) throw error;
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
function required(name: string): string {
|
|
||||||
const value = process.env[name];
|
|
||||||
if (value === undefined || value === "") throw new Error(`${name} is not set`);
|
|
||||||
return value;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (import.meta.main) {
|
|
||||||
await postRuntime(required("BOT_AGENTS_MANIFEST"), {
|
|
||||||
apiUrl: required("GITEA_API_URL"),
|
|
||||||
repository: required("GITEA_REPOSITORY"),
|
|
||||||
issueIndex: required("ISSUE_INDEX"),
|
|
||||||
eventName: required("EVENT_NAME"),
|
|
||||||
});
|
|
||||||
}
|
|
||||||
@@ -0,0 +1,22 @@
|
|||||||
|
// The post phase: posts the agent's result as the reviewer and removes the
|
||||||
|
// runtime credentials.
|
||||||
|
import process from "node:process";
|
||||||
|
|
||||||
|
import { postRuntime } from "./post.ts";
|
||||||
|
|
||||||
|
export { type Fetcher, type PostContext, postRuntime } from "./post.ts";
|
||||||
|
|
||||||
|
function required(name: string): string {
|
||||||
|
const value = process.env[name];
|
||||||
|
if (value === undefined || value === "") throw new Error(`${name} is not set`);
|
||||||
|
return value;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (import.meta.main) {
|
||||||
|
await postRuntime(required("BOT_AGENTS_MANIFEST"), {
|
||||||
|
apiUrl: required("GITEA_API_URL"),
|
||||||
|
repository: required("GITEA_REPOSITORY"),
|
||||||
|
issueIndex: required("ISSUE_INDEX"),
|
||||||
|
eventName: required("EVENT_NAME"),
|
||||||
|
});
|
||||||
|
}
|
||||||
@@ -1,12 +1,11 @@
|
|||||||
import { chmod, mkdir, rm, stat, symlink, writeFile } from "node:fs/promises";
|
import { chmod, mkdir, rm, stat, symlink, writeFile } from "node:fs/promises";
|
||||||
|
|
||||||
import { assert, expect, test } from "vite-plus/test";
|
import { assert, expect, test } from "vite-plus/test";
|
||||||
|
|
||||||
import { isNotFound } from "./errors.ts";
|
import { isNotFound } from "#common";
|
||||||
import { postRuntime } from "./post.ts";
|
import type { RuntimeFailure, RuntimeManifest, RuntimeOutcome } from "#runtime";
|
||||||
import type { PostContext } from "./post.ts";
|
import { currentGid, currentUid, IS_WINDOWS, makeTempDir } from "#testing";
|
||||||
import type { RuntimeManifest, RuntimeOutcome } from "./runtime.ts";
|
|
||||||
import { currentGid, currentUid, IS_WINDOWS, makeTempDir } from "./testing.ts";
|
import { type Fetcher, type PostContext, postRuntime } from "./post.ts";
|
||||||
|
|
||||||
const context: PostContext = {
|
const context: PostContext = {
|
||||||
apiUrl: "https://gitea.example/api/v1",
|
apiUrl: "https://gitea.example/api/v1",
|
||||||
@@ -23,7 +22,18 @@ interface Fixture {
|
|||||||
outcomeFile: string;
|
outcomeFile: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
type FixtureSource = Extract<RuntimeOutcome, { ok: false }> | { ok: true; body: string };
|
interface FixtureSuccess {
|
||||||
|
ok: true;
|
||||||
|
body: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
type FixtureSource = RuntimeFailure | FixtureSuccess;
|
||||||
|
|
||||||
|
// One request the fake Gitea received.
|
||||||
|
interface RecordedRequest {
|
||||||
|
url: string;
|
||||||
|
init: RequestInit;
|
||||||
|
}
|
||||||
|
|
||||||
async function writePrivate(path: string, text: string): Promise<void> {
|
async function writePrivate(path: string, text: string): Promise<void> {
|
||||||
await writeFile(path, text, { mode: 0o600 });
|
await writeFile(path, text, { mode: 0o600 });
|
||||||
@@ -32,8 +42,8 @@ async function writePrivate(path: string, text: string): Promise<void> {
|
|||||||
|
|
||||||
async function writeArtifacts(
|
async function writeArtifacts(
|
||||||
outcome: RuntimeOutcome,
|
outcome: RuntimeOutcome,
|
||||||
review: string | undefined,
|
review?: string,
|
||||||
anchors: unknown,
|
anchors?: unknown,
|
||||||
): Promise<void> {
|
): Promise<void> {
|
||||||
if (!outcome.ok) return;
|
if (!outcome.ok) return;
|
||||||
if (review !== undefined) await writePrivate(outcome.reviewPath, review);
|
if (review !== undefined) await writePrivate(outcome.reviewPath, review);
|
||||||
@@ -107,7 +117,7 @@ function requestBody(init?: RequestInit): unknown {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// A fake Gitea that records each request body and answers with `status`.
|
// A fake Gitea that records each request body and answers with `status`.
|
||||||
function recordingFetch(bodies: unknown[], status = 201): typeof fetch {
|
function recordingFetch(bodies: unknown[], status = 201): Fetcher {
|
||||||
return (_url, init) => {
|
return (_url, init) => {
|
||||||
bodies.push(requestBody(init));
|
bodies.push(requestBody(init));
|
||||||
return Promise.resolve(new Response(null, { status }));
|
return Promise.resolve(new Response(null, { status }));
|
||||||
@@ -116,7 +126,7 @@ function recordingFetch(bodies: unknown[], status = 201): typeof fetch {
|
|||||||
|
|
||||||
test("posts a successful issue result and removes runtime credentials", async () => {
|
test("posts a successful issue result and removes runtime credentials", async () => {
|
||||||
const result = await fixture({ ok: true, body: "done" });
|
const result = await fixture({ ok: true, body: "done" });
|
||||||
const requests: { url: unknown; init: RequestInit | undefined }[] = [];
|
const requests: RecordedRequest[] = [];
|
||||||
|
|
||||||
await postRuntime(result.manifestPath, context, (url, init) => {
|
await postRuntime(result.manifestPath, context, (url, init) => {
|
||||||
requests.push({ url, init });
|
requests.push({ url, init });
|
||||||
@@ -0,0 +1,224 @@
|
|||||||
|
import type { Stats } from "node:fs";
|
||||||
|
import { lstat, readFile, rm } from "node:fs/promises";
|
||||||
|
import { join } from "node:path";
|
||||||
|
|
||||||
|
import { isNotFound, isObject } from "#common";
|
||||||
|
import { failureFooter, type FailureReason, type ProfileFailure, withProfile } from "#profiles";
|
||||||
|
import { readRuntimeManifest, type RuntimeManifest, type RuntimeOutcome } from "#runtime";
|
||||||
|
|
||||||
|
export interface PostContext {
|
||||||
|
apiUrl: string;
|
||||||
|
repository: string;
|
||||||
|
issueIndex: string;
|
||||||
|
eventName: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Anchor {
|
||||||
|
path: string;
|
||||||
|
line: number;
|
||||||
|
side: "new" | "old";
|
||||||
|
body: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
const ANSI = new RegExp(`${String.fromCodePoint(27)}\\[[0-9;]*[A-Za-z]`, "gu");
|
||||||
|
const stripAnsi = (text: string): string => text.replace(ANSI, "");
|
||||||
|
const VERDICTS: NodeJS.Dict<[event: string, mark: string]> = {
|
||||||
|
Approved: ["APPROVED", "✅"],
|
||||||
|
"Changes requested": ["REQUEST_CHANGES", "🛑"],
|
||||||
|
};
|
||||||
|
const PROFILE_TYPES: Set<unknown> = new Set(["claude", "codex", "opencode"]);
|
||||||
|
const FAILURE_REASONS: Set<unknown> = new Set(["sign-in failed", "usage exhausted", "failed"]);
|
||||||
|
const isProfileType = (value: unknown): value is ProfileFailure["type"] => PROFILE_TYPES.has(value);
|
||||||
|
const isFailureReason = (value: unknown): value is FailureReason => FAILURE_REASONS.has(value);
|
||||||
|
const failureComment = (failures: ProfileFailure[]): string =>
|
||||||
|
`AI bot failed.\n\n${failureFooter(failures)}`;
|
||||||
|
|
||||||
|
// The `fetch` subset the reviewer posts through, which tests replace.
|
||||||
|
export type Fetcher = (url: string, init: RequestInit) => Promise<Response>;
|
||||||
|
|
||||||
|
class GiteaRequestError extends Error {}
|
||||||
|
|
||||||
|
function parseAnchors(text: string, sourcePath: string): Anchor[] {
|
||||||
|
const entries: unknown = JSON.parse(text);
|
||||||
|
if (!Array.isArray(entries)) throw new TypeError(`${sourcePath}: not an array`);
|
||||||
|
return entries.map((entry: unknown, index) => {
|
||||||
|
const at = `${sourcePath}[${index}]`;
|
||||||
|
if (!isObject(entry)) {
|
||||||
|
throw new TypeError(`${at}: not an object`);
|
||||||
|
}
|
||||||
|
const { path, line, side = "new", body } = entry;
|
||||||
|
if (typeof path !== "string" || path === "") {
|
||||||
|
throw new TypeError(`${at}.path: expected a repository path`);
|
||||||
|
}
|
||||||
|
if (typeof line !== "number" || !Number.isInteger(line) || line < 1) {
|
||||||
|
throw new TypeError(`${at}.line: expected a line number`);
|
||||||
|
}
|
||||||
|
if (side !== "new" && side !== "old") {
|
||||||
|
throw new Error(`${at}.side: expected "new" or "old"`);
|
||||||
|
}
|
||||||
|
if (typeof body !== "string" || body.trim() === "") {
|
||||||
|
throw new TypeError(`${at}.body: expected the finding`);
|
||||||
|
}
|
||||||
|
return { path, line, side, body };
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
async function readOutcome(path: string): Promise<RuntimeOutcome> {
|
||||||
|
const value: unknown = JSON.parse(await readFile(path, "utf8"));
|
||||||
|
if (!isObject(value) || !("ok" in value)) {
|
||||||
|
throw new Error("invalid agent outcome");
|
||||||
|
}
|
||||||
|
const outcome = value;
|
||||||
|
if (outcome["ok"] === false) {
|
||||||
|
// Only known labels reach the comment, never raw agent output.
|
||||||
|
const failures: unknown[] = Array.isArray(outcome["failures"]) ? outcome["failures"] : [];
|
||||||
|
return {
|
||||||
|
ok: false,
|
||||||
|
failures: failures.flatMap((entry: unknown) => {
|
||||||
|
const { type, model, reason } = isObject(entry) ? entry : {};
|
||||||
|
return isProfileType(type) && typeof model === "string" && isFailureReason(reason)
|
||||||
|
? [{ type, model, reason }]
|
||||||
|
: [];
|
||||||
|
}),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
if (
|
||||||
|
outcome["ok"] !== true ||
|
||||||
|
typeof outcome["body"] !== "string" ||
|
||||||
|
typeof outcome["reviewPath"] !== "string" ||
|
||||||
|
typeof outcome["anchorsPath"] !== "string" ||
|
||||||
|
!isObject(outcome["profile"])
|
||||||
|
) {
|
||||||
|
throw new Error("invalid agent outcome");
|
||||||
|
}
|
||||||
|
const profile = outcome["profile"];
|
||||||
|
if (!isProfileType(profile["type"]) || typeof profile["model"] !== "string") {
|
||||||
|
throw new Error("invalid agent outcome");
|
||||||
|
}
|
||||||
|
return {
|
||||||
|
ok: true,
|
||||||
|
body: outcome["body"],
|
||||||
|
reviewPath: outcome["reviewPath"],
|
||||||
|
anchorsPath: outcome["anchorsPath"],
|
||||||
|
profile: {
|
||||||
|
type: profile["type"],
|
||||||
|
model: profile["model"],
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
async function readAgentArtifact(
|
||||||
|
manifest: RuntimeManifest,
|
||||||
|
path: string,
|
||||||
|
name: string,
|
||||||
|
): Promise<string | null> {
|
||||||
|
const profile = manifest.profiles.find((entry) => join(entry.home, name) === path);
|
||||||
|
if (profile === undefined) throw new Error(`${name}: outside profile home`);
|
||||||
|
let stat: Stats;
|
||||||
|
try {
|
||||||
|
stat = await lstat(path);
|
||||||
|
} catch (error) {
|
||||||
|
if (isNotFound(error)) return null;
|
||||||
|
throw error;
|
||||||
|
}
|
||||||
|
if (
|
||||||
|
!stat.isFile() ||
|
||||||
|
stat.isSymbolicLink() ||
|
||||||
|
stat.uid !== profile.uid ||
|
||||||
|
(stat.mode & 0o077) !== 0
|
||||||
|
) {
|
||||||
|
throw new Error(`${name}: expected a profile-owned regular private file`);
|
||||||
|
}
|
||||||
|
const text = await readFile(path, "utf8");
|
||||||
|
return text === "" ? null : text;
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function postRuntime(
|
||||||
|
manifestPath: string,
|
||||||
|
context: PostContext,
|
||||||
|
fetcher: Fetcher = fetch,
|
||||||
|
): Promise<void> {
|
||||||
|
const manifest = await readRuntimeManifest(manifestPath);
|
||||||
|
try {
|
||||||
|
const reviewerToken = (await readFile(manifest.reviewerFile, "utf8")).trim();
|
||||||
|
const request = async (path: string, body: unknown): Promise<void> => {
|
||||||
|
let response: Response;
|
||||||
|
try {
|
||||||
|
response = await fetcher(`${context.apiUrl}/${path}`, {
|
||||||
|
method: "POST",
|
||||||
|
headers: {
|
||||||
|
Authorization: `token ${reviewerToken}`,
|
||||||
|
"Content-Type": "application/json",
|
||||||
|
},
|
||||||
|
body: JSON.stringify(body),
|
||||||
|
});
|
||||||
|
} catch (error) {
|
||||||
|
const detail = error instanceof Error ? error.message : String(error);
|
||||||
|
throw new GiteaRequestError(`${path}: ${detail}`, { cause: error });
|
||||||
|
}
|
||||||
|
if (!response.ok) {
|
||||||
|
throw new GiteaRequestError(`${path}: ${response.status} ${await response.text()}`);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
const postComment = (body: string): Promise<void> =>
|
||||||
|
request(`repos/${context.repository}/issues/${context.issueIndex}/comments`, {
|
||||||
|
body: stripAnsi(body),
|
||||||
|
});
|
||||||
|
|
||||||
|
let outcome: RuntimeOutcome;
|
||||||
|
try {
|
||||||
|
outcome = await readOutcome(manifest.outcomeFile);
|
||||||
|
} catch (error) {
|
||||||
|
await postComment(failureComment([]));
|
||||||
|
throw new Error("agent phase failed", { cause: error });
|
||||||
|
}
|
||||||
|
if (!outcome.ok) {
|
||||||
|
await postComment(failureComment(outcome.failures));
|
||||||
|
throw new Error("agent phase failed");
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
const review = await readAgentArtifact(manifest, outcome.reviewPath, "review.md");
|
||||||
|
if (review === null) {
|
||||||
|
if (context.eventName === "pull_request") {
|
||||||
|
throw new Error("agent did not write a pull request review");
|
||||||
|
}
|
||||||
|
await postComment(withProfile(outcome.body, outcome.profile));
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const [verdict = "", ...rest] = review.split("\n");
|
||||||
|
const [event, mark] = VERDICTS[verdict.trim()] ?? ["COMMENT", "💬"];
|
||||||
|
const anchorText = await readAgentArtifact(manifest, outcome.anchorsPath, "anchors.json");
|
||||||
|
const anchors = anchorText === null ? [] : parseAnchors(anchorText, outcome.anchorsPath);
|
||||||
|
const postReview = (entries: Anchor[]): Promise<void> =>
|
||||||
|
request(`repos/${context.repository}/pulls/${context.issueIndex}/reviews`, {
|
||||||
|
body: stripAnsi(
|
||||||
|
withProfile([`${mark} ${verdict.trim()}`, ...rest].join("\n"), outcome.profile),
|
||||||
|
),
|
||||||
|
event,
|
||||||
|
comments: entries.map(({ path, line, side, body }) => ({
|
||||||
|
path,
|
||||||
|
body: stripAnsi(withProfile(body, outcome.profile)),
|
||||||
|
new_position: side === "new" ? line : 0,
|
||||||
|
old_position: side === "old" ? line : 0,
|
||||||
|
})),
|
||||||
|
});
|
||||||
|
await postReview(anchors).catch(async (error: unknown) => {
|
||||||
|
if (anchors.length === 0) throw error;
|
||||||
|
console.error(
|
||||||
|
`inline comments rejected: ${error instanceof Error ? error.message : String(error)}`,
|
||||||
|
);
|
||||||
|
await postReview([]);
|
||||||
|
});
|
||||||
|
} catch (error) {
|
||||||
|
if (error instanceof GiteaRequestError) throw error;
|
||||||
|
await postComment(failureComment([{ ...outcome.profile, reason: "failed" }]));
|
||||||
|
throw error;
|
||||||
|
}
|
||||||
|
} finally {
|
||||||
|
await rm(manifest.runtimeDir, { recursive: true }).catch((error: unknown) => {
|
||||||
|
if (!isNotFound(error)) throw error;
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,13 +1,11 @@
|
|||||||
import { appendFile, rm } from "node:fs/promises";
|
import { appendFile, rm } from "node:fs/promises";
|
||||||
import process from "node:process";
|
import process from "node:process";
|
||||||
|
|
||||||
import { prepareRuntime } from "./runtime.ts";
|
import { prepareRuntime } from "#runtime";
|
||||||
|
|
||||||
const env = (name: string): string => {
|
const env = (name: string): string => {
|
||||||
const value = process.env[name];
|
const value = process.env[name];
|
||||||
if (value === undefined || value === "") {
|
if (value === undefined || value === "") throw new Error(`${name} is not set`);
|
||||||
throw new Error(`${name} is not set`);
|
|
||||||
}
|
|
||||||
return value;
|
return value;
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -0,0 +1,35 @@
|
|||||||
|
import { spawn } from "node:child_process";
|
||||||
|
import { expect, test } from "vite-plus/test";
|
||||||
|
|
||||||
|
import { isNotFound } from "#common";
|
||||||
|
|
||||||
|
import { exitCode } from "./child.ts";
|
||||||
|
|
||||||
|
test("reports the exit code", async () => {
|
||||||
|
expect(await exitCode(spawn("/bin/sh", ["-c", "exit 0"], { stdio: "ignore" }))).toBe(0);
|
||||||
|
expect(await exitCode(spawn("/bin/sh", ["-c", "exit 3"], { stdio: "ignore" }))).toBe(3);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("reports a signal as 128 plus its number", async () => {
|
||||||
|
const child = spawn("/bin/sh", ["-c", "kill -KILL $$"], { stdio: "ignore" });
|
||||||
|
expect(await exitCode(child)).toBe(137);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("resolves on exit while a grandchild still holds the output open", async () => {
|
||||||
|
const child = spawn("/bin/sh", ["-c", "sleep 2 & exit 5"], { stdio: ["ignore", "pipe", "pipe"] });
|
||||||
|
const started = Date.now();
|
||||||
|
expect(await exitCode(child)).toBe(5);
|
||||||
|
expect(Date.now() - started).toBeLessThan(1500);
|
||||||
|
child.stdout.destroy();
|
||||||
|
child.stderr.destroy();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("rejects when the command does not exist", async () => {
|
||||||
|
const child = spawn("/nonexistent/command", [], { stdio: "ignore" });
|
||||||
|
const code = exitCode(child);
|
||||||
|
// The rejection must stay unhandled-safe until it is awaited.
|
||||||
|
await new Promise((resolve) => {
|
||||||
|
setTimeout(resolve, 50);
|
||||||
|
});
|
||||||
|
await expect(code).rejects.toSatisfy(isNotFound);
|
||||||
|
});
|
||||||
@@ -0,0 +1,30 @@
|
|||||||
|
// What the child process call sites share: the exit status, read right after
|
||||||
|
// `spawn` so the exit event cannot pass unseen while the caller reads the
|
||||||
|
// streams, and echoing output without outrunning a slow reader.
|
||||||
|
import type { ChildProcess } from "node:child_process";
|
||||||
|
import { once } from "node:events";
|
||||||
|
import { constants } from "node:os";
|
||||||
|
import type { Writable } from "node:stream";
|
||||||
|
|
||||||
|
// Resolves once the process exits, before its streams close, with its exit
|
||||||
|
// code, or with 128 plus the signal number if a signal killed it, as a shell
|
||||||
|
// reports. A process that fails to start rejects with the spawn error.
|
||||||
|
export function exitCode(child: ChildProcess): Promise<number> {
|
||||||
|
const code = new Promise<number>((resolve, reject) => {
|
||||||
|
child.once("error", reject);
|
||||||
|
child.once("exit", (exit, signal) => {
|
||||||
|
resolve(exit ?? (signal === null ? 1 : 128 + constants.signals[signal]));
|
||||||
|
});
|
||||||
|
});
|
||||||
|
// Callers await it after draining the streams; a failed start must not be
|
||||||
|
// reported as an unhandled rejection before then.
|
||||||
|
code.catch(() => {});
|
||||||
|
return code;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Writes a chunk, waiting for the stream to drain when its buffer is full.
|
||||||
|
export async function echo(stream: Writable, chunk: string | Uint8Array): Promise<void> {
|
||||||
|
if (!stream.write(chunk)) {
|
||||||
|
await once(stream, "drain");
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,4 @@
|
|||||||
|
// Child processes: waiting on and echoing them, and the isolated profile
|
||||||
|
// user's processes and files.
|
||||||
|
export { echo, exitCode } from "./child.ts";
|
||||||
|
export { killProfileProcesses, readProfileFile } from "./isolation.ts";
|
||||||
@@ -1,16 +1,13 @@
|
|||||||
import { expect, test } from "vite-plus/test";
|
import { spawnSync, type SpawnSyncReturns } from "node:child_process";
|
||||||
import { chmod, chown, mkdir, readFile, rm, symlink, writeFile } from "node:fs/promises";
|
import { chmod, chown, mkdir, readFile, rm, symlink, writeFile } from "node:fs/promises";
|
||||||
import process from "node:process";
|
import process from "node:process";
|
||||||
|
import { expect, test } from "vite-plus/test";
|
||||||
|
|
||||||
import { isNotFound } from "./errors.ts";
|
import { isNotFound } from "#common";
|
||||||
import {
|
import type { RuntimeProfile } from "#runtime";
|
||||||
agentCommand,
|
import { currentUid, IS_ROOT, IS_WINDOWS, makeTempDir } from "#testing";
|
||||||
isRunnableProfileProcess,
|
|
||||||
killProfileProcesses,
|
import { isRunnableProfileProcess, killProfileProcesses, readProfileFile } from "./isolation.ts";
|
||||||
readProfileFile,
|
|
||||||
} from "./isolation.ts";
|
|
||||||
import type { RuntimeProfile } from "./runtime.ts";
|
|
||||||
import { currentUid, IS_ROOT, IS_WINDOWS, makeTempDir } from "./testing.ts";
|
|
||||||
|
|
||||||
const profile = (uid: number, home: string): RuntimeProfile => ({
|
const profile = (uid: number, home: string): RuntimeProfile => ({
|
||||||
index: uid - 20_000,
|
index: uid - 20_000,
|
||||||
@@ -22,6 +19,23 @@ const profile = (uid: number, home: string): RuntimeProfile => ({
|
|||||||
tokenFile: null,
|
tokenFile: null,
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// Runs a command as the profile's user from the root directory. Without `env`
|
||||||
|
// it inherits this process's environment.
|
||||||
|
function runAs(
|
||||||
|
selected: RuntimeProfile,
|
||||||
|
command: string,
|
||||||
|
args: string[],
|
||||||
|
env?: NodeJS.ProcessEnv,
|
||||||
|
): SpawnSyncReturns<string> {
|
||||||
|
return spawnSync(command, args, {
|
||||||
|
cwd: "/",
|
||||||
|
uid: selected.uid,
|
||||||
|
gid: selected.gid,
|
||||||
|
encoding: "utf8",
|
||||||
|
...(env !== undefined && { env }),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
test("zombie process entries are already quiescent", () => {
|
test("zombie process entries are already quiescent", () => {
|
||||||
const status = "State:\tZ (zombie)\nUid:\t20010\t20010\t20010\t20010\n";
|
const status = "State:\tZ (zombie)\nUid:\t20010\t20010\t20010\t20010\n";
|
||||||
expect(isRunnableProfileProcess(status, 20_010)).toBe(false);
|
expect(isRunnableProfileProcess(status, 20_010)).toBe(false);
|
||||||
@@ -60,20 +74,14 @@ test.skipIf(!IS_ROOT)("a profile process can read only its own private files", a
|
|||||||
await writeFile(`${root}/reviewer`, "root", { mode: 0o600 });
|
await writeFile(`${root}/reviewer`, "root", { mode: 0o600 });
|
||||||
|
|
||||||
const selected = profile(20_000, homeA);
|
const selected = profile(20_000, homeA);
|
||||||
const own = await agentCommand(selected, "/bin/cat", [`${homeA}/token`], {
|
const own = runAs(selected, "/bin/cat", [`${homeA}/token`]);
|
||||||
cwd: "/",
|
const sibling = runAs(selected, "/bin/cat", [`${homeB}/token`]);
|
||||||
}).output();
|
const reviewer = runAs(selected, "/bin/cat", [`${root}/reviewer`]);
|
||||||
const sibling = await agentCommand(selected, "/bin/cat", [`${homeB}/token`], {
|
|
||||||
cwd: "/",
|
|
||||||
}).output();
|
|
||||||
const reviewer = await agentCommand(selected, "/bin/cat", [`${root}/reviewer`], {
|
|
||||||
cwd: "/",
|
|
||||||
}).output();
|
|
||||||
|
|
||||||
expect(new TextDecoder().decode(own.stdout)).toBe("own");
|
expect(own.stdout).toBe("own");
|
||||||
expect(own.success).toBe(true);
|
expect(own.status).toBe(0);
|
||||||
expect(sibling.success).toBe(false);
|
expect(sibling.status).not.toBe(0);
|
||||||
expect(reviewer.success).toBe(false);
|
expect(reviewer.status).not.toBe(0);
|
||||||
} finally {
|
} finally {
|
||||||
await rm(root, { recursive: true });
|
await rm(root, { recursive: true });
|
||||||
}
|
}
|
||||||
@@ -81,13 +89,8 @@ test.skipIf(!IS_ROOT)("a profile process can read only its own private files", a
|
|||||||
|
|
||||||
test.skipIf(!IS_ROOT)("cleanup leaves no runnable daemonized process", async () => {
|
test.skipIf(!IS_ROOT)("cleanup leaves no runnable daemonized process", async () => {
|
||||||
const selected = profile(20_010, "/tmp");
|
const selected = profile(20_010, "/tmp");
|
||||||
const launched = await agentCommand(
|
const launched = runAs(selected, "/bin/sh", ["-c", "sleep 60 >/dev/null 2>&1 & echo $!"]);
|
||||||
selected,
|
const pid = Number(launched.stdout.trim());
|
||||||
"/bin/sh",
|
|
||||||
["-c", "sleep 60 >/dev/null 2>&1 & echo $!"],
|
|
||||||
{ cwd: "/" },
|
|
||||||
).output();
|
|
||||||
const pid = Number(new TextDecoder().decode(launched.stdout).trim());
|
|
||||||
expect(Number.isInteger(pid)).toBe(true);
|
expect(Number.isInteger(pid)).toBe(true);
|
||||||
|
|
||||||
await killProfileProcesses(selected.uid);
|
await killProfileProcesses(selected.uid);
|
||||||
@@ -99,14 +102,11 @@ test.skipIf(!IS_ROOT)("cleanup leaves no runnable daemonized process", async ()
|
|||||||
expect(status === null || !isRunnableProfileProcess(status, selected.uid)).toBe(true);
|
expect(status === null || !isRunnableProfileProcess(status, selected.uid)).toBe(true);
|
||||||
});
|
});
|
||||||
|
|
||||||
test.skipIf(!IS_ROOT)("the agent process cannot read its coordinator environment", async () => {
|
test.skipIf(!IS_ROOT)("the agent process cannot read its coordinator environment", () => {
|
||||||
const selected = profile(20_020, "/tmp");
|
const selected = profile(20_020, "/tmp");
|
||||||
const result = await agentCommand(selected, "/usr/bin/cat", [`/proc/${process.pid}/environ`], {
|
const result = runAs(selected, "/usr/bin/cat", [`/proc/${process.pid}/environ`], {
|
||||||
cwd: "/",
|
PARENT_SECRET: "must-not-cross-boundary",
|
||||||
env: { PARENT_SECRET: "must-not-cross-boundary" },
|
});
|
||||||
clearEnv: true,
|
|
||||||
stderr: "piped",
|
|
||||||
}).output();
|
|
||||||
|
|
||||||
expect(result.success).toBe(false);
|
expect(result.status).not.toBe(0);
|
||||||
});
|
});
|
||||||
@@ -2,30 +2,8 @@ import { lstat, readdir, readFile } from "node:fs/promises";
|
|||||||
import process from "node:process";
|
import process from "node:process";
|
||||||
import { setTimeout as sleep } from "node:timers/promises";
|
import { setTimeout as sleep } from "node:timers/promises";
|
||||||
|
|
||||||
import { output, spawn } from "./command.ts";
|
import { isNotFound } from "#common";
|
||||||
import type { CommandChild, CommandOptions, CommandOutput } from "./command.ts";
|
import type { RuntimeProfile } from "#runtime";
|
||||||
import { isNotFound } from "./errors.ts";
|
|
||||||
import type { RuntimeProfile } from "./runtime.ts";
|
|
||||||
|
|
||||||
export type AgentCommandOptions = Omit<CommandOptions, "args" | "uid" | "gid">;
|
|
||||||
|
|
||||||
export interface AgentCommand {
|
|
||||||
output(): Promise<CommandOutput>;
|
|
||||||
spawn(): CommandChild;
|
|
||||||
}
|
|
||||||
|
|
||||||
export function agentCommand(
|
|
||||||
profile: RuntimeProfile,
|
|
||||||
command: string,
|
|
||||||
args: string[],
|
|
||||||
options: AgentCommandOptions = {},
|
|
||||||
): AgentCommand {
|
|
||||||
const full: CommandOptions = { ...options, args, uid: profile.uid, gid: profile.gid };
|
|
||||||
return {
|
|
||||||
output: () => output(command, full),
|
|
||||||
spawn: () => spawn(command, full),
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
export function isRunnableProfileProcess(status: string, uid: number): boolean {
|
export function isRunnableProfileProcess(status: string, uid: number): boolean {
|
||||||
const owner = /^Uid:\s+(\d+)/mu.exec(status)?.[1];
|
const owner = /^Uid:\s+(\d+)/mu.exec(status)?.[1];
|
||||||
@@ -49,27 +27,19 @@ async function profileProcessIds(uid: number): Promise<number[]> {
|
|||||||
.map(Number);
|
.map(Number);
|
||||||
}
|
}
|
||||||
|
|
||||||
function killProcess(pid: number): void {
|
|
||||||
try {
|
|
||||||
process.kill(pid, "SIGKILL");
|
|
||||||
} catch (error) {
|
|
||||||
if (!isNotFound(error)) {
|
|
||||||
throw error;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Kills the UID's processes every 10 ms until none is left, for up to 100 rounds.
|
// Kills the UID's processes every 10 ms until none is left, for up to 100 rounds.
|
||||||
export async function killProfileProcesses(uid: number, attempt = 0): Promise<void> {
|
export async function killProfileProcesses(uid: number, attempt = 0): Promise<void> {
|
||||||
if (attempt === 100) {
|
if (attempt === 100) {
|
||||||
throw new Error(`profile UID ${uid} still owns processes after cleanup`);
|
throw new Error(`profile UID ${uid} still owns processes after cleanup`);
|
||||||
}
|
}
|
||||||
const ids = await profileProcessIds(uid);
|
const ids = await profileProcessIds(uid);
|
||||||
if (ids.length === 0) {
|
if (ids.length === 0) return;
|
||||||
return;
|
|
||||||
}
|
|
||||||
for (const pid of ids) {
|
for (const pid of ids) {
|
||||||
killProcess(pid);
|
try {
|
||||||
|
process.kill(pid, "SIGKILL");
|
||||||
|
} catch (error) {
|
||||||
|
if (!isNotFound(error)) throw error;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
await sleep(10);
|
await sleep(10);
|
||||||
await killProfileProcesses(uid, attempt + 1);
|
await killProfileProcesses(uid, attempt + 1);
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
// Bot profiles: their footers, failure reports, ordered runs, and the
|
||||||
|
// environment each agent gets.
|
||||||
|
export {
|
||||||
|
AgentAuthError,
|
||||||
|
agentEnvironment,
|
||||||
|
failureFooter,
|
||||||
|
profileFooter,
|
||||||
|
runProfiles,
|
||||||
|
sanitizedEnvironment,
|
||||||
|
withProfile,
|
||||||
|
} from "./profiles.ts";
|
||||||
|
export type { BotProfile, FailureReason, ProfileFailure, ProfileIdentity } from "./profiles.ts";
|
||||||
@@ -1,4 +1,5 @@
|
|||||||
import { expect, test } from "vite-plus/test";
|
import { expect, test } from "vite-plus/test";
|
||||||
|
|
||||||
import {
|
import {
|
||||||
AgentAuthError,
|
AgentAuthError,
|
||||||
agentEnvironment,
|
agentEnvironment,
|
||||||
@@ -1,35 +1,32 @@
|
|||||||
export type ProfileType = "claude" | "codex" | "opencode";
|
// The agent and model a profile runs, which every report names.
|
||||||
|
export interface ProfileIdentity {
|
||||||
export interface BotProfile {
|
type: "claude" | "codex" | "opencode";
|
||||||
type: ProfileType;
|
|
||||||
model: string;
|
model: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface BotProfile extends ProfileIdentity {
|
||||||
token?: string;
|
token?: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
const PROFILE_TYPES: Set<unknown> = new Set(["claude", "codex", "opencode"]);
|
export function profileFooter(profile: ProfileIdentity): string {
|
||||||
const FAILURE_REASONS: Set<unknown> = new Set(["sign-in failed", "usage exhausted", "failed"]);
|
|
||||||
|
|
||||||
export function isProfileType(value: unknown): value is ProfileType {
|
|
||||||
return PROFILE_TYPES.has(value);
|
|
||||||
}
|
|
||||||
|
|
||||||
export function profileFooter(profile: Pick<BotProfile, "type" | "model">): string {
|
|
||||||
return `> Profile: \`${profile.type}\` · \`${profile.model}\``;
|
return `> Profile: \`${profile.type}\` · \`${profile.model}\``;
|
||||||
}
|
}
|
||||||
|
|
||||||
export function withProfile(body: string, profile: Pick<BotProfile, "type" | "model">): string {
|
export function withProfile(body: string, profile: ProfileIdentity): string {
|
||||||
return `${body}\n\n${profileFooter(profile)}`;
|
return `${body}\n\n${profileFooter(profile)}`;
|
||||||
}
|
}
|
||||||
|
|
||||||
export type FailureReason = "sign-in failed" | "usage exhausted" | "failed";
|
export type FailureReason = "sign-in failed" | "usage exhausted" | "failed";
|
||||||
|
|
||||||
export function isFailureReason(value: unknown): value is FailureReason {
|
export interface ProfileFailure extends ProfileIdentity {
|
||||||
return FAILURE_REASONS.has(value);
|
reason: FailureReason;
|
||||||
}
|
}
|
||||||
|
|
||||||
export type ProfileFailure = Pick<BotProfile, "type" | "model"> & {
|
// Where a profile's isolated user keeps its home.
|
||||||
reason: FailureReason;
|
interface ProfileHome {
|
||||||
};
|
type: ProfileIdentity["type"];
|
||||||
|
home: string;
|
||||||
|
}
|
||||||
|
|
||||||
// Raised once an agent's credentials are rejected and any re-login is spent.
|
// Raised once an agent's credentials are rejected and any re-login is spent.
|
||||||
export class AgentAuthError extends Error {}
|
export class AgentAuthError extends Error {}
|
||||||
@@ -54,7 +51,7 @@ export function failureFooter(failures: ProfileFailure[]): string {
|
|||||||
|
|
||||||
// Tries the profiles from `index` on, moving on only after a sign-in failure
|
// Tries the profiles from `index` on, moving on only after a sign-in failure
|
||||||
// or exhausted usage, and records every profile it tried.
|
// or exhausted usage, and records every profile it tried.
|
||||||
async function attemptFrom<T, P extends Pick<BotProfile, "type" | "model">>(
|
async function attemptFrom<T, P extends ProfileIdentity>(
|
||||||
profiles: P[],
|
profiles: P[],
|
||||||
attempt: (profile: P) => Promise<T>,
|
attempt: (profile: P) => Promise<T>,
|
||||||
failures: ProfileFailure[],
|
failures: ProfileFailure[],
|
||||||
@@ -75,7 +72,7 @@ async function attemptFrom<T, P extends Pick<BotProfile, "type" | "model">>(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
export function runProfiles<T, P extends Pick<BotProfile, "type" | "model">>(
|
export function runProfiles<T, P extends ProfileIdentity>(
|
||||||
profiles: P[],
|
profiles: P[],
|
||||||
attempt: (profile: P) => Promise<T>,
|
attempt: (profile: P) => Promise<T>,
|
||||||
failures: ProfileFailure[] = [],
|
failures: ProfileFailure[] = [],
|
||||||
@@ -83,8 +80,8 @@ export function runProfiles<T, P extends Pick<BotProfile, "type" | "model">>(
|
|||||||
return attemptFrom(profiles, attempt, failures, 0);
|
return attemptFrom(profiles, attempt, failures, 0);
|
||||||
}
|
}
|
||||||
|
|
||||||
export function sanitizedEnvironment(environment: Record<string, string>): Record<string, string> {
|
export function sanitizedEnvironment(environment: NodeJS.ProcessEnv): NodeJS.ProcessEnv {
|
||||||
const result: Record<string, string> = {};
|
const result: NodeJS.ProcessEnv = {};
|
||||||
for (const name of [
|
for (const name of [
|
||||||
"PATH",
|
"PATH",
|
||||||
"HOME",
|
"HOME",
|
||||||
@@ -118,13 +115,13 @@ export function sanitizedEnvironment(environment: Record<string, string>): Recor
|
|||||||
}
|
}
|
||||||
|
|
||||||
export function agentEnvironment(
|
export function agentEnvironment(
|
||||||
environment: Record<string, string>,
|
environment: NodeJS.ProcessEnv,
|
||||||
profile: Pick<BotProfile, "type"> & { home: string },
|
profile: ProfileHome,
|
||||||
token?: string,
|
token?: string,
|
||||||
): Record<string, string> {
|
): NodeJS.ProcessEnv {
|
||||||
const result = sanitizedEnvironment(environment);
|
const result = sanitizedEnvironment(environment);
|
||||||
result.HOME = profile.home;
|
result["HOME"] = profile.home;
|
||||||
if (profile.type === "codex") result.CODEX_HOME = `${profile.home}/.codex`;
|
if (profile.type === "codex") result["CODEX_HOME"] = `${profile.home}/.codex`;
|
||||||
if (token !== undefined && token !== "") {
|
if (token !== undefined && token !== "") {
|
||||||
const tokenName = {
|
const tokenName = {
|
||||||
claude: "CLAUDE_CODE_OAUTH_TOKEN",
|
claude: "CLAUDE_CODE_OAUTH_TOKEN",
|
||||||
@@ -1,79 +0,0 @@
|
|||||||
// The agent phase's environment and the helpers every agent runner shares. It
|
|
||||||
// is read once, when the runner starts, as the single-file runner did.
|
|
||||||
import { chmod, chown, writeFile } from "node:fs/promises";
|
|
||||||
import process from "node:process";
|
|
||||||
|
|
||||||
import { agentCommand } from "./isolation.ts";
|
|
||||||
import { agentEnvironment, sanitizedEnvironment } from "./profiles.ts";
|
|
||||||
import { readRuntimeManifest } from "./runtime.ts";
|
|
||||||
import type { RuntimeProfile } from "./runtime.ts";
|
|
||||||
|
|
||||||
export const env = (name: string): string => {
|
|
||||||
const value = process.env[name];
|
|
||||||
if (value === undefined) {
|
|
||||||
throw new Error(`${name} is not set`);
|
|
||||||
}
|
|
||||||
return value;
|
|
||||||
};
|
|
||||||
|
|
||||||
function definedEnvironment(): Record<string, string> {
|
|
||||||
const result: Record<string, string> = {};
|
|
||||||
for (const [name, value] of Object.entries(process.env)) {
|
|
||||||
if (value !== undefined) {
|
|
||||||
result[name] = value;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return result;
|
|
||||||
}
|
|
||||||
|
|
||||||
export const API = env("GITEA_API_URL");
|
|
||||||
export const REPO = env("GITEA_REPOSITORY");
|
|
||||||
export const INDEX = env("ISSUE_INDEX");
|
|
||||||
export const EVENT = env("EVENT_NAME");
|
|
||||||
const AUTHOR_TOKEN = env("GITEA_TOKEN");
|
|
||||||
export const WORKSPACE = env("GITHUB_WORKSPACE");
|
|
||||||
export const MANIFEST = await readRuntimeManifest(env("BOT_AGENTS_MANIFEST"));
|
|
||||||
export const PROCESS_ENV = sanitizedEnvironment(definedEnvironment());
|
|
||||||
|
|
||||||
export async function gitea(path: string, body?: unknown): Promise<Response> {
|
|
||||||
const response = await fetch(`${API}/${path}`, {
|
|
||||||
method: body === undefined ? "GET" : "POST",
|
|
||||||
headers: {
|
|
||||||
Authorization: `token ${AUTHOR_TOKEN}`,
|
|
||||||
"Content-Type": "application/json",
|
|
||||||
},
|
|
||||||
body: body === undefined ? null : JSON.stringify(body),
|
|
||||||
});
|
|
||||||
if (!response.ok) {
|
|
||||||
throw new Error(`${path}: ${response.status} ${await response.text()}`);
|
|
||||||
}
|
|
||||||
return response;
|
|
||||||
}
|
|
||||||
|
|
||||||
export async function postAuthorComment(body: string): Promise<void> {
|
|
||||||
await gitea(`repos/${REPO}/issues/${INDEX}/comments`, { body });
|
|
||||||
}
|
|
||||||
|
|
||||||
export async function runAgentCommand(
|
|
||||||
profile: RuntimeProfile,
|
|
||||||
command: string,
|
|
||||||
args: string[],
|
|
||||||
token?: string,
|
|
||||||
): Promise<void> {
|
|
||||||
const { success, code } = await agentCommand(profile, command, args, {
|
|
||||||
cwd: WORKSPACE,
|
|
||||||
env: agentEnvironment(PROCESS_ENV, profile, token),
|
|
||||||
clearEnv: true,
|
|
||||||
}).output();
|
|
||||||
if (!success) {
|
|
||||||
throw new Error(`${command} ${args[0]} exited with ${code}`);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
export async function makeProfileFile(profile: RuntimeProfile, name: string): Promise<string> {
|
|
||||||
const path = `${profile.home}/${name}`;
|
|
||||||
await writeFile(path, "", { mode: 0o600 });
|
|
||||||
await chmod(path, 0o600);
|
|
||||||
await chown(path, profile.uid, profile.gid);
|
|
||||||
return path;
|
|
||||||
}
|
|
||||||
-172
@@ -1,172 +0,0 @@
|
|||||||
// Runs one ordered agent profile. Credential decryption and reviewer posting
|
|
||||||
// live in separate processes so neither privileged secret reaches this runner.
|
|
||||||
import { chmod, readFile, writeFile } from "node:fs/promises";
|
|
||||||
|
|
||||||
import { codexAuthentication, persistCodexAuth, stageCodexAuth } from "./auth.ts";
|
|
||||||
import { runAgent } from "./agents.ts";
|
|
||||||
import type { AgentAnswer } from "./agents.ts";
|
|
||||||
import { output } from "./command.ts";
|
|
||||||
import { killProfileProcesses, readProfileFile } from "./isolation.ts";
|
|
||||||
import { isObject } from "./json.ts";
|
|
||||||
import { runProfiles } from "./profiles.ts";
|
|
||||||
import type { ProfileFailure } from "./profiles.ts";
|
|
||||||
import {
|
|
||||||
API,
|
|
||||||
env,
|
|
||||||
EVENT,
|
|
||||||
gitea,
|
|
||||||
INDEX,
|
|
||||||
makeProfileFile,
|
|
||||||
MANIFEST,
|
|
||||||
PROCESS_ENV,
|
|
||||||
REPO,
|
|
||||||
runAgentCommand,
|
|
||||||
WORKSPACE,
|
|
||||||
} from "./run-context.ts";
|
|
||||||
import type { RuntimeOutcome, RuntimeProfile } from "./runtime.ts";
|
|
||||||
|
|
||||||
interface AttemptResult {
|
|
||||||
body: string;
|
|
||||||
reviewPath: string;
|
|
||||||
anchorsPath: string;
|
|
||||||
profile: Pick<RuntimeProfile, "type" | "model">;
|
|
||||||
}
|
|
||||||
|
|
||||||
interface RenderedPrompt {
|
|
||||||
prompt: string;
|
|
||||||
reviewPath: string;
|
|
||||||
anchorsPath: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
const RULES_PATH = "repos/commons/code-rules/raw/README.md";
|
|
||||||
const CODEX_AUTH = "/root/.codex/auth.json";
|
|
||||||
const SKILLS_INSTALL = "skills add obra/superpowers";
|
|
||||||
|
|
||||||
async function runRoot(command: string, args: string[]): Promise<void> {
|
|
||||||
const { success, code } = await output(command, { args, env: PROCESS_ENV, clearEnv: true });
|
|
||||||
if (!success) {
|
|
||||||
throw new Error(`${command} ${args[0]} exited with ${code}`);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
async function configureGitAuthor(): Promise<void> {
|
|
||||||
const user: unknown = await (await gitea("user")).json();
|
|
||||||
if (!isObject(user) || typeof user.login !== "string" || typeof user.email !== "string") {
|
|
||||||
throw new Error("user: unexpected Gitea response");
|
|
||||||
}
|
|
||||||
await runRoot("git", ["config", "user.name", user.login]);
|
|
||||||
await runRoot("git", ["config", "user.email", user.email]);
|
|
||||||
}
|
|
||||||
|
|
||||||
async function readProfileToken(profile: RuntimeProfile): Promise<string | undefined> {
|
|
||||||
const token = profile.tokenFile === null ? undefined : await readFile(profile.tokenFile, "utf8");
|
|
||||||
return token;
|
|
||||||
}
|
|
||||||
|
|
||||||
async function prepareProfile(profile: RuntimeProfile): Promise<void> {
|
|
||||||
await runAgentCommand(profile, "git", [
|
|
||||||
"config",
|
|
||||||
"--global",
|
|
||||||
"--add",
|
|
||||||
"safe.directory",
|
|
||||||
WORKSPACE,
|
|
||||||
]);
|
|
||||||
await runAgentCommand(profile, "npx", [
|
|
||||||
"-y",
|
|
||||||
...SKILLS_INSTALL.split(" "),
|
|
||||||
"--global",
|
|
||||||
"--agent",
|
|
||||||
profile.type === "claude" ? "claude-code" : profile.type,
|
|
||||||
"--yes",
|
|
||||||
]);
|
|
||||||
}
|
|
||||||
|
|
||||||
// One issue comment as the prompt quotes it.
|
|
||||||
function formatComment(comment: unknown): string {
|
|
||||||
const { user, created_at: createdAt, body } = isObject(comment) ? comment : {};
|
|
||||||
const login = isObject(user) ? user.login : undefined;
|
|
||||||
return `## ${String(login)} at ${String(createdAt)}\n\n${String(body)}\n`;
|
|
||||||
}
|
|
||||||
|
|
||||||
async function promptValues(
|
|
||||||
reviewPath: string,
|
|
||||||
anchorsPath: string,
|
|
||||||
): Promise<Record<string, string>> {
|
|
||||||
const comments: unknown = await (
|
|
||||||
await gitea(`repos/${REPO}/issues/${INDEX}/comments?limit=100`)
|
|
||||||
).json();
|
|
||||||
if (!Array.isArray(comments)) {
|
|
||||||
throw new TypeError("comments: unexpected Gitea response");
|
|
||||||
}
|
|
||||||
return {
|
|
||||||
COMMENT: env("COMMENT"),
|
|
||||||
ISSUE_COMMENTS: comments.map((comment: unknown) => formatComment(comment)).join("\n"),
|
|
||||||
CODE_RULES: await (await gitea(RULES_PATH)).text(),
|
|
||||||
EVENT_NAME: EVENT,
|
|
||||||
GITEA_API_URL: API,
|
|
||||||
GITEA_REPOSITORY: REPO,
|
|
||||||
ISSUE_INDEX: INDEX,
|
|
||||||
REVIEW_PATH: reviewPath,
|
|
||||||
ANCHORS_PATH: anchorsPath,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
async function renderPrompt(profile: RuntimeProfile): Promise<RenderedPrompt> {
|
|
||||||
const reviewPath = await makeProfileFile(profile, "review.md");
|
|
||||||
const anchorsPath = await makeProfileFile(profile, "anchors.json");
|
|
||||||
const values = await promptValues(reviewPath, anchorsPath);
|
|
||||||
const template = await readFile(new URL("../prompt.md", import.meta.url), "utf8");
|
|
||||||
return {
|
|
||||||
prompt: template.replaceAll(
|
|
||||||
/\$\{(\w+)\}/gu,
|
|
||||||
(match: string, name: string) => values[name] ?? match,
|
|
||||||
),
|
|
||||||
reviewPath,
|
|
||||||
anchorsPath,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
async function runProfile(profile: RuntimeProfile): Promise<AttemptResult> {
|
|
||||||
const token = await readProfileToken(profile);
|
|
||||||
const authentication = profile.type === "codex" ? codexAuthentication(token) : null;
|
|
||||||
let stagedCodexAuth: string | null = null;
|
|
||||||
let answer: AgentAnswer = {};
|
|
||||||
let rendered: RenderedPrompt | undefined;
|
|
||||||
try {
|
|
||||||
if (authentication?.kind === "persistent") {
|
|
||||||
stagedCodexAuth = await stageCodexAuth(CODEX_AUTH, profile.home, profile.uid, profile.gid);
|
|
||||||
}
|
|
||||||
await prepareProfile(profile);
|
|
||||||
rendered = await renderPrompt(profile);
|
|
||||||
answer = await runAgent(profile, token, rendered.prompt, authentication);
|
|
||||||
} finally {
|
|
||||||
await killProfileProcesses(profile.uid);
|
|
||||||
if (stagedCodexAuth !== null) {
|
|
||||||
await persistCodexAuth(stagedCodexAuth, CODEX_AUTH);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
const body =
|
|
||||||
answer.resultPath === undefined
|
|
||||||
? answer.body
|
|
||||||
: await readProfileFile(profile, answer.resultPath);
|
|
||||||
if (body === undefined || rendered === undefined) {
|
|
||||||
throw new Error("agent attempt produced no result");
|
|
||||||
}
|
|
||||||
const { reviewPath, anchorsPath } = rendered;
|
|
||||||
return { body, reviewPath, anchorsPath, profile: { type: profile.type, model: profile.model } };
|
|
||||||
}
|
|
||||||
|
|
||||||
async function writeOutcome(outcome: RuntimeOutcome): Promise<void> {
|
|
||||||
await writeFile(MANIFEST.outcomeFile, JSON.stringify(outcome), { mode: 0o600 });
|
|
||||||
await chmod(MANIFEST.outcomeFile, 0o600);
|
|
||||||
}
|
|
||||||
|
|
||||||
const failures: ProfileFailure[] = [];
|
|
||||||
try {
|
|
||||||
await configureGitAuthor();
|
|
||||||
await writeOutcome({ ok: true, ...(await runProfiles(MANIFEST.profiles, runProfile, failures)) });
|
|
||||||
} catch (error) {
|
|
||||||
console.error(error);
|
|
||||||
await writeOutcome({ ok: false, failures });
|
|
||||||
throw error;
|
|
||||||
}
|
|
||||||
@@ -0,0 +1,506 @@
|
|||||||
|
// Runs one ordered agent profile. Credential decryption and reviewer posting
|
||||||
|
// live in separate processes so neither privileged secret reaches this runner.
|
||||||
|
import { spawn } from "node:child_process";
|
||||||
|
import { chmod, chown, readFile, writeFile } from "node:fs/promises";
|
||||||
|
import process from "node:process";
|
||||||
|
import { createInterface } from "node:readline";
|
||||||
|
import type { Readable } from "node:stream";
|
||||||
|
import { text as readText } from "node:stream/consumers";
|
||||||
|
import { finished } from "node:stream/promises";
|
||||||
|
import { setTimeout as sleep } from "node:timers/promises";
|
||||||
|
|
||||||
|
import {
|
||||||
|
type ClaudeFailureFields,
|
||||||
|
type CodexAuthentication,
|
||||||
|
codexAuthentication,
|
||||||
|
collectOpenCodeOutput,
|
||||||
|
type CommandResult,
|
||||||
|
isClaudeAuthFailure,
|
||||||
|
isCodexAuthFailure,
|
||||||
|
openCodeArgs,
|
||||||
|
openCodeError,
|
||||||
|
parseOpenCodeEvents,
|
||||||
|
persistCodexAuth,
|
||||||
|
retryInvalidToken,
|
||||||
|
stageCodexAuth,
|
||||||
|
} from "#agents";
|
||||||
|
import { isObject } from "#common";
|
||||||
|
import { echo, exitCode, killProfileProcesses, readProfileFile } from "#processes";
|
||||||
|
import {
|
||||||
|
AgentAuthError,
|
||||||
|
agentEnvironment,
|
||||||
|
type ProfileFailure,
|
||||||
|
type ProfileIdentity,
|
||||||
|
runProfiles,
|
||||||
|
sanitizedEnvironment,
|
||||||
|
withProfile,
|
||||||
|
} from "#profiles";
|
||||||
|
import { readRuntimeManifest, type RuntimeOutcome, type RuntimeProfile } from "#runtime";
|
||||||
|
|
||||||
|
interface AttemptResult {
|
||||||
|
body: string;
|
||||||
|
reviewPath: string;
|
||||||
|
anchorsPath: string;
|
||||||
|
profile: ProfileIdentity;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Claude Code's stream-json `result` event, with camelCase field names.
|
||||||
|
interface ClaudeResult extends ClaudeFailureFields {
|
||||||
|
isError?: boolean;
|
||||||
|
subtype: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface RenderedPrompt {
|
||||||
|
prompt: string;
|
||||||
|
reviewPath: string;
|
||||||
|
anchorsPath: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
const env = (name: string): string => {
|
||||||
|
const value = process.env[name];
|
||||||
|
if (value === undefined) throw new Error(`${name} is not set`);
|
||||||
|
return value;
|
||||||
|
};
|
||||||
|
|
||||||
|
function definedEnvironment(): NodeJS.ProcessEnv {
|
||||||
|
const result: NodeJS.ProcessEnv = {};
|
||||||
|
for (const [name, value] of Object.entries(process.env)) {
|
||||||
|
if (value !== undefined) {
|
||||||
|
result[name] = value;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
const API = env("GITEA_API_URL");
|
||||||
|
const REPO = env("GITEA_REPOSITORY");
|
||||||
|
const INDEX = env("ISSUE_INDEX");
|
||||||
|
const EVENT = env("EVENT_NAME");
|
||||||
|
const AUTHOR_TOKEN = env("GITEA_TOKEN");
|
||||||
|
const WORKSPACE = env("GITHUB_WORKSPACE");
|
||||||
|
const MANIFEST = await readRuntimeManifest(env("BOT_AGENTS_MANIFEST"));
|
||||||
|
const PROCESS_ENV = sanitizedEnvironment(definedEnvironment());
|
||||||
|
const RULES_PATH = "repos/commons/code-rules/raw/README.md";
|
||||||
|
const CODEX_AUTH = "/root/.codex/auth.json";
|
||||||
|
const SKILLS_INSTALL = "skills add obra/superpowers";
|
||||||
|
|
||||||
|
async function gitea(path: string, body?: unknown): Promise<Response> {
|
||||||
|
const response = await fetch(`${API}/${path}`, {
|
||||||
|
method: body === undefined ? "GET" : "POST",
|
||||||
|
headers: {
|
||||||
|
Authorization: `token ${AUTHOR_TOKEN}`,
|
||||||
|
"Content-Type": "application/json",
|
||||||
|
},
|
||||||
|
body: body === undefined ? undefined : JSON.stringify(body),
|
||||||
|
});
|
||||||
|
if (!response.ok) {
|
||||||
|
throw new Error(`${path}: ${response.status} ${await response.text()}`);
|
||||||
|
}
|
||||||
|
return response;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function postAuthorComment(body: string): Promise<void> {
|
||||||
|
await gitea(`repos/${REPO}/issues/${INDEX}/comments`, { body });
|
||||||
|
}
|
||||||
|
|
||||||
|
async function runRoot(command: string, args: string[]): Promise<void> {
|
||||||
|
const code = await exitCode(spawn(command, args, { env: PROCESS_ENV, stdio: "ignore" }));
|
||||||
|
if (code !== 0) throw new Error(`${command} ${args[0]} exited with ${code}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
async function configureGitAuthor(): Promise<void> {
|
||||||
|
const user: unknown = await (await gitea("user")).json();
|
||||||
|
if (!isObject(user) || typeof user["login"] !== "string" || typeof user["email"] !== "string") {
|
||||||
|
throw new Error("user: unexpected Gitea response");
|
||||||
|
}
|
||||||
|
await runRoot("git", ["config", "user.name", user["login"]]);
|
||||||
|
await runRoot("git", ["config", "user.email", user["email"]]);
|
||||||
|
}
|
||||||
|
|
||||||
|
async function readProfileToken(profile: RuntimeProfile): Promise<string | null> {
|
||||||
|
const token = profile.tokenFile === null ? null : await readFile(profile.tokenFile, "utf8");
|
||||||
|
return token;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function runAgentCommand(
|
||||||
|
profile: RuntimeProfile,
|
||||||
|
command: string,
|
||||||
|
args: string[],
|
||||||
|
token?: string,
|
||||||
|
): Promise<void> {
|
||||||
|
const child = spawn(command, args, {
|
||||||
|
cwd: WORKSPACE,
|
||||||
|
env: agentEnvironment(PROCESS_ENV, profile, token),
|
||||||
|
uid: profile.uid,
|
||||||
|
gid: profile.gid,
|
||||||
|
stdio: "ignore",
|
||||||
|
});
|
||||||
|
const code = await exitCode(child);
|
||||||
|
if (code !== 0) throw new Error(`${command} ${args[0]} exited with ${code}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
async function prepareProfile(profile: RuntimeProfile): Promise<void> {
|
||||||
|
await runAgentCommand(profile, "git", [
|
||||||
|
"config",
|
||||||
|
"--global",
|
||||||
|
"--add",
|
||||||
|
"safe.directory",
|
||||||
|
WORKSPACE,
|
||||||
|
]);
|
||||||
|
await runAgentCommand(profile, "npx", [
|
||||||
|
"-y",
|
||||||
|
...SKILLS_INSTALL.split(" "),
|
||||||
|
"--global",
|
||||||
|
"--agent",
|
||||||
|
profile.type === "claude" ? "claude-code" : profile.type,
|
||||||
|
"--yes",
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
|
||||||
|
// One issue comment as the prompt quotes it.
|
||||||
|
function formatComment(comment: unknown): string {
|
||||||
|
const { user, created_at: createdAt, body } = isObject(comment) ? comment : {};
|
||||||
|
const login = isObject(user) ? user["login"] : undefined;
|
||||||
|
return `## ${String(login)} at ${String(createdAt)}\n\n${String(body)}\n`;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function renderPrompt(profile: RuntimeProfile): Promise<RenderedPrompt> {
|
||||||
|
const reviewPath = await makeProfileFile(profile, "review.md");
|
||||||
|
const anchorsPath = await makeProfileFile(profile, "anchors.json");
|
||||||
|
const comments: unknown = await (
|
||||||
|
await gitea(`repos/${REPO}/issues/${INDEX}/comments?limit=100`)
|
||||||
|
).json();
|
||||||
|
if (!Array.isArray(comments)) {
|
||||||
|
throw new TypeError("comments: unexpected Gitea response");
|
||||||
|
}
|
||||||
|
const values: NodeJS.ProcessEnv = {
|
||||||
|
COMMENT: env("COMMENT"),
|
||||||
|
ISSUE_COMMENTS: comments.map((comment: unknown) => formatComment(comment)).join("\n"),
|
||||||
|
CODE_RULES: await (await gitea(RULES_PATH)).text(),
|
||||||
|
EVENT_NAME: EVENT,
|
||||||
|
GITEA_API_URL: API,
|
||||||
|
GITEA_REPOSITORY: REPO,
|
||||||
|
ISSUE_INDEX: INDEX,
|
||||||
|
REVIEW_PATH: reviewPath,
|
||||||
|
ANCHORS_PATH: anchorsPath,
|
||||||
|
};
|
||||||
|
const template = await readFile(new URL("../../prompt.md", import.meta.url), "utf8");
|
||||||
|
return {
|
||||||
|
prompt: template.replaceAll(
|
||||||
|
/\$\{(\w+)\}/gu,
|
||||||
|
(match: string, name: string) => values[name] ?? match,
|
||||||
|
),
|
||||||
|
reviewPath,
|
||||||
|
anchorsPath,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
async function runClaude(profile: RuntimeProfile, token: string, prompt: string): Promise<string> {
|
||||||
|
const claude = spawn(
|
||||||
|
"claude",
|
||||||
|
[
|
||||||
|
"--print",
|
||||||
|
"--dangerously-skip-permissions",
|
||||||
|
"--model",
|
||||||
|
profile.model,
|
||||||
|
"--output-format",
|
||||||
|
"stream-json",
|
||||||
|
"--verbose",
|
||||||
|
prompt,
|
||||||
|
],
|
||||||
|
{
|
||||||
|
cwd: WORKSPACE,
|
||||||
|
env: {
|
||||||
|
...agentEnvironment(PROCESS_ENV, profile, token),
|
||||||
|
IS_SANDBOX: "1",
|
||||||
|
},
|
||||||
|
uid: profile.uid,
|
||||||
|
gid: profile.gid,
|
||||||
|
stdio: ["ignore", "pipe", "pipe"],
|
||||||
|
},
|
||||||
|
);
|
||||||
|
const status = exitCode(claude);
|
||||||
|
let result: ClaudeResult | null = null;
|
||||||
|
let error = "";
|
||||||
|
const copyError = (async (): Promise<void> => {
|
||||||
|
claude.stderr.setEncoding("utf8");
|
||||||
|
for await (const chunk of claude.stderr) {
|
||||||
|
const part = String(chunk);
|
||||||
|
error += part;
|
||||||
|
console.error(part);
|
||||||
|
}
|
||||||
|
})();
|
||||||
|
for await (const line of createInterface({ input: claude.stdout, crlfDelay: Infinity })) {
|
||||||
|
if (line !== "") {
|
||||||
|
const event: unknown = JSON.parse(line);
|
||||||
|
if (isObject(event)) {
|
||||||
|
const content = isObject(event["message"]) ? event["message"]["content"] : undefined;
|
||||||
|
for (const part of Array.isArray(content) ? content : []) {
|
||||||
|
if (isObject(part)) {
|
||||||
|
const text = part["thinking"] ?? part["text"] ?? part["name"];
|
||||||
|
if (typeof text === "string" && text !== "") {
|
||||||
|
console.log(text);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (event["type"] === "result") {
|
||||||
|
const { is_error: isError, result: answer, subtype, api_error_status: apiStatus } = event;
|
||||||
|
result = {
|
||||||
|
isError: typeof isError === "boolean" ? isError : undefined,
|
||||||
|
result: typeof answer === "string" ? answer : undefined,
|
||||||
|
subtype: String(subtype),
|
||||||
|
apiErrorStatus: typeof apiStatus === "number" ? apiStatus : undefined,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
const [code] = await Promise.all([status, copyError]);
|
||||||
|
if (result?.isError === true) {
|
||||||
|
const failure = new Error(result.result ?? `claude ended with ${result.subtype}`);
|
||||||
|
if (isClaudeAuthFailure(result)) {
|
||||||
|
throw new AgentAuthError("claude sign-in failed", { cause: failure });
|
||||||
|
}
|
||||||
|
throw failure;
|
||||||
|
}
|
||||||
|
if (result?.result === undefined) {
|
||||||
|
throw new Error(error.trim() || `claude ended with ${result?.subtype ?? "no result"}`);
|
||||||
|
}
|
||||||
|
if (code !== 0) {
|
||||||
|
throw new Error(error.trim() || `claude exited with ${code}`);
|
||||||
|
}
|
||||||
|
return result.result;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Polls every 100 ms until the login prints something, failing if it exits first.
|
||||||
|
async function pollForInstructions(
|
||||||
|
shownText: () => string,
|
||||||
|
status: Promise<number>,
|
||||||
|
): Promise<void> {
|
||||||
|
if (shownText().trim() !== "") {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
const exited = await Promise.race([status.then(() => true), sleep(100, false)]);
|
||||||
|
if (exited) {
|
||||||
|
throw new AgentAuthError("AI bot login produced no instructions");
|
||||||
|
}
|
||||||
|
await pollForInstructions(shownText, status);
|
||||||
|
}
|
||||||
|
|
||||||
|
async function codexDeviceLogin(
|
||||||
|
profile: RuntimeProfile,
|
||||||
|
environment: NodeJS.ProcessEnv,
|
||||||
|
): Promise<void> {
|
||||||
|
const login = spawn("codex", ["login", "--device-auth"], {
|
||||||
|
cwd: WORKSPACE,
|
||||||
|
env: environment,
|
||||||
|
uid: profile.uid,
|
||||||
|
gid: profile.gid,
|
||||||
|
stdio: ["ignore", "pipe", "pipe"],
|
||||||
|
});
|
||||||
|
const status = exitCode(login);
|
||||||
|
let shown = "";
|
||||||
|
const collect = async (stream: Readable): Promise<void> => {
|
||||||
|
stream.setEncoding("utf8");
|
||||||
|
for await (const chunk of stream) {
|
||||||
|
shown += String(chunk);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
const drained = Promise.all([collect(login.stdout), collect(login.stderr)]);
|
||||||
|
await sleep(3000);
|
||||||
|
await pollForInstructions(() => shown, status);
|
||||||
|
await postAuthorComment(withProfile(shown, profile));
|
||||||
|
const [code] = await Promise.all([status, drained]);
|
||||||
|
if (code !== 0) {
|
||||||
|
throw new AgentAuthError(`codex login exited with ${code}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async function codexApiLogin(
|
||||||
|
profile: RuntimeProfile,
|
||||||
|
environment: NodeJS.ProcessEnv,
|
||||||
|
token: string,
|
||||||
|
): Promise<void> {
|
||||||
|
const login = spawn("codex", ["login", "--with-api-key"], {
|
||||||
|
cwd: WORKSPACE,
|
||||||
|
env: environment,
|
||||||
|
uid: profile.uid,
|
||||||
|
gid: profile.gid,
|
||||||
|
stdio: ["pipe", "inherit", "pipe"],
|
||||||
|
});
|
||||||
|
const status = exitCode(login);
|
||||||
|
login.stdin.end(`${token}\n`);
|
||||||
|
await finished(login.stdin);
|
||||||
|
const [code, error] = await Promise.all([status, readText(login.stderr)]);
|
||||||
|
if (code !== 0) {
|
||||||
|
throw new Error(error.trim() || `codex login exited with ${code}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async function makeProfileFile(profile: RuntimeProfile, name: string): Promise<string> {
|
||||||
|
const path = `${profile.home}/${name}`;
|
||||||
|
await writeFile(path, "", { mode: 0o600 });
|
||||||
|
await chmod(path, 0o600);
|
||||||
|
await chown(path, profile.uid, profile.gid);
|
||||||
|
return path;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function runCodex(
|
||||||
|
profile: RuntimeProfile,
|
||||||
|
prompt: string,
|
||||||
|
authentication: CodexAuthentication,
|
||||||
|
): Promise<string> {
|
||||||
|
const token = authentication.kind === "api-key" ? authentication.token : undefined;
|
||||||
|
const environment = agentEnvironment(PROCESS_ENV, profile, token);
|
||||||
|
if (authentication.kind === "api-key") {
|
||||||
|
await codexApiLogin(profile, environment, authentication.token);
|
||||||
|
} else {
|
||||||
|
const check = spawn("codex", ["login", "status"], {
|
||||||
|
cwd: WORKSPACE,
|
||||||
|
env: environment,
|
||||||
|
uid: profile.uid,
|
||||||
|
gid: profile.gid,
|
||||||
|
stdio: "ignore",
|
||||||
|
});
|
||||||
|
if ((await exitCode(check)) !== 0) await codexDeviceLogin(profile, environment);
|
||||||
|
}
|
||||||
|
const outputPath = await makeProfileFile(profile, "result.md");
|
||||||
|
const attempt = async (): Promise<CommandResult> => {
|
||||||
|
const codex = spawn(
|
||||||
|
"codex",
|
||||||
|
[
|
||||||
|
"exec",
|
||||||
|
"--model",
|
||||||
|
profile.model,
|
||||||
|
"--dangerously-bypass-approvals-and-sandbox",
|
||||||
|
"--output-last-message",
|
||||||
|
outputPath,
|
||||||
|
prompt,
|
||||||
|
],
|
||||||
|
{
|
||||||
|
cwd: WORKSPACE,
|
||||||
|
env: environment,
|
||||||
|
uid: profile.uid,
|
||||||
|
gid: profile.gid,
|
||||||
|
stdio: ["ignore", "inherit", "pipe"],
|
||||||
|
},
|
||||||
|
);
|
||||||
|
const status = exitCode(codex);
|
||||||
|
codex.stderr.setEncoding("utf8");
|
||||||
|
let error = "";
|
||||||
|
for await (const chunk of codex.stderr) {
|
||||||
|
const part = String(chunk);
|
||||||
|
await echo(process.stderr, part);
|
||||||
|
error += part;
|
||||||
|
}
|
||||||
|
// Codex echoes the prompt, whose comments may quote auth errors.
|
||||||
|
return { code: await status, error: error.replaceAll(prompt, "") };
|
||||||
|
};
|
||||||
|
const result =
|
||||||
|
authentication.kind === "api-key"
|
||||||
|
? await attempt()
|
||||||
|
: await retryInvalidToken(attempt, async () => {
|
||||||
|
await runAgentCommand(profile, "codex", ["logout"]);
|
||||||
|
await codexDeviceLogin(profile, environment);
|
||||||
|
});
|
||||||
|
if (result.code !== 0) {
|
||||||
|
const failure = new Error(result.error.trim() || `codex exited with ${result.code}`);
|
||||||
|
if (isCodexAuthFailure(result.error)) {
|
||||||
|
throw new AgentAuthError("codex sign-in failed", { cause: failure });
|
||||||
|
}
|
||||||
|
throw failure;
|
||||||
|
}
|
||||||
|
return outputPath;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function runOpenCode(
|
||||||
|
profile: RuntimeProfile,
|
||||||
|
token: string,
|
||||||
|
prompt: string,
|
||||||
|
): Promise<string> {
|
||||||
|
const child = spawn("opencode", openCodeArgs(profile.model, prompt), {
|
||||||
|
cwd: WORKSPACE,
|
||||||
|
env: agentEnvironment(PROCESS_ENV, profile, token),
|
||||||
|
uid: profile.uid,
|
||||||
|
gid: profile.gid,
|
||||||
|
stdio: ["ignore", "pipe", "pipe"],
|
||||||
|
});
|
||||||
|
const status = exitCode(child);
|
||||||
|
const collected = collectOpenCodeOutput(
|
||||||
|
child.stdout,
|
||||||
|
child.stderr,
|
||||||
|
(chunk) => echo(process.stdout, chunk),
|
||||||
|
(chunk) => echo(process.stderr, chunk),
|
||||||
|
);
|
||||||
|
const [code, streams] = await Promise.all([status, collected]);
|
||||||
|
const error = streams.stderr.trim();
|
||||||
|
if (code !== 0) {
|
||||||
|
throw openCodeError(streams.stdout) ?? new Error(error || `opencode exited with ${code}`);
|
||||||
|
}
|
||||||
|
return parseOpenCodeEvents(streams.stdout);
|
||||||
|
}
|
||||||
|
|
||||||
|
async function runProfile(profile: RuntimeProfile): Promise<AttemptResult> {
|
||||||
|
const token = await readProfileToken(profile);
|
||||||
|
const authentication = profile.type === "codex" ? codexAuthentication(token ?? undefined) : null;
|
||||||
|
let stagedCodexAuth: string | null = null;
|
||||||
|
let body: string | null = null;
|
||||||
|
let resultPath: string | null = null;
|
||||||
|
let reviewPath: string | null = null;
|
||||||
|
let anchorsPath: string | null = null;
|
||||||
|
try {
|
||||||
|
if (authentication?.kind === "persistent") {
|
||||||
|
stagedCodexAuth = await stageCodexAuth(CODEX_AUTH, profile.home, profile.uid, profile.gid);
|
||||||
|
}
|
||||||
|
await prepareProfile(profile);
|
||||||
|
const rendered = await renderPrompt(profile);
|
||||||
|
reviewPath = rendered.reviewPath;
|
||||||
|
anchorsPath = rendered.anchorsPath;
|
||||||
|
if (profile.type === "claude") {
|
||||||
|
body = await runClaude(profile, token ?? "", rendered.prompt);
|
||||||
|
} else if (profile.type === "codex") {
|
||||||
|
resultPath = await runCodex(
|
||||||
|
profile,
|
||||||
|
rendered.prompt,
|
||||||
|
authentication ?? codexAuthentication(token ?? undefined),
|
||||||
|
);
|
||||||
|
} else {
|
||||||
|
body = await runOpenCode(profile, token ?? "", rendered.prompt);
|
||||||
|
}
|
||||||
|
} finally {
|
||||||
|
await killProfileProcesses(profile.uid);
|
||||||
|
if (stagedCodexAuth !== null) {
|
||||||
|
await persistCodexAuth(stagedCodexAuth, CODEX_AUTH);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (resultPath !== null) body = await readProfileFile(profile, resultPath);
|
||||||
|
if (body === null || reviewPath === null || anchorsPath === null) {
|
||||||
|
throw new Error("agent attempt produced no result");
|
||||||
|
}
|
||||||
|
return {
|
||||||
|
body,
|
||||||
|
reviewPath,
|
||||||
|
anchorsPath,
|
||||||
|
profile: { type: profile.type, model: profile.model },
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
async function writeOutcome(outcome: RuntimeOutcome): Promise<void> {
|
||||||
|
await writeFile(MANIFEST.outcomeFile, JSON.stringify(outcome), {
|
||||||
|
mode: 0o600,
|
||||||
|
});
|
||||||
|
await chmod(MANIFEST.outcomeFile, 0o600);
|
||||||
|
}
|
||||||
|
|
||||||
|
const failures: ProfileFailure[] = [];
|
||||||
|
try {
|
||||||
|
await configureGitAuthor();
|
||||||
|
await writeOutcome({
|
||||||
|
ok: true,
|
||||||
|
...(await runProfiles(MANIFEST.profiles, runProfile, failures)),
|
||||||
|
});
|
||||||
|
} catch (error) {
|
||||||
|
console.error(error);
|
||||||
|
await writeOutcome({ ok: false, failures });
|
||||||
|
throw error;
|
||||||
|
}
|
||||||
@@ -1,4 +1,5 @@
|
|||||||
import { expect, test } from "vite-plus/test";
|
import { expect, test } from "vite-plus/test";
|
||||||
|
|
||||||
import { decryptCredential, encryptCredential, parseCredentials } from "./credentials.ts";
|
import { decryptCredential, encryptCredential, parseCredentials } from "./credentials.ts";
|
||||||
|
|
||||||
const MASTER_KEY = "AAECAwQFBgcICQoLDA0ODxAREhMUFRYXGBkaGxwdHh8";
|
const MASTER_KEY = "AAECAwQFBgcICQoLDA0ODxAREhMUFRYXGBkaGxwdHh8";
|
||||||
@@ -1,9 +1,15 @@
|
|||||||
import { webcrypto } from "node:crypto";
|
import { webcrypto } from "node:crypto";
|
||||||
|
|
||||||
import { isMapping } from "./json.ts";
|
import { isMapping } from "#common";
|
||||||
import type { BotProfile } from "./profiles.ts";
|
import type { BotProfile } from "#profiles";
|
||||||
|
|
||||||
const DEFAULT_MODELS: Record<BotProfile["type"], string> = {
|
interface DefaultModels {
|
||||||
|
claude: string;
|
||||||
|
codex: string;
|
||||||
|
opencode: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
const DEFAULT_MODELS: DefaultModels = {
|
||||||
claude: "claude-sonnet-5",
|
claude: "claude-sonnet-5",
|
||||||
codex: "gpt-5.6-terra",
|
codex: "gpt-5.6-terra",
|
||||||
opencode: "openrouter/qwen/qwen3.8-27b",
|
opencode: "openrouter/qwen/qwen3.8-27b",
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
// The runtime the prepare phase writes for the later phases: decrypted
|
||||||
|
// credentials laid out per profile, described by a manifest.
|
||||||
|
export { prepareRuntime, readRuntimeManifest } from "./runtime.ts";
|
||||||
|
export type {
|
||||||
|
RuntimeFailure,
|
||||||
|
RuntimeManifest,
|
||||||
|
RuntimeOutcome,
|
||||||
|
RuntimeProfile,
|
||||||
|
RuntimeSuccess,
|
||||||
|
} from "./runtime.ts";
|
||||||
@@ -1,26 +1,20 @@
|
|||||||
|
import { spawnSync } from "node:child_process";
|
||||||
import { chmod, readdir, readFile, rm, stat, writeFile } from "node:fs/promises";
|
import { chmod, readdir, readFile, rm, stat, writeFile } from "node:fs/promises";
|
||||||
import process from "node:process";
|
import process from "node:process";
|
||||||
import { fileURLToPath } from "node:url";
|
import { fileURLToPath } from "node:url";
|
||||||
|
|
||||||
import { assert, expect, test } from "vite-plus/test";
|
import { assert, expect, test } from "vite-plus/test";
|
||||||
|
|
||||||
import { output } from "./command.ts";
|
import { IS_ROOT, makeTempDir } from "#testing";
|
||||||
import { prepareRuntime } from "./runtime.ts";
|
|
||||||
import type { RuntimeProfile } from "./runtime.ts";
|
import { prepareRuntime, type RuntimeProfile } from "./runtime.ts";
|
||||||
import { IS_ROOT, makeTempDir } from "./testing.ts";
|
|
||||||
|
|
||||||
const MASTER_KEY = "AAECAwQFBgcICQoLDA0ODxAREhMUFRYXGBkaGxwdHh8";
|
const MASTER_KEY = "AAECAwQFBgcICQoLDA0ODxAREhMUFRYXGBkaGxwdHh8";
|
||||||
const ENCRYPTED = "v1:ICEiIyQlJicoKSor:oV_FAgnsN3p1FyegJxwGVdyjfyPio6qDeSUwbA";
|
const ENCRYPTED = "v1:ICEiIyQlJicoKSor:oV_FAgnsN3p1FyegJxwGVdyjfyPio6qDeSUwbA";
|
||||||
|
|
||||||
// Runs `command` as the profile's user, from the root directory.
|
// Runs `command` as the profile's user, from the root directory.
|
||||||
async function runAs(profile: RuntimeProfile, command: string, path: string): Promise<boolean> {
|
function runAs(profile: RuntimeProfile, command: string, path: string): boolean {
|
||||||
const result = await output(command, {
|
const result = spawnSync(command, [path], { cwd: "/", uid: profile.uid, gid: profile.gid });
|
||||||
args: [path],
|
return result.status === 0;
|
||||||
cwd: "/",
|
|
||||||
uid: profile.uid,
|
|
||||||
gid: profile.gid,
|
|
||||||
});
|
|
||||||
return result.success;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
async function expectPrivate(path: string, uid: number, mode: number): Promise<void> {
|
async function expectPrivate(path: string, uid: number, mode: number): Promise<void> {
|
||||||
@@ -58,16 +52,16 @@ test.skipIf(!IS_ROOT)("prepares root-only reviewer and isolated profile credenti
|
|||||||
expect((await stat(codex.home)).uid).toStrictEqual(codex.uid);
|
expect((await stat(codex.home)).uid).toStrictEqual(codex.uid);
|
||||||
expect(codex.tokenFile).toBe(null);
|
expect(codex.tokenFile).toBe(null);
|
||||||
|
|
||||||
const ownToken = await output("/bin/cat", {
|
const ownToken = spawnSync("/bin/cat", [claude.tokenFile], {
|
||||||
args: [claude.tokenFile],
|
|
||||||
cwd: "/",
|
cwd: "/",
|
||||||
uid: claude.uid,
|
uid: claude.uid,
|
||||||
gid: claude.gid,
|
gid: claude.gid,
|
||||||
|
encoding: "utf8",
|
||||||
});
|
});
|
||||||
expect(ownToken.success).toBe(true);
|
expect(ownToken.status).toBe(0);
|
||||||
expect(new TextDecoder().decode(ownToken.stdout)).toBe("secret-token");
|
expect(ownToken.stdout).toBe("secret-token");
|
||||||
expect(await runAs(claude, "/bin/cat", manifest.reviewerFile)).toBe(false);
|
expect(runAs(claude, "/bin/cat", manifest.reviewerFile)).toBe(false);
|
||||||
expect(await runAs(claude, "/bin/ls", codex.home)).toBe(false);
|
expect(runAs(claude, "/bin/ls", codex.home)).toBe(false);
|
||||||
} finally {
|
} finally {
|
||||||
await rm(root, { recursive: true });
|
await rm(root, { recursive: true });
|
||||||
await rm(action, { recursive: true });
|
await rm(action, { recursive: true });
|
||||||
@@ -85,18 +79,20 @@ test.skipIf(!IS_ROOT)("removes prepared credentials when output publication fail
|
|||||||
profiles: [{ type: "claude", token: ENCRYPTED }],
|
profiles: [{ type: "claude", token: ENCRYPTED }],
|
||||||
}),
|
}),
|
||||||
);
|
);
|
||||||
const result = await output(process.execPath, {
|
const result = spawnSync(
|
||||||
args: [fileURLToPath(new URL("prepare.ts", import.meta.url))],
|
process.execPath,
|
||||||
env: {
|
[fileURLToPath(new URL("../prepare/index.ts", import.meta.url))],
|
||||||
ACTION_PATH: action,
|
{
|
||||||
RUNNER_TEMP: root,
|
env: {
|
||||||
BOT_AGENTS_MASTER_KEY: MASTER_KEY,
|
ACTION_PATH: action,
|
||||||
GITHUB_OUTPUT: action,
|
RUNNER_TEMP: root,
|
||||||
|
BOT_AGENTS_MASTER_KEY: MASTER_KEY,
|
||||||
|
GITHUB_OUTPUT: action,
|
||||||
|
},
|
||||||
},
|
},
|
||||||
clearEnv: true,
|
);
|
||||||
});
|
|
||||||
|
|
||||||
expect(result.success).toBe(false);
|
expect(result.status).not.toBe(0);
|
||||||
expect(await readdir(root)).toStrictEqual([]);
|
expect(await readdir(root)).toStrictEqual([]);
|
||||||
} finally {
|
} finally {
|
||||||
await rm(root, { recursive: true });
|
await rm(root, { recursive: true });
|
||||||
@@ -1,19 +1,20 @@
|
|||||||
import { chmod, chown, mkdir, mkdtemp, readFile, rm, writeFile } from "node:fs/promises";
|
import { chmod, chown, mkdir, mkdtemp, readFile, rm, writeFile } from "node:fs/promises";
|
||||||
import { join } from "node:path";
|
import { join } from "node:path";
|
||||||
|
|
||||||
|
import { isMapping } from "#common";
|
||||||
|
import type { ProfileFailure, ProfileIdentity } from "#profiles";
|
||||||
|
|
||||||
import { parseCredentials } from "./credentials.ts";
|
import { parseCredentials } from "./credentials.ts";
|
||||||
import { isMapping } from "./json.ts";
|
|
||||||
import type { BotProfile, ProfileFailure } from "./profiles.ts";
|
|
||||||
|
|
||||||
const FIRST_PROFILE_UID = 20_000;
|
const FIRST_PROFILE_UID = 20_000;
|
||||||
|
|
||||||
export type RuntimeProfile = Pick<BotProfile, "type" | "model"> & {
|
export interface RuntimeProfile extends ProfileIdentity {
|
||||||
index: number;
|
index: number;
|
||||||
uid: number;
|
uid: number;
|
||||||
gid: number;
|
gid: number;
|
||||||
home: string;
|
home: string;
|
||||||
tokenFile: string | null;
|
tokenFile: string | null;
|
||||||
};
|
}
|
||||||
|
|
||||||
export interface RuntimeManifest {
|
export interface RuntimeManifest {
|
||||||
runtimeDir: string;
|
runtimeDir: string;
|
||||||
@@ -23,15 +24,20 @@ export interface RuntimeManifest {
|
|||||||
profiles: RuntimeProfile[];
|
profiles: RuntimeProfile[];
|
||||||
}
|
}
|
||||||
|
|
||||||
export type RuntimeOutcome =
|
export interface RuntimeSuccess {
|
||||||
| {
|
ok: true;
|
||||||
ok: true;
|
body: string;
|
||||||
body: string;
|
reviewPath: string;
|
||||||
reviewPath: string;
|
anchorsPath: string;
|
||||||
anchorsPath: string;
|
profile: ProfileIdentity;
|
||||||
profile: Pick<RuntimeProfile, "type" | "model">;
|
}
|
||||||
}
|
|
||||||
| { ok: false; failures: ProfileFailure[] };
|
export interface RuntimeFailure {
|
||||||
|
ok: false;
|
||||||
|
failures: ProfileFailure[];
|
||||||
|
}
|
||||||
|
|
||||||
|
export type RuntimeOutcome = RuntimeSuccess | RuntimeFailure;
|
||||||
|
|
||||||
async function writePrivate(path: string, value: string, uid: number, gid: number): Promise<void> {
|
async function writePrivate(path: string, value: string, uid: number, gid: number): Promise<void> {
|
||||||
await writeFile(path, value, { mode: 0o600 });
|
await writeFile(path, value, { mode: 0o600 });
|
||||||
@@ -39,24 +45,6 @@ async function writePrivate(path: string, value: string, uid: number, gid: numbe
|
|||||||
await chown(path, uid, gid);
|
await chown(path, uid, gid);
|
||||||
}
|
}
|
||||||
|
|
||||||
async function prepareProfile(
|
|
||||||
runtimeDir: string,
|
|
||||||
profile: BotProfile,
|
|
||||||
index: number,
|
|
||||||
): Promise<RuntimeProfile> {
|
|
||||||
const uid = FIRST_PROFILE_UID + index;
|
|
||||||
const home = join(runtimeDir, `profile-${index}`);
|
|
||||||
await mkdir(home, { mode: 0o700 });
|
|
||||||
await chmod(home, 0o700);
|
|
||||||
await chown(home, uid, uid);
|
|
||||||
const tokenFile =
|
|
||||||
profile.token === undefined || profile.token === "" ? null : join(home, "token");
|
|
||||||
if (tokenFile !== null && profile.token !== undefined) {
|
|
||||||
await writePrivate(tokenFile, profile.token, uid, uid);
|
|
||||||
}
|
|
||||||
return { index, type: profile.type, model: profile.model, uid, gid: uid, home, tokenFile };
|
|
||||||
}
|
|
||||||
|
|
||||||
export async function prepareRuntime(
|
export async function prepareRuntime(
|
||||||
actionPath: string,
|
actionPath: string,
|
||||||
runtimeRoot: string,
|
runtimeRoot: string,
|
||||||
@@ -74,10 +62,29 @@ export async function prepareRuntime(
|
|||||||
|
|
||||||
// One profile at a time, in order, as each claims the next UID.
|
// One profile at a time, in order, as each claims the next UID.
|
||||||
const profiles = await credentials.profiles.reduce<Promise<RuntimeProfile[]>>(
|
const profiles = await credentials.profiles.reduce<Promise<RuntimeProfile[]>>(
|
||||||
async (previous, profile, index) => [
|
async (previous, profile, index) => {
|
||||||
...(await previous),
|
const prepared = await previous;
|
||||||
await prepareProfile(runtimeDir, profile, index),
|
const uid = FIRST_PROFILE_UID + index;
|
||||||
],
|
const home = join(runtimeDir, `profile-${index}`);
|
||||||
|
await mkdir(home, { mode: 0o700 });
|
||||||
|
await chmod(home, 0o700);
|
||||||
|
await chown(home, uid, uid);
|
||||||
|
const tokenFile =
|
||||||
|
profile.token === undefined || profile.token === "" ? null : join(home, "token");
|
||||||
|
if (tokenFile !== null && profile.token !== undefined) {
|
||||||
|
await writePrivate(tokenFile, profile.token, uid, uid);
|
||||||
|
}
|
||||||
|
prepared.push({
|
||||||
|
index,
|
||||||
|
type: profile.type,
|
||||||
|
model: profile.model,
|
||||||
|
uid,
|
||||||
|
gid: uid,
|
||||||
|
home,
|
||||||
|
tokenFile,
|
||||||
|
});
|
||||||
|
return prepared;
|
||||||
|
},
|
||||||
Promise.resolve([]),
|
Promise.resolve([]),
|
||||||
);
|
);
|
||||||
|
|
||||||
@@ -100,11 +107,11 @@ export async function prepareRuntime(
|
|||||||
function isRuntimeManifest(value: unknown): value is RuntimeManifest {
|
function isRuntimeManifest(value: unknown): value is RuntimeManifest {
|
||||||
return (
|
return (
|
||||||
isMapping(value) &&
|
isMapping(value) &&
|
||||||
typeof value.runtimeDir === "string" &&
|
typeof value["runtimeDir"] === "string" &&
|
||||||
typeof value.manifestPath === "string" &&
|
typeof value["manifestPath"] === "string" &&
|
||||||
typeof value.reviewerFile === "string" &&
|
typeof value["reviewerFile"] === "string" &&
|
||||||
typeof value.outcomeFile === "string" &&
|
typeof value["outcomeFile"] === "string" &&
|
||||||
Array.isArray(value.profiles)
|
Array.isArray(value["profiles"])
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1,23 +0,0 @@
|
|||||||
// Test support: the current user's IDs and a fresh temporary directory.
|
|
||||||
import { mkdtemp } from "node:fs/promises";
|
|
||||||
import { tmpdir } from "node:os";
|
|
||||||
import { join } from "node:path";
|
|
||||||
import process from "node:process";
|
|
||||||
|
|
||||||
export function currentUid(): number {
|
|
||||||
return process.getuid?.() ?? -1;
|
|
||||||
}
|
|
||||||
|
|
||||||
export function currentGid(): number {
|
|
||||||
return process.getgid?.() ?? -1;
|
|
||||||
}
|
|
||||||
|
|
||||||
// The isolation tests switch UIDs, which only root may do.
|
|
||||||
export const IS_ROOT: boolean = currentUid() === 0;
|
|
||||||
|
|
||||||
// Symlinks and POSIX modes, as these tests use them, need a Unix host.
|
|
||||||
export const IS_WINDOWS: boolean = process.platform === "win32";
|
|
||||||
|
|
||||||
export function makeTempDir(): Promise<string> {
|
|
||||||
return mkdtemp(join(tmpdir(), "bot-agents-test-"));
|
|
||||||
}
|
|
||||||
@@ -0,0 +1,47 @@
|
|||||||
|
// Test support: the current user's IDs, a fresh temporary directory, and a
|
||||||
|
// plain command runner. It imports no source module, so the repository-level
|
||||||
|
// tests in tests/, which reach src/ only through `#testing`, never touch
|
||||||
|
// internals.
|
||||||
|
import { spawn } from "node:child_process";
|
||||||
|
import { once } from "node:events";
|
||||||
|
import { mkdtemp } from "node:fs/promises";
|
||||||
|
import { tmpdir } from "node:os";
|
||||||
|
import { join } from "node:path";
|
||||||
|
import process from "node:process";
|
||||||
|
import { text } from "node:stream/consumers";
|
||||||
|
|
||||||
|
export function currentUid(): number {
|
||||||
|
return process.getuid?.() ?? -1;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function currentGid(): number {
|
||||||
|
return process.getgid?.() ?? -1;
|
||||||
|
}
|
||||||
|
|
||||||
|
// The isolation tests switch UIDs, which only root may do.
|
||||||
|
export const IS_ROOT: boolean = currentUid() === 0;
|
||||||
|
|
||||||
|
// Symlinks and POSIX modes, as these tests use them, need a Unix host.
|
||||||
|
export const IS_WINDOWS: boolean = process.platform === "win32";
|
||||||
|
|
||||||
|
export function makeTempDir(): Promise<string> {
|
||||||
|
return mkdtemp(join(tmpdir(), "bot-agents-test-"));
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface CommandResult {
|
||||||
|
success: boolean;
|
||||||
|
stderr: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Runs a command with stdin closed and only the given environment, and
|
||||||
|
// collects its stderr.
|
||||||
|
export async function runCommand(
|
||||||
|
command: string,
|
||||||
|
args: string[],
|
||||||
|
env: NodeJS.ProcessEnv,
|
||||||
|
): Promise<CommandResult> {
|
||||||
|
const child = spawn(command, args, { env, stdio: ["ignore", "ignore", "pipe"] });
|
||||||
|
const [stderr, closed] = await Promise.all([text(child.stderr), once(child, "close")]);
|
||||||
|
const exitCode: unknown = closed[0];
|
||||||
|
return { success: exitCode === 0, stderr };
|
||||||
|
}
|
||||||
@@ -1,11 +1,10 @@
|
|||||||
import process from "node:process";
|
import process from "node:process";
|
||||||
import { fileURLToPath } from "node:url";
|
import { fileURLToPath } from "node:url";
|
||||||
|
|
||||||
import { expect, test } from "vite-plus/test";
|
import { expect, test } from "vite-plus/test";
|
||||||
|
|
||||||
import { output } from "../src/command.ts";
|
import { runCommand } from "#testing";
|
||||||
|
|
||||||
// Each phase runs as `node src/<phase>.ts` with no build step. Node loads the
|
// Each phase runs as `node src/<phase>/index.ts` with no build step. Node loads the
|
||||||
// whole import graph, stripping types, before the phase reads its first
|
// whole import graph, stripping types, before the phase reads its first
|
||||||
// variable, so failing on that variable proves every module loads.
|
// variable, so failing on that variable proves every module loads.
|
||||||
const PHASES: [phase: string, firstVariable: string][] = [
|
const PHASES: [phase: string, firstVariable: string][] = [
|
||||||
@@ -15,13 +14,8 @@ const PHASES: [phase: string, firstVariable: string][] = [
|
|||||||
];
|
];
|
||||||
|
|
||||||
test.each(PHASES)("Node loads the %s phase", async (phase, firstVariable) => {
|
test.each(PHASES)("Node loads the %s phase", async (phase, firstVariable) => {
|
||||||
const path = fileURLToPath(new URL(`../src/${phase}.ts`, import.meta.url));
|
const path = fileURLToPath(new URL(`../src/${phase}/index.ts`, import.meta.url));
|
||||||
const result = await output(process.execPath, {
|
const result = await runCommand(process.execPath, [path], { PATH: process.env["PATH"] ?? "" });
|
||||||
args: [path],
|
|
||||||
env: { PATH: process.env.PATH ?? "" },
|
|
||||||
clearEnv: true,
|
|
||||||
stdin: "null",
|
|
||||||
});
|
|
||||||
expect(result.success).toBe(false);
|
expect(result.success).toBe(false);
|
||||||
expect(new TextDecoder().decode(result.stderr)).toContain(`${firstVariable} is not set`);
|
expect(result.stderr).toContain(`${firstVariable} is not set`);
|
||||||
});
|
});
|
||||||
|
|||||||
+47
-39
@@ -1,14 +1,14 @@
|
|||||||
import { readdir, readFile, rm, stat } from "node:fs/promises";
|
import { readdir, readFile, rm, stat } from "node:fs/promises";
|
||||||
import process from "node:process";
|
import process from "node:process";
|
||||||
|
|
||||||
import { assert, expect, test } from "vite-plus/test";
|
import { assert, expect, test } from "vite-plus/test";
|
||||||
import { parse } from "yaml";
|
import { parse } from "yaml";
|
||||||
|
|
||||||
import { output } from "../src/command.ts";
|
import { makeTempDir, runCommand } from "#testing";
|
||||||
import { isNotFound } from "../src/errors.ts";
|
|
||||||
import { isMapping } from "../src/json.ts";
|
type JsonObject = NodeJS.Dict<unknown>;
|
||||||
import type { JsonObject } from "../src/json.ts";
|
|
||||||
import { makeTempDir } from "../src/testing.ts";
|
const isMapping = (value: unknown): value is JsonObject =>
|
||||||
|
typeof value === "object" && value !== null && !Array.isArray(value);
|
||||||
|
|
||||||
const mapping = (value: unknown, at: string): JsonObject => {
|
const mapping = (value: unknown, at: string): JsonObject => {
|
||||||
assert(isMapping(value), at);
|
assert(isMapping(value), at);
|
||||||
@@ -47,11 +47,11 @@ test("all committed YAML parses", async () => {
|
|||||||
|
|
||||||
test("the action exposes only the master key and scopes it to preparation", async () => {
|
test("the action exposes only the master key and scopes it to preparation", async () => {
|
||||||
const action = await yaml("action.yml");
|
const action = await yaml("action.yml");
|
||||||
expect(Object.keys(mapping(action.inputs, "inputs"))).toStrictEqual(["master-key"]);
|
expect(Object.keys(mapping(action["inputs"], "inputs"))).toStrictEqual(["master-key"]);
|
||||||
const steps = sequence(mapping(action.runs, "runs").steps, "runs.steps");
|
const steps = sequence(mapping(action["runs"], "runs")["steps"], "runs.steps");
|
||||||
for (const step of steps) {
|
for (const step of steps) {
|
||||||
if (typeof step.run === "string") {
|
if (typeof step["run"] === "string") {
|
||||||
expect(step.run.includes("\n"), String(step.name)).toBe(false);
|
expect(step["run"].includes("\n"), String(step["name"])).toBe(false);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
const checkout = findStep(steps, "uses", "actions/checkout@v4");
|
const checkout = findStep(steps, "uses", "actions/checkout@v4");
|
||||||
@@ -59,16 +59,16 @@ test("the action exposes only the master key and scopes it to preparation", asyn
|
|||||||
const agent = findStep(steps, "id", "agent");
|
const agent = findStep(steps, "id", "agent");
|
||||||
const post = findStep(steps, "id", "post");
|
const post = findStep(steps, "id", "post");
|
||||||
findStep(steps, "id", "source");
|
findStep(steps, "id", "source");
|
||||||
expect(mapping(checkout.with, "checkout.with").token).toBe("${{ gitea.token }}");
|
expect(mapping(checkout["with"], "checkout.with")["token"]).toBe("${{ gitea.token }}");
|
||||||
expect(mapping(prepare.env, "prepare.env").BOT_AGENTS_MASTER_KEY).toBe(
|
expect(mapping(prepare["env"], "prepare.env")["BOT_AGENTS_MASTER_KEY"]).toBe(
|
||||||
"${{ inputs.master-key }}",
|
"${{ inputs.master-key }}",
|
||||||
);
|
);
|
||||||
expect(JSON.stringify(agent).includes("BOT_AGENTS_MASTER_KEY")).toBe(false);
|
expect(JSON.stringify(agent).includes("BOT_AGENTS_MASTER_KEY")).toBe(false);
|
||||||
expect(JSON.stringify(post).includes("BOT_AGENTS_MASTER_KEY")).toBe(false);
|
expect(JSON.stringify(post).includes("BOT_AGENTS_MASTER_KEY")).toBe(false);
|
||||||
expect(mapping(agent.env, "agent.env").GITEA_TOKEN).toBe("${{ gitea.token }}");
|
expect(mapping(agent["env"], "agent.env")["GITEA_TOKEN"]).toBe("${{ gitea.token }}");
|
||||||
assert(String(post.if).includes("always()"));
|
assert(String(post["if"]).includes("always()"));
|
||||||
for (const step of [prepare, agent, post]) {
|
for (const step of [prepare, agent, post]) {
|
||||||
assert(String(step.run).includes("steps.source.outputs.path"));
|
assert(String(step["run"]).includes("steps.source.outputs.path"));
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -76,18 +76,21 @@ test("the source protection script stages immutable action files", async () => {
|
|||||||
const temp = await makeTempDir();
|
const temp = await makeTempDir();
|
||||||
const outputFile = `${temp}/output`;
|
const outputFile = `${temp}/output`;
|
||||||
try {
|
try {
|
||||||
const result = await output("/bin/bash", {
|
const result = await runCommand("/bin/bash", ["scripts/protect-source.sh"], {
|
||||||
args: ["scripts/protect-source.sh"],
|
...process.env,
|
||||||
env: { ACTION_PATH: process.cwd(), GITHUB_OUTPUT: outputFile, RUNNER_TEMP: temp },
|
ACTION_PATH: process.cwd(),
|
||||||
stderr: "piped",
|
GITHUB_OUTPUT: outputFile,
|
||||||
|
RUNNER_TEMP: temp,
|
||||||
});
|
});
|
||||||
assert(result.success, new TextDecoder().decode(result.stderr));
|
assert(result.success, result.stderr);
|
||||||
|
|
||||||
const path = (await readFile(outputFile, "utf8")).trim().slice(5);
|
const path = (await readFile(outputFile, "utf8")).trim().slice(5);
|
||||||
const files = [
|
const files = [
|
||||||
"src/prepare.ts",
|
"src/prepare/index.ts",
|
||||||
"src/run.ts",
|
"src/run/index.ts",
|
||||||
"src/post.ts",
|
"src/post/index.ts",
|
||||||
|
"src/runtime/index.ts",
|
||||||
|
"src/agents/auth.ts",
|
||||||
"package.json",
|
"package.json",
|
||||||
"profiles.json",
|
"profiles.json",
|
||||||
"prompt.md",
|
"prompt.md",
|
||||||
@@ -103,7 +106,7 @@ test("the source protection script stages immutable action files", async () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
test("module-relative runtime assets exist", async () => {
|
test("module-relative runtime assets exist", async () => {
|
||||||
const module = new URL("../src/run.ts", import.meta.url);
|
const module = new URL("../src/run/index.ts", import.meta.url);
|
||||||
const source = await readFile(module, "utf8");
|
const source = await readFile(module, "utf8");
|
||||||
const assets = [...source.matchAll(/new URL\("([^"]+)", import\.meta\.url\)/gu)].map(
|
const assets = [...source.matchAll(/new URL\("([^"]+)", import\.meta\.url\)/gu)].map(
|
||||||
([, asset = ""]) => new URL(asset, module),
|
([, asset = ""]) => new URL(asset, module),
|
||||||
@@ -116,17 +119,17 @@ test("module-relative runtime assets exist", async () => {
|
|||||||
|
|
||||||
test("the repository uses its trusted main action", async () => {
|
test("the repository uses its trusted main action", async () => {
|
||||||
const workflow = await yaml(".gitea/workflows/agents.yml");
|
const workflow = await yaml(".gitea/workflows/agents.yml");
|
||||||
const job = mapping(mapping(workflow.jobs, "jobs").agent, "jobs.agent");
|
const job = mapping(mapping(workflow["jobs"], "jobs")["agent"], "jobs.agent");
|
||||||
const permissions = mapping(job.permissions, "jobs.agent.permissions");
|
const permissions = mapping(job["permissions"], "jobs.agent.permissions");
|
||||||
expect(permissions).toStrictEqual({
|
expect(permissions).toStrictEqual({
|
||||||
code: "write",
|
code: "write",
|
||||||
issues: "write",
|
issues: "write",
|
||||||
"pull-requests": "write",
|
"pull-requests": "write",
|
||||||
});
|
});
|
||||||
const steps = sequence(job.steps, "jobs.agent.steps");
|
const steps = sequence(job["steps"], "jobs.agent.steps");
|
||||||
expect(steps.findIndex((step) => step.uses === "./")).toStrictEqual(-1);
|
expect(steps.findIndex((step) => step["uses"] === "./")).toStrictEqual(-1);
|
||||||
const trusted = findStep(steps, "uses", "https://git.capsulizers.com/commons/bot-agents@main");
|
const trusted = findStep(steps, "uses", "https://git.capsulizers.com/commons/bot-agents@main");
|
||||||
expect(mapping(trusted.with, "trusted.with")["master-key"]).toBe(
|
expect(mapping(trusted["with"], "trusted.with")["master-key"]).toBe(
|
||||||
"${{ secrets.BOT_AGENTS_MASTER_KEY }}",
|
"${{ secrets.BOT_AGENTS_MASTER_KEY }}",
|
||||||
);
|
);
|
||||||
expect(JSON.stringify(workflow).includes("gitea.actor != 'bot'")).toBe(true);
|
expect(JSON.stringify(workflow).includes("gitea.actor != 'bot'")).toBe(true);
|
||||||
@@ -134,9 +137,9 @@ test("the repository uses its trusted main action", async () => {
|
|||||||
|
|
||||||
test("CI checks every phase and the root isolation suite", async () => {
|
test("CI checks every phase and the root isolation suite", async () => {
|
||||||
const workflow = await yaml(".gitea/workflows/check.yml");
|
const workflow = await yaml(".gitea/workflows/check.yml");
|
||||||
const job = mapping(mapping(workflow.jobs, "jobs").check, "jobs.check");
|
const job = mapping(mapping(workflow["jobs"], "jobs")["check"], "jobs.check");
|
||||||
const commands = sequence(job.steps, "jobs.check.steps")
|
const commands = sequence(job["steps"], "jobs.check.steps")
|
||||||
.map((step) => (typeof step.run === "string" ? step.run : ""))
|
.map((step) => (typeof step["run"] === "string" ? step["run"] : ""))
|
||||||
.join("\n");
|
.join("\n");
|
||||||
// `vp check` type-checks every phase, and `vp test` runs each of them under
|
// `vp check` type-checks every phase, and `vp test` runs each of them under
|
||||||
// Node as well as the root-only isolation tests.
|
// Node as well as the root-only isolation tests.
|
||||||
@@ -146,11 +149,11 @@ test("CI checks every phase and the root isolation suite", async () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
test("uses the standard Skills installer without custom discovery", async () => {
|
test("uses the standard Skills installer without custom discovery", async () => {
|
||||||
const runner = await readFile("src/run.ts", "utf8");
|
const runner = await readFile("src/run/index.ts", "utf8");
|
||||||
assert(runner.includes("skills add obra/superpowers"));
|
assert(runner.includes("skills add obra/superpowers"));
|
||||||
const removed = await stat("superpowers.ts").then(
|
const removed = await stat("superpowers.ts").then(
|
||||||
() => false,
|
() => false,
|
||||||
(error: unknown) => isNotFound(error),
|
(error: unknown) => error instanceof Error && "code" in error && error.code === "ENOENT",
|
||||||
);
|
);
|
||||||
assert(removed, "superpowers.ts should be removed");
|
assert(removed, "superpowers.ts should be removed");
|
||||||
});
|
});
|
||||||
@@ -160,16 +163,21 @@ test("installs the OpenCode CLI", async () => {
|
|||||||
assert(action.includes("opencode-ai"));
|
assert(action.includes("opencode-ai"));
|
||||||
});
|
});
|
||||||
|
|
||||||
|
test("does not install Deno", async () => {
|
||||||
|
const action = await readFile("action.yml", "utf8");
|
||||||
|
expect(action).not.toMatch(/\bdeno\b/iu);
|
||||||
|
});
|
||||||
|
|
||||||
test("profile preparation does not receive provider credentials", async () => {
|
test("profile preparation does not receive provider credentials", async () => {
|
||||||
const runner = await readFile("src/run.ts", "utf8");
|
const runner = await readFile("src/run/index.ts", "utf8");
|
||||||
assert(runner.includes("await prepareProfile(profile);"));
|
assert(runner.includes("await prepareProfile(profile);"));
|
||||||
expect(runner.includes("prepareProfile(profile, token)")).toBe(false);
|
expect(runner.includes("prepareProfile(profile, token)")).toBe(false);
|
||||||
});
|
});
|
||||||
|
|
||||||
test("central profiles fall back from Codex to Claude to OpenCode", async () => {
|
test("central profiles fall back from Codex to Claude to OpenCode", async () => {
|
||||||
const credentials: unknown = JSON.parse(await readFile("profiles.json", "utf8"));
|
const credentials: unknown = JSON.parse(await readFile("profiles.json", "utf8"));
|
||||||
const profiles = sequence(mapping(credentials, "profiles.json").profiles, "profiles");
|
const profiles = sequence(mapping(credentials, "profiles.json")["profiles"], "profiles");
|
||||||
expect(profiles.map((profile) => profile.type)).toStrictEqual(["codex", "claude", "opencode"]);
|
expect(profiles.map((profile) => profile["type"])).toStrictEqual(["codex", "claude", "opencode"]);
|
||||||
expect(profiles[2]?.model).toBe("openrouter/qwen/qwen3.8-27b");
|
expect(profiles[2]?.["model"]).toBe("openrouter/qwen/qwen3.8-27b");
|
||||||
assert(String(profiles[2]?.token).startsWith("v1:"));
|
assert(String(profiles[2]?.["token"]).startsWith("v1:"));
|
||||||
});
|
});
|
||||||
|
|||||||
+1
-1
@@ -9,8 +9,8 @@
|
|||||||
"erasableSyntaxOnly": true,
|
"erasableSyntaxOnly": true,
|
||||||
"verbatimModuleSyntax": true,
|
"verbatimModuleSyntax": true,
|
||||||
"strict": true,
|
"strict": true,
|
||||||
"exactOptionalPropertyTypes": true,
|
|
||||||
"noUncheckedIndexedAccess": true,
|
"noUncheckedIndexedAccess": true,
|
||||||
|
"noPropertyAccessFromIndexSignature": true,
|
||||||
"noImplicitOverride": true,
|
"noImplicitOverride": true,
|
||||||
"noImplicitReturns": true,
|
"noImplicitReturns": true,
|
||||||
"noFallthroughCasesInSwitch": true,
|
"noFallthroughCasesInSwitch": true,
|
||||||
|
|||||||
+13
-9
@@ -1,20 +1,24 @@
|
|||||||
|
import explicitTypes from "eslint-plugin-explicit-types";
|
||||||
|
import importStructure from "eslint-plugin-import-structure";
|
||||||
import { defineConfig } from "vite-plus";
|
import { defineConfig } from "vite-plus";
|
||||||
|
|
||||||
import projectLint from "./scripts/project-lint.ts";
|
import projectLint from "./scripts/project-lint.ts";
|
||||||
|
|
||||||
export default defineConfig({
|
export default defineConfig({
|
||||||
// Keep package.json in its hand-written order.
|
|
||||||
fmt: { sortPackageJson: false },
|
|
||||||
lint: {
|
lint: {
|
||||||
plugins: ["typescript", "unicorn", "oxc", "import"],
|
plugins: ["typescript", "unicorn", "oxc", "import"],
|
||||||
jsPlugins: ["./scripts/project-lint.ts"],
|
jsPlugins: [
|
||||||
categories: { correctness: "error", suspicious: "error", pedantic: "error", perf: "error" },
|
"eslint-plugin-explicit-types",
|
||||||
rules: projectLint.configs.project.rules,
|
"eslint-plugin-import-structure",
|
||||||
// Repo tooling, not app code: the lint plugin compares AST node `type`s,
|
"./scripts/project-lint.ts",
|
||||||
// which the AST types declare as an enum.
|
|
||||||
overrides: [
|
|
||||||
{ files: ["scripts/**"], rules: { "typescript/no-unsafe-enum-comparison": "off" } },
|
|
||||||
],
|
],
|
||||||
|
categories: { correctness: "error", suspicious: "error", pedantic: "error", perf: "error" },
|
||||||
|
rules: {
|
||||||
|
...explicitTypes.configs.concrete.rules,
|
||||||
|
...explicitTypes.configs.absence.rules,
|
||||||
|
...importStructure.configs.modules.rules,
|
||||||
|
...projectLint.configs.project.rules,
|
||||||
|
},
|
||||||
options: {
|
options: {
|
||||||
typeAware: true,
|
typeAware: true,
|
||||||
typeCheck: true,
|
typeCheck: true,
|
||||||
|
|||||||
Reference in New Issue
Block a user