activejob 7.0.8 → 7.1.0

data/lib/active_job/queue_priority.rb

@@ -18,7 +18,24 @@ module ActiveJob
       #     end
       #   end
       #
-      # Specify either an argument or a block.
+      # Can be given a block that will evaluate in the context of the job
+      # so that a dynamic priority can be applied:
+      #
+      #   class PublishToFeedJob < ApplicationJob
+      #     queue_with_priority do
+      #       post = self.arguments.first
+      #
+      #       if post.paid?
+      #         10
+      #       else
+      #         50
+      #       end
+      #     end
+      #
+      #     def perform(post)
+      #       post.to_feed!
+      #     end
+      #   end
       def queue_with_priority(priority = nil, &block)
         if block_given?
           self.priority = block

data/lib/active_job/railtie.rb

@@ -10,6 +10,10 @@ module ActiveJob
     config.active_job.custom_serializers = []
     config.active_job.log_query_tags_around_perform = true
 
+    initializer "active_job.deprecator", before: :load_environment_config do |app|
+      app.deprecators[:active_job] = ActiveJob.deprecator
+    end
+
     initializer "active_job.logger" do
       ActiveSupport.on_load(:active_job) { self.logger = ::Rails.logger }
     end
@@ -25,6 +29,15 @@ module ActiveJob
       options = app.config.active_job
       options.queue_adapter ||= :async
 
+      config.after_initialize do
+        options.each do |k, v|
+          k = "#{k}="
+          if ActiveJob.respond_to?(k)
+            ActiveJob.send(k, v)
+          end
+        end
+      end
+
       ActiveSupport.on_load(:active_job) do
         # Configs used in other initializers
         options = options.except(
@@ -32,19 +45,19 @@ module ActiveJob
           :custom_serializers
         )
 
-        options.each do  |k, v|
+        options.each do |k, v|
           k = "#{k}="
-          send(k, v) if respond_to? k
+          if ActiveJob.respond_to?(k)
+            ActiveJob.send(k, v)
+          elsif respond_to? k
+            send(k, v)
+          end
         end
       end
 
       ActiveSupport.on_load(:action_dispatch_integration_test) do
         include ActiveJob::TestHelper
       end
-
-      ActiveSupport.on_load(:active_record) do
-        self.destroy_association_async_job = ActiveRecord::DestroyAssociationAsyncJob
-      end
     end
 
     initializer "active_job.set_reloader_hook" do |app|
@@ -70,5 +83,11 @@ module ActiveJob
         end
       end
     end
+
+    initializer "active_job.backtrace_cleaner" do
+      ActiveSupport.on_load(:active_job) do
+        LogSubscriber.backtrace_cleaner = ::Rails.backtrace_cleaner
+      end
+    end
   end
 end

data/lib/active_job/serializers/big_decimal_serializer.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "bigdecimal"
+
+module ActiveJob
+  module Serializers
+    class BigDecimalSerializer < ObjectSerializer # :nodoc:
+      def serialize(big_decimal)
+        super("value" => big_decimal.to_s)
+      end
+
+      def deserialize(hash)
+        BigDecimal(hash["value"])
+      end
+
+      private
+        def klass
+          BigDecimal
+        end
+    end
+  end
+end

data/lib/active_job/serializers/duration_serializer.rb

@@ -4,14 +4,16 @@ module ActiveJob
   module Serializers
     class DurationSerializer < ObjectSerializer # :nodoc:
       def serialize(duration)
+        # Ideally duration.parts would be wrapped in an array before passing to Arguments.serialize,
+        # but we continue passing the bare hash for backwards compatibility:
         super("value" => duration.value, "parts" => Arguments.serialize(duration.parts))
       end
 
       def deserialize(hash)
         value = hash["value"]
         parts = Arguments.deserialize(hash["parts"])
-
-        klass.new(value, parts)
+        # `parts` is originally a hash, but will have been flattened to an array by Arguments.serialize
+        klass.new(value, parts.to_h)
       end
 
       private

data/lib/active_job/serializers.rb

@@ -3,7 +3,9 @@
 require "set"
 
 module ActiveJob
-  # The <tt>ActiveJob::Serializers</tt> module is used to store a list of known serializers
+  # = Active Job \Serializers
+  #
+  # The +ActiveJob::Serializers+ module is used to store a list of known serializers
   # and to add new ones. It also has helpers to serialize/deserialize objects.
   module Serializers # :nodoc:
     extend ActiveSupport::Autoload
@@ -18,6 +20,7 @@ module ActiveJob
     autoload :TimeSerializer
     autoload :ModuleSerializer
     autoload :RangeSerializer
+    autoload :BigDecimalSerializer
 
     mattr_accessor :_additional_serializers
     self._additional_serializers = Set.new
@@ -25,7 +28,7 @@ module ActiveJob
     class << self
       # Returns serialized representative of the passed object.
       # Will look up through all known serializers.
-      # Raises <tt>ActiveJob::SerializationError</tt> if it can't find a proper serializer.
+      # Raises ActiveJob::SerializationError if it can't find a proper serializer.
       def serialize(argument)
         serializer = serializers.detect { |s| s.serialize?(argument) }
         raise SerializationError.new("Unsupported argument type: #{argument.class.name}") unless serializer
@@ -63,6 +66,7 @@ module ActiveJob
       TimeWithZoneSerializer,
       TimeSerializer,
       ModuleSerializer,
-      RangeSerializer
+      RangeSerializer,
+      BigDecimalSerializer
   end
 end

data/lib/active_job/test_helper.rb

@@ -354,6 +354,13 @@ module ActiveJob
     #     assert_enqueued_with(at: Date.tomorrow.noon, queue: "my_queue")
     #   end
     #
+    # For keyword arguments, specify them as a hash inside an array:
+    #
+    #   def test_assert_enqueued_with_keyword_arguments
+    #     MyJob.perform_later(arg1: 'value1', arg2: 'value2')
+    #     assert_enqueued_with(job: MyJob, args: [{ arg1: 'value1', arg2: 'value2' }])
+    #   end
+    #
     # The given arguments may also be specified as matcher procs that return a
     # boolean value indicating whether a job's attribute meets certain criteria.
     #
@@ -595,9 +602,14 @@ module ActiveJob
     #
     # If the +:at+ option is specified, then only run jobs enqueued to run
     # immediately or before the given time
+    #
+    # If an adapter other than the test adapter is in use, this method just yields.
+    # See queue_adapter_for_test for more information.
     def perform_enqueued_jobs(only: nil, except: nil, queue: nil, at: nil, &block)
       return flush_enqueued_jobs(only: only, except: except, queue: queue, at: at) unless block_given?
 
+      return _assert_nothing_raised_or_warn("perform_enqueued_jobs", &block) unless using_test_adapter?
+
       validate_option(only: only, except: except)
 
       old_perform_enqueued_jobs = queue_adapter.perform_enqueued_jobs
@@ -636,12 +648,16 @@ module ActiveJob
     end
 
     private
+      def using_test_adapter?
+        queue_adapter.is_a?(ActiveJob::QueueAdapters::TestAdapter)
+      end
+
       def clear_enqueued_jobs
-        enqueued_jobs.clear
+        enqueued_jobs.clear if using_test_adapter?
       end
 
       def clear_performed_jobs
-        performed_jobs.clear
+        performed_jobs.clear if using_test_adapter?
       end
 
       def jobs_with(jobs, only: nil, except: nil, queue: nil, at: nil)
@@ -694,6 +710,10 @@ module ActiveJob
 
       def prepare_args_for_assertion(args)
         args.dup.tap do |arguments|
+          if arguments[:queue].is_a?(Symbol)
+            arguments[:queue] = arguments[:queue].to_s
+          end
+
           if arguments[:at].acts_like?(:time)
             at_range = arguments[:at] - 1..arguments[:at] + 1
             arguments[:at] = ->(at) { at_range.cover?(at) }

data/lib/active_job/version.rb

@@ -3,7 +3,7 @@
 require_relative "gem_version"
 
 module ActiveJob
-  # Returns the currently loaded version of Active Job as a <tt>Gem::Version</tt>.
+  # Returns the currently loaded version of Active Job as a +Gem::Version+.
   def self.version
     gem_version
   end

data/lib/active_job.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #--
-# Copyright (c) 2014-2022 David Heinemeier Hansson
+# Copyright (c) David Heinemeier Hansson
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -26,16 +26,38 @@
 require "active_support"
 require "active_support/rails"
 require "active_job/version"
+require "active_job/deprecator"
 require "global_id"
 
+# :markup: markdown
+# :include: activejob/README.md
 module ActiveJob
   extend ActiveSupport::Autoload
 
   autoload :Base
   autoload :QueueAdapters
-  autoload :Serializers
-  autoload :ConfiguredJob
+
+  eager_autoload do
+    autoload :Serializers
+    autoload :ConfiguredJob
+  end
+
   autoload :TestCase
   autoload :TestHelper
-  autoload :QueryTags
+
+  ##
+  # :singleton-method:
+  # If false, \Rails will preserve the legacy serialization of BigDecimal job arguments as Strings.
+  # If true, \Rails will use the new BigDecimalSerializer to (de)serialize BigDecimal losslessly.
+  # Legacy serialization will be removed in \Rails 7.2, along with this config.
+  singleton_class.attr_accessor :use_big_decimal_serializer
+  self.use_big_decimal_serializer = false
+
+  ##
+  # :singleton-method:
+  #
+  # Specifies if the methods calling background job enqueue should be logged below
+  # their relevant enqueue log lines. Defaults to false.
+  singleton_class.attr_accessor :verbose_enqueue_logs
+  self.verbose_enqueue_logs = false
 end

data/lib/rails/generators/job/USAGE

@@ -0,0 +1,19 @@
+Description:
+    Generates a new job. Pass the job name, either CamelCased or
+    under_scored, with or without the job postfix.
+
+Examples:
+    `bin/rails generate job checkout`
+
+      Creates the following files:
+
+        Job:   app/jobs/checkout_job.rb
+        Test:  test/jobs/checkout_job_test.rb
+
+    `bin/rails generate job send_sms --queue=sms`
+
+      Creates a job and test with a custom sms queue.
+
+    `bin/rails generate job process_payment --parent=payment_job`
+
+      Creates a job and test with a `PaymentJob` parent class.

data/lib/rails/generators/job/job_generator.rb

@@ -5,10 +5,10 @@ require "rails/generators/named_base"
 module Rails # :nodoc:
   module Generators # :nodoc:
     class JobGenerator < Rails::Generators::NamedBase # :nodoc:
-      desc "This generator creates an active job file at app/jobs"
-
       class_option :queue, type: :string, default: "default", desc: "The queue name for the generated job"
 
+      class_option :parent, type: :string, default: "ApplicationJob", desc: "The parent class for the generated job"
+
       check_class_collision suffix: "Job"
 
       hook_for :test_framework
@@ -28,6 +28,10 @@ module Rails # :nodoc:
       end
 
       private
+        def parent_class_name
+          options[:parent]
+        end
+
         def file_name
           @_file_name ||= super.sub(/_job\z/i, "")
         end

data/lib/rails/generators/job/templates/job.rb.tt

@@ -1,5 +1,5 @@
 <% module_namespacing do -%>
-class <%= class_name %>Job < ApplicationJob
+class <%= class_name %>Job < <%= parent_class_name.classify %>
   queue_as :<%= options[:queue] %>
 
   def perform(*args)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activejob
 version: !ruby/object:Gem::Version
-  version: 7.0.8
+  version: 7.1.0
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-09 00:00:00.000000000 Z
+date: 2023-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.0.8
+        version: 7.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.0.8
+        version: 7.1.0
 - !ruby/object:Gem::Dependency
   name: globalid
   requirement: !ruby/object:Gem::Requirement
@@ -53,6 +53,7 @@ files:
 - lib/active_job/callbacks.rb
 - lib/active_job/configured_job.rb
 - lib/active_job/core.rb
+- lib/active_job/deprecator.rb
 - lib/active_job/enqueuing.rb
 - lib/active_job/exceptions.rb
 - lib/active_job/execution.rb
@@ -66,7 +67,6 @@ files:
 - lib/active_job/queue_adapters/backburner_adapter.rb
 - lib/active_job/queue_adapters/delayed_job_adapter.rb
 - lib/active_job/queue_adapters/inline_adapter.rb
-- lib/active_job/queue_adapters/que_adapter.rb
 - lib/active_job/queue_adapters/queue_classic_adapter.rb
 - lib/active_job/queue_adapters/resque_adapter.rb
 - lib/active_job/queue_adapters/sidekiq_adapter.rb
@@ -77,6 +77,7 @@ files:
 - lib/active_job/queue_priority.rb
 - lib/active_job/railtie.rb
 - lib/active_job/serializers.rb
+- lib/active_job/serializers/big_decimal_serializer.rb
 - lib/active_job/serializers/date_serializer.rb
 - lib/active_job/serializers/date_time_serializer.rb
 - lib/active_job/serializers/duration_serializer.rb
@@ -92,6 +93,7 @@ files:
 - lib/active_job/timezones.rb
 - lib/active_job/translation.rb
 - lib/active_job/version.rb
+- lib/rails/generators/job/USAGE
 - lib/rails/generators/job/job_generator.rb
 - lib/rails/generators/job/templates/application_job.rb.tt
 - lib/rails/generators/job/templates/job.rb.tt
@@ -100,10 +102,10 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/rails/rails/issues
-  changelog_uri: https://github.com/rails/rails/blob/v7.0.8/activejob/CHANGELOG.md
-  documentation_uri: https://api.rubyonrails.org/v7.0.8/
+  changelog_uri: https://github.com/rails/rails/blob/v7.1.0/activejob/CHANGELOG.md
+  documentation_uri: https://api.rubyonrails.org/v7.1.0/
   mailing_list_uri: https://discuss.rubyonrails.org/c/rubyonrails-talk
-  source_code_uri: https://github.com/rails/rails/tree/v7.0.8/activejob
+  source_code_uri: https://github.com/rails/rails/tree/v7.1.0/activejob
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []

data/lib/active_job/queue_adapters/que_adapter.rb

@@ -1,61 +0,0 @@
-# frozen_string_literal: true
-
-require "que"
-
-module ActiveJob
-  module QueueAdapters
-    # == Que adapter for Active Job
-    #
-    # Que is a high-performance alternative to DelayedJob or QueueClassic that
-    # improves the reliability of your application by protecting your jobs with
-    # the same ACID guarantees as the rest of your data. Que is a queue for
-    # Ruby and PostgreSQL that manages jobs using advisory locks.
-    #
-    # Read more about Que {here}[https://github.com/chanks/que].
-    #
-    # To use Que set the queue_adapter config to +:que+.
-    #
-    #   Rails.application.config.active_job.queue_adapter = :que
-    class QueAdapter
-      def enqueue(job) # :nodoc:
-        job_options = { priority: job.priority, queue: job.queue_name }
-        que_job = nil
-
-        if require_job_options_kwarg?
-          que_job = JobWrapper.enqueue job.serialize, job_options: job_options
-        else
-          que_job = JobWrapper.enqueue job.serialize, **job_options
-        end
-
-        job.provider_job_id = que_job.attrs["job_id"]
-        que_job
-      end
-
-      def enqueue_at(job, timestamp) # :nodoc:
-        job_options = { priority: job.priority, queue: job.queue_name, run_at: Time.at(timestamp) }
-        que_job = nil
-
-        if require_job_options_kwarg?
-          que_job = JobWrapper.enqueue job.serialize, job_options: job_options
-        else
-          que_job = JobWrapper.enqueue job.serialize, **job_options
-        end
-
-        job.provider_job_id = que_job.attrs["job_id"]
-        que_job
-      end
-
-      private
-        def require_job_options_kwarg?
-          @require_job_options_kwarg ||=
-            JobWrapper.method(:enqueue).parameters.any? { |ptype, pname| ptype == :key && pname == :job_options }
-        end
-
-        class JobWrapper < Que::Job # :nodoc:
-          def run(job_data)
-            Base.execute job_data
-          end
-        end
-    end
-  end
-end