ktx/scripts/check-boundaries.mjs
Andrey Avtomonov 56985b7e09
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

257 lines
7.7 KiB
JavaScript

#!/usr/bin/env node
import { readdir, readFile } from 'node:fs/promises';
import path from 'node:path';
import { fileURLToPath, pathToFileURL } from 'node:url';
const codeExtensions = new Set(['.ts', '.tsx', '.js', '.jsx', '.mjs', '.cjs', '.py']);
const runtimeAssetPatterns = [/^packages\/cli\/src\/prompts\/.+\.md$/, /^packages\/cli\/src\/skills\/.+\.md$/];
const identifierSkipPrefixes = ['docs/', 'docs-site/', 'examples/', 'python/ktx-sl/plans/', 'python/ktx-sl/openspec/'];
const identifierAllowPatterns = [
/^packages\/cli\/src\/(?:index|managed-local-embeddings|managed-python-command|managed-python-daemon|managed-python-runtime|release-version|runtime)(?:\.test)?\.ts$/,
/^python\/ktx-daemon\/src\/ktx_daemon\/__init__\.py$/,
/^scripts\/(?:build-python-runtime-wheel|local-embeddings-runtime-smoke|package-artifacts|public-npm-release-metadata|published-package-smoke|release-readiness)(?:\.test)?\.mjs$/,
/^scripts\/semantic-release-config\.cjs$/,
];
const forbiddenIdentifierTerms = ['kae' + 'lio', 'Kae' + 'lio', 'KAE' + 'LIO_'];
const appImportPatterns = [
{
label: 'server source import',
pattern: /(?:from\s+['"][^'"]*|import\s*\(\s*['"][^'"]*|import\s+['"][^'"]*)(?:@server\/|server\/src|(?:\.\.\/)+server\/src)/,
},
{
label: 'frontend source import',
pattern: /(?:from\s+['"][^'"]*|import\s*\(\s*['"][^'"]*|import\s+['"][^'"]*)(?:@frontend\/|frontend\/src|(?:\.\.\/)+frontend\/src)/,
},
{
label: 'python service app import',
pattern: /(?:from\s+['"][^'"]*|import\s*\(\s*['"][^'"]*|import\s+['"][^'"]*|from\s+)(?:python-service\/app|python_service\.app|app\.)/,
},
];
const llmBoundaryPatterns = [
{
label: 'direct Anthropic provider construction',
pattern: /\bcreateAnthropic\b/,
},
{
label: 'direct Vertex Anthropic provider construction',
pattern: /\bcreateVertexAnthropic\b/,
},
{
label: 'direct AI SDK gateway construction',
pattern: /\bcreateGateway\b/,
},
{
label: 'direct AI SDK embedding execution',
pattern: /\bembedMany\b/,
},
{
label: 'context-owned LLM provider port',
pattern: /\bLlmProviderPort\b/,
},
{
label: 'scan-owned LLM provider port',
pattern: /\bKtxScanLlmPort\b/,
},
{
label: 'context-owned gateway LLM provider helper',
pattern: /\bcreateGatewayLlmProvider\b/,
},
];
const contextProductionLlmBoundaryPatterns = [
{
label: 'context getModelByName call',
pattern: /\.\s*getModelByName\s*\(/,
},
];
const concreteDialectImportPatterns = [
/from\s+['"][^'"]*connectors\/[^'"]+\/dialect\.js['"]/,
/import\s*\(\s*['"][^'"]*connectors\/[^'"]+\/dialect\.js['"]\s*\)/,
/from\s+['"]\.\/dialect\.js['"]/,
/import\s*\(\s*['"]\.\/dialect\.js['"]\s*\)/,
];
function normalizePath(filePath) {
return filePath.split(path.sep).join('/');
}
function isCodeSource(relativePath) {
return codeExtensions.has(path.extname(relativePath));
}
function isRuntimeAsset(relativePath) {
return runtimeAssetPatterns.some((pattern) => pattern.test(relativePath));
}
function scansForAppImports(relativePath) {
return isCodeSource(relativePath);
}
function scansForLlmBoundaries(relativePath) {
return isCodeSource(relativePath) && relativePath.startsWith('packages/cli/src/context/');
}
function isTestSource(relativePath) {
return (
/(?:^|\/)[^/]+\.(?:test|spec)\.[cm]?[jt]sx?$/.test(relativePath) ||
/(?:^|\/)tests\/(?:.+\/)?(?:test_[^/]+|[^/]+_test)\.py$/.test(relativePath)
);
}
function scansForContextProductionLlmBoundaries(relativePath) {
return scansForLlmBoundaries(relativePath) && !isTestSource(relativePath);
}
function scansForConcreteDialectImportBoundaries(relativePath) {
return (
relativePath.startsWith('packages/cli/src/context/scan/') ||
/^packages\/cli\/src\/connectors\/[^/]+\/connector\.ts$/.test(relativePath)
);
}
function scansForForbiddenIdentifiers(relativePath) {
return (isCodeSource(relativePath) && !isTestSource(relativePath)) || isRuntimeAsset(relativePath);
}
function skipsIdentifierScan(relativePath) {
return identifierSkipPrefixes.some((prefix) => relativePath.startsWith(prefix));
}
function allowsForbiddenIdentifier(relativePath) {
return identifierAllowPatterns.some((pattern) => pattern.test(relativePath));
}
export function scanFileContent(relativePath, content) {
const normalizedPath = normalizePath(relativePath);
const violations = [];
if (scansForAppImports(normalizedPath)) {
for (const appImportPattern of appImportPatterns) {
if (appImportPattern.pattern.test(content)) {
violations.push({
file: normalizedPath,
kind: 'app-import',
message: `Forbidden ${appImportPattern.label}`,
});
}
}
}
if (scansForLlmBoundaries(normalizedPath)) {
for (const llmBoundaryPattern of llmBoundaryPatterns) {
if (llmBoundaryPattern.pattern.test(content)) {
violations.push({
file: normalizedPath,
kind: 'llm-boundary',
message: `Forbidden ${llmBoundaryPattern.label}; use packages/cli/src/llm`,
});
}
}
}
if (scansForContextProductionLlmBoundaries(normalizedPath)) {
for (const llmBoundaryPattern of contextProductionLlmBoundaryPatterns) {
if (llmBoundaryPattern.pattern.test(content)) {
violations.push({
file: normalizedPath,
kind: 'llm-boundary',
message: `Forbidden ${llmBoundaryPattern.label}; use getModel(role) inside context modules`,
});
}
}
}
if (scansForConcreteDialectImportBoundaries(normalizedPath)) {
for (const pattern of concreteDialectImportPatterns) {
if (pattern.test(content)) {
violations.push({
file: normalizedPath,
kind: 'dialect-boundary',
message:
'Forbidden concrete connector dialect import; use getDialectForDriver() from context/connections/dialects.ts',
});
}
}
}
if (
scansForForbiddenIdentifiers(normalizedPath) &&
!skipsIdentifierScan(normalizedPath) &&
!allowsForbiddenIdentifier(normalizedPath)
) {
for (const term of forbiddenIdentifierTerms) {
if (content.includes(term)) {
violations.push({
file: normalizedPath,
kind: 'identifier',
message: `Forbidden product identifier "${term}"`,
});
}
}
}
return violations;
}
async function collectFiles(rootDir, currentDir = rootDir) {
const entries = await readdir(currentDir, { withFileTypes: true });
const files = [];
for (const entry of entries) {
const fullPath = path.join(currentDir, entry.name);
if (entry.isDirectory()) {
if (entry.name === 'node_modules' || entry.name === 'dist' || entry.name === '.venv') {
continue;
}
files.push(...(await collectFiles(rootDir, fullPath)));
continue;
}
if (entry.isFile()) {
files.push(fullPath);
}
}
return files;
}
export async function collectViolations(rootDir) {
const files = await collectFiles(rootDir);
const violations = [];
for (const file of files) {
const relativePath = normalizePath(path.relative(rootDir, file));
const content = await readFile(file, 'utf8');
violations.push(...scanFileContent(relativePath, content));
}
return violations;
}
async function main() {
const scriptDir = path.dirname(fileURLToPath(import.meta.url));
const rootDir = path.resolve(scriptDir, '..');
const violations = await collectViolations(rootDir);
if (violations.length === 0) {
process.stdout.write('ktx boundary check passed\n');
return;
}
for (const violation of violations) {
process.stderr.write(`${violation.file}: ${violation.message}\n`);
}
process.exitCode = 1;
}
if (import.meta.url === pathToFileURL(process.argv[1] ?? '').href) {
await main();
}