Skip to content

Commit ac8170e

Browse files
committed
refactor(code-index): separate service factories and embedder validation
1 parent 1803c01 commit ac8170e

24 files changed

Lines changed: 900 additions & 280 deletions

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

Lines changed: 197 additions & 54 deletions
Large diffs are not rendered by default.
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
import { TelemetryService } from "@roo-code/telemetry"
2+
import { TelemetryEventName } from "@roo-code/types"
3+
import { OpenAiEmbedder } from "../openai"
4+
import { EmbedderValidationManager } from "../embedder-validation-manager"
5+
6+
vi.mock("../openai")
7+
vi.mock("@roo-code/telemetry", () => ({
8+
TelemetryService: { instance: { captureEvent: vi.fn() } },
9+
}))
10+
11+
describe("EmbedderValidationManager", () => {
12+
const manager = new EmbedderValidationManager()
13+
14+
beforeEach(() => vi.clearAllMocks())
15+
16+
it.each([{ valid: true }, { valid: false, error: "Invalid credentials" }])(
17+
"preserves the validation result %j without reporting an exception",
18+
async (result) => {
19+
const embedder = new OpenAiEmbedder({ openAiNativeApiKey: "test-key" })
20+
vi.mocked(embedder.validateConfiguration).mockResolvedValue(result)
21+
22+
expect(await manager.validateEmbedder(embedder)).toBe(result)
23+
expect(embedder.validateConfiguration).toHaveBeenCalledExactlyOnceWith()
24+
expect(TelemetryService.instance.captureEvent).not.toHaveBeenCalled()
25+
},
26+
)
27+
28+
it("preserves an exception's message and reports its stack", async () => {
29+
const embedder = new OpenAiEmbedder({ openAiNativeApiKey: "test-key" })
30+
const error = new Error("Connection failed")
31+
vi.mocked(embedder.validateConfiguration).mockRejectedValue(error)
32+
33+
expect(await manager.validateEmbedder(embedder)).toEqual({ valid: false, error: error.message })
34+
expect(TelemetryService.instance.captureEvent).toHaveBeenCalledExactlyOnceWith(
35+
TelemetryEventName.CODE_INDEX_ERROR,
36+
{ error: error.message, stack: error.stack, location: "validateEmbedder" },
37+
)
38+
})
39+
40+
it.each(["unavailable", null, undefined])("handles non-Error rejection %s", async (error) => {
41+
const embedder = new OpenAiEmbedder({ openAiNativeApiKey: "test-key" })
42+
vi.mocked(embedder.validateConfiguration).mockRejectedValue(error)
43+
44+
expect(await manager.validateEmbedder(embedder)).toEqual({
45+
valid: false,
46+
error: "embeddings:validation.configurationError",
47+
})
48+
expect(TelemetryService.instance.captureEvent).toHaveBeenCalledExactlyOnceWith(
49+
TelemetryEventName.CODE_INDEX_ERROR,
50+
{ error: String(error), stack: undefined, location: "validateEmbedder" },
51+
)
52+
})
53+
})
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
import { providerIdentifiers } from "@roo-code/types/provider-identifiers"
2+
3+
import { t } from "../../../i18n"
4+
import type { CodeIndexConfig } from "../interfaces/config"
5+
import type { IEmbedder } from "../interfaces"
6+
import type { IEmbedderFactory } from "../interfaces/embedder-factory"
7+
import { OpenAiEmbedderFactory } from "./factories/openai-embedder-factory"
8+
import { OllamaEmbedderFactory } from "./factories/ollama-embedder-factory"
9+
import { OpenAICompatibleEmbedderFactory } from "./factories/openai-compatible-embedder-factory"
10+
import { GeminiEmbedderFactory } from "./factories/gemini-embedder-factory"
11+
import { MistralEmbedderFactory } from "./factories/mistral-embedder-factory"
12+
import { VercelAiGatewayEmbedderFactory } from "./factories/vercel-ai-gateway-embedder-factory"
13+
import { BedrockEmbedderFactory } from "./factories/bedrock-embedder-factory"
14+
import { OpenRouterEmbedderFactory } from "./factories/openrouter-embedder-factory"
15+
16+
type VectorEmbedderProvider = Exclude<CodeIndexConfig["embedderProvider"], "semble">
17+
18+
export class EmbedderFactory implements IEmbedderFactory {
19+
// Each provider owns its constructor arguments and validation. The record requires
20+
// an entry for every vector embedder provider when the supported union changes.
21+
// TODO: Inject the provider factory registry via DI instead of constructing factories here.
22+
// https://github.com/Zoo-Code-Org/Zoo-Code/issues/1817
23+
private readonly embedderFactories: Readonly<Record<VectorEmbedderProvider, IEmbedderFactory>> = {
24+
[providerIdentifiers.openai]: new OpenAiEmbedderFactory(),
25+
[providerIdentifiers.ollama]: new OllamaEmbedderFactory(),
26+
"openai-compatible": new OpenAICompatibleEmbedderFactory(),
27+
[providerIdentifiers.gemini]: new GeminiEmbedderFactory(),
28+
[providerIdentifiers.mistral]: new MistralEmbedderFactory(),
29+
[providerIdentifiers.vercelAiGateway]: new VercelAiGatewayEmbedderFactory(),
30+
[providerIdentifiers.bedrock]: new BedrockEmbedderFactory(),
31+
[providerIdentifiers.openrouter]: new OpenRouterEmbedderFactory(),
32+
}
33+
34+
public create(config: CodeIndexConfig): IEmbedder {
35+
const provider = config.embedderProvider
36+
37+
// Semble is a self-contained search binary, not a vector embedder.
38+
if (provider === "semble") {
39+
throw new Error(
40+
"Semble provider handles its own embedding. Do not call createEmbedder() for semble — use SembleProvider instead.",
41+
)
42+
}
43+
44+
// Keep a runtime guard for invalid persisted configuration, including prototype keys.
45+
if (!Object.prototype.hasOwnProperty.call(this.embedderFactories, provider)) {
46+
throw new Error(t("embeddings:serviceFactory.invalidEmbedderType", { embedderProvider: provider }))
47+
}
48+
49+
return this.embedderFactories[provider].create(config)
50+
}
51+
}
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
import { TelemetryService } from "@roo-code/telemetry"
2+
import { TelemetryEventName } from "@roo-code/types"
3+
import type { IEmbedder } from "../interfaces"
4+
5+
export class EmbedderValidationManager {
6+
public async validateEmbedder(embedder: IEmbedder): Promise<{ valid: boolean; error?: string }> {
7+
try {
8+
return await embedder.validateConfiguration()
9+
} catch (error) {
10+
TelemetryService.instance.captureEvent(TelemetryEventName.CODE_INDEX_ERROR, {
11+
error: error instanceof Error ? error.message : String(error),
12+
stack: error instanceof Error ? error.stack : undefined,
13+
location: "validateEmbedder",
14+
})
15+
16+
return {
17+
valid: false,
18+
error: error instanceof Error ? error.message : "embeddings:validation.configurationError",
19+
}
20+
}
21+
}
22+
}
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
import type { CodeIndexConfig } from "../../interfaces/config"
2+
import type { IEmbedderFactory } from "../../interfaces/embedder-factory"
3+
import { BedrockEmbedder } from "../bedrock"
4+
import { requireSetting } from "./require-setting"
5+
6+
export class BedrockEmbedderFactory implements IEmbedderFactory {
7+
create({ bedrockOptions, modelId }: CodeIndexConfig): BedrockEmbedder {
8+
return new BedrockEmbedder(
9+
requireSetting(bedrockOptions?.region, "embeddings:serviceFactory.bedrockConfigMissing"),
10+
bedrockOptions?.profile,
11+
modelId,
12+
)
13+
}
14+
}
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
import type { CodeIndexConfig } from "../../interfaces/config"
2+
import type { IEmbedderFactory } from "../../interfaces/embedder-factory"
3+
import { GeminiEmbedder } from "../gemini"
4+
import { requireSetting } from "./require-setting"
5+
6+
export class GeminiEmbedderFactory implements IEmbedderFactory {
7+
create({ geminiOptions, modelId }: CodeIndexConfig): GeminiEmbedder {
8+
return new GeminiEmbedder(
9+
requireSetting(geminiOptions?.apiKey, "embeddings:serviceFactory.geminiConfigMissing"),
10+
modelId,
11+
)
12+
}
13+
}
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
import type { CodeIndexConfig } from "../../interfaces/config"
2+
import type { IEmbedderFactory } from "../../interfaces/embedder-factory"
3+
import { MistralEmbedder } from "../mistral"
4+
import { requireSetting } from "./require-setting"
5+
6+
export class MistralEmbedderFactory implements IEmbedderFactory {
7+
create({ mistralOptions, modelId }: CodeIndexConfig): MistralEmbedder {
8+
return new MistralEmbedder(
9+
requireSetting(mistralOptions?.apiKey, "embeddings:serviceFactory.mistralConfigMissing"),
10+
modelId,
11+
)
12+
}
13+
}
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
import type { CodeIndexConfig } from "../../interfaces/config"
2+
import type { IEmbedderFactory } from "../../interfaces/embedder-factory"
3+
import { CodeIndexOllamaEmbedder } from "../ollama"
4+
import { requireSetting } from "./require-setting"
5+
6+
export class OllamaEmbedderFactory implements IEmbedderFactory {
7+
create({ ollamaOptions, modelId }: CodeIndexConfig): CodeIndexOllamaEmbedder {
8+
return new CodeIndexOllamaEmbedder({
9+
...ollamaOptions,
10+
ollamaBaseUrl: requireSetting(
11+
ollamaOptions?.ollamaBaseUrl,
12+
"embeddings:serviceFactory.ollamaConfigMissing",
13+
),
14+
ollamaModelId: modelId,
15+
})
16+
}
17+
}
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
import type { CodeIndexConfig } from "../../interfaces/config"
2+
import type { IEmbedderFactory } from "../../interfaces/embedder-factory"
3+
import { OpenAICompatibleEmbedder } from "../openai-compatible"
4+
import { requireSetting } from "./require-setting"
5+
6+
export class OpenAICompatibleEmbedderFactory implements IEmbedderFactory {
7+
create({ openAiCompatibleOptions, modelId }: CodeIndexConfig): OpenAICompatibleEmbedder {
8+
return new OpenAICompatibleEmbedder(
9+
requireSetting(openAiCompatibleOptions?.baseUrl, "embeddings:serviceFactory.openAiCompatibleConfigMissing"),
10+
requireSetting(openAiCompatibleOptions?.apiKey, "embeddings:serviceFactory.openAiCompatibleConfigMissing"),
11+
modelId,
12+
)
13+
}
14+
}
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
import type { CodeIndexConfig } from "../../interfaces/config"
2+
import type { IEmbedderFactory } from "../../interfaces/embedder-factory"
3+
import { OpenAiEmbedder } from "../openai"
4+
import { requireSetting } from "./require-setting"
5+
6+
export class OpenAiEmbedderFactory implements IEmbedderFactory {
7+
create({ openAiOptions, modelId }: CodeIndexConfig): OpenAiEmbedder {
8+
return new OpenAiEmbedder({
9+
...openAiOptions,
10+
openAiNativeApiKey: requireSetting(
11+
openAiOptions?.openAiNativeApiKey,
12+
"embeddings:serviceFactory.openAiConfigMissing",
13+
),
14+
openAiEmbeddingModelId: modelId,
15+
})
16+
}
17+
}

0 commit comments

Comments
 (0)