Skip to content

Commit 32b554d

Browse files
committed
refactor(embeddings): use canonical provider identifiers
1 parent 9bcdabf commit 32b554d

8 files changed

Lines changed: 152 additions & 149 deletions

File tree

‎src/eslint.config.mjs‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,6 @@ export default [
3737
files: ["**/*.ts", "**/*.tsx"],
3838
ignores: [
3939
"**/fixtures/**",
40-
// Embedding providers are a separate domain whose identifiers only partially
41-
// overlap with the canonical API provider registry.
42-
"services/code-index/**",
43-
"shared/embeddingModels.ts",
4440
],
4541
plugins: {
4642
zoo: {

‎src/services/code-index/__tests__/config-manager.spec.ts‎

Lines changed: 82 additions & 81 deletions
Large diffs are not rendered by default.

‎src/services/code-index/__tests__/manager.spec.ts‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import { CodeIndexManager } from "../manager"
22
import { CodeIndexServiceFactory } from "../service-factory"
33
import type { MockedClass } from "vitest"
44
import * as path from "path"
5+
import { providerIdentifiers } from "@roo-code/types/provider-identifiers"
56

67
// Helper: create a mock vscode.Uri from an fsPath
78
function mockUri(fsPath: string, scheme = "file") {
@@ -181,7 +182,7 @@ describe("CodeIndexManager - handleSettingsChange regression", () => {
181182
isFeatureEnabled: true,
182183
getConfig: vi.fn().mockReturnValue({
183184
isConfigured: true,
184-
embedderProvider: "openai",
185+
embedderProvider: providerIdentifiers.openai,
185186
modelId: "text-embedding-3-small",
186187
openAiOptions: { openAiNativeApiKey: "test-key" },
187188
qdrantUrl: "http://localhost:6333",
@@ -250,7 +251,7 @@ describe("CodeIndexManager - handleSettingsChange regression", () => {
250251
isFeatureEnabled: true,
251252
getConfig: vi.fn().mockReturnValue({
252253
isConfigured: true,
253-
embedderProvider: "openai",
254+
embedderProvider: providerIdentifiers.openai,
254255
modelId: "text-embedding-3-small",
255256
openAiOptions: { openAiNativeApiKey: "test-key" },
256257
qdrantUrl: "http://localhost:6333",
@@ -380,7 +381,7 @@ describe("CodeIndexManager - handleSettingsChange regression", () => {
380381
isFeatureEnabled: true,
381382
getConfig: vitest.fn().mockReturnValue({
382383
isConfigured: true,
383-
embedderProvider: "openai",
384+
embedderProvider: providerIdentifiers.openai,
384385
modelId: "text-embedding-3-small",
385386
openAiOptions: { openAiNativeApiKey: "test-key" },
386387
qdrantUrl: "http://localhost:6333",
@@ -477,7 +478,7 @@ describe("CodeIndexManager - handleSettingsChange regression", () => {
477478
isFeatureEnabled: true,
478479
getConfig: vi.fn().mockReturnValue({
479480
isConfigured: true,
480-
embedderProvider: "openai",
481+
embedderProvider: providerIdentifiers.openai,
481482
modelId: "text-embedding-3-small",
482483
openAiOptions: { openAiNativeApiKey: "test-key" },
483484
qdrantUrl: "http://localhost:6333",
@@ -584,7 +585,7 @@ describe("CodeIndexManager - handleSettingsChange regression", () => {
584585
getGlobalState: vi.fn().mockReturnValue({
585586
codebaseIndexEnabled: true,
586587
codebaseIndexQdrantUrl: "http://localhost:6333",
587-
codebaseIndexEmbedderProvider: "openai",
588+
codebaseIndexEmbedderProvider: providerIdentifiers.openai,
588589
codebaseIndexEmbedderModelId: "text-embedding-3-small",
589590
codebaseIndexEmbedderModelDimension: 1536,
590591
codebaseIndexSearchMaxResults: 10,

‎src/services/code-index/__tests__/service-factory.spec.ts‎

Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ const MockedQdrantVectorStore = QdrantVectorStore as MockedClass<typeof QdrantVe
3838

3939
// Import the mocked functions
4040
import { getDefaultModelId, getModelDimension } from "../../../shared/embeddingModels"
41+
import { providerIdentifiers } from "@roo-code/types/provider-identifiers"
4142
const mockGetDefaultModelId = getDefaultModelId as MockedFunction<typeof getDefaultModelId>
4243
const mockGetModelDimension = getModelDimension as MockedFunction<typeof getModelDimension>
4344

@@ -63,7 +64,7 @@ describe("CodeIndexServiceFactory", () => {
6364
// Arrange
6465
const testModelId = "text-embedding-3-large"
6566
const testConfig = {
66-
embedderProvider: "openai",
67+
embedderProvider: providerIdentifiers.openai,
6768
modelId: testModelId,
6869
openAiOptions: {
6970
openAiNativeApiKey: "test-api-key",
@@ -85,7 +86,7 @@ describe("CodeIndexServiceFactory", () => {
8586
// Arrange
8687
const testModelId = "nomic-embed-text:latest"
8788
const testConfig = {
88-
embedderProvider: "ollama",
89+
embedderProvider: providerIdentifiers.ollama,
8990
modelId: testModelId,
9091
ollamaOptions: {
9192
ollamaBaseUrl: "http://localhost:11434",
@@ -106,7 +107,7 @@ describe("CodeIndexServiceFactory", () => {
106107
it("should handle undefined model ID for OpenAI embedder", () => {
107108
// Arrange
108109
const testConfig = {
109-
embedderProvider: "openai",
110+
embedderProvider: providerIdentifiers.openai,
110111
modelId: undefined,
111112
openAiOptions: {
112113
openAiNativeApiKey: "test-api-key",
@@ -127,7 +128,7 @@ describe("CodeIndexServiceFactory", () => {
127128
it("should handle undefined model ID for Ollama embedder", () => {
128129
// Arrange
129130
const testConfig = {
130-
embedderProvider: "ollama",
131+
embedderProvider: providerIdentifiers.ollama,
131132
modelId: undefined,
132133
ollamaOptions: {
133134
ollamaBaseUrl: "http://localhost:11434",
@@ -148,7 +149,7 @@ describe("CodeIndexServiceFactory", () => {
148149
it("should throw error when OpenAI API key is missing", () => {
149150
// Arrange
150151
const testConfig = {
151-
embedderProvider: "openai",
152+
embedderProvider: providerIdentifiers.openai,
152153
modelId: "text-embedding-3-large",
153154
openAiOptions: {
154155
openAiNativeApiKey: undefined,
@@ -163,7 +164,7 @@ describe("CodeIndexServiceFactory", () => {
163164
it("should throw error when Ollama base URL is missing", () => {
164165
// Arrange
165166
const testConfig = {
166-
embedderProvider: "ollama",
167+
embedderProvider: providerIdentifiers.ollama,
167168
modelId: "nomic-embed-text:latest",
168169
ollamaOptions: {
169170
ollamaBaseUrl: undefined,
@@ -270,7 +271,7 @@ describe("CodeIndexServiceFactory", () => {
270271
it("should create GeminiEmbedder with default model when no modelId specified", () => {
271272
// Arrange
272273
const testConfig = {
273-
embedderProvider: "gemini",
274+
embedderProvider: providerIdentifiers.gemini,
274275
geminiOptions: {
275276
apiKey: "test-gemini-api-key",
276277
},
@@ -287,7 +288,7 @@ describe("CodeIndexServiceFactory", () => {
287288
it("should create GeminiEmbedder with specified modelId", () => {
288289
// Arrange
289290
const testConfig = {
290-
embedderProvider: "gemini",
291+
embedderProvider: providerIdentifiers.gemini,
291292
modelId: "gemini-embedding-001",
292293
geminiOptions: {
293294
apiKey: "test-gemini-api-key",
@@ -306,7 +307,7 @@ describe("CodeIndexServiceFactory", () => {
306307
// Arrange - service-factory passes the config modelId directly;
307308
// GeminiEmbedder handles the migration internally
308309
const testConfig = {
309-
embedderProvider: "gemini",
310+
embedderProvider: providerIdentifiers.gemini,
310311
modelId: "text-embedding-004",
311312
geminiOptions: {
312313
apiKey: "test-gemini-api-key",
@@ -324,7 +325,7 @@ describe("CodeIndexServiceFactory", () => {
324325
it("should throw error when Gemini API key is missing", () => {
325326
// Arrange
326327
const testConfig = {
327-
embedderProvider: "gemini",
328+
embedderProvider: providerIdentifiers.gemini,
328329
geminiOptions: {
329330
apiKey: undefined,
330331
},
@@ -338,7 +339,7 @@ describe("CodeIndexServiceFactory", () => {
338339
it("should throw error when Gemini options are missing", () => {
339340
// Arrange
340341
const testConfig = {
341-
embedderProvider: "gemini",
342+
embedderProvider: providerIdentifiers.gemini,
342343
geminiOptions: undefined,
343344
}
344345
mockConfigManager.getConfig.mockReturnValue(testConfig as any)
@@ -381,7 +382,7 @@ describe("CodeIndexServiceFactory", () => {
381382
// Arrange
382383
const testModelId = "text-embedding-3-large"
383384
const testConfig = {
384-
embedderProvider: "openai",
385+
embedderProvider: providerIdentifiers.openai,
385386
modelId: testModelId,
386387
qdrantUrl: "http://localhost:6333",
387388
qdrantApiKey: "test-key",
@@ -406,7 +407,7 @@ describe("CodeIndexServiceFactory", () => {
406407
// Arrange
407408
const testModelId = "nomic-embed-text:latest"
408409
const testConfig = {
409-
embedderProvider: "ollama",
410+
embedderProvider: providerIdentifiers.ollama,
410411
modelId: testModelId,
411412
qdrantUrl: "http://localhost:6333",
412413
qdrantApiKey: "test-key",
@@ -592,7 +593,7 @@ describe("CodeIndexServiceFactory", () => {
592593
it("should use model-specific dimension for Gemini provider", () => {
593594
// Arrange
594595
const testConfig = {
595-
embedderProvider: "gemini",
596+
embedderProvider: providerIdentifiers.gemini,
596597
modelId: "gemini-embedding-001",
597598
qdrantUrl: "http://localhost:6333",
598599
qdrantApiKey: "test-key",
@@ -616,7 +617,7 @@ describe("CodeIndexServiceFactory", () => {
616617
it("should use default model dimension for Gemini when modelId not specified", () => {
617618
// Arrange
618619
const testConfig = {
619-
embedderProvider: "gemini",
620+
embedderProvider: providerIdentifiers.gemini,
620621
qdrantUrl: "http://localhost:6333",
621622
qdrantApiKey: "test-key",
622623
}
@@ -641,7 +642,7 @@ describe("CodeIndexServiceFactory", () => {
641642
it("should use default model when config.modelId is undefined", () => {
642643
// Arrange
643644
const testConfig = {
644-
embedderProvider: "openai",
645+
embedderProvider: providerIdentifiers.openai,
645646
modelId: undefined,
646647
qdrantUrl: "http://localhost:6333",
647648
qdrantApiKey: "test-key",
@@ -665,7 +666,7 @@ describe("CodeIndexServiceFactory", () => {
665666
it("should throw error when vector dimension cannot be determined", () => {
666667
// Arrange
667668
const testConfig = {
668-
embedderProvider: "openai",
669+
embedderProvider: providerIdentifiers.openai,
669670
modelId: "unknown-model",
670671
qdrantUrl: "http://localhost:6333",
671672
qdrantApiKey: "test-key",
@@ -680,7 +681,7 @@ describe("CodeIndexServiceFactory", () => {
680681
it("should throw error when Qdrant URL is missing", () => {
681682
// Arrange
682683
const testConfig = {
683-
embedderProvider: "openai",
684+
embedderProvider: providerIdentifiers.openai,
684685
modelId: "text-embedding-3-small",
685686
qdrantUrl: undefined,
686687
qdrantApiKey: "test-key",
@@ -716,7 +717,7 @@ describe("CodeIndexServiceFactory", () => {
716717
it("should validate OpenAI embedder successfully", async () => {
717718
// Arrange
718719
const testConfig = {
719-
embedderProvider: "openai",
720+
embedderProvider: providerIdentifiers.openai,
720721
modelId: "text-embedding-3-small",
721722
openAiOptions: {
722723
openAiNativeApiKey: "test-api-key",
@@ -740,7 +741,7 @@ describe("CodeIndexServiceFactory", () => {
740741
it("should return validation error from OpenAI embedder", async () => {
741742
// Arrange
742743
const testConfig = {
743-
embedderProvider: "openai",
744+
embedderProvider: providerIdentifiers.openai,
744745
modelId: "text-embedding-3-small",
745746
openAiOptions: {
746747
openAiNativeApiKey: "invalid-key",
@@ -769,7 +770,7 @@ describe("CodeIndexServiceFactory", () => {
769770
it("should validate Ollama embedder successfully", async () => {
770771
// Arrange
771772
const testConfig = {
772-
embedderProvider: "ollama",
773+
embedderProvider: providerIdentifiers.ollama,
773774
modelId: "nomic-embed-text",
774775
ollamaOptions: {
775776
ollamaBaseUrl: "http://localhost:11434",
@@ -818,7 +819,7 @@ describe("CodeIndexServiceFactory", () => {
818819
it("should validate Gemini embedder successfully", async () => {
819820
// Arrange
820821
const testConfig = {
821-
embedderProvider: "gemini",
822+
embedderProvider: providerIdentifiers.gemini,
822823
geminiOptions: {
823824
apiKey: "test-gemini-api-key",
824825
},
@@ -841,7 +842,7 @@ describe("CodeIndexServiceFactory", () => {
841842
it("should handle validation exceptions", async () => {
842843
// Arrange
843844
const testConfig = {
844-
embedderProvider: "openai",
845+
embedderProvider: providerIdentifiers.openai,
845846
modelId: "text-embedding-3-small",
846847
openAiOptions: {
847848
openAiNativeApiKey: "test-api-key",
@@ -869,7 +870,7 @@ describe("CodeIndexServiceFactory", () => {
869870
it("should return error for invalid embedder configuration", async () => {
870871
// Arrange
871872
const testConfig = {
872-
embedderProvider: "openai",
873+
embedderProvider: providerIdentifiers.openai,
873874
modelId: "text-embedding-3-small",
874875
openAiOptions: {
875876
openAiNativeApiKey: undefined, // Missing API key

‎src/services/code-index/config-manager.ts‎

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ import { EmbedderProvider } from "./interfaces/manager"
44
import { CodeIndexConfig, PreviousConfigSnapshot } from "./interfaces/config"
55
import { DEFAULT_SEARCH_MIN_SCORE, DEFAULT_MAX_SEARCH_RESULTS } from "./constants"
66
import { getDefaultModelId, getModelDimension, getModelScoreThreshold } from "../../shared/embeddingModels"
7+
import { providerIdentifiers } from "@roo-code/types/provider-identifiers"
78

89
/**
910
* Manages configuration state and validation for the code indexing feature.
@@ -48,7 +49,7 @@ export class CodeIndexConfigManager {
4849
const codebaseIndexConfig = this.contextProxy?.getGlobalState("codebaseIndexConfig") ?? {
4950
codebaseIndexEnabled: false,
5051
codebaseIndexQdrantUrl: "http://localhost:6333",
51-
codebaseIndexEmbedderProvider: "openai",
52+
codebaseIndexEmbedderProvider: providerIdentifiers.openai,
5253
codebaseIndexEmbedderBaseUrl: "",
5354
codebaseIndexEmbedderModelId: "",
5455
codebaseIndexSearchMinScore: undefined,
@@ -106,24 +107,24 @@ export class CodeIndexConfigManager {
106107
this.openAiOptions = { openAiNativeApiKey: openAiKey }
107108

108109
// Set embedder provider with support for openai-compatible
109-
if (codebaseIndexEmbedderProvider === "ollama") {
110-
this.embedderProvider = "ollama"
110+
if (codebaseIndexEmbedderProvider === providerIdentifiers.ollama) {
111+
this.embedderProvider = providerIdentifiers.ollama
111112
} else if (codebaseIndexEmbedderProvider === "openai-compatible") {
112113
this.embedderProvider = "openai-compatible"
113-
} else if (codebaseIndexEmbedderProvider === "gemini") {
114-
this.embedderProvider = "gemini"
115-
} else if (codebaseIndexEmbedderProvider === "mistral") {
116-
this.embedderProvider = "mistral"
117-
} else if (codebaseIndexEmbedderProvider === "vercel-ai-gateway") {
118-
this.embedderProvider = "vercel-ai-gateway"
114+
} else if (codebaseIndexEmbedderProvider === providerIdentifiers.gemini) {
115+
this.embedderProvider = providerIdentifiers.gemini
116+
} else if (codebaseIndexEmbedderProvider === providerIdentifiers.mistral) {
117+
this.embedderProvider = providerIdentifiers.mistral
118+
} else if (codebaseIndexEmbedderProvider === providerIdentifiers.vercelAiGateway) {
119+
this.embedderProvider = providerIdentifiers.vercelAiGateway
119120
} else if ((codebaseIndexEmbedderProvider as string) === "bedrock") {
120-
this.embedderProvider = "bedrock"
121-
} else if (codebaseIndexEmbedderProvider === "openrouter") {
122-
this.embedderProvider = "openrouter"
121+
this.embedderProvider = providerIdentifiers.bedrock
122+
} else if (codebaseIndexEmbedderProvider === providerIdentifiers.openrouter) {
123+
this.embedderProvider = providerIdentifiers.openrouter
123124
} else if (codebaseIndexEmbedderProvider === "semble") {
124125
this.embedderProvider = "semble"
125126
} else {
126-
this.embedderProvider = "openai"
127+
this.embedderProvider = providerIdentifiers.openai
127128
}
128129

129130
this.modelId = codebaseIndexEmbedderModelId || undefined
@@ -238,11 +239,11 @@ export class CodeIndexConfigManager {
238239
return true
239240
}
240241

241-
if (this.embedderProvider === "openai") {
242+
if (this.embedderProvider === providerIdentifiers.openai) {
242243
const openAiKey = this.openAiOptions?.openAiNativeApiKey
243244
const qdrantUrl = this.qdrantUrl
244245
return !!(openAiKey && qdrantUrl)
245-
} else if (this.embedderProvider === "ollama") {
246+
} else if (this.embedderProvider === providerIdentifiers.ollama) {
246247
// Ollama model ID has a default, so only base URL is strictly required for config
247248
const ollamaBaseUrl = this.ollamaOptions?.ollamaBaseUrl
248249
const qdrantUrl = this.qdrantUrl
@@ -253,28 +254,28 @@ export class CodeIndexConfigManager {
253254
const qdrantUrl = this.qdrantUrl
254255
const isConfigured = !!(baseUrl && apiKey && qdrantUrl)
255256
return isConfigured
256-
} else if (this.embedderProvider === "gemini") {
257+
} else if (this.embedderProvider === providerIdentifiers.gemini) {
257258
const apiKey = this.geminiOptions?.apiKey
258259
const qdrantUrl = this.qdrantUrl
259260
const isConfigured = !!(apiKey && qdrantUrl)
260261
return isConfigured
261-
} else if (this.embedderProvider === "mistral") {
262+
} else if (this.embedderProvider === providerIdentifiers.mistral) {
262263
const apiKey = this.mistralOptions?.apiKey
263264
const qdrantUrl = this.qdrantUrl
264265
const isConfigured = !!(apiKey && qdrantUrl)
265266
return isConfigured
266-
} else if (this.embedderProvider === "vercel-ai-gateway") {
267+
} else if (this.embedderProvider === providerIdentifiers.vercelAiGateway) {
267268
const apiKey = this.vercelAiGatewayOptions?.apiKey
268269
const qdrantUrl = this.qdrantUrl
269270
const isConfigured = !!(apiKey && qdrantUrl)
270271
return isConfigured
271-
} else if (this.embedderProvider === "bedrock") {
272+
} else if (this.embedderProvider === providerIdentifiers.bedrock) {
272273
// Only region is required for Bedrock (profile is optional)
273274
const region = this.bedrockOptions?.region
274275
const qdrantUrl = this.qdrantUrl
275276
const isConfigured = !!(region && qdrantUrl)
276277
return isConfigured
277-
} else if (this.embedderProvider === "openrouter") {
278+
} else if (this.embedderProvider === providerIdentifiers.openrouter) {
278279
const apiKey = this.openRouterOptions?.apiKey
279280
const qdrantUrl = this.qdrantUrl
280281
const isConfigured = !!(apiKey && qdrantUrl)

0 commit comments

Comments
 (0)