Files
socraticode/tests/unit/embedding-provider.test.ts
Tomasz Szuster 332ee800a8 feat(embeddings): add LM Studio as a first-class embedding provider (#42)
LM Studio's Local Server speaks the OpenAI-compatible /v1/embeddings
protocol, so users running it as their model host (chat plus embedding in
one desktop app, GGUF model management) had no clean integration path.

Changes:

- src/services/provider-lmstudio.ts: new LMStudioEmbeddingProvider wrapping
  the OpenAI SDK with a custom baseURL (default http://localhost:1234/v1).
  Sends a placeholder API key to satisfy the OpenAI SDK while LM Studio's
  Local Server runs without auth by default. Skips the dimensions parameter
  because LM Studio models have no Matryoshka projection. Forces
  encoding_format=float to defeat the OpenAI SDK 6.x base64 default, which
  would otherwise mangle LM Studio's plain-array responses into 1024 zeros.
- src/services/embedding-config.ts: extends the EmbeddingProvider union,
  reads LMSTUDIO_URL and LMSTUDIO_API_KEY, fail-fast validation when
  EMBEDDING_PROVIDER=lmstudio without EMBEDDING_MODEL or EMBEDDING_DIMENSIONS.
- src/services/embedding-provider.ts: factory case for lmstudio with a
  dynamic import to avoid loading the OpenAI SDK at startup for ollama users.
- ensureReady distinguishes "LM Studio unreachable" from "reachable but
  embedding model not loaded" so the operator knows whether to start the
  Local Server or load the configured model.
- src/services/qdrant.ts: minor refactor to extract the hybrid-search query
  payload to a local const for readability.
- README.md: dedicated LM Studio section, MCP host config example, env-var
  table entries.
- tests/unit/embedding-config.test.ts: 8 new cases (required-env validation,
  URL default and override, optional API key, context-length override).
- tests/unit/embedding-provider.test.ts: 3 new cases (factory wiring,
  ensureReady error format against a closed port, healthCheck unreachable
  output).

Backward compatible. The lmstudio provider is opt-in via
EMBEDDING_PROVIDER=lmstudio. Existing ollama, openai, and google paths are
untouched.
2026-05-04 12:47:26 +01:00

204 lines
6.8 KiB
TypeScript

// SPDX-License-Identifier: AGPL-3.0-only
// Copyright (C) 2026 Giancarlo Erra - Altaire Limited
import { afterEach, beforeEach, describe, expect, it, } from "vitest";
import { resetEmbeddingConfig } from "../../src/services/embedding-config.js";
import { getEmbeddingProvider, resetEmbeddingProvider } from "../../src/services/embedding-provider.js";
describe("embedding-provider", () => {
const originalEnv = { ...process.env };
beforeEach(() => {
resetEmbeddingConfig();
resetEmbeddingProvider();
delete process.env.EMBEDDING_PROVIDER;
delete process.env.OLLAMA_MODE;
delete process.env.OLLAMA_URL;
delete process.env.EMBEDDING_MODEL;
delete process.env.EMBEDDING_DIMENSIONS;
delete process.env.EMBEDDING_CONTEXT_LENGTH;
delete process.env.OLLAMA_API_KEY;
delete process.env.OPENAI_API_KEY;
delete process.env.GOOGLE_API_KEY;
delete process.env.LMSTUDIO_URL;
delete process.env.LMSTUDIO_API_KEY;
});
afterEach(() => {
resetEmbeddingConfig();
resetEmbeddingProvider();
process.env = { ...originalEnv };
});
describe("factory", () => {
it("defaults to OllamaEmbeddingProvider", async () => {
const provider = await getEmbeddingProvider();
expect(provider.name).toBe("ollama");
});
it("creates OpenAIEmbeddingProvider when configured", async () => {
process.env.EMBEDDING_PROVIDER = "openai";
const provider = await getEmbeddingProvider();
expect(provider.name).toBe("openai");
});
it("creates GoogleEmbeddingProvider when configured", async () => {
process.env.EMBEDDING_PROVIDER = "google";
const provider = await getEmbeddingProvider();
expect(provider.name).toBe("google");
});
it("creates LMStudioEmbeddingProvider when configured", async () => {
process.env.EMBEDDING_PROVIDER = "lmstudio";
process.env.EMBEDDING_MODEL = "nomic-embed-text-v1.5";
process.env.EMBEDDING_DIMENSIONS = "768";
const provider = await getEmbeddingProvider();
expect(provider.name).toBe("lmstudio");
});
it("caches provider instance", async () => {
const p1 = await getEmbeddingProvider();
const p2 = await getEmbeddingProvider();
expect(p1).toBe(p2);
});
it("recreates provider when config changes", async () => {
const p1 = await getEmbeddingProvider();
expect(p1.name).toBe("ollama");
resetEmbeddingConfig();
resetEmbeddingProvider();
process.env.EMBEDDING_PROVIDER = "openai";
const p2 = await getEmbeddingProvider();
expect(p2.name).toBe("openai");
expect(p2).not.toBe(p1);
});
});
});
describe("OpenAIEmbeddingProvider", () => {
const originalEnv = { ...process.env };
beforeEach(() => {
resetEmbeddingConfig();
resetEmbeddingProvider();
delete process.env.EMBEDDING_PROVIDER;
delete process.env.OPENAI_API_KEY;
delete process.env.EMBEDDING_MODEL;
delete process.env.EMBEDDING_DIMENSIONS;
});
afterEach(() => {
resetEmbeddingConfig();
resetEmbeddingProvider();
process.env = { ...originalEnv };
});
it("throws when OPENAI_API_KEY is not set", async () => {
process.env.EMBEDDING_PROVIDER = "openai";
const provider = await getEmbeddingProvider();
await expect(provider.ensureReady()).rejects.toThrow("OPENAI_API_KEY");
});
it("reports missing API key in health check", async () => {
process.env.EMBEDDING_PROVIDER = "openai";
const provider = await getEmbeddingProvider();
const health = await provider.healthCheck();
expect(health.available).toBe(false);
expect(health.modelReady).toBe(false);
expect(health.statusLines.some((l) => l.includes("Missing"))).toBe(true);
});
});
describe("GoogleEmbeddingProvider", () => {
const originalEnv = { ...process.env };
beforeEach(() => {
resetEmbeddingConfig();
resetEmbeddingProvider();
delete process.env.EMBEDDING_PROVIDER;
delete process.env.GOOGLE_API_KEY;
delete process.env.EMBEDDING_MODEL;
delete process.env.EMBEDDING_DIMENSIONS;
});
afterEach(() => {
resetEmbeddingConfig();
resetEmbeddingProvider();
process.env = { ...originalEnv };
});
it("throws when GOOGLE_API_KEY is not set", async () => {
process.env.EMBEDDING_PROVIDER = "google";
const provider = await getEmbeddingProvider();
await expect(provider.ensureReady()).rejects.toThrow("GOOGLE_API_KEY");
});
it("reports missing API key in health check", async () => {
process.env.EMBEDDING_PROVIDER = "google";
const provider = await getEmbeddingProvider();
const health = await provider.healthCheck();
expect(health.available).toBe(false);
expect(health.modelReady).toBe(false);
expect(health.statusLines.some((l) => l.includes("Missing"))).toBe(true);
});
});
describe("LMStudioEmbeddingProvider", () => {
const originalEnv = { ...process.env };
beforeEach(() => {
resetEmbeddingConfig();
resetEmbeddingProvider();
delete process.env.EMBEDDING_PROVIDER;
delete process.env.EMBEDDING_MODEL;
delete process.env.EMBEDDING_DIMENSIONS;
delete process.env.EMBEDDING_CONTEXT_LENGTH;
delete process.env.LMSTUDIO_URL;
delete process.env.LMSTUDIO_API_KEY;
});
afterEach(() => {
resetEmbeddingConfig();
resetEmbeddingProvider();
process.env = { ...originalEnv };
});
it("ensureReady throws an actionable error when LM Studio is unreachable", async () => {
process.env.EMBEDDING_PROVIDER = "lmstudio";
process.env.EMBEDDING_MODEL = "nomic-embed-text-v1.5";
process.env.EMBEDDING_DIMENSIONS = "768";
// Point at a deliberately closed port so the request fails fast.
process.env.LMSTUDIO_URL = "http://127.0.0.1:1/v1";
const provider = await getEmbeddingProvider();
await expect(provider.ensureReady()).rejects.toThrow(
/LM Studio is not reachable at http:\/\/127\.0\.0\.1:1\/v1/,
);
});
it("healthCheck reports unreachable LM Studio without throwing", async () => {
process.env.EMBEDDING_PROVIDER = "lmstudio";
process.env.EMBEDDING_MODEL = "nomic-embed-text-v1.5";
process.env.EMBEDDING_DIMENSIONS = "768";
process.env.LMSTUDIO_URL = "http://127.0.0.1:1/v1";
const provider = await getEmbeddingProvider();
const health = await provider.healthCheck();
expect(health.available).toBe(false);
expect(health.modelReady).toBe(false);
expect(health.statusLines.some((l) => l.includes("LM Studio") && l.includes("Not reachable"))).toBe(true);
});
it("does not require LMSTUDIO_API_KEY to construct the provider", async () => {
process.env.EMBEDDING_PROVIDER = "lmstudio";
process.env.EMBEDDING_MODEL = "nomic-embed-text-v1.5";
process.env.EMBEDDING_DIMENSIONS = "768";
// Intentionally no LMSTUDIO_API_KEY.
const provider = await getEmbeddingProvider();
expect(provider.name).toBe("lmstudio");
});
});