@hotmeshio/hotmesh 0.0.33 → 0.0.35

package/build/services/durable/factory.js

@@ -21,13 +21,19 @@ const getWorkflowYAML = (app, version) => {
   graphs:
     - subscribes: ${app}.execute
       publishes: ${app}.executed
-      expire: 120
+      expire:
+        '@pipe':
+          - ['{t1.output.data.originJobId}', 0, '{t1.output.data.expire}']
+          - ['{@conditional.ternary}']
+
       input:
         schema:
           type: object
           properties:
             parentWorkflowId:
               type: string
+            originJobId:
+              type: string
             workflowId:
               type: string
             arguments:
@@ -36,6 +42,8 @@ const getWorkflowYAML = (app, version) => {
               type: string
             backoffCoefficient:
               type: number
+            expire:
+              type: number
       output:
         schema:
           type: object
@@ -52,10 +60,7 @@ const getWorkflowYAML = (app, version) => {
           stats:
             id: '{$self.input.data.workflowId}'
             key: '{$self.input.data.parentWorkflowId}'
-            granularity: infinity
-            measures:
-              - measure: index
-                target: '{$self.input.data.parentWorkflowId}'
+            parent: '{$self.input.data.originJobId}'
           job:
             maps:
               done: false
@@ -86,10 +91,13 @@ const getWorkflowYAML = (app, version) => {
               properties:
                 workflowId:
                   type: string
+                originJobId:
+                  type: string
                 arguments:
                   type: array
             maps:
               workflowId: '{t1.output.data.workflowId}'
+              originJobId: '{t1.output.data.originJobId}'
               arguments: '{t1.output.data.arguments}'
           output:
             schema:
@@ -149,18 +157,6 @@ const getWorkflowYAML = (app, version) => {
               response: '{$self.output.data.response}'
               done: '{$self.output.data.done}'
 
-        a2:
-          title: Wait for cleanup signal
-          type: hook
-          hook:
-            type: object
-            properties:
-              done:
-                type: boolean
-          job:
-            maps:
-              workflowId: '{t1.output.data.workflowId}'
-
         sig:
           title: Signal In - Receive signals
           type: hook
@@ -202,12 +198,15 @@ const getWorkflowYAML = (app, version) => {
               properties:
                 workflowId:
                   type: string
+                originJobId:
+                  type: string
                 workflowDimension:
                   type: string
                 arguments:
                   type: array
             maps:
               workflowId: '{t1.output.data.workflowId}'
+              originJobId: '{t1.output.data.originJobId}'
               workflowDimension: '{sig.output.metadata.dad}'
               arguments: '{sig.hook.data.arguments}'
           output:
@@ -259,7 +258,7 @@ const getWorkflowYAML = (app, version) => {
               maps:
                 duration: '{$self.output.data.duration}'
                 index: '{$self.output.data.index}'
-  
+
         siga594:
           title: Signal In - Wait for signals
           type: await
@@ -282,6 +281,8 @@ const getWorkflowYAML = (app, version) => {
                         type: number
                 parentWorkflowId:
                   type: string
+                originJobId:
+                  type: string
                 cycleWorkflowId:
                   type: string
                 baseWorkflowId:
@@ -293,6 +294,10 @@ const getWorkflowYAML = (app, version) => {
                 '@pipe':
                   - ['{$job.metadata.jid}', '-w']
                   - ['{@string.concat}']
+              originJobId:
+                '@pipe':
+                  - ['{t1.output.data.originJobId}', '{t1.output.data.originJobId}', '{$job.metadata.jid}']
+                  - ['{@conditional.ternary}']
               cycleWorkflowId:
                 '@pipe':
                   - ['-', '{$job.metadata.jid}', '-$wfc', '{sig.output.metadata.dad}', '-', '{sigw1.output.data.index}']
@@ -334,6 +339,8 @@ const getWorkflowYAML = (app, version) => {
                   type: string
                 parentWorkflowId:
                   type: string
+                originJobId:
+                  type: string
             maps:
               duration: '{sigw1.output.data.duration}'
               index: '{sigw1.output.data.index}'
@@ -341,6 +348,11 @@ const getWorkflowYAML = (app, version) => {
                 '@pipe':
                   - ['{$job.metadata.jid}', '-s']
                   - ['{@string.concat}']
+              originJobId:
+                '@pipe':
+                  - ['{t1.output.data.originJobId}', '{t1.output.data.originJobId}', '{$job.metadata.jid}']
+                  - ['{@conditional.ternary}']
+
               workflowId:
                 '@pipe':
                   - ['-', '{$job.metadata.jid}', '-$sleep', '{sig.output.metadata.dad}', '-', '{sigw1.output.data.index}']
@@ -413,6 +425,8 @@ const getWorkflowYAML = (app, version) => {
                         type: number
                 parentWorkflowId:
                   type: string
+                originJobId:
+                  type: string
                 cycleWorkflowId:
                   type: string
                 baseWorkflowId:
@@ -424,6 +438,10 @@ const getWorkflowYAML = (app, version) => {
                 '@pipe':
                   - ['{$job.metadata.jid}', '-w']
                   - ['{@string.concat}']
+              originJobId:
+                '@pipe':
+                  - ['{t1.output.data.originJobId}', '{t1.output.data.originJobId}', '{$job.metadata.jid}']
+                  - ['{@conditional.ternary}']
               cycleWorkflowId:
                 '@pipe':
                   - ['-', '{$job.metadata.jid}', '-$wfc-', '{w1.output.data.index}']
@@ -465,6 +483,8 @@ const getWorkflowYAML = (app, version) => {
                   type: string
                 parentWorkflowId:
                   type: string
+                originJobId:
+                  type: string
             maps:
               duration: '{w1.output.data.duration}'
               index: '{w1.output.data.index}'
@@ -472,6 +492,10 @@ const getWorkflowYAML = (app, version) => {
                 '@pipe':
                   - ['{$job.metadata.jid}', '-s']
                   - ['{@string.concat}']
+              originJobId:
+                '@pipe':
+                  - ['{t1.output.data.originJobId}', '{t1.output.data.originJobId}', '{$job.metadata.jid}']
+                  - ['{@conditional.ternary}']
               workflowId:
                 '@pipe':
                   - ['-', '{$job.metadata.jid}', '-$sleep-', '{w1.output.data.index}']
@@ -522,154 +546,6 @@ const getWorkflowYAML = (app, version) => {
                   - ['{a1.output.data.duration}', '{t1.output.data.backoffCoefficient}']
                   - ['{@math.multiply}']
 
-        s1:
-          title: Awaken activity flows so they end and self-clean
-          type: signal
-          subtype: all
-          key_name: parentWorkflowId
-          key_value:
-            '@pipe':
-              - ['{$job.metadata.jid}', '-a']
-              - ['{@string.concat}']
-          topic: ${app}.activity.awaken
-          resolver:
-            schema:
-              type: object
-              properties:
-                data:
-                  type: object
-                  properties:
-                    parentWorkflowId:
-                      type: string
-                scrub:
-                  type: boolean
-            maps:
-              data:
-                parentWorkflowId:
-                  '@pipe':
-                    - ['{$job.metadata.jid}', '-a']
-                    - ['{@string.concat}']
-
-              scrub: true
-          signal:
-            schema:
-              type: object
-              properties:
-                done:
-                  type: boolean
-            maps:
-              done: true
-
-        s2:
-          title: Awaken sleeping flows so they end and self-clean
-          type: signal
-          subtype: all
-          key_name: parentWorkflowId
-          key_value:
-            '@pipe':
-              - ['{$job.metadata.jid}', '-s']
-              - ['{@string.concat}']
-          topic: ${app}.sleep.awaken
-          resolver:
-            schema:
-              type: object
-              properties:
-                data:
-                  type: object
-                  properties:
-                    parentWorkflowId:
-                      type: string
-                scrub:
-                  type: boolean
-            maps:
-              data:
-                parentWorkflowId:
-                  '@pipe':
-                    - ['{$job.metadata.jid}', '-s']
-                    - ['{@string.concat}']
-              scrub: true
-          signal:
-            schema:
-              type: object
-              properties:
-                done:
-                  type: boolean
-            maps:
-              done: true
-
-        s3:
-          title: Awaken WFS flows so they end and self-clean
-          type: signal
-          subtype: all
-          key_name: parentWorkflowId
-          key_value:
-            '@pipe':
-              - ['{$job.metadata.jid}', '-w']
-              - ['{@string.concat}']
-          topic: ${app}.wfs.awaken
-          resolver:
-            schema:
-              type: object
-              properties:
-                data:
-                  type: object
-                  properties:
-                    parentWorkflowId:
-                      type: string
-                scrub:
-                  type: boolean
-            maps:
-              data:
-                parentWorkflowId:
-                  '@pipe':
-                    - ['{$job.metadata.jid}', '-w']
-                    - ['{@string.concat}']
-              scrub: true
-          signal:
-            schema:
-              type: object
-              properties:
-                done:
-                  type: boolean
-            maps:
-              done: true
-
-        s4:
-          title: Awaken child flows so they end and self-clean
-          type: signal
-          subtype: all
-          key_name: parentWorkflowId
-          key_value:
-            '@pipe':
-              - ['{$job.metadata.jid}', '-f']
-              - ['{@string.concat}']
-          topic: ${app}.childflow.awaken
-          resolver:
-            schema:
-              type: object
-              properties:
-                data:
-                  type: object
-                  properties:
-                    parentWorkflowId:
-                      type: string
-                scrub:
-                  type: boolean
-            maps:
-              data:
-                parentWorkflowId:
-                  '@pipe':
-                    - ['{$job.metadata.jid}', '-f']
-                    - ['{@string.concat}']
-              scrub: true
-          signal:
-            schema:
-              type: object
-              properties:
-                done:
-                  type: boolean
-            maps:
-              done: true
         s5:
           title: Close Signal In Channel
           type: signal
@@ -687,14 +563,6 @@ const getWorkflowYAML = (app, version) => {
       transitions:
         t1:
           - to: a1
-          - to: a2
-            conditions:
-              match:
-                - expected: true
-                  actual:
-                    '@pipe':
-                      - ['{$job.metadata.key}', true, false]
-                      - ['{@conditional.ternary}']
           - to: sig
         sig:
           - to: siga1
@@ -717,12 +585,8 @@ const getWorkflowYAML = (app, version) => {
               code: 599
         siga594:
           - to: sigc594
-            conditions:
-              code: 202
         siga595:
           - to: sigc595
-            conditions:
-              code: 202
         siga592:
           - to: sigc592
         siga599:
@@ -742,42 +606,19 @@ const getWorkflowYAML = (app, version) => {
           - to: a599
             conditions:
               code: 599
-          - to: s3
-            conditions:
-              code: [200, 598, 597, 596]
-          - to: s1
-            conditions:
-              code: [200, 598, 597, 596]
-          - to: s2
-            conditions:
-              code: [200, 598, 597, 596]
-          - to: s4
-            conditions:
-              code: [200, 598, 597, 596]
           - to: s5
             conditions:
               code: [200, 598, 597, 596]
         a594:
           - to: c594
-            conditions:
-              code: 202
         a595:
           - to: c595
-            conditions:
-              code: 202
         a592:
           - to: c592
         a599:
           - to: c599
 
       hooks:
-        ${app}.childflow.awaken:
-          - to: a2
-            conditions:
-              match:
-                - expected: '{t1.output.data.workflowId}'
-                  actual: '{$self.hook.data.id}'
-
         ${app}.flow.signal:
           - to: sig
             conditions:
@@ -788,7 +629,7 @@ const getWorkflowYAML = (app, version) => {
     - subscribes: ${app}.activity.execute
       publishes: ${app}.activity.executed
 
-      expire: 120
+      expire: 0
 
       input:
         schema:
@@ -796,6 +637,8 @@ const getWorkflowYAML = (app, version) => {
           properties:
             parentWorkflowId:
               type: string
+            originJobId:
+              type: string
             workflowId:
               type: string
             workflowTopic:
@@ -820,16 +663,12 @@ const getWorkflowYAML = (app, version) => {
           stats:
             id: '{$self.input.data.workflowId}'
             key: '{$self.input.data.parentWorkflowId}'
-            granularity: infinity
-            measures:
-              - measure: index
-                target: '{$self.input.data.parentWorkflowId}'
+            parent: '{$self.input.data.originJobId}'
 
         w1a:
           title: Activity Worker - Calls Activity Functions
           type: worker
           topic: '{t1a.output.data.workflowTopic}'
-          emit: true
           input:
             schema:
               type: object
@@ -861,36 +700,14 @@ const getWorkflowYAML = (app, version) => {
               response: '{$self.output.data.response}'
               done: true
 
-        s1a:
-          title: Awaken activity flows so they end and self-clean
-          type: hook
-          hook:
-            type: object
-            properties:
-              done:
-                type: boolean
-          job:
-            maps:
-              workflowId: '{t1a.output.data.workflowId}'
-
       transitions:
         t1a:
           - to: w1a
-        w1a:
-          - to: s1a
-
-      hooks:
-        ${app}.activity.awaken:
-          - to: s1a
-            conditions:
-              match:
-                - expected: '{t1a.output.data.workflowId}'
-                  actual: '{$self.hook.data.id}'
 
     - subscribes: ${app}.sleep.execute
       publishes: ${app}.sleep.executed
 
-      expire: 120
+      expire: 0
 
       input:
         schema:
@@ -898,6 +715,8 @@ const getWorkflowYAML = (app, version) => {
           properties:
             parentWorkflowId:
               type: string
+            originJobId:
+              type: string
             workflowId:
               type: string
             duration:
@@ -923,50 +742,27 @@ const getWorkflowYAML = (app, version) => {
           stats:
             id: '{$self.input.data.workflowId}'
             key: '{$self.input.data.parentWorkflowId}'
-            granularity: infinity
-            measures:
-              - measure: index
-                target: '{$self.input.data.parentWorkflowId}'
+            parent: '{$self.input.data.originJobId}'
 
         a1s:
           title: Sleep for a duration
           type: hook
           sleep: '{t1s.output.data.duration}'
-          emit: true
-
-        a2s:
-          title: Awaken sleep flows so they end and self-clean
-          type: hook
-          hook:
-            type: object
-            properties:
-              done:
-                type: boolean
           job:
             maps:
               done: true
               duration: '{t1s.output.data.duration}'
               index: '{t1s.output.data.index}'
               workflowId: '{t1s.output.data.workflowId}'
-  
+
       transitions:
         t1s:
           - to: a1s
-        a1s:
-          - to: a2s
-
-      hooks:
-        ${app}.sleep.awaken:
-          - to: a2s
-            conditions:
-              match:
-                - expected: '{t1s.output.data.workflowId}'
-                  actual: '{$self.hook.data.id}'
 
     - subscribes: ${app}.wfsc.execute
       publishes: ${app}.wfsc.executed
 
-      expire: 120
+      expire: 0
 
       input:
         schema:
@@ -986,6 +782,8 @@ const getWorkflowYAML = (app, version) => {
                     type: number
             parentWorkflowId:
               type: string
+            originJobId:
+              type: string
             cycleWorkflowId:
               type: string
             baseWorkflowId:
@@ -1004,6 +802,7 @@ const getWorkflowYAML = (app, version) => {
           type: trigger
           stats:
             id: '{$self.input.data.cycleWorkflowId}'
+            parent: '{$self.input.data.originJobId}'
 
         a1wc:
           title: Pivot - All Cycling Descendants Point Here
@@ -1079,7 +878,6 @@ const getWorkflowYAML = (app, version) => {
           title: Call WFS workflow
           type: await
           topic: ${app}.wfs.execute
-          emit: true
           input:
             schema:
               type: object
@@ -1087,6 +885,9 @@ const getWorkflowYAML = (app, version) => {
                 parentWorkflowId:
                   type: string
                   description: used to forge the cleanup key
+                originJobId:
+                  type: string
+                  description: used for dependency cleanup
                 signalId:
                   type: string
                   description: used to forge the custom hookid
@@ -1095,6 +896,7 @@ const getWorkflowYAML = (app, version) => {
                   description: the baseId + index
             maps:
               parentWorkflowId: '{t1wc.output.data.parentWorkflowId}'
+              originJobId: '{t1wc.output.data.originJobId}'
               signalId: '{a1wc.output.data.targetSignal.signal}'
               workflowId:
                 '@pipe':
@@ -1135,7 +937,7 @@ const getWorkflowYAML = (app, version) => {
     - subscribes: ${app}.wfs.execute
       publishes: ${app}.wfs.executed
 
-      expire: 120
+      expire: 0
 
       input:
         schema:
@@ -1144,6 +946,9 @@ const getWorkflowYAML = (app, version) => {
             parentWorkflowId:
               type: string
               description: used to forge the cleanup key
+            originJobId:
+              type: string
+              description: used for dependency cleanup
             workflowId:
               type: string
               description: used to forge the cleanup hookid
@@ -1168,15 +973,11 @@ const getWorkflowYAML = (app, version) => {
           stats:
             id: '{$self.input.data.workflowId}'
             key: '{$self.input.data.parentWorkflowId}'
-            granularity: infinity
-            measures:
-              - measure: index
-                target: '{$self.input.data.parentWorkflowId}'
+            parent: '{$self.input.data.originJobId}'
 
         a1ww:
           title: WFS - signal entry point
           type: hook
-          emit: true
           hook:
             type: object
             properties:
@@ -1187,24 +988,11 @@ const getWorkflowYAML = (app, version) => {
               signalData: '{$self.hook.data}'
               workflowId: '{t1ww.output.data.workflowId}'
               signalId: '{t1ww.output.data.signalId}'
-
-        a2ww:
-          title: WFS - cleanup signal entry point
-          type: hook
-          hook:
-            type: object
-            properties:
-              done:
-                type: boolean
-          job:
-            maps:
               done: true
-              workflowId: '{t1ww.output.data.workflowId}'
 
       transitions:
         t1ww:
           - to: a1ww
-          - to: a2ww
 
       hooks:
         ${app}.wfs.signal:
@@ -1212,14 +1000,7 @@ const getWorkflowYAML = (app, version) => {
             conditions:
               match:
                 - expected: '{t1ww.output.data.signalId}'
-                  actual: '{$self.hook.data.id}'
-        ${app}.wfs.awaken:
-          - to: a2ww
-            conditions:
-              match:
-                - expected: '{t1ww.output.data.workflowId}'
-                  actual: '{$self.hook.data.id}'
-                
+                  actual: '{$self.hook.data.id}'       
 `;
 };
 exports.getWorkflowYAML = getWorkflowYAML;

package/build/services/durable/handle.d.ts

@@ -1,12 +1,49 @@
 import { HotMeshService as HotMesh } from '../hotmesh';
+import { JobInterruptOptions } from '../../types/job';
 export declare class WorkflowHandleService {
     hotMesh: HotMesh;
     workflowTopic: string;
     workflowId: string;
     constructor(hotMesh: HotMesh, workflowTopic: string, workflowId: string);
+    /**
+     * Sends a signal to the workflow. This is a way to send
+     * a message to a workflow that is paused due to having
+     * executed a `waitForSignal` workflow extension. Awakens
+     * the workflow if no other signals are pending.
+     */
     signal(signalId: string, data: Record<any, any>): Promise<void>;
+    /**
+     * Returns the job state of the workflow. If the workflow has completed
+     * this is also the job output. If the workflow is still running, this
+     * is the current state of the job, but it may change depending upon
+     * the activities that remain.
+     */
     state(metadata?: boolean): Promise<Record<string, any>>;
+    /**
+     * Returns the current search state of the workflow. This is
+     * different than the job state or individual activity state.
+     * Search state represents name/value pairs that were added
+     * to the workflow. As the workflow is stored in a Redis hash,
+     * this is a way to store additional data that is indexed
+     * and searchable using the RediSearch module.
+     */
     queryState(fields: string[]): Promise<Record<string, any>>;
+    /**
+     * Returns the current status of the workflow. This is a semaphore
+     * value that represents the current state of the workflow, where
+     * 0 is complete and a negative value represents that the flow was
+     * interrupted.
+     */
     status(): Promise<number>;
+    /**
+     * Interrupts a running workflow. Standard Job Completion tasks will
+     * run. Subscribers will be notified and the job hash will be expired.
+     */
+    interrupt(options?: JobInterruptOptions): Promise<string>;
+    /**
+     * Awaits for the workflow to complete and returns the result. If
+     * the workflow thows and error, this method will likewise throw
+     * an error.
+     */
     result(loadState?: boolean): Promise<any>;
 }