@futdevpro/nts-dynamo 1.9.15 → 1.9.17

package/src/_services/shared.service.spec.ts

@@ -1,19 +1,19 @@
-import { DynamoNTS_Shared } from './shared.static-service';
-
-describe('DynamoNTS_Shared', () => {
-  it('getIpFromRequest should be accessible', () => {
-    expect(DynamoNTS_Shared.getIpFromRequest).toBeTruthy();
-  });
-
-  it('getIpFromRequest should be accessible', () => {
-    expect(DynamoNTS_Shared.getLocationDataByRequest).toBeTruthy();
-  });
-
-  it('getIpFromRequest should be accessible', () => {
-    expect(DynamoNTS_Shared.getLocationByIp).toBeTruthy();
-  });
-
-  it('getIpFromRequest should be accessible', () => {
-    expect(DynamoNTS_Shared.prompt).toBeTruthy();
-  });
-});
+import { DynamoNTS_Shared } from './shared.static-service';
+
+describe('DynamoNTS_Shared', () => {
+  it('getIpFromRequest should be accessible', () => {
+    expect(DynamoNTS_Shared.getIpFromRequest).toBeTruthy();
+  });
+
+  it('getIpFromRequest should be accessible', () => {
+    expect(DynamoNTS_Shared.getLocationDataByRequest).toBeTruthy();
+  });
+
+  it('getIpFromRequest should be accessible', () => {
+    expect(DynamoNTS_Shared.getLocationByIp).toBeTruthy();
+  });
+
+  it('getIpFromRequest should be accessible', () => {
+    expect(DynamoNTS_Shared.prompt).toBeTruthy();
+  });
+});

package/src/_services/shared.static-service.ts

@@ -1,73 +1,73 @@
-
-import * as ReadLine from 'readline';
-import * as GeoIp from 'geoip-lite';
-import { Request } from 'express';
-
-import { DynamoFM_GeoIpLocation, DynamoFM_Shared } from '@futdevpro/fsm-dynamo/shared-service';
-
-/**
- * 
- */
-export class DynamoNTS_Shared extends DynamoFM_Shared {
-
-  /**
-   * 
-   * @param request 
-   * @returns 
-   */
-  static getIpFromRequest(request: Request): string {
-    let ip: string;
-
-    if (request?.headers?.['x-forwarded-for']) {
-      const route: string[] = (request.headers['x-forwarded-for'] as string).split(', ');
-
-      console.log('TESTTTT route:', route);
-      ip = route[route.length - 1];
-    } else {
-      ip = request.socket.remoteAddress;
-    }
-
-    return ip;
-  }
-
-  /**
-   * 
-   * @param request 
-   * @returns 
-   */
-  static getLocationDataByRequest(request: Request): DynamoFM_GeoIpLocation {
-    return GeoIp.lookup(this.getIpFromRequest(request));
-  }
-
-  /**
-   * 
-   * @param request 
-   * @returns 
-   */
-  static getLocationByIp(ip: string): DynamoFM_GeoIpLocation {
-    return GeoIp.lookup(ip);
-  }
-
-  /**
-   * 
-   * @param question 
-   * @returns 
-   */
-  static async prompt(question: string): Promise<string> {
-    const readLine = ReadLine.createInterface({ 
-      input: process.stdin, 
-      output: process.stdout,
-    });
-    
-    return new Promise((resolve, reject) => {
-      try {
-        readLine.question(question, (result: string) => {
-          resolve(result);
-          readLine.close();
-        });
-      } catch (error) {
-        reject(error);
-      }
-    });
-  }
-}
+
+import * as ReadLine from 'readline';
+import * as GeoIp from 'geoip-lite';
+import { Request } from 'express';
+
+import { DynamoFM_GeoIpLocation, DynamoFM_Shared } from '@futdevpro/fsm-dynamo/shared-service';
+
+/**
+ * 
+ */
+export class DynamoNTS_Shared extends DynamoFM_Shared {
+
+  /**
+   * 
+   * @param request 
+   * @returns 
+   */
+  static getIpFromRequest(request: Request): string {
+    let ip: string;
+
+    if (request?.headers?.['x-forwarded-for']) {
+      const route: string[] = (request.headers['x-forwarded-for'] as string).split(', ');
+
+      console.log('TESTTTT route:', route);
+      ip = route[route.length - 1];
+    } else {
+      ip = request.socket.remoteAddress;
+    }
+
+    return ip;
+  }
+
+  /**
+   * 
+   * @param request 
+   * @returns 
+   */
+  static getLocationDataByRequest(request: Request): DynamoFM_GeoIpLocation {
+    return GeoIp.lookup(this.getIpFromRequest(request));
+  }
+
+  /**
+   * 
+   * @param request 
+   * @returns 
+   */
+  static getLocationByIp(ip: string): DynamoFM_GeoIpLocation {
+    return GeoIp.lookup(ip);
+  }
+
+  /**
+   * 
+   * @param question 
+   * @returns 
+   */
+  static async prompt(question: string): Promise<string> {
+    const readLine = ReadLine.createInterface({ 
+      input: process.stdin, 
+      output: process.stdout,
+    });
+    
+    return new Promise((resolve, reject) => {
+      try {
+        readLine.question(question, (result: string) => {
+          resolve(result);
+          readLine.close();
+        });
+      } catch (error) {
+        reject(error);
+      }
+    });
+  }
+}

package/src/_services/socket/socket-client.service.ts

@@ -1,235 +1,236 @@
-
-
-
-import * as SocketIO from 'socket.io-client';
-
-import { DynamoNTS_SingletonService } from '../base/singleton.service';
-import { DynamoFM_Error, DynamoFM_Log } from '@futdevpro/fsm-dynamo';
-import { DynamoFM_delay, DynamoFM_Array } from '@futdevpro/fsm-dynamo/utils';
-import { 
-  DynamoNTS_SocketClientService_Params 
-} from '../../_models/control-models/socket-client-service-params.control-model';
-import { DynamoNTS_globalSettings } from '../../_constants/global-settings.const';
-import { DynamoNTS_SocketEvent } from '../../_models/control-models/socket-event.control-model';
-import { DynamoNTS_SocketEventKey } from '../../_enums/http/socket-event-type.enum';
-
-export abstract class DynamoNTS_SocketClientService extends DynamoNTS_SingletonService {
-
-  private _params: DynamoNTS_SocketClientService_Params;
-  protected get params(): DynamoNTS_SocketClientService_Params { return this._params; }
-  get name(): string { return this.params.name; }
-
-  protected socket: SocketIO.Socket;
-  
-  protected incomingEvents: DynamoNTS_SocketEvent<any>[];
-  
-  protected _connected: boolean = false;
-  get connected(): boolean { return this._connected; }
-
-  protected debugLog: boolean = DynamoNTS_globalSettings.logSetup;
-  protected logFn: boolean;
-
-  private defaultEvents: DynamoNTS_SocketEvent<any>[] = [
-    new DynamoNTS_SocketEvent<any>({
-      eventKey: DynamoNTS_SocketEventKey.connect,
-      tasks: [
-        async () => {
-          this._connected = true;
-          DynamoFM_Log.success(`<   >  socket-client(${this.params.name}) connected!`);
-        },
-      ],
-    }),
-
-    new DynamoNTS_SocketEvent<any>({
-      eventKey: DynamoNTS_SocketEventKey.disconnect,
-      tasks: [
-        async () => {
-          this._connected = false;
-          DynamoFM_Log.warn(`<x  >  socket-client(${this.params.name}) disconnected!`);
-
-          if (this._params.reconnect) {
-            await DynamoFM_delay(this._params.reconnectDelay);
-            this.connectSocket();
-          }
-        },
-      ],
-    }),
-
-    new DynamoNTS_SocketEvent<any>({
-      eventKey: DynamoNTS_SocketEventKey.subscriptionSuccessful,
-      tasks: [
-        async () => {
-          DynamoFM_Log.success(`<=-->  socket-client(${this.params.name}) subscription successful!`);
-        },
-      ],
-    }),
-
-    new DynamoNTS_SocketEvent<any>({
-      eventKey: DynamoNTS_SocketEventKey.error,
-      tasks: [
-        async (content: any) => {
-          DynamoFM_Log.error(`=-->   socket-client(${this.params.name}) ERROR!:`, content);
-        },
-      ],
-    }),
-  ];
-
-  protected constructor() {
-    super();
-
-    this.asyncConstructor().catch((error: any) => {
-      DynamoFM_Log.error(`socket-client(${this.params?.name}) Service setup failed! ERROR:`, error);
-      
-      if (error?.flag?.includes?.('DYNAMO-ERROR-OBJECT')) {
-        DynamoFM_Log.error(`\nErrorMessage: ${(error as DynamoFM_Error)._message}`);
-        DynamoFM_Log.error(`ErrorCode: ${(error as DynamoFM_Error)._errorCode}`);
-      }
-    });
-  }
-
-  private async asyncConstructor(): Promise<void> {
-    try {
-      this._params = this.getParams();
-      this.incomingEvents = this.getIncomingEvents() ?? [];
-      this.socket = SocketIO.io(`${this.params.address}:${this.params.port}`);
-      
-      await this.setupDefaultEvents();
-
-      await this.setupSocketEvents();
-
-      DynamoFM_Log.success(`\nsocket-client(${this.params?.name}) Service setup finished`);
-      
-      await this.connectSocket();
-    } catch (error) {
-      DynamoFM_Log.error(`socket-client(${this.params?.name}) Service setup failed!`, error);
-
-      throw new DynamoFM_Error({
-        errorCode: 'NTS-SCS-001',
-        error: error,        
-      });
-    }
-  }
-
-  private async setupDefaultEvents(): Promise<void> {
-    try {
-      if (this.logFn) console.log('\nFn:. setupDefaultEvents');
-
-      this.defaultEvents.forEach((defaultEvent: DynamoNTS_SocketEvent<any>) => {
-        defaultEvent.serviceName = this.params.name;
-        const eventDeclared = this.incomingEvents.find(
-          (event: DynamoNTS_SocketEvent<any>) => event.eventKey === defaultEvent.eventKey
-        );
-
-        if (!eventDeclared) {
-          this.incomingEvents.push(defaultEvent);
-        } else {
-          eventDeclared.tasks.unshift(...defaultEvent.tasks);
-        }
-      });
-    } catch (error) {
-      DynamoFM_Log.error(
-        `socket-client(${this.params.name}) Service Setup Default Events failed, ` +
-        `ERROR:`, error
-      );
-
-      throw error;
-    }
-  }
-
-  private async setupSocketEvents(): Promise<void> {
-    try {
-      if (this.debugLog) console.log(`Setup socket-client(${this.params.name}) Events...`);
-
-      await DynamoFM_Array.asyncForEach(
-        this.incomingEvents, 
-        async (event: DynamoNTS_SocketEvent<any>) => {
-          event.serviceName = this.params.name;
-          this.socket.on(event.eventKey, async (content: any) => { 
-            try {
-              await event.executeEventTasks(content, this.params.service);
-            } catch (error) {
-              DynamoFM_Log.error(`socket-client(${this.params.name}) Event failed, ERROR:`, error);
-              await this.emitEvent(DynamoNTS_SocketEventKey.error, error);
-            }
-          });
-        }
-      );
-    } catch (error) {
-      DynamoFM_Log.error(
-        `socket-client(${this.params.name}) Service Setup Socket Events failed, ` +
-        `ERROR:`, error
-      );
-
-      throw error;
-    }
-  }
-  
-  private async connectSocket(): Promise<void> {
-    try {
-      DynamoFM_Log.info(
-        `< .. > socket-client(${this.params.name}) ` +
-        `connecting to ${this.params.address}:${this.params.port} ...`
-      );
-
-      this.socket.connect();
-
-      if (this.params.reconnect) {
-        await this.tryReconnectIfNeeded();
-      }
-    } catch (error) {
-      DynamoFM_Log.error(
-        `socket-client(${this.params.name}) Service Connect Socket failed, ` +
-        `ERROR:`, error
-      );
-
-      throw error;
-    }
-  }
-
-  private async tryReconnectIfNeeded(): Promise<void> {
-    try {
-      if (this.logFn) console.log(`\nFn:. tryReconnectIfNeeded`);
-      await DynamoFM_delay(this._params.reconnectDelay);
-      
-      if (!this._connected) {
-        await this.connectSocket();
-      }
-    } catch (error) {
-      DynamoFM_Log.error(
-        `socket-client(${this.params.name}) Service Try Reconnect failed, ` +
-        `ERROR:`, error
-      );
-
-      throw error;
-    }
-  }
-
-  /**
-   * Emit event to the socket
-   * @param eventType event name
-   * @param content event content
-   */
-  protected async emitEvent(eventType: string, content: any): Promise<void> {
-    try {
-      DynamoFM_Log.log(`<=--   outgoing socket-client(${this.params.name}) event: ${eventType}`);
-      this.socket.emit(eventType, content);
-    } catch (error) {
-      DynamoFM_Log.error(
-        `socket-client(${this.params.name}) ` +
-        `Service Emit Event failed: ${this.params?.name} (${this.params?.port})`, error
-      );
-
-      throw error;
-    }
-  }
-  
-  /**
-   * You must setup params for the service in this function
-   */
-  abstract getParams(): DynamoNTS_SocketClientService_Params;
-
-  /**
-   * You must setup events and required services in this function
-   */
-  abstract getIncomingEvents(): DynamoNTS_SocketEvent<any>[];
-}
+
+
+
+import * as SocketIO from 'socket.io-client';
+
+import { DynamoNTS_SingletonService } from '../base/singleton.service';
+import { DynamoFM_Error, DynamoFM_Log } from '@futdevpro/fsm-dynamo';
+import { DynamoFM_delay, DynamoFM_Array } from '@futdevpro/fsm-dynamo/utils';
+import { 
+  DynamoNTS_SocketClientService_Params 
+} from '../../_models/control-models/socket-client-service-params.control-model';
+import { DynamoNTS_globalSettings } from '../../_constants/global-settings.const';
+import { DynamoNTS_SocketEvent } from '../../_models/control-models/socket-event.control-model';
+import { DynamoNTS_SocketEventKey } from '../../_enums/http/socket-event-type.enum';
+
+export abstract class DynamoNTS_SocketClientService extends DynamoNTS_SingletonService {
+
+  private _params: DynamoNTS_SocketClientService_Params;
+  protected get params(): DynamoNTS_SocketClientService_Params { return this._params; }
+  get name(): string { return this.params.name; }
+
+  protected socket: SocketIO.Socket;
+  
+  protected incomingEvents: DynamoNTS_SocketEvent<any>[];
+  
+  protected _connected: boolean = false;
+  get connected(): boolean { return this._connected; }
+
+  protected debugLog: boolean = DynamoNTS_globalSettings.logSetup;
+  protected logFn: boolean;
+
+  private defaultEvents: DynamoNTS_SocketEvent<any>[] = [
+    new DynamoNTS_SocketEvent<any>({
+      eventKey: DynamoNTS_SocketEventKey.connect,
+      tasks: [
+        async () => {
+          this._connected = true;
+          DynamoFM_Log.success(`<   >  socket-client(${this.params.name}) connected!`);
+        },
+      ],
+    }),
+
+    new DynamoNTS_SocketEvent<any>({
+      eventKey: DynamoNTS_SocketEventKey.disconnect,
+      tasks: [
+        async () => {
+          this._connected = false;
+          DynamoFM_Log.warn(`<x  >  socket-client(${this.params.name}) disconnected!`);
+
+          if (this._params.reconnect) {
+            await DynamoFM_delay(this._params.reconnectDelay);
+            this.connectSocket();
+          }
+        },
+      ],
+    }),
+
+    new DynamoNTS_SocketEvent<any>({
+      eventKey: DynamoNTS_SocketEventKey.subscriptionSuccessful,
+      tasks: [
+        async () => {
+          DynamoFM_Log.success(`<=-->  socket-client(${this.params.name}) subscription successful!`);
+        },
+      ],
+    }),
+
+    new DynamoNTS_SocketEvent<any>({
+      eventKey: DynamoNTS_SocketEventKey.error,
+      tasks: [
+        async (content: any) => {
+          DynamoFM_Log.error(`=-->   socket-client(${this.params.name}) ERROR!:`, content);
+        },
+      ],
+    }),
+  ];
+
+  protected constructor() {
+    super();
+
+    this.asyncConstructor().catch((error: any) => {
+      DynamoFM_Log.error(`socket-client(${this.params?.name}) Service setup failed! ERROR:`, error);
+      
+      if (error?.flag?.includes?.('DYNAMO-ERROR-OBJECT')) {
+        DynamoFM_Log.error(`\nErrorMessage: ${(error as DynamoFM_Error)._message}`);
+        DynamoFM_Log.error(`ErrorCode: ${(error as DynamoFM_Error)._errorCode}`);
+        DynamoFM_Log.error(`UserMessage: ${(error as DynamoFM_Error).__userMessage}`);
+      }
+    });
+  }
+
+  private async asyncConstructor(): Promise<void> {
+    try {
+      this._params = this.getParams();
+      this.incomingEvents = this.getIncomingEvents() ?? [];
+      this.socket = SocketIO.io(`${this.params.address}:${this.params.port}`);
+      
+      await this.setupDefaultEvents();
+
+      await this.setupSocketEvents();
+
+      DynamoFM_Log.success(`\nsocket-client(${this.params?.name}) Service setup finished`);
+      
+      await this.connectSocket();
+    } catch (error) {
+      DynamoFM_Log.error(`socket-client(${this.params?.name}) Service setup failed!`, error);
+
+      throw new DynamoFM_Error({
+        errorCode: 'NTS-SCS-001',
+        error: error,        
+      });
+    }
+  }
+
+  private async setupDefaultEvents(): Promise<void> {
+    try {
+      if (this.logFn) console.log('\nFn:. setupDefaultEvents');
+
+      this.defaultEvents.forEach((defaultEvent: DynamoNTS_SocketEvent<any>) => {
+        defaultEvent.serviceName = this.params.name;
+        const eventDeclared = this.incomingEvents.find(
+          (event: DynamoNTS_SocketEvent<any>) => event.eventKey === defaultEvent.eventKey
+        );
+
+        if (!eventDeclared) {
+          this.incomingEvents.push(defaultEvent);
+        } else {
+          eventDeclared.tasks.unshift(...defaultEvent.tasks);
+        }
+      });
+    } catch (error) {
+      DynamoFM_Log.error(
+        `socket-client(${this.params.name}) Service Setup Default Events failed, ` +
+        `ERROR:`, error
+      );
+
+      throw error;
+    }
+  }
+
+  private async setupSocketEvents(): Promise<void> {
+    try {
+      if (this.debugLog) console.log(`Setup socket-client(${this.params.name}) Events...`);
+
+      await DynamoFM_Array.asyncForEach(
+        this.incomingEvents, 
+        async (event: DynamoNTS_SocketEvent<any>) => {
+          event.serviceName = this.params.name;
+          this.socket.on(event.eventKey, async (content: any) => { 
+            try {
+              await event.executeEventTasks(content, this.params.service);
+            } catch (error) {
+              DynamoFM_Log.error(`socket-client(${this.params.name}) Event failed, ERROR:`, error);
+              await this.emitEvent(DynamoNTS_SocketEventKey.error, error);
+            }
+          });
+        }
+      );
+    } catch (error) {
+      DynamoFM_Log.error(
+        `socket-client(${this.params.name}) Service Setup Socket Events failed, ` +
+        `ERROR:`, error
+      );
+
+      throw error;
+    }
+  }
+  
+  private async connectSocket(): Promise<void> {
+    try {
+      DynamoFM_Log.info(
+        `< .. > socket-client(${this.params.name}) ` +
+        `connecting to ${this.params.address}:${this.params.port} ...`
+      );
+
+      this.socket.connect();
+
+      if (this.params.reconnect) {
+        await this.tryReconnectIfNeeded();
+      }
+    } catch (error) {
+      DynamoFM_Log.error(
+        `socket-client(${this.params.name}) Service Connect Socket failed, ` +
+        `ERROR:`, error
+      );
+
+      throw error;
+    }
+  }
+
+  private async tryReconnectIfNeeded(): Promise<void> {
+    try {
+      if (this.logFn) console.log(`\nFn:. tryReconnectIfNeeded`);
+      await DynamoFM_delay(this._params.reconnectDelay);
+      
+      if (!this._connected) {
+        await this.connectSocket();
+      }
+    } catch (error) {
+      DynamoFM_Log.error(
+        `socket-client(${this.params.name}) Service Try Reconnect failed, ` +
+        `ERROR:`, error
+      );
+
+      throw error;
+    }
+  }
+
+  /**
+   * Emit event to the socket
+   * @param eventType event name
+   * @param content event content
+   */
+  protected async emitEvent(eventType: string, content: any): Promise<void> {
+    try {
+      DynamoFM_Log.log(`<=--   outgoing socket-client(${this.params.name}) event: ${eventType}`);
+      this.socket.emit(eventType, content);
+    } catch (error) {
+      DynamoFM_Log.error(
+        `socket-client(${this.params.name}) ` +
+        `Service Emit Event failed: ${this.params?.name} (${this.params?.port})`, error
+      );
+
+      throw error;
+    }
+  }
+  
+  /**
+   * You must setup params for the service in this function
+   */
+  abstract getParams(): DynamoNTS_SocketClientService_Params;
+
+  /**
+   * You must setup events and required services in this function
+   */
+  abstract getIncomingEvents(): DynamoNTS_SocketEvent<any>[];
+}