Defer ActiveJob enqueue callbacks until after commit when enqueue_after_transaction_commit enabled

Author: wroever

activejob/CHANGELOG.md

@@ -1,3 +1,8 @@
+*   Defer invocation of ActiveJob enqueue callbacks until after commit when
+    `enqueue_after_transaction_commit` is enabled.
+
+    *Will Roever*
+
 *   Add `report:` option to `ActiveJob::Base#retry_on` and `#discard_on`
 
     When the `report:` option is passed, errors will be reported to the error reporter

activejob/lib/active_job/enqueuing.rb

@@ -113,9 +113,7 @@ def enqueue(options = {})
       set(options)
       self.successfully_enqueued = false
 
-      run_callbacks :enqueue do
-        raw_enqueue
-      end
+      raw_enqueue
 
       if successfully_enqueued?
         self
@@ -126,6 +124,12 @@ def enqueue(options = {})
 
     private
       def raw_enqueue
+        run_callbacks :enqueue do
+          _raw_enqueue
+        end
+      end
+
+      def _raw_enqueue
         if scheduled_at
           queue_adapter.enqueue_at self, scheduled_at.to_f
         else

activejob/test/cases/enqueue_after_transaction_commit_test.rb

@@ -55,6 +55,21 @@ def perform
     end
   end
 
+  class EnqueueAfterCommitCallbackJob < ActiveJob::Base
+    self.enqueue_after_transaction_commit = true
+
+    attr_reader :around_enqueue_called
+
+    around_enqueue do |job, block|
+      job.instance_variable_set(:@around_enqueue_called, true)
+      block.call
+    end
+
+    def perform
+      # noop
+    end
+  end
+
   test "#perform_later wait for transactions to complete before enqueuing the job" do
     fake_active_record = FakeActiveRecord.new
     stub_const(Object, :ActiveRecord, fake_active_record, exists: false) do
@@ -98,4 +113,14 @@ def perform
       assert_not_predicate job, :successfully_enqueued?
     end
   end
+
+  test "#perform_later defers enqueue callbacks until after commit" do
+    fake_active_record = FakeActiveRecord.new(false)
+    stub_const(Object, :ActiveRecord, fake_active_record, exists: false) do
+      job = EnqueueAfterCommitCallbackJob.perform_later
+      assert_not_predicate job, :around_enqueue_called
+      fake_active_record.run_after_commit_callbacks
+      assert_predicate job, :around_enqueue_called
+    end
+  end
 end