@hotmeshio/hotmesh 0.0.52 → 0.0.54

package/services/serializer/index.ts

@@ -136,7 +136,10 @@ export class SerializerService {
           let shortKey = abbreviationMap.get(key) || key;
           const shortDimensionalKey = `${shortKey}${dimensionalIndex}`;
           result[shortDimensionalKey] = source[key];
-          }
+        } else if (!(key in result) && this.isLiteralKeyType(key)) {
+          //mark (-) and search (_)
+          result[key] = source[key];
+        }  
       }
     };
     for (let id of ids) {
@@ -148,6 +151,10 @@ export class SerializerService {
     return result;
   }
 
+  isLiteralKeyType(key: string): boolean {
+    return key.startsWith('-') || key.startsWith('_');
+  }
+
   decompress(document: StringStringType, ids: string[]): StringStringType {
     if (this.symKeys.size === 0) {
       return document;
@@ -179,7 +186,7 @@ export class SerializerService {
   stringify(document: Record<string, any>): StringStringType {
     let result: StringStringType = {};
     for (let key in document) {
-      let value = this.toString(document[key]);
+      let value = SerializerService.toString(document[key]);
       if (value) {
         if (/^:*[a-zA-Z]{2}$/.test(value)) {
           value = ':' + value;
@@ -203,13 +210,13 @@ export class SerializerService {
         if (value?.length === 2 && this.symValMaps.has(value)) {
           value = this.symValMaps.get(value);
         }
-        result[key] = this.fromString(value);
+        result[key] = SerializerService.fromString(value);
       }
     }
     return result;
   }
 
-  toString(value: any): string|undefined {
+  static toString(value: any): string|undefined {
     switch (typeof value) {
       case 'string':
         break;
@@ -232,7 +239,7 @@ export class SerializerService {
     return value;
   }
 
-  fromString(value: string|undefined): any {
+  static fromString(value: string|undefined): any {
     if (typeof value !== 'string') return undefined;
     const prefix = value.slice(0, 2);
     const rest = value.slice(2);

package/services/store/clients/ioredis.ts

@@ -77,7 +77,7 @@ class IORedisStoreService extends StoreService<RedisClientType, RedisMultiType>
     try {
       return await (multi || this.redisClient).xadd(key, id, messageId, messageValue);
     } catch (error) {
-      this.logger.error(`Error publishing 'xadd'; key: ${key}`, { error });
+      this.logger.error(`Error publishing 'xadd'; key: ${key}`, { ...error });
       throw error;
     }
   }
@@ -93,7 +93,7 @@ class IORedisStoreService extends StoreService<RedisClientType, RedisMultiType>
     try {
       return await this.redisClient.xpending(key, group, start, end, count, consumer);
     } catch (error) {
-      this.logger.error(`Error in retrieving pending messages for [stream ${key}], [group ${group}]`, { error });
+      this.logger.error(`Error in retrieving pending messages for [stream ${key}], [group ${group}]`, { ...error });
       throw error;
     }
   }
@@ -109,7 +109,7 @@ class IORedisStoreService extends StoreService<RedisClientType, RedisMultiType>
     try {
       return await this.redisClient.xclaim(key, group, consumer, minIdleTime, id, ...args) as unknown as ReclaimedMessageType;
     } catch (error) {
-      this.logger.error(`Error in claiming message with id: ${id} in group: ${group} for key: ${key}`, { error });
+      this.logger.error(`Error in claiming message with id: ${id} in group: ${group} for key: ${key}`, { ...error });
       throw error;
     }
   }
@@ -118,7 +118,7 @@ class IORedisStoreService extends StoreService<RedisClientType, RedisMultiType>
     try {
       return await (multi || this.redisClient).xack(key, group, id);
     } catch (error) {
-      this.logger.error(`Error in acknowledging messages in group: ${group} for key: ${key}`, { error });
+      this.logger.error(`Error in acknowledging messages in group: ${group} for key: ${key}`, { ...error });
       throw error;
     }
   }
@@ -127,7 +127,7 @@ class IORedisStoreService extends StoreService<RedisClientType, RedisMultiType>
     try {
       return await (multi || this.redisClient).xdel(key, id);
     } catch (error) {
-      this.logger.error(`Error in deleting messages with id: ${id} for key: ${key}`, { error });
+      this.logger.error(`Error in deleting messages with id: ${id} for key: ${key}`, { ...error });
       throw error;
     }
   }
@@ -136,7 +136,7 @@ class IORedisStoreService extends StoreService<RedisClientType, RedisMultiType>
     try {
       return await (multi || this.redisClient).xlen(key);
     } catch (error) {
-      this.logger.error(`Error getting stream depth: ${key}`, { error });
+      this.logger.error(`Error getting stream depth: ${key}`, { ...error });
       throw error;
     }
   }

package/services/store/clients/redis.ts

@@ -89,7 +89,7 @@ class RedisStoreService extends StoreService<RedisClientType, RedisMultiType> {
       return (await this.redisClient.sendCommand(['XGROUP', 'CREATE', key, groupName, id, ...args])) === 1;
     } catch (error) {
       const streamType = mkStream === 'MKSTREAM' ? 'with MKSTREAM' : 'without MKSTREAM';
-      this.logger.debug(`x-group-error ${streamType} for key: ${key} and group: ${groupName}`, { error });
+      this.logger.debug(`x-group-error ${streamType} for key: ${key} and group: ${groupName}`, { ...error });
       throw error;
     }
   }
@@ -102,7 +102,7 @@ class RedisStoreService extends StoreService<RedisClientType, RedisMultiType> {
     try {
       return await (multi || this.redisClient).XADD(key, id, { [args[0]]: args[1] });
     } catch (error) {
-      this.logger.error(`Error publishing 'xadd'; key: ${key}`, { error });
+      this.logger.error(`Error publishing 'xadd'; key: ${key}`, { ...error });
       throw error;
     }
   }
@@ -123,7 +123,7 @@ class RedisStoreService extends StoreService<RedisClientType, RedisMultiType> {
       if (consumer) args.push(consumer);
       return await this.redisClient.sendCommand(['XPENDING', ...args]);
     } catch (error) {
-      this.logger.error(`Error in retrieving pending messages for group: ${group} in key: ${key}`, { error });
+      this.logger.error(`Error in retrieving pending messages for group: ${group} in key: ${key}`, { ...error });
       throw error;
     }
   }
@@ -139,7 +139,7 @@ class RedisStoreService extends StoreService<RedisClientType, RedisMultiType> {
     try {
       return await this.redisClient.sendCommand(['XCLAIM', key, group, consumer, minIdleTime.toString(), id, ...args]) as unknown as ReclaimedMessageType;
     } catch (error) {
-      this.logger.error(`Error in claiming message with id: ${id} in group: ${group} for key: ${key}`, { error });
+      this.logger.error(`Error in claiming message with id: ${id} in group: ${group} for key: ${key}`, { ...error });
       throw error;
     }
   }
@@ -153,7 +153,7 @@ class RedisStoreService extends StoreService<RedisClientType, RedisMultiType> {
         return await this.redisClient[this.commands.xack](key, group, id);
       }
     } catch (error) {
-      this.logger.error(`Error in acknowledging messages in group: ${group} for key: ${key}`, { error });
+      this.logger.error(`Error in acknowledging messages in group: ${group} for key: ${key}`, { ...error });
       throw error;
     }
   }
@@ -167,7 +167,7 @@ class RedisStoreService extends StoreService<RedisClientType, RedisMultiType> {
         return await this.redisClient[this.commands.xdel](key, id);
       }
     } catch (error) {
-      this.logger.error(`Error in deleting messages with ids: ${id} for key: ${key}`, { error });
+      this.logger.error(`Error in deleting messages with ids: ${id} for key: ${key}`, { ...error });
       throw error;
     }
   }
@@ -181,7 +181,7 @@ class RedisStoreService extends StoreService<RedisClientType, RedisMultiType> {
         return await this.redisClient.XLEN(key);
       }
     } catch (error) {
-      this.logger.error(`Error getting stream depth: ${key}`, { error });
+      this.logger.error(`Error getting stream depth: ${key}`, { ...error });
       throw error;
     }
   }

package/services/store/index.ts

@@ -977,6 +977,8 @@ abstract class StoreService<T, U extends AbstractRedisClient> {
    * This method is called by the engine and not by an activity and is
    * followed by a call to execute job completion/cleanup tasks
    * associated with a job completion event.
+   * 
+   * Todo: move most of this logic to the engine (too much logic for the store)
    */
   async interrupt(topic: string, jobId: string, options: JobInterruptOptions = {}): Promise<void> {
     try {
@@ -1004,8 +1006,9 @@ abstract class StoreService<T, U extends AbstractRedisClient> {
 
         //persists the standard 410 error (job is `gone`)
         const err = JSON.stringify({
-          code: HMSH_CODE_INTERRUPT,
+          code: options.code ?? HMSH_CODE_INTERRUPT,
           message: options.reason ?? `job [${jobId}] interrupted`,
+          stack: options.stack ?? '',
           job_id: jobId
         });
 

package/services/stream/clients/ioredis.ts

@@ -51,7 +51,7 @@ class IORedisStreamService extends StreamService<RedisClientType, RedisMultiType
     try {
       return await (multi || this.redisClient).xadd(key, id, messageId, messageValue);
     } catch (error) {
-      this.logger.error(`Error publishing 'xadd'; key: ${key}`, { error });
+      this.logger.error(`Error publishing 'xadd'; key: ${key}`, { ...error });
       throw error;
     }
   }
@@ -80,7 +80,7 @@ class IORedisStreamService extends StreamService<RedisClientType, RedisMultiType
         id
       );
     } catch (error) {
-      this.logger.error(`Error reading stream data [Stream ${streamName}] [Group ${groupName}]`, { error });
+      this.logger.error(`Error reading stream data [Stream ${streamName}] [Group ${groupName}]`, { ...error });
       throw error;
     }
   }
@@ -102,10 +102,10 @@ class IORedisStreamService extends StreamService<RedisClientType, RedisMultiType
       try {
         return await this.redisClient.call('XPENDING', ...args) as [string, string, number, number][];
       } catch (error) {
-        this.logger.error('err, args', { error }, args);
+        this.logger.error('err, args', { ...error }, args);
       }
     } catch (error) {
-      this.logger.error(`Error in retrieving pending messages for [stream ${key}], [group ${group}]`, { error });
+      this.logger.error(`Error in retrieving pending messages for [stream ${key}], [group ${group}]`, { ...error });
       throw error;
     }
   }
@@ -121,7 +121,7 @@ class IORedisStreamService extends StreamService<RedisClientType, RedisMultiType
     try {
       return await this.redisClient.xclaim(key, group, consumer, minIdleTime, id, ...args) as unknown as ReclaimedMessageType;
     } catch (error) {
-      this.logger.error(`Error in claiming message with id: ${id} in group: ${group} for key: ${key}`, { error });
+      this.logger.error(`Error in claiming message with id: ${id} in group: ${group} for key: ${key}`, { ...error });
       throw error;
     }
   }
@@ -130,7 +130,7 @@ class IORedisStreamService extends StreamService<RedisClientType, RedisMultiType
     try {
       return await (multi || this.redisClient).xack(key, group, id);
     } catch (error) {
-      this.logger.error(`Error in acknowledging messages in group: ${group} for key: ${key}`, { error });
+      this.logger.error(`Error in acknowledging messages in group: ${group} for key: ${key}`, { ...error });
       throw error;
     }
   }
@@ -139,7 +139,7 @@ class IORedisStreamService extends StreamService<RedisClientType, RedisMultiType
     try {
       return await (multi || this.redisClient).xdel(key, id);
     } catch (error) {
-      this.logger.error(`Error in deleting messages with id: ${id} for key: ${key}`, { error });
+      this.logger.error(`Error in deleting messages with id: ${id} for key: ${key}`, { ...error });
       throw error;
     }
   }
@@ -148,7 +148,7 @@ class IORedisStreamService extends StreamService<RedisClientType, RedisMultiType
     try {
       return await (multi || this.redisClient).xlen(key);
     } catch (error) {
-      this.logger.error(`Error getting stream depth: ${key}`, { error });
+      this.logger.error(`Error getting stream depth: ${key}`, { ...error });
       throw error;
     }
   }

package/services/stream/clients/redis.ts

@@ -149,7 +149,7 @@ class RedisStreamService extends StreamService<RedisClientType, RedisMultiType>
         return await this.redisClient.XLEN(key);
       }
     } catch (error) {
-      this.logger.error(`Error getting stream depth: ${key}`, { error });
+      this.logger.error(`Error getting stream depth: ${key}`, { ...error });
       throw error;
     }
   }

package/types/activity.ts

@@ -110,32 +110,104 @@ interface SignalActivity extends BaseActivity {
 
 interface InterruptActivity extends BaseActivity {
   type: 'interrupt';
-  /** Optional Reason; will be used as the error `message` when thrown; NOTE: 410 is the error `code` */
+
+  /** 
+   * Optional Reason; will be used as the error `message` when thrown
+   * @default 'Job Interrupted'
+   */
   reason?: string;
-  /** default is `true` (throw JobInterrupted error upon interrupting) */
+
+  /** 
+   * throw JobInterrupted error upon interrupting
+   * @default true
+   */
   throw?: boolean;
-  /** TODO: // default is `false` (do not interrupt child jobs) */
+
+  /** 
+   * Interrupt child/descendant jobs
+   * @default false
+   */
   descend?: boolean;
-  /** target job id (if not present the current job will be targeted) */
+
+  /** 
+   * Target job id (if not present the current job will be targeted)
+   */
   target?: string;
-  /** topic to publish the interrupt message (if not present the current job topic will be used) */
+
+  /** 
+   * Optional topic to publish the interrupt message (if not present the current job topic will be used
+   */
   topic?: string;
+
+  /** 
+   * Optional Error Code; will be used as the error `code` when thrown
+   * @default 410
+   */
+  code?: number;
+
+  /**
+   * Optional stack trace
+   */
+  stack?: string;
 }
 
 type ActivityType = BaseActivity | TriggerActivity | AwaitActivity | WorkerActivity | InterruptActivity | HookActivity | SignalActivity | CycleActivity;
 
 type ActivityData = Record<string, any>;
+
+/**
+ * Type definition for activity metadata.
+ */
 type ActivityMetadata = {
-  aid: string;  //activity_id
-  atp: string;  //activity_type
-  stp: string;  //activity_subtype
-  ac: string;   //GMT created //activity_created
-  au: string;   //GMT updated //activity_updated
-  err?: string; //stringified error json: {message: string, code: number, error?}
-  l1s?: string; //open telemetry span context (leg 1)
-  l2s?: string; //open telemetry span context (leg 2)
-  dad?: string; //dimensional address
-  as?: string;  //activity status (e.g., 889000001000001)
+  /**
+   * Unique identifier for the activity.
+   */
+  aid: string;
+
+  /**
+   * Type of the activity.
+   */
+  atp: string;
+
+  /**
+   * Subtype of the activity.
+   */
+  stp: string;
+
+  /**
+   * Timestamp when the activity was created, in GMT.
+   */
+  ac: string;
+
+  /**
+   * Timestamp when the activity was last updated, in GMT.
+   */
+  au: string;
+
+  /**
+   * Optional stringified JSON containing error details such as message, code, and an optional error object.
+   */
+  err?: string;
+
+  /**
+   * OpenTelemetry span context for the first leg of the activity.
+   */
+  l1s?: string;
+
+  /**
+   * OpenTelemetry span context for the second leg of the activity.
+   */
+  l2s?: string;
+
+  /**
+   * Dimensional address, used for additional metadata.
+   */
+  dad?: string;
+
+  /**
+   * Status of the activity, could be codes representing different states.
+   */
+  as?: string;
 };
 
 type ActivityContext = {