activejob 7.0.8.4 → 7.1.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4031fa01a9c6c297d846de18e8c57bf01f740753b5a37ae250f23e75a6a364d5
-  data.tar.gz: 5e99adb28b7e899c55738d4beadd1ad2211ba7c848ca6a82f993b089b3252fb8
+  metadata.gz: c13b1ea6ba1e35ea17b2a2051b76b2d12912e746120f5c85170839cb43432e1f
+  data.tar.gz: fd72f8bf538fe535a8cc8faa22671392789459265618228cbeda8cee73cc0cf5
 SHA512:
-  metadata.gz: bf3fc41a3b73721554718834f99cf70650b4d4b304531c7aecf2caa9d8ab1c6673f5ce6b6f50633204bb280db9f9be766ba3217b168926b9cda58ecc9b99dfef
-  data.tar.gz: 0003ced37b9c53eef27f52eb2887c405a41ec6a15b0c6353db99f725ef95dc5c55cd821123abb9496c87e015f1b8b0c9a3cf0c76844513cc34b2dd85ab322c31
+  metadata.gz: 0bc47ff3a65ba512ce75d6f33c9bcf59319eb3e749753f961cf4073b8785d48816f7a28d373675f4d710886b5e967474ff9f543f6ec0e697418397990f09ac92
+  data.tar.gz: e69b622ce5699395aab14669d9afb5116743d6186530031c30a907c52ad8a622e08c256458d417af5fbeeb5a61e6a4c6a9fd4731ba38cb836e1b159004de75ea

data/CHANGELOG.md

@@ -1,266 +1,283 @@
-## Rails 7.0.8.4 (June 04, 2024) ##
+## Rails 7.1.3.4 (June 04, 2024) ##
 
 *   No changes.
 
 
-## Rails 7.0.8.3 (May 17, 2024) ##
+## Rails 7.1.3.3 (May 16, 2024) ##
 
 *   No changes.
 
 
-## Rails 7.0.8.2 (May 16, 2024) ##
+## Rails 7.1.3.2 (February 21, 2024) ##
 
 *   No changes.
 
 
-## Rails 7.0.8.1 (February 21, 2024) ##
+## Rails 7.1.3.1 (February 21, 2024) ##
 
 *   No changes.
 
 
-## Rails 7.0.8 (September 09, 2023) ##
+## Rails 7.1.3 (January 16, 2024) ##
 
-*   Fix Active Job log message to correctly report a job failed to enqueue
-    when the adapter raises an `ActiveJob::EnqueueError`.
-
-    *Ben Sheldon*
+*   Do not trigger immediate loading of `ActiveJob::Base` when loading `ActiveJob::TestHelper`.
 
+    *Maxime Réty*
 
-## Rails 7.0.7.2 (August 22, 2023) ##
-
-*   No changes.
+*   Preserve the serialized timezone when deserializing `ActiveSupport::TimeWithZone` arguments.
 
+    *Joshua Young*
 
-## Rails 7.0.7.1 (August 22, 2023) ##
+*   Fix ActiveJob arguments serialization to correctly serialize String subclasses having custom serializers.
 
-*   No changes.
+    *fatkodima*
 
 
-## Rails 7.0.7 (August 09, 2023) ##
+## Rails 7.1.2 (November 10, 2023) ##
 
 *   No changes.
 
 
-## Rails 7.0.6 (June 29, 2023) ##
+## Rails 7.1.1 (October 11, 2023) ##
 
-*   Fix error Active Job passed class with `permitted?`.
+*   Don't log enqueuing details when the job wasn't enqueued.
 
-    *Alex Baldwin*
+    *Dustin Brown*
 
 
-## Rails 7.0.5.1 (June 26, 2023) ##
+## Rails 7.1.0 (October 05, 2023) ##
 
 *   No changes.
 
 
-## Rails 7.0.5 (May 24, 2023) ##
-
-*   Make delayed job `display_name` failsafe.
+## Rails 7.1.0.rc2 (October 01, 2023) ##
 
-    *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.
-
-    *Alex Ghiculescu*
-
-
-## Rails 7.0.4.3 (March 13, 2023) ##
-
-*   No changes.
+*   Make sure `scheduled_at` is a Time object when asserting enqueued jobs.
 
+    *Rafael Mendonça França*
 
-## Rails 7.0.4.2 (January 24, 2023) ##
 
-*   No changes.
+## 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.
 
-## Rails 7.0.4.1 (January 17, 2023) ##
+    Deserializes `enqueued_at` as a Time instead of ISO8601 String.
 
-*   No changes.
+    *Ben Sheldon*
 
+*   Clarify the backoff strategy for the recommended `:wait` option when retrying jobs
 
-## Rails 7.0.4 (September 09, 2022) ##
+    `wait: :exponentially_longer` is waiting polynomially longer, so it is now recommended to use `wait: :polynomially_longer` to keep the same behavior.
 
-*   Update `ActiveJob::QueueAdapters::QueAdapter` to remove deprecation warning.
+    *Victor Mours*
 
-    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.1.0.beta1 (September 13, 2023) ##
 
-## Rails 7.0.3.1 (July 12, 2022) ##
+*   Fix Active Job log message to correctly report a job failed to enqueue
+    when the adapter raises an `ActiveJob::EnqueueError`.
 
-*   No changes.
+    *Ben Sheldon*
 
+*   Add `after_discard` method.
 
-## Rails 7.0.3 (May 09, 2022) ##
+    This method lets job authors define a block which will be run when a job is about to be discarded. For example:
 
-*   Add missing `bigdecimal` require in `ActiveJob::Arguments`
+    ```ruby
+    class AfterDiscardJob < ActiveJob::Base
+      after_discard do |job, exception|
+        Rails.logger.info("#{job.class} raised an exception: #{exception}")
+      end
 
-    Could cause `uninitialized constant ActiveJob::Arguments::BigDecimal (NameError)`
-    when loading Active Job in isolation.
+      def perform
+        raise StandardError
+      end
+    end
+    ```
 
-    *Jean Boussier*
+    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.
 
-## Rails 7.0.2.4 (April 26, 2022) ##
+    *Rob Cardy*
 
-*   No changes.
+*   Fix deserialization of ActiveSupport::Duration
 
+    Previously, a deserialized Duration would return an array from Duration#parts.
+    It will now return a hash just like a regular Duration.
 
-## Rails 7.0.2.3 (March 08, 2022) ##
+    This also fixes an error when trying to add or subtract from a deserialized Duration
+    (eg `duration + 1.year`).
 
-*   No changes.
+    *Jonathan del Strother*
 
+*   `perform_enqueued_jobs` is now compatible with all Active Job adapters
 
-## Rails 7.0.2.2 (February 11, 2022) ##
+    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.
 
-*   No changes.
+    *Alex Ghiculescu*
 
+*   Allow queue adapters to provide a custom name by implementing `queue_adapter_name`
 
-## Rails 7.0.2.1 (February 11, 2022) ##
+    *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.2 (February 08, 2022) ##
+    Example log line:
 
-*   No changes.
+    ```
+    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.
 
-## Rails 7.0.1 (January 06, 2022) ##
+    *fatkodima*
 
-*   Allow testing `discard_on/retry_on ActiveJob::DeserializationError`
+*   Set `provider_job_id` for Backburner jobs
 
-    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.
+    *Cameron Matheson*
 
-    Now `deserialize_arguments_if_needed` call is postponed to when `perform_now`
-    is called.
+*   Add `perform_all_later` to enqueue multiple jobs at once
 
-    Example:
+    This adds the ability to bulk enqueue jobs, without running callbacks, by
+    passing multiple jobs or an array of jobs. For example:
 
     ```ruby
-    class UpdateUserJob < ActiveJob::Base
-      discard_on ActiveJob::DeserializationError
+    ActiveJob.perform_all_later(MyJob.new("hello", 42), MyJob.new("world", 0))
 
-      def perform(user)
-        # ...
-      end
-    end
-
-    # In the test
-    User.destroy_all
-    assert_nothing_raised do
-      perform_enqueued_jobs only: UpdateUserJob
-    end
+    user_jobs = User.pluck(:id).map { |id| UserJob.new(user_id: id) }
+    ActiveJob.perform_all_later(user_jobs)
     ```
 
-    *Jacopo Beschi*
+    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.0 (December 15, 2021) ##
-
-*   No changes.
+    *Sander Verdonschot*
 
+*   Don't double log the `job` when using `ActiveRecord::QueryLog`
 
-## Rails 7.0.0.rc3 (December 14, 2021) ##
+    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.
 
-*   No changes.
+    *Alex Ghiculescu*
 
+*   Add support for Sidekiq's transaction-aware client
 
-## Rails 7.0.0.rc2 (December 14, 2021) ##
+    *Jonathan del Strother*
 
-*   No changes.
+*   Remove QueAdapter from Active Job.
 
-## Rails 7.0.0.rc1 (December 06, 2021) ##
+    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 deprecated `:return_false_on_aborted_enqueue` option.
+    Active Job Que adapter can be included in the future version of que gem itself.
 
-    *Rafael Mendonça França*
+    *Yasuo Honda*
 
-*   Deprecated `Rails.config.active_job.skip_after_callbacks_if_terminated`.
+*   Fix BigDecimal (de)serialization for adapters using JSON.
 
-    *Rafael Mendonça França*
+    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).
 
-*   Removed deprecated behavior that was not halting `after_enqueue`/`after_perform` callbacks when a
-    previous callback was halted with `throw :abort`.
+    By using a serializer, we ensure the round trip is safe.
 
-    *Rafael Mendonça França*
+    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..
 
-*   Raise an `SerializationError` in `Serializer::ModuleSerializer`
-    if the module name is not present.
+    *Sam Bostock*
 
-    *Veerpal Brar*
+*   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.
 
-## Rails 7.0.0.alpha2 (September 15, 2021) ##
+    *Jeremy Daer*
 
-*   No changes.
+*   Add `--parent` option to job generator to specify parent class of job.
 
+    Example:
 
-## Rails 7.0.0.alpha1 (September 15, 2021) ##
+    `bin/rails g job process_payment --parent=payment_job` generates:
 
-*   Allow a job to retry indefinitely
+    ```ruby
+    class ProcessPaymentJob < PaymentJob
+      # ...
+    end
+    ```
 
-    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.
+    *Gannon McGibbon*
 
-        class MyJob < ActiveJob::Base
-          retry_on(AlwaysRetryException, attempts: :unlimited)
+*   Add more detailed description to job generator.
 
-          # the actual job code
-        end
+    *Gannon McGibbon*
 
-    *Daniel Morton*
+*   `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.
 
-*   Added possibility to check on `:priority` in test helper methods
-    `assert_enqueued_with` and `assert_performed_with`.
+    *Jonathan Hefner*
 
-    *Wojciech Wnętrzak*
+*   Update `ActiveJob::QueueAdapters::QueAdapter` to remove deprecation warning.
 
-*   OpenSSL constants are now used for Digest computations.
+    Remove a deprecation warning introduced in que 1.2 to prepare for changes in
+    que 2.0 necessary for Ruby 3 compatibility.
 
-    *Dirkjan Bussink*
+    *Damir Zekic* and *Adis Hasovic*
 
-*   Add a Serializer for the Range class.
+*   Add missing `bigdecimal` require in `ActiveJob::Arguments`
 
-    This should allow things like `MyJob.perform_later(range: 1..100)`.
+    Could cause `uninitialized constant ActiveJob::Arguments::BigDecimal (NameError)`
+    when loading Active Job in isolation.
 
-*   Communicate enqueue failures to callers of `perform_later`.
+    *Jean Boussier*
 
-    `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.
+*   Allow testing `discard_on/retry_on ActiveJob::DeserializationError`
 
-        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
+    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.
 
-    *Daniel Morton*
+    Now `deserialize_arguments_if_needed` call is postponed to when `perform_now`
+    is called.
 
-*   Don't log rescuable exceptions defined with `rescue_from`.
+    Example:
 
-    *Hu Hailin*
+    ```ruby
+    class UpdateUserJob < ActiveJob::Base
+      discard_on ActiveJob::DeserializationError
 
-*   Allow `rescue_from` to rescue all exceptions.
+      def perform(user)
+        # ...
+      end
+    end
 
-    *Adrianna Chang*, *Étienne Barrié*
+    # In the test
+    User.destroy_all
+    assert_nothing_raised do
+      perform_enqueued_jobs only: UpdateUserJob
+    end
+    ```
 
+    *Jacopo Beschi*
 
-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

@@ -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,29 @@ 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)
+          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
         end
       end
 
       def deserialize_argument(argument)
         case argument
-        when String
+        when nil, true, false, String, Integer, Float
           argument
-        when *PERMITTED_TYPES
+        when BigDecimal # BigDecimal may have been legacy serialized; Remove in 7.2
           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:
@@ -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
@@ -135,7 +132,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