apunkt/ktx
1
0
Fork 0
mirror of https://github.com/Kaelio/ktx.git synced 2026-06-25 08:48:08 +02:00
Code Issues Projects Releases Packages Wiki Activity

fix(telemetry): preserve driver error class and code in connection_test (#260)

Browse source 
Native connector test failures were flattened to `new Error(message)`,
collapsing every driver's error class to `Error` and dropping `.code` /
`.number`. connection_test telemetry could therefore not tell a SQL Server
login rejection (ELOGIN / 18456) apart from a network or TLS error, and the
only field that varied was a raw message.

Connectors now return `connectorTestFailure(error)`, which preserves the
original driver error as `cause`, and `testNativeConnection` re-throws that
cause. `scrubErrorClass` then records the real class (e.g. ConnectionError)
and `formatErrorDetail` keeps the code prefix (e.g. "ELOGIN: ..."). The
helper is the single source of truth for the failure shape across all seven
native connectors. User-facing terminal output is unchanged.
This commit is contained in:
Andrey Avtomonov 2026-06-04 14:51:14 +02:00 • committed by GitHub
parent c2beaf7d55
commit ec7edf8f50
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
10 changed files with 82 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

30
packages/cli/test/connection.test.ts
View file

@ -38,7 +38,7 @@ function makeIo() {
function nativeConnector(
driver: KtxConnectionDriver,
testResult: { success: true } | { success: false; error: string } = { success: true },
testResult: { success: true } | { success: false; error: string; cause?: unknown } = { success: true },
) {
const testConnection = vi.fn(async () => testResult);
const cleanup = vi.fn(async () => undefined);
@ -183,6 +183,34 @@ describe('runKtxConnection', () => {
expect(io.stderr()).toContain('"errorDetail":"database file is unreadable"');
});
it('preserves the driver error class and code in connection_test telemetry', async () => {
vi.stubEnv('KTX_TELEMETRY_DEBUG', '1');
vi.stubEnv('CI', '');
const projectDir = join(tempDir, 'project');
await initKtxProject({ projectDir });
await writeConnections(projectDir, {
warehouse: { driver: 'sqlserver', host: 'db.example.test', database: 'analytics', username: 'svc_ro' },
});
class ConnectionError extends Error {
readonly code = 'ELOGIN';
}
const driverError = new ConnectionError("Login failed for user 'svc_ro'.");
const { connector } = nativeConnector('sqlserver', {
success: false,
error: driverError.message,
cause: driverError,
});
const io = makeIo();
const code = await runKtxConnection({ command: 'test', projectDir, connectionId: 'warehouse' }, io.io, {
createScanConnector: vi.fn(async () => connector),
});
expect(code).toBe(1);
expect(io.stderr()).toContain('"errorClass":"ConnectionError"');
expect(io.stderr()).toContain('"errorDetail":"ELOGIN: Login failed for user \'svc_ro\'."');
});
it('reports the connector error and still cleans up when native testConnection fails', async () => {
const projectDir = join(tempDir, 'project');
await initKtxProject({ projectDir });