activejob 6.0.6.1 → 6.1.7.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: adbbee2d0fe2c43330baf21875d3a39f5e58171124de1a8495728d3b5c281d9c
-  data.tar.gz: ebdd2fff8081906fe5caa78e3a671bc1e0b834ac0e1eb7389e87fd5c0dbead4c
+  metadata.gz: b28fe0654bb20d3c60ac03d80c9570ae206da676ddbc24172f255f7c85347689
+  data.tar.gz: 4a1a372d7cfc7393f4da5f971d60034b0531e00196903a29674ae9436a1d966b
 SHA512:
-  metadata.gz: de7357ed0fd2885973dfb4a88acb0efb650eab45cf204f6b5dec81c3b53eb34e162cb06d7ad295a72dec0ced6b0464a79ab622d66e42f3388e65671a6d91cc02
-  data.tar.gz: c5b62b04096aeea7ebff62756c253894de1fc89c2e7ce577f8b76df93860a901f3538f6a39213c3967e51fecb8c3fd727f4de1a28ab11df408d70c78afda6c83
+  metadata.gz: 314fea74bf234e8de9c8d9280f4a6ef50e00e5a1e868d88a249b81bded37ea8ddf13150b070138de403d025c0ae08366fa3576ac72aa53e5bd3c1aacc2a23cae
+  data.tar.gz: 47b48ba2e74b1a0c0836f9e5370f2302d3c33f030f9ce7546d93c5d5d3513cb73ca974a99f277cf2d2ea4c4573c79374d922f3ffda4828a2d5b567bedf352927

data/CHANGELOG.md

@@ -1,293 +1,261 @@
-## Rails 6.0.6.1 (January 17, 2023) ##
+## Rails 6.1.7.6 (August 22, 2023) ##
 
 *   No changes.
 
 
-## Rails 6.0.6 (September 09, 2022) ##
+## Rails 6.1.7.5 (August 22, 2023) ##
 
 *   No changes.
 
 
-## Rails 6.0.5.1 (July 12, 2022) ##
+## Rails 6.1.7.4 (June 26, 2023) ##
 
 *   No changes.
 
 
-## Rails 6.0.5 (May 09, 2022) ##
+## Rails 6.1.7.3 (March 13, 2023) ##
 
 *   No changes.
 
 
-## Rails 6.0.4.8 (April 26, 2022) ##
+## Rails 6.1.7.2 (January 24, 2023) ##
 
 *   No changes.
 
 
-## Rails 6.0.4.7 (March 08, 2022) ##
+## Rails 6.1.7.1 (January 17, 2023) ##
 
 *   No changes.
 
 
-## Rails 6.0.4.6 (February 11, 2022) ##
+## Rails 6.1.7 (September 09, 2022) ##
 
 *   No changes.
 
 
-## Rails 6.0.4.5 (February 11, 2022) ##
+## Rails 6.1.6.1 (July 12, 2022) ##
 
 *   No changes.
 
 
-## Rails 6.0.4.4 (December 15, 2021) ##
+## Rails 6.1.6 (May 09, 2022) ##
 
 *   No changes.
 
 
-## Rails 6.0.4.3 (December 14, 2021) ##
+## Rails 6.1.5.1 (April 26, 2022) ##
 
 *   No changes.
 
 
-## Rails 6.0.4.2 (December 14, 2021) ##
+## Rails 6.1.5 (March 09, 2022) ##
 
 *   No changes.
 
 
-## Rails 6.0.4.1 (August 19, 2021) ##
+## Rails 6.1.4.7 (March 08, 2022) ##
 
 *   No changes.
 
 
-## Rails 6.0.4 (June 15, 2021) ##
+## Rails 6.1.4.6 (February 11, 2022) ##
 
 *   No changes.
 
 
-## Rails 6.0.3.7 (May 05, 2021) ##
+## Rails 6.1.4.5 (February 11, 2022) ##
 
 *   No changes.
 
 
-## Rails 6.0.3.6 (March 26, 2021) ##
+## Rails 6.1.4.4 (December 15, 2021) ##
 
 *   No changes.
 
 
-## Rails 6.0.3.5 (February 10, 2021) ##
+## Rails 6.1.4.3 (December 14, 2021) ##
 
 *   No changes.
 
 
-## Rails 6.0.3.4 (October 07, 2020) ##
+## Rails 6.1.4.2 (December 14, 2021) ##
 
 *   No changes.
 
 
-## Rails 6.0.3.3 (September 09, 2020) ##
+## Rails 6.1.4.1 (August 19, 2021) ##
 
 *   No changes.
 
 
-## Rails 6.0.3.2 (June 17, 2020) ##
+## Rails 6.1.4 (June 24, 2021) ##
 
 *   No changes.
 
 
-## Rails 6.0.3.1 (May 18, 2020) ##
+## Rails 6.1.3.2 (May 05, 2021) ##
 
 *   No changes.
 
 
-## Rails 6.0.3 (May 06, 2020) ##
-
-*   While using `perform_enqueued_jobs` test helper enqueued jobs must be stored for the later check with
-    `assert_enqueued_with`.
-
-    *Dmitry Polushkin*
-
-*   Add queue name support to Que adapter
-
-    *Brad Nauta*, *Wojciech Wnętrzak*
-
-
-## Rails 6.0.2.2 (March 19, 2020) ##
+## Rails 6.1.3.1 (March 26, 2021) ##
 
 *   No changes.
 
 
-## Rails 6.0.2.1 (December 18, 2019) ##
+## Rails 6.1.3 (February 17, 2021) ##
 
 *   No changes.
 
 
-## Rails 6.0.2 (December 13, 2019) ##
-
-*   Allow Sidekiq access to the underlying job class.
-
-    By having access to the Active Job class, Sidekiq can get access to any `sidekiq_options` which
-    have been set on that Active Job type and serialize those options into Redis.
-
-    https://github.com/mperham/sidekiq/blob/master/Changes.md#60
-
-    *Mike Perham*
-
-
-## Rails 6.0.1 (November 5, 2019) ##
+## Rails 6.1.2.1 (February 10, 2021) ##
 
 *   No changes.
 
 
-## Rails 6.0.0 (August 16, 2019) ##
-
-*   `assert_enqueued_with` and `assert_performed_with` can now test jobs with relative delay.
-
-    *Vlado Cingel*
-
-
-## Rails 6.0.0.rc2 (July 22, 2019) ##
+## Rails 6.1.2 (February 09, 2021) ##
 
 *   No changes.
 
 
-## Rails 6.0.0.rc1 (April 24, 2019) ##
+## Rails 6.1.1 (January 07, 2021) ##
 
-*   Use individual execution counters when calculating retry delay.
+*   Make `retry_job` return the job that was created.
 
-    *Patrik Bóna*
+    *Rafael Mendonça França*
 
-*   Make job argument assertions with `Time`, `ActiveSupport::TimeWithZone`, and `DateTime` work by dropping microseconds. Microsecond precision is lost during serialization.
+*   Include `ActiveSupport::Testing::Assertions` in `ActiveJob::TestHelpers`.
 
-    *Gannon McGibbon*
+    *Mikkel Malmberg*
 
 
-## Rails 6.0.0.beta3 (March 11, 2019) ##
-
-*   No changes.
+## Rails 6.1.0 (December 09, 2020) ##
 
+*   Recover nano precision when serializing `Time`, `TimeWithZone` and `DateTime` objects.
 
-## Rails 6.0.0.beta2 (February 25, 2019) ##
+    *Alan Tan*
 
-*   No changes.
+*   Deprecate `config.active_job.return_false_on_aborted_enqueue`.
 
+    *Rafael Mendonça França*
 
-## Rails 6.0.0.beta1 (January 18, 2019) ##
+*   Return `false` when enqueuing a job is aborted.
 
-*   Return false instead of the job instance when `enqueue` is aborted.
+    *Rafael Mendonça França*
 
-    This will be the behavior in Rails 6.1 but it can be controlled now with
-    `config.active_job.return_false_on_aborted_enqueue`.
-
-    *Kir Shatrov*
-
-*   Keep executions for each specific declaration
-
-    Each `retry_on` declaration has now its own specific executions counter. Before it was
-    shared between all executions of a job.
+*   While using `perform_enqueued_jobs` test helper enqueued jobs must be stored for the later check with
+    `assert_enqueued_with`.
 
-    *Alberto Almagro*
+    *Dmitry Polushkin*
 
-*   Allow all assertion helpers that have a `only` and `except` keyword to accept
-    Procs.
+*   `ActiveJob::TestCase#perform_enqueued_jobs` without a block removes performed jobs from the queue.
 
-    *Edouard Chin*
+    That way the helper can be called multiple times and not perform a job invocation multiple times.
 
-*   Restore `HashWithIndifferentAccess` support to `ActiveJob::Arguments.deserialize`.
+    ```ruby
+    def test_jobs
+      HelloJob.perform_later("rafael")
+      perform_enqueued_jobs # only runs with "rafael"
+      HelloJob.perform_later("david")
+      perform_enqueued_jobs # only runs with "david"
+    end
+    ```
 
-    *Gannon McGibbon*
+    *Étienne Barrié*
 
-*   Include deserialized arguments in job instances returned from
-    `assert_enqueued_with` and `assert_performed_with`
+*   `ActiveJob::TestCase#perform_enqueued_jobs` will no longer perform retries:
 
-    *Alan Wu*
+    When calling `perform_enqueued_jobs` without a block, the adapter will
+    now perform jobs that are **already** in the queue. Jobs that will end up in
+    the queue afterwards won't be performed.
 
-*   Allow `assert_enqueued_with`/`assert_performed_with` methods to accept
-    a proc for the `args` argument. This is useful to check if only a subset of arguments
-    matches your expectations.
+    This change only affects `perform_enqueued_jobs` when no block is given.
 
     *Edouard Chin*
 
-*   `ActionDispatch::IntegrationTest` includes `ActiveJob::TestHelper` module by default.
-
-    *Ricardo Díaz*
-
-*   Added `enqueue_retry.active_job`, `retry_stopped.active_job`, and `discard.active_job` hooks.
-
-    *steves*
+*   Add queue name support to Que adapter.
 
-*   Allow `assert_performed_with` to be called without a block.
+    *Brad Nauta*, *Wojciech Wnętrzak*
 
-    *bogdanvlviv*
+*   Don't run `after_enqueue` and `after_perform` callbacks if the callback chain is halted.
 
-*   Execution of `assert_performed_jobs`, and `assert_no_performed_jobs`
-    without a block should respect passed `:except`, `:only`, and `:queue` options.
+        class MyJob < ApplicationJob
+          before_enqueue { throw(:abort) }
+          after_enqueue { # won't enter here anymore }
+        end
 
-    *bogdanvlviv*
+    `after_enqueue` and `after_perform` callbacks will no longer run if the callback chain is halted.
+    This behaviour is a breaking change and won't take effect until Rails 7.0.
+    To enable this behaviour in your app right now, you can add in your app's configuration file
+    `config.active_job.skip_after_callbacks_if_terminated = true`.
 
-*   Allow `:queue` option to job assertions and helpers.
+    *Edouard Chin*
 
-    *bogdanvlviv*
+*   Fix enqueuing and performing incorrect logging message.
 
-*   Allow `perform_enqueued_jobs` to be called without a block.
+    Jobs will no longer always log "Enqueued MyJob" or "Performed MyJob" when they actually didn't get enqueued/performed.
 
-    Performs all of the jobs that have been enqueued up to this point in the test.
+    ```ruby
+      class MyJob < ApplicationJob
+        before_enqueue { throw(:abort) }
+      end
 
-    *Kevin Deisz*
+      MyJob.perform_later # Will no longer log "Enqueued MyJob" since job wasn't even enqueued through adapter.
+    ```
 
-*   Move `enqueue`/`enqueue_at` notifications to an around callback.
+    A new message will be logged in case a job couldn't be enqueued, either because the callback chain was halted or
+    because an exception happened during enqueuing. (i.e. Redis is down when you try to enqueue your job)
 
-    Improves timing accuracy over the old after callback by including
-    time spent writing to the adapter's IO implementation.
+    *Edouard Chin*
 
-    *Zach Kemp*
+*   Add an option to disable logging of the job arguments when enqueuing and executing the job.
 
-*   Allow call `assert_enqueued_with` with no block.
+        class SensitiveJob < ApplicationJob
+          self.log_arguments = false
 
-    Example:
-    ```
-    def test_assert_enqueued_with
-      MyJob.perform_later(1,2,3)
-      assert_enqueued_with(job: MyJob, args: [1,2,3], queue: 'low')
+          def perform(my_sensitive_argument)
+          end
+        end
 
-      MyJob.set(wait_until: Date.tomorrow.noon).perform_later
-      assert_enqueued_with(job: MyJob, at: Date.tomorrow.noon)
-    end
-    ```
+    When dealing with sensitive arguments as password and tokens it is now possible to configure the job
+    to not put the sensitive argument in the logs.
 
-    *bogdanvlviv*
+    *Rafael Mendonça França*
 
-*   Allow passing multiple exceptions to `retry_on`, and `discard_on`.
+*   Changes in `queue_name_prefix` of a job no longer affects all other jobs.
 
-    *George Claghorn*
+    Fixes #37084.
 
-*   Pass the error instance as the second parameter of block executed by `discard_on`.
+    *Lucas Mansur*
 
-    Fixes #32853.
+*   Allow `Class` and `Module` instances to be serialized.
 
-    *Yuji Yaginuma*
+    *Kevin Deisz*
 
-*   Remove support for Qu gem.
+*   Log potential matches in `assert_enqueued_with` and `assert_performed_with`.
 
-    Reasons are that the Qu gem wasn't compatible since Rails 5.1,
-    gem development was stopped in 2014 and maintainers have
-    confirmed its demise. See issue #32273
+    *Gareth du Plooy*
 
-    *Alberto Almagro*
+*   Add `at` argument to the `perform_enqueued_jobs` test helper.
 
-*   Add support for timezones to Active Job.
+    *John Crepezzi*, *Eileen Uchitelle*
 
-    Record what was the current timezone in effect when the job was
-    enqueued and then restore when the job is executed in same way
-    that the current locale is recorded and restored.
+*   `assert_enqueued_with` and `assert_performed_with` can now test jobs with relative delay.
 
-    *Andrew White*
+    *Vlado Cingel*
 
-*   Rails 6 requires Ruby 2.5.0 or newer.
+*   Add jitter to `ActiveJob::Exceptions.retry_on`.
 
-    *Jeremy Daer*, *Kasper Timm Hansen*
+    `ActiveJob::Exceptions.retry_on` now uses a random amount of jitter in order to
+    prevent the [thundering herd effect](https://en.wikipedia.org/wiki/Thundering_herd_problem). Defaults to
+    15% (represented as 0.15) but overridable via the `:jitter` option when using `retry_on`.
+    Jitter is applied when an `Integer`, `ActiveSupport::Duration` or `:exponentially_longer`, is passed to the `wait` argument in `retry_on`.
 
-*   Add support to define custom argument serializers.
+    ```ruby
+    retry_on(MyError, wait: :exponentially_longer, jitter: 0.30)
+    ```
 
-    *Evgenii Pecherkin*, *Rafael Mendonça França*
+    *Anthony Ross*
 
 
-Please check [5-2-stable](https://github.com/rails/rails/blob/5-2-stable/activejob/CHANGELOG.md) for previous changes.
+Please check [6-0-stable](https://github.com/rails/rails/blob/6-0-stable/activejob/CHANGELOG.md) for previous changes.

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2014-2019 David Heinemeier Hansson
+Copyright (c) 2014-2022 David Heinemeier Hansson
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -18,4 +18,3 @@ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-

data/README.md

@@ -95,9 +95,6 @@ their gem, or as a stand-alone gem. For discussion about this see the
 following PRs: [23311](https://github.com/rails/rails/issues/23311#issuecomment-176275718),
 [21406](https://github.com/rails/rails/pull/21406#issuecomment-138813484), and [#32285](https://github.com/rails/rails/pull/32285).
 
-## Auxiliary gems
-
-* [activejob-stats](https://github.com/seuros/activejob-stats)
 
 ## Download and installation
 
@@ -111,6 +108,7 @@ Source code can be downloaded as part of the Rails project on GitHub:
 
 * https://github.com/rails/rails/tree/main/activejob
 
+
 ## License
 
 Active Job is released under the MIT license:

data/lib/active_job/base.rb

@@ -8,7 +8,9 @@ require "active_job/enqueuing"
 require "active_job/execution"
 require "active_job/callbacks"
 require "active_job/exceptions"
+require "active_job/log_subscriber"
 require "active_job/logging"
+require "active_job/instrumentation"
 require "active_job/timezones"
 require "active_job/translation"
 
@@ -68,6 +70,7 @@ module ActiveJob #:nodoc:
     include Callbacks
     include Exceptions
     include Logging
+    include Instrumentation
     include Timezones
     include Translation
 

data/lib/active_job/callbacks.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require "active_support/callbacks"
+require "active_support/core_ext/object/with_options"
+require "active_support/core_ext/module/attribute_accessors"
 
 module ActiveJob
   # = Active Job Callbacks
@@ -27,16 +29,25 @@ module ActiveJob
     end
 
     included do
-      define_callbacks :perform
-      define_callbacks :enqueue
+      class_attribute :return_false_on_aborted_enqueue, instance_accessor: false, instance_predicate: false, default: false
+      singleton_class.deprecate :return_false_on_aborted_enqueue, :return_false_on_aborted_enqueue=
+      cattr_accessor :skip_after_callbacks_if_terminated, instance_accessor: false, default: false
 
-      class_attribute :return_false_on_aborted_enqueue, instance_accessor: false, instance_predicate: false
-      self.return_false_on_aborted_enqueue = false
+      with_options(skip_after_callbacks_if_terminated: skip_after_callbacks_if_terminated) do
+        define_callbacks :perform
+        define_callbacks :enqueue
+      end
     end
 
     # These methods will be included into any Active Job object, adding
     # callbacks for +perform+ and +enqueue+ methods.
     module ClassMethods
+      def inherited(klass)
+        klass.get_callbacks(:enqueue).config[:skip_after_callbacks_if_terminated] = skip_after_callbacks_if_terminated
+        klass.get_callbacks(:perform).config[:skip_after_callbacks_if_terminated] = skip_after_callbacks_if_terminated
+        super
+      end
+
       # Defines a callback that will get called right before the
       # job's perform method is executed.
       #
@@ -91,6 +102,19 @@ module ActiveJob
       #     end
       #   end
       #
+      # You can access the return value of the job only if the execution wasn't halted.
+      #
+      #   class VideoProcessJob < ActiveJob::Base
+      #     around_perform do |job, block|
+      #       value = block.call
+      #       puts value # => "Hello World!"
+      #     end
+      #
+      #     def perform
+      #       "Hello World!"
+      #     end
+      #   end
+      #
       def around_perform(*filters, &blk)
         set_callback(:perform, :around, *filters, &blk)
       end
@@ -154,5 +178,21 @@ module ActiveJob
         set_callback(:enqueue, :around, *filters, &blk)
       end
     end
+
+    private
+      def halted_callback_hook(_filter, name) # :nodoc:
+        return super unless %i(enqueue perform).include?(name.to_sym)
+        callbacks = public_send("_#{name}_callbacks")
+
+        if !self.class.skip_after_callbacks_if_terminated && callbacks.any? { |c| c.kind == :after }
+          ActiveSupport::Deprecation.warn(<<~EOM)
+            In Rails 7.0, `after_enqueue`/`after_perform` callbacks no longer run if `before_enqueue`/`before_perform` respectively halts with `throw :abort`.
+            To enable this behavior, uncomment the `config.active_job.skip_after_callbacks_if_terminated` config
+            in the new 6.1 framework defaults initializer.
+          EOM
+        end
+
+        super
+      end
   end
 end

data/lib/active_job/core.rb

@@ -85,7 +85,7 @@ module ActiveJob
       @priority   = self.class.priority
       @executions = 0
       @exception_executions = {}
-      @timezone   = Time.zone.try(:name)
+      @timezone   = Time.zone&.name
     end
     ruby2_keywords(:initialize) if respond_to?(:ruby2_keywords, true)
 
@@ -142,7 +142,7 @@ module ActiveJob
       self.executions           = job_data["executions"]
       self.exception_executions = job_data["exception_executions"]
       self.locale               = job_data["locale"] || I18n.locale.to_s
-      self.timezone             = job_data["timezone"] || Time.zone.try(:name)
+      self.timezone             = job_data["timezone"] || Time.zone&.name
       self.enqueued_at          = job_data["enqueued_at"]
     end
 

data/lib/active_job/enqueuing.rb

@@ -54,9 +54,9 @@ module ActiveJob
 
       run_callbacks :enqueue do
         if scheduled_at
-          self.class.queue_adapter.enqueue_at self, scheduled_at
+          queue_adapter.enqueue_at self, scheduled_at
         else
-          self.class.queue_adapter.enqueue self
+          queue_adapter.enqueue self
         end
 
         successfully_enqueued = true
@@ -65,17 +65,7 @@ module ActiveJob
       if successfully_enqueued
         self
       else
-        if self.class.return_false_on_aborted_enqueue
-          false
-        else
-          ActiveSupport::Deprecation.warn(
-            "Rails 6.1 will return false when the enqueuing is aborted. Make sure your code doesn't depend on it" \
-            " returning the instance of the job and set `config.active_job.return_false_on_aborted_enqueue = true`" \
-            " to remove the deprecations."
-          )
-
-          self
-        end
+        false
       end
     end
   end