@onify/flow-extensions 1.1.0 → 3.0.0

package/index.js

@@ -1,9 +1,10 @@
 import cronParser from 'cron-parser';
-import IOProperties from './src/IOProperties';
-import IOForm from './src/IOForm';
-import Connector from './src/Connector';
-import ServiceExpression from './src/ServiceExpression';
-import {InputOutput} from './src/IO';
+import IOProperties from './src/IOProperties.js';
+import IOForm from './src/IOForm.js';
+import Connector from './src/Connector.js';
+import ServiceExpression from './src/ServiceExpression.js';
+import {InputOutput} from './src/IO.js';
+import ExtensionListeners from './src/ExecutionListeners.js';
 
 const iso8601cycle = /^\s*(R\d+\/)?P\w+/i;
 
@@ -72,26 +73,22 @@ class OnifyElementExtensions {
       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'}, {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});
-    }, {consumerTag: '_onify-extension-on-enter'});
+    if (message.fields.redelivered && message.fields.routingKey === 'run.start') {
+      activity.on('start', (elementApi) => {
+        this._formatOnEnter(broker, formatQ, elementApi);
+      }, {consumerTag: '_onify-extension-on-enter'});
+    } else {
+      activity.on('enter', (elementApi) => {
+        this._formatOnEnter(broker, formatQ, elementApi);
+      }, {consumerTag: '_onify-extension-on-enter'});
+    }
 
     activity.on('activity.execution.completed', async (elementApi) => {
-      if (elementApi.fields.redelivered) return;
-
       formatQ.queueMessage({routingKey: 'run.end.format'}, {endRoutingKey: 'run.end.complete'}, {persistent: false});
 
       try {
@@ -102,11 +99,52 @@ 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) => {
+        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?.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, properties, io, form} = this.extensions;
@@ -178,7 +216,9 @@ function getExtensions(element, context) {
   const extensions = element.behaviour.extensionElements?.values;
   if (!extensions) return result;
 
+  const listeners = new ExtensionListeners(element, context);
 
+  let listener = 0;
   for (const ext of extensions) {
     switch (ext.$type) {
       case 'camunda:Properties':
@@ -196,16 +236,21 @@ function getExtensions(element, context) {
         result.Service = Connector.bind(Connector, 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) {
@@ -246,7 +291,7 @@ class FormatActivity {
     }
 
     return {
-      resultVariable: this.resultVariable,
+      ...(this.resultVariable && {resultVariable: this.resultVariable}),
       ...(scheduledStart && activity.parent.type === 'bpmn:Process' && {scheduledStart}),
       ...(user?.length && {candidateUsers: user}),
       ...(groups?.length && {candidateGroups: groups}),
@@ -270,13 +315,11 @@ class FormatProcess {
       candidateStarterGroups,
     } = bp.behaviour;
 
-
     if (candidateStarterUsers) user = resolveAndSplit(elementApi, candidateStarterUsers);
     if (candidateStarterGroups) groups = resolveAndSplit(elementApi, candidateStarterGroups);
     if (documentation) description = documentation[0]?.text;
 
     return {
-      resultVariable: this.resultVariable,
       ...(user?.length && {candidateStarterUsers: user}),
       ...(groups?.length && {candidateStarterGroups: groups}),
       ...(!elementApi.content.description && description && {description: elementApi.resolveExpression(description)}),
@@ -306,11 +349,20 @@ function extendFn(behaviour, context) {
 
   if (!Array.isArray(behaviour.extensionElements?.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) {
@@ -331,3 +383,16 @@ 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onify/flow-extensions",
-  "version": "1.1.0",
+  "version": "3.0.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.18.6",
-    "@babel/core": "^7.18.6",
-    "@babel/preset-env": "^7.18.6",
-    "@babel/register": "^7.18.6",
-    "bpmn-elements": "^8.1.0",
-    "bpmn-engine": "^14.1.0",
-    "bpmn-moddle": "^7.1.2",
-    "c8": "^7.11.3",
-    "camunda-bpmn-moddle": "^6.1.2",
-    "chai": "^4.3.6",
+    "@babel/cli": "^7.19.3",
+    "@babel/core": "^7.20.2",
+    "@babel/preset-env": "^7.20.2",
+    "@babel/register": "^7.18.9",
+    "bpmn-elements-8-1": "npm:bpmn-elements@8.1",
+    "bpmn-engine": "^15.1.2",
+    "bpmn-engine-14": "npm:bpmn-engine@14",
+    "bpmn-moddle": "^7.1.3",
+    "c8": "^7.12.0",
+    "camunda-bpmn-moddle": "^7.0.1",
+    "chai": "^4.3.7",
     "chronokinesis": "^3.1.2",
     "debug": "^4.3.4",
-    "eslint": "^7.32.0",
-    "mocha": "^10.0.0",
+    "eslint": "^8.28.0",
+    "mocha": "^10.1.0",
     "mocha-cakes-2": "^3.3.0",
-    "moddle-context-serializer": "^2.1.0",
-    "nock": "^13.2.8"
+    "moddle-context-serializer": "^2.1.0"
   },
   "dependencies": {
-    "cron-parser": "^4.5.0"
+    "cron-parser": "^4.7.0"
   },
   "files": [
     "src",

package/src/ExecutionListeners.js

@@ -0,0 +1,126 @@
+class Listener {
+  constructor(activity, context, extension) {
+    this.activity = activity;
+    this.environment = this.activity.environment;
+    this.context = context;
+    this.extension = extension;
+    this.type = extension.$type;
+    this.event = extension.event;
+  }
+  _getScope(message, extend) {
+    const environment = this.environment;
+
+    const {fields, content, properties} = message;
+    const scope = {
+      ...extend,
+      type: this.type,
+      listener: {
+        event: this.event,
+      },
+      fields,
+      content,
+      properties,
+      environment,
+      logger: this.activity.logger,
+    };
+
+    const listenerFields = this._getFields(environment, scope);
+    if (listenerFields) scope.listener.fields = listenerFields;
+
+    return scope;
+  }
+  _getFields(environment, scope) {
+    const fields = this.extension.fields;
+    if (!fields?.length) return;
+    const result = {};
+    for (const {name, expression, string} of fields) {
+      result['' + name] = expression ? environment.resolveExpression(expression, scope) : string;
+    }
+    return result;
+  }
+}
+
+class ScriptListener extends Listener {
+  constructor(activity, context, extension, pos) {
+    super(activity, context, extension);
+    const id = this.id = `${activity.id}/${extension.script.$type}/${this.event}/${pos}`;
+    this._register(context, id, extension.script);
+  }
+  execute(api) {
+    const environment = this.environment;
+    const scope = this._getScope(api, {id: this.id, resolveExpression});
+    const script = this.environment.scripts.getScript(this.extension.scriptFormat, {id: this.id});
+
+    return new Promise((resolve, reject) => {
+      return script.execute(scope, (err, result) => {
+        if (err) return reject(err);
+        resolve(result);
+      });
+    });
+
+    function resolveExpression(expression) {
+      return environment.resolveExpression(expression, scope);
+    }
+  }
+  _register(context, id, script) {
+    const {
+      scriptFormat,
+      value,
+      resource
+    } = script;
+
+    context.environment.scripts.register({
+      id,
+      type: this.type,
+      behaviour: {
+        scriptFormat,
+        ...(value && {
+          script: value
+        }),
+        ...(resource && {
+          resource
+        })
+      }
+    });
+  }
+}
+
+class ExpressionListener extends Listener {
+  execute(message) {
+    const scope = this._getScope(message);
+    return {expression: this.environment.resolveExpression(this.extension.expression, scope)};
+  }
+}
+
+export default class ExecutionListeners {
+  constructor(activity, context) {
+    this.activity = activity;
+    this.context = context;
+    this.listeners = [];
+    this.onStart = false;
+    this.onEnd = false;
+  }
+  get length() {
+    return this.listeners.length;
+  }
+  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);
+    const format = {};
+    for (const f of found) {
+      const result = await f.execute(message);
+      if (result !== null && typeof result === 'object') Object.assign(format, result);
+    }
+    return format;
+  }
+}

package/src/IO.js

@@ -153,7 +153,7 @@ class IOScript extends IOBase {
 
     const {fields, content, properties, ...rest} = executionMessage;
     const scope = {
-      id: this.scriptId,
+      id: this.id,
       type: this.type,
       name,
       fields,