mirror of
https://github.com/Kaelio/ktx.git
synced 2026-06-13 08:15:14 +02:00
* fix: read semantic sources safely
* test: retarget reindex per-scope error case to a broken manifest
Reading a broken standalone source was made non-fatal in de1f1a8d (it is
surfaced for repair instead of throwing), so the reindex per-scope error
test no longer captured an error. Point it at a corrupt manifest shard,
which is the remaining fatal read failure the per-scope catch must
isolate, and assert the captured error names the offending file.
* fix(sl): decouple semantic-layer file names from warehouse naming rules
The in-file `name:` field is now the sole source identity; the filename is
a derived label that never participates in identity. This removes the
"Unsafe semantic-layer source name" failure class entirely: any warehouse
identifier (Snowflake's uppercase SIGNED_UP, EVENT$LOG, dotted names) can
be read, overlaid, edited, and deleted.
- New `source-files.ts`: one total filename derivation (safe lowercase
names verbatim; otherwise slug + sha256-hash suffix, immune to
case-insensitive-filesystem collisions) and one by-name file resolver.
- Reads resolve by name everywhere; the path-from-name fast path and
`assertSafeSourceName` are gone.
- Writes resolve-then-write: rewrites land on the file that declares the
name (human renames survive); new sources get a derived filename; a
derived path occupied by a different source fails instead of clobbering.
- `readSourceFile` returns null for missing files instead of forcing every
caller to launder IO errors; `deleteSource` distinguishes manifest-backed
sources from not-found instead of silently succeeding.
- `sl_write_source` accepts verbatim warehouse identifiers (snake_case is
now a recommendation for new sources) and rejects sourceName/source.name
mismatches; `sl_edit_source` rejects name-changing edits.
- Ingest projection commits, gate-repair allowlists, and touched-source
derivation use resolved paths / in-file names instead of interpolating
`<connId>/<name>.yaml`.
- Collapsed the five parallel path derivations and duplicated path-token
helpers onto the shared module; dropped dead service methods.
* fix(sl): resolve sources by declared name end-to-end and gate warehouse SQL with the parser-backed validator
- Key broken/renamed semantic-layer files by their recoverable in-file
name (slSourceNameForFile) so mid-edit sources stay reachable under
their real identity in reads, listings, and search
- Derive finalization touched sources from composed-source diffs and
recover deleted files' declared names from the pre-change commit
instead of parsing hash-derived filenames
- Resolve revert/rollback paths against history (listFilesAtCommit) so
human-renamed files are restored where they lived at preHead
- Validate ingest sql_execution through the daemon's sqlglot
validateReadOnly in the connection's dialect, sharing one
driver-to-dialect map (sql-analysis/dialect.ts) across MCP and ingest
- Harden the local read-only SQL backstop: accept leading comments,
reject smuggled second statements, and strip trailing
semicolons/comments before row-limit wrapping
199 lines
7.5 KiB
TypeScript
199 lines
7.5 KiB
TypeScript
import { mkdir, mkdtemp, rm, writeFile } from 'node:fs/promises';
|
|
import { tmpdir } from 'node:os';
|
|
import { join } from 'node:path';
|
|
import { afterEach, beforeEach, describe, expect, it } from 'vitest';
|
|
import type { KtxEmbeddingPort } from '../../../src/context/core/embedding.js';
|
|
import { initKtxProject, loadKtxProject, type KtxLocalProject } from '../../../src/context/project/project.js';
|
|
import { SqliteKnowledgeIndex } from '../../../src/context/wiki/sqlite-knowledge-index.js';
|
|
import { reindexLocalIndexes } from '../../../src/context/index-sync/reindex.js';
|
|
|
|
class FakeEmbeddingPort implements KtxEmbeddingPort {
|
|
readonly maxBatchSize = 8;
|
|
|
|
async computeEmbedding(text: string): Promise<number[]> {
|
|
return [text.length, 1];
|
|
}
|
|
|
|
async computeEmbeddingsBulk(texts: string[]): Promise<number[][]> {
|
|
return texts.map((text) => [text.length, 1]);
|
|
}
|
|
}
|
|
|
|
async function createProject(tempDir: string): Promise<KtxLocalProject> {
|
|
await initKtxProject({ projectDir: tempDir, force: true });
|
|
return loadKtxProject({ projectDir: tempDir });
|
|
}
|
|
|
|
describe('reindexLocalIndexes', () => {
|
|
let tempDir: string;
|
|
|
|
beforeEach(async () => {
|
|
tempDir = await mkdtemp(join(tmpdir(), 'ktx-reindex-'));
|
|
});
|
|
|
|
afterEach(async () => {
|
|
await rm(tempDir, { recursive: true, force: true });
|
|
});
|
|
|
|
it('returns an empty summary when no wiki or semantic-layer directories exist', async () => {
|
|
const project = await createProject(tempDir);
|
|
await rm(join(project.projectDir, 'wiki'), { recursive: true, force: true });
|
|
await rm(join(project.projectDir, 'semantic-layer'), { recursive: true, force: true });
|
|
|
|
await expect(reindexLocalIndexes(project, { force: false, embeddingService: null })).resolves.toMatchObject({
|
|
scopes: [],
|
|
totals: { scanned: 0, updated: 0, deleted: 0, embeddingsRecomputed: 0, embeddingsFailed: 0 },
|
|
force: false,
|
|
embeddingsAvailable: false,
|
|
});
|
|
});
|
|
|
|
it('discovers empty directories as zero-row scopes', async () => {
|
|
const project = await createProject(tempDir);
|
|
await mkdir(join(project.projectDir, 'wiki/user/local'), { recursive: true });
|
|
await mkdir(join(project.projectDir, 'semantic-layer/warehouse'), { recursive: true });
|
|
|
|
const summary = await reindexLocalIndexes(project, { force: false, embeddingService: null });
|
|
|
|
expect(summary.scopes.map((scope) => scope.label)).toEqual(['global', 'user/local', 'warehouse']);
|
|
expect(summary.totals.scanned).toBe(0);
|
|
});
|
|
|
|
it('indexes mixed wiki and SL sources and reports totals', async () => {
|
|
const project = await createProject(tempDir);
|
|
await writeFile(
|
|
join(project.projectDir, 'wiki/global/revenue.md'),
|
|
'---\nsummary: Revenue\nusage_mode: auto\n---\n\nPaid orders.\n',
|
|
'utf-8',
|
|
);
|
|
await mkdir(join(project.projectDir, 'semantic-layer/warehouse'), { recursive: true });
|
|
await writeFile(
|
|
join(project.projectDir, 'semantic-layer/warehouse/orders.yaml'),
|
|
'name: orders\ntable: public.orders\ngrain: [id]\ncolumns:\n - name: id\n type: number\njoins: []\nmeasures: []\n',
|
|
'utf-8',
|
|
);
|
|
|
|
const summary = await reindexLocalIndexes(project, {
|
|
force: false,
|
|
embeddingService: new FakeEmbeddingPort(),
|
|
});
|
|
|
|
expect(summary.scopes).toHaveLength(2);
|
|
expect(summary.totals).toMatchObject({ scanned: 2, updated: 2, deleted: 0, embeddingsRecomputed: 2 });
|
|
expect(summary.embeddingsAvailable).toBe(true);
|
|
});
|
|
|
|
it('does not report unchanged lexical-only rows as updated on repeated runs', async () => {
|
|
const project = await createProject(tempDir);
|
|
await writeFile(
|
|
join(project.projectDir, 'wiki/global/revenue.md'),
|
|
'---\nsummary: Revenue\nusage_mode: auto\n---\n\nPaid orders.\n',
|
|
'utf-8',
|
|
);
|
|
await mkdir(join(project.projectDir, 'semantic-layer/warehouse'), { recursive: true });
|
|
await writeFile(
|
|
join(project.projectDir, 'semantic-layer/warehouse/orders.yaml'),
|
|
'name: orders\ntable: public.orders\ngrain: [id]\ncolumns:\n - name: id\n type: number\njoins: []\nmeasures: []\n',
|
|
'utf-8',
|
|
);
|
|
|
|
const first = await reindexLocalIndexes(project, { force: false, embeddingService: null });
|
|
expect(first.totals).toMatchObject({
|
|
scanned: 2,
|
|
updated: 2,
|
|
deleted: 0,
|
|
embeddingsRecomputed: 0,
|
|
embeddingsFailed: 0,
|
|
});
|
|
|
|
const second = await reindexLocalIndexes(project, { force: false, embeddingService: null });
|
|
|
|
expect(second.totals).toMatchObject({
|
|
scanned: 2,
|
|
updated: 0,
|
|
deleted: 0,
|
|
embeddingsRecomputed: 0,
|
|
embeddingsFailed: 0,
|
|
});
|
|
expect(second.scopes.map((scope) => [scope.label, scope.updated])).toEqual([
|
|
['global', 0],
|
|
['warehouse', 0],
|
|
]);
|
|
});
|
|
|
|
it('force clears stale rows before rebuilding each discovered scope', async () => {
|
|
const project = await createProject(tempDir);
|
|
const wikiIndex = new SqliteKnowledgeIndex({ dbPath: join(project.projectDir, '.ktx/db.sqlite') });
|
|
wikiIndex.sync([
|
|
{
|
|
path: 'wiki/global/stale.md',
|
|
key: 'stale',
|
|
scope: 'GLOBAL',
|
|
scopeId: null,
|
|
summary: 'Stale',
|
|
content: 'Stale content',
|
|
tags: [],
|
|
embedding: [1, 0],
|
|
},
|
|
]);
|
|
await writeFile(
|
|
join(project.projectDir, 'wiki/global/revenue.md'),
|
|
'---\nsummary: Revenue\nusage_mode: auto\n---\n\nPaid orders.\n',
|
|
'utf-8',
|
|
);
|
|
|
|
const summary = await reindexLocalIndexes(project, {
|
|
force: true,
|
|
embeddingService: new FakeEmbeddingPort(),
|
|
});
|
|
|
|
expect(summary.force).toBe(true);
|
|
expect(summary.totals).toMatchObject({ scanned: 1, updated: 1, deleted: 0 });
|
|
expect(wikiIndex.search('Stale', 10)).toEqual([]);
|
|
});
|
|
|
|
it('captures a per-scope error and continues other scopes', async () => {
|
|
const project = await createProject(tempDir);
|
|
await writeFile(
|
|
join(project.projectDir, 'wiki/global/revenue.md'),
|
|
'---\nsummary: Revenue\nusage_mode: auto\n---\n\nPaid orders.\n',
|
|
'utf-8',
|
|
);
|
|
// A broken standalone source is surfaced for repair rather than failing the
|
|
// scope, so use a corrupt machine-generated manifest shard, which is the
|
|
// remaining fatal read failure that the per-scope catch must isolate.
|
|
await mkdir(join(project.projectDir, 'semantic-layer/warehouse/_schema'), { recursive: true });
|
|
await writeFile(join(project.projectDir, 'semantic-layer/warehouse/_schema/broken.yaml'), 'not: [valid', 'utf-8');
|
|
|
|
const summary = await reindexLocalIndexes(project, { force: false, embeddingService: null });
|
|
|
|
expect(summary.scopes.find((scope) => scope.label === 'global')?.error).toBeUndefined();
|
|
expect(summary.scopes.find((scope) => scope.label === 'warehouse')?.error).toContain('_schema/broken.yaml');
|
|
});
|
|
|
|
it('marks a scope errored when configured embeddings fail', async () => {
|
|
const project = await createProject(tempDir);
|
|
await writeFile(
|
|
join(project.projectDir, 'wiki/global/revenue.md'),
|
|
'---\nsummary: Revenue\nusage_mode: auto\n---\n\nPaid orders.\n',
|
|
'utf-8',
|
|
);
|
|
const embeddingService: KtxEmbeddingPort = {
|
|
maxBatchSize: 8,
|
|
async computeEmbedding() {
|
|
throw new Error('embedding provider unavailable');
|
|
},
|
|
async computeEmbeddingsBulk() {
|
|
throw new Error('embedding provider unavailable');
|
|
},
|
|
};
|
|
|
|
const summary = await reindexLocalIndexes(project, { force: false, embeddingService });
|
|
|
|
expect(summary.scopes[0]).toMatchObject({
|
|
label: 'global',
|
|
embeddingsFailed: 1,
|
|
error: '1 embedding recomputation failed',
|
|
});
|
|
});
|
|
});
|