activejob 7.0.8 → 7.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 235128c7d980f87db5c8868459c333bd46426236218aae248293461011c39f82
-  data.tar.gz: d8c90ea58afcb522bb34846a4356dbc4f06063d3edd89b1486bce21d07b0272f
+  metadata.gz: 61775543f203855f8c8bdec31ddaa7d3c1413aab36a2de5665a726b7f5998307
+  data.tar.gz: 39b14d506be28b9c980fc69ac8910c8e31245aa8e19caa4a15b3511f9d90cac8
 SHA512:
-  metadata.gz: de04d283bcec657df1b29faa766d084c95820ef6f0505633484a8e15e6421a8e1313cb2727a9dfc6b09c280f1e4a1533a0673ceb0489ac674834ec0fbbd65bf2
-  data.tar.gz: 3c9bb2aa0e47b7482a3ec51e25747c0952f457f6770ddbbeaa56b7c6bac137a2046a8df778237fb4a2500b533962711b1d5e0b5efceaff49bb3d2cf725fc4f0b
+  metadata.gz: 6351b9fb7e90d452428f30db98315ff523cbd781f409df3fba0ae7241fdedc0ae52514a3d5c4acd01b9474e235844e683a832f6631d65e8ea77b261bea0b3cf9
+  data.tar.gz: 9e18505077f83dd8924cb866138d0809b83fb9df68623f9a5e67cc0dbe1fcdcaea4a59c9de5cd9a4884684a1202b54a8ad0da657f08f5474a6790d20436be130

data/CHANGELOG.md

@@ -1,246 +1,67 @@
-## Rails 7.0.8 (September 09, 2023) ##
+## Rails 7.2.0 (August 09, 2024) ##
 
-*   Fix Active Job log message to correctly report a job failed to enqueue
-    when the adapter raises an `ActiveJob::EnqueueError`.
+*   All tests now respect the `active_job.queue_adapter` config.
 
-    *Ben Sheldon*
+    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`.
 
+    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.
 
-## Rails 7.0.7.2 (August 22, 2023) ##
-
-*   No changes.
-
-
-## Rails 7.0.7.1 (August 22, 2023) ##
-
-*   No changes.
-
-
-## Rails 7.0.7 (August 09, 2023) ##
-
-*   No changes.
-
-
-## Rails 7.0.6 (June 29, 2023) ##
-
-*   Fix error Active Job passed class with `permitted?`.
-
-    *Alex Baldwin*
-
-
-## Rails 7.0.5.1 (June 26, 2023) ##
-
-*   No changes.
-
-
-## Rails 7.0.5 (May 24, 2023) ##
-
-*   Make delayed job `display_name` failsafe.
-
-    *codez*
-
-*   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.
+    See [#48585](https://github.com/rails/rails/pull/48585) for more details.
 
     *Alex Ghiculescu*
 
+*   Make Active Job transaction aware when used conjointly with Active Record.
 
-## Rails 7.0.4.3 (March 13, 2023) ##
-
-*   No changes.
-
-
-## Rails 7.0.4.2 (January 24, 2023) ##
-
-*   No changes.
-
-
-## Rails 7.0.4.1 (January 17, 2023) ##
-
-*   No changes.
-
-
-## Rails 7.0.4 (September 09, 2022) ##
-
-*   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*
-
-## Rails 7.0.3.1 (July 12, 2022) ##
-
-*   No changes.
-
-
-## Rails 7.0.3 (May 09, 2022) ##
-
-*   Add missing `bigdecimal` require in `ActiveJob::Arguments`
-
-    Could cause `uninitialized constant ActiveJob::Arguments::BigDecimal (NameError)`
-    when loading Active Job in isolation.
-
-    *Jean Boussier*
-
-## Rails 7.0.2.4 (April 26, 2022) ##
-
-*   No changes.
-
-
-## Rails 7.0.2.3 (March 08, 2022) ##
-
-*   No changes.
-
-
-## Rails 7.0.2.2 (February 11, 2022) ##
-
-*   No changes.
-
-
-## Rails 7.0.2.1 (February 11, 2022) ##
-
-*   No changes.
-
-
-## Rails 7.0.2 (February 08, 2022) ##
-
-*   No changes.
-
-
-## Rails 7.0.1 (January 06, 2022) ##
-
-*   Allow testing `discard_on/retry_on ActiveJob::DeserializationError`
-
-    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 behaviour makes difficult testing the job `discard_on/retry_on` logic.
-
-    Now `deserialize_arguments_if_needed` call is postponed to when `perform_now`
-    is called.
-
-    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
-    class UpdateUserJob < ActiveJob::Base
-      discard_on ActiveJob::DeserializationError
-
-      def perform(user)
-        # ...
-      end
-    end
-
-    # In the test
-    User.destroy_all
-    assert_nothing_raised do
-      perform_enqueued_jobs only: UpdateUserJob
+    Topic.transaction do
+      topic = Topic.create(...)
+      NewTopicNotificationJob.perform_later(topic)
     end
     ```
 
-    *Jacopo Beschi*
-
-
-## Rails 7.0.0 (December 15, 2021) ##
-
-*   No changes.
+    Now Active Job will automatically defer the enqueuing to after the transaction is committed,
+    and drop the job if the transaction is rolled back.
 
+    Various queue implementations can choose to disable this behavior, and users can disable it,
+    or force it on a per job basis:
 
-## Rails 7.0.0.rc3 (December 14, 2021) ##
+    ```ruby
+    class NewTopicNotificationJob < ApplicationJob
+      self.enqueue_after_transaction_commit = :never # or `:always` or `:default`
+    end
+    ```
 
-*   No changes.
+    *Jean Boussier*, *Cristian Bica*
 
+*   Do not trigger immediate loading of `ActiveJob::Base` when loading `ActiveJob::TestHelper`.
 
-## Rails 7.0.0.rc2 (December 14, 2021) ##
+    *Maxime Réty*
 
-*   No changes.
+*   Preserve the serialized timezone when deserializing `ActiveSupport::TimeWithZone` arguments.
 
-## Rails 7.0.0.rc1 (December 06, 2021) ##
+    *Joshua Young*
 
-*   Remove deprecated `:return_false_on_aborted_enqueue` option.
+*   Remove deprecated `:exponentially_longer` value for the `:wait` in `retry_on`.
 
     *Rafael Mendonça França*
 
-*   Deprecated `Rails.config.active_job.skip_after_callbacks_if_terminated`.
+*   Remove deprecated support to set numeric values to `scheduled_at` attribute.
 
     *Rafael Mendonça França*
 
-*   Removed deprecated behavior that was not halting `after_enqueue`/`after_perform` callbacks when a
-    previous callback was halted with `throw :abort`.
+*   Deprecate `Rails.application.config.active_job.use_big_decimal_serialize`.
 
     *Rafael Mendonça França*
 
-*   Raise an `SerializationError` in `Serializer::ModuleSerializer`
-    if the module name is not present.
-
-    *Veerpal Brar*
-
-
-## Rails 7.0.0.alpha2 (September 15, 2021) ##
-
-*   No changes.
-
-
-## Rails 7.0.0.alpha1 (September 15, 2021) ##
-
-*   Allow a job to retry indefinitely
-
-    The `attempts` parameter of the `retry_on` method now accepts the
-    symbol reference `:unlimited` in addition to a specific number of retry
-    attempts to allow a developer to specify that a job should retry
-    forever until it succeeds.
-
-        class MyJob < ActiveJob::Base
-          retry_on(AlwaysRetryException, attempts: :unlimited)
-
-          # the actual job code
-        end
-
-    *Daniel Morton*
-
-*   Added possibility to check on `:priority` in test helper methods
-    `assert_enqueued_with` and `assert_performed_with`.
-
-    *Wojciech Wnętrzak*
-
-*   OpenSSL constants are now used for Digest computations.
-
-    *Dirkjan Bussink*
-
-*   Add a Serializer for the Range class.
-
-    This should allow things like `MyJob.perform_later(range: 1..100)`.
-
-*   Communicate enqueue failures to callers of `perform_later`.
-
-    `perform_later` can now optionally take a block which will execute after
-    the adapter attempts to enqueue the job. The block will receive the job
-    instance as an argument even if the enqueue was not successful.
-    Additionally, `ActiveJob` adapters now have the ability to raise an
-    `ActiveJob::EnqueueError` which will be caught and stored in the job
-    instance so code attempting to enqueue jobs can inspect any raised
-    `EnqueueError` using the block.
-
-        MyJob.perform_later do |job|
-          unless job.successfully_enqueued?
-            if job.enqueue_error&.message == "Redis was unavailable"
-              # invoke some code that will retry the job after a delay
-            end
-          end
-        end
-
-    *Daniel Morton*
-
-*   Don't log rescuable exceptions defined with `rescue_from`.
-
-    *Hu Hailin*
-
-*   Allow `rescue_from` to rescue all exceptions.
-
-    *Adrianna Chang*, *Étienne Barrié*
+*   Remove deprecated primitive serializer for `BigDecimal` arguments.
 
+    *Rafael Mendonça França*
 
-Please check [6-1-stable](https://github.com/rails/rails/blob/6-1-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/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2014-2022 David Heinemeier Hansson
+Copyright (c) David Heinemeier Hansson
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -10,14 +10,14 @@ that makes it easy to turn any mailing into a job for running later. That's
 one of the most common jobs in a modern web application: sending emails outside
 the request-response cycle, so the user doesn't have to wait on it.
 
-The main point is to ensure that all Rails apps will have a job infrastructure
+The main point is to ensure that all \Rails apps will have a job infrastructure
 in place, even if it's in the form of an "immediate runner". We can then have
 framework features and other gems build on top of that, without having to worry
 about API differences between Delayed Job and Resque. Picking your queuing
 backend becomes more of an operational concern, then. And you'll be able to
 switch between them without having to rewrite your jobs.
 
-You can read more about Active Job in the [Active Job Basics](https://edgeguides.rubyonrails.org/active_job_basics.html) guide.
+You can read more about Active Job in the [Active Job Basics](https://guides.rubyonrails.org/active_job_basics.html) guide.
 
 ## Usage
 

data/lib/active_job/arguments.rb

@@ -46,8 +46,6 @@ module ActiveJob
     end
 
     private
-      # :nodoc:
-      PERMITTED_TYPES = [ NilClass, String, Integer, Float, BigDecimal, TrueClass, FalseClass ]
       # :nodoc:
       GLOBALID_KEY = "_aj_globalid"
       # :nodoc:
@@ -67,35 +65,23 @@ module ActiveJob
         OBJECT_SERIALIZER_KEY, OBJECT_SERIALIZER_KEY.to_sym,
         WITH_INDIFFERENT_ACCESS_KEY, WITH_INDIFFERENT_ACCESS_KEY.to_sym,
       ]
-      private_constant :PERMITTED_TYPES, :RESERVED_KEYS, :GLOBALID_KEY,
+      private_constant :RESERVED_KEYS, :GLOBALID_KEY,
         :SYMBOL_KEYS_KEY, :RUBY2_KEYWORDS_KEY, :WITH_INDIFFERENT_ACCESS_KEY
 
-      unless Hash.respond_to?(:ruby2_keywords_hash?) && Hash.respond_to?(:ruby2_keywords_hash)
-        using Module.new {
-          refine Hash do
-            class << Hash
-              def ruby2_keywords_hash?(hash)
-                !new(*[hash]).default.equal?(hash)
-              end
-
-              def ruby2_keywords_hash(hash)
-                _ruby2_keywords_hash(**hash)
-              end
-
-              private
-                def _ruby2_keywords_hash(*args)
-                  args.last
-                end
-                ruby2_keywords(:_ruby2_keywords_hash)
-            end
-          end
-        }
-      end
-
       def serialize_argument(argument)
         case argument
-        when *PERMITTED_TYPES
+        when nil, true, false, Integer, Float # Types that can hardly be subclassed
           argument
+        when String
+          if argument.class == String
+            argument
+          else
+            begin
+              Serializers.serialize(argument)
+            rescue SerializationError
+              argument
+            end
+          end
         when GlobalID::Identification
           convert_to_global_id_hash(argument)
         when Array
@@ -112,18 +98,18 @@ module ActiveJob
           result = serialize_hash(argument)
           result[aj_hash_key] = symbol_keys
           result
-        when -> (arg) { arg.respond_to?(:permitted?) && arg.respond_to?(:to_h) }
-          serialize_indifferent_hash(argument.to_h)
         else
-          Serializers.serialize(argument)
+          if argument.respond_to?(:permitted?) && argument.respond_to?(:to_h)
+            serialize_indifferent_hash(argument.to_h)
+          else
+            Serializers.serialize(argument)
+          end
         end
       end
 
       def deserialize_argument(argument)
         case argument
-        when String
-          argument
-        when *PERMITTED_TYPES
+        when nil, true, false, String, Integer, Float
           argument
         when Array
           argument.map { |arg| deserialize_argument(arg) }

data/lib/active_job/base.rb

@@ -15,7 +15,7 @@ require "active_job/timezones"
 require "active_job/translation"
 
 module ActiveJob # :nodoc:
-  # = Active Job
+  # = Active Job \Base
   #
   # Active Job objects can be configured to work with different backend
   # queuing frameworks. To specify a queue adapter to use:

data/lib/active_job/callbacks.rb

@@ -4,7 +4,7 @@ require "active_support/callbacks"
 require "active_support/core_ext/module/attribute_accessors"
 
 module ActiveJob
-  # = Active Job Callbacks
+  # = Active Job \Callbacks
   #
   # Active Job provides hooks during the life cycle of a job. Callbacks allow you
   # to trigger logic during this cycle. Available callbacks are:
@@ -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
@@ -28,9 +25,6 @@ module ActiveJob
     end
 
     included do
-      cattr_accessor :skip_after_callbacks_if_terminated, instance_accessor: false, default: false
-      singleton_class.deprecate :skip_after_callbacks_if_terminated, :skip_after_callbacks_if_terminated=
-
       define_callbacks :perform, skip_after_callbacks_if_terminated: true
       define_callbacks :enqueue, skip_after_callbacks_if_terminated: true
     end
@@ -135,7 +129,8 @@ module ActiveJob
       #     queue_as :default
       #
       #     after_enqueue do |job|
-      #       $statsd.increment "enqueue-video-job.success"
+      #       result = job.successfully_enqueued? ? "success" : "failure"
+      #       $statsd.increment "enqueue-video-job.#{result}"
       #     end
       #
       #     def perform(video_id)

data/lib/active_job/configured_job.rb

@@ -14,5 +14,9 @@ module ActiveJob
     def perform_later(...)
       @job_class.new(...).enqueue @options
     end
+
+    def perform_all_later(multi_args)
+      @job_class.perform_all_later(multi_args, options: @options)
+    end
   end
 end

data/lib/active_job/core.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module ActiveJob
+  # = Active Job \Core
+  #
   # Provides general behavior that will be included into every Active Job
   # object that inherits from ActiveJob::Base.
   module Core
@@ -10,7 +12,7 @@ module ActiveJob
     attr_accessor :arguments
     attr_writer :serialized_arguments
 
-    # Timestamp when the job should be performed
+    # Time when the job should be performed
     attr_accessor :scheduled_at
 
     # Job Identifier
@@ -92,6 +94,7 @@ module ActiveJob
       @arguments  = arguments
       @job_id     = SecureRandom.uuid
       @queue_name = self.class.queue_name
+      @scheduled_at = nil
       @priority   = self.class.priority
       @executions = 0
       @exception_executions = {}
@@ -113,7 +116,8 @@ module ActiveJob
         "exception_executions" => exception_executions,
         "locale"     => I18n.locale.to_s,
         "timezone"   => timezone,
-        "enqueued_at" => Time.now.utc.iso8601
+        "enqueued_at" => Time.now.utc.iso8601(9),
+        "scheduled_at" => scheduled_at ? scheduled_at.utc.iso8601(9) : nil,
       }
     end
 
@@ -153,13 +157,14 @@ module ActiveJob
       self.exception_executions = job_data["exception_executions"]
       self.locale               = job_data["locale"] || I18n.locale.to_s
       self.timezone             = job_data["timezone"] || Time.zone&.name
-      self.enqueued_at          = job_data["enqueued_at"]
+      self.enqueued_at          = Time.iso8601(job_data["enqueued_at"]) if job_data["enqueued_at"]
+      self.scheduled_at         = Time.iso8601(job_data["scheduled_at"]) if job_data["scheduled_at"]
     end
 
     # Configures the job with the given options.
     def set(options = {}) # :nodoc:
-      self.scheduled_at = options[:wait].seconds.from_now.to_f if options[:wait]
-      self.scheduled_at = options[:wait_until].to_f if options[:wait_until]
+      self.scheduled_at = options[:wait].seconds.from_now if options[:wait]
+      self.scheduled_at = options[:wait_until] if options[:wait_until]
       self.queue_name   = self.class.queue_name_from_part(options[:queue]) if options[:queue]
       self.priority     = options[:priority].to_i if options[:priority]
 
@@ -191,7 +196,7 @@ module ActiveJob
       end
 
       def arguments_serialized?
-        defined?(@serialized_arguments) && @serialized_arguments
+        @serialized_arguments
       end
   end
 end

data/lib/active_job/deprecator.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActiveJob
+  def self.deprecator # :nodoc:
+    @deprecator ||= ActiveSupport::Deprecation.new
+  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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "active_job/arguments"
-
 module ActiveJob
   # Provides behavior for enqueuing jobs.
 
@@ -9,9 +7,53 @@ module ActiveJob
   # why the adapter was unexpectedly unable to enqueue a job.
   class EnqueueError < StandardError; end
 
+  class << self
+    # Push many jobs onto the queue at once without running enqueue callbacks.
+    # Queue adapters may communicate the enqueue status of each job by setting
+    # successfully_enqueued and/or enqueue_error on the passed-in job instances.
+    def perform_all_later(*jobs)
+      jobs.flatten!
+      jobs.group_by(&:queue_adapter).each do |queue_adapter, adapter_jobs|
+        instrument_enqueue_all(queue_adapter, adapter_jobs) do
+          if queue_adapter.respond_to?(:enqueue_all)
+            queue_adapter.enqueue_all(adapter_jobs)
+          else
+            adapter_jobs.each do |job|
+              job.successfully_enqueued = false
+              if job.scheduled_at
+                queue_adapter.enqueue_at(job, job.scheduled_at.to_f)
+              else
+                queue_adapter.enqueue(job)
+              end
+              job.successfully_enqueued = true
+            rescue EnqueueError => e
+              job.enqueue_error = e
+            end
+            adapter_jobs.count(&:successfully_enqueued?)
+          end
+        end
+      end
+      nil
+    end
+  end
+
   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,
@@ -22,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
@@ -35,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)
@@ -61,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
+          queue_adapter.enqueue_at self, scheduled_at.to_f
         else
           queue_adapter.enqueue self
         end
@@ -71,12 +137,5 @@ module ActiveJob
       rescue EnqueueError => e
         self.enqueue_error = e
       end
-
-      if successfully_enqueued?
-        self
-      else
-        false
-      end
-    end
   end
 end