Skip to content

Commit 9081dde

Browse files
authored
refactor(webview): canonicalize provider and model message identifiers (#1143)
* refactor(webview): canonicalize provider settings identifiers * refactor(webview): centralize model message identifiers
1 parent 8cac2ac commit 9081dde

39 files changed

Lines changed: 1072 additions & 186 deletions
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
import {
2+
OllamaModelsMessageType,
3+
ollamaModelsMessageTypeSchema,
4+
ollamaModelsMessageTypes,
5+
} from "../providers/ollama.js"
6+
import { OpenAiModelsMessageType, openAiModelsMessageTypeSchema } from "../providers/openai.js"
7+
import { LmStudioModelsMessageType, lmStudioModelsMessageTypeSchema } from "../providers/lm-studio.js"
8+
import { VsCodeLmModelsMessageType, vsCodeLmModelsMessageTypeSchema } from "../providers/vscode-llm.js"
9+
10+
describe("OllamaModelsMessageType", () => {
11+
it("exposes the request and response message types", () => {
12+
expect(ollamaModelsMessageTypes).toEqual(["requestOllamaModels", "ollamaModels"])
13+
expect(OllamaModelsMessageType.requestOllamaModels).toBe("requestOllamaModels")
14+
expect(OllamaModelsMessageType.ollamaModels).toBe("ollamaModels")
15+
})
16+
17+
it("validates supported message types", () => {
18+
expect(ollamaModelsMessageTypeSchema.safeParse("requestOllamaModels").success).toBe(true)
19+
expect(ollamaModelsMessageTypeSchema.safeParse("ollamaModels").success).toBe(true)
20+
expect(ollamaModelsMessageTypeSchema.safeParse("requestUnknownModels").success).toBe(false)
21+
})
22+
})
23+
24+
describe.each([
25+
["OpenAI", OpenAiModelsMessageType, openAiModelsMessageTypeSchema, "requestOpenAiModels", "openAiModels"],
26+
[
27+
"LM Studio",
28+
LmStudioModelsMessageType,
29+
lmStudioModelsMessageTypeSchema,
30+
"requestLmStudioModels",
31+
"lmStudioModels",
32+
],
33+
[
34+
"VS Code LM",
35+
VsCodeLmModelsMessageType,
36+
vsCodeLmModelsMessageTypeSchema,
37+
"requestVsCodeLmModels",
38+
"vsCodeLmModels",
39+
],
40+
])("%s model message types", (_provider, messageType, schema, requestType, responseType) => {
41+
it("exposes and validates its request and response types", () => {
42+
expect(messageType).toMatchObject({ [requestType]: requestType, [responseType]: responseType })
43+
expect(schema.safeParse(requestType).success).toBe(true)
44+
expect(schema.safeParse(responseType).success).toBe(true)
45+
expect(schema.safeParse("unknownModelsMessage").success).toBe(false)
46+
})
47+
})

‎packages/types/src/__tests__/nanogpt.test.ts‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,16 @@ import {
1313
describe("NanoGPT shared contract", () => {
1414
it("registers the stable dynamic-provider identity and default model", () => {
1515
expect(providerIdentifiers.nanogpt).toBe("nanogpt")
16-
expect(dynamicProviders).toContain("nanogpt")
17-
expect(getProviderDefaultModelId("nanogpt")).toBe(nanoGptDefaultModelId)
16+
expect(dynamicProviders).toContain(providerIdentifiers.nanogpt)
17+
expect(getProviderDefaultModelId(providerIdentifiers.nanogpt)).toBe(nanoGptDefaultModelId)
1818
})
1919

2020
it("classifies the API key as secret and resolves missing routing to auto", () => {
2121
expect(isSecretStateKey("nanoGptApiKey")).toBe(true)
22-
const settings = providerSettingsSchema.parse({ apiProvider: "nanogpt", nanoGptModelId: "model" })
22+
const settings = providerSettingsSchema.parse({
23+
apiProvider: providerIdentifiers.nanogpt,
24+
nanoGptModelId: "model",
25+
})
2326
expect(settings.nanoGptRoutingPreference ?? nanoGptDefaultRoutingPreference).toBe("auto")
2427
expect(getModelId(settings)).toBe("model")
2528
})

‎packages/types/src/model.ts‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -186,3 +186,18 @@ export type ModelInfo = z.infer<typeof modelInfoSchema>
186186
export type ModelRecord = Record<string, ModelInfo>
187187

188188
export type RouterModels = Record<DynamicProvider | LocalProvider, ModelRecord>
189+
190+
export const routerModelsMessageTypes = [
191+
"flushRouterModels",
192+
"requestRouterModels",
193+
"routerModels",
194+
"singleRouterModelFetchResponse",
195+
] as const
196+
197+
export const routerModelsMessageTypeSchema = z.enum(routerModelsMessageTypes)
198+
199+
export const RouterModelsMessageType = routerModelsMessageTypeSchema.enum
200+
201+
export type RouterModelsMessageType = z.infer<typeof routerModelsMessageTypeSchema>
202+
203+
export const allRouterModelsProvider = "all" as const

‎packages/types/src/providers/lm-studio.ts‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
1+
import { z } from "zod"
2+
13
import type { ModelInfo } from "../model.js"
24

5+
export const lmStudioModelsMessageTypes = ["requestLmStudioModels", "lmStudioModels"] as const
6+
7+
export const lmStudioModelsMessageTypeSchema = z.enum(lmStudioModelsMessageTypes)
8+
9+
export const LmStudioModelsMessageType = lmStudioModelsMessageTypeSchema.enum
10+
11+
export type LmStudioModelsMessageType = z.infer<typeof lmStudioModelsMessageTypeSchema>
12+
313
export const LMSTUDIO_DEFAULT_TEMPERATURE = 0
414

515
// LM Studio

‎packages/types/src/providers/ollama.ts‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,17 @@
1+
import { z } from "zod"
2+
13
import type { ModelInfo } from "../model.js"
24

35
// Ollama
46
// https://ollama.com/models
7+
export const ollamaModelsMessageTypes = ["requestOllamaModels", "ollamaModels"] as const
8+
9+
export const ollamaModelsMessageTypeSchema = z.enum(ollamaModelsMessageTypes)
10+
11+
export const OllamaModelsMessageType = ollamaModelsMessageTypeSchema.enum
12+
13+
export type OllamaModelsMessageType = z.infer<typeof ollamaModelsMessageTypeSchema>
14+
515
export const ollamaDefaultModelId = "devstral:24b"
616
export const ollamaDefaultModelInfo: ModelInfo = {
717
maxTokens: 4096,

‎packages/types/src/providers/openai.ts‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
1+
import { z } from "zod"
2+
13
import type { ModelInfo } from "../model.js"
24

35
// https://openai.com/api/pricing/
6+
export const openAiModelsMessageTypes = ["requestOpenAiModels", "openAiModels"] as const
7+
8+
export const openAiModelsMessageTypeSchema = z.enum(openAiModelsMessageTypes)
9+
10+
export const OpenAiModelsMessageType = openAiModelsMessageTypeSchema.enum
11+
12+
export type OpenAiModelsMessageType = z.infer<typeof openAiModelsMessageTypeSchema>
13+
414
export type OpenAiNativeModelId = keyof typeof openAiNativeModels
515

616
export const OPENAI_API_PROTOCOL = "openai"

‎packages/types/src/providers/vscode-llm.ts‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
1+
import { z } from "zod"
2+
13
import type { ModelInfo } from "../model.js"
24

5+
export const vsCodeLmModelsMessageTypes = ["requestVsCodeLmModels", "vsCodeLmModels"] as const
6+
7+
export const vsCodeLmModelsMessageTypeSchema = z.enum(vsCodeLmModelsMessageTypes)
8+
9+
export const VsCodeLmModelsMessageType = vsCodeLmModelsMessageTypeSchema.enum
10+
11+
export type VsCodeLmModelsMessageType = z.infer<typeof vsCodeLmModelsMessageTypeSchema>
12+
313
export type VscodeLlmModelId = keyof typeof vscodeLlmModels
414

515
export const vscodeLlmDefaultModelId: VscodeLlmModelId = "claude-sonnet-4.5"

‎packages/types/src/vscode-extension-host.ts‎

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,11 @@ import type { CloudUserInfo, CloudOrganizationMembership, OrganizationAllowList,
1212
import type { SerializedCustomToolDefinition } from "./custom-tool.js"
1313
import type { GitCommit } from "./git.js"
1414
import type { McpServer } from "./mcp.js"
15-
import type { ModelRecord, RouterModels } from "./model.js"
15+
import { RouterModelsMessageType, type ModelRecord, type RouterModels } from "./model.js"
16+
import { LmStudioModelsMessageType } from "./providers/lm-studio.js"
17+
import { OllamaModelsMessageType } from "./providers/ollama.js"
18+
import { OpenAiModelsMessageType } from "./providers/openai.js"
19+
import { VsCodeLmModelsMessageType } from "./providers/vscode-llm.js"
1620
import type { OpenAiCodexRateLimitInfo } from "./providers/openai-codex-rate-limits.js"
1721
import type { SkillMetadata } from "./skills.js"
1822
import type { RuleMetadata } from "./rules.js"
@@ -38,12 +42,12 @@ export interface ExtensionMessage {
3842
| "enhancedPrompt"
3943
| "commitSearchResults"
4044
| "listApiConfig"
41-
| "routerModels"
45+
| typeof RouterModelsMessageType.routerModels
4246
| "zooGatewayCredentialsReady"
43-
| "openAiModels"
44-
| "ollamaModels"
45-
| "lmStudioModels"
46-
| "vsCodeLmModels"
47+
| typeof OpenAiModelsMessageType.openAiModels
48+
| typeof OllamaModelsMessageType.ollamaModels
49+
| typeof LmStudioModelsMessageType.lmStudioModels
50+
| typeof VsCodeLmModelsMessageType.vsCodeLmModels
4751
| "vsCodeLmApiAvailable"
4852
| "updatePrompt"
4953
| "systemPrompt"
@@ -69,7 +73,7 @@ export interface ExtensionMessage {
6973
| "authenticatedUser"
7074
| "condenseTaskContextStarted"
7175
| "condenseTaskContextResponse"
72-
| "singleRouterModelFetchResponse"
76+
| typeof RouterModelsMessageType.singleRouterModelFetchResponse
7377
| "indexingStatusUpdate"
7478
| "indexCleared"
7579
| "codebaseIndexConfig"
@@ -474,13 +478,13 @@ export interface WebviewMessage {
474478
| "importSettings"
475479
| "exportSettings"
476480
| "resetState"
477-
| "flushRouterModels"
478-
| "requestRouterModels"
479-
| "requestOpenAiModels"
480-
| "requestOllamaModels"
481-
| "requestLmStudioModels"
481+
| typeof RouterModelsMessageType.flushRouterModels
482+
| typeof RouterModelsMessageType.requestRouterModels
483+
| typeof OpenAiModelsMessageType.requestOpenAiModels
484+
| typeof OllamaModelsMessageType.requestOllamaModels
485+
| typeof LmStudioModelsMessageType.requestLmStudioModels
482486
| "requestRooModels"
483-
| "requestVsCodeLmModels"
487+
| typeof VsCodeLmModelsMessageType.requestVsCodeLmModels
484488
| "openImage"
485489
| "saveImage"
486490
| "openFile"

‎src/api/providers/__tests__/nanogpt.spec.ts‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ vi.mock("vscode", () => ({
55
import { Anthropic } from "@anthropic-ai/sdk"
66
import OpenAI from "openai"
77

8-
import { nanoGptDefaultModelId } from "@roo-code/types"
8+
import { nanoGptDefaultModelId, providerIdentifiers } from "@roo-code/types"
99

1010
import { buildApiHandler } from "../../index"
1111
import { asyncStreamFrom, collectStream } from "../../../test-utils/stream"
@@ -49,7 +49,7 @@ describe("NanoGptHandler", () => {
4949
})
5050

5151
it("is constructed by the backend provider registry", () => {
52-
expect(buildApiHandler({ apiProvider: "nanogpt" })).toBeInstanceOf(NanoGptHandler)
52+
expect(buildApiHandler({ apiProvider: providerIdentifiers.nanogpt })).toBeInstanceOf(NanoGptHandler)
5353
})
5454

5555
it("keeps the canonical model ID while applying request-only routing", async () => {
@@ -187,7 +187,9 @@ describe("NanoGptHandler", () => {
187187
vi.mocked(getModels).mockResolvedValue({})
188188
mockCreate.mockResolvedValue(asyncStreamFrom([]))
189189
await collectStream(new NanoGptHandler({ nanoGptModelId: "model:thinking" }).createMessage("sys", messages))
190-
expect(getModels).toHaveBeenLastCalledWith(expect.objectContaining({ provider: "nanogpt", apiKey: undefined }))
190+
expect(getModels).toHaveBeenLastCalledWith(
191+
expect.objectContaining({ provider: providerIdentifiers.nanogpt, apiKey: undefined }),
192+
)
191193
})
192194

193195
it("maps usage with root-field precedence and no reasoning double count", async () => {

‎src/api/providers/nanogpt.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ import {
66
NANOGPT_BASE_URL,
77
nanoGptDefaultModelId,
88
nanoGptDefaultModelInfo,
9+
providerIdentifiers,
910
type NanoGptRoutingPreference,
1011
} from "@roo-code/types"
1112

@@ -58,7 +59,7 @@ export class NanoGptHandler extends RouterProvider implements SingleCompletionHa
5859
constructor(options: ApiHandlerOptions) {
5960
super({
6061
options,
61-
name: "nanogpt",
62+
name: providerIdentifiers.nanogpt,
6263
baseURL: NANOGPT_BASE_URL,
6364
apiKey: options.nanoGptApiKey,
6465
modelId: options.nanoGptModelId,

0 commit comments

Comments
 (0)