ktx/packages/cli/test/context/ingest/adapters/lookml/fetch.test.ts

147 lines
6.2 KiB
TypeScript
Raw Permalink Normal View History

2026-05-10 23:12:26 +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 } from 'vitest';
import { makeLocalGitRepo } from '../../../test/make-local-git-repo.js';
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
import { fetchLookmlRepo } from '../../../../../src/context/ingest/adapters/lookml/fetch.js';
import type { LookmlPullConfig } from '../../../../../src/context/ingest/adapters/lookml/pull-config.js';
2026-05-10 23:12:26 +02:00
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
const FIXTURE_ROOT = join(__dirname, '../../../../fixtures/lookml');
2026-05-10 23:12:26 +02:00
function pullConfig(overrides: Partial<LookmlPullConfig> & Pick<LookmlPullConfig, 'repoUrl'>): LookmlPullConfig {
return {
branch: 'main',
path: null,
authToken: null,
expectedLookerConnectionName: null,
parsedTargetTables: {},
...overrides,
};
}
describe('fetchLookmlRepo', () => {
let tmpRoot: string;
beforeEach(async () => {
tmpRoot = await mkdtemp(join(tmpdir(), 'fetch-lookml-'));
});
afterEach(async () => rm(tmpRoot, { recursive: true, force: true }));
it('clones a local file:// repo and materializes only .lkml/.lookml files into stagedDir', async () => {
const repo = await makeLocalGitRepo(join(FIXTURE_ROOT, 'single-model'), join(tmpRoot, 'origin'));
// Add a non-LookML file to prove we filter it out.
await repo.writeFile('README.md', '# readme\n');
await repo.commit('add readme');
const stagedDir = join(tmpRoot, 'staged');
const cacheDir = join(tmpRoot, 'cache', 'conn-1');
await mkdir(stagedDir, { recursive: true });
const result = await fetchLookmlRepo({
config: pullConfig({ repoUrl: repo.repoUrl }),
cacheDir,
stagedDir,
});
expect(result.filesCopied).toBe(3); // orders.model.lkml + 2 views
expect(result.commitHash).toMatch(/^[0-9a-f]{40}$/);
await expect(readFile(join(stagedDir, 'orders.model.lkml'), 'utf-8')).resolves.toMatch(/connection:/);
await expect(readFile(join(stagedDir, 'views', 'orders.view.lkml'), 'utf-8')).resolves.toMatch(/view: orders/);
// README.md is present in the cache but NOT in stagedDir.
await expect(readFile(join(stagedDir, 'README.md'), 'utf-8')).rejects.toThrow();
await expect(readFile(join(cacheDir, 'README.md'), 'utf-8')).resolves.toMatch(/readme/);
});
it('pulls an existing cache dir (second call) and surfaces the new commit', async () => {
const repo = await makeLocalGitRepo(join(FIXTURE_ROOT, 'single-model'), join(tmpRoot, 'origin'));
const stagedDir1 = join(tmpRoot, 'staged-1');
const stagedDir2 = join(tmpRoot, 'staged-2');
const cacheDir = join(tmpRoot, 'cache', 'conn-1');
await mkdir(stagedDir1, { recursive: true });
await mkdir(stagedDir2, { recursive: true });
const r1 = await fetchLookmlRepo({
config: pullConfig({ repoUrl: repo.repoUrl }),
cacheDir,
stagedDir: stagedDir1,
});
// Commit a new revision in the origin — a modified view.
await repo.writeFile('views/orders.view.lkml', 'view: orders { sql_table_name: public.orders_v2 ;; }\n');
await repo.commit('bump');
const r2 = await fetchLookmlRepo({
config: pullConfig({ repoUrl: repo.repoUrl }),
cacheDir,
stagedDir: stagedDir2,
});
expect(r2.commitHash).not.toBe(r1.commitHash);
await expect(readFile(join(stagedDir2, 'views', 'orders.view.lkml'), 'utf-8')).resolves.toMatch(/orders_v2/);
});
it('respects config.path — only files under that subtree land in stagedDir', async () => {
// Build a multi-subdir repo: models/... + views/...
const originRoot = join(tmpRoot, 'origin');
await mkdir(originRoot, { recursive: true });
await mkdir(join(originRoot, 'fixture-src', 'models'), { recursive: true });
await mkdir(join(originRoot, 'fixture-src', 'views'), { recursive: true });
await writeFile(join(originRoot, 'fixture-src', 'models', 'orders.model.lkml'), 'connection: "c"\n', 'utf-8');
await writeFile(join(originRoot, 'fixture-src', 'views', 'orders.view.lkml'), 'view: orders {}\n', 'utf-8');
const repo = await makeLocalGitRepo(join(originRoot, 'fixture-src'), join(originRoot, 'git'));
const stagedDir = join(tmpRoot, 'staged');
const cacheDir = join(tmpRoot, 'cache', 'conn-path');
await mkdir(stagedDir, { recursive: true });
const result = await fetchLookmlRepo({
config: pullConfig({ repoUrl: repo.repoUrl, path: 'views' }),
cacheDir,
stagedDir,
});
expect(result.filesCopied).toBe(1);
await expect(readFile(join(stagedDir, 'orders.view.lkml'), 'utf-8')).resolves.toMatch(/view: orders/);
// The model under `models/` is NOT copied because we scoped to `views/`.
await expect(readFile(join(stagedDir, 'orders.model.lkml'), 'utf-8')).rejects.toThrow();
});
it('falls back to fresh clone when the cache dir is corrupt', async () => {
const repo = await makeLocalGitRepo(join(FIXTURE_ROOT, 'single-model'), join(tmpRoot, 'origin'));
const stagedDir = join(tmpRoot, 'staged');
const cacheDir = join(tmpRoot, 'cache', 'conn-bad');
await mkdir(stagedDir, { recursive: true });
// Pre-create a cacheDir that looks like a git repo but is corrupt.
await mkdir(join(cacheDir, '.git'), { recursive: true });
await writeFile(join(cacheDir, '.git', 'HEAD'), 'garbage\n', 'utf-8');
const result = await fetchLookmlRepo({
config: pullConfig({ repoUrl: repo.repoUrl }),
cacheDir,
stagedDir,
});
expect(result.filesCopied).toBeGreaterThan(0);
});
it('sanitizes auth tokens out of error messages when clone fails', async () => {
const stagedDir = join(tmpRoot, 'staged');
const cacheDir = join(tmpRoot, 'cache', 'conn-bad-url');
await mkdir(stagedDir, { recursive: true });
await expect(
fetchLookmlRepo({
config: pullConfig({
repoUrl: 'http://definitely-not-a-real-host.test/r.git',
authToken: 'supersecret-token',
}),
cacheDir,
stagedDir,
}),
).rejects.toThrow(
// Error is thrown with sanitized message — the token is replaced by '***'.
// The exact message depends on simple-git's failure mode; we assert the token does NOT appear.
expect.objectContaining({ message: expect.not.stringContaining('supersecret-token') }),
);
});
});