mirror of
https://github.com/Ark0N/Codeman.git
synced 2026-11-14 02:29:33 +01:00
Every run mode is now a `CliEntry` in `src/config/cli-registry/` — discovery (search dirs, version + identity probes), the launch argv template, env handling, the `capabilities` flags that replace per-CLI branching, and the `overlays` that back the remote/docker pane commands. Code that used to ask "which CLI is this?" reads the entry instead. Behaviour is unchanged. `test/cli-registry-spawn-golden.test.ts` pins every spawn command as a literal string, captured from the hand-written builders before they were deleted, and `test/location-overlay-commands.test.ts` does the same for all 20 remote and in-container pane commands. Config can never contain shell text: an entry declares typed argv tokens, literals are validated against a safe-word pattern at LOAD time (a bad literal rejects the whole entry — a silently dropped `--no-approve` is not cosmetic), and values resolve through patterns NAMED in code, so a user `clis.json` cannot widen its own validation. `~/.codeman/clis.json` overrides any entry, read-only in this release. OMP is included as a registry entry rather than a tenth hand-written builder, so `buildOmpCommand()`, the omp availability pre-flight, the omp arm of `buildPathExport()` and the omp entries in the truecolor/NO_COLOR, alt-screen and doctor ladders all drop out. Guard rails: - `test/cli-registry-no-id-branching.test.ts` fails the build if per-CLI-id branching reappears outside `stock.ts`, in any of its four shapes (`===`, `!==`, `switch`/`case`, `includes`) — an `===`-only version would miss the negated forms, which is how 36 of them survived an earlier pass. Every allowlisted branch carries its reason. - `external`, `hooks` and `altScreen` stay three INDEPENDENT capabilities; deriving one from another shipped the `until=stop`-hangs-on-shell bug. - `param` is two namespaces. `launch.params` keys, `configSetenv.fromParam` and `privilegedParams[].param` all name a LAUNCH param; the legacy `<Mode>Config` wire field is separate, bridged only by `legacyConfigAliases`. Getting `privilegedParams[].param` wrong is SILENT — it is the multi-user bypass clamp's only handle on a CLI's privilege switch, and a wrong name clamps nothing with no error and no failing test — so `schema.ts` rejects an entry naming a param it never declared. - Registry data resolves AT CALL TIME (`sessionModeSchema()`, `allowedEnvPrefixes()`, `dependencyRegistry()`, the resolvers' `searchDirs` thunks). A module-level const freezes at first import, so a CLI enabled while the server ran moved the run menu but not that surface. - Six fields are annotated DECLARED-FOR-LATER and read by nothing (`shortBadge`, `accent`, `capabilities.echo`/`wheelForward`/ `keyboardAccessory`/`maxFrameBytes`): all frontend behaviour, transcribed rather than measured. A test pins the list so it cannot quietly grow. Three user-visible changes, all deliberate and named: - `probeDockerCliVersion()` derives the in-container binary from the registry rather than assuming it equals the mode name (`antigravity` runs `agy`). - The remote CLI version probe now covers grok and deepseek, which the hardcoded map it replaces omitted while its own comment said the rule was "every mode except shell". - `codeman doctor`'s CLI rows are generated from the entries, so Claude's install hint is the install command rather than a docs URL, five CLIs gain hints they never had, and the row order follows the catalog. Also hardened along the way: `sessionModeSchema()` is bounded at 24 chars (matching the `cliId` pattern) before its failure message quotes the value back, and `deepMerge` skips `__proto__`/`constructor`/`prototype` when reading the hand-editable `clis.json`. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WQkoi1cNegqVwZHgzx5SbJ
140 lines
5.2 KiB
TypeScript
140 lines
5.2 KiB
TypeScript
/**
|
|
* @fileoverview Resolve the OMP CLI binary across common install paths.
|
|
*
|
|
* Uses the shared `createCliExecutableResolver` (cli-executable-resolver.ts),
|
|
* same as the sibling claude/opencode/codex/gemini/antigravity/pi resolvers:
|
|
* server process PATH first, then common install directories, then — last,
|
|
* because it is the only step that spawns anything — an interactive login
|
|
* shell, which is what finds nvm/Homebrew/user-npm installs when Codeman runs
|
|
* as a systemd/launchd service with a minimal PATH.
|
|
*
|
|
* Provides an augmented PATH directory for tmux sessions.
|
|
*
|
|
* @module utils/omp-cli-resolver
|
|
*/
|
|
|
|
import { execFileSync } from 'node:child_process';
|
|
import { EXEC_TIMEOUT_MS } from '../config/exec-timeout.js';
|
|
import { getCli } from '../config/cli-registry/registry.js';
|
|
import { expandHome } from './cli-resolver.js';
|
|
import {
|
|
createCliExecutableResolver,
|
|
formatCliNotFoundMessage,
|
|
type CliResolverHost,
|
|
} from './cli-executable-resolver.js';
|
|
|
|
/**
|
|
* Directories probed after `which`, read from this CLI's registry entry so the spawn
|
|
* path, `codeman doctor` and this resolver cannot disagree about where to look.
|
|
* `~` is expanded by `expandHome`; nothing else is interpreted.
|
|
*
|
|
* `~/.local/bin` still leads, for the reason it always did: omp.sh's installer targets it
|
|
* with no `--dir` override (verified against a real `--no-cache` docker build), while
|
|
* `~/.omp/bin` was an unverified guess that turned out wrong and is kept as a fallback.
|
|
*/
|
|
const OMP_SEARCH_DIRS = (): string[] => (getCli('omp')?.discovery.searchDirs ?? []).map(expandHome);
|
|
|
|
/**
|
|
* A real `omp --version` prints `omp/<semver>` (e.g. `omp/17.4.0`).
|
|
*
|
|
* Shape mirrors PI_VERSION_REGEX: a capturing group and a leading boundary so
|
|
* `omp/17.4.0` matches while an unrelated `omp` (some other program) does not.
|
|
*/
|
|
export const OMP_VERSION_REGEX = /(?:^|\s)omp\/(\d+\.\d+\.\d+)/;
|
|
|
|
const OMP_NOT_FOUND = 'OMP CLI not found. Install with: curl -fsSL https://omp.sh/install | sh';
|
|
|
|
/**
|
|
* Run `omp --version` on a candidate path and return the trimmed version when
|
|
* it looks like the coding agent. Returns null for anything else — a missing
|
|
* binary, a non-zero exit, a hang (timeout), or output that is not
|
|
* `omp/<semver>`-shaped (which is how an unrelated `omp` on PATH gets rejected).
|
|
*
|
|
* Never runs under vitest: the suites must stay hermetic and must not depend on
|
|
* whether the dev box happens to have omp installed. The shared resolver host
|
|
* is already inert under vitest, so this gate is defense in depth for any
|
|
* opted-in host that still carries the default probe.
|
|
*/
|
|
function probeOmpVersion(binPath: string): string | null {
|
|
if (process.env.VITEST) return null;
|
|
try {
|
|
const out = execFileSync(binPath, ['--version'], {
|
|
encoding: 'utf-8',
|
|
timeout: EXEC_TIMEOUT_MS,
|
|
stdio: ['ignore', 'pipe', 'ignore'],
|
|
// A stuck or hostile `omp` that ignores SIGTERM would survive the timeout
|
|
// and block the server (execFileSync keeps waiting after the signal).
|
|
killSignal: 'SIGKILL',
|
|
}).trim();
|
|
const candidate = OMP_VERSION_REGEX.exec(out)?.[1];
|
|
if (candidate) return candidate;
|
|
console.warn(`[OmpResolver] Ignoring ${binPath}: "omp --version" printed ${JSON.stringify(out.slice(0, 80))}`);
|
|
} catch (err) {
|
|
console.warn(`[OmpResolver] Ignoring ${binPath}: "omp --version" failed (${(err as Error).message})`);
|
|
}
|
|
return null;
|
|
}
|
|
|
|
type OmpVersionProbe = (binPath: string) => string | null;
|
|
|
|
function createOmpResolver(
|
|
host?: CliResolverHost,
|
|
versionProbe: OmpVersionProbe = probeOmpVersion,
|
|
now?: () => number
|
|
) {
|
|
return createCliExecutableResolver<string>(
|
|
{
|
|
binary: 'omp',
|
|
searchDirs: OMP_SEARCH_DIRS,
|
|
validateCandidate: (binPath) => {
|
|
const version = versionProbe(binPath);
|
|
return version ? { accepted: true, metadata: version } : { accepted: false };
|
|
},
|
|
now,
|
|
},
|
|
host
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Creates an isolated OMP wrapper around an injected host, version probe and
|
|
* clock. Omitting `versionProbe` keeps the ambient (VITEST-gated) probe, which
|
|
* is exactly what the hermeticity test exercises.
|
|
*/
|
|
export function createOmpResolverForTest(host: CliResolverHost, versionProbe?: OmpVersionProbe, now?: () => number) {
|
|
return createOmpResolver(host, versionProbe ?? probeOmpVersion, now);
|
|
}
|
|
|
|
const ompResolver = createOmpResolver();
|
|
|
|
/**
|
|
* Finds the directory containing a verified `omp` binary.
|
|
* Checks `which omp` first, then falls back to common install locations. Every
|
|
* candidate must pass the `omp --version` sanity probe before it is accepted.
|
|
*
|
|
* @returns Directory path, or null if not found
|
|
*/
|
|
export function resolveOmpDir(): string | null {
|
|
return ompResolver.resolve()?.directory ?? null;
|
|
}
|
|
|
|
/**
|
|
* Check if the OMP CLI is available on the system.
|
|
*/
|
|
export function isOmpAvailable(): boolean {
|
|
return resolveOmpDir() !== null;
|
|
}
|
|
|
|
export function getOmpNotFoundMessage(): string {
|
|
return formatCliNotFoundMessage(OMP_NOT_FOUND, ompResolver.diagnostics());
|
|
}
|
|
|
|
/**
|
|
* Version reported by the resolved `omp` binary, or null when omp is
|
|
* unavailable. Surfaced through `GET /api/omp/status` so a misresolution is
|
|
* diagnosable from the UI.
|
|
*/
|
|
export function getOmpCliVersion(): string | null {
|
|
return ompResolver.resolve()?.metadata ?? null;
|
|
}
|