disallow recovering or resuming a running engine

minor update of moddle-context-serializer

Author: paed01

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [25.0.0] - 2025-03-17
+
+It has been possible to recover a running engine. The execution was overwritten and all references to timers etc was lost. This stops with this version. Either stop the the execution or wait for it to end if the engine should be re-used. It is highly recommended to initiate a new Engine when recovering from state.
+
+### Breaking
+
+- Disallow a running engine to be recovered and resumed. Recommended is to recover and resume a new Engine instance with state or stop the instance before recovering.
+
 ## [24.0.1] - 2025-03-14
 
 - fix recover engine with options not keeping scripts and logger from when initiated

docs/API.md

@@ -1,6 +1,6 @@
 <!-- version -->
 
-# 24.0.0 API Reference
+# 25.0.0 API Reference
 
 <!-- versionstop -->
 
@@ -508,6 +508,8 @@ engine.execute({
 
 Recover engine from state.
 
+> NB! Will throw an error if the engine is running.
+
 Arguments:
 
 - `state`: engine state
@@ -524,6 +526,8 @@ const engine = new Engine().recover(state);
 
 Resume execution function with previously saved engine state.
 
+> NB! Attempting to resume a running engine returns error in callback or throws if callback is not passed.
+
 Arguments:
 
 - `options`: optional resume options object

lib/index.cjs

@@ -281,9 +281,7 @@ Engine.prototype.stop = function stop() {
 
 Engine.prototype.recover = function recover(savedState, recoverOptions) {
   if (this[kExecution]?.isRunning) {
-    this.logger.error('recover during running execution will be deprecated next major version');
-    this.logger.debug(`<${this.name}> stopping current running execution`);
-    this[kExecution].stop();
+    throw new Error('cannot recover a running engine');
   }
 
   if (!savedState) return this;
@@ -338,6 +336,10 @@ Engine.prototype.resume = async function resume(...args) {
       throw err;
     }
     execution = this[kExecution] = new Execution(this, definitions, this.options);
+  } else if (execution.isRunning) {
+    const err = new Error('cannot resume a running engine');
+    if (callback) return callback(err);
+    throw err;
   }
 
   return execution._resume(resumeOptions, callback);

package.json

@@ -1,7 +1,7 @@
 {
   "name": "bpmn-engine",
   "description": "BPMN 2.0 execution engine. Open source javascript workflow engine.",
-  "version": "24.0.1",
+  "version": "25.0.0",
   "type": "module",
   "module": "./src/index.js",
   "main": "./lib/index.cjs",
@@ -72,7 +72,7 @@
     "bpmn-elements": "^17.0.0",
     "bpmn-moddle": "^9.0.1",
     "debug": "^4.3.7",
-    "moddle-context-serializer": "^4.2.1"
+    "moddle-context-serializer": "^4.3.0"
   },
   "peerDependencies": {
     "smqp": ">=9"

src/index.js

@@ -135,9 +135,7 @@ Engine.prototype.stop = function stop() {
 
 Engine.prototype.recover = function recover(savedState, recoverOptions) {
   if (this[kExecution]?.isRunning) {
-    this.logger.error('recover during running execution will be deprecated next major version');
-    this.logger.debug(`<${this.name}> stopping current running execution`);
-    this[kExecution].stop();
+    throw new Error('cannot recover a running engine');
   }
 
   if (!savedState) return this;
@@ -192,6 +190,10 @@ Engine.prototype.resume = async function resume(...args) {
       throw err;
     }
     execution = this[kExecution] = new Execution(this, definitions, this.options);
+  } else if (execution.isRunning) {
+    const err = new Error('cannot resume a running engine');
+    if (callback) return callback(err);
+    throw err;
   }
 
   return execution._resume(resumeOptions, callback);

test/feature/issues/issue-199-feature.js

@@ -86,6 +86,10 @@ Feature('issue 199 - Issue with Script Tasks After State Recovery in bpmn-engine
       expect(execution.state).to.equal('running');
     });
 
+    Given('execution is stopped', () => {
+      return execution.stop();
+    });
+
     When('same instance is recovered with options', () => {
       engine.recover(state, {
         services: {

test/feature/resume-feature.js

@@ -329,8 +329,39 @@ Feature('Resume execution', () => {
       expect(execution1.activityStatus).to.equal('timer');
     });
 
+    And('attempting to recover a running engine instance throws', () => {
+      expect(() => {
+        engine.recover(execution1.getState(), {
+          settings: {
+            mySetting: 1,
+          },
+        });
+      }).to.throw(/running/);
+    });
+
+    And('attempting to resume a running engine instance throws', async () => {
+      try {
+        await engine.resume();
+      } catch (err) {
+        // eslint-disable-next-line no-var
+        var error = err;
+      }
+      expect(error).to.match(/running/);
+    });
+
+    And('attempting to resume a running engine instance with callback returns error in callback', (done) => {
+      engine.resume((err) => {
+        expect(err).to.match(/running/);
+        done();
+      });
+    });
+
+    Given('execution is stopped', () => {
+      return execution1.stop();
+    });
+
     let execution2;
-    When('same instance is recovered options and resumed', async () => {
+    When('same instance is recovered with options and resumed', async () => {
       engine.recover(execution1.getState(), {
         settings: {
           mySetting: 1,