@futdevpro/nts-dynamo 1.15.157 → 1.15.160

package/src/_services/route/controller.service.spec.ts

@@ -1,53 +0,0 @@
-
-import { DyFM_HttpCallType } from '@futdevpro/fsm-dynamo';
-
-import { DyNTS_Endpoint_Params } from '../../_models/control-models/endpoint-params.control-model';
-import { DyNTS_Controller } from './controller.service';
-
-class TestController extends DyNTS_Controller {
-  setupEndpoints(): void {
-    this.endpoints = [
-      new DyNTS_Endpoint_Params({
-        name: 'testEndpoint',
-        type: DyFM_HttpCallType.get,
-        endpoint: '/test-endpoint',
-        preProcesses: [],
-        tasks: [
-          async (req: any, res: any) => {
-            res.send({ message: 'Test successful' });
-          },
-        ],
-      }),
-    ];
-  }
-
-  static getInstance(): TestController {
-    return new TestController();
-  }
-}
-
-describe('| DyNTS_Controller', () => {
-  let controller: TestController;
-
-  beforeEach(() => {
-    controller = TestController.getInstance();
-    controller.setupEndpoints();
-  });
-
-  it('| should initialize endpoints correctly', () => {
-    expect(controller.endpoints.length).toBe(1);
-    expect(controller.endpoints[0].name).toBe('testEndpoint');
-    expect(controller.endpoints[0].endpoint).toBe('/test-endpoint');
-  });
-
-  /* it('| should execute task and send response', async () => {
-    const req = {};
-    const res = {
-      send: jasmine.createSpy('send'),
-    };
-
-    await controller.endpoints[0].tasks[0](req, res);
-
-    expect(res.send).toHaveBeenCalledWith({ message: 'Test successful' });
-  }); */
-});

package/src/_services/route/controller.service.ts

@@ -1,148 +0,0 @@
-
-
-import {
-  DyNTS_Endpoint_Params
-} from '../../_models/control-models/endpoint-params.control-model';
-
-import { DyNTS_SingletonService } from '../base/singleton.service';
-
-/**
- * Basic controller for endpoint handlings
- * 
- * (You'll need to add them to a {@link DyNTS_RoutingModule} through it's constructor)
- * 
- * You can add default endpoints to the controller by using the {@link DyNTS_DefaultEndpoints_Util} utility class
- * 
- * @example
- * this.endpoints = [
- *   ...DyNTS_DefaultEndpoints_Util.getAllDefaultEndpoints({
- *     entityName: 'UserMatchStatistics',
- *     dataServiceClass: UserMatchStatistics_DataService,
- *     endpoints: {
- *       get: '/get/user-match-statistics/:userId',
- *       search: '/search/user-match-statistics',
- *       modify: '/modify/user-match-statistics',
- *       patch: '/patch/user-match-statistics/:userId',
- *       delete: '/delete/user-match-statistics/:userId',
- *     },
- *     authService: this.authService,
- *   }),
- * ];
- * 
- * @example
- * export class UserMatchStatisticsController extends DyNTS_Controller {
- *
- * static getInstance(): UserMatchStatisticsController {
- *   return UserMatchStatisticsController.getSingletonInstance();
- * }
- *
- *   // SERVICES
- *   private authService: AuthService;
- *
- *   setupEndpoints(): void {
- *     this.authService = AuthService.getInstance();
- *
- *     this.endpoints = [
- *       new DyNTS_Endpoint_Params({
- *         name: 'getUserMatchStatistics',
- *         type: DyFM_HttpCallType.get,
- *         endpoint: '/get/user-match-statistics/:userId',
- *         preProcesses: [ this.authService.authenticate_tokenSelf ],
- *         tasks: [ 
- *           async (req: Request, res: Response) => {
- *             const userMatchStatistics = new UserMatchStatisticsService({ 
- *               data: { userId: req.params.userId }
- *             });
- * 
- *             await userMatchStatistics.getDataByDependencyId();
- *             
- *             res.send(
- *               userMatchStatistics.data
- *             );
- *           }
- *         ]
- *       }),
- *     ];
- *   }
- * }
- */
-export abstract class DyNTS_Controller extends DyNTS_SingletonService {
-
-  /**
-   * setup this in the setupEndpoints(), which will be called on the construcion
-   * 
-   * @example
-   * 
-   * this.endpoints = [
-   *   new DyNTS_Endpoint_Params({
-   *     name: 'getUserMatchStatistics',
-   *     type: DyFM_HttpCallType.get,
-   *     endpoint: '/get/user-match-statistics/:userId',
-   *     preProcesses: [ this.authService.authenticate_tokenSelf ],
-   *     tasks: [ 
-   *       async (req: Request, res: Response) => {
-   *         const userMatchStatistics = new UserMatchStatisticsService({ 
-   *           data: { userId: req.params.userId }
-   *         });
-   * 
-   *         await userMatchStatistics.getDataByDependencyId();
-   *         
-   *         res.send(
-   *           userMatchStatistics.data
-   *         );
-   *       }
-   *     ]
-   *   }),
-   * ];
-   */
-  endpoints: DyNTS_Endpoint_Params[];
-
-  /* protected constructor(){
-    super();
-    
-    try {
-      this.setupEndpoints();
-    } catch (error) {
-      throw new DyFM_Error({
-        message: 'DynamoNTSController setup failed. Please check the setupEndpoints() method.',
-        errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-COS-000',
-        issuerService: this?.constructor?.name,
-        error: error,
-        level: DyFM_ErrorLevel.critical,
-      });
-    }
-  } */
-
-  /**
-   * You must setup endpoints and required services in this function
-   * 
-   * @example
-   * 
-   * setupEndpoints(): void {
-   *   this.authService = AuthService.getInstance();
-   *
-   *   this.endpoints = [
-   *     new DyNTS_Endpoint_Params({
-   *       name: 'getUserMatchStatistics',
-   *       type: DyFM_HttpCallType.get,
-   *       endpoint: '/get/user-match-statistics/:userId',
-   *       preProcesses: [ this.authService.authenticate_tokenSelf ],
-   *       tasks: [ 
-   *         async (req: Request, res: Response) => {
-   *           const userMatchStatistics = new UserMatchStatisticsService({ 
-   *             data: { userId: req.params.userId }
-   *           });
-   *
-   *           await userMatchStatistics.getDataByDependencyId();
-   *             
-   *           res.send(
-   *             userMatchStatistics.data
-   *           );
-   *         }
-   *       ]
-   *     }),
-   *   ];
-   * }
-   */
-  abstract setupEndpoints(): void
-}

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

@@ -1,98 +0,0 @@
-
-import { DyFM_Error, DyFM_HttpCallType } from '@futdevpro/fsm-dynamo';
-
-import { DyNTS_global_settings } from '../../_collections/global-settings.const';
-import { DyNTS_RouteSecurity } from '../../_enums/route-security.enum';
-import { DyNTS_Endpoint_Params } from '../../_models/control-models/endpoint-params.control-model';
-import {
-  DyNTS_RoutingModule_Settings
-} from '../../_models/interfaces/routing-module-settings.interface';
-import { DyNTS_Controller } from './controller.service';
-import { DyNTS_RoutingModule } from './routing-module.service';
-
-describe('| DyNTS_RoutingModule', () => {
-  let routingModule: DyNTS_RoutingModule;
-  let mockController: DyNTS_Controller;
-  let mockEndpoint: DyNTS_Endpoint_Params;
-
-  beforeEach(() => {
-    mockController = {
-      setupEndpoints: jasmine.createSpy('setupEndpoints'),
-      endpoints: [],
-    } as unknown as DyNTS_Controller;
-
-    mockEndpoint = {
-      endpoint: '/test',
-      type: DyFM_HttpCallType.get,
-      getFullExecution: jasmine.createSpy('getFullExecution'),
-      security: DyNTS_RouteSecurity.open,
-    } as any as DyNTS_Endpoint_Params;
-
-    const settings: DyNTS_RoutingModule_Settings = {
-      route: '/test',
-      controllers: [ mockController ],
-    };
-
-    routingModule = new DyNTS_RoutingModule(settings);
-  });
-
-  it('| should initialize with given settings', () => {
-    expect(routingModule.route).toContain('/test');
-    expect(routingModule.endpoints.length).toBe(0);
-  });
-
-  it('| should setup routes by calling setupEndpoints on each controller', () => {
-    routingModule['setupRoutes']();
-    expect(mockController.setupEndpoints).toHaveBeenCalled();
-  });
-
-  it('| should add endpoints from controllers to the routing module', () => {
-    mockController.endpoints = [ mockEndpoint ];
-    routingModule['setupRoutes']();
-    expect(routingModule.endpoints).toContain(mockEndpoint);
-  });
-
-  it('should mount open routes correctly', () => {
-    mockEndpoint.getFullExecution = jasmine.createSpy('getFullExecution').and.returnValue(async () => {});
-    routingModule.endpoints = [ mockEndpoint ];
-    routingModule['mountOpenRoute'](mockEndpoint);
-    expect(routingModule.openRouter.stack.length).toBeGreaterThan(0);
-  });
-
-  it('should mount secure routes correctly', () => {
-    mockEndpoint.security = DyNTS_RouteSecurity.secure;
-    mockEndpoint.getFullExecution = jasmine.createSpy('getFullExecution').and.returnValue(async () => {});
-    routingModule.endpoints = [ mockEndpoint ];
-    routingModule['mountSecureRoute'](mockEndpoint);
-    expect(routingModule.secureRouter.stack.length).toBeGreaterThan(0);
-  });
-
-  it('should throw error for invalid route type in open route', () => {
-    mockEndpoint.type = 'invalid' as DyFM_HttpCallType;
-    expect(() => routingModule['mountOpenRoute'](mockEndpoint)).toThrow();
-  });
-
-  it('should throw error for invalid route type in secure route', () => {
-    mockEndpoint.type = 'invalid' as DyFM_HttpCallType;
-    expect(() => routingModule['mountSecureRoute'](mockEndpoint)).toThrow();
-  });
-
-  it('| should handle endpoint duplication error', () => {
-    routingModule.endpoints = [ mockEndpoint, mockEndpoint ];
-    expect(() => routingModule['mountRoutes']()).toThrowError(/ENDPOINT DUPLICATION/);
-  });
-
-  it('| should use DyNTS_global_settings.baseUrl as route prefix', () => {
-    const originalBaseUrl: string = DyNTS_global_settings.baseUrl;
-    try {
-      DyNTS_global_settings.baseUrl = '/custom-api';
-      const moduleWithCustomBase: DyNTS_RoutingModule = new DyNTS_RoutingModule({
-        route: '/foo',
-        controllers: [ mockController ],
-      });
-      expect(moduleWithCustomBase.route).toBe('/custom-api/foo');
-    } finally {
-      DyNTS_global_settings.baseUrl = originalBaseUrl;
-    }
-  });
-});

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

@@ -1,339 +0,0 @@
-import { Request, Response, Router } from 'express';
-
-import {
-  DyFM_AnyError, DyFM_Error, DyFM_ErrorLevel, DyFM_Error_Settings,
-  DyFM_HttpCallType,
-  DyFM_Log,
-  DyFM_getConstructionStackLocation,
-  DyFM_getLocalStackLocation
-} from '@futdevpro/fsm-dynamo';
-
-import { DyNTS_global_settings } from '../../_collections/global-settings.const';
-import { DyNTS_RouteSecurity } from '../../_enums/route-security.enum';
-import {
-  DyNTS_Endpoint_Params
-} from '../../_models/control-models/endpoint-params.control-model';
-import {
-  DyNTS_RoutingModule_Settings
-} from '../../_models/interfaces/routing-module-settings.interface';
-import { DyNTS_Controller } from './controller.service';
-import { DyNTS_RequestTelemetry_ControlService } from '../core/request-telemetry.control-service';
-
-/**
- * Routing Module
- * Handling route setup and control
- * 
- * (You'll need to add them to a {@link DyNTS_App} through the {@link DyNTS_App.getRoutingModules} method)
- * 
- * You can add routes and controllers for them
- * @example
- *   // Setting up Routes
- *   setupRoutingModules(): void {
- *     this.httpPort = env.port;
-
- *     this.routingModules = [
- *       new DyNTS_RoutingModule({
- *         route: '/user',
- *         controllers: [ 
- *           UserController.getInstance(),
- *           UserDataController.getInstance(),
- *           UserOptionsController.getInstance(),
- *           UserStatisticsController.getInstance(),
- *           UserAchievementsController.getInstance(),
- *           UserNotificationsController.getInstance()
- *         ]
- *       }),
- *       new DyNTS_RoutingModule({
- *         route: '/match',
- *         controllers: [ 
- *           MatchController.getInstance(),
- *           MatchDistributionController.getInstance(),
- *           MatchStatisticsController.getInstance(),
- *         ]
- *       }),
- *       new DyNTS_RoutingModule({
- *         route: '/server',
- *         controllers: [ 
- *           ServerController.getInstance(),
- *         ]
- *       }),
-
- *       getTestRoutingModule(),
- *       getUsageRoutingModule()
- *     ];
- *   }
- */
-export class DyNTS_RoutingModule {
-
-  /* serviceName: string; */
-  
-  security: DyNTS_RouteSecurity;
-  readonly route: string;
-
-  private readonly controllers: DyNTS_Controller[];
-  endpoints: DyNTS_Endpoint_Params[] = [];
-
-  readonly openRouter: Router = Router();
-  readonly secureRouter: Router = Router();
-
-  readonly stackLocation: string;
-
-  get logSetup(): boolean {
-    return DyNTS_global_settings.log_settings.setup;
-  }
-
-  defaultErrorUserMsg = 
-    `We encountered an uncaught BackEnd Build Error, ` +
-    `\nplease contact the responsible development team.`;
-
-  constructor(
-    set: DyNTS_RoutingModule_Settings
-  ){
-    try {
-      /* this.serviceName = set.route.replace('/', '') + 'RoutingModule'; */
-      this.route = DyNTS_global_settings.baseUrl + set.route;
-      this.controllers = set.controllers ?? [];
-      this.stackLocation = DyFM_getConstructionStackLocation();
-      this.setupRoutes();
-      this.mountRoutes(set.securityOverride);
-
-      if (this.logSetup) console.log(
-        `routing module setup done: ${this.route} security: ${this.security}\n`
-      );
-    } catch (error) {
-      /* if (
-        DyNTS_global_settings.log_settings.highDetailedLogs ||
-        !(error instanceof DyFM_Error)
-      ) {
-        DyFM_Log.H_error(
-          `Routing module setup failed (${this.route}).`,
-          `\n    ERROR:`, error
-        );
-      } else {
-        error.logSimple(
-          `Routing module setup failed (${this.route}).` +
-          '\nmessages:\n' + error._messages.join('        \n')
-        );
-      } */
-
-      /* DyFM_Log.error(`\nRouting module setup failed (${this.route})`, error); */
-      throw new DyFM_Error({
-        ...this.getDefaultErrorSettings(
-          'DyNTS_RoutingModule.constructor', 
-          error
-        ),
-
-        message: `Routing module setup failed (${this.route}).`,
-        errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-RMS-000`,
-        __localStack: this.stackLocation,
-        additionalContent: set,
-      });
-    }
-  }
-
-  /**
-   * You must setup endpoints and required services for this function
-   */
-  private setupRoutes(): void {
-    this.controllers.forEach((controller: DyNTS_Controller): void => {
-      try {
-        controller.setupEndpoints();
-      } catch (error) {
-        throw new DyFM_Error({
-          ...this.getDefaultErrorSettings(
-            'setupRoutes', 
-            error
-          ),
-
-          message: 
-            `DyNTS_Controller setup failed. (${controller?.constructor?.name}) ` +
-            `Please check the setupEndpoints() method.`,
-          errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-RMS-SR1`,
-          level: DyFM_ErrorLevel.critical,
-        });
-      }
-    
-      if (controller?.endpoints?.length) {
-        this.endpoints.push(...controller.endpoints);
-      }
-    });
-  }
-
-  /**
-   * 
-   * @param securityOverride 
-   */
-  private mountRoutes(securityOverride?: DyNTS_RouteSecurity): void {
-    if (securityOverride) {
-      this.security = securityOverride;
-    }
-
-    this.endpoints.forEach((endpoint: DyNTS_Endpoint_Params): void => {
-      if (securityOverride) {
-        endpoint.security = securityOverride;
-      } else {
-        if (!endpoint.security) {
-          DyFM_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 = DyNTS_RouteSecurity.both;
-        }
-      }
-
-      if (this.logSetup) console.log(
-        `endpoint mount (${endpoint.security}): ${this.route}${endpoint.endpoint}`
-      );
-      const existingEndPoints: DyNTS_Endpoint_Params[] = this.endpoints.filter(
-        (e_params: DyNTS_Endpoint_Params): boolean => 
-          e_params.endpoint === endpoint.endpoint &&
-          e_params.type === endpoint.type
-      );
-        
-      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 !== DyNTS_RouteSecurity.secure) {
-          this.mountOpenRoute(endpoint);
-        }
-
-        if (endpoint.security !== DyNTS_RouteSecurity.open) {
-          this.mountSecureRoute(endpoint);
-        }
-      } catch (error) {
-        DyFM_Log.error(`\nRouting module setup failed (${this.route})`, error);
-
-        throw new DyFM_Error({ 
-          ...this.getDefaultErrorSettings(
-            'mountRoutes', 
-            new Error(`DYNAMO-NTS ERROR: Failed to mount routes.`)
-          ),
-
-          errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-RMS-100`,
-        });
-      }
-    });
-  }
-
-  /**
-   * 
-   * @param endpointParams 
-   */
-  private mountOpenRoute(endpointParams: DyNTS_Endpoint_Params): void {
-    const routeIdentity = DyNTS_RequestTelemetry_ControlService.getInstance().identifyRoute(
-      `${this.route}${endpointParams.endpoint}`
-    );
-
-    switch (endpointParams.type) {
-      case DyFM_HttpCallType.get:
-        this.openRouter.get(endpointParams.endpoint, routeIdentity, endpointParams.getFullExecution());
-        break;
-
-      case DyFM_HttpCallType.post:
-        this.openRouter.post(endpointParams.endpoint, routeIdentity, endpointParams.getFullExecution());
-        break;
-
-      case DyFM_HttpCallType.put:
-        this.openRouter.put(endpointParams.endpoint, routeIdentity, endpointParams.getFullExecution());
-        break;
-
-      case DyFM_HttpCallType.patch:
-        this.openRouter.patch(endpointParams.endpoint, routeIdentity, endpointParams.getFullExecution());
-        break;
-
-      case DyFM_HttpCallType.delete:
-        this.openRouter.delete(endpointParams.endpoint, routeIdentity, endpointParams.getFullExecution());
-        break;
-
-      default:
-        DyFM_Log.error(`INVALID route type: ${endpointParams.type} - ${endpointParams.name}`);
-
-        throw new DyFM_Error({ 
-          ...this.getDefaultErrorSettings(
-            'mountOpenRoute', 
-            new Error(
-              `DYNAMO-NTS ERROR: INVALID route type: ` +
-              `${endpointParams.type} - ${endpointParams.name}`
-            ),
-          ),
-
-          errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-RMS-200`,
-        });
-    }
-  }
-
-  /**
-   * 
-   * @param endpointParams 
-   */
-  private mountSecureRoute(endpointParams: DyNTS_Endpoint_Params): void {
-    const routeIdentity = DyNTS_RequestTelemetry_ControlService.getInstance().identifyRoute(
-      `${this.route}${endpointParams.endpoint}`
-    );
-
-    switch (endpointParams.type) {
-      case DyFM_HttpCallType.get:
-        this.secureRouter.get(endpointParams.endpoint, routeIdentity, endpointParams.getFullExecution());
-        break;
-
-      case DyFM_HttpCallType.post:
-        this.secureRouter.post(endpointParams.endpoint, routeIdentity, endpointParams.getFullExecution());
-        break;
-
-      case DyFM_HttpCallType.put:
-        this.secureRouter.put(endpointParams.endpoint, routeIdentity, endpointParams.getFullExecution());
-        break;
-
-      case DyFM_HttpCallType.patch:
-        this.secureRouter.patch(endpointParams.endpoint, routeIdentity, endpointParams.getFullExecution());
-        break;
-
-      case DyFM_HttpCallType.delete:
-        this.secureRouter.delete(endpointParams.endpoint, routeIdentity, endpointParams.getFullExecution());
-        break;
-
-      default:
-        DyFM_Log.error(
-          `DYNAMO-NTS ERROR: INVALID route type: ${endpointParams.type} - ${endpointParams.name}`
-        );
-
-        throw new DyFM_Error({ 
-          ...this.getDefaultErrorSettings(
-            'mountSecureRoute', 
-            new Error(
-              `DYNAMO-NTS ERROR: INVALID route type: ` +
-              `${endpointParams.type} - ${endpointParams.name}`
-            ),
-          ),
-
-          errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-RMS-300`,
-        });
-    }
-  }
-
-  private getDefaultErrorSettings(
-    fnName: string, 
-    error: DyFM_AnyError
-  ): DyFM_Error_Settings {
-    return {
-      status: 500,
-      message: (error as Error)?.message ??   
-        (error as DyFM_Error)?._message ??
-        `${fnName} was UNSUCCESSFUL (NTS)`,
-      userMessage: (error as DyFM_Error)?.__userMessage ?? 
-        this.defaultErrorUserMsg,
-      addECToUserMsg: true,
-      error: error,
-      issuerService: this.constructor?.name,
-      systemVersion: DyNTS_global_settings.systemVersion,
-    };
-  }
-}