@onify/flow-extensions 4.0.0 → 4.1.0

package/CHANGELOG.md

@@ -1,6 +1,10 @@
 Changelog
 =========
 
+# 4.1.0
+
+- Support sequence flow properties and take execution listener. Requires `bpmn-elements >= 9.2`
+
 # 4.0.0
 
 - make sure sub-process extensions are only triggered once. Sub process activities unintentionally trigger formatting since events bubble

package/README.md

@@ -120,3 +120,92 @@ function getModdleContext(source, options) {
   return bpmnModdle.fromXML(Buffer.isBuffer(source) ? source.toString() : source.trim());
 }
 ```
+
+## Extend sequence flow with properties and take listeners
+
+```js
+const {OnifySequenceFlow, extensions} = require('@onify/flow-extensions');
+const FlowScripts = require('@onify/flow-extensions/dist/src/FlowScripts');
+const {Engine} = require('bpmn-engine');
+const Elements = require('bpmn-elements');
+
+const source = `
+<?xml version="1.0" encoding="UTF-8"?>
+<definitions
+  id="Def_0"
+  xmlns="http://www.omg.org/spec/BPMN/20100524/MODEL"
+  xmlns:camunda="http://camunda.org/schema/1.0/bpmn"
+  targetNamespace="http://bpmn.io/schema/bpmn">
+  <process id="Process_1kk79yr" isExecutable="true">
+    <startEvent id="start" />
+    <sequenceFlow id="to-script" sourceRef="start" targetRef="script">
+      <extensionElements>
+        <camunda:properties>
+          <camunda:property name="source" value="\${content.id}" />
+        </camunda:properties>
+        <camunda:executionListener event="take">
+          <camunda:script scriptFormat="js">environment.output.fields = listener.fields; next();</camunda:script>
+          <camunda:field name="taken">
+            <camunda:expression>\${true}</camunda:expression>
+          </camunda:field>
+          <camunda:field name="bar">
+            <camunda:string>baz</camunda:string>
+          </camunda:field>
+        </camunda:executionListener>
+      </extensionElements>
+    </sequenceFlow>
+    <sequenceFlow id="to-end" sourceRef="script" targetRef="end">
+      <extensionElements>
+        <camunda:properties>
+          <camunda:property name="foo" value="bar" />
+        </camunda:properties>
+      </extensionElements>
+    </sequenceFlow>
+    <scriptTask id="script" name="script" scriptFormat="js">
+      <script>next(null, { foo: environment.variables.required.input });</script>
+    </scriptTask>
+    <boundaryEvent id="catch-err" attachedToRef="script">
+      <errorEventDefinition />
+    </boundaryEvent>
+    <endEvent id="end-err">
+      <extensionElements>
+        <camunda:executionListener event="start">
+          <camunda:script scriptFormat="js">
+            environment.output.failedBy = content.inbound[0].properties.error;
+            if (next) next();
+          </camunda:script>
+        </camunda:executionListener>
+      </extensionElements>
+    </endEvent>
+    <sequenceFlow id="to-end-err" sourceRef="catch-err" targetRef="end-err">
+      <extensionElements>
+        <camunda:properties>
+          <camunda:property name="error" value="\${content.output}" />
+        </camunda:properties>
+      </extensionElements>
+    </sequenceFlow>
+    <endEvent id="end" />
+  </process>
+</definitions>`;
+
+const engine = new Engine({
+  name: 'sequence flow extension',
+  source,
+  moddleOptions: {
+    camunda: require('camunda-bpmn-moddle/resources/camunda.json'),
+  },
+  extensions: {
+    onify: extensions,
+  },
+  scripts: new FlowScripts('sequence flow extension'),
+  elements: {
+    ...Elements,
+    SequenceFlow: OnifySequenceFlow,
+  },
+});
+
+engine.execute((err, instance) => {
+  if (err) throw err;
+  console.log(instance.name, instance.environment.output);
+});
+```

package/dist/index.js

@@ -3,10 +3,17 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+Object.defineProperty(exports, "OnifySequenceFlow", {
+  enumerable: true,
+  get: function () {
+    return _OnifySequenceFlow.OnifySequenceFlow;
+  }
+});
 exports.extendFn = extendFn;
 exports.extensions = extensions;
 var _OnifyProcessExtensions = require("./src/OnifyProcessExtensions.js");
 var _OnifyElementExtensions = require("./src/OnifyElementExtensions.js");
+var _OnifySequenceFlow = require("./src/OnifySequenceFlow.js");
 function extensions(element, context) {
   if (element.type === 'bpmn:Process') return new _OnifyProcessExtensions.OnifyProcessExtensions(element, context);
   return new _OnifyElementExtensions.OnifyElementExtensions(element, context);

package/dist/src/ExecutionListeners.js

@@ -62,6 +62,8 @@ class ScriptListener extends Listener {
       id: this.id,
       resolveExpression
     });
+    const listenerFields = this._getFields(environment, scope);
+    if (listenerFields) scope.listener.fields = listenerFields;
     const script = this.environment.scripts.getScript(this.extension.scriptFormat, {
       id: this.id
     });
@@ -109,23 +111,27 @@ class ExecutionListeners {
     this.activity = activity;
     this.context = context;
     this.listeners = [];
-    this.onStart = false;
-    this.onEnd = false;
   }
   get length() {
     return this.listeners.length;
   }
+  get onStart() {
+    return this.listeners.some(l => l.event === 'start');
+  }
+  get onEnd() {
+    return this.listeners.some(l => l.event === 'end');
+  }
+  get onTake() {
+    return this.listeners.some(l => l.event === 'take');
+  }
   add(extension, pos) {
     const {
-      event,
       script,
       expression
     } = extension;
     if (!script && !expression) return;
     const list = this.listeners;
     if (script && (script.value || script.resource)) list.push(new ScriptListener(this.activity, this.context, extension, pos));else if (expression) list.push(new ExpressionListener(this.activity, this.context, extension));
-    if (event === 'start') this.onStart = true;
-    if (event === 'end') this.onEnd = true;
   }
   async execute(event, message) {
     const found = this.listeners.filter(l => l.event === event);

package/dist/src/FlowScripts.js

@@ -80,7 +80,7 @@ FlowScripts.prototype.register = function register({
         resource = behaviour.resource;
       }
   }
-  if (!language) language = 'javascript';
+  if (!language) return;
   if (!['js', 'javascript'].includes(language.toLowerCase().trim())) return;
   language = 'javascript';
   const name = this._name;

package/dist/src/OnifyElementExtensions.js

@@ -20,6 +20,7 @@ class OnifyElementExtensions {
     const activity = this.activity;
     const broker = activity.broker;
     const formatQ = activity.broker.getQueue('format-run-q');
+    const executionListeners = this.extensions.listeners;
     if (message.fields.redelivered && message.fields.routingKey === 'run.start') {
       activity.on('start', elementApi => {
         this._formatOnEnter(broker, formatQ, elementApi);
@@ -59,7 +60,6 @@ class OnifyElementExtensions {
     }, {
       consumerTag: '_onify-extension-on-executed'
     });
-    const executionListeners = this.extensions.listeners;
     if (executionListeners !== null && executionListeners !== void 0 && executionListeners.onStart) {
       activity.on('start', async elementApi => {
         if (activity.isSubProcess && activity.id !== elementApi.id) return;
@@ -211,11 +211,12 @@ class OnifyElementExtensions {
       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;
+    if (output !== undefined && output !== null) {
+      if (assignToOutput && typeof output === 'object') {
+        Object.assign(this.activity.environment.output, output);
+      } else if (resultVariable) {
+        elementApi.environment.output[resultVariable] = output;
+      }
     }
     return result;
   }

package/dist/src/OnifySequenceFlow.js

@@ -0,0 +1,52 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.OnifySequenceFlow = void 0;
+var _bpmnElements = require("bpmn-elements");
+var _getExtensions = require("./getExtensions.js");
+class OnifySequenceFlow extends _bpmnElements.SequenceFlow {
+  constructor(flowDef, context) {
+    super(flowDef, context);
+    this.extensions = (0, _getExtensions.getExtensions)(this, context);
+    this._activate();
+  }
+  _activate() {
+    var _this$extensions$list;
+    if (!((_this$extensions$list = this.extensions.listeners) !== null && _this$extensions$list !== void 0 && _this$extensions$list.onTake)) return;
+    this.broker.subscribeTmp('event', 'flow.take', (_, msg) => {
+      this._executeListeners(msg);
+    }, {
+      noAck: true,
+      consumerTag: '_onify-execution-listener'
+    });
+  }
+  async _executeListeners(message) {
+    try {
+      await this.extensions.listeners.execute('take', message);
+    } catch (err) {
+      this.logger.error(`<${this.id}> execution listener error: ${err}`);
+    }
+  }
+  evaluate(fromMessage, callback) {
+    const properties = this.extensions.properties;
+    if (!properties) return super.evaluate(fromMessage, callback);
+    super.evaluate(fromMessage, (err, result) => {
+      if (err) return callback(err);
+      try {
+        let overriddenResult = result ? {} : false;
+        if (result) {
+          overriddenResult = {
+            ...(typeof result === 'object' && result),
+            properties: properties.resolve(this.getApi(fromMessage))
+          };
+        }
+        return callback(err, overriddenResult);
+      } catch (formatErr) {
+        return callback(formatErr);
+      }
+    });
+  }
+}
+exports.OnifySequenceFlow = OnifySequenceFlow;

package/dist/src/getExtensions.js

@@ -14,39 +14,47 @@ var _ServiceExpression = _interopRequireDefault(require("./ServiceExpression.js"
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 function getExtensions(element, context) {
   var _element$behaviour$ex, _ext$values, _ext$fields;
-  const result = {
-    format: element.type === 'bpmn:Process' ? new _formatters.FormatProcess(element) : new _formatters.FormatActivity(element)
-  };
+  const result = {};
+  switch (element.type) {
+    case 'bpmn:SequenceFlow':
+      break;
+    case 'bpmn:Process':
+      result.format = new _formatters.FormatProcess(element);
+      break;
+    default:
+      result.format = new _formatters.FormatActivity(element);
+  }
+  let listenerPosition = 0;
+  const listeners = new _ExecutionListeners.default(element, context);
   const expression = element.behaviour.expression;
   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 {
-            connectorId,
-            inputOutput
-          } = ext;
-          const io = inputOutput && new _IO.InputOutput(`${element.id}/${ext.$type.toLowerCase()}`, inputOutput, context);
-          result.Service = _Connector.default.bind(_Connector.default, connectorId, io);
+  if (extensions) {
+    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 {
+              connectorId,
+              inputOutput
+            } = ext;
+            const io = inputOutput && new _IO.InputOutput(`${element.id}/${ext.$type.toLowerCase()}`, inputOutput, context);
+            result.Service = _Connector.default.bind(_Connector.default, connectorId, io);
+            break;
+          }
+        case 'camunda:ExecutionListener':
+          listeners.add(ext, listenerPosition++);
           break;
-        }
-      case 'camunda:ExecutionListener':
-        listeners.add(ext, listener++);
-        break;
+      }
     }
   }
   if (listeners.length) result.listeners = listeners;

package/index.js

@@ -1,9 +1,11 @@
 import {OnifyProcessExtensions} from './src/OnifyProcessExtensions.js';
 import {OnifyElementExtensions} from './src/OnifyElementExtensions.js';
+import {OnifySequenceFlow} from './src/OnifySequenceFlow.js';
 
 export {
   extensions,
   extendFn,
+  OnifySequenceFlow,
 };
 
 function extensions(element, context) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onify/flow-extensions",
-  "version": "4.0.0",
+  "version": "4.1.0",
   "description": "Onify Flow extensions",
   "module": "index.js",
   "main": "dist/index.js",
@@ -35,26 +35,26 @@
   "license": "MIT",
   "devDependencies": {
     "@aircall/expression-parser": "^1.0.4",
-    "@babel/cli": "^7.20.7",
-    "@babel/core": "^7.20.12",
-    "@babel/preset-env": "^7.20.2",
-    "@babel/register": "^7.18.9",
+    "@babel/cli": "^7.21.5",
+    "@babel/core": "^7.21.5",
+    "@babel/preset-env": "^7.21.5",
+    "@babel/register": "^7.21.0",
     "bpmn-elements-8-1": "npm:bpmn-elements@8.1",
-    "bpmn-engine": "^15.1.2",
+    "bpmn-engine": "^16.0.0",
     "bpmn-engine-14": "npm:bpmn-engine@14",
-    "bpmn-moddle": "^7.1.3",
-    "c8": "^7.12.0",
+    "bpmn-moddle": "^8.0.1",
+    "c8": "^7.13.0",
     "camunda-bpmn-moddle": "^7.0.1",
     "chai": "^4.3.7",
-    "chronokinesis": "^4.0.1",
+    "chronokinesis": "^5.0.2",
     "debug": "^4.3.4",
-    "eslint": "^8.32.0",
+    "eslint": "^8.39.0",
     "mocha": "^10.2.0",
     "mocha-cakes-2": "^3.3.0",
-    "moddle-context-serializer": "^3.1.1"
+    "moddle-context-serializer": "^3.2.2"
   },
   "dependencies": {
-    "cron-parser": "^4.7.1"
+    "cron-parser": "^4.8.1"
   },
   "files": [
     "src",

package/src/ExecutionListeners.js

@@ -49,6 +49,8 @@ class ScriptListener extends Listener {
   execute(api) {
     const environment = this.environment;
     const scope = this._getScope(api, {id: this.id, resolveExpression});
+    const listenerFields = this._getFields(environment, scope);
+    if (listenerFields) scope.listener.fields = listenerFields;
     const script = this.environment.scripts.getScript(this.extension.scriptFormat, {id: this.id});
 
     return new Promise((resolve, reject) => {
@@ -97,22 +99,26 @@ export default class ExecutionListeners {
     this.activity = activity;
     this.context = context;
     this.listeners = [];
-    this.onStart = false;
-    this.onEnd = false;
   }
   get length() {
     return this.listeners.length;
   }
+  get onStart() {
+    return this.listeners.some((l) => l.event === 'start');
+  }
+  get onEnd() {
+    return this.listeners.some((l) => l.event === 'end');
+  }
+  get onTake() {
+    return this.listeners.some((l) => l.event === 'take');
+  }
   add(extension, pos) {
-    const {event, script, expression} = extension;
+    const {script, expression} = extension;
     if (!script && !expression) return;
 
     const list = this.listeners;
     if (script && (script.value || script.resource)) list.push(new ScriptListener(this.activity, this.context, extension, pos));
     else if (expression) list.push(new ExpressionListener(this.activity, this.context, extension));
-
-    if (event === 'start') this.onStart = true;
-    if (event === 'end') this.onEnd = true;
   }
   async execute(event, message) {
     const found = this.listeners.filter((l) => l.event === event);

package/src/OnifyElementExtensions.js

@@ -13,6 +13,7 @@ export class OnifyElementExtensions {
     const activity = this.activity;
     const broker = activity.broker;
     const formatQ = activity.broker.getQueue('format-run-q');
+    const executionListeners = this.extensions.listeners;
 
     if (message.fields.redelivered && message.fields.routingKey === 'run.start') {
       activity.on('start', (elementApi) => {
@@ -38,7 +39,6 @@ export class OnifyElementExtensions {
       broker.publish('format', 'run.end.complete', {...format}, {persistent: false});
     }, {consumerTag: '_onify-extension-on-executed'});
 
-    const executionListeners = this.extensions.listeners;
     if (executionListeners?.onStart) {
       activity.on('start', async (elementApi) => {
         if (activity.isSubProcess && activity.id !== elementApi.id) return;
@@ -137,12 +137,12 @@ export class OnifyElementExtensions {
 
     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;
+    if (output !== undefined && output !== null) {
+      if (assignToOutput && typeof output === 'object') {
+        Object.assign(this.activity.environment.output, output);
+      } else if (resultVariable) {
+        elementApi.environment.output[resultVariable] = output;
+      }
     }
 
     return result;

package/src/OnifySequenceFlow.js

@@ -0,0 +1,45 @@
+import {SequenceFlow} from 'bpmn-elements';
+import {getExtensions} from './getExtensions.js';
+
+export class OnifySequenceFlow extends SequenceFlow {
+  constructor(flowDef, context) {
+    super(flowDef, context);
+    this.extensions = getExtensions(this, context);
+    this._activate();
+  }
+  _activate() {
+    if (!this.extensions.listeners?.onTake) return;
+
+    this.broker.subscribeTmp('event', 'flow.take', (_, msg) => {
+      this._executeListeners(msg);
+    }, {noAck: true, consumerTag: '_onify-execution-listener'});
+  }
+  async _executeListeners(message) {
+    try {
+      await this.extensions.listeners.execute('take', message);
+    } catch (err) {
+      this.logger.error(`<${this.id}> execution listener error: ${err}`);
+    }
+  }
+  evaluate(fromMessage, callback) {
+    const properties = this.extensions.properties;
+    if (!properties) return super.evaluate(fromMessage, callback);
+
+    super.evaluate(fromMessage, (err, result) => {
+      if (err) return callback(err);
+
+      try {
+        let overriddenResult = result ? {} : false;
+        if (result) {
+          overriddenResult = {
+            ...(typeof result === 'object' && result),
+            properties: properties.resolve(this.getApi(fromMessage)),
+          };
+        }
+        return callback(err, overriddenResult);
+      } catch (formatErr) {
+        return callback(formatErr);
+      }
+    });
+  }
+}

package/src/getExtensions.js

@@ -7,39 +7,47 @@ import IOProperties from './IOProperties.js';
 import ServiceExpression from './ServiceExpression.js';
 
 export function getExtensions(element, context) {
-  const result = {
-    format: element.type === 'bpmn:Process' ? new FormatProcess(element) : new FormatActivity(element),
-  };
+  const result = {};
+
+  switch (element.type) {
+    case 'bpmn:SequenceFlow':
+      break;
+    case 'bpmn:Process':
+      result.format = new FormatProcess(element);
+      break;
+    default:
+      result.format = new FormatActivity(element);
+  }
+
+  let listenerPosition = 0;
+  const listeners = new ExecutionListeners(element, context);
 
   const expression = element.behaviour.expression;
   if (expression) result.Service = ServiceExpression;
 
   const extensions = element.behaviour.extensionElements?.values;
-  if (!extensions) return result;
-
-  const listeners = new ExecutionListeners(element, context);
-
-  let listener = 0;
-  for (const ext of extensions) {
-    switch (ext.$type) {
-      case 'camunda:Properties':
-        if (ext.values?.length) result.properties = new IOProperties(element, ext);
-        break;
-      case 'camunda:InputOutput':
-        result.io = new InputOutput(element.id, ext, context);
-        break;
-      case 'camunda:FormData':
-        if (ext.fields?.length) result.form = new IOForm(element, ext);
-        break;
-      case 'camunda:Connector': {
-        const {connectorId, inputOutput} = ext;
-        const io = inputOutput && new InputOutput(`${element.id}/${ext.$type.toLowerCase()}`, inputOutput, context);
-        result.Service = Connector.bind(Connector, connectorId, io);
-        break;
+  if (extensions) {
+    for (const ext of extensions) {
+      switch (ext.$type) {
+        case 'camunda:Properties':
+          if (ext.values?.length) result.properties = new IOProperties(element, ext);
+          break;
+        case 'camunda:InputOutput':
+          result.io = new InputOutput(element.id, ext, context);
+          break;
+        case 'camunda:FormData':
+          if (ext.fields?.length) result.form = new IOForm(element, ext);
+          break;
+        case 'camunda:Connector': {
+          const {connectorId, inputOutput} = ext;
+          const io = inputOutput && new InputOutput(`${element.id}/${ext.$type.toLowerCase()}`, inputOutput, context);
+          result.Service = Connector.bind(Connector, connectorId, io);
+          break;
+        }
+        case 'camunda:ExecutionListener':
+          listeners.add(ext, listenerPosition++);
+          break;
       }
-      case 'camunda:ExecutionListener':
-        listeners.add(ext, listener++);
-        break;
     }
   }