hanzoai/tasks
2
0
Fork 0
mirror of https://github.com/hanzoai/tasks.git synced 2026-10-04 02:04:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

rm setMetricsHandler from filebasedDCclient (#9457)

Browse Source 
## What changed?
rm setMetricsHandler of FilebasedDCClient

## Why?
rm redundancy

## How did you test it?
- [x] built
- [ ] run locally and tested manually
- [x] covered by existing tests
- [ ] added new unit test(s)
- [ ] added new functional test(s)
This commit is contained in:
feiyang
2026-03-11 01:03:08 +00:00
committed by GitHub
parent a367d8cc47
commit d989d3caf0
3 changed files with 13 additions and 81 deletions
Download Patch File Download Diff File Expand all files Collapse all files
common/dynamicconfig/file_based_client.go
+7 -12
View File
@@ -51,19 +51,14 @@ type (
}
)
// NewFileBasedClientWithoutMetrics creates a file based client without a metrics.Handler,
// which can be set later with SetMetricsHandler. This is useful when the metricsHandler is not available
// at the time of initialization like in cases of circular dependencies.
func NewFileBasedClientWithoutMetrics(config *FileBasedClientConfig, logger log.Logger, doneCh <-chan any) (*fileBasedClient, error) {
return NewFileBasedClient(config, logger, doneCh, nil)
}
func (fc *fileBasedClient) SetMetricsHandler(metricsHandler metrics.Handler) {
fc.metricsHandler = metricsHandler
}
// NewFileBasedClient creates a file based client.
func NewFileBasedClient(config *FileBasedClientConfig, logger log.Logger, doneCh <-chan any, metricsHandler metrics.Handler) (*fileBasedClient, error) {
// use the NewFileBasedClientWithMetrics instead if you want to collect metrics.
// This method is retained mainly for backward compatibility.
func NewFileBasedClient(config *FileBasedClientConfig, logger log.Logger, doneCh <-chan any) (*fileBasedClient, error) {
return NewFileBasedClientWithMetrics(config, logger, doneCh, metrics.NoopMetricsHandler)
}
func NewFileBasedClientWithMetrics(config *FileBasedClientConfig, logger log.Logger, doneCh <-chan any, metricsHandler metrics.Handler) (*fileBasedClient, error) {
if config == nil {
return nil, errors.New("configuration for dynamic config client is nil")
}
common/dynamicconfig/file_based_client_test.go
+5 -68
View File
@@ -37,7 +37,7 @@ func (s *fileBasedClientSuite) SetupSuite() {
var err error
s.doneCh = make(chan any)
logger := log.NewNoopLogger()
s.client, err = dynamicconfig.NewFileBasedClient(&dynamicconfig.FileBasedClientConfig{
s.client, err = dynamicconfig.NewFileBasedClientWithMetrics(&dynamicconfig.FileBasedClientConfig{
Filepath: "config/testConfig.yaml",
PollInterval: time.Second * 5,
}, logger, s.doneCh, metrics.NoopMetricsHandler)
@@ -81,15 +81,12 @@ func (s *fileBasedClientSuite) TestNewFileBasedClientWithoutMetrics() {
doneCh := make(chan any)
defer close(doneCh)
client, err := dynamicconfig.NewFileBasedClientWithoutMetrics(
_, err := dynamicconfig.NewFileBasedClient(
&dynamicconfig.FileBasedClientConfig{
Filepath: "config/testConfig.yaml",
PollInterval: time.Minute * 5,
}, logger, doneCh)
s.NoError(err)
client.SetMetricsHandler(metrics.NoopMetricsHandler)
s.NoError(client.Update())
}
func (s *fileBasedClientSuite) TestGetValue_CaseInsensitie() {
@@ -276,12 +273,12 @@ func (s *fileBasedClientSuite) TestGetDurationValue_FilteredByTaskTypeQueue() {
}
func (s *fileBasedClientSuite) TestValidateConfig_ConfigNotExist() {
_, err := dynamicconfig.NewFileBasedClient(nil, nil, nil, nil)
_, err := dynamicconfig.NewFileBasedClientWithMetrics(nil, nil, nil, nil)
s.Error(err)
}
func (s *fileBasedClientSuite) TestValidateConfig_FileNotExist() {
_, err := dynamicconfig.NewFileBasedClient(&dynamicconfig.FileBasedClientConfig{
_, err := dynamicconfig.NewFileBasedClientWithMetrics(&dynamicconfig.FileBasedClientConfig{
Filepath: "file/not/exist.yaml",
PollInterval: time.Second * 10,
}, nil, nil, nil)
@@ -289,7 +286,7 @@ func (s *fileBasedClientSuite) TestValidateConfig_FileNotExist() {
}
func (s *fileBasedClientSuite) TestValidateConfig_ShortPollInterval() {
_, err := dynamicconfig.NewFileBasedClient(&dynamicconfig.FileBasedClientConfig{
_, err := dynamicconfig.NewFileBasedClientWithMetrics(&dynamicconfig.FileBasedClientConfig{
Filepath: "config/testConfig.yaml",
PollInterval: time.Second,
}, nil, nil, nil)
@@ -822,66 +819,6 @@ testGetIntPropertyKey:
s.NoError(client.Update())
}
func (s *fileBasedClientSuite) TestUpdate_SetMetricsHandlerRecordsMetrics() {
dynamicconfig.NewGlobalIntSetting(testGetIntPropertyKey, 0, "")
ctrl := gomock.NewController(s.T())
defer ctrl.Finish()
doneCh := make(chan any)
defer close(doneCh)
reader := dynamicconfig.NewMockFileReader(ctrl)
logger := log.NewNoopLogger()
captureHandler := metricstest.NewCaptureHandler()
updateInterval := time.Minute * 5
t1 := time.Now()
t2 := t1.Add(time.Second)
t3 := t2.Add(time.Second)
fileData := []byte(`
testGetIntPropertyKey:
- value: 1000
constraints: {}
`)
// init with nil metricsHandler — should succeed without error
reader.EXPECT().GetModTime().Return(t1, nil).Times(2)
reader.EXPECT().ReadFile().Return(fileData, nil)
client, err := dynamicconfig.NewFileBasedClientWithReader(reader,
&dynamicconfig.FileBasedClientConfig{
Filepath: "anyValue",
PollInterval: updateInterval,
}, logger, doneCh, nil)
s.NoError(err)
// Set the metrics handler; subsequent updates should record metrics
client.SetMetricsHandler(captureHandler)
capture := captureHandler.StartCapture()
defer captureHandler.StopCapture(capture)
// Successful update should record gauge 0
reader.EXPECT().GetModTime().Return(t2, nil)
reader.EXPECT().ReadFile().Return(fileData, nil)
s.NoError(client.Update())
snapshot := capture.Snapshot()
s.Len(snapshot["dynamic_config_update_failure"], 1)
s.InDelta(float64(0), snapshot["dynamic_config_update_failure"][0].Value, 0)
// Failed update should record gauge 1
// lastCheckedTime is now t2, so t3 triggers a read
reader.EXPECT().GetModTime().Return(t3, nil)
reader.EXPECT().ReadFile().Return(nil, errors.New("transient error"))
s.Error(client.Update())
snapshot = capture.Snapshot()
s.Len(snapshot["dynamic_config_update_failure"], 2)
s.InDelta(float64(1), snapshot["dynamic_config_update_failure"][1].Value, 0)
}
func (s *fileBasedClientSuite) TestWarnUnregisteredKey() {
dynamicconfig.NewGlobalIntSetting(testGetIntPropertyKey, 0, "")
temporal/fx.go
+1 -1
View File
@@ -214,7 +214,7 @@ func ServerOptionsProvider(opts []ServerOption) (serverOptionsProvider, error) {
if dcClient == nil {
dcConfig := so.config.DynamicConfigClient
if dcConfig != nil {
dcClient, err = dynamicconfig.NewFileBasedClient(dcConfig, logger, stopChan, metricHandler)
dcClient, err = dynamicconfig.NewFileBasedClientWithMetrics(dcConfig, logger, stopChan, metricHandler)
if err != nil {
return serverOptionsProvider{}, fmt.Errorf("unable to create dynamic config client: %w", err)
}