@futdevpro/nts-dynamo 1.15.13 → 1.15.15

package/src/_modules/socket/_models/socket-presence.control-model.ts

@@ -1,210 +1,210 @@
-
-import {
-  DyFM_AnyError, DyFM_Error, DyFM_Error_Settings, DyFM_Log
-} from '@futdevpro/fsm-dynamo';
-import * as SocketIO from 'socket.io';
-import { DyNTS_global_settings } from '../../..';
-
-/**
- * socket handling and clarification is under development
- */
-export class DyNTS_SocketPresence {
-  /** 
-   * this is the presence ID which is used to get and handle the presence 
-   * usually the service master identifier such as userID 
-   * (issuerLocalId != issuer which is the main master identifier usually the accountID)
-   * */
-  issuerLocalId: string;
-  serviceName?: string = 'unknown';
-  onDestroy?: (issuerId: string) => void = (): void => {};
-  
-  defaultErrorUserMsg?: string = 
-    `We encountered an unhandled Socket Error, ` +
-    `\nplease contact the responsible development team.`; 
-  
-  sockets?: SocketIO.Socket[] = [];
-
-  issuer: string;
-  
-  constructor(
-    set: Partial<DyNTS_SocketPresence>
-  ) {
-    if (!set?.issuerLocalId) {
-      throw new DyFM_Error({ 
-        ...this._getDefaultErrorSettings(
-          'constructor',
-          new Error(
-            `trying to create DyNTS_SocketPresence without a valid issuerLocalId!`/*  +
-            `\nset: ${JSON.stringify(set)}` */
-          ),
-          set?.issuer
-        ),
-        errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-SD0-C00`,
-        additionalContent: { set: set },
-      });
-    }
-
-    this.issuerLocalId = set.issuerLocalId;
-    
-    if (set.serviceName) {
-      this.serviceName = set.serviceName;
-    }
-
-    if (set.onDestroy) {
-      this.onDestroy = set.onDestroy;
-    }
-
-    if (set.defaultErrorUserMsg) {
-      this.defaultErrorUserMsg = set.defaultErrorUserMsg;
-    }
-
-    if (!set?.sockets?.length) {
-      throw new DyFM_Error({ 
-        ...this._getDefaultErrorSettings(
-          'constructor',
-          new Error(
-            `trying to create DyNTS_SocketPresence without a single active socket!` +
-            `\nissuerId: ${this.issuerLocalId}`
-          ),
-          set?.issuer
-        ),
-
-        errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-SD0-C01`,
-      });
-    }
-
-    this.sockets = set.sockets;
-  }
-
-  /**
-   * Emits event on all sockets
-   * @param event 
-   * @param content 
-   */
-  emitEvent(event: string, content: any, issuer: string): void {
-    /* let anyFailed: boolean = false; */
-    const errors: any = [];
-    const inactiveSockets: SocketIO.Socket[] = [];
-
-    try {
-      JSON.stringify(content);
-    } catch {
-      throw new DyFM_Error({
-        ...this._getDefaultErrorSettings(
-          'emitEvent',
-          new Error(
-            `Emitting event '${event}' on socket(s)(${this.serviceName}) failed!`+
-            `\n  ERROR: content is not stringify-able!`
-          ),
-          issuer
-        ),
-
-        errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-SPC-EE1`,
-      });
-    }
-
-    this.sockets.forEach((socket: SocketIO.Socket, index: number) => {
-      if (!socket.connected) {
-        DyFM_Log.warn(
-          `Emitting event '${event}' on socket(${this.serviceName})-(${index}) failed!` +
-          `\n  ERROR: socket[${socket.id}] is not connected! (it will be removed...)`
-        );
-
-        /* errors.push(
-          new DyFM_Error({
-            status: 500,
-            errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-SPC-EE2',
-            addECToUserMsg: true,
-            message: 
-            `Emitting event '${event}' on socket(${this.serviceName})-(${index}) failed!`+
-            `\nERROR: socket[${socket.id}] is not connected!`,
-            userMessage: 'We encountered an unhandled Server Error, please contact the responsible development team.',
-          })
-        ); */
-
-        inactiveSockets.push(socket);
-        socket?.disconnect(true);
-      }
-    });
-
-    /* this.sockets.forEach((socket: SocketIO.Socket, index: number) => {
-      if (!socket) {
-        return;
-      }
-      if (inactiveSockets.includes(socket) || !socket?.connected) {
-        socket.TRY RECONNECT
-      } */
-
-    this.sockets = this.sockets.filter(
-      (socket): boolean => !inactiveSockets.includes(socket) && socket?.connected
-    );
-
-    this.sockets.forEach((socket: SocketIO.Socket, index: number): void => {
-      const success: boolean = socket.emit(event, content, (error): void => {
-        DyFM_Log.error(
-          `Emitting event '${event}' on socket(${this.serviceName})-(${index}) failed!(0)` +
-          `\nerror:`, error
-        );
-        errors.push(error);
-      });
-
-      if (!success) {
-        DyFM_Log.error(
-          `Emitting event '${event}' on socket(${this.serviceName})-(${index}) failed!(1)`
-        );
-      }
-    });
-
-    if (0 < errors.length) {
-      throw new DyFM_Error({
-        ...this._getDefaultErrorSettings(
-          'emitEvent',
-          new Error(
-            `Emitting event '${event}' on socket(s)(${this.serviceName}) failed!`+
-            `\n${errors.length} errors occured!`
-          ),
-          issuer
-        ),
-
-        errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-SPC-EE3`,
-        additionalContent: {
-          inactiveSockets: inactiveSockets,
-          errors: errors,
-        },
-      });
-
-    } else if (this.sockets.length === 0) {
-      throw new DyFM_Error({
-        ...this._getDefaultErrorSettings(
-          'emitEvent',
-          new Error(
-            `Emitting event '${event}' on socket(s)(${this.serviceName}) failed!`+ 
-            `\n  No more sockets left connected!`
-          ),
-          issuer
-        ),
-        errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-SPC-EE4`,
-      });
-    }
-  }
-  
-  private _getDefaultErrorSettings(
-    fnName: string, 
-    error: DyFM_AnyError, 
-    issuer: string
-  ): DyFM_Error_Settings {
-    return {
-      status: (error as DyFM_Error)?.___status ?? 500,
-      message: (error as Error)?.message ?? 
-        (error as DyFM_Error)?._message ??
-        `${fnName} was UNSUCCESSFUL (NTS; ${this.serviceName})`,
-      userMessage: (error as DyFM_Error)?.__userMessage ?? this.defaultErrorUserMsg,
-      issuerService: this.serviceName + ` (${this?.constructor?.name}-DyNTS_SocketPresence)`,
-      addECToUserMsg: !(error as DyFM_Error)?.__userMessage,
-      issuer: issuer,
-      error: error,
-    };
-  }
-
-}
-
+
+import {
+  DyFM_AnyError, DyFM_Error, DyFM_Error_Settings, DyFM_Log
+} from '@futdevpro/fsm-dynamo';
+import * as SocketIO from 'socket.io';
+import { DyNTS_global_settings } from '../../..';
+
+/**
+ * socket handling and clarification is under development
+ */
+export class DyNTS_SocketPresence {
+  /** 
+   * this is the presence ID which is used to get and handle the presence 
+   * usually the service master identifier such as userID 
+   * (issuerLocalId != issuer which is the main master identifier usually the accountID)
+   * */
+  issuerLocalId: string;
+  serviceName?: string = 'unknown';
+  onDestroy?: (issuerId: string) => void = (): void => {};
+  
+  defaultErrorUserMsg?: string = 
+    `We encountered an unhandled Socket Error, ` +
+    `\nplease contact the responsible development team.`; 
+  
+  sockets?: SocketIO.Socket[] = [];
+
+  issuer: string;
+  
+  constructor(
+    set: Partial<DyNTS_SocketPresence>
+  ) {
+    if (!set?.issuerLocalId) {
+      throw new DyFM_Error({ 
+        ...this._getDefaultErrorSettings(
+          'constructor',
+          new Error(
+            `trying to create DyNTS_SocketPresence without a valid issuerLocalId!`/*  +
+            `\nset: ${JSON.stringify(set)}` */
+          ),
+          set?.issuer
+        ),
+        errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-SD0-C00`,
+        additionalContent: { set: set },
+      });
+    }
+
+    this.issuerLocalId = set.issuerLocalId;
+    
+    if (set.serviceName) {
+      this.serviceName = set.serviceName;
+    }
+
+    if (set.onDestroy) {
+      this.onDestroy = set.onDestroy;
+    }
+
+    if (set.defaultErrorUserMsg) {
+      this.defaultErrorUserMsg = set.defaultErrorUserMsg;
+    }
+
+    if (!set?.sockets?.length) {
+      throw new DyFM_Error({ 
+        ...this._getDefaultErrorSettings(
+          'constructor',
+          new Error(
+            `trying to create DyNTS_SocketPresence without a single active socket!` +
+            `\nissuerId: ${this.issuerLocalId}`
+          ),
+          set?.issuer
+        ),
+
+        errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-SD0-C01`,
+      });
+    }
+
+    this.sockets = set.sockets;
+  }
+
+  /**
+   * Emits event on all sockets
+   * @param event 
+   * @param content 
+   */
+  emitEvent(event: string, content: any, issuer: string): void {
+    /* let anyFailed: boolean = false; */
+    const errors: any = [];
+    const inactiveSockets: SocketIO.Socket[] = [];
+
+    try {
+      JSON.stringify(content);
+    } catch {
+      throw new DyFM_Error({
+        ...this._getDefaultErrorSettings(
+          'emitEvent',
+          new Error(
+            `Emitting event '${event}' on socket(s)(${this.serviceName}) failed!`+
+            `\n  ERROR: content is not stringify-able!`
+          ),
+          issuer
+        ),
+
+        errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-SPC-EE1`,
+      });
+    }
+
+    this.sockets.forEach((socket: SocketIO.Socket, index: number) => {
+      if (!socket.connected) {
+        DyFM_Log.warn(
+          `Emitting event '${event}' on socket(${this.serviceName})-(${index}) failed!` +
+          `\n  ERROR: socket[${socket.id}] is not connected! (it will be removed...)`
+        );
+
+        /* errors.push(
+          new DyFM_Error({
+            status: 500,
+            errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-SPC-EE2',
+            addECToUserMsg: true,
+            message: 
+            `Emitting event '${event}' on socket(${this.serviceName})-(${index}) failed!`+
+            `\nERROR: socket[${socket.id}] is not connected!`,
+            userMessage: 'We encountered an unhandled Server Error, please contact the responsible development team.',
+          })
+        ); */
+
+        inactiveSockets.push(socket);
+        socket?.disconnect(true);
+      }
+    });
+
+    /* this.sockets.forEach((socket: SocketIO.Socket, index: number) => {
+      if (!socket) {
+        return;
+      }
+      if (inactiveSockets.includes(socket) || !socket?.connected) {
+        socket.TRY RECONNECT
+      } */
+
+    this.sockets = this.sockets.filter(
+      (socket): boolean => !inactiveSockets.includes(socket) && socket?.connected
+    );
+
+    this.sockets.forEach((socket: SocketIO.Socket, index: number): void => {
+      const success: boolean = socket.emit(event, content, (error): void => {
+        DyFM_Log.error(
+          `Emitting event '${event}' on socket(${this.serviceName})-(${index}) failed!(0)` +
+          `\nerror:`, error
+        );
+        errors.push(error);
+      });
+
+      if (!success) {
+        DyFM_Log.error(
+          `Emitting event '${event}' on socket(${this.serviceName})-(${index}) failed!(1)`
+        );
+      }
+    });
+
+    if (0 < errors.length) {
+      throw new DyFM_Error({
+        ...this._getDefaultErrorSettings(
+          'emitEvent',
+          new Error(
+            `Emitting event '${event}' on socket(s)(${this.serviceName}) failed!`+
+            `\n${errors.length} errors occured!`
+          ),
+          issuer
+        ),
+
+        errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-SPC-EE3`,
+        additionalContent: {
+          inactiveSockets: inactiveSockets,
+          errors: errors,
+        },
+      });
+
+    } else if (this.sockets.length === 0) {
+      throw new DyFM_Error({
+        ...this._getDefaultErrorSettings(
+          'emitEvent',
+          new Error(
+            `Emitting event '${event}' on socket(s)(${this.serviceName}) failed!`+ 
+            `\n  No more sockets left connected!`
+          ),
+          issuer
+        ),
+        errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-SPC-EE4`,
+      });
+    }
+  }
+  
+  private _getDefaultErrorSettings(
+    fnName: string, 
+    error: DyFM_AnyError, 
+    issuer: string
+  ): DyFM_Error_Settings {
+    return {
+      status: (error as DyFM_Error)?.___status ?? 500,
+      message: (error as Error)?.message ?? 
+        (error as DyFM_Error)?._message ??
+        `${fnName} was UNSUCCESSFUL (NTS; ${this.serviceName})`,
+      userMessage: (error as DyFM_Error)?.__userMessage ?? this.defaultErrorUserMsg,
+      issuerService: this.serviceName + ` (${this?.constructor?.name}-DyNTS_SocketPresence)`,
+      addECToUserMsg: !(error as DyFM_Error)?.__userMessage,
+      issuer: issuer,
+      error: error,
+    };
+  }
+
+}
+

package/src/_modules/socket/_models/socket-server-service-params.control-model.spec.ts

@@ -1,46 +1,46 @@
-
-import { DyNTS_global_settings } from '../../../_collections/global-settings.const';
-import { DyNTS_SocketSecurity } from '../_enums/socket-security.enum';
-import { DyNTS_SocketServerService_Params } from './socket-server-service-params.control-model';
-
-describe('| DyNTS_SocketServerService_Params', () => {
-  it('| should create an instance with provided values', () => {
-    const params = {
-      name: 'TestSocket',
-      port: 8080,
-      security: DyNTS_SocketSecurity.secure,
-    };
-
-    const instance = new DyNTS_SocketServerService_Params(params);
-
-    expect(instance.name).toBe('TestSocket');
-    expect(instance.port).toBe(8080);
-    expect(instance.security).toBe(DyNTS_SocketSecurity.secure);
-  });
-
-  it('| should use default security if not provided', () => {
-    const params = {
-      name: 'TestSocket',
-      port: 8080,
-    };
-
-    const instance = new DyNTS_SocketServerService_Params(params);
-
-    expect(instance.name).toBe('TestSocket');
-    expect(instance.port).toBe(8080);
-    expect(instance.security).toBe(DyNTS_global_settings.defaultSocketSecurity);
-  });
-
-  it('| should allow port to be omitted (optional, default used by app-extended)', () => {
-    const params = {
-      name: 'TestSocketNoPort',
-      security: DyNTS_SocketSecurity.open,
-    };
-
-    const instance = new DyNTS_SocketServerService_Params(params);
-
-    expect(instance.name).toBe('TestSocketNoPort');
-    expect(instance.port).toBeUndefined();
-    expect(instance.security).toBe(DyNTS_SocketSecurity.open);
-  });
-});
+
+import { DyNTS_global_settings } from '../../../_collections/global-settings.const';
+import { DyNTS_SocketSecurity } from '../_enums/socket-security.enum';
+import { DyNTS_SocketServerService_Params } from './socket-server-service-params.control-model';
+
+describe('| DyNTS_SocketServerService_Params', () => {
+  it('| should create an instance with provided values', () => {
+    const params = {
+      name: 'TestSocket',
+      port: 8080,
+      security: DyNTS_SocketSecurity.secure,
+    };
+
+    const instance = new DyNTS_SocketServerService_Params(params);
+
+    expect(instance.name).toBe('TestSocket');
+    expect(instance.port).toBe(8080);
+    expect(instance.security).toBe(DyNTS_SocketSecurity.secure);
+  });
+
+  it('| should use default security if not provided', () => {
+    const params = {
+      name: 'TestSocket',
+      port: 8080,
+    };
+
+    const instance = new DyNTS_SocketServerService_Params(params);
+
+    expect(instance.name).toBe('TestSocket');
+    expect(instance.port).toBe(8080);
+    expect(instance.security).toBe(DyNTS_global_settings.defaultSocketSecurity);
+  });
+
+  it('| should allow port to be omitted (optional, default used by app-extended)', () => {
+    const params = {
+      name: 'TestSocketNoPort',
+      security: DyNTS_SocketSecurity.open,
+    };
+
+    const instance = new DyNTS_SocketServerService_Params(params);
+
+    expect(instance.name).toBe('TestSocketNoPort');
+    expect(instance.port).toBeUndefined();
+    expect(instance.security).toBe(DyNTS_SocketSecurity.open);
+  });
+});

package/src/_modules/socket/_models/socket-server-service-params.control-model.ts

@@ -1,22 +1,22 @@
-
-import { DyNTS_global_settings } from '../../../_collections/global-settings.const';
-import { DyNTS_SocketSecurity } from '../_enums/socket-security.enum';
-
-/**
- * Socket service paraméterek.
- * A port opcionális: ha nincs megadva, az app-extended a getPortSettings() httpPort/httpsPort értékét használja (ugyanaz a port, mint a HTTP/HTTPS).
- */
-export class DyNTS_SocketServerService_Params<T = any> {
-  name: string;
-  /** Opcionális: ha nincs megadva, az extended app a HTTP/HTTPS portot használja (same port). */
-  port?: number;
-  security?: DyNTS_SocketSecurity;
-
-  constructor(
-    set: DyNTS_SocketServerService_Params<T>
-  ) {
-    this.name = set.name;
-    this.port = set.port;
-    this.security = set.security ? set.security : DyNTS_global_settings.defaultSocketSecurity;
-  }
-}
+
+import { DyNTS_global_settings } from '../../../_collections/global-settings.const';
+import { DyNTS_SocketSecurity } from '../_enums/socket-security.enum';
+
+/**
+ * Socket service paraméterek.
+ * A port opcionális: ha nincs megadva, az app-extended a getPortSettings() httpPort/httpsPort értékét használja (ugyanaz a port, mint a HTTP/HTTPS).
+ */
+export class DyNTS_SocketServerService_Params<T = any> {
+  name: string;
+  /** Opcionális: ha nincs megadva, az extended app a HTTP/HTTPS portot használja (same port). */
+  port?: number;
+  security?: DyNTS_SocketSecurity;
+
+  constructor(
+    set: DyNTS_SocketServerService_Params<T>
+  ) {
+    this.name = set.name;
+    this.port = set.port;
+    this.security = set.security ? set.security : DyNTS_global_settings.defaultSocketSecurity;
+  }
+}

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

@@ -1,15 +1,15 @@
-
-import { DyNTS_SocketClient_ServiceBase } from './socket-client.service';
-import { DyNTS_SocketClientService_Params } from '../_models/socket-client-service-params.control-model';
-import { DyFM_SocketEvent, DyFM_SocketEvent_Key } from '@futdevpro/fsm-dynamo/socket';
-
-// Skip these tests - socket.io-client 'io' export cannot be reliably mocked
-// as it's not writable and the spyOn approach fails
-describe('| DyNTS_SocketClient_ServiceBase', () => {
-  it('| tests skipped due to socket.io-client io not being writable', () => {
-    // The io function from socket.io-client cannot be mocked with spyOn
-    // because it's a non-writable export
-    expect(true).toBe(true);
-  });
-});
-
+
+import { DyNTS_SocketClient_ServiceBase } from './socket-client.service';
+import { DyNTS_SocketClientService_Params } from '../_models/socket-client-service-params.control-model';
+import { DyFM_SocketEvent, DyFM_SocketEvent_Key } from '@futdevpro/fsm-dynamo/socket';
+
+// Skip these tests - socket.io-client 'io' export cannot be reliably mocked
+// as it's not writable and the spyOn approach fails
+describe('| DyNTS_SocketClient_ServiceBase', () => {
+  it('| tests skipped due to socket.io-client io not being writable', () => {
+    // The io function from socket.io-client cannot be mocked with spyOn
+    // because it's a non-writable export
+    expect(true).toBe(true);
+  });
+});
+