@rsdk/db.knex 2.5.1
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/.env +3 -0
- package/CHANGELOG.md +155 -0
- package/README.md +11 -0
- package/dist/index.d.ts +9 -0
- package/dist/index.js +15 -0
- package/dist/index.js.map +1 -0
- package/dist/inject-knex.decorator.d.ts +2 -0
- package/dist/inject-knex.decorator.js +8 -0
- package/dist/inject-knex.decorator.js.map +1 -0
- package/dist/internal/context.d.ts +77 -0
- package/dist/internal/context.js +220 -0
- package/dist/internal/context.js.map +1 -0
- package/dist/internal/exceptions.d.ts +65 -0
- package/dist/internal/exceptions.js +94 -0
- package/dist/internal/exceptions.js.map +1 -0
- package/dist/internal/initializer.d.ts +9 -0
- package/dist/internal/initializer.js +42 -0
- package/dist/internal/initializer.js.map +1 -0
- package/dist/internal/strategy.d.ts +18 -0
- package/dist/internal/strategy.js +75 -0
- package/dist/internal/strategy.js.map +1 -0
- package/dist/internal/test/strategy.test.e2e.d.ts +1 -0
- package/dist/internal/test/strategy.test.e2e.js +762 -0
- package/dist/internal/test/strategy.test.e2e.js.map +1 -0
- package/dist/internal/test/utils.d.ts +17 -0
- package/dist/internal/test/utils.js +21 -0
- package/dist/internal/test/utils.js.map +1 -0
- package/dist/knex.module.d.ts +5 -0
- package/dist/knex.module.js +34 -0
- package/dist/knex.module.js.map +1 -0
- package/dist/knex.plugin.d.ts +10 -0
- package/dist/knex.plugin.js +20 -0
- package/dist/knex.plugin.js.map +1 -0
- package/dist/providers/index.d.ts +4 -0
- package/dist/providers/index.js +21 -0
- package/dist/providers/index.js.map +1 -0
- package/dist/providers/knex-logger.adapter.d.ts +10 -0
- package/dist/providers/knex-logger.adapter.js +45 -0
- package/dist/providers/knex-logger.adapter.js.map +1 -0
- package/dist/providers/knex.config.d.ts +10 -0
- package/dist/providers/knex.config.js +76 -0
- package/dist/providers/knex.config.js.map +1 -0
- package/dist/providers/knex.factory.d.ts +13 -0
- package/dist/providers/knex.factory.js +96 -0
- package/dist/providers/knex.factory.js.map +1 -0
- package/dist/providers/knex.indicator.d.ts +8 -0
- package/dist/providers/knex.indicator.js +41 -0
- package/dist/providers/knex.indicator.js.map +1 -0
- package/dist/types.d.ts +12 -0
- package/dist/types.js +20 -0
- package/dist/types.js.map +1 -0
- package/jest.config.js +8 -0
- package/package.json +26 -0
- package/src/index.ts +10 -0
- package/src/inject-knex.decorator.ts +6 -0
- package/src/internal/context.ts +284 -0
- package/src/internal/exceptions.ts +91 -0
- package/src/internal/initializer.ts +43 -0
- package/src/internal/strategy.ts +116 -0
- package/src/internal/test/strategy.test.e2e.ts +1026 -0
- package/src/internal/test/utils.ts +26 -0
- package/src/knex.module.ts +28 -0
- package/src/knex.plugin.ts +21 -0
- package/src/providers/index.ts +4 -0
- package/src/providers/knex-logger.adapter.ts +32 -0
- package/src/providers/knex.config.ts +57 -0
- package/src/providers/knex.factory.ts +83 -0
- package/src/providers/knex.indicator.ts +22 -0
- package/src/types.ts +21 -0
- package/tsconfig.json +11 -0
package/.env
ADDED
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,155 @@
|
|
|
1
|
+
# Change Log
|
|
2
|
+
|
|
3
|
+
All notable changes to this project will be documented in this file.
|
|
4
|
+
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
|
+
|
|
6
|
+
## [2.5.1](https://github.com/R-Vision/rsdk/compare/v2.5.0...v2.5.1) (2023-09-25)
|
|
7
|
+
|
|
8
|
+
**Note:** Version bump only for package @rsdk/db.knex
|
|
9
|
+
|
|
10
|
+
# [2.5.0](https://github.com/R-Vision/rsdk/compare/v2.4.4-next.0...v2.5.0) (2023-06-23)
|
|
11
|
+
|
|
12
|
+
**Note:** Version bump only for package @rsdk/db.knex
|
|
13
|
+
|
|
14
|
+
## [2.4.4-next.0](https://github.com/R-Vision/rsdk/compare/v2.4.3...v2.4.4-next.0) (2023-06-22)
|
|
15
|
+
|
|
16
|
+
**Note:** Version bump only for package @rsdk/db.knex
|
|
17
|
+
|
|
18
|
+
## [2.4.3](https://github.com/R-Vision/rsdk/compare/v2.4.3-next.0...v2.4.3) (2023-06-21)
|
|
19
|
+
|
|
20
|
+
**Note:** Version bump only for package @rsdk/db.knex
|
|
21
|
+
|
|
22
|
+
## [2.4.3-next.0](https://github.com/R-Vision/rsdk/compare/v2.4.2...v2.4.3-next.0) (2023-06-21)
|
|
23
|
+
|
|
24
|
+
**Note:** Version bump only for package @rsdk/db.knex
|
|
25
|
+
|
|
26
|
+
## [2.4.2](https://github.com/R-Vision/rsdk/compare/v2.4.2-next.0...v2.4.2) (2023-06-16)
|
|
27
|
+
|
|
28
|
+
**Note:** Version bump only for package @rsdk/db.knex
|
|
29
|
+
|
|
30
|
+
## [2.4.2-next.0](https://github.com/R-Vision/rsdk/compare/v2.4.1...v2.4.2-next.0) (2023-06-15)
|
|
31
|
+
|
|
32
|
+
### Bug Fixes
|
|
33
|
+
|
|
34
|
+
* **eslint-plugin:** normalize tsconfig.lint.json ([25d77cd](https://github.com/R-Vision/rsdk/commit/25d77cd69206fa6e1c79ba6ae27ee89276b0cfa2))
|
|
35
|
+
|
|
36
|
+
## [2.4.1](https://github.com/R-Vision/rsdk/compare/v2.4.1-next.2...v2.4.1) (2023-06-15)
|
|
37
|
+
|
|
38
|
+
**Note:** Version bump only for package @rsdk/db.knex
|
|
39
|
+
|
|
40
|
+
## [2.4.1-next.2](https://github.com/R-Vision/rsdk/compare/v2.4.1-next.1...v2.4.1-next.2) (2023-06-15)
|
|
41
|
+
|
|
42
|
+
**Note:** Version bump only for package @rsdk/db.knex
|
|
43
|
+
|
|
44
|
+
## [2.4.1-next.1](https://github.com/R-Vision/rsdk/compare/v2.4.1-next.0...v2.4.1-next.1) (2023-06-15)
|
|
45
|
+
|
|
46
|
+
**Note:** Version bump only for package @rsdk/db.knex
|
|
47
|
+
|
|
48
|
+
## [2.4.1-next.0](https://github.com/R-Vision/rsdk/compare/v2.4.0...v2.4.1-next.0) (2023-06-15)
|
|
49
|
+
|
|
50
|
+
**Note:** Version bump only for package @rsdk/db.knex
|
|
51
|
+
|
|
52
|
+
# [2.4.0](https://github.com/R-Vision/rsdk/compare/v2.3.1...v2.4.0) (2023-06-15)
|
|
53
|
+
|
|
54
|
+
**Note:** Version bump only for package @rsdk/db.knex
|
|
55
|
+
|
|
56
|
+
## [2.3.1](https://github.com/R-Vision/rsdk/compare/v2.3.0...v2.3.1) (2023-06-08)
|
|
57
|
+
|
|
58
|
+
**Note:** Version bump only for package @rsdk/db.knex
|
|
59
|
+
|
|
60
|
+
# [2.1.0](https://github.com/R-Vision/rsdk/compare/v2.0.0...v2.1.0) (2023-06-06)
|
|
61
|
+
|
|
62
|
+
**Note:** Version bump only for package @rsdk/db.knex
|
|
63
|
+
|
|
64
|
+
# [2.0.0](https://github.com/R-Vision/rsdk/compare/v1.0.12...v2.0.0) (2023-06-06)
|
|
65
|
+
|
|
66
|
+
### Draft
|
|
67
|
+
|
|
68
|
+
* Pfm 303 static to meta migration ([#45](https://github.com/R-Vision/rsdk/issues/45)) ([d98e303](https://github.com/R-Vision/rsdk/commit/d98e3032f9b10446b478427d841b9209ed68fa2d))
|
|
69
|
+
|
|
70
|
+
### BREAKING CHANGES
|
|
71
|
+
|
|
72
|
+
* GrpcClientModule removed
|
|
73
|
+
new way for declaration with `GrpcServers.define()` and `@InjectGrpcClient`
|
|
74
|
+
|
|
75
|
+
* fix: rework interaction with metadata and generating modules from metadata
|
|
76
|
+
|
|
77
|
+
* refactor: destructring added
|
|
78
|
+
|
|
79
|
+
* docs: added docs for autodoc pre-commit hook
|
|
80
|
+
|
|
81
|
+
* chore: spell fix
|
|
82
|
+
|
|
83
|
+
* chore: some improves declaration
|
|
84
|
+
|
|
85
|
+
* chore: laconic naming for constants
|
|
86
|
+
|
|
87
|
+
* chore: remove useless
|
|
88
|
+
|
|
89
|
+
* chore: move file to suitable place
|
|
90
|
+
|
|
91
|
+
* chore: remove useless imports
|
|
92
|
+
|
|
93
|
+
* chore!: remove boostrap tasks from Makefile
|
|
94
|
+
|
|
95
|
+
* chore: rework test tasks
|
|
96
|
+
|
|
97
|
+
* feat: grpc client plugin useless
|
|
98
|
+
|
|
99
|
+
* chore: verbosed naming
|
|
100
|
+
|
|
101
|
+
* docs: improve verbosity
|
|
102
|
+
|
|
103
|
+
## 1.0.12 (2023-05-23)
|
|
104
|
+
|
|
105
|
+
### Bug Fixes
|
|
106
|
+
|
|
107
|
+
* remove private dependencies from `peerDependencies` section ([0bce6ff](https://github.com/R-Vision/rsdk/commit/0bce6ffb5b699e2ed1dc9aca77cbdbf085267ff7))
|
|
108
|
+
|
|
109
|
+
## 1.0.11 (2023-05-23)
|
|
110
|
+
|
|
111
|
+
**Note:** Version bump only for package @rsdk/db.knex
|
|
112
|
+
|
|
113
|
+
## 1.0.10 (2023-05-22)
|
|
114
|
+
|
|
115
|
+
### Bug Fixes
|
|
116
|
+
|
|
117
|
+
* add "access: public" to new packages ([04d5983](https://github.com/R-Vision/rsdk/commit/04d5983cfa3e97c5d8219e07208a0499a8c6bc83))
|
|
118
|
+
|
|
119
|
+
## 1.0.9 (2023-05-21)
|
|
120
|
+
|
|
121
|
+
**Note:** Version bump only for package @rsdk/db.knex
|
|
122
|
+
|
|
123
|
+
## 1.0.8 (2023-05-17)
|
|
124
|
+
|
|
125
|
+
**Note:** Version bump only for package @rsdk/db.knex
|
|
126
|
+
|
|
127
|
+
## 1.0.7 (2023-05-11)
|
|
128
|
+
|
|
129
|
+
**Note:** Version bump only for package @rsdk/db.knex
|
|
130
|
+
|
|
131
|
+
## 1.0.6 (2023-05-11)
|
|
132
|
+
|
|
133
|
+
**Note:** Version bump only for package @rsdk/db.knex
|
|
134
|
+
|
|
135
|
+
## 1.0.5 (2023-05-10)
|
|
136
|
+
|
|
137
|
+
**Note:** Version bump only for package @rsdk/db.knex
|
|
138
|
+
|
|
139
|
+
## 1.0.4 (2023-05-10)
|
|
140
|
+
|
|
141
|
+
**Note:** Version bump only for package @rsdk/db.knex
|
|
142
|
+
|
|
143
|
+
## 1.0.3 (2023-05-10)
|
|
144
|
+
|
|
145
|
+
### Bug Fixes
|
|
146
|
+
|
|
147
|
+
* builtin make not private in npm ([50c83b6](https://github.com/R-Vision/rsdk/commit/50c83b6454f9a89f1e99d3b33a497ce2c029d8c6))
|
|
148
|
+
|
|
149
|
+
## 1.0.2 (2023-05-10)
|
|
150
|
+
|
|
151
|
+
**Note:** Version bump only for package @rsdk/db.knex
|
|
152
|
+
|
|
153
|
+
## 1.0.1 (2023-05-07)
|
|
154
|
+
|
|
155
|
+
**Note:** Version bump only for package @rsdk/db.knex
|
package/README.md
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
Каждый db пакет должен реализовывать следующие функции:
|
|
2
|
+
|
|
3
|
+
- [x] интеграция с нестовым DI контейнером
|
|
4
|
+
- [x] интеграция платформенной системой конфигурации
|
|
5
|
+
- [x] интеграция с платформенной системой хелсчеков
|
|
6
|
+
- [ ] {не отлажено} интеграция с платформенной системой логирования
|
|
7
|
+
- [ ] {проверить} реконнекты (infinite retry)
|
|
8
|
+
- [ ] декларативную транзакционность (декоратор Transactional)
|
|
9
|
+
- [ ] оформить это в виде плагина (PlatformAppPlugin)
|
|
10
|
+
|
|
11
|
+
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { TransactionRunner } from '@rsdk/db';
|
|
2
|
+
export { KnexPlugin } from './knex.plugin';
|
|
3
|
+
export { InjectKnex, KNEX_INJECTION_TOKEN } from './inject-knex.decorator';
|
|
4
|
+
export { IsolationLevel } from './types';
|
|
5
|
+
export declare const Runner: TransactionRunner<import("./types").IsolationLevel, import("./internal/context").KnexContext>;
|
|
6
|
+
export declare const Transactional: (payload?: {
|
|
7
|
+
isolation?: import("./types").IsolationLevel;
|
|
8
|
+
propagation?: import("@rsdk/db").Propagation;
|
|
9
|
+
} | undefined) => MethodDecorator;
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.Transactional = exports.Runner = exports.IsolationLevel = exports.KNEX_INJECTION_TOKEN = exports.InjectKnex = exports.KnexPlugin = void 0;
|
|
4
|
+
const db_1 = require("@rsdk/db");
|
|
5
|
+
const strategy_1 = require("./internal/strategy");
|
|
6
|
+
var knex_plugin_1 = require("./knex.plugin");
|
|
7
|
+
Object.defineProperty(exports, "KnexPlugin", { enumerable: true, get: function () { return knex_plugin_1.KnexPlugin; } });
|
|
8
|
+
var inject_knex_decorator_1 = require("./inject-knex.decorator");
|
|
9
|
+
Object.defineProperty(exports, "InjectKnex", { enumerable: true, get: function () { return inject_knex_decorator_1.InjectKnex; } });
|
|
10
|
+
Object.defineProperty(exports, "KNEX_INJECTION_TOKEN", { enumerable: true, get: function () { return inject_knex_decorator_1.KNEX_INJECTION_TOKEN; } });
|
|
11
|
+
var types_1 = require("./types");
|
|
12
|
+
Object.defineProperty(exports, "IsolationLevel", { enumerable: true, get: function () { return types_1.IsolationLevel; } });
|
|
13
|
+
exports.Runner = new db_1.TransactionRunner(new strategy_1.KnexTransactionalStrategy());
|
|
14
|
+
exports.Transactional = exports.Runner.Transactional.bind(exports.Runner);
|
|
15
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,iCAA6C;AAE7C,kDAAgE;AAEhE,6CAA2C;AAAlC,yGAAA,UAAU,OAAA;AACnB,iEAA2E;AAAlE,mHAAA,UAAU,OAAA;AAAE,6HAAA,oBAAoB,OAAA;AACzC,iCAAyC;AAAhC,uGAAA,cAAc,OAAA;AAEV,QAAA,MAAM,GAAG,IAAI,sBAAiB,CAAC,IAAI,oCAAyB,EAAE,CAAC,CAAC;AAChE,QAAA,aAAa,GAAG,cAAM,CAAC,aAAa,CAAC,IAAI,CAAC,cAAM,CAAC,CAAC"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.InjectKnex = exports.KNEX_INJECTION_TOKEN = void 0;
|
|
4
|
+
const common_1 = require("@nestjs/common");
|
|
5
|
+
exports.KNEX_INJECTION_TOKEN = Symbol('Knex');
|
|
6
|
+
const InjectKnex = () => (0, common_1.Inject)(exports.KNEX_INJECTION_TOKEN);
|
|
7
|
+
exports.InjectKnex = InjectKnex;
|
|
8
|
+
//# sourceMappingURL=inject-knex.decorator.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"inject-knex.decorator.js","sourceRoot":"","sources":["../src/inject-knex.decorator.ts"],"names":[],"mappings":";;;AAAA,2CAAwC;AAE3B,QAAA,oBAAoB,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;AAE5C,MAAM,UAAU,GAAG,GAAuB,EAAE,CACjD,IAAA,eAAM,EAAC,4BAAoB,CAAC,CAAC;AADlB,QAAA,UAAU,cACQ"}
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
import { BaseContext } from '@rsdk/db';
|
|
2
|
+
import type { Knex } from 'knex';
|
|
3
|
+
import type { IsolationLevel } from '../types';
|
|
4
|
+
export type KnexRunner = {
|
|
5
|
+
connection: any;
|
|
6
|
+
builder: Knex;
|
|
7
|
+
client: Knex;
|
|
8
|
+
run(...args: any[]): Promise<any>;
|
|
9
|
+
};
|
|
10
|
+
export declare class KnexContext extends BaseContext<IsolationLevel> {
|
|
11
|
+
readonly isolationLevels: readonly IsolationLevel[];
|
|
12
|
+
/**
|
|
13
|
+
* Завершена ли работа с этим контекстом
|
|
14
|
+
* Необходимо для контроля за тем чтобы не было переиспользований этого контекста
|
|
15
|
+
* @private
|
|
16
|
+
*/
|
|
17
|
+
private _isReleased;
|
|
18
|
+
/**
|
|
19
|
+
* Массив слоёв в котором каждый trx и runner соответствует вложенности
|
|
20
|
+
* Необходимо для поддержки savepoint
|
|
21
|
+
* @private
|
|
22
|
+
*/
|
|
23
|
+
private layers;
|
|
24
|
+
/**
|
|
25
|
+
* Глубина вложенности
|
|
26
|
+
* Не путать с индексом вложенности
|
|
27
|
+
* По сути является необходимым количеством проинициализированных слоев
|
|
28
|
+
* @private
|
|
29
|
+
*/
|
|
30
|
+
private nestDepth;
|
|
31
|
+
private constructor();
|
|
32
|
+
private constructor();
|
|
33
|
+
get isReleased(): boolean;
|
|
34
|
+
/**
|
|
35
|
+
* Служебная функция для проверки проинициализирована ли транзакция.
|
|
36
|
+
* Не касается статуса инициализации текущего уровня вложенности
|
|
37
|
+
* @private
|
|
38
|
+
*/
|
|
39
|
+
get transactionInitialized(): boolean;
|
|
40
|
+
static create(isolationLevel: IsolationLevel): KnexContext;
|
|
41
|
+
/**
|
|
42
|
+
* Создаёт инстанс контекста, который обеспечит изоляцию от внешнего контекста
|
|
43
|
+
* Прежде всего необходимо для имплементации NOT_SUPPORTED propagation
|
|
44
|
+
*/
|
|
45
|
+
static createSuspended(): KnexContext;
|
|
46
|
+
/**
|
|
47
|
+
* Создаём новый runner для запуска метода `run`
|
|
48
|
+
* Необходимо из-за того что builder определяется при создании `runner`
|
|
49
|
+
* @param knexRunner
|
|
50
|
+
*/
|
|
51
|
+
createContextRunner(knexRunner: KnexRunner): KnexRunner | undefined;
|
|
52
|
+
/**
|
|
53
|
+
* Метод инициализирует необходимые слои для корректной работы savepoint
|
|
54
|
+
* @param settledRunner
|
|
55
|
+
*/
|
|
56
|
+
initialize(settledRunner: KnexRunner): Promise<void>;
|
|
57
|
+
/**
|
|
58
|
+
* Должен быть вызван перед тем как запускать функцию, подразумевающую вложенный уровень транзакционности
|
|
59
|
+
*/
|
|
60
|
+
addNestLayer(): void;
|
|
61
|
+
rollbackTransaction(): Promise<void>;
|
|
62
|
+
commitTransaction(): Promise<void>;
|
|
63
|
+
/**
|
|
64
|
+
* Завершает обработку вложенности
|
|
65
|
+
* @param mustRelease должны ли быть все транзакции завершены, а соединение возвращено в пул
|
|
66
|
+
*/
|
|
67
|
+
finalize(mustRelease: boolean): void;
|
|
68
|
+
/**
|
|
69
|
+
* Проинициализированы ли все необходимые слои транзакций
|
|
70
|
+
* Необходимо для тестов и внутренних процессов
|
|
71
|
+
*/
|
|
72
|
+
isInitialized(): boolean;
|
|
73
|
+
/**
|
|
74
|
+
* Можно ли начать использовать этот контекст
|
|
75
|
+
*/
|
|
76
|
+
assertStart(): void;
|
|
77
|
+
}
|
|
@@ -0,0 +1,220 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.KnexContext = void 0;
|
|
7
|
+
/* eslint-disable @typescript-eslint/ban-ts-comment */
|
|
8
|
+
const db_1 = require("@rsdk/db");
|
|
9
|
+
/**
|
|
10
|
+
ts-ignore потому что в тайпингах этого нет, а тайпингов нет потому что knex ~~говно~~ написан на js, и тайпинги написаны руками,
|
|
11
|
+
руками которые не написали тайпинги для внутренних вещей
|
|
12
|
+
*/
|
|
13
|
+
// @ts-ignore
|
|
14
|
+
const runner_1 = __importDefault(require("knex/lib/execution/runner"));
|
|
15
|
+
// @ts-ignore
|
|
16
|
+
const make_knex_1 = __importDefault(require("knex/lib/knex-builder/make-knex"));
|
|
17
|
+
const types_1 = require("../types");
|
|
18
|
+
const exceptions_1 = require("./exceptions");
|
|
19
|
+
class KnexContext extends db_1.BaseContext {
|
|
20
|
+
isolationLevels = types_1.isolationLevels;
|
|
21
|
+
/**
|
|
22
|
+
* Завершена ли работа с этим контекстом
|
|
23
|
+
* Необходимо для контроля за тем чтобы не было переиспользований этого контекста
|
|
24
|
+
* @private
|
|
25
|
+
*/
|
|
26
|
+
_isReleased = false;
|
|
27
|
+
/**
|
|
28
|
+
* Массив слоёв в котором каждый trx и runner соответствует вложенности
|
|
29
|
+
* Необходимо для поддержки savepoint
|
|
30
|
+
* @private
|
|
31
|
+
*/
|
|
32
|
+
layers = [];
|
|
33
|
+
/**
|
|
34
|
+
* Глубина вложенности
|
|
35
|
+
* Не путать с индексом вложенности
|
|
36
|
+
* По сути является необходимым количеством проинициализированных слоев
|
|
37
|
+
* @private
|
|
38
|
+
*/
|
|
39
|
+
nestDepth = 1;
|
|
40
|
+
constructor(arg) {
|
|
41
|
+
super(arg ?? types_1.DEFAULT_ISOLATION_LEVEL);
|
|
42
|
+
}
|
|
43
|
+
get isReleased() {
|
|
44
|
+
return this._isReleased;
|
|
45
|
+
}
|
|
46
|
+
/**
|
|
47
|
+
* Служебная функция для проверки проинициализирована ли транзакция.
|
|
48
|
+
* Не касается статуса инициализации текущего уровня вложенности
|
|
49
|
+
* @private
|
|
50
|
+
*/
|
|
51
|
+
get transactionInitialized() {
|
|
52
|
+
return Boolean(this.layers.at(0)?.trx?.isTransaction);
|
|
53
|
+
}
|
|
54
|
+
static create(isolationLevel) {
|
|
55
|
+
return new KnexContext(isolationLevel);
|
|
56
|
+
}
|
|
57
|
+
/**
|
|
58
|
+
* Создаёт инстанс контекста, который обеспечит изоляцию от внешнего контекста
|
|
59
|
+
* Прежде всего необходимо для имплементации NOT_SUPPORTED propagation
|
|
60
|
+
*/
|
|
61
|
+
static createSuspended() {
|
|
62
|
+
return new KnexContext(true);
|
|
63
|
+
}
|
|
64
|
+
/**
|
|
65
|
+
* Создаём новый runner для запуска метода `run`
|
|
66
|
+
* Необходимо из-за того что builder определяется при создании `runner`
|
|
67
|
+
* @param knexRunner
|
|
68
|
+
*/
|
|
69
|
+
createContextRunner(knexRunner) {
|
|
70
|
+
const layer = this.layers.at(this.nestDepth - 1);
|
|
71
|
+
if (!layer) {
|
|
72
|
+
throw new exceptions_1.LayerMustBeInitialized();
|
|
73
|
+
}
|
|
74
|
+
const transactionRunner = new runner_1.default(layer.trx.client, knexRunner.builder);
|
|
75
|
+
/**
|
|
76
|
+
* Для того чтобы он точно использовал подключение уже существующего queryRunner, а не пытался его проинициализировать
|
|
77
|
+
* https://github.com/knex/knex/blob/42b91980b7de281a4c53910f9af32da4462a9c5a/lib/execution/runner.js#L30
|
|
78
|
+
* https://github.com/knex/knex/blob/42b91980b7de281a4c53910f9af32da4462a9c5a/lib/execution/runner.js#L281
|
|
79
|
+
*
|
|
80
|
+
* Такой же хак используется в самом knex
|
|
81
|
+
* https://github.com/knex/knex/blob/42b91980b7de281a4c53910f9af32da4462a9c5a/lib/execution/runner.js#L246
|
|
82
|
+
*
|
|
83
|
+
* Не думаю что есть повод беспокоиться о том что runner может взять подключение у builder, это делается форсировано самим пользователем,
|
|
84
|
+
* по крайней мере на данный момент я не нашёл использования этого внутри `knex`
|
|
85
|
+
*/
|
|
86
|
+
transactionRunner.connection = layer.runner.connection;
|
|
87
|
+
return transactionRunner;
|
|
88
|
+
}
|
|
89
|
+
/**
|
|
90
|
+
* Метод инициализирует необходимые слои для корректной работы savepoint
|
|
91
|
+
* @param settledRunner
|
|
92
|
+
*/
|
|
93
|
+
async initialize(settledRunner) {
|
|
94
|
+
if (this.suspended) {
|
|
95
|
+
if (this.layers.length === 1) {
|
|
96
|
+
return;
|
|
97
|
+
}
|
|
98
|
+
const trx = (0, make_knex_1.default)(settledRunner.client);
|
|
99
|
+
const runner = new runner_1.default(trx.client,
|
|
100
|
+
/**
|
|
101
|
+
* Билдер в данном случае не имеет принципиального значения, сделано больше для соблюдения API, практического значения не имеет
|
|
102
|
+
*/
|
|
103
|
+
settledRunner.builder);
|
|
104
|
+
this.layers = [
|
|
105
|
+
{
|
|
106
|
+
trx: trx,
|
|
107
|
+
runner: runner,
|
|
108
|
+
},
|
|
109
|
+
];
|
|
110
|
+
}
|
|
111
|
+
/**
|
|
112
|
+
* Получаем необходимое для инициализации количество слоёв,
|
|
113
|
+
* То есть количество вложенностей которое нам необходимо проинициализировать
|
|
114
|
+
*/
|
|
115
|
+
const requiredLayerCount = this.nestDepth - this.layers.length;
|
|
116
|
+
for (let i = 0; i < requiredLayerCount; i++) {
|
|
117
|
+
const trx =
|
|
118
|
+
/**
|
|
119
|
+
* Если до этого транзакция уже была проинициализирована, то используем существующей trx для создания `savepoint`
|
|
120
|
+
*/
|
|
121
|
+
this.layers.at(-1)?.trx ??
|
|
122
|
+
/**
|
|
123
|
+
* Создаём новый инстанс knex для начала нашей транзакции
|
|
124
|
+
* Элегантного способа использовать существующий нет ни возможности, ни практического смысла
|
|
125
|
+
*/
|
|
126
|
+
(0, make_knex_1.default)(settledRunner.client);
|
|
127
|
+
/**
|
|
128
|
+
* Если транзакции ещё не было, создаст её,
|
|
129
|
+
* иначе создаст `savepoint`
|
|
130
|
+
*/
|
|
131
|
+
const initializedTrx = await trx.transaction();
|
|
132
|
+
const transactionRunner = new runner_1.default(initializedTrx.client,
|
|
133
|
+
/**
|
|
134
|
+
* Билдер в данном случае не имеет принципиального значения, сделано больше для соблюдения API, практического значения не имеет
|
|
135
|
+
*/
|
|
136
|
+
settledRunner.builder);
|
|
137
|
+
const newKnexContextLayer = {
|
|
138
|
+
runner: transactionRunner,
|
|
139
|
+
trx: initializedTrx,
|
|
140
|
+
};
|
|
141
|
+
this.layers.push(newKnexContextLayer);
|
|
142
|
+
}
|
|
143
|
+
}
|
|
144
|
+
/**
|
|
145
|
+
* Должен быть вызван перед тем как запускать функцию, подразумевающую вложенный уровень транзакционности
|
|
146
|
+
*/
|
|
147
|
+
addNestLayer() {
|
|
148
|
+
if (this.suspended) {
|
|
149
|
+
throw new exceptions_1.NestUnavailableOnSuspendedContext();
|
|
150
|
+
}
|
|
151
|
+
this.nestDepth += 1;
|
|
152
|
+
}
|
|
153
|
+
async rollbackTransaction() {
|
|
154
|
+
if (this.suspended) {
|
|
155
|
+
return;
|
|
156
|
+
}
|
|
157
|
+
/**
|
|
158
|
+
* Слой может быть не проинициализирован из-за того что внутри функции не было запросов к бд
|
|
159
|
+
*/
|
|
160
|
+
await this.layers.at(this.nestDepth - 1)?.trx?.rollback();
|
|
161
|
+
}
|
|
162
|
+
async commitTransaction() {
|
|
163
|
+
if (this.suspended) {
|
|
164
|
+
return;
|
|
165
|
+
}
|
|
166
|
+
/**
|
|
167
|
+
* Слой может быть не проинициализирован из-за того что внутри функции не было запросов к бд
|
|
168
|
+
*/
|
|
169
|
+
await this.layers.at(this.nestDepth - 1)?.trx?.commit();
|
|
170
|
+
}
|
|
171
|
+
/**
|
|
172
|
+
* Завершает обработку вложенности
|
|
173
|
+
* @param mustRelease должны ли быть все транзакции завершены, а соединение возвращено в пул
|
|
174
|
+
*/
|
|
175
|
+
finalize(mustRelease) {
|
|
176
|
+
if (this.nestDepth < this.layers.length) {
|
|
177
|
+
/**
|
|
178
|
+
* Не должно быть ситуаций при которых мы попадаем сюда с количеством слоев больше чем уровень вложенности
|
|
179
|
+
*/
|
|
180
|
+
throw new exceptions_1.LayersCountMoreThanNestDepth();
|
|
181
|
+
}
|
|
182
|
+
this.nestDepth -= 1;
|
|
183
|
+
/**
|
|
184
|
+
* Удаляем обработанные слои
|
|
185
|
+
*/
|
|
186
|
+
this.layers.splice(this.nestDepth);
|
|
187
|
+
/**
|
|
188
|
+
* Релизнули(закрыли) ли мы соединение
|
|
189
|
+
*/
|
|
190
|
+
const isReleased = this.layers.length === 0;
|
|
191
|
+
this._isReleased = isReleased;
|
|
192
|
+
/**
|
|
193
|
+
* В обоих случаях в идеале завершать работу приложения так как часть операция может быть не выполнена, хотя должна была и наоборот
|
|
194
|
+
* И в качестве бонуса получим висящее соединение к СУБД которое нельзя использовать
|
|
195
|
+
*/
|
|
196
|
+
if (mustRelease && !isReleased) {
|
|
197
|
+
throw new exceptions_1.MustReleased();
|
|
198
|
+
}
|
|
199
|
+
if (isReleased && !mustRelease) {
|
|
200
|
+
throw new exceptions_1.UnexpectedRelease();
|
|
201
|
+
}
|
|
202
|
+
}
|
|
203
|
+
/**
|
|
204
|
+
* Проинициализированы ли все необходимые слои транзакций
|
|
205
|
+
* Необходимо для тестов и внутренних процессов
|
|
206
|
+
*/
|
|
207
|
+
isInitialized() {
|
|
208
|
+
return this.layers.length === this.nestDepth;
|
|
209
|
+
}
|
|
210
|
+
/**
|
|
211
|
+
* Можно ли начать использовать этот контекст
|
|
212
|
+
*/
|
|
213
|
+
assertStart() {
|
|
214
|
+
if (this.nestDepth < 1) {
|
|
215
|
+
throw new exceptions_1.StartWithFinalizedContextUnavailable();
|
|
216
|
+
}
|
|
217
|
+
}
|
|
218
|
+
}
|
|
219
|
+
exports.KnexContext = KnexContext;
|
|
220
|
+
//# sourceMappingURL=context.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"context.js","sourceRoot":"","sources":["../../src/internal/context.ts"],"names":[],"mappings":";;;;;;AAAA,sDAAsD;AACtD,iCAAuC;AAEvC;;;GAGG;AACH,aAAa;AACb,uEAA8D;AAC9D,aAAa;AACb,gFAAuD;AAGvD,oCAAoE;AAEpE,6CAOsB;AAqBtB,MAAa,WAAY,SAAQ,gBAA2B;IACjD,eAAe,GAAG,uBAAe,CAAC;IAE3C;;;;OAIG;IACK,WAAW,GAAG,KAAK,CAAC;IAE5B;;;;OAIG;IACK,MAAM,GAAuB,EAAE,CAAC;IAExC;;;;;OAKG;IACK,SAAS,GAAG,CAAC,CAAC;IAItB,YAAoB,GAA2B;QAC7C,KAAK,CAAC,GAAG,IAAI,+BAAuB,CAAC,CAAC;IACxC,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACH,IAAI,sBAAsB;QACxB,OAAO,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,aAAa,CAAC,CAAC;IACxD,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,cAA8B;QAC1C,OAAO,IAAI,WAAW,CAAC,cAAc,CAAC,CAAC;IACzC,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,eAAe;QACpB,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACH,mBAAmB,CAAC,UAAsB;QACxC,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC;QACjD,IAAI,CAAC,KAAK,EAAE;YACV,MAAM,IAAI,mCAAsB,EAAE,CAAC;SACpC;QAED,MAAM,iBAAiB,GAAG,IAAI,gBAAM,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC;QAE3E;;;;;;;;;;WAUG;QACH,iBAAiB,CAAC,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC;QAEvD,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,UAAU,CAAC,aAAyB;QACxC,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;gBAC5B,OAAO;aACR;YAED,MAAM,GAAG,GAAG,IAAA,mBAAQ,EAAC,aAAa,CAAC,MAAM,CAAS,CAAC;YACnD,MAAM,MAAM,GAAG,IAAI,gBAAM,CACvB,GAAG,CAAC,MAAM;YACV;;eAEG;YACH,aAAa,CAAC,OAAO,CACtB,CAAC;YAEF,IAAI,CAAC,MAAM,GAAG;gBACZ;oBACE,GAAG,EAAE,GAAuB;oBAC5B,MAAM,EAAE,MAAM;iBACf;aACF,CAAC;SACH;QAED;;;WAGG;QACH,MAAM,kBAAkB,GAAG,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;QAE/D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,kBAAkB,EAAE,CAAC,EAAE,EAAE;YAC3C,MAAM,GAAG;YACP;;eAEG;YACH,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG;gBACvB;;;mBAGG;gBACF,IAAA,mBAAQ,EAAC,aAAa,CAAC,MAAM,CAAU,CAAC;YAE3C;;;eAGG;YACH,MAAM,cAAc,GAAG,MAAM,GAAG,CAAC,WAAW,EAAE,CAAC;YAE/C,MAAM,iBAAiB,GAAG,IAAI,gBAAM,CAClC,cAAc,CAAC,MAAM;YACrB;;eAEG;YACH,aAAa,CAAC,OAAO,CACtB,CAAC;YACF,MAAM,mBAAmB,GAAG;gBAC1B,MAAM,EAAE,iBAAiB;gBACzB,GAAG,EAAE,cAAc;aACpB,CAAC;YAEF,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;SACvC;IACH,CAAC;IAED;;OAEG;IACH,YAAY;QACV,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,MAAM,IAAI,8CAAiC,EAAE,CAAC;SAC/C;QAED,IAAI,CAAC,SAAS,IAAI,CAAC,CAAC;IACtB,CAAC;IAED,KAAK,CAAC,mBAAmB;QACvB,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,OAAO;SACR;QAED;;WAEG;QACH,MAAM,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC;IAC5D,CAAC;IAED,KAAK,CAAC,iBAAiB;QACrB,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,OAAO;SACR;QAED;;WAEG;QACH,MAAM,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC;IAC1D,CAAC;IAED;;;OAGG;IACH,QAAQ,CAAC,WAAoB;QAC3B,IAAI,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;YACvC;;eAEG;YACH,MAAM,IAAI,yCAA4B,EAAE,CAAC;SAC1C;QAED,IAAI,CAAC,SAAS,IAAI,CAAC,CAAC;QAEpB;;WAEG;QACH,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAEnC;;WAEG;QACH,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC;QAE5C,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAE9B;;;WAGG;QACH,IAAI,WAAW,IAAI,CAAC,UAAU,EAAE;YAC9B,MAAM,IAAI,yBAAY,EAAE,CAAC;SAC1B;QAED,IAAI,UAAU,IAAI,CAAC,WAAW,EAAE;YAC9B,MAAM,IAAI,8BAAiB,EAAE,CAAC;SAC/B;IACH,CAAC;IAED;;;OAGG;IACH,aAAa;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,IAAI,CAAC,SAAS,CAAC;IAC/C,CAAC;IAED;;OAEG;IACH,WAAW;QACT,IAAI,IAAI,CAAC,SAAS,GAAG,CAAC,EAAE;YACtB,MAAM,IAAI,iDAAoC,EAAE,CAAC;SAClD;IACH,CAAC;CACF;AAhPD,kCAgPC"}
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
import { InternalException } from '@rsdk/core';
|
|
2
|
+
/**
|
|
3
|
+
* Попытка начать выполнения функции в контексте при неподходящем состоянии контекста
|
|
4
|
+
*/
|
|
5
|
+
export declare class StartWithFinalizedContextUnavailable extends InternalException {
|
|
6
|
+
constructor();
|
|
7
|
+
}
|
|
8
|
+
/**
|
|
9
|
+
* Попытка использовать queryRunner в момент когда слой для уровня вложенности ещё не проинициализирован
|
|
10
|
+
*/
|
|
11
|
+
export declare class LayerMustBeInitialized extends InternalException {
|
|
12
|
+
constructor();
|
|
13
|
+
}
|
|
14
|
+
export declare class FinalizeException extends InternalException {
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* Ожидалось завершение работы с транзакцией, но не удовлетворены условия завершения (например транзакция не может быть закрыта из-за наличия незакрытых `savepoint`)
|
|
18
|
+
*/
|
|
19
|
+
export declare class MustReleased extends InternalException {
|
|
20
|
+
constructor();
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* Проинициализировано больше слоев чем текущий уровень вложенности
|
|
24
|
+
*/
|
|
25
|
+
export declare class LayersCountMoreThanNestDepth extends FinalizeException {
|
|
26
|
+
constructor();
|
|
27
|
+
}
|
|
28
|
+
export declare class ContextMustBeProvided extends InternalException {
|
|
29
|
+
constructor();
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* Неожиданный релиз (закрытие/возвращение в пул) соединения
|
|
33
|
+
*/
|
|
34
|
+
export declare class UnexpectedRelease extends InternalException {
|
|
35
|
+
constructor();
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* Попытка использовать контекст когда работа с ним была завершена
|
|
39
|
+
* Например если не дождались завершения промиса использующего соединение
|
|
40
|
+
* @example
|
|
41
|
+
* runInContext(()=> {
|
|
42
|
+
* Promise.resolve().then(() => manager.query('SELECT 1'))
|
|
43
|
+
* })
|
|
44
|
+
*
|
|
45
|
+
* @example
|
|
46
|
+
* class UserController {
|
|
47
|
+
* constructor(
|
|
48
|
+
* private registerAttemptService: { registerAttemptToDb(): Promise<void> },
|
|
49
|
+
* private userService: { fetchUser(userId: UserId): Promise<User | null> }
|
|
50
|
+
* ) {}
|
|
51
|
+
*
|
|
52
|
+
* // @Get('/user')
|
|
53
|
+
* // @Transactional()
|
|
54
|
+
* async sum(@Query() query: { userId: UserId }): Promise<void> {
|
|
55
|
+
* this.registerAttemptService.registerAttemptToDb();
|
|
56
|
+
* return this.userService.fetchUser(query.userId);
|
|
57
|
+
* }
|
|
58
|
+
* }
|
|
59
|
+
*/
|
|
60
|
+
export declare class ContextIsReleased extends InternalException {
|
|
61
|
+
constructor();
|
|
62
|
+
}
|
|
63
|
+
export declare class NestUnavailableOnSuspendedContext extends InternalException {
|
|
64
|
+
constructor();
|
|
65
|
+
}
|