-
Notifications
You must be signed in to change notification settings - Fork 839
[common][dynamicconfig] Move dynamic config to fx Module #6828
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.
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
3vilhamster
merged 3 commits into
cadence-workflow:master
from
3vilhamster:dynamicconfigfx
Apr 21, 2025
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| // The MIT License (MIT) | ||
|
|
||
| // Copyright (c) 2017-2020 Uber Technologies Inc. | ||
|
|
||
| // Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| // of this software and associated documentation files (the "Software"), to deal | ||
| // in the Software without restriction, including without limitation the rights | ||
| // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| // copies of the Software, and to permit persons to whom the Software is | ||
| // furnished to do so, subject to the following conditions: | ||
| // | ||
| // The above copyright notice and this permission notice shall be included in all | ||
| // copies or substantial portions of the Software. | ||
| // | ||
| // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| // SOFTWARE. | ||
|
|
||
| package dynamicconfigfx | ||
|
|
||
| import ( | ||
| "context" | ||
| "path/filepath" | ||
|
|
||
| "go.uber.org/fx" | ||
|
|
||
| "github.com/uber/cadence/common/config" | ||
| "github.com/uber/cadence/common/dynamicconfig" | ||
| "github.com/uber/cadence/common/dynamicconfig/configstore" | ||
| "github.com/uber/cadence/common/log" | ||
| "github.com/uber/cadence/common/log/tag" | ||
| "github.com/uber/cadence/common/persistence" | ||
| ) | ||
|
|
||
| // Module provides fx options for dynamic config initialization | ||
| var Module = fx.Options(fx.Provide(New)) | ||
|
|
||
| // Params required to build a new dynamic config. | ||
| type Params struct { | ||
| fx.In | ||
|
|
||
| Cfg config.Config | ||
| Logger log.Logger | ||
| RootDir string `name:"root-dir"` | ||
|
|
||
| Lifecycle fx.Lifecycle | ||
| } | ||
|
|
||
| // New creates dynamicconfig.Client from the configuration | ||
| func New(p Params) dynamicconfig.Client { | ||
| stopped := make(chan struct{}) | ||
|
|
||
| if p.Cfg.DynamicConfig.Client == "" { | ||
| p.Cfg.DynamicConfigClient.Filepath = constructPathIfNeed(p.RootDir, p.Cfg.DynamicConfigClient.Filepath) | ||
| } else { | ||
| p.Cfg.DynamicConfig.FileBased.Filepath = constructPathIfNeed(p.RootDir, p.Cfg.DynamicConfig.FileBased.Filepath) | ||
| } | ||
|
|
||
| p.Lifecycle.Append(fx.Hook{OnStop: func(_ context.Context) error { | ||
| close(stopped) | ||
| return nil | ||
| }}) | ||
|
|
||
| var res dynamicconfig.Client | ||
|
|
||
| var err error | ||
| if p.Cfg.DynamicConfig.Client == "" { | ||
| p.Logger.Warn("falling back to legacy file based dynamicClientConfig") | ||
| res, err = dynamicconfig.NewFileBasedClient(&p.Cfg.DynamicConfigClient, p.Logger, stopped) | ||
| } else { | ||
| switch p.Cfg.DynamicConfig.Client { | ||
| case dynamicconfig.ConfigStoreClient: | ||
| p.Logger.Info("initialising ConfigStore dynamic config client") | ||
| res, err = configstore.NewConfigStoreClient( | ||
| &p.Cfg.DynamicConfig.ConfigStore, | ||
| &p.Cfg.Persistence, | ||
| p.Logger, | ||
| persistence.DynamicConfig, | ||
| ) | ||
| case dynamicconfig.FileBasedClient: | ||
| p.Logger.Info("initialising File Based dynamic config client") | ||
| res, err = dynamicconfig.NewFileBasedClient(&p.Cfg.DynamicConfig.FileBased, p.Logger, stopped) | ||
| } | ||
| } | ||
|
|
||
| if res == nil { | ||
| p.Logger.Info("initialising NOP dynamic config client") | ||
| res = dynamicconfig.NewNopClient() | ||
| } else if err != nil { | ||
| p.Logger.Error("creating dynamic config client failed, using no-op config client instead", tag.Error(err)) | ||
| res = dynamicconfig.NewNopClient() | ||
| } | ||
|
|
||
| return res | ||
| } | ||
|
|
||
| // constructPathIfNeed would append the dir as the root dir | ||
| // when the file wasn't absolute path. | ||
| func constructPathIfNeed(dir string, file string) string { | ||
| if !filepath.IsAbs(file) { | ||
| return dir + "/" + file | ||
| } | ||
| return file | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Error cases silently switching to no-op config doesn't sound right. I know that's also the current behavior but we should consider failing startup if there's a misconfiguration for dynamicconfigs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's a good point, but I'm unsure how safe it is. It's something to consider for v2: a stricter startup to ensure no missing dependencies.