-
Notifications
You must be signed in to change notification settings - Fork 2.1k
/
watch.go
148 lines (123 loc) · 4.13 KB
/
watch.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
/*
Copyright 2019 The Vitess 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 consultopo
import (
"context"
"path"
"time"
"github.com/hashicorp/consul/api"
"github.com/spf13/pflag"
"vitess.io/vitess/go/vt/servenv"
"vitess.io/vitess/go/vt/topo"
)
var (
watchPollDuration = 30 * time.Second
)
func init() {
servenv.RegisterFlagsForTopoBinaries(registerWatchFlags)
}
func registerWatchFlags(fs *pflag.FlagSet) {
fs.DurationVar(&watchPollDuration, "topo_consul_watch_poll_duration", watchPollDuration, "time of the long poll for watch queries.")
}
// Watch is part of the topo.Conn interface.
func (s *Server) Watch(ctx context.Context, filePath string) (*topo.WatchData, <-chan *topo.WatchData, error) {
// Initial get.
nodePath := path.Join(s.root, filePath)
options := &api.QueryOptions{}
initialCtx, initialCancel := context.WithTimeout(ctx, topo.RemoteOperationTimeout)
defer initialCancel()
pair, _, err := s.kv.Get(nodePath, options.WithContext(initialCtx))
if err != nil {
return nil, nil, err
}
if pair == nil {
// Node doesn't exist.
return nil, nil, topo.NewError(topo.NoNode, nodePath)
}
// Initial value to return.
wd := &topo.WatchData{
Contents: pair.Value,
Version: ConsulVersion(pair.ModifyIndex),
}
// Create the notifications channel, send updates to it.
notifications := make(chan *topo.WatchData, 10)
go func() {
defer close(notifications)
var getCtx context.Context
// Initialize to no-op function to avoid having to check for nil.
cancelGetCtx := func() {}
defer cancelGetCtx()
for {
// Wait/poll until we get a new version.
// Get with a WaitIndex and WaitTime will return
// the current version at the end of WaitTime
// if it didn't change. So we just check for that
// and swallow the notifications when version matches.
waitIndex := pair.ModifyIndex
opts := &api.QueryOptions{
WaitIndex: waitIndex,
WaitTime: watchPollDuration,
}
// Make a new Context for just this one Get() call.
// The server should send us something after WaitTime at the latest.
// If it takes more than 2x that long, assume we've lost contact.
// This essentially uses WaitTime as a heartbeat interval to detect
// a dead connection.
cancelGetCtx()
getCtx, cancelGetCtx = context.WithTimeout(ctx, 2*opts.WaitTime)
pair, _, err = s.kv.Get(nodePath, opts.WithContext(getCtx))
if err != nil {
// Serious error or context timeout/cancelled.
notifications <- &topo.WatchData{
Err: convertError(err, nodePath),
}
cancelGetCtx()
return
}
// If the node disappeared, pair is nil.
if pair == nil {
notifications <- &topo.WatchData{
Err: topo.NewError(topo.NoNode, nodePath),
}
cancelGetCtx()
return
}
// If we got a new value, send it.
if pair.ModifyIndex != waitIndex {
notifications <- &topo.WatchData{
Contents: pair.Value,
Version: ConsulVersion(pair.ModifyIndex),
}
}
// See if the watch was canceled.
select {
case <-ctx.Done():
notifications <- &topo.WatchData{
Err: convertError(ctx.Err(), nodePath),
}
cancelGetCtx()
return
default:
}
}
}()
return wd, notifications, nil
}
// WatchRecursive is part of the topo.Conn interface.
func (s *Server) WatchRecursive(_ context.Context, path string) ([]*topo.WatchDataRecursive, <-chan *topo.WatchDataRecursive, error) {
// This isn't implemented yet, but likely can be implemented using List
// with blocking logic like how we use Get with blocking for regular Watch.
// See also how https://www.consul.io/docs/dynamic-app-config/watches#keyprefix
// works under the hood.
return nil, nil, topo.NewError(topo.NoImplementation, path)
}