Skip to content

pkg/settings: fix SettingMap.GetOrDefault #1730

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jmank88 merged 1 commit into from
Dec 10, 2025
+79 −9
Merged

pkg/settings: fix SettingMap.GetOrDefault #1730

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions pkg/settings/cresettings/settings.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ func reinit() {
if err != nil {
log.Fatalf("failed to initialize settings: %v", err)
}
} else {
DefaultGetter = nil
}
}

Expand Down
73 changes: 69 additions & 4 deletions pkg/settings/cresettings/settings_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ import (
"github.com/smartcontractkit/chainlink-common/pkg/config"
"github.com/smartcontractkit/chainlink-common/pkg/contexts"
"github.com/smartcontractkit/chainlink-common/pkg/logger"
"github.com/smartcontractkit/chainlink-common/pkg/settings"
"github.com/smartcontractkit/chainlink-common/pkg/settings/limits"
)

Expand Down Expand Up @@ -199,6 +200,10 @@ func TestDefaultGetter_SettingMap(t *testing.T) {
}
}`)
reinit() // set default vars

// ensure merged values; defaults must remain
require.Equal(t, "true", Default.PerWorkflow.ChainAllowed.Values["3379446385462418246"])
// confirm
got, err = limit.GetOrDefault(ctx, DefaultGetter)
require.NoError(t, err)
require.False(t, got)
Expand Down Expand Up @@ -233,13 +238,73 @@ func TestDefaultGetter_SettingMap(t *testing.T) {
require.True(t, got)
}

func TestChainAllows(t *testing.T) {
gl, err := limits.MakeGateLimiter(limits.Factory{Logger: logger.Test(t)}, Default.PerWorkflow.ChainAllowed)
func TestDefaultEnvVars(t *testing.T) {
// confirm defaults
require.Equal(t, "", Default.PerWorkflow.ChainAllowed.Values["1234"])
require.Equal(t, "true", Default.PerWorkflow.ChainAllowed.Values["3379446385462418246"])

t.Cleanup(reinit) // restore after

// update defaults
t.Setenv(envNameSettingsDefault, `{
"PerWorkflow": {
"ChainAllowed": {
"Values": {
"1234": "true"
}
}
}
}`)
reinit() // set default vars

// confirm through Default
require.Equal(t, "true", Default.PerWorkflow.ChainAllowed.Values["1234"])
// without affecting others (they must merge)
require.Equal(t, "true", Default.PerWorkflow.ChainAllowed.Values["3379446385462418246"])

// confirm through DefaultGetter
gl, err := limits.MakeGateLimiter(limits.Factory{Logger: logger.Test(t), Settings: DefaultGetter}, Default.PerWorkflow.ChainAllowed)
require.NoError(t, err)

ctx := contexts.WithCRE(t.Context(), contexts.CRE{Owner: "owner-id", Workflow: "foo"})
ctx := contexts.WithCRE(t.Context(), contexts.CRE{Org: "foo", Owner: "owner-id", Workflow: "foo"})
// defaults and global override allowed
assert.NoError(t, gl.AllowErr(contexts.WithChainSelector(ctx, 3379446385462418246)))
assert.NoError(t, gl.AllowErr(contexts.WithChainSelector(ctx, 12922642891491394802)))
assert.NoError(t, gl.AllowErr(contexts.WithChainSelector(ctx, 1234)))

// update overrides
t.Setenv(envNameSettingsDefault, "{}")
t.Setenv(envNameSettings, `{
"global": {
"PerWorkflow": {
"ChainAllowed": {
"Values": {
"1234": "true"
}
}
}
}
}`)

reinit() // set default vars

// confirm through DefaultGetter
gl, err = limits.MakeGateLimiter(limits.Factory{Logger: logger.Test(t), Settings: DefaultGetter}, Default.PerWorkflow.ChainAllowed)
require.NoError(t, err)

// defaults and global override allowed
assert.NoError(t, gl.AllowErr(contexts.WithChainSelector(ctx, 3379446385462418246)))
assert.NoError(t, gl.AllowErr(contexts.WithChainSelector(ctx, 12922642891491394802)))
assert.NoError(t, gl.AllowErr(contexts.WithChainSelector(ctx, 1234)))

// confirm through an empty, but non-nil getter
getter, err := settings.NewJSONGetter([]byte(`{}`))
require.NoError(t, err)
gl, err = limits.MakeGateLimiter(limits.Factory{Logger: logger.Test(t), Settings: getter}, Default.PerWorkflow.ChainAllowed)
require.NoError(t, err)

// defaults and global override allowed
assert.NoError(t, gl.AllowErr(contexts.WithChainSelector(ctx, 3379446385462418246)))
assert.NoError(t, gl.AllowErr(contexts.WithChainSelector(ctx, 12922642891491394802)))
assert.ErrorIs(t, gl.AllowErr(contexts.WithChainSelector(ctx, 1234)), limits.ErrorNotAllowed{})
assert.NoError(t, gl.AllowErr(contexts.WithChainSelector(ctx, 1234)))
}
13 changes: 8 additions & 5 deletions pkg/settings/map.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,16 +45,19 @@ func (s *SettingMap[T]) GetOrDefault(ctx context.Context, g Getter) (value T, er
if err != nil {
return s.Default.DefaultValue, fmt.Errorf("failed to get value from context: %w", err)
}
if g == nil {
valueOrDefault := func() (T, error) {
Copy link
Contributor Author

@jmank88 jmank88 Dec 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This logic was only applied when the SettingsGetter was nil, but even if DefaultGetter is nil (like our tests), core wraps it in an AtomicSettings getter, so it was bypassed. Instead we need to apply it in every default case.

if str, ok := s.Values[strconv.FormatUint(k, 10)]; ok {
value, err = s.Default.Parse(str)
if err != nil {
return s.Default.DefaultValue, err
}
return
return value, nil
}
return s.Default.DefaultValue, nil
}
if g == nil {
return valueOrDefault()
}

valueKey := s.Default.Key + ".Values." + strconv.FormatUint(k, 10)
defaultKey := s.Default.Key + ".Default"
Expand All @@ -66,20 +69,20 @@ func (s *SettingMap[T]) GetOrDefault(ctx context.Context, g Getter) (value T, er
} else if str != "" {
value, err = s.Default.Parse(str)
if err != nil {
return s.Default.DefaultValue, err
return valueOrDefault()
}
return
}

// Default override
str, err = g.GetScoped(ctx, s.Default.Scope, defaultKey)
if err != nil || str == "" {
return s.Default.DefaultValue, err
return valueOrDefault()
}

value, err = s.Default.Parse(str)
if err != nil {
return s.Default.DefaultValue, err
return valueOrDefault()
}
return
}
Loading