bpmn-engine 21.1.0 → 22.0.1

package/lib/index.cjs

@@ -2,15 +2,15 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var module$1 = require('module');
-var events = require('events');
-var url = require('url');
+var node_module = require('node:module');
+var node_events = require('node:events');
+var node_url = require('node:url');
 var BpmnModdle = require('bpmn-moddle');
 var Elements = require('bpmn-elements');
 var smqp = require('smqp');
 var serializer = require('moddle-context-serializer');
 var Debug = require('debug');
-var vm = require('vm');
+var node_vm = require('node:vm');
 
 var _documentCurrentScript = typeof document !== 'undefined' ? document.currentScript : null;
 function _interopNamespaceDefault(e) {
@@ -42,7 +42,7 @@ function Logger(scope) {
 
 function Scripts(disableDummy) {
   if (!(this instanceof Scripts)) return new Scripts(disableDummy);
-  this.scripts = {};
+  this.scripts = new Map();
   this.disableDummy = disableDummy;
 }
 
@@ -67,25 +67,25 @@ Scripts.prototype.register = function register({ id, type, behaviour, logger, en
   if (!language || !scriptBody) {
     if (this.disableDummy) return;
     const script = new DummyScript(language, filename, logger);
-    this.scripts[id] = script;
+    this.scripts.set(id, script);
     return script;
   }
 
-  if (!/^javascript$/i.test(language)) return;
+  if (!/^(javascript|js)$/i.test(language)) return;
 
   const script = new JavaScript(language, filename, scriptBody, environment);
-  this.scripts[id] = script;
+  this.scripts.set(id, script);
 
   return script;
 };
 
 Scripts.prototype.getScript = function getScript(language, { id }) {
-  return this.scripts[id];
+  return this.scripts.get(id);
 };
 
 function JavaScript(language, filename, scriptBody, environment) {
   this.id = filename;
-  this.script = new vm.Script(scriptBody, { filename });
+  this.script = new node_vm.Script(scriptBody, { filename });
   this.language = language;
   this.environment = environment;
 }
@@ -161,7 +161,7 @@ ProcessOutputDataObject.prototype.write = function writeDataObject(broker, excha
   return broker.publish(exchange, `${routingKeyPrefix}response`, { id, name, type, value }, messageProperties);
 };
 
-const nodeRequire = module$1.createRequire(url.fileURLToPath((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.src || new URL('index.cjs', document.baseURI).href))));
+const nodeRequire = node_module.createRequire(node_url.fileURLToPath((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.src || new URL('index.cjs', document.baseURI).href))));
 const { version: engineVersion } = nodeRequire('../package.json');
 
 const kEngine = Symbol.for('engine');
@@ -171,7 +171,6 @@ const kExecution = Symbol.for('execution');
 const kLoadedDefinitions = Symbol.for('loaded definitions');
 const kOnBrokerReturn = Symbol.for('onBrokerReturn');
 const kPendingSources = Symbol.for('pending sources');
-const kSources = Symbol.for('sources');
 const kState = Symbol.for('state');
 const kStopped = Symbol.for('stopped');
 const kTypeResolver = Symbol.for('type resolver');
@@ -179,7 +178,7 @@ const kTypeResolver = Symbol.for('type resolver');
 function Engine(options = {}) {
   if (!(this instanceof Engine)) return new Engine(options);
 
-  events.EventEmitter.call(this);
+  node_events.EventEmitter.call(this);
 
   const opts = (this.options = {
     Logger: Logger,
@@ -204,12 +203,11 @@ function Engine(options = {}) {
 
   this[kExecution] = null;
   this[kLoadedDefinitions] = null;
-  this[kSources] = [];
 
-  const pendingSources = (this[kPendingSources] = []);
-  if (opts.source) pendingSources.push(this._serializeSource(opts.source));
-  if (opts.moddleContext) pendingSources.push(this._serializeModdleContext(opts.moddleContext));
-  if (opts.sourceContext) pendingSources.push(opts.sourceContext);
+  const pendingSources = (this[kPendingSources] = new Set());
+  if (opts.source) pendingSources.add(this._serializeSource(opts.source));
+  if (opts.moddleContext) pendingSources.add(this._serializeModdleContext(opts.moddleContext));
+  if (opts.sourceContext) pendingSources.add(opts.sourceContext);
 }
 
 function defaultTypeResolver(elementTypes) {
@@ -217,7 +215,7 @@ function defaultTypeResolver(elementTypes) {
   elementTypes['bpmn:DataStoreReference'] = ProcessOutputDataObject;
 }
 
-Engine.prototype = Object.create(events.EventEmitter.prototype);
+Engine.prototype = Object.create(node_events.EventEmitter.prototype);
 
 Object.defineProperties(Engine.prototype, {
   name: {
@@ -295,7 +293,8 @@ Engine.prototype.recover = function recover(savedState, recoverOptions) {
   if (!savedState.definitions) return this;
 
   const pendingSources = this[kPendingSources];
-  const preSources = pendingSources.splice(0);
+  const preSources = [...pendingSources];
+  pendingSources.clear();
 
   const typeResolver = this[kTypeResolver];
   const loadedDefinitions = (this[kLoadedDefinitions] = savedState.definitions.map((dState) => {
@@ -303,7 +302,7 @@ Engine.prototype.recover = function recover(savedState, recoverOptions) {
     if (dState.source) source = serializer.deserialize(JSON.parse(dState.source), typeResolver);
     else source = preSources.find((s) => s.id === dState.id);
 
-    pendingSources.push(source);
+    pendingSources.add(source);
 
     this.logger.debug(`<${name}> recover ${dState.type} <${dState.id}>`);
 
@@ -339,7 +338,7 @@ Engine.prototype.addSource = function addSource({ sourceContext: addContext } =
   if (!addContext) return;
   const loadedDefinitions = this[kLoadedDefinitions];
   if (loadedDefinitions) loadedDefinitions.splice(0);
-  this[kPendingSources].push(addContext);
+  this[kPendingSources].add(addContext);
 };
 
 Engine.prototype.getDefinitions = function getDefinitions(executeOptions) {
@@ -413,9 +412,7 @@ Engine.prototype._serializeSource = async function serializeSource(source) {
 };
 
 Engine.prototype._serializeModdleContext = function serializeModdleContext(moddleContext) {
-  const serialized = serializer(moddleContext, this[kTypeResolver]);
-  this[kSources].push(serialized);
-  return serialized;
+  return serializer(moddleContext, this[kTypeResolver], this.options.extendFn);
 };
 
 Engine.prototype._getModdleContext = function getModdleContext(source) {
@@ -431,7 +428,7 @@ function Execution(engine, definitions, options, isRecovered = false) {
   this[kStopped] = isRecovered;
   this[kEnvironment] = engine.environment;
   this[kEngine] = engine;
-  this[kExecuting] = [];
+  this[kExecuting] = new Set();
   const onBrokerReturn = (this[kOnBrokerReturn] = this._onBrokerReturn.bind(this));
   engine.broker.on('return', onBrokerReturn);
 }
@@ -462,6 +459,14 @@ Object.defineProperties(Execution.prototype, {
       return this._getActivityStatus();
     },
   },
+  isRunning: {
+    get() {
+      for (const definition of this[kExecuting]) {
+        if (definition.isRunning) return true;
+      }
+      return false;
+    },
+  },
 });
 
 Execution.prototype._execute = function execute(executeOptions, callback) {
@@ -492,7 +497,7 @@ Execution.prototype._resume = function resume(resumeOptions, callback) {
   this._debug('resume');
   this._addConsumerCallbacks(callback);
 
-  this[kExecuting].splice(0);
+  this[kExecuting].clear();
   this.definitions.forEach((definition) => definition.resume());
 
   return this;
@@ -554,9 +559,11 @@ Execution.prototype.stop = async function stop() {
   this[kStopped] = true;
   const timers = engine.environment.timers;
 
-  timers.executing.slice().forEach((ref) => timers.clearTimeout(ref));
+  timers.executing.forEach((ref) => timers.clearTimeout(ref));
 
-  this[kExecuting].splice(0).forEach((d) => d.stop());
+  const executing = new Set(this[kExecuting]);
+  this[kExecuting].clear();
+  for (const definition of executing) definition.stop();
 
   const result = await prom;
   this[kState] = 'stopped';
@@ -590,17 +597,13 @@ Execution.prototype._onChildMessage = function onChildMessage(routingKey, messag
   switch (routingKey) {
     case 'definition.resume':
     case 'definition.enter': {
-      const executing = this[kExecuting];
-      const idx = executing.indexOf(owner);
-      if (idx > -1) break;
-      executing.push(owner);
+      this[kExecuting].add(owner);
       break;
     }
     case 'definition.stop': {
       this._teardownDefinition(owner);
 
-      const executing = this[kExecuting];
-      if (executing.some((d) => d.isRunning)) break;
+      if (this.isRunning) break;
 
       newState = 'stopped';
       this[kStopped] = true;
@@ -609,7 +612,7 @@ Execution.prototype._onChildMessage = function onChildMessage(routingKey, messag
     case 'definition.leave':
       this._teardownDefinition(owner);
 
-      if (this[kExecuting].some((d) => d.isRunning)) break;
+      if (this.isRunning) break;
 
       newState = 'idle';
       break;
@@ -660,10 +663,7 @@ Execution.prototype._complete = function complete(eventType, content, messagePro
 };
 
 Execution.prototype._teardownDefinition = function teardownDefinition(definition) {
-  const executing = this[kExecuting];
-  const idx = executing.indexOf(definition);
-  if (idx > -1) executing.splice(idx, 1);
-
+  this[kExecuting].delete(definition);
   definition.broker.cancel('_engine_definition');
 };
 
@@ -709,11 +709,12 @@ Execution.prototype.getActivityById = function getActivityById(activityId) {
 };
 
 Execution.prototype.getPostponed = function getPostponed() {
-  const defs = this.stopped ? this.definitions : this[kExecuting];
-  return defs.reduce((result, definition) => {
+  const definitions = this.stopped ? this.definitions : this[kExecuting];
+  let result = [];
+  for (const definition of definitions) {
     result = result.concat(definition.getPostponed());
-    return result;
-  }, []);
+  }
+  return result;
 };
 
 Execution.prototype.signal = function signal(payload, { ignoreSameDefinition } = {}) {
@@ -745,13 +746,12 @@ Execution.prototype._debug = function debug(msg) {
 
 Execution.prototype._getActivityStatus = function getActivityStatus() {
   let status = 'idle';
-  const running = this[kExecuting];
-  if (!running.length) return status;
-  else if (running.length === 1) return running[0].activityStatus;
+  const executing = this[kExecuting];
+  if (!executing.size) return status;
 
-  for (const def of running) {
-    const bpStatus = def.activityStatus;
-    switch (def.activityStatus) {
+  for (const definition of executing) {
+    const bpStatus = definition.activityStatus;
+    switch (definition.activityStatus) {
       case 'executing':
         return bpStatus;
       case 'timer':

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "bpmn-engine",
   "description": "BPMN 2.0 execution engine. Open source javascript workflow engine.",
-  "version": "21.1.0",
+  "version": "22.0.1",
   "type": "module",
   "module": "./src/index.js",
   "main": "./lib/index.cjs",
@@ -16,7 +16,7 @@
     "url": "https://github.com/paed01"
   },
   "engines": {
-    "node": ">=14"
+    "node": ">=18"
   },
   "files": [
     "lib/",
@@ -25,7 +25,7 @@
   ],
   "scripts": {
     "test": "mocha -p -R @bonniernews/hot-bev",
-    "posttest": "npm run lint && npm run toc",
+    "posttest": "npm run lint && npm run toc && npm run dist",
     "lint": "eslint . --cache && prettier . -c --cache",
     "wintest": "mocha",
     "cov:html": "c8 -r html -r text mocha -p -R @bonniernews/hot-bev",
@@ -52,11 +52,11 @@
   ],
   "devDependencies": {
     "@bonniernews/hot-bev": "^0.4.0",
-    "@rollup/plugin-commonjs": "^25.0.7",
+    "@rollup/plugin-commonjs": "^26.0.1",
     "@types/bpmn-moddle": "^5.1.6",
     "@types/node": "^18.19.31",
     "bent": "^7.3.12",
-    "c8": "^9.1.0",
+    "c8": "^10.0.0",
     "camunda-bpmn-moddle": "^7.0.1",
     "chai": "^5.1.0",
     "chronokinesis": "^6.0.0",
@@ -64,16 +64,15 @@
     "markdown-toc": "^1.2.0",
     "mocha": "^10.2.0",
     "mocha-cakes-2": "^3.3.0",
-    "nock": "^13.3.2",
     "prettier": "^3.2.5",
     "rollup": "^4.10.0",
-    "texample": "^0.0.2"
+    "texample": "^0.0.5"
   },
   "dependencies": {
-    "bpmn-elements": "^14.1.0",
+    "bpmn-elements": "^15.0.1",
     "bpmn-moddle": "^9.0.1",
     "debug": "^4.3.4",
     "moddle-context-serializer": "^4.2.0",
-    "smqp": "^8.2.3"
+    "smqp": "^9.0.2"
   }
 }

package/src/JavaScripts.js

@@ -1,8 +1,8 @@
-import { Script } from 'vm';
+import { Script } from 'node:vm';
 
 export default function Scripts(disableDummy) {
   if (!(this instanceof Scripts)) return new Scripts(disableDummy);
-  this.scripts = {};
+  this.scripts = new Map();
   this.disableDummy = disableDummy;
 }
 
@@ -27,20 +27,20 @@ Scripts.prototype.register = function register({ id, type, behaviour, logger, en
   if (!language || !scriptBody) {
     if (this.disableDummy) return;
     const script = new DummyScript(language, filename, logger);
-    this.scripts[id] = script;
+    this.scripts.set(id, script);
     return script;
   }
 
-  if (!/^javascript$/i.test(language)) return;
+  if (!/^(javascript|js)$/i.test(language)) return;
 
   const script = new JavaScript(language, filename, scriptBody, environment);
-  this.scripts[id] = script;
+  this.scripts.set(id, script);
 
   return script;
 };
 
 Scripts.prototype.getScript = function getScript(language, { id }) {
-  return this.scripts[id];
+  return this.scripts.get(id);
 };
 
 function JavaScript(language, filename, scriptBody, environment) {

package/src/index.js

@@ -1,6 +1,6 @@
-import { createRequire } from 'module';
-import { EventEmitter } from 'events';
-import { fileURLToPath } from 'url';
+import { createRequire } from 'node:module';
+import { EventEmitter } from 'node:events';
+import { fileURLToPath } from 'node:url';
 
 import BpmnModdle from 'bpmn-moddle';
 import * as Elements from 'bpmn-elements';
@@ -22,7 +22,6 @@ const kExecution = Symbol.for('execution');
 const kLoadedDefinitions = Symbol.for('loaded definitions');
 const kOnBrokerReturn = Symbol.for('onBrokerReturn');
 const kPendingSources = Symbol.for('pending sources');
-const kSources = Symbol.for('sources');
 const kState = Symbol.for('state');
 const kStopped = Symbol.for('stopped');
 const kTypeResolver = Symbol.for('type resolver');
@@ -58,12 +57,11 @@ export function Engine(options = {}) {
 
   this[kExecution] = null;
   this[kLoadedDefinitions] = null;
-  this[kSources] = [];
 
-  const pendingSources = (this[kPendingSources] = []);
-  if (opts.source) pendingSources.push(this._serializeSource(opts.source));
-  if (opts.moddleContext) pendingSources.push(this._serializeModdleContext(opts.moddleContext));
-  if (opts.sourceContext) pendingSources.push(opts.sourceContext);
+  const pendingSources = (this[kPendingSources] = new Set());
+  if (opts.source) pendingSources.add(this._serializeSource(opts.source));
+  if (opts.moddleContext) pendingSources.add(this._serializeModdleContext(opts.moddleContext));
+  if (opts.sourceContext) pendingSources.add(opts.sourceContext);
 }
 
 function defaultTypeResolver(elementTypes) {
@@ -149,7 +147,8 @@ Engine.prototype.recover = function recover(savedState, recoverOptions) {
   if (!savedState.definitions) return this;
 
   const pendingSources = this[kPendingSources];
-  const preSources = pendingSources.splice(0);
+  const preSources = [...pendingSources];
+  pendingSources.clear();
 
   const typeResolver = this[kTypeResolver];
   const loadedDefinitions = (this[kLoadedDefinitions] = savedState.definitions.map((dState) => {
@@ -157,7 +156,7 @@ Engine.prototype.recover = function recover(savedState, recoverOptions) {
     if (dState.source) source = deserialize(JSON.parse(dState.source), typeResolver);
     else source = preSources.find((s) => s.id === dState.id);
 
-    pendingSources.push(source);
+    pendingSources.add(source);
 
     this.logger.debug(`<${name}> recover ${dState.type} <${dState.id}>`);
 
@@ -193,7 +192,7 @@ Engine.prototype.addSource = function addSource({ sourceContext: addContext } =
   if (!addContext) return;
   const loadedDefinitions = this[kLoadedDefinitions];
   if (loadedDefinitions) loadedDefinitions.splice(0);
-  this[kPendingSources].push(addContext);
+  this[kPendingSources].add(addContext);
 };
 
 Engine.prototype.getDefinitions = function getDefinitions(executeOptions) {
@@ -267,9 +266,7 @@ Engine.prototype._serializeSource = async function serializeSource(source) {
 };
 
 Engine.prototype._serializeModdleContext = function serializeModdleContext(moddleContext) {
-  const serialized = serializer(moddleContext, this[kTypeResolver]);
-  this[kSources].push(serialized);
-  return serialized;
+  return serializer(moddleContext, this[kTypeResolver], this.options.extendFn);
 };
 
 Engine.prototype._getModdleContext = function getModdleContext(source) {
@@ -285,7 +282,7 @@ export function Execution(engine, definitions, options, isRecovered = false) {
   this[kStopped] = isRecovered;
   this[kEnvironment] = engine.environment;
   this[kEngine] = engine;
-  this[kExecuting] = [];
+  this[kExecuting] = new Set();
   const onBrokerReturn = (this[kOnBrokerReturn] = this._onBrokerReturn.bind(this));
   engine.broker.on('return', onBrokerReturn);
 }
@@ -316,6 +313,14 @@ Object.defineProperties(Execution.prototype, {
       return this._getActivityStatus();
     },
   },
+  isRunning: {
+    get() {
+      for (const definition of this[kExecuting]) {
+        if (definition.isRunning) return true;
+      }
+      return false;
+    },
+  },
 });
 
 Execution.prototype._execute = function execute(executeOptions, callback) {
@@ -346,7 +351,7 @@ Execution.prototype._resume = function resume(resumeOptions, callback) {
   this._debug('resume');
   this._addConsumerCallbacks(callback);
 
-  this[kExecuting].splice(0);
+  this[kExecuting].clear();
   this.definitions.forEach((definition) => definition.resume());
 
   return this;
@@ -408,9 +413,11 @@ Execution.prototype.stop = async function stop() {
   this[kStopped] = true;
   const timers = engine.environment.timers;
 
-  timers.executing.slice().forEach((ref) => timers.clearTimeout(ref));
+  timers.executing.forEach((ref) => timers.clearTimeout(ref));
 
-  this[kExecuting].splice(0).forEach((d) => d.stop());
+  const executing = new Set(this[kExecuting]);
+  this[kExecuting].clear();
+  for (const definition of executing) definition.stop();
 
   const result = await prom;
   this[kState] = 'stopped';
@@ -444,17 +451,13 @@ Execution.prototype._onChildMessage = function onChildMessage(routingKey, messag
   switch (routingKey) {
     case 'definition.resume':
     case 'definition.enter': {
-      const executing = this[kExecuting];
-      const idx = executing.indexOf(owner);
-      if (idx > -1) break;
-      executing.push(owner);
+      this[kExecuting].add(owner);
       break;
     }
     case 'definition.stop': {
       this._teardownDefinition(owner);
 
-      const executing = this[kExecuting];
-      if (executing.some((d) => d.isRunning)) break;
+      if (this.isRunning) break;
 
       newState = 'stopped';
       this[kStopped] = true;
@@ -463,7 +466,7 @@ Execution.prototype._onChildMessage = function onChildMessage(routingKey, messag
     case 'definition.leave':
       this._teardownDefinition(owner);
 
-      if (this[kExecuting].some((d) => d.isRunning)) break;
+      if (this.isRunning) break;
 
       newState = 'idle';
       break;
@@ -514,10 +517,7 @@ Execution.prototype._complete = function complete(eventType, content, messagePro
 };
 
 Execution.prototype._teardownDefinition = function teardownDefinition(definition) {
-  const executing = this[kExecuting];
-  const idx = executing.indexOf(definition);
-  if (idx > -1) executing.splice(idx, 1);
-
+  this[kExecuting].delete(definition);
   definition.broker.cancel('_engine_definition');
 };
 
@@ -563,11 +563,12 @@ Execution.prototype.getActivityById = function getActivityById(activityId) {
 };
 
 Execution.prototype.getPostponed = function getPostponed() {
-  const defs = this.stopped ? this.definitions : this[kExecuting];
-  return defs.reduce((result, definition) => {
+  const definitions = this.stopped ? this.definitions : this[kExecuting];
+  let result = [];
+  for (const definition of definitions) {
     result = result.concat(definition.getPostponed());
-    return result;
-  }, []);
+  }
+  return result;
 };
 
 Execution.prototype.signal = function signal(payload, { ignoreSameDefinition } = {}) {
@@ -599,13 +600,12 @@ Execution.prototype._debug = function debug(msg) {
 
 Execution.prototype._getActivityStatus = function getActivityStatus() {
   let status = 'idle';
-  const running = this[kExecuting];
-  if (!running.length) return status;
-  else if (running.length === 1) return running[0].activityStatus;
+  const executing = this[kExecuting];
+  if (!executing.size) return status;
 
-  for (const def of running) {
-    const bpStatus = def.activityStatus;
-    switch (def.activityStatus) {
+  for (const definition of executing) {
+    const bpStatus = definition.activityStatus;
+    switch (definition.activityStatus) {
       case 'executing':
         return bpStatus;
       case 'timer':

package/types/bpmn-engine.d.ts

@@ -1,9 +1,13 @@
 // Author : Saeed Tabrizi
 // Refactored by : Pål Edman
 
-import { EventEmitter } from 'events';
+import { EventEmitter } from 'node:events';
 import { Definitions as BpmnModdleDefinitions } from 'bpmn-moddle';
-import { extendFn, SerializableContext } from 'moddle-context-serializer';
+import {
+  extendFn,
+  SerializableContext,
+  TypeResolver,
+} from 'moddle-context-serializer';
 import {
   ActivityStatus,
   ElementBroker,
@@ -68,8 +72,12 @@ declare module 'bpmn-engine' {
     [name: string]: any;
   }
 
+  export interface IListenerEmitter {
+    emit(eventName: string, ...args: any[]): void;
+  }
+
   export interface BpmnEngineExecuteOptions extends EnvironmentOptions {
-    listener?: EventEmitter;
+    listener?: EventEmitter | IListenerEmitter;
   }
 
   export interface BpmnEngineOptions extends BpmnEngineExecuteOptions {
@@ -89,15 +97,20 @@ declare module 'bpmn-engine' {
      * optional override of BPMN Elements behaviors, defaults to bpmn-elements
      */
     elements?: Record<string, any>;
+    /**
+     * Passed to moddle-context-serializer as TypeResolver
+     */
+    typeResolver?: typeof TypeResolver;
     /**
      * Passed to moddle-context-serializer as extendFn
      */
-    typeResolver?: extendFn;
+    extendFn?: extendFn;
     /**
      * optional bpmn-moddle options to be passed to bpmn-moddle
      */
     moddleOptions?: any;
     moddleContext?: BpmnModdleDefinitions;
+    [x: string]: any;
   }
 
   const enum BpmnEngineRunningStatus {
@@ -267,6 +280,10 @@ declare module 'bpmn-engine' {
      */
     readonly definitions: Definition[];
     get activityStatus(): ActivityStatus;
+    /**
+     * Are any definition running
+     */
+    get isRunning(): boolean;
 
     /**
      * Get activity/element by id. Loops the definitions and returns the first found activity with id.