activejob 6.1.4 → 7.0.0.rc1

data/lib/active_job/logging.rb

@@ -4,22 +4,25 @@ require "active_support/tagged_logging"
 require "active_support/logger"
 
 module ActiveJob
-  module Logging #:nodoc:
+  module Logging # :nodoc:
     extend ActiveSupport::Concern
 
     included do
       cattr_accessor :logger, default: ActiveSupport::TaggedLogging.new(ActiveSupport::Logger.new(STDOUT))
       class_attribute :log_arguments, instance_accessor: false, default: true
 
-      around_enqueue { |_, block| tag_logger(&block) }
-      around_perform { |job, block| tag_logger(job.class.name, job.job_id, &block) }
+      around_enqueue(prepend: true) { |_, block| tag_logger(&block) }
+    end
+
+    def perform_now
+      tag_logger(self.class.name, self.job_id) { super }
     end
 
     private
-      def tag_logger(*tags)
+      def tag_logger(*tags, &block)
         if logger.respond_to?(:tagged)
           tags.unshift "ActiveJob" unless logger_tagged_by_active_job?
-          logger.tagged(*tags) { yield }
+          logger.tagged(*tags, &block)
         else
           yield
         end

data/lib/active_job/queue_adapter.rb

@@ -5,7 +5,7 @@ require "active_support/core_ext/string/inflections"
 module ActiveJob
   # The <tt>ActiveJob::QueueAdapter</tt> module is used to load the
   # correct adapter. The default queue adapter is the +:async+ queue.
-  module QueueAdapter #:nodoc:
+  module QueueAdapter # :nodoc:
     extend ActiveSupport::Concern
 
     included do

data/lib/active_job/queue_adapters/async_adapter.rb

@@ -36,23 +36,23 @@ module ActiveJob
         @scheduler = Scheduler.new(**executor_options)
       end
 
-      def enqueue(job) #:nodoc:
+      def enqueue(job) # :nodoc:
         @scheduler.enqueue JobWrapper.new(job), queue_name: job.queue_name
       end
 
-      def enqueue_at(job, timestamp) #:nodoc:
+      def enqueue_at(job, timestamp) # :nodoc:
         @scheduler.enqueue_at JobWrapper.new(job), timestamp, queue_name: job.queue_name
       end
 
       # Gracefully stop processing jobs. Finishes in-progress work and handles
       # any new jobs following the executor's fallback policy (`caller_runs`).
       # Waits for termination by default. Pass `wait: false` to continue.
-      def shutdown(wait: true) #:nodoc:
+      def shutdown(wait: true) # :nodoc:
         @scheduler.shutdown wait: wait
       end
 
       # Used for our test suite.
-      def immediate=(immediate) #:nodoc:
+      def immediate=(immediate) # :nodoc:
         @scheduler.immediate = immediate
       end
 
@@ -60,7 +60,7 @@ module ActiveJob
       # performing them in-process, but we do so anyway for parity with other
       # adapters and deployment environments. Otherwise, serialization bugs
       # may creep in undetected.
-      class JobWrapper #:nodoc:
+      class JobWrapper # :nodoc:
         def initialize(job)
           job.provider_job_id = SecureRandom.uuid
           @job_data = job.serialize
@@ -71,7 +71,7 @@ module ActiveJob
         end
       end
 
-      class Scheduler #:nodoc:
+      class Scheduler # :nodoc:
         DEFAULT_EXECUTOR_OPTIONS = {
           min_threads:     0,
           max_threads:     Concurrent.processor_count,

data/lib/active_job/queue_adapters/backburner_adapter.rb

@@ -15,16 +15,16 @@ module ActiveJob
     #
     #   Rails.application.config.active_job.queue_adapter = :backburner
     class BackburnerAdapter
-      def enqueue(job) #:nodoc:
+      def enqueue(job) # :nodoc:
         Backburner::Worker.enqueue(JobWrapper, [job.serialize], queue: job.queue_name, pri: job.priority)
       end
 
-      def enqueue_at(job, timestamp) #:nodoc:
+      def enqueue_at(job, timestamp) # :nodoc:
         delay = timestamp - Time.current.to_f
         Backburner::Worker.enqueue(JobWrapper, [job.serialize], queue: job.queue_name, pri: job.priority, delay: delay)
       end
 
-      class JobWrapper #:nodoc:
+      class JobWrapper # :nodoc:
         class << self
           def perform(job_data)
             Base.execute job_data

data/lib/active_job/queue_adapters/delayed_job_adapter.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "delayed_job"
+require "active_support/core_ext/string/inflections"
 
 module ActiveJob
   module QueueAdapters
@@ -15,19 +16,19 @@ module ActiveJob
     #
     #   Rails.application.config.active_job.queue_adapter = :delayed_job
     class DelayedJobAdapter
-      def enqueue(job) #:nodoc:
+      def enqueue(job) # :nodoc:
         delayed_job = Delayed::Job.enqueue(JobWrapper.new(job.serialize), queue: job.queue_name, priority: job.priority)
         job.provider_job_id = delayed_job.id
         delayed_job
       end
 
-      def enqueue_at(job, timestamp) #:nodoc:
+      def enqueue_at(job, timestamp) # :nodoc:
         delayed_job = Delayed::Job.enqueue(JobWrapper.new(job.serialize), queue: job.queue_name, priority: job.priority, run_at: Time.at(timestamp))
         job.provider_job_id = delayed_job.id
         delayed_job
       end
 
-      class JobWrapper #:nodoc:
+      class JobWrapper # :nodoc:
         attr_accessor :job_data
 
         def initialize(job_data)
@@ -35,12 +36,21 @@ module ActiveJob
         end
 
         def display_name
-          "#{job_data['job_class']} [#{job_data['job_id']}] from DelayedJob(#{job_data['queue_name']}) with arguments: #{job_data['arguments']}"
+          base_name = "#{job_data["job_class"]} [#{job_data["job_id"]}] from DelayedJob(#{job_data["queue_name"]})"
+
+          return base_name unless log_arguments?
+
+          "#{base_name} with arguments: #{job_data["arguments"]}"
         end
 
         def perform
           Base.execute(job_data)
         end
+
+        private
+          def log_arguments?
+            job_data["job_class"].constantize.log_arguments?
+          end
       end
     end
   end

data/lib/active_job/queue_adapters/inline_adapter.rb

@@ -11,11 +11,11 @@ module ActiveJob
     #
     #   Rails.application.config.active_job.queue_adapter = :inline
     class InlineAdapter
-      def enqueue(job) #:nodoc:
+      def enqueue(job) # :nodoc:
         Base.execute(job.serialize)
       end
 
-      def enqueue_at(*) #:nodoc:
+      def enqueue_at(*) # :nodoc:
         raise NotImplementedError, "Use a queueing backend to enqueue jobs in the future. Read more at https://guides.rubyonrails.org/active_job_basics.html"
       end
     end

data/lib/active_job/queue_adapters/que_adapter.rb

@@ -17,19 +17,19 @@ module ActiveJob
     #
     #   Rails.application.config.active_job.queue_adapter = :que
     class QueAdapter
-      def enqueue(job) #:nodoc:
+      def enqueue(job) # :nodoc:
         que_job = JobWrapper.enqueue job.serialize, priority: job.priority, queue: job.queue_name
         job.provider_job_id = que_job.attrs["job_id"]
         que_job
       end
 
-      def enqueue_at(job, timestamp) #:nodoc:
+      def enqueue_at(job, timestamp) # :nodoc:
         que_job = JobWrapper.enqueue job.serialize, priority: job.priority, queue: job.queue_name, run_at: Time.at(timestamp)
         job.provider_job_id = que_job.attrs["job_id"]
         que_job
       end
 
-      class JobWrapper < Que::Job #:nodoc:
+      class JobWrapper < Que::Job # :nodoc:
         def run(job_data)
           Base.execute job_data
         end

data/lib/active_job/queue_adapters/queue_classic_adapter.rb

@@ -19,13 +19,13 @@ module ActiveJob
     #
     #   Rails.application.config.active_job.queue_adapter = :queue_classic
     class QueueClassicAdapter
-      def enqueue(job) #:nodoc:
+      def enqueue(job) # :nodoc:
         qc_job = build_queue(job.queue_name).enqueue("#{JobWrapper.name}.perform", job.serialize)
         job.provider_job_id = qc_job["id"] if qc_job.is_a?(Hash)
         qc_job
       end
 
-      def enqueue_at(job, timestamp) #:nodoc:
+      def enqueue_at(job, timestamp) # :nodoc:
         queue = build_queue(job.queue_name)
         unless queue.respond_to?(:enqueue_at)
           raise NotImplementedError, "To be able to schedule jobs with queue_classic " \
@@ -46,7 +46,7 @@ module ActiveJob
         QC::Queue.new(queue_name)
       end
 
-      class JobWrapper #:nodoc:
+      class JobWrapper # :nodoc:
         class << self
           def perform(job_data)
             Base.execute job_data

data/lib/active_job/queue_adapters/resque_adapter.rb

@@ -28,12 +28,12 @@ module ActiveJob
     #
     #   Rails.application.config.active_job.queue_adapter = :resque
     class ResqueAdapter
-      def enqueue(job) #:nodoc:
+      def enqueue(job) # :nodoc:
         JobWrapper.instance_variable_set(:@queue, job.queue_name)
         Resque.enqueue_to job.queue_name, JobWrapper, job.serialize
       end
 
-      def enqueue_at(job, timestamp) #:nodoc:
+      def enqueue_at(job, timestamp) # :nodoc:
         unless Resque.respond_to?(:enqueue_at_with_queue)
           raise NotImplementedError, "To be able to schedule jobs with Resque you need the " \
             "resque-scheduler gem. Please add it to your Gemfile and run bundle install"
@@ -41,7 +41,7 @@ module ActiveJob
         Resque.enqueue_at_with_queue job.queue_name, timestamp, JobWrapper, job.serialize
       end
 
-      class JobWrapper #:nodoc:
+      class JobWrapper # :nodoc:
         class << self
           def perform(job_data)
             Base.execute job_data

data/lib/active_job/queue_adapters/sidekiq_adapter.rb

@@ -17,7 +17,7 @@ module ActiveJob
     #
     #   Rails.application.config.active_job.queue_adapter = :sidekiq
     class SidekiqAdapter
-      def enqueue(job) #:nodoc:
+      def enqueue(job) # :nodoc:
         # Sidekiq::Client does not support symbols as keys
         job.provider_job_id = Sidekiq::Client.push \
           "class"   => JobWrapper,
@@ -26,7 +26,7 @@ module ActiveJob
           "args"    => [ job.serialize ]
       end
 
-      def enqueue_at(job, timestamp) #:nodoc:
+      def enqueue_at(job, timestamp) # :nodoc:
         job.provider_job_id = Sidekiq::Client.push \
           "class"   => JobWrapper,
           "wrapped" => job.class,
@@ -35,7 +35,7 @@ module ActiveJob
           "at"      => timestamp
       end
 
-      class JobWrapper #:nodoc:
+      class JobWrapper # :nodoc:
         include Sidekiq::Worker
 
         def perform(job_data)

data/lib/active_job/queue_adapters/sneakers_adapter.rb

@@ -22,18 +22,18 @@ module ActiveJob
         @monitor = Monitor.new
       end
 
-      def enqueue(job) #:nodoc:
+      def enqueue(job) # :nodoc:
         @monitor.synchronize do
           JobWrapper.from_queue job.queue_name
           JobWrapper.enqueue ActiveSupport::JSON.encode(job.serialize)
         end
       end
 
-      def enqueue_at(job, timestamp) #:nodoc:
+      def enqueue_at(job, timestamp) # :nodoc:
         raise NotImplementedError, "This queueing backend does not support scheduling jobs. To see what features are supported go to http://api.rubyonrails.org/classes/ActiveJob/QueueAdapters.html"
       end
 
-      class JobWrapper #:nodoc:
+      class JobWrapper # :nodoc:
         include Sneakers::Worker
         from_queue "default"
 

data/lib/active_job/queue_adapters/sucker_punch_adapter.rb

@@ -18,7 +18,7 @@ module ActiveJob
     #
     #   Rails.application.config.active_job.queue_adapter = :sucker_punch
     class SuckerPunchAdapter
-      def enqueue(job) #:nodoc:
+      def enqueue(job) # :nodoc:
         if JobWrapper.respond_to?(:perform_async)
           # sucker_punch 2.0 API
           JobWrapper.perform_async job.serialize
@@ -28,7 +28,7 @@ module ActiveJob
         end
       end
 
-      def enqueue_at(job, timestamp) #:nodoc:
+      def enqueue_at(job, timestamp) # :nodoc:
         if JobWrapper.respond_to?(:perform_in)
           delay = timestamp - Time.current.to_f
           JobWrapper.perform_in delay, job.serialize
@@ -37,7 +37,7 @@ module ActiveJob
         end
       end
 
-      class JobWrapper #:nodoc:
+      class JobWrapper # :nodoc:
         include SuckerPunch::Job
 
         def perform(job_data)

data/lib/active_job/queue_adapters/test_adapter.rb

@@ -25,12 +25,12 @@ module ActiveJob
         @performed_jobs ||= []
       end
 
-      def enqueue(job) #:nodoc:
+      def enqueue(job) # :nodoc:
         job_data = job_to_hash(job)
         perform_or_enqueue(perform_enqueued_jobs && !filtered?(job), job, job_data)
       end
 
-      def enqueue_at(job, timestamp) #:nodoc:
+      def enqueue_at(job, timestamp) # :nodoc:
         job_data = job_to_hash(job, at: timestamp)
         perform_or_enqueue(perform_enqueued_at_jobs && !filtered?(job), job, job_data)
       end
@@ -41,6 +41,7 @@ module ActiveJob
             job_data[:job] = job.class
             job_data[:args] = job_data.fetch("arguments")
             job_data[:queue] = job_data.fetch("queue_name")
+            job_data[:priority] = job_data.fetch("priority")
           end.merge(extras)
         end
 

data/lib/active_job/queue_name.rb

@@ -45,7 +45,7 @@ module ActiveJob
         end
       end
 
-      def queue_name_from_part(part_name) #:nodoc:
+      def queue_name_from_part(part_name) # :nodoc:
         queue_name = part_name || default_queue_name
         name_parts = [queue_name_prefix.presence, queue_name]
         -name_parts.compact.join(queue_name_delimiter)

data/lib/active_job/railtie.rb

@@ -8,6 +8,7 @@ module ActiveJob
   class Railtie < Rails::Railtie # :nodoc:
     config.active_job = ActiveSupport::OrderedOptions.new
     config.active_job.custom_serializers = []
+    config.active_job.log_query_tags_around_perform = true
 
     initializer "active_job.logger" do
       ActiveSupport.on_load(:active_job) { self.logger = ::Rails.logger }
@@ -15,7 +16,7 @@ module ActiveJob
 
     initializer "active_job.custom_serializers" do |app|
       config.after_initialize do
-        custom_serializers = app.config.active_job.delete(:custom_serializers)
+        custom_serializers = app.config.active_job.custom_serializers
         ActiveJob::Serializers.add_serializers custom_serializers
       end
     end
@@ -25,6 +26,12 @@ module ActiveJob
       options.queue_adapter ||= :async
 
       ActiveSupport.on_load(:active_job) do
+        # Configs used in other initializers
+        options = options.except(
+          :log_query_tags_around_perform,
+          :custom_serializers
+        )
+
         options.each do  |k, v|
           k = "#{k}="
           send(k, v) if respond_to? k
@@ -49,5 +56,19 @@ module ActiveJob
         end
       end
     end
+
+    initializer "active_job.query_log_tags" do |app|
+      query_logs_tags_enabled = app.config.respond_to?(:active_record) &&
+        app.config.active_record.query_log_tags_enabled &&
+        app.config.active_job.log_query_tags_around_perform
+
+      if query_logs_tags_enabled
+        app.config.active_record.query_log_tags << :job
+
+        ActiveSupport.on_load(:active_record) do
+          ActiveRecord::QueryLogs.taggings[:job] = ->(context) { context[:job].class.name if context[:job] }
+        end
+      end
+    end
   end
 end

data/lib/active_job/serializers/module_serializer.rb

@@ -4,6 +4,7 @@ module ActiveJob
   module Serializers
     class ModuleSerializer < ObjectSerializer # :nodoc:
       def serialize(constant)
+        raise SerializationError, "Serializing an anonymous class is not supported" unless constant.name
         super("value" => constant.name)
       end
 

data/lib/active_job/serializers/range_serializer.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ActiveJob
+  module Serializers
+    class RangeSerializer < ObjectSerializer
+      KEYS = %w[begin end exclude_end].freeze
+
+      def serialize(range)
+        args = Arguments.serialize([range.begin, range.end, range.exclude_end?])
+        super(KEYS.zip(args).to_h)
+      end
+
+      def deserialize(hash)
+        klass.new(*Arguments.deserialize(hash.values_at(*KEYS)))
+      end
+
+      private
+        def klass
+          ::Range
+        end
+    end
+  end
+end

data/lib/active_job/serializers.rb

@@ -17,6 +17,7 @@ module ActiveJob
     autoload :TimeWithZoneSerializer
     autoload :TimeSerializer
     autoload :ModuleSerializer
+    autoload :RangeSerializer
 
     mattr_accessor :_additional_serializers
     self._additional_serializers = Set.new
@@ -61,6 +62,7 @@ module ActiveJob
       DateSerializer,
       TimeWithZoneSerializer,
       TimeSerializer,
-      ModuleSerializer
+      ModuleSerializer,
+      RangeSerializer
   end
 end

data/lib/active_job/test_helper.rb

@@ -109,7 +109,7 @@ module ActiveJob
     #     end
     #   end
     #
-    # +:only+ and +:except+ options accepts Class, Array of Class or Proc. When passed a Proc,
+    # +:only+ and +:except+ options accept Class, Array of Class or Proc. When passed a Proc,
     # a hash containing the job's class and it's argument are passed as argument.
     #
     # Asserts the number of times a job is enqueued to a specific queue by passing +:queue+ option.
@@ -124,7 +124,7 @@ module ActiveJob
       if block_given?
         original_jobs = enqueued_jobs_with(only: only, except: except, queue: queue)
 
-        assert_nothing_raised(&block)
+        _assert_nothing_raised_or_warn("assert_enqueued_jobs", &block)
 
         new_jobs = enqueued_jobs_with(only: only, except: except, queue: queue)
 
@@ -168,7 +168,7 @@ module ActiveJob
     #     end
     #   end
     #
-    # +:only+ and +:except+ options accepts Class, Array of Class or Proc. When passed a Proc,
+    # +:only+ and +:except+ options accept Class, Array of Class or Proc. When passed a Proc,
     # a hash containing the job's class and it's argument are passed as argument.
     #
     # Asserts that no jobs are enqueued to a specific queue by passing +:queue+ option
@@ -325,7 +325,7 @@ module ActiveJob
     #     end
     #   end
     #
-    # +:only+ and +:except+ options accepts Class, Array of Class or Proc. When passed a Proc,
+    # +:only+ and +:except+ options accept Class, Array of Class or Proc. When passed a Proc,
     # an instance of the job will be passed as argument.
     #
     # If the +:queue+ option is specified,
@@ -389,15 +389,15 @@ module ActiveJob
     #       MyJob.set(wait_until: Date.tomorrow.noon).perform_later
     #     end
     #   end
-    def assert_enqueued_with(job: nil, args: nil, at: nil, queue: nil, &block)
-      expected = { job: job, args: args, at: at, queue: queue }.compact
+    def assert_enqueued_with(job: nil, args: nil, at: nil, queue: nil, priority: nil, &block)
+      expected = { job: job, args: args, at: at, queue: queue, priority: priority }.compact
       expected_args = prepare_args_for_assertion(expected)
       potential_matches = []
 
       if block_given?
         original_enqueued_jobs = enqueued_jobs.dup
 
-        assert_nothing_raised(&block)
+        _assert_nothing_raised_or_warn("assert_enqueued_with", &block)
 
         jobs = enqueued_jobs - original_enqueued_jobs
       else
@@ -417,8 +417,20 @@ module ActiveJob
         end
       end
 
+      matching_class = potential_matches.select do |enqueued_job|
+        enqueued_job["job_class"] == job.to_s
+      end
+
       message = +"No enqueued job found with #{expected}"
-      message << "\n\nPotential matches: #{potential_matches.join("\n")}" if potential_matches.present?
+      if potential_matches.empty?
+        message << "\n\nNo jobs were enqueued"
+      elsif matching_class.empty?
+        message << "\n\nNo jobs of class #{expected[:job]} were enqueued, job classes enqueued: "
+        message << potential_matches.map { |job| job["job_class"] }.join(", ")
+      else
+        message << "\n\nPotential matches: #{matching_class.join("\n")}"
+      end
+
       assert matching_job, message
       instantiate_job(matching_job)
     end
@@ -479,8 +491,8 @@ module ActiveJob
     #       MyJob.set(wait_until: Date.tomorrow.noon).perform_later
     #     end
     #   end
-    def assert_performed_with(job: nil, args: nil, at: nil, queue: nil, &block)
-      expected = { job: job, args: args, at: at, queue: queue }.compact
+    def assert_performed_with(job: nil, args: nil, at: nil, queue: nil, priority: nil, &block)
+      expected = { job: job, args: args, at: at, queue: queue, priority: priority }.compact
       expected_args = prepare_args_for_assertion(expected)
       potential_matches = []
 
@@ -507,8 +519,20 @@ module ActiveJob
         end
       end
 
+      matching_class = potential_matches.select do |enqueued_job|
+        enqueued_job["job_class"] == job.to_s
+      end
+
       message = +"No performed job found with #{expected}"
-      message << "\n\nPotential matches: #{potential_matches.join("\n")}" if potential_matches.present?
+      if potential_matches.empty?
+        message << "\n\nNo jobs were performed"
+      elsif matching_class.empty?
+        message << "\n\nNo jobs of class #{expected[:job]} were performed, job classes performed: "
+        message << potential_matches.map { |job| job["job_class"] }.join(", ")
+      else
+        message << "\n\nPotential matches: #{matching_class.join("\n")}"
+      end
+
       assert matching_job, message
 
       instantiate_job(matching_job)
@@ -555,7 +579,7 @@ module ActiveJob
     #     assert_performed_jobs 1
     #   end
     #
-    # +:only+ and +:except+ options accepts Class, Array of Class or Proc. When passed a Proc,
+    # +:only+ and +:except+ options accept Class, Array of Class or Proc. When passed a Proc,
     # an instance of the job will be passed as argument.
     #
     # If the +:queue+ option is specified,
@@ -591,7 +615,7 @@ module ActiveJob
         queue_adapter.queue = queue
         queue_adapter.at = at
 
-        assert_nothing_raised(&block)
+        _assert_nothing_raised_or_warn("perform_enqueued_jobs", &block)
       ensure
         queue_adapter.perform_enqueued_jobs = old_perform_enqueued_jobs
         queue_adapter.perform_enqueued_at_jobs = old_perform_enqueued_at_jobs

data/lib/active_job/timezones.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module ActiveJob
-  module Timezones #:nodoc:
+  module Timezones # :nodoc:
     extend ActiveSupport::Concern
 
     included do

data/lib/active_job/translation.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module ActiveJob
-  module Translation #:nodoc:
+  module Translation # :nodoc:
     extend ActiveSupport::Concern
 
     included do

data/lib/active_job.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #--
-# Copyright (c) 2014-2020 David Heinemeier Hansson
+# Copyright (c) 2014-2021 David Heinemeier Hansson
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -37,4 +37,5 @@ module ActiveJob
   autoload :ConfiguredJob
   autoload :TestCase
   autoload :TestHelper
+  autoload :QueryTags
 end