Skip to content

Commit 5ded839

Browse files
committed
Strip default_ prefix from retry_jitter config to match conventions
1 parent 8739729 commit 5ded839

File tree

5 files changed

+14
-14
lines changed

5 files changed

+14
-14
lines changed

activejob/lib/active_job/exceptions.rb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ module Exceptions
88
extend ActiveSupport::Concern
99

1010
included do
11-
class_attribute :default_retry_jitter, instance_accessor: false, instance_predicate: false
12-
self.default_retry_jitter = 0.15
11+
class_attribute :retry_jitter, instance_accessor: false, instance_predicate: false
12+
self.retry_jitter = 0.15
1313
end
1414

1515
module ClassMethods
@@ -128,7 +128,7 @@ def retry_job(options = {})
128128

129129
private
130130
def determine_delay(seconds_or_duration_or_algorithm:, executions:, jitter: nil)
131-
jitter ||= self.class.default_retry_jitter
131+
jitter ||= self.class.retry_jitter
132132
case seconds_or_duration_or_algorithm
133133
when :exponentially_longer
134134
((executions**4) + (Kernel.rand((executions**4) * jitter))) + 2

activejob/test/cases/exceptions_test.rb

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -129,9 +129,9 @@ class ExceptionsTest < ActiveSupport::TestCase
129129
end
130130
end
131131

132-
test "retry jitter uses value from ActiveJob::Base.default_retry_jitter by default" do
133-
old_jitter = ActiveJob::Base.default_retry_jitter
134-
ActiveJob::Base.default_retry_jitter = 4.0
132+
test "retry jitter uses value from ActiveJob::Base.retry_jitter by default" do
133+
old_jitter = ActiveJob::Base.retry_jitter
134+
ActiveJob::Base.retry_jitter = 4.0
135135

136136
travel_to Time.now
137137

@@ -151,7 +151,7 @@ class ExceptionsTest < ActiveSupport::TestCase
151151
], JobBuffer.values
152152
end
153153
ensure
154-
ActiveJob::Base.default_retry_jitter = old_jitter
154+
ActiveJob::Base.retry_jitter = old_jitter
155155
end
156156

157157
test "custom wait retrying job" do

guides/source/configuring.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -807,7 +807,7 @@ There are a few configuration options available in Active Support:
807807

808808
* `config.active_job.log_arguments` controls if the arguments of a job are logged. Defaults to `true`.
809809

810-
* `config.active_job.default_retry_jitter` controls the amount of "jitter" (random variation) applied to the delay time calculated when retrying failed jobs. Defaults to `0.15`.
810+
* `config.active_job.retry_jitter` controls the amount of "jitter" (random variation) applied to the delay time calculated when retrying failed jobs. Defaults to `0.15`.
811811

812812
### Configuring Action Cable
813813

railties/lib/rails/application/configuration.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ def load_defaults(target_version)
157157
load_defaults "6.0"
158158

159159
if respond_to?(:active_job)
160-
active_job.default_retry_jitter = 0.15
160+
active_job.retry_jitter = 0.15
161161
end
162162

163163
if respond_to?(:active_record)

railties/test/application/configuration_test.rb

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2262,18 +2262,18 @@ class ::DummySerializer < ActiveJob::Serializers::ObjectSerializer; end
22622262
end
22632263
end
22642264

2265-
test "ActiveJob::Base.default_retry_jitter is 0.15 by default" do
2265+
test "ActiveJob::Base.retry_jitter is 0.15 by default" do
22662266
app "development"
22672267

2268-
assert_equal 0.15, ActiveJob::Base.default_retry_jitter
2268+
assert_equal 0.15, ActiveJob::Base.retry_jitter
22692269
end
22702270

2271-
test "ActiveJob::Base.default_retry_jitter can be set by config" do
2271+
test "ActiveJob::Base.retry_jitter can be set by config" do
22722272
app "development"
22732273

2274-
Rails.application.config.active_job.default_retry_jitter = 0.22
2274+
Rails.application.config.active_job.retry_jitter = 0.22
22752275

2276-
assert_equal 0.22, ActiveJob::Base.default_retry_jitter
2276+
assert_equal 0.22, ActiveJob::Base.retry_jitter
22772277
end
22782278

22792279
test "ActiveJob::Base.return_false_on_aborted_enqueue is true by default" do

0 commit comments

Comments
 (0)