Files
OmniRoute/open-sse/executors/freebuff.ts
Adrian A. Firmansyah cbf23772ec feat(providers): implement native support for Freebuff AI gateway (#6793) (#10531)
Adds native support for Freebuff (Codebuff CLI free-tier gateway): executor with upstream session acquisition, agent-run lifecycle (START/FINISH), canonical system-prompt injection, and model→agent mapping for 9 free models; registry entry, dashboard branding/icons, and API-key validation. Closes #6793.

Validated in an isolated worktree boarded onto origin/release/v3.8.50 (0 conflicts after resolving generated provider-count drift, 15 files):
- 9/9 focused tests pass (freebuff-provider, providers-constants-split).
- Dropped one out-of-scope, unrelated hunk in scripts/build/build-next-isolated.mjs (build-memory heap tuning) that had nothing to do with the Freebuff provider — kept the branch scoped to its stated purpose.
- check-changelog-integrity: OK.
- file-size: gateways.ts and AddApiKeyModal.tsx crossed the frozen cap by +15/+5 lines (irreducible catalog-entry + credential-hint additions) — rebaselined with justification, pushed fix-in-place to the PR branch.
- typecheck:core: clean.
- check-complexity / check-cognitive-complexity: OK, both under baseline.

Co-authored-by: adrianaryaputra <adrianaryaputra@users.noreply.github.com>
2026-08-20 22:53:24 -03:00

173 lines
5.5 KiB
TypeScript

import {
BaseExecutor,
type ExecuteInput,
} from "./base.ts";
import { PROVIDERS } from "../config/constants.ts";
const MODEL_TO_AGENT: Record<string, string> = {
"deepseek/deepseek-v4-flash": "base2-free-deepseek-flash",
"deepseek/deepseek-v4-pro": "base2-free-deepseek",
"openai/gpt-5.6-luna": "base2-free-luna",
"minimax/minimax-m3": "base2-free-minimax-m3",
"mimo/mimo-v2.5": "base2-free-mimo",
"z-ai/glm-5.2": "base2-free-glm",
"crof/kimi-k3-eco": "base2-free-kimi-k3-eco",
"anthropic/claude-fable-5": "base2-free-fable",
"meta/muse-spark-1.2-contributor": "base2-free-muse-spark",
};
function generateClientSessionId(): string {
const alphabet = "0123456789abcdefghijklmnopqrstuvwxyz";
let out = "";
for (let i = 0; i < 13; i++) {
out += alphabet[Math.floor(Math.random() * alphabet.length)];
}
return out;
}
export class FreebuffExecutor extends BaseExecutor {
constructor() {
super("freebuff", (PROVIDERS as Record<string, unknown>).freebuff as string || "freebuff");
}
override async execute(input: ExecuteInput) {
const { model, body, stream, credentials, signal } = input;
const token = credentials?.apiKey || credentials?.accessToken || "";
if (!token) {
return {
response: new Response(
JSON.stringify({ error: { message: "Freebuff Auth Token required", type: "authentication_error" } }),
{ status: 401, headers: { "Content-Type": "application/json" } }
),
};
}
const requestedModel = typeof model === "string" ? model.replace(/^freebuff\//, "") : (model || "deepseek/deepseek-v4-flash");
const agentId = MODEL_TO_AGENT[requestedModel] || "base2-free";
const authHeaders = {
Authorization: `Bearer ${token}`,
"Content-Type": "application/json",
"User-Agent": "codebuff/0.1.0 (darwin-arm64)",
};
let instanceId = "";
let runId = "";
// 1. Session acquisition
try {
const sessionRes = await fetch("https://www.codebuff.com/api/v1/freebuff/session", {
method: "POST",
headers: {
...authHeaders,
"x-freebuff-model": requestedModel,
},
body: JSON.stringify({}),
signal,
});
if (sessionRes.ok) {
const data = (await sessionRes.json()) as { instanceId?: string };
instanceId = data.instanceId || "";
} else {
const errText = await sessionRes.text();
return {
response: new Response(
JSON.stringify({ error: { message: `Freebuff session failed (${sessionRes.status}): ${errText}`, type: "upstream_error" } }),
{ status: sessionRes.status, headers: { "Content-Type": "application/json" } }
),
};
}
} catch (e: unknown) {
const msg = e instanceof Error ? e.message : String(e);
return {
response: new Response(
JSON.stringify({ error: { message: `Freebuff session network error: ${msg}`, type: "upstream_error" } }),
{ status: 502, headers: { "Content-Type": "application/json" } }
),
};
}
// 2. Start agent run
try {
const runRes = await fetch("https://www.codebuff.com/api/v1/agent-runs", {
method: "POST",
headers: authHeaders,
body: JSON.stringify({ action: "START", agentId }),
signal,
});
if (runRes.ok) {
const runData = (await runRes.json()) as { runId?: string };
runId = runData.runId || "";
}
} catch {}
// 3. Prepare Chat Payload & Buffy System Prompt
const incomingMessages = Array.isArray(body?.messages) ? [...body.messages] : [];
const hasBuffyPrompt =
incomingMessages.length > 0 &&
incomingMessages[0].role === "system" &&
typeof incomingMessages[0].content === "string" &&
incomingMessages[0].content.trim().startsWith("You are Buffy");
if (!hasBuffyPrompt) {
incomingMessages.unshift({
role: "system",
content: "You are Buffy, the strategic coding assistant.",
});
}
const clientSessionId = generateClientSessionId();
const upstreamBody = {
...(body || {}),
model: requestedModel,
messages: incomingMessages,
stream: stream !== false,
codebuff_metadata: {
run_id: runId,
cost_mode: "free",
client_id: clientSessionId,
freebuff_instance_id: instanceId,
...((body as Record<string, unknown>)?.codebuff_metadata as Record<string, unknown> || {}),
},
};
const completionHeaders = {
Authorization: `Bearer ${token}`,
"Content-Type": "application/json",
"User-Agent": "ai-sdk/openai-compatible/1.0.25/codebuff",
Accept: "application/json, text/event-stream",
"x-freebuff-instance-id": instanceId,
...(runId ? { "x-codebuff-run-id": runId } : {}),
"x-codebuff-agent-id": agentId,
};
// 4. Chat Completion
const completionUrl = "https://www.codebuff.com/api/v1/chat/completions";
const response = await fetch(completionUrl, {
method: "POST",
headers: completionHeaders,
body: JSON.stringify(upstreamBody),
signal,
});
// 5. Finish agent run (background)
if (runId) {
void fetch("https://www.codebuff.com/api/v1/agent-runs", {
method: "POST",
headers: authHeaders,
body: JSON.stringify({
action: "FINISH",
runId,
status: "completed",
totalSteps: 1,
directCredits: 0,
totalCredits: 0,
}),
}).catch(() => {});
}
return { response };
}
}