Skip to content

Commit 5e61370

Browse files
committed
[configretry] validate max_elapsed_time
1 parent f5a7315 commit 5e61370

File tree

3 files changed

+37
-0
lines changed

3 files changed

+37
-0
lines changed

.chloggen/check_max_elapsed_time.yaml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Use this changelog template to create an entry for release notes.
2+
3+
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
4+
change_type: enhancement
5+
6+
# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver)
7+
component: configretry
8+
9+
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
10+
note: Validate `max_elapsed_time`, ensure it is larger than `max_interval` and `initial_interval` respectively.
11+
12+
# One or more tracking issues or pull requests related to the change
13+
issues: [9489]
14+
15+
# (Optional) One or more lines of additional information to render under the primary note.
16+
# These lines will be padded with 2 spaces and then inserted directly into the document.
17+
# Use pipe (|) for multiline entries.
18+
subtext:
19+
20+
# Optional: The change log or logs in which this entry should be included.
21+
# e.g. '[user]' or '[user, api]'
22+
# Include 'user' if the change is relevant to end users.
23+
# Include 'api' if there is a change to a library API.
24+
# Default: '[user]'
25+
change_logs: []

config/configretry/backoff.go

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,5 +61,11 @@ func (bs *BackOffConfig) Validate() error {
6161
if bs.MaxElapsedTime < 0 {
6262
return errors.New("'max_elapsed' time must be non-negative")
6363
}
64+
if bs.MaxElapsedTime < bs.InitialInterval {
65+
return errors.New("'max_elapsed' is less than 'initial_interval'")
66+
}
67+
if bs.MaxElapsedTime < bs.MaxInterval {
68+
return errors.New("'max_elapsed' is less than 'max_interval'")
69+
}
6470
return nil
6571
}

config/configretry/backoff_test.go

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,12 @@ func TestInvalidMaxElapsedTime(t *testing.T) {
6666
assert.NoError(t, cfg.Validate())
6767
cfg.MaxElapsedTime = -1
6868
assert.Error(t, cfg.Validate())
69+
cfg.MaxElapsedTime = 60
70+
assert.Error(t, cfg.Validate())
71+
cfg.InitialInterval = 0
72+
assert.Error(t, cfg.Validate())
73+
cfg.MaxInterval = 0
74+
assert.NoError(t, cfg.Validate())
6975
}
7076

7177
func TestDisabledWithInvalidValues(t *testing.T) {

0 commit comments

Comments
 (0)