bpmn-elements 8.1.0 → 8.2.1

package/dist/src/tasks/SubProcess.js

@@ -5,49 +5,41 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.SubProcessBehaviour = SubProcessBehaviour;
 exports.default = SubProcess;
-
 var _Activity = _interopRequireDefault(require("../activity/Activity"));
-
 var _ProcessExecution = _interopRequireDefault(require("../process/ProcessExecution"));
-
 var _messageHelper = require("../messageHelper");
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 const kExecutions = Symbol.for('executions');
 const kMessageHandlers = Symbol.for('messageHandlers');
-
 function SubProcess(activityDef, context) {
   const triggeredByEvent = activityDef.behaviour && activityDef.behaviour.triggeredByEvent;
-  const subProcess = new _Activity.default(SubProcessBehaviour, { ...activityDef,
+  const subProcess = new _Activity.default(SubProcessBehaviour, {
+    ...activityDef,
     isSubProcess: true,
     triggeredByEvent
   }, context);
-
   subProcess.getStartActivities = function getStartActivities(filterOptions) {
     return context.getStartActivities(filterOptions, activityDef.id);
   };
-
   subProcess.broker.cancel('_api-shake');
   subProcess.broker.subscribeTmp('api', 'activity.shake.*', onShake, {
     noAck: true,
     consumerTag: '_api-shake'
   });
   return subProcess;
-
   function onShake(_, message) {
     const {
       startId
     } = message.content;
     const last = message.content.sequence.pop();
     const sequence = new _ProcessExecution.default(subProcess, context).shake(startId);
-    message.content.sequence.push({ ...last,
+    message.content.sequence.push({
+      ...last,
       isSubProcess: true,
       sequence
     });
   }
 }
-
 function SubProcessBehaviour(activity, context) {
   const {
     id,
@@ -68,31 +60,24 @@ function SubProcessBehaviour(activity, context) {
     onExecutionCompleted: this._onExecutionCompleted.bind(this)
   };
 }
-
 const proto = SubProcessBehaviour.prototype;
 Object.defineProperty(proto, 'execution', {
   get() {
     return this[kExecutions][0];
   }
-
 });
 Object.defineProperty(proto, 'executions', {
   get() {
     return this[kExecutions].slice();
   }
-
 });
-
 proto.execute = function execute(executeMessage) {
   const content = executeMessage.content;
   let executionId = this.executionId;
-
   if (content.isRootScope) {
     executionId = this.executionId = content.executionId;
   }
-
   const loopCharacteristics = this.loopCharacteristics;
-
   if (loopCharacteristics && content.isRootScope) {
     this.broker.subscribeTmp('api', `activity.#.${executionId}`, this[kMessageHandlers].onApiRootMessage, {
       noAck: true,
@@ -101,13 +86,10 @@ proto.execute = function execute(executeMessage) {
     });
     return loopCharacteristics.execute(executeMessage);
   }
-
   const processExecution = this._upsertExecution(executeMessage);
-
   if (!processExecution) return;
   return processExecution.execute(executeMessage);
 };
-
 proto.stop = function stop() {
   for (const execution of this[kExecutions]) {
     this.broker.cancel(`_sub-process-execution-${execution.executionId}`);
@@ -115,7 +97,6 @@ proto.stop = function stop() {
     execution.stop();
   }
 };
-
 proto.discard = function discard() {
   for (const execution of this[kExecutions]) {
     this.broker.cancel(`_sub-process-execution-${execution.executionId}`);
@@ -123,7 +104,6 @@ proto.discard = function discard() {
     execution.discard();
   }
 };
-
 proto.getState = function getState() {
   if (this.loopCharacteristics) {
     return {
@@ -134,120 +114,96 @@ proto.getState = function getState() {
       })
     };
   }
-
   const execution = this.execution;
-
   if (execution) {
     const state = execution.getState();
     state.environment = execution.environment.getState();
     return state;
   }
 };
-
 proto.recover = function recover(state) {
   if (!state) return;
   const executions = this[kExecutions];
   const loopCharacteristics = this.loopCharacteristics;
-
   if (loopCharacteristics && state.executions) {
     executions.splice(0);
-
     for (const se of state.executions) {
       this.recover(se);
     }
-
     return;
   }
-
   if (!loopCharacteristics) {
     executions.splice(0);
   }
-
   const subEnvironment = this.environment.clone().recover(state.environment);
   const subContext = this.context.clone(subEnvironment);
   const execution = new _ProcessExecution.default(this.activity, subContext).recover(state);
   executions.push(execution);
   return execution;
 };
-
 proto.getPostponed = function getPostponed() {
   return this[kExecutions].reduce((result, pe) => {
     result = result.concat(pe.getPostponed());
     return result;
   }, []);
 };
-
 proto._onApiRootMessage = function onApiRootMessage(_, message) {
   const messageType = message.properties.type;
-
   switch (messageType) {
     case 'stop':
       this.broker.cancel(message.fields.consumerTag);
       this.stop();
       break;
-
     case 'discard':
       this.broker.cancel(message.fields.consumerTag);
       this.discard();
       break;
   }
 };
-
 proto._upsertExecution = function upsertExecution(executeMessage) {
   const content = executeMessage.content;
   const executionId = content.executionId;
-
   let execution = this._getExecutionById(executionId);
-
   if (execution) {
     if (executeMessage.fields.redelivered) this._addListeners(execution, executionId);
     return execution;
   }
-
   const subEnvironment = this.environment.clone();
   const subContext = this.context.clone(subEnvironment);
   execution = new _ProcessExecution.default(this.activity, subContext);
   this[kExecutions].push(execution);
-
   this._addListeners(execution, executionId);
-
   return execution;
 };
-
 proto._addListeners = function addListeners(processExecution, executionId) {
   this.broker.subscribeTmp('subprocess-execution', `execution.#.${executionId}`, this[kMessageHandlers].onExecutionCompleted, {
     noAck: true,
     consumerTag: `_sub-process-execution-${executionId}`
   });
 };
-
 proto._onExecutionCompleted = function onExecutionCompleted(_, message) {
   if (message.fields.redelivered && message.properties.persistent === false) return;
   const content = message.content;
   const messageType = message.properties.type;
   const broker = this.broker;
-
   switch (messageType) {
     case 'stopped':
       {
         broker.cancel(message.fields.consumerTag);
         break;
       }
-
     case 'discard':
       {
         broker.cancel(message.fields.consumerTag);
         broker.publish('execution', 'execute.discard', (0, _messageHelper.cloneContent)(content));
         break;
       }
-
     case 'completed':
       {
         broker.cancel(message.fields.consumerTag);
         broker.publish('execution', 'execute.completed', (0, _messageHelper.cloneContent)(content));
         break;
       }
-
     case 'error':
       {
         broker.cancel(message.fields.consumerTag);
@@ -260,21 +216,17 @@ proto._onExecutionCompleted = function onExecutionCompleted(_, message) {
       }
   }
 };
-
 proto.getApi = function getApi(apiMessage) {
   const content = apiMessage.content;
   if (content.id === this.id) return;
   let execution;
-
   if (execution = this._getExecutionById(content.parent.executionId)) {
     return execution.getApi(apiMessage);
   }
-
   for (const pp of content.parent.path) {
     if (execution = this._getExecutionById(pp.executionId)) return execution.getApi(apiMessage);
   }
 };
-
 proto._getExecutionById = function getExecutionById(executionId) {
   return this[kExecutions].find(pe => pe.executionId === executionId);
 };

package/dist/src/tasks/Task.js

@@ -5,17 +5,12 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.TaskBehaviour = TaskBehaviour;
 exports.default = Task;
-
 var _Activity = _interopRequireDefault(require("../activity/Activity"));
-
 var _messageHelper = require("../messageHelper");
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 function Task(activityDef, context) {
   return new _Activity.default(TaskBehaviour, activityDef, context);
 }
-
 function TaskBehaviour(activity) {
   const {
     id,
@@ -28,14 +23,11 @@ function TaskBehaviour(activity) {
   this.loopCharacteristics = behaviour.loopCharacteristics && new behaviour.loopCharacteristics.Behaviour(activity, behaviour.loopCharacteristics);
   this.broker = broker;
 }
-
 TaskBehaviour.prototype.execute = function execute(executeMessage) {
   const executeContent = executeMessage.content;
   const loopCharacteristics = this.loopCharacteristics;
-
   if (loopCharacteristics && executeContent.isRootScope) {
     return loopCharacteristics.execute(executeMessage);
   }
-
   return this.broker.publish('execution', 'execute.completed', (0, _messageHelper.cloneContent)(executeContent));
 };

package/dist/src/tasks/Transaction.js

@@ -4,11 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = Transaction;
-
 var _SubProcess = _interopRequireDefault(require("./SubProcess"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 function Transaction(activityDef, context) {
   const transaction = {
     type: 'transaction',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bpmn-elements",
-  "version": "8.1.0",
+  "version": "8.2.1",
   "description": "Executable workflow elements based on BPMN 2.0",
   "main": "dist/index.js",
   "module": "index.js",
@@ -46,18 +46,18 @@
   ],
   "devDependencies": {
     "@aircall/expression-parser": "^1.0.4",
-    "@babel/cli": "^7.18.6",
-    "@babel/core": "^7.18.6",
-    "@babel/preset-env": "^7.18.6",
-    "@babel/register": "^7.18.6",
+    "@babel/cli": "^7.19.3",
+    "@babel/core": "^7.20.2",
+    "@babel/preset-env": "^7.20.2",
+    "@babel/register": "^7.18.9",
     "bpmn-moddle": "^7.1.2",
     "camunda-bpmn-moddle": "^6.1.2",
-    "chai": "^4.3.6",
+    "chai": "^4.3.7",
     "chronokinesis": "^3.0.0",
     "debug": "^4.3.4",
-    "eslint": "^7.32.0",
+    "eslint": "^8.27.0",
     "got": "^11.8.5",
-    "mocha": "^9.2.2",
+    "mocha": "^10.1.0",
     "mocha-cakes-2": "^3.3.0",
     "moddle-context-serializer": "^2.1.0",
     "nock": "^13.2.8",

package/src/Context.js

@@ -1,3 +1,4 @@
+import BpmnIO from './io/BpmnIO';
 import Environment from './Environment';
 import ExtensionsMapper from './ExtensionsMapper';
 import {getUniqueId} from './shared';
@@ -16,7 +17,7 @@ function ContextInstance(definitionContext, environment) {
   this.sid = sid;
   this.definitionContext = definitionContext;
   this.environment = environment;
-  this.extensionsMapper = ExtensionsMapper(this);
+  this.extensionsMapper = new ExtensionsMapper(this);
   this.refs = {
     activityRefs: {},
     associationRefs: [],
@@ -196,6 +197,9 @@ proto.getStartActivities = function getStartActivities(filterOptions, scopeId) {
 };
 
 proto.loadExtensions = function loadExtensions(activity) {
-  return this.extensionsMapper.get(activity);
+  const io = new BpmnIO(activity, this);
+  const extensions = this.extensionsMapper.get(activity);
+  if (io.hasIo) extensions.extensions.push(io);
+  if (!extensions.extensions.length) return;
+  return extensions;
 };
-

package/src/ExtensionsMapper.js

@@ -1,42 +1,42 @@
-export default function ExtensionsMapper(context) {
-  const {extensions: envExtensions} = context.environment;
-  const extensions = getExtensions();
+const kActivated = Symbol.for('activated');
 
-  return {
-    get,
-  };
+export default function ExtensionsMapper(context) {
+  this.context = context;
+}
 
-  function get(activity) {
-    const activityExtensions = extensions.reduce(applyExtension, []);
-    return {
-      activate,
-      deactivate,
-    };
+ExtensionsMapper.prototype.get = function get(activity) {
+  return new Extensions(activity, this.context, this._getExtensions());
+};
 
-    function applyExtension(result, Extension) {
-      const extension = Extension(activity, context);
-      if (extension) result.push(extension);
-      return result;
-    }
+ExtensionsMapper.prototype._getExtensions = function getExtensions() {
+  let extensions;
+  if (!(extensions = this.context.environment.extensions)) return [];
+  return Object.values(extensions);
+};
 
-    function activate(message) {
-      for (const extension of activityExtensions) extension.activate(message);
-    }
-    function deactivate(message) {
-      for (const extension of activityExtensions) extension.deactivate(message);
-    }
+function Extensions(activity, context, extensions) {
+  const result = this.extensions = [];
+  for (const Extension of extensions) {
+    const extension = Extension(activity, context);
+    if (extension) result.push(extension);
   }
+  this[kActivated] = false;
+}
 
-  function getExtensions() {
-    const result = [];
-    if (!envExtensions) return result;
+Object.defineProperty(Extensions.prototype, 'count', {
+  get() {
+    return this.extensions.length;
+  },
+});
 
-    for (const key in envExtensions) {
-      const extension = envExtensions[key];
-      if (extension) {
-        result.push(extension);
-      }
-    }
-    return result;
-  }
-}
+Extensions.prototype.activate = function activate(message) {
+  if (this[kActivated]) return;
+  this[kActivated] = true;
+  for (const extension of this.extensions) extension.activate(message);
+};
+
+Extensions.prototype.deactivate = function deactivate(message) {
+  if (!this[kActivated]) return;
+  this[kActivated] = false;
+  for (const extension of this.extensions) extension.deactivate(message);
+};

package/src/activity/Activity.js

@@ -1,5 +1,4 @@
 import ActivityExecution from './ActivityExecution';
-import BpmnIO from '../io/BpmnIO';
 import {brokerSafeId, getUniqueId} from '../shared';
 import {ActivityApi} from '../Api';
 import {ActivityBroker} from '../EventBroker';
@@ -8,7 +7,6 @@ import {cloneContent, cloneParent, cloneMessage} from '../messageHelper';
 import {makeErrorFromMessage, ActivityError} from '../error/Errors';
 
 const kActivityDef = Symbol.for('activityDefinition');
-const kBpmnIo = Symbol.for('bpmnIo');
 const kConsuming = Symbol.for('consuming');
 const kCounters = Symbol.for('counters');
 const kEventDefinitions = Symbol.for('eventDefinitions');
@@ -105,6 +103,7 @@ function Activity(Behaviour, activityDef, context) {
   }
 
   this[kEventDefinitions] = eventDefinitions && eventDefinitions.map((ed) => new ed.Behaviour(this, ed, this.context));
+  this[kExtensions] = context.loadExtensions(this);
 }
 
 const proto = Activity.prototype;
@@ -130,21 +129,18 @@ Object.defineProperty(proto, 'executionId', {
   },
 });
 
-Object.defineProperty(proto, 'bpmnIo', {
+Object.defineProperty(proto, 'extensions', {
   enumerable: true,
   get() {
-    if (kBpmnIo in this) return this[kBpmnIo];
-    const bpmnIo = this[kBpmnIo] = new BpmnIO(this, this.context);
-    return bpmnIo;
+    return this[kExtensions];
   },
 });
 
-Object.defineProperty(proto, 'extensions', {
+Object.defineProperty(proto, 'bpmnIo', {
   enumerable: true,
   get() {
-    if (kExtensions in this) return this[kExtensions];
-    const extensions = this[kExtensions] = this.context.loadExtensions(this);
-    return extensions;
+    const extensions = this[kExtensions];
+    return extensions && extensions.extensions.find(e => e.type === 'bpmnio');
   },
 });
 
@@ -408,10 +404,12 @@ proto._discardRun = function discardRun() {
   }
 
   this._deactivateRunConsumers();
-  if (this.extensions) this.extensions.deactivate();
+
+  const message = this[kStateMessage];
+  if (this.extensions) this.extensions.deactivate(cloneMessage(message));
   const broker = this.broker;
   broker.getQueue('run-q').purge();
-  broker.publish('run', 'run.discard', cloneContent(this[kStateMessage].content));
+  broker.publish('run', 'run.discard', cloneContent(message.content));
   this._consumeRunQ();
 };
 
@@ -601,12 +599,9 @@ proto._continueRunMessage = function continueRunMessage(routingKey, message) {
       this.status = 'entered';
       if (!isRedelivered) {
         this[kExec].execution = null;
+        if (this.extensions) this.extensions.activate(cloneMessage(message));
+        this._publishEvent('enter', content, {correlationId});
       }
-
-      if (this.extensions) this.extensions.activate(cloneMessage(message), this);
-      if (this.bpmnIo) this.bpmnIo.activate(message);
-
-      if (!isRedelivered) this._publishEvent('enter', content, {correlationId});
       break;
     }
     case 'run.discard': {
@@ -615,8 +610,7 @@ proto._continueRunMessage = function continueRunMessage(routingKey, message) {
       this.status = 'discard';
       this[kExec].execution = null;
 
-      if (this.extensions) this.extensions.activate(cloneMessage(message), this);
-      if (this.bpmnIo) this.bpmnIo.activate(message);
+      if (this.extensions) this.extensions.activate(cloneMessage(message));
 
       if (!isRedelivered) {
         this.broker.publish('run', 'run.discarded', content, {correlationId});
@@ -631,7 +625,6 @@ proto._continueRunMessage = function continueRunMessage(routingKey, message) {
         this.broker.publish('run', 'run.execute', content, {correlationId});
         this._publishEvent('start', content, {correlationId});
       }
-
       break;
     }
     case 'run.execute.passthrough': {
@@ -645,23 +638,15 @@ proto._continueRunMessage = function continueRunMessage(routingKey, message) {
       this.status = 'executing';
       this[kExecuteMessage] = message;
 
-      this.broker.getQueue('execution-q').assertConsumer(this[kMessageHandlers].onExecutionMessage, {exclusive: true, consumerTag: '_activity-execution'});
       const exec = this[kExec];
+      if (isRedelivered && this.extensions) this.extensions.activate(cloneMessage(message));
       if (!exec.execution) exec.execution = new ActivityExecution(this, this.context);
-
-      if (isRedelivered) {
-        return this._resumeExtensions(message, (err, formattedContent) => {
-          if (err) return this.emitFatal(err, message.content);
-          if (formattedContent) message.content = formattedContent;
-          this.status = 'executing';
-          return exec.execution.execute(message);
-        });
-      }
-
+      this.broker.getQueue('execution-q').assertConsumer(this[kMessageHandlers].onExecutionMessage, {exclusive: true, consumerTag: '_activity-execution'});
       return exec.execution.execute(message);
     }
     case 'run.end': {
-      if (this.status === 'end') break;
+      this.logger.debug(`<${id}> end`, isRedelivered ? 'redelivered' : '');
+      if (isRedelivered) break;
 
       this[kCounters].taken++;
 
@@ -707,8 +692,7 @@ proto._continueRunMessage = function continueRunMessage(routingKey, message) {
     case 'run.leave': {
       this.status = undefined;
 
-      if (this.bpmnIo) this.bpmnIo.deactivate(message);
-      if (this.extensions) this.extensions.deactivate(message);
+      if (this.extensions) this.extensions.deactivate(cloneMessage(message));
 
       if (!isRedelivered) {
         this.broker.publish('run', 'run.next', content, {persistent: false});
@@ -844,7 +828,8 @@ proto._onResumeMessage = function onResumeMessage(message) {
   message.ack();
 
   const stateMessage = this[kStateMessage];
-  const {fields} = stateMessage;
+  const fields = stateMessage.fields;
+  if (!fields.redelivered) return;
 
   switch (fields.routingKey) {
     case 'run.enter':
@@ -857,7 +842,7 @@ proto._onResumeMessage = function onResumeMessage(message) {
       return;
   }
 
-  if (!fields.redelivered) return;
+  if (this.extensions) this.extensions.activate(cloneMessage(stateMessage));
 
   this.logger.debug(`<${this.id}> resume from ${message.content.status}`);
 
@@ -887,7 +872,7 @@ proto._onStop = function onStop(message) {
   broker.cancel('_format-consumer');
 
   if (running) {
-    if (this.extensions) this.extensions.deactivate(message || this._createMessage());
+    if (this.extensions) this.extensions.deactivate(cloneMessage(message));
     this._publishEvent('stop', this._createMessage());
   }
 };
@@ -936,20 +921,6 @@ proto._getOutboundSequenceFlowById = function getOutboundSequenceFlowById(flowId
   return this[kFlows].outboundSequenceFlows.find((flow) => flow.id === flowId);
 };
 
-proto._resumeExtensions = function resumeExtensions(message, callback) {
-  const extensions = this.extensions, bpmnIo = this.bpmnIo;
-  if (!extensions && !bpmnIo) return callback();
-
-  if (extensions) extensions.activate(cloneMessage(message), this);
-  if (bpmnIo) bpmnIo.activate(cloneMessage(message), this);
-
-  this.status = 'formatting';
-  return this.formatter.format(message, (err, formattedContent, formatted) => {
-    if (err) return callback(err);
-    return callback(null, formatted && formattedContent);
-  });
-};
-
 proto._deactivateRunConsumers = function _deactivateRunConsumers() {
   const broker = this.broker;
   broker.cancel('_activity-api');

package/src/gateways/EventBasedGateway.js

@@ -81,4 +81,3 @@ EventBasedGatewayBehaviour.prototype._stop = function stop() {
   for (const target of this[kTargets]) target.broker.cancel(targetConsumerTag);
   this.broker.cancel('_api-stop-execution');
 };
-

package/src/io/BpmnIO.js

@@ -1,6 +1,7 @@
 export default function BpmnIO(activity, context) {
   this.activity = activity;
   this.context = context;
+  this.type = 'bpmnio';
 
   const {
     ioSpecification: ioSpecificationDef,
@@ -11,6 +12,12 @@ export default function BpmnIO(activity, context) {
   this.properties = propertiesDef && new propertiesDef.Behaviour(activity, propertiesDef, context);
 }
 
+Object.defineProperty(BpmnIO.prototype, 'hasIo', {
+  get() {
+    return this.specification || this.properties;
+  },
+});
+
 BpmnIO.prototype.activate = function activate(message) {
   const properties = this.properties, specification = this.specification;
   if (properties) properties.activate(message);

package/src/io/EnvironmentDataObject.js

@@ -9,6 +9,7 @@ export default function EnvironmentDataObject(dataObjectDef, {environment}) {
 }
 
 EnvironmentDataObject.prototype.read = function read(broker, exchange, routingKeyPrefix, messageProperties) {
+
   const environment = this.environment;
   const value = environment.variables._data && environment.variables._data[this.id];
   const content = this._createContent(value);