@onify/flow-extensions 1.1.0 → 3.0.0

package/CHANGELOG.md

@@ -1,7 +1,17 @@
 Changelog
 =========
 
-# 1.0.1
+# 3.0.0
+
+- Support activity script and expression execution listeners
+- Remove default behaviour of saving activity output even if output is not declared. Output **was** saved to `environment.output._<Activity ID>` if no result variable or output was declared. The reason was that there was no easy way of getting output from SubProcess or a multi-instance task. Now SubProcess output can be defined and multi-instance output can be solved with execution listener
+
+# 2.0.0
+
+- fix resume extension when recovered mid formatting
+- drop node 12 support
+
+# 1.1.0
 
 - allow ISO8601 repeating interval and duration in timeCycle
 

package/dist/index.js

@@ -5,23 +5,15 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.extendFn = extendFn;
 exports.extensions = extensions;
-
 var _cronParser = _interopRequireDefault(require("cron-parser"));
-
-var _IOProperties = _interopRequireDefault(require("./src/IOProperties"));
-
-var _IOForm = _interopRequireDefault(require("./src/IOForm"));
-
-var _Connector = _interopRequireDefault(require("./src/Connector"));
-
-var _ServiceExpression = _interopRequireDefault(require("./src/ServiceExpression"));
-
-var _IO = require("./src/IO");
-
+var _IOProperties = _interopRequireDefault(require("./src/IOProperties.js"));
+var _IOForm = _interopRequireDefault(require("./src/IOForm.js"));
+var _Connector = _interopRequireDefault(require("./src/Connector.js"));
+var _ServiceExpression = _interopRequireDefault(require("./src/ServiceExpression.js"));
+var _IO = require("./src/IO.js");
+var _ExecutionListeners = _interopRequireDefault(require("./src/ExecutionListeners.js"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 const iso8601cycle = /^\s*(R\d+\/)?P\w+/i;
-
 class FormatError extends Error {
   constructor(elementId, err) {
     super(`<${elementId}> ${err.message}`);
@@ -30,33 +22,28 @@ class FormatError extends Error {
       statusCode: 500
     };
   }
-
 }
-
 function extensions(element, context) {
   if (element.type === 'bpmn:Process') return new OnifyProcessExtensions(element, context);
   return new OnifyElementExtensions(element, context);
 }
-
 class OnifyProcessExtensions {
   constructor(bp, context) {
     this.process = bp;
     this.context = context;
     this.extensions = getExtensions(bp, context);
-
     this._activate();
   }
-
   _activate() {
     const bp = this.process;
     bp.on('process.enter', elementApi => {
       try {
         const result = this._onEnter(elementApi);
-
         const environment = elementApi.environment;
         environment.assignVariables(result);
       } catch (err) {
-        elementApi.broker.publish('event', 'process.error', { ...elementApi.content,
+        elementApi.broker.publish('event', 'process.error', {
+          ...elementApi.content,
           error: new FormatError(bp.id, err)
         }, {
           mandatory: true,
@@ -67,7 +54,6 @@ class OnifyProcessExtensions {
       consumerTag: '_onify-extension-on-enter'
     });
   }
-
   _onEnter(elementApi) {
     const {
       format,
@@ -76,17 +62,13 @@ class OnifyProcessExtensions {
     const result = {};
     Object.assign(result, format.resolve(elementApi));
     Object.assign(elementApi.content, result);
-
     if (properties) {
       Object.assign(result, properties.resolve(elementApi));
       Object.assign(elementApi.content, result);
     }
-
     return result;
   }
-
 }
-
 class OnifyElementExtensions {
   constructor(activity, context) {
     this.activity = activity;
@@ -94,43 +76,28 @@ class OnifyElementExtensions {
     const {
       Service
     } = this.extensions = getExtensions(activity, context);
-
     if (Service) {
       activity.behaviour.Service = Service;
     }
   }
-
-  activate() {
+  activate(message) {
     const activity = this.activity;
     const broker = activity.broker;
     const formatQ = activity.broker.getQueue('format-run-q');
-    activity.on('enter', async elementApi => {
-      formatQ.queueMessage({
-        routingKey: 'run.enter.format'
-      }, {
-        endRoutingKey: 'run.enter.complete'
+    if (message.fields.redelivered && message.fields.routingKey === 'run.start') {
+      activity.on('start', elementApi => {
+        this._formatOnEnter(broker, formatQ, elementApi);
       }, {
-        persistent: false
+        consumerTag: '_onify-extension-on-enter'
       });
-
-      try {
-        var format = await this._onEnter(elementApi);
-      } catch (err) {
-        return broker.publish('format', 'run.enter.error', {
-          error: err
-        }, {
-          persistent: false
-        });
-      }
-
-      broker.publish('format', 'run.enter.complete', format, {
-        persistent: false
+    } else {
+      activity.on('enter', elementApi => {
+        this._formatOnEnter(broker, formatQ, elementApi);
+      }, {
+        consumerTag: '_onify-extension-on-enter'
       });
-    }, {
-      consumerTag: '_onify-extension-on-enter'
-    });
+    }
     activity.on('activity.execution.completed', async elementApi => {
-      if (elementApi.fields.redelivered) return;
       formatQ.queueMessage({
         routingKey: 'run.end.format'
       }, {
@@ -138,7 +105,6 @@ class OnifyElementExtensions {
       }, {
         persistent: false
       });
-
       try {
         var format = await this._onExecuted(elementApi);
       } catch (err) {
@@ -148,22 +114,98 @@ class OnifyElementExtensions {
           persistent: false
         });
       }
-
-      broker.publish('format', 'run.end.complete', { ...format
+      broker.publish('format', 'run.end.complete', {
+        ...format
       }, {
         persistent: false
       });
     }, {
       consumerTag: '_onify-extension-on-executed'
     });
+    const executionListeners = this.extensions.listeners;
+    if (executionListeners !== null && executionListeners !== void 0 && executionListeners.onStart) {
+      activity.on('start', async elementApi => {
+        formatQ.queueMessage({
+          routingKey: 'run.listener.start'
+        }, {
+          endRoutingKey: 'run.listener.start.complete'
+        }, {
+          persistent: false
+        });
+        try {
+          var format = await executionListeners.execute('start', elementApi);
+        } catch (err) {
+          return broker.publish('format', 'run.listener.start.error', {
+            error: err
+          }, {
+            persistent: false
+          });
+        }
+        broker.publish('format', 'run.listener.start.complete', {
+          ...format
+        }, {
+          persistent: false
+        });
+      }, {
+        consumerTag: '_onify-extension-on-listenerstart'
+      });
+    }
+    if (executionListeners !== null && executionListeners !== void 0 && executionListeners.onEnd) {
+      activity.on('end', async elementApi => {
+        formatQ.queueMessage({
+          routingKey: 'run.listener.end'
+        }, {
+          endRoutingKey: 'run.listener.end.complete'
+        }, {
+          persistent: false
+        });
+        try {
+          var format = await executionListeners.execute('end', elementApi);
+        } catch (err) {
+          return broker.publish('format', 'run.listener.end.error', {
+            error: err
+          }, {
+            persistent: false
+          });
+        }
+        broker.publish('format', 'run.listener.end.complete', {
+          ...format
+        }, {
+          persistent: false
+        });
+      }, {
+        consumerTag: '_onify-extension-on-listenerend'
+      });
+    }
   }
-
   deactivate() {
     const broker = this.activity.broker;
     broker.cancel('_onify-extension-on-enter');
     broker.cancel('_onify-extension-on-executed');
+    broker.cancel('_onify-extension-on-listenerstart');
+    broker.cancel('_onify-extension-on-listenerend');
+  }
+  async _formatOnEnter(broker, formatQ, elementApi) {
+    formatQ.queueMessage({
+      routingKey: 'run.enter.format'
+    }, {
+      endRoutingKey: 'run.enter.complete'
+    }, {
+      persistent: false
+    });
+    try {
+      var format = await this._onEnter(elementApi);
+    } catch (err) {
+      return broker.publish('format', 'run.enter.error', {
+        error: err
+      }, {
+        persistent: false
+      });
+    }
+    broker.publish('format', 'run.enter.complete', format, {
+      persistent: false
+    });
   }
-
   async _onEnter(elementApi) {
     const {
       format,
@@ -174,17 +216,14 @@ class OnifyElementExtensions {
     const result = {};
     Object.assign(result, format.resolve(elementApi));
     Object.assign(elementApi.content, result);
-
     if (properties) {
       Object.assign(result, {
         properties: properties.resolve(elementApi)
       });
       Object.assign(elementApi.content, result);
     }
-
     if (io) {
       var _io$input, _io$output;
-
       if ((_io$input = io.input) !== null && _io$input !== void 0 && _io$input.length) {
         const input = await io.getInput(this.activity, elementApi);
         Object.assign(result, {
@@ -192,28 +231,23 @@ class OnifyElementExtensions {
         });
         Object.assign(elementApi.content, result);
       }
-
       if ((_io$output = io.output) !== null && _io$output !== void 0 && _io$output.length) {
         result.assignToOutput = true;
       }
     }
-
     if (form) {
       Object.assign(result, {
         form: form.resolve(elementApi)
       });
     }
-
     return result;
   }
-
   async _onExecuted(elementApi) {
     const {
       properties,
       io
     } = this.extensions;
     const result = {};
-
     if (io !== null && io !== void 0 && io.output.length) {
       const output = await io.getOutput(this.activity, elementApi);
       Object.assign(result, {
@@ -223,7 +257,6 @@ class OnifyElementExtensions {
         output
       });
     }
-
     if (properties) {
       const props = properties.resolve(elementApi);
       Object.assign(result, {
@@ -233,28 +266,22 @@ class OnifyElementExtensions {
         properties: props
       });
     }
-
     const {
       output,
       assignToOutput,
       resultVariable
     } = elementApi.content;
     if (output === undefined || output === null) return result;
-
     if (assignToOutput && typeof output === 'object') {
       Object.assign(this.activity.environment.output, output);
     } else if (resultVariable) {
       elementApi.environment.output[resultVariable] = output;
     }
-
     return result;
   }
-
 }
-
 function getExtensions(element, context) {
   var _element$behaviour$ex, _ext$values, _ext$fields;
-
   const result = {
     format: element.type === 'bpmn:Process' ? new FormatProcess(element) : new FormatActivity(element)
   };
@@ -262,21 +289,19 @@ function getExtensions(element, context) {
   if (expression) result.Service = _ServiceExpression.default;
   const extensions = (_element$behaviour$ex = element.behaviour.extensionElements) === null || _element$behaviour$ex === void 0 ? void 0 : _element$behaviour$ex.values;
   if (!extensions) return result;
-
+  const listeners = new _ExecutionListeners.default(element, context);
+  let listener = 0;
   for (const ext of extensions) {
     switch (ext.$type) {
       case 'camunda:Properties':
         if ((_ext$values = ext.values) !== null && _ext$values !== void 0 && _ext$values.length) result.properties = new _IOProperties.default(element, ext);
         break;
-
       case 'camunda:InputOutput':
         result.io = new _IO.InputOutput(element.id, ext, context);
         break;
-
       case 'camunda:FormData':
         if ((_ext$fields = ext.fields) !== null && _ext$fields !== void 0 && _ext$fields.length) result.form = new _IOForm.default(element, ext);
         break;
-
       case 'camunda:Connector':
         {
           const {
@@ -287,18 +312,19 @@ function getExtensions(element, context) {
           result.Service = _Connector.default.bind(_Connector.default, connectorId, io);
           break;
         }
+      case 'camunda:ExecutionListener':
+        listeners.add(ext, listener++);
+        break;
     }
   }
-
+  if (listeners.length) result.listeners = listeners;
   return result;
 }
-
 class FormatActivity {
   constructor(activity) {
     this.activity = activity;
-    this.resultVariable = activity.behaviour.resultVariable || '_' + activity.id;
+    this.resultVariable = activity.behaviour.resultVariable;
     let timeCycles;
-
     if (activity.eventDefinitions) {
       for (const ed of activity.eventDefinitions.filter(e => e.type === 'bpmn:TimerEventDefinition')) {
         if (!('timeCycle' in ed)) continue;
@@ -306,13 +332,10 @@ class FormatActivity {
         timeCycles.push(ed.timeCycle);
       }
     }
-
     this.timeCycles = timeCycles;
   }
-
   resolve(elementApi) {
     var _documentation$, _user, _groups;
-
     let user, groups, assigneeValue, description;
     const activity = this.activity;
     const {
@@ -328,20 +351,18 @@ class FormatActivity {
     if (documentation) description = (_documentation$ = documentation[0]) === null || _documentation$ === void 0 ? void 0 : _documentation$.text;
     let expireAt;
     let timeCycles = this.timeCycles;
-
     if (timeCycles) {
       for (const cycle of timeCycles) {
         const cron = elementApi.resolveExpression(cycle);
         if (!cron || iso8601cycle.test(cron)) continue;
-
         const expireAtDt = _cronParser.default.parseExpression(cron).next().toDate();
-
         if (!expireAt || expireAtDt < expireAt) expireAt = expireAtDt;
       }
     }
-
     return {
-      resultVariable: this.resultVariable,
+      ...(this.resultVariable && {
+        resultVariable: this.resultVariable
+      }),
       ...(scheduledStart && activity.parent.type === 'bpmn:Process' && {
         scheduledStart
       }),
@@ -362,17 +383,13 @@ class FormatActivity {
       })
     };
   }
-
 }
-
 class FormatProcess {
   constructor(bp) {
     this.process = bp;
   }
-
   resolve(elementApi) {
     var _documentation$2, _user2, _groups2;
-
     let user, groups, description;
     const bp = this.process;
     const {
@@ -384,7 +401,6 @@ class FormatProcess {
     if (candidateStarterGroups) groups = resolveAndSplit(elementApi, candidateStarterGroups);
     if (documentation) description = (_documentation$2 = documentation[0]) === null || _documentation$2 === void 0 ? void 0 : _documentation$2.text;
     return {
-      resultVariable: this.resultVariable,
       ...(((_user2 = user) === null || _user2 === void 0 ? void 0 : _user2.length) && {
         candidateStarterUsers: user
       }),
@@ -396,9 +412,7 @@ class FormatProcess {
       })
     };
   }
-
 }
-
 function resolveAndSplit(elementApi, str) {
   if (Array.isArray(str)) return str.filter(Boolean);
   if (typeof str !== 'string') return;
@@ -407,10 +421,8 @@ function resolveAndSplit(elementApi, str) {
   if (typeof resolved !== 'string') return;
   return resolved.split(',').map(g => g.trim && g.trim().toLowerCase()).filter(Boolean);
 }
-
 function extendFn(behaviour, context) {
   var _behaviour$extensionE;
-
   if (behaviour.$type === 'bpmn:StartEvent' && behaviour.eventDefinitions) {
     const timer = behaviour.eventDefinitions.find(({
       type,
@@ -420,21 +432,28 @@ function extendFn(behaviour, context) {
       scheduledStart: timer.behaviour.timeCycle
     });
   }
-
   if (!Array.isArray((_behaviour$extensionE = behaviour.extensionElements) === null || _behaviour$extensionE === void 0 ? void 0 : _behaviour$extensionE.values)) return;
-  const inputOutput = behaviour.extensionElements.values.find(el => el.$type === 'camunda:InputOutput');
-  const connector = behaviour.extensionElements.values.find(el => el.$type === 'camunda:Connector');
-  if (inputOutput) registerIOScripts(behaviour.id, context, inputOutput.$type, inputOutput);
-  if (connector) registerIOScripts(behaviour.id, context, connector.$type, connector.inputOutput);
+  let listener = 0;
+  for (const extension of behaviour.extensionElements.values) {
+    switch (extension.$type) {
+      case 'camunda:InputOutput':
+        registerIOScripts(behaviour.id, context, extension.$type, extension);
+        break;
+      case 'camunda:Connector':
+        registerIOScripts(behaviour.id, context, extension.$type, extension.inputOutput);
+        break;
+      case 'camunda:ExecutionListener':
+        registerListenerScript(behaviour.id, context, extension.$type, extension, listener++);
+        break;
+    }
+  }
 }
-
 function registerIOScripts(parentId, context, type, ioBehaviour) {
   if (!ioBehaviour) return;
   const {
     inputParameters = [],
     outputParameters = []
   } = ioBehaviour;
-
   for (const {
     $type,
     name,
@@ -454,4 +473,22 @@ function registerIOScripts(parentId, context, type, ioBehaviour) {
       })
     });
   }
+}
+function registerListenerScript(parentId, context, type, listener, pos) {
+  const {
+    event,
+    script
+  } = listener;
+  if (!script) return;
+  const id = `${parentId}/${type}/${event}/${pos}`;
+  context.addScript(id, {
+    id,
+    scriptFormat: script.scriptFormat,
+    ...(script.value && {
+      body: script.value
+    }),
+    ...(script.resource && {
+      resource: script.resource
+    })
+  });
 }

package/dist/src/Connector.js

@@ -4,9 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = Connector;
-
 var _Errors = require("./Errors");
-
 function Connector(connectorId, io, activity, executionMessage) {
   if (!(this instanceof Connector)) return new Connector(connectorId, io, activity, executionMessage);
   this.connectorId = connectorId;
@@ -14,7 +12,6 @@ function Connector(connectorId, io, activity, executionMessage) {
   this.activity = activity;
   this.executionMessage = executionMessage;
 }
-
 Connector.prototype.execute = async function execute(...args) {
   const callback = args.pop();
   args.push(formatCallback);
@@ -25,20 +22,18 @@ Connector.prototype.execute = async function execute(...args) {
   const executionMessage = this.executionMessage;
   const serviceFunction = environment.services[connectorId];
   if (!serviceFunction) return callback(new _Errors.NotImplemented(connectorId));
-
   try {
     const input = io && (await io.getInput(activity, executionMessage));
     await serviceFunction.call(activity, input, ...args);
   } catch (err) {
     return callback(err);
   }
-
   async function formatCallback(serviceErr, result) {
     if (serviceErr) return callback(serviceErr);
     if (!(io !== null && io !== void 0 && io.output.length)) return callback(null, result);
-
     try {
-      const formattedResult = await io.getOutput(activity, { ...executionMessage,
+      const formattedResult = await io.getOutput(activity, {
+        ...executionMessage,
         ...result
       });
       return callback(null, formattedResult);

package/dist/src/Errors.js

@@ -4,7 +4,6 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.NotImplemented = void 0;
-
 class NotImplemented extends Error {
   constructor(serviceId) {
     super(`${serviceId} service function not found`);
@@ -13,7 +12,5 @@ class NotImplemented extends Error {
       statusCode: 501
     };
   }
-
 }
-
 exports.NotImplemented = NotImplemented;