activejob 8.1.0.beta1 → 8.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9a034077d88450ca67c9f9921d2b9678d506724adeb387742be2be30b30b038
-  data.tar.gz: 6efdff593dfb0f7d0773a6a8419c084919346d1dc15c44619e58f5009886ad3b
+  metadata.gz: bc270930c258d16e62b3f01ee4ed3591e91b680ddea4c43ddba1870206bda41f
+  data.tar.gz: 6bc1d66fb46babd36a3959754021ddbc6d115fbeef7e78d025b4880e48c63db1
 SHA512:
-  metadata.gz: 7a6be4dfbb96daba9f49b695a5aa568420a446cb303bf3a9ba6083a1d3d4c3bb7663fb428107a2f0b3f954a2ba4b4c5781dad015f4d56b97201096d75ab4bf35
-  data.tar.gz: 4b01822ccd36668f128a6754b8ad9ea06d7874b2f3584c7fe44e54948df92552c6e93609ab7f2a688a20c23116078b0a84711ac1c851308657e438f0892ceb32
+  metadata.gz: aed3444d15f38a03c9df4321d898958c8c4611c427dd4ad6ada5d14804db2dced96aa035d98e3d777c0280d1c7c0433a1888cb930ff55692882eb1dbecfb729e
+  data.tar.gz: 47396127fb20f53dc5ec782619913145fa911128b04ab3e8f80dc52d4b3071634653f49c6271f86a1fe1ccf58595d1dd6a7fc0453d37eb2a3a9a250fa601ded8

data/CHANGELOG.md

@@ -1,4 +1,20 @@
-## Rails 8.1.0.beta1 (September 04, 2025) ##
+## Rails 8.1.0 (October 22, 2025) ##
+
+*   Add structured events for Active Job:
+    - `active_job.enqueued`
+    - `active_job.bulk_enqueued`
+    - `active_job.started`
+    - `active_job.completed`
+    - `active_job.retry_scheduled`
+    - `active_job.retry_stopped`
+    - `active_job.discarded`
+    - `active_job.interrupt`
+    - `active_job.resume`
+    - `active_job.step_skipped`
+    - `active_job.step_started`
+    - `active_job.step`
+
+    *Adrianna Chang*
 
 *   Deprecate built-in `sidekiq` adapter.
 

data/lib/active_job/arguments.rb

@@ -31,7 +31,11 @@ module ActiveJob
     # serialized without mutation are returned as-is. Arrays/Hashes are
     # serialized element by element. All other types are serialized using
     # GlobalID.
-    def serialize(argument)
+    def serialize(arguments)
+      arguments.map { |argument| serialize_argument(argument) }
+    end
+
+    def serialize_argument(argument) # :nodoc:
       case argument
       when nil, true, false, Integer, Float # Types that can hardly be subclassed
         argument
@@ -50,7 +54,7 @@ module ActiveJob
       when GlobalID::Identification
         convert_to_global_id_hash(argument)
       when Array
-        argument.map { |arg| serialize(arg) }
+        argument.map { |arg| serialize_argument(arg) }
       when ActiveSupport::HashWithIndifferentAccess
         serialize_indifferent_hash(argument)
       when Hash
@@ -137,7 +141,7 @@ module ActiveJob
 
       def serialize_hash(argument)
         argument.each_with_object({}) do |(key, value), hash|
-          hash[serialize_hash_key(key)] = serialize(value)
+          hash[serialize_hash_key(key)] = serialize_argument(value)
         end
       end
 

data/lib/active_job/base.rb

@@ -9,6 +9,7 @@ require "active_job/execution"
 require "active_job/callbacks"
 require "active_job/exceptions"
 require "active_job/log_subscriber"
+require "active_job/structured_event_subscriber"
 require "active_job/logging"
 require "active_job/instrumentation"
 require "active_job/execution_state"

data/lib/active_job/core.rb

@@ -167,8 +167,8 @@ module ActiveJob
       self.exception_executions = job_data["exception_executions"]
       self.locale               = job_data["locale"] || I18n.locale.to_s
       self.timezone             = job_data["timezone"] || Time.zone&.name
-      self.enqueued_at          = Time.iso8601(job_data["enqueued_at"]) if job_data["enqueued_at"]
-      self.scheduled_at         = Time.iso8601(job_data["scheduled_at"]) if job_data["scheduled_at"]
+      self.enqueued_at          = deserialize_time(job_data["enqueued_at"]) if job_data["enqueued_at"]
+      self.scheduled_at         = deserialize_time(job_data["scheduled_at"]) if job_data["scheduled_at"]
     end
 
     # Configures the job with the given options.
@@ -208,5 +208,13 @@ module ActiveJob
       def arguments_serialized?
         @serialized_arguments
       end
+
+      def deserialize_time(time)
+        if time.is_a?(Time)
+          time
+        else
+          Time.iso8601(time)
+        end
+      end
   end
 end

data/lib/active_job/gem_version.rb

@@ -10,7 +10,7 @@ module ActiveJob
     MAJOR = 8
     MINOR = 1
     TINY  = 0
-    PRE   = "beta1"
+    PRE   = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
   end

data/lib/active_job/serializers/action_controller_parameters_serializer.rb

@@ -4,7 +4,7 @@ module ActiveJob
   module Serializers
     class ActionControllerParametersSerializer < ObjectSerializer
       def serialize(argument)
-        Arguments.serialize(argument.to_h.with_indifferent_access)
+        Arguments.serialize_argument(argument.to_h.with_indifferent_access)
       end
 
       def deserialize(hash)

data/lib/active_job/serializers/object_serializer.rb

@@ -28,6 +28,11 @@ module ActiveJob
         delegate :serialize?, :serialize, :deserialize, to: :instance
       end
 
+      def initialize
+        super
+        @template = { Arguments::OBJECT_SERIALIZER_KEY => self.class.name }.freeze
+      end
+
       # Determines if an argument should be serialized by a serializer.
       def serialize?(argument)
         argument.is_a?(klass)
@@ -35,19 +40,13 @@ module ActiveJob
 
       # Serializes an argument to a JSON primitive type.
       def serialize(hash)
-        hash[Arguments::OBJECT_SERIALIZER_KEY] = self.class.name
-        hash
+        @template.merge(hash)
       end
 
       # Deserializes an argument from a JSON primitive type.
       def deserialize(hash)
         raise NotImplementedError, "#{self.class.name} should implement a public #deserialize(hash) method"
       end
-
-      # The class of the object that will be serialized.
-      def klass
-        raise NotImplementedError, "#{self.class.name} should implement a public #klass method"
-      end
     end
   end
 end

data/lib/active_job/serializers/range_serializer.rb

@@ -5,8 +5,8 @@ module ActiveJob
     class RangeSerializer < ObjectSerializer
       def serialize(range)
         super(
-          "begin" => Arguments.serialize(range.begin),
-          "end" => Arguments.serialize(range.end),
+          "begin" => Arguments.serialize_argument(range.begin),
+          "end" => Arguments.serialize_argument(range.end),
           "exclude_end" => range.exclude_end?, # Always boolean, no need to serialize
         )
       end

data/lib/active_job/serializers.rb

@@ -81,8 +81,16 @@ module ActiveJob
               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

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

@@ -43,6 +43,7 @@ module ActiveJob
   autoload :EnqueueAfterTransactionCommit
 
   eager_autoload do
+    autoload :Continuable
     autoload :Continuation
     autoload :Serializers
     autoload :ConfiguredJob

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activejob
 version: !ruby/object:Gem::Version
-  version: 8.1.0.beta1
+  version: 8.1.0
 platform: ruby
 authors:
 - David Heinemeier Hansson
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 8.1.0.beta1
+        version: 8.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 8.1.0.beta1
+        version: 8.1.0
 - !ruby/object:Gem::Dependency
   name: globalid
   requirement: !ruby/object:Gem::Requirement
@@ -95,6 +95,7 @@ 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/version.rb
@@ -107,10 +108,10 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/rails/rails/issues
-  changelog_uri: https://github.com/rails/rails/blob/v8.1.0.beta1/activejob/CHANGELOG.md
-  documentation_uri: https://api.rubyonrails.org/v8.1.0.beta1/
+  changelog_uri: https://github.com/rails/rails/blob/v8.1.0/activejob/CHANGELOG.md
+  documentation_uri: https://api.rubyonrails.org/v8.1.0/
   mailing_list_uri: https://discuss.rubyonrails.org/c/rubyonrails-talk
-  source_code_uri: https://github.com/rails/rails/tree/v8.1.0.beta1/activejob
+  source_code_uri: https://github.com/rails/rails/tree/v8.1.0/activejob
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths: