Deprecate setting config.active_job.enqueue_after_transaction_commit

Also change the configuration to be a boolean instead of a symbol.

The value of this setting isn't delegated to the queue adapter anymore,
since the behavior that this setting controls is too dangerous to
leave this change of behavior as something that users don't control.

Fixes rails#52675.

Author: rafaelfranca

activejob/lib/active_job/enqueue_after_transaction_commit.rb

@@ -4,13 +4,29 @@ module ActiveJob
   module EnqueueAfterTransactionCommit # :nodoc:
     private
       def raw_enqueue
+        enqueue_after_transaction_commit = self.class.enqueue_after_transaction_commit
+
         after_transaction = case self.class.enqueue_after_transaction_commit
         when :always
+          ActiveJob.deprecator.warn(<<~MSG.squish)
+            Setting `#{self.class.name}.enqueue_after_transaction_commit = :always` is deprecated and will be removed in Rails 8.1.
+            Set to `true` to always enqueue the job after the transaction is committed.
+          MSG
           true
         when :never
+          ActiveJob.deprecator.warn(<<~MSG.squish)
+            Setting #{self.class.name}.enqueue_after_transaction_commit = :never` is deprecated and will be removed in Rails 8.1.
+            Set to `false` to never enqueue the job after the transaction is committed.
+          MSG
+          false
+        when :default
+          ActiveJob.deprecator.warn(<<~MSG.squish)
+            Setting `#{self.class.name}.enqueue_after_transaction_commit = :default` is deprecated and will be removed in Rails 8.1.
+            Set to `false` to never enqueue the job after the transaction is committed.
+          MSG
           false
-        else # :default
-          queue_adapter.enqueue_after_transaction_commit?
+        else
+          enqueue_after_transaction_commit
         end
 
         if after_transaction

activejob/lib/active_job/enqueuing.rb

@@ -48,10 +48,9 @@ module Enqueuing
       # automatically defers the enqueue to after the transaction commits.
       #
       # It can be set on a per job basis:
-      #  - `:always` forces the job to be deferred.
-      #  - `:never` forces the job to be queued immediately.
-      #  - `:default` lets the queue adapter define the behavior (recommended).
-      class_attribute :enqueue_after_transaction_commit, instance_accessor: false, instance_predicate: false, default: :never
+      #  - true forces the job to be deferred.
+      #  - false forces the job to be queued immediately.
+      class_attribute :enqueue_after_transaction_commit, instance_accessor: false, instance_predicate: false, default: false
     end
 
     # Includes the +perform_later+ method for job initialization.

activejob/lib/active_job/queue_adapters/abstract_adapter.rb

@@ -7,14 +7,6 @@ module QueueAdapters
     # Active Job supports multiple job queue systems. ActiveJob::QueueAdapters::AbstractAdapter
     # forms the abstraction layer which makes this possible.
     class AbstractAdapter
-      # Defines whether enqueuing should happen implicitly to after commit when called
-      # from inside a transaction. Most adapters should return true, but some adapters
-      # that use the same database as Active Record and are transaction aware can return
-      # false to continue enqueuing jobs as part of the transaction.
-      def enqueue_after_transaction_commit?
-        true
-      end
-
       def enqueue(job)
         raise NotImplementedError
       end

activejob/lib/active_job/queue_adapters/delayed_job_adapter.rb

@@ -16,14 +16,6 @@ module QueueAdapters
     #
     #   Rails.application.config.active_job.queue_adapter = :delayed_job
     class DelayedJobAdapter < AbstractAdapter
-      def initialize(enqueue_after_transaction_commit: false)
-        @enqueue_after_transaction_commit = enqueue_after_transaction_commit
-      end
-
-      def enqueue_after_transaction_commit? # :nodoc:
-        @enqueue_after_transaction_commit
-      end
-
       def enqueue(job) # :nodoc:
         delayed_job = Delayed::Job.enqueue(JobWrapper.new(job.serialize), queue: job.queue_name, priority: job.priority)
         job.provider_job_id = delayed_job.id

activejob/lib/active_job/queue_adapters/inline_adapter.rb

@@ -11,10 +11,6 @@ module QueueAdapters
     #
     #   Rails.application.config.active_job.queue_adapter = :inline
     class InlineAdapter < AbstractAdapter
-      def enqueue_after_transaction_commit? # :nodoc:
-        false
-      end
-
       def enqueue(job) # :nodoc:
         Base.execute(job.serialize)
       end

activejob/lib/active_job/queue_adapters/queue_classic_adapter.rb

@@ -19,14 +19,6 @@ module QueueAdapters
     #
     #   Rails.application.config.active_job.queue_adapter = :queue_classic
     class QueueClassicAdapter < AbstractAdapter
-      def initialize(enqueue_after_transaction_commit: false)
-        @enqueue_after_transaction_commit = enqueue_after_transaction_commit
-      end
-
-      def enqueue_after_transaction_commit? # :nodoc:
-        @enqueue_after_transaction_commit
-      end
-
       def enqueue(job) # :nodoc:
         qc_job = build_queue(job.queue_name).enqueue("#{JobWrapper.name}.perform", job.serialize)
         job.provider_job_id = qc_job["id"] if qc_job.is_a?(Hash)

activejob/lib/active_job/queue_adapters/test_adapter.rb

@@ -12,17 +12,9 @@ module QueueAdapters
     #
     #   Rails.application.config.active_job.queue_adapter = :test
     class TestAdapter < AbstractAdapter
-      attr_accessor(:perform_enqueued_jobs, :perform_enqueued_at_jobs, :filter, :reject, :queue, :at, :enqueue_after_transaction_commit)
+      attr_accessor(:perform_enqueued_jobs, :perform_enqueued_at_jobs, :filter, :reject, :queue, :at)
       attr_writer(:enqueued_jobs, :performed_jobs)
 
-      def initialize(enqueue_after_transaction_commit: true)
-        @enqueue_after_transaction_commit = enqueue_after_transaction_commit
-      end
-
-      def enqueue_after_transaction_commit? # :nodoc:
-        @enqueue_after_transaction_commit
-      end
-
       # Provides a store of all the enqueued jobs with the TestAdapter so you can check them.
       def enqueued_jobs
         @enqueued_jobs ||= []

activejob/lib/active_job/railtie.rb

@@ -31,7 +31,22 @@ class Railtie < Rails::Railtie # :nodoc:
           ActiveJob::Base.include EnqueueAfterTransactionCommit
 
           if app.config.active_job.key?(:enqueue_after_transaction_commit)
-            ActiveJob::Base.enqueue_after_transaction_commit = app.config.active_job.delete(:enqueue_after_transaction_commit)
+            ActiveJob.deprecator.warn(<<~MSG.squish)
+              `config.active_job.enqueue_after_transaction_commit` is deprecated and will be removed in Rails 8.1.
+              This configuration can still be set on individual jobs using `self.enqueue_after_transaction_commit=`,
+              but due the nature of this behavior, it is not recommended to be set globally.
+            MSG
+
+            value = case app.config.active_job.enqueue_after_transaction_commit
+            when :always
+              true
+            when :never
+              false
+            else
+              false
+            end
+
+            ActiveJob::Base.enqueue_after_transaction_commit = value
           end
         end
       end
@@ -54,7 +69,8 @@ class Railtie < Rails::Railtie # :nodoc:
         # Configs used in other initializers
         options = options.except(
           :log_query_tags_around_perform,
-          :custom_serializers
+          :custom_serializers,
+          :enqueue_after_transaction_commit
         )
 
         options.each do |k, v|

activejob/test/cases/enqueue_after_transaction_commit_test.rb

@@ -29,7 +29,7 @@ def run_after_commit_callbacks
   end
 
   class EnqueueAfterCommitJob < ActiveJob::Base
-    self.enqueue_after_transaction_commit = :always
+    self.enqueue_after_transaction_commit = true
 
     def perform
       # noop
@@ -38,10 +38,6 @@ def perform
 
   class ErrorEnqueueAfterCommitJob < EnqueueErrorJob
     class EnqueueErrorAdapter
-      def enqueue_after_transaction_commit?
-        true
-      end
-
       def enqueue(...)
         raise ActiveJob::EnqueueError, "There was an error enqueuing the job"
       end
@@ -52,7 +48,7 @@ def enqueue_at(...)
     end
 
     self.queue_adapter = EnqueueErrorAdapter.new
-    self.enqueue_after_transaction_commit = :always
+    self.enqueue_after_transaction_commit = true
 
     def perform
       # noop

activejob/test/cases/queue_adapter_test.rb

@@ -5,13 +5,11 @@
 module ActiveJob
   module QueueAdapters
     class StubOneAdapter
-      def enqueue_after_transaction_commit?; false; end
       def enqueue(*); end
       def enqueue_at(*); end
     end
 
     class StubTwoAdapter
-      def enqueue_after_transaction_commit?; false; end
       def enqueue(*); end
       def enqueue_at(*); end
     end
@@ -74,7 +72,6 @@ class QueueAdapterTest < ActiveJob::TestCase
 
   module StubThreeAdapter
     class << self
-      def enqueue_after_transaction_commit?; false; end
       def enqueue(*); end
       def enqueue_at(*); end
     end
@@ -87,7 +84,6 @@ def enqueue_at(*); end
   end
 
   class StubFourAdapter
-    def enqueue_after_transaction_commit?; false; end
     def enqueue(*); end
     def enqueue_at(*); end
     def queue_adapter_name