mirror of
https://github.com/diegosouzapw/OmniRoute.git
synced 2026-08-01 04:42:10 +03:00
Add POST /v1/search — a unified search endpoint routing queries across 5 providers (Serper, Brave, Perplexity Search, Exa, Tavily) with automatic failover, in-memory caching, and request coalescing. No open-source AI gateway offers unified search routing. This chains free tiers for 5,500+ searches/month with zero downtime. Providers: Serper ($0.001/q, 2500/mo free), Brave ($0.005/q, 1000/mo), Perplexity Search ($0.005/q), Exa ($0.007/q, 1000/mo), Tavily ($0.008/q, 1000/mo). Auto-select picks cheapest with credentials. Architecture follows existing patterns: - searchRegistry.ts (same as embeddingRegistry.ts) - search.ts handler (same as embeddings.ts) - route.ts (same as /v1/embeddings/route.ts) - searchCache.ts (bounded TTL cache + request coalescing) Schema finalized — all future fields defined as optional with safe defaults. No breaking changes when implementing content extraction, answer synthesis, or ranking. Key features: - Per-provider request builders and response normalizers - Enriched response: display_url, score, favicon_url, content block, metadata, answer block, errors array, upstream_latency_ms metrics - Cost-sorted auto-select with failover on 429/5xx/timeout - Credential fallback (perplexity-search reuses perplexity chat key) - Cache key includes all result-affecting parameters - max_results clamped to provider limits, sanitized error responses - Factored validators (validateSearchProvider factory) - CORS headers on all responses - Dashboard: Search & Discovery section, search provider template - DB migration 007: request_type column in call_logs - 28 unit tests (registry, cache, coalescing, validation)
278 lines
9.8 KiB
JavaScript
278 lines
9.8 KiB
JavaScript
import test from "node:test";
|
|
import assert from "node:assert/strict";
|
|
|
|
// ═══════════════════════════════════════════════════════════════
|
|
// Search Registry + Cache Unit Tests
|
|
// Tests for searchRegistry, searchCache, and response normalization
|
|
// ═══════════════════════════════════════════════════════════════
|
|
|
|
const { SEARCH_PROVIDERS, getSearchProvider, getAllSearchProviders, selectProvider } =
|
|
await import("../../open-sse/config/searchRegistry.ts");
|
|
|
|
const { computeCacheKey, getOrCoalesce, getCacheStats, SEARCH_CACHE_DEFAULT_TTL_MS } =
|
|
await import("../../open-sse/services/searchCache.ts");
|
|
|
|
// ─── Registry Tests ──────────────────────────────────────────
|
|
|
|
test("SEARCH_PROVIDERS has all 5 providers", () => {
|
|
assert.ok(SEARCH_PROVIDERS["serper-search"], "serper should exist");
|
|
assert.ok(SEARCH_PROVIDERS["brave-search"], "brave should exist");
|
|
assert.ok(SEARCH_PROVIDERS["perplexity-search"], "perplexity-search should exist");
|
|
assert.ok(SEARCH_PROVIDERS["exa-search"], "exa should exist");
|
|
assert.ok(SEARCH_PROVIDERS["tavily-search"], "tavily should exist");
|
|
assert.equal(Object.keys(SEARCH_PROVIDERS).length, 5);
|
|
});
|
|
|
|
test("serper-search config is correct", () => {
|
|
const s = SEARCH_PROVIDERS["serper-search"];
|
|
assert.equal(s.id, "serper-search");
|
|
assert.equal(s.method, "POST");
|
|
assert.equal(s.authHeader, "x-api-key");
|
|
assert.equal(s.costPerQuery, 0.001);
|
|
assert.equal(s.freeMonthlyQuota, 2500);
|
|
assert.deepEqual(s.searchTypes, ["web", "news"]);
|
|
});
|
|
|
|
test("brave-search config is correct", () => {
|
|
const b = SEARCH_PROVIDERS["brave-search"];
|
|
assert.equal(b.id, "brave-search");
|
|
assert.equal(b.method, "GET");
|
|
assert.equal(b.authHeader, "x-subscription-token");
|
|
assert.equal(b.costPerQuery, 0.005);
|
|
assert.equal(b.freeMonthlyQuota, 1000);
|
|
});
|
|
|
|
test("perplexity-search config is correct", () => {
|
|
const p = SEARCH_PROVIDERS["perplexity-search"];
|
|
assert.equal(p.id, "perplexity-search");
|
|
assert.equal(p.method, "POST");
|
|
assert.equal(p.authHeader, "bearer");
|
|
assert.equal(p.baseUrl, "https://api.perplexity.ai/search");
|
|
assert.equal(p.costPerQuery, 0.005);
|
|
assert.equal(p.freeMonthlyQuota, 0);
|
|
assert.deepEqual(p.searchTypes, ["web"]);
|
|
});
|
|
|
|
test("getSearchProvider returns config for valid ID", () => {
|
|
const config = getSearchProvider("serper-search");
|
|
assert.ok(config);
|
|
assert.equal(config.id, "serper-search");
|
|
});
|
|
|
|
test("getSearchProvider returns null for unknown ID", () => {
|
|
assert.equal(getSearchProvider("unknown"), null);
|
|
});
|
|
|
|
test("tavily config is correct", () => {
|
|
const t = SEARCH_PROVIDERS["tavily-search"];
|
|
assert.equal(t.id, "tavily-search");
|
|
assert.equal(t.method, "POST");
|
|
assert.equal(t.authHeader, "bearer");
|
|
assert.equal(t.baseUrl, "https://api.tavily.com/search");
|
|
assert.equal(t.costPerQuery, 0.008);
|
|
assert.equal(t.freeMonthlyQuota, 1000);
|
|
assert.deepEqual(t.searchTypes, ["web", "news"]);
|
|
});
|
|
|
|
test("getAllSearchProviders returns flat list", () => {
|
|
const all = getAllSearchProviders();
|
|
assert.equal(all.length, 5);
|
|
assert.ok(all.some((p) => p.id === "serper-search"));
|
|
assert.ok(all.some((p) => p.id === "brave-search"));
|
|
assert.ok(all.some((p) => p.id === "perplexity-search"));
|
|
assert.ok(all.some((p) => p.id === "exa-search"));
|
|
assert.ok(all.some((p) => p.id === "tavily-search"));
|
|
// Each entry should have id, name, searchTypes
|
|
for (const p of all) {
|
|
assert.ok(p.id);
|
|
assert.ok(p.name);
|
|
assert.ok(Array.isArray(p.searchTypes));
|
|
}
|
|
});
|
|
|
|
test("selectProvider with explicit provider returns that provider", () => {
|
|
const config = selectProvider("brave-search");
|
|
assert.ok(config);
|
|
assert.equal(config.id, "brave-search");
|
|
});
|
|
|
|
test("selectProvider with unknown provider returns null", () => {
|
|
assert.equal(selectProvider("unknown"), null);
|
|
});
|
|
|
|
test("selectProvider without argument returns cheapest (serper)", () => {
|
|
const config = selectProvider();
|
|
assert.ok(config);
|
|
assert.equal(config.id, "serper-search"); // $0.001 < $0.005
|
|
});
|
|
|
|
// ─── Cache Key Tests ─────────────────────────────────────────
|
|
|
|
test("computeCacheKey is deterministic", () => {
|
|
const k1 = computeCacheKey("hello world", "auto", "web", 5);
|
|
const k2 = computeCacheKey("hello world", "auto", "web", 5);
|
|
assert.equal(k1, k2);
|
|
});
|
|
|
|
test("computeCacheKey normalizes query (case, whitespace)", () => {
|
|
const k1 = computeCacheKey("Hello World", "auto", "web", 5);
|
|
const k2 = computeCacheKey("hello world", "auto", "web", 5);
|
|
assert.equal(k1, k2);
|
|
});
|
|
|
|
test("computeCacheKey differs by provider", () => {
|
|
const k1 = computeCacheKey("test", "serper", "web", 5);
|
|
const k2 = computeCacheKey("test", "brave", "web", 5);
|
|
assert.notEqual(k1, k2);
|
|
});
|
|
|
|
test("computeCacheKey differs by search_type", () => {
|
|
const k1 = computeCacheKey("test", "auto", "web", 5);
|
|
const k2 = computeCacheKey("test", "auto", "news", 5);
|
|
assert.notEqual(k1, k2);
|
|
});
|
|
|
|
test("computeCacheKey differs by max_results", () => {
|
|
const k1 = computeCacheKey("test", "auto", "web", 5);
|
|
const k2 = computeCacheKey("test", "auto", "web", 10);
|
|
assert.notEqual(k1, k2);
|
|
});
|
|
|
|
// ─── Cache + Coalescing Tests ────────────────────────────────
|
|
|
|
test("getOrCoalesce caches and returns on second call", async () => {
|
|
let callCount = 0;
|
|
const key = "test-cache-hit-" + Date.now();
|
|
|
|
const r1 = await getOrCoalesce(key, 60_000, async () => {
|
|
callCount++;
|
|
return { value: 42 };
|
|
});
|
|
assert.equal(r1.cached, false);
|
|
assert.deepEqual(r1.data, { value: 42 });
|
|
|
|
const r2 = await getOrCoalesce(key, 60_000, async () => {
|
|
callCount++;
|
|
return { value: 99 };
|
|
});
|
|
assert.equal(r2.cached, true);
|
|
assert.deepEqual(r2.data, { value: 42 }); // original value, not 99
|
|
assert.equal(callCount, 1); // fetchFn called only once
|
|
});
|
|
|
|
test("getOrCoalesce coalesces concurrent requests", async () => {
|
|
let callCount = 0;
|
|
const key = "test-coalesce-" + Date.now();
|
|
|
|
const fetchFn = async () => {
|
|
callCount++;
|
|
await new Promise((r) => setTimeout(r, 50)); // simulate async
|
|
return { value: "coalesced" };
|
|
};
|
|
|
|
// Launch 3 concurrent requests with the same key
|
|
const [r1, r2, r3] = await Promise.all([
|
|
getOrCoalesce(key, 60_000, fetchFn),
|
|
getOrCoalesce(key, 60_000, fetchFn),
|
|
getOrCoalesce(key, 60_000, fetchFn),
|
|
]);
|
|
|
|
assert.equal(callCount, 1); // Only one fetch executed
|
|
assert.deepEqual(r1.data, { value: "coalesced" });
|
|
assert.deepEqual(r2.data, { value: "coalesced" });
|
|
assert.deepEqual(r3.data, { value: "coalesced" });
|
|
});
|
|
|
|
test("getOrCoalesce respects TTL=0 (no caching)", async () => {
|
|
let callCount = 0;
|
|
const key = "test-no-cache-" + Date.now();
|
|
|
|
await getOrCoalesce(key, 0, async () => {
|
|
callCount++;
|
|
return { value: 1 };
|
|
});
|
|
await getOrCoalesce(key, 0, async () => {
|
|
callCount++;
|
|
return { value: 2 };
|
|
});
|
|
|
|
assert.equal(callCount, 2); // Both calls executed
|
|
});
|
|
|
|
test("getCacheStats returns valid stats", () => {
|
|
const stats = getCacheStats();
|
|
assert.equal(typeof stats.size, "number");
|
|
assert.equal(typeof stats.hits, "number");
|
|
assert.equal(typeof stats.misses, "number");
|
|
});
|
|
|
|
test("SEARCH_CACHE_DEFAULT_TTL_MS is positive", () => {
|
|
assert.ok(SEARCH_CACHE_DEFAULT_TTL_MS > 0);
|
|
});
|
|
|
|
// ─── Validation Schema Tests ────────────────────────────────
|
|
|
|
test("v1SearchSchema validates correct input", async () => {
|
|
const { v1SearchSchema } = await import("../../src/shared/validation/schemas.ts");
|
|
|
|
const result = v1SearchSchema.safeParse({
|
|
query: "test query",
|
|
provider: "serper-search",
|
|
max_results: 10,
|
|
search_type: "web",
|
|
});
|
|
assert.ok(result.success);
|
|
assert.equal(result.data.query, "test query");
|
|
assert.equal(result.data.provider, "serper-search");
|
|
assert.equal(result.data.max_results, 10);
|
|
});
|
|
|
|
test("v1SearchSchema rejects empty query", async () => {
|
|
const { v1SearchSchema } = await import("../../src/shared/validation/schemas.ts");
|
|
|
|
const result = v1SearchSchema.safeParse({ query: "" });
|
|
assert.ok(!result.success);
|
|
});
|
|
|
|
test("v1SearchSchema rejects query over 500 chars", async () => {
|
|
const { v1SearchSchema } = await import("../../src/shared/validation/schemas.ts");
|
|
|
|
const result = v1SearchSchema.safeParse({ query: "a".repeat(501) });
|
|
assert.ok(!result.success);
|
|
});
|
|
|
|
test("v1SearchSchema rejects invalid provider", async () => {
|
|
const { v1SearchSchema } = await import("../../src/shared/validation/schemas.ts");
|
|
|
|
const result = v1SearchSchema.safeParse({ query: "test", provider: "google" });
|
|
assert.ok(!result.success);
|
|
});
|
|
|
|
test("v1SearchSchema accepts tavily provider", async () => {
|
|
const { v1SearchSchema } = await import("../../src/shared/validation/schemas.ts");
|
|
|
|
const result = v1SearchSchema.safeParse({ query: "test", provider: "tavily-search" });
|
|
assert.ok(result.success);
|
|
assert.equal(result.data.provider, "tavily-search");
|
|
});
|
|
|
|
test("v1SearchSchema applies defaults", async () => {
|
|
const { v1SearchSchema } = await import("../../src/shared/validation/schemas.ts");
|
|
|
|
const result = v1SearchSchema.safeParse({ query: "test" });
|
|
assert.ok(result.success);
|
|
assert.equal(result.data.max_results, 5);
|
|
assert.equal(result.data.search_type, "web");
|
|
assert.equal(result.data.provider, undefined);
|
|
});
|
|
|
|
test("v1SearchSchema allows unknown fields (forward compat)", async () => {
|
|
const { v1SearchSchema } = await import("../../src/shared/validation/schemas.ts");
|
|
|
|
const result = v1SearchSchema.safeParse({
|
|
query: "test",
|
|
future_field: true,
|
|
});
|
|
assert.ok(result.success);
|
|
});
|