@rsdk/db 5.16.0 → 5.17.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.
@@ -37,15 +37,21 @@ export declare abstract class DbMetricsModuleBase {
37
37
  */
38
38
  onModuleInit(): void;
39
39
  /**
40
- * Снимает всё подключённое в обратном порядке: подводит итог по пулам,
41
- * выключает subscriber-ы и обёртки.
40
+ * Закрывает ORM и снимает всё подключённое в обратном порядке: подводит итог
41
+ * по пулам, выключает subscriber-ы и обёртки.
42
42
  *
43
43
  * Не `onModuleDestroy`: Nest вызывает его до того, как перестаёт принимать
44
44
  * запросы, и транзакция, которая ещё идёт, закоммитилась бы уже после итога
45
- * по пулу и попала бы в rollback. Если ORM закрыл пул раньше, итог уже
46
- * подведён. Повторный вызов ничего не делает
45
+ * по пулу и попала бы в rollback. Глобальный модуль ORM Nest завершает
46
+ * после этого хука, поэтому ORM закрывается здесь, а закрытие пула дожидается
47
+ * транзакции. Повторный вызов ничего не делает
47
48
  */
48
- onApplicationShutdown(): void;
49
+ onApplicationShutdown(): Promise<void>;
50
+ /**
51
+ * Закрывает пулы ORM. Вызывается и при повторной остановке, и до хука модуля
52
+ * самого ORM, поэтому закрытие должно быть идемпотентным
53
+ */
54
+ protected abstract closeOrm(): Promise<void>;
49
55
  /**
50
56
  * Подключает метрики ORM: находит пулы и передаёт их в `client`,
51
57
  * ставит subscriber-ы и обёртки. Вызывается один раз и только при
@@ -45,16 +45,24 @@ class DbMetricsModuleBase {
45
45
  }
46
46
  }
47
47
  /**
48
- * Снимает всё подключённое в обратном порядке: подводит итог по пулам,
49
- * выключает subscriber-ы и обёртки.
48
+ * Закрывает ORM и снимает всё подключённое в обратном порядке: подводит итог
49
+ * по пулам, выключает subscriber-ы и обёртки.
50
50
  *
51
51
  * Не `onModuleDestroy`: Nest вызывает его до того, как перестаёт принимать
52
52
  * запросы, и транзакция, которая ещё идёт, закоммитилась бы уже после итога
53
- * по пулу и попала бы в rollback. Если ORM закрыл пул раньше, итог уже
54
- * подведён. Повторный вызов ничего не делает
53
+ * по пулу и попала бы в rollback. Глобальный модуль ORM Nest завершает
54
+ * после этого хука, поэтому ORM закрывается здесь, а закрытие пула дожидается
55
+ * транзакции. Повторный вызов ничего не делает
55
56
  */
56
- onApplicationShutdown() {
57
- this.detaches.detachAll();
57
+ async onApplicationShutdown() {
58
+ try {
59
+ if (this.client !== null) {
60
+ await this.closeOrm();
61
+ }
62
+ }
63
+ finally {
64
+ this.detaches.detachAll();
65
+ }
58
66
  }
59
67
  }
60
68
  exports.DbMetricsModuleBase = DbMetricsModuleBase;
@@ -1 +1 @@
1
- {"version":3,"file":"db-metrics.module-base.js","sourceRoot":"","sources":["../../src/metrics/db-metrics.module-base.ts"],"names":[],"mappings":";;;AAEA,iDAA6C;AAG7C;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAsB,mBAAmB;IAWpB;IACE;IAXJ,QAAQ,GAAG,IAAI,0BAAW,EAAE,CAAC;IAE9C;;;;;;OAMG;IACH,YACmB,MAA8B,EAC5B,gBAAiD;QADnD,WAAM,GAAN,MAAM,CAAwB;QAC5B,qBAAgB,GAAhB,gBAAgB,CAAiC;IACnE,CAAC;IAEJ;;OAEG;IACH,YAAY;QACV,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;YACzB,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QAClE,CAAC;IACH,CAAC;IAED;;;;;;;;OAQG;IACH,qBAAqB;QACnB,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,CAAC;IAC5B,CAAC;CAiBF;AApDD,kDAoDC"}
1
+ {"version":3,"file":"db-metrics.module-base.js","sourceRoot":"","sources":["../../src/metrics/db-metrics.module-base.ts"],"names":[],"mappings":";;;AAEA,iDAA6C;AAG7C;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAsB,mBAAmB;IAWpB;IACE;IAXJ,QAAQ,GAAG,IAAI,0BAAW,EAAE,CAAC;IAE9C;;;;;;OAMG;IACH,YACmB,MAA8B,EAC5B,gBAAiD;QADnD,WAAM,GAAN,MAAM,CAAwB;QAC5B,qBAAgB,GAAhB,gBAAgB,CAAiC;IACnE,CAAC;IAEJ;;OAEG;IACH,YAAY;QACV,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;YACzB,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QAClE,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,qBAAqB;QACzB,IAAI,CAAC;YACH,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;gBACzB,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;YACxB,CAAC;QACH,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,CAAC;QAC5B,CAAC;IACH,CAAC;CAuBF;AAjED,kDAiEC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rsdk/db",
3
- "version": "5.16.0",
3
+ "version": "5.17.0-next.0",
4
4
  "description": "Common functionality and interfaces for relational database plugins",
5
5
  "main": "dist/index.js",
6
6
  "publishConfig": {
@@ -19,5 +19,5 @@
19
19
  "@rsdk/logging": "*",
20
20
  "reflect-metadata": "^0.1.12 || ^0.2.0"
21
21
  },
22
- "gitHead": "6815c6f20a183c919cf4b01a3b61bc381b4321c6"
22
+ "gitHead": "c65206299ce1f0f1e209bb936721a1537bc4a064"
23
23
  }
@@ -13,6 +13,8 @@ class SpecModule extends DbMetricsModuleBase {
13
13
  [(detach?: Detach) => void, DbClientMetrics]
14
14
  >();
15
15
 
16
+ readonly closed = jest.fn<Promise<void>, []>().mockResolvedValue();
17
+
16
18
  constructor(
17
19
  client: DbClientMetrics | null,
18
20
  entityOperations: EntityOperationsRecorder | null = null,
@@ -30,6 +32,10 @@ class SpecModule extends DbMetricsModuleBase {
30
32
  ): void {
31
33
  this.attached(add, client);
32
34
  }
35
+
36
+ protected closeOrm(): Promise<void> {
37
+ return this.closed();
38
+ }
33
39
  }
34
40
 
35
41
  describe('DbMetricsModuleBase', () => {
@@ -44,13 +50,14 @@ describe('DbMetricsModuleBase', () => {
44
50
  register.clear();
45
51
  });
46
52
 
47
- it('does not attach when there is no client', () => {
53
+ it('does not attach or close the ORM when there is no client', async () => {
48
54
  const module = new SpecModule(null);
49
55
 
50
56
  module.onModuleInit();
51
- module.onApplicationShutdown();
57
+ await module.onApplicationShutdown();
52
58
 
53
59
  expect(module.attached).not.toHaveBeenCalled();
60
+ expect(module.closed).not.toHaveBeenCalled();
54
61
  });
55
62
 
56
63
  it('attaches once with the injected client', () => {
@@ -62,7 +69,40 @@ describe('DbMetricsModuleBase', () => {
62
69
  expect(module.attached.mock.calls[0]![1]).toBe(client);
63
70
  });
64
71
 
65
- it('detaches everything on shutdown in reverse order', () => {
72
+ it('detaches only after the ORM is closed', async () => {
73
+ const calls: string[] = [];
74
+ const module = new SpecModule(client);
75
+
76
+ module.attached.mockImplementation((add) => {
77
+ add(() => calls.push('detach'));
78
+ });
79
+ module.closed.mockImplementation(async () => {
80
+ await Promise.resolve();
81
+ calls.push('close');
82
+ });
83
+
84
+ module.onModuleInit();
85
+ await module.onApplicationShutdown();
86
+
87
+ expect(calls).toEqual(['close', 'detach']);
88
+ });
89
+
90
+ it('detaches even when closing the ORM fails', async () => {
91
+ const detach = jest.fn();
92
+ const module = new SpecModule(client);
93
+
94
+ module.attached.mockImplementation((add) => add(detach));
95
+ module.closed.mockRejectedValue(new Error('close failed'));
96
+
97
+ module.onModuleInit();
98
+
99
+ await expect(module.onApplicationShutdown()).rejects.toThrow(
100
+ 'close failed',
101
+ );
102
+ expect(detach).toHaveBeenCalledTimes(1);
103
+ });
104
+
105
+ it('detaches everything on shutdown in reverse order', async () => {
66
106
  const calls: string[] = [];
67
107
  const module = new SpecModule(client);
68
108
 
@@ -76,8 +116,8 @@ describe('DbMetricsModuleBase', () => {
76
116
 
77
117
  expect(calls).toEqual([]);
78
118
 
79
- module.onApplicationShutdown();
80
- module.onApplicationShutdown();
119
+ await module.onApplicationShutdown();
120
+ await module.onApplicationShutdown();
81
121
 
82
122
  expect(calls).toEqual(['second', 'first']);
83
123
  });
@@ -47,18 +47,31 @@ export abstract class DbMetricsModuleBase {
47
47
  }
48
48
 
49
49
  /**
50
- * Снимает всё подключённое в обратном порядке: подводит итог по пулам,
51
- * выключает subscriber-ы и обёртки.
50
+ * Закрывает ORM и снимает всё подключённое в обратном порядке: подводит итог
51
+ * по пулам, выключает subscriber-ы и обёртки.
52
52
  *
53
53
  * Не `onModuleDestroy`: Nest вызывает его до того, как перестаёт принимать
54
54
  * запросы, и транзакция, которая ещё идёт, закоммитилась бы уже после итога
55
- * по пулу и попала бы в rollback. Если ORM закрыл пул раньше, итог уже
56
- * подведён. Повторный вызов ничего не делает
55
+ * по пулу и попала бы в rollback. Глобальный модуль ORM Nest завершает
56
+ * после этого хука, поэтому ORM закрывается здесь, а закрытие пула дожидается
57
+ * транзакции. Повторный вызов ничего не делает
57
58
  */
58
- onApplicationShutdown(): void {
59
- this.detaches.detachAll();
59
+ async onApplicationShutdown(): Promise<void> {
60
+ try {
61
+ if (this.client !== null) {
62
+ await this.closeOrm();
63
+ }
64
+ } finally {
65
+ this.detaches.detachAll();
66
+ }
60
67
  }
61
68
 
69
+ /**
70
+ * Закрывает пулы ORM. Вызывается и при повторной остановке, и до хука модуля
71
+ * самого ORM, поэтому закрытие должно быть идемпотентным
72
+ */
73
+ protected abstract closeOrm(): Promise<void>;
74
+
62
75
  /**
63
76
  * Подключает метрики ORM: находит пулы и передаёт их в `client`,
64
77
  * ставит subscriber-ы и обёртки. Вызывается один раз и только при
@@ -1,5 +1,8 @@
1
1
  {
2
2
  "extends": "./tsconfig.json",
3
+ "compilerOptions": {
4
+ "rootDir": "src"
5
+ },
3
6
  "exclude": [
4
7
  "node_modules",
5
8
  "dist",
package/tsconfig.json CHANGED
@@ -2,6 +2,7 @@
2
2
  "extends": "@rsdk/tsconfig/base.json",
3
3
  "compilerOptions": {
4
4
  "declaration": true,
5
- "outDir": "dist"
5
+ "outDir": "dist",
6
+ "rootDir": "src"
6
7
  }
7
8
  }