activejob 7.0.8 → 7.1.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 235128c7d980f87db5c8868459c333bd46426236218aae248293461011c39f82
-  data.tar.gz: d8c90ea58afcb522bb34846a4356dbc4f06063d3edd89b1486bce21d07b0272f
+  metadata.gz: 6afc607e83451a80e5538b8289eb78a3d4256a82648d2fc364c00b35d86652a1
+  data.tar.gz: 66372474efc76dc1bcb4e4bc7e32bc6ccfbf62242bd394bfa0b6982a65a48133
 SHA512:
-  metadata.gz: de04d283bcec657df1b29faa766d084c95820ef6f0505633484a8e15e6421a8e1313cb2727a9dfc6b09c280f1e4a1533a0673ceb0489ac674834ec0fbbd65bf2
-  data.tar.gz: 3c9bb2aa0e47b7482a3ec51e25747c0952f457f6770ddbbeaa56b7c6bac137a2046a8df778237fb4a2500b533962711b1d5e0b5efceaff49bb3d2cf725fc4f0b
+  metadata.gz: d3ec6a49ca490b307c258df58fa5d6885d7be0ecd3d7db615096a06696ea718e129002198603cd46be21a3c2c7e43146e22e0f3350da69c3a828945a3785cff8
+  data.tar.gz: 1d051b0f106d489def667bf37f5801a452269742c25029fd392eb826a02830762730bae3fb556f8a175b79f91b57bb43e49c6d1f69d74ed4d40edea03abe2c1f

data/CHANGELOG.md

@@ -1,116 +1,194 @@
-## Rails 7.0.8 (September 09, 2023) ##
+## 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.
 
-## Rails 7.0.7.2 (August 22, 2023) ##
+    This method lets job authors define a block which will be run when a job is about to be discarded. For example:
 
-*   No changes.
+    ```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
+    ```
 
-## Rails 7.0.7.1 (August 22, 2023) ##
+    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.
 
-*   No changes.
+    *Rob Cardy*
 
+*   Fix deserialization of ActiveSupport::Duration
 
-## Rails 7.0.7 (August 09, 2023) ##
+    Previously, a deserialized Duration would return an array from Duration#parts.
+    It will now return a hash just like a regular Duration.
 
-*   No changes.
+    This also fixes an error when trying to add or subtract from a deserialized Duration
+    (eg `duration + 1.year`).
 
+    *Jonathan del Strother*
 
-## Rails 7.0.6 (June 29, 2023) ##
+*   `perform_enqueued_jobs` is now compatible with all Active Job adapters
 
-*   Fix error Active Job passed class with `permitted?`.
+    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.
 
-    *Alex Baldwin*
+    *Alex Ghiculescu*
 
+*   Allow queue adapters to provide a custom name by implementing `queue_adapter_name`
 
-## Rails 7.0.5.1 (June 26, 2023) ##
+    *Sander Verdonschot*
 
-*   No changes.
+*   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.
 
-## Rails 7.0.5 (May 24, 2023) ##
+    Example log line:
 
-*   Make delayed job `display_name` failsafe.
+    ```
+    Enqueued AvatarThumbnailsJob (Job ID: ab528951-41fb-4c48-9129-3171791c27d6) to Sidekiq(default) with arguments: 1092412064
+    ↳ app/models/user.rb:421:in `generate_avatar_thumbnails'
+    ```
 
-    *codez*
+    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.
 
-*   Don't double log the `job` when using `ActiveRecord::QueryLog`
+    *fatkodima*
 
-    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.
+*   Set `provider_job_id` for Backburner jobs
 
-    *Alex Ghiculescu*
+    *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:
 
+    ```ruby
+    ActiveJob.perform_all_later(MyJob.new("hello", 42), MyJob.new("world", 0))
 
-## Rails 7.0.4.3 (March 13, 2023) ##
+    user_jobs = User.pluck(:id).map { |id| UserJob.new(user_id: id) }
+    ActiveJob.perform_all_later(user_jobs)
+    ```
 
-*   No changes.
+    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`.
 
-## Rails 7.0.4.2 (January 24, 2023) ##
+    *Sander Verdonschot*
 
-*   No changes.
+*   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.
 
-## Rails 7.0.4.1 (January 17, 2023) ##
+    *Alex Ghiculescu*
 
-*   No changes.
+*   Add support for Sidekiq's transaction-aware client
 
+    *Jonathan del Strother*
 
-## Rails 7.0.4 (September 09, 2022) ##
+*   Remove QueAdapter from Active Job.
 
-*   Update `ActiveJob::QueueAdapters::QueAdapter` to remove deprecation warning.
+    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.
 
-    Remove a deprecation warning introduced in que 1.2 to prepare for changes in
-    que 2.0 necessary for Ruby 3 compatibility.
+    Active Job Que adapter can be included in the future version of que gem itself.
 
-    *Damir Zekic* and *Adis Hasovic*
+    *Yasuo Honda*
 
-## Rails 7.0.3.1 (July 12, 2022) ##
+*   Fix BigDecimal (de)serialization for adapters using JSON.
 
-*   No changes.
+    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.
 
-## Rails 7.0.3 (May 09, 2022) ##
+    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..
 
-*   Add missing `bigdecimal` require in `ActiveJob::Arguments`
+    *Sam Bostock*
 
-    Could cause `uninitialized constant ActiveJob::Arguments::BigDecimal (NameError)`
-    when loading Active Job in isolation.
+*   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.
 
-    *Jean Boussier*
+    Retains IS08601 format compatibility.
 
-## Rails 7.0.2.4 (April 26, 2022) ##
+    *Jeremy Daer*
 
-*   No changes.
+*   Add `--parent` option to job generator to specify parent class of job.
 
+    Example:
 
-## Rails 7.0.2.3 (March 08, 2022) ##
+    `bin/rails g job process_payment --parent=payment_job` generates:
 
-*   No changes.
+    ```ruby
+    class ProcessPaymentJob < PaymentJob
+      # ...
+    end
+    ```
 
+    *Gannon McGibbon*
 
-## Rails 7.0.2.2 (February 11, 2022) ##
+*   Add more detailed description to job generator.
 
-*   No changes.
+    *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.
 
-## Rails 7.0.2.1 (February 11, 2022) ##
+    *Jonathan Hefner*
 
-*   No changes.
+*   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.
 
-## Rails 7.0.2 (February 08, 2022) ##
+    *Damir Zekic* and *Adis Hasovic*
 
-*   No changes.
+*   Add missing `bigdecimal` require in `ActiveJob::Arguments`
 
+    Could cause `uninitialized constant ActiveJob::Arguments::BigDecimal (NameError)`
+    when loading Active Job in isolation.
 
-## Rails 7.0.1 (January 06, 2022) ##
+    *Jean Boussier*
 
 *   Allow testing `discard_on/retry_on ActiveJob::DeserializationError`
 
@@ -118,7 +196,7 @@
     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.
+    This behavior makes difficult testing the job `discard_on/retry_on` logic.
 
     Now `deserialize_arguments_if_needed` call is postponed to when `perform_now`
     is called.
@@ -143,104 +221,4 @@
 
     *Jacopo Beschi*
 
-
-## Rails 7.0.0 (December 15, 2021) ##
-
-*   No changes.
-
-
-## Rails 7.0.0.rc3 (December 14, 2021) ##
-
-*   No changes.
-
-
-## Rails 7.0.0.rc2 (December 14, 2021) ##
-
-*   No changes.
-
-## Rails 7.0.0.rc1 (December 06, 2021) ##
-
-*   Remove deprecated `:return_false_on_aborted_enqueue` option.
-
-    *Rafael Mendonça França*
-
-*   Deprecated `Rails.config.active_job.skip_after_callbacks_if_terminated`.
-
-    *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`.
-
-    *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é*
-
-
-Please check [6-1-stable](https://github.com/rails/rails/blob/6-1-stable/activejob/CHANGELOG.md) for previous changes.
+Please check [7-0-stable](https://github.com/rails/rails/blob/7-0-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

@@ -47,7 +47,7 @@ module ActiveJob
 
     private
       # :nodoc:
-      PERMITTED_TYPES = [ NilClass, String, Integer, Float, BigDecimal, TrueClass, FalseClass ]
+      PERMITTED_TYPES = [ NilClass, String, Integer, Float, TrueClass, FalseClass ]
       # :nodoc:
       GLOBALID_KEY = "_aj_globalid"
       # :nodoc:
@@ -70,28 +70,6 @@ module ActiveJob
       private_constant :PERMITTED_TYPES, :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
@@ -115,16 +93,27 @@ module ActiveJob
         when -> (arg) { arg.respond_to?(:permitted?) && arg.respond_to?(:to_h) }
           serialize_indifferent_hash(argument.to_h)
         else
+          if 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 you 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
+            return argument
+          end
+
           Serializers.serialize(argument)
         end
       end
 
       def deserialize_argument(argument)
         case argument
-        when String
-          argument
         when *PERMITTED_TYPES
           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/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:
@@ -28,9 +28,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

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,8 +12,10 @@ module ActiveJob
     attr_accessor :arguments
     attr_writer :serialized_arguments
 
-    # Timestamp when the job should be performed
-    attr_accessor :scheduled_at
+    # Time when the job should be performed
+    attr_reader :scheduled_at
+
+    attr_reader :_scheduled_at_time # :nodoc:
 
     # Job Identifier
     attr_accessor :job_id
@@ -92,6 +96,8 @@ module ActiveJob
       @arguments  = arguments
       @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 = {}
@@ -113,7 +119,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_time ? _scheduled_at_time.utc.iso8601(9) : nil,
       }
     end
 
@@ -153,19 +160,32 @@ 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]
 
       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?

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/enqueuing.rb

@@ -9,6 +9,36 @@ 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_time.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
 
@@ -62,7 +92,7 @@ module ActiveJob
 
       run_callbacks :enqueue do
         if scheduled_at
-          queue_adapter.enqueue_at self, scheduled_at
+          queue_adapter.enqueue_at self, _scheduled_at_time.to_f
         else
           queue_adapter.enqueue self
         end