activejob 5.2.8.1 → 6.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da2404a4773487b6302f696114ebfc6e461481ac51abba4adcdb169fa7df2f9c
-  data.tar.gz: 371b96928991144d2d6e5880eedecc8959d78975aad4da78c71c7e790752317f
+  metadata.gz: 4efdf023b31288a45487abbafc8fc37207c470167a9f2d770a5d3364e4a7c399
+  data.tar.gz: e2476b972bf30c7bfb9cdce2ee2fb5018e2253d6b1bb28142dcbb169bf834c2d
 SHA512:
-  metadata.gz: 86113704b57cd7ab3d3b4bcd411c104376cf9c453e285277f018e5d537492a4e9eaa41f417ef495f4b6f84be94867adad2d5306f01ff49bf5aeacd47583cbe40
-  data.tar.gz: d971688295936bc31b1c2cc5c2bd611601598e9d9a3a9b9fa0c221d23bf61b88e76381c29398d20c751fec1333f4c37f78c58921e1d532af2b7f3a505dba7af4
+  metadata.gz: 2f5b5589be292b9df0693b61a38f8a1b5d8a8b88ecd4ec2eb22556f18fd8795fa7be9f447057626ed9f852bb543807a96eefa28989a27f16ee946a5e91550614
+  data.tar.gz: 694d741cfd413f0bae6165706b5924a6cb5ae7a6240d5fc6d09c3cc1b4020d1fc3006ae154b932a3734126530b3ff112c29f56839ca9b630ab7ed467dda3f38a

data/CHANGELOG.md

@@ -1,160 +1,121 @@
-## Rails 5.2.8.1 (July 12, 2022) ##
+## Rails 6.0.0.beta1 (January 18, 2019) ##
 
-*   No changes.
+*   Return false instead of the job instance when `enqueue` is aborted.
 
+    This will be the behavior in Rails 6.1 but it can be controlled now with
+    `config.active_job.return_false_on_aborted_enqueue`.
 
-## Rails 5.2.8 (May 09, 2022) ##
+    *Kir Shatrov*
 
-*   No changes.
+*   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.
 
-## Rails 5.2.7.1 (April 26, 2022) ##
+    *Alberto Almagro*
 
-*   No changes.
+*   Allow all assertion helpers that have a `only` and `except` keyword to accept
+    Procs.
 
+    *Edouard Chin*
 
-## Rails 5.2.7 (March 10, 2022) ##
+*   Restore HashWithIndifferentAccess support to ActiveJob::Arguments.deserialize.
 
-*   No changes.
-
-
-## Rails 5.2.6.3 (March 08, 2022) ##
-
-*   No changes.
-
-
-## Rails 5.2.6.2 (February 11, 2022) ##
-
-*   No changes.
-
-
-## Rails 5.2.6.1 (February 11, 2022) ##
-
-*   No changes.
-
-
-## Rails 5.2.6 (May 05, 2021) ##
-
-*   No changes.
-
-
-## Rails 5.2.5 (March 26, 2021) ##
-
-*   No changes.
-
-
-## Rails 5.2.4.6 (May 05, 2021) ##
-
-*   No changes.
-
-
-## Rails 5.2.4.5 (February 10, 2021) ##
-
-*   No changes.
-
-
-## Rails 5.2.4.4 (September 09, 2020) ##
-
-*   No changes.
-
-
-## Rails 5.2.4.3 (May 18, 2020) ##
+    *Gannon McGibbon*
 
-*   No changes.
+*   Include deserialized arguments in job instances returned from
+    `assert_enqueued_with` and `assert_performed_with`
 
+    *Alan Wu*
 
-## Rails 5.2.4.2 (March 19, 2020) ##
+*   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.
 
-*   No changes.
+    *Edouard Chin*
 
+*   `ActionDispatch::IntegrationTest` includes `ActiveJob::TestHelper` module by default.
 
-## Rails 5.2.4.1 (December 18, 2019) ##
+    *Ricardo Díaz*
 
-*   No changes.
+*   Added `enqueue_retry.active_job`, `retry_stopped.active_job`, and `discard.active_job` hooks.
 
+    *steves*
 
-## Rails 5.2.4 (November 27, 2019) ##
+*   Allow `assert_performed_with` to be called without a block.
 
-*   No changes.
+    *bogdanvlviv*
 
+*   Execution of `assert_performed_jobs`, and `assert_no_performed_jobs`
+    without a block should respect passed `:except`, `:only`, and `:queue` options.
 
-## Rails 5.2.3 (March 27, 2019) ##
+    *bogdanvlviv*
 
-*   No changes.
+*   Allow `:queue` option to job assertions and helpers.
 
+    *bogdanvlviv*
 
-## Rails 5.2.2.1 (March 11, 2019) ##
+*   Allow `perform_enqueued_jobs` to be called without a block.
 
-*   No changes.
+    Performs all of the jobs that have been enqueued up to this point in the test.
 
+    *Kevin Deisz*
 
-## Rails 5.2.2 (December 04, 2018) ##
+*   Move `enqueue`/`enqueue_at` notifications to an around callback.
 
-*   Make sure `assert_enqueued_with()` & `assert_performed_with()` work reliably with hash arguments.
+    Improves timing accuracy over the old after callback by including
+    time spent writing to the adapter's IO implementation.
 
-    *Sharang Dashputre*
+    *Zach Kemp*
 
-*   Restore `ActionController::Parameters` support to `ActiveJob::Arguments.serialize`.
+*   Allow call `assert_enqueued_with` with no block.
 
-    *Bernie Chiu*
+    Example:
+    ```
+    def test_assert_enqueued_with
+      MyJob.perform_later(1,2,3)
+      assert_enqueued_with(job: MyJob, args: [1,2,3], queue: 'low')
 
-*   Restore `HashWithIndifferentAccess` support to `ActiveJob::Arguments.deserialize`.
+      MyJob.set(wait_until: Date.tomorrow.noon).perform_later
+      assert_enqueued_with(job: MyJob, at: Date.tomorrow.noon)
+    end
+    ```
 
-    *Gannon McGibbon*
+    *bogdanvlviv*
 
-*   Include deserialized arguments in job instances returned from
-    `assert_enqueued_with` and `assert_performed_with`
+*   Allow passing multiple exceptions to `retry_on`, and `discard_on`.
 
-    *Alan Wu*
+    *George Claghorn*
 
-*   Increment execution count before deserialize arguments.
+*   Pass the error instance as the second parameter of block executed by `discard_on`.
 
-    Currently, the execution count increments after deserializes arguments.
-    Therefore, if an error occurs with deserialize, it retries indefinitely.
+    Fixes #32853.
 
     *Yuji Yaginuma*
 
+*   Remove support for Qu gem.
 
-## Rails 5.2.1.1 (November 27, 2018) ##
+    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
 
-*   Do not deserialize GlobalID objects that were not generated by Active Job.
+    *Alberto Almagro*
 
-    Trusting any GlobaID object when deserializing jobs can allow attackers to access
-    information that should not be accessible to them.
+*   Add support for timezones to Active Job.
 
-    Fix CVE-2018-16476.
+    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.
 
-    *Rafael Mendonça França*
-
-
-## Rails 5.2.1 (August 07, 2018) ##
-
-*   Pass the error instance as the second parameter of block executed by `discard_on`.
-
-    Fixes #32853.
-
-    *Yuji Yaginuma*
-
-## Rails 5.2.0 (April 09, 2018) ##
-
-*   Allow block to be passed to `ActiveJob::Base.discard_on` to allow custom handling of discard jobs.
-
-    Example:
+    *Andrew White*
 
-        class RemoteServiceJob < ActiveJob::Base
-          discard_on(CustomAppException) do |job, exception|
-            ExceptionNotifier.caught(exception)
-          end
+*   Rails 6 requires Ruby 2.5.0 or newer.
 
-          def perform(*args)
-            # Might raise CustomAppException for something domain specific
-          end
-        end
+    *Jeremy Daer*, *Kasper Timm Hansen*
 
-    *Aidan Haran*
+*   Add support to define custom argument serializers.
 
-*   Support redis-rb 4.0.
+    *Evgenii Pecherkin*, *Rafael Mendonça França*
 
-    *Jeremy Daer*
 
-Please check [5-1-stable](https://github.com/rails/rails/blob/5-1-stable/activejob/CHANGELOG.md) for previous changes.
+Please check [5-2-stable](https://github.com/rails/rails/blob/5-2-stable/activejob/CHANGELOG.md) for previous changes.

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2014-2018 David Heinemeier Hansson
+Copyright (c) 2014-2019 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

@@ -1,7 +1,7 @@
 # Active Job -- Make work happen later
 
 Active Job is a framework for declaring jobs and making them run on a variety
-of queueing backends. These jobs can be everything from regularly scheduled
+of queuing backends. These jobs can be everything from regularly scheduled
 clean-ups, to billing charges, to mailings. Anything that can be chopped up into
 small units of work and run in parallel, really.
 
@@ -20,7 +20,7 @@ switch between them without having to rewrite your jobs.
 
 ## Usage
 
-To learn how to use your preferred queueing backend see its adapter
+To learn how to use your preferred queuing backend see its adapter
 documentation at
 [ActiveJob::QueueAdapters](http://api.rubyonrails.org/classes/ActiveJob/QueueAdapters.html).
 
@@ -39,7 +39,7 @@ end
 Enqueue a job like so:
 
 ```ruby
-MyJob.perform_later record  # Enqueue a job to be performed as soon as the queueing system is free.
+MyJob.perform_later record  # Enqueue a job to be performed as soon as the queuing system is free.
 ```
 
 ```ruby
@@ -82,12 +82,18 @@ This works with any class that mixes in GlobalID::Identification, which
 by default has been mixed into Active Record classes.
 
 
-## Supported queueing systems
+## Supported queuing systems
 
-Active Job has built-in adapters for multiple queueing backends (Sidekiq,
+Active Job has built-in adapters for multiple queuing backends (Sidekiq,
 Resque, Delayed Job and others). To get an up-to-date list of the adapters
 see the API Documentation for [ActiveJob::QueueAdapters](http://api.rubyonrails.org/classes/ActiveJob/QueueAdapters.html).
 
+**Please note:** We are not accepting pull requests for new adapters. We
+encourage library authors to provide an ActiveJob adapter as part of
+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)
@@ -102,7 +108,7 @@ The latest version of Active Job can be installed with RubyGems:
 
 Source code can be downloaded as part of the Rails project on GitHub:
 
-* https://github.com/rails/rails/tree/5-2-stable/activejob
+* https://github.com/rails/rails/tree/master/activejob
 
 ## License
 

data/lib/active_job/arguments.rb

@@ -14,29 +14,30 @@ module ActiveJob
   end
 
   # Raised when an unsupported argument type is set as a job argument. We
-  # currently support NilClass, Integer, Fixnum, Float, String, TrueClass, FalseClass,
-  # Bignum, BigDecimal, and objects that can be represented as GlobalIDs (ex: Active Record).
+  # currently support String, Integer, Float, NilClass, TrueClass, FalseClass,
+  # BigDecimal, Symbol, Date, Time, DateTime, ActiveSupport::TimeWithZone,
+  # ActiveSupport::Duration, Hash, ActiveSupport::HashWithIndifferentAccess,
+  # Array or GlobalID::Identification instances, although this can be extended
+  # by adding custom serializers.
   # Raised if you set the key for a Hash something else than a string or
   # a symbol. Also raised when trying to serialize an object which can't be
-  # identified with a Global ID - such as an unpersisted Active Record model.
+  # identified with a GlobalID - such as an unpersisted Active Record model.
   class SerializationError < ArgumentError; end
 
   module Arguments
     extend self
-    # :nodoc:
-    TYPE_WHITELIST = [ NilClass, String, Integer, Float, BigDecimal, TrueClass, FalseClass ]
-    TYPE_WHITELIST.push(Fixnum, Bignum) unless 1.class == Integer
-
-    # Serializes a set of arguments. Whitelisted types are returned
-    # as-is. Arrays/Hashes are serialized element by element.
-    # All other types are serialized using GlobalID.
+    # Serializes a set of arguments. Intrinsic types that can safely be
+    # serialized without mutation are returned as-is. Arrays/Hashes are
+    # serialized element by element. All other types are serialized using
+    # GlobalID.
     def serialize(arguments)
       arguments.map { |argument| serialize_argument(argument) }
     end
 
-    # Deserializes a set of arguments. Whitelisted types are returned
-    # as-is. Arrays/Hashes are deserialized element by element.
-    # All other types are deserialized using GlobalID.
+    # Deserializes a set of arguments. Intrinsic types that can safely be
+    # deserialized without mutation are returned as-is. Arrays/Hashes are
+    # deserialized element by element. All other types are deserialized using
+    # GlobalID.
     def deserialize(arguments)
       arguments.map { |argument| deserialize_argument(argument) }
     rescue
@@ -44,17 +45,30 @@ module ActiveJob
     end
 
     private
+
+      # :nodoc:
+      PERMITTED_TYPES = [ NilClass, String, Integer, Float, BigDecimal, TrueClass, FalseClass ]
+      # :nodoc:
+      GLOBALID_KEY = "_aj_globalid"
+      # :nodoc:
+      SYMBOL_KEYS_KEY = "_aj_symbol_keys"
       # :nodoc:
-      GLOBALID_KEY = "_aj_globalid".freeze
+      WITH_INDIFFERENT_ACCESS_KEY = "_aj_hash_with_indifferent_access"
       # :nodoc:
-      SYMBOL_KEYS_KEY = "_aj_symbol_keys".freeze
+      OBJECT_SERIALIZER_KEY = "_aj_serialized"
+
       # :nodoc:
-      WITH_INDIFFERENT_ACCESS_KEY = "_aj_hash_with_indifferent_access".freeze
-      private_constant :GLOBALID_KEY, :SYMBOL_KEYS_KEY, :WITH_INDIFFERENT_ACCESS_KEY
+      RESERVED_KEYS = [
+        GLOBALID_KEY, GLOBALID_KEY.to_sym,
+        SYMBOL_KEYS_KEY, SYMBOL_KEYS_KEY.to_sym,
+        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, :SYMBOL_KEYS_KEY, :WITH_INDIFFERENT_ACCESS_KEY
 
       def serialize_argument(argument)
         case argument
-        when *TYPE_WHITELIST
+        when *PERMITTED_TYPES
           argument
         when GlobalID::Identification
           convert_to_global_id_hash(argument)
@@ -70,7 +84,7 @@ module ActiveJob
         when -> (arg) { arg.respond_to?(:permitted?) }
           serialize_indifferent_hash(argument.to_h)
         else
-          raise SerializationError.new("Unsupported argument type: #{argument.class.name}")
+          Serializers.serialize(argument)
         end
       end
 
@@ -78,13 +92,15 @@ module ActiveJob
         case argument
         when String
           argument
-        when *TYPE_WHITELIST
+        when *PERMITTED_TYPES
           argument
         when Array
           argument.map { |arg| deserialize_argument(arg) }
         when Hash
           if serialized_global_id?(argument)
             deserialize_global_id argument
+          elsif custom_serialized?(argument)
+            Serializers.deserialize(argument)
           else
             deserialize_hash(argument)
           end
@@ -101,6 +117,10 @@ module ActiveJob
         GlobalID::Locator.locate hash[GLOBALID_KEY]
       end
 
+      def custom_serialized?(hash)
+        hash.key?(OBJECT_SERIALIZER_KEY)
+      end
+
       def serialize_hash(argument)
         argument.each_with_object({}) do |(key, value), hash|
           hash[serialize_hash_key(key)] = serialize_argument(value)
@@ -117,14 +137,6 @@ module ActiveJob
         result
       end
 
-      # :nodoc:
-      RESERVED_KEYS = [
-        GLOBALID_KEY, GLOBALID_KEY.to_sym,
-        SYMBOL_KEYS_KEY, SYMBOL_KEYS_KEY.to_sym,
-        WITH_INDIFFERENT_ACCESS_KEY, WITH_INDIFFERENT_ACCESS_KEY.to_sym,
-      ]
-      private_constant :RESERVED_KEYS
-
       def serialize_hash_key(key)
         case key
         when *RESERVED_KEYS

data/lib/active_job/base.rb

@@ -9,6 +9,7 @@ require "active_job/execution"
 require "active_job/callbacks"
 require "active_job/exceptions"
 require "active_job/logging"
+require "active_job/timezones"
 require "active_job/translation"
 
 module ActiveJob #:nodoc:
@@ -39,7 +40,7 @@ module ActiveJob #:nodoc:
   # Records that are passed in are serialized/deserialized using Global
   # ID. More information can be found in Arguments.
   #
-  # To enqueue a job to be performed as soon as the queueing system is free:
+  # To enqueue a job to be performed as soon as the queuing system is free:
   #
   #   ProcessPhotoJob.perform_later(photo)
   #
@@ -67,6 +68,7 @@ module ActiveJob #:nodoc:
     include Callbacks
     include Exceptions
     include Logging
+    include Timezones
     include Translation
 
     ActiveSupport.run_load_hooks(:active_job, self)

data/lib/active_job/callbacks.rb

@@ -29,6 +29,9 @@ module ActiveJob
     included do
       define_callbacks :perform
       define_callbacks :enqueue
+
+      class_attribute :return_false_on_aborted_enqueue, instance_accessor: false, instance_predicate: false
+      self.return_false_on_aborted_enqueue = false
     end
 
     # These methods will be included into any Active Job object, adding
@@ -130,7 +133,7 @@ module ActiveJob
         set_callback(:enqueue, :after, *filters, &blk)
       end
 
-      # Defines a callback that will get called around the enqueueing
+      # Defines a callback that will get called around the enqueuing
       # of the job.
       #
       #   class VideoProcessJob < ActiveJob::Base

data/lib/active_job/core.rb

@@ -6,32 +6,39 @@ module ActiveJob
   module Core
     extend ActiveSupport::Concern
 
-    included do
-      # Job arguments
-      attr_accessor :arguments
-      attr_writer :serialized_arguments
+    # Job arguments
+    attr_accessor :arguments
+    attr_writer :serialized_arguments
 
-      # Timestamp when the job should be performed
-      attr_accessor :scheduled_at
+    # Timestamp when the job should be performed
+    attr_accessor :scheduled_at
 
-      # Job Identifier
-      attr_accessor :job_id
+    # Job Identifier
+    attr_accessor :job_id
 
-      # Queue in which the job will reside.
-      attr_writer :queue_name
+    # Queue in which the job will reside.
+    attr_writer :queue_name
 
-      # Priority that the job will have (lower is more priority).
-      attr_writer :priority
+    # Priority that the job will have (lower is more priority).
+    attr_writer :priority
 
-      # ID optionally provided by adapter
-      attr_accessor :provider_job_id
+    # ID optionally provided by adapter
+    attr_accessor :provider_job_id
 
-      # Number of times this job has been executed (which increments on every retry, like after an exception).
-      attr_accessor :executions
+    # Number of times this job has been executed (which increments on every retry, like after an exception).
+    attr_accessor :executions
 
-      # I18n.locale to be used during the job.
-      attr_accessor :locale
-    end
+    # Hash that contains the number of times this job handled errors for each specific retry_on declaration.
+    # Keys are the string representation of the exceptions listed in the retry_on declaration,
+    # while its associated value holds the number of executions where the corresponding retry_on
+    # declaration handled one of its listed exceptions.
+    attr_accessor :exception_executions
+
+    # I18n.locale to be used during the job.
+    attr_accessor :locale
+
+    # Timezone to be used during the job.
+    attr_accessor :timezone
 
     # These methods will be included into any Active Job object, adding
     # helpers for de/serialization and creation of job instances.
@@ -74,10 +81,11 @@ module ActiveJob
       @queue_name = self.class.queue_name
       @priority   = self.class.priority
       @executions = 0
+      @exception_executions = {}
     end
 
     # Returns a hash with the job data that can safely be passed to the
-    # queueing adapter.
+    # queuing adapter.
     def serialize
       {
         "job_class"  => self.class.name,
@@ -87,7 +95,9 @@ module ActiveJob
         "priority"   => priority,
         "arguments"  => serialize_arguments_if_needed(arguments),
         "executions" => executions,
-        "locale"     => I18n.locale.to_s
+        "exception_executions" => exception_executions,
+        "locale"     => I18n.locale.to_s,
+        "timezone"   => Time.zone.try(:name)
       }
     end
 
@@ -124,7 +134,9 @@ module ActiveJob
       self.priority             = job_data["priority"]
       self.serialized_arguments = job_data["arguments"]
       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)
     end
 
     private

data/lib/active_job/enqueuing.rb

@@ -9,10 +9,12 @@ module ActiveJob
 
     # Includes the +perform_later+ method for job initialization.
     module ClassMethods
-      # Push a job onto the queue. The arguments must be legal JSON types
-      # (+string+, +int+, +float+, +nil+, +true+, +false+, +hash+ or +array+) or
-      # GlobalID::Identification instances. Arbitrary Ruby objects
-      # are not supported.
+      # Push a job onto the queue. By default the arguments must be either String,
+      # Integer, Float, NilClass, TrueClass, FalseClass, BigDecimal, Symbol, Date,
+      # Time, DateTime, ActiveSupport::TimeWithZone, ActiveSupport::Duration,
+      # Hash, ActiveSupport::HashWithIndifferentAccess, Array or
+      # GlobalID::Identification instances, although this can be extended by adding
+      # custom serializers.
       #
       # Returns an instance of the job class queued with arguments available in
       # Job#arguments.
@@ -46,14 +48,33 @@ module ActiveJob
       self.scheduled_at = options[:wait_until].to_f 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]
+      successfully_enqueued = false
+
       run_callbacks :enqueue do
         if scheduled_at
           self.class.queue_adapter.enqueue_at self, scheduled_at
         else
           self.class.queue_adapter.enqueue self
         end
+
+        successfully_enqueued = true
+      end
+
+      if successfully_enqueued
+        self
+      else
+        if self.class.return_false_on_aborted_enqueue
+          false
+        else
+          ActiveSupport::Deprecation.warn(
+            "Rails 6.0 will return false when the enqueing 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
       end
-      self
     end
   end
 end