status_workflow 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f0b810a0de956ac985342e3f395cd3ca3370a023
-  data.tar.gz: c2cd573069b22280b2073088f71ed42489fa6897
+  metadata.gz: 31fac79b181eaf226d6f199406c58b23f2860674
+  data.tar.gz: abb35fc730390397b21692c0a0f398a9628253e1
 SHA512:
-  metadata.gz: cf15a846af4ca562412ef389e9383bff8132d302c60fdb2d255aad602dba1692b061e4745fa70e562739c5d4efc9f3d65fe929d5ce014b02e7c9aa12fff86ac2
-  data.tar.gz: 0ffcb10c6b5a145d7c1cd9806f3808317a69091b988ee6c2bb7f225b75d04aac828dad8bb641157001c7d4013132c53d7f29af3104370c05116e8fcf7110a705
+  metadata.gz: e7f31170e7845fcd47a2f0f9ab5e68c08b6a7eae0226f784b8060d563a4ffa812ca21d7ff79230e248fb899d2a325d57299ce830ade5ffb4776d412247889a85
+  data.tar.gz: 271e5943314d59d02ca2a8e48e2cd5750077fbea2986605c2ca3d0074de16efca5bbb407cbd5fc76b6d1316bb4a80629c8ddff2d877b574a9d9e7da5c1b9f50c

data/.gitignore

@@ -10,3 +10,4 @@
 
 # rspec failure tracking
 .rspec_status
+*.gem

data/.travis.yml

@@ -4,3 +4,4 @@ rvm:
   - 2.5
 services:
   - redis-server
+  - postgresql

data/CHANGELOG

@@ -1,3 +1,9 @@
+1.0.1 / 2018-09-28
+
+Enhancements
+
+  * Allow passing a block to be executed before the state transition
+
 1.0.0 / 2018-09-23
 
 Initial extraction from Faraday production systems

data/README.md

@@ -1,5 +1,7 @@
 # StatusWorkflow
 
+[![Build Status](https://travis-ci.org/faradayio/status_workflow_ruby.svg?branch=master)](https://travis-ci.org/faradayio/status_workflow_ruby)
+
 Basic state machine using Redis for locking.
 
 ```

data/lib/status_workflow.rb

@@ -1,5 +1,6 @@
 require 'status_workflow/version'
 require 'timeout'
+require 'set'
 
 module StatusWorkflow
   class InvalidTransition < StandardError; end
@@ -16,29 +17,57 @@ module StatusWorkflow
     @redis or raise("please set StatusWorkflow.redis=")
   end
 
+  LOCK_ACQUISITION_TIMEOUT = 8
+  LOCK_EXPIRY = 4
+  LOCK_CHECK_RATE = 0.2
+
   module ClassMethods
     def status_workflow(transitions)
       transitions.inject({}) do |memo, (from_status, to_statuses)|
         to_statuses.each do |to_status|
-          memo[to_status] ||= []
+          memo[to_status] ||= Set.new
           memo[to_status] << from_status
         end
         memo
       end.each do |to_status, from_statuses|
-        define_method "enter_#{to_status}!" do
+        define_method "enter_#{to_status}!" do |&blk|
           lock_key = "status_workflow/#{self.class.name}/#{id}"
-          Timeout.timeout(8, nil, "timeout waiting for #{self.class.name}/#{id} lock") do
-            until StatusWorkflow.redis.set(lock_key, true, nx: true, ex: 4)
-              sleep 0.2
+          # Give ourselves 8 seconds to get the lock, checking every 0.2 seconds
+          Timeout.timeout(LOCK_ACQUISITION_TIMEOUT, nil, "timeout waiting for #{self.class.name}/#{id} lock") do
+            until StatusWorkflow.redis.set(lock_key, true, nx: true, ex: LOCK_EXPIRY)
+              sleep LOCK_CHECK_RATE
             end
           end
-          # got the lock, i have 3 (4 expiry on lock - 1 for safety) seconds to set it
-          Timeout.timeout(3, nil, "timeout waiting for #{self.class.name}/#{id} status update") do
-            # depend on #can_enter_X to reload
-            raise InvalidTransition, "can't enter #{to_status} from #{status}, expected #{from_statuses.join('/')}" unless send("can_enter_#{to_status}?")
+          heartbeat = nil
+          begin
+            # Give ourselves 2 seconds to check the status of the lock
+            Timeout.timeout(2, nil, "timeout waiting for #{self.class.name}/#{id} status check") do
+              # depend on #can_enter_X to reload
+              raise InvalidTransition, "can't enter #{to_status} from #{status}, expected #{from_statuses.to_a.join('/')}" unless send("can_enter_#{to_status}?")
+            end
+            # If a block was given, start a heartbeat thread
+            if blk
+              begin
+                heartbeat = Thread.new do
+                  loop do
+                    StatusWorkflow.redis.expire lock_key, LOCK_EXPIRY
+                    sleep LOCK_EXPIRY/2
+                  end
+                end
+                blk.call
+              rescue
+                # If the block errors, set status to error and record the backtrace
+                error = (["#{$!.class} #{$!.message}"] + $!.backtrace).join("\n")
+                update_columns status: 'error', status_changed_at: Time.now, error: error
+                raise
+              end
+            end
+            # Success!
             update_columns status: to_status, status_changed_at: Time.now
+          ensure
+            StatusWorkflow.redis.del lock_key
+            heartbeat.kill if heartbeat
           end
-          StatusWorkflow.redis.del lock_key
           true
         end
         define_method "can_enter_#{to_status}?" do

data/lib/status_workflow/version.rb

@@ -1,3 +1,3 @@
 module StatusWorkflow
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: status_workflow
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Seamus Abshere
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-23 00:00:00.000000000 Z
+date: 2018-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis