@hotmeshio/hotmesh 0.0.12 → 0.0.13

package/services/durable/factory.ts

@@ -1,27 +1,19 @@
 /**
- * 1) `maxSystemRetries` | can be 0 to 3 and represents milliseconds;
- * if there is an error, the workflow will retry up to `maxSystemRetries` times
- * delaying by 10, 100, and 1000ms; this is a system level retry
- * and is not configurable. It exists to handle intermittent network
- * errors. (NOTE: each retry spawns a new transition stream)
- * 
- * 2) `backoffExponent` | can be any number and represents `seconds` when applied;
- * retries will happen indefinitely and adhere to the
- * exponential backoff algorithm by multiplying by `backoffExponent`.
- * For example, if `backoffExponent` is 10, the workflow will retry
- * in 10s, 100s, 1000s, 10000s, etc.
- *
- * EXAMPLE | Using `maxSystemRetries = 3` and `backoffExponent = 10`, errant
- * workflows will be retried on the following schedule (8 times in 27 hours):
- * => 10ms, 100ms, 1000ms, 10s, 100s, 1_000s, 10_000s, 100_000s
+ * NOTE: Using `maxSystemRetries = 3` and `backoffCoefficient = 10`, errant
+ *       workflows will be retried on the following schedule (8 times in 27 hours):
+ *       => 10ms, 100ms, 1000ms, 10s, 100s, 1_000s, 10_000s, 100_000s
  */
-const getWorkflowYAML = (topic: string, version = '1', maxSystemRetries = 2, backoffExponent = 10) => {
+
+//todo: getChildWorkflowYAML (includes key, so flow will cleanup)
+//todo: if an activity throws an error, it should self-clean its index
+
+const getWorkflowYAML = (app: string, version: string) => {
   return `app:
-  id: ${topic}
+  id: ${app}
   version: '${version}'
   graphs:
-    - subscribes: ${topic}
-      publishes: ${topic}
+    - subscribes: ${app}.execute
+      publishes: ${app}.executed
       expire: 120
       input:
         schema:
@@ -31,18 +23,27 @@ const getWorkflowYAML = (topic: string, version = '1', maxSystemRetries = 2, bac
               type: string
             arguments:
               type: array
+            workflowTopic:
+              type: string
+            backoffCoefficient:
+              type: number
       output:
         schema:
           type: object
           properties:
             response:
               type: any
+            done:
+              type: boolean
 
       activities:
         t1:
           type: trigger
           stats:
             id: '{$self.input.data.workflowId}'
+          job:
+            maps:
+              done: false
 
         a1:
           type: activity
@@ -54,13 +55,13 @@ const getWorkflowYAML = (topic: string, version = '1', maxSystemRetries = 2, bac
                 duration:
                   type: number
             maps:
-              duration: ${backoffExponent}
+              duration: '{t1.output.data.backoffCoefficient}'
 
         w1:
           type: worker
-          topic: ${topic}
+          topic: '{t1.output.data.workflowTopic}'
           retry:
-            '599': [${maxSystemRetries}]
+            '599': [2]
           input:
             schema:
               type: object
@@ -78,16 +79,152 @@ const getWorkflowYAML = (topic: string, version = '1', maxSystemRetries = 2, bac
               properties:
                 response:
                   type: any
+            594:
+              schema:
+                type: object
+                properties:
+                  index:
+                    type: number
+                    description: the index of the first signal in the array
+                  signals:
+                    type: array
+                    description: remaining signal ids
+                    items:
+                      type: object
+                      properties:
+                        signal:
+                          type: string
+                        index:
+                          type: number
+              maps:
+                index: '{$self.output.data.index}'
+                signals: '{$self.output.data.signals}'
+            595:
+              schema:
+                type: object
+                properties:
+                  duration:
+                    type: number
+                    description: sleep duration in seconds
+                  index:
+                    type: number
+                    description: the current index
+              maps:
+                duration: '{$self.output.data.duration}'
+                index: '{$self.output.data.index}'
           job:
             maps:
               response: '{$self.output.data.response}'
+              done: '{$self.output.data.done}'
 
-        a599:
+        a594:
+          title: Wait for signals
+          type: await
+          topic: ${app}.wfsc.execute
+          input:
+            schema:
+              type: object
+              properties:
+                index:
+                  type: number
+                signals:
+                  type: array
+                  description: signal ids
+                  items:
+                    type: object
+                    properties:
+                      signal:
+                        type: string
+                      index:
+                        type: number
+                parentWorkflowId:
+                  type: string
+                cycleWorkflowId:
+                  type: string
+                baseWorkflowId:
+                  type: string
+                  description: index will be appended later
+            maps:
+              signals: '{w1.output.data.signals}'
+              parentWorkflowId:
+                '@pipe':
+                  - ['{$job.metadata.jid}', '-w']
+                  - ['{@string.concat}']
+              cycleWorkflowId:
+                '@pipe':
+                  - ['{$job.metadata.jid}', '-$wfc-', '{w1.output.data.index}']
+                  - ['{@string.concat}']
+              baseWorkflowId:
+                '@pipe':
+                  - ['{$job.metadata.jid}', '-$wfs-']
+                  - ['{@string.concat}']
+          output:
+            schema:
+              type: object
+              properties:
+                done:
+                  type: boolean
+            maps:
+              done: '{w1.output.data.done}'
+
+        c594:
+          title: Goto Activity a1
+          type: cycle
+          ancestor: a1
+          input:
+            maps:
+              duration: '{a1.output.data.duration}'
+
+        a595:
           title: Sleep before trying again
+          type: await
+          topic: ${app}.sleep.execute
+          input:
+            schema:
+              type: object
+              properties:
+                duration:
+                  type: number
+                index:
+                  type: number
+                workflowId:
+                  type: string
+                parentWorkflowId:
+                  type: string
+            maps:
+              duration: '{w1.output.data.duration}'
+              index: '{w1.output.data.index}'
+              parentWorkflowId:
+                '@pipe':
+                  - ['{$job.metadata.jid}', '-s']
+                  - ['{@string.concat}']
+              workflowId:
+                '@pipe':
+                  - ['{$job.metadata.jid}', '-$sleep-', '{w1.output.data.index}']
+                  - ['{@string.concat}']
+          output:
+            schema:
+              type: object
+              properties:
+                done:
+                  type: boolean
+            maps:
+              done: '{w1.output.data.done}'
+
+        c595:
+          title: Goto Activity a1
+          type: cycle
+          ancestor: a1
+          input:
+            maps:
+              duration: '{a1.output.data.duration}'
+
+        a599:
+          title: Sleep exponentially longer before retrying
           type: activity
-          sleep: "{a1.output.data.duration}"
+          sleep: '{a1.output.data.duration}'
 
-        c1:
+        c599:
           title: Goto Activity a1
           type: cycle
           ancestor: a1
@@ -95,39 +232,174 @@ const getWorkflowYAML = (topic: string, version = '1', maxSystemRetries = 2, bac
             maps:
               duration:
                 '@pipe':
-                  - ['{a1.output.data.duration}', ${backoffExponent}]
+                  - ['{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 sleep 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
+    
       transitions:
         t1:
           - to: a1
         a1:
           - to: w1
         w1:
+          - to: a594
+            conditions:
+              code: 594
+          - to: a595
+            conditions:
+              code: 595
           - to: a599
             conditions:
               code: 599
+          - to: s1
+            conditions:
+              code: [200, 598, 597, 596]
+          - to: s2
+            conditions:
+              code: [200, 598, 597, 596]
+          - to: s3
+            conditions:
+              code: [200, 598, 597, 596]
+        a594:
+          - to: c594
+            conditions:
+              code: 202
+
+        a595:
+          - to: c595
+            conditions:
+              code: 202
         a599:
-        - to: c1
-`;
-}
+          - to: c599
+
+    - subscribes: ${app}.activity.execute
+      publishes: ${app}.activity.executed
+
+      expire: 120
 
-const getActivityYAML = (topic: string, version = '1') => {
-  return `app:
-  id: ${topic}
-  version: '${version}'
-  graphs:
-    - subscribes: ${topic}
       input:
         schema:
           type: object
           properties:
+            parentWorkflowId:
+              type: string
             workflowId:
               type: string
             workflowTopic:
               type: string
             activityName:
-              type: array
+              type: string
             arguments:
               type: array
       output:
@@ -136,32 +408,44 @@ const getActivityYAML = (topic: string, version = '1') => {
           properties:
             response:
               type: any
+            done:
+              type: boolean
 
       activities:
-        t1:
+        t1a:
           type: trigger
           stats:
             id: '{$self.input.data.workflowId}'
-        a1:
+            key: '{$self.input.data.parentWorkflowId}'
+            granularity: infinity
+            measures:
+              - measure: index
+                target: '{$self.input.data.parentWorkflowId}'
+
+        w1a:
           type: worker
-          topic: ${topic}
+          topic: '{t1a.output.data.workflowTopic}'
+          emit: true
           input:
             schema:
               type: object
               properties:
+                parentWorkflowId:
+                  type: string
                 workflowId:
                   type: string
                 workflowTopic:
                   type: string
                 activityName:
-                  type: array
+                  type: string
                 arguments:
                   type: array
             maps:
-              workflowId: '{t1.output.data.workflowId}'
-              workflowTopic: '{t1.output.data.workflowTopic}'
-              activityName: '{t1.output.data.activityName}'
-              arguments: '{t1.output.data.arguments}'
+              parentWorkflowId: '{t1a.output.data.parentWorkflowId}'
+              workflowId: '{t1a.output.data.workflowId}'
+              workflowTopic: '{t1a.output.data.workflowTopic}'
+              activityName: '{t1a.output.data.activityName}'
+              arguments: '{t1a.output.data.arguments}'
           output:
             schema:
               type: object
@@ -171,12 +455,402 @@ const getActivityYAML = (topic: string, version = '1') => {
           job:
             maps:
               response: '{$self.output.data.response}'
+              done: true
+
+        s1a:
+          type: activity
+          title: Wait for cleanup signal
+          hook:
+            type: object
+            properties:
+              done:
+                type: boolean
+          job:
+            maps:
+              workflowId: '{t1a.output.data.workflowId}'
+
       transitions:
-        t1:
-          - to: a1`;
-}
+        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
+
+      input:
+        schema:
+          type: object
+          properties:
+            parentWorkflowId:
+              type: string
+            workflowId:
+              type: string
+            duration:
+              type: number
+              description: in seconds
+            index:
+              type: number
+      output:
+        schema:
+          type: object
+          properties:
+            done:
+              type: boolean
+            duration:
+              type: number
+            index:
+              type: number
+
+      activities:
+        t1s:
+          type: trigger
+          stats:
+            id: '{$self.input.data.workflowId}'
+            key: '{$self.input.data.parentWorkflowId}'
+            granularity: infinity
+            measures:
+              - measure: index
+                target: '{$self.input.data.parentWorkflowId}'
+
+        a1s:
+          type: activity
+          title: Sleep for a duration
+          sleep: '{t1s.output.data.duration}'
+          emit: true
+
+        a2s:
+          type: activity
+          title: Wait for cleanup signal
+          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
+
+      input:
+        schema:
+          type: object
+          properties:
+            index:
+              type: number
+            signals:
+              type: array
+              description: signal ids
+              items:
+                type: object
+                properties:
+                  signal:
+                    type: string
+                  index:
+                    type: number
+            parentWorkflowId:
+              type: string
+            cycleWorkflowId:
+              type: string
+            baseWorkflowId:
+              type: string
+              description: index will be appended later
+      output:
+        schema:
+          type: object
+          properties:
+            done:
+              type: boolean
+
+      activities:
+        t1wc:
+          title: Cycler workflow that creates signal workflows
+          type: trigger
+          stats:
+            id: '{$self.input.data.cycleWorkflowId}'
+
+        a1wc:
+          title: Split signal data
+          type: activity
+          cycle: true
+          output:
+            schema:
+              type: object
+              properties:
+                targetLength:
+                  type: number
+                targetSignal:
+                  type: object
+                  properties:
+                    signal:
+                      type: string
+                    index:
+                      type: number
+                signals:
+                  type: array
+                  items:
+                    type: object
+                    properties:
+                      signal:
+                        type: string
+                      index:
+                        type: number
+            maps:
+              targetLength:
+                '@pipe':
+                  - ['{t1wc.output.data.signals}']
+                  - ['{@array.length}']        
+              targetSignal:
+                '@pipe':
+                  - ['{t1wc.output.data.signals}', 0]
+                  - ['{@array.get}']
+              signals:
+                '@pipe':
+                  - ['{t1wc.output.data.signals}', 1]
+                  - ['{@array.slice}']
+        a2wc:
+          type: activity
+          output:
+            schema:
+              type: object
+              properties:
+                targetLength:
+                  type: number
+            maps:
+              targetLength: '{a1wc.output.data.targetLength}'
+ 
+        c1wc:
+          title: Goto Activity a1wc
+          type: cycle
+          ancestor: a1wc
+          input:
+            maps:
+              targetLength:
+                '@pipe':
+                  - ['{a1wc.output.data.signals}']
+                  - ['{@array.length}']
+              targetSignal:
+                '@pipe':
+                  - ['{a1wc.output.data.signals}', 0]
+                  - ['{@array.get}']
+              signals:
+                '@pipe':
+                  - ['{a1wc.output.data.signals}', 1]
+                  - ['{@array.slice}']
+
+        a3wc:
+          title: Call WFS workflow
+          type: await
+          topic: ${app}.wfs.execute
+          emit: true
+          input:
+            schema:
+              type: object
+              properties:
+                parentWorkflowId:
+                  type: string
+                  description: used to forge the cleanup key
+                signalId:
+                  type: string
+                  description: used to forge the custom hookid
+                workflowId:
+                  type: string
+                  description: the baseId + index
+            maps:
+              parentWorkflowId: '{t1wc.output.data.parentWorkflowId}'
+              signalId: '{a1wc.output.data.targetSignal.signal}'
+              workflowId:
+                '@pipe':
+                  - ['{t1wc.output.data.baseWorkflowId}', '{a1wc.output.data.targetSignal.index}']
+                  - ['{@string.concat}']
+          output:
+            schema:
+              type: object
+              properties:
+                done:
+                  type: boolean
+            maps:
+              done: '{w1.output.data.done}'
+    
+      transitions:
+        t1wc:
+          - to: a1wc
+        a1wc:
+          - to: a2wc
+        a2wc:
+          - to: c1wc
+            conditions:
+              match:
+                - expected: true
+                  actual:
+                    '@pipe':
+                      - ['{a1wc.output.data.targetLength}', 0]
+                      - ['{@conditional.greater_than}']
+          - to: a3wc
+            conditions:
+              match:
+                - expected: true
+                  actual:
+                    '@pipe':
+                      - ['{a1wc.output.data.targetLength}', 0]
+                      - ['{@conditional.greater_than}']
+
+    - subscribes: ${app}.wfs.execute
+      publishes: ${app}.wfs.executed
+
+      expire: 120
+
+      input:
+        schema:
+          type: object
+          properties:
+            parentWorkflowId:
+              type: string
+              description: used to forge the cleanup key
+            workflowId:
+              type: string
+              description: used to forge the cleanup hookid
+            signalId:
+              type: string
+              description: used to forge the custom hookid
+      output:
+        schema:
+          type: object
+          properties:
+            done:
+              type: boolean
+            workflowId:
+              type: string
+            signalData:
+              type: object
+
+      activities:
+        t1ww:
+          type: trigger
+          stats:
+            id: '{$self.input.data.workflowId}'
+            key: '{$self.input.data.parentWorkflowId}'
+            granularity: infinity
+            measures:
+              - measure: index
+                target: '{$self.input.data.parentWorkflowId}'
+
+        a1ww:
+          type: activity
+          title: Wait for custom signal
+          emit: true
+          hook:
+            type: object
+            properties:
+              signalData:
+                type: object
+          job:
+            maps:
+              signalData: '{$self.hook.data}'
+              workflowId: '{t1ww.output.data.workflowId}'
+              signalId: '{t1ww.output.data.signalId}'
+
+        a2ww:
+          type: activity
+          title: Wait for cleanup signal
+          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:
+          - to: a1ww
+            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}'
+                
+`;
+};
+
+const APP_VERSION = '1';
+const APP_ID = 'durable';
+const ACTIVITY_SUBSCRIBES_TOPIC = 'durable.activity.execute';
+const ACTIVITY_PUBLISHES_TOPIC = 'durable.activity.executed';
+const SLEEP_SUBSCRIBES_TOPIC = 'durable.sleep.execute';
+const SLEEP_PUBLISHES_TOPIC = 'durable.sleep.executed';
+const WFS_SUBSCRIBES_TOPIC = 'durable.wfs.execute';
+const WFS_PUBLISHES_TOPIC = 'durable.wfs.executed';
+const WFSC_SUBSCRIBES_TOPIC = 'durable.wfsc.execute';
+const WFSC_PUBLISHES_TOPIC = 'durable.wfsc.executed';
+const SUBSCRIBES_TOPIC = 'durable.execute';
+const PUBLISHES_TOPIC = 'durable.executed';
+const HOOK_ID = 'durable.awaken';
+const ACTIVITY_HOOK_ID = 'durable.activity.awaken';
+const SLEEP_HOOK_ID = 'durable.sleep.awaken';
+const WFS_HOOK_ID = 'durable.wfs.awaken';
+const DEFAULT_COEFFICIENT = 10;
 
 export {
-  getActivityYAML,
-  getWorkflowYAML
+  getWorkflowYAML,
+  APP_VERSION,
+  APP_ID,
+  ACTIVITY_SUBSCRIBES_TOPIC,
+  ACTIVITY_PUBLISHES_TOPIC,
+  SLEEP_SUBSCRIBES_TOPIC,
+  SLEEP_PUBLISHES_TOPIC,
+  SUBSCRIBES_TOPIC,
+  PUBLISHES_TOPIC,
+  HOOK_ID,
+  ACTIVITY_HOOK_ID,
+  SLEEP_HOOK_ID,
+  DEFAULT_COEFFICIENT,
+  WFS_SUBSCRIBES_TOPIC,
+  WFS_PUBLISHES_TOPIC,
+  WFSC_SUBSCRIBES_TOPIC,
+  WFSC_PUBLISHES_TOPIC,
+  WFS_HOOK_ID,
 };