bpmn-elements 8.0.1 → 8.2.0

package/CHANGELOG.md

@@ -1,6 +1,16 @@
 Changelog
 =========
 
+# 8.2.0
+
+- fix resume when activity has formatting status, extensions were not re-activated
+- fix InputOutputSpecification output now passed as dataOutput instead of dataInput, as it should
+- refactor Extensions loading, bpmn io is now pushed to the end of the extensions list
+
+# 8.1.0
+
+- support non-interrupting BoundaryEvent with ISO8601 repeating interval timeCycle
+
 # 8.0.1
 
 ## Fix

package/dist/src/Context.js

@@ -5,6 +5,8 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = Context;
 
+var _BpmnIO = _interopRequireDefault(require("./io/BpmnIO"));
+
 var _Environment = _interopRequireDefault(require("./Environment"));
 
 var _ExtensionsMapper = _interopRequireDefault(require("./ExtensionsMapper"));
@@ -31,7 +33,7 @@ function ContextInstance(definitionContext, environment) {
   this.sid = sid;
   this.definitionContext = definitionContext;
   this.environment = environment;
-  this.extensionsMapper = (0, _ExtensionsMapper.default)(this);
+  this.extensionsMapper = new _ExtensionsMapper.default(this);
   this.refs = {
     activityRefs: {},
     associationRefs: [],
@@ -204,5 +206,9 @@ proto.getStartActivities = function getStartActivities(filterOptions, scopeId) {
 };
 
 proto.loadExtensions = function loadExtensions(activity) {
-  return this.extensionsMapper.get(activity);
+  const io = new _BpmnIO.default(activity, this);
+  const extensions = this.extensionsMapper.get(activity);
+  if (io.hasIo) extensions.extensions.push(io);
+  if (!extensions.extensions.length) return;
+  return extensions;
 };

package/dist/src/ExtensionsMapper.js

@@ -4,50 +4,50 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = ExtensionsMapper;
+const kActivated = Symbol.for('activated');
 
 function ExtensionsMapper(context) {
-  const {
-    extensions: envExtensions
-  } = context.environment;
-  const extensions = getExtensions();
-  return {
-    get
-  };
-
-  function get(activity) {
-    const activityExtensions = extensions.reduce(applyExtension, []);
-    return {
-      activate,
-      deactivate
-    };
-
-    function applyExtension(result, Extension) {
-      const extension = Extension(activity, context);
-      if (extension) result.push(extension);
-      return result;
-    }
-
-    function activate(message) {
-      for (const extension of activityExtensions) extension.activate(message);
-    }
-
-    function deactivate(message) {
-      for (const extension of activityExtensions) extension.deactivate(message);
-    }
-  }
+  this.context = context;
+}
 
-  function getExtensions() {
-    const result = [];
-    if (!envExtensions) return result;
+ExtensionsMapper.prototype.get = function get(activity) {
+  return new Extensions(activity, this.context, this._getExtensions());
+};
 
-    for (const key in envExtensions) {
-      const extension = envExtensions[key];
+ExtensionsMapper.prototype._getExtensions = function getExtensions() {
+  let extensions;
+  if (!(extensions = this.context.environment.extensions)) return [];
+  return Object.values(extensions);
+};
 
-      if (extension) {
-        result.push(extension);
-      }
-    }
+function Extensions(activity, context, extensions) {
+  const result = this.extensions = [];
 
-    return result;
+  for (const Extension of extensions) {
+    const extension = Extension(activity, context);
+    if (extension) result.push(extension);
   }
-}
+
+  this[kActivated] = false;
+}
+
+Object.defineProperty(Extensions.prototype, 'count', {
+  get() {
+    return this.extensions.length;
+  }
+
+});
+
+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/dist/src/activity/Activity.js

@@ -7,8 +7,6 @@ exports.default = void 0;
 
 var _ActivityExecution = _interopRequireDefault(require("./ActivityExecution"));
 
-var _BpmnIO = _interopRequireDefault(require("../io/BpmnIO"));
-
 var _shared = require("../shared");
 
 var _Api = require("../Api");
@@ -24,7 +22,6 @@ var _Errors = require("../error/Errors");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 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');
@@ -145,6 +142,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;
@@ -173,23 +171,20 @@ 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.default(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');
   }
 
 });
@@ -485,10 +480,11 @@ proto._discardRun = function discardRun() {
 
   this._deactivateRunConsumers();
 
-  if (this.extensions) this.extensions.deactivate();
+  const message = this[kStateMessage];
+  if (this.extensions) this.extensions.deactivate((0, _messageHelper.cloneMessage)(message));
   const broker = this.broker;
   broker.getQueue('run-q').purge();
-  broker.publish('run', 'run.discard', (0, _messageHelper.cloneContent)(this[kStateMessage].content));
+  broker.publish('run', 'run.discard', (0, _messageHelper.cloneContent)(message.content));
 
   this._consumeRunQ();
 };
@@ -543,6 +539,7 @@ proto._onInbound = function onInbound(routingKey, message) {
   switch (routingKey) {
     case 'association.take':
     case 'flow.take':
+    case 'activity.restart':
     case 'activity.enter':
       return this.run({
         message: content.message,
@@ -719,13 +716,13 @@ proto._continueRunMessage = function continueRunMessage(routingKey, message) {
 
         if (!isRedelivered) {
           this[kExec].execution = null;
+          if (this.extensions) this.extensions.activate((0, _messageHelper.cloneMessage)(message));
+
+          this._publishEvent('enter', content, {
+            correlationId
+          });
         }
 
-        if (this.extensions) this.extensions.activate((0, _messageHelper.cloneMessage)(message), this);
-        if (this.bpmnIo) this.bpmnIo.activate(message);
-        if (!isRedelivered) this._publishEvent('enter', content, {
-          correlationId
-        });
         break;
       }
 
@@ -734,8 +731,7 @@ proto._continueRunMessage = function continueRunMessage(routingKey, message) {
         this.logger.debug(`<${id}> discard`, isRedelivered ? 'redelivered' : '');
         this.status = 'discard';
         this[kExec].execution = null;
-        if (this.extensions) this.extensions.activate((0, _messageHelper.cloneMessage)(message), this);
-        if (this.bpmnIo) this.bpmnIo.activate(message);
+        if (this.extensions) this.extensions.activate((0, _messageHelper.cloneMessage)(message));
 
         if (!isRedelivered) {
           this.broker.publish('run', 'run.discarded', content, {
@@ -780,28 +776,20 @@ proto._continueRunMessage = function continueRunMessage(routingKey, message) {
       {
         this.status = 'executing';
         this[kExecuteMessage] = message;
+        const exec = this[kExec];
+        if (isRedelivered && this.extensions) this.extensions.activate((0, _messageHelper.cloneMessage)(message));
+        if (!exec.execution) exec.execution = new _ActivityExecution.default(this, this.context);
         this.broker.getQueue('execution-q').assertConsumer(this[kMessageHandlers].onExecutionMessage, {
           exclusive: true,
           consumerTag: '_activity-execution'
         });
-        const exec = this[kExec];
-        if (!exec.execution) exec.execution = new _ActivityExecution.default(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);
-          });
-        }
-
         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++;
         this.status = 'end';
         return this._doRunLeave(message, false, () => {
@@ -859,8 +847,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((0, _messageHelper.cloneMessage)(message));
 
         if (!isRedelivered) {
           this.broker.publish('run', 'run.next', content, {
@@ -976,9 +963,9 @@ proto._doRunLeave = function doRunLeave(message, isDiscarded, onOutbound) {
       });
     }
 
-    this.broker.publish('run', 'run.leave', (0, _messageHelper.cloneContent)(content, { ...(outbound.length ? {
+    this.broker.publish('run', 'run.leave', (0, _messageHelper.cloneContent)(content, { ...(outbound.length && {
         outbound
-      } : undefined)
+      })
     }), {
       correlationId
     });
@@ -1030,9 +1017,9 @@ proto._doRunOutbound = function doRunOutbound(outboundList, content, discardSequ
     this.broker.publish('run', 'run.outbound.' + action, (0, _messageHelper.cloneContent)(content, {
       flow: { ...outboundFlow,
         sequenceId: (0, _shared.getUniqueId)(`${flowId}_${action}`),
-        ...(discardSequence ? {
+        ...(discardSequence && {
           discardSequence: discardSequence.slice()
-        } : undefined)
+        })
       }
     }));
   }
@@ -1043,9 +1030,8 @@ proto._doRunOutbound = function doRunOutbound(outboundList, content, discardSequ
 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':
@@ -1059,7 +1045,7 @@ proto._onResumeMessage = function onResumeMessage(message) {
       return;
   }
 
-  if (!fields.redelivered) return;
+  if (this.extensions) this.extensions.activate((0, _messageHelper.cloneMessage)(stateMessage));
   this.logger.debug(`<${this.id}> resume from ${message.content.status}`);
   return this.broker.publish('run', fields.routingKey, (0, _messageHelper.cloneContent)(stateMessage.content), stateMessage.properties);
 };
@@ -1086,7 +1072,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(message ? (0, _messageHelper.cloneMessage)(message) : this._createMessage());
 
     this._publishEvent('stop', this._createMessage());
   }
@@ -1130,15 +1116,15 @@ proto._createMessage = function createMessage(override) {
   const result = { ...override,
     id: this.id,
     type: this.type,
-    ...(name ? {
+    ...(name && {
       name
-    } : undefined),
-    ...(status ? {
+    }),
+    ...(status && {
       status
-    } : undefined),
-    ...(parent ? {
+    }),
+    ...(parent && {
       parent: (0, _messageHelper.cloneParent)(parent)
-    } : undefined)
+    })
   };
 
   for (const [flag, value] of Object.entries(this[kFlags])) {
@@ -1152,19 +1138,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((0, _messageHelper.cloneMessage)(message), this);
-  if (bpmnIo) bpmnIo.activate((0, _messageHelper.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');
@@ -1315,9 +1288,9 @@ OutboundEvaluator.prototype.completed = function completed(err) {
 
   for (const flow of Object.values(result)) {
     evaluationResult.push({ ...flow,
-      ...(message !== undefined ? {
+      ...(message !== undefined && {
         message
-      } : undefined)
+      })
     });
   }
 
@@ -1328,8 +1301,8 @@ function formatFlowAction(flow, options) {
   return { ...options,
     id: flow.id,
     action: options.action,
-    ...(flow.isDefault ? {
+    ...(flow.isDefault && {
       isDefault: true
-    } : undefined)
+    })
   };
 }

package/dist/src/activity/ActivityExecution.js

@@ -414,9 +414,9 @@ proto._debug = function debug(logMessage, executionId) {
 };
 
 function getExecuteMessage(message) {
-  const result = (0, _messageHelper.cloneMessage)(message, { ...(message.fields.redelivered ? {
+  const result = (0, _messageHelper.cloneMessage)(message, { ...(message.fields.redelivered && {
       isRecovered: true
-    } : undefined),
+    }),
     ignoreIfExecuting: undefined
   });
   return result;

package/dist/src/activity/Message.js

@@ -30,9 +30,9 @@ function Message(messageDef, context) {
       id,
       type,
       messageType: 'message',
-      ...(name ? {
+      ...(name && {
         name: environment.resolveExpression(name, executionMessage)
-      } : undefined),
+      }),
       parent: { ...parent
       }
     };

package/dist/src/activity/Signal.js

@@ -30,9 +30,9 @@ function Signal(signalDef, context) {
       id,
       type,
       messageType: 'signal',
-      ...(name ? {
+      ...(name && {
         name: environment.resolveExpression(name, executionMessage)
-      } : undefined),
+      }),
       parent: { ...parent
       }
     };

package/dist/src/eventDefinitions/TimerEventDefinition.js

@@ -12,6 +12,7 @@ var _iso8601Duration = require("iso8601-duration");
 const kStopped = Symbol.for('stopped');
 const kTimerContent = Symbol.for('timerContent');
 const kTimer = Symbol.for('timer');
+const repeatPattern = /^\s*R(\d+)\//;
 
 function TimerEventDefinition(activity, eventDefinition) {
   const type = this.type = eventDefinition.type || 'TimerEventDefinition';
@@ -77,9 +78,9 @@ proto.execute = function execute(executeMessage) {
   const resolvedTimer = this._getTimers(executeMessage);
 
   const timerContent = this[kTimerContent] = (0, _messageHelper.cloneContent)(content, { ...resolvedTimer,
-    ...(isResumed ? {
+    ...(isResumed && {
       isResumed
-    } : undefined),
+    }),
     startedAt,
     state: 'timer'
   });
@@ -129,6 +130,14 @@ proto._completed = function completed(completeContent, options) {
   };
   const broker = this.broker;
   broker.publish('event', 'activity.timeout', (0, _messageHelper.cloneContent)(timerContent, content), options);
+
+  if (timerContent.repeat > 1) {
+    const repeat = timerContent.repeat - 1;
+    broker.publish('execution', 'execute.repeat', (0, _messageHelper.cloneContent)(timerContent, { ...content,
+      repeat
+    }), options);
+  }
+
   broker.publish('execution', 'execute.completed', (0, _messageHelper.cloneContent)(timerContent, content), options);
 };
 
@@ -171,9 +180,9 @@ proto._onApiMessage = function onApiMessage(routingKey, message) {
 
         return this._completed({
           state: 'cancel',
-          ...(message.content.message ? {
+          ...(message.content.message && {
             message: message.content.message
-          } : undefined)
+          })
         }, {
           correlationId
         });
@@ -213,39 +222,48 @@ proto._stop = function stop() {
 proto._getTimers = function getTimers(executeMessage) {
   const content = executeMessage.content;
   const now = Date.now();
-  const result = { ...('expireAt' in content ? {
+  const result = { ...('expireAt' in content && {
       expireAt: new Date(content.expireAt)
-    } : undefined)
+    })
   };
 
   for (const t of ['timeDuration', 'timeDate', 'timeCycle']) {
     if (t in content) result[t] = content[t];else if (t in this) result[t] = this.environment.resolveExpression(this[t], executeMessage);else continue;
-    let expireAtDate;
-
-    if (t === 'timeDuration') {
-      const durationStr = result[t];
-
-      if (durationStr) {
-        const delay = this._getDurationInMilliseconds(durationStr);
-
-        if (delay !== undefined) expireAtDate = new Date(now + delay);
-      } else {
-        expireAtDate = new Date(now);
-      }
-    } else if (t === 'timeDate') {
-      const dateStr = result[t];
-
-      if (dateStr) {
-        const ms = Date.parse(dateStr);
-
-        if (!isNaN(ms)) {
-          expireAtDate = new Date(ms);
-        } else {
-          this._warn(`invalid timeDate >${dateStr}<`);
-        }
-      } else {
-        expireAtDate = new Date(now);
+    let expireAtDate, repeat;
+    const timerStr = result[t];
+
+    if (timerStr) {
+      switch (t) {
+        case 'timeCycle':
+          {
+            const mRepeat = timerStr.match(repeatPattern);
+            if (mRepeat && mRepeat.length) repeat = parseInt(mRepeat[1]);
+          }
+
+        case 'timeDuration':
+          {
+            const delay = this._getDurationInMilliseconds(timerStr);
+
+            if (delay !== undefined) expireAtDate = new Date(now + delay);
+            break;
+          }
+
+        case 'timeDate':
+          {
+            const dateStr = result[t];
+            const ms = Date.parse(dateStr);
+
+            if (!isNaN(ms)) {
+              expireAtDate = new Date(ms);
+            } else {
+              this._warn(`invalid timeDate >${dateStr}<`);
+            }
+
+            break;
+          }
       }
+    } else {
+      expireAtDate = new Date(now);
     }
 
     if (!expireAtDate) continue;
@@ -253,6 +271,7 @@ proto._getTimers = function getTimers(executeMessage) {
     if (!('expireAt' in result) || result.expireAt > expireAtDate) {
       result.timerType = t;
       result.expireAt = expireAtDate;
+      if (repeat) result.repeat = repeat;
     }
   }
 
@@ -264,6 +283,10 @@ proto._getTimers = function getTimers(executeMessage) {
     result.timeout = 0;
   }
 
+  if (content.inbound && 'repeat' in content.inbound[0]) {
+    result.repeat = content.inbound[0].repeat;
+  }
+
   return result;
 };
 
@@ -271,7 +294,7 @@ proto._getDurationInMilliseconds = function getDurationInMilliseconds(duration)
   try {
     return (0, _iso8601Duration.toSeconds)((0, _iso8601Duration.parse)(duration)) * 1000;
   } catch (err) {
-    this._warn(`failed to parse timeDuration >${duration}<: ${err.message}`);
+    this._warn(`failed to parse ${this.timerType} >${duration}<: ${err.message}`);
   }
 };