-
Notifications
You must be signed in to change notification settings - Fork 103
/
chooser.go
339 lines (312 loc) · 10.7 KB
/
chooser.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
// Copyright (c) 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 yarpcconfig
import (
"fmt"
"sort"
"strings"
"go.uber.org/yarpc/api/peer"
"go.uber.org/yarpc/internal/config"
peerbind "go.uber.org/yarpc/peer"
)
// PeerChooser facilitates decoding and building peer choosers. A peer chooser
// combines a peer list (which implements the peer selection strategy) and a
// peer list updater (which informs the peer list about different peers),
// allowing transports to rely on these two pieces for peer selection and load
// balancing.
//
// Format
//
// Peer chooser configuration may define only one of the following keys:
// `peer`, `with`, or the name of any registered PeerListSpec.
//
// `peer` indicates that requests must be sent to a single peer.
//
// http:
// peer: 127.0.0.1:8080
//
// Note that how this string is interpreted is transport-dependent.
//
// `with` specifies that a named peer chooser preset defined by the transport
// should be used rather than defining one by hand in the configuration.
//
// # Given a dev-proxy preset on your TransportSpec,
// http:
// with: dev-proxy
//
// If the name of a registered PeerListSpec is the key, an object specifying
// the configuration parameters for the PeerListSpec is expected along with
// the name of a known peer list updater and its configuration.
//
// # cfg.RegisterPeerList(roundrobin.Spec())
// round-robin:
// peers:
// - 127.0.0.1:8080
// - 127.0.0.1:8081
//
// In the example above, there are no configuration parameters for the round
// robin peer list. The only remaining key is the name of the peer list
// updater: `peers` which is just a static list of peers.
//
// Integration
//
// To integrate peer choosers with your transport, embed this struct into your
// outbound configuration.
//
// type myOutboundConfig struct {
// config.PeerChooser
//
// Address string
// }
//
// Then in your Build*Outbound function, use the PeerChooser.BuildPeerChooser
// method to retrieve a peer chooser for your outbound. The following example
// only works if your transport implements the peer.Transport interface.
//
// func buildOutbound(cfg *myOutboundConfig, t transport.Transport, k *config.Kit) (transport.UnaryOutbound, error) {
// myTransport := t.(*MyTransport)
// peerChooser, err := cfg.BuildPeerChooser(myTransport, hostport.Identify, k)
// if err != nil {
// return nil, err
// }
// return myTransport.NewOutbound(peerChooser), nil
// }
//
// The *config.Kit received by the Build*Outbound function MUST be passed to
// the BuildPeerChooser function as-is.
//
// Note that the keys for the PeerChooser: peer, with, and any peer list name,
// share the namespace with the attributes of your outbound configuration.
type PeerChooser struct {
peerChooser
}
// peerChooser is the private representation of PeerChooser that captures
// decoded configuration without revealing it on the public type.
type peerChooser struct {
Peer string `config:"peer,interpolate"`
Preset string `config:"with,interpolate"`
Etc config.AttributeMap `config:",squash"`
}
// Empty returns true if the PeerChooser is empty, i.e., it does not have any
// keys defined.
//
// This allows Build*Outbound functions to handle the case where the peer
// configuration is specified in a different way than the standard peer
// configuration.
func (pc PeerChooser) Empty() bool {
return pc.Peer == "" && pc.Preset == "" && len(pc.Etc) == 0
}
// BuildPeerChooser translates the decoded configuration into a peer.Chooser.
//
// The identify function informs us how to convert string-based peer names
// into peer identifiers for the transport.
//
// The Kit received by the Build*Outbound function MUST be passed to
// BuildPeerChooser as-is.
func (pc PeerChooser) BuildPeerChooser(transport peer.Transport, identify func(string) peer.Identifier, kit *Kit) (peer.Chooser, error) {
// Establish a peer selection strategy.
switch {
case pc.Peer != "":
// myoutbound:
// outboundopt1: ...
// outboundopt2: ...
// peer: 127.0.0.1:8080
if len(pc.Etc) > 0 {
return nil, fmt.Errorf("unrecognized attributes in outbound config: %+v", pc.Etc)
}
return peerbind.NewSingle(identify(pc.Peer), transport), nil
case pc.Preset != "":
// myoutbound:
// outboundopt1: ...
// outboundopt2: ...
// with: somepreset
if len(pc.Etc) > 0 {
return nil, fmt.Errorf("unrecognized attributes in outbound config: %+v", pc.Etc)
}
preset, err := kit.peerChooserPreset(pc.Preset)
if err != nil {
return nil, err
}
return preset.Build(transport, kit)
default:
// myoutbound:
// outboundopt1: ...
// outboundopt2: ...
// my-peer-list:
// ...
return pc.buildPeerChooser(transport, identify, kit)
}
}
func (pc PeerChooser) buildPeerChooser(transport peer.Transport, identify func(string) peer.Identifier, kit *Kit) (peer.Chooser, error) {
peerChooserName, peerChooserConfig, err := getPeerListInfo(pc.Etc, kit)
if err != nil {
return nil, err
}
if peerChooserSpec := kit.maybePeerChooserSpec(peerChooserName); peerChooserSpec != nil {
chooserBuilder, err := peerChooserSpec.PeerChooser.Decode(peerChooserConfig, config.InterpolateWith(kit.resolver))
if err != nil {
return nil, err
}
result, err := chooserBuilder.Build(transport, kit)
if err != nil {
return nil, err
}
return result.(peer.Chooser), nil
}
// if there was no chooser registered, we assume we have a peer list registered
peerListSpec, err := kit.peerListSpec(peerChooserName)
if err != nil {
return nil, err
}
// This builds the peer list updater and also removes its entry from the
// map. Given,
//
// least-pending:
// failurePenalty: 5s
// dns:
// ..
//
// We will be left with only failurePenalty in the map so that we can simply
// decode it into the peer list configuration type.
peerListUpdater, err := buildPeerListUpdater(peerChooserConfig, identify, kit)
if err != nil {
return nil, err
}
listBuilder, err := peerListSpec.PeerList.Decode(peerChooserConfig, config.InterpolateWith(kit.resolver))
if err != nil {
return nil, err
}
result, err := listBuilder.Build(transport, kit)
if err != nil {
return nil, err
}
peerChooser := result.(peer.ChooserList)
return peerbind.Bind(peerChooser, peerListUpdater), nil
}
// getPeerListInfo extracts the peer list entry from the given attribute map. It
// must be the only remaining entry.
//
// For example, in
//
// myoutbound:
// outboundopt1: ...
// outboundopt2: ...
// my-peer-list:
// ...
//
// By the time getPeerListInfo is called, the map must only be,
//
// my-peer-list:
// ...
//
// The name of the peer list (my-peer-list) is returned with the attributes
// specified under that entry.
func getPeerListInfo(etc config.AttributeMap, kit *Kit) (name string, config config.AttributeMap, err error) {
names := etc.Keys()
switch len(names) {
case 0:
err = fmt.Errorf("no peer list or chooser provided in config, need one of: %+v", kit.peerChooserAndListSpecNames())
case 1:
name = names[0]
_, err = etc.Pop(name, &config)
default:
err = fmt.Errorf("unrecognized attributes in outbound config: %+v", etc)
}
return
}
// buildPeerListUpdater builds the peer list updater given the peer list
// configuration map. For example, we might get,
//
// least-pending:
// failurePenalty: 5s
// dns:
// name: myservice.example.com
// record: A
func buildPeerListUpdater(c config.AttributeMap, identify func(string) peer.Identifier, kit *Kit) (peer.Binder, error) {
// Special case for explicit list of peers.
var peers []string
if _, err := c.Pop("peers", &peers); err != nil {
return nil, err
}
if len(peers) > 0 {
return peerbind.BindPeers(identifyAll(identify, peers)), nil
}
// TODO: Make peers a separate peer list updater that is registered by
// default instead of special casing here.
var (
// The peer list updater config is in the same namespace as the
// attributes for the peer list config. We want to ensure that there is
// exactly one peer list updater in the config.
foundUpdaters []string
// The peer list updater spec we'll actually use.
peerListUpdaterSpec *compiledPeerListUpdaterSpec
)
for name := range c {
spec := kit.peerListUpdaterSpec(name)
if spec != nil {
peerListUpdaterSpec = spec
foundUpdaters = append(foundUpdaters, name)
}
}
switch len(foundUpdaters) {
case 0:
return nil, fmt.Errorf(
"no recognized peer list updater in config: got %s; need one of %s",
strings.Join(configNames(c), ", "),
strings.Join(kit.peerListUpdaterSpecNames(), ", "),
)
case 1:
// fall through to logic below
default:
sort.Strings(foundUpdaters) // deterministic error message
return nil, fmt.Errorf(
"found too many peer list updaters in config: got %s",
strings.Join(foundUpdaters, ", "))
}
var peerListUpdaterConfig config.AttributeMap
if _, err := c.Pop(foundUpdaters[0], &peerListUpdaterConfig); err != nil {
return nil, err
}
// This decodes all attributes on the peer list updater block, including the
// field with the name of the peer list updater.
peerListUpdaterBuilder, err := peerListUpdaterSpec.PeerListUpdater.Decode(peerListUpdaterConfig, config.InterpolateWith(kit.resolver))
if err != nil {
return nil, err
}
result, err := peerListUpdaterBuilder.Build(kit)
if err != nil {
return nil, err
}
return result.(peer.Binder), nil
}
func identifyAll(identify func(string) peer.Identifier, peers []string) []peer.Identifier {
pids := make([]peer.Identifier, len(peers))
for i, p := range peers {
pids[i] = identify(p)
}
return pids
}
func configNames(c config.AttributeMap) (names []string) {
for name := range c {
names = append(names, name)
}
sort.Strings(names)
return
}