@futdevpro/nts-dynamo 1.9.15 → 1.9.16

package/src/_services/route/routing-module.service.ts

@@ -1,273 +1,293 @@
-
-import { Router } from 'express';
-
-import { DynamoFM_Error, DynamoFM_ErrorLevel, DynamoFM_Log } from '@futdevpro/fsm-dynamo';
-
-import { DynamoNTS_globalSettings } from '../../_constants/global-settings.const';
-import { DynamoNTS_RouteSecurity } from '../../_enums/route-security.enum';
-import { DynamoNTS_HttpCallType } from '../../_enums/http/http-call-type.enum';
-import { DynamoNTS_Controller } from './controller.service';
-import { 
-  DynamoNTS_RoutingModule_Settings 
-} from '../../_models/interfaces/routing-module-settings.interface';
-import { 
-  DynamoNTS_Endpoint_Params 
-} from '../../_models/control-models/endpoint-params.control-model';
-
-/**
- * Routing Module
- * Handling route setup and control
- * 
- * You can add routes and controllers for them
- * @example
- *   // Setting up Routes
- *   setupRoutingModules(): void {
- *     this.httpPort = env.port;
-
- *     this.routingModules = [
- *       new DynamoNTS_RoutingModule({
- *         route: '/user',
- *         controllers: [ 
- *           UserController.getInstance(),
- *           UserDataController.getInstance(),
- *           UserOptionsController.getInstance(),
- *           UserStatisticsController.getInstance(),
- *           UserAchievementsController.getInstance(),
- *           UserNotificationsController.getInstance()
- *         ]
- *       }),
- *       new DynamoNTS_RoutingModule({
- *         route: '/match',
- *         controllers: [ 
- *           MatchController.getInstance(),
- *           MatchDistributionController.getInstance(),
- *           MatchStatisticsController.getInstance(),
- *         ]
- *       }),
- *       new DynamoNTS_RoutingModule({
- *         route: '/server',
- *         controllers: [ 
- *           ServerController.getInstance(),
- *         ]
- *       }),
-
- *       getTestRoutingModule(),
- *       getUsageRoutingModule()
- *     ];
- *   }
- */
-export class DynamoNTS_RoutingModule {
-
-  serviceName: string;
-  
-  security: DynamoNTS_RouteSecurity;
-  route: string;
-
-  private controllers: DynamoNTS_Controller[];
-  endpoints: DynamoNTS_Endpoint_Params[] = [];
-
-  openRouter: Router = Router();
-  secureRouter: Router = Router();
-
-  protected log: boolean = DynamoNTS_globalSettings.logSetup;
-
-  defaultErrorUserMsg = 
-    `We encountered an uncaught BackEnd Build Error, ` +
-    `\nplease contact the responsible development team.`;
-
-  constructor(
-    set: DynamoNTS_RoutingModule_Settings
-  ){
-    try {
-      this.serviceName = set.route.replace('/', '') + 'RoutingModule';
-      this.route = DynamoNTS_globalSettings.baseUrl + set.route;
-      this.controllers = set.controllers ?? [];
-      this.setupRoutes();
-      this.mountRoutes(set.securityOverride);
-
-      if (this.log) console.log(
-        `routing module setup done: ${this.route} security: ${this.security}\n`
-      );
-    } catch (error) {
-      /* DynamoFM_Log.error(`\nRouting module setup failed (${this.route})`, error); */
-      throw new DynamoFM_Error({
-        errorCode: 'NTS-RMS-000',
-        addECToUserMsg: true,
-        message: `Routing module setup failed (${this.route}).`, 
-        userMessage: this.defaultErrorUserMsg, 
-        issuerService: this.serviceName + ' - ' + this.route,
-        error,
-        additionalContent: set,
-      });
-    }
-  }
-
-  /**
-   * You must setup endpoints and required services for this function
-   */
-  private setupRoutes(): void {
-    this.controllers.forEach((controller: DynamoNTS_Controller): void => {
-      try {
-        controller.setupEndpoints();
-      } catch (error) {
-        throw new DynamoFM_Error({
-          message: 'DynamoBEController setup failed. Please check the setupEndpoints() method.',
-          errorCode: 'NTS-RMS-SR1',
-          issuerService: `${this?.constructor?.name} > ${controller?.constructor?.name}`,
-          error: error,
-          level: DynamoFM_ErrorLevel.critical,
-        });
-      }
-    
-      if (controller?.endpoints?.length) {
-        this.endpoints.push(...controller.endpoints);
-      }
-    });
-  }
-
-  /**
-   * 
-   * @param securityOverride 
-   */
-  private mountRoutes(securityOverride?: DynamoNTS_RouteSecurity): void {
-    if (securityOverride) {
-      this.security = securityOverride;
-    }
-
-    this.endpoints.forEach((endpoint: DynamoNTS_Endpoint_Params): void => {
-      if (securityOverride) {
-        endpoint.security = securityOverride;
-      } else {
-        if (!endpoint.security) {
-          DynamoFM_Log.error(`Endpoint security not set: ${endpoint.endpoint}\n`);
-        } else if (!this.security) {
-          this.security = endpoint.security;
-        } else if (this.security !== endpoint.security) {
-          this.security = DynamoNTS_RouteSecurity.both;
-        }
-      }
-
-      if (this.log) console.log(
-        `endpoint mount (${endpoint.security}): ${this.route}${endpoint.endpoint}`
-      );
-      const existingEndPoints: DynamoNTS_Endpoint_Params[] = this.endpoints.filter(
-        (e_params: DynamoNTS_Endpoint_Params): boolean => e_params.endpoint === endpoint.endpoint
-      );
-        
-      if (1 < existingEndPoints.length) {
-        const error = new Error(`ENDPOINT DUPLICATION: ${endpoint.endpoint}`);
-        const errorStack: string[] = error.stack.split('\n');
-
-        errorStack.splice(1, 4);
-        error.stack = errorStack.join('\n');
-
-        throw error;
-      }
-
-      try {
-        if (endpoint.security !== DynamoNTS_RouteSecurity.secure) {
-          this.mountOpenRoute(endpoint);
-        }
-
-        if (endpoint.security !== DynamoNTS_RouteSecurity.open) {
-          this.mountSecureRoute(endpoint);
-        }
-      } catch (error) {
-        DynamoFM_Log.error(`\nRouting module setup failed (${this.route})`, error);
-
-        throw new DynamoFM_Error({ 
-          errorCode: 'NTS-RMS-100',
-          addECToUserMsg: true,
-          message: `DYNAMO-NTS ERROR: Failed to mount routes.`, 
-          userMessage: this.defaultErrorUserMsg, 
-          issuerService: this.serviceName + ' - ' + this.route,
-          error,
-        });
-      }
-    });
-  }
-
-  /**
-   * 
-   * @param endpointParams 
-   */
-  private mountOpenRoute(endpointParams: DynamoNTS_Endpoint_Params): void {
-    switch (endpointParams.type) {
-      case DynamoNTS_HttpCallType.get:
-        this.openRouter.get(endpointParams.endpoint, endpointParams.getFullExecution());
-        break;
-
-      case DynamoNTS_HttpCallType.post:
-        this.openRouter.post(endpointParams.endpoint, endpointParams.getFullExecution());
-        break;
-
-      case DynamoNTS_HttpCallType.put:
-        this.openRouter.put(endpointParams.endpoint, endpointParams.getFullExecution());
-        break;
-
-      case DynamoNTS_HttpCallType.patch:
-        this.openRouter.patch(endpointParams.endpoint, endpointParams.getFullExecution());
-        break;
-
-      case DynamoNTS_HttpCallType.delete:
-        this.openRouter.delete(endpointParams.endpoint, endpointParams.getFullExecution());
-        break;
-
-      default:
-        DynamoFM_Log.error(`INVALID route type: ${endpointParams.type} - ${endpointParams.name}`);
-
-        throw new DynamoFM_Error({ 
-          errorCode: 'NTS-RMS-200',
-          addECToUserMsg: true,
-          message:
-            `DYNAMO-NTS ERROR: INVALID route type: ${endpointParams.type} - ${endpointParams.name}`,
-          userMessage: this.defaultErrorUserMsg, 
-          issuerService: this.serviceName + ' - ' + this.route,
-          error: new Error(),
-        });
-    }
-  }
-
-  /**
-   * 
-   * @param endpointParams 
-   */
-  private mountSecureRoute(endpointParams: DynamoNTS_Endpoint_Params): void {
-    switch (endpointParams.type) {
-      case DynamoNTS_HttpCallType.get:
-        this.secureRouter.get(endpointParams.endpoint, endpointParams.getFullExecution());
-        break;
-
-      case DynamoNTS_HttpCallType.post:
-        this.secureRouter.post(endpointParams.endpoint, endpointParams.getFullExecution());
-        break;
-
-      case DynamoNTS_HttpCallType.put:
-        this.secureRouter.put(endpointParams.endpoint, endpointParams.getFullExecution());
-        break;
-
-      case DynamoNTS_HttpCallType.patch:
-        this.secureRouter.patch(endpointParams.endpoint, endpointParams.getFullExecution());
-        break;
-
-      case DynamoNTS_HttpCallType.delete:
-        this.secureRouter.delete(endpointParams.endpoint, endpointParams.getFullExecution());
-        break;
-
-      default:
-        DynamoFM_Log.error(
-          `DYNAMO-NTS ERROR: INVALID route type: ${endpointParams.type} - ${endpointParams.name}`
-        );
-
-        throw new DynamoFM_Error({ 
-          errorCode: 'NTS-RMS-300',
-          addECToUserMsg: true,
-          message: 
-            `DYNAMO-NTS ERROR: INVALID route type: ${endpointParams.type} - ${endpointParams.name}`,
-          userMessage: this.defaultErrorUserMsg, 
-          issuerService: this.serviceName + ' - ' + this.route,
-          error: new Error(),
-        });
-    }
-  }
-}
+
+import { Router } from 'express';
+
+import { DynamoFM_AnyError, DynamoFM_Error, DynamoFM_ErrorLevel, DynamoFM_Error_Settings, DynamoFM_Log } from '@futdevpro/fsm-dynamo';
+
+import { DynamoNTS_globalSettings } from '../../_constants/global-settings.const';
+import { DynamoNTS_RouteSecurity } from '../../_enums/route-security.enum';
+import { DynamoNTS_HttpCallType } from '../../_enums/http/http-call-type.enum';
+import { DynamoNTS_Controller } from './controller.service';
+import { 
+  DynamoNTS_RoutingModule_Settings 
+} from '../../_models/interfaces/routing-module-settings.interface';
+import { 
+  DynamoNTS_Endpoint_Params 
+} from '../../_models/control-models/endpoint-params.control-model';
+
+/**
+ * Routing Module
+ * Handling route setup and control
+ * 
+ * You can add routes and controllers for them
+ * @example
+ *   // Setting up Routes
+ *   setupRoutingModules(): void {
+ *     this.httpPort = env.port;
+
+ *     this.routingModules = [
+ *       new DynamoNTS_RoutingModule({
+ *         route: '/user',
+ *         controllers: [ 
+ *           UserController.getInstance(),
+ *           UserDataController.getInstance(),
+ *           UserOptionsController.getInstance(),
+ *           UserStatisticsController.getInstance(),
+ *           UserAchievementsController.getInstance(),
+ *           UserNotificationsController.getInstance()
+ *         ]
+ *       }),
+ *       new DynamoNTS_RoutingModule({
+ *         route: '/match',
+ *         controllers: [ 
+ *           MatchController.getInstance(),
+ *           MatchDistributionController.getInstance(),
+ *           MatchStatisticsController.getInstance(),
+ *         ]
+ *       }),
+ *       new DynamoNTS_RoutingModule({
+ *         route: '/server',
+ *         controllers: [ 
+ *           ServerController.getInstance(),
+ *         ]
+ *       }),
+
+ *       getTestRoutingModule(),
+ *       getUsageRoutingModule()
+ *     ];
+ *   }
+ */
+export class DynamoNTS_RoutingModule {
+
+  serviceName: string;
+  
+  security: DynamoNTS_RouteSecurity;
+  route: string;
+
+  private controllers: DynamoNTS_Controller[];
+  endpoints: DynamoNTS_Endpoint_Params[] = [];
+
+  openRouter: Router = Router();
+  secureRouter: Router = Router();
+
+  protected log: boolean = DynamoNTS_globalSettings.logSetup;
+
+  defaultErrorUserMsg = 
+    `We encountered an uncaught BackEnd Build Error, ` +
+    `\nplease contact the responsible development team.`;
+
+  constructor(
+    set: DynamoNTS_RoutingModule_Settings
+  ){
+    try {
+      this.serviceName = set.route.replace('/', '') + 'RoutingModule';
+      this.route = DynamoNTS_globalSettings.baseUrl + set.route;
+      this.controllers = set.controllers ?? [];
+      this.setupRoutes();
+      this.mountRoutes(set.securityOverride);
+
+      if (this.log) console.log(
+        `routing module setup done: ${this.route} security: ${this.security}\n`
+      );
+    } catch (error) {
+      /* DynamoFM_Log.error(`\nRouting module setup failed (${this.route})`, error); */
+      throw new DynamoFM_Error({
+        ...this.getDefaultErrorSettings(
+          'constructor', 
+          new Error(`Routing module setup failed (${this.route}).`)
+        ),
+
+        errorCode: 'NTS-RMS-000',
+        additionalContent: set,
+      });
+    }
+  }
+
+  /**
+   * You must setup endpoints and required services for this function
+   */
+  private setupRoutes(): void {
+    this.controllers.forEach((controller: DynamoNTS_Controller): void => {
+      try {
+        controller.setupEndpoints();
+      } catch (error) {
+        throw new DynamoFM_Error({
+          ...this.getDefaultErrorSettings(
+            'setupRoutes', 
+            new Error(`DynamoBEController setup failed. Please check the setupEndpoints() method.`)
+          ),
+
+          errorCode: 'NTS-RMS-SR1',
+          level: DynamoFM_ErrorLevel.critical,
+        });
+      }
+    
+      if (controller?.endpoints?.length) {
+        this.endpoints.push(...controller.endpoints);
+      }
+    });
+  }
+
+  /**
+   * 
+   * @param securityOverride 
+   */
+  private mountRoutes(securityOverride?: DynamoNTS_RouteSecurity): void {
+    if (securityOverride) {
+      this.security = securityOverride;
+    }
+
+    this.endpoints.forEach((endpoint: DynamoNTS_Endpoint_Params): void => {
+      if (securityOverride) {
+        endpoint.security = securityOverride;
+      } else {
+        if (!endpoint.security) {
+          DynamoFM_Log.error(`Endpoint security not set: ${endpoint.endpoint}\n`);
+        } else if (!this.security) {
+          this.security = endpoint.security;
+        } else if (this.security !== endpoint.security) {
+          this.security = DynamoNTS_RouteSecurity.both;
+        }
+      }
+
+      if (this.log) console.log(
+        `endpoint mount (${endpoint.security}): ${this.route}${endpoint.endpoint}`
+      );
+      const existingEndPoints: DynamoNTS_Endpoint_Params[] = this.endpoints.filter(
+        (e_params: DynamoNTS_Endpoint_Params): boolean => e_params.endpoint === endpoint.endpoint
+      );
+        
+      if (1 < existingEndPoints.length) {
+        const error = new Error(`ENDPOINT DUPLICATION: ${endpoint.endpoint}`);
+        const errorStack: string[] = error.stack.split('\n');
+
+        errorStack.splice(1, 4);
+        error.stack = errorStack.join('\n');
+
+        throw error;
+      }
+
+      try {
+        if (endpoint.security !== DynamoNTS_RouteSecurity.secure) {
+          this.mountOpenRoute(endpoint);
+        }
+
+        if (endpoint.security !== DynamoNTS_RouteSecurity.open) {
+          this.mountSecureRoute(endpoint);
+        }
+      } catch (error) {
+        DynamoFM_Log.error(`\nRouting module setup failed (${this.route})`, error);
+
+        throw new DynamoFM_Error({ 
+          ...this.getDefaultErrorSettings(
+            'mountRoutes', 
+            new Error(`DYNAMO-NTS ERROR: Failed to mount routes.`)
+          ),
+
+          errorCode: 'NTS-RMS-100',
+        });
+      }
+    });
+  }
+
+  /**
+   * 
+   * @param endpointParams 
+   */
+  private mountOpenRoute(endpointParams: DynamoNTS_Endpoint_Params): void {
+    switch (endpointParams.type) {
+      case DynamoNTS_HttpCallType.get:
+        this.openRouter.get(endpointParams.endpoint, endpointParams.getFullExecution());
+        break;
+
+      case DynamoNTS_HttpCallType.post:
+        this.openRouter.post(endpointParams.endpoint, endpointParams.getFullExecution());
+        break;
+
+      case DynamoNTS_HttpCallType.put:
+        this.openRouter.put(endpointParams.endpoint, endpointParams.getFullExecution());
+        break;
+
+      case DynamoNTS_HttpCallType.patch:
+        this.openRouter.patch(endpointParams.endpoint, endpointParams.getFullExecution());
+        break;
+
+      case DynamoNTS_HttpCallType.delete:
+        this.openRouter.delete(endpointParams.endpoint, endpointParams.getFullExecution());
+        break;
+
+      default:
+        DynamoFM_Log.error(`INVALID route type: ${endpointParams.type} - ${endpointParams.name}`);
+
+        throw new DynamoFM_Error({ 
+          ...this.getDefaultErrorSettings(
+            'mountOpenRoute', 
+            new Error(
+              `DYNAMO-NTS ERROR: INVALID route type: ` +
+              `${endpointParams.type} - ${endpointParams.name}`
+            ),
+          ),
+
+          errorCode: 'NTS-RMS-200',
+        });
+    }
+  }
+
+  /**
+   * 
+   * @param endpointParams 
+   */
+  private mountSecureRoute(endpointParams: DynamoNTS_Endpoint_Params): void {
+    switch (endpointParams.type) {
+      case DynamoNTS_HttpCallType.get:
+        this.secureRouter.get(endpointParams.endpoint, endpointParams.getFullExecution());
+        break;
+
+      case DynamoNTS_HttpCallType.post:
+        this.secureRouter.post(endpointParams.endpoint, endpointParams.getFullExecution());
+        break;
+
+      case DynamoNTS_HttpCallType.put:
+        this.secureRouter.put(endpointParams.endpoint, endpointParams.getFullExecution());
+        break;
+
+      case DynamoNTS_HttpCallType.patch:
+        this.secureRouter.patch(endpointParams.endpoint, endpointParams.getFullExecution());
+        break;
+
+      case DynamoNTS_HttpCallType.delete:
+        this.secureRouter.delete(endpointParams.endpoint, endpointParams.getFullExecution());
+        break;
+
+      default:
+        DynamoFM_Log.error(
+          `DYNAMO-NTS ERROR: INVALID route type: ${endpointParams.type} - ${endpointParams.name}`
+        );
+
+        throw new DynamoFM_Error({ 
+          ...this.getDefaultErrorSettings(
+            'mountSecureRoute', 
+            new Error(
+              `DYNAMO-NTS ERROR: INVALID route type: ` +
+              `${endpointParams.type} - ${endpointParams.name}`
+            ),
+          ),
+
+          errorCode: 'NTS-RMS-300',
+        });
+    }
+  }
+
+  private getDefaultErrorSettings(
+    fnName: string, 
+    error: DynamoFM_AnyError
+  ): DynamoFM_Error_Settings {
+    return {
+      status: 500,
+      message: (error as Error)?.message ?? `${fnName} was UNSUCCESSFUL (NTS)`,
+      issuerService: this.constructor?.name,
+      userMessage: (error as DynamoFM_Error)?.__userMessage ?? this.defaultErrorUserMsg,
+      addECToUserMsg: true,
+      error: error,
+    };
+  }
+}