forked from mongodb/mongo-go-driver
-
Notifications
You must be signed in to change notification settings - Fork 0
/
topology.go
677 lines (571 loc) · 17.9 KB
/
topology.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
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
// Copyright (C) MongoDB, Inc. 2017-present.
//
// 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
// Package topology contains types that handles the discovery, monitoring, and selection
// of servers. This package is designed to expose enough inner workings of service discovery
// and monitoring to allow low level applications to have fine grained control, while hiding
// most of the detailed implementation of the algorithms.
package topology // import "go.mongodb.org/mongo-driver/x/mongo/driver/topology"
import (
"context"
"errors"
"math/rand"
"strings"
"sync"
"sync/atomic"
"time"
"fmt"
"go.mongodb.org/mongo-driver/x/mongo/driver"
"go.mongodb.org/mongo-driver/x/mongo/driver/address"
"go.mongodb.org/mongo-driver/x/mongo/driver/description"
"go.mongodb.org/mongo-driver/x/mongo/driver/dns"
)
// ErrSubscribeAfterClosed is returned when a user attempts to subscribe to a
// closed Server or Topology.
var ErrSubscribeAfterClosed = errors.New("cannot subscribe after closeConnection")
// ErrTopologyClosed is returned when a user attempts to call a method on a
// closed Topology.
var ErrTopologyClosed = errors.New("topology is closed")
// ErrTopologyConnected is returned whena user attempts to Connect to an
// already connected Topology.
var ErrTopologyConnected = errors.New("topology is connected or connecting")
// ErrServerSelectionTimeout is returned from server selection when the server
// selection process took longer than allowed by the timeout.
var ErrServerSelectionTimeout = errors.New("server selection timeout")
// MonitorMode represents the way in which a server is monitored.
type MonitorMode uint8
// These constants are the available monitoring modes.
const (
AutomaticMode MonitorMode = iota
SingleMode
)
// Topology represents a MongoDB deployment.
type Topology struct {
connectionstate int32
cfg *config
desc atomic.Value // holds a description.Topology
dnsResolver *dns.Resolver
done chan struct{}
pollingDone chan struct{}
pollingwg sync.WaitGroup
rescanSRVInterval time.Duration
pollHeartbeatTime atomic.Value // holds a bool
fsm *fsm
// This should really be encapsulated into it's own type. This will likely
// require a redesign so we can share a minimum of data between the
// subscribers and the topology.
subscribers map[uint64]chan description.Topology
currentSubscriberID uint64
subscriptionsClosed bool
subLock sync.Mutex
// We should redesign how we Connect and handle individal servers. This is
// too difficult to maintain and it's rather easy to accidentally access
// the servers without acquiring the lock or checking if the servers are
// closed. This lock should also be an RWMutex.
serversLock sync.Mutex
serversClosed bool
servers map[address.Address]*Server
}
var _ driver.Deployment = &Topology{}
var _ driver.Subscriber = &Topology{}
type serverSelectionState struct {
selector description.ServerSelector
timeoutChan <-chan time.Time
}
func newServerSelectionState(selector description.ServerSelector, timeoutChan <-chan time.Time) serverSelectionState {
return serverSelectionState{
selector: selector,
timeoutChan: timeoutChan,
}
}
// New creates a new topology.
func New(opts ...Option) (*Topology, error) {
cfg, err := newConfig(opts...)
if err != nil {
return nil, err
}
t := &Topology{
cfg: cfg,
done: make(chan struct{}),
pollingDone: make(chan struct{}),
rescanSRVInterval: 60 * time.Second,
fsm: newFSM(),
subscribers: make(map[uint64]chan description.Topology),
servers: make(map[address.Address]*Server),
dnsResolver: dns.DefaultResolver,
}
t.desc.Store(description.Topology{})
if cfg.replicaSetName != "" {
t.fsm.SetName = cfg.replicaSetName
t.fsm.Kind = description.ReplicaSetNoPrimary
}
if cfg.mode == SingleMode {
t.fsm.Kind = description.Single
}
return t, nil
}
// Connect initializes a Topology and starts the monitoring process. This function
// must be called to properly monitor the topology.
func (t *Topology) Connect() error {
if !atomic.CompareAndSwapInt32(&t.connectionstate, disconnected, connecting) {
return ErrTopologyConnected
}
t.desc.Store(description.Topology{})
var err error
t.serversLock.Lock()
for _, a := range t.cfg.seedList {
addr := address.Address(a).Canonicalize()
t.fsm.Servers = append(t.fsm.Servers, description.Server{Addr: addr})
err = t.addServer(addr)
if err != nil {
return err
}
}
t.serversLock.Unlock()
if srvPollingRequired(t.cfg.cs.Original) {
go t.pollSRVRecords()
t.pollingwg.Add(1)
}
t.subscriptionsClosed = false // explicitly set in case topology was disconnected and then reconnected
atomic.StoreInt32(&t.connectionstate, connected)
return nil
}
// Disconnect closes the topology. It stops the monitoring thread and
// closes all open subscriptions.
func (t *Topology) Disconnect(ctx context.Context) error {
if !atomic.CompareAndSwapInt32(&t.connectionstate, connected, disconnecting) {
return ErrTopologyClosed
}
servers := make(map[address.Address]*Server)
t.serversLock.Lock()
t.serversClosed = true
for addr, server := range t.servers {
servers[addr] = server
}
t.serversLock.Unlock()
for _, server := range servers {
_ = server.Disconnect(ctx)
}
t.subLock.Lock()
for id, ch := range t.subscribers {
close(ch)
delete(t.subscribers, id)
}
t.subscriptionsClosed = true
t.subLock.Unlock()
if srvPollingRequired(t.cfg.cs.Original) {
t.pollingDone <- struct{}{}
t.pollingwg.Wait()
}
t.desc.Store(description.Topology{})
atomic.StoreInt32(&t.connectionstate, disconnected)
return nil
}
func srvPollingRequired(connstr string) bool {
return strings.HasPrefix(connstr, "mongodb+srv://")
}
// Description returns a description of the topology.
func (t *Topology) Description() description.Topology {
td, ok := t.desc.Load().(description.Topology)
if !ok {
td = description.Topology{}
}
return td
}
// Kind returns the topology kind of this Topology.
func (t *Topology) Kind() description.TopologyKind { return t.Description().Kind }
// Subscribe returns a Subscription on which all updated description.Topologys
// will be sent. The channel of the subscription will have a buffer size of one,
// and will be pre-populated with the current description.Topology.
// Subscribe implements the driver.Subscriber interface.
func (t *Topology) Subscribe() (*driver.Subscription, error) {
if atomic.LoadInt32(&t.connectionstate) != connected {
return nil, errors.New("cannot subscribe to Topology that is not connected")
}
ch := make(chan description.Topology, 1)
td, ok := t.desc.Load().(description.Topology)
if !ok {
td = description.Topology{}
}
ch <- td
t.subLock.Lock()
defer t.subLock.Unlock()
if t.subscriptionsClosed {
return nil, ErrSubscribeAfterClosed
}
id := t.currentSubscriberID
t.subscribers[id] = ch
t.currentSubscriberID++
return &driver.Subscription{
Updates: ch,
ID: id,
}, nil
}
// Unsubscribe unsubscribes the given subscription from the topology and closes the subscription channel.
// Unsubscribe implements the driver.Subscriber interface.
func (t *Topology) Unsubscribe(sub *driver.Subscription) error {
t.subLock.Lock()
defer t.subLock.Unlock()
if t.subscriptionsClosed {
return nil
}
ch, ok := t.subscribers[sub.ID]
if !ok {
return nil
}
close(ch)
delete(t.subscribers, sub.ID)
return nil
}
// RequestImmediateCheck will send heartbeats to all the servers in the
// topology right away, instead of waiting for the heartbeat timeout.
func (t *Topology) RequestImmediateCheck() {
if atomic.LoadInt32(&t.connectionstate) != connected {
return
}
t.serversLock.Lock()
for _, server := range t.servers {
server.RequestImmediateCheck()
}
t.serversLock.Unlock()
}
// SupportsSessions returns true if the topology supports sessions.
func (t *Topology) SupportsSessions() bool {
return t.Description().SessionTimeoutMinutes != 0 && t.Description().Kind != description.Single
}
// SupportsRetryWrites returns true if the topology supports retryable writes, which it does if it supports sessions.
func (t *Topology) SupportsRetryWrites() bool {
return t.SupportsSessions()
}
// SelectServer selects a server with given a selector. SelectServer complies with the
// server selection spec, and will time out after severSelectionTimeout or when the
// parent context is done.
func (t *Topology) SelectServer(ctx context.Context, ss description.ServerSelector) (driver.Server, error) {
if atomic.LoadInt32(&t.connectionstate) != connected {
return nil, ErrTopologyClosed
}
var ssTimeoutCh <-chan time.Time
if t.cfg.serverSelectionTimeout > 0 {
ssTimeout := time.NewTimer(t.cfg.serverSelectionTimeout)
ssTimeoutCh = ssTimeout.C
defer ssTimeout.Stop()
}
var doneOnce bool
var sub *driver.Subscription
selectionState := newServerSelectionState(ss, ssTimeoutCh)
for {
var suitable []description.Server
var selectErr error
if !doneOnce {
// for the first pass, select a server from the current description.
// this improves selection speed for up-to-date topology descriptions.
suitable, selectErr = t.selectServerFromDescription(ctx, t.Description(), selectionState)
doneOnce = true
} else {
// if the first pass didn't select a server, the previous description did not contain a suitable server, so
// we subscribe to the topology and attempt to obtain a server from that subscription
if sub == nil {
var err error
sub, err = t.Subscribe()
if err != nil {
return nil, err
}
defer t.Unsubscribe(sub)
}
suitable, selectErr = t.selectServerFromSubscription(ctx, sub.Updates, selectionState)
}
if selectErr != nil {
return nil, selectErr
}
if len(suitable) == 0 {
// try again if there are no servers available
continue
}
selected := suitable[rand.Intn(len(suitable))]
selectedS, err := t.FindServer(selected)
switch {
case err != nil:
return nil, err
case selectedS != nil:
return selectedS, nil
default:
// We don't have an actual server for the provided description.
// This could happen for a number of reasons, including that the
// server has since stopped being a part of this topology, or that
// the server selector returned no suitable servers.
}
}
}
// SelectServerLegacy selects a server with given a selector. SelectServerLegacy complies with the
// server selection spec, and will time out after severSelectionTimeout or when the
// parent context is done.
func (t *Topology) SelectServerLegacy(ctx context.Context, ss description.ServerSelector) (*SelectedServer, error) {
if atomic.LoadInt32(&t.connectionstate) != connected {
return nil, ErrTopologyClosed
}
var ssTimeoutCh <-chan time.Time
if t.cfg.serverSelectionTimeout > 0 {
ssTimeout := time.NewTimer(t.cfg.serverSelectionTimeout)
ssTimeoutCh = ssTimeout.C
defer ssTimeout.Stop()
}
sub, err := t.Subscribe()
if err != nil {
return nil, err
}
defer t.Unsubscribe(sub)
selectionState := newServerSelectionState(ss, ssTimeoutCh)
for {
suitable, err := t.selectServerFromSubscription(ctx, sub.Updates, selectionState)
if err != nil {
return nil, err
}
selected := suitable[rand.Intn(len(suitable))]
selectedS, err := t.FindServer(selected)
switch {
case err != nil:
return nil, err
case selectedS != nil:
return selectedS, nil
default:
// We don't have an actual server for the provided description.
// This could happen for a number of reasons, including that the
// server has since stopped being a part of this topology, or that
// the server selector returned no suitable servers.
}
}
}
// FindServer will attempt to find a server that fits the given server description.
// This method will return nil, nil if a matching server could not be found.
func (t *Topology) FindServer(selected description.Server) (*SelectedServer, error) {
if atomic.LoadInt32(&t.connectionstate) != connected {
return nil, ErrTopologyClosed
}
t.serversLock.Lock()
defer t.serversLock.Unlock()
server, ok := t.servers[selected.Addr]
if !ok {
return nil, nil
}
desc := t.Description()
return &SelectedServer{
Server: server,
Kind: desc.Kind,
}, nil
}
func wrapServerSelectionError(err error, t *Topology) error {
return fmt.Errorf("server selection error: %v, current topology: { %s }", err, t.String())
}
// selectServerFromSubscription loops until a topology description is available for server selection. It returns
// when the given context expires, server selection timeout is reached, or a description containing a selectable
// server is available.
func (t *Topology) selectServerFromSubscription(ctx context.Context, subscriptionCh <-chan description.Topology,
selectionState serverSelectionState) ([]description.Server, error) {
var current description.Topology
for {
select {
case <-ctx.Done():
return nil, ctx.Err()
case <-selectionState.timeoutChan:
return nil, wrapServerSelectionError(ErrServerSelectionTimeout, t)
case current = <-subscriptionCh:
}
suitable, err := t.selectServerFromDescription(ctx, current, selectionState)
if err != nil {
return nil, err
}
if len(suitable) > 0 {
return suitable, nil
}
t.RequestImmediateCheck()
}
}
// selectServerFromDescription process the given topology description and returns a slice of suitable servers.
func (t *Topology) selectServerFromDescription(ctx context.Context, desc description.Topology,
selectionState serverSelectionState) ([]description.Server, error) {
select {
case <-ctx.Done():
return nil, ctx.Err()
case <-selectionState.timeoutChan:
return nil, wrapServerSelectionError(ErrServerSelectionTimeout, t)
default:
}
var allowed []description.Server
for _, s := range desc.Servers {
if s.Kind != description.Unknown {
allowed = append(allowed, s)
}
}
suitable, err := selectionState.selector.SelectServer(desc, allowed)
if err != nil {
return nil, wrapServerSelectionError(err, t)
}
return suitable, nil
}
func (t *Topology) pollSRVRecords() {
defer t.pollingwg.Done()
serverConfig, _ := newServerConfig(t.cfg.serverOpts...)
heartbeatInterval := serverConfig.heartbeatInterval
pollTicker := time.NewTicker(t.rescanSRVInterval)
defer pollTicker.Stop()
t.pollHeartbeatTime.Store(false)
var doneOnce bool
defer func() {
// ¯\_(ツ)_/¯
if r := recover(); r != nil && !doneOnce {
<-t.pollingDone
}
}()
// remove the scheme
uri := t.cfg.cs.Original[14:]
hosts := uri
if idx := strings.IndexAny(uri, "/?@"); idx != -1 {
hosts = uri[:idx]
}
for {
select {
case <-pollTicker.C:
case <-t.pollingDone:
doneOnce = true
return
}
topoKind := t.Description().Kind
if !(topoKind == description.Unknown || topoKind == description.Sharded) {
break
}
parsedHosts, err := t.dnsResolver.ParseHosts(hosts, false)
// DNS problem or no verified hosts returned
if err != nil || len(parsedHosts) == 0 {
if !t.pollHeartbeatTime.Load().(bool) {
pollTicker.Stop()
pollTicker = time.NewTicker(heartbeatInterval)
t.pollHeartbeatTime.Store(true)
}
continue
}
if t.pollHeartbeatTime.Load().(bool) {
pollTicker.Stop()
pollTicker = time.NewTicker(t.rescanSRVInterval)
t.pollHeartbeatTime.Store(false)
}
cont := t.processSRVResults(parsedHosts)
if !cont {
break
}
}
<-t.pollingDone
doneOnce = true
}
func (t *Topology) processSRVResults(parsedHosts []string) bool {
t.serversLock.Lock()
defer t.serversLock.Unlock()
if t.serversClosed {
return false
}
diff := t.fsm.Topology.DiffHostlist(parsedHosts)
if len(diff.Added) == 0 && len(diff.Removed) == 0 {
return true
}
for _, r := range diff.Removed {
addr := address.Address(r).Canonicalize()
s, ok := t.servers[addr]
if !ok {
continue
}
go func() {
cancelCtx, cancel := context.WithCancel(context.Background())
cancel()
_ = s.Disconnect(cancelCtx)
}()
delete(t.servers, addr)
t.fsm.removeServerByAddr(addr)
}
for _, a := range diff.Added {
addr := address.Address(a).Canonicalize()
_ = t.addServer(addr)
t.fsm.addServer(addr)
}
//store new description
newDesc := description.Topology{
Kind: t.fsm.Kind,
Servers: t.fsm.Servers,
SessionTimeoutMinutes: t.fsm.SessionTimeoutMinutes,
}
t.desc.Store(newDesc)
t.subLock.Lock()
for _, ch := range t.subscribers {
// We drain the description if there's one in the channel
select {
case <-ch:
default:
}
ch <- newDesc
}
t.subLock.Unlock()
return true
}
func (t *Topology) apply(ctx context.Context, desc description.Server) {
var err error
t.serversLock.Lock()
defer t.serversLock.Unlock()
if _, ok := t.servers[desc.Addr]; t.serversClosed || !ok {
return
}
prev := t.fsm.Topology
current, err := t.fsm.apply(desc)
if err != nil {
return
}
diff := description.DiffTopology(prev, current)
for _, removed := range diff.Removed {
if s, ok := t.servers[removed.Addr]; ok {
go func() {
cancelCtx, cancel := context.WithCancel(ctx)
cancel()
_ = s.Disconnect(cancelCtx)
}()
delete(t.servers, removed.Addr)
}
}
for _, added := range diff.Added {
_ = t.addServer(added.Addr)
}
t.desc.Store(current)
t.subLock.Lock()
for _, ch := range t.subscribers {
// We drain the description if there's one in the channel
select {
case <-ch:
default:
}
ch <- current
}
t.subLock.Unlock()
}
func (t *Topology) addServer(addr address.Address) error {
if _, ok := t.servers[addr]; ok {
return nil
}
topoFunc := func(desc description.Server) {
t.apply(context.TODO(), desc)
}
svr, err := ConnectServer(addr, topoFunc, t.cfg.serverOpts...)
if err != nil {
return err
}
t.servers[addr] = svr
return nil
}
// String implements the Stringer interface
func (t *Topology) String() string {
desc := t.Description()
serversStr := ""
t.serversLock.Lock()
defer t.serversLock.Unlock()
for _, s := range t.servers {
serversStr += "{ " + s.String() + " }, "
}
return fmt.Sprintf("Type: %s, Servers: [%s]", desc.Kind, serversStr)
}