statesman 3.5.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9fb352daa2f2ec337dd202cc2615a7e0925741a4
-  data.tar.gz: 9de7812c9356e6e9f98a317b503220b3a7f7709b
+  metadata.gz: 5063951e126e3898569d97511ea5c89149122c3e
+  data.tar.gz: 888fcdc8b6bfbde03dbc4471fa3d84f58fd0871e
 SHA512:
-  metadata.gz: fbd8b2b4b822b2f7148cb7b47111153e6cd18831e227cf6c72ca073904866025eb3e1d433f503e778853734c0f522e674ad29cad44ec5bc29fdfda7e55130275
-  data.tar.gz: d55e7635f0773babcc1b5ef9da6f75a4144c8812ce305b93e1762e6100e658bd73f2989bb867efcb0be42225f1dfa49a67aeb064c1c287df62720c8afc693d4b
+  metadata.gz: c4f1b64670d9b94c53f65ef3ed7182be77388c732536906d7066db8e0970016ad1e0cec26148d62b5cd32719e446a253033da3b1e8dd5c0c5e813834715e032f
+  data.tar.gz: 8c5ab391235a0f4b073fee60eeea93c4752e9f5a2d71a6b05ba955cebfd5bae61921bf87ac9769a967db05439cd907e5de6be1fe5f8d5a45a80fc4588b722d9a

data/.circleci/config.yml

@@ -11,7 +11,7 @@ references:
     - type: cache-restore
       key: statesman-{{ checksum "Gemfile" }}-{{ checksum "~/RAILS_VERSION.txt" }}
 
-    - run: gem install bundler
+    - run: gem install bundler -v 1.3
 
     - run: bundle install --path vendor/bundle
 

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## v4.0.0, 22 February 2019
+
+- Forces Statesman to use a new transactions with `requires_new: true` (https://github.com/gocardless/statesman/pull/249)
+- Fixes an issue with `after_commit` transition blocks that where being
+    executed even if the transaction rolled back. ([patch](https://github.com/gocardless/statesman/pull/338) by [@matid](https://github.com/matid))
+
 ## v3.5.0, 2 November 2018
 
 - Expose `most_recent_transition_join` - ActiveRecords `or` requires that both

data/lib/statesman/adapters/active_record.rb

@@ -25,6 +25,7 @@ module Statesman
         elsif serialized && JSON_COLUMN_TYPES.include?(column_type)
           raise IncompatibleSerializationError, transition_class.name
         end
+
         @transition_class = transition_class
         @parent_model = parent_model
         @observer = observer
@@ -36,6 +37,7 @@ module Statesman
         create_transition(from.to_s, to.to_s, metadata)
       rescue ::ActiveRecord::RecordNotUnique => e
         raise TransitionConflictError, e.message if transition_conflict_error? e
+
         raise
       ensure
         @last_transition = nil
@@ -70,18 +72,26 @@ module Statesman
 
         transition = transitions_for_parent.build(transition_attributes)
 
-        ::ActiveRecord::Base.transaction do
+        ::ActiveRecord::Base.transaction(requires_new: true) do
           @observer.execute(:before, from, to, transition)
           unset_old_most_recent
           transition.save!
           @last_transition = transition
           @observer.execute(:after, from, to, transition)
+          add_after_commit_callback(from, to, transition)
         end
-        @observer.execute(:after_commit, from, to, transition)
 
         transition
       end
 
+      def add_after_commit_callback(from, to, transition)
+        ::ActiveRecord::Base.connection.add_transaction_record(
+          ActiveRecordAfterCommitWrap.new do
+            @observer.execute(:after_commit, from, to, transition)
+          end,
+        )
+      end
+
       def transitions_for_parent
         @parent_model.send(@association_name)
       end
@@ -147,5 +157,31 @@ module Statesman
         params.merge(column => timestamp)
       end
     end
+
+    class ActiveRecordAfterCommitWrap
+      def initialize
+        @callback = Proc.new
+        @connection = ::ActiveRecord::Base.connection
+      end
+
+      # rubocop: disable Naming/PredicateName
+      def has_transactional_callbacks?
+        true
+      end
+      # rubocop: enable Naming/PredicateName
+
+      def committed!(*)
+        @callback.call
+      end
+
+      def before_committed!(*); end
+
+      def rolledback!(*); end
+
+      # Required for +transaction(requires_new: true)+
+      def add_to_transaction(*)
+        @connection.add_transaction_record(self)
+      end
+    end
   end
 end

data/lib/statesman/machine.rb

@@ -46,10 +46,10 @@ module Statesman
 
       def callbacks
         @callbacks ||= {
-          before:       [],
-          after:        [],
+          before: [],
+          after: [],
           after_commit: [],
-          guards:       [],
+          guards: [],
         }
       end
 

data/lib/statesman/version.rb

@@ -1,3 +1,3 @@
 module Statesman
-  VERSION = "3.5.0".freeze
+  VERSION = "4.0.0".freeze
 end

data/lib/tasks/statesman.rake

@@ -19,7 +19,7 @@ namespace :statesman do
     batch_size = 500
 
     parent_class.find_in_batches(batch_size: batch_size) do |models|
-      ActiveRecord::Base.transaction do
+      ActiveRecord::Base.transaction(requires_new: true) do
         if Statesman::Adapters::ActiveRecord.database_supports_partial_indexes?
           # Set all transitions' most_recent to FALSE
           transition_class.where(parent_fk => models.map(&:id)).

data/spec/statesman/adapters/active_record_queries_spec.rb

@@ -168,4 +168,38 @@ describe Statesman::Adapters::ActiveRecordQueries, active_record: true do
       end
     end
   end
+
+  context "after_commit transactional integrity" do
+    before do
+      MyStateMachine.class_eval do
+        cattr_accessor(:after_commit_callback_executed) { false }
+
+        after_transition(from: :initial, to: :succeeded, after_commit: true) do
+          # This leaks state in a testable way if transactional integrity is broken.
+          MyStateMachine.after_commit_callback_executed = true
+        end
+      end
+    end
+
+    after do
+      MyStateMachine.class_eval do
+        callbacks[:after_commit] = []
+      end
+    end
+
+    let!(:model) do
+      MyActiveRecordModel.create
+    end
+
+    # rubocop:disable RSpec/ExampleLength
+    it do
+      expect do
+        ActiveRecord::Base.transaction do
+          model.state_machine.transition_to!(:succeeded)
+          raise ActiveRecord::Rollback
+        end
+      end.to_not change(MyStateMachine, :after_commit_callback_executed)
+    end
+    # rubocop:enable RSpec/ExampleLength
+  end
 end

data/spec/statesman/adapters/active_record_spec.rb

@@ -227,6 +227,7 @@ describe Statesman::Adapters::ActiveRecord, active_record: true do
             it "still has the old state" do
               allow(observer).to receive(:execute) do |phase|
                 next unless phase == :before
+
                 expect(
                   model.transitions.where(most_recent: true).first.to_state,
                 ).to eq("y")
@@ -240,6 +241,7 @@ describe Statesman::Adapters::ActiveRecord, active_record: true do
             it "still has the old state" do
               allow(observer).to receive(:execute) do |phase|
                 next unless phase == :after
+
                 expect(
                   model.transitions.where(most_recent: true).first.to_state,
                 ).to eq("z")

data/statesman.gemspec

@@ -31,6 +31,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec-its", "~> 1.1"
   spec.add_development_dependency "rspec-rails", "~> 3.1"
   spec.add_development_dependency "rspec_junit_formatter", "~> 0.4.0"
-  spec.add_development_dependency "sqlite3", "~> 1.3"
+  spec.add_development_dependency "sqlite3", "~> 1.3.6"
   spec.add_development_dependency "timecop", "~> 0.9.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: statesman
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 4.0.0
 platform: ruby
 authors:
 - GoCardless
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-02 00:00:00.000000000 Z
+date: 2019-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ammeter
@@ -184,14 +184,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 1.3.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 1.3.6
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement