scheduler: extract storage operations to schedulerConfig interface #8515
There are no files selected for viewing
This file contains 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 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 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,56 @@ | ||
| // Copyright 2024 TiKV Project Authors. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package schedulers | ||
|
|
||
| import ( | ||
| "github.com/pingcap/errors" | ||
| "github.com/pingcap/failpoint" | ||
| "github.com/tikv/pd/pkg/storage/endpoint" | ||
| ) | ||
|
|
||
| type schedulerConfig interface { | ||
| save(any) error | ||
| load(any) error | ||
| init(name string, storage endpoint.ConfigStorage) | ||
| } | ||
|
|
||
| type baseSchedulerConfig struct { | ||
| name string | ||
| storage endpoint.ConfigStorage | ||
| } | ||
|
|
||
| func (b *baseSchedulerConfig) init(name string, storage endpoint.ConfigStorage) { | ||
| b.name = name | ||
| b.storage = storage | ||
| } | ||
|
|
||
| func (b *baseSchedulerConfig) save(v any) error { | ||
| data, err := EncodeConfig(v) | ||
| failpoint.Inject("persistFail", func() { | ||
| err = errors.New("fail to persist") | ||
| }) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| return b.storage.SaveSchedulerConfig(b.name, data) | ||
| } | ||
|
|
||
| func (b *baseSchedulerConfig) load(v any) error { | ||
| data, err := b.storage.LoadSchedulerConfig(b.name) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| return DecodeConfig([]byte(data), v) | ||
| } | ||
This file contains 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,46 @@ | ||
| // Copyright 2024 TiKV Project Authors. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package schedulers | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
| "github.com/tikv/pd/pkg/storage" | ||
| ) | ||
|
|
||
| func TestSchedulerConfig(t *testing.T) { | ||
| s := storage.NewStorageWithMemoryBackend() | ||
| cfg := &baseSchedulerConfig{} | ||
| cfg.init("test", s) | ||
|
|
||
| type testConfig struct { | ||
| Value string `json:"value"` | ||
| } | ||
|
|
||
| tc := &testConfig{ | ||
| Value: "test", | ||
| } | ||
| require.NoError(t, cfg.save(tc)) | ||
| newTc := &testConfig{} | ||
| require.NoError(t, cfg.load(newTc)) | ||
| require.Equal(t, tc.Value, newTc.Value) | ||
|
|
||
| // config with another name cannot loaded the previous config | ||
| cfg2 := &baseSchedulerConfig{} | ||
| cfg2.init("test2", s) | ||
| // report error because the config is empty and cannot be decoded | ||
| require.Error(t, cfg2.load(newTc)) | ||
| } |
This file contains 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
Oops, something went wrong.
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.
how about conf.save()
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.
If we change it to the form of
conf.save(), then we will have to saveconf(xxxxxSchedulerConfig) as a pointer(any) inbaseSchedulerConfig. I'm not sure if this is a good idea. If everyone agrees, I can make this change.cc @rleungx
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.
I've made this change, we can compare them and choose the best one. 96ef87e
Actually, I also think that
save()is better👀