activejob 7.1.5.1 → 7.2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3163adeb0ad6bf21b0048cfcde214b97af34a0b49299f37cd2e93905a5839327
-  data.tar.gz: ccaff11c2aa436b1ad0b7a479c030c7e241ee8e2c0a4754361ac6acb6a703d5f
+  metadata.gz: c3b47492def92c2f9d51610a3b8ca696cbb32ff69fe45107ebaf478a69abc65f
+  data.tar.gz: f05813374e5dec3e6b9e138585ef9ef23c87640187a42ea03e7db9d50d1e2362
 SHA512:
-  metadata.gz: d319ffd95f49cddec8a0fdbc39f36d5029a3d7bc91086564cd673f784268a86d20c3d2977d248a8f7591e80d8652be11d9c9bd0e94afb5cbefad132035d1ad68
-  data.tar.gz: e9eaebe18fc732613af2da14a35d5993f1c4c6e87ff01908fef6f569c51c395150046d1502d913df2bcb4cbeb0c2810bbe2d5a337f8903207e604dabba789509
+  metadata.gz: 58e96af8f140d46c83bc3d9231ee6e8c330d71e724def12d20844d5af4280b12a4de63ba3c7e58157d32295193c55405fb292071c6f0494416f66ea46ad658a6
+  data.tar.gz: a5f662c33aa37b48aa7643299cddaf5f76559feb7820468862b71aae7c0f725cf25ad098b0df2d951c810d76abaa10e49e24bdac3589b4c6bd9b683335856424

data/CHANGELOG.md

@@ -1,310 +1,92 @@
-## Rails 7.1.5.1 (December 10, 2024) ##
+## Rails 7.2.2.1 (December 10, 2024) ##
 
 *   No changes.
 
 
-## Rails 7.1.5 (October 30, 2024) ##
+## Rails 7.2.2 (October 30, 2024) ##
 
 *   No changes.
 
 
-## Rails 7.1.4.2 (October 23, 2024) ##
+## Rails 7.2.1.2 (October 23, 2024) ##
 
 *   No changes.
 
 
-## Rails 7.1.4.1 (October 15, 2024) ##
+## Rails 7.2.1.1 (October 15, 2024) ##
 
 *   No changes.
 
 
-## Rails 7.1.4 (August 22, 2024) ##
-
-*   Register autoload for `ActiveJob::Arguments`.
-
-    *Rafael Mendonça França*
-
-
-## Rails 7.1.3.4 (June 04, 2024) ##
-
-*   No changes.
-
-
-## Rails 7.1.3.3 (May 16, 2024) ##
-
-*   No changes.
-
-
-## Rails 7.1.3.2 (February 21, 2024) ##
-
-*   No changes.
-
-
-## Rails 7.1.3.1 (February 21, 2024) ##
-
-*   No changes.
-
-
-## Rails 7.1.3 (January 16, 2024) ##
-
-*   Do not trigger immediate loading of `ActiveJob::Base` when loading `ActiveJob::TestHelper`.
-
-    *Maxime Réty*
-
-*   Preserve the serialized timezone when deserializing `ActiveSupport::TimeWithZone` arguments.
-
-    *Joshua Young*
-
-*   Fix ActiveJob arguments serialization to correctly serialize String subclasses having custom serializers.
-
-    *fatkodima*
-
-
-## Rails 7.1.2 (November 10, 2023) ##
+## Rails 7.2.1 (August 22, 2024) ##
 
 *   No changes.
 
 
-## Rails 7.1.1 (October 11, 2023) ##
-
-*   Don't log enqueuing details when the job wasn't enqueued.
-
-    *Dustin Brown*
-
-
-## Rails 7.1.0 (October 05, 2023) ##
-
-*   No changes.
-
-
-## Rails 7.1.0.rc2 (October 01, 2023) ##
-
-*   Make sure `scheduled_at` is a Time object when asserting enqueued jobs.
-
-    *Rafael Mendonça França*
-
-
-## Rails 7.1.0.rc1 (September 27, 2023) ##
-
-*   Set `scheduled_at` attribute as a Time object instead of epoch seconds, and serialize and deserialize the value
-    when enqueued. Assigning a numeric/epoch value to scheduled_at= is deprecated; use a Time object instead.
-
-    Deserializes `enqueued_at` as a Time instead of ISO8601 String.
-
-    *Ben Sheldon*
-
-*   Clarify the backoff strategy for the recommended `:wait` option when retrying jobs
-
-    `wait: :exponentially_longer` is waiting polynomially longer, so it is now recommended to use `wait: :polynomially_longer` to keep the same behavior.
-
-    *Victor Mours*
-
-
-## Rails 7.1.0.beta1 (September 13, 2023) ##
-
-*   Fix Active Job log message to correctly report a job failed to enqueue
-    when the adapter raises an `ActiveJob::EnqueueError`.
-
-    *Ben Sheldon*
-
-*   Add `after_discard` method.
-
-    This method lets job authors define a block which will be run when a job is about to be discarded. For example:
-
-    ```ruby
-    class AfterDiscardJob < ActiveJob::Base
-      after_discard do |job, exception|
-        Rails.logger.info("#{job.class} raised an exception: #{exception}")
-      end
-
-      def perform
-        raise StandardError
-      end
-    end
-    ```
-
-    The above job will run the block passed to `after_discard` after the job is discarded. The exception will
-    still be raised after the block has been run.
-
-    *Rob Cardy*
+## Rails 7.2.0 (August 09, 2024) ##
 
-*   Fix deserialization of ActiveSupport::Duration
+*   All tests now respect the `active_job.queue_adapter` config.
 
-    Previously, a deserialized Duration would return an array from Duration#parts.
-    It will now return a hash just like a regular Duration.
+    Previously if you had set `config.active_job.queue_adapter` in your `config/application.rb`
+    or `config/environments/test.rb` file, the adapter you selected was previously not used consistently
+    across all tests. In some tests your adapter would be used, but other tests would use the `TestAdapter`.
 
-    This also fixes an error when trying to add or subtract from a deserialized Duration
-    (eg `duration + 1.year`).
+    In Rails 7.2, all tests will respect the `queue_adapter` config if provided. If no config is provided,
+    the `TestAdapter` will continue to be used.
 
-    *Jonathan del Strother*
-
-*   `perform_enqueued_jobs` is now compatible with all Active Job adapters
-
-    This means that methods that depend on it, like Action Mailer's `assert_emails`,
-    will work correctly even if the test adapter is not used.
+    See [#48585](https://github.com/rails/rails/pull/48585) for more details.
 
     *Alex Ghiculescu*
 
-*   Allow queue adapters to provide a custom name by implementing `queue_adapter_name`
-
-    *Sander Verdonschot*
-
-*   Log background job enqueue callers
-
-    Add `verbose_enqueue_logs` configuration option to display the caller
-    of background job enqueue in the log to help with debugging.
-
-    Example log line:
-
-    ```
-    Enqueued AvatarThumbnailsJob (Job ID: ab528951-41fb-4c48-9129-3171791c27d6) to Sidekiq(default) with arguments: 1092412064
-    ↳ app/models/user.rb:421:in `generate_avatar_thumbnails'
-    ```
-
-    Enabled in development only for new and upgraded applications. Not recommended for use
-    in the production environment since it relies on Ruby's `Kernel#caller` which is fairly slow.
-
-    *fatkodima*
+*   Make Active Job transaction aware when used conjointly with Active Record.
 
-*   Set `provider_job_id` for Backburner jobs
-
-    *Cameron Matheson*
-
-*   Add `perform_all_later` to enqueue multiple jobs at once
-
-    This adds the ability to bulk enqueue jobs, without running callbacks, by
-    passing multiple jobs or an array of jobs. For example:
+    A common mistake with Active Job is to enqueue jobs from inside a transaction,
+    causing them to potentially be picked and ran by another process, before the
+    transaction is committed, which may result in various errors.
 
     ```ruby
-    ActiveJob.perform_all_later(MyJob.new("hello", 42), MyJob.new("world", 0))
-
-    user_jobs = User.pluck(:id).map { |id| UserJob.new(user_id: id) }
-    ActiveJob.perform_all_later(user_jobs)
+    Topic.transaction do
+      topic = Topic.create(...)
+      NewTopicNotificationJob.perform_later(topic)
+    end
     ```
 
-    This can greatly reduce the number of round-trips to the queue datastore.
-    For queue adapters that do not implement the new `enqueue_all` method, we
-    fall back to enqueuing jobs individually. The Sidekiq adapter implements
-    `enqueue_all` with `push_bulk`.
-
-    This method does not use the existing `enqueue.active_job` event, but adds a
-    new event `enqueue_all.active_job`.
-
-    *Sander Verdonschot*
-
-*   Don't double log the `job` when using `ActiveRecord::QueryLog`
-
-    Previously if you set `config.active_record.query_log_tags` to an array that included
-    `:job`, the job name would get logged twice. This bug has been fixed.
-
-    *Alex Ghiculescu*
-
-*   Add support for Sidekiq's transaction-aware client
-
-    *Jonathan del Strother*
-
-*   Remove QueAdapter from Active Job.
-
-    After maintaining Active Job QueAdapter by Rails and Que side
-    to support Ruby 3 keyword arguments and options provided as top level keywords,
-    it is quite difficult to maintain it this way.
+    Now Active Job will automatically defer the enqueuing to after the transaction is committed,
+    and drop the job if the transaction is rolled back.
 
-    Active Job Que adapter can be included in the future version of que gem itself.
-
-    *Yasuo Honda*
-
-*   Fix BigDecimal (de)serialization for adapters using JSON.
-
-    Previously, BigDecimal was listed as not needing a serializer.  However,
-    when used with an adapter storing the job arguments as JSON, it would get
-    serialized as a simple String, resulting in deserialization also producing
-    a String (instead of a BigDecimal).
-
-    By using a serializer, we ensure the round trip is safe.
-
-    To ensure applications using BigDecimal job arguments are not subject to
-    race conditions during deployment (where a replica running a version of
-    Rails without BigDecimalSerializer fails to deserialize an argument
-    serialized with it), `ActiveJob.use_big_decimal_serializer` is disabled by
-    default, and can be set to true in a following deployment..
-
-    *Sam Bostock*
-
-*   Preserve full-precision `enqueued_at` timestamps for serialized jobs,
-    allowing more accurate reporting of how long a job spent waiting in the
-    queue before it was performed.
-
-    Retains IS08601 format compatibility.
-
-    *Jeremy Daer*
-
-*   Add `--parent` option to job generator to specify parent class of job.
-
-    Example:
-
-    `bin/rails g job process_payment --parent=payment_job` generates:
+    Various queue implementations can choose to disable this behavior, and users can disable it,
+    or force it on a per job basis:
 
     ```ruby
-    class ProcessPaymentJob < PaymentJob
-      # ...
+    class NewTopicNotificationJob < ApplicationJob
+      self.enqueue_after_transaction_commit = :never # or `:always` or `:default`
     end
     ```
 
-    *Gannon McGibbon*
-
-*   Add more detailed description to job generator.
-
-    *Gannon McGibbon*
-
-*   `perform.active_job` notification payloads now include `:db_runtime`, which
-    is the total time (in ms) taken by database queries while performing a job.
-    This value can be used to better understand how a job's time is spent.
+    *Jean Boussier*, *Cristian Bica*
 
-    *Jonathan Hefner*
-
-*   Update `ActiveJob::QueueAdapters::QueAdapter` to remove deprecation warning.
-
-    Remove a deprecation warning introduced in que 1.2 to prepare for changes in
-    que 2.0 necessary for Ruby 3 compatibility.
-
-    *Damir Zekic* and *Adis Hasovic*
+*   Do not trigger immediate loading of `ActiveJob::Base` when loading `ActiveJob::TestHelper`.
 
-*   Add missing `bigdecimal` require in `ActiveJob::Arguments`
+    *Maxime Réty*
 
-    Could cause `uninitialized constant ActiveJob::Arguments::BigDecimal (NameError)`
-    when loading Active Job in isolation.
+*   Preserve the serialized timezone when deserializing `ActiveSupport::TimeWithZone` arguments.
 
-    *Jean Boussier*
+    *Joshua Young*
 
-*   Allow testing `discard_on/retry_on ActiveJob::DeserializationError`
+*   Remove deprecated `:exponentially_longer` value for the `:wait` in `retry_on`.
 
-    Previously in `perform_enqueued_jobs`, `deserialize_arguments_if_needed`
-    was called before calling `perform_now`. When a record no longer exists
-    and is serialized using GlobalID this led to raising
-    an `ActiveJob::DeserializationError` before reaching `perform_now` call.
-    This behavior makes difficult testing the job `discard_on/retry_on` logic.
+    *Rafael Mendonça França*
 
-    Now `deserialize_arguments_if_needed` call is postponed to when `perform_now`
-    is called.
+*   Remove deprecated support to set numeric values to `scheduled_at` attribute.
 
-    Example:
+    *Rafael Mendonça França*
 
-    ```ruby
-    class UpdateUserJob < ActiveJob::Base
-      discard_on ActiveJob::DeserializationError
+*   Deprecate `Rails.application.config.active_job.use_big_decimal_serialize`.
 
-      def perform(user)
-        # ...
-      end
-    end
+    *Rafael Mendonça França*
 
-    # In the test
-    User.destroy_all
-    assert_nothing_raised do
-      perform_enqueued_jobs only: UpdateUserJob
-    end
-    ```
+*   Remove deprecated primitive serializer for `BigDecimal` arguments.
 
-    *Jacopo Beschi*
+    *Rafael Mendonça França*
 
-Please check [7-0-stable](https://github.com/rails/rails/blob/7-0-stable/activejob/CHANGELOG.md) for previous changes.
+Please check [7-1-stable](https://github.com/rails/rails/blob/7-1-stable/activejob/CHANGELOG.md) for previous changes.

data/lib/active_job/arguments.rb

@@ -101,15 +101,6 @@ module ActiveJob
         else
           if argument.respond_to?(:permitted?) && argument.respond_to?(:to_h)
             serialize_indifferent_hash(argument.to_h)
-          elsif BigDecimal === argument && !ActiveJob.use_big_decimal_serializer
-            ActiveJob.deprecator.warn(<<~MSG)
-              Primitive serialization of BigDecimal job arguments is deprecated as it may serialize via .to_s using certain queue adapters.
-              Enable config.active_job.use_big_decimal_serializer to use BigDecimalSerializer instead, which will be mandatory in Rails 7.2.
-
-              Note that if your application has multiple replicas, you should only enable this setting after successfully deploying your app to Rails 7.1 first.
-              This will ensure that during your deployment all replicas are capable of deserializing arguments serialized with BigDecimalSerializer.
-            MSG
-            argument
           else
             Serializers.serialize(argument)
           end
@@ -120,8 +111,6 @@ module ActiveJob
         case argument
         when nil, true, false, String, Integer, Float
           argument
-        when BigDecimal # BigDecimal may have been legacy serialized; Remove in 7.2
-          argument
         when Array
           argument.map { |arg| deserialize_argument(arg) }
         when Hash

data/lib/active_job/callbacks.rb

@@ -15,9 +15,6 @@ module ActiveJob
   # * <tt>before_perform</tt>
   # * <tt>around_perform</tt>
   # * <tt>after_perform</tt>
-  #
-  # NOTE: Calling the same callback multiple times will overwrite previous callback definitions.
-  #
   module Callbacks
     extend  ActiveSupport::Concern
     include ActiveSupport::Callbacks

data/lib/active_job/core.rb

@@ -13,9 +13,7 @@ module ActiveJob
     attr_writer :serialized_arguments
 
     # Time when the job should be performed
-    attr_reader :scheduled_at
-
-    attr_reader :_scheduled_at_time # :nodoc:
+    attr_accessor :scheduled_at
 
     # Job Identifier
     attr_accessor :job_id
@@ -97,7 +95,6 @@ module ActiveJob
       @job_id     = SecureRandom.uuid
       @queue_name = self.class.queue_name
       @scheduled_at = nil
-      @_scheduled_at_time = nil
       @priority   = self.class.priority
       @executions = 0
       @exception_executions = {}
@@ -120,7 +117,7 @@ module ActiveJob
         "locale"     => I18n.locale.to_s,
         "timezone"   => timezone,
         "enqueued_at" => Time.now.utc.iso8601(9),
-        "scheduled_at" => _scheduled_at_time ? _scheduled_at_time.utc.iso8601(9) : nil,
+        "scheduled_at" => scheduled_at ? scheduled_at.utc.iso8601(9) : nil,
       }
     end
 
@@ -174,18 +171,6 @@ module ActiveJob
       self
     end
 
-    def scheduled_at=(value)
-      @_scheduled_at_time = if value&.is_a?(Numeric)
-        ActiveJob.deprecator.warn(<<~MSG.squish)
-          Assigning a numeric/epoch value to scheduled_at is deprecated. Use a Time object instead.
-        MSG
-        Time.at(value)
-      else
-        value
-      end
-      @scheduled_at = value
-    end
-
     private
       def serialize_arguments_if_needed(arguments)
         if arguments_serialized?
@@ -211,7 +196,7 @@ module ActiveJob
       end
 
       def arguments_serialized?
-        defined?(@serialized_arguments) && @serialized_arguments
+        @serialized_arguments
       end
   end
 end

data/lib/active_job/enqueue_after_transaction_commit.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module ActiveJob
+  module EnqueueAfterTransactionCommit # :nodoc:
+    private
+      def raw_enqueue
+        after_transaction = case self.class.enqueue_after_transaction_commit
+        when :always
+          true
+        when :never
+          false
+        else # :default
+          queue_adapter.enqueue_after_transaction_commit?
+        end
+
+        if after_transaction
+          self.successfully_enqueued = true
+          ActiveRecord.after_all_transactions_commit do
+            self.successfully_enqueued = false
+            super
+          end
+          self
+        else
+          super
+        end
+      end
+  end
+end

data/lib/active_job/enqueuing.rb

@@ -21,7 +21,7 @@ module ActiveJob
             adapter_jobs.each do |job|
               job.successfully_enqueued = false
               if job.scheduled_at
-                queue_adapter.enqueue_at(job, job._scheduled_at_time.to_f)
+                queue_adapter.enqueue_at(job, job.scheduled_at.to_f)
               else
                 queue_adapter.enqueue(job)
               end
@@ -40,6 +40,20 @@ module ActiveJob
   module Enqueuing
     extend ActiveSupport::Concern
 
+    included do
+      ##
+      # :singleton-method:
+      #
+      # Defines if enqueueing this job from inside an Active Record transaction
+      # 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
+    end
+
     # Includes the +perform_later+ method for job initialization.
     module ClassMethods
       # Push a job onto the queue. By default the arguments must be either String,
@@ -50,9 +64,21 @@ module ActiveJob
       # custom serializers.
       #
       # Returns an instance of the job class queued with arguments available in
-      # Job#arguments or false if the enqueue did not succeed.
+      # Job#arguments or +false+ if the enqueue did not succeed.
       #
       # After the attempted enqueue, the job will be yielded to an optional block.
+      #
+      # If Active Job is used conjointly with Active Record, and #perform_later is called
+      # inside an Active Record transaction, then the enqueue is implicitly deferred to after
+      # the transaction is committed, or dropped if it's rolled back. In such case #perform_later
+      # will return the job instance like if it was successfully enqueued, but will still return
+      # +false+ if a callback prevented the job from being enqueued.
+      #
+      # This behavior can be changed on a per job basis:
+      #
+      #  class NotificationJob < ApplicationJob
+      #    self.enqueue_after_transaction_commit = false
+      #  end
       def perform_later(...)
         job = job_or_instantiate(...)
         enqueue_result = job.enqueue
@@ -63,7 +89,7 @@ module ActiveJob
       end
 
       private
-        def job_or_instantiate(*args) # :doc:
+        def job_or_instantiate(*args, &_) # :doc:
           args.first.is_a?(self) ? args.first : new(*args)
         end
         ruby2_keywords(:job_or_instantiate)
@@ -89,8 +115,20 @@ module ActiveJob
       self.successfully_enqueued = false
 
       run_callbacks :enqueue do
+        raw_enqueue
+      end
+
+      if successfully_enqueued?
+        self
+      else
+        false
+      end
+    end
+
+    private
+      def raw_enqueue
         if scheduled_at
-          queue_adapter.enqueue_at self, _scheduled_at_time.to_f
+          queue_adapter.enqueue_at self, scheduled_at.to_f
         else
           queue_adapter.enqueue self
         end
@@ -99,12 +137,5 @@ module ActiveJob
       rescue EnqueueError => e
         self.enqueue_error = e
       end
-
-      if successfully_enqueued?
-        self
-      else
-        false
-      end
-    end
   end
 end

data/lib/active_job/exceptions.rb

@@ -21,7 +21,7 @@ module ActiveJob
       # You can also pass a block that'll be invoked if the retry attempts fail for custom logic rather than letting
       # the exception bubble up. This block is yielded with the job instance as the first and the error instance as the second parameter.
       #
-      # `retry_on` and `discard_on` handlers are searched from bottom to top, and up the class hierarchy. The handler of the first class for
+      # +retry_on+ and +discard_on+ handlers are searched from bottom to top, and up the class hierarchy. The handler of the first class for
       # which <tt>exception.is_a?(klass)</tt> holds true is the one invoked, if any.
       #
       # ==== Options
@@ -29,8 +29,8 @@ module ActiveJob
       #   as a computing proc that takes the number of executions so far as an argument, or as a symbol reference of
       #   <tt>:polynomially_longer</tt>, which applies the wait algorithm of <tt>((executions**4) + (Kernel.rand * (executions**4) * jitter)) + 2</tt>
       #   (first wait ~3s, then ~18s, then ~83s, etc)
-      # * <tt>:attempts</tt> - Re-enqueues the job the specified number of times (default: 5 attempts) or a symbol reference of <tt>:unlimited</tt>
-      #   to retry the job until it succeeds
+      # * <tt>:attempts</tt> - Enqueues the job the specified number of times (default: 5 attempts) or a symbol reference of <tt>:unlimited</tt>
+      #   to retry the job until it succeeds. The number of attempts includes the original job execution.
       # * <tt>:queue</tt> - Re-enqueues the job on a different queue
       # * <tt>:priority</tt> - Re-enqueues the job with a different priority
       # * <tt>:jitter</tt> - A random delay of wait time used when calculating backoff. The default is 15% (0.15) which represents the upper bound of possible wait time (expressed as a percentage)
@@ -60,12 +60,6 @@ module ActiveJob
       #    end
       #  end
       def retry_on(*exceptions, wait: 3.seconds, attempts: 5, queue: nil, priority: nil, jitter: JITTER_DEFAULT)
-        if wait == :exponentially_longer
-          ActiveJob.deprecator.warn(<<~MSG.squish)
-            `wait: :exponentially_longer` will actually wait polynomially longer and is therefore deprecated.
-            Prefer `wait: :polynomially_longer` to avoid confusion and keep the same behavior.
-          MSG
-        end
         rescue_from(*exceptions) do |error|
           executions = executions_for(exceptions)
           if attempts == :unlimited || executions < attempts
@@ -90,7 +84,7 @@ module ActiveJob
       #
       # You can also pass a block that'll be invoked. This block is yielded with the job instance as the first and the error instance as the second parameter.
       #
-      # `retry_on` and `discard_on` handlers are searched from bottom to top, and up the class hierarchy. The handler of the first class for
+      # +retry_on+ and +discard_on+ handlers are searched from bottom to top, and up the class hierarchy. The handler of the first class for
       # which <tt>exception.is_a?(klass)</tt> holds true is the one invoked, if any.
       #
       # ==== Example
@@ -168,7 +162,7 @@ module ActiveJob
         jitter = jitter == JITTER_DEFAULT ? self.class.retry_jitter : (jitter || 0.0)
 
         case seconds_or_duration_or_algorithm
-        when :exponentially_longer, :polynomially_longer
+        when  :polynomially_longer
           # This delay uses a polynomial backoff strategy, which was previously misnamed as exponential
           delay = executions**4
           delay_jitter = determine_jitter_for_delay(delay, jitter)

data/lib/active_job/gem_version.rb

@@ -8,8 +8,8 @@ module ActiveJob
 
   module VERSION
     MAJOR = 7
-    MINOR = 1
-    TINY  = 5
+    MINOR = 2
+    TINY  = 2
     PRE   = "1"
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")

data/lib/active_job/log_subscriber.rb

@@ -125,7 +125,7 @@ module ActiveJob
         "Stopped retrying #{job.class} (Job ID: #{job.job_id}) due to a #{ex.class} (#{ex.message}), which reoccurred on #{job.executions} attempts."
       end
     end
-    subscribe_log_level :enqueue_retry, :error
+    subscribe_log_level :retry_stopped, :error
 
     def discard(event)
       job = event.payload[:job]

data/lib/active_job/logging.rb

@@ -4,17 +4,31 @@ require "active_support/tagged_logging"
 require "active_support/logger"
 
 module ActiveJob
-  module Logging # :nodoc:
+  module Logging
     extend ActiveSupport::Concern
 
     included do
+      ##
+      # Accepts a logger conforming to the interface of Log4r or the default
+      # Ruby +Logger+ class. You can retrieve this logger by calling +logger+ on
+      # either an Active Job job class or an Active Job job instance.
       cattr_accessor :logger, default: ActiveSupport::TaggedLogging.new(ActiveSupport::Logger.new(STDOUT))
+
+      ##
+      # Configures whether a job's arguments should be logged. This can be
+      # useful when a job's arguments may be sensitive and so should not be
+      # logged.
+      #
+      # The value defaults to +true+, but this can be configured with
+      # +config.active_job.log_arguments+. Additionally, individual jobs can
+      # also configure a value, which will apply to themselves and any
+      # subclasses.
       class_attribute :log_arguments, instance_accessor: false, default: true
 
       around_enqueue(prepend: true) { |_, block| tag_logger(&block) }
     end
 
-    def perform_now
+    def perform_now # :nodoc:
       tag_logger(self.class.name, self.job_id) { super }
     end
 

data/lib/active_job/queue_adapter.rb

@@ -15,7 +15,8 @@ module ActiveJob
   # = Active Job Queue adapter
   #
   # The +ActiveJob::QueueAdapter+ module is used to load the
-  # correct adapter. The default queue adapter is the +:async+ queue.
+  # correct adapter. The default queue adapter is +:async+,
+  # which loads the ActiveJob::QueueAdapters::AsyncAdapter.
   module QueueAdapter # :nodoc:
     extend ActiveSupport::Concern
 
@@ -24,21 +25,21 @@ module ActiveJob
       class_attribute :_queue_adapter, instance_accessor: false, instance_predicate: false
 
       delegate :queue_adapter, to: :class
-
-      self.queue_adapter = :async
     end
 
     # Includes the setter method for changing the active queue adapter.
     module ClassMethods
       # Returns the backend queue provider. The default queue adapter
-      # is the +:async+ queue. See QueueAdapters for more information.
+      # is +:async+. See QueueAdapters for more information.
       def queue_adapter
+        self.queue_adapter = :async if _queue_adapter.nil?
         _queue_adapter
       end
 
       # Returns string denoting the name of the configured queue adapter.
       # By default returns <tt>"async"</tt>.
       def queue_adapter_name
+        self.queue_adapter = :async if _queue_adapter_name.nil?
         _queue_adapter_name
       end
 

data/lib/active_job/queue_adapters/abstract_adapter.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module ActiveJob
+  module QueueAdapters
+    # = Active Job Abstract Adapter
+    #
+    # 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
+
+      def enqueue_at(job, timestamp)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/active_job/queue_adapters/async_adapter.rb

@@ -30,7 +30,7 @@ module ActiveJob
     # The adapter uses a {Concurrent Ruby}[https://github.com/ruby-concurrency/concurrent-ruby] thread pool to schedule and execute
     # jobs. Since jobs share a single thread pool, long-running jobs will block
     # short-lived jobs. Fine for dev/test; bad for production.
-    class AsyncAdapter
+    class AsyncAdapter < AbstractAdapter
       # See {Concurrent::ThreadPoolExecutor}[https://ruby-concurrency.github.io/concurrent-ruby/master/Concurrent/ThreadPoolExecutor.html] for executor options.
       def initialize(**executor_options)
         @scheduler = Scheduler.new(**executor_options)

data/lib/active_job/queue_adapters/backburner_adapter.rb

@@ -14,7 +14,7 @@ module ActiveJob
     # To use Backburner set the queue_adapter config to +:backburner+.
     #
     #   Rails.application.config.active_job.queue_adapter = :backburner
-    class BackburnerAdapter
+    class BackburnerAdapter < AbstractAdapter
       def enqueue(job) # :nodoc:
         response = Backburner::Worker.enqueue(JobWrapper, [job.serialize], queue: job.queue_name, pri: job.priority)
         job.provider_job_id = response[:id] if response.is_a?(Hash)

data/lib/active_job/queue_adapters/delayed_job_adapter.rb

@@ -15,7 +15,15 @@ module ActiveJob
     # To use Delayed Job, set the queue_adapter config to +:delayed_job+.
     #
     #   Rails.application.config.active_job.queue_adapter = :delayed_job
-    class DelayedJobAdapter
+    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

data/lib/active_job/queue_adapters/inline_adapter.rb

@@ -10,7 +10,11 @@ module ActiveJob
     # To use the Inline set the queue_adapter config to +:inline+.
     #
     #   Rails.application.config.active_job.queue_adapter = :inline
-    class InlineAdapter
+    class InlineAdapter < AbstractAdapter
+      def enqueue_after_transaction_commit? # :nodoc:
+        false
+      end
+
       def enqueue(job) # :nodoc:
         Base.execute(job.serialize)
       end

data/lib/active_job/queue_adapters/queue_classic_adapter.rb

@@ -18,7 +18,15 @@ module ActiveJob
     # To use queue_classic set the queue_adapter config to +:queue_classic+.
     #
     #   Rails.application.config.active_job.queue_adapter = :queue_classic
-    class QueueClassicAdapter
+    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)

data/lib/active_job/queue_adapters/resque_adapter.rb

@@ -27,7 +27,7 @@ module ActiveJob
     # To use Resque set the queue_adapter config to +:resque+.
     #
     #   Rails.application.config.active_job.queue_adapter = :resque
-    class ResqueAdapter
+    class ResqueAdapter < AbstractAdapter
       def enqueue(job) # :nodoc:
         JobWrapper.instance_variable_set(:@queue, job.queue_name)
         Resque.enqueue_to job.queue_name, JobWrapper, job.serialize

data/lib/active_job/queue_adapters/sidekiq_adapter.rb

@@ -17,7 +17,7 @@ module ActiveJob
     # To use Sidekiq set the queue_adapter config to +:sidekiq+.
     #
     #   Rails.application.config.active_job.queue_adapter = :sidekiq
-    class SidekiqAdapter
+    class SidekiqAdapter < AbstractAdapter
       def enqueue(job) # :nodoc:
         job.provider_job_id = JobWrapper.set(
           wrapped: job.class,

data/lib/active_job/queue_adapters/sneakers_adapter.rb

@@ -17,7 +17,7 @@ module ActiveJob
     # To use Sneakers set the queue_adapter config to +:sneakers+.
     #
     #   Rails.application.config.active_job.queue_adapter = :sneakers
-    class SneakersAdapter
+    class SneakersAdapter < AbstractAdapter
       def initialize
         @monitor = Monitor.new
       end

data/lib/active_job/queue_adapters/sucker_punch_adapter.rb

@@ -17,7 +17,7 @@ module ActiveJob
     # To use Sucker Punch set the queue_adapter config to +:sucker_punch+.
     #
     #   Rails.application.config.active_job.queue_adapter = :sucker_punch
-    class SuckerPunchAdapter
+    class SuckerPunchAdapter < AbstractAdapter
       def enqueue(job) # :nodoc:
         if JobWrapper.respond_to?(:perform_async)
           # sucker_punch 2.0 API

data/lib/active_job/queue_adapters/test_adapter.rb

@@ -11,10 +11,18 @@ module ActiveJob
     # To use the test adapter set +queue_adapter+ config to +:test+.
     #
     #   Rails.application.config.active_job.queue_adapter = :test
-    class TestAdapter
-      attr_accessor(:perform_enqueued_jobs, :perform_enqueued_at_jobs, :filter, :reject, :queue, :at)
+    class TestAdapter < AbstractAdapter
+      attr_accessor(:perform_enqueued_jobs, :perform_enqueued_at_jobs, :filter, :reject, :queue, :at, :enqueue_after_transaction_commit)
       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 ||= []

data/lib/active_job/queue_adapters.rb

@@ -114,6 +114,7 @@ module ActiveJob
   module QueueAdapters
     extend ActiveSupport::Autoload
 
+    autoload :AbstractAdapter
     autoload :AsyncAdapter
     autoload :InlineAdapter
     autoload :BackburnerAdapter

data/lib/active_job/railtie.rb

@@ -25,9 +25,21 @@ module ActiveJob
       end
     end
 
+    initializer "active_job.enqueue_after_transaction_commit" do |app|
+      ActiveSupport.on_load(:active_job) do
+        ActiveSupport.on_load(:active_record) do
+          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)
+          end
+        end
+      end
+    end
+
     initializer "active_job.set_configs" do |app|
       options = app.config.active_job
-      options.queue_adapter ||= :async
+      options.queue_adapter ||= (Rails.env.test? ? :test : :async)
 
       config.after_initialize do
         options.each do |k, v|

data/lib/active_job/serializers/object_serializer.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "singleton"
+
 module ActiveJob
   module Serializers
     # Base class for serializing and deserializing custom objects.

data/lib/active_job/test_helper.rb

@@ -39,10 +39,13 @@ module ActiveJob
     end
 
     def before_setup # :nodoc:
-      test_adapter = queue_adapter_for_test
-
+      queue_adapter_specific_to_this_test_class = queue_adapter_for_test
       queue_adapter_changed_jobs.each do |klass|
-        klass.enable_test_adapter(test_adapter)
+        if queue_adapter_specific_to_this_test_class
+          klass.enable_test_adapter(queue_adapter_specific_to_this_test_class)
+        elsif klass._queue_adapter.nil?
+          klass.enable_test_adapter(ActiveJob::QueueAdapters::TestAdapter.new)
+        end
       end
 
       clear_enqueued_jobs
@@ -61,7 +64,6 @@ module ActiveJob
     # Override this method to specify a different adapter. The adapter must
     # implement the same interface as ActiveJob::QueueAdapters::TestAdapter.
     def queue_adapter_for_test
-      ActiveJob::QueueAdapters::TestAdapter.new
     end
 
     # Asserts that the number of enqueued jobs matches the given number.
@@ -118,6 +120,8 @@ module ActiveJob
     #     end
     #   end
     def assert_enqueued_jobs(number, only: nil, except: nil, queue: nil, &block)
+      require_active_job_test_adapter!("assert_enqueued_jobs")
+
       if block_given?
         original_jobs = enqueued_jobs_with(only: only, except: except, queue: queue)
 
@@ -180,6 +184,8 @@ module ActiveJob
     #
     #   assert_enqueued_jobs 0, &block
     def assert_no_enqueued_jobs(only: nil, except: nil, queue: nil, &block)
+      require_active_job_test_adapter!("assert_no_enqueued_jobs")
+
       assert_enqueued_jobs 0, only: only, except: except, queue: queue, &block
     end
 
@@ -270,6 +276,8 @@ module ActiveJob
     #       end
     #     end
     def assert_performed_jobs(number, only: nil, except: nil, queue: nil, &block)
+      require_active_job_test_adapter!("assert_performed_jobs")
+
       if block_given?
         original_count = performed_jobs.size
 
@@ -338,6 +346,8 @@ module ActiveJob
     #
     #   assert_performed_jobs 0, &block
     def assert_no_performed_jobs(only: nil, except: nil, queue: nil, &block)
+      require_active_job_test_adapter!("assert_no_performed_jobs")
+
       assert_performed_jobs 0, only: only, except: except, queue: queue, &block
     end
 
@@ -394,6 +404,8 @@ module ActiveJob
     #     end
     #   end
     def assert_enqueued_with(job: nil, args: nil, at: nil, queue: nil, priority: nil, &block)
+      require_active_job_test_adapter!("assert_enqueued_with")
+
       expected = { job: job, args: args, at: at, queue: queue, priority: priority }.compact
       expected_args = prepare_args_for_assertion(expected)
       potential_matches = []
@@ -496,6 +508,8 @@ module ActiveJob
     #     end
     #   end
     def assert_performed_with(job: nil, args: nil, at: nil, queue: nil, priority: nil, &block)
+      require_active_job_test_adapter!("assert_performed_with")
+
       expected = { job: job, args: args, at: at, queue: queue, priority: priority }.compact
       expected_args = prepare_args_for_assertion(expected)
       potential_matches = []
@@ -604,7 +618,10 @@ module ActiveJob
     # If queue_adapter_for_test is overridden to return a different adapter,
     # +perform_enqueued_jobs+ will merely execute the block.
     def perform_enqueued_jobs(only: nil, except: nil, queue: nil, at: nil, &block)
-      return flush_enqueued_jobs(only: only, except: except, queue: queue, at: at) unless block_given?
+      unless block_given?
+        require_active_job_test_adapter!("perform_enqueued_jobs (without a block)")
+        return flush_enqueued_jobs(only: only, except: except, queue: queue, at: at)
+      end
 
       return _assert_nothing_raised_or_warn("perform_enqueued_jobs", &block) unless using_test_adapter?
 
@@ -646,6 +663,12 @@ module ActiveJob
     end
 
     private
+      def require_active_job_test_adapter!(method)
+        unless using_test_adapter?
+          raise ArgumentError.new("#{method} requires the Active Job test adapter, you're using #{queue_adapter.class.name}.")
+        end
+      end
+
       def using_test_adapter?
         queue_adapter.is_a?(ActiveJob::QueueAdapters::TestAdapter)
       end

data/lib/active_job.rb

@@ -39,6 +39,7 @@ module ActiveJob
   autoload :Arguments
   autoload :DeserializationError, "active_job/arguments"
   autoload :SerializationError, "active_job/arguments"
+  autoload :EnqueueAfterTransactionCommit
 
   eager_autoload do
     autoload :Serializers
@@ -48,16 +49,20 @@ module ActiveJob
   autoload :TestCase
   autoload :TestHelper
 
-  ##
-  # :singleton-method:
-  # If false, \Rails will preserve the legacy serialization of BigDecimal job arguments as Strings.
-  # If true, \Rails will use the new BigDecimalSerializer to (de)serialize BigDecimal losslessly.
-  # Legacy serialization will be removed in \Rails 7.2, along with this config.
-  singleton_class.attr_accessor :use_big_decimal_serializer
-  self.use_big_decimal_serializer = false
+  def self.use_big_decimal_serializer
+    ActiveJob.deprecator.warn <<-WARNING.squish
+      Rails.application.config.active_job.use_big_decimal_serializer is deprecated and will be removed in Rails 8.0.
+    WARNING
+  end
+
+  def self.use_big_decimal_serializer=(value)
+    ActiveJob.deprecator.warn <<-WARNING.squish
+      Rails.application.config.active_job.use_big_decimal_serializer is deprecated and will be removed in Rails 8.0.
+    WARNING
+  end
 
   ##
-  # :singleton-method:
+  # :singleton-method: verbose_enqueue_logs
   #
   # Specifies if the methods calling background job enqueue should be logged below
   # their relevant enqueue log lines. Defaults to false.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activejob
 version: !ruby/object:Gem::Version
-  version: 7.1.5.1
+  version: 7.2.2.1
 platform: ruby
 authors:
 - David Heinemeier Hansson
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.1.5.1
+        version: 7.2.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.1.5.1
+        version: 7.2.2.1
 - !ruby/object:Gem::Dependency
   name: globalid
   requirement: !ruby/object:Gem::Requirement
@@ -54,6 +54,7 @@ files:
 - lib/active_job/configured_job.rb
 - lib/active_job/core.rb
 - lib/active_job/deprecator.rb
+- lib/active_job/enqueue_after_transaction_commit.rb
 - lib/active_job/enqueuing.rb
 - lib/active_job/exceptions.rb
 - lib/active_job/execution.rb
@@ -63,6 +64,7 @@ files:
 - lib/active_job/logging.rb
 - lib/active_job/queue_adapter.rb
 - lib/active_job/queue_adapters.rb
+- lib/active_job/queue_adapters/abstract_adapter.rb
 - lib/active_job/queue_adapters/async_adapter.rb
 - lib/active_job/queue_adapters/backburner_adapter.rb
 - lib/active_job/queue_adapters/delayed_job_adapter.rb
@@ -102,10 +104,10 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/rails/rails/issues
-  changelog_uri: https://github.com/rails/rails/blob/v7.1.5.1/activejob/CHANGELOG.md
-  documentation_uri: https://api.rubyonrails.org/v7.1.5.1/
+  changelog_uri: https://github.com/rails/rails/blob/v7.2.2.1/activejob/CHANGELOG.md
+  documentation_uri: https://api.rubyonrails.org/v7.2.2.1/
   mailing_list_uri: https://discuss.rubyonrails.org/c/rubyonrails-talk
-  source_code_uri: https://github.com/rails/rails/tree/v7.1.5.1/activejob
+  source_code_uri: https://github.com/rails/rails/tree/v7.2.2.1/activejob
   rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
@@ -115,7 +117,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="