feat(connectors): generalize readiness and constraint handling (#212)

* feat(connectors): add postgres maxConnections

* feat(connectors): add mysql maxConnections

* feat(connectors): add sqlserver maxConnections

* feat(connectors): rename snowflake pool config

* docs: document connector maxConnections

* feat(scan): add constraint discovery warning helper

* feat(scan): carry structural warnings through reports

* feat(postgres): soft-fail denied constraint discovery

* feat(mysql): soft-fail denied constraint discovery

* feat(sqlserver): soft-fail denied constraint discovery

* feat(bigquery): soft-fail denied primary key discovery

* feat(snowflake): report denied primary key discovery

* test(scan): verify constraint discovery warnings

* feat(historic-sql): use shared readiness probes

* docs: document query history readiness probes

* test(historic-sql): verify readiness probe registry

* test(ingest): account for live database warnings artifact

* Add skip option for agent setup
This commit is contained in:
Andrey Avtomonov 2026-05-24 19:30:06 +02:00 committed by GitHub
parent cfd1749ab9
commit 78b8a0c025
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
42 changed files with 2763 additions and 554 deletions

View file

@ -0,0 +1,113 @@
import { describe, expect, it, vi } from 'vitest';
import {
HistoricSqlExtensionMissingError,
HistoricSqlGrantsMissingError,
HistoricSqlVersionUnsupportedError,
} from '../adapters/historic-sql/errors.js';
import { PostgresPgssProbeRunner } from './postgres-runner.js';
describe('PostgresPgssProbeRunner', () => {
it('runs the pg_stat_statements reader and cleans up the client', async () => {
const cleanup = vi.fn(async () => undefined);
const reader = {
probe: vi.fn(async () => ({
pgServerVersion: 'PostgreSQL 16.4',
warnings: [],
info: ['tracked statements: 12'],
})),
};
const runner = new PostgresPgssProbeRunner({
reader,
createClient: () => ({ client: { executeQuery: vi.fn() }, cleanup }),
});
await expect(
runner.run({
projectDir: '/work/project',
connectionId: 'warehouse',
connection: { driver: 'postgres', url: 'env:DATABASE_URL' },
env: {},
}),
).resolves.toEqual({
pgServerVersion: 'PostgreSQL 16.4',
warnings: [],
info: ['tracked statements: 12'],
});
expect(reader.probe).toHaveBeenCalledOnce();
expect(cleanup).toHaveBeenCalledOnce();
});
it('rejects non-Postgres connections', async () => {
const runner = new PostgresPgssProbeRunner({
reader: { probe: vi.fn() },
createClient: () => ({ client: {}, cleanup: vi.fn() }),
});
await expect(
runner.run({
projectDir: '/work/project',
connectionId: 'warehouse',
connection: { driver: 'snowflake' },
env: {},
}),
).rejects.toThrow('Native PostgreSQL connector cannot run driver "snowflake"');
});
it('formats successful Postgres details', () => {
const runner = new PostgresPgssProbeRunner();
expect(
runner.formatSuccessDetail({
pgServerVersion: 'PostgreSQL 16.4',
warnings: ['pg_stat_statements.track is top'],
info: ['tracked statements: 12'],
}),
).toEqual({
detail: 'pg_stat_statements ready (PostgreSQL 16.4); tracked statements: 12',
warnings: ['pg_stat_statements.track is top'],
});
});
it('maps Postgres probe errors to actionable advice', () => {
const runner = new PostgresPgssProbeRunner();
expect(
runner.fixAdvice(
new HistoricSqlExtensionMissingError({
dialect: 'postgres',
message: 'pg_stat_statements missing',
remediation: 'CREATE EXTENSION pg_stat_statements;',
}),
),
).toEqual({
failHeadline: 'pg_stat_statements extension is missing',
remediation: 'CREATE EXTENSION pg_stat_statements;',
});
expect(
runner.fixAdvice(
new HistoricSqlGrantsMissingError({
dialect: 'postgres',
message: 'missing grants',
remediation: 'GRANT pg_read_all_stats TO <connection role>;',
}),
),
).toEqual({
failHeadline: 'Postgres connection role lacks pg_read_all_stats',
remediation: 'GRANT pg_read_all_stats TO <connection role>;',
});
expect(
runner.fixAdvice(
new HistoricSqlVersionUnsupportedError({
dialect: 'postgres',
detectedVersion: 'PostgreSQL 13.12',
minimumVersion: 'PostgreSQL 14',
}),
),
).toEqual({
failHeadline: 'Postgres version too old',
remediation: 'Use PostgreSQL 14 or newer, or disable query history for this connection',
});
});
});