mirror of
https://github.com/garrytan/gbrain.git
synced 2026-08-16 09:52:22 +00:00
Compare commits
2
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
5882d5261a | ||
|
|
a5a80549e5 |
-64
@@ -24,7 +24,6 @@ import type { GBrainConfig } from './core/config.ts';
|
||||
import type { AIGatewayConfig } from './core/ai/types.ts';
|
||||
import type { BrainEngine } from './core/engine.ts';
|
||||
import { operations, OperationError } from './core/operations.ts';
|
||||
import { resolveSourceIdEngineFree } from './core/source-resolver.ts';
|
||||
import { formatVolunteeredPage } from './core/context/volunteer.ts';
|
||||
import type { Operation, OperationContext } from './core/operations.ts';
|
||||
import { shouldForceExitAfterMain, finishCliTeardown, flushThenExit, currentExitCode, setCliExitVerdict } from './core/cli-force-exit.ts';
|
||||
@@ -383,15 +382,6 @@ async function main() {
|
||||
if (op.localOnly) {
|
||||
refuseThinClient(command, cfgPre!.remote_mcp!.mcp_url);
|
||||
}
|
||||
// #2098: the local path resolves --source / GBRAIN_SOURCE / .gbrain-source
|
||||
// inside makeContext (ctx.sourceId), which this route never reaches — so
|
||||
// scope must be mapped onto the op's source_id wire param before the call.
|
||||
try {
|
||||
applyThinClientSourceScope(op, params);
|
||||
} catch (e: unknown) {
|
||||
console.error(e instanceof Error ? e.message : String(e));
|
||||
process.exit(1);
|
||||
}
|
||||
await runThinClientRouted(op, params, cfgPre!, cliOpts);
|
||||
return;
|
||||
}
|
||||
@@ -812,60 +802,6 @@ export function parseOpArgs(op: Operation, args: string[]): Record<string, unkno
|
||||
return params;
|
||||
}
|
||||
|
||||
/**
|
||||
* #2098: thin-client source scoping. Locally, --source / GBRAIN_SOURCE /
|
||||
* .gbrain-source resolve to ctx.sourceId in makeContext; the thin-client
|
||||
* route short-circuits before that, so `gbrain query --source X` against a
|
||||
* remote brain silently searched unscoped. This runs the engine-free tiers
|
||||
* (flag → env → dotfile; the DB-backed tiers can't run without an engine —
|
||||
* the server's grant scoping covers the rest) and maps the result onto the
|
||||
* op's `source_id` wire param.
|
||||
*
|
||||
* Ops that declare their OWN `source` param (facts add, etc.) are left
|
||||
* untouched — their --source is an op param, not scope. An explicit --source
|
||||
* on an op with no source_id wire param throws (loud beats silent drop);
|
||||
* ambient env/dotfile scope with nowhere to send it is ignored, matching the
|
||||
* pre-fix behavior for non-scopeable ops. Exported for tests.
|
||||
*/
|
||||
// Ops whose `source_id` wire param is NOT read-scope semantics: get_skill's
|
||||
// source_id flips the lookup from host catalog to brain-resident-pack
|
||||
// (getResidentSkillDetail). Ambient env/dotfile scope must never leak into
|
||||
// these; an explicit --source-id still passes through untouched above.
|
||||
const NON_SCOPE_SOURCE_ID_OPS = new Set(['get_skill']);
|
||||
|
||||
export function applyThinClientSourceScope(
|
||||
op: Operation,
|
||||
params: Record<string, unknown>,
|
||||
cwd?: string,
|
||||
): void {
|
||||
if ('source' in op.params) return; // the op owns --source; not a scope flag
|
||||
const explicit = typeof params.source === 'string' && params.source.length > 0
|
||||
? (params.source as string)
|
||||
: null;
|
||||
delete params.source; // never a wire param on these ops — don't leak it
|
||||
// Explicit per-call scope already on the wire wins over ambient tiers.
|
||||
if (params.source_id !== undefined || params.all_sources === true) {
|
||||
if (explicit) {
|
||||
throw new Error('Pass either --source or --source-id/--all-sources, not both.');
|
||||
}
|
||||
return;
|
||||
}
|
||||
const resolved = resolveSourceIdEngineFree(explicit, cwd);
|
||||
if (!resolved) return;
|
||||
if (!('source_id' in op.params) || NON_SCOPE_SOURCE_ID_OPS.has(op.name)) {
|
||||
if (explicit) {
|
||||
const hint = NON_SCOPE_SOURCE_ID_OPS.has(op.name)
|
||||
? `(its source_id parameter is not a scope filter; pass --source-id explicitly if you mean it)`
|
||||
: `(the remote op has no source_id parameter; the server scopes it to your grant)`;
|
||||
throw new Error(
|
||||
`gbrain ${op.cliHints?.name || op.name} does not accept --source on a thin-client install ${hint}.`,
|
||||
);
|
||||
}
|
||||
return; // ambient env/dotfile scope with nowhere to send it
|
||||
}
|
||||
params.source_id = resolved;
|
||||
}
|
||||
|
||||
async function makeContext(engine: BrainEngine, params: Record<string, unknown>): Promise<OperationContext> {
|
||||
// v0.31.8 (D11): resolve sourceId via the canonical 6-tier chain. Honors
|
||||
// --source / GBRAIN_SOURCE / .gbrain-source / path-match / brain default /
|
||||
|
||||
@@ -820,6 +820,10 @@ export async function doctorReportRemote(engine: BrainEngine): Promise<DoctorRep
|
||||
// v0.42.x (#1794, 4A): pool-budget nudge when GBRAIN_MAX_CONNECTIONS is set.
|
||||
checks.push(await checkPoolBudget(engine));
|
||||
|
||||
// #2552: warn when an explicit embed-concurrency override fans out against
|
||||
// a local single-slot embedding endpoint (silent backfill starvation).
|
||||
checks.push(await checkEmbedConcurrency());
|
||||
|
||||
// v0.42.7 (#1696): link-extraction lag. Strictly SQL (single indexed COUNT),
|
||||
// safe on the thin-client/remote path — remote operators on checkout-less
|
||||
// Postgres brains are exactly who can't otherwise see the extraction backlog.
|
||||
@@ -3815,6 +3819,61 @@ export function computePoolBudgetCheck(
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* #2552: warn when an explicit GBRAIN_EMBED_CONCURRENCY override fans out
|
||||
* against a local single-slot embedding endpoint (Ollama / llama-server /
|
||||
* localhost base URL). Requests serialize on the one loaded model, so N
|
||||
* parallel pages multiply latency xN and can exceed the fetch timeout with
|
||||
* no surfaced error — the backfill silently starves. (When the env var is
|
||||
* unset, embed auto-caps at LOCAL_EMBED_CONCURRENCY_CAP and this check
|
||||
* reports ok.) Pure; exported for tests.
|
||||
*/
|
||||
export function computeEmbedConcurrencyCheck(
|
||||
isLocalEndpoint: boolean,
|
||||
envValue: string | undefined,
|
||||
localCap: number,
|
||||
): Check {
|
||||
const name = 'embed_concurrency';
|
||||
if (!isLocalEndpoint) {
|
||||
return { name, status: 'ok', message: 'Embedding endpoint is not a local inference server — cloud concurrency defaults apply.' };
|
||||
}
|
||||
const parsed = envValue ? parseInt(envValue, 10) : NaN;
|
||||
if (envValue && Number.isFinite(parsed) && parsed > localCap) {
|
||||
return {
|
||||
name,
|
||||
status: 'warn',
|
||||
message:
|
||||
`GBRAIN_EMBED_CONCURRENCY=${parsed} against a local embedding endpoint. ` +
|
||||
`Local inference servers serialize requests, so ${parsed} parallel pages multiply ` +
|
||||
`latency x${parsed} and can exceed the fetch timeout — the embed backfill stalls ` +
|
||||
`with no error. Unset GBRAIN_EMBED_CONCURRENCY (auto-caps at ${localCap}) or set it <= ${localCap}.`,
|
||||
};
|
||||
}
|
||||
return {
|
||||
name,
|
||||
status: 'ok',
|
||||
message: `Local embedding endpoint detected; embed concurrency capped at ${envValue ? parsed : localCap}.`,
|
||||
};
|
||||
}
|
||||
|
||||
/** Thin gateway/env wrapper over `computeEmbedConcurrencyCheck`. */
|
||||
export async function checkEmbedConcurrency(): Promise<Check> {
|
||||
try {
|
||||
const { isLocalEmbeddingEndpoint, LOCAL_EMBED_CONCURRENCY_CAP } = await import('../core/ai/gateway.ts');
|
||||
return computeEmbedConcurrencyCheck(
|
||||
isLocalEmbeddingEndpoint(),
|
||||
process.env.GBRAIN_EMBED_CONCURRENCY,
|
||||
LOCAL_EMBED_CONCURRENCY_CAP,
|
||||
);
|
||||
} catch (err) {
|
||||
return {
|
||||
name: 'embed_concurrency',
|
||||
status: 'ok',
|
||||
message: `Skipped (${err instanceof Error ? err.message : String(err)})`,
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
/** Thin env/engine wrapper over `computePoolBudgetCheck`. */
|
||||
export async function checkPoolBudget(_engine: BrainEngine): Promise<Check> {
|
||||
try {
|
||||
|
||||
+30
-8
@@ -1,5 +1,6 @@
|
||||
import type { BrainEngine } from '../core/engine.ts';
|
||||
import { embedBatch, currentEmbeddingSignature } from '../core/embedding.ts';
|
||||
import { isLocalEmbeddingEndpoint, LOCAL_EMBED_CONCURRENCY_CAP } from '../core/ai/gateway.ts';
|
||||
import type { ChunkInput } from '../core/types.ts';
|
||||
import { chunkText } from '../core/chunkers/recursive.ts';
|
||||
import { createProgress, type ProgressReporter } from '../core/progress.ts';
|
||||
@@ -176,6 +177,31 @@ export class EmbeddingDimMismatchError extends Error {
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* #2552: resolve the bulk-embed worker count. Env override or the
|
||||
* cloud-tuned default of 20 — but when the operator did NOT set
|
||||
* GBRAIN_EMBED_CONCURRENCY and the embedding endpoint is a local inference
|
||||
* server (Ollama / llama-server / localhost base URL), cap at
|
||||
* LOCAL_EMBED_CONCURRENCY_CAP: 20 parallel pages against a single-slot
|
||||
* server serialize on the one loaded model, multiply latency x20 past the
|
||||
* fetch timeout, and starve the backfill with no surfaced error. An
|
||||
* explicit env value always wins (`gbrain doctor` warns instead).
|
||||
* Pacing only ever LOWERS concurrency (Codex P2).
|
||||
*/
|
||||
export function resolveEmbedConcurrency(paceMaxConcurrency?: number): number {
|
||||
const envSet = !!process.env.GBRAIN_EMBED_CONCURRENCY;
|
||||
const base = parseInt(process.env.GBRAIN_EMBED_CONCURRENCY || '20', 10);
|
||||
let resolved = base;
|
||||
if (!envSet && isLocalEmbeddingEndpoint() && base > LOCAL_EMBED_CONCURRENCY_CAP) {
|
||||
resolved = LOCAL_EMBED_CONCURRENCY_CAP;
|
||||
serr(
|
||||
`[embed] local embedding endpoint detected — capping concurrency at ` +
|
||||
`${LOCAL_EMBED_CONCURRENCY_CAP} (set GBRAIN_EMBED_CONCURRENCY to override)`,
|
||||
);
|
||||
}
|
||||
return paceMaxConcurrency ? Math.min(resolved, paceMaxConcurrency) : resolved;
|
||||
}
|
||||
|
||||
/**
|
||||
* Pre-flight check: read the actual schema column dim and compare to the
|
||||
* gateway's resolved dim. Throws `EmbeddingDimMismatchError` on mismatch
|
||||
@@ -677,10 +703,8 @@ async function embedAll(
|
||||
// Paced runs lower this to the resolved cap (the real lever vs pooler-slot
|
||||
// starvation); unpaced keeps the env/default 20. Codex P2: only ever LOWER —
|
||||
// never raise above an operator's existing env cap.
|
||||
const BASE_CONCURRENCY = parseInt(process.env.GBRAIN_EMBED_CONCURRENCY || '20', 10);
|
||||
const CONCURRENCY = staleOpts?.paceMaxConcurrency
|
||||
? Math.min(BASE_CONCURRENCY, staleOpts.paceMaxConcurrency)
|
||||
: BASE_CONCURRENCY;
|
||||
// #2552: local endpoints auto-cap — see resolveEmbedConcurrency.
|
||||
const CONCURRENCY = resolveEmbedConcurrency(staleOpts?.paceMaxConcurrency);
|
||||
|
||||
async function embedOnePage(page: typeof pages[number]) {
|
||||
// #1737: bail before doing any work for this page if the run was aborted.
|
||||
@@ -855,10 +879,8 @@ async function embedAllStale(
|
||||
// Paced runs lower concurrency to the resolved cap (E-1: worker count IS the
|
||||
// lever on this single pool, no separate permit). Codex P2: pacing only ever
|
||||
// LOWERS concurrency — never raise above an operator's existing env cap.
|
||||
const BASE_CONCURRENCY = parseInt(process.env.GBRAIN_EMBED_CONCURRENCY || '20', 10);
|
||||
const CONCURRENCY = staleOpts?.paceMaxConcurrency
|
||||
? Math.min(BASE_CONCURRENCY, staleOpts.paceMaxConcurrency)
|
||||
: BASE_CONCURRENCY;
|
||||
// #2552: local endpoints auto-cap — see resolveEmbedConcurrency.
|
||||
const CONCURRENCY = resolveEmbedConcurrency(staleOpts?.paceMaxConcurrency);
|
||||
const pacer = staleOpts?.pacer ?? createNoopPacer();
|
||||
|
||||
// D3 + D3a + D8: wall-clock budget. 30 min default; env override.
|
||||
|
||||
@@ -683,6 +683,33 @@ export function getEmbeddingDimensions(): number {
|
||||
return requireConfig().embedding_dimensions ?? DEFAULT_EMBEDDING_DIMENSIONS;
|
||||
}
|
||||
|
||||
/**
|
||||
* #2552: cap for parallel bulk-embed workers against a local inference
|
||||
* server. A single-slot Ollama/llama-server serializes requests, so the
|
||||
* cloud-tuned 20-worker fan-out multiplies latency x20 and blows past the
|
||||
* fetch timeout with no surfaced error (the backfill silently starves).
|
||||
*/
|
||||
export const LOCAL_EMBED_CONCURRENCY_CAP = 2;
|
||||
|
||||
/**
|
||||
* #2552: true when the configured embedding model routes to a local
|
||||
* inference server — the `ollama` / `llama-server` recipes, or any recipe
|
||||
* whose base URL was explicitly pointed at localhost. Bulk callers use this
|
||||
* to pick CPU-safe concurrency defaults; `gbrain doctor` uses it to warn
|
||||
* about an explicit cloud-sized override. Fail-open: unconfigured or
|
||||
* unresolvable gateway → false (cloud behavior, the historical default).
|
||||
*/
|
||||
export function isLocalEmbeddingEndpoint(): boolean {
|
||||
try {
|
||||
const { recipe } = resolveRecipe(getEmbeddingModel());
|
||||
if (recipe.id === 'ollama' || recipe.id === 'llama-server') return true;
|
||||
const base = requireConfig().base_urls?.[recipe.id] ?? '';
|
||||
return /\/\/(localhost|127\.0\.0\.1|\[::1\])(:|\/|$)/i.test(base);
|
||||
} catch {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* v0.28.11: returns the configured multimodal embedding model when set,
|
||||
* or undefined if the brain falls back to `embedding_model` for multimodal
|
||||
|
||||
@@ -29,9 +29,17 @@ export const ollama: Recipe = {
|
||||
trust_custom_dims: true, // #2271: local models carry varied native dims
|
||||
cost_per_1m_tokens_usd: 0,
|
||||
price_last_verified: '2026-04-20',
|
||||
// Ollama's batch capacity depends on the locally loaded model + the
|
||||
// OLLAMA_NUM_PARALLEL config; no static cap to declare. v0.32 (#779).
|
||||
no_batch_cap: true,
|
||||
// #2552: Ollama's true batch capacity depends on the locally loaded
|
||||
// model + OLLAMA_NUM_PARALLEL, but the previous `no_batch_cap: true`
|
||||
// meant a whole page went out in ONE request — on a CPU-only box that
|
||||
// multiplies latency past the fetch timeout and the backfill starves
|
||||
// with no surfaced error. Ollama doesn't return a recognizable
|
||||
// token-limit error either, so the recursive-halving safety net never
|
||||
// fires; a conservative static pre-split cap is the only guard.
|
||||
// 4096 tokens x 2 chars/token ~= 8K chars per request (code-dense
|
||||
// pages run ~2 chars/token, not the tiktoken-ish 4).
|
||||
max_batch_tokens: 4096,
|
||||
chars_per_token: 2,
|
||||
},
|
||||
},
|
||||
setup_hint: 'Install Ollama from https://ollama.ai, then `ollama pull nomic-embed-text` and `ollama serve`.',
|
||||
|
||||
@@ -141,6 +141,7 @@ export const OPS_CHECK_NAMES: ReadonlySet<string> = new Set([
|
||||
'pgbouncer_prepare',
|
||||
'pgvector',
|
||||
'pool_budget',
|
||||
'embed_concurrency',
|
||||
'progressive_batch_audit_health',
|
||||
'queue_health',
|
||||
'reranker_health',
|
||||
|
||||
@@ -56,7 +56,7 @@ import { GBrainError, PAGE_SORT_SQL, ENRICH_ORDER_SQL } from './types.ts';
|
||||
import { finalizeLastSeen } from './chronicle/last-seen.ts';
|
||||
import { computeAnomaliesFromBuckets } from './cycle/anomaly.ts';
|
||||
import { resolveBoostMap, resolveHardExcludes } from './search/source-boost.ts';
|
||||
import { buildSourceFactorCase, buildHardExcludeClause, buildVisibilityClause, buildRecencyComponentSql, buildBestPerPagePoolCte, buildOrFallbackWebsearchQuery } from './search/sql-ranking.ts';
|
||||
import { buildSourceFactorCase, buildHardExcludeClause, buildVisibilityClause, buildRecencyComponentSql, buildBestPerPagePoolCte, buildOrFallbackWebsearchQuery, buildWebsearchQueryExpr } from './search/sql-ranking.ts';
|
||||
import {
|
||||
normalizeEngineColumn,
|
||||
buildVectorCastFragment,
|
||||
@@ -1591,6 +1591,8 @@ export class PGLiteEngine implements BrainEngine {
|
||||
}
|
||||
|
||||
// v0.20.0 Cathedral II Layer 10 C1/C2: language + symbol-kind filters.
|
||||
// #2380: slash-bearing queries match both the split-word and literal
|
||||
// slash forms — see buildWebsearchQueryExpr in ./search/sql-ranking.ts.
|
||||
const params: unknown[] = [query, innerLimit, limit, offset];
|
||||
let extraFilter = '';
|
||||
if (opts?.language) {
|
||||
@@ -1630,6 +1632,7 @@ export class PGLiteEngine implements BrainEngine {
|
||||
// FTS config name (e.g. 'english', 'pt_br'). Validated by getFtsLanguage()
|
||||
// — safe to interpolate into raw SQL.
|
||||
const ftsLang = getFtsLanguage();
|
||||
const ftsQueryExpr = buildWebsearchQueryExpr(ftsLang, '$1', query);
|
||||
|
||||
const keywordSql =
|
||||
`WITH ranked AS (
|
||||
@@ -1637,14 +1640,14 @@ export class PGLiteEngine implements BrainEngine {
|
||||
p.slug, p.id as page_id, p.title, p.type, p.source_id,
|
||||
p.effective_date, p.effective_date_source,
|
||||
cc.id as chunk_id, cc.chunk_index, cc.chunk_text, cc.chunk_source,
|
||||
ts_rank(cc.search_vector, websearch_to_tsquery('${ftsLang}', $1)) * ${sourceFactorCase} AS score,
|
||||
ts_rank(cc.search_vector, ${ftsQueryExpr}) * ${sourceFactorCase} AS score,
|
||||
CASE WHEN p.updated_at < (
|
||||
SELECT MAX(te.created_at) FROM timeline_entries te WHERE te.page_id = p.id
|
||||
) THEN true ELSE false END AS stale
|
||||
FROM content_chunks cc
|
||||
JOIN pages p ON p.id = cc.page_id
|
||||
JOIN sources s ON s.id = p.source_id
|
||||
WHERE cc.search_vector @@ websearch_to_tsquery('${ftsLang}', $1) ${detailFilter}${extraFilter} ${hardExcludeClause} ${visibilityClause}
|
||||
WHERE cc.search_vector @@ ${ftsQueryExpr} ${detailFilter}${extraFilter} ${hardExcludeClause} ${visibilityClause}
|
||||
-- v0.27.1: hide image rows from default text-keyword search so
|
||||
-- OCR text doesn't drown text-page hits. Image-similarity queries
|
||||
-- run a separate vector path on embedding_image.
|
||||
@@ -1712,7 +1715,10 @@ export class PGLiteEngine implements BrainEngine {
|
||||
// FTS config name (e.g. 'english', 'pt_br'). Validated by getFtsLanguage()
|
||||
// — safe to interpolate into raw SQL.
|
||||
const ftsLang = getFtsLanguage();
|
||||
const ftsQueryExpr = buildWebsearchQueryExpr(ftsLang, '$1', query);
|
||||
|
||||
// #2380: slash-bearing queries match both the split-word and literal
|
||||
// slash forms — see buildWebsearchQueryExpr in ./search/sql-ranking.ts.
|
||||
const params: unknown[] = [query, limit, offset];
|
||||
let extraFilter = '';
|
||||
if (opts?.type) {
|
||||
@@ -1760,7 +1766,7 @@ export class PGLiteEngine implements BrainEngine {
|
||||
COALESCE(rep.chunk_index, 0) as chunk_index,
|
||||
COALESCE(rep.chunk_text, '') as chunk_text,
|
||||
COALESCE(rep.chunk_source, 'compiled_truth') as chunk_source,
|
||||
ts_rank_cd(p.search_vector, websearch_to_tsquery('${ftsLang}', $1)) * ${sourceFactorCase} AS score,
|
||||
ts_rank_cd(p.search_vector, ${ftsQueryExpr}) * ${sourceFactorCase} AS score,
|
||||
CASE WHEN p.updated_at < (
|
||||
SELECT MAX(te.created_at) FROM timeline_entries te WHERE te.page_id = p.id
|
||||
) THEN true ELSE false END AS stale
|
||||
@@ -1775,7 +1781,7 @@ export class PGLiteEngine implements BrainEngine {
|
||||
ORDER BY (cc.chunk_source = 'compiled_truth') DESC, cc.chunk_index ASC
|
||||
LIMIT 1
|
||||
) rep ON true
|
||||
WHERE p.search_vector @@ websearch_to_tsquery('${ftsLang}', $1)
|
||||
WHERE p.search_vector @@ ${ftsQueryExpr}
|
||||
${extraFilter} ${hardExcludeClause} ${visibilityClause}
|
||||
ORDER BY score DESC, p.id ASC
|
||||
LIMIT $2 OFFSET $3`;
|
||||
@@ -1962,6 +1968,8 @@ export class PGLiteEngine implements BrainEngine {
|
||||
});
|
||||
}
|
||||
|
||||
// #2380: slash-bearing queries match both the split-word and literal
|
||||
// slash forms — see buildWebsearchQueryExpr in ./search/sql-ranking.ts.
|
||||
const params: unknown[] = [query, limit, offset];
|
||||
let extraFilter = '';
|
||||
if (opts?.language) {
|
||||
@@ -1996,20 +2004,21 @@ export class PGLiteEngine implements BrainEngine {
|
||||
// FTS config name (e.g. 'english', 'pt_br'). Validated by getFtsLanguage()
|
||||
// — safe to interpolate into raw SQL.
|
||||
const ftsLang = getFtsLanguage();
|
||||
const ftsQueryExpr = buildWebsearchQueryExpr(ftsLang, '$1', query);
|
||||
|
||||
const { rows } = await this.db.query(
|
||||
`SELECT
|
||||
p.slug, p.id as page_id, p.title, p.type, p.source_id,
|
||||
p.effective_date, p.effective_date_source,
|
||||
cc.id as chunk_id, cc.chunk_index, cc.chunk_text, cc.chunk_source,
|
||||
ts_rank(cc.search_vector, websearch_to_tsquery('${ftsLang}', $1)) * ${sourceFactorCase} AS score,
|
||||
ts_rank(cc.search_vector, ${ftsQueryExpr}) * ${sourceFactorCase} AS score,
|
||||
CASE WHEN p.updated_at < (
|
||||
SELECT MAX(te.created_at) FROM timeline_entries te WHERE te.page_id = p.id
|
||||
) THEN true ELSE false END AS stale
|
||||
FROM content_chunks cc
|
||||
JOIN pages p ON p.id = cc.page_id
|
||||
JOIN sources s ON s.id = p.source_id
|
||||
WHERE cc.search_vector @@ websearch_to_tsquery('${ftsLang}', $1) ${detailFilter}${extraFilter} ${hardExcludeClause} ${visibilityClause}
|
||||
WHERE cc.search_vector @@ ${ftsQueryExpr} ${detailFilter}${extraFilter} ${hardExcludeClause} ${visibilityClause}
|
||||
ORDER BY score DESC
|
||||
LIMIT $2 OFFSET $3`,
|
||||
params
|
||||
|
||||
@@ -64,7 +64,7 @@ import { ConnectionManager } from './connection-manager.ts';
|
||||
import { logConnectionEvent } from './connection-audit.ts';
|
||||
import { validateSlug, contentHash, rowToPage, rowToStalePage, rowToChunk, rowToSearchResult, parseEmbedding, tryParseEmbedding, takeRowToTake, takeHitRowToHit, isUndefinedTableError, warnOncePerProcess } from './utils.ts';
|
||||
import { resolveBoostMap, resolveHardExcludes } from './search/source-boost.ts';
|
||||
import { buildSourceFactorCase, buildHardExcludeClause, buildVisibilityClause, buildRecencyComponentSql, buildBestPerPagePoolCte, buildOrFallbackWebsearchQuery } from './search/sql-ranking.ts';
|
||||
import { buildSourceFactorCase, buildHardExcludeClause, buildVisibilityClause, buildRecencyComponentSql, buildBestPerPagePoolCte, buildOrFallbackWebsearchQuery, buildWebsearchQueryExpr } from './search/sql-ranking.ts';
|
||||
import { DEFAULT_EMBEDDING_MODEL, DEFAULT_EMBEDDING_DIMENSIONS } from './ai/defaults.ts';
|
||||
import { DELETE_BATCH_SIZE } from './engine-constants.ts';
|
||||
|
||||
@@ -1691,6 +1691,8 @@ export class PostgresEngine implements BrainEngine {
|
||||
const hardExcludePrefixes = resolveHardExcludes(opts?.exclude_slug_prefixes, opts?.include_slug_prefixes);
|
||||
const hardExcludeClause = buildHardExcludeClause('p.slug', hardExcludePrefixes);
|
||||
|
||||
// #2380: slash-bearing queries match both the split-word and literal
|
||||
// slash forms — see buildWebsearchQueryExpr in ./search/sql-ranking.ts.
|
||||
const params: unknown[] = [query];
|
||||
let typeClause = '';
|
||||
if (type) {
|
||||
@@ -1761,6 +1763,7 @@ export class PostgresEngine implements BrainEngine {
|
||||
// FTS config name (e.g. 'english', 'pt_br'). Validated by getFtsLanguage()
|
||||
// — safe to interpolate into raw SQL.
|
||||
const ftsLang = getFtsLanguage();
|
||||
const ftsQueryExpr = buildWebsearchQueryExpr(ftsLang, '$1', query);
|
||||
|
||||
const rawQuery = `
|
||||
WITH ranked_chunks AS (
|
||||
@@ -1768,11 +1771,11 @@ export class PostgresEngine implements BrainEngine {
|
||||
p.slug, p.id as page_id, p.title, p.type, p.source_id,
|
||||
p.effective_date, p.effective_date_source,
|
||||
cc.id as chunk_id, cc.chunk_index, cc.chunk_text, cc.chunk_source,
|
||||
ts_rank(cc.search_vector, websearch_to_tsquery('${ftsLang}', $1)) * ${sourceFactorCase} AS score
|
||||
ts_rank(cc.search_vector, ${ftsQueryExpr}) * ${sourceFactorCase} AS score
|
||||
FROM content_chunks cc
|
||||
JOIN pages p ON p.id = cc.page_id
|
||||
JOIN sources s ON s.id = p.source_id
|
||||
WHERE cc.search_vector @@ websearch_to_tsquery('${ftsLang}', $1)
|
||||
WHERE cc.search_vector @@ ${ftsQueryExpr}
|
||||
${typeClause}
|
||||
${typesClause}
|
||||
${excludeSlugsClause}
|
||||
@@ -1863,7 +1866,10 @@ export class PostgresEngine implements BrainEngine {
|
||||
// FTS config name (e.g. 'english', 'pt_br'). Validated by getFtsLanguage()
|
||||
// — safe to interpolate into raw SQL.
|
||||
const ftsLang = getFtsLanguage();
|
||||
const ftsQueryExpr = buildWebsearchQueryExpr(ftsLang, '$1', query);
|
||||
|
||||
// #2380: slash-bearing queries match both the split-word and literal
|
||||
// slash forms — see buildWebsearchQueryExpr in ./search/sql-ranking.ts.
|
||||
const params: unknown[] = [query];
|
||||
let typeClause = '';
|
||||
if (opts?.type) {
|
||||
@@ -1923,7 +1929,7 @@ export class PostgresEngine implements BrainEngine {
|
||||
COALESCE(rep.chunk_index, 0) as chunk_index,
|
||||
COALESCE(rep.chunk_text, '') as chunk_text,
|
||||
COALESCE(rep.chunk_source, 'compiled_truth') as chunk_source,
|
||||
ts_rank_cd(p.search_vector, websearch_to_tsquery('${ftsLang}', $1)) * ${sourceFactorCase} AS score,
|
||||
ts_rank_cd(p.search_vector, ${ftsQueryExpr}) * ${sourceFactorCase} AS score,
|
||||
false AS stale
|
||||
FROM pages p
|
||||
JOIN sources s ON s.id = p.source_id
|
||||
@@ -1936,7 +1942,7 @@ export class PostgresEngine implements BrainEngine {
|
||||
ORDER BY (cc.chunk_source = 'compiled_truth') DESC, cc.chunk_index ASC
|
||||
LIMIT 1
|
||||
) rep ON true
|
||||
WHERE p.search_vector @@ websearch_to_tsquery('${ftsLang}', $1)
|
||||
WHERE p.search_vector @@ ${ftsQueryExpr}
|
||||
${typeClause}
|
||||
${typesClause}
|
||||
${excludeSlugsClause}
|
||||
@@ -2000,6 +2006,8 @@ export class PostgresEngine implements BrainEngine {
|
||||
const hardExcludePrefixes = resolveHardExcludes(opts?.exclude_slug_prefixes, opts?.include_slug_prefixes);
|
||||
const hardExcludeClause = buildHardExcludeClause('p.slug', hardExcludePrefixes);
|
||||
|
||||
// #2380: slash-bearing queries match both the split-word and literal
|
||||
// slash forms — see buildWebsearchQueryExpr in ./search/sql-ranking.ts.
|
||||
const params: unknown[] = [query];
|
||||
let typeClause = '';
|
||||
if (type) {
|
||||
@@ -2060,18 +2068,19 @@ export class PostgresEngine implements BrainEngine {
|
||||
// FTS config name (e.g. 'english', 'pt_br'). Validated by getFtsLanguage()
|
||||
// — safe to interpolate into raw SQL.
|
||||
const ftsLang = getFtsLanguage();
|
||||
const ftsQueryExpr = buildWebsearchQueryExpr(ftsLang, '$1', query);
|
||||
|
||||
const rawQuery = `
|
||||
SELECT
|
||||
p.slug, p.id as page_id, p.title, p.type, p.source_id,
|
||||
p.effective_date, p.effective_date_source,
|
||||
cc.id as chunk_id, cc.chunk_index, cc.chunk_text, cc.chunk_source,
|
||||
ts_rank(cc.search_vector, websearch_to_tsquery('${ftsLang}', $1)) * ${sourceFactorCase} AS score,
|
||||
ts_rank(cc.search_vector, ${ftsQueryExpr}) * ${sourceFactorCase} AS score,
|
||||
false AS stale
|
||||
FROM content_chunks cc
|
||||
JOIN pages p ON p.id = cc.page_id
|
||||
JOIN sources s ON s.id = p.source_id
|
||||
WHERE cc.search_vector @@ websearch_to_tsquery('${ftsLang}', $1)
|
||||
WHERE cc.search_vector @@ ${ftsQueryExpr}
|
||||
${typeClause}
|
||||
${typesClause}
|
||||
${excludeSlugsClause}
|
||||
|
||||
@@ -251,6 +251,28 @@ export function buildOrFallbackWebsearchQuery(query: string): string | null {
|
||||
return tokens.join(' OR ');
|
||||
}
|
||||
|
||||
/**
|
||||
* #2380: FTS query expression for slash-bearing queries. Postgres' default
|
||||
* text-search parser classifies `foo/bar` as a single `file`-alias lexeme —
|
||||
* on BOTH the query side and the index side. So a raw `foo/bar` query only
|
||||
* matched documents carrying the identical joined lexeme (literal paths),
|
||||
* and a slash-split query only matches documents whose text had the words
|
||||
* separated. Neither form alone covers both document shapes; OR the two
|
||||
* parses so a slash query matches prose ("foo and bar", stemmed, AND
|
||||
* semantics) AND literal slash forms ("src/core/x.ts") alike.
|
||||
*
|
||||
* Slash-free queries return the plain single-parse expression — byte-
|
||||
* identical SQL and identical ts_rank to the historical behavior.
|
||||
*
|
||||
* `ftsLang` is validated by getFtsLanguage() (safe to interpolate);
|
||||
* `param` is a `$N` placeholder, never user text.
|
||||
*/
|
||||
export function buildWebsearchQueryExpr(ftsLang: string, param: string, query: string): string {
|
||||
const plain = `websearch_to_tsquery('${ftsLang}', ${param})`;
|
||||
if (!query.includes('/')) return plain;
|
||||
return `(websearch_to_tsquery('${ftsLang}', translate(${param}, '/', ' ')) || ${plain})`;
|
||||
}
|
||||
|
||||
// ============================================================
|
||||
// v0.29.1 — Recency component SQL builder
|
||||
// ============================================================
|
||||
|
||||
@@ -160,33 +160,6 @@ export async function resolveSourceId(
|
||||
return 'default';
|
||||
}
|
||||
|
||||
/**
|
||||
* Engine-free tiers (1-3) of the resolution chain: explicit flag →
|
||||
* GBRAIN_SOURCE env → .gbrain-source dotfile walk. Used by the thin-client
|
||||
* CLI path (#2098), which has no local engine to run tiers 4-6 or
|
||||
* assertSourceExists against — the remote server enforces existence + grant.
|
||||
* Returns null when no engine-free tier fires.
|
||||
*/
|
||||
export function resolveSourceIdEngineFree(
|
||||
explicit: string | null | undefined,
|
||||
cwd: string = process.cwd(),
|
||||
): string | null {
|
||||
if (explicit) {
|
||||
if (!SOURCE_ID_RE.test(explicit)) {
|
||||
throw new Error(`Invalid --source value "${explicit}". Must match [a-z0-9-]{1,32}.`);
|
||||
}
|
||||
return explicit;
|
||||
}
|
||||
const env = process.env.GBRAIN_SOURCE;
|
||||
if (env && env.length > 0) {
|
||||
if (!SOURCE_ID_RE.test(env)) {
|
||||
throw new Error(`Invalid GBRAIN_SOURCE value "${env}". Must match [a-z0-9-]{1,32}.`);
|
||||
}
|
||||
return env;
|
||||
}
|
||||
return readDotfileWalk(cwd);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the id of the SINGLE registered non-default source with a
|
||||
* local_path, when exactly one such row exists. Returns null when:
|
||||
|
||||
@@ -28,8 +28,8 @@ describe('v0.32 #779: no_batch_cap suppresses the missing-max_batch_tokens warni
|
||||
resetGateway();
|
||||
});
|
||||
|
||||
test('Ollama, LiteLLM, llama-server all declare no_batch_cap: true', () => {
|
||||
for (const id of ['ollama', 'litellm', 'llama-server']) {
|
||||
test('LiteLLM and llama-server declare no_batch_cap: true', () => {
|
||||
for (const id of ['litellm', 'llama-server']) {
|
||||
const r = getRecipe(id);
|
||||
expect(r, `${id} not registered`).toBeDefined();
|
||||
expect(
|
||||
@@ -39,6 +39,18 @@ describe('v0.32 #779: no_batch_cap suppresses the missing-max_batch_tokens warni
|
||||
}
|
||||
});
|
||||
|
||||
test('#2552: Ollama declares a conservative static batch cap, not no_batch_cap', () => {
|
||||
// A CPU-only Ollama box wedges when a whole page ships in one request;
|
||||
// Ollama never returns a token-limit error so the recursive-halving
|
||||
// safety net can't fire. The pre-split cap is the only guard.
|
||||
const r = getRecipe('ollama');
|
||||
expect(r).toBeDefined();
|
||||
const e = r!.touchpoints.embedding!;
|
||||
expect(e.no_batch_cap).toBeUndefined();
|
||||
expect(e.max_batch_tokens).toBe(4096);
|
||||
expect(e.chars_per_token).toBe(2);
|
||||
});
|
||||
|
||||
test('configureGateway does NOT warn for ollama/litellm/llama-server', () => {
|
||||
warnSpy.mockClear();
|
||||
resetGateway();
|
||||
|
||||
@@ -0,0 +1,118 @@
|
||||
/**
|
||||
* #2552: cloud-tuned embedding defaults silently wedge CPU-only local
|
||||
* endpoints (Ollama). Three-part fix under test:
|
||||
*
|
||||
* 1. `isLocalEmbeddingEndpoint()` — gateway helper detecting local
|
||||
* inference servers (ollama / llama-server recipes, localhost base URL).
|
||||
* 2. `resolveEmbedConcurrency()` — embed auto-caps the 20-worker fan-out
|
||||
* at LOCAL_EMBED_CONCURRENCY_CAP for local endpoints unless the
|
||||
* operator set GBRAIN_EMBED_CONCURRENCY explicitly.
|
||||
* 3. `computeEmbedConcurrencyCheck()` — doctor warns when an explicit env
|
||||
* override fans out against a local endpoint.
|
||||
*
|
||||
* Serial: mutates process.env and the module-global gateway config.
|
||||
*/
|
||||
|
||||
import { afterAll, afterEach, describe, expect, test } from 'bun:test';
|
||||
import {
|
||||
configureGateway,
|
||||
resetGateway,
|
||||
isLocalEmbeddingEndpoint,
|
||||
LOCAL_EMBED_CONCURRENCY_CAP,
|
||||
} from '../src/core/ai/gateway.ts';
|
||||
import { resolveEmbedConcurrency } from '../src/commands/embed.ts';
|
||||
import { computeEmbedConcurrencyCheck } from '../src/commands/doctor.ts';
|
||||
|
||||
const SAVED_ENV = process.env.GBRAIN_EMBED_CONCURRENCY;
|
||||
|
||||
afterEach(() => {
|
||||
resetGateway();
|
||||
if (SAVED_ENV === undefined) delete process.env.GBRAIN_EMBED_CONCURRENCY;
|
||||
else process.env.GBRAIN_EMBED_CONCURRENCY = SAVED_ENV;
|
||||
});
|
||||
|
||||
afterAll(() => {
|
||||
resetGateway();
|
||||
});
|
||||
|
||||
describe('#2552 isLocalEmbeddingEndpoint', () => {
|
||||
test('false when the gateway is not configured (fail-open to cloud behavior)', () => {
|
||||
resetGateway();
|
||||
expect(isLocalEmbeddingEndpoint()).toBe(false);
|
||||
});
|
||||
|
||||
test('true for the ollama recipe', () => {
|
||||
configureGateway({ embedding_model: 'ollama:nomic-embed-text', env: {} });
|
||||
expect(isLocalEmbeddingEndpoint()).toBe(true);
|
||||
});
|
||||
|
||||
test('true for the llama-server recipe', () => {
|
||||
configureGateway({ embedding_model: 'llama-server:my-gguf', env: {} });
|
||||
expect(isLocalEmbeddingEndpoint()).toBe(true);
|
||||
});
|
||||
|
||||
test('false for a cloud recipe', () => {
|
||||
configureGateway({
|
||||
embedding_model: 'openai:text-embedding-3-small',
|
||||
env: { OPENAI_API_KEY: 'fake' },
|
||||
});
|
||||
expect(isLocalEmbeddingEndpoint()).toBe(false);
|
||||
});
|
||||
|
||||
test('true when a cloud recipe base URL is explicitly pointed at localhost', () => {
|
||||
configureGateway({
|
||||
embedding_model: 'openai:text-embedding-3-small',
|
||||
env: { OPENAI_API_KEY: 'fake' },
|
||||
base_urls: { openai: 'http://localhost:8080/v1' },
|
||||
});
|
||||
expect(isLocalEmbeddingEndpoint()).toBe(true);
|
||||
});
|
||||
});
|
||||
|
||||
describe('#2552 resolveEmbedConcurrency', () => {
|
||||
test('caps at LOCAL_EMBED_CONCURRENCY_CAP for a local endpoint when env is unset', () => {
|
||||
delete process.env.GBRAIN_EMBED_CONCURRENCY;
|
||||
configureGateway({ embedding_model: 'ollama:nomic-embed-text', env: {} });
|
||||
expect(resolveEmbedConcurrency()).toBe(LOCAL_EMBED_CONCURRENCY_CAP);
|
||||
});
|
||||
|
||||
test('explicit env override always wins, even against a local endpoint', () => {
|
||||
process.env.GBRAIN_EMBED_CONCURRENCY = '10';
|
||||
configureGateway({ embedding_model: 'ollama:nomic-embed-text', env: {} });
|
||||
expect(resolveEmbedConcurrency()).toBe(10);
|
||||
});
|
||||
|
||||
test('cloud endpoints keep the historical default of 20', () => {
|
||||
delete process.env.GBRAIN_EMBED_CONCURRENCY;
|
||||
configureGateway({ env: { OPENAI_API_KEY: 'fake' } });
|
||||
expect(resolveEmbedConcurrency()).toBe(20);
|
||||
});
|
||||
|
||||
test('pacing only ever lowers concurrency', () => {
|
||||
delete process.env.GBRAIN_EMBED_CONCURRENCY;
|
||||
configureGateway({ embedding_model: 'ollama:nomic-embed-text', env: {} });
|
||||
expect(resolveEmbedConcurrency(1)).toBe(1);
|
||||
expect(resolveEmbedConcurrency(16)).toBe(LOCAL_EMBED_CONCURRENCY_CAP);
|
||||
});
|
||||
});
|
||||
|
||||
describe('#2552 computeEmbedConcurrencyCheck (doctor)', () => {
|
||||
test('ok for non-local endpoints', () => {
|
||||
expect(computeEmbedConcurrencyCheck(false, '20', 2).status).toBe('ok');
|
||||
});
|
||||
|
||||
test('warn when an explicit override exceeds the local cap', () => {
|
||||
const check = computeEmbedConcurrencyCheck(true, '20', 2);
|
||||
expect(check.status).toBe('warn');
|
||||
expect(check.message).toContain('GBRAIN_EMBED_CONCURRENCY=20');
|
||||
});
|
||||
|
||||
test('ok when env is unset against a local endpoint (auto-cap applies)', () => {
|
||||
expect(computeEmbedConcurrencyCheck(true, undefined, 2).status).toBe('ok');
|
||||
});
|
||||
|
||||
test('ok when the override is at or under the cap', () => {
|
||||
expect(computeEmbedConcurrencyCheck(true, '2', 2).status).toBe('ok');
|
||||
expect(computeEmbedConcurrencyCheck(true, '1', 2).status).toBe('ok');
|
||||
});
|
||||
});
|
||||
@@ -216,6 +216,67 @@ describe('PGLiteEngine: Search', () => {
|
||||
expect(results.length).toBe(0);
|
||||
});
|
||||
|
||||
// Regression (#2380): queries containing `/` used to bypass FTS AND
|
||||
// semantics. Postgres' default text-search parser classifies `foo/bar` as
|
||||
// a `file`-alias token mapped to the `simple` dictionary, so it became a
|
||||
// single un-stemmed lexeme `'foo/bar'` that never matches indexed text —
|
||||
// the primary FTS pass returned 0 and the OR fallback took over, matching
|
||||
// pages that contain EITHER term. searchKeyword/searchTitles now normalize
|
||||
// `/` to whitespace before websearch_to_tsquery parses, so the primary
|
||||
// AND pass matches directly.
|
||||
test('searchKeyword: slash query matches with AND semantics, not OR fallback', async () => {
|
||||
// Decoy shares only ONE of the two query terms ('enterprise').
|
||||
await engine.putPage('concepts/enterprise-pricing', {
|
||||
type: 'concept', title: 'Widget Pricing',
|
||||
compiled_truth: 'Enterprise pricing for widgets.',
|
||||
});
|
||||
await engine.upsertChunks('concepts/enterprise-pricing', [
|
||||
{ chunk_index: 0, chunk_text: 'Enterprise pricing for widgets', chunk_source: 'compiled_truth' },
|
||||
]);
|
||||
|
||||
// Both terms co-occur only in the novamind chunk. Pre-fix this returned
|
||||
// BOTH pages (primary pass zero-hit → OR fallback); post-fix the primary
|
||||
// AND pass returns exactly the co-occurrence page.
|
||||
const results = await engine.searchKeyword('NovaMind/enterprise');
|
||||
expect(results.length).toBe(1);
|
||||
expect(results[0].slug).toBe('companies/novamind');
|
||||
});
|
||||
|
||||
test('searchTitles: slash query matches with AND semantics, not OR fallback', async () => {
|
||||
await engine.putPage('companies/novamind-enterprise', {
|
||||
type: 'company', title: 'NovaMind Enterprise Platform',
|
||||
compiled_truth: 'Placeholder body.',
|
||||
});
|
||||
await engine.putPage('guides/enterprise-sales', {
|
||||
type: 'concept', title: 'Enterprise Sales Guide',
|
||||
compiled_truth: 'Placeholder body.',
|
||||
});
|
||||
|
||||
// Pre-fix: `NovaMind/Enterprise` parsed as one file-alias lexeme → the
|
||||
// primary title pass returned 0 and the OR fallback matched BOTH titles.
|
||||
const results = await engine.searchTitles('NovaMind/Enterprise');
|
||||
expect(results.length).toBe(1);
|
||||
expect(results[0].slug).toBe('companies/novamind-enterprise');
|
||||
});
|
||||
|
||||
test('searchKeyword: slash query still matches the literal slash form (file paths)', async () => {
|
||||
// The INDEX side also emits the joined file-alias lexeme for literal
|
||||
// `foo/bar` text, so a query normalized to split words alone would go
|
||||
// blind to documents containing the literal slash form (paths, URLs).
|
||||
// buildWebsearchQueryExpr ORs both parses; this pins the raw arm.
|
||||
await engine.putPage('runbooks/widget-deploy', {
|
||||
type: 'concept', title: 'Widget Deploy Runbook',
|
||||
compiled_truth: 'Runbook for the acme/widget deployment pipeline.',
|
||||
});
|
||||
await engine.upsertChunks('runbooks/widget-deploy', [
|
||||
{ chunk_index: 0, chunk_text: 'Runbook for the acme/widget deployment pipeline', chunk_source: 'compiled_truth' },
|
||||
]);
|
||||
|
||||
const results = await engine.searchKeyword('acme/widget');
|
||||
expect(results.length).toBe(1);
|
||||
expect(results[0].slug).toBe('runbooks/widget-deploy');
|
||||
});
|
||||
|
||||
test('tsvector trigger populates search_vector on insert', async () => {
|
||||
// Verify the PL/pgSQL trigger fires and content_chunks.search_vector is
|
||||
// populated from chunk_text. v0.20.0 Cathedral II Layer 3 moved FTS from
|
||||
|
||||
@@ -1,142 +0,0 @@
|
||||
/**
|
||||
* #2098: thin-client routing dropped --source / GBRAIN_SOURCE / .gbrain-source.
|
||||
*
|
||||
* The local CLI path resolves source scope in makeContext (ctx.sourceId); the
|
||||
* thin-client route short-circuits before that and sent params verbatim, so
|
||||
* `gbrain query --source X` against a remote brain silently searched unscoped
|
||||
* (the server op ignores the unknown `source` key).
|
||||
*
|
||||
* applyThinClientSourceScope runs the engine-free tiers (flag → env → dotfile)
|
||||
* and maps the result onto the op's `source_id` wire param. These tests fail
|
||||
* without the fix (params.source_id stays undefined / params.source leaks).
|
||||
*/
|
||||
|
||||
import { describe, test, expect } from 'bun:test';
|
||||
import { mkdtempSync, rmSync, writeFileSync } from 'fs';
|
||||
import { join } from 'path';
|
||||
import { tmpdir } from 'os';
|
||||
import { applyThinClientSourceScope, parseOpArgs } from '../src/cli.ts';
|
||||
import { operationsByName } from '../src/core/operations.ts';
|
||||
import { withEnv } from './helpers/with-env.ts';
|
||||
|
||||
const queryOp = operationsByName.query;
|
||||
|
||||
describe('applyThinClientSourceScope (#2098)', () => {
|
||||
test('--source maps onto the query op wire param source_id', async () => {
|
||||
await withEnv({ GBRAIN_SOURCE: undefined }, () => {
|
||||
const params = parseOpArgs(queryOp, ['find things', '--source', 'wiki']);
|
||||
expect(params.source).toBe('wiki'); // pre-fix state: wrong key
|
||||
applyThinClientSourceScope(queryOp, params, '/');
|
||||
expect(params.source_id).toBe('wiki');
|
||||
expect('source' in params).toBe(false); // never leaks the unknown key
|
||||
});
|
||||
});
|
||||
|
||||
test('GBRAIN_SOURCE env tier fires when no flag is passed', async () => {
|
||||
await withEnv({ GBRAIN_SOURCE: 'gstack' }, () => {
|
||||
const params = parseOpArgs(queryOp, ['find things']);
|
||||
applyThinClientSourceScope(queryOp, params, '/');
|
||||
expect(params.source_id).toBe('gstack');
|
||||
});
|
||||
});
|
||||
|
||||
test('.gbrain-source dotfile tier fires when flag and env are absent', async () => {
|
||||
await withEnv({ GBRAIN_SOURCE: undefined }, () => {
|
||||
const tmp = mkdtempSync(join(tmpdir(), 'gbrain-thin-scope-'));
|
||||
try {
|
||||
writeFileSync(join(tmp, '.gbrain-source'), 'essays\n');
|
||||
const params = parseOpArgs(queryOp, ['find things']);
|
||||
applyThinClientSourceScope(queryOp, params, tmp);
|
||||
expect(params.source_id).toBe('essays');
|
||||
} finally {
|
||||
rmSync(tmp, { recursive: true, force: true });
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
test('explicit --source-id on the wire wins over ambient env scope', async () => {
|
||||
await withEnv({ GBRAIN_SOURCE: 'gstack' }, () => {
|
||||
const params = parseOpArgs(queryOp, ['find things', '--source-id', 'wiki']);
|
||||
applyThinClientSourceScope(queryOp, params, '/');
|
||||
expect(params.source_id).toBe('wiki');
|
||||
});
|
||||
});
|
||||
|
||||
test('--source together with --source-id is rejected loudly', async () => {
|
||||
await withEnv({ GBRAIN_SOURCE: undefined }, () => {
|
||||
const params = parseOpArgs(queryOp, ['q', '--source', 'a', '--source-id', 'b']);
|
||||
expect(() => applyThinClientSourceScope(queryOp, params, '/')).toThrow(/not both/);
|
||||
});
|
||||
});
|
||||
|
||||
test('invalid --source value is rejected loudly', async () => {
|
||||
await withEnv({ GBRAIN_SOURCE: undefined }, () => {
|
||||
const params = parseOpArgs(queryOp, ['q', '--source', 'Bad_Value!']);
|
||||
expect(() => applyThinClientSourceScope(queryOp, params, '/')).toThrow(/Invalid --source/);
|
||||
});
|
||||
});
|
||||
|
||||
test('--source on an op with no source_id wire param errors instead of silently dropping', async () => {
|
||||
await withEnv({ GBRAIN_SOURCE: undefined }, () => {
|
||||
const op = operationsByName.add_tag;
|
||||
expect('source_id' in op.params).toBe(false);
|
||||
const params = { slug: 'x', tag: 'y', source: 'wiki' };
|
||||
expect(() => applyThinClientSourceScope(op, params, '/')).toThrow(/--source/);
|
||||
});
|
||||
});
|
||||
|
||||
test('ambient env scope on an op with no source_id wire param is ignored (no throw)', async () => {
|
||||
await withEnv({ GBRAIN_SOURCE: 'wiki' }, () => {
|
||||
const op = operationsByName.add_tag;
|
||||
const params: Record<string, unknown> = { slug: 'x', tag: 'y' };
|
||||
applyThinClientSourceScope(op, params, '/');
|
||||
expect(params.source_id).toBeUndefined();
|
||||
});
|
||||
});
|
||||
|
||||
test('ops that declare their OWN source param are left untouched', async () => {
|
||||
await withEnv({ GBRAIN_SOURCE: undefined }, () => {
|
||||
const op = operationsByName.put_raw_data;
|
||||
expect('source' in op.params).toBe(true);
|
||||
const params: Record<string, unknown> = { slug: 'x', source: 'crustdata', data: {} };
|
||||
applyThinClientSourceScope(op, params, '/');
|
||||
expect(params.source).toBe('crustdata');
|
||||
expect(params.source_id).toBeUndefined();
|
||||
});
|
||||
});
|
||||
|
||||
test('get_skill: ambient scope never leaks into its non-scope source_id param', async () => {
|
||||
await withEnv({ GBRAIN_SOURCE: 'wiki' }, () => {
|
||||
const op = operationsByName.get_skill;
|
||||
expect('source_id' in op.params).toBe(true); // has the param, but it is a mode switch
|
||||
const params: Record<string, unknown> = { name: 'ingest' };
|
||||
applyThinClientSourceScope(op, params, '/');
|
||||
expect(params.source_id).toBeUndefined(); // would flip host catalog → brain-pack lookup
|
||||
});
|
||||
});
|
||||
|
||||
test('get_skill: explicit --source errors instead of masquerading as --source-id', async () => {
|
||||
await withEnv({ GBRAIN_SOURCE: undefined }, () => {
|
||||
const op = operationsByName.get_skill;
|
||||
const params: Record<string, unknown> = { name: 'ingest', source: 'wiki' };
|
||||
expect(() => applyThinClientSourceScope(op, params, '/')).toThrow(/--source-id/);
|
||||
});
|
||||
});
|
||||
|
||||
test('get_skill: explicit --source-id passes through untouched', async () => {
|
||||
await withEnv({ GBRAIN_SOURCE: 'gstack' }, () => {
|
||||
const op = operationsByName.get_skill;
|
||||
const params: Record<string, unknown> = { name: 'ingest', source_id: 'wiki' };
|
||||
applyThinClientSourceScope(op, params, '/');
|
||||
expect(params.source_id).toBe('wiki');
|
||||
});
|
||||
});
|
||||
|
||||
test('no scope from any tier leaves params unchanged', async () => {
|
||||
await withEnv({ GBRAIN_SOURCE: undefined }, () => {
|
||||
const params = parseOpArgs(queryOp, ['find things']);
|
||||
applyThinClientSourceScope(queryOp, params, '/');
|
||||
expect(params.source_id).toBeUndefined();
|
||||
});
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user