activejob 5.0.7.2 → 5.1.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: ecdf4a56b98a2c195f395d7ce97d4156a7eed47df1f510b37ff57b2657dabef1
-  data.tar.gz: dbde580495e6f009e966e3e19ba96612766f0f1b149e8cfdea47bab57c89834a
+SHA1:
+  metadata.gz: f531ce0d6eaf7a50b34ce12d446306d52ee5c1c8
+  data.tar.gz: 75398a20122581b02e422c07798a7770d0481cdf
 SHA512:
-  metadata.gz: 91dd626ddf7d659f4ddd0444b761198860195daad86132299e7734d668e0af7e1f92f471d73b7d398153fb38bc70be9796f6d400b659f63aa1a432a627434061
-  data.tar.gz: 247bcb13011b91cb99fcf7e39119d9105bebba8cb6178b8d8d2a31cc012f7eecf6f5e94b10ead717ede24d0a160f7e2fd6f0c6049acf52d24c7742b873fd8150
+  metadata.gz: d70263baebf9c8476d0a45fe9e0eef753f35baaa221ebce00662971f46a1cc701fd51d9138194d445891954205ed6cfdf66573a6a107cf216ef7b0eaf2c28e70
+  data.tar.gz: f62463ae9aebd79e7933002dd9b2d786b74ca2dc28b94322fd3ea440b68c5c0d4ab0a59967a5f46d6932b869f4c62168878e5a9e48e49e7ea637597201276d85

data/CHANGELOG.md

@@ -1,76 +1,22 @@
-## Rails 5.0.7.2 (March 11, 2019) ##
+## Rails 5.1.0.beta1 (February 23, 2017) ##
 
-*   No changes.
+*   Correctly set test adapter when configure the queue adapter on a per job.
 
+    Fixes #26360.
 
-## Rails 5.0.7.1 (November 27, 2018) ##
+    *Yuji Yaginuma*
 
-*   Do not deserialize GlobalID objects that were not generated by Active Job.
+*   Push skipped jobs to `enqueued_jobs` when using `perform_enqueued_jobs` with a `only` filter in tests
 
-    Trusting any GlobaID object when deserializing jobs can allow attackers to access
-    information that should not be accessible to them.
+    *Alexander Pauly*
 
-    Fix CVE-2018-16476.
+*   Removed deprecated support to passing the adapter class to `.queue_adapter`.
 
     *Rafael Mendonça França*
 
+*   Removed deprecated `#original_exception` in `ActiveJob::DeserializationError`.
 
-## Rails 5.0.7 (March 29, 2018) ##
-
-*   No changes.
-
-
-## Rails 5.0.6 (September 07, 2017) ##
-
-*   No changes.
-
-
-## Rails 5.0.6.rc1 (August 24, 2017) ##
-
-*   No changes.
-
-
-## Rails 5.0.5 (July 31, 2017) ##
-
-*   No changes.
-
-
-## Rails 5.0.5.rc2 (July 25, 2017) ##
-
-*   No changes.
-
-
-## Rails 5.0.5.rc1 (July 19, 2017) ##
-
-*   No changes.
-
-
-## Rails 5.0.4 (June 19, 2017) ##
-
-*   No changes.
-
-
-## Rails 5.0.3 (May 12, 2017) ##
-
-*   No changes.
-
-
-## Rails 5.0.2 (March 01, 2017) ##
-
-*   No changes.
-
-
-## Rails 5.0.1 (December 21, 2016) ##
-
-*   No changes.
-
-
-## Rails 5.0.1.rc2 (December 10, 2016) ##
-
-*   No changes.
-
-
-## Rails 5.0.1.rc1 (December 01, 2016) ##
+    *Rafael Mendonça França*
 
 *   Added instance variable `@queue` to JobWrapper.
 
@@ -79,172 +25,29 @@
 
     *mu29*
 
-
-## Rails 5.0.0 (June 30, 2016) ##
-
-*   Enable class reloading prior to job dispatch, and ensure Active Record
-    connections are returned to the pool when jobs are run in separate threads.
-
-    *Matthew Draper*
-
-*   Tune the async adapter for low-footprint dev/test usage. Use a single
-    thread pool for all queues and limit to 0 to #CPU total threads, down from
-    2 to 10*#CPU per queue.
-
-    *Jeremy Daer*
-
-*   Change the default adapter from inline to async. It's a better default as tests will then not mistakenly
-    come to rely on behavior happening synchronously. This is especially important with things like jobs kicked off
-    in Active Record lifecycle callbacks.
+*   Yield the job instance so you have access to things like `job.arguments` on the custom logic after retries fail.
 
     *DHH*
 
-*   Fixed serializing `:at` option for `assert_enqueued_with`
-    and `assert_performed_with`.
-
-    *Wojciech Wnętrzak*
-
-*   Support passing array to `assert_enqueued_jobs` in `:only` option.
-
-    *Wojciech Wnętrzak*
-
-*   Add job priorities to Active Job.
-
-    *wvengen*
-
-*   Implement a simple `AsyncJob` processor and associated `AsyncAdapter` that
-    queue jobs to a `concurrent-ruby` thread pool.
-
-    *Jerry D'Antonio*
-
-*   Implement `provider_job_id` for `queue_classic` adapter. This requires the
-    latest, currently unreleased, version of queue_classic.
+*   Added declarative exception handling via `ActiveJob::Base.retry_on` and `ActiveJob::Base.discard_on`.
 
-    *Yves Senn*
+    Examples:
 
-*   `assert_enqueued_with` and `assert_performed_with` now returns the matched
-    job instance for further assertions.
+        class RemoteServiceJob < ActiveJob::Base
+          retry_on CustomAppException # defaults to 3s wait, 5 attempts
+          retry_on AnotherCustomAppException, wait: ->(executions) { executions * 2 }
+          retry_on ActiveRecord::Deadlocked, wait: 5.seconds, attempts: 3
+          retry_on Net::OpenTimeout, wait: :exponentially_longer, attempts: 10
+          discard_on ActiveJob::DeserializationError
 
-    *Jean Boussier*
-
-*   Include `I18n.locale` into job serialization/deserialization and use it around
-    `perform`.
-
-    Fixes #20799.
-
-    *Johannes Opper*
-
-*   Allow `DelayedJob`, `Sidekiq`, `qu`, and `que` to report the job id back to
-    `ActiveJob::Base` as `provider_job_id`.
-
-    Fixes #18821.
-
-    *Kevin Deisz*, *Jeroen van Baarsen*
-
-*   `assert_enqueued_jobs` and `assert_performed_jobs` in block form use the
-    given number as expected value. This makes the error message much easier to
-    understand.
-
-    *y-yagi*
-
-*   A generated job now inherits from `app/jobs/application_job.rb` by default.
-
-    *Jeroen van Baarsen*
-
-*   Add ability to configure the queue adapter on a per job basis.
-
-    Now different jobs can have different queue adapters without conflicting with
-    each other.
-
-    Example:
-
-        class EmailJob < ActiveJob::Base
-          self.queue_adapter = :sidekiq
-        end
-
-        class ImageProcessingJob < ActiveJob::Base
-          self.queue_adapter = :delayed_job
-        end
-
-    *tamird*
-
-*   Add an `:only` option to `perform_enqueued_jobs` to filter jobs based on
-    type.
-
-    This allows specific jobs to be tested, while preventing others from
-    being performed unnecessarily.
-
-    Example:
-
-        def test_hello_job
-          assert_performed_jobs 1, only: HelloJob do
-            HelloJob.perform_later('jeremy')
-            LoggingJob.perform_later
-          end
-        end
-
-    An array may also be specified, to support testing multiple jobs.
-
-    Example:
-
-        def test_hello_and_logging_jobs
-          assert_nothing_raised do
-            assert_performed_jobs 2, only: [HelloJob, LoggingJob] do
-              HelloJob.perform_later('jeremy')
-              LoggingJob.perform_later('stewie')
-              RescueJob.perform_later('david')
-            end
-          end
-        end
-
-    Fixes #18802.
-
-    *Michael Ryan*
-
-*   Allow keyword arguments to be used with Active Job.
-
-    Fixes #18741.
-
-    *Sean Griffin*
-
-*   Add `:only` option to `assert_enqueued_jobs`, to check the number of times
-    a specific kind of job is enqueued.
-
-    Example:
-
-        def test_logging_job
-          assert_enqueued_jobs 1, only: LoggingJob do
-            LoggingJob.perform_later
-            HelloJob.perform_later('jeremy')
+          def perform(*args)
+            # Might raise CustomAppException or AnotherCustomAppException for something domain specific
+            # Might raise ActiveRecord::Deadlocked when a local db deadlock is detected
+            # Might raise Net::OpenTimeout when the remote service is down
           end
         end
 
-    *George Claghorn*
-
-*   `ActiveJob::Base.deserialize` delegates to the job class.
-
-    Since `ActiveJob::Base#deserialize` can be overridden by subclasses (like
-    `ActiveJob::Base#serialize`) this allows jobs to attach arbitrary metadata
-    when they get serialized and read it back when they get performed.
-
-    Example:
-
-        class DeliverWebhookJob < ActiveJob::Base
-          def serialize
-            super.merge('attempt_number' => (@attempt_number || 0) + 1)
-          end
-
-          def deserialize(job_data)
-            super
-            @attempt_number = job_data['attempt_number']
-          end
-
-          rescue_from(TimeoutError) do |exception|
-            raise exception if @attempt_number > 5
-            retry_job(wait: 10)
-          end
-        end
+    *DHH*
 
-    *Isaac Seymour*
 
-Please check [4-2-stable](https://github.com/rails/rails/blob/4-2-stable/activejob/CHANGELOG.md) for previous changes.
+Please check [5-0-stable](https://github.com/rails/rails/blob/5-0-stable/activejob/CHANGELOG.md) for previous changes.

data/MIT-LICENSE

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

@@ -102,7 +102,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-0-stable/activejob
+* https://github.com/rails/rails/tree/master/activejob
 
 ## License
 

data/lib/active_job.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2014-2016 David Heinemeier Hansson
+# Copyright (c) 2014-2017 David Heinemeier Hansson
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -21,10 +21,10 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
 
-require 'active_support'
-require 'active_support/rails'
-require 'active_job/version'
-require 'global_id'
+require "active_support"
+require "active_support/rails"
+require "active_job/version"
+require "global_id"
 
 module ActiveJob
   extend ActiveSupport::Autoload

data/lib/active_job/arguments.rb

@@ -1,26 +1,14 @@
-require 'active_support/core_ext/hash'
+require "active_support/core_ext/hash"
 
 module ActiveJob
   # Raised when an exception is raised during job arguments deserialization.
   #
   # Wraps the original exception raised as +cause+.
   class DeserializationError < StandardError
-    def initialize(e = nil) #:nodoc:
-      if e
-        ActiveSupport::Deprecation.warn("Passing #original_exception is deprecated and has no effect. " \
-                                        "Exceptions will automatically capture the original exception.", caller)
-      end
-
+    def initialize #:nodoc:
       super("Error while trying to deserialize arguments: #{$!.message}")
       set_backtrace $!.backtrace
     end
-
-    # The original exception that was raised during deserialization of job
-    # arguments.
-    def original_exception
-      ActiveSupport::Deprecation.warn("#original_exception is deprecated. Use #cause instead.", caller)
-      cause
-    end
   end
 
   # Raised when an unsupported argument type is set as a job argument. We
@@ -55,11 +43,11 @@ module ActiveJob
 
     private
       # :nodoc:
-      GLOBALID_KEY = '_aj_globalid'.freeze
+      GLOBALID_KEY = "_aj_globalid".freeze
       # :nodoc:
-      SYMBOL_KEYS_KEY = '_aj_symbol_keys'.freeze
+      SYMBOL_KEYS_KEY = "_aj_symbol_keys".freeze
       # :nodoc:
-      WITH_INDIFFERENT_ACCESS_KEY = '_aj_hash_with_indifferent_access'.freeze
+      WITH_INDIFFERENT_ACCESS_KEY = "_aj_hash_with_indifferent_access".freeze
       private_constant :GLOBALID_KEY, :SYMBOL_KEYS_KEY, :WITH_INDIFFERENT_ACCESS_KEY
 
       def serialize_argument(argument)
@@ -87,7 +75,7 @@ module ActiveJob
       def deserialize_argument(argument)
         case argument
         when String
-          argument
+          GlobalID::Locator.locate(argument) || argument
         when *TYPE_WHITELIST
           argument
         when Array
@@ -104,7 +92,7 @@ module ActiveJob
       end
 
       def serialized_global_id?(hash)
-        hash.size == 1 and hash.include?(GLOBALID_KEY)
+        hash.size == 1 && hash.include?(GLOBALID_KEY)
       end
 
       def deserialize_global_id(hash)

data/lib/active_job/base.rb

@@ -1,12 +1,13 @@
-require 'active_job/core'
-require 'active_job/queue_adapter'
-require 'active_job/queue_name'
-require 'active_job/queue_priority'
-require 'active_job/enqueuing'
-require 'active_job/execution'
-require 'active_job/callbacks'
-require 'active_job/logging'
-require 'active_job/translation'
+require "active_job/core"
+require "active_job/queue_adapter"
+require "active_job/queue_name"
+require "active_job/queue_priority"
+require "active_job/enqueuing"
+require "active_job/execution"
+require "active_job/callbacks"
+require "active_job/exceptions"
+require "active_job/logging"
+require "active_job/translation"
 
 module ActiveJob #:nodoc:
   # = Active Job
@@ -62,6 +63,7 @@ module ActiveJob #:nodoc:
     include Enqueuing
     include Execution
     include Callbacks
+    include Exceptions
     include Logging
     include Translation
 

data/lib/active_job/callbacks.rb

@@ -1,4 +1,4 @@
-require 'active_support/callbacks'
+require "active_support/callbacks"
 
 module ActiveJob
   # = Active Job Callbacks
@@ -126,8 +126,8 @@ module ActiveJob
         set_callback(:enqueue, :after, *filters, &blk)
       end
 
-      # Defines a callback that will get called before and after the
-      # job is enqueued.
+      # Defines a callback that will get called around the enqueueing
+      # of the job.
       #
       #   class VideoProcessJob < ActiveJob::Base
       #     queue_as :default

data/lib/active_job/configured_job.rb

@@ -1,6 +1,6 @@
 module ActiveJob
   class ConfiguredJob #:nodoc:
-    def initialize(job_class, options={})
+    def initialize(job_class, options = {})
       @options = options
       @job_class = job_class
     end

data/lib/active_job/core.rb

@@ -24,6 +24,9 @@ module ActiveJob
       # 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
+
       # I18n.locale to be used during the job.
       attr_accessor :locale
     end
@@ -33,7 +36,7 @@ module ActiveJob
     module ClassMethods
       # Creates a new job instance from a hash created with +serialize+
       def deserialize(job_data)
-        job = job_data['job_class'].constantize.new
+        job = job_data["job_class"].constantize.new
         job.deserialize(job_data)
         job
       end
@@ -56,7 +59,7 @@ module ActiveJob
       #    VideoJob.set(queue: :some_queue, wait: 5.minutes).perform_later(Video.last)
       #    VideoJob.set(queue: :some_queue, wait_until: Time.now.tomorrow).perform_later(Video.last)
       #    VideoJob.set(queue: :some_queue, wait: 5.minutes, priority: 10).perform_later(Video.last)
-      def set(options={})
+      def set(options = {})
         ConfiguredJob.new(self, options)
       end
     end
@@ -68,6 +71,7 @@ module ActiveJob
       @job_id     = SecureRandom.uuid
       @queue_name = self.class.queue_name
       @priority   = self.class.priority
+      @executions = 0
     end
 
     # Returns a hash with the job data that can safely be passed to the
@@ -76,10 +80,10 @@ module ActiveJob
       {
         "job_class"  => self.class.name,
         "job_id"     => job_id,
-        "provider_job_id" => provider_job_id,
         "queue_name" => queue_name,
         "priority"   => priority,
         "arguments"  => serialize_arguments(arguments),
+        "executions" => executions,
         "locale"     => I18n.locale.to_s
       }
     end
@@ -105,12 +109,13 @@ module ActiveJob
     #      end
     #    end
     def deserialize(job_data)
-      self.job_id               = job_data['job_id']
-      self.provider_job_id      = job_data['provider_job_id']
-      self.queue_name           = job_data['queue_name']
-      self.priority             = job_data['priority']
-      self.serialized_arguments = job_data['arguments']
-      self.locale               = job_data['locale'] || I18n.locale.to_s
+      self.job_id               = job_data["job_id"]
+      self.provider_job_id      = job_data["provider_job_id"]
+      self.queue_name           = job_data["queue_name"]
+      self.priority             = job_data["priority"]
+      self.serialized_arguments = job_data["arguments"]
+      self.executions           = job_data["executions"]
+      self.locale               = job_data["locale"] || I18n.locale.to_s
     end
 
     private