@onify/flow-extensions 7.0.0 → 7.1.0

package/CHANGELOG.md

@@ -1,5 +1,10 @@
-Changelog
-=========
+# Changelog
+
+# 7.1.0
+
+- add process attribute `historyTimeToLive` to process environment variables when running
+- add process attribute `historyTimeToLive` as timer to definition context via `extendFn`, formatted as ISO8601 duration
+- use prettier since eslint will deprecate formatting rules in the next major release
 
 # 7.0.0
 

package/README.md

@@ -1,5 +1,4 @@
-Onify Flow Extensions
-=====================
+# Onify Flow Extensions
 
 [![Built latest](https://github.com/onify/flow-extensions/actions/workflows/build-latest.yaml/badge.svg)](https://github.com/onify/flow-extensions/actions/workflows/build-latest.yaml)[![Coverage Status](https://coveralls.io/repos/github/onify/flow-extensions/badge.svg?branch=default)](https://coveralls.io/github/onify/flow-extensions?branch=default)
 
@@ -13,8 +12,8 @@ Onify Flow Extensions
 ## Bpmn engine example
 
 ```js
-const {Engine} = require('bpmn-engine');
-const {extensions} = require('@onify/flow-extensions');
+const { Engine } = require('bpmn-engine');
+const { extensions } = require('@onify/flow-extensions');
 const FlowScripts = require('@onify/flow-extensions/dist/src/FlowScripts');
 
 const source = `
@@ -41,8 +40,8 @@ const engine = new Engine({
   },
   services: {
     serviceFn(scope, callback) {
-      callback(null, {data: 1});
-    }
+      callback(null, { data: 1 });
+    },
   },
   extensions: {
     onify: extensions,
@@ -63,11 +62,11 @@ engine.execute((err, instance) => {
 ## Extract scripts with extend function
 
 ```js
-const {extendFn} = require('@onify/flow-extensions');
+const { extendFn } = require('@onify/flow-extensions');
 
 const BpmnModdle = require('bpmn-moddle');
 const Elements = require('bpmn-elements');
-const {default: Serializer, TypeResolver} = require('moddle-context-serializer');
+const { default: Serializer, TypeResolver } = require('moddle-context-serializer');
 
 const source = `
 <definitions id="Def_0" xmlns="http://www.omg.org/spec/BPMN/20100524/MODEL"
@@ -124,9 +123,9 @@ function getModdleContext(source, options) {
 ## Extend sequence flow with properties and take listeners
 
 ```js
-const {OnifySequenceFlow, extensions} = require('@onify/flow-extensions');
+const { OnifySequenceFlow, extensions } = require('@onify/flow-extensions');
 const FlowScripts = require('@onify/flow-extensions/dist/src/FlowScripts');
-const {Engine} = require('bpmn-engine');
+const { Engine } = require('bpmn-engine');
 const Elements = require('bpmn-elements');
 
 const source = `

package/dist/formatters.js

@@ -77,6 +77,10 @@ exports.FormatActivity = FormatActivity;
 class FormatProcess {
   constructor(bp) {
     this.process = bp;
+    this._historyTTL = undefined;
+    if (bp.behaviour.historyTimeToLive) {
+      this._historyTTL = bp.context.definitionContext.getTimersByElementId(bp.id).find(t => t.timer.type === 'historyTimeToLive');
+    }
   }
   resolve(elementApi) {
     var _documentation$2, _user2, _groups2;
@@ -99,6 +103,9 @@ class FormatProcess {
       }),
       ...(!elementApi.content.description && description && {
         description: elementApi.resolveExpression(description)
+      }),
+      ...(this._historyTTL && {
+        historyTimeToLive: this._historyTTL.timer.value
       })
     };
   }

package/dist/index.js

@@ -38,14 +38,31 @@ function extensions(element, context) {
 }
 function extendFn(behaviour, context) {
   var _behaviour$extensionE;
-  if (behaviour.$type === 'bpmn:StartEvent' && behaviour.eventDefinitions) {
-    const timer = behaviour.eventDefinitions.find(({
-      type,
-      behaviour: edBehaviour
-    }) => edBehaviour && type === 'bpmn:TimerEventDefinition');
-    if (timer && timer.behaviour.timeCycle) Object.assign(behaviour, {
-      scheduledStart: timer.behaviour.timeCycle
-    });
+  switch (behaviour.$type) {
+    case 'bpmn:StartEvent':
+      {
+        if (!behaviour.eventDefinitions) break;
+        const timer = behaviour.eventDefinitions.find(({
+          type,
+          behaviour: edBehaviour
+        }) => edBehaviour && type === 'bpmn:TimerEventDefinition');
+        if (timer && timer.behaviour.timeCycle) Object.assign(behaviour, {
+          scheduledStart: timer.behaviour.timeCycle
+        });
+        break;
+      }
+    case 'bpmn:Process':
+      {
+        if (!behaviour.isExecutable) break;
+        const {
+          historyTimeToLive,
+          isExecutable
+        } = behaviour;
+        if (historyTimeToLive && isExecutable) {
+          context.addTimer(behaviour.id + ':historyTimeToLive', getHistoryTimeToLiveTimer(behaviour));
+        }
+        break;
+      }
   }
   if (!Array.isArray((_behaviour$extensionE = behaviour.extensionElements) === null || _behaviour$extensionE === void 0 ? void 0 : _behaviour$extensionE.values)) return;
   let listener = 0;
@@ -109,4 +126,25 @@ function registerListenerScript(parentId, context, type, listener, pos) {
       resource: script.resource
     })
   });
+}
+function getHistoryTimeToLiveTimer(behaviour) {
+  const {
+    id,
+    $type: type,
+    historyTimeToLive
+  } = behaviour;
+  let value = historyTimeToLive;
+  if (/^\d+$/.test(historyTimeToLive)) {
+    value = `P${historyTimeToLive}D`;
+  }
+  return {
+    id: `${type}/${id}:historyTimeToLive`,
+    type: 'historyTimeToLive',
+    timerType: 'timeDuration',
+    value,
+    parent: {
+      id,
+      type
+    }
+  };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onify/flow-extensions",
-  "version": "7.0.0",
+  "version": "7.1.0",
   "description": "Onify Flow extensions",
   "type": "module",
   "module": "src/index.js",
@@ -14,7 +14,7 @@
   "scripts": {
     "test": "mocha -R dot",
     "posttest": "npm run lint && npm run dist",
-    "lint": "eslint . --cache",
+    "lint": "eslint . --cache && prettier . --check --cache",
     "prepare": "npm run dist",
     "dist": "babel src -d dist && babel test/helpers/FlowScripts.js -d dist",
     "test:lcov": "c8 -r lcov mocha && npm run lint",
@@ -39,23 +39,24 @@
   "devDependencies": {
     "@aircall/expression-parser": "^1.0.4",
     "@babel/cli": "^7.23.4",
-    "@babel/core": "^7.23.6",
-    "@babel/preset-env": "^7.23.6",
-    "@babel/register": "^7.22.15",
+    "@babel/core": "^7.23.7",
+    "@babel/preset-env": "^7.23.8",
+    "@babel/register": "^7.23.7",
     "bpmn-elements-8-1": "npm:bpmn-elements@8.1",
     "bpmn-engine": "^18.0.0",
     "bpmn-engine-14": "npm:bpmn-engine@14",
     "bpmn-moddle": "^8.1.0",
-    "c8": "^8.0.1",
+    "c8": "^9.1.0",
     "camunda-bpmn-moddle": "^7.0.1",
-    "chai": "^4.3.10",
+    "chai": "^5.0.0",
     "chronokinesis": "^6.0.0",
     "debug": "^4.3.4",
     "eslint": "^8.56.0",
     "eslint-plugin-import": "^2.29.1",
     "mocha": "^10.2.0",
     "mocha-cakes-2": "^3.3.0",
-    "moddle-context-serializer": "^4.1.1"
+    "moddle-context-serializer": "^4.1.1",
+    "prettier": "^3.2.4"
   },
   "peerDependencies": {
     "bpmn-elements": ">=8"

package/src/Connector.js

@@ -1,4 +1,4 @@
-import {NotImplemented} from './Errors.js';
+import { NotImplemented } from './Errors.js';
 
 export default function Connector(connectorId, io, activity, executionMessage) {
   if (!(this instanceof Connector)) return new Connector(connectorId, io, activity, executionMessage);
@@ -22,7 +22,7 @@ Connector.prototype.execute = async function execute(...args) {
   if (!serviceFunction) return callback(new NotImplemented(connectorId));
 
   try {
-    const input = io && await io.getInput(activity, executionMessage);
+    const input = io && (await io.getInput(activity, executionMessage));
     await serviceFunction.call(activity, input, ...args);
   } catch (err) {
     return callback(err);
@@ -33,7 +33,7 @@ Connector.prototype.execute = async function execute(...args) {
     if (!io?.output.length) return callback(null, result);
 
     try {
-      const formattedResult = await io.getOutput(activity, {...executionMessage, ...result});
+      const formattedResult = await io.getOutput(activity, { ...executionMessage, ...result });
       return callback(null, formattedResult);
     } catch (err) {
       return callback(err);

package/src/Errors.js

@@ -2,7 +2,7 @@ export class NotImplemented extends Error {
   constructor(serviceId) {
     super(`${serviceId} service function not found`);
     this.code = 'EFLOW_NOT_IMPLEMENTED';
-    this.output = {statusCode: 501};
+    this.output = { statusCode: 501 };
   }
 }
 
@@ -10,6 +10,6 @@ export class FormatError extends Error {
   constructor(elementId, err) {
     super(`<${elementId}> ${err.message}`);
     this.code = 'EFLOW_FORMAT';
-    this.output = {statusCode: 500};
+    this.output = { statusCode: 500 };
   }
 }

package/src/ExecutionListeners.js

@@ -10,7 +10,7 @@ class Listener {
   _getScope(message, extend) {
     const environment = this.environment;
 
-    const {fields, content, properties} = message;
+    const { fields, content, properties } = message;
     const scope = {
       ...extend,
       type: this.type,
@@ -33,7 +33,7 @@ class Listener {
     const fields = this.extension.fields;
     if (!fields?.length) return;
     const result = {};
-    for (const {name, expression, string} of fields) {
+    for (const { name, expression, string } of fields) {
       result['' + name] = expression ? environment.resolveExpression(expression, scope) : string;
     }
     return result;
@@ -43,15 +43,15 @@ class Listener {
 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}`;
+    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 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});
+    const script = this.environment.scripts.getScript(this.extension.scriptFormat, { id: this.id });
 
     return new Promise((resolve, reject) => {
       return script.execute(scope, (err, result) => {
@@ -65,11 +65,7 @@ class ScriptListener extends Listener {
     }
   }
   _register(context, id, script) {
-    const {
-      scriptFormat,
-      value,
-      resource,
-    } = script;
+    const { scriptFormat, value, resource } = script;
 
     context.environment.scripts.register({
       id,
@@ -90,7 +86,7 @@ class ScriptListener extends Listener {
 class ExpressionListener extends Listener {
   execute(message) {
     const scope = this._getScope(message);
-    return {expression: this.environment.resolveExpression(this.extension.expression, scope)};
+    return { expression: this.environment.resolveExpression(this.extension.expression, scope) };
   }
 }
 
@@ -113,7 +109,7 @@ export default class ExecutionListeners {
     return this.listeners.some((l) => l.event === 'take');
   }
   add(extension, pos) {
-    const {script, expression} = extension;
+    const { script, expression } = extension;
     if (!script && !expression) return;
 
     const list = this.listeners;

package/src/IO.js

@@ -1,7 +1,7 @@
 export class IOBase {
   constructor(parm) {
     this.name = parm.name;
-    this.type = parm.definition && parm.definition.$type || 'string';
+    this.type = (parm.definition && parm.definition.$type) || 'string';
     this.behaviour = parm;
   }
   getValue(activity, executionMessage) {
@@ -18,12 +18,12 @@ class IOMap extends IOBase {
   getValue(activity, executionMessage) {
     const name = this.name;
     const entries = this.behaviour.definition.entries;
-    if (!Array.isArray(entries)) return {[name]: {}};
+    if (!Array.isArray(entries)) return { [name]: {} };
 
     const environment = activity.environment;
 
     const result = {};
-    for (const {key, value} of entries) {
+    for (const { key, value } of entries) {
       if (!key) continue;
 
       const val = environment.resolveExpression(value, executionMessage);
@@ -33,7 +33,7 @@ class IOMap extends IOBase {
         if (Array.isArray(current)) {
           current.push(val);
         } else {
-          const items = result[key] = [];
+          const items = (result[key] = []);
           if (current !== undefined) items.push(current);
           items.push(val);
         }
@@ -42,7 +42,7 @@ class IOMap extends IOBase {
       }
     }
 
-    return {[name]: result};
+    return { [name]: result };
   }
 }
 
@@ -55,7 +55,7 @@ export class IOList extends IOBase {
     const items = this.behaviour.definition.items;
 
     const result = [];
-    if (!Array.isArray(items)) return {[name]: result};
+    if (!Array.isArray(items)) return { [name]: result };
 
     const environment = activity.environment;
     for (const item of items) {
@@ -80,7 +80,7 @@ export class IOScript extends IOBase {
     const name = this.name;
     const environment = activity.environment;
 
-    const {fields, content, properties, ...rest} = executionMessage;
+    const { fields, content, properties, ...rest } = executionMessage;
     const scope = {
       id: this.id,
       type: this.type,
@@ -94,12 +94,12 @@ export class IOScript extends IOBase {
       ...rest,
     };
 
-    const script = environment.scripts.getScript(definition.scriptFormat, {id: this.id});
+    const script = environment.scripts.getScript(definition.scriptFormat, { id: this.id });
 
     return new Promise((resolve, reject) => {
       return script.execute(scope, (err, result) => {
         if (err) return reject(err);
-        resolve({[name]: result});
+        resolve({ [name]: result });
       });
     });
 
@@ -113,7 +113,7 @@ export class InputOutput {
   constructor(parentId, behaviour, context) {
     this.parentId = parentId;
     this.context = context;
-    const {inputParameters, outputParameters} = behaviour;
+    const { inputParameters, outputParameters } = behaviour;
     this.input = this._map(parentId, inputParameters, 'input', context);
     this.output = this._map(parentId, outputParameters, 'output', context);
   }
@@ -145,7 +145,7 @@ export class InputOutput {
         }
         case 'camunda:Script': {
           const id = `${parentId}/${ioType}/${type}/${parm.name}`;
-          const {scriptFormat, value, resource} = definition;
+          const { scriptFormat, value, resource } = definition;
 
           if (!value && !resource) break;
 
@@ -154,8 +154,8 @@ export class InputOutput {
             type: parm.$type,
             behaviour: {
               scriptFormat,
-              ...(value && {script: value}),
-              ...(resource && {resource}),
+              ...(value && { script: value }),
+              ...(resource && { resource }),
             },
           });
 

package/src/IOForm.js

@@ -8,11 +8,11 @@ export default class IOForm {
   resolve(elementApi) {
     const form = {};
     for (const field of this.behaviour.fields) {
-      const f = form[field.id] = {
+      const f = (form[field.id] = {
         ...field,
-        ...(field.label && {defaultValue: elementApi.resolveExpression(field.label)}),
-        ...(field.defaultValue && {defaultValue: elementApi.resolveExpression(field.defaultValue)}),
-      };
+        ...(field.label && { defaultValue: elementApi.resolveExpression(field.label) }),
+        ...(field.defaultValue && { defaultValue: elementApi.resolveExpression(field.defaultValue) }),
+      });
       if (f.properties) {
         f.properties = new IOProperties(this.activity, f.properties).resolve(elementApi);
       }

package/src/IOProperties.js

@@ -6,7 +6,7 @@ export default class IOProperties {
   resolve(elementApi) {
     const properties = {};
 
-    for (const {id, name, value} of this.behaviour.values) {
+    for (const { id, name, value } of this.behaviour.values) {
       properties[id || name] = elementApi.resolveExpression(value);
     }
 

package/src/OnifyBoundaryEventExtensions.js

@@ -1,65 +1,77 @@
-import { OnifyElementExtensions } from './OnifyElementExtensions.js';
-
-export class OnifyBoundaryEventExtensions extends OnifyElementExtensions {
-  constructor(activity, context) {
-    super(activity, context);
-    this._syncFormatOnEnter = this._syncFormatOnEnter.bind(this);
-  }
-  activate(message) {
-    const activity = this.activity;
-    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', this._syncFormatOnEnter, { consumerTag: '_onify-extension-on-enter' });
-    } else {
-      activity.on('enter', this._syncFormatOnEnter, { consumerTag: '_onify-extension-on-enter' });
-    }
-
-    activity.on('activity.execution.completed', (elementApi) => {
-      return this._onExecutionCompleted(elementApi, formatQ);
-    }, { consumerTag: '_onify-extension-on-executed' });
-
-    if (executionListeners?.onStart) {
-      activity.on('start', async (elementApi) => {
-        try {
-          await executionListeners.execute('start', elementApi);
-        } catch (err) {
-          return activity.logger.error(`<${activity.id}> execution listener error`, err);
-        }
-      }, { consumerTag: '_onify-extension-on-listenerstart' });
-    }
-    if (executionListeners?.onEnd) {
-      activity.on('end', (elementApi) => {
-        this._executeExecutionListener('end', elementApi, formatQ);
-      }, { consumerTag: '_onify-extension-on-listenerend' });
-    }
-  }
-  _syncFormatOnEnter(elementApi) {
-    try {
-      var format = this._onEnterSync(elementApi);
-    } catch (err) {
-      return elementApi.broker.publish('format', 'run.enter.error', { error: err }, { persistent: false });
-    }
-
-    elementApi.broker.publish('format', 'run.enter.complete', format, { persistent: false });
-  }
-  _onEnterSync(elementApi) {
-    const {format, properties, io} = 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?.output?.length) {
-      result.assignToOutput = true;
-    }
-
-    return result;
-  }
-}
+import { OnifyElementExtensions } from './OnifyElementExtensions.js';
+
+export class OnifyBoundaryEventExtensions extends OnifyElementExtensions {
+  constructor(activity, context) {
+    super(activity, context);
+    this._syncFormatOnEnter = this._syncFormatOnEnter.bind(this);
+  }
+  activate(message) {
+    const activity = this.activity;
+    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', this._syncFormatOnEnter, { consumerTag: '_onify-extension-on-enter' });
+    } else {
+      activity.on('enter', this._syncFormatOnEnter, { consumerTag: '_onify-extension-on-enter' });
+    }
+
+    activity.on(
+      'activity.execution.completed',
+      (elementApi) => {
+        return this._onExecutionCompleted(elementApi, formatQ);
+      },
+      { consumerTag: '_onify-extension-on-executed' },
+    );
+
+    if (executionListeners?.onStart) {
+      activity.on(
+        'start',
+        async (elementApi) => {
+          try {
+            await executionListeners.execute('start', elementApi);
+          } catch (err) {
+            return activity.logger.error(`<${activity.id}> execution listener error`, err);
+          }
+        },
+        { consumerTag: '_onify-extension-on-listenerstart' },
+      );
+    }
+    if (executionListeners?.onEnd) {
+      activity.on(
+        'end',
+        (elementApi) => {
+          this._executeExecutionListener('end', elementApi, formatQ);
+        },
+        { consumerTag: '_onify-extension-on-listenerend' },
+      );
+    }
+  }
+  _syncFormatOnEnter(elementApi) {
+    try {
+      var format = this._onEnterSync(elementApi);
+    } catch (err) {
+      return elementApi.broker.publish('format', 'run.enter.error', { error: err }, { persistent: false });
+    }
+
+    elementApi.broker.publish('format', 'run.enter.complete', format, { persistent: false });
+  }
+  _onEnterSync(elementApi) {
+    const { format, properties, io } = 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?.output?.length) {
+      result.assignToOutput = true;
+    }
+
+    return result;
+  }
+}