activejob 7.0.8.7 → 7.2.2.1

data/lib/active_job/test_helper.rb

@@ -34,13 +34,18 @@ module ActiveJob
       end
     end
 
-    ActiveJob::Base.include(TestQueueAdapter)
+    ActiveSupport.on_load(:active_job) do
+      ActiveJob::Base.include(TestQueueAdapter)
+    end
 
     def before_setup # :nodoc:
-      test_adapter = queue_adapter_for_test
-
+      queue_adapter_specific_to_this_test_class = queue_adapter_for_test
       queue_adapter_changed_jobs.each do |klass|
-        klass.enable_test_adapter(test_adapter)
+        if queue_adapter_specific_to_this_test_class
+          klass.enable_test_adapter(queue_adapter_specific_to_this_test_class)
+        elsif klass._queue_adapter.nil?
+          klass.enable_test_adapter(ActiveJob::QueueAdapters::TestAdapter.new)
+        end
       end
 
       clear_enqueued_jobs
@@ -54,17 +59,11 @@ module ActiveJob
       queue_adapter_changed_jobs.each { |klass| klass.disable_test_adapter }
     end
 
-    # Specifies the queue adapter to use with all Active Job test helpers.
-    #
-    # Returns an instance of the queue adapter and defaults to
-    # ActiveJob::QueueAdapters::TestAdapter.
-    #
-    # Note: The adapter provided by this method must provide some additional
-    # methods from those expected of a standard ActiveJob::QueueAdapter
-    # in order to be used with the active job test helpers. Refer to
-    # ActiveJob::QueueAdapters::TestAdapter.
+    # Returns a queue adapter instance to use with all Active Job test helpers.
+    # By default, returns an instance of ActiveJob::QueueAdapters::TestAdapter.
+    # Override this method to specify a different adapter. The adapter must
+    # implement the same interface as ActiveJob::QueueAdapters::TestAdapter.
     def queue_adapter_for_test
-      ActiveJob::QueueAdapters::TestAdapter.new
     end
 
     # Asserts that the number of enqueued jobs matches the given number.
@@ -121,6 +120,8 @@ module ActiveJob
     #     end
     #   end
     def assert_enqueued_jobs(number, only: nil, except: nil, queue: nil, &block)
+      require_active_job_test_adapter!("assert_enqueued_jobs")
+
       if block_given?
         original_jobs = enqueued_jobs_with(only: only, except: except, queue: queue)
 
@@ -183,6 +184,8 @@ module ActiveJob
     #
     #   assert_enqueued_jobs 0, &block
     def assert_no_enqueued_jobs(only: nil, except: nil, queue: nil, &block)
+      require_active_job_test_adapter!("assert_no_enqueued_jobs")
+
       assert_enqueued_jobs 0, only: only, except: except, queue: queue, &block
     end
 
@@ -273,6 +276,8 @@ module ActiveJob
     #       end
     #     end
     def assert_performed_jobs(number, only: nil, except: nil, queue: nil, &block)
+      require_active_job_test_adapter!("assert_performed_jobs")
+
       if block_given?
         original_count = performed_jobs.size
 
@@ -341,6 +346,8 @@ module ActiveJob
     #
     #   assert_performed_jobs 0, &block
     def assert_no_performed_jobs(only: nil, except: nil, queue: nil, &block)
+      require_active_job_test_adapter!("assert_no_performed_jobs")
+
       assert_performed_jobs 0, only: only, except: except, queue: queue, &block
     end
 
@@ -354,6 +361,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.
     #
@@ -390,6 +404,8 @@ module ActiveJob
     #     end
     #   end
     def assert_enqueued_with(job: nil, args: nil, at: nil, queue: nil, priority: nil, &block)
+      require_active_job_test_adapter!("assert_enqueued_with")
+
       expected = { job: job, args: args, at: at, queue: queue, priority: priority }.compact
       expected_args = prepare_args_for_assertion(expected)
       potential_matches = []
@@ -492,6 +508,8 @@ module ActiveJob
     #     end
     #   end
     def assert_performed_with(job: nil, args: nil, at: nil, queue: nil, priority: nil, &block)
+      require_active_job_test_adapter!("assert_performed_with")
+
       expected = { job: job, args: args, at: at, queue: queue, priority: priority }.compact
       expected_args = prepare_args_for_assertion(expected)
       potential_matches = []
@@ -593,10 +611,19 @@ module ActiveJob
     #     assert_performed_jobs 1
     #   end
     #
-    # If the +:at+ option is specified, then only run jobs enqueued to run
-    # immediately or before the given time
+    # If the +:at+ option is specified, then only jobs that have been enqueued
+    # to run at or before the given time will be performed. This includes jobs
+    # that have been enqueued without a time.
+    #
+    # If queue_adapter_for_test is overridden to return a different adapter,
+    # +perform_enqueued_jobs+ will merely execute the block.
     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?
+      unless block_given?
+        require_active_job_test_adapter!("perform_enqueued_jobs (without a block)")
+        return flush_enqueued_jobs(only: only, except: except, queue: queue, at: at)
+      end
+
+      return _assert_nothing_raised_or_warn("perform_enqueued_jobs", &block) unless using_test_adapter?
 
       validate_option(only: only, except: except)
 
@@ -636,12 +663,22 @@ module ActiveJob
     end
 
     private
+      def require_active_job_test_adapter!(method)
+        unless using_test_adapter?
+          raise ArgumentError.new("#{method} requires the Active Job test adapter, you're using #{queue_adapter.class.name}.")
+        end
+      end
+
+      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 +731,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,46 @@
 require "active_support"
 require "active_support/rails"
 require "active_job/version"
+require "active_job/deprecator"
 require "global_id"
 
+# :markup: markdown
+# :include: ../README.md
 module ActiveJob
   extend ActiveSupport::Autoload
 
   autoload :Base
   autoload :QueueAdapters
-  autoload :Serializers
-  autoload :ConfiguredJob
+  autoload :Arguments
+  autoload :DeserializationError, "active_job/arguments"
+  autoload :SerializationError, "active_job/arguments"
+  autoload :EnqueueAfterTransactionCommit
+
+  eager_autoload do
+    autoload :Serializers
+    autoload :ConfiguredJob
+  end
+
   autoload :TestCase
   autoload :TestHelper
-  autoload :QueryTags
+
+  def self.use_big_decimal_serializer
+    ActiveJob.deprecator.warn <<-WARNING.squish
+      Rails.application.config.active_job.use_big_decimal_serializer is deprecated and will be removed in Rails 8.0.
+    WARNING
+  end
+
+  def self.use_big_decimal_serializer=(value)
+    ActiveJob.deprecator.warn <<-WARNING.squish
+      Rails.application.config.active_job.use_big_decimal_serializer is deprecated and will be removed in Rails 8.0.
+    WARNING
+  end
+
+  ##
+  # :singleton-method: verbose_enqueue_logs
+  #
+  # 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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activejob
 version: !ruby/object:Gem::Version
-  version: 7.0.8.7
+  version: 7.2.2.1
 platform: ruby
 authors:
 - David Heinemeier Hansson
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.0.8.7
+        version: 7.2.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.0.8.7
+        version: 7.2.2.1
 - !ruby/object:Gem::Dependency
   name: globalid
   requirement: !ruby/object:Gem::Requirement
@@ -53,6 +53,8 @@ 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/enqueue_after_transaction_commit.rb
 - lib/active_job/enqueuing.rb
 - lib/active_job/exceptions.rb
 - lib/active_job/execution.rb
@@ -62,11 +64,11 @@ files:
 - lib/active_job/logging.rb
 - lib/active_job/queue_adapter.rb
 - lib/active_job/queue_adapters.rb
+- lib/active_job/queue_adapters/abstract_adapter.rb
 - lib/active_job/queue_adapters/async_adapter.rb
 - 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 +79,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 +95,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 +104,10 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/rails/rails/issues
-  changelog_uri: https://github.com/rails/rails/blob/v7.0.8.7/activejob/CHANGELOG.md
-  documentation_uri: https://api.rubyonrails.org/v7.0.8.7/
+  changelog_uri: https://github.com/rails/rails/blob/v7.2.2.1/activejob/CHANGELOG.md
+  documentation_uri: https://api.rubyonrails.org/v7.2.2.1/
   mailing_list_uri: https://discuss.rubyonrails.org/c/rubyonrails-talk
-  source_code_uri: https://github.com/rails/rails/tree/v7.0.8.7/activejob
+  source_code_uri: https://github.com/rails/rails/tree/v7.2.2.1/activejob
   rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
@@ -113,7 +117,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

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