@bitkyc08/opencodex
Version:
Universal provider proxy for OpenAI Codex & Claude Code — use any LLM with Codex CLI/App/SDK and Claude Code
1,225 lines • 58 kB
text/typescript
import { randomUUID } from "node:crypto";
import { beginCodexCliSelectionParentWrite, withCodexCliSelectionParentWriteAsync, CodexCliSelectionMutationBusyError } from "./cli-update-selection-gate";
import {
existsSync,
lstatSync,
readFileSync,
writeFileSync,
} from "node:fs";
import { delimiter, join, posix, win32 } from "node:path";
import { durableBunRuntime, type DurableBunRuntime } from "../lib/bun-runtime";
import type { FileIdentity } from "../lib/file-identity";
import { assertSelectedRuntimeWritable, RuntimePreflightError, type RuntimePreflightDeps } from "../lib/bun-runtime-preflight";
import { getConfigDir } from "../config";
import { isWslRuntime, wslAutomountRoot } from "./home";
import { truncateRetainedUtf8 } from "../lib/admission";
import { SHIM_MARKER, UNIX_SHIM_REVISION_MARKER } from "./shim-templates";
import {
hasUsableBackingPath,
isCurrentShimProbe,
isCurrentUnixShimProbe,
isHealthyShimProbe,
isVersionManagerOwnedCodexPath,
restoreWithoutReplacing,
sameFingerprint,
sameFingerprintAfterRename,
sameStableShimPathProbe,
shimPathFingerprint,
stableShimPathProbe,
type ShimPathFingerprint,
type StableShimPathProbe,
} from "./shim-fingerprint";
import {
fileErrorCode,
readStateResult,
stateFiles,
statePath,
writeState,
type ShimFileState,
type ShimState,
} from "./shim-state-file";
import {
CODEX_SHIM_INSTALL_PROBE_TIMEOUT_MS,
MAX_DIAGNOSTIC_VALUE_BYTES,
probeUnixShimFiles,
type UnixShimProbeResult,
} from "./shim-probe";
import { tryAcquireShimRestoreLock } from "./shim-restore-lock";
import { refreshAdmittedWindowsShims, refreshObsoleteWindowsShim } from "./shim-windows-refresh";
import {
isWindowsInteropDir,
isExecutableCodexCandidate,
inspectShimFile,
realIsDirectory,
resolveStableFnmCodexPath,
type CodexPathScanDeps,
} from "./shim-path-resolution";
import { ownedWrapperFingerprint, windowsShimContent, wrapperInodeIsOurs, writeShim } from "./shim-wrapper-write";
import {
checkLegacyShimRecord,
hostShimPathApi,
guardedRenameSync as renameSync,
guardedUnlinkSync as unlinkSync,
legacyShimBackupPath,
legacyShimDirectoryUnchanged,
legacyShimFilesProblem,
legacyShimFreshLaunchersProblem,
legacyShimManualRestoreMessage,
setLegacyShimMutationGuard,
} from "./shim-legacy-record";
export { buildUnixCodexShim, buildWindowsCodexShim, buildWindowsPowerShellCodexShim } from "./shim-templates";
export { isVersionManagerOwnedCodexPath } from "./shim-fingerprint";
export { CODEX_SHIM_STATE_MAX_BYTES } from "./shim-state-file";
export { setCodexShimProbeHookForTests, setCodexShimProbeShellForTests, setCodexShimProbeObservationMsForTests } from "./shim-probe";
export type { CodexShimBackingForCommand } from "./shim-inspect";
export type { CodexPathScanDeps } from "./shim-path-resolution";
export { isWindowsInteropDir } from "./shim-path-resolution";
export { isLocalAbsoluteInspectionPath, inspectCodexShimBackingForCommand } from "./shim-inspect";
import { isShim, diagnoseCodexShim } from "./shim-diagnostics";
import { installUnixOverlay, autoRestoreUnixOverlay, uninstallUnixCodexShim, overlayPaths } from "./shim-overlay";
export { diagnoseCodexShim, codexShimStatus, type CodexShimDiagnostic } from "./shim-diagnostics";
export const CODEX_SHIM_REPLACEMENT_STABLE_MS = 100;
let lastShimDiscoveryError: string | null = null;
/** Last human-readable reason discovery returned null (exposed for doctor/tests). */
export function lastCodexDiscoveryError(): string | null {
return lastShimDiscoveryError;
}
interface InstallCodexShimInternalOptions extends RuntimePreflightDeps {
runtime?: DurableBunRuntime;
runtimeAdmitted?: boolean;
expectedReplacements?: ReadonlyMap<string, ShimPathFingerprint>;
allowFreshInstall: boolean;
beforeGuardedRefresh?: (wrapperPath: string, index: number) => void;
}
function discoveredCodexPath(path: string, posixPaths: boolean, realpath?: (path: string) => string): string | null {
const resolved = resolveStableFnmCodexPath(path, posixPaths, realpath);
if (resolved !== null) return resolved;
lastShimDiscoveryError = truncateRetainedUtf8(
`Found codex at ${path} inside fnm's temporary multishell path, but it did not resolve to a durable Node installation. `
+ "Refusing to install a shim; retry after fnm selects a stable installation.",
MAX_DIAGNOSTIC_VALUE_BYTES,
);
return null;
}
export type CodexShimAutoRestoreResult =
| { status: "not-installed" | "healthy" | "disabled" }
| { status: "ineligible" | "deferred"; message?: string }
| { status: "restored"; message: string };
function commandNames(name: string): string[] {
if (process.platform !== "win32") return [name];
const exts = (process.env.PATHEXT ?? ".COM;.EXE;.BAT;.CMD;.PS1").split(";").filter(Boolean);
return [name, ...exts.flatMap(ext => [`${name}${ext.toLowerCase()}`, `${name}${ext.toUpperCase()}`])];
}
export function findCodexOnPath(deps: CodexPathScanDeps = {}): string | null {
lastShimDiscoveryError = null;
const exists = deps.exists ?? existsSync;
const shimFile = deps.isShimFile ?? (process.platform === "win32" ? isShim : (path: string) => inspectShimFile(path) !== false);
const isDir = deps.isDirectory ?? realIsDirectory;
const eligible = deps.executableEligible ?? (deps.exists ? () => true : isExecutableCodexCandidate);
const wsl = deps.wsl ?? (process.platform === "linux" && isWslRuntime());
const usePosix = deps.posixPaths ?? (wsl || process.platform !== "win32");
// The injected path flavour governs join and separator alike; host-native `join` and
// `delimiter` made a Windows-flavoured scan split `C:\...` on a Linux host.
const joinPath = usePosix ? posix.join : win32.join;
const pathSep = usePosix ? ":" : win32.delimiter;
const automountRoot = deps.automountRoot ?? (wsl ? wslAutomountRoot() : "/mnt");
// Windows npm prefixes ship codex.exe/codex.cmd next to the extensionless sh launcher.
const interopNames = ["codex", "codex.exe", "codex.cmd", "codex.ps1"];
let skippedInterop: string | null = null;
for (const dir of (deps.pathValue ?? process.env.PATH ?? "").split(pathSep).filter(Boolean)) {
if (wsl && isWindowsInteropDir(dir, automountRoot)) {
// A Windows-side codex reached through WSL PATH interop: a Unix shim written
// here would embed WSL-only paths and break every Windows-side invocation.
if (!skippedInterop) {
for (const name of interopNames) {
const path = joinPath(dir, name);
if (exists(path) && !shimFile(path) && !isDir(path)) { skippedInterop = path; break; }
}
}
continue;
}
// Interop dirs carry Windows launcher names even when the scan is not skipping them.
const names = isWindowsInteropDir(dir, automountRoot) ? interopNames : commandNames("codex");
for (const name of names) {
const path = joinPath(dir, name);
if (!exists(path)) continue;
if (usePosix && (path === overlayPaths().wrapper || !eligible(path))) continue;
if (shimFile(path)) continue;
if (!isDir(path)) {
const resolved = discoveredCodexPath(path, usePosix, deps.realpath);
if (resolved !== null) return resolved;
return null;
}
}
}
if (skippedInterop) {
lastShimDiscoveryError = truncateRetainedUtf8(
`Found a Windows codex at ${skippedInterop} via WSL PATH interop, but no Linux-side codex. ` +
"Refusing to shim a Windows launcher from WSL (a WSL shim breaks Windows invocations). " +
"Install codex inside WSL (npm i -g @openai/codex), or run 'ocx ensure' from Windows to shim the Windows side.",
MAX_DIAGNOSTIC_VALUE_BYTES,
);
}
return null;
}
function findWindowsCodexTargets(): ShimFileState[] | null {
lastShimDiscoveryError = null;
for (const dir of (process.env.PATH ?? "").split(delimiter).filter(Boolean)) {
const exe = join(dir, "codex.exe");
const stableExe = existsSync(exe) && !isShim(exe) ? discoveredCodexPath(exe, false) : exe;
if (stableExe === null) return null;
if (existsSync(stableExe) && !isShim(stableExe)) {
try {
if (!lstatSync(stableExe).isDirectory()) {
lastShimDiscoveryError = truncateRetainedUtf8(
`Found codex.exe at ${stableExe}. Refusing to rename a real .exe because exact codex.exe invocations would break; ` +
"install a codex.cmd/codex.ps1 launcher or use `ocx service install` for autostart.",
MAX_DIAGNOSTIC_VALUE_BYTES,
);
return null;
}
} catch { /* keep scanning */ }
}
const cmd = join(dir, "codex.cmd");
const ps1 = join(dir, "codex.ps1");
// npm also installs an extensionless `codex` sh launcher for Git-Bash/MSYS shells;
// leaving it unshimmed means Git-Bash users silently get no autostart.
const gitBashLauncher = join(dir, "codex");
const targets: ShimFileState[] = [];
for (const path of [cmd, ps1, gitBashLauncher]) {
if (!existsSync(path) || isShim(path)) continue;
const stablePath = discoveredCodexPath(path, false);
if (stablePath === null) return null;
if (!existsSync(stablePath) || isShim(stablePath)) continue;
try {
if (!lstatSync(stablePath).isDirectory()) {
targets.push({ wrapperPath: stablePath, originalPath: stablePath, backupPath: backupPathFor(stablePath) });
}
} catch { /* keep scanning */ }
}
if (targets.length > 0) return targets;
}
return null;
}
function backupPathFor(path: string): string {
return legacyShimBackupPath(path);
}
/**
* Why auto-restore refused, in the operator's own terms. Auto-restore used to
* return a bare `{ status: "ineligible" }`, and the CLI warns only when a
* message is present, so `ocx start`, `ocx ensure`, and `ocx service repair` all
* reported success while routing quietly stayed native (#2412, the cause behind
* the misleading green status in #2411).
*/
function destroyedShimMessage(file: ShimFileState): string {
const wrapper = existsSync(file.wrapperPath)
? stableShimPathProbe(file.wrapperPath)?.prefix.includes(SHIM_MARKER) ? "present but unusable" : "present but not an opencodex shim"
: "missing";
const backup = existsSync(file.backupPath) ? "present" : "missing";
const base = `Codex autostart shim not restored: wrapper ${wrapper} at ${file.wrapperPath}; original backup ${backup} at ${file.backupPath}.`;
if (!isVersionManagerOwnedCodexPath(file.wrapperPath)) {
return `${base} Re-run 'ocx codex-shim install' once the Codex binary is stable.`;
}
return `${base} This Codex binary is owned by a version manager (mise/asdf/volta), so opencodex will not wrap it as a new original — the next upgrade would overwrite the shim and its backup again. Route through Codex instead with 'ocx start', and use 'ocx service install' for autostart.`;
}
let codexShimGuardedWriteHookForTests: (() => void) | null = null;
let codexShimFreshWriteHookForTests: (() => void) | null = null;
let codexShimRollbackRestoreHookForTests: ((target: ShimFileState) => void) | null = null;
/** Narrow deterministic seam for guarded partial-write rollback tests. */
export function setCodexShimGuardedWriteHookForTests(hook: (() => void) | null): void {
codexShimGuardedWriteHookForTests = hook;
}
/** Narrow deterministic seam for fresh-install partial-write rollback tests. */
export function setCodexShimFreshWriteHookForTests(hook: (() => void) | null): void {
codexShimFreshWriteHookForTests = hook;
}
/**
* @internal Test-only seam for the rollback restore race.
*
* The window this closes opens after `sourceOccupied` is sampled and closes when
* the backup is republished, so no earlier hook can reach it: publishing from
* the fresh-write hook makes `sourceOccupied` true and skips the restore
* entirely.
*/
export function setCodexShimRollbackRestoreHookForTests(
hook: ((target: ShimFileState) => void) | null,
): void {
codexShimRollbackRestoreHookForTests = hook;
}
interface FreshShimInstallJournalEntry {
target: ShimFileState;
movedOriginalFingerprint?: ShimPathFingerprint;
originalMovedToBackup: boolean;
writtenWrapperFingerprint?: ShimPathFingerprint;
wrapperWriteStarted: boolean;
/** dev/ino of the file our `writeShim()` created, recorded before anything can fail. */
writtenWrapperInode?: FileIdentity;
}
function rollbackFreshShimInstall(journal: readonly FreshShimInstallJournalEntry[]): void {
const errors: Error[] = [];
for (const entry of [...journal].reverse()) {
const target = entry.target;
let sourceOccupied = false;
let ownsWrapperNow = false;
try {
const wrapper = stableShimPathProbe(target.wrapperPath);
// Ownership is the inode our own write created. There is no marker-text
// fallback: the markers are public, so a concurrent updater's wrapper carries
// them too, and treating that as proof is how we would delete a file we never
// wrote. An in-place truncation of our file keeps the inode and is still ours
// to clean up; a replacement renamed over it has a different inode and is not.
const ownsWrapper = !target.preserveOnly
&& entry.wrapperWriteStarted
&& wrapper !== null
&& wrapperInodeIsOurs(wrapper, entry.writtenWrapperInode, entry.writtenWrapperFingerprint);
ownsWrapperNow = ownsWrapper;
if (ownsWrapper) unlinkSync(target.wrapperPath);
else {
try {
lstatSync(target.originalPath);
sourceOccupied = true;
} catch (error) {
if (fileErrorCode(error) !== "ENOENT") sourceOccupied = true;
}
}
} catch (error) {
errors.push(error instanceof Error ? error : new Error(String(error)));
}
try {
if (entry.originalMovedToBackup && existsSync(target.backupPath)) {
const movedOriginal = shimPathFingerprint(target.backupPath);
if (!movedOriginal || !entry.movedOriginalFingerprint
|| !sameFingerprint(movedOriginal, entry.movedOriginalFingerprint)) {
throw new Error("Codex shim fresh-install backup changed during rollback");
}
if (sourceOccupied) {
// Something else occupies the source path. Dropping the backup is correct
// only when that something is a file we own; when a concurrent updater
// owns it, this backup is the user's real launcher and deleting it would
// lose the command entirely. Keep it in that case — a stray
// `codex.opencodex-real` is recoverable, a deleted launcher is not.
if (ownsWrapperNow) unlinkSync(target.backupPath);
} else {
// No-replace: sourceOccupied was sampled earlier, so a concurrent
// installer may have published a launcher at the original path since.
codexShimRollbackRestoreHookForTests?.(target);
restoreWithoutReplacing(target.backupPath, target.originalPath);
}
}
} catch (error) {
errors.push(error instanceof Error ? error : new Error(String(error)));
}
}
if (errors.length > 0) throw new AggregateError(errors, "Codex shim install validation rollback failed");
}
function primaryState(files: ShimFileState[]): ShimState {
const first = files[0]!;
return { platform: process.platform, ...first, wrappers: files };
}
function replaceOwnedBackup(sourcePath: string, backupPath: string): void {
const oldBackupPath = `${backupPath}.old-${process.pid}`;
if (existsSync(oldBackupPath)) unlinkSync(oldBackupPath);
if (existsSync(backupPath)) renameSync(backupPath, oldBackupPath);
try {
renameSync(sourcePath, backupPath);
if (existsSync(oldBackupPath)) unlinkSync(oldBackupPath);
} catch (error) {
if (!existsSync(backupPath) && existsSync(oldBackupPath)) renameSync(oldBackupPath, backupPath);
throw error;
}
}
function refreshShimFile(file: ShimFileState, runtime: DurableBunRuntime): boolean {
if (file.preserveOnly) {
if (existsSync(file.originalPath) && !isShim(file.originalPath)) {
replaceOwnedBackup(file.originalPath, file.backupPath);
return true;
}
return false;
}
if (existsSync(file.wrapperPath) && !isShim(file.wrapperPath)) {
if (file.wrapperPath !== file.originalPath) return false;
const replacement = stableShimPathProbe(file.wrapperPath);
if (!replacement) return false;
return applyGuardedRefreshTransaction([{
file,
expectedReplacement: replacement.fingerprint,
sourcePath: file.wrapperPath,
}], undefined, undefined, runtime);
}
if (!existsSync(file.wrapperPath) && existsSync(file.backupPath)) {
writeShim(file.wrapperPath, file.realPath ?? file.backupPath, runtime);
const writtenWrapper = stableShimPathProbe(file.wrapperPath);
if (!writtenWrapper || !writtenWrapper.prefix.includes(SHIM_MARKER)) {
return false;
}
let unsafe: UnixShimProbeResult = null;
let probeError: Error | null = null;
try {
unsafe = probeUnixShimFiles([file]);
} catch (error) {
probeError = error instanceof Error ? error : new Error(String(error));
}
const currentWrapper = stableShimPathProbe(file.wrapperPath);
const wrapperChangedDuringProbe = !currentWrapper
|| !sameFingerprint(currentWrapper.fingerprint, writtenWrapper.fingerprint);
if (unsafe !== null || probeError || wrapperChangedDuringProbe) {
if (currentWrapper && sameFingerprint(currentWrapper.fingerprint, writtenWrapper.fingerprint)) {
unlinkSync(file.wrapperPath);
}
if (probeError) throw probeError;
return false;
}
return true;
}
if (file.originalPath !== file.wrapperPath && existsSync(file.originalPath) && existsSync(file.wrapperPath) && isShim(file.wrapperPath)) {
replaceOwnedBackup(file.originalPath, file.backupPath);
writeShim(file.wrapperPath, file.realPath ?? file.backupPath, runtime);
return true;
}
// An owned Windows wrapper from an older template revision (e.g. one that loads the service
// token before honoring OCX_SHIM_BYPASS) is replaced over the same backing launcher through an
// ownership-checked stage-and-link transaction that never clobbers a concurrent replacement.
if (process.platform === "win32" && existsSync(file.wrapperPath) && isShim(file.wrapperPath) && hasUsableBackingPath(file)) {
const probe = stableShimPathProbe(file.wrapperPath);
if (probe && probe.prefix.includes(SHIM_MARKER) && !isCurrentShimProbe(probe, "win32")) {
return refreshObsoleteWindowsShim(file.wrapperPath, probe, () => windowsShimContent(file.wrapperPath, file.realPath ?? file.backupPath, runtime));
}
}
return false;
}
interface GuardedRefreshOperation {
file: ShimFileState;
expectedReplacement: ShimPathFingerprint;
sourcePath: string;
}
interface GuardedRefreshJournalEntry {
operation: GuardedRefreshOperation;
stagedOldBackupPath?: string;
movedReplacementFingerprint?: ShimPathFingerprint;
replacementMovedToBackup: boolean;
writtenWrapperFingerprint?: ShimPathFingerprint;
wrapperWriteStarted: boolean;
}
let guardedRefreshTransactionId = 0;
function planGuardedRefreshTransaction(
files: readonly ShimFileState[],
expectedReplacements: ReadonlyMap<string, ShimPathFingerprint>,
): GuardedRefreshOperation[] | null {
const operations: GuardedRefreshOperation[] = [];
const seen = new Set<string>();
for (const file of files) {
if (seen.has(file.wrapperPath)) return null;
seen.add(file.wrapperPath);
if (file.preserveOnly) {
if (!existsSync(file.backupPath) || existsSync(file.originalPath)) return null;
continue;
}
if (!hasUsableBackingPath(file)) return null;
const probe = stableShimPathProbe(file.wrapperPath);
if (!probe) return null;
const expectedReplacement = expectedReplacements.get(file.wrapperPath);
if (!expectedReplacement) {
if (!isHealthyShimProbe(probe, process.platform)) return null;
continue;
}
if (file.wrapperPath !== file.originalPath
|| probe.prefix.includes(SHIM_MARKER)
|| !sameFingerprint(probe.fingerprint, expectedReplacement)) return null;
operations.push({ file, expectedReplacement, sourcePath: file.wrapperPath });
}
if (operations.length !== expectedReplacements.size) return null;
return operations;
}
function rollbackGuardedRefresh(journal: readonly GuardedRefreshJournalEntry[]): Error[] {
const rollbackErrors: Error[] = [];
const attempt = (operation: () => void): void => {
try {
operation();
} catch (error) {
rollbackErrors.push(error instanceof Error ? error : new Error(String(error)));
}
};
for (const entry of [...journal].reverse()) {
let sourceOccupied = false;
attempt(() => {
const wrapper = stableShimPathProbe(entry.operation.file.wrapperPath);
// No marker-text fallback: the markers are public, so a concurrent updater's
// wrapper carries them too. No recorded inode identity means not ours.
const ownsWrapper = entry.wrapperWriteStarted
&& wrapper !== null
&& entry.writtenWrapperFingerprint !== undefined
&& sameFingerprint(wrapper.fingerprint, entry.writtenWrapperFingerprint);
if (ownsWrapper) {
unlinkSync(entry.operation.file.wrapperPath);
} else {
try {
lstatSync(entry.operation.sourcePath);
sourceOccupied = true;
} catch (error) {
if (fileErrorCode(error) !== "ENOENT") sourceOccupied = true;
}
}
});
attempt(() => {
if (entry.replacementMovedToBackup && existsSync(entry.operation.file.backupPath)) {
const movedReplacement = stableShimPathProbe(entry.operation.file.backupPath);
if (!movedReplacement || !entry.movedReplacementFingerprint
|| !sameFingerprint(movedReplacement.fingerprint, entry.movedReplacementFingerprint)) {
throw new Error("Codex shim guarded refresh backup changed during rollback");
}
if (sourceOccupied) unlinkSync(entry.operation.file.backupPath);
else renameSync(entry.operation.file.backupPath, entry.operation.sourcePath);
}
});
attempt(() => {
if (entry.stagedOldBackupPath && existsSync(entry.stagedOldBackupPath)) {
renameSync(entry.stagedOldBackupPath, entry.operation.file.backupPath);
}
});
}
return rollbackErrors;
}
function applyGuardedRefreshTransaction(
operations: readonly GuardedRefreshOperation[],
beforeGuardedRefresh?: (wrapperPath: string, index: number) => void,
commitState?: () => void,
runtime?: DurableBunRuntime,
): boolean {
const journal: GuardedRefreshJournalEntry[] = [];
let applyError: Error | null = null;
let fingerprintMismatch = false;
let unsafeLauncher = false;
let wrapperChangedDuringProbe = false;
const transactionId = `${process.pid}-${++guardedRefreshTransactionId}`;
for (const [index, operation] of operations.entries()) {
beforeGuardedRefresh?.(operation.sourcePath, index);
const probe = stableShimPathProbe(operation.sourcePath);
if (!probe || !sameFingerprint(probe.fingerprint, operation.expectedReplacement)) {
fingerprintMismatch = true;
break;
}
const entry: GuardedRefreshJournalEntry = {
operation,
replacementMovedToBackup: false,
wrapperWriteStarted: false,
};
journal.push(entry);
try {
if (existsSync(operation.file.backupPath)) {
entry.stagedOldBackupPath = `${operation.file.backupPath}.autorestore-${transactionId}-${index}`;
if (existsSync(entry.stagedOldBackupPath)) unlinkSync(entry.stagedOldBackupPath);
renameSync(operation.file.backupPath, entry.stagedOldBackupPath);
}
renameSync(operation.sourcePath, operation.file.backupPath);
entry.replacementMovedToBackup = true;
const movedReplacement = stableShimPathProbe(operation.file.backupPath);
if (!movedReplacement) throw new Error("Codex shim guarded refresh could not fingerprint the staged launcher");
entry.movedReplacementFingerprint = movedReplacement.fingerprint;
entry.wrapperWriteStarted = true;
const writtenInode = writeShim(operation.file.wrapperPath, operation.file.realPath ?? operation.file.backupPath, runtime);
// Claim our own partial write before the hook can fail (see fresh install).
entry.writtenWrapperFingerprint = ownedWrapperFingerprint(operation.file.wrapperPath, writtenInode);
codexShimGuardedWriteHookForTests?.();
// Re-check: unset means a concurrent writer owns the path now, so rollback
// must leave it alone.
entry.writtenWrapperFingerprint = ownedWrapperFingerprint(operation.file.wrapperPath, writtenInode);
if (!entry.writtenWrapperFingerprint && !writtenInode) {
throw new Error("Codex shim guarded refresh could not fingerprint the generated wrapper");
}
} catch (error) {
applyError = error instanceof Error ? error : new Error(String(error));
break;
}
}
if (!fingerprintMismatch && !applyError) {
try {
unsafeLauncher = probeUnixShimFiles(operations.map(operation => operation.file)) !== null;
} catch (error) {
applyError = error instanceof Error ? error : new Error(String(error));
}
}
if (!fingerprintMismatch && !applyError && !unsafeLauncher) {
wrapperChangedDuringProbe = journal.some(entry => {
const wrapper = stableShimPathProbe(entry.operation.file.wrapperPath);
return !wrapper || !entry.writtenWrapperFingerprint
|| !sameFingerprint(wrapper.fingerprint, entry.writtenWrapperFingerprint);
});
}
if (!fingerprintMismatch && !applyError && !unsafeLauncher && !wrapperChangedDuringProbe && commitState) {
try {
commitState();
} catch (error) {
applyError = error instanceof Error ? error : new Error(String(error));
}
}
if (fingerprintMismatch || applyError || unsafeLauncher || wrapperChangedDuringProbe) {
const rollbackErrors = rollbackGuardedRefresh(journal);
if (applyError || rollbackErrors.length > 0) {
throw new AggregateError(
[...(applyError ? [applyError] : []), ...rollbackErrors],
"Codex shim guarded refresh failed",
);
}
return false;
}
const cleanupErrors: Error[] = [];
for (const entry of journal) {
try {
if (entry.stagedOldBackupPath && existsSync(entry.stagedOldBackupPath)) unlinkSync(entry.stagedOldBackupPath);
} catch (error) {
cleanupErrors.push(error instanceof Error ? error : new Error(String(error)));
}
}
if (cleanupErrors.length > 0) throw new AggregateError(cleanupErrors, "Codex shim guarded refresh cleanup failed");
return true;
}
interface ObsoleteUnixShimJournalEntry {
file: ShimFileState;
stagedWrapperPath: string;
priorWrapperFingerprint: ShimPathFingerprint;
backingFingerprint: ShimPathFingerprint;
writtenWrapperFingerprint?: ShimPathFingerprint;
wrapperWriteStarted: boolean;
}
function rollbackObsoleteUnixShimRefresh(journal: readonly ObsoleteUnixShimJournalEntry[]): Error[] {
const errors: Error[] = [];
const attempt = (operation: () => void): void => {
try {
operation();
} catch (error) {
errors.push(error instanceof Error ? error : new Error(String(error)));
}
};
for (const entry of [...journal].reverse()) {
attempt(() => {
const wrapper = stableShimPathProbe(entry.file.wrapperPath);
const ownsWrapper = entry.wrapperWriteStarted
&& wrapper !== null
&& (entry.writtenWrapperFingerprint
? sameFingerprint(wrapper.fingerprint, entry.writtenWrapperFingerprint)
: wrapper.prefix.includes(UNIX_SHIM_REVISION_MARKER));
if (ownsWrapper) unlinkSync(entry.file.wrapperPath);
});
attempt(() => {
if (!existsSync(entry.stagedWrapperPath)) return;
if (existsSync(entry.file.wrapperPath)) unlinkSync(entry.stagedWrapperPath);
else renameSync(entry.stagedWrapperPath, entry.file.wrapperPath);
});
}
return errors;
}
type ObsoleteUnixShimRefreshResult =
| { installed: true; message: string }
| { installed: false; deferred: boolean; message: string };
function refreshObsoleteUnixShims(files: readonly ShimFileState[], runtime?: DurableBunRuntime): ObsoleteUnixShimRefreshResult {
if (process.platform === "win32") {
return { installed: false, deferred: false, message: "Codex autostart shim is already current." };
}
const candidates = files.filter(file => {
if (file.preserveOnly || file.wrapperPath !== file.originalPath || !existsSync(file.wrapperPath)) return false;
const probe = stableShimPathProbe(file.wrapperPath);
return probe !== null && probe.prefix.includes(SHIM_MARKER) && !isCurrentUnixShimProbe(probe);
});
if (candidates.length === 0) {
return { installed: false, deferred: true, message: "Codex autostart shim upgrade deferred because tracked launchers changed." };
}
const journal: ObsoleteUnixShimJournalEntry[] = [];
const transactionId = `${process.pid}-${randomUUID()}`;
let applyError: Error | null = null;
for (const [index, file] of candidates.entries()) {
const wrapper = stableShimPathProbe(file.wrapperPath);
const backing = stableShimPathProbe(file.backupPath);
if (!wrapper || !wrapper.prefix.includes(SHIM_MARKER) || isCurrentUnixShimProbe(wrapper) || !backing) {
applyError = new Error("Codex autostart shim upgrade inputs changed before regeneration");
break;
}
const entry: ObsoleteUnixShimJournalEntry = {
file,
stagedWrapperPath: `${file.wrapperPath}.upgrade-${transactionId}-${index}`,
priorWrapperFingerprint: wrapper.fingerprint,
backingFingerprint: backing.fingerprint,
wrapperWriteStarted: false,
};
journal.push(entry);
try {
renameSync(file.wrapperPath, entry.stagedWrapperPath);
const stagedWrapper = stableShimPathProbe(entry.stagedWrapperPath);
if (!stagedWrapper
|| !sameFingerprintAfterRename(stagedWrapper.fingerprint, entry.priorWrapperFingerprint)) {
throw new Error("Codex autostart shim upgrade could not fingerprint the staged wrapper");
}
entry.wrapperWriteStarted = true;
const writtenInode = writeShim(file.wrapperPath, file.realPath ?? file.backupPath, runtime);
const writtenWrapper = stableShimPathProbe(file.wrapperPath);
if (!writtenWrapper || !isCurrentUnixShimProbe(writtenWrapper)) {
throw new Error("Codex autostart shim upgrade could not fingerprint the regenerated wrapper");
}
// Identity is the inode we created; a replacement that landed since the
// rename leaves this unset so rollback treats the file as someone else's.
entry.writtenWrapperFingerprint = ownedWrapperFingerprint(file.wrapperPath, writtenInode);
} catch (error) {
applyError = error instanceof Error ? error : new Error(String(error));
break;
}
}
let unsafe: UnixShimProbeResult = null;
let probeError: Error | null = null;
if (!applyError) {
try {
unsafe = probeUnixShimFiles(candidates);
} catch (error) {
probeError = error instanceof Error ? error : new Error(String(error));
}
}
const changedDuringProbe = !applyError && !probeError && journal.some(entry => {
const wrapper = stableShimPathProbe(entry.file.wrapperPath);
const backing = stableShimPathProbe(entry.file.backupPath);
return !wrapper || !entry.writtenWrapperFingerprint
|| !sameFingerprint(wrapper.fingerprint, entry.writtenWrapperFingerprint)
|| !backing || !sameFingerprint(backing.fingerprint, entry.backingFingerprint);
});
if (applyError || probeError || changedDuringProbe) {
const rollbackErrors = rollbackObsoleteUnixShimRefresh(journal);
if (applyError || probeError || rollbackErrors.length > 0) {
throw new AggregateError(
[...(applyError ? [applyError] : []), ...(probeError ? [probeError] : []), ...rollbackErrors],
"Codex autostart shim upgrade failed",
);
}
return { installed: false, deferred: true, message: "Codex autostart shim upgrade deferred because tracked launchers changed." };
}
if (unsafe) {
const cleanupErrors: Error[] = [];
for (const entry of [...journal].reverse()) {
try {
const wrapper = stableShimPathProbe(entry.file.wrapperPath);
if (!wrapper || !entry.writtenWrapperFingerprint
|| !sameFingerprint(wrapper.fingerprint, entry.writtenWrapperFingerprint)) {
throw new Error("Codex autostart shim upgrade lost wrapper ownership before removal");
}
const backing = stableShimPathProbe(entry.file.backupPath);
if (!backing || !sameFingerprint(backing.fingerprint, entry.backingFingerprint)) {
throw new Error("Codex autostart shim upgrade backing launcher changed before restoration");
}
unlinkSync(entry.file.wrapperPath);
renameSync(entry.file.backupPath, entry.file.originalPath);
if (existsSync(entry.stagedWrapperPath)) unlinkSync(entry.stagedWrapperPath);
} catch (error) {
cleanupErrors.push(error instanceof Error ? error : new Error(String(error)));
}
}
if (cleanupErrors.length > 0) {
throw new AggregateError(cleanupErrors, "Codex autostart shim upgrade safety removal failed");
}
if (existsSync(statePath())) unlinkSync(statePath());
return {
installed: false,
deferred: false,
message: "Removed an obsolete Codex autostart shim because its saved launcher failed current validation. The original launcher was restored; reinstall Codex as a concrete executable before enabling codexAutoStart.",
};
}
const cleanupErrors: Error[] = [];
for (const entry of journal) {
try {
if (existsSync(entry.stagedWrapperPath)) unlinkSync(entry.stagedWrapperPath);
} catch (error) {
cleanupErrors.push(error instanceof Error ? error : new Error(String(error)));
}
}
if (cleanupErrors.length > 0) throw new AggregateError(cleanupErrors, "Codex autostart shim upgrade cleanup failed");
return {
installed: true,
message: `Upgraded Codex autostart shim at ${candidates.map(file => file.wrapperPath).join(", ")} and validated the saved launcher.`,
};
}
type InstallResult = { installed: boolean; message: string; refused?: boolean };
function installCodexShimInternal(options: InstallCodexShimInternalOptions): InstallResult {
const read = readStateResult();
// A record that is present but unreadable is not "no record": a fresh install would overwrite it.
if (read.present && !read.state) return { installed: false, refused: true, message: legacyShimManualRestoreMessage(read.warning ? "the shim record is unsafe to read" : "the shim record is unreadable", statePath()) };
const legacy = read.state ? checkLegacyShimRecord(read.state) : null;
if (legacy && !legacy.ok) return { installed: false, refused: true, message: legacyShimManualRestoreMessage(legacy.reason, statePath()) };
const release = setLegacyShimMutationGuard(legacy);
try { return installCodexShimFromState(options, read.state); } finally { release(); }
}
function installCodexShimFromState(options: InstallCodexShimInternalOptions, existing: ShimState | null): InstallResult {
const filesBefore = existing ? stateFiles(existing) : [];
if (filesBefore.length > 0 && filesBefore.every(file => {
if (file.preserveOnly) return existsSync(file.backupPath) && !existsSync(file.originalPath);
const probe = stableShimPathProbe(file.wrapperPath);
return hasUsableBackingPath(file) && probe !== null && isHealthyShimProbe(probe, process.platform)
&& (process.platform !== "win32" || isCurrentShimProbe(probe, "win32"));
})) {
return { installed: false, message: "Codex autostart shim is already installed." };
}
const runtime = options.runtime ?? Object.freeze({ ...(options.selectRuntime ?? durableBunRuntime)() });
if (!options.runtimeAdmitted) {
const configDir = (options.configDir ?? getConfigDir)();
(options.assertRuntimeWritable ?? assertSelectedRuntimeWritable)(runtime, configDir, { rootWasAbsent: !existsSync(configDir) });
}
if (existing) {
const files = stateFiles(existing);
if (!options.expectedReplacements && process.platform !== "win32") {
const hasObsoleteShim = files.some(file => {
if (file.preserveOnly) return false;
const probe = stableShimPathProbe(file.wrapperPath);
return probe !== null && probe.prefix.includes(SHIM_MARKER) && !isCurrentUnixShimProbe(probe);
});
if (hasObsoleteShim) return refreshObsoleteUnixShims(files);
}
if (options.expectedReplacements) {
const operations = planGuardedRefreshTransaction(files, options.expectedReplacements);
if (!operations || operations.length === 0) {
return { installed: false, message: "Codex shim auto-restore deferred because tracked launchers changed." };
}
const originalStateBytes = readFileSync(statePath());
const commitState = (): void => {
try {
writeState(primaryState(files));
} catch (writeError) {
try {
writeFileSync(statePath(), originalStateBytes);
} catch (restoreError) {
throw new AggregateError(
[writeError, restoreError],
"Codex shim state commit and restoration failed",
);
}
throw writeError;
}
};
if (!applyGuardedRefreshTransaction(operations, options.beforeGuardedRefresh, commitState, runtime)) {
return { installed: false, message: "Codex shim auto-restore deferred because tracked launchers changed." };
}
return {
installed: true,
message: `Codex update detected. Backed up new launcher and refreshed shim at ${files.map(f => f.wrapperPath).join(", ")}.`,
};
}
let refreshed = false;
for (const file of files) refreshed = refreshShimFile(file, runtime) || refreshed;
// A Windows refresh that refused to publish over a concurrent replacement is not a success.
if (process.platform === "win32" && files.some(file => {
if (file.preserveOnly) return false;
const probe = stableShimPathProbe(file.wrapperPath);
return !probe || !probe.prefix.includes(SHIM_MARKER) || !isCurrentShimProbe(probe, "win32");
})) return { installed: false, message: "Codex shim refresh deferred because a tracked launcher changed during the refresh." };
const allInstalled = files.every(file => file.preserveOnly
? existsSync(file.backupPath) && !existsSync(file.originalPath)
: existsSync(file.wrapperPath)
&& (existsSync(file.backupPath) || (file.realPath ? existsSync(file.realPath) : false))
&& isShim(file.wrapperPath));
if (refreshed || allInstalled) {
writeState(primaryState(files));
if (refreshed) {
return {
installed: true,
message: `Codex update detected. Backed up new launcher and refreshed shim at ${files.map(f => f.wrapperPath).join(", ")}.`,
};
}
return {
installed: false,
message: `Codex autostart shim already installed at ${files.map(f => f.wrapperPath).join(", ")}.`,
};
}
}
if (!options.allowFreshInstall) {
return { installed: false, message: "Codex shim auto-restore requires a valid prior installation." };
}
const targets: ShimFileState[] | null = process.platform === "win32"
? findWindowsCodexTargets()
: (() => {
const originalPath = findCodexOnPath();
return originalPath ? [{ wrapperPath: originalPath, originalPath, backupPath: backupPathFor(originalPath) }] : null;
})();
if (!targets) return { installed: false, message: lastShimDiscoveryError ?? "Could not find a codex executable on PATH." };
// The writer obeys the rules every later restore checks, so it never records a layout it would refuse.
const fresh = checkLegacyShimRecord(primaryState(targets));
const freshProblem = fresh.ok ? legacyShimFreshLaunchersProblem(fresh.files, fresh.resolvedDirectory) : fresh.reason;
if (!fresh.ok || freshProblem) return { installed: false, refused: true, message: `Refusing to install the Codex autostart shim: ${freshProblem}.` };
setLegacyShimMutationGuard(fresh); // released with the caller's guard
for (const target of targets) {
if (existsSync(target.backupPath)) return { installed: false, message: `Refusing to overwrite existing backup: ${target.backupPath}` };
}
const freshJournal: FreshShimInstallJournalEntry[] = [];
let freshApplyError: Error | null = null;
for (const target of targets) {
const entry: FreshShimInstallJournalEntry = {
target,
originalMovedToBackup: false,
wrapperWriteStarted: false,
};
freshJournal.push(entry);
try {
if (existsSync(target.originalPath)) {
renameSync(target.originalPath, target.backupPath);
entry.originalMovedToBackup = true;
// Metadata-only, and before the content probe: an empty or otherwise
// unprobeable launcher must still be restorable during rollback.
//
// Only Unix reaches the rollback path (Windows rethrows freshApplyError
// without rolling back), so only Unix may treat a missing fingerprint as
// fatal. Throwing here on Windows would abort AFTER the original moved,
// stranding the launcher at its backup path with nothing to restore it.
const movedOriginalFingerprint = shimPathFingerprint(target.backupPath);
if (movedOriginalFingerprint) entry.movedOriginalFingerprint = movedOriginalFingerprint;
if (process.platform !== "win32") {
if (!movedOriginalFingerprint) {
throw new Error("Codex shim fresh install could not fingerprint the staged launcher");
}
const movedOriginal = stableShimPathProbe(target.backupPath);
// A content probe still runs where it can, purely as a consistency
// check: disagreement means the file moved under us mid-install.
if (movedOriginal && !sameFingerprint(movedOriginal.fingerprint, movedOriginalFingerprint)) {
throw new Error("Codex shim fresh install staged launcher changed while being fingerprinted");
}
}
}
if (!target.preserveOnly) {
entry.wrapperWriteStarted = true;
const writtenInode = writeShim(target.wrapperPath, target.realPath ?? target.backupPath, runtime);
entry.writtenWrapperInode = writtenInode;
codexShimFreshWriteHookForTests?.();
if (process.platform !== "win32") {
if (!writtenInode) throw new Error("Codex shim fresh install could not fingerprint the generated wrapper");
entry.writtenWrapperFingerprint = ownedWrapperFingerprint(target.wrapperPath, writtenInode);
}
}
} catch (error) {
freshApplyError = error instanceof Error ? error : new Error(String(error));
break;
}
}
if (process.platform !== "win32") {
if (freshApplyError) {
try {
rollbackFreshShimInstall(freshJournal);
} catch (rollbackError) {
throw new AggregateError([freshApplyError, rollbackError], "Codex shim installation and rollback failed");
}
throw freshApplyError;
}
let unsafe: UnixShimProbeResult = null;
let probeError: Error | null = null;
try {
unsafe = probeUnixShimFiles(targets);
} catch (error) {
probeError = error instanceof Error ? error : new Error(String(error));
}
if (probeError) {
try {
rollbackFreshShimInstall(freshJournal);
} catch (rollbackError) {
throw new AggregateError([probeError, rollbackError], "Codex shim probe and install rollback failed");
}
throw probeError;
}
const wrapperChangedDuringProbe = freshJournal.some(entry => {
if (entry.target.preserveOnly) return false;
const wrapper = stableShimPathProbe(entry.target.wrapperPath);
return !wrapper || !entry.writtenWrapperFingerprint
|| !sameFingerprint(wrapper.fingerprint, entry.writtenWrapperFingerprint);
});
if (unsafe || wrapperChangedDuringProbe) {
rollbackFreshShimInstall(freshJournal);
const reason = wrapperChangedDuringProbe
? "the generated wrapper changed during its validation probe"
: unsafe === "recursive"
? "the saved launcher resolved back to the generated shim"
: unsafe === "timeout"
? `the saved launcher did not finish --version within ${CODEX_SHIM_INSTALL_PROBE_TIMEOUT_MS}ms`
: unsafe === "descendants"
? "the saved launcher left background descendants running after --version"
: unsafe !== null && typeof unsafe === "object"
? `the saved launcher's probe process group could not be terminated cleanly [phase=${unsafe.phase}; code=${unsafe.code}; status=${unsafe.status ?? "none"}; signal=${unsafe.signal}]`
: "the saved launcher failed its --version probe";
return {
installed: false,
message: wrapperChangedDuringProbe
? `Refusing Codex autostart shim because ${reason}. The concurrent launcher was preserved, and your previous launcher was kept alongside it as \`<codex>.opencodex-real\`; retry after the Codex update finishes, and remove that backup once you are satisfied the launcher on PATH is the one you want.`
: `Refusing Codex autostart shim because ${reason}. The original launcher was restored; reinstall Codex as a concrete executable before enabling codexAutoStart.`,
};
}
} else if (freshApplyError) {
throw freshApplyError;
}
writeState(primaryState(targets));
return {
installed: true,
message: `Codex autostart shim installed at ${targets.map(t => t.wrapperPath).join(", ")}. Original saved at ${targets.map(t => t.backupPath).join(", ")}.`,
};
}
export function installCodexShim(deps: RuntimePreflightDeps = {}): { installed: boolean; message: string; refused?: boolean; runnable?: boolean } {
if (process.platform !== "win32") return installUnixOverlay(findCodexOnPath, lastCodexDiscoveryError);
const gate = beginCodexCliSelectionParentWrite();
if (!gate.entered) return { installed: false, refused: true, message: "codex_cli_selection_busy" };
try { return installCodexShimInternal({ ...deps, allowFreshInstall: true }); }
finally { gate.exit(); }
}
export async function installCodexShimAsync(deps: RuntimePreflightDeps = {}): Promise<ReturnType<typeof installCodexShim>> {
try { return await withCodexCliSelectionParentWriteAsync(() => installCodexShim(deps)); }
catch (error) {
if (error instanceof CodexCliSelectionMutationBusyError) return { installed: false, refused: true, message: error.message };
throw error;
}
}
export async function autoRestoreCodexShimAsync(options: Parameters<typeof autoRestoreCodexShim>[0]): Promise<CodexShimAutoRestoreResult> {
try { return await withCodexCliSelectionParentWriteAsync(() => autoRestoreCodexShim(options)); }
catch (error) {
if (error instanceof CodexCliSelectionMutationBusyError) return { status: "deferred", message: error.message };
throw error;
}
}
export async function uninstallCodexShimAsync(): Promise<ReturnType<typeof uninstallCodexShim>> {
try { return await withCodexCliSelectionParentWriteAsync(uninstallCodexShim); }
catch (error) {
if (error instanceof CodexCliSelectionMutationBusyError) return { removed: false, message: error.message };
throw error;
}
}
export function autoRestoreCodexShim(options: Parameters<typeof autoRestoreWindowsCodexShim>[0]): CodexShimAutoRestoreResult {
if (process.platform !== "win32") return autoRestoreUnixOverlay(options);
const gate = beginCodexCliSelectionParentWrite();
if (!gate.entered) return { status: "deferred", message: "codex_cli_selection_busy" };
try { return autoRestoreWindowsCodexShim(options); }
finally { gate.exit(); }
}
function autoRestoreWindowsCodexShim(options: RuntimePreflightDeps & {
enabled: () => boolean;
stabilitySleep?: (ms: number) => void;
/** Narrow deterministic seam used to hold the interprocess lock in tests. */
afterRestoreLockAcquired?: () => void;
/** Narrow deterministic seam for stale-lock compare-and-delete tests. */
beforeStaleRestoreLockDelete?: () => void;
/** Narrow deterministic race seam for the guarded transaction tests. */
beforeGuardedRefresh?: (wrapperPath: string, index: number) => void;
}): CodexShimAutoRestoreResult {
const stateRead = readStateResult();
const state = stateRead.state;
if (!state) {
if (stateRead.warning) return { status: "ineligible", message: stateRead.warning };
return { status: stateRead.present ? "ineligible" : "not-installed" };
}
if (state.platform !== process.platform) return { status: "ineligible" };
const legacy = checkLegacyShimRecord(state);
if (!legacy.ok) return { status: "ineligible", message: legacyShimManualRestoreMessage(legacy.reason, statePath()) };
const files = stateFiles(state);
const replacementProbes = new Map<string, StableShimPathProbe>();
const obsoleteShimProbes = new Map<string, StableShimPathProbe>();
const seen = new Set<string>();
const currentShimProbes = new Map<string, StableShimPathProbe>();
for (const file of files) {
if (seen.has(file.wrapperPath)) return { status: "ineligible" };
seen.add(file.wrapperPath);
if (file.preserveOnly) {
if (!existsSync(file.backupPath) || existsSync(file.originalPath)) {
return { status: "ineligible", message: destroyedShimMessage(file) };
}
continue;
}
if (!existsSync(file.wrapperPath) || !hasUsableBackingPath(file)) {
return { status: "ineligible", message: destroyedShimMessage(file) };
}
const probe = stableShimPathProbe(file.wrapperPath);
if (!probe) return { status: "deferred" };
if (probe.prefix.includes(SHIM_MARKER)) {
if (!isHealthyShimProbe(probe, state.platform)) {
return { status: "ineligible", message: destroyedShimMessage(file) };
}
if (!isCurrentShimProbe(probe, state.platform)) {
obsoleteShimProbes.set(file.wrapperPath, probe);
continue;
}
currentShimProbes.set(file.wrapperPath, probe);
continue;
}
// A surviving backup would otherwise let the replacement path below wrap the
// version manager's NEW binary as a fresh original — the same adoption the
// missing-backup case refuses, arriving through the back door.
if (isVersionManagerOwnedCodexPath(file.wrapperPath)) {
return { status: "ineligible", message: destroyedShimMessage(file) };
}
replacementProbes.set(file.wrapperPath, probe);
}
if (replacementProbes.size === 0 && obsoleteShimProbes.size === 0) return { status: "healthy" };
if (!options.enabled()) return { status: "disabled" };
// Windows current + obsolete siblings (a partial revision upgrade) resume: only the obsolete
// wrappers are refreshed, so a transient publish failure cannot block recovery forever.
const revisionOnlyMix = state.platform === "win32" && replacementProbes.size === 0;
if (files.length > 1 && ((currentShimProbes.size > 0 && !revisionOnlyMix) || (replacementProbes.size > 0 && obsoleteShimProbes.size > 0))) {
return {
status: "deferred",
message: "Codex shim auto-restore deferred because tracked launcher siblings are in a mixed shim/replacement state.",
};
}
const runtime = Object.freeze({ ...(options.selectRuntime ?? durableBunRuntime)() });
try {
const configDir = (options.configDir ?? getConfigDir)();
(options.assertRuntimeWritable ?? assertSelectedRuntimeWritable)(runtime, configDir, { rootWasAbsent: !existsSync(configDir) });
} catch (error) {
if (error instanceof RuntimePreflightError) return { status: "deferred", message: error.message };
throw error;
}
const lock = tryAcquireShimRestoreLock(options.beforeStaleRestoreLockDelete);
if (!lock) return { status: "deferred" };
try {
options.afterRestoreLockAcquired?.();
(options.stabilitySleep ?? Bun.sleepSync)(CODEX_SHIM_REPLACEMENT_STABLE_MS);
if (obsoleteShimProbes.size > 0) {
for (const [path, firstProbe] of obsoleteShimProbes) {
const secondProbe = stableShimPathProbe(path);
if (!secondProbe || isCurrentShimProbe(secondProbe, state.platform)
|| !sameStableShimPathProbe(firstProbe, secondProbe)) return { status: "deferred" };
}
if (state.platform === "win32") {
// Recheck after the lock and the stability sleep, immediately before the wrappers are rewritten.
const recheck = checkLegacyShimRecord(state);
if (!recheck.ok) return { status: "ineligible", message: legacyShimManualRestoreMessage(recheck.reason, statePath()) };
const realFor = (path: string) => { const file = files.find(entry => entry.wrapperPath === path)!; return file.realPath ?? file.backupPath; };
const release = setLegacyShimMutationGuard(recheck);
try {
return refreshAdmittedWindowsShims(obsoleteShimProbes, currentShimProbes, path => windowsShimContent(path, realFor(path), runtime))
? { status: "restored", message: `Upgraded Codex autostart shim at ${[...obsoleteShimProbes.keys()].join(", ")}.` } : { status: "deferred" };
} finally { release(); }
}
const result = refreshObsoleteUnixShims(files);
return result.installed
? { status: "restored", message: result.message }
: result.deferred
? { status: "deferred", message: result.message }
: { status: "ineligible", message: result.message };
}
const expectedReplacements = new Map<string, ShimPathFingerprint>();
for (const [path, firstProbe] of replacementProbes) {
const secondProbe = stableShimPathProbe(path);
if (!secondProbe || secondProbe.prefix.includes(SHIM_MARKER)
|| !sameStableShimPathProbe(firstProbe, secondProbe)) return { status: "deferred" };
expectedReplacements.set(path, secondProbe.fingerprint);
}
const result = installCodexShimInternal({
runtime, runtimeAdmitted: true,
allowFreshInstall: false,
expectedReplacements,
beforeGuardedRefresh: options.beforeGuardedRefresh,
});
return result.installed
? { status: "restored", message: result.message }
: result.refused ? { status: "ineligible", message: result.message } : { status: "deferred" };
} finally {
lock.release();
}
}
export function uninstallCodexShim(): { removed: boolean; message: string; refused?: boolean } {
if (process.platform !== "win32") return uninstallUnixCodexShim();
const gate = beginCodexCliSelectionParentWrite();
if (!gate.entered) return { removed: false, message: "codex_cli_selection_busy" };
try { return uninstallWindowsCodexShim(); }
finally { gate.exit(); }
}
let legacyUninstallStepHookForTests: ((step: "unlink" | "rename", index: number) => void) | null = null;
/** @internal Runs before each uninstall mutation, after validation; lets tests change the filesystem there. */
export function setLegacyShimUninstallStepHookForTests(hook: typeof legacyUninstallStepHookForTests): void {
legacyUninstallStepHookForTests = hook;
}
function uninstallWindowsCodexShim(): { removed: boolean; message: string; refused?: boolean } {
const read = readStateResult();
const refused = (reason: string, partial = false) => ({ removed: false, refused: true, message: legacyShimManualRestoreMessage(reason, statePath(), partial) });
if (!read.state) return read.present ? refused(read.warning ? "the shim record is unsafe to read" : "the shim record is unreadable") : { removed: false, message: "Codex autostart shim is not installed." };
if (read.state.mode !== undefined || read.state.platform !== "win32") {
// Another platform's record (a config directory shared with WSL) names no Windows launcher.
if (existsSync(statePath())) unlinkSync(statePath());
return { removed: true, message: "Codex autostart shim record from another platform removed; no launcher file was changed." };
}
const checked = checkLegacyShimRecord(read.state);
if (!checked.ok) return refused(checked.reason);
const { files, recordedDirectory, resolvedDirectory, directoryIdentity } = checked;
if (resolvedDirectory !== null) {
const api = hostShimPathApi();
const at = (path: string) => api.join(resolvedDirectory, api.basename(path));
// Act only inside the directory that was validated, and only while it still resolves there.
const stillValid = () => legacyShimDirectoryUnchanged(recordedDirectory, resolvedDirectory, directoryIdentity)
&& legacyShimFilesProblem(files, resolvedDirectory) === null;
let step = 0;
for (const [index, file] of files.entries()) {
legacyUninstallStepHookForTests?.("unlink", index);
if (!stillValid()) return refused("the launcher directory changed during removal", step > 0);
const wrapper = at(file.wrapperPath);
if (existsSync(wrapper) && isShim(wrapper)) { unlinkSync(wrapper); step++; }
}
for (const [index, file] of files.entries()) {
legacyUninstallStepHookForTests?.("rename", index);
if (!stillValid()) return refused("the launcher directory changed during removal", step > 0);
const backup = at(file.backupPath), original = at(file.originalPath);
if (existsSync(backup) && !existsSync(original)) { renameSync(backup, original); step++; }
}
}
if (existsSync(statePath())) unlinkSync(statePath());
return { removed: true, message: `Codex autostart shim removed. Restored ${files.map(f => f.originalPath).join(", ")}.` };
}
/** True if a Codex autostart shim is currently installed (state file present). */
export function isCodexShimInstalled(): boolean {
return diagnoseCodexShim().installed;
}