Merge pull request #1074 from notaphplover/fix/update-transaction-bas…

…ed-flows-to-release-them-on-uncaught-errors Update transaction based flows to release them on uncaught errors
notaphplover · Mar 16, 2024 · fc10b5e · fc10b5e
2 parents e4372a9 + 4ecaeb1
commit fc10b5e
Show file tree

Hide file tree

Showing 13 changed files with 170 additions and 6 deletions.
diff --git a/...ter/typeorm/builders/GameActionCreateQueryTypeOrmFromGameActionCreateQueryBuilder.spec.ts b/...ter/typeorm/builders/GameActionCreateQueryTypeOrmFromGameActionCreateQueryBuilder.spec.ts
@@ -8,7 +8,7 @@ import {
   PlayCardsGameActionCreateQuery,
 } from '@cornie-js/backend-game-domain/gameActions';
 import { GameActionCreateQueryFixtures } from '@cornie-js/backend-game-domain/gameActions/fixtures';
-import { FindOptionsWhere, Repository, SelectQueryBuilder } from 'typeorm';
+import { Repository, SelectQueryBuilder } from 'typeorm';
 import { QueryDeepPartialEntity } from 'typeorm/query-builder/QueryPartialEntity.js';
 
 import { CardDb } from '../../../../cards/adapter/typeorm/models/CardDb';

diff --git a/.../backend-game-application/src/games/application/handlers/CreateGameUseCaseHandler.spec.ts b/.../backend-game-application/src/games/application/handlers/CreateGameUseCaseHandler.spec.ts
@@ -1,3 +1,15 @@
+/*
+ * Ugly workaround until https://github.com/jestjs/jest/issues/14874 is provided in jest@30
+ */
+
+const disposeSymbol: unique symbol = Symbol('Symbol.dispose');
+const asyncDisposeSymbol: unique symbol = Symbol('Symbol.asyncDispose');
+
+(Symbol as Writable<SymbolConstructor>).asyncDispose ??=
+  asyncDisposeSymbol as unknown as SymbolConstructor['asyncDispose'];
+(Symbol as Writable<SymbolConstructor>).dispose ??=
+  disposeSymbol as unknown as SymbolConstructor['dispose'];
+
 import { afterAll, beforeAll, describe, expect, it, jest } from '@jest/globals';
 
 import { models as apiModels } from '@cornie-js/api-models';
@@ -7,6 +19,7 @@ import {
   AppErrorKind,
   Builder,
   Left,
+  Writable,
 } from '@cornie-js/backend-common';
 import { TransactionWrapper } from '@cornie-js/backend-db/application';
 import {
@@ -105,6 +118,7 @@ describe(CreateGameUseCaseHandler.name, () => {
         gameSpecFixture = GameSpecFixtures.any;
         gameV1Fixture = ActiveGameV1Fixtures.any;
         transactionWrapperMock = {
+          [Symbol.asyncDispose]: jest.fn(),
           rollback: jest.fn(),
           tryCommit: jest
             .fn()
@@ -200,6 +214,15 @@ describe(CreateGameUseCaseHandler.name, () => {
         );
       });
 
+      it('should call transactionWrapper[Symbol.asyncDispose]()', () => {
+        expect(
+          transactionWrapperMock[Symbol.asyncDispose],
+        ).toHaveBeenCalledTimes(1);
+        expect(
+          transactionWrapperMock[Symbol.asyncDispose],
+        ).toHaveBeenCalledWith();
+      });
+
       it('should return a GameV1', () => {
         expect(result).toBe(gameV1Fixture);
       });

diff --git a/.../game/backend-game-application/src/games/application/handlers/CreateGameUseCaseHandler.ts b/.../game/backend-game-application/src/games/application/handlers/CreateGameUseCaseHandler.ts
@@ -89,7 +89,7 @@ export class CreateGameUseCaseHandler
 
     this.#validate(gameCreateQuery);
 
-    const transactionWrapper: TransactionWrapper =
+    await using transactionWrapper: TransactionWrapper =
       await this.#transactionProvisionOutputPort.provide();
 
     const game: Game = await this.#gamePersistenceOutputPort.create(

diff --git a/...end-game-application/src/games/application/handlers/GameIdDrawCardsQueryV1Handler.spec.ts b/...end-game-application/src/games/application/handlers/GameIdDrawCardsQueryV1Handler.spec.ts
@@ -1,3 +1,15 @@
+/*
+ * Ugly workaround until https://github.com/jestjs/jest/issues/14874 is provided in jest@30
+ */
+
+const disposeSymbol: unique symbol = Symbol('Symbol.dispose');
+const asyncDisposeSymbol: unique symbol = Symbol('Symbol.asyncDispose');
+
+(Symbol as Writable<SymbolConstructor>).asyncDispose ??=
+  asyncDisposeSymbol as unknown as SymbolConstructor['asyncDispose'];
+(Symbol as Writable<SymbolConstructor>).dispose ??=
+  disposeSymbol as unknown as SymbolConstructor['dispose'];
+
 import { afterAll, beforeAll, describe, expect, it, jest } from '@jest/globals';
 
 import { models as apiModels } from '@cornie-js/api-models';
@@ -6,6 +18,7 @@ import {
   AppErrorKind,
   Builder,
   Handler,
+  Writable,
 } from '@cornie-js/backend-common';
 import { TransactionWrapper } from '@cornie-js/backend-db/application';
 import {
@@ -491,6 +504,7 @@ describe(GameIdDrawCardsQueryV1Handler.name, () => {
         gameDrawMutationFixture = GameDrawMutationFixtures.any;
         gameUpdateQueryFixture = GameUpdateQueryFixtures.any;
         transactionWrapperMock = {
+          [Symbol.asyncDispose]: jest.fn(),
           tryCommit: jest.fn(),
         } as Partial<
           jest.Mocked<TransactionWrapper>
@@ -623,6 +637,15 @@ describe(GameIdDrawCardsQueryV1Handler.name, () => {
         expect(transactionWrapperMock.tryCommit).toHaveBeenCalledWith();
       });
 
+      it('should call transactionWrapper[Symbol.asyncDispose]()', () => {
+        expect(
+          transactionWrapperMock[Symbol.asyncDispose],
+        ).toHaveBeenCalledTimes(1);
+        expect(
+          transactionWrapperMock[Symbol.asyncDispose],
+        ).toHaveBeenCalledWith();
+      });
+
       it('should return undefined', () => {
         expect(result).toBeUndefined();
       });

diff --git a/...kend-game-application/src/games/application/handlers/GameIdPassTurnQueryV1Handler.spec.ts b/...kend-game-application/src/games/application/handlers/GameIdPassTurnQueryV1Handler.spec.ts
@@ -1,3 +1,15 @@
+/*
+ * Ugly workaround until https://github.com/jestjs/jest/issues/14874 is provided in jest@30
+ */
+
+const disposeSymbol: unique symbol = Symbol('Symbol.dispose');
+const asyncDisposeSymbol: unique symbol = Symbol('Symbol.asyncDispose');
+
+(Symbol as Writable<SymbolConstructor>).asyncDispose ??=
+  asyncDisposeSymbol as unknown as SymbolConstructor['asyncDispose'];
+(Symbol as Writable<SymbolConstructor>).dispose ??=
+  disposeSymbol as unknown as SymbolConstructor['dispose'];
+
 import { afterAll, beforeAll, describe, expect, it, jest } from '@jest/globals';
 
 import { models as apiModels } from '@cornie-js/api-models';
@@ -6,6 +18,7 @@ import {
   AppErrorKind,
   Builder,
   Handler,
+  Writable,
 } from '@cornie-js/backend-common';
 import { TransactionWrapper } from '@cornie-js/backend-db/application';
 import {
@@ -476,6 +489,7 @@ describe(GameIdPassTurnQueryV1Handler.name, () => {
         gameSpecFixture = GameSpecFixtures.any;
         gameUpdateQueryFixture = GameUpdateQueryFixtures.any;
         transactionWrapperMock = {
+          [Symbol.asyncDispose]: jest.fn(),
           tryCommit: jest.fn(),
         } as Partial<
           jest.Mocked<TransactionWrapper>
@@ -603,6 +617,15 @@ describe(GameIdPassTurnQueryV1Handler.name, () => {
         expect(transactionWrapperMock.tryCommit).toHaveBeenCalledWith();
       });
 
+      it('should call transactionWrapper[Symbol.asyncDispose]()', () => {
+        expect(
+          transactionWrapperMock[Symbol.asyncDispose],
+        ).toHaveBeenCalledTimes(1);
+        expect(
+          transactionWrapperMock[Symbol.asyncDispose],
+        ).toHaveBeenCalledWith();
+      });
+
       it('should return undefined', () => {
         expect(result).toBeUndefined();
       });

diff --git a/...end-game-application/src/games/application/handlers/GameIdPlayCardsQueryV1Handler.spec.ts b/...end-game-application/src/games/application/handlers/GameIdPlayCardsQueryV1Handler.spec.ts
@@ -1,3 +1,15 @@
+/*
+ * Ugly workaround until https://github.com/jestjs/jest/issues/14874 is provided in jest@30
+ */
+
+const disposeSymbol: unique symbol = Symbol('Symbol.dispose');
+const asyncDisposeSymbol: unique symbol = Symbol('Symbol.asyncDispose');
+
+(Symbol as Writable<SymbolConstructor>).asyncDispose ??=
+  asyncDisposeSymbol as unknown as SymbolConstructor['asyncDispose'];
+(Symbol as Writable<SymbolConstructor>).dispose ??=
+  disposeSymbol as unknown as SymbolConstructor['dispose'];
+
 import { afterAll, beforeAll, describe, expect, it, jest } from '@jest/globals';
 
 import { models as apiModels } from '@cornie-js/api-models';
@@ -6,6 +18,7 @@ import {
   AppErrorKind,
   Builder,
   Handler,
+  Writable,
 } from '@cornie-js/backend-common';
 import { TransactionWrapper } from '@cornie-js/backend-db/application';
 import { CardColor, Card } from '@cornie-js/backend-game-domain/cards';
@@ -508,6 +521,7 @@ describe(GameIdPlayCardsQueryV1Handler.name, () => {
         gamePlayCardsUpdateQueryFixture =
           GameUpdateQueryFixtures.withCurrentCard;
         transactionWrapperMock = {
+          [Symbol.asyncDispose]: jest.fn(),
           tryCommit: jest.fn(),
         } as Partial<
           jest.Mocked<TransactionWrapper>
@@ -684,6 +698,15 @@ describe(GameIdPlayCardsQueryV1Handler.name, () => {
         expect(transactionWrapperMock.tryCommit).toHaveBeenCalledWith();
       });
 
+      it('should call transactionWrapper[Symbol.asyncDispose]()', () => {
+        expect(
+          transactionWrapperMock[Symbol.asyncDispose],
+        ).toHaveBeenCalledTimes(1);
+        expect(
+          transactionWrapperMock[Symbol.asyncDispose],
+        ).toHaveBeenCalledWith();
+      });
+
       it('should return undefined', () => {
         expect(result).toBeUndefined();
       });
@@ -736,6 +759,7 @@ describe(GameIdPlayCardsQueryV1Handler.name, () => {
         gamePlayCardsUpdateQueryFixture =
           GameUpdateQueryFixtures.withCurrentCard;
         transactionWrapperMock = {
+          [Symbol.asyncDispose]: jest.fn(),
           tryCommit: jest.fn(),
         } as Partial<
           jest.Mocked<TransactionWrapper>
@@ -924,6 +948,15 @@ describe(GameIdPlayCardsQueryV1Handler.name, () => {
         expect(transactionWrapperMock.tryCommit).toHaveBeenCalledWith();
       });
 
+      it('should call transactionWrapper[Symbol.asyncDispose]()', () => {
+        expect(
+          transactionWrapperMock[Symbol.asyncDispose],
+        ).toHaveBeenCalledTimes(1);
+        expect(
+          transactionWrapperMock[Symbol.asyncDispose],
+        ).toHaveBeenCalledWith();
+      });
+
       it('should return undefined', () => {
         expect(result).toBeUndefined();
       });

diff --git a/...ame/backend-game-application/src/games/application/handlers/GameIdUpdateQueryV1Handler.ts b/...ame/backend-game-application/src/games/application/handlers/GameIdUpdateQueryV1Handler.ts
@@ -53,7 +53,7 @@ export abstract class GameIdUpdateQueryV1Handler<
 
     this._checkUnprocessableOperation(game, gameSpec, gameIdUpdateQueryV1);
 
-    const transactionWrapper: TransactionWrapper =
+    await using transactionWrapper: TransactionWrapper =
       await this.#transactionProvisionOutputPort.provide();
 
     const gameUpdatedEvent: ActiveGameUpdatedEvent =

diff --git a/...nd-game-application/src/games/application/ports/input/GameSlotManagementInputPort.spec.ts b/...nd-game-application/src/games/application/ports/input/GameSlotManagementInputPort.spec.ts
@@ -1,3 +1,15 @@
+/*
+ * Ugly workaround until https://github.com/jestjs/jest/issues/14874 is provided in jest@30
+ */
+
+const disposeSymbol: unique symbol = Symbol('Symbol.dispose');
+const asyncDisposeSymbol: unique symbol = Symbol('Symbol.asyncDispose');
+
+(Symbol as Writable<SymbolConstructor>).asyncDispose ??=
+  asyncDisposeSymbol as unknown as SymbolConstructor['asyncDispose'];
+(Symbol as Writable<SymbolConstructor>).dispose ??=
+  disposeSymbol as unknown as SymbolConstructor['dispose'];
+
 import { afterAll, beforeAll, describe, expect, it, jest } from '@jest/globals';
 
 import { models as apiModels } from '@cornie-js/api-models';
@@ -8,6 +20,7 @@ import {
   Builder,
   Handler,
   Spec,
+  Writable,
 } from '@cornie-js/backend-common';
 import { TransactionWrapper } from '@cornie-js/backend-db/application';
 import { Card } from '@cornie-js/backend-game-domain/cards';
@@ -138,6 +151,7 @@ describe(GameSlotManagementInputPort.name, () => {
         gameSlotFixture = NonStartedGameSlotFixtures.any;
         gameSlotV1Fixture = NonStartedGameSlotV1Fixtures.any;
         transactionWrapperMock = {
+          [Symbol.asyncDispose]: jest.fn(),
           tryCommit: jest.fn(),
         } as Partial<
           jest.Mocked<TransactionWrapper>
@@ -257,6 +271,15 @@ describe(GameSlotManagementInputPort.name, () => {
         );
       });
 
+      it('should call transactionWrapper[Symbol.asyncDispose]()', () => {
+        expect(
+          transactionWrapperMock[Symbol.asyncDispose],
+        ).toHaveBeenCalledTimes(1);
+        expect(
+          transactionWrapperMock[Symbol.asyncDispose],
+        ).toHaveBeenCalledWith();
+      });
+
       it('should return a GameSlotV1', () => {
         expect(result).toBe(gameSlotV1Fixture);
       });
@@ -276,6 +299,7 @@ describe(GameSlotManagementInputPort.name, () => {
         gameSlotFixture = NonStartedGameSlotFixtures.any;
         gameSlotV1Fixture = NonStartedGameSlotV1Fixtures.any;
         transactionWrapperMock = {
+          [Symbol.asyncDispose]: jest.fn(),
           tryCommit: jest.fn(),
         } as Partial<
           jest.Mocked<TransactionWrapper>
@@ -405,6 +429,15 @@ describe(GameSlotManagementInputPort.name, () => {
         );
       });
 
+      it('should call transactionWrapper[Symbol.asyncDispose]()', () => {
+        expect(
+          transactionWrapperMock[Symbol.asyncDispose],
+        ).toHaveBeenCalledTimes(1);
+        expect(
+          transactionWrapperMock[Symbol.asyncDispose],
+        ).toHaveBeenCalledWith();
+      });
+
       it('should return a GameSlotV1', () => {
         expect(result).toBe(gameSlotV1Fixture);
       });

diff --git a/...backend-game-application/src/games/application/ports/input/GameSlotManagementInputPort.ts b/...backend-game-application/src/games/application/ports/input/GameSlotManagementInputPort.ts
@@ -132,7 +132,7 @@ export class GameSlotManagementInputPort {
         this.#createGameSlotCreationQueryContext(game),
       );
 
-    const transactionWrapper: TransactionWrapper =
+    await using transactionWrapper: TransactionWrapper =
       await this.#transactionProvisionOutputPort.provide();
 
     const gameSlot: ActiveGameSlot | NonStartedGameSlot =

diff --git a/.../backend-user-application/src/users/application/handlers/CreateUserUseCaseHandler.spec.ts b/.../backend-user-application/src/users/application/handlers/CreateUserUseCaseHandler.spec.ts
@@ -1,10 +1,23 @@
+/*
+ * Ugly workaround until https://github.com/jestjs/jest/issues/14874 is provided in jest@30
+ */
+
+const disposeSymbol: unique symbol = Symbol('Symbol.dispose');
+const asyncDisposeSymbol: unique symbol = Symbol('Symbol.asyncDispose');
+
+(Symbol as Writable<SymbolConstructor>).asyncDispose ??=
+  asyncDisposeSymbol as unknown as SymbolConstructor['asyncDispose'];
+(Symbol as Writable<SymbolConstructor>).dispose ??=
+  disposeSymbol as unknown as SymbolConstructor['dispose'];
+
 import { afterAll, beforeAll, describe, expect, it, jest } from '@jest/globals';
 
 import {
   AppError,
   AppErrorKind,
   Handler,
   ReportBasedSpec,
+  Writable,
 } from '@cornie-js/backend-common';
 import { TransactionWrapper } from '@cornie-js/backend-db/application';
 import { User, UserCreateQuery } from '@cornie-js/backend-user-domain/users';
@@ -121,6 +134,7 @@ describe(CreateUserUseCaseHandler.name, () => {
 
       beforeAll(async () => {
         transactionWrapperMock = {
+          [Symbol.asyncDispose]: jest.fn(),
           rollback: jest.fn(),
           tryCommit: jest
             .fn()
@@ -192,6 +206,15 @@ describe(CreateUserUseCaseHandler.name, () => {
         expect(transactionWrapperMock.tryCommit).toHaveBeenCalledWith();
       });
 
+      it('should call transactionWrapper[Symbol.asyncDispose]()', () => {
+        expect(
+          transactionWrapperMock[Symbol.asyncDispose],
+        ).toHaveBeenCalledTimes(1);
+        expect(
+          transactionWrapperMock[Symbol.asyncDispose],
+        ).toHaveBeenCalledWith();
+      });
+
       it('should return an UserV1', () => {
         expect(result).toBe(userFixture);
       });

diff --git a/.../user/backend-user-application/src/users/application/handlers/CreateUserUseCaseHandler.ts b/.../user/backend-user-application/src/users/application/handlers/CreateUserUseCaseHandler.ts
@@ -55,7 +55,7 @@ export class CreateUserUseCaseHandler
   public async handle(userCreateQuery: UserCreateQuery): Promise<User> {
     this.#validate(userCreateQuery);
 
-    const transactionWrapper: TransactionWrapper =
+    await using transactionWrapper: TransactionWrapper =
       await this.#transactionProvisionOutputPort.provide();
 
     const user: User = await this.#userPersistenceOutputPort.create(

diff --git a/.../libraries/backend-db/src/persistence/adapter/typeorm/models/TypeOrmTransactionWrapper.ts b/.../libraries/backend-db/src/persistence/adapter/typeorm/models/TypeOrmTransactionWrapper.ts
@@ -33,6 +33,12 @@ export class TypeOrmTransactionWrapper implements TransactionWrapper {
     );
   }
 
+  public async [Symbol.asyncDispose](): Promise<void> {
+    if (!this.#queryRunner.isReleased) {
+      await this.rollback();
+    }
+  }
+
   public async rollback(): Promise<void> {
     try {
       await this.#queryRunner.rollbackTransaction();

diff --git a/...ges/backend/libraries/backend-db/src/persistence/application/models/TransactionWrapper.ts b/...ges/backend/libraries/backend-db/src/persistence/application/models/TransactionWrapper.ts
@@ -1,4 +1,4 @@
-export interface TransactionWrapper {
+export interface TransactionWrapper extends AsyncDisposable {
   rollback(): Promise<void>;
   tryCommit(): Promise<void>;
   unwrap(): unknown;