bpmn-engine 17.0.0 → 17.1.1

package/CHANGELOG.md

@@ -1,6 +1,16 @@
 Changelog
 =========
 
+# 17.1.1
+
+- Finetuning Engine.execute and Engine.resume callback arg typization by @bestmazzo
+- Patch [`bpmn-elements`](https://github.com/paed01/bpmn-elements/blob/master/CHANGELOG.md)
+
+# 17.1.0
+
+- Clear arbitrary engine timers on end and error, not just on stop as it was before
+- Bump [`smqp@8`](https://github.com/paed01/smqp/blob/default/CHANGELOG.md)
+
 # 17.0.0
 
 - Even slimmer state from [`bpmn-elements@11`](https://github.com/paed01/bpmn-elements/blob/master/CHANGELOG.md). In most cases it should be safe to update, unless you inspect element states for some reason

package/index.js

@@ -432,10 +432,10 @@ Execution.prototype._setup = function setup(setupOptions = {}) {
   for (const definition of this.definitions) {
     if (listener) definition.environment.options.listener = listener;
 
-    definition.broker.subscribeTmp('event', 'definition.#', onChildMessage, {noAck: true, consumerTag: '_engine_definition'});
-    definition.broker.subscribeTmp('event', 'process.#', onChildMessage, {noAck: true, consumerTag: '_engine_process'});
-    definition.broker.subscribeTmp('event', 'activity.#', onChildMessage, {noAck: true, consumerTag: '_engine_activity'});
-    definition.broker.subscribeTmp('event', 'flow.#', onChildMessage, {noAck: true, consumerTag: '_engine_flow'});
+    const {queueName} = definition.broker.subscribeTmp('event', 'definition.#', onChildMessage, {noAck: true, consumerTag: '_engine_definition'});
+    definition.broker.bindQueue(queueName, 'event', 'process.#');
+    definition.broker.bindQueue(queueName, 'event', 'activity.#');
+    definition.broker.bindQueue(queueName, 'event', 'flow.#');
   }
 };
 
@@ -513,27 +513,29 @@ Execution.prototype._onChildMessage = function onChildMessage(routingKey, messag
   switch (newState) {
     case 'stopped':
       this._debug('stopped');
-      broker.publish('event', 'engine.stop', {}, {type: 'stop'});
-      return this[kEngine].emit('stop', this);
+      return this._complete('stop', {}, {type: 'stop'});
     case 'idle':
       this._debug('completed');
-      broker.publish('event', 'engine.end', {}, {type: 'end'});
-      return this[kEngine].emit('end', this);
+      return this._complete('end', {}, {type: 'end'});
     case 'error':
       this._debug('error');
-      return broker.publish('event', 'engine.error', message.content.error, {type: 'error', mandatory: true});
+      return this._complete('error', message.content.error, {type: 'error', mandatory: true});
   }
 };
 
+Execution.prototype._complete = function complete(eventType, content, messageProperties) {
+  const timers = this.environment.timers;
+  timers.executing.slice().forEach((ref) => timers.clearTimeout(ref));
+  this.broker.publish('event', 'engine.' + eventType, content, messageProperties);
+  return eventType !== 'error' && this[kEngine].emit(eventType, this);
+};
+
 Execution.prototype._teardownDefinition = function teardownDefinition(definition) {
   const executing = this[kExecuting];
   const idx = executing.indexOf(definition);
   if (idx > -1) executing.splice(idx, 1);
 
   definition.broker.cancel('_engine_definition');
-  definition.broker.cancel('_engine_process');
-  definition.broker.cancel('_engine_activity');
-  definition.broker.cancel('_engine_flow');
 };
 
 Execution.prototype.getState = function getState() {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "bpmn-engine",
   "description": "BPMN 2.0 execution engine. Open source javascript workflow engine.",
-  "version": "17.0.0",
+  "version": "17.1.1",
   "main": "index.js",
   "types": "types/bpmn-engine.d.ts",
   "repository": {
@@ -51,18 +51,18 @@
     "camunda-bpmn-moddle": "^7.0.1",
     "chai": "^4.3.7",
     "chronokinesis": "^5.0.2",
-    "eslint": "^8.43.0",
+    "eslint": "^8.45.0",
     "markdown-toc": "^1.2.0",
     "mocha": "^10.2.0",
     "mocha-cakes-2": "^3.3.0",
-    "nock": "^13.3.1"
+    "nock": "^13.3.2"
   },
   "dependencies": {
     "@types/bpmn-moddle": "^5.1.6",
-    "bpmn-elements": "^11.0.1",
+    "bpmn-elements": "^11.1.1",
     "bpmn-moddle": "^8.0.1",
     "debug": "^4.3.4",
     "moddle-context-serializer": "^4.0.0",
-    "smqp": "^7.1.3"
+    "smqp": "^8.0.0"
   }
 }

package/types/bpmn-engine.d.ts

@@ -128,7 +128,7 @@ declare module 'bpmn-engine' {
     /**
      * current engine execution
      */
-    readonly  execution: Execution;
+    readonly execution: Execution;
     /**
      * engine environment
      */
@@ -147,7 +147,7 @@ declare module 'bpmn-engine' {
      */
     execute(): Promise<Execution>;
     execute(options: BpmnEngineExecuteOptions): Promise<Execution>;
-    execute(options: BpmnEngineExecuteOptions, cb: (err: Error) => void): Promise<Execution>;
+    execute(options: BpmnEngineExecuteOptions, cb: (err: Error, execution?: Execution) => void): Promise<Execution>;
     execute(cb: (err: Error) => void): Promise<Execution>;
 
     /**
@@ -178,7 +178,7 @@ declare module 'bpmn-engine' {
      * @param options
      * @param callback
      */
-    resume(options?: BpmnEngineExecuteOptions, callback?: () => void): Promise<Execution>;
+    resume(options?: BpmnEngineExecuteOptions, callback?: (err: Error, execution?: Execution) => void): Promise<Execution>;
 
     /**
      * Stop execution. The instance is terminated.
@@ -191,7 +191,7 @@ declare module 'bpmn-engine' {
      * Add definition source by source context.
      * @param options
      */
-    addSource(options?: {sourceContext: any}): void;
+    addSource(options?: { sourceContext: any }): void;
   }
 
   interface BpmnEngineDefinitionState extends DefinitionState {
@@ -284,7 +284,7 @@ declare module 'bpmn-engine' {
      * @param message {BpmnMessage}
      * @param options
      */
-    signal(message?: BpmnMessage, options?: {ignoreSameDefinition?: boolean}): void;
+    signal(message?: BpmnMessage, options?: { ignoreSameDefinition?: boolean }): void;
 
     /**
      * send cancel activity to execution, distributed to all definitions