test: split cli tests from source tree (#216)

* feat(cli): define full warehouse dialect contract

* test(cli): keep dialect edge tests focused

* fix(cli): stabilize dialect contract foundation

* refactor(connectors): own read-only query preparation

* refactor(connectors): resolve dialects through registry

* refactor(connectors): keep concrete dialect classes internal

* chore(workspace): enforce dialect import boundary

* refactor(cli): resolve relationship dialect at scan boundary

* refactor(cli): use dialect display parsing for entity details

* refactor(cli): use dialect display parsing for warehouse catalog

* refactor(cli): use dialect SQL in relationship workflows

* test(cli): verify solid dialect scan workflow closure

* test: split cli tests from source tree

* refactor(cli): standardize BigQuery scope listing

* feat(sqlite): implement connector scope listing

* test(connectors): cover required table listing

* feat(cli): add warehouse driver registry

* refactor(setup): route scope discovery through driver registry

* refactor(cli): route local query execution through driver registry

* refactor(historic-sql): route dialect support through driver registry

* refactor(cli): test warehouse connections through driver registry

* fix(cli): close driver registry type export gaps

* Improve setup daemon diagnostics

* refactor(setup): centralize rail-prefixed diagnostics + query-history fallback

Extract errorMessage, writePrefixedLines, and flushPrefixedBufferedCommandOutput
into clack.ts so the setup wizard, managed daemons, and embedding/agent steps
share one rail-formatted writer. setup-databases.ts also adds a
"disable query history and retry" option when the schema-context build fails
and query history is the likely culprit, surfaced via a new
failed-query-history-unavailable status.

* fix(cli): carry catalog through the picker so BigQuery/Snowflake/SQL Server scope filters match

The setup picker's KtxTableListEntry was a 2-level { schema, name }, so
qualifiedTableId always wrote db.name into enabled_tables. When BigQuery,
Snowflake, or SQL Server later ran fast ingest, their introspect step filtered
the scope set with scopedTableNames(scope, { catalog: projectId|database, db })
— catalog was non-null on the introspect side but null in the scope refs, so
every entry was rejected, the live-database adapter staged zero table files,
and detect() failed with 'Adapter "live-database" did not recognize fetched
source output'.

Align the picker boundary with the canonical 3-level KtxTableRef:

- Add catalog: string | null to KtxTableListEntry.
- BigQuery/Snowflake/SQL Server listTables populate catalog from the
  resolved projectId / database; Postgres/MySQL/ClickHouse/SQLite set null.
- qualifiedTableId emits catalog.schema.name when catalog is non-null
  (resolveEnabledTables already accepts the 3-part shape) and
  schemasFromEnabledTables now goes through parseDottedTableEntry so it
  recovers the schema correctly from both 2-part and 3-part entries.
- Export parseDottedTableEntry from enabled-tables.ts (@internal) for picker
  reuse.

Update listTables expectations in all seven connector tests and the setup /
picker test fixtures. Add a picker regression test that covers the
catalog-bearing round-trip (save + refine).

* fix(cli): allow debug telemetry under opt-out env
This commit is contained in:
Andrey Avtomonov 2026-05-26 08:49:05 +02:00 committed by GitHub
parent 924868841d
commit 56985b7e09
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
548 changed files with 5048 additions and 2228 deletions

View file

@ -0,0 +1,272 @@
import { describe, expect, it, vi } from 'vitest';
import { KnowledgeWikiService, type WikiFrontmatter } from '../../../src/context/wiki/knowledge-wiki.service.js';
function makeService() {
const pagesRepository: Record<string, ReturnType<typeof vi.fn>> = {
upsertPage: vi.fn().mockResolvedValue(undefined),
deleteByKey: vi.fn().mockResolvedValue(0),
deleteByScope: vi.fn().mockResolvedValue(0),
deleteStale: vi.fn().mockResolvedValue(0),
getExistingSearchTexts: vi.fn().mockResolvedValue(new Map()),
applyDiffTransactional: vi.fn().mockResolvedValue(undefined),
};
const embeddingService = {
computeEmbedding: vi.fn().mockResolvedValue([0.1, 0.2, 0.3]),
computeEmbeddingsBulk: vi.fn().mockResolvedValue([]),
maxBatchSize: 16,
};
const configService = {
forWorktree: vi.fn().mockReturnValue({
writeFile: vi.fn(),
readFile: vi.fn(),
deleteFile: vi.fn(),
listFiles: vi.fn(),
getFileHistory: vi.fn(),
}),
writeFile: vi.fn(),
readFile: vi.fn(),
deleteFile: vi.fn(),
listFiles: vi.fn(),
getFileHistory: vi.fn(),
};
const gitService = {
diffNameStatus: vi.fn().mockResolvedValue([]),
getFileAtCommit: vi.fn().mockResolvedValue(''),
};
const logger = {
log: vi.fn(),
warn: vi.fn(),
error: vi.fn(),
};
const service = new KnowledgeWikiService(
configService as any,
embeddingService as any,
pagesRepository as any,
gitService as any,
logger as any,
);
return { service, pagesRepository, embeddingService, configService, gitService, logger };
}
const fm: WikiFrontmatter = { summary: 'sum', usage_mode: 'auto' };
describe('KnowledgeWikiService file reads', () => {
it('warns and returns null when an existing page cannot be parsed', async () => {
const { service, configService, logger } = makeService();
configService.readFile.mockResolvedValue({ content: '---\nsummary: [\n---\nBody' });
await expect(service.readPage('GLOBAL', null, 'revenue')).resolves.toBeNull();
expect(configService.readFile).toHaveBeenCalledWith('wiki/global/revenue.md');
expect(logger.warn).toHaveBeenCalledWith(expect.stringContaining('[readPage] wiki/global/revenue.md: parse failed:'));
});
it('warns and returns an empty page list when directory listing fails', async () => {
const { service, configService, logger } = makeService();
configService.listFiles.mockRejectedValue(new Error('filesystem unavailable'));
await expect(service.listPageKeys('GLOBAL', null)).resolves.toEqual([]);
expect(logger.warn).toHaveBeenCalledWith('[listPageKeys] wiki/global: filesystem unavailable');
});
});
describe('KnowledgeWikiService.syncIndex result stats', () => {
it('reports scanned, updated, deleted, and embedding counts', async () => {
const { service, pagesRepository, embeddingService, configService } = makeService();
configService.listFiles.mockResolvedValue({ files: ['wiki/global/revenue.md'] });
configService.readFile.mockResolvedValue({
content: '---\nsummary: Revenue\nusage_mode: auto\ntags:\n - finance\n---\n\nPaid orders.\n',
});
pagesRepository.getExistingSearchTexts.mockResolvedValue(
new Map([
['old-page', { searchText: 'old', hasEmbedding: true }],
]),
);
embeddingService.computeEmbeddingsBulk.mockResolvedValue([[0.1, 0.2, 0.3]]);
pagesRepository.deleteStale.mockResolvedValue(1);
await expect(service.syncIndex('GLOBAL', null)).resolves.toEqual({
scanned: 1,
updated: 1,
deleted: 1,
embeddingsRecomputed: 1,
embeddingsFailed: 0,
});
});
it('indexes lexical rows when embeddings are not configured', async () => {
const { pagesRepository, configService, gitService, logger } = makeService();
const service = new KnowledgeWikiService(
configService as any,
null,
pagesRepository as any,
gitService as any,
logger as any,
);
configService.listFiles.mockResolvedValue({ files: ['wiki/global/revenue.md'] });
configService.readFile.mockResolvedValue({
content: '---\nsummary: Revenue\nusage_mode: auto\n---\n\nPaid orders.\n',
});
pagesRepository.getExistingSearchTexts.mockResolvedValue(new Map());
pagesRepository.deleteStale.mockResolvedValue(0);
const result = await service.syncIndex('GLOBAL', null);
expect(result.embeddingsRecomputed).toBe(0);
expect(result.embeddingsFailed).toBe(0);
expect(pagesRepository.upsertPage).toHaveBeenCalledWith(
expect.objectContaining({ pageKey: 'revenue', embedding: null }),
);
});
it('does not update unchanged lexical-only wiki rows on repeated sync', async () => {
const { pagesRepository, configService, gitService, logger } = makeService();
const service = new KnowledgeWikiService(
configService as any,
null,
pagesRepository as any,
gitService as any,
logger as any,
);
configService.listFiles.mockResolvedValue({ files: ['wiki/global/revenue.md'] });
configService.readFile.mockResolvedValue({
content: '---\nsummary: Revenue\nusage_mode: auto\n---\n\nPaid orders.\n',
});
pagesRepository.getExistingSearchTexts.mockResolvedValue(
new Map([
['revenue', { searchText: 'revenue\nRevenue\nPaid orders.', hasEmbedding: false }],
]),
);
pagesRepository.deleteStale.mockResolvedValue(0);
await expect(service.syncIndex('GLOBAL', null)).resolves.toEqual({
scanned: 1,
updated: 0,
deleted: 0,
embeddingsRecomputed: 0,
embeddingsFailed: 0,
});
expect(pagesRepository.upsertPage).not.toHaveBeenCalled();
expect(pagesRepository.deleteStale).toHaveBeenCalledWith('GLOBAL', null, ['revenue']);
});
});
describe('KnowledgeWikiService.forWorktree isolation', () => {
it('syncSinglePage in worktree scope does not call pagesRepository.upsertPage', async () => {
const { service, pagesRepository, embeddingService } = makeService();
const scoped = service.forWorktree('/tmp/fake-worktree');
await scoped.syncSinglePage('GLOBAL', null, 'key', fm, 'body');
expect(pagesRepository.upsertPage).not.toHaveBeenCalled();
expect(embeddingService.computeEmbedding).not.toHaveBeenCalled();
});
it('deleteFromIndex in worktree scope does not call pagesRepository.deleteByKey', async () => {
const { service, pagesRepository } = makeService();
const scoped = service.forWorktree('/tmp/fake-worktree');
await scoped.deleteFromIndex('GLOBAL', null, 'key');
expect(pagesRepository.deleteByKey).not.toHaveBeenCalled();
});
it('syncSinglePage in main scope still calls pagesRepository.upsertPage', async () => {
const { service, pagesRepository } = makeService();
await service.syncSinglePage('GLOBAL', null, 'key', fm, 'body');
expect(pagesRepository.upsertPage).toHaveBeenCalledTimes(1);
});
});
describe('KnowledgeWikiService.syncFromCommit', () => {
it('applies upserts for added/modified files and deletes for removed files in a single transactional batch', async () => {
const { service, pagesRepository, gitService } = makeService();
gitService.diffNameStatus.mockResolvedValue([
{ status: 'A', path: 'wiki/global/new-page.md' },
{ status: 'M', path: 'wiki/global/changed-page.md' },
{ status: 'D', path: 'wiki/global/gone-page.md' },
]);
gitService.getFileAtCommit.mockImplementation((path: string) => {
if (path.endsWith('new-page.md')) {
return Promise.resolve('---\nsummary: new\nusage_mode: auto\n---\n\nbody-new\n');
}
if (path.endsWith('changed-page.md')) {
return Promise.resolve('---\nsummary: changed\nusage_mode: auto\n---\n\nbody-changed\n');
}
return Promise.reject(new Error(`unexpected getFileAtCommit path: ${path}`));
});
await service.syncFromCommit('sha-before', 'sha-after', 'run-uuid');
expect(pagesRepository.applyDiffTransactional).toHaveBeenCalledTimes(1);
const call = pagesRepository.applyDiffTransactional.mock.calls[0][0];
expect(call.runId).toBe('run-uuid');
expect(call.upserts).toHaveLength(2);
expect(call.upserts).toEqual(
expect.arrayContaining([
expect.objectContaining({ scope: 'GLOBAL', pageKey: 'new-page', summary: 'new' }),
expect.objectContaining({ scope: 'GLOBAL', pageKey: 'changed-page', summary: 'changed' }),
]),
);
expect(call.deletes).toEqual([{ scope: 'GLOBAL', scopeId: null, pageKey: 'gone-page' }]);
});
it('indexes only flat wiki pages and skips nested paths from commit sync', async () => {
const { service, pagesRepository, gitService, logger } = makeService();
gitService.diffNameStatus.mockResolvedValue([
{ status: 'A', path: 'wiki/global/revenue-policy.md' },
{ status: 'A', path: 'wiki/global/historic-sql-order-lifecycle.md' },
{ status: 'A', path: 'wiki/global/historic-sql/order-lifecycle.md' },
{ status: 'A', path: 'wiki/global/orbit/company-overview.md' },
]);
gitService.getFileAtCommit.mockImplementation((path: string) => {
if (path.endsWith('revenue-policy.md')) {
return Promise.resolve('---\nsummary: revenue\nusage_mode: auto\n---\n\nbody-revenue\n');
}
if (path.endsWith('order-lifecycle.md')) {
return Promise.resolve('---\nsummary: order lifecycle\nusage_mode: auto\n---\n\nbody-orders\n');
}
if (path.endsWith('retired-pattern.md')) {
return Promise.resolve('---\nsummary: retired\nusage_mode: never\n---\n\nbody-retired\n');
}
return Promise.reject(new Error(`unexpected getFileAtCommit path: ${path}`));
});
await service.syncFromCommit('sha-before', 'sha-after', 'run-uuid');
expect(gitService.getFileAtCommit).not.toHaveBeenCalledWith('wiki/global/orbit/company-overview.md', 'sha-after');
expect(gitService.getFileAtCommit).not.toHaveBeenCalledWith('wiki/global/historic-sql/order-lifecycle.md', 'sha-after');
expect(logger.warn).toHaveBeenCalledWith(
'[wiki.sync] skipping unparseable path: wiki/global/orbit/company-overview.md',
);
expect(logger.warn).toHaveBeenCalledWith(
'[wiki.sync] skipping unparseable path: wiki/global/historic-sql/order-lifecycle.md',
);
const call = pagesRepository.applyDiffTransactional.mock.calls[0][0];
expect(call.upserts).toEqual(
expect.arrayContaining([
expect.objectContaining({ scope: 'GLOBAL', pageKey: 'revenue-policy', summary: 'revenue' }),
expect.objectContaining({
scope: 'GLOBAL',
pageKey: 'historic-sql-order-lifecycle',
summary: 'order lifecycle',
}),
]),
);
expect(call.upserts).toHaveLength(2);
});
it('is a no-op when the diff between shas has no knowledge changes', async () => {
const { service, pagesRepository, gitService } = makeService();
gitService.diffNameStatus.mockResolvedValue([]);
await service.syncFromCommit('sha-before', 'sha-after', 'run-uuid');
expect(pagesRepository.applyDiffTransactional).not.toHaveBeenCalled();
});
});

View file

@ -0,0 +1,323 @@
import { access, mkdtemp, rm } from 'node:fs/promises';
import { tmpdir } from 'node:os';
import { join } from 'node:path';
import { afterEach, beforeEach, describe, expect, it } from 'vitest';
import { initKtxProject, type KtxLocalProject } from '../../../src/context/project/project.js';
import {
listLocalKnowledgePages,
readLocalKnowledgePage,
searchLocalKnowledgePages,
writeLocalKnowledgePage,
} from '../../../src/context/wiki/local-knowledge.js';
class FakeEmbeddingPort {
readonly maxBatchSize = 16;
async computeEmbedding(text: string): Promise<number[]> {
return text.toLowerCase().includes('semantic revenue') ? [1, 0] : [0, 1];
}
async computeEmbeddingsBulk(texts: string[]): Promise<number[][]> {
return Promise.all(texts.map((text) => this.computeEmbedding(text)));
}
}
class ArrSynonymEmbeddingPort {
readonly maxBatchSize = 16;
async computeEmbedding(text: string): Promise<number[]> {
const lower = text.toLowerCase();
if (lower.trim() === 'annual recurring revenue' || lower.includes('arr') || lower.includes('contract-first')) {
return [1, 0];
}
if (lower.includes('net revenue') || lower.includes('gross') || lower.includes('refund')) {
return [0, 1];
}
return [0.5, 0.5];
}
async computeEmbeddingsBulk(texts: string[]): Promise<number[][]> {
return Promise.all(texts.map((text) => this.computeEmbedding(text)));
}
}
describe('local knowledge helpers', () => {
let tempDir: string;
let project: KtxLocalProject;
beforeEach(async () => {
tempDir = await mkdtemp(join(tmpdir(), 'ktx-local-knowledge-'));
project = await initKtxProject({ projectDir: join(tempDir, 'project') });
});
afterEach(async () => {
await rm(tempDir, { recursive: true, force: true });
});
it('writes, reads, lists, and searches global wiki pages', async () => {
const write = await writeLocalKnowledgePage(project, {
key: 'metrics-revenue',
scope: 'GLOBAL',
summary: 'Revenue metric definition',
content: 'Revenue is recognized when an order is paid.',
tags: ['finance'],
refs: ['semantic-layer/warehouse/orders.yaml'],
slRefs: ['orders'],
});
expect(write.path).toBe('wiki/global/metrics-revenue.md');
expect(write.operation).toBe('write');
await expect(readLocalKnowledgePage(project, { key: 'metrics-revenue', userId: 'local' })).resolves.toMatchObject({
key: 'metrics-revenue',
scope: 'GLOBAL',
summary: 'Revenue metric definition',
content: 'Revenue is recognized when an order is paid.',
tags: ['finance'],
refs: ['semantic-layer/warehouse/orders.yaml'],
slRefs: ['orders'],
});
await expect(listLocalKnowledgePages(project, { userId: 'local' })).resolves.toEqual([
{
key: 'metrics-revenue',
path: 'wiki/global/metrics-revenue.md',
scope: 'GLOBAL',
summary: 'Revenue metric definition',
},
]);
const search = await searchLocalKnowledgePages(project, { query: 'paid order', userId: 'local' });
expect(search).toEqual([
expect.objectContaining({
key: 'metrics-revenue',
path: 'wiki/global/metrics-revenue.md',
scope: 'GLOBAL',
score: expect.any(Number),
matchReasons: expect.arrayContaining(['lexical']),
lanes: expect.arrayContaining([expect.objectContaining({ lane: 'lexical', status: 'available' })]),
}),
]);
expect(search[0]?.score).toBeGreaterThan(0);
await expect(access(join(project.projectDir, '.ktx', 'db.sqlite'))).resolves.toBeUndefined();
});
it('adds the token lane alongside lexical wiki matches', async () => {
await writeLocalKnowledgePage(project, {
key: 'metrics-revenue',
scope: 'GLOBAL',
summary: 'Revenue metric definition',
content: 'Revenue is recognized when an order is paid.',
tags: ['finance'],
});
const search = await searchLocalKnowledgePages(project, { query: 'paid---', userId: 'local', limit: 5 });
expect(search[0]).toMatchObject({
key: 'metrics-revenue',
matchReasons: expect.arrayContaining(['token']),
lanes: expect.arrayContaining([expect.objectContaining({ lane: 'token', status: 'available' })]),
});
});
it('uses stored page embeddings when a wiki embedding backend is configured', async () => {
await writeLocalKnowledgePage(project, {
key: 'metrics-revenue',
scope: 'GLOBAL',
summary: 'Semantic revenue definition',
content: 'Revenue search text.',
tags: ['finance'],
});
await writeLocalKnowledgePage(project, {
key: 'support-escalations',
scope: 'GLOBAL',
summary: 'Support escalation process',
content: 'Support search text.',
tags: ['operations'],
});
const search = await searchLocalKnowledgePages(project, {
query: 'semantic revenue',
userId: 'local',
limit: 5,
embeddingService: new FakeEmbeddingPort(),
});
expect(search[0]).toMatchObject({
key: 'metrics-revenue',
matchReasons: expect.arrayContaining(['semantic']),
lanes: expect.arrayContaining([expect.objectContaining({ lane: 'semantic', status: 'available' })]),
});
});
it('ranks ARR synonym queries by semantic page embeddings over stronger lexical revenue matches', async () => {
await writeLocalKnowledgePage(project, {
key: 'arr-definition',
scope: 'GLOBAL',
summary: 'ARR is calculated contract-first for active customer contracts.',
content: 'Contract-first active contract value takes precedence over subscription values.',
tags: ['arr', 'contracts', 'finance'],
});
await writeLocalKnowledgePage(project, {
key: 'net-revenue-definition',
scope: 'GLOBAL',
summary: 'Net revenue definition',
content: 'Annual revenue is gross invoice revenue minus credits and refunds.',
tags: ['revenue', 'finance'],
});
const search = await searchLocalKnowledgePages(project, {
query: 'annual recurring revenue',
userId: 'local',
limit: 2,
embeddingService: new ArrSynonymEmbeddingPort(),
});
expect(search.map((result) => result.key)).toEqual(['arr-definition', 'net-revenue-definition']);
expect(search[0]).toMatchObject({
key: 'arr-definition',
matchReasons: expect.arrayContaining(['semantic']),
lanes: expect.arrayContaining([expect.objectContaining({ lane: 'semantic', status: 'available' })]),
});
});
it('reports semantic lane as skipped when wiki embeddings are not configured', async () => {
await writeLocalKnowledgePage(project, {
key: 'metrics-revenue',
scope: 'GLOBAL',
summary: 'Revenue metric definition',
content: 'Revenue is recognized when an order is paid.',
tags: ['finance'],
});
const search = await searchLocalKnowledgePages(project, { query: 'revenue', userId: 'local', limit: 5 });
expect(search[0]?.lanes).toEqual(
expect.arrayContaining([
expect.objectContaining({ lane: 'semantic', status: 'skipped', reason: 'embedding_unconfigured' }),
]),
);
});
it('prefers user knowledge over global pages with the same key', async () => {
await writeLocalKnowledgePage(project, {
key: 'handoff',
scope: 'GLOBAL',
summary: 'Global handoff',
content: 'Global context.',
});
await writeLocalKnowledgePage(project, {
key: 'handoff',
scope: 'USER',
userId: 'agent-1',
summary: 'User handoff',
content: 'User context.',
});
await expect(readLocalKnowledgePage(project, { key: 'handoff', userId: 'agent-1' })).resolves.toMatchObject({
scope: 'USER',
summary: 'User handoff',
});
});
it('serializes historic-SQL frontmatter fields for global pages', async () => {
await writeLocalKnowledgePage(project, {
key: 'monthly-paid-orders',
scope: 'GLOBAL',
summary: 'Monthly paid orders',
content: '## Monthly paid order count',
tags: ['historic-sql', 'query-pattern'],
slRefs: ['analytics.orders'],
source: 'historic-sql',
intent: 'Monthly paid order count',
tables: ['analytics.orders'],
representativeSql: "SELECT count(*) FROM analytics.orders WHERE status = 'paid'",
usage: {
executions: 42,
distinct_users: 3,
first_seen: '2026-02-01',
last_seen: '2026-05-04',
p50_runtime_ms: 100,
p95_runtime_ms: 200,
error_rate: 0,
rows_produced: 42,
},
fingerprints: ['fp_paid_orders'],
});
const raw = await project.fileStore.readFile('wiki/global/monthly-paid-orders.md');
expect(raw.content).toContain('source: historic-sql');
expect(raw.content).toContain('intent: Monthly paid order count');
expect(raw.content).toContain(['tables:', ' - analytics.orders'].join('\n'));
expect(raw.content).toContain("representative_sql: SELECT count(*) FROM analytics.orders WHERE status = 'paid'");
expect(raw.content).toContain(['usage:', ' executions: 42', ' distinct_users: 3'].join('\n'));
expect(raw.content).toContain(['fingerprints:', ' - fp_paid_orders'].join('\n'));
});
it('falls back to Markdown scanning when the config does not select sqlite-fts5', async () => {
project.config.storage.search = 'postgres-hybrid';
await writeLocalKnowledgePage(project, {
key: 'metrics-revenue',
scope: 'GLOBAL',
summary: 'Revenue metric definition',
content: 'Revenue is recognized when an order is paid.',
tags: ['finance'],
});
await expect(searchLocalKnowledgePages(project, { query: 'paid order', userId: 'local' })).resolves.toEqual([
expect.objectContaining({
key: 'metrics-revenue',
score: 3,
matchReasons: ['token'],
}),
]);
});
it('rejects unsafe knowledge keys', async () => {
await expect(
writeLocalKnowledgePage(project, {
key: '../secret',
scope: 'GLOBAL',
summary: 'bad',
content: 'bad',
}),
).rejects.toThrow('Invalid wiki key "../secret". Wiki keys must be flat; use "secret".');
});
it('rejects slash-delimited knowledge keys with a flat-key suggestion', async () => {
await expect(
writeLocalKnowledgePage(project, {
key: 'orbit/company-overview',
scope: 'GLOBAL',
summary: 'bad',
content: 'bad',
}),
).rejects.toThrow('Invalid wiki key "orbit/company-overview". Wiki keys must be flat; use "orbit-company-overview".');
});
it('ignores nested historic-SQL legacy paths when listing local wiki pages', async () => {
await writeLocalKnowledgePage(project, {
key: 'historic-sql-paid-orders',
scope: 'GLOBAL',
summary: 'Flat historic SQL page',
content: 'Flat page body.',
tags: ['historic-sql'],
});
await project.fileStore.writeFile(
'wiki/global/historic-sql/paid-orders.md',
'---\nsummary: Nested historic SQL page\nusage_mode: auto\n---\n\nNested body\n',
'Test',
'test@example.com',
'Write nested legacy page',
);
await expect(listLocalKnowledgePages(project, { userId: 'local' })).resolves.toEqual([
{
key: 'historic-sql-paid-orders',
path: 'wiki/global/historic-sql-paid-orders.md',
scope: 'GLOBAL',
summary: 'Flat historic SQL page',
},
]);
});
});

View file

@ -0,0 +1,152 @@
import { access, mkdtemp, rm } from 'node:fs/promises';
import { tmpdir } from 'node:os';
import { join } from 'node:path';
import { afterEach, beforeEach, describe, expect, it } from 'vitest';
import { SqliteKnowledgeIndex, type SqliteKnowledgeIndexPage } from '../../../src/context/wiki/sqlite-knowledge-index.js';
describe('SqliteKnowledgeIndex', () => {
let tempDir: string;
let dbPath: string;
beforeEach(async () => {
tempDir = await mkdtemp(join(tmpdir(), 'ktx-sqlite-knowledge-index-'));
dbPath = join(tempDir, 'db.sqlite');
});
afterEach(async () => {
await rm(tempDir, { recursive: true, force: true });
});
function page(overrides: Partial<SqliteKnowledgeIndexPage> = {}): SqliteKnowledgeIndexPage {
return {
path: 'wiki/global/revenue.md',
key: 'revenue',
scope: 'GLOBAL',
summary: 'Revenue definition',
content: 'Revenue is the sum of paid order amounts.',
tags: ['finance'],
embedding: null,
...overrides,
};
}
it('creates a SQLite FTS5 index and returns lexical lane candidates', async () => {
const index = new SqliteKnowledgeIndex({ dbPath });
index.sync([
page(),
page({
path: 'wiki/global/support.md',
key: 'support',
summary: 'Support queue',
content: 'Tickets are grouped by priority.',
tags: ['operations'],
}),
]);
await expect(access(dbPath)).resolves.toBeUndefined();
expect(index.searchLexicalCandidates({ queryText: 'paid order', limit: 10 })).toEqual([
expect.objectContaining({
id: 'wiki/global/revenue.md',
path: 'wiki/global/revenue.md',
rank: 1,
rawScore: expect.any(Number),
}),
]);
});
it('removes stale rows when the Markdown source list changes', () => {
const index = new SqliteKnowledgeIndex({ dbPath });
index.rebuild([page(), page({ path: 'wiki/global/churn.md', key: 'churn', content: 'Churn risk.' })]);
expect(index.search('churn', 10)).toHaveLength(1);
index.rebuild([page()]);
expect(index.search('churn', 10)).toEqual([]);
});
it('clear removes one wiki scope and leaves other scopes intact', async () => {
const index = new SqliteKnowledgeIndex({ dbPath });
index.sync([
page({ path: 'wiki/global/revenue.md', key: 'revenue', scope: 'GLOBAL', scopeId: null }),
page({
path: 'wiki/user/local/revenue.md',
key: 'revenue',
scope: 'USER',
scopeId: 'local',
summary: 'Local revenue',
content: 'Local revenue notes.',
}),
page({
path: 'wiki/user/alex/revenue.md',
key: 'revenue',
scope: 'USER',
scopeId: 'alex',
summary: 'Alex revenue',
content: 'Alex revenue notes.',
}),
]);
expect(index.clear('USER', 'local')).toBe(1);
expect(index.search('Local', 10)).toEqual([]);
expect(index.search('Alex', 10)).toEqual([expect.objectContaining({ path: 'wiki/user/alex/revenue.md' })]);
expect(index.search('definition', 10)).toEqual([expect.objectContaining({ path: 'wiki/global/revenue.md' })]);
});
it('exposes existing search text and embedding state for incremental refresh', () => {
const index = new SqliteKnowledgeIndex({ dbPath });
index.sync([page({ path: 'wiki/global/revenue.md', key: 'revenue', embedding: [1, 0] })]);
expect(index.getExistingPages()).toEqual(
new Map([
[
'wiki/global/revenue.md',
expect.objectContaining({
searchText: expect.stringContaining('Revenue definition'),
embedding: [1, 0],
}),
],
]),
);
});
it('does not treat empty embeddings as indexed semantic vectors', () => {
const index = new SqliteKnowledgeIndex({ dbPath });
index.sync([page({ path: 'wiki/global/revenue.md', key: 'revenue', embedding: [] })]);
expect(index.getExistingPages().get('wiki/global/revenue.md')?.embedding).toBeNull();
expect(index.searchSemanticCandidates({ queryEmbedding: [1, 0], limit: 10 })).toEqual([]);
});
it('returns semantic lane candidates from stored page embeddings', () => {
const index = new SqliteKnowledgeIndex({ dbPath });
index.sync([
page({ path: 'wiki/global/revenue.md', key: 'revenue', embedding: [1, 0] }),
page({ path: 'wiki/global/support.md', key: 'support', summary: 'Support queue', embedding: [0, 1] }),
]);
expect(index.searchSemanticCandidates({ queryEmbedding: [1, 0], limit: 10 })).toEqual([
expect.objectContaining({
id: 'wiki/global/revenue.md',
path: 'wiki/global/revenue.md',
rank: 1,
rawScore: 1,
}),
expect.objectContaining({
id: 'wiki/global/support.md',
path: 'wiki/global/support.md',
rank: 2,
rawScore: 0,
}),
]);
});
it('returns an empty result for blank or punctuation-only queries', () => {
const index = new SqliteKnowledgeIndex({ dbPath });
index.rebuild([page()]);
expect(index.search(' ', 10)).toEqual([]);
expect(index.search('---', 10)).toEqual([]);
});
});

View file

@ -0,0 +1,44 @@
import { describe, expect, it, vi } from 'vitest';
import type { ToolContext } from '../../../../src/context/tools/base-tool.js';
import { WikiListTagsTool } from '../../../../src/context/wiki/tools/wiki-list-tags.tool.js';
describe('WikiListTagsTool', () => {
const baseContext: ToolContext = { sourceId: 's', messageId: 'm', userId: 'u' };
it("returns distinct sorted tags across the user's visible pages", async () => {
const pagesRepository = {
listPagesForUser: vi.fn().mockResolvedValue([
{ scope: 'GLOBAL', scope_id: null, page_key: 'k1', tags: ['metrics', 'finance'] },
{ scope: 'USER', scope_id: 'u', page_key: 'k2', tags: ['metrics'] },
]),
};
const tool = new WikiListTagsTool(pagesRepository as any);
const result = await tool.call({}, baseContext);
expect(result.markdown).toContain('finance');
expect(result.markdown).toContain('metrics');
expect(result.structured.tags).toEqual(['finance', 'metrics']);
});
it('lists tags from historic-SQL indexed pages with flat wiki keys', async () => {
const pagesRepository = {
listPagesForUser: vi.fn().mockResolvedValue([
{ scope: 'GLOBAL', scope_id: null, page_key: 'company-overview', tags: ['notion'] },
{ scope: 'GLOBAL', scope_id: null, page_key: 'historic-sql-revenue-pattern', tags: ['historic-sql', 'pattern'] },
]),
};
const tool = new WikiListTagsTool(pagesRepository as any);
const result = await tool.call({}, baseContext);
expect(result.structured.tags).toEqual(['historic-sql', 'notion', 'pattern']);
});
it('returns a friendly message when no pages have tags', async () => {
const pagesRepository = { listPagesForUser: vi.fn().mockResolvedValue([]) };
const tool = new WikiListTagsTool(pagesRepository as any);
const result = await tool.call({}, baseContext);
expect(result.markdown).toMatch(/no tags/i);
});
});

View file

@ -0,0 +1,80 @@
import { describe, expect, it, vi } from 'vitest';
import type { ToolSession } from '../../../../src/context/tools/tool-session.js';
import { createTouchedSlSources } from '../../../../src/context/tools/touched-sl-sources.js';
import type { ToolContext } from '../../../../src/context/tools/base-tool.js';
import { WikiReadTool } from '../../../../src/context/wiki/tools/wiki-read.tool.js';
describe('WikiReadTool', () => {
const baseContext: ToolContext = { sourceId: 's', messageId: 'm', userId: 'u' };
it('reads from the session wiki service when a worktree-scoped ingest session is present', async () => {
const rootWikiService = { readPageForUser: vi.fn().mockResolvedValue(null) };
const sessionWikiService = {
readPageForUser: vi.fn().mockResolvedValue({
pageKey: 'staged-page',
scope: 'GLOBAL',
frontmatter: { summary: 'Staged', tags: ['notion'], refs: ['related'] },
content: 'A page written earlier in the same ingest worktree.',
}),
};
const pagesRepository = { findPageByKey: vi.fn().mockResolvedValue({ id: 'page-1' }), incrementUsageCount: vi.fn() };
const tool = new WikiReadTool(rootWikiService as any, pagesRepository as any);
const session: ToolSession = {
connectionId: 'c',
isWorktreeScoped: true,
preHead: null,
touchedSlSources: createTouchedSlSources(),
actions: [],
semanticLayerService: {} as any,
wikiService: sessionWikiService as any,
configService: {} as any,
gitService: {} as any,
};
const result = await tool.call({ key: 'staged-page' }, { ...baseContext, session });
expect(rootWikiService.readPageForUser).not.toHaveBeenCalled();
expect(sessionWikiService.readPageForUser).toHaveBeenCalledWith('u', 'staged-page');
expect(result.structured).toMatchObject({ found: true, blockKey: 'staged-page', scope: 'GLOBAL' });
expect(result.markdown).toContain('A page written earlier in the same ingest worktree.');
});
it('rejects slash-delimited page keys with a flat-key suggestion', async () => {
const rootWikiService = { readPageForUser: vi.fn().mockResolvedValue(null) };
const pagesRepository = { findPageByKey: vi.fn(), incrementUsageCount: vi.fn() };
const tool = new WikiReadTool(rootWikiService as any, pagesRepository as any);
const result = await tool.call({ key: 'orbit/company-overview' }, baseContext);
expect(result.structured).toEqual({
blockKey: 'orbit/company-overview',
content: '',
scope: '',
found: false,
});
expect(result.markdown).toContain(
'Invalid wiki key "orbit/company-overview". Wiki keys must be flat; use "orbit-company-overview".',
);
expect(rootWikiService.readPageForUser).not.toHaveBeenCalled();
});
it('does not append derived refs to the editable markdown body', async () => {
const rootWikiService = {
readPageForUser: vi.fn().mockResolvedValue({
pageKey: 'orbit-how-we-work',
scope: 'GLOBAL',
frontmatter: { summary: 'How we work', tags: ['policy'], refs: ['orbit-company-overview'] },
content: '## How We Work\n\nUse written-first operating norms.',
}),
};
const pagesRepository = { findPageByKey: vi.fn().mockResolvedValue(null), incrementUsageCount: vi.fn() };
const tool = new WikiReadTool(rootWikiService as any, pagesRepository as any);
const result = await tool.call({ key: 'orbit-how-we-work' }, baseContext);
expect(result.markdown).toBe('## How We Work\n\nUse written-first operating norms.');
expect(result.markdown).not.toContain('See also');
expect(result.markdown).not.toContain('[[orbit-company-overview]]');
expect(result.structured.refs).toEqual(['orbit-company-overview']);
});
});

View file

@ -0,0 +1,109 @@
import { describe, expect, it, vi } from 'vitest';
import type { ToolSession } from '../../../../src/context/tools/tool-session.js';
import { createTouchedSlSources } from '../../../../src/context/tools/touched-sl-sources.js';
import type { ToolContext } from '../../../../src/context/tools/base-tool.js';
import { WikiRemoveTool } from '../../../../src/context/wiki/tools/wiki-remove.tool.js';
describe('WikiRemoveTool', () => {
const baseContext: ToolContext = { sourceId: 's', messageId: 'm', userId: 'u' };
it('removes an existing page when no session is present', async () => {
const wikiService = {
deletePage: vi.fn().mockResolvedValue(undefined),
deleteFromIndex: vi.fn().mockResolvedValue(undefined),
};
const pagesRepository = {
findPageByKey: vi.fn().mockResolvedValue({ page_key: 'old' }),
};
const knowledgeRepository = { createEvent: vi.fn().mockResolvedValue(undefined) };
const tool = new WikiRemoveTool(wikiService as any, pagesRepository as any, knowledgeRepository as any);
const result = await tool.call({ key: 'old' } as any, baseContext);
expect(wikiService.deletePage).toHaveBeenCalledTimes(1);
expect(wikiService.deleteFromIndex).toHaveBeenCalledTimes(1);
expect(result.markdown).toMatch(/removed/i);
});
it('rejects slash-delimited page keys with a flat-key suggestion', async () => {
const wikiService = {
deletePage: vi.fn().mockResolvedValue(undefined),
deleteFromIndex: vi.fn().mockResolvedValue(undefined),
};
const pagesRepository = { findPageByKey: vi.fn().mockResolvedValue({ page_key: 'old' }) };
const knowledgeRepository = { createEvent: vi.fn().mockResolvedValue(undefined) };
const tool = new WikiRemoveTool(wikiService as any, pagesRepository as any, knowledgeRepository as any);
const result = await tool.call({ key: 'orbit/company-overview' } as any, baseContext);
expect(result.structured).toEqual({ success: false, key: 'orbit/company-overview' });
expect(result.markdown).toContain(
'Invalid wiki key "orbit/company-overview". Wiki keys must be flat; use "orbit-company-overview".',
);
expect(pagesRepository.findPageByKey).not.toHaveBeenCalled();
expect(wikiService.deletePage).not.toHaveBeenCalled();
});
it('skips deleteFromIndex when session is worktree-scoped', async () => {
const wikiService = {
readPage: vi.fn().mockResolvedValue({ pageKey: 'old', frontmatter: { summary: 'Old' }, content: 'body' }),
deletePage: vi.fn().mockResolvedValue(undefined),
deleteFromIndex: vi.fn().mockResolvedValue(undefined),
};
const pagesRepository = { findPageByKey: vi.fn().mockResolvedValue({ page_key: 'old' }) };
const knowledgeRepository = { createEvent: vi.fn().mockResolvedValue(undefined) };
const tool = new WikiRemoveTool(wikiService as any, pagesRepository as any, knowledgeRepository as any);
const session: ToolSession = {
connectionId: 'c',
isWorktreeScoped: true,
preHead: null,
touchedSlSources: createTouchedSlSources(),
actions: [],
semanticLayerService: {} as any,
wikiService: wikiService as any,
configService: {} as any,
gitService: {} as any,
};
await tool.call({ key: 'old' } as any, { ...baseContext, session });
expect(wikiService.deletePage).toHaveBeenCalledTimes(1);
expect(wikiService.deleteFromIndex).not.toHaveBeenCalled();
expect(session.actions).toContainEqual(expect.objectContaining({ target: 'wiki', type: 'removed', key: 'old' }));
});
it('finds pages through the session wiki service even when the shared index has not seen the worktree write', async () => {
const wikiService = {
readPage: vi.fn().mockResolvedValue({ pageKey: 'staged', frontmatter: { summary: 'Staged' }, content: 'body' }),
deletePage: vi.fn().mockResolvedValue(undefined),
deleteFromIndex: vi.fn().mockResolvedValue(undefined),
};
const pagesRepository = { findPageByKey: vi.fn().mockResolvedValue(null) };
const knowledgeRepository = { createEvent: vi.fn().mockResolvedValue(undefined) };
const tool = new WikiRemoveTool(wikiService as any, pagesRepository as any, knowledgeRepository as any);
const session: ToolSession = {
connectionId: 'c',
isWorktreeScoped: true,
preHead: null,
touchedSlSources: createTouchedSlSources(),
actions: [],
semanticLayerService: {} as any,
wikiService: wikiService as any,
configService: {} as any,
gitService: {} as any,
};
const result = await tool.call({ key: 'staged' } as any, { ...baseContext, session });
expect(pagesRepository.findPageByKey).not.toHaveBeenCalled();
expect(wikiService.readPage).toHaveBeenCalledWith('GLOBAL', null, 'staged');
expect(wikiService.deletePage).toHaveBeenCalledTimes(1);
expect(result.structured).toEqual({ success: true, key: 'staged' });
});
it('returns a friendly message when the page does not exist', async () => {
const wikiService = { deletePage: vi.fn(), deleteFromIndex: vi.fn() };
const pagesRepository = { findPageByKey: vi.fn().mockResolvedValue(null) };
const knowledgeRepository = { createEvent: vi.fn() };
const tool = new WikiRemoveTool(wikiService as any, pagesRepository as any, knowledgeRepository as any);
const result = await tool.call({ key: 'missing' } as any, baseContext);
expect(result.structured.success).toBe(false);
expect(result.markdown).toMatch(/not found/i);
});
});

View file

@ -0,0 +1,41 @@
import { describe, expect, it, vi } from 'vitest';
import { WikiSearchTool } from '../../../../src/context/wiki/tools/wiki-search.tool.js';
describe('WikiSearchTool', () => {
it('searches through the injected wiki adapter port', async () => {
const search = vi.fn(async () => ({
results: [
{
key: 'metrics-revenue',
path: 'wiki/global/metrics-revenue.md',
scope: 'GLOBAL' as const,
summary: 'Revenue metric definition',
score: 0.02459016393442623,
matchReasons: ['lexical' as const, 'token' as const],
},
],
totalFound: 1,
}));
const tool = new WikiSearchTool({ search });
const result = await tool.call(
{ query: 'paid order', limit: 5 },
{ sourceId: 'test', messageId: 'message-1', userId: 'agent' },
);
expect(search).toHaveBeenCalledWith({ userId: 'agent', query: 'paid order', limit: 5 });
expect(result.structured).toEqual({
results: [
{
blockKey: 'metrics-revenue',
path: 'wiki/global/metrics-revenue.md',
summary: 'Revenue metric definition',
score: 0.02459016393442623,
matchReasons: ['lexical', 'token'],
},
],
totalFound: 1,
});
expect(result.markdown).toContain('**metrics-revenue**');
});
});

View file

@ -0,0 +1,344 @@
import { describe, expect, it, vi } from 'vitest';
import type { ToolSession } from '../../../../src/context/tools/tool-session.js';
import { createTouchedSlSources } from '../../../../src/context/tools/touched-sl-sources.js';
import type { ToolContext } from '../../../../src/context/tools/base-tool.js';
import { WikiWriteTool } from '../../../../src/context/wiki/tools/wiki-write.tool.js';
function makeTool(overrides: any = {}) {
const wikiService = {
readPage: vi.fn().mockResolvedValue(null),
listPageKeys: vi.fn().mockResolvedValue([]),
writePage: vi.fn().mockResolvedValue(undefined),
syncSinglePage: vi.fn().mockResolvedValue(undefined),
...overrides.wikiService,
};
const pagesRepository = {
findPageByKey: vi.fn().mockResolvedValue(null),
getUserPageCount: vi.fn().mockResolvedValue(0),
...overrides.pagesRepository,
};
const knowledgeRepository = {
createEvent: vi.fn().mockResolvedValue(undefined),
...overrides.knowledgeRepository,
};
const tool = new WikiWriteTool(wikiService as any, pagesRepository as any, knowledgeRepository as any);
return { tool, wikiService, pagesRepository, knowledgeRepository };
}
describe('WikiWriteTool', () => {
const baseContext: ToolContext = { sourceId: 's', messageId: 'm', userId: 'u' };
it('creates a new page and indexes it when no session is present', async () => {
const { tool, wikiService } = makeTool();
const result = await tool.call(
{ key: 'leads-source', summary: 'Lead source definitions', content: '# Leads' } as any,
baseContext,
);
expect(wikiService.writePage).toHaveBeenCalledTimes(1);
expect(wikiService.syncSinglePage).toHaveBeenCalledTimes(1);
expect(result.markdown).toMatch(/created/i);
});
it('rejects slash-delimited page keys with a flat-key suggestion', async () => {
const { tool, wikiService } = makeTool();
const result = await tool.call(
{ key: 'orbit/company-overview', summary: 'Company overview', content: '# Orbit' } as any,
baseContext,
);
expect(result.structured).toEqual({ success: false, key: 'orbit/company-overview' });
expect(result.markdown).toContain(
'Invalid wiki key "orbit/company-overview". Wiki keys must be flat; use "orbit-company-overview".',
);
expect(wikiService.readPage).not.toHaveBeenCalled();
expect(wikiService.writePage).not.toHaveBeenCalled();
});
it('normalizes accidentally escaped markdown newlines before writing', async () => {
const { tool, wikiService } = makeTool();
await tool.call(
{
key: 'large-contract-requesters',
summary: 'Cross-schema Metabase query',
content:
'# Large Contract Requesters\\n\\n**Source card:** Metabase #110\\n\\n## SQL\\n\\n```sql\\nselect * from orbit_analytics.mart_account_segments\\n```\\n',
} as any,
baseContext,
);
expect(wikiService.writePage.mock.calls[0][4]).toBe(
'# Large Contract Requesters\n\n**Source card:** Metabase #110\n\n## SQL\n\n```sql\nselect * from orbit_analytics.mart_account_segments\n```\n',
);
expect(wikiService.syncSinglePage.mock.calls[0][4]).toBe(
'# Large Contract Requesters\n\n**Source card:** Metabase #110\n\n## SQL\n\n```sql\nselect * from orbit_analytics.mart_account_segments\n```\n',
);
});
it('preserves intentional escaped newline examples in inline code', async () => {
const { tool, wikiService } = makeTool();
await tool.call(
{
key: 'newline-token',
summary: 'Escaped newline token',
content: 'Use `\\n\\n` when documenting the literal separator.',
} as any,
baseContext,
);
expect(wikiService.writePage.mock.calls[0][4]).toBe('Use `\\n\\n` when documenting the literal separator.');
});
it('skips syncSinglePage when session is worktree-scoped', async () => {
const { tool, wikiService } = makeTool();
const session: ToolSession = {
connectionId: 'conn-1',
isWorktreeScoped: true,
preHead: null,
touchedSlSources: createTouchedSlSources(),
actions: [],
semanticLayerService: {} as any,
wikiService: wikiService as any,
configService: {} as any,
gitService: {} as any,
};
const context: ToolContext = { ...baseContext, session };
await tool.call({ key: 'k', summary: 's', content: '# x' } as any, context);
expect(wikiService.writePage).toHaveBeenCalledTimes(1);
expect(wikiService.syncSinglePage).not.toHaveBeenCalled();
expect(session.actions).toContainEqual(expect.objectContaining({ target: 'wiki', type: 'created', key: 'k' }));
});
it('requires either content or replacements', async () => {
const { tool } = makeTool();
const result = await tool.call({ key: 'k', summary: 's' } as any, baseContext);
expect(result.structured.success).toBe(false);
expect(result.markdown).toMatch(/content.*or.*replacements/i);
});
it('updates frontmatter only on an existing page while preserving content', async () => {
const { tool, wikiService } = makeTool({
wikiService: {
readPage: vi.fn().mockResolvedValue({
pageKey: 'orbit-customers',
frontmatter: {
summary: 'Customer source details',
usage_mode: 'auto',
sort_order: 0,
tags: ['notion'],
refs: ['notion:old'],
sl_refs: ['postgres-warehouse/orbit_analytics.customer'],
},
content: '# Orbit Customers\n\nSource: Notion - Orbit Customers Source.',
}),
},
});
const result = await tool.call(
{
key: 'orbit-customers',
summary: 'Customer source details mapped to the warehouse customer view',
sl_refs: ['postgres-warehouse/orbit_analytics.customer', 'dbt-main/customer'],
} as any,
baseContext,
);
expect(result.structured).toMatchObject({ success: true, key: 'orbit-customers', action: 'updated' });
expect(wikiService.writePage).toHaveBeenCalledWith(
'USER',
'u',
'orbit-customers',
expect.objectContaining({
summary: 'Customer source details mapped to the warehouse customer view',
tags: ['notion'],
refs: ['notion:old'],
sl_refs: ['postgres-warehouse/orbit_analytics.customer', 'dbt-main/customer'],
}),
'# Orbit Customers\n\nSource: Notion - Orbit Customers Source.',
expect.any(String),
expect.any(String),
);
});
it('writes historic-SQL frontmatter fields', async () => {
const { tool, wikiService } = makeTool();
await tool.call(
{
key: 'monthly-paid-orders',
summary: 'Monthly paid orders',
tags: ['historic-sql', 'query-pattern'],
sl_refs: ['analytics.orders'],
source: 'historic-sql',
intent: 'Monthly paid order count',
tables: ['analytics.orders'],
representative_sql: "SELECT count(*) FROM analytics.orders WHERE status = 'paid'",
usage: {
executions: 42,
distinct_users: 3,
first_seen: '2026-02-01',
last_seen: '2026-05-04',
p50_runtime_ms: 100,
p95_runtime_ms: 200,
error_rate: 0,
rows_produced: 42,
},
fingerprints: ['fp_paid_orders'],
content: '## Monthly paid order count',
} as any,
baseContext,
);
expect(wikiService.writePage.mock.calls[0][3]).toEqual({
summary: 'Monthly paid orders',
usage_mode: 'auto',
sort_order: 0,
tags: ['historic-sql', 'query-pattern'],
refs: undefined,
sl_refs: ['analytics.orders'],
source: 'historic-sql',
intent: 'Monthly paid order count',
tables: ['analytics.orders'],
representative_sql: "SELECT count(*) FROM analytics.orders WHERE status = 'paid'",
usage: {
executions: 42,
distinct_users: 3,
first_seen: '2026-02-01',
last_seen: '2026-05-04',
p50_runtime_ms: 100,
p95_runtime_ms: 200,
error_rate: 0,
rows_produced: 42,
},
fingerprints: ['fp_paid_orders'],
});
});
it('preserves historic-SQL frontmatter fields when update omits them', async () => {
const existingFrontmatter = {
summary: 'Monthly paid orders',
usage_mode: 'auto' as const,
sort_order: 0,
tags: ['historic-sql'],
sl_refs: ['analytics.orders'],
source: 'historic-sql',
intent: 'Monthly paid order count',
tables: ['analytics.orders'],
representative_sql: "SELECT count(*) FROM analytics.orders WHERE status = 'paid'",
usage: {
executions: 42,
distinct_users: 3,
first_seen: '2026-02-01',
last_seen: '2026-05-04',
p50_runtime_ms: 100,
p95_runtime_ms: 200,
error_rate: 0,
rows_produced: 42,
},
fingerprints: ['fp_paid_orders'],
};
const { tool, wikiService } = makeTool({
wikiService: {
readPage: vi.fn().mockResolvedValue({
pageKey: 'monthly-paid-orders',
frontmatter: existingFrontmatter,
content: 'old body',
}),
},
});
await tool.call(
{
key: 'monthly-paid-orders',
summary: 'Monthly paid orders updated',
content: '## Monthly paid order count updated',
} as any,
baseContext,
);
expect(wikiService.writePage.mock.calls[0][3]).toEqual({
...existingFrontmatter,
summary: 'Monthly paid orders updated',
});
});
it('rejects frontmatter refs that target missing wiki pages', async () => {
const { tool, wikiService } = makeTool({
wikiService: {
listPageKeys: vi.fn().mockResolvedValue(['orbit-company-overview']),
},
});
const result = await tool.call(
{
key: 'orbit-how-we-work',
summary: 'Operating norms',
content: '## How We Work',
refs: ['orbit-company-overview', 'orbit-team-lanes-detail'],
} as any,
baseContext,
);
expect(result.structured.success).toBe(false);
expect(result.markdown).toMatch(/orbit-team-lanes-detail/);
expect(wikiService.writePage).not.toHaveBeenCalled();
});
it('rejects inline wiki links that target missing wiki pages', async () => {
const { tool, wikiService } = makeTool({
wikiService: {
listPageKeys: vi.fn().mockResolvedValue(['orbit-company-overview']),
},
});
const result = await tool.call(
{
key: 'orbit-how-we-work',
summary: 'Operating norms',
content: 'See [[orbit-company-overview]] and [[orbit-team-lanes-detail]].',
} as any,
baseContext,
);
expect(result.structured.success).toBe(false);
expect(result.markdown).toMatch(/orbit-team-lanes-detail/);
expect(wikiService.writePage).not.toHaveBeenCalled();
});
it('accepts forward refs during ingest sessions for post-pass validation', async () => {
const { tool, wikiService } = makeTool({
wikiService: {
listPageKeys: vi.fn().mockResolvedValue(['orbit-company-overview']),
},
});
const session: ToolSession = {
connectionId: 'conn-1',
isWorktreeScoped: true,
preHead: null,
touchedSlSources: createTouchedSlSources(),
actions: [],
semanticLayerService: {} as any,
wikiService: wikiService as any,
configService: {} as any,
gitService: {} as any,
ingest: { runId: 'run-1', jobId: 'job-1', syncId: 'sync-1', sourceKey: 'notion' },
};
const result = await tool.call(
{
key: 'orbit-how-we-work',
summary: 'Operating norms',
content: 'See [[orbit-team-lanes-detail]].',
refs: ['orbit-company-overview', 'orbit-team-lanes-detail'],
} as any,
{ ...baseContext, session },
);
expect(result.structured).toMatchObject({ success: true, key: 'orbit-how-we-work', action: 'created' });
expect(wikiService.writePage).toHaveBeenCalledTimes(1);
expect(session.actions).toContainEqual(
expect.objectContaining({ target: 'wiki', type: 'created', key: 'orbit-how-we-work' }),
);
});
});

View file

@ -0,0 +1,74 @@
import { describe, expect, it, vi } from 'vitest';
import { findDanglingWikiRefsForActions } from '../../../src/context/wiki/wiki-ref-validation.js';
function makeWikiService(pages: Record<string, { refs?: string[]; content?: string }>) {
return {
listPageKeys: vi.fn().mockResolvedValue(Object.keys(pages)),
readPage: vi.fn().mockImplementation((_scope: string, _scopeId: string | null, pageKey: string) => {
const page = pages[pageKey];
if (!page) {
return Promise.resolve(null);
}
return Promise.resolve({
pageKey,
frontmatter: { summary: pageKey, usage_mode: 'auto', refs: page.refs },
content: page.content ?? '',
});
}),
};
}
describe('wiki ref validation', () => {
it('allows circular refs once both touched pages exist', async () => {
const wikiService = makeWikiService({
'page-a': { refs: ['page-b'], content: 'See [[page-b]].' },
'page-b': { refs: ['page-a'], content: 'See [[page-a]].' },
});
const dangling = await findDanglingWikiRefsForActions({
wikiService: wikiService as any,
scope: 'GLOBAL',
scopeId: null,
actions: [
{ target: 'wiki', type: 'created', key: 'page-a', detail: 'Page A' },
{ target: 'wiki', type: 'created', key: 'page-b', detail: 'Page B' },
],
});
expect(dangling).toEqual([]);
});
it('treats removed pages as unavailable ref targets', async () => {
const wikiService = makeWikiService({
'page-a': { refs: ['page-b'], content: 'See [[page-b]].' },
});
const dangling = await findDanglingWikiRefsForActions({
wikiService: wikiService as any,
scope: 'GLOBAL',
scopeId: null,
actions: [
{ target: 'wiki', type: 'updated', key: 'page-a', detail: 'Page A' },
{ target: 'wiki', type: 'removed', key: 'page-b', detail: 'Page B' },
],
});
expect(dangling).toEqual(['page-a -> page-b']);
});
it('does not validate existing dangling refs on untouched pages', async () => {
const wikiService = makeWikiService({
'page-a': { refs: [], content: '' },
'old-page': { refs: ['missing-page'], content: 'See [[missing-page]].' },
});
const dangling = await findDanglingWikiRefsForActions({
wikiService: wikiService as any,
scope: 'GLOBAL',
scopeId: null,
actions: [{ target: 'wiki', type: 'updated', key: 'page-a', detail: 'Page A' }],
});
expect(dangling).toEqual([]);
});
});