2026-05-15 02:35:09 +02:00
|
|
|
import { mkdir, mkdtemp, readFile, rm, writeFile } from 'node:fs/promises';
|
|
|
|
|
import { tmpdir } from 'node:os';
|
|
|
|
|
import { join } from 'node:path';
|
|
|
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
|
|
|
|
|
import {
|
|
|
|
|
mcpDaemonLayout,
|
|
|
|
|
readKtxMcpDaemonStatus,
|
|
|
|
|
startKtxMcpDaemon,
|
|
|
|
|
stopKtxMcpDaemon,
|
|
|
|
|
type KtxMcpDaemonChild,
|
|
|
|
|
type KtxMcpDaemonState,
|
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
2026-05-26 08:49:05 +02:00
|
|
|
} from '../src/managed-mcp-daemon.js';
|
2026-05-15 02:35:09 +02:00
|
|
|
|
2026-05-19 18:18:56 +02:00
|
|
|
type KtxMcpDaemonStartOptions = Parameters<typeof startKtxMcpDaemon>[0];
|
|
|
|
|
|
2026-05-15 02:35:09 +02:00
|
|
|
function child(pid = 4242): KtxMcpDaemonChild {
|
|
|
|
|
return { pid, unref: vi.fn() };
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
function state(projectDir: string, overrides: Partial<KtxMcpDaemonState> = {}): KtxMcpDaemonState {
|
|
|
|
|
return {
|
|
|
|
|
schemaVersion: 1,
|
|
|
|
|
pid: 4242,
|
|
|
|
|
host: '127.0.0.1',
|
|
|
|
|
port: 7878,
|
|
|
|
|
tokenAuth: false,
|
|
|
|
|
projectDir,
|
|
|
|
|
startedAt: '2026-05-14T00:00:00.000Z',
|
|
|
|
|
logPath: join(projectDir, '.ktx/logs/mcp.log'),
|
|
|
|
|
...overrides,
|
|
|
|
|
};
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
describe('managed MCP daemon lifecycle', () => {
|
|
|
|
|
let tempDir: string;
|
|
|
|
|
let projectDir: string;
|
|
|
|
|
|
|
|
|
|
beforeEach(async () => {
|
|
|
|
|
tempDir = await mkdtemp(join(tmpdir(), 'ktx-mcp-daemon-'));
|
|
|
|
|
projectDir = join(tempDir, 'project');
|
|
|
|
|
await mkdir(projectDir, { recursive: true });
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
afterEach(async () => {
|
2026-05-19 18:18:56 +02:00
|
|
|
vi.unstubAllEnvs();
|
2026-05-15 02:35:09 +02:00
|
|
|
await rm(tempDir, { recursive: true, force: true });
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('uses the spec state and log paths', () => {
|
|
|
|
|
expect(mcpDaemonLayout(projectDir)).toEqual({
|
|
|
|
|
statePath: join(projectDir, '.ktx/mcp.json'),
|
|
|
|
|
logPath: join(projectDir, '.ktx/logs/mcp.log'),
|
|
|
|
|
});
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('starts a detached child and writes state without the token value', async () => {
|
|
|
|
|
const spawnDaemon = vi.fn(() => child(5555));
|
|
|
|
|
await startKtxMcpDaemon({
|
|
|
|
|
projectDir,
|
|
|
|
|
cliVersion: '0.0.0-test',
|
|
|
|
|
host: '0.0.0.0',
|
|
|
|
|
port: 7879,
|
|
|
|
|
token: 'secret-token',
|
|
|
|
|
allowedHosts: ['mcp.example.test'],
|
|
|
|
|
allowedOrigins: ['https://mcp.example.test'],
|
|
|
|
|
binPath: '/repo/packages/cli/dist/bin.js',
|
|
|
|
|
spawnDaemon,
|
|
|
|
|
processAlive: vi.fn(() => false),
|
|
|
|
|
portAvailable: vi.fn(async () => true),
|
|
|
|
|
now: () => new Date('2026-05-14T00:00:00.000Z'),
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
expect(spawnDaemon).toHaveBeenCalledWith(
|
|
|
|
|
process.execPath,
|
|
|
|
|
[
|
|
|
|
|
'/repo/packages/cli/dist/bin.js',
|
|
|
|
|
'--project-dir',
|
|
|
|
|
projectDir,
|
|
|
|
|
'mcp',
|
|
|
|
|
'serve-internal',
|
|
|
|
|
'--host',
|
|
|
|
|
'0.0.0.0',
|
|
|
|
|
'--port',
|
|
|
|
|
'7879',
|
|
|
|
|
'--allowed-host',
|
|
|
|
|
'mcp.example.test',
|
|
|
|
|
'--allowed-origin',
|
|
|
|
|
'https://mcp.example.test',
|
|
|
|
|
],
|
|
|
|
|
expect.objectContaining({
|
|
|
|
|
detached: true,
|
|
|
|
|
env: expect.objectContaining({ KTX_MCP_TOKEN: 'secret-token' }),
|
|
|
|
|
}),
|
|
|
|
|
);
|
|
|
|
|
expect(JSON.stringify(JSON.parse(await readFile(join(projectDir, '.ktx/mcp.json'), 'utf8')))).not.toContain(
|
|
|
|
|
'secret-token',
|
|
|
|
|
);
|
|
|
|
|
});
|
|
|
|
|
|
2026-05-19 18:18:56 +02:00
|
|
|
it('sanitizes IPv6 CIDR entries from child NO_PROXY env', async () => {
|
|
|
|
|
vi.stubEnv('NO_PROXY', 'localhost,fd07:b51a:cc66:f0::/64');
|
|
|
|
|
vi.stubEnv('no_proxy', '::1,fd00::/8,*.orb.local');
|
|
|
|
|
const spawnDaemon = vi.fn<NonNullable<KtxMcpDaemonStartOptions['spawnDaemon']>>(() => child(5555));
|
|
|
|
|
|
|
|
|
|
await startKtxMcpDaemon({
|
|
|
|
|
projectDir,
|
|
|
|
|
cliVersion: '0.0.0-test',
|
|
|
|
|
host: '127.0.0.1',
|
|
|
|
|
port: 7879,
|
|
|
|
|
allowedHosts: [],
|
|
|
|
|
allowedOrigins: [],
|
|
|
|
|
binPath: '/repo/packages/cli/dist/bin.js',
|
|
|
|
|
spawnDaemon,
|
|
|
|
|
processAlive: vi.fn(() => false),
|
|
|
|
|
portAvailable: vi.fn(async () => true),
|
|
|
|
|
now: () => new Date('2026-05-14T00:00:00.000Z'),
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
const env = spawnDaemon.mock.calls[0]?.[2].env;
|
|
|
|
|
if (!env) {
|
|
|
|
|
throw new Error('Expected MCP daemon spawn env');
|
|
|
|
|
}
|
|
|
|
|
expect(env.NO_PROXY).toBe('localhost,::1,*.orb.local');
|
|
|
|
|
expect(env.no_proxy).toBe(env.NO_PROXY);
|
|
|
|
|
});
|
|
|
|
|
|
feat(setup): add Claude Desktop target and MCP-first agent setup (#114)
* feat(setup): add Claude Desktop target and MCP-first agent setup
Adds `ktx mcp stdio` and a `claude-desktop` setup target that generates a
local plugin ZIP wiring the analytics skill and a stdio MCP config. Replaces
the CLI-only agent install mode with MCP+analytics (default) and an optional
admin CLI skill, renames the research skill to analytics, and lets interactive
setup pick project vs global scope when every target supports it. Extracts a
shared MCP server factory used by both HTTP and stdio entrypoints.
* Add MCP agent client setup support
* Polish setup output formatting
* Add MCP tool polish design spec
Design for slimming the MCP-registered surface from 25 to 11 tools,
introducing memory_ingest, applying the per-tool polish kit (annotations,
outputSchema, .describe(), in-band error wrapping, union-drift fixes,
type-narrowed jsonToolResult), emitting progress notifications on
sql_execution + sl_query, and refining the ktx-analytics SKILL.md to
match.
* Refine MCP tool polish design spec after adversarial review iteration 1
* Refine MCP tool polish design spec after adversarial review iteration 2
* Refine MCP tool polish design spec after adversarial review iteration 3
* refactor(context): rename memory capture service to ingest
* feat(mcp): slim research tool surface
* refactor(mcp): remove admin ports from server factory
* refactor(cli): rename text ingest memory port
* docs: update analytics skill for memory ingest
* chore: verify mcp surface rename
* Add MCP tool polish v1 surface change plan
* feat(context): polish mcp tool metadata
* fix(context): enforce resolved semantic layer compute sources
* feat(context): emit mcp query progress stages
* fix(context): keep mcp progress event internal
* Add MCP tool polish v1 metadata & progress plan
* Fix CI snapshot and docs checks
2026-05-16 11:39:55 +02:00
|
|
|
it('returns already-running without spawning when the daemon is alive at the same host/port', async () => {
|
|
|
|
|
await mkdir(join(projectDir, '.ktx'), { recursive: true });
|
|
|
|
|
await writeFile(join(projectDir, '.ktx/mcp.json'), `${JSON.stringify(state(projectDir), null, 2)}\n`);
|
|
|
|
|
const spawnDaemon = vi.fn(() => child(9999));
|
|
|
|
|
|
|
|
|
|
const result = await startKtxMcpDaemon({
|
|
|
|
|
projectDir,
|
|
|
|
|
cliVersion: '0.0.0-test',
|
|
|
|
|
host: '127.0.0.1',
|
|
|
|
|
port: 7878,
|
|
|
|
|
allowedHosts: [],
|
|
|
|
|
allowedOrigins: [],
|
|
|
|
|
binPath: '/repo/packages/cli/dist/bin.js',
|
|
|
|
|
spawnDaemon,
|
|
|
|
|
processAlive: vi.fn(() => true),
|
|
|
|
|
portAvailable: vi.fn(async () => true),
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
expect(result.status).toBe('already-running');
|
|
|
|
|
expect(result.url).toBe('http://127.0.0.1:7878/mcp');
|
|
|
|
|
expect(result.state.pid).toBe(4242);
|
|
|
|
|
expect(spawnDaemon).not.toHaveBeenCalled();
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('throws when the recorded daemon uses a different host or port', async () => {
|
|
|
|
|
await mkdir(join(projectDir, '.ktx'), { recursive: true });
|
|
|
|
|
await writeFile(join(projectDir, '.ktx/mcp.json'), `${JSON.stringify(state(projectDir), null, 2)}\n`);
|
|
|
|
|
const spawnDaemon = vi.fn(() => child(9999));
|
|
|
|
|
|
|
|
|
|
await expect(
|
|
|
|
|
startKtxMcpDaemon({
|
|
|
|
|
projectDir,
|
|
|
|
|
cliVersion: '0.0.0-test',
|
|
|
|
|
host: '127.0.0.1',
|
|
|
|
|
port: 9000,
|
|
|
|
|
allowedHosts: [],
|
|
|
|
|
allowedOrigins: [],
|
|
|
|
|
binPath: '/repo/packages/cli/dist/bin.js',
|
|
|
|
|
spawnDaemon,
|
|
|
|
|
processAlive: vi.fn(() => true),
|
|
|
|
|
portAvailable: vi.fn(async () => true),
|
|
|
|
|
}),
|
|
|
|
|
).rejects.toThrow(/different configuration[\s\S]*ktx mcp stop/);
|
|
|
|
|
expect(spawnDaemon).not.toHaveBeenCalled();
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('throws when token-auth presence differs from the recorded daemon', async () => {
|
|
|
|
|
await mkdir(join(projectDir, '.ktx'), { recursive: true });
|
|
|
|
|
await writeFile(
|
|
|
|
|
join(projectDir, '.ktx/mcp.json'),
|
|
|
|
|
`${JSON.stringify(state(projectDir, { tokenAuth: false }), null, 2)}\n`,
|
|
|
|
|
);
|
|
|
|
|
const spawnDaemon = vi.fn(() => child(9999));
|
|
|
|
|
|
|
|
|
|
await expect(
|
|
|
|
|
startKtxMcpDaemon({
|
|
|
|
|
projectDir,
|
|
|
|
|
cliVersion: '0.0.0-test',
|
|
|
|
|
host: '127.0.0.1',
|
|
|
|
|
port: 7878,
|
|
|
|
|
token: 'secret-token',
|
|
|
|
|
allowedHosts: [],
|
|
|
|
|
allowedOrigins: [],
|
|
|
|
|
binPath: '/repo/packages/cli/dist/bin.js',
|
|
|
|
|
spawnDaemon,
|
|
|
|
|
processAlive: vi.fn(() => true),
|
|
|
|
|
portAvailable: vi.fn(async () => true),
|
|
|
|
|
}),
|
|
|
|
|
).rejects.toThrow(/different configuration/);
|
|
|
|
|
expect(spawnDaemon).not.toHaveBeenCalled();
|
|
|
|
|
});
|
|
|
|
|
|
2026-05-15 02:35:09 +02:00
|
|
|
it('reports running when the process is alive and health passes', async () => {
|
|
|
|
|
await mkdir(join(projectDir, '.ktx'), { recursive: true });
|
|
|
|
|
await writeFile(join(projectDir, '.ktx/mcp.json'), `${JSON.stringify(state(projectDir), null, 2)}\n`);
|
|
|
|
|
|
|
|
|
|
const status = await readKtxMcpDaemonStatus({
|
|
|
|
|
projectDir,
|
|
|
|
|
processAlive: vi.fn(() => true),
|
|
|
|
|
fetchHealth: vi.fn(async () => ({ ok: true, body: { status: 'ok', projectDir, port: 7878 } })),
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
expect(status.kind).toBe('running');
|
|
|
|
|
if (status.kind !== 'running') {
|
|
|
|
|
throw new Error(`Expected running status, received ${status.kind}`);
|
|
|
|
|
}
|
|
|
|
|
expect(status.url).toBe('http://127.0.0.1:7878/mcp');
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('stops a recorded daemon and removes state', async () => {
|
|
|
|
|
await mkdir(join(projectDir, '.ktx'), { recursive: true });
|
|
|
|
|
await writeFile(join(projectDir, '.ktx/mcp.json'), `${JSON.stringify(state(projectDir), null, 2)}\n`);
|
|
|
|
|
const alive = new Set([4242]);
|
|
|
|
|
const killProcess = vi.fn((pid: number) => alive.delete(pid));
|
|
|
|
|
|
|
|
|
|
await expect(
|
|
|
|
|
stopKtxMcpDaemon({
|
|
|
|
|
projectDir,
|
|
|
|
|
processAlive: vi.fn((pid) => alive.has(pid)),
|
|
|
|
|
killProcess,
|
|
|
|
|
stopGraceMs: 1,
|
|
|
|
|
pollIntervalMs: 1,
|
|
|
|
|
}),
|
|
|
|
|
).resolves.toEqual({ status: 'stopped' });
|
|
|
|
|
|
|
|
|
|
expect(killProcess).toHaveBeenCalledWith(4242, 'SIGTERM');
|
|
|
|
|
await expect(readFile(join(projectDir, '.ktx/mcp.json'), 'utf8')).rejects.toThrow();
|
|
|
|
|
});
|
|
|
|
|
});
|