bpmn-elements 11.0.0 → 11.1.1

package/CHANGELOG.md

@@ -1,6 +1,19 @@
 Changelog
 =========
 
+# 11.1.1
+
+- fix boundary event not cancelling task if resumed before task was resumed
+- a cancelled call activity should also cancel the called process even if resumed before called process was resumed later
+
+# 11.1.0
+
+- bump [smqp@8](https://github.com/paed01/smqp/blob/default/CHANGELOG.md)
+
+# 11.0.1
+
+- update neglected type definition
+
 # 11.0.0
 
 - slim activity state by removing properties not needed for recover, might be breaking if state is inspected
@@ -263,7 +276,7 @@ Refactor scripts again
 
 # 2.1.0
 
-Transactions and compensation if canceled.
+Transactions and compensation if cancelled.
 
 ## Additions
 - Add support for Transaction

package/README.md

@@ -62,7 +62,7 @@ The following elements are tested and supported.
 - SignalEventDefinition
   - throw
   - catch
-- SignalTask
+- [SignalTask](/docs/SignalTask.md)
   - ManualTask
   - UserTask
 - [StandardLoopCharacteristics](/docs/LoopCharacteristics.md)

package/dist/definition/DefinitionExecution.js

@@ -602,7 +602,16 @@ DefinitionExecution.prototype._onCancelCallActivity = function onCancelCallActiv
   const targetProcess = this.getProcessByExecutionId(bpExecutionId);
   if (!targetProcess) return;
   this._debug(`cancel call from <${fromParent.id}.${fromId}> to <${calledElement}>`);
-  targetProcess.getApi().discard();
+  if (!targetProcess.isRunning) {
+    targetProcess.getApi({
+      content: {
+        id: targetProcess.id,
+        executionId: targetProcess.executionId
+      }
+    }).discard();
+  } else {
+    targetProcess.getApi().discard();
+  }
 };
 DefinitionExecution.prototype._onDelegateMessage = function onDelegateMessage(routingKey, executeMessage) {
   const content = executeMessage.content;

package/dist/events/BoundaryEvent.js

@@ -107,13 +107,28 @@ BoundaryEventBehaviour.prototype._onCompleted = function onCompleted(_, {
     }));
   }
   this[kCompleteContent] = content;
-  const inbound = this[kExecuteMessage].content.inbound;
+  const {
+    inbound,
+    executionId
+  } = this[kExecuteMessage].content;
   const attachedToContent = inbound && inbound[0];
   const attachedTo = this.attachedTo;
-  this.activity.logger.debug(`<${this.executionId} (${this.id})> cancel ${attachedTo.status} activity <${attachedToContent.executionId} (${attachedToContent.id})>`);
-  attachedTo.getApi({
-    content: attachedToContent
-  }).discard();
+  this.activity.logger.debug(`<${executionId} (${this.id})> cancel ${attachedTo.status} activity <${attachedToContent.executionId} (${attachedToContent.id})>`);
+  if (content.isRecovered && !attachedTo.isRunning) {
+    const attachedExecuteTag = `_on-attached-execute-${executionId}`;
+    this[kAttachedTags].push(attachedExecuteTag);
+    attachedTo.broker.subscribeOnce('execution', '#', () => {
+      attachedTo.getApi({
+        content: attachedToContent
+      }).discard();
+    }, {
+      consumerTag: attachedExecuteTag
+    });
+  } else {
+    attachedTo.getApi({
+      content: attachedToContent
+    }).discard();
+  }
 };
 BoundaryEventBehaviour.prototype._onAttachedLeave = function onAttachedLeave(_, {
   content

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bpmn-elements",
-  "version": "11.0.0",
+  "version": "11.1.1",
   "description": "Executable workflow elements based on BPMN 2.0",
   "type": "module",
   "main": "dist/index.js",
@@ -45,9 +45,9 @@
   ],
   "devDependencies": {
     "@aircall/expression-parser": "^1.0.4",
-    "@babel/cli": "^7.22.5",
-    "@babel/core": "^7.22.5",
-    "@babel/preset-env": "^7.22.5",
+    "@babel/cli": "^7.22.9",
+    "@babel/core": "^7.22.9",
+    "@babel/preset-env": "^7.22.9",
     "@babel/register": "^7.22.5",
     "@bonniernews/hot-bev": "^0.4.0",
     "bpmn-moddle": "^8.0.1",
@@ -56,7 +56,7 @@
     "chai": "^4.3.7",
     "chronokinesis": "^5.0.2",
     "debug": "^4.3.4",
-    "eslint": "^8.43.0",
+    "eslint": "^8.44.0",
     "eslint-plugin-import": "^2.27.5",
     "got": "^12.6.1",
     "mocha": "^10.1.0",
@@ -65,6 +65,6 @@
     "nock": "^13.3.1"
   },
   "dependencies": {
-    "smqp": "^7.1.4"
+    "smqp": "^8.0.0"
   }
 }

package/src/definition/DefinitionExecution.js

@@ -614,7 +614,16 @@ DefinitionExecution.prototype._onCancelCallActivity = function onCancelCallActiv
 
   this._debug(`cancel call from <${fromParent.id}.${fromId}> to <${calledElement}>`);
 
-  targetProcess.getApi().discard();
+  if (!targetProcess.isRunning) {
+    targetProcess.getApi({
+      content: {
+        id: targetProcess.id,
+        executionId: targetProcess.executionId,
+      },
+    }).discard();
+  } else {
+    targetProcess.getApi().discard();
+  }
 };
 
 DefinitionExecution.prototype._onDelegateMessage = function onDelegateMessage(routingKey, executeMessage) {

package/src/events/BoundaryEvent.js

@@ -103,13 +103,21 @@ BoundaryEventBehaviour.prototype._onCompleted = function onCompleted(_, {content
 
   this[kCompleteContent] = content;
 
-  const inbound = this[kExecuteMessage].content.inbound;
+  const {inbound, executionId} = this[kExecuteMessage].content;
   const attachedToContent = inbound && inbound[0];
   const attachedTo = this.attachedTo;
 
-  this.activity.logger.debug(`<${this.executionId} (${this.id})> cancel ${attachedTo.status} activity <${attachedToContent.executionId} (${attachedToContent.id})>`);
+  this.activity.logger.debug(`<${executionId} (${this.id})> cancel ${attachedTo.status} activity <${attachedToContent.executionId} (${attachedToContent.id})>`);
 
-  attachedTo.getApi({content: attachedToContent}).discard();
+  if (content.isRecovered && !attachedTo.isRunning) {
+    const attachedExecuteTag = `_on-attached-execute-${executionId}`;
+    this[kAttachedTags].push(attachedExecuteTag);
+    attachedTo.broker.subscribeOnce('execution', '#', () => {
+      attachedTo.getApi({content: attachedToContent}).discard();
+    }, {consumerTag: attachedExecuteTag});
+  } else {
+    attachedTo.getApi({content: attachedToContent}).discard();
+  }
 };
 
 BoundaryEventBehaviour.prototype._onAttachedLeave = function onAttachedLeave(_, {content}) {

package/types/index.d.ts

@@ -129,6 +129,23 @@ declare module 'bpmn-elements' {
 
   type filterPostponed = (elementApi: Api<ElementBase>) => boolean;
 
+  const enum DefinitionRunStatus {
+    Entered = 'entered',
+    Start = 'start',
+    Executing = 'executing',
+    End = 'end',
+    Discarded = 'discarded',
+  }
+
+  const enum ProcessRunStatus {
+    Entered = 'entered',
+    Start = 'start',
+    Executing = 'executing',
+    Errored = 'errored',
+    End = 'end',
+    Discarded = 'discarded',
+  }
+
   /**
    * Activity status
    * Can be used to decide when to save states, Timer and Wait is recommended.
@@ -153,6 +170,30 @@ declare module 'bpmn-elements' {
     Wait = 'wait',
   }
 
+  /**
+   * Activity run status
+   */
+  const enum ActivityRunStatus {
+    /** Run entered, triggered by taken inbound flow */
+    Entered = 'entered',
+    /** Run started */
+    Started = 'started',
+    /** Executing activity behaviour */
+    Executing = 'executing',
+    /** Activity behaviour execution completed successfully */
+    Executed = 'executed',
+    /** Run end, take outbound flows */
+    End = 'end',
+    /** Entering discard run, triggered by discarded inbound flow */
+    Discard = 'discard',
+    /** Run was discarded, discard outbound flows */
+    Discarded = 'discarded',
+    /** Activity behaviour execution failed, discard run */
+    Error = 'error',
+    /** Formatting next run message */
+    Formatting = 'formatting',
+  }
+
   interface DefinitionExecution {
     get id(): string;
     get type(): string;
@@ -162,7 +203,7 @@ declare module 'bpmn-elements' {
     get executionId(): string;
     get stopped(): boolean;
     get completed(): boolean;
-    get status(): boolean;
+    get status(): string;
     get processes(): Process[];
     get postponedCount(): number;
     get isRunning(): boolean;
@@ -314,7 +355,6 @@ declare module 'bpmn-elements' {
   interface ElementState {
     id: string;
     type: string;
-    name: string;
     broker?: BrokerState;
     [x: string]: any;
   }
@@ -333,9 +373,9 @@ declare module 'bpmn-elements' {
   }
 
   interface ActivityState extends ElementState {
+    status?: string,
     executionId: string;
     stopped: boolean;
-    behaviour: Record<string, any>;
     counters: { taken: number, discarded: number };
     execution?: ActivityExecutionState;
   }
@@ -344,17 +384,12 @@ declare module 'bpmn-elements' {
     counters: {take: number, discard: number, looped: number};
   }
 
-  interface MessageFlowState {
-    id: string;
-    type: string;
+  interface MessageFlowState extends ElementState {
     counters: {messages: number};
   }
 
   interface AssociationState extends ElementState {
     counters: {take: number, discard: number };
-    sourceId: string;
-    targetId: string;
-    isAssociation: boolean;
   }
 
   interface ProcessExecutionState {
@@ -401,7 +436,7 @@ declare module 'bpmn-elements' {
     get execution(): DefinitionExecution;
     get executionId(): string;
     get isRunning(): boolean;
-    get status(): string;
+    get status(): DefinitionRunStatus | undefined;
     get stopped(): boolean;
     get activityStatus(): ActivityStatus;
     run(): Definition;
@@ -437,7 +472,7 @@ declare module 'bpmn-elements' {
     get isRunning(): boolean;
     get executionId(): string;
     get execution(): ProcessExecution;
-    get status(): string;
+    get status(): ProcessRunStatus | undefined;
     get activityStatus(): ActivityStatus;
     init(useAsExecutionId?: string): void;
     run(runContent?: Record<string, any>): void;
@@ -602,7 +637,7 @@ declare module 'bpmn-elements' {
   interface Activity extends Element<Activity> {
     get Behaviour(): ActivityBehaviour;
     get stopped(): boolean;
-    get status(): string;
+    get status(): ActivityRunStatus | undefined;
     get counters(): { taken: number, discarded: number };
     get execution(): ActivityExecution;
     get executionId(): string;