forked from recws-org/recws
/
recws.go
576 lines (473 loc) · 13 KB
/
recws.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
// Package recws provides websocket client based on gorilla/websocket
// that will automatically reconnect if the connection is dropped.
package recws
import (
"crypto/tls"
"errors"
"log"
"math/rand"
"net/http"
"net/url"
"sync"
"sync/atomic"
"time"
"github.com/gorilla/websocket"
"github.com/jpillora/backoff"
)
// ErrNotConnected is returned when the application read/writes
// a message and the connection is closed
var ErrNotConnected = errors.New("websocket: not connected")
// The RecConn type represents a Reconnecting WebSocket connection.
type RecConn struct {
// RecIntvlMin specifies the initial reconnecting interval,
// default to 2 seconds
RecIntvlMin time.Duration
// RecIntvlMax specifies the maximum reconnecting interval,
// default to 30 seconds
RecIntvlMax time.Duration
// RecIntvlFactor specifies the rate of increase of the reconnection
// interval, default to 1.5
RecIntvlFactor float64
// HandshakeTimeout specifies the duration for the handshake to complete,
// default to 2 seconds
HandshakeTimeout time.Duration
// Proxy specifies the proxy function for the dialer
// defaults to ProxyFromEnvironment
Proxy func(*http.Request) (*url.URL, error)
// Client TLS config to use on reconnect
TLSClientConfig *tls.Config
// SubscribeHandler fires after the connection successfully establish.
SubscribeHandler func() error
// DisconnectHandler fires after the connection has been closed
DisconnectHandler func()
// PongHandler fires on every Pong control message received
PongHandler func() error
// KeepAliveTimeout is an interval for sending ping/pong messages
// disabled if 0
KeepAliveTimeout time.Duration
// keepAliveDone is a channel which triggers the closing of all
// previous monitoring goroutines
keepAliveDone chan struct{}
// NonVerbose suppress connecting/reconnecting messages.
NonVerbose bool
isConnected bool
isReconnecting bool
mu sync.RWMutex
url string
reqHeader http.Header
httpResp *http.Response
dialErr error
dialer *websocket.Dialer
*websocket.Conn
}
var keepAliveCounter int64
// CloseAndReconnect will try to reconnect.
func (rc *RecConn) CloseAndReconnect() {
if rc.IsReconnecting() {
return
}
rc.setIsReconnecting(true)
rc.Close()
go rc.connect()
}
// setIsConnected sets state for isConnected
func (rc *RecConn) setIsConnected(state bool) {
rc.mu.Lock()
defer rc.mu.Unlock()
rc.isConnected = state
}
func (rc *RecConn) getConn() *websocket.Conn {
rc.mu.RLock()
defer rc.mu.RUnlock()
return rc.Conn
}
// Close closes the underlying network connection without
// sending or waiting for a close frame.
func (rc *RecConn) Close() {
if rc.getConn() != nil {
rc.mu.Lock()
rc.Conn.Close()
rc.mu.Unlock()
}
rc.setIsConnected(false)
if rc.hasDisconnectHandler() {
rc.DisconnectHandler()
}
}
// Shutdown gracefully closes the connection by sending the websocket.CloseMessage.
// The writeWait param defines the duration before the deadline of the write operation is hit.
func (rc *RecConn) Shutdown(writeWait time.Duration) {
msg := websocket.FormatCloseMessage(websocket.CloseNormalClosure, "")
err := rc.WriteControl(websocket.CloseMessage, msg, time.Now().Add(writeWait))
if err != nil && err != websocket.ErrCloseSent {
// If close message could not be sent, then close without the handshake.
log.Printf("Shutdown: %v", err)
rc.Close()
}
}
// ReadMessage is a helper method for getting a reader
// using NextReader and reading from that reader to a buffer.
//
// If the connection is closed ErrNotConnected is returned
func (rc *RecConn) ReadMessage() (messageType int, message []byte, err error) {
err = ErrNotConnected
if rc.IsConnected() {
messageType, message, err = rc.Conn.ReadMessage()
if websocket.IsCloseError(err, websocket.CloseNormalClosure) {
rc.Close()
return messageType, message, nil
}
if err != nil {
rc.CloseAndReconnect()
}
}
return
}
// WriteMessage is a helper method for getting a writer using NextWriter,
// writing the message and closing the writer.
//
// If the connection is closed ErrNotConnected is returned
func (rc *RecConn) WriteMessage(messageType int, data []byte) error {
err := ErrNotConnected
if rc.IsConnected() {
rc.mu.Lock()
err = rc.Conn.WriteMessage(messageType, data)
rc.mu.Unlock()
if websocket.IsCloseError(err, websocket.CloseNormalClosure) {
rc.Close()
return nil
}
if err != nil {
rc.CloseAndReconnect()
}
}
return err
}
// WriteJSON writes the JSON encoding of v to the connection.
//
// See the documentation for encoding/json Marshal for details about the
// conversion of Go values to JSON.
//
// If the connection is closed ErrNotConnected is returned
func (rc *RecConn) WriteJSON(v interface{}) error {
err := ErrNotConnected
if rc.IsConnected() {
rc.mu.Lock()
err = rc.Conn.WriteJSON(v)
rc.mu.Unlock()
if websocket.IsCloseError(err, websocket.CloseNormalClosure) {
rc.Close()
return nil
}
if err != nil {
rc.CloseAndReconnect()
}
}
return err
}
// ReadJSON reads the next JSON-encoded message from the connection and stores
// it in the value pointed to by v.
//
// See the documentation for the encoding/json Unmarshal function for details
// about the conversion of JSON to a Go value.
//
// If the connection is closed ErrNotConnected is returned
func (rc *RecConn) ReadJSON(v interface{}) error {
err := ErrNotConnected
if rc.IsConnected() {
err = rc.Conn.ReadJSON(v)
if websocket.IsCloseError(err, websocket.CloseNormalClosure) {
rc.Close()
return nil
}
if err != nil {
rc.CloseAndReconnect()
}
}
return err
}
func (rc *RecConn) setURL(url string) {
rc.mu.Lock()
defer rc.mu.Unlock()
rc.url = url
}
func (rc *RecConn) setReqHeader(reqHeader http.Header) {
rc.mu.Lock()
defer rc.mu.Unlock()
rc.reqHeader = reqHeader
}
// parseURL parses current url
func (rc *RecConn) parseURL(urlStr string) (string, error) {
if urlStr == "" {
return "", errors.New("dial: url cannot be empty")
}
u, err := url.Parse(urlStr)
if err != nil {
return "", errors.New("url: " + err.Error())
}
if u.Scheme != "ws" && u.Scheme != "wss" {
return "", errors.New("url: websocket uris must start with ws or wss scheme")
}
if u.User != nil {
return "", errors.New("url: user name and password are not allowed in websocket URIs")
}
return urlStr, nil
}
func (rc *RecConn) setDefaultRecIntvlMin() {
rc.mu.Lock()
defer rc.mu.Unlock()
if rc.RecIntvlMin <= 0 {
rc.RecIntvlMin = 2 * time.Second
}
}
func (rc *RecConn) setDefaultRecIntvlMax() {
rc.mu.Lock()
defer rc.mu.Unlock()
if rc.RecIntvlMax <= 0 {
rc.RecIntvlMax = 30 * time.Second
}
}
func (rc *RecConn) setDefaultRecIntvlFactor() {
rc.mu.Lock()
defer rc.mu.Unlock()
if rc.RecIntvlFactor <= 0 {
rc.RecIntvlFactor = 1.5
}
}
func (rc *RecConn) setDefaultHandshakeTimeout() {
rc.mu.Lock()
defer rc.mu.Unlock()
if rc.HandshakeTimeout <= 0 {
rc.HandshakeTimeout = 2 * time.Second
}
}
func (rc *RecConn) setDefaultProxy() {
rc.mu.Lock()
defer rc.mu.Unlock()
if rc.Proxy == nil {
rc.Proxy = http.ProxyFromEnvironment
}
}
func (rc *RecConn) setDefaultDialer(tlsClientConfig *tls.Config, handshakeTimeout time.Duration) {
rc.mu.Lock()
defer rc.mu.Unlock()
rc.dialer = &websocket.Dialer{
HandshakeTimeout: handshakeTimeout,
Proxy: rc.Proxy,
TLSClientConfig: tlsClientConfig,
}
}
func (rc *RecConn) getHandshakeTimeout() time.Duration {
rc.mu.RLock()
defer rc.mu.RUnlock()
return rc.HandshakeTimeout
}
func (rc *RecConn) getTLSClientConfig() *tls.Config {
rc.mu.RLock()
defer rc.mu.RUnlock()
return rc.TLSClientConfig
}
func (rc *RecConn) SetTLSClientConfig(tlsClientConfig *tls.Config) {
rc.mu.Lock()
defer rc.mu.Unlock()
rc.TLSClientConfig = tlsClientConfig
}
// Dial creates a new client connection.
// The URL url specifies the host and request URI. Use requestHeader to specify
// the origin (Origin), subprotocols (Sec-WebSocket-Protocol) and cookies
// (Cookie). Use GetHTTPResponse() method for the response.Header to get
// the selected subprotocol (Sec-WebSocket-Protocol) and cookies (Set-Cookie).
func (rc *RecConn) Dial(urlStr string, reqHeader http.Header) {
urlStr, err := rc.parseURL(urlStr)
if err != nil {
log.Fatalf("Dial: %v", err)
}
// Config
rc.setURL(urlStr)
rc.setReqHeader(reqHeader)
rc.setDefaultRecIntvlMin()
rc.setDefaultRecIntvlMax()
rc.setDefaultRecIntvlFactor()
rc.setDefaultHandshakeTimeout()
rc.setDefaultProxy()
rc.setDefaultDialer(rc.getTLSClientConfig(), rc.getHandshakeTimeout())
// Connect
go rc.connect()
// wait on first attempt
time.Sleep(rc.getHandshakeTimeout())
}
// GetURL returns current connection url
func (rc *RecConn) GetURL() string {
rc.mu.RLock()
defer rc.mu.RUnlock()
return rc.url
}
func (rc *RecConn) getNonVerbose() bool {
rc.mu.RLock()
defer rc.mu.RUnlock()
return rc.NonVerbose
}
func (rc *RecConn) getBackoff() *backoff.Backoff {
rc.mu.RLock()
defer rc.mu.RUnlock()
return &backoff.Backoff{
Min: rc.RecIntvlMin,
Max: rc.RecIntvlMax,
Factor: rc.RecIntvlFactor,
Jitter: true,
}
}
func (rc *RecConn) hasSubscribeHandler() bool {
rc.mu.RLock()
defer rc.mu.RUnlock()
return rc.SubscribeHandler != nil
}
func (rc *RecConn) hasDisconnectHandler() bool {
rc.mu.RLock()
defer rc.mu.RUnlock()
return rc.DisconnectHandler != nil
}
func (rc *RecConn) hasPongHandler() bool {
rc.mu.RLock()
defer rc.mu.RUnlock()
return rc.PongHandler != nil
}
func (rc *RecConn) getKeepAliveTimeout() time.Duration {
rc.mu.RLock()
defer rc.mu.RUnlock()
return rc.KeepAliveTimeout
}
func (rc *RecConn) resetKeepAliveDone() chan struct{} {
rc.mu.RLock()
defer rc.mu.RUnlock()
if rc.keepAliveDone != nil {
close(rc.keepAliveDone)
}
rc.keepAliveDone = make(chan struct{})
return rc.keepAliveDone
}
func (rc *RecConn) writeControlPingMessage(writeWait time.Duration) error {
rc.mu.Lock()
defer rc.mu.Unlock()
return rc.Conn.WriteControl(websocket.PingMessage, []byte{}, time.Now().Add(writeWait))
}
func (rc *RecConn) keepAlive() {
var (
keepAliveResponse = new(keepAliveResponse)
keepAliveTimeout = rc.getKeepAliveTimeout()
keepAliveDone = rc.resetKeepAliveDone()
keepAliveId = atomic.AddInt64(&keepAliveCounter, 1)
ticker = time.NewTicker(keepAliveTimeout)
pingTicker = time.NewTicker(time.Second)
pingSent = false
)
if !rc.getNonVerbose() {
log.Printf("WS: started Keep Alive #%d\n", keepAliveId)
}
rc.mu.Lock()
rc.Conn.SetPongHandler(func(msg string) error {
keepAliveResponse.setLastResponse()
if rc.hasPongHandler() {
return rc.PongHandler()
}
return nil
})
rc.mu.Unlock()
go func() {
defer ticker.Stop()
defer pingTicker.Stop()
for {
select {
case <-keepAliveDone:
log.Printf("WS: closed Keep Alive #%d\n", keepAliveId)
return
case <-pingTicker.C:
if !pingSent && rc.IsConnected() {
if err := rc.writeControlPingMessage(keepAliveTimeout); err != nil {
log.Println(err)
}
pingSent = true
}
case <-ticker.C:
if time.Since(keepAliveResponse.getLastResponse()) > keepAliveTimeout {
rc.CloseAndReconnect()
if !rc.getNonVerbose() {
log.Printf("WS: closed Keep Alive #%d\n", keepAliveId)
}
return
}
pingSent = false
}
}
}()
}
func (rc *RecConn) connect() {
b := rc.getBackoff()
rand.Seed(time.Now().UTC().UnixNano())
for {
nextItvl := b.Duration()
wsConn, httpResp, err := rc.dialer.Dial(rc.url, rc.reqHeader)
rc.mu.Lock()
rc.Conn = wsConn
rc.dialErr = err
rc.isConnected = err == nil
rc.httpResp = httpResp
rc.mu.Unlock()
if err == nil {
if rc.hasSubscribeHandler() {
if err := rc.SubscribeHandler(); err != nil {
log.Fatalf("Dial: connect handler failed with %s", err.Error())
}
if !rc.getNonVerbose() {
log.Printf("Dial: connect handler was successfully established with %s\n", rc.url)
}
} else {
if !rc.getNonVerbose() {
log.Printf("Dial: connection was successfully established with %s\n", rc.url)
}
}
rc.setIsReconnecting(false)
if rc.getKeepAliveTimeout() > 0 {
rc.keepAlive()
}
return
}
if !rc.getNonVerbose() {
log.Println(err)
log.Println("Dial: will try again in", nextItvl, "seconds.")
}
time.Sleep(nextItvl)
}
}
// GetHTTPResponse returns the http response from the handshake.
// Useful when WebSocket handshake fails,
// so that callers can handle redirects, authentication, etc.
func (rc *RecConn) GetHTTPResponse() *http.Response {
rc.mu.RLock()
defer rc.mu.RUnlock()
return rc.httpResp
}
// GetDialError returns the last dialer error.
// nil on successful connection.
func (rc *RecConn) GetDialError() error {
rc.mu.RLock()
defer rc.mu.RUnlock()
return rc.dialErr
}
// IsConnected returns the WebSocket connection state
func (rc *RecConn) IsConnected() bool {
rc.mu.RLock()
defer rc.mu.RUnlock()
return rc.isConnected
}
func (rc *RecConn) setIsReconnecting(isReconnecting bool) {
rc.mu.Lock()
defer rc.mu.Unlock()
rc.isReconnecting = isReconnecting
}
// IsReconnecting returns whether the connection is being reinstated
func (rc *RecConn) IsReconnecting() bool {
rc.mu.RLock()
defer rc.mu.RUnlock()
return rc.isReconnecting
}