activejob 6.0.3.1 → 6.1.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c6163a34634ae189a8ec46a32cd8e2f292e3c565d945aca0b461afee089ec68
-  data.tar.gz: a34908b6ccff83ed35b5c83274105713011b9d22f68d22a9b08648a3e61a27f9
+  metadata.gz: 440134b603c43896fefc8ab03b787679e37e8862f896a7ac55e45949b765f0a4
+  data.tar.gz: c98cec1ff12d0b6e56200bd99e25480eaf171aea2e0f252e68b5cd442f6782cb
 SHA512:
-  metadata.gz: 25112718e0d255f3ba2cbe779925a083dffed238c7d5ceb2d823b9664364ca807e394a1856212afca0f7801117300b76b53b87e85fe66d0a43b64d6d4da2d240
-  data.tar.gz: 1d44968c18701431c825b54d830290c5bf0c119e50381e0a9e02f0f983cc7322a01c563944158aa66868d2f9dcc821c65767a7ff42d303f9a628fc3817127405
+  metadata.gz: 173c876fb4b08fdcb3ef3acb7e32e9d8b793044f80d0cd8490204772a2e730a58e7cf12b3b3392b0a808c79811bc2e984c114eacb86ee689ce8914b067249289
+  data.tar.gz: 219b5cf6e8acf7ecb429553ce27e157f6ff4efc8aee38cf605119b7cb997a84cfd333015400707220423e41950ce698adf8769ace6da5649cc64ce04a07247a8

data/CHANGELOG.md

@@ -1,198 +1,135 @@
-## Rails 6.0.3.1 (May 18, 2020) ##
+## Rails 6.1.0.rc2 (December 01, 2020) ##
 
 *   No changes.
 
 
-## Rails 6.0.3 (May 06, 2020) ##
+## Rails 6.1.0.rc1 (November 02, 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) ##
-
-*   No changes.
-
-
-## Rails 6.0.2.1 (December 18, 2019) ##
-
-*   No changes.
-
-
-## Rails 6.0.2 (December 13, 2019) ##
+*   Recover nano precision when serializing `Time`, `TimeWithZone` and `DateTime` objects.
 
-*   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) ##
-
-*   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) ##
-
-*   No changes.
+    *Alan Tan*
 
+*   Deprecate `config.active_job.return_false_on_aborted_enqueue`.
 
-## Rails 6.0.0.rc1 (April 24, 2019) ##
+    *Rafael Mendonça França*
 
-*   Use individual execution counters when calculating retry delay.
+*   Return `false` when enqueuing a job is aborted.
 
-    *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.
-
-    *Gannon McGibbon*
+*   While using `perform_enqueued_jobs` test helper enqueued jobs must be stored for the later check with
+    `assert_enqueued_with`.
 
+    *Dmitry Polushkin*
 
-## Rails 6.0.0.beta3 (March 11, 2019) ##
+*   `ActiveJob::TestCase#perform_enqueued_jobs` without a block removes performed jobs from the queue.
 
-*   No changes.
+    That way the helper can be called multiple times and not perform a job invocation multiple times.
 
+    ```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
+    ```
 
-## Rails 6.0.0.beta2 (February 25, 2019) ##
-
-*   No changes.
+    *Étienne Barrié*
 
+*   `ActiveJob::TestCase#perform_enqueued_jobs` will no longer perform retries:
 
-## Rails 6.0.0.beta1 (January 18, 2019) ##
+    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.
 
-*   Return false instead of the job instance when `enqueue` is aborted.
+    This change only affects `perform_enqueued_jobs` when no block is given.
 
-    This will be the behavior in Rails 6.1 but it can be controlled now with
-    `config.active_job.return_false_on_aborted_enqueue`.
+    *Edouard Chin*
 
-    *Kir Shatrov*
+*   Add queue name support to Que adapter.
 
-*   Keep executions for each specific declaration
+    *Brad Nauta*, *Wojciech Wnętrzak*
 
-    Each `retry_on` declaration has now its own specific executions counter. Before it was
-    shared between all executions of a job.
+*   Don't run `after_enqueue` and `after_perform` callbacks if the callback chain is halted.
 
-    *Alberto Almagro*
+        class MyJob < ApplicationJob
+          before_enqueue { throw(:abort) }
+          after_enqueue { # won't enter here anymore }
+        end
 
-*   Allow all assertion helpers that have a `only` and `except` keyword to accept
-    Procs.
+    `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 6.2.
+    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`.
 
     *Edouard Chin*
 
-*   Restore `HashWithIndifferentAccess` support to `ActiveJob::Arguments.deserialize`.
+*   Fix enqueuing and performing incorrect logging message.
 
-    *Gannon McGibbon*
+    Jobs will no longer always log "Enqueued MyJob" or "Performed MyJob" when they actually didn't get enqueued/performed.
 
-*   Include deserialized arguments in job instances returned from
-    `assert_enqueued_with` and `assert_performed_with`
+    ```ruby
+      class MyJob < ApplicationJob
+        before_enqueue { throw(:abort) }
+      end
 
-    *Alan Wu*
+      MyJob.perform_later # Will no longer log "Enqueued MyJob" since job wasn't even enqueued through adapter.
+    ```
 
-*   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.
+    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)
 
     *Edouard Chin*
 
-*   `ActionDispatch::IntegrationTest` includes `ActiveJob::TestHelper` module by default.
-
-    *Ricardo Díaz*
+*   Add an option to disable logging of the job arguments when enqueuing and executing the job.
 
-*   Added `enqueue_retry.active_job`, `retry_stopped.active_job`, and `discard.active_job` hooks.
+        class SensitiveJob < ApplicationJob
+          self.log_arguments = false
 
-    *steves*
+          def perform(my_sensitive_argument)
+          end
+        end
 
-*   Allow `assert_performed_with` to be called without a block.
+    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*
 
-*   Execution of `assert_performed_jobs`, and `assert_no_performed_jobs`
-    without a block should respect passed `:except`, `:only`, and `:queue` options.
+*   Changes in `queue_name_prefix` of a job no longer affects all other jobs.
 
-    *bogdanvlviv*
+    Fixes #37084.
 
-*   Allow `:queue` option to job assertions and helpers.
+    *Lucas Mansur*
 
-    *bogdanvlviv*
-
-*   Allow `perform_enqueued_jobs` to be called without a block.
-
-    Performs all of the jobs that have been enqueued up to this point in the test.
+*   Allow `Class` and `Module` instances to be serialized.
 
     *Kevin Deisz*
 
-*   Move `enqueue`/`enqueue_at` notifications to an around callback.
+*   Log potential matches in `assert_enqueued_with` and `assert_performed_with`.
 
-    Improves timing accuracy over the old after callback by including
-    time spent writing to the adapter's IO implementation.
+    *Gareth du Plooy*
 
-    *Zach Kemp*
+*   Add `at` argument to the `perform_enqueued_jobs` test helper.
 
-*   Allow call `assert_enqueued_with` with no block.
-
-    Example:
-    ```
-    def test_assert_enqueued_with
-      MyJob.perform_later(1,2,3)
-      assert_enqueued_with(job: MyJob, args: [1,2,3], queue: 'low')
+    *John Crepezzi*, *Eileen Uchitelle*
 
-      MyJob.set(wait_until: Date.tomorrow.noon).perform_later
-      assert_enqueued_with(job: MyJob, at: Date.tomorrow.noon)
-    end
-    ```
-
-    *bogdanvlviv*
-
-*   Allow passing multiple exceptions to `retry_on`, and `discard_on`.
-
-    *George Claghorn*
-
-*   Pass the error instance as the second parameter of block executed by `discard_on`.
-
-    Fixes #32853.
-
-    *Yuji Yaginuma*
-
-*   Remove support for Qu gem.
-
-    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
-
-    *Alberto Almagro*
-
-*   Add support for timezones to Active Job.
-
-    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-2020 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

@@ -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/master/activejob
 
+
 ## License
 
 Active Job is released under the MIT license:

data/lib/active_job.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #--
-# Copyright (c) 2014-2019 David Heinemeier Hansson
+# Copyright (c) 2014-2020 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/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 6.2, `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,6 +85,7 @@ module ActiveJob
       @priority   = self.class.priority
       @executions = 0
       @exception_executions = {}
+      @timezone   = Time.zone&.name
     end
     ruby2_keywords(:initialize) if respond_to?(:ruby2_keywords, true)
 
@@ -101,7 +102,7 @@ module ActiveJob
         "executions" => executions,
         "exception_executions" => exception_executions,
         "locale"     => I18n.locale.to_s,
-        "timezone"   => Time.zone.try(:name),
+        "timezone"   => timezone,
         "enqueued_at" => Time.now.utc.iso8601
       }
     end
@@ -141,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