@futdevpro/fsm-dynamo 1.9.29 → 1.9.31

package/src/_modules/socket/_services/sck-client.service-base.ts

@@ -0,0 +1,303 @@
+
+import * as SocketIOClient from 'socket.io-client';
+
+import { 
+  DyFM_global_settings 
+} from '../../../_collections/constants/global-settings.const';
+import { DyFM_Error } from '../../../_models/control-models/error.control-model';
+import { DyFM_Log } from '../../../_collections/utils/log.util';
+import { DyFM_Array } from '../../../_collections/utils/array.util';
+import { DyFM_delay } from '../../../_collections/utils/utilities.util';
+
+import { DyFM_SocketEvent_Key } from '../_enums/sck-event-key.enum';
+import { DyFM_SocketClient_Params } from '../_models/sck-client-params.control-model';
+import { DyFM_SocketEvent } from '../_models/sck-socket-event.control-model';
+import { BehaviorSubject } from 'rxjs';
+
+export abstract class DyFM_SocketClient_ServiceBase<T_SubscriptionContent = any> {
+
+  private _params: DyFM_SocketClient_Params;
+  protected get params(): DyFM_SocketClient_Params { return this._params; }
+  get name(): string { return this.params.name; }
+
+  protected socket: SocketIOClient.Socket;
+  
+  protected incomingEvents: DyFM_SocketEvent<any>[];
+  
+  protected _connected_BS: BehaviorSubject<boolean> = new BehaviorSubject<boolean>(false);
+  get connected(): boolean { return this._connected_BS.value; }
+  readonly connected$ = this._connected_BS.asObservable();
+
+  private _subscribed_BS: BehaviorSubject<boolean> = new BehaviorSubject<boolean>(false);
+  get subscribed(): boolean { return this._subscribed_BS.value; }
+  readonly subscribed$ = this._subscribed_BS.asObservable();
+
+  protected debugLog: boolean = DyFM_global_settings.log_settings.setup;
+  protected logFn: boolean = DyFM_global_settings.log_settings.functions;
+
+  private defaultEvents: DyFM_SocketEvent<any>[] = [
+    new DyFM_SocketEvent<any>({
+      eventKey: DyFM_SocketEvent_Key.connect,
+      tasks: [
+        async (): Promise<void> => {
+          this._connected_BS.next(true);
+
+          if (this.subscribed) {
+            this._subscribed_BS.next(false);
+          }
+          DyFM_Log.success(`<   >  socket-client(${this.params.name}) connected!`);
+        },
+      ],
+    }),
+
+    new DyFM_SocketEvent<any>({
+      eventKey: DyFM_SocketEvent_Key.disconnect,
+      tasks: [
+        async (): Promise<void> => {
+          this._connected_BS.next(false);
+
+          if (this.subscribed) {
+            this._subscribed_BS.next(false);
+          }
+          DyFM_Log.warn(`<x  >  socket-client(${this.params.name}) disconnected!`);
+
+          if (this._params.reconnect) {
+            await DyFM_delay(this._params.reconnectDelay);
+            this.connectSocket();
+          }
+        },
+      ],
+    }),
+
+    new DyFM_SocketEvent<any>({
+      eventKey: DyFM_SocketEvent_Key.subscriptionSuccessful,
+      tasks: [
+        async (): Promise<void> => {
+          DyFM_Log.success(`<=-->  socket-client(${this.params.name}) subscription successful!`);
+          this._subscribed_BS.next(true);
+        },
+      ],
+    }),
+
+    new DyFM_SocketEvent<any>({
+      eventKey: DyFM_SocketEvent_Key.unsubscribeSuccessful,
+      tasks: [
+        async (): Promise<void> => {
+          DyFM_Log.success(`<x-->  socket-client(${this.params.name}) unsubscribe successful!`);
+          this._subscribed_BS.next(false);
+        },
+      ],
+    }),
+
+    new DyFM_SocketEvent<any>({
+      eventKey: DyFM_SocketEvent_Key.error,
+      tasks: [
+        async (content: any): Promise<void> => {
+          DyFM_Log.error(`=-->   socket-client(${this.params.name}) ERROR!:`, content);
+        },
+      ],
+    }),
+  ];
+
+  protected constructor() {
+    this.asyncConstructor().catch((error: any): void => {
+      if (
+        DyFM_global_settings.log_settings.highDetailedLogs ||
+        !(error instanceof DyFM_Error)
+      ) {
+        DyFM_Log.H_error(
+          `socket-client "${this.params?.name}" Service setup failed! ` +
+          `(DyFM_SocketClientService constructor catch)`,
+          `\n    ERROR:`, error
+        );
+      } else {
+        error.logSimple(
+          `socket-client "${this.params?.name}" Service setup failed! ` +
+          `(DyFM_SocketClientService constructor catch)`
+        );
+      }
+    });
+  }
+
+  async subscribe(): Promise<void> {
+    try {
+      const subscriptionContent: T_SubscriptionContent = await this.getSubscriptionContent();
+
+      await this.emitEvent(DyFM_SocketEvent_Key.subscribe, subscriptionContent);
+    } catch (error) {
+      DyFM_Log.error(`socket-client(${this.params.name}) Service Subscribe failed!`, error);
+
+      throw error;
+    }
+  }
+
+  async unsubscribe(): Promise<void> {
+    try {
+      await this.emitEvent(DyFM_SocketEvent_Key.unsubscribe, null);
+    } catch (error) {
+      DyFM_Log.error(`socket-client(${this.params.name}) Service Unsubscribe failed!`, 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 {
+      DyFM_Log.log(`<=--   outgoing socket-client(${this.params.name}) event: ${eventType}`);
+      this.socket.emit(eventType, content);
+    } catch (error) {
+      DyFM_Log.error(
+        `socket-client(${this.params.name}) ` +
+        `Service Emit Event failed: ${this.params?.name} (${this.params?.port})`, error
+      );
+
+      throw error;
+    }
+  }
+
+  private async asyncConstructor(): Promise<void> {
+    try {
+      this._params = this.getParams();
+      this.incomingEvents = this.getIncomingEvents() ?? [];
+      this.socket = SocketIOClient.io(
+        `${this.params.address}:${this.params.port}`,
+        {
+          /* reconnection: this.params.reconnect,
+          reconnectionDelay: this.params.reconnectDelay, */
+          ...this.params.socketOptions,
+        }
+      );
+      
+      await this.setupDefaultEvents();
+
+      await this.setupSocketEvents();
+
+      DyFM_Log.success(`\nsocket-client(${this.params?.name}) Service setup finished`);
+      
+      await this.connectSocket();
+    } catch (error) {
+      DyFM_Log.error(`socket-client(${this.params?.name}) Service setup failed!`, error);
+
+      throw new DyFM_Error({
+        errorCode: 'FM-SCS-001',
+        error: error,        
+      });
+    }
+  }
+
+  private async setupDefaultEvents(): Promise<void> {
+    try {
+      if (this.logFn) console.log('\nFn:. setupDefaultEvents');
+
+      this.defaultEvents.forEach((defaultEvent: DyFM_SocketEvent<any>): void => {
+        defaultEvent.serviceName = this.params.name;
+        const eventDeclared = this.incomingEvents.find(
+          (event: DyFM_SocketEvent<any>): boolean => event.eventKey === defaultEvent.eventKey
+        );
+
+        if (!eventDeclared) {
+          this.incomingEvents.push(defaultEvent);
+        } else {
+          eventDeclared.tasks.unshift(...defaultEvent.tasks);
+        }
+      });
+    } catch (error) {
+      DyFM_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 DyFM_Array.asyncForEach(
+        this.incomingEvents, 
+        async (event: DyFM_SocketEvent<any>): Promise<void> => {
+          event.serviceName = this.params.name;
+          this.socket.on(event.eventKey, async (content: any): Promise<void> => { 
+            try {
+              await event.executeEventTasks(content, this.params.service);
+            } catch (error) {
+              DyFM_Log.error(`socket-client(${this.params.name}) Event failed, ERROR:`, error);
+              await this.emitEvent(DyFM_SocketEvent_Key.error, error);
+            }
+          });
+        }
+      );
+    } catch (error) {
+      DyFM_Log.error(
+        `socket-client(${this.params.name}) Service Setup Socket Events failed, ` +
+        `ERROR:`, error
+      );
+
+      throw error;
+    }
+  }
+  
+  private async connectSocket(): Promise<void> {
+    try {
+      DyFM_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) {
+      DyFM_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 DyFM_delay(this._params.reconnectDelay);
+      
+      if (!this.connected) {
+        await this.connectSocket();
+      }
+    } catch (error) {
+      DyFM_Log.error(
+        `socket-client(${this.params.name}) Service Try Reconnect failed, ` +
+        `ERROR:`, error
+      );
+
+      throw error;
+    }
+  }
+  
+  /**
+   * You must setup params for the service in this function
+   */
+  abstract getParams(): DyFM_SocketClient_Params;
+
+  /**
+   * You must setup events and required services in this function
+   */
+  abstract getIncomingEvents(): DyFM_SocketEvent<any>[];
+
+  /**
+   * You must setup subscription content for the service in this function
+   */
+  abstract getSubscriptionContent(): Promise<T_SubscriptionContent>;
+}
+
+

package/src/_modules/socket/index.ts

@@ -1,6 +1,14 @@
 
 
+
+// ENUMS
+export * from './_enums/sck-event-key.enum';
+
+
 // MODELS
 export * from './_models/sck-client-params.control-model';
+export * from './_models/sck-socket-event.control-model';
 
 
+// SERVICES
+export * from './_services/sck-client.service-base';

package/src/_modules/usage/_models/usg-session.data-model.ts

@@ -34,7 +34,7 @@ export class DyFM_UsageSession extends DyFM_Metadata {
   }
 }
 
-export const DyFM_usageSessionModel_params: DyFM_DataModel_Params = 
+export const DyFM_usageSession_dataParams: DyFM_DataModel_Params = 
   new DyFM_DataModel_Params({
     dataName: 'usageSession',
     properties: [

package/src/index.ts

@@ -2,6 +2,7 @@
 // COLLECTIONS
 // collections/CONSTANTS
 export * from './_collections/constants/error-defaults.const';
+export * from './_collections/constants/global-settings.const';
 export * from './_collections/constants/times.const';
 
 // collections/UTILS
@@ -57,3 +58,7 @@ export * from './_models/interfaces/random-weight.interface';
 export * from './_models/interfaces/route-settings.interface';
 export * from './_models/interfaces/vector2.interface';
 
+// models/interfaces/ENVIRONMENT
+export * from './_models/interfaces/environment/global-settings.interface';
+export * from './_models/interfaces/environment/global-log-settings.interface';
+