refactor(core): introduce ITerminate and rename outbox dispose

fizzbuds · Apr 3, 2024 · c48497c · c48497c
1 parent 9ef1419
commit c48497c
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 5 deletions.
diff --git a/packages/ddd-toolkit/src/outbox/mongo-outbox.spec.ts b/packages/ddd-toolkit/src/outbox/mongo-outbox.spec.ts
@@ -39,7 +39,7 @@ describe('Mongo outbox', () => {
     });
 
     afterAll(async () => {
-        await outbox.dispose();
+        await outbox.terminate();
         await mongoClient.close();
         await mongodb.stop();
     });

diff --git a/packages/ddd-toolkit/src/outbox/mongo-outbox.ts b/packages/ddd-toolkit/src/outbox/mongo-outbox.ts
@@ -5,6 +5,7 @@ import { inspect } from 'util';
 import { difference, intersection } from 'lodash';
 import { IOutbox } from './outbox.interface';
 import { IInit } from '../init.interface';
+import { ITerminate } from '../terminate.interface';
 
 type OutboxEventModel = {
     event: IEvent<unknown>;
@@ -14,7 +15,7 @@ type OutboxEventModel = {
     contextName?: string;
 };
 
-export class MongoOutbox implements IOutbox, IInit {
+export class MongoOutbox implements IOutbox, IInit, ITerminate {
     private outboxCollection: Collection<OutboxEventModel>;
 
     private stopping = false;
@@ -35,7 +36,7 @@ export class MongoOutbox implements IOutbox, IInit {
         void this.checkScheduledEvents([]);
     }
 
-    public async dispose() {
+    public async terminate() {
         this.stopping = true;
         await sleep(this.monitoringIntervalMs);
     }

diff --git a/packages/ddd-toolkit/src/outbox/outbox.interface.ts b/packages/ddd-toolkit/src/outbox/outbox.interface.ts
@@ -3,7 +3,7 @@ import { IEvent } from '../event-bus/event-bus.interface';
 export interface IOutbox {
     init(): Promise<void>;
 
-    dispose(): Promise<void>;
+    terminate(): Promise<void>;
 
     scheduleEvents(events: IEvent<unknown>[], transaction: unknown): Promise<string[]>;
 

diff --git a/packages/ddd-toolkit/src/repo/tests/mongo-aggregate-repo-with-outbox.integration-spec.ts b/packages/ddd-toolkit/src/repo/tests/mongo-aggregate-repo-with-outbox.integration-spec.ts
@@ -50,7 +50,7 @@ describe('MongoAggregateRepo MongoDB Integration', () => {
     });
 
     afterAll(async () => {
-        await outbox.dispose();
+        await outbox.terminate();
         await mongoClient.close();
         await mongodb.stop();
     });

diff --git a/packages/ddd-toolkit/src/terminate.interface.ts b/packages/ddd-toolkit/src/terminate.interface.ts
@@ -0,0 +1,3 @@
+export interface ITerminate {
+    terminate(): Promise<void> | void;
+}