feat: add event hooks

Author: joscelynjeanvdm

CHANGELOG.md

@@ -5,6 +5,7 @@ All notable changes to this library will be documented in this file.
 ## 1.0.4
 
 -   Delegation function is called when a connection to MongoDB is required instead of retaining the database reference ([issue #11](https://github.com/VilledeMontreal/express-idempotency-mongo-adapter/issues/11))
+-   Add events for before and after database usage
 
 ## 1.0.3
 

src/adapter.ts

@@ -73,6 +73,9 @@ export class MongoAdapter implements IIdempotencyDataAdapter {
                 ? options.collectionPrefix
                 : COLLECTION_PREFIX,
             ttl: options.ttl ? options.ttl : TTL,
+            // Events
+            onBeforeDbUse: options.onBeforeDbUse,
+            onAfterDbUse: options.onAfterDbUse
         };
     }
 
@@ -219,6 +222,8 @@ export class MongoAdapter implements IIdempotencyDataAdapter {
         idempotencyResource: IdempotencyResource
     ): Promise<void> {
         await this.checkForInitialization();
+
+        await this._options?.onBeforeDbUse?.call(this);
         const db: Db = await this._options.delegate();
 
         const collection = db.collection(this.getStoreCollectionName());
@@ -227,6 +232,7 @@ export class MongoAdapter implements IIdempotencyDataAdapter {
             createdAt: new Date(),
             schemaVersion: SCHEMA_VERSION,
         });
+        await this._options?.onAfterDbUse?.call(this);
     }
 
     /**
@@ -237,6 +243,7 @@ export class MongoAdapter implements IIdempotencyDataAdapter {
         idempotencyResource: IdempotencyResource
     ): Promise<void> {
         await this.checkForInitialization();
+        await this._options?.onBeforeDbUse?.call(this);
         const db: Db = await this._options.delegate();
 
         const newResource = {
@@ -249,6 +256,7 @@ export class MongoAdapter implements IIdempotencyDataAdapter {
             { idempotencyKey: idempotencyResource.idempotencyKey },
             newResource
         );
+        await this._options?.onAfterDbUse?.call(this);
     }
 
     /**
@@ -257,9 +265,11 @@ export class MongoAdapter implements IIdempotencyDataAdapter {
      */
     public async delete(idempotencyKey: string): Promise<void> {
         await this.checkForInitialization();
+        await this._options?.onBeforeDbUse?.call(this);
         const db: Db = await this._options.delegate();
         const collection = db.collection(this.getStoreCollectionName());
         await collection.deleteOne({ idempotencyKey });
+        await this._options?.onAfterDbUse?.call(this);
     }
 }
 

src/adapterOptions.ts

@@ -29,6 +29,10 @@ export interface AdapterOptions {
     useDelegation?: boolean;
     delegate?: () => Promise<mongodb.Db>;
 
+    // Hooks for events
+    onBeforeDbUse?: () => Promise<void>;
+    onAfterDbUse?: () => Promise<void>;
+
     // The prefix used to create collections in the mongo database
     // Default value is 'idempotency'
     collectionPrefix?: string;