@hotmeshio/hotmesh 0.0.52 → 0.0.54

package/build/services/durable/exporter.js

@@ -1,388 +1,216 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ExporterService = void 0;
-const serializer_1 = require("../serializer");
 const utils_1 = require("../../modules/utils");
-const key_1 = require("../../modules/key");
-/**
- * Downloads job data from Redis (hscan, hmget, hgetall)
- * Splits, Inflates, and Sorts the job data for use in durable contexts
- */
+const serializer_1 = require("../serializer");
 class ExporterService {
     constructor(appId, store, logger) {
-        /**
-         * Friendly names for the activity ids
-         */
-        this.activitySymbols = {
-            t1: 'trigger',
-            a1: 'pivot',
-            w1: 'worker',
-            a592: 'sleeper',
-            a594: 'awaiter',
-            a599: 'retryer',
-            c592: 'sleep_cycler',
-            c594: 'await_cycler',
-            c599: 'retry_cycler',
-            s5: 'scrubber',
-            sig: 'hook',
-            siga1: 'hook_pivot',
-            sigw1: 'hook_worker',
-            siga592: 'hook_sleeper',
-            siga594: 'hook_awaiter',
-            siga599: 'hook_retryer',
-            sigc592: 'hook_sleep_cycler',
-            sigc594: 'hook_await_cycler',
-            sigc599: 'hook_retry_cycler',
-        };
-        //adjacent transitions
-        this.transitions = {
-            trigger: ['pivot', 'hook'],
-            pivot: ['worker'],
-            worker: ['sleeper', 'awaiter', 'retryer', 'scrubber'],
-            sleeper: ['sleep_cycler'],
-            awaiter: ['await_cycler'],
-            retryer: ['retry_cycler'],
-            hook: ['hook_pivot'],
-            hook_pivot: ['hook_worker'],
-            hook_worker: ['hook_sleeper', 'hook_awaiter', 'hook_retryer'],
-            hook_sleeper: ['hook_sleep_cycler'],
-            hook_awaiter: ['hook_await_cycler'],
-            hook_retryer: ['hook_retry_cycler'],
-        };
-        //goto transitions
-        this.cycles = {
-            sleep_cycler: ['pivot'],
-            await_cycler: ['pivot'],
-            retry_cycler: ['pivot'],
-            hook_sleep_cycler: ['hook_pivot'],
-            hook_await_cycler: ['hook_pivot'],
-            hook_retry_cycler: ['hook_pivot'],
-        };
         this.appId = appId;
         this.logger = logger;
         this.store = store;
-        this.serializer = new serializer_1.SerializerService();
     }
     /**
-     * Convert the job hash and dependency list into a DurableJobExport object.
-     * This object contains various facets that describe the interaction
-     * in terms relevant to narrative storytelling.
+     * Convert the job hash from its compiles format into a DurableJobExport object with
+     * facets that describe the workflow in terms relevant to narrative storytelling.
      */
     async export(jobId, options = {}) {
-        if (!this.symbols) {
-            this.symbols = this.store.getAllSymbols();
-            this.symbols = await this.symbols;
+        if (!ExporterService.symbols.has(this.appId)) {
+            const symbols = this.store.getAllSymbols();
+            ExporterService.symbols.set(this.appId, await symbols);
         }
-        const depData = await this.store.getDependencies(jobId);
         const jobData = await this.store.getRaw(jobId);
-        const jobExport = this.inflate(jobData, depData);
+        const jobExport = this.inflate(jobData, options);
         return jobExport;
     }
     /**
-     * Interleave actions into the replay timeline to create
-     * a time-ordered timeline of the entire interaction, beginning
-     * with the entry trigger and concluding with the scrubber
-     * activity. Using the returned timeline, it is possible to
-     * create an animated narrative of the job, highlighting
-     * activities in the graph according to the timeline's
-     * activity-created (/ac) and activity-updated (/au) entries.
+     * Inflates the job data from Redis into a DurableJobExport object
+     * @param jobHash - the job data from Redis
+     * @param dependencyList - the list of dependencies for the job
+     * @returns - the inflated job data
      */
-    createTimeline(replay, actions) {
+    inflate(jobHash, options) {
         const timeline = [];
-        replay.forEach((item) => {
-            const dimensions = item[0];
-            const parts = dimensions.split('/');
-            const activityName = item[1].split('/')[0];
-            const duplex = item[1].endsWith('/ac') ? 'entry' : 'exit';
-            const timestamp = item[2];
-            let event = {
-                activity: activityName,
-                duplex: duplex,
-                dimension: dimensions,
-                timestamp,
-                created: timestamp,
-                updated: timestamp,
-            };
-            const prior = timeline[timeline.length - 1];
-            if (prior && prior.activity === event.activity && prior.duplex !== event.duplex && prior.dimension === event.dimension) {
-                if (event.duplex === 'exit') {
-                    prior.updated = event.timestamp;
-                }
-                else {
-                    prior.created = event.timestamp;
-                }
-                event = prior;
+        const state = {};
+        const data = {};
+        const transitionsObject = {};
+        const regex = /^([a-zA-Z]{3}),(\d+(?:,\d+)*)/;
+        Object.entries(jobHash).forEach(([key, value]) => {
+            const match = key.match(regex);
+            if (match) {
+                //transitions
+                this.inflateTransition(match, value, transitionsObject);
             }
-            else {
-                timeline.push(event);
+            else if (key.length === 3) {
+                //state
+                state[this.inflateKey(key)] = serializer_1.SerializerService.fromString(value);
             }
-            if (this.isMainEntry(item[1])) {
-                event.actions = [];
-                this.interleaveActions(actions.main, event.actions);
+            else if (key.startsWith('_')) {
+                //data
+                data[key.substring(1)] = value;
             }
-            else if (this.isHookEntry(item[1])) {
-                const hookDimension = `/${parts[1]}/${parts[2]}`;
-                const hookActions = actions.hooks[hookDimension];
-                event.actions = [];
-                this.interleaveActions(hookActions, event.actions);
+            else if (key.startsWith('-')) {
+                //timeline
+                const keyParts = this.keyToObject(key); //key parts have meaning
+                timeline.push({
+                    ...keyParts,
+                    key,
+                    value: this.resolveValue(value, options.values),
+                });
             }
         });
-        return timeline;
+        return this.filterFields({
+            data: (0, utils_1.restoreHierarchy)(data),
+            state: Object.entries((0, utils_1.restoreHierarchy)(state))[0][1],
+            status: parseInt(jobHash[':'], 10),
+            timeline: this.sortParts(timeline),
+            transitions: this.sortEntriesByCreated(transitionsObject),
+        }, options.block, options.allow);
     }
-    /**
-     * Interleave actions into the 'worker' and 'hook_worker'
-     * activities (between their /ac and /au entries)
-     */
-    interleaveActions(target, actions) {
-        if (target) {
-            for (let i = target.cursor + 1; i < target.items.length; i++) {
-                const [_, actionType, jobOrIndex] = target.items[i];
-                actions.push({ action: actionType, target: jobOrIndex });
-                target.cursor = i;
-                if (this.isPausingAction(actionType)) {
-                    break;
-                }
+    resolveValue(raw, withValues) {
+        const resolved = serializer_1.SerializerService.fromString(raw);
+        if (withValues !== false) {
+            return resolved;
+        }
+        if (resolved && typeof resolved === 'object') {
+            if ('data' in resolved) {
+                resolved.data = {};
+            }
+            if ('$error' in resolved) {
+                resolved.$error = {};
             }
         }
-    }
-    isPausingAction(actionType) {
-        return actionType === 'sleep' || actionType === 'waitForSignal';
-    }
-    isMainEntry(key) {
-        return key.startsWith('worker/') && key.endsWith('/ac');
-    }
-    isHookEntry(key) {
-        return key.startsWith('hook_worker/') && key.endsWith('/ac');
+        return resolved;
     }
     /**
      * Inflates the key from Redis, 3-character symbol
      * into a human-readable JSON path, reflecting the
      * tree-like structure of the unidimensional Hash
+     * @private
      */
     inflateKey(key) {
-        if (key in this.symbols) {
-            const path = this.symbols[key];
+        const symbols = ExporterService.symbols.get(this.appId);
+        if (key in symbols) {
+            const path = symbols[key];
             const parts = path.split('/');
-            if (parts[0] in this.activitySymbols) {
-                parts[0] = this.activitySymbols[parts[0]];
-            }
             return parts.join('/');
         }
         return key;
     }
-    /**
-     * Inflates the dependency data from Redis into a DurableJobExport object by
-     * organizing the dimensional isolate in sch a way asto interleave
-     * into a story
-     * @param data - the dependency data from Redis
-     * @returns - the organized dependency data
-     */
-    inflateDependencyData(data, actions) {
-        const hookReg = /([0-9,]+)-(\d+)$/;
-        const flowReg = /-(\d+)$/;
-        return data.map((dependency, index) => {
-            const [action, topic, gid, _pd, ...jid] = dependency.split(key_1.VALSEP);
-            const jobId = jid.join(key_1.VALSEP);
-            const match = jobId.match(hookReg);
-            let prefix;
-            let type;
-            let dimensionKey = '';
-            if (match) {
-                //hook-originating dependency
-                const [_, dimension, counter] = match;
-                dimensionKey = dimension.split(',').join('/');
-                prefix = `${dimensionKey}[${counter}]`;
-                type = 'hook';
-            }
-            else {
-                const match = jobId.match(flowReg);
-                if (match) {
-                    //main workflow-originating dependency
-                    const [_, counter] = match;
-                    prefix = `[${counter}]`;
-                    type = 'flow';
+    filterFields(fullObject, block = [], allow = []) {
+        let result = {};
+        if (allow && allow.length > 0) {
+            allow.forEach(field => {
+                if (field in fullObject) {
+                    result[field] = fullObject[field];
                 }
-                else {
-                    //'other' types like signal cleanup
-                    prefix = '/';
-                    type = 'other';
+            });
+        }
+        else {
+            result = { ...fullObject };
+        }
+        if (block && block.length > 0) {
+            block.forEach(field => {
+                if (field in result) {
+                    delete result[field];
                 }
-            }
-            this.seedActions(type, action, topic, dependency, prefix, dimensionKey, actions, jobId);
-            return {
-                type: action,
-                topic,
-                gid,
-                jid: jobId,
-            };
-        });
+            });
+        }
+        return result;
     }
-    /**
-     * Adds historical actions (proxyActivity, executeChild)
-     * using the `dependency list` to determine
-     * after-the-fact what happened within the 'black-box'
-     * worker function. This is necessary to interleave the
-     * actions into the replay timeline, given that it isn't
-     * really possible to know the inner-workings of the user's
-     * function
-     *
-     */
-    seedActions(type, action, topic, dep, prefix, dimensionKey, actions, jobId) {
-        if (type !== 'other' && action === 'expire-child') {
-            let depType;
-            if (topic == `${this.appId}.activity.execute`) {
-                depType = 'proxyActivity';
-            }
-            else if (topic == `${this.appId}.execute`) {
-                depType = 'executeChild';
-            }
-            else if (topic == `${this.appId}.wfsc.execute`) {
-                depType = 'waitForSignal';
+    inflateTransition(match, value, transitionsObject) {
+        const [_, letters, dimensions] = match;
+        const path = this.inflateKey(letters);
+        const parts = path.split('/');
+        const activity = parts[0];
+        const isCreate = path.endsWith('/output/metadata/ac');
+        const isUpdate = path.endsWith('/output/metadata/au');
+        //for now only export activity start/stop; activity data would also be interesting
+        if (isCreate || isUpdate) {
+            const targetName = `${activity},${dimensions}`;
+            let target = transitionsObject[targetName];
+            if (!target) {
+                transitionsObject[targetName] = {
+                    activity,
+                    dimensions,
+                    created: isCreate ? value : null,
+                    updated: isUpdate ? value : null,
+                };
             }
-            if (depType) {
-                if (type === 'flow') {
-                    actions.main.items.push([prefix, depType, jobId]);
-                }
-                else if (type === 'hook') {
-                    if (!actions.hooks[dimensionKey]) {
-                        actions.hooks[dimensionKey] = {
-                            cursor: -1,
-                            items: [],
-                        };
-                    }
-                    actions.hooks[dimensionKey].items.push([prefix, depType, jobId]);
-                }
+            else {
+                target[isCreate ? 'created' : 'updated'] = value;
             }
         }
     }
+    sortEntriesByCreated(obj) {
+        const entriesArray = Object.values(obj);
+        entriesArray.sort((a, b) => {
+            return (a.created || a.updated).localeCompare(b.created || b.updated);
+        });
+        return entriesArray;
+    }
     /**
-     * Inflates the job data from Redis into a DurableJobExport object
-     * @param jobHash - the job data from Redis
-     * @param dependencyList - the list of dependencies for the job
-     * @returns - the inflated job data
+     * marker names are overloaded with details like sequence, type, etc
      */
-    inflate(jobHash, dependencyList) {
-        //the list of actions taken in the workflow and hook functions
-        const actions = {
-            hooks: {},
-            main: { cursor: -1, items: [] },
-        };
-        const dependencies = this.inflateDependencyData(dependencyList, actions);
-        const state = {};
-        const data = {};
-        const other = [];
-        const replay = [];
-        const regex = /^([a-zA-Z]{3}),(\d+(?:,\d+)*)/;
-        Object.entries(jobHash).forEach(([key, value]) => {
-            const match = key.match(regex);
-            if (match) {
-                //activity process state
-                this.inflateProcess(match, value, replay);
-            }
-            else if (key.length === 3) {
-                //job state
-                state[this.inflateKey(key)] = this.serializer.fromString(value);
+    keyToObject(key) {
+        function extractDimension(label) {
+            const parts = label.split(',');
+            if (parts.length > 1) {
+                parts.shift();
+                return parts.join(',');
             }
-            else if (key.startsWith('_')) {
-                //job data
-                data[key.substring(1)] = value;
-            }
-            else if (key.startsWith('-')) {
-                //actions with side effect (replayable)
-                this.inflateActions(key, value, actions);
-            }
-            else {
-                //collator guids, etc
-                other.push([null, key, value]);
-            }
-        });
-        replay.sort(this.dateSort);
-        actions.main.items.sort(this.reverseSort);
-        Object.entries(actions.hooks).forEach(([key, value]) => {
-            value.items.sort(this.reverseSort);
-        });
-        return {
-            data: (0, utils_1.restoreHierarchy)(data),
-            dependencies,
-            state: Object.entries((0, utils_1.restoreHierarchy)(state))[0][1],
-            status: jobHash[':'],
-            timeline: this.createTimeline(replay, actions),
-            transitions: { ...this.transitions },
-            cycles: { ...this.cycles },
-        };
-    }
-    inflateProcess(match, value, replay) {
-        const [_, letters, numbers] = match;
-        const path = this.inflateKey(letters);
-        if (path.endsWith('/output/metadata/ac') ||
-            path.endsWith('/output/metadata/au')) {
-            const dimensions = `/${numbers.replace(/,/g, '/')}`;
-            const resolved = this.serializer.fromString(value);
-            replay.push([
-                dimensions,
-                path,
-                resolved,
-            ]);
         }
-    }
-    inflateActions(key, value, actions) {
-        let [_, dimensionalType, counter, subcounter] = key.split('-');
-        if (subcounter) {
-            counter = `${counter}.${subcounter}`;
-        }
-        const [type, ...dimensions] = dimensionalType.split(',');
-        let dimensionKey = '';
-        let isHook = false;
-        if (dimensions.length > 0) {
-            dimensionKey = `/${dimensions.join('/')}`;
-            isHook = true;
-        }
-        let targetList;
-        if (isHook) {
-            if (!actions.hooks[dimensionKey]) {
-                actions.hooks[dimensionKey] = {
-                    cursor: -1,
-                    items: [],
-                };
-            }
-            targetList = actions.hooks[dimensionKey].items;
+        const parts = key.split('-');
+        if (parts.length === 4) {
+            //-proxy-5-     -search-1-1-
+            return {
+                index: parseInt(parts[2], 10),
+                dimension: extractDimension(parts[1]),
+            };
         }
         else {
-            targetList = actions.main.items;
+            //-search,0,0-1-1-    -proxy,0,0-1-
+            return {
+                index: parseInt(parts[2], 10),
+                secondary: parseInt(parts[3], 10),
+                dimension: extractDimension(parts[1]),
+            };
         }
-        targetList.push([
-            `${dimensionKey}[${counter}]`,
-            type,
-            value,
-        ]);
     }
-    reverseSort(aKey, bKey) {
-        if (aKey[0] > bKey[0]) {
-            return 1;
-        }
-        else if (aKey[0] < bKey[0]) {
-            return -1;
-        }
-        else {
-            if (aKey[1] > bKey[1]) {
+    /**
+     * idem list has a complicated sort order based on indexes and dimensions
+     */
+    sortParts(parts) {
+        return parts.sort((a, b) => {
+            const { dimension: aDim, index: aIdx, secondary: aSec } = a;
+            const { dimension: bDim, index: bIdx, secondary: bSec } = b;
+            if (aDim === undefined && bDim !== undefined)
+                return -1;
+            if (aDim !== undefined && bDim === undefined)
                 return 1;
+            if (aDim !== undefined && bDim !== undefined) {
+                if (aDim < bDim)
+                    return -1;
+                if (aDim > bDim)
+                    return 1;
             }
-            else if (aKey[1] < bKey[1]) {
+            if (aIdx < bIdx)
+                return -1;
+            if (aIdx > bIdx)
+                return 1;
+            if (aSec === undefined && bSec !== undefined)
                 return -1;
+            if (aSec !== undefined && bSec === undefined)
+                return 1;
+            if (aSec !== undefined && bSec !== undefined) {
+                if (aSec < bSec)
+                    return -1;
+                if (aSec > bSec)
+                    return 1;
             }
             return 0;
-        }
-    }
-    dateSort(aKey, bKey) {
-        if (aKey[2] > bKey[2]) {
-            return 1;
-        }
-        else if (aKey[2] < bKey[2]) {
-            return -1;
-        }
-        else {
-            return 0;
-        }
+        });
     }
+    ;
 }
 exports.ExporterService = ExporterService;
+ExporterService.symbols = new Map();

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

@@ -1,19 +1,20 @@
 import { ExporterService } from './exporter';
 import { HotMeshService as HotMesh } from '../hotmesh';
-import { DurableJobExport } from '../../types/exporter';
+import { DurableJobExport, ExportOptions } from '../../types/exporter';
 import { JobInterruptOptions } from '../../types/job';
+import { StreamError } from '../../types/stream';
 export declare class WorkflowHandleService {
     exporter: ExporterService;
     hotMesh: HotMesh;
     workflowTopic: string;
     workflowId: string;
     constructor(hotMesh: HotMesh, workflowTopic: string, workflowId: string);
-    export(): Promise<DurableJobExport>;
+    export(options?: ExportOptions): Promise<DurableJobExport>;
     /**
      * 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.
+     * executed `Durable.workflow.waitFor`. The workflow
+     * will awaken if no other signals are pending.
      */
     signal(signalId: string, data: Record<any, any>): Promise<void>;
     /**
@@ -45,9 +46,13 @@ export declare class WorkflowHandleService {
      */
     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.
+     * Waits for the workflow to complete and returns the result. If
+     * the workflow response includes an error, this method will rethrow
+     * the error, including the stack trace if available.
+     * Wrap calls in a try/catch as necessary to avoid unhandled exceptions.
      */
-    result(loadState?: boolean): Promise<any>;
+    result<T>(config?: {
+        state?: boolean;
+        throwOnError?: boolean;
+    }): Promise<T | StreamError>;
 }