@hotmeshio/hotmesh 0.1.2 → 0.1.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hotmeshio/hotmesh",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "Unbreakable Workflows",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",
@@ -31,7 +31,7 @@
     "test:durable:collision": "NODE_ENV=test jest ./tests/durable/collision/index.test.ts --detectOpenHandles --forceExit --verbose",
     "test:durable:fatal": "NODE_ENV=test jest ./tests/durable/fatal/index.test.ts --detectOpenHandles --forceExit --verbose",
     "test:durable:goodbye": "NODE_ENV=test jest ./tests/durable/goodbye/index.test.ts --detectOpenHandles --forceExit --verbose",
-    "test:durable:hello": "NODE_ENV=test jest ./tests/durable/helloworld/index.test.ts --detectOpenHandles --forceExit --verbose",
+    "test:durable:hello": "HMSH_IS_CLUSTER=true NODE_ENV=test jest ./tests/durable/helloworld/index.test.ts --detectOpenHandles --forceExit --verbose",
     "test:durable:hook": "NODE_ENV=test jest ./tests/durable/hook/index.test.ts --detectOpenHandles --forceExit --verbose",
     "test:durable:interrupt": "NODE_ENV=test jest ./tests/durable/interrupt/index.test.ts --detectOpenHandles --forceExit --verbose",
     "test:durable:loopactivity": "NODE_ENV=test jest ./tests/durable/loopactivity/index.test.ts --detectOpenHandles --forceExit --verbose",
@@ -41,6 +41,7 @@
     "test:durable:signal": "NODE_ENV=test jest ./tests/durable/signal/index.test.ts --detectOpenHandles --forceExit --verbose",
     "test:durable:unknown": "NODE_ENV=test jest ./tests/durable/unknown/index.test.ts --detectOpenHandles --forceExit --verbose",
     "test:emit": "NODE_ENV=test jest ./tests/functional/emit/index.test.ts --detectOpenHandles --forceExit --verbose",
+    "test:expired": "NODE_ENV=test jest ./tests/functional/expired/index.test.ts --detectOpenHandles --forceExit --verbose",
     "test:functional": "NODE_ENV=test jest ./tests/functional/*/index.test.ts --detectOpenHandles --forceExit --verbose",
     "test:hmsh": "NODE_ENV=test jest ./tests/functional/index.test.ts --detectOpenHandles --verbose",
     "test:hook": "NODE_ENV=test jest ./tests/functional/hook/index.test.ts --detectOpenHandles --forceExit --verbose",

package/types/durable.ts

@@ -200,7 +200,8 @@ export type WorkflowSearchSchema = Record<
      * literal value to use for the indexed field name (without including the standard underscore (_) prefix isolate)
      */
     fieldName?: string;
-  }>;
+  }
+>;
 
 type WorkflowSearchOptions = {
   /** FT index name (myapp:myindex) */
@@ -312,6 +313,18 @@ type WorkflowOptions = {
    * default is true; if false, will not await the execution
    */
   await?: boolean;
+
+  /**
+   * If provided, the job will initialize in an expired state, reserving
+   * only the job ID (HSETNX) and persisting search and marker (if provided).
+   * If a `resume` signal is sent before the specified number of seconds,
+   * the job will resume as normal, transition to the adjacent children
+   * of the trigger. If the job is not resumed within the number
+   * of seconds specified, the job will be scrubbed. No dependencies
+   * are added for a job in an expired state; however, dependencies
+   * will be added after the job is resumed if relevant.
+   */
+  expired?: number;
 };
 
 /**

package/types/hotmesh.ts

@@ -11,7 +11,7 @@ import { LogLevel } from './logger';
  */
 enum KeyType {
   APP = 'APP',
-  ENGINE_ID = 'ENGINE',
+  THROTTLE_RATE = 'THROTTLE_RATE',
   HOOKS = 'HOOKS',
   JOB_DEPENDENTS = 'JOB_DEPENDENTS',
   JOB_STATE = 'JOB_STATE',

package/types/job.ts

@@ -106,6 +106,18 @@ type ExtensionType = {
    * the initial data set.
    */
   marker?: StringStringType;
+
+  /**
+   * If provided, the job will initialize in an expired state, reserving
+   * only the job ID (HSETNX) and persisting search and marker (if provided).
+   * If a `resume` signal is sent before the specified number of seconds,
+   * the job will resume as normal, transition the the adjacent children
+   * of the trigger. If the job is not resumed within the
+   * number of seconds specified, the job will be scrubbed. No dependencies
+   * are added for a job in an expired state; however, dependencies will be
+   * added after the job is resumed if relevant.
+   */
+  expired?: number;
 };
 
 /**

package/types/quorum.ts

@@ -34,11 +34,9 @@ export type ThrottleOptions = {
   topic?: string;
   /** entity/noun */
   entity?: string;
-  /** in milliseconds; default is 0 */
+  /** in milliseconds; set to -1 for indefinite throttle */
   throttle: number;
-  /** namespace
-   * @default 'durable'
-   */
+  /** namespace */
   namespace?: string;
 };
 

package/types/redis.ts

@@ -74,6 +74,7 @@ interface RedisRedisMultiType {
   XLEN(key: string): this;
   DEL(key: string): this;
   EXISTS(key: string): this;
+  EXPIRE(key: string, seconds: number): this;
   HDEL(key: string, itemId: string): this;
   HGET(key: string, itemId: string): this;
   HGETALL(key: string): this;
@@ -303,6 +304,8 @@ interface IORedisMultiType {
     id: string,
     ...args: string[]
   ): this;
+  del(key: string): this;
+  expire(key: string, seconds: number): this;
   hdel(key: string, itemId: string): this;
   hget(key: string, itemId: string): this;
   hgetall(key: string): this;

package/types/stream.ts

@@ -130,6 +130,8 @@ export type StreamConfig = {
   guid: string;
   /** Role associated with the stream */
   role: StreamRole;
+  /** Default throttle (read from KeyType.THROTTLE_RATE) */
+  throttle: number;
   /** Optional topic for the stream */
   topic?: string;
   /** Delay before a message can be reclaimed, defaults to 60,000 milliseconds */