@rsdk/db 5.15.0-next.9 → 5.16.0-next.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +4 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +15 -0
- package/dist/index.js.map +1 -1
- package/dist/metrics/call-then.d.ts +30 -0
- package/dist/metrics/call-then.js +91 -0
- package/dist/metrics/call-then.js.map +1 -0
- package/dist/metrics/clock.d.ts +2 -0
- package/dist/metrics/clock.js +9 -0
- package/dist/metrics/clock.js.map +1 -0
- package/dist/metrics/db-client-metrics.d.ts +85 -0
- package/dist/metrics/db-client-metrics.js +164 -0
- package/dist/metrics/db-client-metrics.js.map +1 -0
- package/dist/metrics/db-metric.d.ts +41 -0
- package/dist/metrics/db-metric.js +99 -0
- package/dist/metrics/db-metric.js.map +1 -0
- package/dist/metrics/db-metrics.config.d.ts +7 -0
- package/dist/metrics/db-metrics.config.js +60 -0
- package/dist/metrics/db-metrics.config.js.map +1 -0
- package/dist/metrics/db-metrics.module-base.d.ts +61 -0
- package/dist/metrics/db-metrics.module-base.js +61 -0
- package/dist/metrics/db-metrics.module-base.js.map +1 -0
- package/dist/metrics/db-metrics.providers.d.ts +66 -0
- package/dist/metrics/db-metrics.providers.js +83 -0
- package/dist/metrics/db-metrics.providers.js.map +1 -0
- package/dist/metrics/detach-group.d.ts +19 -0
- package/dist/metrics/detach-group.js +31 -0
- package/dist/metrics/detach-group.js.map +1 -0
- package/dist/metrics/detach.d.ts +24 -0
- package/dist/metrics/detach.js +45 -0
- package/dist/metrics/detach.js.map +1 -0
- package/dist/metrics/entity-operations.recorder.d.ts +17 -0
- package/dist/metrics/entity-operations.recorder.js +28 -0
- package/dist/metrics/entity-operations.recorder.js.map +1 -0
- package/dist/metrics/events.d.ts +11 -0
- package/dist/metrics/events.js +20 -0
- package/dist/metrics/events.js.map +1 -0
- package/dist/metrics/guards.d.ts +12 -0
- package/dist/metrics/guards.js +19 -0
- package/dist/metrics/guards.js.map +1 -0
- package/dist/metrics/index.d.ts +1 -0
- package/dist/metrics/index.js +11 -0
- package/dist/metrics/index.js.map +1 -0
- package/dist/metrics/instrumentation/pg-pool.instrumentation.d.ts +48 -0
- package/dist/metrics/instrumentation/pg-pool.instrumentation.js +117 -0
- package/dist/metrics/instrumentation/pg-pool.instrumentation.js.map +1 -0
- package/dist/metrics/instrumentation/pool-adapters.d.ts +22 -0
- package/dist/metrics/instrumentation/pool-adapters.js +16 -0
- package/dist/metrics/instrumentation/pool-adapters.js.map +1 -0
- package/dist/metrics/instrumentation/pool-close.d.ts +10 -0
- package/dist/metrics/instrumentation/pool-close.js +43 -0
- package/dist/metrics/instrumentation/pool-close.js.map +1 -0
- package/dist/metrics/instrumentation/pool-scope.d.ts +13 -0
- package/dist/metrics/instrumentation/pool-scope.js +3 -0
- package/dist/metrics/instrumentation/pool-scope.js.map +1 -0
- package/dist/metrics/instrumentation/pool.adapter.d.ts +50 -0
- package/dist/metrics/instrumentation/pool.adapter.js +3 -0
- package/dist/metrics/instrumentation/pool.adapter.js.map +1 -0
- package/dist/metrics/instrumentation/pool.recorder.d.ts +74 -0
- package/dist/metrics/instrumentation/pool.recorder.js +125 -0
- package/dist/metrics/instrumentation/pool.recorder.js.map +1 -0
- package/dist/metrics/instrumentation/query-completion.d.ts +12 -0
- package/dist/metrics/instrumentation/query-completion.js +76 -0
- package/dist/metrics/instrumentation/query-completion.js.map +1 -0
- package/dist/metrics/instrumentation/query.instrumentation.d.ts +35 -0
- package/dist/metrics/instrumentation/query.instrumentation.js +85 -0
- package/dist/metrics/instrumentation/query.instrumentation.js.map +1 -0
- package/dist/metrics/instrumentation/tarn-pool.instrumentation.d.ts +44 -0
- package/dist/metrics/instrumentation/tarn-pool.instrumentation.js +95 -0
- package/dist/metrics/instrumentation/tarn-pool.instrumentation.js.map +1 -0
- package/dist/metrics/instrumentation/transaction-tracker.d.ts +32 -0
- package/dist/metrics/instrumentation/transaction-tracker.js +64 -0
- package/dist/metrics/instrumentation/transaction-tracker.js.map +1 -0
- package/dist/metrics/metric-types.d.ts +17 -0
- package/dist/metrics/metric-types.js +3 -0
- package/dist/metrics/metric-types.js.map +1 -0
- package/dist/metrics/metrics.d.ts +82 -0
- package/dist/metrics/metrics.js +269 -0
- package/dist/metrics/metrics.js.map +1 -0
- package/dist/metrics/plugin-kit.d.ts +12 -0
- package/dist/metrics/plugin-kit.js +42 -0
- package/dist/metrics/plugin-kit.js.map +1 -0
- package/dist/metrics/pool-names.d.ts +47 -0
- package/dist/metrics/pool-names.js +44 -0
- package/dist/metrics/pool-names.js.map +1 -0
- package/dist/metrics/pool-stats.registry.d.ts +25 -0
- package/dist/metrics/pool-stats.registry.js +32 -0
- package/dist/metrics/pool-stats.registry.js.map +1 -0
- package/dist/metrics/scrape-source.registry.d.ts +29 -0
- package/dist/metrics/scrape-source.registry.js +55 -0
- package/dist/metrics/scrape-source.registry.js.map +1 -0
- package/dist/metrics/sql.d.ts +34 -0
- package/dist/metrics/sql.js +132 -0
- package/dist/metrics/sql.js.map +1 -0
- package/package.json +2 -2
- package/src/index.ts +1 -0
- package/src/metrics/call-then.ts +134 -0
- package/src/metrics/clock.ts +5 -0
- package/src/metrics/db-client-metrics.spec.ts +1894 -0
- package/src/metrics/db-client-metrics.ts +206 -0
- package/src/metrics/db-metric.spec.ts +185 -0
- package/src/metrics/db-metric.ts +186 -0
- package/src/metrics/db-metrics.config.ts +46 -0
- package/src/metrics/db-metrics.module-base.spec.ts +91 -0
- package/src/metrics/db-metrics.module-base.ts +77 -0
- package/src/metrics/db-metrics.providers.spec.ts +182 -0
- package/src/metrics/db-metrics.providers.ts +134 -0
- package/src/metrics/detach-group.spec.ts +41 -0
- package/src/metrics/detach-group.ts +30 -0
- package/src/metrics/detach.spec.ts +61 -0
- package/src/metrics/detach.ts +57 -0
- package/src/metrics/entity-operations.recorder.ts +26 -0
- package/src/metrics/events.spec.ts +19 -0
- package/src/metrics/events.ts +28 -0
- package/src/metrics/guards.spec.ts +20 -0
- package/src/metrics/guards.ts +19 -0
- package/src/metrics/index.ts +6 -0
- package/src/metrics/instrumentation/pg-pool.instrumentation.ts +177 -0
- package/src/metrics/instrumentation/pool-adapters.ts +35 -0
- package/src/metrics/instrumentation/pool-close.ts +59 -0
- package/src/metrics/instrumentation/pool-guards.spec.ts +318 -0
- package/src/metrics/instrumentation/pool-scope.ts +14 -0
- package/src/metrics/instrumentation/pool.adapter.ts +67 -0
- package/src/metrics/instrumentation/pool.recorder.ts +167 -0
- package/src/metrics/instrumentation/query-completion.spec.ts +209 -0
- package/src/metrics/instrumentation/query-completion.ts +107 -0
- package/src/metrics/instrumentation/query.instrumentation.ts +136 -0
- package/src/metrics/instrumentation/tarn-pool.instrumentation.ts +138 -0
- package/src/metrics/instrumentation/transaction-tracker.ts +103 -0
- package/src/metrics/metric-types.ts +36 -0
- package/src/metrics/metrics.ts +233 -0
- package/src/metrics/plugin-kit.ts +39 -0
- package/src/metrics/pool-names.spec.ts +79 -0
- package/src/metrics/pool-names.ts +77 -0
- package/src/metrics/pool-stats.registry.spec.ts +81 -0
- package/src/metrics/pool-stats.registry.ts +54 -0
- package/src/metrics/public-api.spec.ts +104 -0
- package/src/metrics/scrape-source.registry.spec.ts +59 -0
- package/src/metrics/scrape-source.registry.ts +55 -0
- package/src/metrics/sql.spec.ts +110 -0
- package/src/metrics/sql.ts +172 -0
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
import { DbMetricsConfig } from './db-metrics.config';
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Состав публичного API метрик и внутреннего API для плагинов. Новый
|
|
5
|
+
* экспорт корня — это обещание пользователям пакета: добавлять его сюда
|
|
6
|
+
* нужно осознанно. Всё, что нужно только ORM-плагинам rsdk, идёт в
|
|
7
|
+
* `plugin-kit`
|
|
8
|
+
*/
|
|
9
|
+
const METRICS_VALUES = ['DbMetricsConfig'];
|
|
10
|
+
|
|
11
|
+
/**
|
|
12
|
+
* Значения корня `@rsdk/db`, которые были в develop до метрик
|
|
13
|
+
*/
|
|
14
|
+
const ROOT_VALUES_BEFORE_METRICS = [
|
|
15
|
+
'BaseContext',
|
|
16
|
+
'CallOutOfContextWithMandatory',
|
|
17
|
+
'ContextStorage',
|
|
18
|
+
'HEALTH_CHECK_QUERY',
|
|
19
|
+
'IncompatibleIsolationLevels',
|
|
20
|
+
'InvalidMultiHostProtocol',
|
|
21
|
+
'InvalidMultiHostUrl',
|
|
22
|
+
'MultiHostNativeRequired',
|
|
23
|
+
'MultiHostResolver',
|
|
24
|
+
'MultiHostUrl',
|
|
25
|
+
'MultiHostUrlParser',
|
|
26
|
+
'NeverRunningInTransaction',
|
|
27
|
+
'Propagation',
|
|
28
|
+
'SslModeEnum',
|
|
29
|
+
'TransactionRunner',
|
|
30
|
+
'getSecureContextOptions',
|
|
31
|
+
'loadPgJsDriver',
|
|
32
|
+
'pgProbe',
|
|
33
|
+
'resolveDbConnection',
|
|
34
|
+
'withoutPgNative',
|
|
35
|
+
];
|
|
36
|
+
|
|
37
|
+
const PLUGIN_KIT_VALUES = [
|
|
38
|
+
'DB_CLIENT_METRICS_TOKEN',
|
|
39
|
+
'DbMetric',
|
|
40
|
+
'DbMetricsModuleBase',
|
|
41
|
+
'ENTITY_OPERATIONS_RECORDER_TOKEN',
|
|
42
|
+
'QUERY_BUCKETS',
|
|
43
|
+
'ScrapeSourceRegistry',
|
|
44
|
+
'dbMetricsModuleProviders',
|
|
45
|
+
'now',
|
|
46
|
+
'once',
|
|
47
|
+
'replaceMethod',
|
|
48
|
+
'secondsSince',
|
|
49
|
+
];
|
|
50
|
+
|
|
51
|
+
// eslint-disable-next-line @typescript-eslint/no-require-imports -- нужен сам объект модуля со всеми ключами
|
|
52
|
+
const keysOf = (path: string): string[] => Object.keys(require(path) as object);
|
|
53
|
+
|
|
54
|
+
describe('metrics public API', () => {
|
|
55
|
+
it('exports only DbMetricsConfig from metrics', () => {
|
|
56
|
+
expect(keysOf('./index').sort()).toEqual([...METRICS_VALUES].sort());
|
|
57
|
+
});
|
|
58
|
+
|
|
59
|
+
it('adds only the metrics values to the package root', () => {
|
|
60
|
+
expect(keysOf('../index').sort()).toEqual(
|
|
61
|
+
[...ROOT_VALUES_BEFORE_METRICS, ...METRICS_VALUES].sort(),
|
|
62
|
+
);
|
|
63
|
+
});
|
|
64
|
+
});
|
|
65
|
+
|
|
66
|
+
describe('DbMetricsConfig', () => {
|
|
67
|
+
it('has no own getters or methods besides the constructor', () => {
|
|
68
|
+
expect(
|
|
69
|
+
Object.getOwnPropertyNames(DbMetricsConfig.prototype).filter(
|
|
70
|
+
(name) => name !== 'constructor',
|
|
71
|
+
),
|
|
72
|
+
).toEqual([]);
|
|
73
|
+
});
|
|
74
|
+
});
|
|
75
|
+
|
|
76
|
+
describe('metrics plugin kit', () => {
|
|
77
|
+
it('exports exactly the agreed values', () => {
|
|
78
|
+
expect(keysOf('./plugin-kit').sort()).toEqual(
|
|
79
|
+
[...PLUGIN_KIT_VALUES].sort(),
|
|
80
|
+
);
|
|
81
|
+
});
|
|
82
|
+
|
|
83
|
+
// Значение класса открыло бы статический `create` в обход провайдеров с
|
|
84
|
+
// проверкой `DB_METRICS_ENABLED`; плагину эти классы нужны только как типы
|
|
85
|
+
it('gives no class with a factory that bypasses the providers', () => {
|
|
86
|
+
const kit = keysOf('./plugin-kit');
|
|
87
|
+
|
|
88
|
+
expect(kit).not.toContain('DbClientMetrics');
|
|
89
|
+
expect(kit).not.toContain('EntityOperationsRecorder');
|
|
90
|
+
});
|
|
91
|
+
|
|
92
|
+
it('is not exported from the package root', () => {
|
|
93
|
+
const root = keysOf('../index');
|
|
94
|
+
|
|
95
|
+
for (const name of [
|
|
96
|
+
...PLUGIN_KIT_VALUES,
|
|
97
|
+
'DbClientMetrics',
|
|
98
|
+
'EntityOperationsRecorder',
|
|
99
|
+
'DetachGroup',
|
|
100
|
+
]) {
|
|
101
|
+
expect(root).not.toContain(name);
|
|
102
|
+
}
|
|
103
|
+
});
|
|
104
|
+
});
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
import { ScrapeSourceRegistry } from './scrape-source.registry';
|
|
2
|
+
|
|
3
|
+
const isNumber = (value: unknown): value is number => typeof value === 'number';
|
|
4
|
+
|
|
5
|
+
const one = (): number => 1;
|
|
6
|
+
|
|
7
|
+
describe('ScrapeSourceRegistry', () => {
|
|
8
|
+
it('returns values of all sources', () => {
|
|
9
|
+
const registry = new ScrapeSourceRegistry(isNumber);
|
|
10
|
+
|
|
11
|
+
registry.add(() => 1);
|
|
12
|
+
registry.add(() => 2);
|
|
13
|
+
|
|
14
|
+
expect(registry.snapshots()).toEqual([1, 2]);
|
|
15
|
+
});
|
|
16
|
+
|
|
17
|
+
it('skips a source that throws', () => {
|
|
18
|
+
const registry = new ScrapeSourceRegistry(isNumber);
|
|
19
|
+
|
|
20
|
+
registry.add(() => {
|
|
21
|
+
throw new Error('closed');
|
|
22
|
+
});
|
|
23
|
+
registry.add(() => 2);
|
|
24
|
+
|
|
25
|
+
expect(registry.snapshots()).toEqual([2]);
|
|
26
|
+
});
|
|
27
|
+
|
|
28
|
+
it('skips a value that fails the check', () => {
|
|
29
|
+
const registry = new ScrapeSourceRegistry(isNumber);
|
|
30
|
+
|
|
31
|
+
registry.add(() => '1' as unknown as number);
|
|
32
|
+
registry.add(() => 2);
|
|
33
|
+
|
|
34
|
+
expect(registry.snapshots()).toEqual([2]);
|
|
35
|
+
});
|
|
36
|
+
|
|
37
|
+
it('removes a source on detach, and a repeated detach changes nothing', () => {
|
|
38
|
+
const registry = new ScrapeSourceRegistry(isNumber);
|
|
39
|
+
const detach = registry.add(() => 1);
|
|
40
|
+
|
|
41
|
+
registry.add(() => 2);
|
|
42
|
+
detach();
|
|
43
|
+
detach();
|
|
44
|
+
|
|
45
|
+
expect(registry.snapshots()).toEqual([2]);
|
|
46
|
+
});
|
|
47
|
+
|
|
48
|
+
it('keeps the same source added twice until both are detached', () => {
|
|
49
|
+
const registry = new ScrapeSourceRegistry(isNumber);
|
|
50
|
+
const first = registry.add(one);
|
|
51
|
+
const second = registry.add(one);
|
|
52
|
+
|
|
53
|
+
first();
|
|
54
|
+
expect(registry.snapshots()).toEqual([1]);
|
|
55
|
+
|
|
56
|
+
second();
|
|
57
|
+
expect(registry.snapshots()).toEqual([]);
|
|
58
|
+
});
|
|
59
|
+
});
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
import type { Detach } from './detach';
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Источники значений, которые gauge читает при scrape. Метрики живут на
|
|
5
|
+
* весь процесс, а то, что они показывают (пулы, EntityManager-ы),
|
|
6
|
+
* появляется и исчезает вместе с приложением, поэтому связь между ними
|
|
7
|
+
* держится здесь.
|
|
8
|
+
*
|
|
9
|
+
* Значения отдаются готовыми снимками ({@link ScrapeSourceRegistry.snapshots}):
|
|
10
|
+
* исключение в `collect` отклоняет весь `register.metrics()`, и приложение
|
|
11
|
+
* перестаёт отдавать вообще все метрики. Поэтому источник, который бросил
|
|
12
|
+
* исключение или вернул значение, не прошедшее проверку, просто пропускается
|
|
13
|
+
*/
|
|
14
|
+
export class ScrapeSourceRegistry<T> {
|
|
15
|
+
private readonly sources = new Set<() => unknown>();
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* @param isValid проверка значения источника: что не прошло, в снимки не
|
|
19
|
+
* попадает
|
|
20
|
+
*/
|
|
21
|
+
constructor(private readonly isValid: (value: unknown) => value is T) {}
|
|
22
|
+
|
|
23
|
+
/**
|
|
24
|
+
* @returns detach: убирает источник
|
|
25
|
+
*/
|
|
26
|
+
add(source: () => T): Detach {
|
|
27
|
+
const read = (): unknown => source();
|
|
28
|
+
|
|
29
|
+
this.sources.add(read);
|
|
30
|
+
|
|
31
|
+
return () => {
|
|
32
|
+
this.sources.delete(read);
|
|
33
|
+
};
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
/**
|
|
37
|
+
* Значения всех источников, которые прочитались и прошли проверку
|
|
38
|
+
*/
|
|
39
|
+
snapshots(): T[] {
|
|
40
|
+
const result: T[] = [];
|
|
41
|
+
|
|
42
|
+
for (const read of this.sources) {
|
|
43
|
+
try {
|
|
44
|
+
const value = read();
|
|
45
|
+
if (this.isValid(value)) {
|
|
46
|
+
result.push(value);
|
|
47
|
+
}
|
|
48
|
+
} catch {
|
|
49
|
+
// Без одного источника лучше, чем пустой /metrics у всего приложения
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
return result;
|
|
54
|
+
}
|
|
55
|
+
}
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
import { classifyQuery, extractSqlState, extractSqlText } from './sql';
|
|
2
|
+
|
|
3
|
+
describe('classifyQuery', () => {
|
|
4
|
+
it.each([
|
|
5
|
+
['SELECT * FROM cat', 'SELECT'],
|
|
6
|
+
[' select 1', 'SELECT'],
|
|
7
|
+
['(SELECT 1) UNION (SELECT 2)', 'SELECT'],
|
|
8
|
+
['/* comment */ INSERT INTO cat VALUES (1)', 'INSERT'],
|
|
9
|
+
['-- comment\nUPDATE cat SET name = $1', 'UPDATE'],
|
|
10
|
+
['DELETE FROM cat', 'DELETE'],
|
|
11
|
+
['WITH x AS (SELECT 1) SELECT * FROM x', 'OTHER'],
|
|
12
|
+
['SET TRANSACTION ISOLATION LEVEL SERIALIZABLE', 'OTHER'],
|
|
13
|
+
['SAVEPOINT typeorm_1', 'OTHER'],
|
|
14
|
+
['RELEASE SAVEPOINT typeorm_1', 'OTHER'],
|
|
15
|
+
['', 'OTHER'],
|
|
16
|
+
])('%s → %s', (sql, operation) => {
|
|
17
|
+
expect(classifyQuery(sql)).toEqual({ operation });
|
|
18
|
+
});
|
|
19
|
+
|
|
20
|
+
it.each([
|
|
21
|
+
['BEGIN;', 'BEGIN', 'begin'],
|
|
22
|
+
['BEGIN TRANSACTION ISOLATION LEVEL serializable;', 'BEGIN', 'begin'],
|
|
23
|
+
['START TRANSACTION', 'BEGIN', 'begin'],
|
|
24
|
+
['COMMIT;', 'COMMIT', 'commit'],
|
|
25
|
+
['END', 'COMMIT', 'commit'],
|
|
26
|
+
['ROLLBACK', 'OTHER', 'rollback'],
|
|
27
|
+
['ABORT', 'OTHER', 'rollback'],
|
|
28
|
+
['ABORT WORK', 'OTHER', 'rollback'],
|
|
29
|
+
['abort transaction;', 'OTHER', 'rollback'],
|
|
30
|
+
['COMMIT; -- done\n', 'COMMIT', 'commit'],
|
|
31
|
+
['BEGIN;; /* knex */ ', 'BEGIN', 'begin'],
|
|
32
|
+
])('%s → transaction boundary %s / %s', (sql, operation, boundary) => {
|
|
33
|
+
expect(classifyQuery(sql)).toEqual({ operation, boundary });
|
|
34
|
+
});
|
|
35
|
+
|
|
36
|
+
it.each([
|
|
37
|
+
'BEGIN; SELECT 1; COMMIT',
|
|
38
|
+
'COMMIT; SELECT 1',
|
|
39
|
+
'START TRANSACTION; INSERT INTO cat VALUES (1)',
|
|
40
|
+
'ROLLBACK; BEGIN',
|
|
41
|
+
'ABORT; BEGIN',
|
|
42
|
+
])('%s holds several statements and gives no transaction boundary', (sql) => {
|
|
43
|
+
expect(classifyQuery(sql)).toEqual({ operation: 'OTHER' });
|
|
44
|
+
});
|
|
45
|
+
|
|
46
|
+
it('keeps the operation of a query with a semicolon inside a literal', () => {
|
|
47
|
+
expect(classifyQuery("SELECT 'a;b' FROM cat")).toEqual({
|
|
48
|
+
operation: 'SELECT',
|
|
49
|
+
});
|
|
50
|
+
});
|
|
51
|
+
|
|
52
|
+
it.each([
|
|
53
|
+
'ROLLBACK TO SAVEPOINT trx2',
|
|
54
|
+
'ROLLBACK TRANSACTION TO SAVEPOINT x',
|
|
55
|
+
])('%s does not close the top-level transaction', (sql) => {
|
|
56
|
+
expect(classifyQuery(sql)).toEqual({ operation: 'OTHER' });
|
|
57
|
+
});
|
|
58
|
+
|
|
59
|
+
it('returns OTHER without query text', () => {
|
|
60
|
+
expect(classifyQuery()).toEqual({ operation: 'OTHER' });
|
|
61
|
+
});
|
|
62
|
+
});
|
|
63
|
+
|
|
64
|
+
describe('extractSqlState', () => {
|
|
65
|
+
it.each([
|
|
66
|
+
[{ code: '23505' }, '23505'],
|
|
67
|
+
[{ code: '40P01' }, '40P01'],
|
|
68
|
+
[{ sqlState: '40001' }, '40001'],
|
|
69
|
+
[{ code: 'ECONNRESET' }, 'unknown'],
|
|
70
|
+
[new Error('Query read timeout'), 'unknown'],
|
|
71
|
+
['boom', 'unknown'],
|
|
72
|
+
[null, 'unknown'],
|
|
73
|
+
])('%p → %s', (error, code) => {
|
|
74
|
+
expect(extractSqlState(error)).toBe(code);
|
|
75
|
+
});
|
|
76
|
+
|
|
77
|
+
it.each(['EPIPE', 'EPERM', 'EBADF', 'EBUSY', 'EINTR'])(
|
|
78
|
+
'Node errno code %s → unknown',
|
|
79
|
+
(errno) => {
|
|
80
|
+
expect(extractSqlState({ code: errno })).toBe('unknown');
|
|
81
|
+
expect(extractSqlState({ sqlState: errno })).toBe('unknown');
|
|
82
|
+
},
|
|
83
|
+
);
|
|
84
|
+
|
|
85
|
+
it.each([
|
|
86
|
+
'23505',
|
|
87
|
+
'40P01',
|
|
88
|
+
'57014',
|
|
89
|
+
'08006',
|
|
90
|
+
'P0001',
|
|
91
|
+
'XX000',
|
|
92
|
+
'HV000',
|
|
93
|
+
'F0000',
|
|
94
|
+
'0A000',
|
|
95
|
+
])('passes SQLSTATE %s through as is', (sqlState) => {
|
|
96
|
+
expect(extractSqlState({ code: sqlState })).toBe(sqlState);
|
|
97
|
+
expect(extractSqlState({ sqlState })).toBe(sqlState);
|
|
98
|
+
});
|
|
99
|
+
});
|
|
100
|
+
|
|
101
|
+
describe('extractSqlText', () => {
|
|
102
|
+
it('understands a string, QueryConfig, Cursor and QueryStream', () => {
|
|
103
|
+
expect(extractSqlText('SELECT 1')).toBe('SELECT 1');
|
|
104
|
+
expect(extractSqlText({ text: 'SELECT 2', values: [] })).toBe('SELECT 2');
|
|
105
|
+
expect(extractSqlText({ sql: 'SELECT 3' })).toBe('SELECT 3');
|
|
106
|
+
expect(extractSqlText({ cursor: { text: 'SELECT 4' } })).toBe('SELECT 4');
|
|
107
|
+
expect(extractSqlText({ cursor: null })).toBeUndefined();
|
|
108
|
+
expect(extractSqlText(42)).toBeUndefined();
|
|
109
|
+
});
|
|
110
|
+
});
|
|
@@ -0,0 +1,172 @@
|
|
|
1
|
+
import { isObject } from './guards';
|
|
2
|
+
|
|
3
|
+
export type DbOperation =
|
|
4
|
+
| 'SELECT'
|
|
5
|
+
| 'INSERT'
|
|
6
|
+
| 'UPDATE'
|
|
7
|
+
| 'DELETE'
|
|
8
|
+
| 'BEGIN'
|
|
9
|
+
| 'COMMIT'
|
|
10
|
+
| 'OTHER';
|
|
11
|
+
|
|
12
|
+
export type TransactionBoundary = 'begin' | 'commit' | 'rollback';
|
|
13
|
+
|
|
14
|
+
export interface ClassifiedQuery {
|
|
15
|
+
operation: DbOperation;
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* Граница транзакции верхнего уровня. Для savepoint-ов не заполняется:
|
|
19
|
+
* savepoint не открывает и не закрывает транзакцию в БД
|
|
20
|
+
*/
|
|
21
|
+
boundary?: TransactionBoundary;
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
const LEADING_NOISE = /^(?:\s+|\(+|--[^\n]*(?:\n|$)|\/\*[\s\S]*?\*\/)*/;
|
|
25
|
+
const FIRST_WORDS = /^([a-z]+)(?:\s+([a-z]+))?(?:\s+([a-z]+))?/i;
|
|
26
|
+
|
|
27
|
+
/**
|
|
28
|
+
* Пробелы, комментарии и лишние `;` — то, что может стоять после
|
|
29
|
+
* единственного оператора и не делает строку многооператорной. Без якоря
|
|
30
|
+
* `$`: совпадение всегда находится, и движку не приходится перебирать
|
|
31
|
+
* варианты на длинной строке
|
|
32
|
+
*/
|
|
33
|
+
const TRAILING_NOISE = /^(?:\s+|;|--[^\n]*(?:\n|$)|\/\*[\s\S]*?\*\/)*/;
|
|
34
|
+
|
|
35
|
+
const SIMPLE_OPERATIONS: Record<string, DbOperation> = {
|
|
36
|
+
SELECT: 'SELECT',
|
|
37
|
+
INSERT: 'INSERT',
|
|
38
|
+
UPDATE: 'UPDATE',
|
|
39
|
+
DELETE: 'DELETE',
|
|
40
|
+
};
|
|
41
|
+
|
|
42
|
+
/**
|
|
43
|
+
* После первого `;` в строке есть ещё оператор. Проверяется только для
|
|
44
|
+
* границ транзакции: в их тексте нет строковых литералов, где `;` мог бы
|
|
45
|
+
* стоять внутри одного оператора
|
|
46
|
+
*/
|
|
47
|
+
const hasMoreStatements = (sql: string): boolean => {
|
|
48
|
+
const end = sql.indexOf(';');
|
|
49
|
+
|
|
50
|
+
return end !== -1 && sql.slice(end + 1).replace(TRAILING_NOISE, '') !== '';
|
|
51
|
+
};
|
|
52
|
+
|
|
53
|
+
/**
|
|
54
|
+
* Граница транзакции по первым словам оператора
|
|
55
|
+
*/
|
|
56
|
+
const classifyBoundary = (
|
|
57
|
+
first: string,
|
|
58
|
+
second: string,
|
|
59
|
+
third: string,
|
|
60
|
+
): ClassifiedQuery | undefined => {
|
|
61
|
+
switch (first) {
|
|
62
|
+
case 'BEGIN':
|
|
63
|
+
return { operation: 'BEGIN', boundary: 'begin' };
|
|
64
|
+
case 'START':
|
|
65
|
+
return second === 'TRANSACTION'
|
|
66
|
+
? { operation: 'BEGIN', boundary: 'begin' }
|
|
67
|
+
: undefined;
|
|
68
|
+
case 'COMMIT':
|
|
69
|
+
case 'END':
|
|
70
|
+
return { operation: 'COMMIT', boundary: 'commit' };
|
|
71
|
+
case 'ROLLBACK':
|
|
72
|
+
// ROLLBACK TO [SAVEPOINT] x откатывает только вложенную транзакцию
|
|
73
|
+
return second === 'TO' || third === 'TO'
|
|
74
|
+
? undefined
|
|
75
|
+
: { operation: 'OTHER', boundary: 'rollback' };
|
|
76
|
+
case 'ABORT':
|
|
77
|
+
// Синоним ROLLBACK в PostgreSQL, формы с TO SAVEPOINT у него нет
|
|
78
|
+
return { operation: 'OTHER', boundary: 'rollback' };
|
|
79
|
+
default:
|
|
80
|
+
return undefined;
|
|
81
|
+
}
|
|
82
|
+
};
|
|
83
|
+
|
|
84
|
+
/**
|
|
85
|
+
* Определяет тип запроса по первому ключевому слову.
|
|
86
|
+
* `WITH ...` относится к OTHER: по началу запроса не понять, читает он или пишет.
|
|
87
|
+
*
|
|
88
|
+
* Граница транзакции (`BEGIN`/`START TRANSACTION`, `COMMIT`/`END`,
|
|
89
|
+
* `ROLLBACK`/`ABORT`) учитывается, только если это единственный оператор
|
|
90
|
+
* в строке; `BEGIN;` от knex — один оператор. В строке из нескольких
|
|
91
|
+
* операторов (`BEGIN; …; COMMIT`) видно только начало, а чем всё кончилось
|
|
92
|
+
* на сервере, неизвестно, поэтому такая строка — OTHER без границы:
|
|
93
|
+
* транзакция не учитывается, но и не остаётся открытой в метриках
|
|
94
|
+
*/
|
|
95
|
+
export const classifyQuery = (sql?: string): ClassifiedQuery => {
|
|
96
|
+
if (!sql) {
|
|
97
|
+
return { operation: 'OTHER' };
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
const statement = sql.replace(LEADING_NOISE, '');
|
|
101
|
+
const words = FIRST_WORDS.exec(statement);
|
|
102
|
+
if (!words) {
|
|
103
|
+
return { operation: 'OTHER' };
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
const [, first = '', second = '', third = ''] = words.map((x) =>
|
|
107
|
+
x?.toUpperCase(),
|
|
108
|
+
);
|
|
109
|
+
|
|
110
|
+
const simple = SIMPLE_OPERATIONS[first];
|
|
111
|
+
if (simple) {
|
|
112
|
+
return { operation: simple };
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
const boundary = classifyBoundary(first, second, third);
|
|
116
|
+
if (!boundary || hasMoreStatements(statement)) {
|
|
117
|
+
return { operation: 'OTHER' };
|
|
118
|
+
}
|
|
119
|
+
|
|
120
|
+
return boundary;
|
|
121
|
+
};
|
|
122
|
+
|
|
123
|
+
// Ни один класс SQLSTATE в Postgres не начинается с `E`, а коды errno Node
|
|
124
|
+
// (`EPIPE`, `EPERM`, `EBADF`) начинаются. Без этого исключения они проходили
|
|
125
|
+
// бы как SQLSTATE
|
|
126
|
+
const SQLSTATE = /^[\dA-DF-Z][\dA-Z]{4}$/;
|
|
127
|
+
|
|
128
|
+
/**
|
|
129
|
+
* SQLSTATE из ошибки драйвера: `code` у pg, `sqlState` у pg-native.
|
|
130
|
+
* Всё остальное (таймауты клиента, обрыв сокета) сводится к `unknown`,
|
|
131
|
+
* чтобы не плодить значения лейбла
|
|
132
|
+
*/
|
|
133
|
+
export const extractSqlState = (error: unknown): string => {
|
|
134
|
+
if (!isObject(error)) {
|
|
135
|
+
return 'unknown';
|
|
136
|
+
}
|
|
137
|
+
|
|
138
|
+
for (const candidate of [error.code, error.sqlState]) {
|
|
139
|
+
if (typeof candidate === 'string' && SQLSTATE.test(candidate)) {
|
|
140
|
+
return candidate;
|
|
141
|
+
}
|
|
142
|
+
}
|
|
143
|
+
|
|
144
|
+
return 'unknown';
|
|
145
|
+
};
|
|
146
|
+
|
|
147
|
+
/**
|
|
148
|
+
* Текст запроса из аргумента `client.query()`: строка, `QueryConfig`
|
|
149
|
+
* с полем `text` (или `sql`), Cursor с полем `text` или QueryStream,
|
|
150
|
+
* у которого текст лежит в `cursor.text`
|
|
151
|
+
*/
|
|
152
|
+
export const extractSqlText = (arg: unknown): string | undefined => {
|
|
153
|
+
if (typeof arg === 'string') {
|
|
154
|
+
return arg;
|
|
155
|
+
}
|
|
156
|
+
|
|
157
|
+
if (isObject(arg)) {
|
|
158
|
+
const { text, sql, cursor } = arg;
|
|
159
|
+
|
|
160
|
+
for (const candidate of [
|
|
161
|
+
text,
|
|
162
|
+
sql,
|
|
163
|
+
isObject(cursor) ? cursor.text : undefined,
|
|
164
|
+
]) {
|
|
165
|
+
if (typeof candidate === 'string') {
|
|
166
|
+
return candidate;
|
|
167
|
+
}
|
|
168
|
+
}
|
|
169
|
+
}
|
|
170
|
+
|
|
171
|
+
return undefined;
|
|
172
|
+
};
|