bpmn-elements 10.1.0 → 11.0.1

package/CHANGELOG.md

@@ -1,6 +1,11 @@
 Changelog
 =========
 
+# 11.0.0
+
+- slim activity state by removing properties not needed for recover, might be breaking if state is inspected
+- slim process state by removing properties not needed for recover, might be breaking if state is inspected
+
 # 10.1.0
 
 - introduce Lane behaviour

package/dist/activity/Activity.js

@@ -296,6 +296,22 @@ Activity.prototype.run = function run(runContent) {
   broker.publish('run', 'run.start', (0, _messageHelper.cloneContent)(content));
   this._consumeRunQ();
 };
+Activity.prototype.getState = function getState() {
+  const status = this.status;
+  const exec = this[kExec];
+  return {
+    id: this.id,
+    type: this.type,
+    ...(status && {
+      status
+    }),
+    executionId: exec.executionId,
+    stopped: this.stopped,
+    counters: this.counters,
+    broker: this.broker.getState(true),
+    execution: exec.execution && exec.execution.getState()
+  };
+};
 Activity.prototype.recover = function recover(state) {
   if (this.isRunning) throw new Error(`cannot recover running activity <${this.id}>`);
   if (!state) return;
@@ -380,21 +396,6 @@ Activity.prototype.shake = function shake() {
 Activity.prototype.evaluateOutbound = function evaluateOutbound(fromMessage, discardRestAtTake, callback) {
   return this[kFlows].outboundEvaluator.evaluate(fromMessage, discardRestAtTake, callback);
 };
-Activity.prototype.getState = function getState() {
-  const msg = this._createMessage();
-  const exec = this[kExec];
-  return {
-    ...msg,
-    executionId: exec.executionId,
-    stopped: this.stopped,
-    behaviour: {
-      ...this.behaviour
-    },
-    counters: this.counters,
-    broker: this.broker.getState(true),
-    execution: exec.execution && exec.execution.getState()
-  };
-};
 Activity.prototype.getApi = function getApi(message) {
   const execution = this[kExec].execution;
   if (execution && !execution.completed) return execution.getApi(message);

package/dist/definition/Definition.js

@@ -156,6 +156,16 @@ Definition.prototype.resume = function resume(callback) {
   this._activateRunConsumers();
   return this;
 };
+Definition.prototype.getState = function getState() {
+  return this._createMessage({
+    status: this.status,
+    stopped: this.stopped,
+    counters: this.counters,
+    environment: this.environment.getState(),
+    execution: this.execution && this.execution.getState(),
+    broker: this.broker.getState(true)
+  });
+};
 Definition.prototype.recover = function recover(state) {
   if (this.isRunning) throw new Error('cannot recover running definition');
   if (!state) return this;
@@ -209,16 +219,6 @@ Definition.prototype._shakeProcess = function shakeProcess(shakeBp, startId) {
   if (shovel) shakeBp.broker.closeShovel('shaker');
   return shakeResult;
 };
-Definition.prototype.getState = function getState() {
-  return this._createMessage({
-    status: this.status,
-    stopped: this.stopped,
-    counters: this.counters,
-    environment: this.environment.getState(),
-    execution: this.execution && this.execution.getState(),
-    broker: this.broker.getState(true)
-  });
-};
 Definition.prototype.getProcesses = function getProcesses() {
   const execution = this.execution;
   if (execution) return execution.getProcesses();

package/dist/flows/Association.js

@@ -72,10 +72,12 @@ Association.prototype.discard = function discard(content = {}) {
   return true;
 };
 Association.prototype.getState = function getState() {
-  return this._createMessageContent({
+  return {
+    id: this.id,
+    type: this.type,
     counters: this.counters,
     broker: this.broker.getState(true)
-  });
+  };
 };
 Association.prototype.recover = function recover(state) {
   Object.assign(this[kCounters], state.counters);

package/dist/flows/MessageFlow.js

@@ -59,11 +59,13 @@ MessageFlow.prototype.getState = function getState() {
   return {
     id: this.id,
     type: this.type,
-    counters: this.counters
+    counters: this.counters,
+    broker: this.broker.getState(true)
   };
 };
 MessageFlow.prototype.recover = function recover(state) {
   Object.assign(this[kCounters], state.counters);
+  this.broker.recover(state.broker);
 };
 MessageFlow.prototype.getApi = function getApi(message) {
   return new _Api.Api('message', this.broker, message || {

package/dist/flows/SequenceFlow.js

@@ -94,10 +94,12 @@ SequenceFlow.prototype.discard = function discard(content = {}) {
   this._publishEvent('discard', content);
 };
 SequenceFlow.prototype.getState = function getState() {
-  return this.createMessage({
+  return {
+    id: this.id,
+    type: this.type,
     counters: this.counters,
     broker: this.broker.getState(true)
-  });
+  };
 };
 SequenceFlow.prototype.recover = function recover(state) {
   Object.assign(this[kCounters], state.counters);

package/dist/process/Process.js

@@ -167,6 +167,19 @@ Process.prototype.resume = function resume() {
   this._activateRunConsumers();
   return this;
 };
+Process.prototype.getState = function getState() {
+  return {
+    id: this.id,
+    type: this.type,
+    executionId: this.executionId,
+    environment: this.environment.getState(),
+    status: this.status,
+    stopped: this.stopped,
+    counters: this.counters,
+    broker: this.broker.getState(true),
+    execution: this.execution && this.execution.getState()
+  };
+};
 Process.prototype.recover = function recover(state) {
   if (this.isRunning) throw new Error(`cannot recover running process <${this.id}>`);
   if (!state) return this;
@@ -203,16 +216,6 @@ Process.prototype.signal = function signal(message) {
     delegate: true
   });
 };
-Process.prototype.getState = function getState() {
-  return this._createMessage({
-    environment: this.environment.getState(),
-    status: this.status,
-    stopped: this.stopped,
-    counters: this.counters,
-    broker: this.broker.getState(true),
-    execution: this.execution && this.execution.getState()
-  });
-};
 Process.prototype.cancelActivity = function cancelActivity(message) {
   return this.getApi().cancel(message, {
     delegate: true

package/dist/process/ProcessExecution.js

@@ -157,6 +157,34 @@ ProcessExecution.prototype.resume = function resume() {
   if (this[kCompleted]) return;
   if (!postponed.length && status === 'executing') return this._complete('completed');
 };
+ProcessExecution.prototype.getState = function getState() {
+  const {
+    children,
+    flows,
+    outboundMessageFlows,
+    associations
+  } = this[kElements];
+  return {
+    executionId: this.executionId,
+    stopped: this[kStopped],
+    completed: this[kCompleted],
+    status: this.status,
+    children: children.reduce((result, activity) => {
+      if (activity.placeholder) return result;
+      result.push(activity.getState());
+      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())
+    })
+  };
+};
 ProcessExecution.prototype.recover = function recover(state) {
   if (!state) return this;
   this.executionId = state.executionId;
@@ -271,34 +299,6 @@ ProcessExecution.prototype.cancel = function discard() {
     type: 'cancel'
   });
 };
-ProcessExecution.prototype.getState = function getState() {
-  const {
-    children,
-    flows,
-    outboundMessageFlows,
-    associations
-  } = this[kElements];
-  return {
-    executionId: this.executionId,
-    stopped: this[kStopped],
-    completed: this[kCompleted],
-    status: this.status,
-    children: children.reduce((result, activity) => {
-      if (activity.placeholder) return result;
-      result.push(activity.getState());
-      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())
-    })
-  };
-};
 ProcessExecution.prototype.getActivities = function getActivities() {
   return this[kElements].children.slice();
 };

package/dist/tasks/SubProcess.js

@@ -86,7 +86,6 @@ SubProcessBehaviour.prototype.execute = function execute(executeMessage) {
     return loopCharacteristics.execute(executeMessage);
   }
   const processExecution = this._upsertExecution(executeMessage);
-  if (!processExecution) return;
   return processExecution.execute(executeMessage);
 };
 SubProcessBehaviour.prototype.stop = function stop() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bpmn-elements",
-  "version": "10.1.0",
+  "version": "11.0.1",
   "description": "Executable workflow elements based on BPMN 2.0",
   "type": "module",
   "main": "dist/index.js",
@@ -13,11 +13,11 @@
   },
   "sideEffects": false,
   "scripts": {
-    "test": "mocha -R @bonniernews/hot-bev -p -t 2000",
+    "test": "mocha -R @bonniernews/hot-bev -p -t 3000",
     "posttest": "npm run lint && npm run dist",
     "lint": "eslint . --cache",
     "prepack": "npm run dist",
-    "cov:html": "c8 -r html -r text mocha -R @bonniernews/hot-bev -p -t 2000",
+    "cov:html": "c8 -r html -r text mocha -R @bonniernews/hot-bev -p -t 3000",
     "test:lcov": "c8 -r lcov mocha && npm run lint",
     "dist": "babel src -d dist/"
   },
@@ -51,12 +51,12 @@
     "@babel/register": "^7.22.5",
     "@bonniernews/hot-bev": "^0.4.0",
     "bpmn-moddle": "^8.0.1",
-    "c8": "^7.14.0",
+    "c8": "^8.0.0",
     "camunda-bpmn-moddle": "^7.0.1",
     "chai": "^4.3.7",
     "chronokinesis": "^5.0.2",
     "debug": "^4.3.4",
-    "eslint": "^8.42.0",
+    "eslint": "^8.43.0",
     "eslint-plugin-import": "^2.27.5",
     "got": "^12.6.1",
     "mocha": "^10.1.0",

package/src/activity/Activity.js

@@ -301,6 +301,21 @@ Activity.prototype.run = function run(runContent) {
   this._consumeRunQ();
 };
 
+Activity.prototype.getState = function getState() {
+  const status = this.status;
+  const exec = this[kExec];
+  return {
+    id: this.id,
+    type: this.type,
+    ...(status && {status}),
+    executionId: exec.executionId,
+    stopped: this.stopped,
+    counters: this.counters,
+    broker: this.broker.getState(true),
+    execution: exec.execution && exec.execution.getState(),
+  };
+};
+
 Activity.prototype.recover = function recover(state) {
   if (this.isRunning) throw new Error(`cannot recover running activity <${this.id}>`);
   if (!state) return;
@@ -389,21 +404,6 @@ Activity.prototype.evaluateOutbound = function evaluateOutbound(fromMessage, dis
   return this[kFlows].outboundEvaluator.evaluate(fromMessage, discardRestAtTake, callback);
 };
 
-Activity.prototype.getState = function getState() {
-  const msg = this._createMessage();
-
-  const exec = this[kExec];
-  return {
-    ...msg,
-    executionId: exec.executionId,
-    stopped: this.stopped,
-    behaviour: {...this.behaviour},
-    counters: this.counters,
-    broker: this.broker.getState(true),
-    execution: exec.execution && exec.execution.getState(),
-  };
-};
-
 Activity.prototype.getApi = function getApi(message) {
   const execution = this[kExec].execution;
   if (execution && !execution.completed) return execution.getApi(message);

package/src/definition/Definition.js

@@ -162,6 +162,17 @@ Definition.prototype.resume = function resume(callback) {
   return this;
 };
 
+Definition.prototype.getState = function getState() {
+  return this._createMessage({
+    status: this.status,
+    stopped: this.stopped,
+    counters: this.counters,
+    environment: this.environment.getState(),
+    execution: this.execution && this.execution.getState(),
+    broker: this.broker.getState(true),
+  });
+};
+
 Definition.prototype.recover = function recover(state) {
   if (this.isRunning) throw new Error('cannot recover running definition');
   if (!state) return this;
@@ -222,17 +233,6 @@ Definition.prototype._shakeProcess = function shakeProcess(shakeBp, startId) {
   return shakeResult;
 };
 
-Definition.prototype.getState = function getState() {
-  return this._createMessage({
-    status: this.status,
-    stopped: this.stopped,
-    counters: this.counters,
-    environment: this.environment.getState(),
-    execution: this.execution && this.execution.getState(),
-    broker: this.broker.getState(true),
-  });
-};
-
 Definition.prototype.getProcesses = function getProcesses() {
   const execution = this.execution;
   if (execution) return execution.getProcesses();

package/src/flows/Association.js

@@ -59,10 +59,12 @@ Association.prototype.discard = function discard(content = {}) {
 };
 
 Association.prototype.getState = function getState() {
-  return this._createMessageContent({
+  return {
+    id: this.id,
+    type: this.type,
     counters: this.counters,
     broker: this.broker.getState(true),
-  });
+  };
 };
 
 Association.prototype.recover = function recover(state) {

package/src/flows/MessageFlow.js

@@ -46,11 +46,13 @@ MessageFlow.prototype.getState = function getState() {
     id: this.id,
     type: this.type,
     counters: this.counters,
+    broker: this.broker.getState(true),
   };
 };
 
 MessageFlow.prototype.recover = function recover(state) {
   Object.assign(this[kCounters], state.counters);
+  this.broker.recover(state.broker);
 };
 
 MessageFlow.prototype.getApi = function getApi(message) {

package/src/flows/SequenceFlow.js

@@ -75,10 +75,12 @@ SequenceFlow.prototype.discard = function discard(content = {}) {
 };
 
 SequenceFlow.prototype.getState = function getState() {
-  return this.createMessage({
+  return {
+    id: this.id,
+    type: this.type,
     counters: this.counters,
     broker: this.broker.getState(true),
-  });
+  };
 };
 
 SequenceFlow.prototype.recover = function recover(state) {

package/src/process/Process.js

@@ -161,6 +161,20 @@ Process.prototype.resume = function resume() {
   return this;
 };
 
+Process.prototype.getState = function getState() {
+  return {
+    id: this.id,
+    type: this.type,
+    executionId: this.executionId,
+    environment: this.environment.getState(),
+    status: this.status,
+    stopped: this.stopped,
+    counters: this.counters,
+    broker: this.broker.getState(true),
+    execution: this.execution && this.execution.getState(),
+  };
+};
+
 Process.prototype.recover = function recover(state) {
   if (this.isRunning) throw new Error(`cannot recover running process <${this.id}>`);
   if (!state) return this;
@@ -201,17 +215,6 @@ Process.prototype.signal = function signal(message) {
   return this.getApi().signal(message, {delegate: true});
 };
 
-Process.prototype.getState = function getState() {
-  return this._createMessage({
-    environment: this.environment.getState(),
-    status: this.status,
-    stopped: this.stopped,
-    counters: this.counters,
-    broker: this.broker.getState(true),
-    execution: this.execution && this.execution.getState(),
-  });
-};
-
 Process.prototype.cancelActivity = function cancelActivity(message) {
   return this.getApi().cancel(message, {delegate: true});
 };

package/src/process/ProcessExecution.js

@@ -169,6 +169,24 @@ ProcessExecution.prototype.resume = function resume() {
   if (!postponed.length && status === 'executing') return this._complete('completed');
 };
 
+ProcessExecution.prototype.getState = function getState() {
+  const {children, flows, outboundMessageFlows, associations} = this[kElements];
+  return {
+    executionId: this.executionId,
+    stopped: this[kStopped],
+    completed: this[kCompleted],
+    status: this.status,
+    children: children.reduce((result, activity) => {
+      if (activity.placeholder) return result;
+      result.push(activity.getState());
+      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())}),
+  };
+};
+
 ProcessExecution.prototype.recover = function recover(state) {
   if (!state) return this;
   this.executionId = state.executionId;
@@ -282,24 +300,6 @@ ProcessExecution.prototype.cancel = function discard() {
   }, { type: 'cancel' });
 };
 
-ProcessExecution.prototype.getState = function getState() {
-  const {children, flows, outboundMessageFlows, associations} = this[kElements];
-  return {
-    executionId: this.executionId,
-    stopped: this[kStopped],
-    completed: this[kCompleted],
-    status: this.status,
-    children: children.reduce((result, activity) => {
-      if (activity.placeholder) return result;
-      result.push(activity.getState());
-      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())}),
-  };
-};
-
 ProcessExecution.prototype.getActivities = function getActivities() {
   return this[kElements].children.slice();
 };

package/src/tasks/SubProcess.js

@@ -76,8 +76,6 @@ SubProcessBehaviour.prototype.execute = function execute(executeMessage) {
   }
 
   const processExecution = this._upsertExecution(executeMessage);
-  if (!processExecution) return;
-
   return processExecution.execute(executeMessage);
 };
 

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;