-
Notifications
You must be signed in to change notification settings - Fork 4.7k
autosharding: add config parsing functionality #9323
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
+223
−0
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| /* | ||
| * | ||
| * Copyright 2026 gRPC 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 autosharding implements the autosharding load balancing policy. | ||
| package autosharding | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "fmt" | ||
| "time" | ||
|
|
||
| "google.golang.org/grpc/balancer" | ||
| iserviceconfig "google.golang.org/grpc/internal/serviceconfig" | ||
| "google.golang.org/grpc/serviceconfig" | ||
| ) | ||
|
|
||
| // Name is the name of the autosharding balancer. | ||
| const Name = "autosharding_experimental" | ||
|
|
||
| func init() { | ||
| balancer.Register(bb{}) | ||
| } | ||
|
|
||
| // lbConfig is the balancer config for the autosharding balancer. | ||
| type lbConfig struct { | ||
| serviceconfig.LoadBalancingConfig `json:"-"` | ||
|
|
||
| ChannelFactoryKey string `json:"channelFactoryKey,omitempty"` | ||
| AutoShardingTarget string `json:"autoshardingTarget,omitempty"` | ||
| KeyHeaderName string `json:"keyHeaderName,omitempty"` | ||
| EnableFallback bool `json:"enableFallback,omitempty"` | ||
| InitialAssignmentTimeout iserviceconfig.Duration `json:"initialAssignmentTimeout,omitempty"` | ||
| } | ||
|
|
||
| type bb struct{} | ||
|
|
||
| func (bb) Name() string { | ||
| return Name | ||
| } | ||
|
|
||
| func (bb) ParseConfig(s json.RawMessage) (serviceconfig.LoadBalancingConfig, error) { | ||
| lbConfig := &lbConfig{InitialAssignmentTimeout: iserviceconfig.Duration(60 * time.Second)} | ||
| if err := json.Unmarshal(s, lbConfig); err != nil { | ||
| return nil, fmt.Errorf("autosharding: unable to unmarshal LBConfig: %v", err) | ||
| } | ||
| if lbConfig.ChannelFactoryKey == "" { | ||
| return nil, fmt.Errorf("autosharding: channelFactoryKey field is required") | ||
| } | ||
| if lbConfig.AutoShardingTarget == "" { | ||
| return nil, fmt.Errorf("autosharding: autoshardingTarget field is required") | ||
| } | ||
| if lbConfig.KeyHeaderName == "" { | ||
| return nil, fmt.Errorf("autosharding: keyHeaderName field is required") | ||
| } | ||
|
eshitachandwani marked this conversation as resolved.
|
||
| return lbConfig, nil | ||
| } | ||
|
|
||
| func (bb) Build(balancer.ClientConn, balancer.BuildOptions) balancer.Balancer { | ||
| return &autoshardingBalancer{} | ||
| } | ||
|
|
||
| type autoshardingBalancer struct { | ||
| balancer.Balancer | ||
| } | ||
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,144 @@ | ||
| /* | ||
| * | ||
| * Copyright 2026 gRPC 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 autosharding | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/google/go-cmp/cmp" | ||
| "google.golang.org/grpc/internal/grpctest" | ||
| iserviceconfig "google.golang.org/grpc/internal/serviceconfig" | ||
| "google.golang.org/grpc/serviceconfig" | ||
| ) | ||
|
|
||
| type s struct { | ||
| grpctest.Tester | ||
| } | ||
|
|
||
| func Test(t *testing.T) { | ||
| grpctest.RunSubTests(t, s{}) | ||
| } | ||
|
|
||
| func (s) TestParseConfig_Success(t *testing.T) { | ||
| parser := bb{} | ||
| tests := []struct { | ||
| name string | ||
| input string | ||
| wantCfg serviceconfig.LoadBalancingConfig | ||
| }{ | ||
| { | ||
| name: "all-fields", | ||
| input: `{ | ||
| "channelFactoryKey": "factory-key", | ||
| "autoshardingTarget": "target", | ||
| "keyHeaderName": "header", | ||
| "enableFallback": true, | ||
| "initialAssignmentTimeout": "30s" | ||
| }`, | ||
| wantCfg: &lbConfig{ | ||
| ChannelFactoryKey: "factory-key", | ||
| AutoShardingTarget: "target", | ||
| KeyHeaderName: "header", | ||
| EnableFallback: true, | ||
| InitialAssignmentTimeout: iserviceconfig.Duration(30 * time.Second), | ||
| }, | ||
| }, | ||
| { | ||
| name: "default-timeout", | ||
| input: `{ | ||
| "channelFactoryKey": "factory-key", | ||
| "autoshardingTarget": "target", | ||
| "keyHeaderName": "header" | ||
| }`, | ||
| wantCfg: &lbConfig{ | ||
| ChannelFactoryKey: "factory-key", | ||
| AutoShardingTarget: "target", | ||
| KeyHeaderName: "header", | ||
| InitialAssignmentTimeout: iserviceconfig.Duration(60 * time.Second), | ||
| }, | ||
| }, | ||
| } | ||
| for _, test := range tests { | ||
| t.Run(test.name, func(t *testing.T) { | ||
| gotCfg, err := parser.ParseConfig(json.RawMessage(test.input)) | ||
| if err != nil { | ||
| t.Fatalf("ParseConfig() error = %v, want nil", err) | ||
| } | ||
| if diff := cmp.Diff(test.wantCfg, gotCfg); diff != "" { | ||
| t.Errorf("ParseConfig() config diff (-want +got):\n%s", diff) | ||
| } | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func (s) TestParseConfig_Failure(t *testing.T) { | ||
| parser := bb{} | ||
| tests := []struct { | ||
| name string | ||
| input string | ||
| }{ | ||
| { | ||
| name: "invalid-json", | ||
| input: "{{invalidjson{{", | ||
| }, | ||
| { | ||
| name: "invalid-duration", | ||
| input: `{ | ||
| "channelFactoryKey": "factory-key", | ||
| "autoshardingTarget": "target", | ||
| "keyHeaderName": "header", | ||
| "initialAssignmentTimeout": "invalid" | ||
| }`, | ||
| }, | ||
| { | ||
| name: "missing-channel-factory-key", | ||
| input: `{ | ||
| "autoshardingTarget": "target", | ||
| "keyHeaderName": "header" | ||
| }`, | ||
| }, | ||
| { | ||
| name: "missing-autosharding-target", | ||
| input: `{ | ||
| "channelFactoryKey": "factory-key", | ||
| "keyHeaderName": "header" | ||
| }`, | ||
| }, | ||
| { | ||
| name: "missing-key-header-name", | ||
| input: `{ | ||
| "channelFactoryKey": "factory-key", | ||
| "autoshardingTarget": "target" | ||
| }`, | ||
| }, | ||
| { | ||
| name: "empty-config", | ||
| input: `{}`, | ||
| }, | ||
| } | ||
| for _, test := range tests { | ||
| t.Run(test.name, func(t *testing.T) { | ||
| if _, err := parser.ParseConfig(json.RawMessage(test.input)); err == nil { | ||
| t.Fatalf("ParseConfig() succeeded, want error") | ||
| } | ||
| }) | ||
| } | ||
| } |
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.
Uh oh!
There was an error while loading. Please reload this page.