@onify/flow-extensions 2.0.0 → 4.0.0

package/CHANGELOG.md

@@ -0,0 +1,38 @@
+Changelog
+=========
+
+# 4.0.0
+
+- make sure sub-process extensions are only triggered once. Sub process activities unintentionally trigger formatting since events bubble
+- add script element type to registered scripts
+- restructure and split up index.js to separate files
+- abide to new lint rules
+
+# 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
+
+# 1.0.0
+
+- proper routing keys for end formatting
+
+# 0.1.0
+
+- catch errors when resolving service expression
+- test with bpmn-engine@14
+
+# 0.0.2
+
+- allow expressions in timeCycle
+- test with bpmn-engine@13
+- error message changed in node 16

package/dist/index.js

@@ -5,354 +5,14 @@ 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");
-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}`);
-    this.code = 'EFLOW_FORMAT';
-    this.output = {
-      statusCode: 500
-    };
-  }
-}
+var _OnifyProcessExtensions = require("./src/OnifyProcessExtensions.js");
+var _OnifyElementExtensions = require("./src/OnifyElementExtensions.js");
 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,
-          error: new FormatError(bp.id, err)
-        }, {
-          mandatory: true,
-          type: 'error'
-        });
-      }
-    }, {
-      consumerTag: '_onify-extension-on-enter'
-    });
-  }
-  _onEnter(elementApi) {
-    const {
-      format,
-      properties
-    } = this.extensions;
-    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;
-    this.context = context;
-    const {
-      Service
-    } = this.extensions = getExtensions(activity, context);
-    if (Service) {
-      activity.behaviour.Service = Service;
-    }
-  }
-  activate(message) {
-    const activity = this.activity;
-    const broker = activity.broker;
-    const formatQ = activity.broker.getQueue('format-run-q');
-    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 => {
-      formatQ.queueMessage({
-        routingKey: 'run.end.format'
-      }, {
-        endRoutingKey: 'run.end.complete'
-      }, {
-        persistent: false
-      });
-      try {
-        var format = await this._onExecuted(elementApi);
-      } catch (err) {
-        return broker.publish('format', 'run.end.error', {
-          error: err
-        }, {
-          persistent: false
-        });
-      }
-      broker.publish('format', 'run.end.complete', {
-        ...format
-      }, {
-        persistent: false
-      });
-    }, {
-      consumerTag: '_onify-extension-on-executed'
-    });
-  }
-  deactivate() {
-    const broker = this.activity.broker;
-    broker.cancel('_onify-extension-on-enter');
-    broker.cancel('_onify-extension-on-executed');
-  }
-  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;
-    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) {
-      if (io.input?.length) {
-        const input = await io.getInput(this.activity, elementApi);
-        Object.assign(result, {
-          input
-        });
-        Object.assign(elementApi.content, result);
-      }
-      if (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?.output.length) {
-      const output = await io.getOutput(this.activity, elementApi);
-      Object.assign(result, {
-        output
-      });
-      Object.assign(elementApi.content, {
-        output
-      });
-    }
-    if (properties) {
-      const props = properties.resolve(elementApi);
-      Object.assign(result, {
-        properties: props
-      });
-      Object.assign(elementApi.content, {
-        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) {
-  const result = {
-    format: element.type === 'bpmn:Process' ? new FormatProcess(element) : new FormatActivity(element)
-  };
-  const expression = element.behaviour.expression;
-  if (expression) result.Service = _ServiceExpression.default;
-  const extensions = element.behaviour.extensionElements?.values;
-  if (!extensions) return result;
-  for (const ext of extensions) {
-    switch (ext.$type) {
-      case 'camunda:Properties':
-        if (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?.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;
-        }
-    }
-  }
-  return result;
-}
-class FormatActivity {
-  constructor(activity) {
-    this.activity = activity;
-    this.resultVariable = activity.behaviour.resultVariable || '_' + activity.id;
-    let timeCycles;
-    if (activity.eventDefinitions) {
-      for (const ed of activity.eventDefinitions.filter(e => e.type === 'bpmn:TimerEventDefinition')) {
-        if (!('timeCycle' in ed)) continue;
-        timeCycles = timeCycles || [];
-        timeCycles.push(ed.timeCycle);
-      }
-    }
-    this.timeCycles = timeCycles;
-  }
-  resolve(elementApi) {
-    let user, groups, assigneeValue, description;
-    const activity = this.activity;
-    const {
-      documentation,
-      candidateUsers,
-      candidateGroups,
-      scheduledStart,
-      assignee
-    } = activity.behaviour;
-    if (candidateUsers) user = resolveAndSplit(elementApi, candidateUsers);
-    if (candidateGroups) groups = resolveAndSplit(elementApi, candidateGroups);
-    if (assignee) assigneeValue = elementApi.resolveExpression(assignee);
-    if (documentation) description = documentation[0]?.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,
-      ...(scheduledStart && activity.parent.type === 'bpmn:Process' && {
-        scheduledStart
-      }),
-      ...(user?.length && {
-        candidateUsers: user
-      }),
-      ...(groups?.length && {
-        candidateGroups: groups
-      }),
-      ...(!elementApi.content.description && description && {
-        description: elementApi.resolveExpression(description)
-      }),
-      ...(expireAt && {
-        expireAt
-      }),
-      ...(assigneeValue && {
-        assignee: assigneeValue
-      })
-    };
-  }
-}
-class FormatProcess {
-  constructor(bp) {
-    this.process = bp;
-  }
-  resolve(elementApi) {
-    let user, groups, description;
-    const bp = this.process;
-    const {
-      documentation,
-      candidateStarterUsers,
-      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)
-      })
-    };
-  }
-}
-function resolveAndSplit(elementApi, str) {
-  if (Array.isArray(str)) return str.filter(Boolean);
-  if (typeof str !== 'string') return;
-  const resolved = elementApi.resolveExpression(str);
-  if (Array.isArray(resolved)) return resolved.filter(Boolean);
-  if (typeof resolved !== 'string') return;
-  return resolved.split(',').map(g => g.trim && g.trim().toLowerCase()).filter(Boolean);
+  if (element.type === 'bpmn:Process') return new _OnifyProcessExtensions.OnifyProcessExtensions(element, context);
+  return new _OnifyElementExtensions.OnifyElementExtensions(element, context);
 }
 function extendFn(behaviour, context) {
+  var _behaviour$extensionE;
   if (behaviour.$type === 'bpmn:StartEvent' && behaviour.eventDefinitions) {
     const timer = behaviour.eventDefinitions.find(({
       type,
@@ -362,11 +22,21 @@ function extendFn(behaviour, context) {
       scheduledStart: timer.behaviour.timeCycle
     });
   }
-  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);
+  if (!Array.isArray((_behaviour$extensionE = behaviour.extensionElements) === null || _behaviour$extensionE === void 0 ? void 0 : _behaviour$extensionE.values)) return;
+  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;
@@ -381,10 +51,12 @@ function registerIOScripts(parentId, context, type, ioBehaviour) {
   } of inputParameters.concat(outputParameters)) {
     if (!definition) continue;
     if (definition.$type !== 'camunda:Script') continue;
-    const filename = `${parentId}/${type}/${$type}/${name}`;
+    const ioType = `${type}/${$type}`;
+    const filename = `${parentId}/${ioType}/${name}`;
     context.addScript(filename, {
       id: filename,
       scriptFormat: definition.scriptFormat,
+      type: ioType,
       ...(definition.value && {
         body: definition.value
       }),
@@ -393,4 +65,23 @@ 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,
+    type,
+    ...(script.value && {
+      body: script.value
+    }),
+    ...(script.resource && {
+      resource: script.resource
+    })
+  });
 }

package/dist/src/Connector.js

@@ -4,7 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = Connector;
-var _Errors = require("./Errors");
+var _Errors = require("./Errors.js");
 function Connector(connectorId, io, activity, executionMessage) {
   if (!(this instanceof Connector)) return new Connector(connectorId, io, activity, executionMessage);
   this.connectorId = connectorId;
@@ -30,7 +30,7 @@ Connector.prototype.execute = async function execute(...args) {
   }
   async function formatCallback(serviceErr, result) {
     if (serviceErr) return callback(serviceErr);
-    if (!io?.output.length) return callback(null, result);
+    if (!(io !== null && io !== void 0 && io.output.length)) return callback(null, result);
     try {
       const formattedResult = await io.getOutput(activity, {
         ...executionMessage,

package/dist/src/Errors.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.NotImplemented = void 0;
+exports.NotImplemented = exports.FormatError = void 0;
 class NotImplemented extends Error {
   constructor(serviceId) {
     super(`${serviceId} service function not found`);
@@ -13,4 +13,14 @@ class NotImplemented extends Error {
     };
   }
 }
-exports.NotImplemented = NotImplemented;
+exports.NotImplemented = NotImplemented;
+class FormatError extends Error {
+  constructor(elementId, err) {
+    super(`<${elementId}> ${err.message}`);
+    this.code = 'EFLOW_FORMAT';
+    this.output = {
+      statusCode: 500
+    };
+  }
+}
+exports.FormatError = FormatError;

package/dist/src/ExecutionListeners.js

@@ -0,0 +1,140 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+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 !== null && fields !== void 0 && 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)
+    };
+  }
+}
+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;
+  }
+}
+exports.default = ExecutionListeners;

package/dist/src/FlowScripts.js

@@ -105,7 +105,7 @@ FlowScripts.prototype.getScript = function getScript(scriptType, {
 function JavaScript(flowName, scriptBody, runContext, options) {
   this.flowName = flowName;
   this._runContext = runContext;
-  this.timeout = options && options.timeout;
+  this.timeout = options === null || options === void 0 ? void 0 : options.timeout;
   try {
     this.script = new _vm.Script(scriptBody, options);
   } catch (err) {
@@ -151,17 +151,22 @@ function JavaScriptResource(flowName, resource, resourceBase, runContext, option
   this[kResources] = resourceBase;
 }
 JavaScriptResource.prototype.execute = async function execute(executionContext, callback) {
+  let resource;
   try {
-    var scriptBody = await _fs.promises.readFile((0, _path.join)(this[kResources], executionContext.resolveExpression(this.resource))); // eslint-disable-line no-var
+    resource = executionContext.resolveExpression(this.resource);
+    var scriptBody = await _fs.promises.readFile((0, _path.join)(this[kResources], resource)); // eslint-disable-line no-var
   } catch (err) {
+    if (err instanceof SyntaxError) {
+      return callback(err);
+    }
     const {
       filename
     } = this.options;
-    return callback(new Error(`${filename}: script resource ${this.resource} not found`));
+    return callback(new Error(`${filename}: script resource ${resource || this.resource} not found`));
   }
   const script = new JavaScript(this.flowName, scriptBody, this._runContext, {
     ...this.options,
-    filename: this.resource
+    filename: `${this.options.filename}/${resource}`
   });
   return script.execute(executionContext, callback);
 };