MONGOID-5708 Add :on to transaction callbacks (#5767)

Author: comandeo-mongo

lib/mongoid/clients/sessions.rb

@@ -16,6 +16,10 @@ def self.included(base)
 
       module ClassMethods
 
+        # Actions that can be used to trigger transactional callbacks.
+        # @api private
+        CALLBACK_ACTIONS = [:create, :destroy, :update]
+
         # Execute a block within the context of a session.
         #
         # @example Execute some operations in the context of a session.
@@ -101,6 +105,49 @@ def transaction(options = {}, session_options: {})
           end
         end
 
+        # Sets up a callback is called after a commit of a transaction.
+        # The callback is called only if the document is created, updated, or destroyed
+        # in the transaction.
+        #
+        # See +ActiveSupport::Callbacks::ClassMethods::set_callback+ for more
+        # information about method parameters and possible options.
+        def after_commit(*args, &block)
+          set_options_for_callbacks!(args)
+          set_callback(:commit, :after, *args, &block)
+        end
+
+        # Shortcut for +after_commit :hook, on: [ :create, :update ]+
+        def after_save_commit(*args, &block)
+          set_options_for_callbacks!(args, on: [ :create, :update ])
+          set_callback(:commit, :after, *args, &block)
+        end
+
+        # Shortcut for +after_commit :hook, on: :create+.
+        def after_create_commit(*args, &block)
+          set_options_for_callbacks!(args, on: :create)
+          set_callback(:commit, :after, *args, &block)
+        end
+
+        # Shortcut for +after_commit :hook, on: :update+.
+        def after_update_commit(*args, &block)
+          set_options_for_callbacks!(args, on: :update)
+          set_callback(:commit, :after, *args, &block)
+        end
+
+        # Shortcut for +after_commit :hook, on: :destroy+.
+        def after_destroy_commit(*args, &block)
+          set_options_for_callbacks!(args, on: :destroy)
+          set_callback(:commit, :after, *args, &block)
+        end
+
+        # This callback is called after a create, update, or destroy are rolled back.
+        #
+        # Please check the documentation of +after_commit+ for options.
+        def after_rollback(*args, &block)
+          set_options_for_callbacks!(args)
+          set_callback(:rollback, :after, *args, &block)
+        end
+
         private
 
         # @return [ Mongo::Session ] Session for the current client.
@@ -145,6 +192,46 @@ def abort_transaction(session)
             doc.run_after_callbacks(:rollback)
           end
         end
+
+        # Transforms custom options for after_commit and after_rollback callbacks
+        # into options for +set_callback+.
+        def set_options_for_callbacks!(args)
+          options = args.extract_options!
+          args << options
+
+          if options[:on]
+            fire_on = Array(options[:on])
+            assert_valid_transaction_action(fire_on)
+            options[:if] = [
+              -> { transaction_include_any_action?(fire_on) },
+              *options[:if]
+            ]
+          end
+        end
+
+        # Asserts that the given actions are valid for after_commit
+        # and after_rollback callbacks.
+        #
+        # @param [ Array<Symbol> ] actions Actions to be checked.
+        # @raise [ ArgumentError ] If any of the actions is not valid.
+        def assert_valid_transaction_action(actions)
+          if (actions - CALLBACK_ACTIONS).any?
+            raise ArgumentError, ":on conditions for after_commit and after_rollback callbacks have to be one of #{CALLBACK_ACTIONS}"
+          end
+        end
+
+        def transaction_include_any_action?(actions)
+          actions.any? do |action|
+            case action
+            when :create
+              persisted? && previously_new_record?
+            when :update
+              !(previously_new_record? || destroyed?)
+            when :destroy
+              destroyed?
+            end
+          end
+        end
       end
     end
   end

lib/mongoid/interceptable.rb

@@ -44,7 +44,9 @@ module Interceptable
       # @api private
       define_model_callbacks :persist_parent
 
-      define_model_callbacks :commit, :rollback, only: :after
+      define_callbacks :commit, :rollback,
+                       only: :after,
+                       scope: [:kind, :name]
 
       attr_accessor :before_callback_halted
     end

spec/mongoid/clients/transactions_spec.rb

@@ -786,111 +786,221 @@ def capture_exception
       before do
         Mongoid::Clients.with_name(:default).database.collections.each(&:drop)
         TransactionsSpecPerson.collection.create
+        TransactionsSpecPersonWithOnCreate.collection.create
+        TransactionsSpecPersonWithOnUpdate.collection.create
+        TransactionsSpecPersonWithOnDestroy.collection.create
         TransactionSpecRaisesBeforeSave.collection.create
         TransactionSpecRaisesAfterSave.collection.create
       end
 
       context 'when commit the transaction' do
         context 'create' do
-          let!(:subject) do
-            person = nil
-            TransactionsSpecPerson.transaction do
-              person = TransactionsSpecPerson.create!(name: 'James Bond')
+          context 'without :on option' do
+            let!(:subject) do
+              person = nil
+              TransactionsSpecPerson.transaction do
+                person = TransactionsSpecPerson.create!(name: 'James Bond')
+              end
+              person
             end
-            person
+
+            it_behaves_like 'commit callbacks are called'
           end
 
-          it_behaves_like 'commit callbacks are called'
+          context 'when callback has :on option' do
+            let!(:subject) do
+              person = nil
+              TransactionsSpecPersonWithOnCreate.transaction do
+                person = TransactionsSpecPersonWithOnCreate.create!(name: 'James Bond')
+              end
+              person
+            end
+
+            it_behaves_like 'commit callbacks are called'
+          end
         end
 
         context 'save' do
-          let(:subject) do
-            TransactionsSpecPerson.create!(name: 'James Bond').tap do |subject|
-              subject.after_commit_counter.reset
-              subject.after_rollback_counter.reset
+          context 'without :on option' do
+            let(:subject) do
+              TransactionsSpecPerson.create!(name: 'James Bond').tap do |subject|
+                subject.after_commit_counter.reset
+                subject.after_rollback_counter.reset
+              end
+            end
+
+            context 'when modified once' do
+              before do
+                subject.transaction do
+                  subject.name = 'Austin Powers'
+                  subject.save!
+                end
+              end
+
+              it_behaves_like 'commit callbacks are called'
+            end
+
+            context 'when modified multiple times' do
+              before do
+                subject.transaction do
+                  subject.name = 'Austin Powers'
+                  subject.save!
+                  subject.name = 'Jason Bourne'
+                  subject.save!
+                end
+              end
+
+              it_behaves_like 'commit callbacks are called'
             end
           end
 
-          context 'when modified once' do
+          context 'with :on option' do
+            let(:subject) do
+              TransactionsSpecPersonWithOnUpdate.create!(name: 'James Bond').tap do |subject|
+                subject.after_commit_counter.reset
+                subject.after_rollback_counter.reset
+              end
+            end
+
+            context 'when modified once' do
+              before do
+                subject.transaction do
+                  subject.name = 'Austin Powers'
+                  subject.save!
+                end
+              end
+
+              it_behaves_like 'commit callbacks are called'
+            end
+
+            context 'when modified multiple times' do
+              before do
+                subject.transaction do
+                  subject.name = 'Austin Powers'
+                  subject.save!
+                  subject.name = 'Jason Bourne'
+                  subject.save!
+                end
+              end
+
+              it_behaves_like 'commit callbacks are called'
+            end
+          end
+        end
+
+        context 'update_attributes' do
+          context 'without :on option' do
+            let(:subject) do
+              TransactionsSpecPerson.create!(name: 'James Bond').tap do |subject|
+                subject.after_commit_counter.reset
+                subject.after_rollback_counter.reset
+              end
+            end
+
             before do
               subject.transaction do
-                subject.name = 'Austin Powers'
-                subject.save!
+                subject.update_attributes!(name: 'Austin Powers')
               end
             end
 
             it_behaves_like 'commit callbacks are called'
           end
 
-          context 'when modified multiple times' do
+          context 'when callback has on option' do
+            let(:subject) do
+              TransactionsSpecPersonWithOnUpdate.create!(name: 'Jason Bourne')
+            end
+
             before do
-              subject.transaction do
-                subject.name = 'Austin Powers'
-                subject.save!
-                subject.name = 'Jason Bourne'
-                subject.save!
+              TransactionsSpecPersonWithOnUpdate.transaction do
+                subject.update_attributes!(name: 'Foma Kiniaev')
               end
             end
 
             it_behaves_like 'commit callbacks are called'
           end
         end
 
-        context 'update_attributes' do
-          let(:subject) do
-            TransactionsSpecPerson.create!(name: 'James Bond').tap do |subject|
-              subject.after_commit_counter.reset
-              subject.after_rollback_counter.reset
+        context 'destroy' do
+          context 'without :on option' do
+            let(:after_commit_counter) do
+              TransactionsSpecCounter.new
             end
-          end
 
-          before do
-            subject.transaction do
-              subject.update_attributes!(name: 'Austin Powers')
+            let(:after_rollback_counter) do
+              TransactionsSpecCounter.new
             end
-          end
 
-          it_behaves_like 'commit callbacks are called'
-        end
+            let(:subject) do
+              TransactionsSpecPerson.create!(name: 'James Bond').tap do |p|
+                p.after_commit_counter = after_commit_counter
+                p.after_rollback_counter = after_rollback_counter
+              end
+            end
 
-        context 'destroy' do
-          let(:after_commit_counter) do
-            TransactionsSpecCounter.new
-          end
+            before do
+              subject.transaction do
+                subject.destroy
+              end
+            end
 
-          let(:after_rollback_counter) do
-            TransactionsSpecCounter.new
+            it_behaves_like 'commit callbacks are called'
           end
 
-          let(:subject) do
-            TransactionsSpecPerson.create!(name: 'James Bond').tap do |p|
-              p.after_commit_counter = after_commit_counter
-              p.after_rollback_counter = after_rollback_counter
+          context 'with :on option' do
+            let(:after_commit_counter) do
+              TransactionsSpecCounter.new
             end
-          end
 
-          before do
-            subject.transaction do
-              subject.destroy
+            let(:after_rollback_counter) do
+              TransactionsSpecCounter.new
             end
-          end
 
-          it_behaves_like 'commit callbacks are called'
+            let(:subject) do
+              TransactionsSpecPersonWithOnDestroy.create!(name: 'James Bond').tap do |p|
+                p.after_commit_counter = after_commit_counter
+                p.after_rollback_counter = after_rollback_counter
+              end
+            end
+
+            before do
+              subject.transaction do
+                subject.destroy
+              end
+            end
+
+            it_behaves_like 'commit callbacks are called'
+          end
         end
       end
 
       context 'when rollback the transaction' do
         context 'create' do
-          let!(:subject) do
-            person = nil
-            TransactionsSpecPerson.transaction do
-              person = TransactionsSpecPerson.create!(name: 'James Bond')
-              raise Mongoid::Errors::Rollback
+          context 'without :on option' do
+            let!(:subject) do
+              person = nil
+              TransactionsSpecPerson.transaction do
+                person = TransactionsSpecPerson.create!(name: 'James Bond')
+                raise Mongoid::Errors::Rollback
+              end
+              person
             end
-            person
+
+            it_behaves_like 'rollback callbacks are called'
           end
 
-          it_behaves_like 'rollback callbacks are called'
+          context 'with :on option' do
+            let!(:subject) do
+              person = nil
+              TransactionsSpecPersonWithOnCreate.transaction do
+                person = TransactionsSpecPersonWithOnCreate.create!(name: 'James Bond')
+                raise Mongoid::Errors::Rollback
+              end
+              person
+            end
+
+            it_behaves_like 'rollback callbacks are called'
+          end
         end
 
         context 'save' do