activejob 7.1.0.beta1 → 7.1.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c483058510bace1163414149c1aff4177dd5dc026414417a99f240128686ccc6
-  data.tar.gz: 27f14766eafe75eb955ebae328ef1c154c3bd3aa42251403e6ced8a61f8dc3d1
+  metadata.gz: d95076eb165c16b44e30c4f98c72bce402b3124c5754e76ad6b86f1e4e02b81e
+  data.tar.gz: e9f4bb0bd99471a34abd21723776a66913b593c605dcd8f84079c029f74cfbc7
 SHA512:
-  metadata.gz: eeb8e50e581068b1e9862917d02d99bc8988fc254475e4a70a4a7e231ccb61340dfa276be6d39d0f6ebd4f347a00019d3c3703c946549bb4788dcdd83b46ccc9
-  data.tar.gz: 23cb3701834db4e4b6ba5adbd77966a50bd0debf8aed7a75d9a83f04355895aad870baca894d6e32183757b9a4a7f62c79748a638f99928be4c497d633302cb5
+  metadata.gz: 70fc9872437f7ebb6161686b3b4ed66acd79e8d1b3e750f84384f1818ea213c0a1b038a9b435cc6c727790eb2334d7ea2458810e90b321485b25dec6c6c3d944
+  data.tar.gz: ea5ae1a2c0ae70db9c44935f7da32344fd84519de9e7b570815f7194e0b780a6c9aba811128a8740fbefac252e2844760bf7c6aec62653fc84dc86f24fdf8adb

data/CHANGELOG.md

@@ -1,3 +1,26 @@
+## Rails 7.1.0.rc2 (October 01, 2023) ##
+
+*   Make sure `scheduled_at` is a Time object when asserting enqueued jobs.
+
+    *Rafael Mendonça França*
+
+
+## Rails 7.1.0.rc1 (September 27, 2023) ##
+
+*   Set `scheduled_at` attribute as a Time object instead of epoch seconds, and serialize and deserialize the value
+    when enqueued. Assigning a numeric/epoch value to scheduled_at= is deprecated; use a Time object instead.
+
+    Deserializes `enqueued_at` as a Time instead of ISO8601 String.
+
+    *Ben Sheldon*
+
+*   Clarify the backoff strategy for the recommended `:wait` option when retrying jobs
+
+    `wait: :exponentially_longer` is waiting polynomially longer, so it is now recommended to use `wait: :polynomially_longer` to keep the same behavior.
+
+    *Victor Mours*
+
+
 ## Rails 7.1.0.beta1 (September 13, 2023) ##
 
 *   Fix Active Job log message to correctly report a job failed to enqueue

data/lib/active_job/core.rb

@@ -12,8 +12,10 @@ module ActiveJob
     attr_accessor :arguments
     attr_writer :serialized_arguments
 
-    # Timestamp when the job should be performed
-    attr_accessor :scheduled_at
+    # Time when the job should be performed
+    attr_reader :scheduled_at
+
+    attr_reader :_scheduled_at_time # :nodoc:
 
     # Job Identifier
     attr_accessor :job_id
@@ -94,6 +96,8 @@ module ActiveJob
       @arguments  = arguments
       @job_id     = SecureRandom.uuid
       @queue_name = self.class.queue_name
+      @scheduled_at = nil
+      @_scheduled_at_time = nil
       @priority   = self.class.priority
       @executions = 0
       @exception_executions = {}
@@ -115,7 +119,8 @@ module ActiveJob
         "exception_executions" => exception_executions,
         "locale"     => I18n.locale.to_s,
         "timezone"   => timezone,
-        "enqueued_at" => Time.now.utc.iso8601(9)
+        "enqueued_at" => Time.now.utc.iso8601(9),
+        "scheduled_at" => _scheduled_at_time ? _scheduled_at_time.utc.iso8601(9) : nil,
       }
     end
 
@@ -155,19 +160,32 @@ 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          = job_data["enqueued_at"]
+      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"]
     end
 
     # Configures the job with the given options.
     def set(options = {}) # :nodoc:
-      self.scheduled_at = options[:wait].seconds.from_now.to_f if options[:wait]
-      self.scheduled_at = options[:wait_until].to_f if options[:wait_until]
+      self.scheduled_at = options[:wait].seconds.from_now if options[:wait]
+      self.scheduled_at = options[:wait_until] if options[:wait_until]
       self.queue_name   = self.class.queue_name_from_part(options[:queue]) if options[:queue]
       self.priority     = options[:priority].to_i if options[:priority]
 
       self
     end
 
+    def scheduled_at=(value)
+      @_scheduled_at_time = if value&.is_a?(Numeric)
+        ActiveJob.deprecator.warn(<<~MSG.squish)
+          Assigning a numeric/epoch value to scheduled_at is deprecated. Use a Time object instead.
+        MSG
+        Time.at(value)
+      else
+        value
+      end
+      @scheduled_at = value
+    end
+
     private
       def serialize_arguments_if_needed(arguments)
         if arguments_serialized?

data/lib/active_job/enqueuing.rb

@@ -23,7 +23,7 @@ module ActiveJob
             adapter_jobs.each do |job|
               job.successfully_enqueued = false
               if job.scheduled_at
-                queue_adapter.enqueue_at(job, job.scheduled_at)
+                queue_adapter.enqueue_at(job, job._scheduled_at_time.to_f)
               else
                 queue_adapter.enqueue(job)
               end
@@ -92,7 +92,7 @@ module ActiveJob
 
       run_callbacks :enqueue do
         if scheduled_at
-          queue_adapter.enqueue_at self, scheduled_at
+          queue_adapter.enqueue_at self, _scheduled_at_time.to_f
         else
           queue_adapter.enqueue self
         end

data/lib/active_job/exceptions.rb

@@ -21,10 +21,13 @@ module ActiveJob
       # You can also pass a block that'll be invoked if the retry attempts fail for custom logic rather than letting
       # the exception bubble up. This block is yielded with the job instance as the first and the error instance as the second parameter.
       #
+      # `retry_on` and `discard_on` handlers are searched from bottom to top, and up the class hierarchy. The handler of the first class for
+      # which <tt>exception.is_a?(klass)</tt> holds true is the one invoked, if any.
+      #
       # ==== Options
       # * <tt>:wait</tt> - Re-enqueues the job with a delay specified either in seconds (default: 3 seconds),
       #   as a computing proc that takes the number of executions so far as an argument, or as a symbol reference of
-      #   <tt>:exponentially_longer</tt>, which applies the wait algorithm of <tt>((executions**4) + (Kernel.rand * (executions**4) * jitter)) + 2</tt>
+      #   <tt>:polynomially_longer</tt>, which applies the wait algorithm of <tt>((executions**4) + (Kernel.rand * (executions**4) * jitter)) + 2</tt>
       #   (first wait ~3s, then ~18s, then ~83s, etc)
       # * <tt>:attempts</tt> - Re-enqueues the job the specified number of times (default: 5 attempts) or a symbol reference of <tt>:unlimited</tt>
       #   to retry the job until it succeeds
@@ -40,11 +43,11 @@ module ActiveJob
       #    retry_on CustomInfrastructureException, wait: 5.minutes, attempts: :unlimited
       #
       #    retry_on ActiveRecord::Deadlocked, wait: 5.seconds, attempts: 3
-      #    retry_on Net::OpenTimeout, Timeout::Error, wait: :exponentially_longer, attempts: 10 # retries at most 10 times for Net::OpenTimeout and Timeout::Error combined
+      #    retry_on Net::OpenTimeout, Timeout::Error, wait: :polynomially_longer, attempts: 10 # retries at most 10 times for Net::OpenTimeout and Timeout::Error combined
       #    # To retry at most 10 times for each individual exception:
-      #    # retry_on Net::OpenTimeout, wait: :exponentially_longer, attempts: 10
+      #    # retry_on Net::OpenTimeout, wait: :polynomially_longer, attempts: 10
       #    # retry_on Net::ReadTimeout, wait: 5.seconds, jitter: 0.30, attempts: 10
-      #    # retry_on Timeout::Error, wait: :exponentially_longer, attempts: 10
+      #    # retry_on Timeout::Error, wait: :polynomially_longer, attempts: 10
       #
       #    retry_on(YetAnotherCustomAppException) do |job, error|
       #      ExceptionNotifier.caught(error)
@@ -57,6 +60,12 @@ module ActiveJob
       #    end
       #  end
       def retry_on(*exceptions, wait: 3.seconds, attempts: 5, queue: nil, priority: nil, jitter: JITTER_DEFAULT)
+        if wait == :exponentially_longer
+          ActiveJob.deprecator.warn(<<~MSG.squish)
+            `wait: :exponentially_longer` will actually wait polynomially longer and is therefore deprecated.
+            Prefer `wait: :polynomially_longer` to avoid confusion and keep the same behavior.
+          MSG
+        end
         rescue_from(*exceptions) do |error|
           executions = executions_for(exceptions)
           if attempts == :unlimited || executions < attempts
@@ -81,6 +90,9 @@ module ActiveJob
       #
       # You can also pass a block that'll be invoked. This block is yielded with the job instance as the first and the error instance as the second parameter.
       #
+      # `retry_on` and `discard_on` handlers are searched from bottom to top, and up the class hierarchy. The handler of the first class for
+      # which <tt>exception.is_a?(klass)</tt> holds true is the one invoked, if any.
+      #
       # ==== Example
       #
       #  class SearchIndexingJob < ActiveJob::Base
@@ -156,7 +168,8 @@ module ActiveJob
         jitter = jitter == JITTER_DEFAULT ? self.class.retry_jitter : (jitter || 0.0)
 
         case seconds_or_duration_or_algorithm
-        when :exponentially_longer
+        when :exponentially_longer, :polynomially_longer
+          # This delay uses a polynomial backoff strategy, which was previously misnamed as exponential
           delay = executions**4
           delay_jitter = determine_jitter_for_delay(delay, jitter)
           delay + delay_jitter + 2

data/lib/active_job/gem_version.rb

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

data/lib/active_job/log_subscriber.rb

@@ -76,7 +76,7 @@ module ActiveJob
     def perform_start(event)
       info do
         job = event.payload[:job]
-        "Performing #{job.class.name} (Job ID: #{job.job_id}) from #{queue_name(event)} enqueued at #{job.enqueued_at}" + args_info(job)
+        "Performing #{job.class.name} (Job ID: #{job.job_id}) from #{queue_name(event)} enqueued at #{job.enqueued_at.utc.iso8601(9)}" + args_info(job)
       end
     end
     subscribe_log_level :perform_start, :info

data/lib/active_job/queue_adapters/sidekiq_adapter.rb

@@ -54,7 +54,7 @@ module ActiveJob
                 "wrapped" => job_class,
                 "queue" => queue,
                 "args" => scheduled_jobs.map { |job| [job.serialize] },
-                "at" => scheduled_jobs.map { |job| job.scheduled_at }
+                "at" => scheduled_jobs.map { |job| job.scheduled_at&.to_f }
               )
               enqueued_count += jids.compact.size
             end

data/lib/active_job/queue_adapters/test_adapter.rb

@@ -59,7 +59,7 @@ module ActiveJob
         end
 
         def filtered_time?(job)
-          job.scheduled_at > at.to_f if at && job.scheduled_at
+          job.scheduled_at > at if at && job.scheduled_at
         end
 
         def filtered_queue?(job)

data/lib/active_job/test_helper.rb

@@ -730,7 +730,7 @@ module ActiveJob
 
       def instantiate_job(payload, skip_deserialize_arguments: false)
         job = payload[:job].deserialize(payload)
-        job.scheduled_at = payload[:at].to_f if payload.key?(:at)
+        job.scheduled_at = Time.at(payload[:at]) if payload.key?(:at)
         job.send(:deserialize_arguments_if_needed) unless skip_deserialize_arguments
         job
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activejob
 version: !ruby/object:Gem::Version
-  version: 7.1.0.beta1
+  version: 7.1.0.rc2
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-13 00:00:00.000000000 Z
+date: 2023-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.1.0.beta1
+        version: 7.1.0.rc2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.1.0.beta1
+        version: 7.1.0.rc2
 - !ruby/object:Gem::Dependency
   name: globalid
   requirement: !ruby/object:Gem::Requirement
@@ -102,10 +102,10 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/rails/rails/issues
-  changelog_uri: https://github.com/rails/rails/blob/v7.1.0.beta1/activejob/CHANGELOG.md
-  documentation_uri: https://api.rubyonrails.org/v7.1.0.beta1/
+  changelog_uri: https://github.com/rails/rails/blob/v7.1.0.rc2/activejob/CHANGELOG.md
+  documentation_uri: https://api.rubyonrails.org/v7.1.0.rc2/
   mailing_list_uri: https://discuss.rubyonrails.org/c/rubyonrails-talk
-  source_code_uri: https://github.com/rails/rails/tree/v7.1.0.beta1/activejob
+  source_code_uri: https://github.com/rails/rails/tree/v7.1.0.rc2/activejob
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []