bpmn-elements 16.2.1 → 17.0.0

package/dist/MessageFormatter.js

@@ -10,7 +10,13 @@ var _Errors = require("./error/Errors.js");
 var _smqp = require("smqp");
 const kOnMessage = Symbol.for('onMessage');
 const kExecution = Symbol.for('execution');
-function Formatter(element, formatQ) {
+const EXEC_ROUTING_KEY = 'run._formatting.exec';
+
+/**
+ * Message formatter used to enrich an element run message before continuing to the next run message
+ * @param {import('types').ElementBase} element
+ */
+function Formatter(element) {
   const {
     id,
     broker,
@@ -19,16 +25,19 @@ function Formatter(element, formatQ) {
   this.id = id;
   this.broker = broker;
   this.logger = logger;
-  this.formatQ = formatQ;
   this[kOnMessage] = this._onMessage.bind(this);
 }
+
+/**
+ * Format message
+ * @param {import('types').ElementBrokerMessage} message
+ * @param {CallableFunction} callback
+ */
 Formatter.prototype.format = function format(message, callback) {
   const correlationId = this._runId = (0, _shared.getUniqueId)(message.fields.routingKey);
   const consumerTag = '_formatter-' + correlationId;
-  const formatQ = this.formatQ;
-  formatQ.queueMessage({
-    routingKey: '_formatting.exec'
-  }, {}, {
+  const broker = this.broker;
+  broker.publish('format', EXEC_ROUTING_KEY, {}, {
     correlationId,
     persistent: false
   });
@@ -37,11 +46,11 @@ Formatter.prototype.format = function format(message, callback) {
     formatKey: message.fields.routingKey,
     runMessage: (0, _messageHelper.cloneMessage)(message),
     callback,
-    pending: [],
+    pending: new Set(),
     formatted: false,
     executeMessage: null
   };
-  formatQ.consume(this[kOnMessage], {
+  broker.consume('format-run-q', this[kOnMessage], {
     consumerTag,
     prefetch: 100
   });
@@ -53,41 +62,33 @@ Formatter.prototype._onMessage = function onMessage(routingKey, message) {
     pending,
     executeMessage
   } = this[kExecution];
-  const asyncFormatting = pending.length;
-  switch (routingKey) {
-    case '_formatting.exec':
-      if (message.properties.correlationId !== correlationId) return message.ack();
-      if (!asyncFormatting) {
-        message.ack();
-        return this._complete(message);
-      }
-      this[kExecution].executeMessage = message;
-      break;
-    default:
-      {
-        message.ack();
-        const endRoutingKey = message.content?.endRoutingKey;
-        if (endRoutingKey) {
-          this._decorate(message.content);
-          pending.push(message);
-          return this._debug(`start formatting ${formatKey} message content with formatter ${routingKey}`);
-        }
-        if (asyncFormatting) {
-          const {
-            isError,
-            message: startMessage
-          } = this._popFormatStart(pending, routingKey);
-          if (startMessage) startMessage.ack();
-          if (isError) {
-            return this._complete(message, true);
-          }
-        }
-        this._decorate(message.content);
-        this._debug(`format ${message.fields.routingKey} message content with formatter ${routingKey}`);
-        if (executeMessage && asyncFormatting && !pending.length) {
-          this._complete(message);
-        }
+  const asyncFormatting = pending.size;
+  if (routingKey === EXEC_ROUTING_KEY) {
+    if (message.properties.correlationId !== correlationId) return message.ack();
+    message.ack();
+    if (!asyncFormatting) {
+      return this._complete(message);
+    }
+    this[kExecution].executeMessage = message;
+  } else {
+    message.ack();
+    const endRoutingKey = message.content?.endRoutingKey;
+    if (endRoutingKey) {
+      this._enrich(message.content);
+      pending.add(message);
+      return this._debug(`start formatting ${formatKey} message content with formatter ${routingKey}`);
+    }
+    if (asyncFormatting) {
+      const isError = this._popFormatStart(pending, routingKey).isError;
+      if (isError) {
+        return this._complete(message, true);
       }
+    }
+    this._enrich(message.content);
+    this._debug(`format ${message.fields.routingKey} message content with formatter ${routingKey}`);
+    if (executeMessage && !pending.size) {
+      this._complete(message);
+    }
   }
 };
 Formatter.prototype._complete = function complete(message, isError) {
@@ -109,7 +110,7 @@ Formatter.prototype._complete = function complete(message, isError) {
   }
   return callback(null, runMessage.content, formatted);
 };
-Formatter.prototype._decorate = function decorate(withContent) {
+Formatter.prototype._enrich = function enrich(withContent) {
   const content = this[kExecution].runMessage.content;
   for (const key in withContent) {
     switch (key) {
@@ -134,20 +135,19 @@ Formatter.prototype._decorate = function decorate(withContent) {
   }
 };
 Formatter.prototype._popFormatStart = function popFormattingStart(pending, routingKey) {
-  for (let idx = 0; idx < pending.length; idx++) {
-    const msg = pending[idx];
+  for (const msg of pending) {
     const {
       endRoutingKey,
       errorRoutingKey = '#.error'
     } = msg.content;
     if (endRoutingKey && (0, _smqp.getRoutingKeyPattern)(endRoutingKey).test(routingKey)) {
       this._debug(`completed formatting ${msg.fields.routingKey} message content with formatter ${routingKey}`);
-      pending.splice(idx, 1);
+      pending.delete(msg);
       return {
         message: msg
       };
     } else if ((0, _smqp.getRoutingKeyPattern)(errorRoutingKey).test(routingKey)) {
-      pending.splice(idx, 1);
+      pending.delete(msg);
       return {
         isError: true,
         message: msg

package/dist/activity/Activity.js

@@ -156,12 +156,7 @@ Object.defineProperties(Activity.prototype, {
     get() {
       let formatter = this[kFormatter];
       if (formatter) return formatter;
-      const broker = this.broker;
-      formatter = this[kFormatter] = new _MessageFormatter.Formatter({
-        id: this.id,
-        broker,
-        logger: this.logger
-      }, broker.getQueue('format-run-q'));
+      formatter = this[kFormatter] = new _MessageFormatter.Formatter(this);
       return formatter;
     }
   },
@@ -430,7 +425,13 @@ Activity.prototype._discardRun = function discardRun() {
   if (!status) return;
   const execution = this[kExec].get('execution');
   if (execution && !execution.completed) return;
+  let discardRoutingKey = 'run.discard';
   switch (status) {
+    case 'executed':
+      {
+        discardRoutingKey = 'run.discarded';
+        break;
+      }
     case 'end':
     case 'executing':
     case 'error':
@@ -442,7 +443,9 @@ Activity.prototype._discardRun = function discardRun() {
   if (this.extensions) this.extensions.deactivate((0, _messageHelper.cloneMessage)(stateMessage));
   const broker = this.broker;
   broker.getQueue('run-q').purge();
-  broker.publish('run', 'run.discard', (0, _messageHelper.cloneContent)(stateMessage.content));
+  broker.publish('run', discardRoutingKey, (0, _messageHelper.cloneContent)(stateMessage.content), {
+    correlationId: stateMessage.properties.correlationId
+  });
   this[kConsuming] = true;
   this._consumeRunQ();
 };
@@ -609,9 +612,11 @@ Activity.prototype._onRunMessage = function onRunMessage(routingKey, message, me
   const preStatus = this.status;
   this.status = 'formatting';
   return this.formatter.format(message, (err, formattedContent, formatted) => {
-    if (err) return this.emitFatal(err, message.content);
-    if (formatted) message.content = formattedContent;
     this.status = preStatus;
+    if (err) {
+      return this.emitFatal(err, message.content);
+    }
+    if (formatted) message.content = formattedContent;
     this._continueRunMessage(routingKey, message, messageProperties);
   });
 };

package/dist/getPropertyValue.js

@@ -3,12 +3,11 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = void 0;
+exports.default = getPropertyValue;
 const propertyPattern = /(\w+)\((.*?)(?:\))|(\.|\[|^)(.+?)(?:\]|\[|\.|$)/;
 const stringConstantPattern = /^(['"])(.*)\1$/;
 const numberConstantPattern = /^\W*-?\d+(.\d+)?\W*$/;
 const negativeIndexPattern = /^-\d+$/;
-var _default = exports.default = getPropertyValue;
 function getPropertyValue(inputContext, propertyPath, fnScope) {
   if (!inputContext) return;
   let resultValue;

package/dist/tasks/CallActivity.js

@@ -52,7 +52,11 @@ CallActivityBehaviour.prototype.execute = function execute(executeMessage) {
   });
   broker.subscribeTmp('api', '#.signal.*', (...args) => this._onDelegatedApiMessage(calledElement, executeMessage, ...args), {
     noAck: true,
-    consumerTag: `_api-delegated-${executionId}`
+    consumerTag: `_api-delegated-signal-${executionId}`
+  });
+  broker.subscribeTmp('api', '#.cancel.*', (...args) => this._onDelegatedApiMessage(calledElement, executeMessage, ...args), {
+    noAck: true,
+    consumerTag: `_api-delegated-cancel-${executionId}`
   });
   broker.publish('event', 'activity.call', (0, _messageHelper.cloneContent)(executeContent, {
     state: 'wait',
@@ -134,5 +138,6 @@ CallActivityBehaviour.prototype._onApiMessage = function onApiMessage(calledElem
 CallActivityBehaviour.prototype._stop = function stop(executionId) {
   const broker = this.broker;
   broker.cancel(`_api-${executionId}`);
-  broker.cancel(`_api-delegated-${executionId}`);
+  broker.cancel(`_api-delegated-signal-${executionId}`);
+  broker.cancel(`_api-delegated-cancel-${executionId}`);
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bpmn-elements",
-  "version": "16.2.1",
+  "version": "17.0.0",
   "description": "Executable workflow elements based on BPMN 2.0",
   "type": "module",
   "main": "./dist/index.js",
@@ -85,7 +85,7 @@
     "@babel/preset-env": "^7.24.4",
     "@babel/register": "^7.23.7",
     "@bonniernews/hot-bev": "^0.4.0",
-    "@types/node": "^16.18.95",
+    "@types/node": "^18.19.63",
     "bpmn-moddle": "^9.0.1",
     "c8": "^10.1.1",
     "camunda-bpmn-moddle": "^7.0.1",
@@ -95,15 +95,15 @@
     "eslint": "^9.0.0",
     "globals": "^15.0.0",
     "got": "^14.2.1",
-    "mocha": "^10.4.0",
+    "mocha": "^11.0.1",
     "mocha-cakes-2": "^3.3.0",
     "moddle-context-serializer": "^4.2.1",
-    "nock": "^13.5.3",
+    "nock": "^14.0.0",
     "prettier": "^3.2.5",
     "texample": "^0.0.6"
   },
   "dependencies": {
-    "@0dep/piso": "^2.2.0",
-    "smqp": "^9.0.2"
+    "@0dep/piso": "^2.4.0",
+    "smqp": "^9.0.6"
   }
 }

package/src/Api.js

@@ -1,25 +1,23 @@
 import { cloneMessage } from './messageHelper.js';
 import { getUniqueId } from './shared.js';
 
-export { ActivityApi, DefinitionApi, ProcessApi, FlowApi, Api };
-
-function ActivityApi(broker, apiMessage, environment) {
+export function ActivityApi(broker, apiMessage, environment) {
   return new Api('activity', broker, apiMessage, environment);
 }
 
-function DefinitionApi(broker, apiMessage, environment) {
+export function DefinitionApi(broker, apiMessage, environment) {
   return new Api('definition', broker, apiMessage, environment);
 }
 
-function ProcessApi(broker, apiMessage, environment) {
+export function ProcessApi(broker, apiMessage, environment) {
   return new Api('process', broker, apiMessage, environment);
 }
 
-function FlowApi(broker, apiMessage, environment) {
+export function FlowApi(broker, apiMessage, environment) {
   return new Api('flow', broker, apiMessage, environment);
 }
 
-function Api(pfx, broker, sourceMessage, environment) {
+export function Api(pfx, broker, sourceMessage, environment) {
   if (!sourceMessage) throw new Error('Api requires message');
 
   const apiMessage = cloneMessage(sourceMessage);
@@ -66,7 +64,7 @@ Api.prototype.resolveExpression = function resolveExpression(expression) {
       content: this.content,
       properties: this.messageProperties,
     },
-    this.owner,
+    this.owner
   );
 };
 

package/src/EventBroker.js

@@ -1,25 +1,23 @@
 import { Broker } from 'smqp';
 import { makeErrorFromMessage } from './error/Errors.js';
 
-export { ActivityBroker, DefinitionBroker, MessageFlowBroker, ProcessBroker, EventBroker };
-
-function ActivityBroker(activity) {
+export function ActivityBroker(activity) {
   const executionBroker = ExecutionBroker(activity, 'activity');
   return executionBroker;
 }
 
-function ProcessBroker(owner) {
+export function ProcessBroker(owner) {
   const executionBroker = ExecutionBroker(owner, 'process');
   executionBroker.broker.assertQueue('api-q', { durable: false, autoDelete: false });
   executionBroker.broker.bindQueue('api-q', 'api', '#');
   return executionBroker;
 }
 
-function DefinitionBroker(owner, onBrokerReturn) {
+export function DefinitionBroker(owner, onBrokerReturn) {
   return ExecutionBroker(owner, 'definition', onBrokerReturn);
 }
 
-function MessageFlowBroker(owner) {
+export function MessageFlowBroker(owner) {
   const eventBroker = new EventBroker(owner, { prefix: 'messageflow', autoDelete: false, durable: false });
   const broker = eventBroker.broker;
 
@@ -51,7 +49,7 @@ function ExecutionBroker(brokerOwner, prefix, onBrokerReturn) {
   return eventBroker;
 }
 
-function EventBroker(brokerOwner, options, onBrokerReturn) {
+export function EventBroker(brokerOwner, options, onBrokerReturn) {
   this.options = options;
   this.eventPrefix = options.prefix;
 

package/src/MessageFormatter.js

@@ -6,44 +6,43 @@ import { getRoutingKeyPattern } from 'smqp';
 const kOnMessage = Symbol.for('onMessage');
 const kExecution = Symbol.for('execution');
 
-export { Formatter };
+const EXEC_ROUTING_KEY = 'run._formatting.exec';
 
-function Formatter(element, formatQ) {
+/**
+ * Message formatter used to enrich an element run message before continuing to the next run message
+ * @param {import('types').ElementBase} element
+ */
+export function Formatter(element) {
   const { id, broker, logger } = element;
   this.id = id;
   this.broker = broker;
   this.logger = logger;
-  this.formatQ = formatQ;
   this[kOnMessage] = this._onMessage.bind(this);
 }
 
+/**
+ * Format message
+ * @param {import('types').ElementBrokerMessage} message
+ * @param {CallableFunction} callback
+ */
 Formatter.prototype.format = function format(message, callback) {
   const correlationId = (this._runId = getUniqueId(message.fields.routingKey));
   const consumerTag = '_formatter-' + correlationId;
-  const formatQ = this.formatQ;
-
-  formatQ.queueMessage(
-    {
-      routingKey: '_formatting.exec',
-    },
-    {},
-    {
-      correlationId,
-      persistent: false,
-    },
-  );
+  const broker = this.broker;
+
+  broker.publish('format', EXEC_ROUTING_KEY, {}, { correlationId, persistent: false });
 
   this[kExecution] = {
     correlationId,
     formatKey: message.fields.routingKey,
     runMessage: cloneMessage(message),
     callback,
-    pending: [],
+    pending: new Set(),
     formatted: false,
     executeMessage: null,
   };
 
-  formatQ.consume(this[kOnMessage], {
+  broker.consume('format-run-q', this[kOnMessage], {
     consumerTag,
     prefetch: 100,
   });
@@ -51,43 +50,40 @@ Formatter.prototype.format = function format(message, callback) {
 
 Formatter.prototype._onMessage = function onMessage(routingKey, message) {
   const { formatKey, correlationId, pending, executeMessage } = this[kExecution];
-  const asyncFormatting = pending.length;
-
-  switch (routingKey) {
-    case '_formatting.exec':
-      if (message.properties.correlationId !== correlationId) return message.ack();
-      if (!asyncFormatting) {
-        message.ack();
-        return this._complete(message);
-      }
-      this[kExecution].executeMessage = message;
-      break;
-    default: {
-      message.ack();
-
-      const endRoutingKey = message.content?.endRoutingKey;
-      if (endRoutingKey) {
-        this._decorate(message.content);
-        pending.push(message);
-        return this._debug(`start formatting ${formatKey} message content with formatter ${routingKey}`);
-      }
+  const asyncFormatting = pending.size;
 
-      if (asyncFormatting) {
-        const { isError, message: startMessage } = this._popFormatStart(pending, routingKey);
-        if (startMessage) startMessage.ack();
+  if (routingKey === EXEC_ROUTING_KEY) {
+    if (message.properties.correlationId !== correlationId) return message.ack();
+    message.ack();
+    if (!asyncFormatting) {
+      return this._complete(message);
+    }
+    this[kExecution].executeMessage = message;
+  } else {
+    message.ack();
 
-        if (isError) {
-          return this._complete(message, true);
-        }
-      }
+    const endRoutingKey = message.content?.endRoutingKey;
 
-      this._decorate(message.content);
-      this._debug(`format ${message.fields.routingKey} message content with formatter ${routingKey}`);
+    if (endRoutingKey) {
+      this._enrich(message.content);
+      pending.add(message);
+      return this._debug(`start formatting ${formatKey} message content with formatter ${routingKey}`);
+    }
 
-      if (executeMessage && asyncFormatting && !pending.length) {
-        this._complete(message);
+    if (asyncFormatting) {
+      const isError = this._popFormatStart(pending, routingKey).isError;
+
+      if (isError) {
+        return this._complete(message, true);
       }
     }
+
+    this._enrich(message.content);
+    this._debug(`format ${message.fields.routingKey} message content with formatter ${routingKey}`);
+
+    if (executeMessage && !pending.size) {
+      this._complete(message);
+    }
   }
 };
 
@@ -108,7 +104,7 @@ Formatter.prototype._complete = function complete(message, isError) {
   return callback(null, runMessage.content, formatted);
 };
 
-Formatter.prototype._decorate = function decorate(withContent) {
+Formatter.prototype._enrich = function enrich(withContent) {
   const content = this[kExecution].runMessage.content;
   for (const key in withContent) {
     switch (key) {
@@ -133,16 +129,14 @@ Formatter.prototype._decorate = function decorate(withContent) {
 };
 
 Formatter.prototype._popFormatStart = function popFormattingStart(pending, routingKey) {
-  for (let idx = 0; idx < pending.length; idx++) {
-    const msg = pending[idx];
+  for (const msg of pending) {
     const { endRoutingKey, errorRoutingKey = '#.error' } = msg.content;
-
     if (endRoutingKey && getRoutingKeyPattern(endRoutingKey).test(routingKey)) {
       this._debug(`completed formatting ${msg.fields.routingKey} message content with formatter ${routingKey}`);
-      pending.splice(idx, 1);
+      pending.delete(msg);
       return { message: msg };
     } else if (getRoutingKeyPattern(errorRoutingKey).test(routingKey)) {
-      pending.splice(idx, 1);
+      pending.delete(msg);
       return { isError: true, message: msg };
     }
   }

package/src/activity/Activity.js

@@ -143,15 +143,7 @@ Object.defineProperties(Activity.prototype, {
       let formatter = this[kFormatter];
       if (formatter) return formatter;
 
-      const broker = this.broker;
-      formatter = this[kFormatter] = new Formatter(
-        {
-          id: this.id,
-          broker,
-          logger: this.logger,
-        },
-        broker.getQueue('format-run-q'),
-      );
+      formatter = this[kFormatter] = new Formatter(this);
       return formatter;
     },
   },
@@ -430,7 +422,12 @@ Activity.prototype._discardRun = function discardRun() {
   const execution = this[kExec].get('execution');
   if (execution && !execution.completed) return;
 
+  let discardRoutingKey = 'run.discard';
   switch (status) {
+    case 'executed': {
+      discardRoutingKey = 'run.discarded';
+      break;
+    }
     case 'end':
     case 'executing':
     case 'error':
@@ -442,10 +439,11 @@ Activity.prototype._discardRun = function discardRun() {
 
   const stateMessage = this[kStateMessage];
   if (this.extensions) this.extensions.deactivate(cloneMessage(stateMessage));
+
   const broker = this.broker;
   broker.getQueue('run-q').purge();
 
-  broker.publish('run', 'run.discard', cloneContent(stateMessage.content));
+  broker.publish('run', discardRoutingKey, cloneContent(stateMessage.content), { correlationId: stateMessage.properties.correlationId });
   this[kConsuming] = true;
   this._consumeRunQ();
 };
@@ -602,10 +600,13 @@ Activity.prototype._onRunMessage = function onRunMessage(routingKey, message, me
 
   const preStatus = this.status;
   this.status = 'formatting';
+
   return this.formatter.format(message, (err, formattedContent, formatted) => {
-    if (err) return this.emitFatal(err, message.content);
-    if (formatted) message.content = formattedContent;
     this.status = preStatus;
+    if (err) {
+      return this.emitFatal(err, message.content);
+    }
+    if (formatted) message.content = formattedContent;
     this._continueRunMessage(routingKey, message, messageProperties);
   });
 };
@@ -700,7 +701,7 @@ Activity.prototype._continueRunMessage = function continueRunMessage(routingKey,
           ...content,
           error: isRedelivered ? makeErrorFromMessage(message) : content.error,
         },
-        { correlationId },
+        { correlationId }
       );
       break;
     }
@@ -819,7 +820,7 @@ Activity.prototype._doRunLeave = function doRunLeave(message, isDiscarded, onOut
       cloneContent(content, {
         ...(outbound.length && { outbound }),
       }),
-      { correlationId },
+      { correlationId }
     );
 
     onOutbound();
@@ -891,7 +892,7 @@ Activity.prototype._publishRunOutbound = function publishRunOutbound(outboundFlo
         sequenceId: getUniqueId(`${flowId}_${action}`),
         ...(discardSequence && { discardSequence: discardSequence.slice() }),
       },
-    }),
+    })
   );
 };
 

package/src/activity/ActivityExecution.js

@@ -306,7 +306,7 @@ ActivityExecution.prototype._onExecutionDiscarded = function onExecutionDiscarde
 ActivityExecution.prototype._publishExecutionCompleted = function publishExecutionCompleted(
   completionType,
   completeContent,
-  correlationId,
+  correlationId
 ) {
   this[kCompleted] = true;
 
@@ -317,7 +317,7 @@ ActivityExecution.prototype._publishExecutionCompleted = function publishExecuti
       ...completeContent,
       state: completionType,
     },
-    { type: completionType, correlationId },
+    { type: completionType, correlationId }
   );
 };
 

package/src/activity/outbound-evaluator.js

@@ -88,7 +88,7 @@ OutboundEvaluator.prototype.evaluateFlow = function evaluateFlow(flow) {
         result,
         evaluationId,
       }),
-      { persistent: false },
+      { persistent: false }
     );
   });
 };

package/src/definition/Definition.js

@@ -219,7 +219,7 @@ Definition.prototype._shakeProcess = function shakeProcess(shakeBp, startId) {
       {
         broker: this.broker,
         exchange: 'event',
-      },
+      }
     );
   }
 
@@ -404,7 +404,7 @@ Definition.prototype._onRunMessage = function onRunMessage(routingKey, message)
           ...content,
           error: fields.redelivered ? makeErrorFromMessage(message) : content.error,
         },
-        { mandatory: true },
+        { mandatory: true }
       );
       break;
     }