Files
OmniRoute/open-sse/services/githubCopilotModels.ts
2026-07-25 02:52:55 -03:00

263 lines
8.6 KiB
TypeScript

/**
* GitHub Copilot live model discovery (#3120, #3121).
*
* The `github` (Copilot) provider previously shipped a STATIC hardcoded model
* catalog in `providerRegistry.ts` and had no discovery source, so "Import
* Models" could never refresh the list (#3120) and advertised models the
* account is not entitled to (e.g. gemini previews), which fail upstream with
* `400 ... not supported` when tested (#3121).
*
* Copilot exposes its per-account catalog at `https://api.githubcopilot.com/models`,
* authenticated with the Copilot bearer token + the standard Copilot chat
* headers. The response shape is `{ data: [{ id, name, model_picker_enabled,
* policy, capabilities, ... }] }`. We map `data[].id` into managed models. Only
* entitled models appear in the live response, so parsing it directly gives the
* entitlement filtering #3121 needs.
*
* A safe fallback to the existing static catalog is preserved for
* offline/unauthed/failed refresh so the import flow never breaks.
*/
import { getGitHubCopilotChatHeaders } from "../config/providerHeaderProfiles.ts";
export const GITHUB_COPILOT_MODELS_URL = "https://api.githubcopilot.com/models";
export const GITHUB_COPILOT_MODEL_ALLOWLIST = [
"claude-fable-5",
"claude-opus-5",
"claude-opus-4.8-fast",
"claude-opus-4.8",
"claude-opus-4.7",
"claude-sonnet-4.6",
"claude-opus-4.5",
"claude-sonnet-5",
"claude-sonnet-4.5",
"claude-haiku-4.5",
"gemini-3.1-pro-preview",
"gemini-3.5-flash",
"gpt-5.6-sol",
"gpt-5.6-terra",
"gpt-5.6-luna",
"gpt-5.5",
"gpt-5.4",
"gpt-5.4-mini",
"gpt-5.3-codex",
"gpt-5-mini",
"gpt-4o-2024-11-20",
"gpt-4o-mini",
"gpt-4-0125-preview",
"kimi-k2.7-code",
"mai-code-1-flash",
"oswe-vscode-prime",
] as const;
const GITHUB_COPILOT_MODEL_ALLOWLIST_SET = new Set<string>(GITHUB_COPILOT_MODEL_ALLOWLIST);
export type GitHubCopilotModel = {
id: string;
name: string;
owned_by: string;
};
type RawRecord = Record<string, unknown>;
function asRecord(value: unknown): RawRecord {
return value && typeof value === "object" && !Array.isArray(value) ? (value as RawRecord) : {};
}
function toNonEmptyString(value: unknown): string | null {
if (typeof value !== "string") return null;
const trimmed = value.trim();
return trimmed.length > 0 ? trimmed : null;
}
/**
* Parse a Copilot `/models` response into managed model rows. Only ids present
* in the live response are returned, which is exactly the entitlement filter
* #3121 requires.
*/
export function parseGitHubCopilotModels(data: unknown): GitHubCopilotModel[] {
const payload = asRecord(data);
const items = Array.isArray(payload.data)
? (payload.data as unknown[])
: Array.isArray(payload.models)
? (payload.models as unknown[])
: [];
const seen = new Set<string>();
const models: GitHubCopilotModel[] = [];
for (const value of items) {
const item = asRecord(value);
const id = toNonEmptyString(item.id) || toNonEmptyString(item.model);
if (!id || seen.has(id)) continue;
if (!GITHUB_COPILOT_MODEL_ALLOWLIST_SET.has(id)) continue;
seen.add(id);
const name = toNonEmptyString(item.name) || toNonEmptyString(item.display_name) || id;
models.push({ id, name, owned_by: "github" });
}
return models;
}
export type FetchGitHubCopilotModelsOptions = {
/** Copilot bearer token (copilotToken; falls back to GitHub accessToken upstream). */
token: string | null | undefined;
/** Injectable fetch (defaults to global fetch). */
fetchImpl?: typeof fetch;
/** Static catalog to fall back to when live discovery is unavailable. */
fallbackModels?: Array<{ id: string; name?: string }>;
};
export type GitHubCopilotModelsResult = {
models: GitHubCopilotModel[];
/** "api" = live discovery; "fallback" = static catalog (offline/unauthed/error). */
source: "api" | "fallback";
};
function toFallbackResult(
fallbackModels: Array<{ id: string; name?: string }> | undefined
): GitHubCopilotModelsResult {
const models = (fallbackModels || [])
.map((model) => {
const id = toNonEmptyString(model.id);
if (!id) return null;
if (!GITHUB_COPILOT_MODEL_ALLOWLIST_SET.has(id)) return null;
return { id, name: toNonEmptyString(model.name) || id, owned_by: "github" };
})
.filter((model): model is GitHubCopilotModel => Boolean(model));
return { models, source: "fallback" };
}
/**
* Discover the Copilot model catalog live, falling back to the static catalog
* when no token is available or the upstream request fails.
*/
export async function fetchGitHubCopilotModels(
options: FetchGitHubCopilotModelsOptions
): Promise<GitHubCopilotModelsResult> {
const { token, fetchImpl = fetch, fallbackModels } = options;
if (!toNonEmptyString(token)) {
return toFallbackResult(fallbackModels);
}
try {
const response = await fetchImpl(GITHUB_COPILOT_MODELS_URL, {
method: "GET",
headers: {
...getGitHubCopilotChatHeaders("application/json"),
Authorization: `Bearer ${token}`,
},
});
if (!response.ok) {
return toFallbackResult(fallbackModels);
}
const data = await response.json();
const models = parseGitHubCopilotModels(data);
if (models.length === 0) {
return toFallbackResult(fallbackModels);
}
return { models, source: "api" };
} catch {
// Network/parse failure — never break the import flow.
return toFallbackResult(fallbackModels);
}
}
/**
* GHE Copilot live model discovery.
*
* The GHE token endpoint returns TWO hosts in `endpoints`:
* - `endpoints.api` (copilotApiUrl) → chat/completions + the real chat
* model catalog. Response shape is `{ data: [{ id, name, ... }] }` (same
* shape as github.com's api.githubcopilot.com/models).
* - `endpoints.proxy` (copilotProxyUrl) → NES / autocomplete / instant-apply
* models only. Response shape is `{ models: [{ name, ... }] }`.
*
* We discover from the `api` host so the imported catalog is the real chat
* models (claude-*, gpt-*, gemini-*), not the completion-only proxy set. Unlike
* github.com, the IDs are enterprise-specific, so NO static allowlist applies —
* every id in the live response is kept. Both response shapes are parsed so a
* legacy connection that still points at the proxy host keeps working.
*/
function asGheRecord(value: unknown): Record<string, unknown> {
return value && typeof value === "object" && !Array.isArray(value)
? (value as Record<string, unknown>)
: {};
}
export function parseGheCopilotModels(data: unknown): GitHubCopilotModel[] {
const payload = asGheRecord(data);
// api host → { data: [{ id }] }; proxy host → { models: [{ name }] }.
const items = Array.isArray(payload.data)
? (payload.data as unknown[])
: Array.isArray(payload.models)
? (payload.models as unknown[])
: [];
const seen = new Set<string>();
const models: GitHubCopilotModel[] = [];
for (const value of items) {
const item = asGheRecord(value);
// api host uses `id`; proxy host uses `name` as the model id.
const id = toNonEmptyString(item.id) || toNonEmptyString(item.name);
if (!id || seen.has(id)) continue;
seen.add(id);
const name =
toNonEmptyString(item.name) ||
toNonEmptyString(item.display_name) ||
toNonEmptyString(item.label) ||
id;
models.push({
id,
name,
owned_by: toNonEmptyString(item.vendor || item.provider) || "ghe-copilot",
});
}
return models;
}
export type FetchGheCopilotModelsOptions = {
/**
* Copilot API base URL (providerSpecificData.copilotApiUrl, from
* endpoints.api). This is the host that serves the real chat model catalog.
*/
apiUrl: string | null | undefined;
/** Copilot bearer token. */
token: string | null | undefined;
/** Injectable fetch (defaults to global fetch). */
fetchImpl?: typeof fetch;
};
/**
* Discover the GHE Copilot model catalog live from `<apiUrl>/models`.
* Returns an empty list (no fallback catalog) when discovery is unavailable —
* GHE model IDs are enterprise-specific, so a static fallback would be wrong.
*/
export async function fetchGheCopilotModels(
options: FetchGheCopilotModelsOptions
): Promise<GitHubCopilotModel[]> {
const { apiUrl, token, fetchImpl = fetch } = options;
const base = toNonEmptyString(apiUrl);
if (!base || !toNonEmptyString(token)) return [];
try {
const response = await fetchImpl(`${base.replace(/\/+$/, "")}/models`, {
method: "GET",
headers: {
...getGitHubCopilotChatHeaders("application/json"),
Authorization: `Bearer ${token}`,
},
});
if (!response.ok) return [];
const data = await response.json();
return parseGheCopilotModels(data);
} catch {
return [];
}
}