ktx/packages/cli/test/context/ingest/adapters/metabase/metabase.adapter.test.ts

154 lines
5.2 KiB
TypeScript
Raw Permalink Normal View History

2026-05-10 23:12:26 +02:00
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, vi } from 'vitest';
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 { MetabaseSourceAdapter } from '../../../../../src/context/ingest/adapters/metabase/metabase.adapter.js';
2026-05-10 23:12:26 +02:00
describe('MetabaseSourceAdapter', () => {
let stagedDir: string;
let adapter: MetabaseSourceAdapter;
beforeEach(async () => {
stagedDir = await mkdtemp(join(tmpdir(), 'mb-adapter-'));
adapter = new MetabaseSourceAdapter({} as any);
});
afterEach(async () => {
await rm(stagedDir, { recursive: true, force: true });
});
it('declares the expected source key and skill list', () => {
expect(adapter.source).toBe('metabase');
expect(adapter.skillNames).toEqual(['metabase_ingest']);
});
it('detect: true for a valid staged dir', async () => {
await writeFile(join(stagedDir, 'sync-config.json'), '{}', 'utf-8');
await mkdir(join(stagedDir, 'cards'), { recursive: true });
await writeFile(join(stagedDir, 'cards/1.json'), '{}', 'utf-8');
expect(await adapter.detect(stagedDir)).toBe(true);
});
it('detect: false for a random empty dir', async () => {
expect(await adapter.detect(stagedDir)).toBe(false);
});
it('exposes a fetch() method (network-bound — real calls covered by fetch.spec.ts)', () => {
expect(typeof adapter.fetch).toBe('function');
});
it('forwards fetch dependencies using the source-state reader port', async () => {
const client = {
getAllCards: vi.fn().mockResolvedValue([]),
getCollectionTree: vi.fn().mockResolvedValue([]),
getCollectionItems: vi.fn().mockResolvedValue([]),
cleanup: vi.fn().mockResolvedValue(undefined),
};
const clientFactory = {
createClient: vi.fn().mockResolvedValue(client),
};
const sourceStateReader = {
getSourceState: vi.fn().mockResolvedValue({
syncMode: 'ALL',
selections: [],
defaultTagNames: [],
mappings: [
{
metabaseDatabaseId: 42,
metabaseDatabaseName: 'Analytics',
metabaseEngine: 'postgres',
targetConnectionId: 'b2c3d4e5-f6a7-4890-abcd-ef0123456789',
syncEnabled: true,
},
],
}),
};
const forwardingAdapter = new MetabaseSourceAdapter({ clientFactory, sourceStateReader });
await forwardingAdapter.fetch(
{
metabaseConnectionId: 'a1b2c3d4-e5f6-4789-9abc-def012345678',
metabaseDatabaseId: 42,
},
stagedDir,
{ connectionId: 'b2c3d4e5-f6a7-4890-abcd-ef0123456789', sourceKey: 'metabase' },
);
expect(sourceStateReader.getSourceState).toHaveBeenCalledWith('a1b2c3d4-e5f6-4789-9abc-def012345678');
expect(clientFactory.createClient).toHaveBeenCalledWith(
{
metabaseConnectionId: 'a1b2c3d4-e5f6-4789-9abc-def012345678',
metabaseDatabaseId: 42,
},
{ connectionId: 'b2c3d4e5-f6a7-4890-abcd-ef0123456789', sourceKey: 'metabase' },
);
});
});
describe('MetabaseSourceAdapter.describeScope', () => {
const adapter = new MetabaseSourceAdapter({} as any);
let dir: string;
beforeEach(async () => {
dir = await mkdtemp(join(tmpdir(), 'mb-scope-'));
});
afterEach(async () => {
await rm(dir, { recursive: true, force: true });
});
async function writeSyncConfig(cfg: unknown): Promise<void> {
await writeFile(join(dir, 'sync-config.json'), JSON.stringify(cfg), 'utf-8');
}
const BASE = {
metabaseConnectionId: 'a1b2c3d4-e5f6-4789-9abc-def012345678',
metabaseDatabaseId: 42,
defaultTagNames: [],
mapping: {
metabaseDatabaseId: 42,
metabaseDatabaseName: 'Analytics',
metabaseEngine: 'postgres',
targetConnectionId: 'b2c3d4e5-f6a7-4890-abcd-ef0123456789',
},
};
it('returns a fingerprint + predicate for ONLY-scope staged dir', async () => {
await writeSyncConfig({
...BASE,
syncMode: 'ONLY',
selections: [{ selectionType: 'item', metabaseObjectId: 5 }],
});
const scope = await adapter.describeScope(dir);
expect(scope.fingerprint).toMatch(/^[0-9a-f]{64}$/);
expect(scope.isPathInScope('cards/5.json')).toBe(true);
expect(scope.isPathInScope('cards/99.json')).toBe(false);
expect(scope.isPathInScope('sync-config.json')).toBe(true);
});
it('fingerprint is stable across invocations', async () => {
await writeSyncConfig({
...BASE,
syncMode: 'ONLY',
selections: [
{ selectionType: 'item', metabaseObjectId: 1 },
{ selectionType: 'item', metabaseObjectId: 2 },
],
});
const a = await adapter.describeScope(dir);
const b = await adapter.describeScope(dir);
expect(a.fingerprint).toBe(b.fingerprint);
});
it('different syncMode produces different fingerprint', async () => {
await writeSyncConfig({ ...BASE, syncMode: 'ALL', selections: [] });
const all = await adapter.describeScope(dir);
await writeSyncConfig({
...BASE,
syncMode: 'ONLY',
selections: [{ selectionType: 'item', metabaseObjectId: 1 }],
});
const only = await adapter.describeScope(dir);
expect(all.fingerprint).not.toBe(only.fingerprint);
});
});