@logicflow/engine 0.0.2 → 0.0.4

package/es/Scheduler.js

@@ -60,7 +60,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 };
 import EventEmitter from './EventEmitter';
 import { EVENT_INSTANCE_COMPLETE, EVENT_INSTANCE_INTERRUPTED, FlowStatus, } from './constant/constant';
-import { createTaskId } from './util/ID';
+import { createActionId } from './util/ID';
 /**
  * 调度器
  * 通过一个队列维护需要执行的节点，一个集合维护正在执行的节点
@@ -70,7 +70,7 @@ var Scheduler = /** @class */ (function (_super) {
     function Scheduler(config) {
         var _this = _super.call(this) || this;
         _this.nodeQueueMap = new Map();
-        _this.taskRunningMap = new Map();
+        _this.actionRunningMap = new Map();
         _this.flowModel = config.flowModel;
         _this.recorder = config.recorder;
         return _this;
@@ -80,13 +80,13 @@ var Scheduler = /** @class */ (function (_super) {
      * 1. 由流程模型将所有的开始节点添加到队列中。
      * 2. 当一个节点执行完成后，将后续的节点添加到队列中。
      */
-    Scheduler.prototype.addTask = function (nodeParam) {
+    Scheduler.prototype.addAction = function (nodeParam) {
         var executionId = nodeParam.executionId;
         if (!this.nodeQueueMap.has(executionId)) {
             this.nodeQueueMap.set(executionId, []);
         }
-        var currentTaskQueue = this.nodeQueueMap.get(executionId);
-        currentTaskQueue.push(nodeParam);
+        var currentActionQueue = this.nodeQueueMap.get(executionId);
+        currentActionQueue.push(nodeParam);
     };
     /**
      * 调度器执行下一个任务
@@ -96,22 +96,21 @@ var Scheduler = /** @class */ (function (_super) {
      */
     Scheduler.prototype.run = function (runParams) {
         var nodeQueue = this.nodeQueueMap.get(runParams.executionId);
-        if (nodeQueue.length > 0) {
-            this.nodeQueueMap.set(runParams.executionId, []);
-            for (var i = 0; i < nodeQueue.length; i++) {
-                var currentNode = nodeQueue[i];
-                var taskId = createTaskId();
-                var taskParam = __assign(__assign({}, currentNode), { taskId: taskId });
-                this.pushTaskToRunningMap(taskParam);
-                this.exec(taskParam);
-            }
+        // 将同一个executionId当前待执行的节点一起执行
+        // 避免出现某一个节点执行时间过长，导致其他节点等待时间过长。
+        while (nodeQueue.length) {
+            var currentNode = nodeQueue.pop();
+            var actionId = createActionId();
+            var actionParam = __assign(__assign({}, currentNode), { actionId: actionId });
+            this.pushActionToRunningMap(actionParam);
+            this.exec(actionParam);
         }
-        else if (!this.hasRunningTask(runParams.executionId)) {
-            // 当一个流程在nodeQueueMap和taskRunningMap中都不存在执行的节点时，说明这个流程已经执行完成。
+        if (!this.hasRunningAction(runParams.executionId)) {
+            // 当一个流程在nodeQueueMap和actionRunningMap中都不存在执行的节点时，说明这个流程已经执行完成。
             this.emit(EVENT_INSTANCE_COMPLETE, {
                 executionId: runParams.executionId,
                 nodeId: runParams.nodeId,
-                taskId: runParams.taskId,
+                actionId: runParams.actionId,
                 status: FlowStatus.COMPLETED,
             });
         }
@@ -126,12 +125,12 @@ var Scheduler = /** @class */ (function (_super) {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        this.pushTaskToRunningMap({
+                        this.pushActionToRunningMap({
                             executionId: resumeParam.executionId,
                             nodeId: resumeParam.nodeId,
-                            taskId: resumeParam.taskId,
+                            actionId: resumeParam.actionId,
                         });
-                        model = this.flowModel.createTask(resumeParam.nodeId);
+                        model = this.flowModel.createAction(resumeParam.nodeId);
                         return [4 /*yield*/, model.resume(__assign(__assign({}, resumeParam), { next: this.next.bind(this) }))];
                     case 1:
                         _a.sent();
@@ -140,44 +139,44 @@ var Scheduler = /** @class */ (function (_super) {
             });
         });
     };
-    Scheduler.prototype.pushTaskToRunningMap = function (taskParam) {
-        var executionId = taskParam.executionId, taskId = taskParam.taskId;
-        if (!this.taskRunningMap.has(executionId)) {
+    Scheduler.prototype.pushActionToRunningMap = function (actionParam) {
+        var executionId = actionParam.executionId, actionId = actionParam.actionId;
+        if (!this.actionRunningMap.has(executionId)) {
             var runningMap = new Map();
-            this.taskRunningMap.set(executionId, runningMap);
+            this.actionRunningMap.set(executionId, runningMap);
         }
-        this.taskRunningMap.get(executionId).set(taskId, taskParam);
+        this.actionRunningMap.get(executionId).set(actionId, actionParam);
     };
-    Scheduler.prototype.removeTaskFromRunningMap = function (taskParam) {
-        var executionId = taskParam.executionId, taskId = taskParam.taskId;
-        if (!taskId)
+    Scheduler.prototype.removeActionFromRunningMap = function (actionParam) {
+        var executionId = actionParam.executionId, actionId = actionParam.actionId;
+        if (!actionId)
             return;
-        var runningMap = this.taskRunningMap.get(executionId);
+        var runningMap = this.actionRunningMap.get(executionId);
         if (!runningMap)
             return;
-        runningMap.delete(taskId);
+        runningMap.delete(actionId);
     };
-    Scheduler.prototype.hasRunningTask = function (executionId) {
-        var runningMap = this.taskRunningMap.get(executionId);
+    Scheduler.prototype.hasRunningAction = function (executionId) {
+        var runningMap = this.actionRunningMap.get(executionId);
         if (!runningMap)
             return false;
         if (runningMap.size === 0) {
-            this.taskRunningMap.delete(executionId);
+            this.actionRunningMap.delete(executionId);
             return false;
         }
         return true;
     };
-    Scheduler.prototype.exec = function (taskParam) {
+    Scheduler.prototype.exec = function (actionParam) {
         return __awaiter(this, void 0, void 0, function () {
             var model, execResult;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        model = this.flowModel.createTask(taskParam.nodeId);
+                        model = this.flowModel.createAction(actionParam.nodeId);
                         return [4 /*yield*/, model.execute({
-                                executionId: taskParam.executionId,
-                                taskId: taskParam.taskId,
-                                nodeId: taskParam.nodeId,
+                                executionId: actionParam.executionId,
+                                actionId: actionParam.actionId,
+                                nodeId: actionParam.nodeId,
                                 next: this.next.bind(this),
                             })];
                     case 1:
@@ -185,12 +184,12 @@ var Scheduler = /** @class */ (function (_super) {
                         if (execResult && execResult.status === FlowStatus.INTERRUPTED) {
                             this.interrupted({
                                 execResult: execResult,
-                                taskParam: taskParam,
+                                actionParam: actionParam,
                             });
-                            this.saveTaskResult({
-                                executionId: taskParam.executionId,
-                                nodeId: taskParam.nodeId,
-                                taskId: taskParam.taskId,
+                            this.saveActionResult({
+                                executionId: actionParam.executionId,
+                                nodeId: actionParam.nodeId,
+                                actionId: actionParam.actionId,
                                 nodeType: execResult.nodeType,
                                 properties: execResult.properties,
                                 outgoing: [],
@@ -199,7 +198,7 @@ var Scheduler = /** @class */ (function (_super) {
                                     detail: execResult.detail,
                                 },
                             });
-                            this.removeTaskFromRunningMap(taskParam);
+                            this.removeActionFromRunningMap(actionParam);
                         }
                         return [2 /*return*/];
                 }
@@ -207,12 +206,12 @@ var Scheduler = /** @class */ (function (_super) {
         });
     };
     Scheduler.prototype.interrupted = function (_a) {
-        var execResult = _a.execResult, taskParam = _a.taskParam;
+        var execResult = _a.execResult, actionParam = _a.actionParam;
         this.emit(EVENT_INSTANCE_INTERRUPTED, {
-            executionId: taskParam.executionId,
+            executionId: actionParam.executionId,
             status: FlowStatus.INTERRUPTED,
-            nodeId: taskParam.nodeId,
-            taskId: taskParam.taskId,
+            nodeId: actionParam.nodeId,
+            actionId: actionParam.actionId,
             detail: execResult.detail,
         });
     };
@@ -220,24 +219,24 @@ var Scheduler = /** @class */ (function (_super) {
         var _this = this;
         if (data.outgoing && data.outgoing.length > 0) {
             data.outgoing.forEach(function (item) {
-                _this.addTask({
+                _this.addAction({
                     executionId: data.executionId,
                     nodeId: item.target,
                 });
             });
         }
-        this.saveTaskResult(data);
-        this.removeTaskFromRunningMap(data);
+        this.saveActionResult(data);
+        this.removeActionFromRunningMap(data);
         this.run({
             executionId: data.executionId,
             nodeId: data.nodeId,
-            taskId: data.taskId,
+            actionId: data.actionId,
         });
     };
-    Scheduler.prototype.saveTaskResult = function (data) {
-        this.recorder.addTask({
+    Scheduler.prototype.saveActionResult = function (data) {
+        this.recorder.addActionRecord({
             executionId: data.executionId,
-            taskId: data.taskId,
+            actionId: data.actionId,
             nodeId: data.nodeId,
             nodeType: data.nodeType,
             timestamp: Date.now(),

package/es/constant/constant.d.ts

@@ -7,7 +7,7 @@ export declare enum FlowStatus {
     RUNNING = "running",
     ERROR = "error"
 }
-export declare enum TaskStatus {
+export declare enum ActionStatus {
     SUCCESS = "success",
     ERROR = "error",
     INTERRUPTED = "interrupted"

package/es/constant/constant.js

@@ -11,10 +11,10 @@ export var FlowStatus;
     FlowStatus["RUNNING"] = "running";
     FlowStatus["ERROR"] = "error";
 })(FlowStatus || (FlowStatus = {}));
-// task status
-export var TaskStatus;
-(function (TaskStatus) {
-    TaskStatus["SUCCESS"] = "success";
-    TaskStatus["ERROR"] = "error";
-    TaskStatus["INTERRUPTED"] = "interrupted";
-})(TaskStatus || (TaskStatus = {}));
+// action status
+export var ActionStatus;
+(function (ActionStatus) {
+    ActionStatus["SUCCESS"] = "success";
+    ActionStatus["ERROR"] = "error";
+    ActionStatus["INTERRUPTED"] = "interrupted";
+})(ActionStatus || (ActionStatus = {}));

package/es/expression/browserVm.d.ts

@@ -1,2 +1,4 @@
+declare const createContext: (globalData: any) => any;
+declare const runInContext: (code: any, context: any) => any;
 declare const runInBrowserContext: (code: string, globalData?: any) => Promise<any>;
-export { runInBrowserContext, };
+export { runInBrowserContext, createContext, runInContext, };

package/es/expression/browserVm.js

@@ -35,32 +35,42 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 import { ErrorCode, WarningCode, getErrorMsg, getWarningMsg, } from '../constant/LogCode';
+var createContext = function (globalData) {
+    var iframe = document.createElement('iframe');
+    iframe.style.display = 'none';
+    if (!document || !document.body) {
+        console.error(getErrorMsg(ErrorCode.NO_DOCUMENT_BODY));
+    }
+    document.body.appendChild(iframe);
+    var iframeWindow = iframe.contentWindow;
+    iframeWindow.parent = null;
+    Object.keys(globalData).forEach(function (key) {
+        iframeWindow[key] = globalData[key];
+    });
+    return iframeWindow;
+};
+var runInContext = function (code, context) {
+    try {
+        var iframeEval = context.eval;
+        iframeEval.call(context, code);
+        if (context.frameElement) {
+            document.body.removeChild(context.frameElement);
+        }
+    }
+    catch (e) {
+        console.warn(getWarningMsg(WarningCode.EXPRESSION_EXEC_ERROR), { code: code, context: context, e: e });
+    }
+    return context;
+};
 var runInBrowserContext = function (code, globalData) {
     if (globalData === void 0) { globalData = {}; }
     return __awaiter(void 0, void 0, void 0, function () {
-        var iframe, iframeWindow, iframeEval, res;
+        var context;
         return __generator(this, function (_a) {
-            iframe = document.createElement('iframe');
-            iframe.style.display = 'none';
-            if (!document || !document.body) {
-                console.error(getErrorMsg(ErrorCode.NO_DOCUMENT_BODY));
-            }
-            document.body.appendChild(iframe);
-            iframeWindow = iframe.contentWindow;
-            iframeEval = iframeWindow.eval;
-            Object.keys(globalData).forEach(function (key) {
-                iframeWindow[key] = globalData[key];
-            });
-            res = null;
-            try {
-                res = iframeEval.call(iframeWindow, code);
-            }
-            catch (e) {
-                console.warn(getWarningMsg(WarningCode.EXPRESSION_EXEC_ERROR), { code: code, globalData: globalData, e: e });
-            }
-            document.body.removeChild(iframe);
-            return [2 /*return*/, res];
+            context = createContext(globalData);
+            runInContext(code, context);
+            return [2 /*return*/, context];
         });
     });
 };
-export { runInBrowserContext, };
+export { runInBrowserContext, createContext, runInContext, };

package/es/expression/nodeVm.js

@@ -34,7 +34,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
-// import vm from 'node:vm';
+/* eslint-disable global-require */
 var vm = require('vm');
 var runInNewContext = function (code, globalData) {
     if (globalData === void 0) { globalData = {}; }

package/es/index.d.ts

@@ -1,18 +1,21 @@
-import type { ResumeParams, GraphConfigData } from './types.d';
-import FlowModel, { TaskParams } from './FlowModel';
+import type { ResumeParams, GraphConfigData, EngineConstructorOptions } from './types.d';
+import FlowModel, { ActionParams } from './FlowModel';
 import StartNode from './nodes/StartNode';
 import TaskNode from './nodes/TaskNode';
 import Recorder from './recorder';
+import { NodeConstructor } from './nodes/BaseNode';
 export default class Engine {
+    id: string;
     global: Record<string, any>;
     graphData: GraphConfigData;
-    nodeModelMap: Map<string, any>;
+    nodeModelMap: Map<string, NodeConstructor>;
     flowModel: FlowModel;
     recorder: Recorder;
-    constructor();
+    context: Record<string, any>;
+    constructor(options?: EngineConstructorOptions);
     /**
      * 注册节点
-     * @param nodeConfig { type: 'custom-node', model: Class }
+     * @param nodeConfig { type: 'custom-node', model: NodeClass }
      */
     register(nodeConfig: any): void;
     /**
@@ -20,8 +23,8 @@ export default class Engine {
      * 注意：由于执行记录不会主动删除，所以需要自行清理。
      * nodejs环境建议自定义为持久化存储。
      * engine.setCustomRecorder({
-     *   async addTask(task) {}
-     *   async getTask(taskId) {}
+     *   async addActionRecord(task) {}
+     *   async getTask(actionId) {}
      *   async getExecutionTasks(executionId) {}
      *   clear() {}
      * });
@@ -30,18 +33,27 @@ export default class Engine {
     /**
      * 加载流程图数据
      */
-    load({ graphData, startNodeType, globalData, context, }: {
+    load({ graphData, startNodeType, globalData, }: {
         graphData: any;
         startNodeType?: string;
         globalData?: {};
-        context?: {};
     }): FlowModel;
     /**
      * 执行流程，允许多次调用。
      */
-    execute(execParam?: TaskParams): Promise<unknown>;
+    execute(execParam?: ActionParams): Promise<unknown>;
+    /**
+     * 恢复执行
+     * 注意此方法只能恢复节点后面的执行，不能恢复流程其他分支的执行。
+     * 同理，中断执行也只能中断节点后面的执行，不会中断其他分支的执行。
+     * 在实际项目中，如果存在中断节点，建议流程所有的节点都是排他网关，这样可以保证执行的过程不存在分支。
+     */
     resume(resumeParam: ResumeParams): Promise<unknown>;
+    getExecutionList(): Promise<any>;
     getExecutionRecord(executionId: any): Promise<any[]>;
+    getGlobalData(): Record<string, any>;
+    setGlobalData(data: any): void;
+    updateGlobalData(data: any): void;
 }
 export { Engine, TaskNode, StartNode, };
-export type { TaskParams, };
+export type { ActionParams, };

package/es/index.js

@@ -49,11 +49,12 @@ import FlowModel from './FlowModel';
 import StartNode from './nodes/StartNode';
 import TaskNode from './nodes/TaskNode';
 import Recorder from './recorder';
+import { createEngineId } from './util/ID';
 var Engine = /** @class */ (function () {
-    function Engine() {
+    function Engine(options) {
         this.nodeModelMap = new Map();
+        this.id = createEngineId();
         this.recorder = new Recorder();
-        // register node
         this.register({
             type: StartNode.nodeTypeName,
             model: StartNode,
@@ -62,10 +63,11 @@ var Engine = /** @class */ (function () {
             type: TaskNode.nodeTypeName,
             model: TaskNode,
         });
+        this.context = (options === null || options === void 0 ? void 0 : options.context) || {};
     }
     /**
      * 注册节点
-     * @param nodeConfig { type: 'custom-node', model: Class }
+     * @param nodeConfig { type: 'custom-node', model: NodeClass }
      */
     Engine.prototype.register = function (nodeConfig) {
         this.nodeModelMap.set(nodeConfig.type, nodeConfig.model);
@@ -75,8 +77,8 @@ var Engine = /** @class */ (function () {
      * 注意：由于执行记录不会主动删除，所以需要自行清理。
      * nodejs环境建议自定义为持久化存储。
      * engine.setCustomRecorder({
-     *   async addTask(task) {}
-     *   async getTask(taskId) {}
+     *   async addActionRecord(task) {}
+     *   async getTask(actionId) {}
      *   async getExecutionTasks(executionId) {}
      *   clear() {}
      * });
@@ -88,11 +90,11 @@ var Engine = /** @class */ (function () {
      * 加载流程图数据
      */
     Engine.prototype.load = function (_a) {
-        var graphData = _a.graphData, _b = _a.startNodeType, startNodeType = _b === void 0 ? 'StartNode' : _b, _c = _a.globalData, globalData = _c === void 0 ? {} : _c, _d = _a.context, context = _d === void 0 ? {} : _d;
+        var graphData = _a.graphData, _b = _a.startNodeType, startNodeType = _b === void 0 ? 'StartNode' : _b, _c = _a.globalData, globalData = _c === void 0 ? {} : _c;
         this.flowModel = new FlowModel({
             nodeModelMap: this.nodeModelMap,
             recorder: this.recorder,
-            context: context,
+            context: this.context,
             globalData: globalData,
             startNodeType: startNodeType,
         });
@@ -119,6 +121,12 @@ var Engine = /** @class */ (function () {
             });
         });
     };
+    /**
+     * 恢复执行
+     * 注意此方法只能恢复节点后面的执行，不能恢复流程其他分支的执行。
+     * 同理，中断执行也只能中断节点后面的执行，不会中断其他分支的执行。
+     * 在实际项目中，如果存在中断节点，建议流程所有的节点都是排他网关，这样可以保证执行的过程不存在分支。
+     */
     Engine.prototype.resume = function (resumeParam) {
         return __awaiter(this, void 0, void 0, function () {
             var _this = this;
@@ -133,23 +141,53 @@ var Engine = /** @class */ (function () {
             });
         });
     };
+    Engine.prototype.getExecutionList = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var executionIds;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.recorder.getExecutionList()];
+                    case 1:
+                        executionIds = _a.sent();
+                        return [2 /*return*/, executionIds];
+                }
+            });
+        });
+    };
     Engine.prototype.getExecutionRecord = function (executionId) {
         return __awaiter(this, void 0, void 0, function () {
             var tasks, records, i;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.recorder.getExecutionTasks(executionId)];
+                    case 0: return [4 /*yield*/, this.recorder.getExecutionActions(executionId)];
                     case 1:
                         tasks = _a.sent();
+                        if (!tasks) {
+                            return [2 /*return*/, null];
+                        }
                         records = [];
                         for (i = 0; i < tasks.length; i++) {
-                            records.push(this.recorder.getTask(tasks[i]));
+                            records.push(this.recorder.getActionRecord(tasks[i]));
                         }
                         return [2 /*return*/, Promise.all(records)];
                 }
             });
         });
     };
+    Engine.prototype.getGlobalData = function () {
+        var _a;
+        return (_a = this.flowModel) === null || _a === void 0 ? void 0 : _a.globalData;
+    };
+    Engine.prototype.setGlobalData = function (data) {
+        if (this.flowModel) {
+            this.flowModel.globalData = data;
+        }
+    };
+    Engine.prototype.updateGlobalData = function (data) {
+        if (this.flowModel) {
+            Object.assign(this.flowModel.globalData, data);
+        }
+    };
     return Engine;
 }());
 export default Engine;

package/es/nodes/BaseNode.d.ts

@@ -5,7 +5,7 @@ export interface BaseNodeInterface {
     nodeId: string;
     type: string;
     readonly baseType: string;
-    execute(taskParam: any): Promise<NodeExecResult>;
+    execute(actionParam: any): Promise<NodeExecResult>;
 }
 export declare type NodeConstructor = {
     new (config: {
@@ -13,6 +13,17 @@ export declare type NodeConstructor = {
         context: Record<string, any>;
         globalData: Record<string, any>;
     }): BaseNode;
+    action(params: {
+        executionId: string;
+        actionId: string;
+        nodeId: string;
+    }): Promise<ActionResult>;
+    onResume(params: {
+        executionId: string;
+        actionId: string;
+        nodeId: string;
+        data?: Record<string, any>;
+    }): Promise<void>;
 };
 export declare type IncomingConfig = {
     id: string;
@@ -31,10 +42,10 @@ export declare type NodeConfig = {
     incoming: IncomingConfig[];
     outgoing: OutgoingConfig[];
 };
-export declare type NextTaskParam = {
+export declare type NextActionParam = {
     executionId: string;
     nodeId: string;
-    taskId: string;
+    actionId: string;
     nodeType: string;
     outgoing: OutgoingConfig[];
     properties?: Record<string, any>;
@@ -71,7 +82,7 @@ export default class BaseNode implements BaseNodeInterface {
         globalData: any;
     });
     /**
-     * 节点的每一次执行都会生成一个唯一的taskId
+     * 节点的每一次执行都会生成一个唯一的actionId
      */
     execute(params: ExecParams): Promise<NodeExecResult>;
     /**
@@ -85,24 +96,24 @@ export default class BaseNode implements BaseNodeInterface {
      * 节点的执行逻辑
      * @overridable 可以自定义节点重写此方法。
      * @param params.executionId 流程执行记录ID
-     * @param params.taskId 此节点执行记录ID
+     * @param params.actionId 此节点执行记录ID
      * @param params.nodeId 节点ID
      */
     action(params: {
         executionId: string;
-        taskId: string;
+        actionId: string;
         nodeId: string;
     }): Promise<ActionResult>;
     /**
      * 节点的重新恢复执行逻辑
      * @overridable 可以自定义节点重写此方法。
      * @param params.executionId 流程执行记录ID
-     * @param params.taskId 此节点执行记录ID
+     * @param params.actionId 此节点执行记录ID
      * @param params.nodeId 节点ID
      */
     onResume(params: {
         executionId: string;
-        taskId: string;
+        actionId: string;
         nodeId: string;
         data?: Record<string, any>;
     }): Promise<void>;