Skip to content

Commit 2cb07fc

Browse files
dfawleydfawley
authored
resolver: rename Option to Options, leaving type aliases for now (grpc#3175)
1 parent dc9615b commit 2cb07fc

File tree

19 files changed

+62
-52
lines changed

19 files changed

+62
-52
lines changed

‎balancer/balancer.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ type ClientConn interface {
140140
UpdateBalancerState(s connectivity.State, p Picker)
141141

142142
// ResolveNow is called by balancer to notify gRPC to do a name resolving.
143-
ResolveNow(resolver.ResolveNowOption)
143+
ResolveNow(resolver.ResolveNowOptions)
144144

145145
// Target returns the dial target for this ClientConn.
146146
//

‎balancer/grpclb/grpclb_remote_balancer.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -372,7 +372,7 @@ func (ccw *remoteBalancerCCWrapper) watchRemoteBalancer() {
372372
}
373373
}
374374
// Trigger a re-resolve when the stream errors.
375-
ccw.lb.cc.cc.ResolveNow(resolver.ResolveNowOption{})
375+
ccw.lb.cc.cc.ResolveNow(resolver.ResolveNowOptions{})
376376

377377
ccw.lb.mu.Lock()
378378
ccw.lb.remoteBalancerConnected = false

‎balancer/grpclb/grpclb_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -871,7 +871,7 @@ func TestFallBackWithNoServerAddress(t *testing.T) {
871871

872872
resolveNowCh := make(chan struct{}, 1)
873873
r, cleanup := manual.GenerateAndRegisterManualResolver()
874-
r.ResolveNowCallback = func(resolver.ResolveNowOption) {
874+
r.ResolveNowCallback = func(resolver.ResolveNowOptions) {
875875
select {
876876
case <-resolveNowCh:
877877
default:

‎balancer/grpclb/grpclb_util.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ type lbManualResolver struct {
6767
ccb balancer.ClientConn
6868
}
6969

70-
func (r *lbManualResolver) Build(_ resolver.Target, cc resolver.ClientConn, _ resolver.BuildOption) (resolver.Resolver, error) {
70+
func (r *lbManualResolver) Build(_ resolver.Target, cc resolver.ClientConn, _ resolver.BuildOptions) (resolver.Resolver, error) {
7171
r.ccr = cc
7272
return r, nil
7373
}
@@ -77,7 +77,7 @@ func (r *lbManualResolver) Scheme() string {
7777
}
7878

7979
// ResolveNow calls resolveNow on the parent ClientConn.
80-
func (r *lbManualResolver) ResolveNow(o resolver.ResolveNowOption) {
80+
func (r *lbManualResolver) ResolveNow(o resolver.ResolveNowOptions) {
8181
r.ccb.ResolveNow(o)
8282
}
8383

‎balancer_conn_wrappers.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ func (ccb *ccBalancerWrapper) UpdateBalancerState(s connectivity.State, p balanc
186186
ccb.cc.csMgr.updateState(s)
187187
}
188188

189-
func (ccb *ccBalancerWrapper) ResolveNow(o resolver.ResolveNowOption) {
189+
func (ccb *ccBalancerWrapper) ResolveNow(o resolver.ResolveNowOptions) {
190190
ccb.cc.resolveNow(o)
191191
}
192192

‎clientconn.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -938,7 +938,7 @@ func (cc *ClientConn) applyServiceConfigAndBalancer(sc *ServiceConfig, addrs []r
938938
}
939939
}
940940

941-
func (cc *ClientConn) resolveNow(o resolver.ResolveNowOption) {
941+
func (cc *ClientConn) resolveNow(o resolver.ResolveNowOptions) {
942942
cc.mu.RLock()
943943
r := cc.resolverWrapper
944944
cc.mu.RUnlock()
@@ -1081,7 +1081,7 @@ func (ac *addrConn) adjustParams(r transport.GoAwayReason) {
10811081
func (ac *addrConn) resetTransport() {
10821082
for i := 0; ; i++ {
10831083
if i > 0 {
1084-
ac.cc.resolveNow(resolver.ResolveNowOption{})
1084+
ac.cc.resolveNow(resolver.ResolveNowOptions{})
10851085
}
10861086

10871087
ac.mu.Lock()

‎examples/features/load_balancing/client/main.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ func main() {
9292

9393
type exampleResolverBuilder struct{}
9494

95-
func (*exampleResolverBuilder) Build(target resolver.Target, cc resolver.ClientConn, opts resolver.BuildOption) (resolver.Resolver, error) {
95+
func (*exampleResolverBuilder) Build(target resolver.Target, cc resolver.ClientConn, opts resolver.BuildOptions) (resolver.Resolver, error) {
9696
r := &exampleResolver{
9797
target: target,
9898
cc: cc,
@@ -119,8 +119,8 @@ func (r *exampleResolver) start() {
119119
}
120120
r.cc.UpdateState(resolver.State{Addresses: addrs})
121121
}
122-
func (*exampleResolver) ResolveNow(o resolver.ResolveNowOption) {}
123-
func (*exampleResolver) Close() {}
122+
func (*exampleResolver) ResolveNow(o resolver.ResolveNowOptions) {}
123+
func (*exampleResolver) Close() {}
124124

125125
func init() {
126126
resolver.Register(&exampleResolverBuilder{})

‎examples/features/name_resolving/client/main.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ func main() {
9898
// ResolverBuilder(https://godoc.org/google.golang.org/grpc/resolver#Builder).
9999
type exampleResolverBuilder struct{}
100100

101-
func (*exampleResolverBuilder) Build(target resolver.Target, cc resolver.ClientConn, opts resolver.BuildOption) (resolver.Resolver, error) {
101+
func (*exampleResolverBuilder) Build(target resolver.Target, cc resolver.ClientConn, opts resolver.BuildOptions) (resolver.Resolver, error) {
102102
r := &exampleResolver{
103103
target: target,
104104
cc: cc,
@@ -127,8 +127,8 @@ func (r *exampleResolver) start() {
127127
}
128128
r.cc.UpdateState(resolver.State{Addresses: addrs})
129129
}
130-
func (*exampleResolver) ResolveNow(o resolver.ResolveNowOption) {}
131-
func (*exampleResolver) Close() {}
130+
func (*exampleResolver) ResolveNow(o resolver.ResolveNowOptions) {}
131+
func (*exampleResolver) Close() {}
132132

133133
func init() {
134134
// Register the example ResolverBuilder. This is usually done in a package's

‎internal/resolver/dns/dns_resolver.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ type dnsBuilder struct {
108108
}
109109

110110
// Build creates and starts a DNS resolver that watches the name resolution of the target.
111-
func (b *dnsBuilder) Build(target resolver.Target, cc resolver.ClientConn, opts resolver.BuildOption) (resolver.Resolver, error) {
111+
func (b *dnsBuilder) Build(target resolver.Target, cc resolver.ClientConn, opts resolver.BuildOptions) (resolver.Resolver, error) {
112112
host, port, err := parseTarget(target.Endpoint, defaultPort)
113113
if err != nil {
114114
return nil, err
@@ -181,7 +181,7 @@ type ipResolver struct {
181181
}
182182

183183
// ResolveNow resend the address it stores, no resolution is needed.
184-
func (i *ipResolver) ResolveNow(opt resolver.ResolveNowOption) {
184+
func (i *ipResolver) ResolveNow(opt resolver.ResolveNowOptions) {
185185
select {
186186
case i.rn <- struct{}{}:
187187
default:
@@ -229,7 +229,7 @@ type dnsResolver struct {
229229
}
230230

231231
// ResolveNow invoke an immediate resolution of the target that this dnsResolver watches.
232-
func (d *dnsResolver) ResolveNow(opt resolver.ResolveNowOption) {
232+
func (d *dnsResolver) ResolveNow(opt resolver.ResolveNowOptions) {
233233
select {
234234
case d.rn <- struct{}{}:
235235
default:

‎internal/resolver/dns/dns_resolver_test.go

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -730,7 +730,7 @@ func testDNSResolver(t *testing.T) {
730730
for _, a := range tests {
731731
b := NewBuilder()
732732
cc := &testClientConn{target: a.target}
733-
r, err := b.Build(resolver.Target{Endpoint: a.target}, cc, resolver.BuildOption{})
733+
r, err := b.Build(resolver.Target{Endpoint: a.target}, cc, resolver.BuildOptions{})
734734
if err != nil {
735735
t.Fatalf("%v\n", err)
736736
}
@@ -820,7 +820,7 @@ func testDNSResolverWithSRV(t *testing.T) {
820820
for _, a := range tests {
821821
b := NewBuilder()
822822
cc := &testClientConn{target: a.target}
823-
r, err := b.Build(resolver.Target{Endpoint: a.target}, cc, resolver.BuildOption{})
823+
r, err := b.Build(resolver.Target{Endpoint: a.target}, cc, resolver.BuildOptions{})
824824
if err != nil {
825825
t.Fatalf("%v\n", err)
826826
}
@@ -892,7 +892,7 @@ func testDNSResolveNow(t *testing.T) {
892892
for _, a := range tests {
893893
b := NewBuilder()
894894
cc := &testClientConn{target: a.target}
895-
r, err := b.Build(resolver.Target{Endpoint: a.target}, cc, resolver.BuildOption{})
895+
r, err := b.Build(resolver.Target{Endpoint: a.target}, cc, resolver.BuildOptions{})
896896
if err != nil {
897897
t.Fatalf("%v\n", err)
898898
}
@@ -920,7 +920,7 @@ func testDNSResolveNow(t *testing.T) {
920920
t.Errorf("Resolved service config of target: %q = %+v, want %+v\n", a.target, sc, a.scWant)
921921
}
922922
revertTbl := mutateTbl(a.target)
923-
r.ResolveNow(resolver.ResolveNowOption{})
923+
r.ResolveNow(resolver.ResolveNowOptions{})
924924
for {
925925
addrs, cnt = cc.getAddress()
926926
if cnt == 2 {
@@ -969,7 +969,7 @@ func testIPResolver(t *testing.T) {
969969
for _, v := range tests {
970970
b := NewBuilder()
971971
cc := &testClientConn{target: v.target}
972-
r, err := b.Build(resolver.Target{Endpoint: v.target}, cc, resolver.BuildOption{})
972+
r, err := b.Build(resolver.Target{Endpoint: v.target}, cc, resolver.BuildOptions{})
973973
if err != nil {
974974
t.Fatalf("%v\n", err)
975975
}
@@ -985,7 +985,7 @@ func testIPResolver(t *testing.T) {
985985
if !reflect.DeepEqual(v.want, addrs) {
986986
t.Errorf("Resolved addresses of target: %q = %+v, want %+v\n", v.target, addrs, v.want)
987987
}
988-
r.ResolveNow(resolver.ResolveNowOption{})
988+
r.ResolveNow(resolver.ResolveNowOptions{})
989989
for {
990990
addrs, cnt = cc.getAddress()
991991
if cnt == 2 {
@@ -1028,12 +1028,12 @@ func TestResolveFunc(t *testing.T) {
10281028
b := NewBuilder()
10291029
for _, v := range tests {
10301030
cc := &testClientConn{target: v.addr}
1031-
r, err := b.Build(resolver.Target{Endpoint: v.addr}, cc, resolver.BuildOption{})
1031+
r, err := b.Build(resolver.Target{Endpoint: v.addr}, cc, resolver.BuildOptions{})
10321032
if err == nil {
10331033
r.Close()
10341034
}
10351035
if !reflect.DeepEqual(err, v.want) {
1036-
t.Errorf("Build(%q, cc, resolver.BuildOption{}) = %v, want %v", v.addr, err, v.want)
1036+
t.Errorf("Build(%q, cc, resolver.BuildOptions{}) = %v, want %v", v.addr, err, v.want)
10371037
}
10381038
}
10391039
}
@@ -1060,7 +1060,7 @@ func TestDisableServiceConfig(t *testing.T) {
10601060
for _, a := range tests {
10611061
b := NewBuilder()
10621062
cc := &testClientConn{target: a.target}
1063-
r, err := b.Build(resolver.Target{Endpoint: a.target}, cc, resolver.BuildOption{DisableServiceConfig: a.disableServiceConfig})
1063+
r, err := b.Build(resolver.Target{Endpoint: a.target}, cc, resolver.BuildOptions{DisableServiceConfig: a.disableServiceConfig})
10641064
if err != nil {
10651065
t.Fatalf("%v\n", err)
10661066
}
@@ -1084,7 +1084,7 @@ func TestDNSResolverRetry(t *testing.T) {
10841084
b := NewBuilder()
10851085
target := "ipv4.single.fake"
10861086
cc := &testClientConn{target: target}
1087-
r, err := b.Build(resolver.Target{Endpoint: target}, cc, resolver.BuildOption{})
1087+
r, err := b.Build(resolver.Target{Endpoint: target}, cc, resolver.BuildOptions{})
10881088
if err != nil {
10891089
t.Fatalf("%v\n", err)
10901090
}
@@ -1103,7 +1103,7 @@ func TestDNSResolverRetry(t *testing.T) {
11031103
// mutate the host lookup table so the target has 0 address returned.
11041104
revertTbl := mutateTbl(target)
11051105
// trigger a resolve that will get empty address list
1106-
r.ResolveNow(resolver.ResolveNowOption{})
1106+
r.ResolveNow(resolver.ResolveNowOptions{})
11071107
for {
11081108
addrs, _ = cc.getAddress()
11091109
if len(addrs) == 0 {
@@ -1221,7 +1221,7 @@ func TestCustomAuthority(t *testing.T) {
12211221

12221222
b := NewBuilder()
12231223
cc := &testClientConn{target: "foo.bar.com"}
1224-
r, err := b.Build(resolver.Target{Endpoint: "foo.bar.com", Authority: a.authority}, cc, resolver.BuildOption{})
1224+
r, err := b.Build(resolver.Target{Endpoint: "foo.bar.com", Authority: a.authority}, cc, resolver.BuildOptions{})
12251225

12261226
if err == nil {
12271227
r.Close()
@@ -1259,7 +1259,7 @@ func TestRateLimitedResolve(t *testing.T) {
12591259
target := "foo.bar.com"
12601260
b := NewBuilder()
12611261
cc := &testClientConn{target: target}
1262-
r, err := b.Build(resolver.Target{Endpoint: target}, cc, resolver.BuildOption{})
1262+
r, err := b.Build(resolver.Target{Endpoint: target}, cc, resolver.BuildOptions{})
12631263
if err != nil {
12641264
t.Fatalf("resolver.Build() returned error: %v\n", err)
12651265
}
@@ -1292,7 +1292,7 @@ func TestRateLimitedResolve(t *testing.T) {
12921292
case <-done:
12931293
return
12941294
default:
1295-
r.ResolveNow(resolver.ResolveNowOption{})
1295+
r.ResolveNow(resolver.ResolveNowOptions{})
12961296
time.Sleep(1 * time.Millisecond)
12971297
}
12981298
}

‎internal/resolver/passthrough/passthrough.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ const scheme = "passthrough"
2626

2727
type passthroughBuilder struct{}
2828

29-
func (*passthroughBuilder) Build(target resolver.Target, cc resolver.ClientConn, opts resolver.BuildOption) (resolver.Resolver, error) {
29+
func (*passthroughBuilder) Build(target resolver.Target, cc resolver.ClientConn, opts resolver.BuildOptions) (resolver.Resolver, error) {
3030
r := &passthroughResolver{
3131
target: target,
3232
cc: cc,
@@ -48,7 +48,7 @@ func (r *passthroughResolver) start() {
4848
r.cc.UpdateState(resolver.State{Addresses: []resolver.Address{{Addr: r.target.Endpoint}}})
4949
}
5050

51-
func (*passthroughResolver) ResolveNow(o resolver.ResolveNowOption) {}
51+
func (*passthroughResolver) ResolveNow(o resolver.ResolveNowOptions) {}
5252

5353
func (*passthroughResolver) Close() {}
5454

‎resolver/manual/manual.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ import (
3030
// NewBuilderWithScheme creates a new test resolver builder with the given scheme.
3131
func NewBuilderWithScheme(scheme string) *Resolver {
3232
return &Resolver{
33-
ResolveNowCallback: func(resolver.ResolveNowOption) {},
33+
ResolveNowCallback: func(resolver.ResolveNowOptions) {},
3434
scheme: scheme,
3535
}
3636
}
@@ -41,7 +41,7 @@ type Resolver struct {
4141
// ResolveNowCallback is called when the ResolveNow method is called on the
4242
// resolver. Must not be nil. Must not be changed after the resolver may
4343
// be built.
44-
ResolveNowCallback func(resolver.ResolveNowOption)
44+
ResolveNowCallback func(resolver.ResolveNowOptions)
4545
scheme string
4646

4747
// Fields actually belong to the resolver.
@@ -56,7 +56,7 @@ func (r *Resolver) InitialState(s resolver.State) {
5656
}
5757

5858
// Build returns itself for Resolver, because it's both a builder and a resolver.
59-
func (r *Resolver) Build(target resolver.Target, cc resolver.ClientConn, opts resolver.BuildOption) (resolver.Resolver, error) {
59+
func (r *Resolver) Build(target resolver.Target, cc resolver.ClientConn, opts resolver.BuildOptions) (resolver.Resolver, error) {
6060
r.CC = cc
6161
if r.bootstrapState != nil {
6262
r.UpdateState(*r.bootstrapState)
@@ -70,7 +70,7 @@ func (r *Resolver) Scheme() string {
7070
}
7171

7272
// ResolveNow is a noop for Resolver.
73-
func (r *Resolver) ResolveNow(o resolver.ResolveNowOption) {
73+
func (r *Resolver) ResolveNow(o resolver.ResolveNowOptions) {
7474
r.ResolveNowCallback(o)
7575
}
7676

‎resolver/resolver.go

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -124,9 +124,14 @@ type Address struct {
124124
Metadata interface{}
125125
}
126126

127-
// BuildOption includes additional information for the builder to create
127+
// BuildOption is a type alias of BuildOptions for legacy reasons.
128+
//
129+
// Deprecated: use BuildOptions instead.
130+
type BuildOption = BuildOptions
131+
132+
// BuildOptions includes additional information for the builder to create
128133
// the resolver.
129-
type BuildOption struct {
134+
type BuildOptions struct {
130135
// DisableServiceConfig indicates whether a resolver implementation should
131136
// fetch service config data.
132137
DisableServiceConfig bool
@@ -224,14 +229,19 @@ type Builder interface {
224229
//
225230
// gRPC dial calls Build synchronously, and fails if the returned error is
226231
// not nil.
227-
Build(target Target, cc ClientConn, opts BuildOption) (Resolver, error)
232+
Build(target Target, cc ClientConn, opts BuildOptions) (Resolver, error)
228233
// Scheme returns the scheme supported by this resolver.
229234
// Scheme is defined at https://github.com/grpc/grpc/blob/master/doc/naming.md.
230235
Scheme() string
231236
}
232237

233-
// ResolveNowOption includes additional information for ResolveNow.
234-
type ResolveNowOption struct{}
238+
// ResolveNowOption is a type alias of ResolveNowOptions for legacy reasons.
239+
//
240+
// Deprecated: use ResolveNowOptions instead.
241+
type ResolveNowOption = ResolveNowOptions
242+
243+
// ResolveNowOptions includes additional information for ResolveNow.
244+
type ResolveNowOptions struct{}
235245

236246
// Resolver watches for the updates on the specified target.
237247
// Updates include address updates and service config updates.
@@ -240,7 +250,7 @@ type Resolver interface {
240250
// again. It's just a hint, resolver can ignore this if it's not necessary.
241251
//
242252
// It could be called multiple times concurrently.
243-
ResolveNow(ResolveNowOption)
253+
ResolveNow(ResolveNowOptions)
244254
// Close closes the resolver.
245255
Close()
246256
}

‎resolver_conn_wrapper.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ func newCCResolverWrapper(cc *ClientConn) (*ccResolverWrapper, error) {
9292
if creds := cc.dopts.copts.TransportCredentials; creds != nil {
9393
credsClone = creds.Clone()
9494
}
95-
rbo := resolver.BuildOption{
95+
rbo := resolver.BuildOptions{
9696
DisableServiceConfig: cc.dopts.disableServiceConfig,
9797
DialCreds: credsClone,
9898
CredsBundle: cc.dopts.copts.CredsBundle,
@@ -113,7 +113,7 @@ func newCCResolverWrapper(cc *ClientConn) (*ccResolverWrapper, error) {
113113
return ccr, nil
114114
}
115115

116-
func (ccr *ccResolverWrapper) resolveNow(o resolver.ResolveNowOption) {
116+
func (ccr *ccResolverWrapper) resolveNow(o resolver.ResolveNowOptions) {
117117
ccr.resolverMu.Lock()
118118
if !ccr.done.HasFired() {
119119
ccr.resolver.ResolveNow(o)
@@ -149,7 +149,7 @@ func (ccr *ccResolverWrapper) poll(err error) {
149149
ccr.polling = p
150150
go func() {
151151
for i := 0; ; i++ {
152-
ccr.resolveNow(resolver.ResolveNowOption{})
152+
ccr.resolveNow(resolver.ResolveNowOptions{})
153153
t := time.NewTimer(ccr.cc.dopts.resolveNowBackoff(i))
154154
select {
155155
case <-p:

0 commit comments

Comments
 (0)