@hotmeshio/hotmesh 0.1.15 → 0.1.17

package/build/modules/utils.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.restoreHierarchy = exports.getValueByPath = exports.getIndexedHash = exports.getSymVal = exports.getSymKey = exports.formatISODate = exports.getTimeSeries = exports.getSubscriptionTopic = exports.findSubscriptionForTrigger = exports.findTopKey = exports.XSleepFor = exports.matchesStatus = exports.matchesStatusCode = exports.identifyRedisTypeFromClass = exports.polyfill = exports.identifyRedisType = exports.deterministicRandom = exports.guid = exports.deepCopy = exports.sleepImmediate = exports.sleepFor = exports.getSystemHealth = exports.hashOptions = void 0;
+exports.restoreHierarchy = exports.getValueByPath = exports.getIndexedHash = exports.getSymVal = exports.getSymKey = exports.formatISODate = exports.getTimeSeries = exports.getSubscriptionTopic = exports.findSubscriptionForTrigger = exports.findTopKey = exports.matchesStatus = exports.matchesStatusCode = exports.identifyRedisTypeFromClass = exports.polyfill = exports.identifyRedisType = exports.XSleepFor = exports.sleepImmediate = exports.sleepFor = exports.guid = exports.deterministicRandom = exports.deepCopy = exports.getSystemHealth = exports.hashOptions = void 0;
 const os_1 = __importDefault(require("os"));
 const crypto_1 = require("crypto");
 const nanoid_1 = require("nanoid");
@@ -26,18 +26,6 @@ async function getSystemHealth() {
     const totalMemory = os_1.default.totalmem();
     const freeMemory = os_1.default.freemem();
     const usedMemory = totalMemory - freeMemory;
-    //NOTE: enable the following if desired; for now, only
-    //      `memory` is emitted when system health is requested
-    //const cpus = os.cpus();
-    // CPU load calculation remains unchanged
-    // const cpuLoad = cpus.map((cpu, i) => {
-    //   const total = Object.values(cpu.times).reduce((acc, tv) => acc + tv, 0);
-    //   const idle = cpu.times.idle;
-    //   const usage = ((total - idle) / total) * 100;
-    //   return { [`CPU ${i} Usage`]: `${usage.toFixed(2)}%` };
-    // });
-    // Wrap each systeminformation call with safeExecute (systeminformation npm package)
-    //const networkStats = await safeExecute(si.networkStats(), []);
     const systemHealth = {
         TotalMemoryGB: `${(totalMemory / 1024 / 1024 / 1024).toFixed(2)} GB`,
         FreeMemoryGB: `${(freeMemory / 1024 / 1024 / 1024).toFixed(2)} GB`,
@@ -48,27 +36,35 @@ async function getSystemHealth() {
     return systemHealth;
 }
 exports.getSystemHealth = getSystemHealth;
-async function sleepFor(ms) {
-    return new Promise((resolve) => setTimeout(resolve, ms));
-}
-exports.sleepFor = sleepFor;
-function sleepImmediate() {
-    return new Promise((resolve) => setImmediate(resolve));
-}
-exports.sleepImmediate = sleepImmediate;
 function deepCopy(obj) {
     return JSON.parse(JSON.stringify(obj));
 }
 exports.deepCopy = deepCopy;
-function guid(size = enums_1.HMSH_GUID_SIZE) {
-    return `H` + (0, nanoid_1.nanoid)(size);
-}
-exports.guid = guid;
 function deterministicRandom(seed) {
     const x = Math.sin(seed) * 10000;
     return x - Math.floor(x);
 }
 exports.deterministicRandom = deterministicRandom;
+function guid(size = enums_1.HMSH_GUID_SIZE) {
+    return `H` + (0, nanoid_1.nanoid)(size);
+}
+exports.guid = guid;
+async function sleepFor(ms) {
+    return new Promise((resolve) => setTimeout(resolve, ms));
+}
+exports.sleepFor = sleepFor;
+function sleepImmediate() {
+    return new Promise((resolve) => setImmediate(resolve));
+}
+exports.sleepImmediate = sleepImmediate;
+function XSleepFor(ms) {
+    let timerId;
+    const promise = new Promise((resolve) => {
+        timerId = setTimeout(resolve, ms);
+    });
+    return { promise, timerId };
+}
+exports.XSleepFor = XSleepFor;
 function identifyRedisType(redisInstance) {
     const prototype = Object.getPrototypeOf(redisInstance);
     if ('defineCommand' in prototype ||
@@ -95,7 +91,6 @@ function identifyRedisType(redisInstance) {
     return null;
 }
 exports.identifyRedisType = identifyRedisType;
-//todo: the polyfill methods will all be deleted in the `beta` release.
 exports.polyfill = {
     resolveActivityType(activityType) {
         if (activityType === 'activity') {
@@ -117,7 +112,6 @@ function identifyRedisTypeFromClass(redisClass) {
 exports.identifyRedisTypeFromClass = identifyRedisTypeFromClass;
 function matchesStatusCode(code, pattern) {
     if (typeof pattern === 'string') {
-        // Convert '*' wildcard to its regex equivalent (\d)
         const regexPattern = `^${pattern.replace(/\*/g, '\\d')}$`;
         return new RegExp(regexPattern).test(code.toString());
     }
@@ -128,15 +122,6 @@ function matchesStatus(status, targetStatus) {
     return status === targetStatus;
 }
 exports.matchesStatus = matchesStatus;
-function XSleepFor(ms) {
-    //can be interrupted with `clearTimeout`
-    let timerId;
-    const promise = new Promise((resolve) => {
-        timerId = setTimeout(resolve, ms);
-    });
-    return { promise, timerId };
-}
-exports.XSleepFor = XSleepFor;
 function findTopKey(obj, input) {
     for (const [key, value] of Object.entries(obj)) {
         if (value.hasOwnProperty(input)) {
@@ -156,10 +141,6 @@ function findSubscriptionForTrigger(obj, value) {
     return null;
 }
 exports.findSubscriptionForTrigger = findSubscriptionForTrigger;
-/**
- * Get the subscription topic for the flow to which @activityId belongs.
- * TODO: resolve this value in the compiler...do not call this at runtime
- */
 async function getSubscriptionTopic(activityId, store, appVID) {
     const appTransitions = await store.getTransitions(appVID);
     const appSubscriptions = await store.getSubscriptions(appVID);
@@ -168,10 +149,6 @@ async function getSubscriptionTopic(activityId, store, appVID) {
     return topic;
 }
 exports.getSubscriptionTopic = getSubscriptionTopic;
-/**
- * returns the 12-digit format of the iso timestamp (e.g, 202101010000); returns
- * an empty string if overridden by the user to not segment by time (infinity).
- */
 function getTimeSeries(granularity) {
     if (granularity.toString() === 'infinity') {
         return '0';

package/build/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hotmeshio/hotmesh",
-    "version": "0.1.15",
+    "version": "0.1.16",
     "description": "Unbreakable Workflows",
     "main": "./build/index.js",
     "types": "./build/index.d.ts",
@@ -26,20 +26,20 @@
         "test:connect:ioredis": "NODE_ENV=test jest ./tests/unit/services/connector/clients/ioredis.test.ts --detectOpenHandles --forceExit --verbose",
         "test:connect:redis": "NODE_ENV=test jest ./tests/unit/services/connector/clients/redis.test.ts --detectOpenHandles --forceExit --verbose",
         "test:cycle": "NODE_ENV=test jest ./tests/functional/cycle/index.test.ts --detectOpenHandles --forceExit --verbose",
-        "test:durable": "NODE_ENV=test jest ./tests/durable/*/index.test.ts --detectOpenHandles --forceExit --verbose",
-        "test:durable:basic": "NODE_ENV=test jest ./tests/durable/basic/index.test.ts --detectOpenHandles --forceExit --verbose",
-        "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": "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",
-        "test:durable:nested": "NODE_ENV=test jest ./tests/durable/nested/index.test.ts --detectOpenHandles --forceExit --verbose",
-        "test:durable:retry": "NODE_ENV=test jest ./tests/durable/retry/index.test.ts --detectOpenHandles --forceExit --verbose",
-        "test:durable:sleep": "NODE_ENV=test jest ./tests/durable/sleep/index.test.ts --detectOpenHandles --forceExit --verbose",
-        "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:meshflow": "NODE_ENV=test jest ./tests/meshflow/*/index.test.ts --detectOpenHandles --forceExit --verbose",
+        "test:meshflow:basic": "NODE_ENV=test jest ./tests/meshflow/basic/index.test.ts --detectOpenHandles --forceExit --verbose",
+        "test:meshflow:collision": "NODE_ENV=test jest ./tests/meshflow/collision/index.test.ts --detectOpenHandles --forceExit --verbose",
+        "test:meshflow:fatal": "NODE_ENV=test jest ./tests/meshflow/fatal/index.test.ts --detectOpenHandles --forceExit --verbose",
+        "test:meshflow:goodbye": "NODE_ENV=test jest ./tests/meshflow/goodbye/index.test.ts --detectOpenHandles --forceExit --verbose",
+        "test:meshflow:hello": "HMSH_IS_CLUSTER=true NODE_ENV=test jest ./tests/meshflow/helloworld/index.test.ts --detectOpenHandles --forceExit --verbose",
+        "test:meshflow:hook": "NODE_ENV=test jest ./tests/meshflow/hook/index.test.ts --detectOpenHandles --forceExit --verbose",
+        "test:meshflow:interrupt": "NODE_ENV=test jest ./tests/meshflow/interrupt/index.test.ts --detectOpenHandles --forceExit --verbose",
+        "test:meshflow:loopactivity": "NODE_ENV=test jest ./tests/meshflow/loopactivity/index.test.ts --detectOpenHandles --forceExit --verbose",
+        "test:meshflow:nested": "NODE_ENV=test jest ./tests/meshflow/nested/index.test.ts --detectOpenHandles --forceExit --verbose",
+        "test:meshflow:retry": "NODE_ENV=test jest ./tests/meshflow/retry/index.test.ts --detectOpenHandles --forceExit --verbose",
+        "test:meshflow:sleep": "NODE_ENV=test jest ./tests/meshflow/sleep/index.test.ts --detectOpenHandles --forceExit --verbose",
+        "test:meshflow:signal": "NODE_ENV=test jest ./tests/meshflow/signal/index.test.ts --detectOpenHandles --forceExit --verbose",
+        "test:meshflow:unknown": "NODE_ENV=test jest ./tests/meshflow/unknown/index.test.ts --detectOpenHandles --forceExit --verbose",
         "test:emit": "NODE_ENV=test jest ./tests/functional/emit/index.test.ts --detectOpenHandles --forceExit --verbose",
         "test:pending": "NODE_ENV=test jest ./tests/functional/pending/index.test.ts --detectOpenHandles --forceExit --verbose",
         "test:functional": "NODE_ENV=test jest ./tests/functional/*/index.test.ts --detectOpenHandles --forceExit --verbose",
@@ -63,6 +63,8 @@
         "test:sub:ioredis": "NODE_ENV=test jest ./tests/functional/sub/clients/ioredis.test.ts --detectOpenHandles --forceExit --verbose",
         "test:sub:redis": "NODE_ENV=test jest ./tests/functional/sub/clients/redis.test.ts --detectOpenHandles --forceExit --verbose",
         "test:trigger": "NODE_ENV=test jest ./tests/unit/services/activities/trigger.test.ts --detectOpenHandles --forceExit --verbose",
+        "test:meshdata": "NODE_ENV=test HMSH_IS_CLUSTER=true jest ./tests/meshdata/index.test.ts --forceExit --verbose --detectOpenHandles",
+        "test:meshcall": "NODE_ENV=test HMSH_LOGLEVEL=debug jest ./tests/meshcall/index.test.ts --forceExit --verbose --detectOpenHandles",
         "test:unit": "NODE_ENV=test jest ./tests/unit/*/*/index.test.ts --detectOpenHandles --forceExit --verbose"
     },
     "keywords": [
@@ -102,6 +104,7 @@
         "ts-jest": "^29.0.5",
         "ts-node": "^10.9.1",
         "ts-node-dev": "^2.0.0",
+        "typedoc": "^0.26.4",
         "typescript": "^5.0.4"
     },
     "peerDependencies": {

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

@@ -7,9 +7,6 @@ import { JobState, JobStatus } from '../../types/job';
 import { MultiResponseFlags, RedisClient, RedisMulti } from '../../types/redis';
 import { StringAnyType } from '../../types/serializer';
 import { StreamCode, StreamData, StreamStatus } from '../../types/stream';
-/**
- * The base class for all activities
- */
 declare class Activity {
     config: ActivityType;
     data: ActivityData;
@@ -26,19 +23,8 @@ 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
-     */
     verifyEntry(): Promise<void>;
-    /**
-     * Upon entering leg 2 of a duplexed activity
-     */
     verifyReentry(): Promise<number>;
     processEvent(status?: StreamStatus, code?: StreamCode, type?: 'hook' | 'output'): Promise<void>;
     processPending(type: 'hook' | 'output'): Promise<MultiResponseFlags>;
@@ -50,14 +36,7 @@ declare class Activity {
     mapInputData(): void;
     mapOutputData(): void;
     registerTimeout(): Promise<void>;
-    /**
-     * Any StreamMessage with a status of ERROR is bound to the activity
-     */
     bindActivityError(data: Record<string, unknown>): void;
-    /**
-     * unhandled activity errors (activities that return an ERROR StreamMessage
-     * status and have no adjacent children to transition to) are bound to the job
-     */
     bindJobError(data: Record<string, unknown>): void;
     getTriggerConfig(): Promise<ActivityType>;
     getJobStatus(): null | number;
@@ -72,12 +51,6 @@ declare class Activity {
     bindJobMetadataPaths(): string[];
     bindActivityMetadataPaths(): string[];
     getState(): Promise<void>;
-    /**
-     * if the job is created/deleted/created with the same key,
-     * the 'gid' ensures no stale messages (such as sleep delays)
-     * enter the workstream. Any message with a mismatched gid
-     * belongs to a prior job and can safely be ignored/dropped.
-     */
     assertGenerationalId(jobGID: string, msgGID?: string): void;
     initDimensionalAddress(dad: string): void;
     initSelf(context: StringAnyType): JobState;
@@ -87,10 +60,6 @@ declare class Activity {
     resolveAdjacentDad(): string;
     filterAdjacent(): Promise<StreamData[]>;
     transition(adjacencyList: StreamData[], jobStatus: JobStatus): Promise<string[]>;
-    /**
-     * A job with a vale < -100_000_000 is considered interrupted,
-     * as the interruption event decrements the job status by 1billion.
-     */
     jobWasInterrupted(jobStatus: JobStatus): boolean;
 }
 export { Activity, ActivityType };

package/build/services/activities/activity.js

@@ -10,9 +10,6 @@ const pipe_1 = require("../pipe");
 const serializer_1 = require("../serializer");
 const telemetry_1 = require("../telemetry");
 const stream_1 = require("../../types/stream");
-/**
- * The base class for all activities
- */
 class Activity {
     constructor(config, data, metadata, hook, engine, context) {
         this.status = stream_1.StreamStatus.SUCCESS;
@@ -30,11 +27,6 @@ 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);
@@ -44,9 +36,6 @@ class Activity {
         }
         return 0;
     }
-    /**
-     * Upon entering leg 1 of a duplexed activity
-     */
     async verifyEntry() {
         this.setLeg(1);
         await this.getState();
@@ -57,7 +46,6 @@ class Activity {
         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);
@@ -70,9 +58,6 @@ class Activity {
         }
         await collator_1.CollatorService.notarizeEntry(this);
     }
-    /**
-     * Upon entering leg 2 of a duplexed activity
-     */
     async verifyReentry() {
         const guid = this.context.metadata.guid;
         this.setLeg(2);
@@ -80,7 +65,6 @@ class Activity {
         collator_1.CollatorService.assertJobActive(this.context.metadata.js, this.context.metadata.jid, this.metadata.aid);
         return await collator_1.CollatorService.notarizeReentry(this, guid);
     }
-    //********  DUPLEX RE-ENTRY POINT  ********//
     async processEvent(status = stream_1.StreamStatus.SUCCESS, code = 200, type = 'output') {
         this.setLeg(2);
         const jid = this.context.metadata.jid;
@@ -186,7 +170,6 @@ class Activity {
         telemetry.mapActivityAttributes();
         const jobStatus = this.resolveStatus(multiResponse);
         const attrs = { 'app.job.jss': jobStatus };
-        //adjacencyList membership has already been set at this point (according to activity status)
         const messageIds = await this.transition(this.adjacencyList, jobStatus);
         if (messageIds?.length) {
             attrs['app.activity.mids'] = messageIds.join(',');
@@ -209,10 +192,6 @@ class Activity {
             if (output) {
                 for (const key in output) {
                     const f1 = key.indexOf('[');
-                    //keys with array notation suffix `somekey[]` represent
-                    //dynamically-keyed mappings whose `value` must be moved to the output.
-                    //The `value` must be an object with keys appropriate to the
-                    //notation type: `somekey[0] (array)`, `somekey[-] (mark)`, OR `somekey[_] (search)`
                     if (f1 > -1) {
                         const amount = key.substring(f1 + 1).split(']')[0];
                         if (!isNaN(Number(amount))) {
@@ -239,7 +218,6 @@ class Activity {
         }
     }
     mapOutputData() {
-        //activity YAML may include output map data that produces/extends activity output data.
         if (this.config.output?.maps) {
             const mapper = new mapper_1.MapperService((0, utils_1.deepCopy)(this.config.output.maps), this.context);
             const actOutData = mapper.mapRules();
@@ -249,21 +227,12 @@ class Activity {
         }
     }
     async registerTimeout() {
-        //set timeout in support of hook and/or duplex
     }
-    /**
-     * Any StreamMessage with a status of ERROR is bound to the activity
-     */
     bindActivityError(data) {
         const md = this.context[this.metadata.aid].output.metadata;
         md.err = JSON.stringify(this.data);
-        //(temporary...useful for mapping error parts in the app.yaml)
         md.$error = { ...data, is_stream_error: true };
     }
-    /**
-     * unhandled activity errors (activities that return an ERROR StreamMessage
-     * status and have no adjacent children to transition to) are bound to the job
-     */
     bindJobError(data) {
         this.context.metadata.err = JSON.stringify({
             ...data,
@@ -281,7 +250,6 @@ class Activity {
         return await this.store.setStatus(amount, this.context.metadata.jid, appId, multi);
     }
     authorizeEntry(state) {
-        //pre-authorize activity state to allow entry for adjacent activities
         return (this.adjacencyList?.map((streamData) => {
             const { metadata: { aid }, } = streamData;
             state[`${aid}/output/metadata/as`] = collator_1.CollatorService.getSeed();
@@ -301,7 +269,6 @@ class Activity {
         const presets = this.authorizeEntry(state);
         this.bindDimensionalAddress(state);
         this.bindActivityState(state);
-        //symbolNames holds symkeys
         const symbolNames = [
             `$${this.config.subscribes}`,
             this.metadata.aid,
@@ -311,7 +278,6 @@ class Activity {
         return await this.store.setState(state, this.getJobStatus(), jobId, symbolNames, dIds, multi);
     }
     bindJobMetadata() {
-        //both legs of the most recently run activity (1 and 2) modify ju (job_updated)
         this.context.metadata.ju = (0, utils_1.formatISODate)(new Date());
     }
     bindActivityMetadata() {
@@ -398,7 +364,6 @@ class Activity {
         telemetry_1.TelemetryService.addTargetTelemetryPaths(consumes, this.config, this.metadata, this.leg);
         const { dad, jid } = this.context.metadata;
         const dIds = collator_1.CollatorService.getDimensionsById([...this.config.ancestors, this.metadata.aid], dad || '');
-        //`state` is a unidimensional hash; context is a tree
         const [state, _status] = await this.store.getState(jid, consumes, dIds);
         this.context = (0, utils_1.restoreHierarchy)(state);
         this.assertGenerationalId(this.context?.metadata?.gid, gid);
@@ -406,12 +371,6 @@ class Activity {
         this.initSelf(this.context);
         this.initPolicies(this.context);
     }
-    /**
-     * if the job is created/deleted/created with the same key,
-     * the 'gid' ensures no stale messages (such as sleep delays)
-     * enter the workstream. Any message with a mismatched gid
-     * belongs to a prior job and can safely be ignored/dropped.
-     */
     assertGenerationalId(jobGID, msgGID) {
         if (msgGID !== jobGID) {
             throw new errors_1.GenerationalError(jobGID, msgGID, this.context?.metadata?.jid ?? '', this.context?.metadata?.aid ?? '', this.context?.metadata?.dad ?? '');
@@ -438,10 +397,9 @@ class Activity {
         if (!self.output.metadata) {
             self.output.metadata = {};
         }
-        //prebind the updated timestamp (mappings need the time)
         self.output.metadata.au = (0, utils_1.formatISODate)(new Date());
         context['$self'] = self;
-        context['$job'] = context; //NEVER call STRINGIFY! (now circular)
+        context['$job'] = context;
         return context;
     }
     initPolicies(context) {
@@ -454,20 +412,17 @@ class Activity {
     resolveDad() {
         let dad = this.metadata.dad;
         if (this.adjacentIndex > 0) {
-            //if adjacent index > 0 the activity is cycling; replace last index with cycle index
             dad = `${dad.substring(0, dad.lastIndexOf(','))},${this.adjacentIndex}`;
         }
         return dad;
     }
     resolveAdjacentDad() {
-        //concat self and child dimension (all children (leg 1) begin life at 0)
         return `${this.resolveDad()}${collator_1.CollatorService.getDimensionalSeed(0)}`;
     }
     async filterAdjacent() {
         const adjacencyList = [];
         const transitions = await this.store.getTransitions(await this.engine.getVID());
         const transition = transitions[`.${this.metadata.aid}`];
-        //resolve the dimensional address for adjacent children
         const adjacentDad = this.resolveAdjacentDad();
         if (transition) {
             for (const toActivityId in transition) {
@@ -514,10 +469,6 @@ class Activity {
         }
         return mIds;
     }
-    /**
-     * A job with a vale < -100_000_000 is considered interrupted,
-     * as the interruption event decrements the job status by 1billion.
-     */
     jobWasInterrupted(jobStatus) {
         return jobStatus < -100000000;
     }

package/build/services/activities/await.js

@@ -12,7 +12,6 @@ class Await extends activity_1.Activity {
     constructor(config, data, metadata, hook, engine, context) {
         super(config, data, metadata, hook, engine, context);
     }
-    //********  INITIAL ENTRY POINT (A)  ********//
     async process() {
         this.logger.debug('await-process', {
             jid: this.context.metadata.jid,
@@ -25,15 +24,12 @@ class Await extends activity_1.Activity {
             telemetry = new telemetry_1.TelemetryService(this.engine.appId, this.config, this.metadata, this.context);
             telemetry.startActivitySpan(this.leg);
             this.mapInputData();
-            //save state and authorize reentry
             const multi = this.store.getMulti();
-            //todo: await this.registerTimeout();
             const messageId = await this.execActivity(multi);
             await collator_1.CollatorService.authorizeReentry(this, multi);
             await this.setState(multi);
             await this.setStatus(0, multi);
             const multiResponse = (await multi.exec());
-            //telemetry
             telemetry.mapActivityAttributes();
             const jobStatus = this.resolveStatus(multiResponse);
             telemetry.setActivityAttributes({

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

@@ -7,13 +7,6 @@ declare class Cycle extends Activity {
     config: CycleActivity;
     constructor(config: ActivityType, data: ActivityData, metadata: ActivityMetadata, hook: ActivityData | null, engine: EngineService, context?: JobState);
     process(): Promise<string>;
-    /**
-     * Trigger the target ancestor to execute in a cycle,
-     * without violating the constraints of the DAG. Immutable
-     * `individual activity state` will execute in a new dimensional
-     * thread while `shared job state` can change. This
-     * pattern allows for retries without violating the DAG.
-     */
     cycleAncestorActivity(multi: RedisMulti): Promise<string>;
 }
 export { Cycle };

package/build/services/activities/cycle.js

@@ -10,7 +10,6 @@ class Cycle extends activity_1.Activity {
     constructor(config, data, metadata, hook, engine, context) {
         super(config, data, metadata, hook, engine, context);
     }
-    //********  LEG 1 ENTRY  ********//
     async process() {
         this.logger.debug('cycle-process', {
             jid: this.context.metadata.jid,
@@ -23,21 +22,18 @@ class Cycle extends activity_1.Activity {
             telemetry = new telemetry_1.TelemetryService(this.engine.appId, this.config, this.metadata, this.context);
             telemetry.startActivitySpan(this.leg);
             this.mapInputData();
-            //set state/status
             let multi = this.store.getMulti();
             await this.setState(multi);
-            await this.setStatus(0, multi); //leg 1 never changes job status
+            await this.setStatus(0, multi);
             const multiResponse = (await multi.exec());
             telemetry.mapActivityAttributes();
             const jobStatus = this.resolveStatus(multiResponse);
-            //cycle the target ancestor
             multi = this.store.getMulti();
             const messageId = await this.cycleAncestorActivity(multi);
             telemetry.setActivityAttributes({
                 'app.activity.mid': messageId,
                 'app.job.jss': jobStatus,
             });
-            //exit early (`Cycle` activities only execute Leg 1)
             await collator_1.CollatorService.notarizeEarlyExit(this, multi);
             (await multi.exec());
             return this.context.metadata.aid;
@@ -70,18 +66,7 @@ class Cycle extends activity_1.Activity {
             });
         }
     }
-    /**
-     * Trigger the target ancestor to execute in a cycle,
-     * without violating the constraints of the DAG. Immutable
-     * `individual activity state` will execute in a new dimensional
-     * thread while `shared job state` can change. This
-     * pattern allows for retries without violating the DAG.
-     */
     async cycleAncestorActivity(multi) {
-        //Cycle activity L1 is a standin for the target ancestor L1.
-        //Input data mapping (mapInputData) allows for the
-        //next dimensonal thread to execute with different
-        //input data than the current dimensional thread
         this.mapInputData();
         const streamData = {
             metadata: {

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

@@ -6,16 +6,10 @@ import { JobState, JobStatus } from '../../types/job';
 import { RedisMulti } from '../../types/redis';
 import { StreamCode, StreamStatus } from '../../types/stream';
 import { Activity } from './activity';
-/**
- * Supports `signal hook`, `time hook`, and `cycle hook` patterns
- */
 declare class Hook extends Activity {
     config: HookActivity;
     constructor(config: ActivityType, data: ActivityData, metadata: ActivityMetadata, hook: ActivityData | null, engine: EngineService, context?: JobState);
     process(): Promise<string>;
-    /**
-     * does this activity use a time-hook or web-hook
-     */
     doesHook(): boolean;
     doHook(telemetry: TelemetryService): Promise<void>;
     doPassThrough(telemetry: TelemetryService): Promise<void>;

package/build/services/activities/hook.js

@@ -8,14 +8,10 @@ const task_1 = require("../task");
 const telemetry_1 = require("../telemetry");
 const stream_1 = require("../../types/stream");
 const activity_1 = require("./activity");
-/**
- * Supports `signal hook`, `time hook`, and `cycle hook` patterns
- */
 class Hook extends activity_1.Activity {
     constructor(config, data, metadata, hook, engine, context) {
         super(config, data, metadata, hook, engine, context);
     }
-    //********  INITIAL ENTRY POINT (A)  ********//
     async process() {
         this.logger.debug('hook-process', {
             jid: this.context.metadata.jid,
@@ -28,11 +24,9 @@ class Hook extends activity_1.Activity {
             telemetry = new telemetry_1.TelemetryService(this.engine.appId, this.config, this.metadata, this.context);
             telemetry.startActivitySpan(this.leg);
             if (this.doesHook()) {
-                //sleep and wait to awaken upon a signal
                 await this.doHook(telemetry);
             }
             else {
-                //end the activity and transition to its children
                 await this.doPassThrough(telemetry);
             }
             return this.context.metadata.aid;
@@ -65,9 +59,6 @@ class Hook extends activity_1.Activity {
             });
         }
     }
-    /**
-     * does this activity use a time-hook or web-hook
-     */
     doesHook() {
         if (this.config.sleep) {
             const duration = pipe_1.Pipe.resolve(this.config.sleep, this.context);
@@ -119,7 +110,6 @@ class Hook extends activity_1.Activity {
             return this.context.metadata.jid;
         }
     }
-    //********  SIGNAL RE-ENTRY POINT  ********//
     async processWebHookEvent(status = stream_1.StreamStatus.SUCCESS, code = 200) {
         this.logger.debug('hook-process-web-hook-event', {
             topic: this.config.hook.topic,
@@ -138,8 +128,8 @@ class Hook extends activity_1.Activity {
             await this.processEvent(status, code, 'hook');
             if (code === 200) {
                 await taskService.deleteWebHookSignal(this.config.hook.topic, data);
-            } //else => 202/keep alive
-        } //else => already resolved
+            }
+        }
     }
     async processTimeHookEvent(jobId) {
         this.logger.debug('hook-process-time-hook-event', {

package/build/services/activities/interrupt.js

@@ -10,7 +10,6 @@ class Interrupt extends activity_1.Activity {
     constructor(config, data, metadata, hook, engine, context) {
         super(config, data, metadata, hook, engine, context);
     }
-    //********  LEG 1 ENTRY  ********//
     async process() {
         this.logger.debug('interrupt-process', {
             jid: this.context.metadata.jid,
@@ -58,14 +57,11 @@ class Interrupt extends activity_1.Activity {
         }
     }
     async interruptSelf(telemetry) {
-        // Apply final updates to THIS job's state
         if (this.config.job?.maps) {
             this.mapJobData();
             await this.setState();
         }
-        // Interrupt THIS job
         const messageId = await this.interrupt();
-        // Notarize completion and log
         telemetry.mapActivityAttributes();
         const multi = this.store.getMulti();
         await collator_1.CollatorService.notarizeEarlyCompletion(this, multi);
@@ -79,10 +75,8 @@ class Interrupt extends activity_1.Activity {
         return this.context.metadata.aid;
     }
     async interruptAnother(telemetry) {
-        // Interrupt ANOTHER job
         const messageId = await this.interrupt();
         const attrs = { 'app.activity.mid': messageId };
-        // Apply updates to THIS job's state
         telemetry.mapActivityAttributes();
         this.adjacencyList = await this.filterAdjacent();
         if (this.config.job?.maps || this.config.output?.maps) {
@@ -91,14 +85,12 @@ class Interrupt extends activity_1.Activity {
             const multi = this.store.getMulti();
             await this.setState(multi);
         }
-        // Notarize completion
         const multi = this.store.getMulti();
         await collator_1.CollatorService.notarizeEarlyCompletion(this, multi);
         await this.setStatus(this.adjacencyList.length - 1, multi);
         const multiResponse = (await multi.exec());
         const jobStatus = this.resolveStatus(multiResponse);
         attrs['app.job.jss'] = jobStatus;
-        // Transition next generation and log
         const messageIds = await this.transition(this.adjacencyList, jobStatus);
         if (messageIds.length) {
             attrs['app.activity.mids'] = messageIds.join(',');