@hotmeshio/hotmesh 0.1.9 → 0.1.11

package/build/modules/errors.d.ts

@@ -27,6 +27,7 @@ declare class DurableProxyError extends Error {
     maximumInterval: number;
     originJobId: string | null;
     parentWorkflowId: string;
+    expire: number;
     workflowDimension: string;
     workflowId: string;
     workflowTopic: string;
@@ -37,6 +38,8 @@ declare class DurableChildError extends Error {
     arguments: string[];
     backoffCoefficient: number;
     code: number;
+    expire: number;
+    signalIn: boolean;
     workflowDimension: string;
     index: number;
     maximumAttempts: number;

package/build/modules/errors.js

@@ -33,6 +33,7 @@ class DurableProxyError extends Error {
         this.workflowId = params.workflowId;
         this.workflowTopic = params.workflowTopic;
         this.parentWorkflowId = params.parentWorkflowId;
+        this.expire = params.expire;
         this.originJobId = params.originJobId;
         this.index = params.index;
         this.activityName = params.activityName;
@@ -51,6 +52,8 @@ class DurableChildError extends Error {
         this.workflowId = params.workflowId;
         this.workflowTopic = params.workflowTopic;
         this.parentWorkflowId = params.parentWorkflowId;
+        this.expire = params.expire;
+        this.signalIn = params.signalIn;
         this.originJobId = params.originJobId;
         this.index = params.index;
         this.workflowDimension = params.workflowDimension;

package/build/package.json

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

package/build/services/activities/activity.d.ts

@@ -26,6 +26,12 @@ declare class Activity {
     adjacentIndex: number;
     constructor(config: ActivityType, data: ActivityData, metadata: ActivityMetadata, hook: ActivityData | null, engine: EngineService, context?: JobState);
     setLeg(leg: ActivityLeg): void;
+    /**
+     * A job is assumed to be complete when its status (a semaphore)
+     * reaches `0`. A different threshold can be set in the
+     * activity YAML, in support of Dynamic Activation Control.
+     */
+    mapStatusThreshold(): number;
     /**
      * Upon entering leg 1 of a duplexed activity
      */
@@ -55,7 +61,7 @@ declare class Activity {
     bindJobError(data: Record<string, unknown>): void;
     getTriggerConfig(): Promise<ActivityType>;
     getJobStatus(): null | number;
-    setStatus(amount: number, multi?: RedisMulti): Promise<void>;
+    setStatus(amount: number, multi?: RedisMulti): Promise<void | any>;
     authorizeEntry(state: StringAnyType): string[];
     bindDimensionalAddress(state: StringAnyType): void;
     setState(multi?: RedisMulti): Promise<string>;

package/build/services/activities/activity.js

@@ -30,13 +30,44 @@ class Activity {
     setLeg(leg) {
         this.leg = leg;
     }
+    /**
+     * A job is assumed to be complete when its status (a semaphore)
+     * reaches `0`. A different threshold can be set in the
+     * activity YAML, in support of Dynamic Activation Control.
+     */
+    mapStatusThreshold() {
+        if (this.config.statusThreshold !== undefined) {
+            const threshold = pipe_1.Pipe.resolve(this.config.statusThreshold, this.context);
+            if (threshold !== undefined && !isNaN(Number(threshold))) {
+                return threshold;
+            }
+        }
+        return 0;
+    }
     /**
      * Upon entering leg 1 of a duplexed activity
      */
     async verifyEntry() {
         this.setLeg(1);
         await this.getState();
-        collator_1.CollatorService.assertJobActive(this.context.metadata.js, this.context.metadata.jid, this.metadata.aid);
+        const threshold = this.mapStatusThreshold();
+        try {
+            collator_1.CollatorService.assertJobActive(this.context.metadata.js, this.context.metadata.jid, this.metadata.aid, threshold);
+        }
+        catch (error) {
+            if (threshold > 0) {
+                if (this.context.metadata.js === threshold) {
+                    //conclude job EXACTLY ONCE
+                    const status = await this.setStatus(-threshold);
+                    if (Number(status) === 0) {
+                        await this.engine.runJobCompletionTasks(this.context);
+                    }
+                }
+            }
+            else {
+                throw error;
+            }
+        }
         await collator_1.CollatorService.notarizeEntry(this);
     }
     /**
@@ -247,7 +278,7 @@ class Activity {
     }
     async setStatus(amount, multi) {
         const { id: appId } = await this.engine.getVID();
-        await this.store.setStatus(amount, this.context.metadata.jid, appId, multi);
+        return await this.store.setStatus(amount, this.context.metadata.jid, appId, multi);
     }
     authorizeEntry(state) {
         //pre-authorize activity state to allow entry for adjacent activities

package/build/services/collator/index.d.ts

@@ -9,7 +9,7 @@ declare class CollatorService {
     /**
      * Upon re/entry, verify that the job status is active
      */
-    static assertJobActive(status: number, jobId: string, activityId: string): void;
+    static assertJobActive(status: number, jobId: string, activityId: string, threshold?: number): void;
     /**
      * returns the dimensional address (dad) for the target; due
      * to the nature of the notary system, the dad for leg 2 entry

package/build/services/collator/index.js

@@ -7,8 +7,8 @@ class CollatorService {
     /**
      * Upon re/entry, verify that the job status is active
      */
-    static assertJobActive(status, jobId, activityId) {
-        if (status <= 0) {
+    static assertJobActive(status, jobId, activityId, threshold = 0) {
+        if (status <= threshold) {
             throw new errors_1.InactiveJobError(jobId, status, activityId);
         }
     }

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

@@ -7,7 +7,7 @@ export declare class ClientService {
     static topics: string[];
     static instances: Map<string, HotMesh | Promise<HotMesh>>;
     constructor(config: ClientConfig);
-    getHotMeshClient: (workflowTopic: string, namespace?: string) => Promise<HotMesh>;
+    getHotMeshClient: (workflowTopic: string | null, namespace?: string) => Promise<HotMesh>;
     /**
      * Creates a stream (Redis `XGROUP.CREATE`) where events can be published (XADD).
      * It is possible that the worker that will read from this stream channel
@@ -38,6 +38,11 @@ export declare class ClientService {
         getHandle: (taskQueue: string, workflowName: string, workflowId: string, namespace?: string) => Promise<WorkflowHandleService>;
         search: (taskQueue: string, workflowName: string, namespace: null | string, index: string, ...query: string[]) => Promise<string[]>;
     };
+    /**
+     * Any point of presence can be used to deploy and activate the HotMesh
+     * distributed executable to the active quorum.
+     */
+    deployAndActivate(namespace?: string, version?: string): Promise<void>;
     verifyWorkflowActive(hotMesh: HotMesh, appId?: string, count?: number): Promise<boolean>;
     activateWorkflow(hotMesh: HotMesh, appId?: string, version?: string): Promise<void>;
     static shutdown(): Promise<void>;

package/build/services/durable/client.js

@@ -78,6 +78,7 @@ class ClientService {
                     arguments: [...options.args],
                     originJobId: options.originJobId,
                     expire: options.expire ?? enums_1.HMSH_EXPIRE_JOB_SECONDS,
+                    signalIn: options.signalIn,
                     parentWorkflowId: options.parentWorkflowId,
                     workflowId: options.workflowId || hotmesh_1.HotMeshService.guid(),
                     workflowTopic: workflowTopic,
@@ -150,6 +151,17 @@ class ClientService {
         };
         this.connection = config.connection;
     }
+    /**
+     * Any point of presence can be used to deploy and activate the HotMesh
+     * distributed executable to the active quorum.
+     */
+    async deployAndActivate(namespace = factory_1.APP_ID, version = factory_1.APP_VERSION) {
+        if (isNaN(Number(version))) {
+            throw new Error('Invalid version number');
+        }
+        const hotMesh = await this.getHotMeshClient('', namespace);
+        await this.activateWorkflow(hotMesh, namespace, version);
+    }
     async verifyWorkflowActive(hotMesh, appId = factory_1.APP_ID, count = 0) {
         const app = await hotMesh.engine.store.getApp(appId);
         const appVersion = app?.version;
@@ -165,24 +177,24 @@ class ClientService {
     async activateWorkflow(hotMesh, appId = factory_1.APP_ID, version = factory_1.APP_VERSION) {
         const app = await hotMesh.engine.store.getApp(appId);
         const appVersion = app?.version;
-        if (isNaN(appVersion)) {
+        if (appVersion === version && !app.active) {
             try {
-                await hotMesh.deploy((0, factory_1.getWorkflowYAML)(appId, version));
                 await hotMesh.activate(version);
             }
             catch (error) {
-                hotMesh.engine.logger.error('durable-client-deploy-activate-err', {
-                    ...error,
-                });
+                hotMesh.engine.logger.error('durable-client-activate-err', { error });
                 throw error;
             }
         }
-        else if (app && !app.active) {
+        else if (isNaN(Number(appVersion)) || appVersion <= version) {
             try {
+                await hotMesh.deploy((0, factory_1.getWorkflowYAML)(appId, version));
                 await hotMesh.activate(version);
             }
             catch (error) {
-                hotMesh.engine.logger.error('durable-client-activate-err', { error });
+                hotMesh.engine.logger.error('durable-client-deploy-activate-err', {
+                    ...error,
+                });
                 throw error;
             }
         }

package/build/services/durable/schemas/factory.d.ts

@@ -21,7 +21,7 @@
  * * Service Meshes
  * * Master Data Management systems
  */
-declare const APP_VERSION = "1";
+declare const APP_VERSION = "2";
 declare const APP_ID = "durable";
 /**
  * returns a new durable workflow schema

package/build/services/durable/schemas/factory.js

@@ -24,7 +24,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.APP_ID = exports.APP_VERSION = exports.getWorkflowYAML = void 0;
-const APP_VERSION = '1';
+const APP_VERSION = '2';
 exports.APP_VERSION = APP_VERSION;
 const APP_ID = 'durable';
 exports.APP_ID = APP_ID;
@@ -81,6 +81,9 @@ const getWorkflowYAML = (app, version) => {
             expire:
               description: the time in seconds to expire the workflow in Redis once it completes
               type: number
+            signalIn:
+              description: if false, the job will not support subordinated hooks
+              type: boolean
 
       output:
         schema:
@@ -232,6 +235,10 @@ const getWorkflowYAML = (app, version) => {
                     type: number
                   maximumInterval:
                     type: number
+                  expire:
+                    type: number
+                  signalIn:
+                    type: boolean
                   await:
                     type: string
                     description: when set to false, do not await the child flow's completion
@@ -335,6 +342,8 @@ const getWorkflowYAML = (app, version) => {
                   type: number
                 expire:
                   type: number
+                signalIn:
+                  type: boolean
                 parentWorkflowId:
                   type: string
                   description: used to forge the cleanup key
@@ -355,6 +364,8 @@ const getWorkflowYAML = (app, version) => {
               index: '{worker.output.data.index}'
               originJobId: '{worker.output.data.originJobId}'
               parentWorkflowId: '{worker.output.data.parentWorkflowId}'
+              expire: '{worker.output.data.expire}'
+              signalIn: '{worker.output.data.signalIn}'
               workflowId: '{worker.output.data.workflowId}'
               workflowName: '{worker.output.data.workflowName}'
               workflowTopic: '{worker.output.data.workflowTopic}'
@@ -512,6 +523,8 @@ const getWorkflowYAML = (app, version) => {
                   description: the arguments to pass to the activity
                   items:
                     type: string
+                expire:
+                  type: number
                 backoffCoefficient:
                   type: number
                 maximumAttempts:
@@ -527,6 +540,7 @@ const getWorkflowYAML = (app, version) => {
               parentWorkflowId: '{worker.output.data.workflowId}'
               workflowId: '{worker.output.data.workflowId}'
               workflowTopic: '{worker.output.data.workflowTopic}'
+              expire: '{worker.output.data.expire}'
               backoffCoefficient:
                 '@pipe':
                   - ['{worker.output.data.backoffCoefficient}','{trigger.output.data.backoffCoefficient}']
@@ -754,6 +768,17 @@ const getWorkflowYAML = (app, version) => {
                     - ['{trigger.output.data.maximumInterval}', 120]
                     - ['{@logical.or}']
                   - ['{@math.min}']
+        ender:
+          title: Sets job data; ignores the \`Signal In\` Hook Channel which was suppressed
+          type: hook
+          job:
+            maps:
+              done: true
+              $error: '{worker.output.data.$error}'
+              jc: '{$job.metadata.jc}'
+              ju:
+                '@pipe':
+                  - ['{@date.toISOXString}']
 
         closer:
           title: Closes the \`Signal In\` Hook Channel, so the workflow can exit
@@ -806,6 +831,7 @@ const getWorkflowYAML = (app, version) => {
         signaler:
           title: Signal-In Reentry point for subordinated hook flows
           type: hook
+          statusThreshold: 1
           hook:
             type: object
             properties:
@@ -938,6 +964,11 @@ const getWorkflowYAML = (app, version) => {
                   maximumInterval:
                     type: number
                     description: the maximum time in seconds to wait between retries; provides a fixed limit to exponential backoff growth
+                  expire:
+                    type: number
+                  signalIn:
+                    type: boolean
+                    description: if false, the spawned child will not support subordinated hooks
                   await:
                     type: string
                     description: when set to false, do not await the child flow's completion
@@ -965,6 +996,8 @@ const getWorkflowYAML = (app, version) => {
                     type: string
                   originJobId:
                     type: string
+                  expire:
+                    type: number
                   backoffCoefficient:
                     type: number
                   maximumAttempts:
@@ -1038,6 +1071,8 @@ const getWorkflowYAML = (app, version) => {
                   type: number
                 expire:
                   type: number
+                signalIn:
+                  type: boolean
                 parentWorkflowId:
                   type: string
                   description: used to forge the cleanup key
@@ -1058,6 +1093,8 @@ const getWorkflowYAML = (app, version) => {
               index: '{signaler_worker.output.data.index}'
               originJobId: '{signaler_worker.output.data.originJobId}'
               parentWorkflowId: '{signaler_worker.output.data.parentWorkflowId}'
+              expire: '{signaler_worker.output.data.expire}'
+              signalIn: '{signaler_worker.output.data.signalIn}'
               workflowId: '{signaler_worker.output.data.workflowId}'
               workflowName: '{signaler_worker.output.data.workflowName}'
               workflowTopic: '{signaler_worker.output.data.workflowTopic}'
@@ -1215,6 +1252,8 @@ const getWorkflowYAML = (app, version) => {
                   description: the arguments to pass to the activity
                   items:
                     type: string
+                expire:
+                  type: number
                 backoffCoefficient:
                   type: number
                 maximumAttempts:
@@ -1230,6 +1269,7 @@ const getWorkflowYAML = (app, version) => {
               parentWorkflowId: '{signaler_worker.output.data.workflowId}'
               workflowId: '{signaler_worker.output.data.workflowId}'
               workflowTopic: '{signaler_worker.output.data.workflowTopic}'
+              expire: '{signaler_worker.output.data.expire}'
               backoffCoefficient:
                 '@pipe':
                   - ['{signaler_worker.output.data.backoffCoefficient}','{trigger.output.data.backoffCoefficient}']
@@ -1462,15 +1502,37 @@ const getWorkflowYAML = (app, version) => {
         trigger:
           - to: cycle_hook
           - to: signaler
+            conditions:
+              match:
+                - expected: true
+                  actual: 
+                    '@pipe':
+                      - ['{$self.output.data.signalIn}', true]
+                      - ['{@conditional.nullish}']
         ## MAIN PROCESS TRANSITIONS ##
         cycle_hook:
           - to: throttler
         throttler:
           - to: worker
         worker:
+          - to: ender
+            conditions:
+              code: [200, 596, 597, 598]
+              match:
+                - expected: false
+                  actual: 
+                    '@pipe':
+                      - ['{trigger.output.data.signalIn}', true]
+                      - ['{@conditional.nullish}']
           - to: closer
             conditions:
               code: [200, 596, 597, 598]
+              match:
+                - expected: true
+                  actual: 
+                    '@pipe':
+                      - ['{trigger.output.data.signalIn}', true]
+                      - ['{@conditional.nullish}']
           - to: sleeper
             conditions:
               code: 588

package/build/services/durable/worker.js

@@ -310,6 +310,7 @@ class WorkerService {
                             index: err.index,
                             originJobId: err.originJobId,
                             parentWorkflowId: err.parentWorkflowId,
+                            expire: err.expire,
                             workflowId: err.workflowId,
                             workflowTopic: err.workflowTopic,
                             activityName: err.activityName,
@@ -342,6 +343,8 @@ class WorkerService {
                             maximumInterval: err.maximumInterval || (0, ms_1.default)(enums_1.HMSH_DURABLE_MAX_INTERVAL) / 1000,
                             originJobId: err.originJobId,
                             parentWorkflowId: err.parentWorkflowId,
+                            expire: err.expire,
+                            signalIn: err.signalIn,
                             workflowDimension: err.workflowDimension,
                             workflowId: err.workflowId,
                             workflowTopic: err.workflowTopic,

package/build/services/durable/workflow.js

@@ -190,6 +190,8 @@ class WorkflowService {
             maximumInterval: (0, ms_1.default)(options?.config?.maximumInterval ?? enums_1.HMSH_DURABLE_MAX_INTERVAL) /
                 1000,
             originJobId: originJobId ?? workflowId,
+            expire: options.expire,
+            signalIn: options.signalIn,
             parentWorkflowId,
             workflowDimension: workflowDimension,
             workflowId: childJobId,
@@ -303,6 +305,7 @@ class WorkflowService {
             workflowId: activityJobId,
             workflowTopic: activityTopic,
             activityName,
+            expire: options.expire,
             backoffCoefficient: options?.retryPolicy?.backoffCoefficient ?? undefined,
             maximumAttempts: options?.retryPolicy?.maximumAttempts ?? undefined,
             maximumInterval: maximumInterval ?? undefined,

package/build/services/pipe/functions/conditional.d.ts

@@ -2,6 +2,8 @@ declare class ConditionalHandler {
     ternary(condition: boolean, valueIfTrue: any, valueIfFalse: any): any;
     equality(value1: any, value2: any): boolean;
     strict_equality(value1: any, value2: any): boolean;
+    inequality(value1: any, value2: any): boolean;
+    strict_inequality(value1: any, value2: any): boolean;
     greater_than(value1: number, value2: number): boolean;
     less_than(value1: number, value2: number): boolean;
     greater_than_or_equal(value1: number, value2: number): boolean;

package/build/services/pipe/functions/conditional.js

@@ -11,6 +11,12 @@ class ConditionalHandler {
     strict_equality(value1, value2) {
         return value1 === value2;
     }
+    inequality(value1, value2) {
+        return value1 != value2;
+    }
+    strict_inequality(value1, value2) {
+        return value1 !== value2;
+    }
     greater_than(value1, value2) {
         return value1 > value2;
     }

package/build/types/activity.d.ts

@@ -6,6 +6,8 @@ interface BaseActivity {
     title?: string;
     type?: ActivityExecutionType;
     subtype?: string;
+    statusThreshold?: number;
+    statusThresholdType?: 'stop' | 'throw' | 'stall';
     input?: Record<string, any>;
     output?: Record<string, any>;
     settings?: Record<string, any>;

package/build/types/durable.d.ts

@@ -260,6 +260,10 @@ type WorkflowOptions = {
      * sets the number of seconds a workflow may exist after completion. As the process engine is an in-memory cache, the default policy is to expire and scrub the job hash as soon as it completes.
      */
     expire?: number;
+    /**
+     * default is true; set to false to optimize workflows that do not require a `signal in`
+     */
+    signalIn?: boolean;
     /**
      * default is true; if false, will not await the execution
      */
@@ -422,6 +426,8 @@ type ProxyType<ACT> = {
  * Configuration settings for activities within a workflow.
  */
 type ActivityConfig = {
+    /** place holder setting; unused at this time (re: activity workflow expire configuration) */
+    expire?: number;
     /** Start to close timeout for the activity; not yet implemented */
     startToCloseTimeout?: string;
     /** Configuration for specific activities, type not yet specified */

package/build/types/error.d.ts

@@ -3,6 +3,8 @@ export type DurableChildErrorType = {
     await?: boolean;
     backoffCoefficient?: number;
     index: number;
+    expire?: number;
+    signalIn?: boolean;
     maximumAttempts?: number;
     maximumInterval?: number;
     originJobId: string | null;
@@ -26,6 +28,7 @@ export type DurableProxyErrorType = {
     activityName: string;
     backoffCoefficient?: number;
     index: number;
+    expire?: number;
     maximumAttempts?: number;
     maximumInterval?: number;
     originJobId: string | null;

package/package.json

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

package/types/activity.ts

@@ -18,6 +18,8 @@ interface BaseActivity {
   title?: string;
   type?: ActivityExecutionType;
   subtype?: string;
+  statusThreshold?: number; //default is 0; set to 1 to ensure not last standing; message will be ignored as if too late to process
+  statusThresholdType?: 'stop' | 'throw' | 'stall'; //default is stop; must explicitly set to throw to throw an error or stall to stall
   input?: Record<string, any>;
   output?: Record<string, any>;
   settings?: Record<string, any>;

package/types/durable.ts

@@ -314,6 +314,11 @@ type WorkflowOptions = {
    */
   expire?: number;
 
+  /**
+   * default is true; set to false to optimize workflows that do not require a `signal in`
+   */
+  signalIn?: boolean;
+
   /**
    * default is true; if false, will not await the execution
    */
@@ -516,6 +521,9 @@ type ProxyType<ACT> = {
  * Configuration settings for activities within a workflow.
  */
 type ActivityConfig = {
+  /** place holder setting; unused at this time (re: activity workflow expire configuration) */
+  expire?: number;
+
   /** Start to close timeout for the activity; not yet implemented */
   startToCloseTimeout?: string;
 

package/types/error.ts

@@ -3,6 +3,8 @@ export type DurableChildErrorType = {
   await?: boolean;
   backoffCoefficient?: number;
   index: number;
+  expire?: number;
+  signalIn?: boolean;
   maximumAttempts?: number;
   maximumInterval?: number;
   originJobId: string | null;
@@ -28,6 +30,7 @@ export type DurableProxyErrorType = {
   activityName: string;
   backoffCoefficient?: number;
   index: number;
+  expire?: number;
   maximumAttempts?: number;
   maximumInterval?: number;
   originJobId: string | null;