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
|
package centrifuge
import (
"net/http"
"sync"
"time"
"github.com/centrifugal/centrifuge/internal/cancelctx"
"github.com/gorilla/websocket"
"github.com/igm/sockjs-go/v3/sockjs"
)
const (
transportSockJS = "sockjs"
)
type sockjsTransport struct {
mu sync.RWMutex
closed bool
closeCh chan struct{}
session sockjs.Session
}
func newSockjsTransport(s sockjs.Session) *sockjsTransport {
t := &sockjsTransport{
session: s,
closeCh: make(chan struct{}),
}
return t
}
// Name returns name of transport.
func (t *sockjsTransport) Name() string {
return transportSockJS
}
// Protocol returns transport protocol.
func (t *sockjsTransport) Protocol() ProtocolType {
return ProtocolTypeJSON
}
// Encoding returns transport encoding.
func (t *sockjsTransport) Encoding() EncodingType {
return EncodingTypeJSON
}
// Write data to transport.
func (t *sockjsTransport) Write(data []byte) error {
select {
case <-t.closeCh:
return nil
default:
return t.session.Send(string(data))
}
}
// Close closes transport.
func (t *sockjsTransport) Close(disconnect *Disconnect) error {
t.mu.Lock()
if t.closed {
// Already closed, noop.
t.mu.Unlock()
return nil
}
t.closed = true
close(t.closeCh)
t.mu.Unlock()
if disconnect == nil {
disconnect = DisconnectNormal
}
return t.session.Close(disconnect.Code, disconnect.CloseText())
}
// SockjsConfig represents config for SockJS handler.
type SockjsConfig struct {
// HandlerPrefix sets prefix for SockJS handler endpoint path.
HandlerPrefix string
// URL is an address to SockJS client javascript library.
URL string
// HeartbeatDelay sets how often to send heartbeat frames to clients.
HeartbeatDelay time.Duration
// CheckOrigin allows to decide whether to use CORS or not in XHR case.
// When false returned then CORS headers won't be set.
CheckOrigin func(*http.Request) bool
// WebsocketCheckOrigin allows to set custom CheckOrigin func for underlying
// Gorilla Websocket based websocket.Upgrader.
WebsocketCheckOrigin func(*http.Request) bool
// WebsocketReadBufferSize is a parameter that is used for raw websocket websocket.Upgrader.
// If set to zero reasonable default value will be used.
WebsocketReadBufferSize int
// WebsocketWriteBufferSize is a parameter that is used for raw websocket websocket.Upgrader.
// If set to zero reasonable default value will be used.
WebsocketWriteBufferSize int
// WebsocketUseWriteBufferPool enables using buffer pool for writes in Websocket transport.
WebsocketUseWriteBufferPool bool
// WebsocketWriteTimeout is maximum time of write message operation.
// Slow client will be disconnected.
// By default DefaultWebsocketWriteTimeout will be used.
WebsocketWriteTimeout time.Duration
}
// SockjsHandler accepts SockJS connections. SockJS has a bunch of fallback
// transports when WebSocket connection is not supported. It comes with additional
// costs though: small protocol framing overhead, lack of binary support, more
// goroutines per connection, and you need to use sticky session mechanism on
// your load balancer in case you are using HTTP-based SockJS fallbacks and have
// more than one Centrifuge Node on a backend (so SockJS to be able to emulate
// bidirectional protocol). So if you can afford it - use WebsocketHandler only.
type SockjsHandler struct {
node *Node
config SockjsConfig
handler http.Handler
}
// NewSockjsHandler creates new SockjsHandler.
func NewSockjsHandler(n *Node, c SockjsConfig) *SockjsHandler {
options := sockjs.DefaultOptions
wsUpgrader := &websocket.Upgrader{
ReadBufferSize: c.WebsocketReadBufferSize,
WriteBufferSize: c.WebsocketWriteBufferSize,
Error: func(w http.ResponseWriter, r *http.Request, status int, reason error) {},
}
if c.WebsocketCheckOrigin != nil {
wsUpgrader.CheckOrigin = c.WebsocketCheckOrigin
} else {
wsUpgrader.CheckOrigin = sameHostOriginCheck(n)
}
if c.WebsocketUseWriteBufferPool {
wsUpgrader.WriteBufferPool = writeBufferPool
} else {
wsUpgrader.WriteBufferSize = c.WebsocketWriteBufferSize
}
options.WebsocketUpgrader = wsUpgrader
// Override sockjs url. It's important to use the same SockJS
// library version on client and server sides when using iframe
// based SockJS transports, otherwise SockJS will raise error
// about version mismatch.
options.SockJSURL = c.URL
if c.CheckOrigin != nil {
options.CheckOrigin = c.CheckOrigin
} else {
options.CheckOrigin = sameHostOriginCheck(n)
}
options.HeartbeatDelay = c.HeartbeatDelay
wsWriteTimeout := c.WebsocketWriteTimeout
if wsWriteTimeout == 0 {
wsWriteTimeout = DefaultWebsocketWriteTimeout
}
options.WebsocketWriteTimeout = wsWriteTimeout
s := &SockjsHandler{
node: n,
config: c,
}
handler := newSockJSHandler(s, c.HandlerPrefix, options)
s.handler = handler
return s
}
func (s *SockjsHandler) ServeHTTP(rw http.ResponseWriter, r *http.Request) {
s.handler.ServeHTTP(rw, r)
}
// newSockJSHandler returns SockJS handler bind to sockjsPrefix url prefix.
// SockJS handler has several handlers inside responsible for various tasks
// according to SockJS protocol.
func newSockJSHandler(s *SockjsHandler, sockjsPrefix string, sockjsOpts sockjs.Options) http.Handler {
return sockjs.NewHandler(sockjsPrefix, sockjsOpts, s.sockJSHandler)
}
// sockJSHandler called when new client connection comes to SockJS endpoint.
func (s *SockjsHandler) sockJSHandler(sess sockjs.Session) {
incTransportConnect(transportSockJS)
// Separate goroutine for better GC of caller's data.
go func() {
transport := newSockjsTransport(sess)
select {
case <-s.node.NotifyShutdown():
_ = transport.Close(DisconnectShutdown)
return
default:
}
ctxCh := make(chan struct{})
defer close(ctxCh)
c, closeFn, err := NewClient(cancelctx.New(sess.Request().Context(), ctxCh), s.node, transport)
if err != nil {
s.node.logger.log(newLogEntry(LogLevelError, "error creating client", map[string]interface{}{"transport": transportSockJS}))
return
}
defer func() { _ = closeFn() }()
s.node.logger.log(newLogEntry(LogLevelDebug, "client connection established", map[string]interface{}{"client": c.ID(), "transport": transportSockJS}))
defer func(started time.Time) {
s.node.logger.log(newLogEntry(LogLevelDebug, "client connection completed", map[string]interface{}{"client": c.ID(), "transport": transportSockJS, "duration": time.Since(started)}))
}(time.Now())
var needWaitLoop bool
for {
if msg, err := sess.Recv(); err == nil {
if ok := c.Handle([]byte(msg)); !ok {
needWaitLoop = true
break
}
continue
}
break
}
if needWaitLoop {
// One extra loop till we get an error from session,
// this is required to wait until close frame will be sent
// into connection inside Client implementation and transport
// closed with proper disconnect reason.
for {
if _, err := sess.Recv(); err != nil {
break
}
}
}
}()
}
|