fix: reset state machine config after force override

Author: Tom Kirkpatrick

lib/index.js

@@ -42,14 +42,12 @@ module.exports = function loopbackComponentFsm(app) {
     const cacheKey = generateCacheKey(instance)
     let cache = _.get(app.locals, cacheKey)
 
-    debug('Fetching cached state machine found for subscription %s (cache key=%s)', instance.id, cacheKey)
-
     if (cache) {
-      debug('Cached state machine found for subscription %s', instance.id)
+      debug('Fetched cached state machine for instance %s (cache key=%s)', instance.id, cacheKey)
       return cache
     }
+    debug('No cached state machine for instance %s (cache key=%s)', instance.id, cacheKey)
 
-    debug('No cached state machine found for subscription %s', instance.id)
     let config = getStateMachineConfig(modelName)
 
     if (!config) {
@@ -58,7 +56,9 @@ module.exports = function loopbackComponentFsm(app) {
 
     config = Object.assign(config, { initial: instance.status })
     cache = new StateMachine(config)
-    debug('Caching state machine subscription %s: %o', instance.id, cache)
+    debug('Created new state machine for instance %s with config %o', instance.id, config)
+
+    debug('Caching state machine for instance %s', instance.id)
     _.set(app.locals, cacheKey, cache)
 
     return cache
@@ -78,7 +78,7 @@ module.exports = function loopbackComponentFsm(app) {
     debug('Deleting cached state machine for subscription %s (cache key=%s)', instance.id, cacheKey)
 
     if (!_.get(app.locals, cacheKey)) {
-      debug('Existing cached state machine not found for subscription %s (cache key=%s)', instance.id, cacheKey)
+      debug('Existing cached state machine not for instance %s (cache key=%s)', instance.id, cacheKey)
       return false
     }
 

lib/mixins/state-machine.js

@@ -133,14 +133,26 @@ module.exports = function StateMachine(Model, settings) {
       const forceEventSetting = _.get(settings, `events[${eventNameIndex}].settings.allowForce`)
       const force = _.get(params, 'force')
 
+      const origFrom = Model.__FSM_CONFIG__.events[eventNameIndex].from
+      const newFrom = [ ...origFrom, this.status ]
+
       // If force has been requested, override the state machine config.
       if (force && (forceFsmSetting || forceEventSetting)) {
-        _.assign(settings.events[eventNameIndex].from, [ this.status ])
+        debug('Force option set - updating list of allowed states for %s to %o', eventName, newFrom)
+        _.set(Model.__FSM_CONFIG__, `events[${eventNameIndex}].from`, newFrom)
       }
 
       // Get the FSM.
       const fms = Model.app.getStateMachine(this)
 
+      // Reset the state machine config.
+      // If force has been requested, override the state machine config.
+      if (force && (forceFsmSetting || forceEventSetting)) {
+        debug('Force option set - resetting list of allowed states for %s (index %s) to %o',
+          eventName, eventNameIndex, origFrom)
+        _.set(Model.__FSM_CONFIG__, `events[${eventNameIndex}].from`, origFrom)
+      }
+
       // Run the event method.
       return fms[eventName](this, ...args)
         .then(result => result)

package.json

@@ -43,6 +43,7 @@
     "condition-circle": "1.5.0",
     "cors": "2.8.3",
     "coveralls": "2.13.1",
+    "dirty-chai": "2.0.0",
     "eslint": "2.13.1",
     "eslint-config-fullcube": "latest",
     "eslint-plugin-mocha": "4.11.0",

test/fullcube-state-machine/common/models/order.js

@@ -0,0 +1,39 @@
+'use strict'
+
+const Promise = require('bluebird')
+const log = require('loglevel')
+
+log.enableAll()
+
+module.exports = function OrderModel(Order) {
+  // Prepare
+  Order.observe('fsm:oneprepare', ctx => {
+    log.info(`Preparing order ${ctx.instance.id}`)
+    return Promise.delay(100)
+  })
+  Order.observe('fsm:onenteredprepared', ctx => {
+    log.info(`Sucessfully prepared order ${ctx.instance.id}`)
+    return Promise.resolve(ctx)
+  })
+
+  // Cancel
+  Order.observe('fsm:oncancel', ctx => {
+    log.info(`Canceling order ${ctx.instance.id}`)
+    return Promise.delay(100)
+  })
+  Order.observe('fsm:onenteredcanceled', ctx => {
+    log.info(`Sucessfully canceled order ${ctx.instance.id}`)
+    return Promise.resolve(ctx)
+  })
+
+  // Deliver
+  Order.observe('fsm:ondeliver', ctx => {
+    log.info(`Delivering order ${ctx.instance.id}`)
+    return Promise.delay(100)
+  })
+  Order.observe('fsm:onentereddelivered', ctx => {
+    log.info(`Sucessfully delivered order ${ctx.instance.id}`)
+    return Promise.resolve(ctx)
+  })
+
+}

test/fullcube-state-machine/common/models/order.json

@@ -9,7 +9,7 @@
     "status": {
       "type": "string",
       "required": true,
-      "default": "prepare"
+      "default": "prepared"
     }
   },
   "validations": [],
@@ -76,8 +76,8 @@
         "allowForce": true
       },
       "events": [
-        { "name": "cancel", "from": "prepare", "to": "canceled" },
-        { "name": "deliver", "from": "prepare", "to": "delivered", "settings": { "allowForce" : true } },
+        { "name": "cancel", "from": "prepared", "to": "canceled" },
+        { "name": "deliver", "from": "prepared", "to": "delivered", "settings": { "allowForce" : true } },
         { "name": "prepare", "from": [ "none" ], "to": "prepared" }
       ]
     }

test/fullcube-state-machine/common/providers/order.js

@@ -10,25 +10,25 @@ module.exports = class FcSubscription {
     this.instance = instance
   }
   activate() {
-    return Promise.delay(2000).then(() => {
+    return Promise.delay(100).then(() => {
       log.info(`Subscription ${this.instance.id} activated`)
     })
   }
 
   cancel() {
-    return Promise.delay(2000).then(() => {
+    return Promise.delay(100).then(() => {
       log.info(`Subscription ${this.instance.id} canceled`)
     })
   }
 
   reactivate() {
-    return Promise.delay(2000).then(() => {
+    return Promise.delay(100).then(() => {
       log.info(`Subscription ${this.instance.id} reactivated`)
     })
   }
 
   expire() {
-    return Promise.delay(2000).then(() => {
+    return Promise.delay(100).then(() => {
       log.info(`Subscription ${this.instance.id} expired`)
     })
   }

test/fullcube-state-machine/common/providers/subscription.js

@@ -1,10 +1,13 @@
+/* eslint no-console: 0 */
+
 'use strict'
 
 const Promise = require('bluebird')
 const path = require('path')
 const chai = require('chai')
 const sinon = require('sinon')
 
+chai.use(require('dirty-chai'))
 chai.use(require('sinon-chai'))
 
 const expect = chai.expect
@@ -275,10 +278,8 @@ describe('Cache', function() {
 
 describe('Force status update', function() {
   beforeEach(function() {
-    return Order.create({ status: 'prepare' })
-      .then(order => {
-        this.order = order
-      })
+    return Order.create()
+      .then(order => (this.order = order))
   })
 
   describe('allowed', function() {
@@ -308,14 +309,29 @@ describe('Force status update', function() {
 
   describe('not allowed', function() {
     it('should not allow invalid state change', function() {
+      this.deliveredSpy = sinon.spy()
+      this.canceledSpy = sinon.spy()
+      Order.observe('fsm:onentereddelivered', ctx => {
+        this.deliveredSpy()
+        return Promise.resolve(ctx)
+      })
+      Order.observe('fsm:onenteredcanceled', ctx => {
+        this.canceledSpy()
+        return Promise.resolve(ctx)
+      })
       return this.order.deliver()
         .then(order => order.cancel())
         .catch(err => {
+          expect(this.order).to.have.property('status', 'delivered')
           expect(err).to.have.property('message', 'Invalid event in current state')
           return this.order.reload().then(order => {
             expect(order).to.have.property('status', 'delivered')
           })
         })
+        .finally(() => {
+          expect(this.deliveredSpy).to.have.been.calledOnce()
+          expect(this.canceledSpy).to.not.have.been.called()
+        })
     })
   })
 })