@hotmeshio/hotmesh 0.2.4 → 0.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hotmeshio/hotmesh",
-  "version": "0.2.4",
+  "version": "0.3.0",
   "description": "Unbreakable Workflows",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",

package/types/activity.ts

@@ -28,7 +28,9 @@ interface BaseActivity {
   telemetry?: Record<string, any>;
   emit?: boolean; //if true, the activity will emit a message to the `publishes` topic immediately before transitioning to adjacent activities
   sleep?: number; //@pipe /in seconds
-  expire?: number; //-1 forever; 0 persists the flow until the parent flow that expired it is dismissed; 15 seconds is the default
+  expire?: number; //-1 forever; 0 persists the flow until the parent flow that expired it is dismissed; 15 seconds is the default (copied from the YAML at compile time)
+  persistent?: boolean; //if true, the job will persist beyond completion (copied from the YAML at compile time)
+  persist?: boolean; //when true, the activity will emit the job completed event and start the `persistence countdown`, using the 'expire' value
   retry?: StreamRetryPolicy;
   cycle?: boolean; //if true, the `notary` will leave leg 2 open, so it can be re/cycled
   collationInt?: number; //compiler

package/types/error.ts

@@ -4,6 +4,7 @@ export type MeshFlowChildErrorType = {
   backoffCoefficient?: number;
   index: number;
   expire?: number;
+  persistent?: boolean;
   signalIn?: boolean;
   maximumAttempts?: number;
   maximumInterval?: number;

package/types/hook.ts

@@ -22,7 +22,12 @@ interface HookRules {
   [eventName: string]: HookRule[];
 }
 
-type HookSignal = { topic: string; resolved: string; jobId: string };
+type HookSignal = {
+  topic: string;
+  resolved: string;
+  jobId: string;
+  expire: number;
+};
 
 interface HookInterface {
   (topic: string, data: { [key: string]: any; id: string }): Promise<void>;

package/types/hotmesh.ts

@@ -88,17 +88,52 @@ type HotMeshConfig = {
 };
 
 type HotMeshGraph = {
+  /**
+   * the unique topic that the graph subscribes to, creating one
+   * job for each idempotent message that is received
+   */
   subscribes: string;
+  /**
+   * the unique topic that the graph publishes/emits to when the job completes
+   */
   publishes?: string;
+  /**
+   * the number of seconds that the completed job should be
+   * left in the store before it is deleted
+   */
   expire?: number;
+  /**
+   * if the graph is reentrant and has open activities, the
+   * `persistent` flag will emit the job completed  event.
+   * This allows the 'main' thread/trigger that started the job to
+   * signal to subscribers (or the parent) that the job
+   * is 'done', while still leaving the job in a
+   * state that allows for reentry (such as cyclical hooks).
+   */
+  persistent?: boolean;
+  /**
+   * the schema for the output of the graph
+   */
   output?: {
     schema: Record<string, any>;
   };
+  /**
+   * the schema for the input of the graph
+   */
   input?: {
     schema: Record<string, any>;
   };
+  /**
+   * the activities that define the graph
+   */
   activities: Record<string, any>;
+  /**
+   * the transitions that define how activities are connected
+   */
   transitions?: Record<string, any>;
+  /**
+   * the reentrant hook rules that define how to reenter a running graph
+   */
   hooks?: HookRules;
 };
 

package/types/job.ts

@@ -63,6 +63,7 @@ type JobMetadata = {
   /** GMT updated //job_updated */
   ju: string;
 
+  /** job status semaphore */
   js: JobStatus;
 
   /** activity_type */
@@ -82,6 +83,9 @@ type JobMetadata = {
 
   /** process data expire policy */
   expire?: number;
+
+  /** job persistence (beyond main thread completion) */
+  persistent?: boolean;
 };
 
 /**
@@ -122,20 +126,6 @@ type ExtensionType = {
    * will be added after the job is resumed if relevant.
    */
   pending?: number;
-
-  /**
-   * Workflows that apply a status threshold will be initialized
-   * with a status value of 1m - statusThreshold.
-   *
-   * The value provided should be the count of descendant activities
-   * (those that descend from the trigger) that should be allowed to
-   * remain open once 'done' event is emitted.
-   *
-   * If the job should not be removed from the cache, the `expire` field
-   * should be set to `0`.
-   *
-   */
-  statusThreshold?: number;
 };
 
 /**

package/types/meshdata.ts

@@ -63,10 +63,6 @@ export type CallOptions = {
 };
 
 export type ConnectOptions = {
-  /**
-   * if set to infinity, callers may not override (the function will be durable)
-   */
-  ttl?: string;
   /**
    * the task queue for the connected function for greater specificity
    */
@@ -265,8 +261,16 @@ export type MeshDataWorkflowOptions = {
   expire?: number;
 
   /**
-   * set to false to optimize workflows that do not require a `signal in`
+   * set to false to optimize workflows that do not require a `signal in`.
+   * explicitly set to true to force the workflow to remain open and persistent.
    * @default true
    */
   signalIn?: boolean;
+
+  /**
+   * set to `true` by the system when a workflow is started with a ttl, ensuring
+   * that the workflow will remain active until the ttl expires and the workflow
+   * is scrubbed. This is a system flag and should not be set by the user.
+   */
+  persistent?: boolean;
 };

package/types/meshflow.ts

@@ -113,6 +113,11 @@ type WorkflowContext = {
    * the HotMesh connection configuration (io/redis NPM package reference and login credentials)
    */
   connection: Connection;
+
+  /**
+   * if present, the workflow will delay expiration for the specified number of seconds
+   */
+  expire?: number;
 };
 
 /**
@@ -316,6 +321,11 @@ type WorkflowOptions = {
    */
   expire?: number;
 
+  /**
+   * system flag to indicate that the flow should remain open beyond main method completion while still emitting the 'job done' event
+   */
+  persistent?: boolean;
+
   /**
    * default is true; set to false to optimize workflows that do not require a `signal in`
    */
@@ -417,8 +427,9 @@ type WorkflowDataType = {
   workflowId: string;
   workflowTopic: string;
   workflowDimension?: string; //is present if hook (not main workflow)
-  originJobId?: string; //is present if there is an originating ancestor job (should rename to originJobId)
+  originJobId?: string; //is present if there is an originating ancestor job
   canRetry?: boolean;
+  expire?: number;
 };
 
 type ConnectionConfig = {