mirror of
https://github.com/garrytan/gbrain.git
synced 2026-07-27 22:15:33 +00:00
* feat: migration v68 — eval_candidates.embedding_column Schema migration ALTERs eval_candidates to add a nullable embedding_column TEXT column. Per-row capture metadata so `gbrain eval replay` reproduces the same column the capture ran against (D16 / CDX-10). NULL-tolerant: pre-v0.36 rows fall back to current default. Renumbered v67→v68 because master claimed v67 for facts_typed_claim_columns during this branch's lifetime. PGLite parity via sqlFor.pglite — same ALTER IF NOT EXISTS. * feat: dynamic embedding column — core (resolver, types, gateway, engines) The read-path foundation for routing search through any populated embedding column, not just OpenAI 1536. src/core/search/embedding-column.ts (new) is the canonical seam. Single source of truth for column → provider/dim/type lookup. Validates registry keys via regex (/^[a-z_][a-z0-9_]*$/), uses Object.create(null) + Object.hasOwn so 'constructor' and other inherited names can't masquerade as registered columns. Identifier-quoting on SQL interpolation as defense in depth. src/core/types.ts widens SearchOpts.embeddingColumn to accept ResolvedColumn descriptors at the engine boundary; adds EmbeddingColumnConfig + ResolvedColumn exports. src/core/config.ts merges embedding_columns + search_embedding_column from the DB plane via loadConfigWithEngine, mirroring the existing embedding_multimodal_model pattern. Handles the no-file case so env-only Postgres installs see DB-plane overrides (codex /ship #3). src/core/ai/gateway.ts: embedQuery(text, opts) + embed(texts, opts) accept embeddingModel + dimensions overrides. isAvailable(touchpoint, modelOverride?) so hybrid asks 'is the active column's provider reachable?' not 'is the global default reachable?' (CDX-4 / D10). Engines: searchVector accepts ResolvedColumn descriptors via normalizeEngineColumn; engine code is config-free and unit-testable. getEmbeddingsByChunkIds(ids, column?) so cosineReScore hydrates from the active column instead of always 'embedding' (CDX-3 / D9). Identifier-quoting belt at the SQL boundary. src/core/eval-capture.ts threads embedding_column from hybridSearch meta into the persisted capture row. * feat: dynamic embedding column — integration (hybrid, ops, doctor) Wires the resolver into hybridSearch, the query op, doctor, and the config command. src/core/search/hybrid.ts: resolves the column once at the boundary, threads the descriptor into engine calls, routes embedQuery through the resolved column's provider/dims, and calls isCacheSafe (not isDefaultColumn) for cache skip so user overrides of the 'embedding' builtin can't leak across vector spaces (CDX-4). cosineReScore now hydrates from the active column. src/core/search/mode.ts: KNOBS_HASH_VERSION 2→3, append-only new fields col= and prov= alongside floor_ratio. Cache rows from different columns or providers now sit in different keyspaces — cross-column contamination impossible. src/core/operations.ts: query op accepts embedding_column param for per-call A/B benchmarking. search op (keyword-only) deliberately does NOT (CDX-9 / D15) — would be silent UX. src/commands/doctor.ts: new embedding_column_registry check. Batch format_type probe (D13) catches dim drift that information_schema.columns.udt_name can't. Batch pg_indexes probe (D5) warns on missing HNSW. Coverage % on active column, gates at <90% (D14), short-circuits on empty brains (codex /ship #5). src/commands/config.ts: validates embedding_columns JSON shape at set time, runs the coverage gate when setting search_embedding_column, uses Object.hasOwn for the registry lookup. src/commands/eval-replay.ts: replay re-runs queries against the captured embedding_column so post-flip-config replays don't surface as false-positive regressions. * test: dynamic embedding column — unit + e2e coverage 50 unit cases for the resolver (resolution chain, registry merge, validation, prototype pollution, descriptor passthrough, isCacheSafe, normalizeEngineColumn). 8 gateway override cases — embeddingModel + dimensions flow into providerOptions, isAvailable(touchpoint, override) routes to the right recipe, unknown models throw clean. 4 cosineReScore + 6 ops + 5 knobs-hash + 7 mode + 9 PGLite E2E + 7 Postgres E2E + 5 eval-replay column metadata. Postgres E2E (gated on DATABASE_URL) covers halfvec(2560) end-to-end on real pgvector, EXPLAIN-visible HNSW index on the alternate column, format_type-based dim drift catch, and the <90% coverage gate. Pins every codex /ship fix: prototype-pollution rejection ('constructor' as column name), descriptor passthrough validation (rejects SQL-shaped strings in dimensions), isCacheSafe semantics (space-based, not name-based). Total: 141 new + extended cases, all green. * chore: bump version and changelog (v0.36.3.0) Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * docs: sync to v0.36.3.0 Add CLAUDE.md key-files entry for src/core/search/embedding-column.ts. Annotate hybrid.ts, gateway.ts, doctor.ts, and migrate.ts entries with v0.36.3.0 wave changes (ResolvedColumn threading, embedQuery model override, embedding_column_registry check, migration v68). Document knobs_hash v=2 → v=3 bump under the Search Mode section. Regenerate llms-full.txt from the updated CLAUDE.md so the auto-checked bundle matches source (build-llms.test.ts CI guard). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * fix(ci): two CI failures from v0.36.3.0 1. test/loadConfig-merge.test.ts: update the 'returns null when base config is null' contract test. Pre-v0.36 the function returned null for null base; the codex /ship #3 fix changed that to synthesize a minimal `{ engine: 'postgres' }` so env-only installs see DB-plane overrides. Test now pins the new contract + adds a round-trip case asserting the merge actually surfaces `embedding_columns` / `search_embedding_column` set via gbrain config set on a null base. 2. test/schema-bootstrap-coverage.test.ts was failing because eval_candidates.embedding_column (added by migration v68) wasn't covered by applyForwardReferenceBootstrap. Fix: add the column to PGLITE_SCHEMA_SQL's eval_candidates CREATE TABLE definition (and src/schema.sql for parity) so fresh installs get it natively. The coverage test's third tier (schemaCreateTableCols) now finds it. Regenerated schema-embedded.ts via bun run build:schema. Schema-blob path is cleaner than COLUMN_EXEMPTIONS — fresh installs skip the migration entirely; upgrade installs still run v68. --------- Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
116 lines
4.2 KiB
TypeScript
116 lines
4.2 KiB
TypeScript
/**
|
|
* v0.36 (D16 / CDX-10) — eval_candidates.embedding_column round-trip.
|
|
*
|
|
* Pins:
|
|
* - logEvalCandidate persists `embedding_column` when set.
|
|
* - listEvalCandidates reads it back (SELECT * carries the new column).
|
|
* - Migration v67 applied: ALTER TABLE eval_candidates ADD COLUMN
|
|
* IF NOT EXISTS embedding_column TEXT.
|
|
* - Back-compat: rows inserted without embedding_column store NULL,
|
|
* and replay treats NULL as "use current default."
|
|
*
|
|
* The integration of replay with hybridSearch's column-override path is
|
|
* tested via the embeddingColumn option being honored — we don't run
|
|
* the full eval-replay CLI subcommand here because that brings in CLI
|
|
* arg parsing + filesystem reading. Unit-level surface is sufficient
|
|
* for the persist-and-read contract.
|
|
*/
|
|
|
|
import { describe, test, expect, beforeAll, afterAll } from 'bun:test';
|
|
import { PGLiteEngine } from '../../src/core/pglite-engine.ts';
|
|
import type { EvalCandidateInput } from '../../src/core/types.ts';
|
|
|
|
let engine: PGLiteEngine;
|
|
|
|
beforeAll(async () => {
|
|
engine = new PGLiteEngine();
|
|
await engine.connect({});
|
|
await engine.initSchema();
|
|
});
|
|
|
|
afterAll(async () => {
|
|
if (engine) await engine.disconnect();
|
|
});
|
|
|
|
const baseRow: Omit<EvalCandidateInput, 'embedding_column'> = {
|
|
tool_name: 'query',
|
|
query: 'test query',
|
|
retrieved_slugs: ['docs/a', 'docs/b'],
|
|
retrieved_chunk_ids: [1, 2],
|
|
source_ids: ['default'],
|
|
expand_enabled: true,
|
|
detail: null,
|
|
detail_resolved: 'medium',
|
|
vector_enabled: true,
|
|
expansion_applied: false,
|
|
latency_ms: 42,
|
|
remote: false,
|
|
job_id: null,
|
|
subagent_id: null,
|
|
};
|
|
|
|
describe('eval_candidates.embedding_column persistence (D16)', () => {
|
|
test('migration v67 added embedding_column TEXT column', async () => {
|
|
const rows = await engine.executeRaw<{ column_name: string; data_type: string; is_nullable: string }>(
|
|
`SELECT column_name, data_type, is_nullable
|
|
FROM information_schema.columns
|
|
WHERE table_name = 'eval_candidates' AND column_name = 'embedding_column'`,
|
|
);
|
|
expect(rows.length).toBe(1);
|
|
expect(rows[0].column_name).toBe('embedding_column');
|
|
expect(rows[0].data_type).toBe('text');
|
|
expect(rows[0].is_nullable).toBe('YES');
|
|
});
|
|
|
|
test('logEvalCandidate stores embedding_column value', async () => {
|
|
const id = await engine.logEvalCandidate({
|
|
...baseRow,
|
|
embedding_column: 'embedding_voyage',
|
|
});
|
|
const rows = await engine.executeRaw<{ embedding_column: string | null }>(
|
|
`SELECT embedding_column FROM eval_candidates WHERE id = $1`,
|
|
[id],
|
|
);
|
|
expect(rows[0].embedding_column).toBe('embedding_voyage');
|
|
});
|
|
|
|
test('listEvalCandidates reads embedding_column back (round-trip via SELECT *)', async () => {
|
|
const id = await engine.logEvalCandidate({
|
|
...baseRow,
|
|
query: 'list-readback test',
|
|
embedding_column: 'embedding_ze',
|
|
});
|
|
const list = await engine.listEvalCandidates({ limit: 100 });
|
|
const found = list.find(r => r.id === id);
|
|
expect(found).toBeDefined();
|
|
// Cast-through-unknown rowToEvalCandidate doesn't exist; SELECT *
|
|
// carries `embedding_column` as a column with the same key name.
|
|
expect((found as any).embedding_column).toBe('embedding_ze');
|
|
});
|
|
|
|
test('back-compat: missing embedding_column coalesces to NULL at insert', async () => {
|
|
// Build a row WITHOUT embedding_column to mimic pre-v0.36 callers.
|
|
const input: EvalCandidateInput = { ...baseRow, query: 'pre-v036 fixture' };
|
|
expect(input.embedding_column).toBeUndefined();
|
|
const id = await engine.logEvalCandidate(input);
|
|
const rows = await engine.executeRaw<{ embedding_column: string | null }>(
|
|
`SELECT embedding_column FROM eval_candidates WHERE id = $1`,
|
|
[id],
|
|
);
|
|
expect(rows[0].embedding_column).toBeNull();
|
|
});
|
|
|
|
test('back-compat: explicit null persists as DB NULL (not the literal string "null")', async () => {
|
|
const id = await engine.logEvalCandidate({
|
|
...baseRow,
|
|
query: 'explicit-null fixture',
|
|
embedding_column: null,
|
|
});
|
|
const rows = await engine.executeRaw<{ embedding_column: string | null }>(
|
|
`SELECT embedding_column FROM eval_candidates WHERE id = $1`,
|
|
[id],
|
|
);
|
|
expect(rows[0].embedding_column).toBeNull();
|
|
});
|
|
});
|