bpmn-elements 8.2.4 → 9.1.0

package/src/activity/Activity.js

@@ -1,10 +1,10 @@
-import ActivityExecution from './ActivityExecution';
-import {brokerSafeId, getUniqueId} from '../shared';
-import {ActivityApi} from '../Api';
-import {ActivityBroker} from '../EventBroker';
-import {Formatter} from '../MessageFormatter';
-import {cloneContent, cloneParent, cloneMessage} from '../messageHelper';
-import {makeErrorFromMessage, ActivityError} from '../error/Errors';
+import ActivityExecution from './ActivityExecution.js';
+import {getUniqueId} from '../shared.js';
+import {ActivityApi} from '../Api.js';
+import {ActivityBroker} from '../EventBroker.js';
+import {Formatter} from '../MessageFormatter.js';
+import {cloneContent, cloneParent, cloneMessage} from '../messageHelper.js';
+import {makeErrorFromMessage, ActivityError} from '../error/Errors.js';
 
 const kActivityDef = Symbol.for('activityDefinition');
 const kConsuming = Symbol.for('consuming');
@@ -18,6 +18,7 @@ const kFlows = Symbol.for('flows');
 const kFormatter = Symbol.for('formatter');
 const kMessageHandlers = Symbol.for('messageHandlers');
 const kStateMessage = Symbol.for('stateMessage');
+const kActivated = Symbol.for('activated');
 
 export default Activity;
 
@@ -39,6 +40,7 @@ function Activity(Behaviour, activityDef, context) {
     taken: 0,
     discarded: 0,
   };
+  const isForCompensation = !!behaviour.isForCompensation;
 
   let attachedToActivity, attachedTo;
   if (attachedToRef) {
@@ -56,7 +58,14 @@ function Activity(Behaviour, activityDef, context) {
 
   const inboundSequenceFlows = context.getInboundSequenceFlows(id);
   const inboundAssociations = context.getInboundAssociations(id);
-  const inboundTriggers = attachedToActivity ? [attachedToActivity] : inboundSequenceFlows.slice();
+  let inboundTriggers;
+  if (attachedToActivity) {
+    inboundTriggers = [attachedToActivity];
+  } else if (isForCompensation) {
+    inboundTriggers = inboundAssociations.slice();
+  } else {
+    inboundTriggers = inboundSequenceFlows.slice();
+  }
   const outboundSequenceFlows = context.getOutboundSequenceFlows(id);
   const flows = this[kFlows] = {
     inboundSequenceFlows,
@@ -67,7 +76,6 @@ function Activity(Behaviour, activityDef, context) {
     outboundEvaluator: new OutboundEvaluator(this, outboundSequenceFlows),
   };
 
-  const isForCompensation = !!behaviour.isForCompensation;
   const isParallelJoin = activityDef.isParallelGateway && flows.inboundSequenceFlows.length > 1;
   this[kFlags] = {
     isEnd: flows.outboundSequenceFlows.length === 0,
@@ -89,54 +97,39 @@ function Activity(Behaviour, activityDef, context) {
     onExecutionMessage: this._onExecutionMessage.bind(this),
   };
 
-  const onInboundEvent = this._onInboundEvent.bind(this);
-  broker.assertQueue('inbound-q', {durable: true, autoDelete: false});
-  if (isForCompensation) {
-    for (const trigger of inboundAssociations) {
-      trigger.broker.subscribeTmp('event', '#', onInboundEvent, {noAck: true, consumerTag: `_inbound-${id}`});
-    }
-  } else {
-    for (const trigger of inboundTriggers) {
-      if (trigger.isSequenceFlow) trigger.broker.subscribeTmp('event', 'flow.#', onInboundEvent, {noAck: true, consumerTag: `_inbound-${id}`});
-      else trigger.broker.subscribeTmp('event', 'activity.#', onInboundEvent, {noAck: true, consumerTag: `_inbound-${id}`});
-    }
-  }
-
   this[kEventDefinitions] = eventDefinitions && eventDefinitions.map((ed) => new ed.Behaviour(this, ed, this.context));
   this[kExtensions] = context.loadExtensions(this);
 }
 
-const proto = Activity.prototype;
-
-Object.defineProperty(proto, 'counters', {
+Object.defineProperty(Activity.prototype, 'counters', {
   enumerable: true,
   get() {
     return {...this[kCounters]};
   },
 });
 
-Object.defineProperty(proto, 'execution', {
+Object.defineProperty(Activity.prototype, 'execution', {
   enumerable: true,
   get() {
     return this[kExec].execution;
   },
 });
 
-Object.defineProperty(proto, 'executionId', {
+Object.defineProperty(Activity.prototype, 'executionId', {
   enumerable: true,
   get() {
     return this[kExec].executionId;
   },
 });
 
-Object.defineProperty(proto, 'extensions', {
+Object.defineProperty(Activity.prototype, 'extensions', {
   enumerable: true,
   get() {
     return this[kExtensions];
   },
 });
 
-Object.defineProperty(proto, 'bpmnIo', {
+Object.defineProperty(Activity.prototype, 'bpmnIo', {
   enumerable: true,
   get() {
     const extensions = this[kExtensions];
@@ -144,7 +137,7 @@ Object.defineProperty(proto, 'bpmnIo', {
   },
 });
 
-Object.defineProperty(proto, 'formatter', {
+Object.defineProperty(Activity.prototype, 'formatter', {
   enumerable: true,
   get() {
     let formatter = this[kFormatter];
@@ -160,7 +153,7 @@ Object.defineProperty(proto, 'formatter', {
   },
 });
 
-Object.defineProperty(proto, 'isRunning', {
+Object.defineProperty(Activity.prototype, 'isRunning', {
   enumerable: true,
   get() {
     if (!this[kConsuming]) return false;
@@ -168,66 +161,72 @@ Object.defineProperty(proto, 'isRunning', {
   },
 });
 
-Object.defineProperty(proto, 'outbound', {
+Object.defineProperty(Activity.prototype, 'outbound', {
   enumerable: true,
   get() {
     return this[kFlows].outboundSequenceFlows;
   },
 });
 
-Object.defineProperty(proto, 'inbound', {
+Object.defineProperty(Activity.prototype, 'inbound', {
   enumerable: true,
   get() {
     return this[kFlows].inboundSequenceFlows;
   },
 });
 
-Object.defineProperty(proto, 'isEnd', {
+Object.defineProperty(Activity.prototype, 'isEnd', {
   enumerable: true,
   get() {
     return this[kFlags].isEnd;
   },
 });
-Object.defineProperty(proto, 'isStart', {
+Object.defineProperty(Activity.prototype, 'isStart', {
   enumerable: true,
   get() {
     return this[kFlags].isStart;
   },
 });
-Object.defineProperty(proto, 'isSubProcess', {
+Object.defineProperty(Activity.prototype, 'isSubProcess', {
   enumerable: true,
   get() {
     return this[kFlags].isSubProcess;
   },
 });
+Object.defineProperty(Activity.prototype, 'isTransaction', {
+  enumerable: true,
+  get() {
+    return this[kFlags].isTransaction;
+  },
+});
 
-Object.defineProperty(proto, 'isMultiInstance', {
+Object.defineProperty(Activity.prototype, 'isMultiInstance', {
   enumerable: true,
   get() {
     return this[kFlags].isMultiInstance;
   },
 });
 
-Object.defineProperty(proto, 'isThrowing', {
+Object.defineProperty(Activity.prototype, 'isThrowing', {
   enumerable: true,
   get() {
     return this[kFlags].isThrowing;
   },
 });
-Object.defineProperty(proto, 'isForCompensation', {
+Object.defineProperty(Activity.prototype, 'isForCompensation', {
   enumerable: true,
   get() {
     return this[kFlags].isForCompensation;
   },
 });
-Object.defineProperty(proto, 'triggeredByEvent', {
+Object.defineProperty(Activity.prototype, 'triggeredByEvent', {
   enumerable: true,
   get() {
     return this[kActivityDef].triggeredByEvent;
   },
 });
 
-Object.defineProperty(proto, 'attachedTo', {
+Object.defineProperty(Activity.prototype, 'attachedTo', {
   enumerable: true,
   get() {
     const attachedToId = this[kFlags].attachedTo;
@@ -236,25 +235,28 @@ Object.defineProperty(proto, 'attachedTo', {
   },
 });
 
-Object.defineProperty(proto, 'eventDefinitions', {
+Object.defineProperty(Activity.prototype, 'eventDefinitions', {
   enumerable: true,
   get() {
     return this[kEventDefinitions];
   },
 });
 
-proto.activate = function activate() {
-  if (this[kFlags].isForCompensation) return;
+Activity.prototype.activate = function activate() {
+  this[kActivated] = true;
+  this.addInboundListeners();
   return this._consumeInbound();
 };
 
-proto.deactivate = function deactivate() {
+Activity.prototype.deactivate = function deactivate() {
+  this[kActivated] = false;
   const broker = this.broker;
+  this.removeInboundListeners();
   broker.cancel('_run-on-inbound');
   broker.cancel('_format-consumer');
 };
 
-proto.init = function init(initContent) {
+Activity.prototype.init = function init(initContent) {
   const id = this.id;
   const exec = this[kExec];
   const executionId = exec.initExecutionId = exec.initExecutionId || getUniqueId(id);
@@ -262,7 +264,7 @@ proto.init = function init(initContent) {
   this._publishEvent('init', this._createMessage({...initContent, executionId}));
 };
 
-proto.run = function run(runContent) {
+Activity.prototype.run = function run(runContent) {
   const id = this.id;
   if (this.isRunning) throw new Error(`activity <${id}> is already running`);
 
@@ -281,7 +283,7 @@ proto.run = function run(runContent) {
   this._consumeRunQ();
 };
 
-proto.recover = function recover(state) {
+Activity.prototype.recover = function recover(state) {
   if (this.isRunning) throw new Error(`cannot recover running activity <${this.id}>`);
   if (!state) return;
 
@@ -301,7 +303,7 @@ proto.recover = function recover(state) {
   return this;
 };
 
-proto.resume = function resume() {
+Activity.prototype.resume = function resume() {
   if (this[kConsuming]) {
     throw new Error(`cannot resume running activity <${this.id}>`);
   }
@@ -316,7 +318,7 @@ proto.resume = function resume() {
   this._consumeRunQ();
 };
 
-proto.discard = function discard(discardContent) {
+Activity.prototype.discard = function discard(discardContent) {
   if (!this.status) return this._runDiscard(discardContent);
   const execution = this[kExec].execution;
   if (execution && !execution.completed) return execution.discard();
@@ -328,12 +330,29 @@ proto.discard = function discard(discardContent) {
   this._consumeRunQ();
 };
 
-proto.stop = function stop() {
-  if (!this[kConsuming]) return;
-  return this.getApi().stop();
+Activity.prototype.addInboundListeners = function addInboundListeners() {
+  const onInboundEvent = this._onInboundEvent.bind(this);
+  const triggerConsumerTag = `_inbound-${this.id}`;
+  for (const trigger of this[kFlows].inboundTriggers) {
+    if (trigger.isSequenceFlow) trigger.broker.subscribeTmp('event', 'flow.#', onInboundEvent, {noAck: true, consumerTag: triggerConsumerTag});
+    else if (this.isForCompensation) trigger.broker.subscribeTmp('event', 'association.#', onInboundEvent, {noAck: true, consumerTag: triggerConsumerTag});
+    else trigger.broker.subscribeTmp('event', 'activity.#', onInboundEvent, {noAck: true, consumerTag: triggerConsumerTag});
+  }
 };
 
-proto.next = function next() {
+Activity.prototype.removeInboundListeners = function removeInboundListeners() {
+  const triggerConsumerTag = `_inbound-${this.id}`;
+  for (const trigger of this[kFlows].inboundTriggers) {
+    trigger.broker.cancel(triggerConsumerTag);
+  }
+};
+
+Activity.prototype.stop = function stop() {
+  if (!this[kConsuming]) return this.broker.cancel('_run-on-inbound');
+  return this.getApi(this[kStateMessage]).stop();
+};
+
+Activity.prototype.next = function next() {
   if (!this.environment.settings.step) return;
   const stateMessage = this[kStateMessage];
   if (!stateMessage) return;
@@ -344,15 +363,15 @@ proto.next = function next() {
   return current;
 };
 
-proto.shake = function shake() {
+Activity.prototype.shake = function shake() {
   this._shakeOutbound({content: this._createMessage()});
 };
 
-proto.evaluateOutbound = function evaluateOutbound(fromMessage, discardRestAtTake, callback) {
+Activity.prototype.evaluateOutbound = function evaluateOutbound(fromMessage, discardRestAtTake, callback) {
   return this[kFlows].outboundEvaluator.evaluate(fromMessage, discardRestAtTake, callback);
 };
 
-proto.getState = function getState() {
+Activity.prototype.getState = function getState() {
   const msg = this._createMessage();
 
   const exec = this[kExec];
@@ -367,17 +386,17 @@ proto.getState = function getState() {
   };
 };
 
-proto.getApi = function getApi(message) {
+Activity.prototype.getApi = function getApi(message) {
   const execution = this[kExec].execution;
   if (execution && !execution.completed) return execution.getApi(message);
   return ActivityApi(this.broker, message || this[kStateMessage]);
 };
 
-proto.getActivityById = function getActivityById(elementId) {
+Activity.prototype.getActivityById = function getActivityById(elementId) {
   return this.context.getActivityById(elementId);
 };
 
-proto._runDiscard = function runDiscard(discardContent) {
+Activity.prototype._runDiscard = function runDiscard(discardContent) {
   const exec = this[kExec];
   const executionId = exec.executionId = exec.initExecutionId || getUniqueId(this.id);
   exec.initExecutionId = null;
@@ -390,12 +409,13 @@ proto._runDiscard = function runDiscard(discardContent) {
   this._consumeRunQ();
 };
 
-proto._discardRun = function discardRun() {
+Activity.prototype._discardRun = function discardRun() {
   const status = this.status;
   if (!status) return;
 
   const execution = this[kExec].execution;
   if (execution && !execution.completed) return;
+
   switch (status) {
     case 'executing':
     case 'error':
@@ -413,7 +433,7 @@ proto._discardRun = function discardRun() {
   this._consumeRunQ();
 };
 
-proto._shakeOutbound = function shakeOutbound(sourceMessage) {
+Activity.prototype._shakeOutbound = function shakeOutbound(sourceMessage) {
   const message = cloneMessage(sourceMessage);
   message.content.sequence = message.content.sequence || [];
   message.content.sequence.push({id: this.id, type: this.type});
@@ -428,7 +448,9 @@ proto._shakeOutbound = function shakeOutbound(sourceMessage) {
   for (const flow of this[kFlows].outboundSequenceFlows) flow.shake(message);
 };
 
-proto._consumeInbound = function consumeInbound() {
+Activity.prototype._consumeInbound = function consumeInbound() {
+  if (!this[kActivated]) return;
+
   if (this.status) return;
   const inboundQ = this.broker.getQueue('inbound-q');
   if (this[kFlags].isParallelJoin) {
@@ -438,9 +460,8 @@ proto._consumeInbound = function consumeInbound() {
   return inboundQ.consume(this[kMessageHandlers].onInbound, {consumerTag: '_run-on-inbound'});
 };
 
-proto._onInbound = function onInbound(routingKey, message) {
+Activity.prototype._onInbound = function onInbound(routingKey, message) {
   message.ack();
-  const id = this.id;
   const broker = this.broker;
   broker.cancel('_run-on-inbound');
 
@@ -462,20 +483,10 @@ proto._onInbound = function onInbound(routingKey, message) {
       if (content.discardSequence) discardSequence = content.discardSequence.slice();
       return this._runDiscard({inbound, discardSequence});
     }
-    case 'association.complete': {
-      broker.cancel('_run-on-inbound');
-
-      const compensationId = `${brokerSafeId(id)}_${brokerSafeId(content.sequenceId)}`;
-      this.logger.debug(`<${id}> completed compensation with id <${compensationId}>`);
-
-      return this._publishEvent('compensation.end', this._createMessage({
-        executionId: compensationId,
-      }));
-    }
   }
 };
 
-proto._onJoinInbound = function onJoinInbound(routingKey, message) {
+Activity.prototype._onJoinInbound = function onJoinInbound(routingKey, message) {
   const {content} = message;
   const {inboundSequenceFlows, inboundJoinFlows, inboundTriggers} = this[kFlows];
   const idx = inboundJoinFlows.findIndex((msg) => msg.content.id === content.id);
@@ -516,9 +527,8 @@ proto._onJoinInbound = function onJoinInbound(routingKey, message) {
   return this.run({inbound});
 };
 
-proto._onInboundEvent = function onInboundEvent(routingKey, message) {
+Activity.prototype._onInboundEvent = function onInboundEvent(routingKey, message) {
   const {fields, content, properties} = message;
-  const id = this.id;
   const inboundQ = this.broker.getQueue('inbound-q');
 
   switch (routingKey) {
@@ -536,36 +546,17 @@ proto._onInboundEvent = function onInboundEvent(routingKey, message) {
     case 'flow.take':
     case 'flow.discard':
       return inboundQ.queueMessage(fields, cloneContent(content), properties);
-    case 'association.discard': {
-      this.logger.debug(`<${id}> compensation discarded`);
-      return inboundQ.purge();
-    }
-    case 'association.complete': {
-      if (!this[kFlags].isForCompensation) break;
-
-      inboundQ.queueMessage(fields, cloneContent(content), properties);
-
-      const compensationId = `${brokerSafeId(id)}_${brokerSafeId(content.sequenceId)}`;
-      this._publishEvent('compensation.start', this._createMessage({
-        executionId: compensationId,
-        placeholder: true,
-      }));
-
-      this.logger.debug(`<${id}> start compensation with id <${compensationId}>`);
-
-      return this._consumeInbound();
-    }
   }
 };
 
-proto._consumeRunQ = function consumeRunQ() {
+Activity.prototype._consumeRunQ = function consumeRunQ() {
   if (this[kConsuming]) return;
 
   this[kConsuming] = true;
   this.broker.getQueue('run-q').assertConsumer(this[kMessageHandlers].onRunMessage, {exclusive: true, consumerTag: '_activity-run'});
 };
 
-proto._onRunMessage = function onRunMessage(routingKey, message, messageProperties) {
+Activity.prototype._onRunMessage = function onRunMessage(routingKey, message, messageProperties) {
   switch (routingKey) {
     case 'run.outbound.discard':
     case 'run.outbound.take':
@@ -586,7 +577,7 @@ proto._onRunMessage = function onRunMessage(routingKey, message, messageProperti
   });
 };
 
-proto._continueRunMessage = function continueRunMessage(routingKey, message) {
+Activity.prototype._continueRunMessage = function continueRunMessage(routingKey, message) {
   const isRedelivered = message.fields.redelivered;
   const content = cloneContent(message.content);
   const correlationId = message.properties.correlationId;
@@ -633,6 +624,7 @@ proto._continueRunMessage = function continueRunMessage(routingKey, message) {
     case 'run.execute.passthrough': {
       const execution = this.execution;
       if (!isRedelivered && execution) {
+        if (execution.completed) return message.ack();
         this[kExecuteMessage] = message;
         return execution.passthrough(message);
       }
@@ -712,7 +704,7 @@ proto._continueRunMessage = function continueRunMessage(routingKey, message) {
   if (!step) message.ack();
 };
 
-proto._onExecutionMessage = function onExecutionMessage(routingKey, message) {
+Activity.prototype._onExecutionMessage = function onExecutionMessage(routingKey, message) {
   const executeMessage = this[kExecuteMessage];
   const content = cloneContent({
     ...executeMessage.content,
@@ -741,6 +733,7 @@ proto._onExecutionMessage = function onExecutionMessage(routingKey, message) {
       broker.publish('run', 'run.discarded', content, {correlationId});
       break;
     }
+    case 'execution.cancel':
     case 'execution.discard':
       this.status = 'discarded';
       broker.publish('run', 'run.discarded', content, {correlationId});
@@ -755,14 +748,13 @@ proto._onExecutionMessage = function onExecutionMessage(routingKey, message) {
   this._ackRunExecuteMessage();
 };
 
-proto._ackRunExecuteMessage = function ackRunExecuteMessage() {
+Activity.prototype._ackRunExecuteMessage = function ackRunExecuteMessage() {
   if (this.environment.settings.step) return;
   const executeMessage = this[kExecuteMessage];
-  this[kExecuteMessage] = null;
   executeMessage.ack();
 };
 
-proto._doRunLeave = function doRunLeave(message, isDiscarded, onOutbound) {
+Activity.prototype._doRunLeave = function doRunLeave(message, isDiscarded, onOutbound) {
   const {content, properties} = message;
   const correlationId = properties.correlationId;
   if (content.ignoreOutbound) {
@@ -783,7 +775,7 @@ proto._doRunLeave = function doRunLeave(message, isDiscarded, onOutbound) {
   });
 };
 
-proto._doOutbound = function doOutbound(fromMessage, isDiscarded, callback) {
+Activity.prototype._doOutbound = function doOutbound(fromMessage, isDiscarded, callback) {
   const outboundSequenceFlows = this[kFlows].outboundSequenceFlows;
   if (!outboundSequenceFlows.length) return callback(null, []);
 
@@ -813,7 +805,7 @@ proto._doOutbound = function doOutbound(fromMessage, isDiscarded, callback) {
   });
 };
 
-proto._doRunOutbound = function doRunOutbound(outboundList, content, discardSequence) {
+Activity.prototype._doRunOutbound = function doRunOutbound(outboundList, content, discardSequence) {
   for (const outboundFlow of outboundList) {
     const {id: flowId, action} = outboundFlow;
     this.broker.publish('run', 'run.outbound.' + action, cloneContent(content, {
@@ -827,7 +819,7 @@ proto._doRunOutbound = function doRunOutbound(outboundList, content, discardSequ
   return outboundList;
 };
 
-proto._onResumeMessage = function onResumeMessage(message) {
+Activity.prototype._onResumeMessage = function onResumeMessage(message) {
   message.ack();
 
   const stateMessage = this[kStateMessage];
@@ -852,7 +844,7 @@ proto._onResumeMessage = function onResumeMessage(message) {
   return this.broker.publish('run', fields.routingKey, cloneContent(stateMessage.content), stateMessage.properties);
 };
 
-proto._publishEvent = function publishEvent(state, content, properties = {}) {
+Activity.prototype._publishEvent = function publishEvent(state, content, properties = {}) {
   this.broker.publish('event', `activity.${state}`, cloneContent(content, {state}), {
     ...properties,
     type: state,
@@ -861,7 +853,7 @@ proto._publishEvent = function publishEvent(state, content, properties = {}) {
   });
 };
 
-proto._onStop = function onStop(message) {
+Activity.prototype._onStop = function onStop(message) {
   const running = this[kConsuming];
 
   this.stopped = true;
@@ -880,7 +872,7 @@ proto._onStop = function onStop(message) {
   }
 };
 
-proto._consumeApi = function consumeApi() {
+Activity.prototype._consumeApi = function consumeApi() {
   const executionId = this[kExec].executionId;
   if (!executionId) return;
   const broker = this.broker;
@@ -888,7 +880,7 @@ proto._consumeApi = function consumeApi() {
   broker.subscribeTmp('api', `activity.*.${executionId}`, this[kMessageHandlers].onApiMessage, {noAck: true, consumerTag: '_activity-api', priority: 100});
 };
 
-proto._onApiMessage = function onApiMessage(routingKey, message) {
+Activity.prototype._onApiMessage = function onApiMessage(routingKey, message) {
   switch (message.properties.type) {
     case 'discard': {
       return this._discardRun(message);
@@ -902,7 +894,7 @@ proto._onApiMessage = function onApiMessage(routingKey, message) {
   }
 };
 
-proto._createMessage = function createMessage(override) {
+Activity.prototype._createMessage = function createMessage(override) {
   const name = this.name, status = this.status, parent = this.parent;
   const result = {
     ...override,
@@ -920,11 +912,11 @@ proto._createMessage = function createMessage(override) {
   return result;
 };
 
-proto._getOutboundSequenceFlowById = function getOutboundSequenceFlowById(flowId) {
+Activity.prototype._getOutboundSequenceFlowById = function getOutboundSequenceFlowById(flowId) {
   return this[kFlows].outboundSequenceFlows.find((flow) => flow.id === flowId);
 };
 
-proto._deactivateRunConsumers = function _deactivateRunConsumers() {
+Activity.prototype._deactivateRunConsumers = function _deactivateRunConsumers() {
   const broker = this.broker;
   broker.cancel('_activity-api');
   broker.cancel('_activity-run');