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
|
package connectors
import (
"errors"
"fmt"
"sync"
"time"
"github.com/mimecast/dtail/internal/clients/handlers"
"github.com/mimecast/dtail/internal/io/dlog"
"github.com/mimecast/dtail/internal/omode"
"github.com/mimecast/dtail/internal/protocol"
sessionspec "github.com/mimecast/dtail/internal/session"
)
var (
// ErrSessionUnsupported indicates that the remote side did not advertise
// runtime query update support.
ErrSessionUnsupported = errors.New("runtime query updates unsupported by server")
// ErrSessionAckTimeout indicates that no hidden SESSION acknowledgement arrived in time.
ErrSessionAckTimeout = errors.New("timed out waiting for session acknowledgement")
// ErrSessionRejected indicates that the server explicitly rejected a SESSION request.
ErrSessionRejected = errors.New("session request rejected")
// ErrUnexpectedSessionAck indicates that the client received a malformed or mismatched acknowledgement.
ErrUnexpectedSessionAck = errors.New("unexpected session acknowledgement")
// ErrJournalUnsupported indicates that the remote side did not advertise journal support.
ErrJournalUnsupported = errors.New("journal file targets unsupported by server")
)
const defaultSessionAckTimeout = 2 * time.Second
type committedSessionState struct {
applyMu sync.Mutex
mu sync.RWMutex
committed bool
generation uint64
spec sessionspec.Spec
}
func (s *committedSessionState) commit(spec sessionspec.Spec, generation uint64) {
s.mu.Lock()
defer s.mu.Unlock()
s.committed = true
s.generation = generation
s.spec = spec
}
func (s *committedSessionState) restore(spec sessionspec.Spec, generation uint64, committed bool) {
s.mu.Lock()
defer s.mu.Unlock()
if !committed {
s.committed = false
s.generation = 0
s.spec = sessionspec.Spec{}
return
}
s.committed = true
s.generation = generation
s.spec = spec
}
func (s *committedSessionState) clear() {
s.mu.Lock()
defer s.mu.Unlock()
s.committed = false
s.generation = 0
s.spec = sessionspec.Spec{}
}
func (s *committedSessionState) snapshot() (sessionspec.Spec, uint64, bool) {
s.mu.RLock()
defer s.mu.RUnlock()
return s.spec, s.generation, s.committed
}
func dispatchInitialCommands(server string, handler handlers.Handler, commands []string,
interactiveQuery bool, initialSpec sessionspec.Spec, state *committedSessionState) error {
if !interactiveQuery || initialSpec.Mode == omode.Unknown {
if err := requireJournalCapability(server, handler, initialSpec, defaultCapabilityWait); err != nil {
return err
}
return sendLegacyCommands(handler, commands)
}
if err := applySessionSpec(server, handler, state, initialSpec, defaultSessionAckTimeout); err != nil {
if !errors.Is(err, ErrSessionUnsupported) {
state.clear()
return err
}
dlog.Client.Warn(server, "Interactive session bootstrap unsupported, falling back to legacy commands", err)
state.clear()
return sendLegacyCommands(handler, commands)
}
return nil
}
func applySessionSpec(server string, handler handlers.Handler,
state *committedSessionState, spec sessionspec.Spec, timeout time.Duration) error {
return applySessionSpecWithGeneration(server, handler, state, spec, 0, true, timeout)
}
func applySessionSpecWithGeneration(server string, handler handlers.Handler,
state *committedSessionState, spec sessionspec.Spec, generation uint64, useCurrentGeneration bool, timeout time.Duration) error {
// Serialize session transitions so an interactive reload cannot race the
// initial SESSION START bootstrap on the same connection.
state.applyMu.Lock()
defer state.applyMu.Unlock()
if useCurrentGeneration {
_, generation, _ = state.snapshot()
}
if err := requireJournalCapability(server, handler, spec, defaultCapabilityWait); err != nil {
return err
}
if !supportsQueryUpdates(handler, defaultCapabilityWait) {
return ErrSessionUnsupported
}
action := "start"
nextGeneration := uint64(0)
command, err := spec.StartCommand()
if err != nil {
return err
}
if generation != 0 {
action = "update"
nextGeneration = generation + 1
command, err = spec.UpdateCommand(nextGeneration)
if err != nil {
return err
}
}
drainSessionAcks(handler)
if err := handler.SendMessage(command); err != nil {
return err
}
ack, ok := handler.WaitForSessionAck(resolveSessionAckTimeout(timeout))
if !ok {
return ErrSessionAckTimeout
}
if ack.Error != "" {
return fmt.Errorf("%w: %s", ErrSessionRejected, ack.Error)
}
if ack.Action != action {
return fmt.Errorf("%w: got action %q want %q", ErrUnexpectedSessionAck, ack.Action, action)
}
if ack.Generation == 0 {
return fmt.Errorf("%w: missing generation", ErrUnexpectedSessionAck)
}
if action == "update" && ack.Generation != nextGeneration {
return fmt.Errorf("%w: got generation %d want %d", ErrUnexpectedSessionAck, ack.Generation, nextGeneration)
}
state.commit(spec, ack.Generation)
dlog.Client.Debug(server, "Committed session spec", "action", action, "generation", ack.Generation)
return nil
}
func requireJournalCapability(server string, handler handlers.Handler, spec sessionspec.Spec, timeout time.Duration) error {
if !spec.HasJournalFiles() {
return nil
}
if handler == nil {
return ErrJournalUnsupported
}
if timeout <= 0 {
timeout = defaultCapabilityWait
}
if handler.WaitForCapabilities(timeout) && handler.HasCapability(protocol.CapabilityJournalV1) {
return nil
}
message := fmt.Sprintf("journal file targets require server capability %s", protocol.CapabilityJournalV1)
handler.ReportServerError(message)
return fmt.Errorf("%w: %s", ErrJournalUnsupported, server)
}
func sendLegacyCommands(handler handlers.Handler, commands []string) error {
for _, command := range commands {
if err := handler.SendMessage(command); err != nil {
return err
}
}
return nil
}
func drainSessionAcks(handler handlers.Handler) {
for {
if _, ok := handler.WaitForSessionAck(0); !ok {
return
}
}
}
func resolveSessionAckTimeout(timeout time.Duration) time.Duration {
if timeout <= 0 {
return defaultSessionAckTimeout
}
return timeout
}
|
