bpmn-elements 13.0.0 → 13.1.0

package/CHANGELOG.md

@@ -1,6 +1,14 @@
 Changelog
 =========
 
+# 13.1.0
+
+- introduce `disableTrackState` setting. Tracking of elements is done by counters, e.g. activity taken or discarded, sequence flow taken and discarded. Counters are saved when getting state. If you run really big flows the state will keep all elements just to be able to recover the number of times an element has been touched. Needless to say it the state will grow out of it's comfort zone. Setting `disableTrackState` to true will only return state for elements that are actually running
+
+## Breaking
+
+- `getState()` can return undefined
+
 # 13.0.0
 
 - export task-, events-, and gateway activity behaviors through `bpmn-elements/tasks`, `bpmn-elements/events`, and `bpmn-elements/gateways` respectively

package/dist/activity/Activity.js

@@ -279,6 +279,8 @@ Activity.prototype.run = function run(runContent) {
 Activity.prototype.getState = function getState() {
   const status = this.status;
   const exec = this[kExec];
+  const brokerState = this.broker.getState(true);
+  if (!brokerState && this.environment.settings.disableTrackState) return;
   return {
     id: this.id,
     type: this.type,
@@ -288,7 +290,7 @@ Activity.prototype.getState = function getState() {
     executionId: exec.executionId,
     stopped: this.stopped,
     counters: this.counters,
-    broker: this.broker.getState(true),
+    broker: brokerState,
     execution: exec.execution && exec.execution.getState()
   };
 };

package/dist/flows/Association.js

@@ -71,11 +71,13 @@ Association.prototype.discard = function discard(content = {}) {
   return true;
 };
 Association.prototype.getState = function getState() {
+  const brokerState = this.broker.getState(true);
+  if (!brokerState && this.environment.settings.disableTrackState) return;
   return {
     id: this.id,
     type: this.type,
     counters: this.counters,
-    broker: this.broker.getState(true)
+    broker: brokerState
   };
 };
 Association.prototype.recover = function recover(state) {

package/dist/flows/MessageFlow.js

@@ -55,11 +55,13 @@ Object.defineProperty(MessageFlow.prototype, 'counters', {
   }
 });
 MessageFlow.prototype.getState = function getState() {
+  const brokerState = this.broker.getState(true);
+  if (!brokerState && this.environment.settings.disableTrackState) return;
   return {
     id: this.id,
     type: this.type,
     counters: this.counters,
-    broker: this.broker.getState(true)
+    broker: brokerState
   };
 };
 MessageFlow.prototype.recover = function recover(state) {

package/dist/flows/SequenceFlow.js

@@ -92,11 +92,13 @@ SequenceFlow.prototype.discard = function discard(content = {}) {
   this._publishEvent('discard', content);
 };
 SequenceFlow.prototype.getState = function getState() {
+  const brokerState = this.broker.getState(true);
+  if (!brokerState && this.environment.settings.disableTrackState) return;
   return {
     id: this.id,
     type: this.type,
     counters: this.counters,
-    broker: this.broker.getState(true)
+    broker: brokerState
   };
 };
 SequenceFlow.prototype.recover = function recover(state) {

package/dist/process/ProcessExecution.js

@@ -162,6 +162,11 @@ ProcessExecution.prototype.getState = function getState() {
     outboundMessageFlows,
     associations
   } = this[kElements];
+  const flowStates = flows.reduce((result, flow) => {
+    const elmState = flow.getState();
+    if (elmState) result.push(elmState);
+    return result;
+  }, []);
   return {
     executionId: this.executionId,
     stopped: this[kStopped],
@@ -169,17 +174,18 @@ ProcessExecution.prototype.getState = function getState() {
     status: this.status,
     children: children.reduce((result, activity) => {
       if (activity.placeholder) return result;
-      result.push(activity.getState());
+      const elmState = activity.getState();
+      if (elmState) result.push(elmState);
       return result;
     }, []),
     ...(flows.length && {
-      flows: flows.map(f => f.getState())
+      flows: flowStates
     }),
     ...(outboundMessageFlows.length && {
-      messageFlows: outboundMessageFlows.length && outboundMessageFlows.map(f => f.getState())
+      messageFlows: outboundMessageFlows.length && outboundMessageFlows.map(f => f.getState()).filter(Boolean)
     }),
     ...(associations.length && {
-      associations: associations.map(f => f.getState())
+      associations: associations.map(f => f.getState()).filter(Boolean)
     })
   };
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bpmn-elements",
-  "version": "13.0.0",
+  "version": "13.1.0",
   "description": "Executable workflow elements based on BPMN 2.0",
   "type": "module",
   "main": "./dist/index.js",
@@ -69,7 +69,7 @@
     "@babel/preset-env": "^7.23.9",
     "@babel/register": "^7.23.7",
     "@bonniernews/hot-bev": "^0.4.0",
-    "@types/node": "^16.18.79",
+    "@types/node": "^16.18.80",
     "bpmn-moddle": "^8.1.0",
     "c8": "^9.1.0",
     "camunda-bpmn-moddle": "^7.0.1",
@@ -78,13 +78,13 @@
     "debug": "^4.3.4",
     "eslint": "^8.56.0",
     "eslint-plugin-import": "^2.29.1",
-    "got": "^14.1.0",
-    "mocha": "^10.1.0",
+    "got": "^14.2.0",
+    "mocha": "^10.3.0",
     "mocha-cakes-2": "^3.3.0",
-    "moddle-context-serializer": "^4.0.0",
+    "moddle-context-serializer": "^4.1.2",
     "nock": "^13.5.1"
   },
   "dependencies": {
-    "smqp": "^8.0.0"
+    "smqp": "^8.2.2"
   }
 }

package/src/activity/Activity.js

@@ -269,6 +269,9 @@ Activity.prototype.run = function run(runContent) {
 Activity.prototype.getState = function getState() {
   const status = this.status;
   const exec = this[kExec];
+  const brokerState = this.broker.getState(true);
+  if (!brokerState && this.environment.settings.disableTrackState) return;
+
   return {
     id: this.id,
     type: this.type,
@@ -276,7 +279,7 @@ Activity.prototype.getState = function getState() {
     executionId: exec.executionId,
     stopped: this.stopped,
     counters: this.counters,
-    broker: this.broker.getState(true),
+    broker: brokerState,
     execution: exec.execution && exec.execution.getState(),
   };
 };

package/src/flows/Association.js

@@ -58,11 +58,14 @@ Association.prototype.discard = function discard(content = {}) {
 };
 
 Association.prototype.getState = function getState() {
+  const brokerState = this.broker.getState(true);
+  if (!brokerState && this.environment.settings.disableTrackState) return;
+
   return {
     id: this.id,
     type: this.type,
     counters: this.counters,
-    broker: this.broker.getState(true),
+    broker: brokerState,
   };
 };
 

package/src/flows/MessageFlow.js

@@ -41,11 +41,14 @@ Object.defineProperty(MessageFlow.prototype, 'counters', {
 });
 
 MessageFlow.prototype.getState = function getState() {
+  const brokerState = this.broker.getState(true);
+  if (!brokerState && this.environment.settings.disableTrackState) return;
+
   return {
     id: this.id,
     type: this.type,
     counters: this.counters,
-    broker: this.broker.getState(true),
+    broker: brokerState,
   };
 };
 

package/src/flows/SequenceFlow.js

@@ -74,11 +74,14 @@ SequenceFlow.prototype.discard = function discard(content = {}) {
 };
 
 SequenceFlow.prototype.getState = function getState() {
+  const brokerState = this.broker.getState(true);
+  if (!brokerState && this.environment.settings.disableTrackState) return;
+
   return {
     id: this.id,
     type: this.type,
     counters: this.counters,
-    broker: this.broker.getState(true),
+    broker: brokerState,
   };
 };
 

package/src/process/ProcessExecution.js

@@ -165,6 +165,13 @@ ProcessExecution.prototype.resume = function resume() {
 
 ProcessExecution.prototype.getState = function getState() {
   const {children, flows, outboundMessageFlows, associations} = this[kElements];
+
+  const flowStates = flows.reduce((result, flow) => {
+    const elmState = flow.getState();
+    if (elmState) result.push(elmState);
+    return result;
+  }, []);
+
   return {
     executionId: this.executionId,
     stopped: this[kStopped],
@@ -172,12 +179,13 @@ ProcessExecution.prototype.getState = function getState() {
     status: this.status,
     children: children.reduce((result, activity) => {
       if (activity.placeholder) return result;
-      result.push(activity.getState());
+      const elmState = activity.getState();
+      if (elmState) result.push(elmState);
       return result;
     }, []),
-    ...(flows.length && {flows: flows.map((f) => f.getState())}),
-    ...(outboundMessageFlows.length && {messageFlows: outboundMessageFlows.length && outboundMessageFlows.map((f) => f.getState())}),
-    ...(associations.length && {associations: associations.map((f) => f.getState())}),
+    ...(flows.length && { flows: flowStates }),
+    ...(outboundMessageFlows.length && { messageFlows: outboundMessageFlows.length && outboundMessageFlows.map((f) => f.getState()).filter(Boolean) }),
+    ...(associations.length && { associations: associations.map((f) => f.getState()).filter(Boolean) }),
   };
 };
 

package/types/types.d.ts

@@ -96,12 +96,18 @@ declare interface IExpressions {
 declare interface EnvironmentSettings {
   /** true returns dummy service function for service task if not found */
   enableDummyService?: boolean;
-  /** true makes activity runs to go forward in steps, defaults to false */
+  /** true forces activity runs to go forward in steps, defaults to false */
   step?: boolean;
   /** strict mode, see documentation, defaults to false */
   strict?: boolean;
   /** positive integer to control parallel loop batch size, defaults to 50 */
   batchSize?: number;
+  /**
+   * disable tracking state between recover and resume
+   * true will only return state for elements that are actually running
+   * Defaults to falsy
+   */
+  disableTrackState?: boolean;
   [x: string]: any;
 }
 
@@ -229,7 +235,7 @@ declare interface IActivityBehaviour {
   type: string;
   activity: Activity;
   environment: Environment;
-  new(acttivity: Activity, context: ContextInstance): IActivityBehaviour
+  new(activity: Activity, context: ContextInstance): IActivityBehaviour
   execute(executeMessage: ElementBrokerMessage): void;
 }
 
@@ -530,6 +536,7 @@ declare interface ISequenceFlowCondition {
 }
 
 declare class SequenceFlow extends Element<SequenceFlow> {
+  constructor(flowDef: SerializableElement, context: ContextInstance)
   get sourceId(): string;
   get targetId(): string;
   get isDefault(): boolean;
@@ -547,6 +554,7 @@ declare class SequenceFlow extends Element<SequenceFlow> {
    * @param {evaluateCallback} callback Callback with evaluation result, if truthy flow should be taken
    */
   evaluate(fromMessage: ElementBrokerMessage, callback: (err: Error, result: any) => void): void;
+  getState(): SequenceFlowState | undefined;
 }
 
 declare interface MessageFlowReference {
@@ -556,20 +564,24 @@ declare interface MessageFlowReference {
 }
 
 declare class MessageFlow extends Element<MessageFlow> {
+  constructor(flowDef: SerializableElement, context: ContextInstance)
   get source(): MessageFlowReference;
   get target(): MessageFlowReference;
   get counters(): { messages: number };
   activate(): void;
   deactivate(): void;
+  getState(): MessageFlowState | undefined;
 }
 
 declare class Association extends Element<Association> {
+  constructor(associationDef: SerializableElement, context: ContextInstance)
   get sourceId(): string;
   get targetId(): string;
   get isAssociation(): boolean;
   get counters(): {take: number, discard: number };
   take(content?: any): boolean;
   discard(content?: any): boolean;
+  getState(): AssociationState | undefined;
 }
 
 declare type LoggerFactory = (scope: string) => ILogger;
@@ -635,10 +647,12 @@ declare interface IScripts {
   getScript(language: string, identifier: {id: string, [x: string]: any}): Script;
 }
 
-declare interface Activity extends Element<Activity> {
+declare class Activity extends Element<Activity> {
+  constructor(behaviour: IActivityBehaviour, activityDef: SerializableElement, context: ContextInstance)
   get Behaviour(): IActivityBehaviour;
   get stopped(): boolean;
   get status(): ActivityRunStatus | undefined;
+  get context(): ContextInstance;
   get counters(): { taken: number, discarded: number };
   get execution(): ActivityExecution;
   get executionId(): string;
@@ -665,6 +679,7 @@ declare interface Activity extends Element<Activity> {
   next(): ElementBrokerMessage;
   shake(): void;
   evaluateOutbound(fromMessage: ElementBrokerMessage, discardRestAtTake: boolean, callback: (err: Error, evaluationResult: any) => void): void;
+  getState(): ActivityState | undefined;
 }
 
 declare class ActivityError extends Error {