@futdevpro/nts-dynamo 1.9.38 → 1.9.40

package/src/_modules/socket/_services/socket-server.service.ts

@@ -68,7 +68,7 @@ export abstract class DyNTS_SocketServerService<
 
     this.asyncConstructor().catch((error: any) => {
       DyFM_Log.error(
-        `Socket Server Service setup failed: ${this.params?.name} (${this.params?.port})`, 
+        `Socket Server Service setup failed: "${this.params?.name}" (${this.params?.port})`, 
         error
       );
     });
@@ -91,12 +91,12 @@ export abstract class DyNTS_SocketServerService<
       await this.prepareEvents();
 
       if (this.logSetup) console.log(
-        `Socket Server Service setup done: ${this.params.name} (${this.params.port}) ` +
+        `Socket Server Service setup done: "${this.params.name}" (${this.params.port}) ` +
         `security: ${this.params.security}\n`
       );
     } catch (error) {
       DyFM_Log.error(
-        `Socket Server Service setup failed: ${this.params?.name} (${this.params?.port})`, 
+        `Socket Server Service setup failed: "${this.params?.name}" (${this.params?.port})`, 
         error
       );
 
@@ -225,7 +225,7 @@ export abstract class DyNTS_SocketServerService<
       } else {
         DyFM_Log.error(
           'getPresenceFromSubscriptionEventContent is not set', 
-          `${this.params.name} (${this.params.port})`
+          `"${this.params.name}" (${this.params.port})`
         );
       }
 
@@ -236,7 +236,7 @@ export abstract class DyNTS_SocketServerService<
     } catch (error) {
       DyFM_Log.error(
         `Socket Server Service - Event Preparation setup failed: ` +
-        `${this.params?.name} (${this.params?.port})`, 
+        `"${this.params?.name}" (${this.params?.port})`, 
         error
       );
 
@@ -272,13 +272,13 @@ export abstract class DyNTS_SocketServerService<
                   if (DyNTS_global_settings.log_settings.socket_eventContent) {
                     DyFM_Log.log(
                       `--=>   incoming socket(${this.params.name}) ` +
-                      `event: ${DyFM_SocketEvent_Key.subscribe};` +
+                      `event: "${DyFM_SocketEvent_Key.subscribe}";` +
                       `\ncontent:`, content
                     );
                   } else {
                     DyFM_Log.log(
                       `--=>   incoming socket(${this.params.name}) ` +
-                      `event: ${DyFM_SocketEvent_Key.subscribe}`
+                      `event: "${DyFM_SocketEvent_Key.subscribe}"`
                     );
                   }
 
@@ -309,13 +309,13 @@ export abstract class DyNTS_SocketServerService<
                 } catch (error) {
                   if (DyNTS_global_settings.log_settings.socket_eventContent) {
                     DyFM_Log.error(
-                      `Socket Subscription failed: ${this.params.name} ` ,
+                      `Socket Subscription failed: "${this.params.name}" ` ,
                       `(${this.params.port}) will disconnect now...`, 
                       error
                     );
                   } else {
                     DyFM_Log.error(
-                      `Socket Subscription failed: ${this.params.name} ` ,
+                      `Socket Subscription failed: "${this.params.name}" ` ,
                       `(${this.params.port}) will disconnect now...`
                     );
                   }
@@ -368,13 +368,13 @@ export abstract class DyNTS_SocketServerService<
                 } catch (error) {
                   if (DyNTS_global_settings.log_settings.socket_eventContent) {
                     DyFM_Log.error(
-                      `Socket unsubscribe failed: ${this.params.name} ` ,
+                      `Socket unsubscribe failed: "${this.params.name}" ` ,
                       `(${this.params.port}) will disconnect now...`, 
                       error
                     );
                   } else {
                     DyFM_Log.error(
-                      `Socket unsubscribe failed: ${this.params.name} ` ,
+                      `Socket unsubscribe failed: "${this.params.name}" ` ,
                       `(${this.params.port}) will disconnect now...`
                     );
                   }
@@ -392,7 +392,7 @@ export abstract class DyNTS_SocketServerService<
                   await event.executeEventTasks(content, issuer);
                 } catch (error) {
                   DyFM_Log.error(
-                    `Socket Event failed: ${this.params.name} (${this.params.port})`, 
+                    `Socket Event failed: "${this.params.name}" (${this.params.port})`, 
                     error
                   );
                   socket.emit(DyFM_SocketEvent_Key.error, error);
@@ -406,7 +406,7 @@ export abstract class DyNTS_SocketServerService<
           }
         } catch (error) {
           DyFM_Log.error(
-            `Socket Connection failed: ${this.params.name} ` +
+            `Socket Connection failed: "${this.params.name}" ` +
             `(${this.params.port}) will disconnect now...`, 
             error
           );
@@ -418,8 +418,8 @@ export abstract class DyNTS_SocketServerService<
       newSocketServer.listen(this.params.port);
       
       DyFM_Log.success(
-        `\nsocket server setup finished: ${this.params.name}` + 
-        `\nsocket server listening on port: ${this.params.port}`
+        `\nsocket server setup finished: "${this.params.name}"` + 
+        `\nsocket server listening on port: "${this.params.port}"`
       );
 
       successCallback();
@@ -435,7 +435,7 @@ export abstract class DyNTS_SocketServerService<
       }
     } catch (error) {
       DyFM_Log.error(
-        `Socket Server Service - Deep Setup failed: ${this.params?.name} ` +
+        `Socket Server Service - Deep Setup failed: "${this.params?.name}" ` +
         `(${this.params?.port})`, 
         error
       );
@@ -458,12 +458,12 @@ export abstract class DyNTS_SocketServerService<
     } catch (error) {
       if (DyNTS_global_settings.log_settings.socket_eventContent) {
         DyFM_Log.error(
-          `Socket Subscription failed: ${this.params?.name} (${this.params?.port})`, 
+          `Socket Subscription failed: "${this.params?.name}" (${this.params?.port})`, 
           error
         );
       } else {
         DyFM_Log.error(
-          `Socket Subscription failed: ${this.params?.name} (${this.params?.port})`
+          `Socket Subscription failed: "${this.params?.name}" (${this.params?.port})`
         );
       }
 
@@ -516,8 +516,8 @@ export abstract class DyNTS_SocketServerService<
           ...this._getDefaultErrorSettings(
             'sendEventForId',
             new Error(
-              `socket subscription for ${issuer} and ` +
-              `${activePresence.issuerLocalId} does not match.`
+              `socket subscription for "${issuer}" and ` +
+              `"${activePresence.issuerLocalId}" does not match.`
             ),
             issuer
           ),
@@ -568,7 +568,7 @@ export abstract class DyNTS_SocketServerService<
         ),
 
         errorCode: 'NTS-SSS-200',
-        message: `socket(${this.params.name}) Subscription Removal failed: ${this.params?.name}`,
+        message: `socket(${this.params.name}) Subscription Removal failed: "${this.params?.name}"`,
       });
     }
   }
@@ -630,6 +630,32 @@ export abstract class DyNTS_SocketServerService<
 
   async sendEventForId(id: string, event: string, content: any, issuer: string): Promise<void> {
     try {
+      if (!event) {
+        throw new DyFM_Error({
+          ...this._getDefaultErrorSettings(
+            'sendEventForId',
+            new Error('No event was provided'),
+            content?.source
+          ),
+
+          status: 400, 
+          errorCode: 'NTS-SSS-300',
+        });
+      }
+
+      if (!id) {
+        throw new DyFM_Error({
+          ...this._getDefaultErrorSettings(
+            'sendEventForId',
+            new Error('No ID was provided'),
+            content?.source
+          ),
+
+          status: 400, 
+          errorCode: 'NTS-SSS-301',
+        });
+      }
+
       const presence: DyNTS_SocketPresence = this.presences.find(
         (pres: DyNTS_SocketPresence) => pres.issuerLocalId === id
       );
@@ -638,7 +664,7 @@ export abstract class DyNTS_SocketServerService<
         throw new DyFM_Error({ 
           ...this._getDefaultErrorSettings(
             'sendEventForId',
-            new Error(`No active socket with this specific ID: ${id}`),
+            new Error(`No active socket with this specific ID: "${id}"`),
             content?.source
           ),
 
@@ -651,13 +677,13 @@ export abstract class DyNTS_SocketServerService<
 
       if (DyNTS_global_settings.log_settings.socket_eventContent) {
         DyFM_Log.success(
-          ` <--=  emitted socket(${this.params.name}) event for presence: ${event}, ` +
-          `\n  presenceId: ${id}, sockets: ${presence.sockets.length}` +
+          ` <--=  emitted socket(${this.params.name}) event: "${event}", ` +
+          `\n  presenceId: "${id}", sockets: ${presence.sockets.length}` +
           `\n  content:`, content
         );
       } else {
         DyFM_Log.success(
-          ` <--=  emitted socket(${this.params.name}) event for presence: ${event}, ` +
+          ` <--=  emitted socket(${this.params.name}) event: "${event}", ` +
           `\n  presenceId: ${id}, sockets: ${presence.sockets.length}`
         );
       }
@@ -678,7 +704,7 @@ export abstract class DyNTS_SocketServerService<
             throw new DyFM_Error({ 
               ...this._getDefaultErrorSettings(
                 'sendEventForId',
-                new Error(`No active socket(${this.params.name}) with this specific ID: ${id}`),
+                new Error(`No active socket(${this.params.name}) with this specific ID: "${id}"`),
                 content?.source
               ),
 
@@ -709,7 +735,7 @@ export abstract class DyNTS_SocketServerService<
 
   broadcastEvent(event: string, content: any, issuer: string): void {
     try {
-      DyFM_Log.log(` <=-== broadcasting socket(${this.params.name}) event: ${event}`);
+      DyFM_Log.log(` <=-== broadcasting socket(${this.params.name}) event: "${event}"`);
 
       this.presences.forEach((presence: DyNTS_SocketPresence) => {
         presence.emitEvent(event, content, issuer);
@@ -733,7 +759,9 @@ export abstract class DyNTS_SocketServerService<
   ): DyFM_Error_Settings {
     return {
       status: (error as DyFM_Error)?.___status ?? 500,
-      message: (error as Error)?.message ?? `${fnName} was UNSUCCESSFUL (NTS)`,
+      message: (error as Error)?.message ?? 
+        (error as DyFM_Error)?._message ?? 
+        `${fnName} was UNSUCCESSFUL (NTS)`,
       addECToUserMsg: !(error as DyFM_Error)?.__userMessage,
       userMessage: (error as DyFM_Error)?.__userMessage ?? this.defaultErrorUserMsg,
       issuer: issuer,

package/src/_services/base/archive-data.service.ts

@@ -0,0 +1,207 @@
+
+import { 
+  DyFM_Metadata, DyFM_DataModel_Params, DyFM_Error
+} from '@futdevpro/fsm-dynamo';
+
+import { DyNTS_DataService } from './data.service';
+import { DyNTS_getArchivedDBName } from '../../_collections/archive.util';
+import { DyNTS_GlobalService } from '../core/global.service';
+import { DyNTS_DBService } from './db.service';
+import { DyNTS_DBFilterSimple } from '../../_models/types/db-filter.type';
+
+// TODO: 3 type of archiving service system: 
+// 1.: within list (data have a list that have elements to archive)
+// 2.: separate db elements needs to be archived
+// 3.: from separate db elements to archive list elements
+
+export class DyNTS_ArchiveDataService<T extends DyFM_Metadata> extends DyNTS_DataService<T> {
+
+  originalDBService: DyNTS_DBService<T>;
+
+  constructor(
+    /**
+     * Initial data, this will be used by functions on default
+     */
+    data: T,
+    /**
+     * DB data prams will be used to connect to usable dbService on GlobalService
+     */
+    dataParams: DyFM_DataModel_Params,
+    /**
+     * Initial set for issuer to be able to follow the issuer's activity
+     */
+    issuer: string
+  ) {
+    const originalDataParams = { ...dataParams };
+    
+    dataParams = { 
+      ...dataParams,
+      dataName: DyNTS_getArchivedDBName(dataParams.dataName),
+    };
+    
+    super(data, dataParams, issuer);
+
+    this.originalDBService = DyNTS_GlobalService.getDBService<T>(originalDataParams);
+  }
+
+  async archiveDataById(id: string): Promise<T> {
+    try {
+      if (!id) {
+        throw new DyFM_Error({
+          ...this.getDefaultErrorSettings(
+            'archiveDataById',
+            new Error('archiveDataById failed, id is missing!')
+          ),
+
+          errorCode: 'NTS-ADS-ADI1',
+        });
+      }
+      
+      const data = await this.originalDBService.getDataById(id);
+
+      if (!data) {
+        throw new DyFM_Error({
+          ...this.getDefaultErrorSettings(
+            'archiveDataById',
+            new Error('archiveDataById failed, data not found!')
+          ),
+
+          errorCode: 'NTS-ADS-ADI2',
+          additionalContent: { 
+            id: id,
+          },
+        });
+      }
+
+      return await this.archiveData(data);
+    } catch (error) {
+      throw new DyFM_Error({
+        ...this.getDefaultErrorSettings(
+          'archiveDataById',
+          error
+        ),
+
+        errorCode: 'NTS-ADS-ADI0',
+      });
+    }      
+  }
+
+  async getDataByOriginalId(originalId: string, dontSetToService?: boolean): Promise<T> {
+    try {
+      return await this.findData(
+        {
+          _originalId: originalId,
+        } as DyNTS_DBFilterSimple<T>, 
+        dontSetToService
+      );
+    } catch (error) {
+      throw new DyFM_Error({
+        ...this.getDefaultErrorSettings(
+          'getDataByOriginalId',
+          error
+        ),
+
+        errorCode: 'NTS-ADS-GDOI0',
+      });
+    }
+  }
+
+  async archiveData(data?: T, dontSetToService?: boolean): Promise<T> {
+    try {
+      data = this.ensureData(data);
+      
+      if (data?._originalId) {
+        throw new DyFM_Error({
+          ...this.getDefaultErrorSettings(
+            'archiveData',
+            new Error(
+              `archiveData failed, originalId is already exists! (${this.dataParams.dataName})`
+            )
+          ),
+
+          errorCode: 'NTS-ADS-AD1',
+        });
+      }
+
+      if (data?._archived) {
+        throw new DyFM_Error({
+          ...this.getDefaultErrorSettings(
+            'archiveData',
+            new Error(
+              `archiveData failed, data is already archived! (${this.dataParams.dataName})`
+            )
+          ),
+
+          errorCode: 'NTS-ADS-AD2',
+        });
+      }
+
+      if (!data?._id) {
+        throw new DyFM_Error({
+          ...this.getDefaultErrorSettings(
+            'archiveData',
+            new Error(`archiveData failed, id is missing! (${this.dataParams.dataName})`)
+          ),
+
+          errorCode: 'NTS-ADS-AD3',
+        });
+      }
+
+      await this.originalDBService.deleteDataById(data._id);
+
+      data._originalId = data._id;
+      data._archived = new Date();
+      delete data._id;
+
+      return await this.saveData(data, dontSetToService);
+    } catch (error) {
+      throw new DyFM_Error({
+        ...this.getDefaultErrorSettings(
+          'archiveData',
+          error
+        ),
+
+        errorCode: 'NTS-ADS-AD0',
+      });
+    }
+  }
+
+  override async saveData(data?: T, dontSetToService?: boolean): Promise<T> {
+    try {
+      data = this.ensureData(data);
+  
+      if (!data?._originalId) {
+        throw new DyFM_Error({
+          ...this.getDefaultErrorSettings(
+            'saveData',
+            new Error(`saveData failed, originalId is missing! (${this.dataParams.dataName})`)
+          ),
+  
+          errorCode: 'NTS-ADS-SD1',
+        });
+      }
+  
+      if (!data?._archived) {
+        throw new DyFM_Error({
+          ...this.getDefaultErrorSettings(
+            'saveData',
+            new Error(`saveData failed, data is not archived! (${this.dataParams.dataName})`)
+          ),
+  
+          errorCode: 'NTS-ADS-SD2',
+        });
+      }
+      
+      return await super.saveData(data, dontSetToService);
+    } catch (error) {
+      throw new DyFM_Error({
+        ...this.getDefaultErrorSettings(
+          'saveData',
+          error
+        ),
+
+        errorCode: 'NTS-ADS-SD0',
+      });
+    }
+  }
+}