feat: implement custom exceptions for factory drive module

Author: tacxou

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,8 +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",
     "ajv": "^8.16.0",
     "ajv-errors": "^3.0.0",
     "ajv-formats": "^3.0.1",
@@ -75,6 +75,7 @@
     "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",
@@ -89,6 +90,7 @@
     "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",
@@ -173,4 +175,4 @@
       "downloadUrl": "https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-debian10-5.0.22.tgz"
     }
   }
-}
+}

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
+  }
+}

src/_common/factorydrive/exceptions/permission-missing.exception.ts

@@ -0,0 +1,10 @@
+import { RuntimeException } from 'node-exceptions'
+
+export class PermissionMissingException extends RuntimeException {
+  public raw: Error
+
+  public constructor(err: Error, path: string) {
+    super(`Missing permission for file ${path}\n${err.message}`, 500, 'E_PERMISSION_MISSING')
+    this.raw = err
+  }
+}

src/_common/factorydrive/exceptions/unknown.exception.ts

@@ -0,0 +1,17 @@
+import { RuntimeException } from 'node-exceptions'
+
+export class UnknownException extends RuntimeException {
+  public raw: Error
+
+  public constructor(err: Error, errorCode: string, path: string) {
+    super(
+      `An unknown error happened with the file ${path}.
+            Error code: ${errorCode}
+            Original stack:
+            ${err.stack}`,
+      500,
+      'E_UNKNOWN',
+    )
+    this.raw = err
+  }
+}