UNPKG

@bitkyc08/opencodex

Version:

Universal provider proxy for OpenAI Codex & Claude Code — use any LLM with Codex CLI/App/SDK and Claude Code

186 lines (171 loc) • 7.4 kB
import { currentExternalCodexModelProvider, getCodexRoutingKind, type CodexRoutingKind, } from "../codex/inject"; import { diagnoseCodexShim, type CodexShimDiagnostic } from "../codex/shim"; import { overlayActivationHint } from "../codex/shim-overlay"; import { findFirstCodexOnPath, type CodexPathCandidate } from "../codex/shim-path-resolution"; import { loadConfig, resolveEnvValue } from "../config"; const PROXY_ENV_KEYS = [ "HTTP_PROXY", "HTTPS_PROXY", "ALL_PROXY", "http_proxy", "https_proxy", "all_proxy", ] as const; export interface CodexShimReadinessInputs { routingKind: CodexRoutingKind; externalProvider: string | null; processProxyEnvPresent: boolean; configuredProxyResolved: boolean; } export type CodexConnectShimStatus = "ready" | "missing" | "unhealthy" | "unverified"; export interface CodexConnectShimReadiness { status: CodexConnectShimStatus; /** Secret-free, actionable text rendered by ocx connect. */ message: string; } export interface CodexConnectShimInspectionDeps { diagnose?: () => Pick<CodexShimDiagnostic, "installed" | "healthy" | "summary" | "runnable" | "active">; findOnPath?: () => CodexPathCandidate | null; } const CODEX_TOKEN_NOTE = "The connected Codex config uses OPENCODEX_API_AUTH_TOKEN; " + "without a working shim or when a PATH wrapper replaces it, Codex may fail with " + '"Missing environment variable".'; const CODEX_TOKEN_ACTION = `${CODEX_TOKEN_NOTE} Run 'ocx codex-shim install' to repair it.`; export function codexConnectShimReadiness(inputs: { diagnosis: Pick<CodexShimDiagnostic, "installed" | "healthy" | "summary" | "runnable" | "active">; commandPath: string | null; commandIsShim?: boolean; }): CodexConnectShimReadiness { if (inputs.diagnosis.runnable && inputs.diagnosis.active !== undefined) { if (inputs.diagnosis.active === null) { return { status: "unverified", message: `PATH activation could not be verified. Shim state: ${inputs.diagnosis.summary}. ` + `Check PATH and retry 'ocx connect'. ${CODEX_TOKEN_NOTE}`, }; } if (!inputs.diagnosis.active) { return { status: "missing", message: `installed but not active; ${inputs.commandPath ? `PATH resolves 'codex' to ${inputs.commandPath}` : "no 'codex' executable was found on PATH"}. ` + `Shim state: ${inputs.diagnosis.summary}. ${overlayActivationHint()} ${CODEX_TOKEN_NOTE}`, }; } return { status: "ready", message: "installed and healthy" }; } if (inputs.diagnosis.installed && !inputs.diagnosis.healthy) { return { status: "unhealthy", message: `installed but unhealthy: ${inputs.diagnosis.summary}. ${CODEX_TOKEN_ACTION}`, }; } if (inputs.diagnosis.healthy && inputs.commandPath && !inputs.commandIsShim) { // The shim is installed and healthy, so reinstalling it cannot fix this: only PATH // order (or the wrapper in front of it) can. return { status: "missing", message: `not active; PATH resolves 'codex' to ${inputs.commandPath}, not an OpenCodex shim. ` + `Shim state: ${inputs.diagnosis.summary}. Put the directory of the tracked shim ahead of that command on PATH, ` + `or remove that wrapper; re-running 'ocx codex-shim install' will not change PATH order. ${CODEX_TOKEN_NOTE}`, }; } if (inputs.diagnosis.installed && inputs.diagnosis.healthy) { if (!inputs.commandPath) { return { status: "missing", message: `installed but not active; no 'codex' executable was found on PATH. ` + `Shim state: ${inputs.diagnosis.summary}. Add the directory of the tracked shim to PATH. ${CODEX_TOKEN_NOTE}`, }; } return { status: "ready", message: "installed and healthy" }; } if (inputs.commandPath) { return { status: "missing", message: `not active; PATH resolves 'codex' to ${inputs.commandPath}, not an OpenCodex shim. ${CODEX_TOKEN_ACTION}`, }; } return { status: "missing", message: `not installed and no 'codex' executable was found on PATH. ${CODEX_TOKEN_ACTION}`, }; } export function inspectCodexShimForConnect( deps: CodexConnectShimInspectionDeps = {}, ): CodexConnectShimReadiness { let diagnosis: Pick<CodexShimDiagnostic, "installed" | "healthy" | "summary" | "runnable" | "active">; try { diagnosis = (deps.diagnose ?? diagnoseCodexShim)(); } catch { diagnosis = { installed: true, healthy: false, summary: "diagnostic state could not be read" }; } let command: CodexPathCandidate | null = null; try { command = (deps.findOnPath ?? findFirstCodexOnPath)(); } catch { return { status: "unverified", message: `PATH activation could not be verified. Shim state: ${diagnosis.summary}. ` + `Check PATH and retry 'ocx connect'. ${CODEX_TOKEN_NOTE}`, }; } return codexConnectShimReadiness({ diagnosis, commandPath: command?.path ?? null, commandIsShim: command?.isShim ?? false, }); } function externalProviderLabel(provider: string | null): string { return provider ? `external model_provider ${JSON.stringify(provider)}` : "the active Codex route"; } export function codexShimReadinessWarnings( inputs: CodexShimReadinessInputs, ): string[] { const warnings: string[] = []; const provider = externalProviderLabel(inputs.externalProvider); if (inputs.routingKind === "unknown") { warnings.push( inputs.externalProvider ? `Codex still selects ${provider}. The shim can start OpenCodex, but it does not redirect that provider; point it at the live OpenCodex /v1 endpoint with wire_api = "responses", or switch to the built-in openai provider and run 'ocx sync'.` : "Codex routing could not be verified. The shim can start OpenCodex, but it may not redirect Codex; run 'ocx doctor' before relying on autostart.", ); } else if (inputs.routingKind === "custom-local") { warnings.push( `Codex uses ${provider} through a user-owned local gateway. The shim can start OpenCodex, but OpenCodex does not own that route; run 'ocx doctor' to verify its lifecycle.`, ); } else if (inputs.routingKind === "custom-remote") { warnings.push( `Codex uses ${provider} through a remote gateway. The shim only starts a local OpenCodex proxy and will not affect those requests.`, ); } if (inputs.processProxyEnvPresent && !inputs.configuredProxyResolved) { warnings.push( "Proxy environment variables are present only in this process while config.proxy is unset or unresolved. Codex launchers and background services may not inherit them; persist config.proxy before relying on autostart.", ); } return warnings; } export function collectCodexShimReadinessWarnings(): string[] { const config = loadConfig(); let externalProvider: string | null = null; try { externalProvider = currentExternalCodexModelProvider(); } catch { // Routing readiness is advisory; getCodexRoutingKind() already reports an // unreadable config as unknown, so preserve that warning instead of failing. } return codexShimReadinessWarnings({ routingKind: getCodexRoutingKind(), externalProvider, processProxyEnvPresent: PROXY_ENV_KEYS.some(key => Boolean(process.env[key]?.trim())), configuredProxyResolved: Boolean(resolveEnvValue(config.proxy)?.trim()), }); }