activejob 4.2.11.3 → 5.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 259b60fde284cd57ed3e2f82015b5364ba4c8910af7acbdb1587d624edfdffff
-  data.tar.gz: '090c18d31150c0d683baf1c03150a228654a5ab2eae284012a458196f83f8bf4'
+SHA1:
+  metadata.gz: 3bfdadd9d05eeb7c784d6916260b2ee3d1494d0d
+  data.tar.gz: 089b206f85a6a27a8b23b699c64bd7227dee50d7
 SHA512:
-  metadata.gz: 24860c2c1359e5c67c2ea0295e61c7065cacf6ffae4b38be6a6f58d6c2b403602bb8bde900434cfa0f7f47d99c8d09fc573b78304801a7443e6bb2767f30a086
-  data.tar.gz: e590efa40fa911a4410ac9a44e425cc8f150ee2a15ff6fd8951300ed78e555424cce27bd8c69965850821c55fc3a705388efa0ed811ce30da28f95ba1ca850d8
+  metadata.gz: 6195c91d63855ba8eee3f6aedccdd0093a393ef462d566d1b936c299841e6469724f6819c0dd1f1046fae2b72036d2465e2e283f3b423264630c34a1ef1c6f47
+  data.tar.gz: 18c352ac26d1739716698165a8ce4a8c9a2c36fba7b4177692a27d42295f5b74ff5a63fdcbcec10ccd5510bffb899761d086fdc72d0cf70aaea2c368cef6d406

data/CHANGELOG.md

@@ -1,103 +1,137 @@
-## Rails 4.2.11.3 (May 15, 2020) ##
+## Rails 5.0.0.beta1 (December 18, 2015) ##
 
 *   No changes.
 
 
-## Rails 4.2.11.2 (May 15, 2020) ##
-
-*   No changes.
-
-
-## Rails 4.2.11.1 (March 11, 2019) ##
-
-*   No changes.
+*   Fixed serializing `:at` option for `assert_enqueued_with`
+    and `assert_performed_with`.
 
+    *Wojciech Wnętrzak*
 
-## Rails 4.2.11 (November 27, 2018) ##
+*   Support passing array to `assert_enqueued_jobs` in `:only` option.
 
-*   Do not deserialize GlobalID objects that were not generated by Active Job.
+    *Wojciech Wnętrzak*
 
-    Trusting any GlobaID object when deserializing jobs can allow attackers to access
-    information that should not be accessible to them.
+*   Add job priorities to Active Job.
 
-    Fix CVE-2018-16476.
+    *wvengen*
 
-    *Rafael Mendonça França*
+*   Implement a simple `AsyncJob` processor and associated `AsyncAdapter` that
+    queue jobs to a `concurrent-ruby` thread pool.
 
+    *Jerry D'Antonio*
 
-## Rails 4.2.10 (September 27, 2017) ##
+*   Implement `provider_job_id` for `queue_classic` adapter. This requires the
+    latest, currently unreleased, version of queue_classic.
 
-*   No changes.
-
-
-## Rails 4.2.9 (June 26, 2017) ##
-
-*   No changes.
+    *Yves Senn*
 
+*   `assert_enqueued_with` and `assert_performed_with` now returns the matched
+    job instance for further assertions.
 
-## Rails 4.2.8 (February 21, 2017) ##
+    *Jean Boussier*
 
-*   No changes.
-
-
-## Rails 4.2.7 (July 12, 2016) ##
+*   Include I18n.locale into job serialization/deserialization and use it around
+    `perform`.
 
-*   No changes.
+    Fixes #20799.
 
+    *Johannes Opper*
 
-## Rails 4.2.6 (March 07, 2016) ##
+*   Allow `DelayedJob`, `Sidekiq`, `qu`, and `que` to report the job id back to
+    `ActiveJob::Base` as `provider_job_id`.
 
-*   No changes.
+    Fixes #18821.
 
+    *Kevin Deisz*, *Jeroen van Baarsen*
 
-## Rails 4.2.5.2 (February 26, 2016) ##
+*   `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.
 
-*   No changes.
+    *y-yagi*
 
+*   A generated job now inherits from `app/jobs/application_job.rb` by default.
 
-## Rails 4.2.5.1 (January 25, 2015) ##
+    *Jeroen van Baarsen*
 
-*   No changes.
+*   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.
 
-## Rails 4.2.5 (November 12, 2015) ##
+    Example:
 
-*   No changes.
+        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.
 
-## Rails 4.2.4 (August 24, 2015) ##
+    Example:
 
-*   Include I18n.locale into job serialization/deserialization and use it around
-    `perform`.
+        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 #20799.
+    Fixes #18802.
 
-    *Johannes Opper*
+    *Michael Ryan*
 
+*   Allow keyword arguments to be used with Active Job.
 
-## Rails 4.2.3 (June 25, 2015) ##
+    Fixes #18741.
 
-*   `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.
+    *Sean Griffin*
 
-    *y-yagi*
+*   Add `:only` option to `assert_enqueued_jobs`, to check the number of times
+    a specific kind of job is enqueued.
 
+    Example:
 
-## Rails 4.2.2 (June 16, 2015) ##
+        def test_logging_job
+          assert_enqueued_jobs 1, only: LoggingJob do
+            LoggingJob.perform_later
+            HelloJob.perform_later('jeremy')
+          end
+        end
 
-* No Changes *
+    *George Claghorn*
 
+*   `ActiveJob::Base.deserialize` delegates to the job class.
 
-## Rails 4.2.1 (March 19, 2015) ##
+    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.
 
-*   Allow keyword arguments to be used with Active Job.
+    Example:
 
-    Fixes #18741.
+        class DeliverWebhookJob < ActiveJob::Base
+          def serialize
+            super.merge('attempt_number' => (@attempt_number || 0) + 1)
+          end
 
-    *Sean Griffin*
+          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
 
-## Rails 4.2.0 (December 20, 2014) ##
+    *Isaac Seymour*
 
-*  Started project.
+Please check [4-2-stable](https://github.com/rails/rails/blob/4-2-stable/activejob/CHANGELOG.md) for previous changes.

data/MIT-LICENSE

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

@@ -7,7 +7,7 @@ small units of work and run in parallel, really.
 
 It also serves as the backend for Action Mailer's #deliver_later functionality
 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
+one of the most common jobs in a modern web application: sending emails outside
 of 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
@@ -44,7 +44,7 @@ end
 Enqueue a job like so:
 
 ```ruby
-MyJob.perform_later record  # Enqueue a job to be performed as soon the queueing system is free.
+MyJob.perform_later record  # Enqueue a job to be performed as soon as the queueing system is free.
 ```
 
 ```ruby
@@ -102,12 +102,12 @@ see the API Documentation for [ActiveJob::QueueAdapters](http://api.rubyonrails.
 The latest version of Active Job can be installed with RubyGems:
 
 ```
-  % [sudo] gem install activejob
+  $ gem install activejob
 ```
 
 Source code can be downloaded as part of the Rails project on GitHub
 
-* https://github.com/rails/rails/tree/4-2-stable/activejob
+* https://github.com/rails/rails/tree/master/activejob
 
 ## License
 
@@ -118,7 +118,7 @@ Active Job is released under the MIT license:
 
 ## Support
 
-API documentation is at
+API documentation is at:
 
 * http://api.rubyonrails.org
 

data/lib/active_job.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2014 David Heinemeier Hansson
+# Copyright (c) 2014-2015 David Heinemeier Hansson
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -32,6 +32,7 @@ module ActiveJob
   autoload :Base
   autoload :QueueAdapters
   autoload :ConfiguredJob
+  autoload :AsyncJob
   autoload :TestCase
   autoload :TestHelper
 end

data/lib/active_job/arguments.rb

@@ -3,30 +3,38 @@ require 'active_support/core_ext/hash'
 module ActiveJob
   # Raised when an exception is raised during job arguments deserialization.
   #
-  # Wraps the original exception raised as +original_exception+.
+  # Wraps the original exception raised as +cause+.
   class DeserializationError < StandardError
-    attr_reader :original_exception
+    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(e) #:nodoc:
-      super("Error while trying to deserialize arguments: #{e.message}")
-      @original_exception = e
-      set_backtrace e.backtrace
+      super("Error while trying to deserialize arguments: #{$!.message}")
+      set_backtrace $!.backtrace
     end
-  end
 
-  # Raised when an unsupported argument type is being set as job argument. We
-  # currently support NilClass, Integer, Fixnum, Float, String, TrueClass, FalseClass,
-  # Bignum and object that can be represented as GlobalIDs (ex: Active Record).
-  # Also raised if you set the key for a Hash something else than a string or
-  # a symbol.
-  class SerializationError < ArgumentError
+    # 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
+  # currently support NilClass, Fixnum, Float, String, TrueClass, FalseClass,
+  # Bignum and objects that can be represented as GlobalIDs (ex: Active Record).
+  # 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.
+  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
+    TYPE_WHITELIST = [ NilClass, Fixnum, Float, String, TrueClass, FalseClass, Bignum ]
 
     # Serializes a set of arguments. Whitelisted types are returned
     # as-is. Arrays/Hashes are serialized element by element.
@@ -40,13 +48,16 @@ module ActiveJob
     # All other types are deserialized using GlobalID.
     def deserialize(arguments)
       arguments.map { |argument| deserialize_argument(argument) }
-    rescue => e
-      raise DeserializationError.new(e)
+    rescue
+      raise DeserializationError
     end
 
     private
+      # :nodoc:
       GLOBALID_KEY = '_aj_globalid'.freeze
+      # :nodoc:
       SYMBOL_KEYS_KEY = '_aj_symbol_keys'.freeze
+      # :nodoc:
       WITH_INDIFFERENT_ACCESS_KEY = '_aj_hash_with_indifferent_access'.freeze
       private_constant :GLOBALID_KEY, :SYMBOL_KEYS_KEY, :WITH_INDIFFERENT_ACCESS_KEY
 
@@ -55,7 +66,7 @@ module ActiveJob
         when *TYPE_WHITELIST
           argument
         when GlobalID::Identification
-          { GLOBALID_KEY => argument.to_global_id.to_s }
+          convert_to_global_id_hash(argument)
         when Array
           argument.map { |arg| serialize_argument(arg) }
         when ActiveSupport::HashWithIndifferentAccess
@@ -75,7 +86,7 @@ module ActiveJob
       def deserialize_argument(argument)
         case argument
         when String
-          argument
+          GlobalID::Locator.locate(argument) || argument
         when *TYPE_WHITELIST
           argument
         when Array
@@ -115,6 +126,7 @@ module ActiveJob
         result
       end
 
+      # :nodoc:
       RESERVED_KEYS = [
         GLOBALID_KEY, GLOBALID_KEY.to_sym,
         SYMBOL_KEYS_KEY, SYMBOL_KEYS_KEY.to_sym,
@@ -142,5 +154,12 @@ module ActiveJob
           end
         end
       end
+
+      def convert_to_global_id_hash(argument)
+        { GLOBALID_KEY => argument.to_global_id.to_s }
+      rescue URI::GID::MissingModelIdError
+        raise SerializationError, "Unable to serialize #{argument.class} " \
+          "without an id. (Maybe you forgot to call save?)"
+      end
   end
 end

data/lib/active_job/async_job.rb

@@ -0,0 +1,77 @@
+require 'concurrent/map'
+require 'concurrent/scheduled_task'
+require 'concurrent/executor/thread_pool_executor'
+require 'concurrent/utility/processor_counter'
+
+module ActiveJob
+  # == Active Job Async Job
+  #
+  # When enqueueing jobs with Async Job each job will be executed asynchronously
+  # on a +concurrent-ruby+ thread pool. All job data is retained in memory.
+  # Because job data is not saved to a persistent datastore there is no
+  # additional infrastructure needed and jobs process quickly. The lack of
+  # persistence, however, means that all unprocessed jobs will be lost on
+  # application restart. Therefore in-memory queue adapters are unsuitable for
+  # most production environments but are excellent for development and testing.
+  #
+  # Read more about Concurrent Ruby {here}[https://github.com/ruby-concurrency/concurrent-ruby].
+  #
+  # To use Async Job set the queue_adapter config to +:async+.
+  #
+  #   Rails.application.config.active_job.queue_adapter = :async
+  #
+  # Async Job supports job queues specified with +queue_as+. Queues are created
+  # automatically as needed and each has its own thread pool.
+  class AsyncJob
+
+    DEFAULT_EXECUTOR_OPTIONS = {
+      min_threads:     [2, Concurrent.processor_count].max,
+      max_threads:     Concurrent.processor_count * 10,
+      auto_terminate:  true,
+      idletime:        60, # 1 minute
+      max_queue:       0, # unlimited
+      fallback_policy: :caller_runs # shouldn't matter -- 0 max queue
+    }.freeze
+
+    QUEUES = Concurrent::Map.new do |hash, queue_name| #:nodoc:
+      hash.compute_if_absent(queue_name) { ActiveJob::AsyncJob.create_thread_pool }
+    end
+
+    class << self
+      # Forces jobs to process immediately when testing the Active Job gem.
+      # This should only be called from within unit tests.
+      def perform_immediately! #:nodoc:
+        @perform_immediately = true
+      end
+
+      # Allows jobs to run asynchronously when testing the Active Job gem.
+      # This should only be called from within unit tests.
+      def perform_asynchronously! #:nodoc:
+        @perform_immediately = false
+      end
+
+      def create_thread_pool #:nodoc:
+        if @perform_immediately
+          Concurrent::ImmediateExecutor.new
+        else
+          Concurrent::ThreadPoolExecutor.new(DEFAULT_EXECUTOR_OPTIONS)
+        end
+      end
+
+      def enqueue(job_data, queue: 'default') #:nodoc:
+        QUEUES[queue].post(job_data) { |job| ActiveJob::Base.execute(job) }
+      end
+
+      def enqueue_at(job_data, timestamp, queue: 'default') #:nodoc:
+        delay = timestamp - Time.current.to_f
+        if delay > 0
+          Concurrent::ScheduledTask.execute(delay, args: [job_data], executor: QUEUES[queue]) do |job|
+            ActiveJob::Base.execute(job)
+          end
+        else
+          enqueue(job_data, queue: queue)
+        end
+      end
+    end
+  end
+end