Skip to content

Commit 37729b1

Browse files
authored
feat(core): add GitHub Copilot Auto and a model resolve hook (#62997)
1 parent fc7e922 commit 37729b1

14 files changed

Lines changed: 468 additions & 57 deletions

File tree

‎packages/core/src/github-copilot/models.ts‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,15 @@ import { Provider } from "../provider.js"
88

99
const RemoteModel = Schema.Struct({
1010
model_picker_enabled: Schema.Boolean,
11+
is_chat_fallback: Schema.optional(Schema.Boolean),
1112
id: Schema.String,
1213
name: Schema.String,
1314
version: Schema.String,
1415
supported_endpoints: Schema.optional(Schema.Array(Schema.String)),
1516
policy: Schema.optional(Schema.Struct({ state: Schema.optional(Schema.String) })),
1617
billing: Schema.optional(
1718
Schema.Struct({
19+
auto_discount: Schema.optional(Schema.Number),
1820
token_prices: Schema.optional(
1921
Schema.Struct({
2022
batch_size: Schema.Number,
@@ -123,6 +125,29 @@ export function derive(baseURL: string, remote: Snapshot, existing: readonly Mod
123125
return result
124126
}
125127

128+
/** Copilot's Auto model. Copilot's router picks the model that serves each Session from the account's Auto pool. */
129+
export const auto = Model.ID.make("auto")
130+
131+
export function autoModel(baseURL: string, remote: Snapshot) {
132+
const pool = Array.from(remote.values()).filter((model) => model.billing?.auto_discount !== undefined)
133+
if (pool.length === 0) return
134+
const route = routeFor(auto, "chat", baseURL)
135+
const limits = pool.map((model) => model.capabilities.limits)
136+
return Model.Info.make({
137+
...Model.Info.default(Provider.ID.githubCopilot, auto),
138+
name: "Auto",
139+
package: route.package,
140+
settings: { baseURL: route.baseURL },
141+
capabilities: { tools: true, input: ["text", "image"], output: ["text"] },
142+
// Any pool model may serve a Session, so show the smallest window.
143+
limit: {
144+
context: Math.min(...limits.map((limit) => limit.max_context_window_tokens ?? limit.max_prompt_tokens)),
145+
input: Math.min(...limits.map((limit) => limit.max_prompt_tokens)),
146+
output: Math.min(...limits.map((limit) => limit.max_output_tokens)),
147+
},
148+
})
149+
}
150+
126151
function usable(model: RemoteModel): model is UsableModel {
127152
return (
128153
model.policy?.state !== "disabled" &&

‎packages/core/src/model-resolver.ts‎

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,8 @@ export type MediaError =
147147

148148
export interface Interface {
149149
readonly resolve: (requested?: Ref) => Effect.Effect<Resolved | undefined, Error>
150+
/** The model used when nothing is selected: the configured default, or the first available text model. */
151+
readonly fallback: () => Effect.Effect<Info | undefined>
150152
readonly resolveModel: (model: Info, variant?: VariantID) => Effect.Effect<Resolved, Error>
151153
/** An enabled image model by ref, or undefined when no image model has that ref. */
152154
readonly resolveImage: (ref: Ref) => Effect.Effect<ImageModel | undefined, MediaError>
@@ -518,24 +520,18 @@ export const layer = Layer.effect(
518520
const { credential, runtimeInfo } = yield* prepare(info, ref.variant)
519521
return yield* fromCatalogMedia(runtimeInfo, is, credential, dependencies)
520522
})
523+
const fallback = Effect.fn("ModelResolver.fallback")(function* () {
524+
const model = yield* models.default()
525+
if (model && hasPackage(model)) return model
526+
return (yield* models.available()).find((model) => hasPackage(model) && Model.supportsText(model))
527+
})
521528
return Service.of({
522529
resolve: Effect.fn("ModelResolver.resolve")(function* (requested) {
523-
const selected = requested
524-
? yield* models.get(requested.providerID, requested.id)
525-
: yield* models
526-
.default()
527-
.pipe(
528-
Effect.flatMap((model) =>
529-
model && hasPackage(model)
530-
? Effect.succeed(model)
531-
: Effect.map(models.available(), (models) =>
532-
models.find((model) => hasPackage(model) && Model.supportsText(model)),
533-
),
534-
),
535-
)
530+
const selected = requested ? yield* models.get(requested.providerID, requested.id) : yield* fallback()
536531
if (!selected) return undefined
537532
return yield* load(selected, requested?.variant)
538533
}),
534+
fallback,
539535
resolveModel: load,
540536
resolveImage: Effect.fn("ModelResolver.resolveImage")(function* (ref) {
541537
return yield* loadMedia(ref, "image", isImageModel)

‎packages/core/src/plugin/provider/github-copilot.ts‎

Lines changed: 93 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import type { IntegrationOAuthMethodRegistration } from "@opencode/plugin/effect/integration"
22
import type { SessionRequestKind, SessionTitle } from "@opencode/plugin/effect/session"
33
import { isRecord } from "@opencode/util/record"
4-
import { Effect, Option, Schema } from "effect"
4+
import { Clock, Effect, Option, Schema } from "effect"
55
import { FetchHttpClient, HttpClient, HttpClientRequest, HttpClientResponse } from "effect/http"
66
import { IntegrationConnection } from "../../integration/connection.js"
77
import { Credential } from "../../credential.js"
@@ -13,6 +13,7 @@ import { Agent } from "../../agent.js"
1313
import { define } from "@opencode/plugin/effect/plugin"
1414
import { Provider } from "../../provider.js"
1515
import { SessionAffinity } from "../../session/affinity.js"
16+
import type { Session } from "@opencode/schema/session"
1617
import { SharedCache } from "../../shared-cache.js"
1718
import { activeCredential } from "./credential-settings.js"
1819
import { ProviderRefresh } from "./refresh.js"
@@ -45,6 +46,11 @@ const User = Schema.Struct({
4546
),
4647
})
4748
const decodeUser = Schema.decodeUnknownOption(User)
49+
const AutoRoute = Schema.Struct({
50+
session_token: Schema.String,
51+
expires_at: Schema.Number,
52+
selected_model: Schema.Struct({ id: Schema.String }),
53+
})
4854
const JsonBody = Schema.fromJsonString(Schema.Unknown)
4955
const decodeBody = Schema.decodeUnknownOption(JsonBody)
5056

@@ -164,6 +170,9 @@ export const GithubCopilotPlugin = define({
164170
const cache = yield* SharedCache.Service
165171
const http = yield* HttpClient.HttpClient
166172
const outbound = yield* FetchHttpClient.Fetch
173+
// Each Session keeps the model Copilot's Auto router picked until its token nears expiry, the Session is compacted,
174+
// or the account changes. The token unlocks the pick and its Auto discount; Copilot rejects it for any other model.
175+
const routes = new Map<Session.ID, { model: string; account: string; token?: string; until: number }>()
167176
const discovered = yield* ProviderRefresh.start({
168177
integrationID: "github-copilot",
169178
initial: {} as {
@@ -246,11 +255,14 @@ export const GithubCopilotPlugin = define({
246255
if (!item) return
247256
const loaded = discovered.current
248257
if (loaded.models) {
258+
const url = loaded.baseURL ?? baseURL()
259+
const router = CopilotModels.autoModel(url, loaded.models)
249260
evt.add({
250261
info: item.provider,
251-
models: Array.from(
252-
CopilotModels.derive(loaded.baseURL ?? baseURL(), loaded.models, Array.from(item.models.values())).values(),
253-
),
262+
models: [
263+
...CopilotModels.derive(url, loaded.models, Array.from(item.models.values())).values(),
264+
...(router ? [router] : []),
265+
],
254266
sourceConnection: loaded.connection,
255267
})
256268
return
@@ -294,6 +306,82 @@ export const GithubCopilotPlugin = define({
294306
evt.headers["X-Interaction-Type"] = interaction
295307
evt.headers["X-Interaction-Id"] = session ? SessionAffinity.get(session) : evt.sessionID
296308
if (interaction !== "conversation-agent") evt.headers["x-initiator"] = "agent"
309+
const route = routes.get(evt.sessionID)
310+
if (route?.token && route.model === evt.model.id) evt.headers["Copilot-Session-Token"] = route.token
311+
}),
312+
{ providerID: Provider.ID.githubCopilot },
313+
)
314+
const route = Effect.fn("GithubCopilotPlugin.route")(function* (sessionID: Session.ID) {
315+
const loaded = discovered.current
316+
if (!loaded.baseURL || !loaded.token || !loaded.models) return
317+
const user = yield* ctx.session.context({ sessionID }).pipe(
318+
Effect.map((messages) => messages.findLast((message) => message.type === "user")),
319+
Effect.orElseSucceed(() => undefined),
320+
)
321+
const headers = (yield* providers.get(Provider.ID.githubCopilot))?.headers ?? {}
322+
const picked = yield* HttpClient.filterStatusOk(http)
323+
.execute(
324+
HttpClientRequest.post(`${loaded.baseURL}/auto`).pipe(
325+
HttpClientRequest.setHeaders({
326+
...headers,
327+
Authorization: `Bearer ${loaded.token}`,
328+
"User-Agent": App.useragent(ctx.app),
329+
"X-GitHub-Api-Version": apiVersion,
330+
}),
331+
HttpClientRequest.bodyJsonUnsafe({
332+
prompt: user?.text ?? "",
333+
...(user?.files?.some((file) => file.mime.startsWith("image/")) ? { has_image: true } : {}),
334+
}),
335+
),
336+
)
337+
.pipe(
338+
Effect.flatMap(HttpClientResponse.schemaBodyJson(AutoRoute)),
339+
Effect.timeout("5 seconds"),
340+
Effect.tapError((cause) => Effect.logWarning("Copilot Auto routing failed", { cause })),
341+
Effect.option,
342+
)
343+
const now = yield* Clock.currentTimeMillis
344+
if (Option.isSome(picked) && loaded.models.has(picked.value.selected_model.id))
345+
return {
346+
model: picked.value.selected_model.id,
347+
account: loaded.token,
348+
token: picked.value.session_token,
349+
// Route again before the token can expire mid-request.
350+
until: picked.value.expires_at * 1000 - 5 * 60_000,
351+
}
352+
const models = Array.from(loaded.models.values())
353+
const fallback =
354+
models.find((model) => model.is_chat_fallback) ?? models.find((model) => model.billing?.auto_discount)
355+
// Retry routing soon when the router fails or picks a model this client cannot serve.
356+
return fallback && { model: fallback.id, account: loaded.token, until: now + 5 * 60_000 }
357+
})
358+
yield* ctx.session.hook(
359+
"experimental.model.resolve",
360+
(evt) =>
361+
Effect.gen(function* () {
362+
// Titles use Copilot's utility model, so they never route.
363+
if (evt.model.id !== CopilotModels.auto || evt.kind === "title") return
364+
const now = yield* Clock.currentTimeMillis
365+
const cached = routes.get(evt.sessionID)
366+
const current =
367+
cached && cached.until > now && cached.account === discovered.current.token
368+
? cached
369+
: yield* route(evt.sessionID)
370+
if (!current) return
371+
for (const [id, route] of routes) if (route.until <= now) routes.delete(id)
372+
routes.set(evt.sessionID, current)
373+
evt.target = Model.Ref.make({ providerID: Provider.ID.githubCopilot, id: Model.ID.make(current.model) })
374+
}),
375+
{ providerID: Provider.ID.githubCopilot },
376+
)
377+
// Compaction rewrites the prompt, so the request after it routes again, like Copilot's own clients. The compaction
378+
// request itself still carries the current pick's token.
379+
yield* ctx.session.hook(
380+
"compaction",
381+
(evt) =>
382+
Effect.sync(() => {
383+
const route = routes.get(evt.sessionID)
384+
if (route) route.until = 0
297385
}),
298386
{ providerID: Provider.ID.githubCopilot },
299387
)
@@ -328,8 +416,7 @@ export const GithubCopilotPlugin = define({
328416
Effect.gen(function* () {
329417
// The Messages route sends the token as `x-api-key`, the OpenAI routes as a bearer token.
330418
const token =
331-
evt.request.headers.get("x-api-key") ??
332-
evt.request.headers.get("authorization")?.replace(/^Bearer\s+/i, "")
419+
evt.request.headers.get("x-api-key") ?? evt.request.headers.get("authorization")?.replace(/^Bearer\s+/i, "")
333420
if (!token) return
334421
const text = yield* Effect.promise(() => evt.request.clone().text())
335422
const body = Option.getOrUndefined(decodeBody(text))

‎packages/core/src/session/compaction.ts‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -284,7 +284,10 @@ export const layer = Layer.effect(
284284
const model =
285285
(agent?.model &&
286286
(yield* models
287-
.resolve({ ...context.session, model: agent.model }, catalog.available)
287+
.resolve({ ...context.session, model: agent.model }, catalog.available, {
288+
kind: "compaction",
289+
agent: agent.id,
290+
})
288291
.pipe(Effect.orElseSucceed(() => undefined)))) ??
289292
context.model
290293
const ceiling = calculateCeiling(model.limit, buffer)

‎packages/core/src/session/context.ts‎

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ import { Model } from "../model.js"
44
import { Permission } from "../permission.js"
55
import { Context, Effect, Layer } from "effect"
66
import { Agent } from "../agent.js"
7+
import type { SessionRequestKind } from "@opencode/plugin/effect/session"
78
import { CodeModeInstructions } from "../codemode/instructions.js"
89
import { Database } from "../database/database.js"
910
import { makeLocationNode } from "@opencode/util/effect/app-node"
@@ -54,6 +55,7 @@ export interface Interface {
5455
readonly load: (selection: Selection) => Effect.Effect<Loaded, SessionRunnerModel.Error>
5556
readonly resolveModel: (
5657
session: SessionSchema.Info,
58+
request: { readonly kind: SessionRequestKind; readonly agent: Agent.ID },
5759
) => Effect.Effect<SessionRunnerModel.Resolved, SessionRunnerModel.Error>
5860
/** Selects auxiliary title capabilities without instruction or tool preflight. */
5961
readonly selectTitle: (session: SessionSchema.Info) => Effect.Effect<
@@ -89,12 +91,17 @@ const layer = Layer.effect(
8991
const store = yield* SessionStore.Service
9092
const registry = yield* Tool.Service
9193

92-
const resolveModel = (session: SessionSchema.Info) => models.resolve(session, model.available)
94+
const resolveModel = (
95+
session: SessionSchema.Info,
96+
request: { readonly kind: SessionRequestKind; readonly agent: Agent.ID },
97+
) => models.resolve(session, model.available, request)
9398

9499
const selectTitle = Effect.fn("SessionContext.selectTitle")(function* (session: SessionSchema.Info) {
95100
const agent = yield* agents.get(Agent.ID.make("title"))
96101
if (!agent) return
97-
const primary = yield* resolveModel(session).pipe(Effect.orElseSucceed(() => undefined))
102+
const primary = yield* resolveModel(session, { kind: "title", agent: agent.id }).pipe(
103+
Effect.orElseSucceed(() => undefined),
104+
)
98105
const candidate = yield* Effect.gen(function* () {
99106
if (agent.model) {
100107
const info = yield* model.get(agent.model.providerID, agent.model.id)
@@ -110,14 +117,17 @@ const layer = Layer.effect(
110117
})
111118
const preferred =
112119
candidate &&
113-
(yield* resolveModel({
114-
...session,
115-
model: Model.Ref.make({
116-
providerID: candidate.info.providerID,
117-
id: candidate.info.id,
118-
...(candidate.variant ? { variant: candidate.variant } : {}),
119-
}),
120-
}).pipe(Effect.orElseSucceed(() => undefined)))
120+
(yield* resolveModel(
121+
{
122+
...session,
123+
model: Model.Ref.make({
124+
providerID: candidate.info.providerID,
125+
id: candidate.info.id,
126+
...(candidate.variant ? { variant: candidate.variant } : {}),
127+
}),
128+
},
129+
{ kind: "title", agent: agent.id },
130+
).pipe(Effect.orElseSucceed(() => undefined)))
121131
const selected = preferred ?? primary
122132
if (!selected) return
123133
return { agent, primary, selected }
@@ -166,7 +176,7 @@ const layer = Layer.effect(
166176
})
167177

168178
const load = Effect.fn("SessionContext.load")(function* (selection: Selection) {
169-
const model = yield* resolveModel(selection.session)
179+
const model = yield* resolveModel(selection.session, { kind: "primary", agent: selection.agent.id })
170180
const history = yield* SessionHistory.entriesForRunner(
171181
db,
172182
selection.session.id,

‎packages/core/src/session/generate.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ export const generate = Effect.fn("SessionGenerate.generate")(function* (input:
4444
yield* Plugin.awaitActivation
4545
const context = yield* SessionContext.Service
4646
const selection = yield* context.select(input.session.id)
47-
const model = yield* context.resolveModel(selection.session)
47+
const model = yield* context.resolveModel(selection.session, { kind: "generate", agent: selection.agent.id })
4848
const history = yield* SessionHistory.preview(database.db, selection.session.id, selection.instructions, model.ref)
4949
const transcript = SessionModelRequest.baseTranscript({
5050
agent: selection.agent.info,

‎packages/core/src/session/runner/llm.ts‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,10 @@ const layer = Layer.effect(
132132
Effect.gen(function* () {
133133
yield* plugins.awaitActivation
134134
const selected = yield* context.select(sessionID)
135-
const model = yield* context.resolveModel(selected.session)
135+
const model = yield* context.resolveModel(selected.session, {
136+
kind: "compaction",
137+
agent: selected.agent.id,
138+
})
136139
// Preview updates without admitting them after the already-delivered compaction marker.
137140
const history = yield* SessionHistory.preview(db, sessionID, selected.instructions, model.ref)
138141
return yield* compaction.compact({

0 commit comments

Comments
 (0)