mirror of
https://github.com/Ark0N/Codeman.git
synced 2026-11-16 11:19:33 +01:00
Follow-up to #393, picking up the work Ark0N invited in his merge comment: "generate those entries from the saved profiles rather than a fixed duplicate per harness, and put it in a follow-up PR so this one stays the backend... The Run-menu picker is yours if you want it." Adds the frontend surface the backend has been waiting on: - Run menu: a "Custom Endpoints" section lists one entry per (harness that supports customModelInjection, saved endpoint) pair, e.g. "Claude Code (llama.cpp)". The harness list comes from window.__codemanCustomModelClis, injected at page render straight off the CLI registry's own capabilities (never a hardcoded id list in the frontend), so a CLI whose injection recipe lands later appears with no frontend change. Picking an entry runs that harness's own existing run*() function unmodified (case creation, env overrides, everything, forced to a single instance) and then applies the endpoint's default model to the session it creates via the existing POST /api/sessions/:id/custom-model route. Entries are hidden for a remote/docker active case, since that route already refuses both. - Settings: App Settings -> Models gets a "Custom model endpoints" group wiring up the customModelEndpointsEnabled toggle (declared since #393, read by nothing until now) plus CRUD against the existing /api/model-endpoints routes: list, add/edit (inline form), delete, discover models. - Backend: CustomModelHost gains an optional defaultModelId, the model the picker applies with no further choice per endpoint (one generated menu entry per CLI+endpoint pair, not per CLI+endpoint+model). The route refuses a value that isn't one of the endpoint's own discovered models, and a fresh discovery drops a default that no longer appears rather than carrying an invalid one forward. Docs: docs/custom-model-endpoints.md describes the new picker and settings panel; CLAUDE.md's Custom Model Endpoint Profiles entry drops the "backend-only" status note and documents the picker's generation mechanism. Tests: four new route tests cover defaultModelId validation, acceptance, and the drop/keep behaviour across a re-discovery; a new render-index-html test pins the __codemanCustomModelClis injection (present, agent CLIs supporting the capability, antigravity and shell excluded) and its solo-window skip. No browser test was added for the Run-menu picker itself or the settings CRUD panel (this box has no tmux, so the live server used by test:browser/test:mobile could not be exercised here) -- worth a Playwright pass before merge, same as any other frontend PR. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01RqZeHrRS6DYcGcGX2p9EwG
76 lines
3.5 KiB
TypeScript
76 lines
3.5 KiB
TypeScript
/**
|
||
* @fileoverview Read/write-array store for user-configured custom OpenAI-compatible
|
||
* model endpoints (local or cloud — docs/custom-model-endpoints-plan.md). Same
|
||
* shape as `remote-hosts.ts` / `webview-store.ts`: `~/.codeman/custom-model-hosts.json`
|
||
* holding a plain array, read/written whole. The file can hold API keys, so it is
|
||
* written 0600 via tmp+rename like `intents.json` (`mode` on `writeFile` applies only
|
||
* to a file being created; the rename is what keeps an existing file's bytes and
|
||
* mode from ever being observable half-written or world-readable).
|
||
*/
|
||
|
||
import { existsSync, mkdirSync } from 'node:fs';
|
||
import fs from 'node:fs/promises';
|
||
import { join } from 'node:path';
|
||
|
||
const CUSTOM_MODEL_HOSTS_FILE = 'custom-model-hosts.json';
|
||
|
||
export type CustomModelAuthStyle = 'bearer' | 'api-key';
|
||
|
||
export interface CustomModelHost {
|
||
id: string;
|
||
label: string;
|
||
/** Root URL, local or cloud — e.g. "http://192.168.1.50:8080" or an Azure AI Foundry URL. */
|
||
baseUrl: string;
|
||
apiKey?: string;
|
||
/**
|
||
* Defaults to 'bearer' (the common `Authorization: Bearer` convention — matches
|
||
* llama.cpp, OpenAI-compatible servers, and most gateways). Pick 'api-key' for
|
||
* endpoints that specifically want the `api-key` header, e.g. Azure AI Foundry.
|
||
*
|
||
* ⚠️ There is deliberately NO 'both' option. An earlier design sent BOTH headers
|
||
* on every discovery request on the theory that an unused header is harmless —
|
||
* live-tested against a real llama-swap server, sending both reliably HUNG the
|
||
* request indefinitely (reproduced 3× — Bearer alone: ~500ms, api-key alone:
|
||
* ~600ms, both together: no response inside a 15s timeout). Whatever auth
|
||
* middleware some servers run apparently does not handle two simultaneous
|
||
* credential conventions gracefully, so "send everything and let the server
|
||
* ignore what it doesn't need" is not a safe default — it can silently turn a
|
||
* working endpoint into one that always times out.
|
||
*/
|
||
authStyle?: CustomModelAuthStyle;
|
||
models?: string[];
|
||
lastDiscoveredAt?: string;
|
||
/**
|
||
* The model the Run-menu picker (docs/custom-model-endpoints-plan.md) applies when
|
||
* this endpoint is picked with no further choice — one generated menu entry per
|
||
* (CLI, endpoint) pair, not per (CLI, endpoint, model), so it needs a single answer.
|
||
* Must be a member of `models` when set; the picker falls back to `models[0]` when
|
||
* this is unset, and disables the entry entirely when `models` is empty (nothing to
|
||
* default to). Never auto-set on discovery — the previous default staying valid
|
||
* after a re-discover is a property worth keeping even if the model list changes.
|
||
*/
|
||
defaultModelId?: string;
|
||
}
|
||
|
||
export function customModelHostsPath(configDir: string): string {
|
||
return join(configDir, CUSTOM_MODEL_HOSTS_FILE);
|
||
}
|
||
|
||
export async function readCustomModelHosts(configDir: string): Promise<CustomModelHost[]> {
|
||
try {
|
||
const raw = await fs.readFile(customModelHostsPath(configDir), 'utf-8');
|
||
const parsed = JSON.parse(raw);
|
||
return Array.isArray(parsed) ? (parsed as CustomModelHost[]) : [];
|
||
} catch {
|
||
return [];
|
||
}
|
||
}
|
||
|
||
export async function writeCustomModelHosts(configDir: string, hosts: CustomModelHost[]): Promise<void> {
|
||
if (!existsSync(configDir)) mkdirSync(configDir, { recursive: true });
|
||
const target = customModelHostsPath(configDir);
|
||
const tmp = `${target}.${process.pid}.tmp`;
|
||
await fs.writeFile(tmp, JSON.stringify(hosts, null, 2), { mode: 0o600 });
|
||
await fs.rename(tmp, target);
|
||
}
|