Extensions (#60)

* Enhance event handling in AbstractServiceSchema with before and after event names for improved logging and extensibility

* Add Extensions module and DTOs for extension management and validation

* Skip processing of lifecycle sources with trigger-based rules in LifecycleService

* Add jsondiffpatch and microdiff dependencies to enhance diffing capabilities

* Remove jsondiffpatch dependency from package.json

* Implement auditing functionality with history tracking and agent reference in the Audits module

* Add history tracking plugin to Agents schema for auditing purposes

* Refactor metadata structure in history plugin to simplify createdBy and createdAt fields

* Remove console log from post-save hook in history plugin

* Add search filter options and schema decorators with tests for filtering functionality

* Refactor package dependencies and update import paths for restools; add DTO and ObjectId validation pipes

* feat: implement custom exceptions for factory drive module

* refactor: improve lifecycle service cron job handling and simplify trigger logic

* refactor: remove unused import from config.ts

Author: tacxou

extensions/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore

package.json

@@ -46,6 +46,8 @@
     "start:debug:webstorm": "node $NODE_DEBUG_OPTION -r ts-node/register -r tsconfig-paths/register src/main.ts"
   },
   "dependencies": {
+    "@aws-sdk/client-s3": ">=3.600.0",
+    "@aws-sdk/s3-request-presigner": "^3.600.0",
     "@nestjs-modules/ioredis": "^2.0.2",
     "@nestjs-modules/mailer": "^2.0.2",
     "@nestjs/axios": "^4.0.1",
@@ -60,9 +62,6 @@
     "@nestjs/platform-express": "^10.4.8",
     "@nestjs/schedule": "^6.0.0",
     "@nestjs/swagger": "^8.0.7",
-    "@the-software-compagny/nestjs_module_factorydrive": "^1.1.5",
-    "@the-software-compagny/nestjs_module_factorydrive-s3": "^1.0.1",
-    "@the-software-compagny/nestjs_module_restools": "^0.0.11",
     "ajv": "^8.16.0",
     "ajv-errors": "^3.0.0",
     "ajv-formats": "^3.0.1",
@@ -74,19 +73,24 @@
     "class-transformer": "^0.5.1",
     "class-validator": "^0.14.1",
     "cookie-parser": "^1.4.6",
+    "dayjs": "^1.11.18",
     "fast-password-entropy": "^1.1.1",
+    "fs-extra": "^11.3.2",
     "glob": "^11.0.0",
     "handlebars": "^4.7.8",
     "helmet": "^7.1.0",
     "hibp": "^14.1.2",
     "ioredis": "^5.4.1",
+    "is-plain-object": "^5.0.0",
     "loglevel": "^1.9.1",
     "lru-cache": "^11.0.2",
+    "microdiff": "^1.5.0",
     "mjml": "^4.15.3",
     "mongoose": "^8.9.5",
     "nest-commander": "^3.13.0",
     "nest-winston": "^1.10.0",
     "nestjs-request-context": "^3.0.0",
+    "node-exceptions": "^4.0.1",
     "nodemailer": "^6.9.16",
     "ora": "^8.1.0",
     "passport": "^0.7.0",
@@ -171,4 +175,4 @@
       "downloadUrl": "https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-debian10-5.0.22.tgz"
     }
   }
-}
+}

src/_common/abstracts/abstract.service.schema.ts

@@ -18,6 +18,7 @@ import { ServiceSchemaInterface } from './interfaces/service.schema.interface';
 import { AbstractSchema } from './schemas/abstract.schema';
 import mongodb from 'mongodb';
 import { omit } from 'radash';
+import { cp } from 'fs';
 
 @Injectable()
 export abstract class AbstractServiceSchema extends AbstractService implements ServiceSchemaInterface {
@@ -38,9 +39,10 @@ export abstract class AbstractServiceSchema extends AbstractService implements S
     options?: QueryOptions<T> | null | undefined,
   ): Promise<Query<Array<T>, T, any, T>[]> {
     if (this.eventEmitter) {
+      const eventName = [this.moduleName.toLowerCase(), this.serviceName.toLowerCase(), 'service', 'beforeFind'].join(EventEmitterSeparator)
       const beforeEvents = await this.eventEmitter?.emitAsync(
-        [this.moduleName.toLowerCase(), this.serviceName.toLowerCase(), 'service', 'beforeFind'].join(EventEmitterSeparator),
-        { filter, projection, options },
+        eventName,
+        { filter, projection, options, eventName },
       )
       for (const beforeEvent of beforeEvents) {
         if (beforeEvent?.stop) throw beforeEvent?.stop
@@ -55,9 +57,10 @@ export abstract class AbstractServiceSchema extends AbstractService implements S
 
   public async count<T extends AbstractSchema | Document>(filter?: FilterQuery<T>, options?: (mongodb.CountOptions & MongooseBaseQueryOptions<T>) | null): Promise<number> {
     if (this.eventEmitter) {
+      const eventName = [this.moduleName.toLowerCase(), this.serviceName.toLowerCase(), 'service', 'beforeCount'].join(EventEmitterSeparator)
       const beforeEvents = await this.eventEmitter?.emitAsync(
-        [this.moduleName.toLowerCase(), this.serviceName.toLowerCase(), 'service', 'beforeCount'].join(EventEmitterSeparator),
-        { filter, options },
+        eventName,
+        { filter, options, eventName },
       )
       for (const beforeEvent of beforeEvents) {
         if (beforeEvent?.stop) throw beforeEvent?.stop
@@ -85,9 +88,10 @@ export abstract class AbstractServiceSchema extends AbstractService implements S
   ): Promise<[Array<T & Query<T, T, any, T>>, number]> {
     this.logger.debug(['findAndCount', JSON.stringify(Object.values(arguments))].join(' '))
     if (this.eventEmitter) {
+      const beforeEventName = [this.moduleName.toLowerCase(), this.serviceName.toLowerCase(), 'service', 'beforeFindAndCount'].join(EventEmitterSeparator)
       const beforeEvents = await this.eventEmitter?.emitAsync(
-        [this.moduleName.toLowerCase(), this.serviceName.toLowerCase(), 'service', 'beforeFindAndCount'].join(EventEmitterSeparator),
-        { filter, projection, options },
+        beforeEventName,
+        { filter, projection, options, eventName: beforeEventName },
       )
       for (const beforeEvent of beforeEvents) {
         if (beforeEvent?.stop) throw beforeEvent?.stop
@@ -102,9 +106,10 @@ export abstract class AbstractServiceSchema extends AbstractService implements S
     let data = await this._model.find<T & Query<T, T, any, T>>(filter, projection, options).exec()
 
     if (this.eventEmitter) {
+      const eventName = [this.moduleName.toLowerCase(), this.serviceName.toLowerCase(), 'service', 'afterFindAndCount'].join(EventEmitterSeparator)
       const afterEvents = await this.eventEmitter?.emitAsync(
-        [this.moduleName.toLowerCase(), this.serviceName.toLowerCase(), 'service', 'afterFindAndCount'].join(EventEmitterSeparator),
-        { data, count },
+        eventName,
+        { data, count, eventName },
       )
       for (const afterEvent of afterEvents) {
         if (afterEvent?.data) data = { ...data, ...afterEvent.data }
@@ -123,9 +128,10 @@ export abstract class AbstractServiceSchema extends AbstractService implements S
     this.logger.debug(['findById', JSON.stringify(Object.values(arguments))].join(' '))
 
     if (this.eventEmitter) {
+      const beforeEventName = [this.moduleName.toLowerCase(), this.serviceName.toLowerCase(), 'service', 'beforeFindById'].join(EventEmitterSeparator)
       const beforeEvents = await this.eventEmitter?.emitAsync(
-        [this.moduleName.toLowerCase(), this.serviceName.toLowerCase(), 'service', 'beforeFindById'].join(EventEmitterSeparator),
-        { _id, projection, options },
+        beforeEventName,
+        { _id, projection, options, eventName: beforeEventName },
       )
       for (const beforeEvent of beforeEvents) {
         if (beforeEvent?.stop) throw beforeEvent?.stop
@@ -137,9 +143,10 @@ export abstract class AbstractServiceSchema extends AbstractService implements S
     let data = await this._model.findById<Query<T | null, T, any, T>>(_id, projection, options).exec()
 
     if (this.eventEmitter) {
+      const eventName = [this.moduleName.toLowerCase(), this.serviceName.toLowerCase(), 'service', 'afterFindById'].join(EventEmitterSeparator)
       const afterEvents = await this.eventEmitter?.emitAsync(
-        [this.moduleName.toLowerCase(), this.serviceName.toLowerCase(), 'service', 'afterFindById'].join(EventEmitterSeparator),
-        { data },
+        eventName,
+        { data, eventName },
       )
       for (const afterEvent of afterEvents) {
         if (afterEvent?.data) data = { ...data, ...afterEvent.data }
@@ -160,9 +167,10 @@ export abstract class AbstractServiceSchema extends AbstractService implements S
   ): Promise<Query<T, T, any, T>> {
     this.logger.debug(['findOne', JSON.stringify(Object.values(arguments))].join(' '))
     if (this.eventEmitter) {
+      const beforeEventName = [this.moduleName.toLowerCase(), this.serviceName.toLowerCase(), 'service', 'beforeFindOne'].join(EventEmitterSeparator)
       const beforeEvents = await this.eventEmitter?.emitAsync(
-        [this.moduleName.toLowerCase(), this.serviceName.toLowerCase(), 'service', 'beforeFindOne'].join(EventEmitterSeparator),
-        { filter, projection, options },
+        beforeEventName,
+        { filter, projection, options, eventName: beforeEventName },
       )
       for (const beforeEvent of beforeEvents) {
         if (beforeEvent?.stop) throw beforeEvent?.stop
@@ -177,9 +185,10 @@ export abstract class AbstractServiceSchema extends AbstractService implements S
       throw new NotFoundException()
     }
     if (this.eventEmitter) {
+      const eventName = [this.moduleName.toLowerCase(), this.serviceName.toLowerCase(), 'service', 'afterFindOne'].join(EventEmitterSeparator)
       const afterEvents = await this.eventEmitter?.emitAsync(
-        [this.moduleName.toLowerCase(), this.serviceName.toLowerCase(), 'service', 'afterFindOne'].join(EventEmitterSeparator),
-        { data },
+        eventName,
+        { data, eventName },
       )
       for (const afterEvent of afterEvents) {
         if (afterEvent?.data) data = { ...data, ...afterEvent.data }
@@ -198,9 +207,10 @@ export abstract class AbstractServiceSchema extends AbstractService implements S
     })
     this.logger.debug(['create', JSON.stringify(logInfos)].join(' '))
     if (this.eventEmitter) {
+      const beforeEventName = [this.moduleName.toLowerCase(), this.serviceName.toLowerCase(), 'service', 'beforeCreate'].join(EventEmitterSeparator)
       const beforeEvents = await this.eventEmitter?.emitAsync(
-        [this.moduleName.toLowerCase(), this.serviceName.toLowerCase(), 'service', 'beforeCreate'].join(EventEmitterSeparator),
-        { data, options },
+        beforeEventName,
+        { data, options, eventName: beforeEventName },
       )
       for (const beforeEvent of beforeEvents) {
         if (beforeEvent?.stop) throw beforeEvent?.stop
@@ -219,9 +229,10 @@ export abstract class AbstractServiceSchema extends AbstractService implements S
     })
     let created = document.save(options)
     if (this.eventEmitter) {
+      const eventName = [this.moduleName.toLowerCase(), this.serviceName.toLowerCase(), 'service', 'afterCreate'].join(EventEmitterSeparator)
       const afterEvents = await this.eventEmitter?.emitAsync(
-        [this.moduleName.toLowerCase(), this.serviceName.toLowerCase(), 'service', 'afterCreate'].join(EventEmitterSeparator),
-        { created },
+        eventName,
+        { created, eventName },
       )
       for (const afterEvent of afterEvents) {
         if (afterEvent?.created) created = { ...created, ...afterEvent.created }
@@ -244,9 +255,10 @@ export abstract class AbstractServiceSchema extends AbstractService implements S
     })
     this.logger.debug(['update', JSON.stringify(logInfos)].join(' '))
     if (this.eventEmitter) {
+      const beforeEventName = [this.moduleName.toLowerCase(), this.serviceName.toLowerCase(), 'service', 'beforeUpdate'].join(EventEmitterSeparator)
       const beforeEvents = await this.eventEmitter?.emitAsync(
-        [this.moduleName.toLowerCase(), this.serviceName.toLowerCase(), 'service', 'beforeUpdate'].join(EventEmitterSeparator),
-        { _id, update, options },
+        beforeEventName,
+        { _id, update, options, eventName: beforeEventName },
       )
       for (const beforeEvent of beforeEvents) {
         if (beforeEvent?.stop) throw beforeEvent?.stop
@@ -282,9 +294,10 @@ export abstract class AbstractServiceSchema extends AbstractService implements S
       throw new NotFoundException()
     }
     if (this.eventEmitter) {
+      const eventName = [this.moduleName.toLowerCase(), this.serviceName.toLowerCase(), 'service', 'afterUpdate'].join(EventEmitterSeparator)
       const afterEvents = await this.eventEmitter?.emitAsync(
-        [this.moduleName.toLowerCase(), this.serviceName.toLowerCase(), 'service', 'afterUpdate'].join(EventEmitterSeparator),
-        { before, updated },
+        eventName,
+        { before, updated, eventName },
       )
       for (const afterEvent of afterEvents) {
         if (afterEvent?.updated) updated = { ...updated, ...afterEvent.updated }
@@ -300,9 +313,10 @@ export abstract class AbstractServiceSchema extends AbstractService implements S
   ): Promise<ModifyResult<Query<T, T, any, T>>> {
     this.logger.debug(['upsert', JSON.stringify(Object.values(arguments))].join(' '));
     if (this.eventEmitter) {
+      const beforeEventName = [this.moduleName.toLowerCase(), this.serviceName.toLowerCase(), 'service', 'beforeUpsert'].join(EventEmitterSeparator);
       const beforeEvents = await this.eventEmitter?.emitAsync(
-        [this.moduleName.toLowerCase(), this.serviceName.toLowerCase(), 'service', 'beforeUpsert'].join(EventEmitterSeparator),
-        { filter, update, options },
+        beforeEventName,
+        { filter, update, options, eventName: beforeEventName },
       );
       for (const beforeEvent of beforeEvents) {
         if (beforeEvent?.stop) throw beforeEvent?.stop;
@@ -338,9 +352,10 @@ export abstract class AbstractServiceSchema extends AbstractService implements S
       .exec();
 
     if (this.eventEmitter) {
+      const eventName = [this.moduleName.toLowerCase(), this.serviceName.toLowerCase(), 'service', 'afterUpsert'].join(EventEmitterSeparator)
       const afterEvents = await this.eventEmitter?.emitAsync(
-        [this.moduleName.toLowerCase(), this.serviceName.toLowerCase(), 'service', 'afterUpsert'].join(EventEmitterSeparator),
-        { result, before },
+        eventName,
+        { result, before, eventName },
       );
       for (const afterEvent of afterEvents) {
         if (afterEvent?.result) result = { ...result, ...afterEvent.result };
@@ -358,9 +373,10 @@ export abstract class AbstractServiceSchema extends AbstractService implements S
   public async delete<T extends AbstractSchema | Document>(_id: Types.ObjectId | any, options?: QueryOptions<T> | null | undefined): Promise<Query<T, T, any, T>> {
     this.logger.debug(['delete', JSON.stringify(Object.values(arguments))].join(' '))
     if (this.eventEmitter) {
+      const beforeEventName = [this.moduleName.toLowerCase(), this.serviceName.toLowerCase(), 'service', 'beforeDelete'].join(EventEmitterSeparator)
       const beforeEvents = await this.eventEmitter?.emitAsync(
-        [this.moduleName.toLowerCase(), this.serviceName.toLowerCase(), 'service', 'beforeDelete'].join(EventEmitterSeparator),
-        { _id, options },
+        beforeEventName,
+        { _id, options, eventName: beforeEventName },
       )
       for (const beforeEvent of beforeEvents) {
         if (beforeEvent?.stop) throw beforeEvent?.stop
@@ -374,9 +390,10 @@ export abstract class AbstractServiceSchema extends AbstractService implements S
       throw new NotFoundException()
     }
     if (this.eventEmitter) {
+      const eventName = [this.moduleName.toLowerCase(), this.serviceName.toLowerCase(), 'service', 'afterDelete'].join(EventEmitterSeparator)
       const afterEvents = await this.eventEmitter?.emitAsync(
-        [this.moduleName.toLowerCase(), this.serviceName.toLowerCase(), 'service', 'afterDelete'].join(EventEmitterSeparator),
-        { before, deleted },
+        eventName,
+        { before, deleted, eventName },
       )
       for (const afterEvent of afterEvents) {
         if (afterEvent?.deleted) deleted = { ...deleted, ...afterEvent.deleted }

src/_common/factorydrive/exceptions/authorization-required.exception.ts

@@ -0,0 +1,10 @@
+import { RuntimeException } from 'node-exceptions'
+
+export class AuthorizationRequiredException extends RuntimeException {
+  public raw: Error
+
+  public constructor(err: Error, path: string) {
+    super(`Unauthorized to access file ${path}\n${err.message}`, 500, 'E_AUTHORIZATION_REQUIRED')
+    this.raw = err
+  }
+}

src/_common/factorydrive/exceptions/driver-not-supported.exception.ts

@@ -0,0 +1,11 @@
+import { RuntimeException } from 'node-exceptions'
+
+export class DriverNotSupportedException extends RuntimeException {
+  public driver!: string
+
+  public static driver(name: string): DriverNotSupportedException {
+    const exception = new this(`Driver ${name} is not supported`, 400)
+    exception.driver = name
+    return exception
+  }
+}

src/_common/factorydrive/exceptions/file-not-found.exception.ts

@@ -0,0 +1,10 @@
+import { RuntimeException } from 'node-exceptions'
+
+export class FileNotFoundException extends RuntimeException {
+  public raw: Error
+
+  public constructor(err: Error, path: string) {
+    super(`The file ${path} doesn't exist\n${err.message}`, 500, 'E_FILE_NOT_FOUND')
+    this.raw = err
+  }
+}

src/_common/factorydrive/exceptions/index.ts

@@ -0,0 +1,9 @@
+export * from './authorization-required.exception'
+export * from './driver-not-supported.exception'
+export * from './file-not-found.exception'
+export * from './invalid-config.exception'
+export * from './method-not-supported.exception'
+export * from './no-such-bucket.exception'
+export * from './permission-missing.exception'
+export * from './unknown.exception'
+export * from './wrong-key-path.exception'

src/_common/factorydrive/exceptions/invalid-config.exception.ts

@@ -0,0 +1,19 @@
+import { RuntimeException } from 'node-exceptions'
+
+export class InvalidConfigException extends RuntimeException {
+  public static missingDiskName(): InvalidConfigException {
+    return new this('Make sure to define a default disk name inside config file', 500, 'E_INVALID_CONFIG')
+  }
+
+  public static missingDiskConfig(name: string): InvalidConfigException {
+    return new this(`Make sure to define config for ${name} disk`, 500, 'E_INVALID_CONFIG')
+  }
+
+  public static missingDiskDriver(name: string): InvalidConfigException {
+    return new this(`Make sure to define driver for ${name} disk`, 500, 'E_INVALID_CONFIG')
+  }
+
+  public static duplicateDiskName(name: string): InvalidConfigException {
+    return new this(`A disk named ${name} is already defined`, 500, 'E_INVALID_CONFIG')
+  }
+}

src/_common/factorydrive/exceptions/method-not-supported.exception.ts

@@ -0,0 +1,7 @@
+import { RuntimeException } from 'node-exceptions'
+
+export class MethodNotSupportedException extends RuntimeException {
+  public constructor(name: string, driver: string) {
+    super(`Method ${name} is not supported for the driver ${driver}`, 500, 'E_METHOD_NOT_SUPPORTED')
+  }
+}

src/_common/factorydrive/exceptions/no-such-bucket.exception.ts

@@ -0,0 +1,10 @@
+import { RuntimeException } from 'node-exceptions'
+
+export class NoSuchBucketException extends RuntimeException {
+  public raw: Error
+
+  public constructor(err: Error, bucket: string) {
+    super(`The bucket ${bucket} doesn't exist\n${err.message}`, 500, 'E_NO_SUCH_BUCKET')
+    this.raw = err
+  }
+}