activejob 7.2.3 → 8.1.3

data/lib/active_job/serializers.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "set"
-
 module ActiveJob
   # = Active Job \Serializers
   #
@@ -21,16 +19,17 @@ module ActiveJob
     autoload :ModuleSerializer
     autoload :RangeSerializer
     autoload :BigDecimalSerializer
+    autoload :ActionControllerParametersSerializer
 
-    mattr_accessor :_additional_serializers
-    self._additional_serializers = Set.new
+    @serializers = Set.new
+    @serializers_index = {}
 
     class << self
       # Returns serialized representative of the passed object.
       # Will look up through all known serializers.
       # Raises ActiveJob::SerializationError if it can't find a proper serializer.
       def serialize(argument)
-        serializer = serializers.detect { |s| s.serialize?(argument) }
+        serializer = @serializers_index[argument.class] || serializers.find { |s| s.serialize?(argument) }
         raise SerializationError.new("Unsupported argument type: #{argument.class.name}") unless serializer
         serializer.serialize(argument)
       end
@@ -39,7 +38,7 @@ module ActiveJob
       # Will look up through all known serializers.
       # If no serializer found will raise <tt>ArgumentError</tt>.
       def deserialize(argument)
-        serializer_name = argument[Arguments::OBJECT_SERIALIZER_KEY]
+        serializer_name = argument[OBJECT_SERIALIZER_KEY]
         raise ArgumentError, "Serializer name is not present in the argument: #{argument.inspect}" unless serializer_name
 
         serializer = serializer_name.safe_constantize
@@ -49,24 +48,69 @@ module ActiveJob
       end
 
       # Returns list of known serializers.
-      def serializers
-        self._additional_serializers
+      attr_reader :serializers
+
+      def serializers=(serializers)
+        @serializers_index.clear
+        @serializers = Set.new
+        add_new_serializers(serializers)
       end
 
       # Adds new serializers to a list of known serializers.
       def add_serializers(*new_serializers)
-        self._additional_serializers += new_serializers.flatten
+        new_serializers = new_serializers.flatten
+        add_new_serializers(new_serializers)
       end
+
+      private
+        def add_new_serializers(new_serializers)
+          new_serializers.map! do |s|
+            if s.is_a?(Class) && s < ObjectSerializer
+              s.instance
+            else
+              s
+            end
+          end
+
+          @serializers += new_serializers
+          index_serializers(new_serializers)
+          @serializers
+        end
+
+        def index_serializers(new_serializers)
+          new_serializers.each do |s|
+            if s.respond_to?(:klass)
+              @serializers_index[s.klass] = s
+            elsif s.respond_to?(:klass, true)
+              klass = s.send(:klass)
+              ActiveJob.deprecator.warn(<<~MSG.squish)
+                #{s.class.name}#klass method should be public.
+                This will raise an error in Rails 8.2.
+              MSG
+              @serializers_index[klass] = s
+            else
+              ActiveJob.deprecator.warn(
+                <<~MSG.squish
+                  #{s.class.name} should implement a public #klass method.
+                  This will raise an error in Rails 8.2.
+                MSG
+              )
+            end
+          end
+        end
     end
 
-    add_serializers SymbolSerializer,
-      DurationSerializer,
-      DateTimeSerializer,
-      DateSerializer,
-      TimeWithZoneSerializer,
-      TimeSerializer,
-      ModuleSerializer,
-      RangeSerializer,
-      BigDecimalSerializer
+    # :nodoc:
+    OBJECT_SERIALIZER_KEY = "_aj_serialized"
+
+    add_serializers SymbolSerializer.instance,
+      DurationSerializer.instance,
+      DateTimeSerializer.instance,
+      DateSerializer.instance,
+      TimeWithZoneSerializer.instance,
+      TimeSerializer.instance,
+      ModuleSerializer.instance,
+      RangeSerializer.instance,
+      BigDecimalSerializer.instance
   end
 end

data/lib/active_job/structured_event_subscriber.rb

@@ -0,0 +1,220 @@
+# frozen_string_literal: true
+
+require "active_support/structured_event_subscriber"
+
+module ActiveJob
+  class StructuredEventSubscriber < ActiveSupport::StructuredEventSubscriber # :nodoc:
+    def enqueue(event)
+      job = event.payload[:job]
+      adapter = event.payload[:adapter]
+      exception = event.payload[:exception_object] || job.enqueue_error
+      payload = {
+        job_class: job.class.name,
+        job_id: job.job_id,
+        queue: job.queue_name,
+        adapter: ActiveJob.adapter_name(adapter),
+        aborted: event.payload[:aborted],
+      }
+
+      if exception
+        payload[:exception_class] = exception.class.name
+        payload[:exception_message] = exception.message
+      end
+
+      if job.class.log_arguments?
+        payload[:arguments] = job.arguments
+      end
+
+      emit_event("active_job.enqueued", payload)
+    end
+
+    def enqueue_at(event)
+      job = event.payload[:job]
+      adapter = event.payload[:adapter]
+      exception = event.payload[:exception_object] || job.enqueue_error
+      payload = {
+        job_class: job.class.name,
+        job_id: job.job_id,
+        queue: job.queue_name,
+        scheduled_at: job.scheduled_at,
+        adapter: ActiveJob.adapter_name(adapter),
+        aborted: event.payload[:aborted],
+      }
+
+      if exception
+        payload[:exception_class] = exception.class.name
+        payload[:exception_message] = exception.message
+      end
+
+      if job.class.log_arguments?
+        payload[:arguments] = job.arguments
+      end
+
+      emit_event("active_job.enqueued_at", payload)
+    end
+
+    def enqueue_all(event)
+      jobs = event.payload[:jobs]
+      adapter = event.payload[:adapter]
+      enqueued_count = event.payload[:enqueued_count].to_i
+      failed_count = jobs.size - enqueued_count
+
+      emit_event("active_job.bulk_enqueued",
+        adapter: ActiveJob.adapter_name(adapter),
+        job_count: jobs.size,
+        enqueued_count: enqueued_count,
+        failed_enqueue_count: failed_count,
+        enqueued_classes: jobs.filter_map do |job|
+          job.class.name if jobs.count == enqueued_count || job.successfully_enqueued?
+        end.tally
+      )
+    end
+
+    def perform_start(event)
+      job = event.payload[:job]
+      payload = {
+        job_class: job.class.name,
+        job_id: job.job_id,
+        queue: job.queue_name,
+        enqueued_at: job.enqueued_at&.utc&.iso8601(9),
+      }
+      if job.class.log_arguments?
+        payload[:arguments] = job.arguments
+      end
+      emit_event("active_job.started", payload)
+    end
+
+    def perform(event)
+      job = event.payload[:job]
+      exception = event.payload[:exception_object]
+      adapter = event.payload[:adapter]
+      payload = {
+        job_class: job.class.name,
+        job_id: job.job_id,
+        queue: job.queue_name,
+        adapter: ActiveJob.adapter_name(adapter),
+        aborted: event.payload[:aborted],
+        duration: event.duration.round(2),
+      }
+
+      if exception
+        payload[:exception_class] = exception.class.name
+        payload[:exception_message] = exception.message
+        payload[:exception_backtrace] = exception.backtrace
+      end
+
+      emit_event("active_job.completed", payload)
+    end
+
+    def enqueue_retry(event)
+      job = event.payload[:job]
+      exception = event.payload[:error]
+      wait = event.payload[:wait]
+
+      emit_event("active_job.retry_scheduled",
+        job_class: job.class.name,
+        job_id: job.job_id,
+        executions: job.executions,
+        wait_seconds: wait.to_i,
+        exception_class: exception&.class&.name,
+        exception_message: exception&.message
+      )
+    end
+
+    def retry_stopped(event)
+      job = event.payload[:job]
+      exception = event.payload[:error]
+
+      emit_event("active_job.retry_stopped",
+        job_class: job.class.name,
+        job_id: job.job_id,
+        executions: job.executions,
+        exception_class: exception.class.name,
+        exception_message: exception.message
+      )
+    end
+
+    def discard(event)
+      job = event.payload[:job]
+      exception = event.payload[:error]
+
+      emit_event("active_job.discarded",
+        job_class: job.class.name,
+        job_id: job.job_id,
+        exception_class: exception.class.name,
+        exception_message: exception.message
+      )
+    end
+
+    def interrupt(event)
+      job = event.payload[:job]
+      description = event.payload[:description]
+      reason = event.payload[:reason]
+
+      emit_event("active_job.interrupt",
+        job_class: job.class.name,
+        job_id: job.job_id,
+        description: description,
+        reason: reason,
+      )
+    end
+
+    def resume(event)
+      job = event.payload[:job]
+      description = event.payload[:description]
+
+      emit_event("active_job.resume",
+        job_class: job.class.name,
+        job_id: job.job_id,
+        description: description,
+      )
+    end
+
+    def step_skipped(event)
+      job = event.payload[:job]
+      step = event.payload[:step]
+
+      emit_event("active_job.step_skipped",
+        job_class: job.class.name,
+        job_id: job.job_id,
+        step: step.name,
+      )
+    end
+
+    def step_started(event)
+      job = event.payload[:job]
+      step = event.payload[:step]
+
+      emit_event("active_job.step_started",
+        job_class: job.class.name,
+        job_id: job.job_id,
+        step: step.name,
+        cursor: step.cursor,
+        resumed: step.resumed?,
+      )
+    end
+
+    def step(event)
+      job = event.payload[:job]
+      step = event.payload[:step]
+      exception = event.payload[:exception_object]
+      payload = {
+        job_class: job.class.name,
+        job_id: job.job_id,
+        step: step.name,
+        cursor: step.cursor,
+        interrupted: event.payload[:interrupted],
+        duration: event.duration.round(2),
+      }
+
+      if exception
+        payload[:exception_class] = exception.class.name
+        payload[:exception_message] = exception.message
+      end
+
+      emit_event("active_job.step", payload)
+    end
+  end
+end
+
+ActiveJob::StructuredEventSubscriber.attach_to :active_job

data/lib/active_job.rb

@@ -39,9 +39,12 @@ module ActiveJob
   autoload :Arguments
   autoload :DeserializationError, "active_job/arguments"
   autoload :SerializationError, "active_job/arguments"
+  autoload :UnknownJobClassError, "active_job/core"
   autoload :EnqueueAfterTransactionCommit
 
   eager_autoload do
+    autoload :Continuable
+    autoload :Continuation
     autoload :Serializers
     autoload :ConfiguredJob
   end
@@ -49,18 +52,6 @@ module ActiveJob
   autoload :TestCase
   autoload :TestHelper
 
-  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
   #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activejob
 version: !ruby/object:Gem::Version
-  version: 7.2.3
+  version: 8.1.3
 platform: ruby
 authors:
 - David Heinemeier Hansson
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.2.3
+        version: 8.1.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.2.3
+        version: 8.1.3
 - !ruby/object:Gem::Dependency
   name: globalid
   requirement: !ruby/object:Gem::Requirement
@@ -51,12 +51,18 @@ files:
 - lib/active_job/base.rb
 - lib/active_job/callbacks.rb
 - lib/active_job/configured_job.rb
+- lib/active_job/continuable.rb
+- lib/active_job/continuation.rb
+- lib/active_job/continuation/step.rb
+- lib/active_job/continuation/test_helper.rb
+- lib/active_job/continuation/validation.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
+- lib/active_job/execution_state.rb
 - lib/active_job/gem_version.rb
 - lib/active_job/instrumentation.rb
 - lib/active_job/log_subscriber.rb
@@ -72,12 +78,12 @@ files:
 - lib/active_job/queue_adapters/resque_adapter.rb
 - lib/active_job/queue_adapters/sidekiq_adapter.rb
 - lib/active_job/queue_adapters/sneakers_adapter.rb
-- lib/active_job/queue_adapters/sucker_punch_adapter.rb
 - lib/active_job/queue_adapters/test_adapter.rb
 - lib/active_job/queue_name.rb
 - lib/active_job/queue_priority.rb
 - lib/active_job/railtie.rb
 - lib/active_job/serializers.rb
+- lib/active_job/serializers/action_controller_parameters_serializer.rb
 - lib/active_job/serializers/big_decimal_serializer.rb
 - lib/active_job/serializers/date_serializer.rb
 - lib/active_job/serializers/date_time_serializer.rb
@@ -89,10 +95,9 @@ files:
 - lib/active_job/serializers/time_object_serializer.rb
 - lib/active_job/serializers/time_serializer.rb
 - lib/active_job/serializers/time_with_zone_serializer.rb
+- lib/active_job/structured_event_subscriber.rb
 - lib/active_job/test_case.rb
 - lib/active_job/test_helper.rb
-- 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
@@ -103,10 +108,10 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/rails/rails/issues
-  changelog_uri: https://github.com/rails/rails/blob/v7.2.3/activejob/CHANGELOG.md
-  documentation_uri: https://api.rubyonrails.org/v7.2.3/
+  changelog_uri: https://github.com/rails/rails/blob/v8.1.3/activejob/CHANGELOG.md
+  documentation_uri: https://api.rubyonrails.org/v8.1.3/
   mailing_list_uri: https://discuss.rubyonrails.org/c/rubyonrails-talk
-  source_code_uri: https://github.com/rails/rails/tree/v7.2.3/activejob
+  source_code_uri: https://github.com/rails/rails/tree/v8.1.3/activejob
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
@@ -115,14 +120,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Job framework with pluggable queues.
 test_files: []

data/lib/active_job/queue_adapters/sucker_punch_adapter.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-require "sucker_punch"
-
-module ActiveJob
-  module QueueAdapters
-    # = Sucker Punch adapter for Active Job
-    #
-    # Sucker Punch is a single-process Ruby asynchronous processing library.
-    # This reduces the cost of hosting on a service like Heroku along
-    # with the memory footprint of having to maintain additional jobs if
-    # hosting on a dedicated server. All queues can run within a
-    # single application (e.g. \Rails, Sinatra, etc.) process.
-    #
-    # Read more about Sucker Punch {here}[https://github.com/brandonhilkert/sucker_punch].
-    #
-    # To use Sucker Punch set the queue_adapter config to +:sucker_punch+.
-    #
-    #   Rails.application.config.active_job.queue_adapter = :sucker_punch
-    class SuckerPunchAdapter < AbstractAdapter
-      def enqueue(job) # :nodoc:
-        if JobWrapper.respond_to?(:perform_async)
-          # sucker_punch 2.0 API
-          JobWrapper.perform_async job.serialize
-        else
-          # sucker_punch 1.0 API
-          JobWrapper.new.async.perform job.serialize
-        end
-      end
-
-      def enqueue_at(job, timestamp) # :nodoc:
-        if JobWrapper.respond_to?(:perform_in)
-          delay = timestamp - Time.current.to_f
-          JobWrapper.perform_in delay, job.serialize
-        else
-          raise NotImplementedError, "sucker_punch 1.0 does not support `enqueue_at`. Please upgrade to version ~> 2.0.0 to enable this behavior."
-        end
-      end
-
-      class JobWrapper # :nodoc:
-        include SuckerPunch::Job
-
-        def perform(job_data)
-          Base.execute job_data
-        end
-      end
-    end
-  end
-end

data/lib/active_job/timezones.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module ActiveJob
-  module Timezones # :nodoc:
-    extend ActiveSupport::Concern
-
-    included do
-      around_perform do |job, block|
-        Time.use_zone(job.timezone, &block)
-      end
-    end
-  end
-end

data/lib/active_job/translation.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module ActiveJob
-  module Translation # :nodoc:
-    extend ActiveSupport::Concern
-
-    included do
-      around_perform do |job, block|
-        I18n.with_locale(job.locale, &block)
-      end
-    end
-  end
-end