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
|
package events
import (
"context"
"encoding/json"
"errors"
"fmt"
"io"
"net"
"sync"
"time"
"github.com/gorilla/websocket"
"github.com/lxc/incus/v6/shared/api"
"github.com/lxc/incus/v6/shared/logger"
)
// EventListenerConnection represents an event listener connection.
type EventListenerConnection interface {
Reader(ctx context.Context, recvFunc EventHandler)
WriteJSON(event any) error
Close() error
LocalAddr() net.Addr // Used for logging
RemoteAddr() net.Addr // Used for logging
}
type websockListenerConnection struct {
*websocket.Conn
lock sync.Mutex
pongsPending int
}
type streamListenerConnection struct {
net.Conn
lock sync.Mutex
}
type simpleListenerConnection struct {
rwc io.ReadWriteCloser
lock sync.Mutex
}
// NewWebsocketListenerConnection returns a new websocket listener connection.
func NewWebsocketListenerConnection(connection *websocket.Conn) EventListenerConnection {
return &websockListenerConnection{
Conn: connection,
}
}
func (e *websockListenerConnection) Reader(ctx context.Context, recvFunc EventHandler) {
ctx, cancelFunc := context.WithCancel(ctx)
closeFunc := func() {
e.lock.Lock()
defer e.lock.Unlock()
if ctx.Err() != nil {
return
}
err := e.Close()
if err != nil {
logger.Warn("Failed closing connection", logger.Ctx{"err": err})
}
cancelFunc()
}
defer closeFunc()
pingInterval := time.Second * 10
e.pongsPending = 0
e.SetPongHandler(func(msg string) error {
e.lock.Lock()
e.pongsPending = 0
e.lock.Unlock()
return nil
})
// Start reader from client.
go func() {
defer closeFunc()
if recvFunc != nil {
for {
var event api.Event
err := e.Conn.ReadJSON(&event)
if err != nil {
return // This detects if client has disconnected or sent invalid data.
}
// Pass received event to the handler.
recvFunc(event)
}
} else {
// Run a blocking reader to detect if the client has disconnected. We don't expect to get
// anything from the remote side, so this should remain blocked until disconnected.
_, _, _ = e.Conn.NextReader()
}
}()
t := time.NewTicker(pingInterval)
defer t.Stop()
for {
if ctx.Err() != nil {
return
}
e.lock.Lock()
if e.pongsPending > 2 {
e.lock.Unlock()
return
}
err := e.WriteControl(websocket.PingMessage, []byte("keepalive"), time.Now().Add(5*time.Second))
if err != nil {
e.lock.Unlock()
return
}
e.pongsPending++
e.lock.Unlock()
select {
case <-t.C:
case <-ctx.Done():
return
}
}
}
func (e *websockListenerConnection) WriteJSON(event any) error {
e.lock.Lock()
defer e.lock.Unlock()
err := e.Conn.SetWriteDeadline(time.Now().Add(5 * time.Second))
if err != nil {
return fmt.Errorf("Failed setting write deadline: %w", err)
}
return e.Conn.WriteJSON(event)
}
// NewStreamListenerConnection returns a new http stream listener connection.
func NewStreamListenerConnection(connection net.Conn) (EventListenerConnection, error) {
// Send HTTP response to let the client know what to expect.
// This is only sent once, and is followed by events.
//
// The X-Content-Type-Options response HTTP header is a marker used by the server to indicate
// that the MIME types advertised in the Content-Type headers should be followed and not be
// changed. The header allows you to avoid MIME type sniffing by saying that the MIME types are
// deliberately configured.
_, err := io.WriteString(connection, `HTTP/1.1 200 OK
Connection: keep-alive
Content-Type: application/json
X-Content-Type-Options: nosniff
`)
if err != nil {
return nil, fmt.Errorf("Failed sending initial HTTP response: %w", err)
}
return &streamListenerConnection{
Conn: connection,
}, nil
}
func (e *streamListenerConnection) Reader(ctx context.Context, recvFunc EventHandler) {
ctx, cancelFunc := context.WithCancel(ctx)
closeFunc := func() {
e.lock.Lock()
defer e.lock.Unlock()
if ctx.Err() != nil {
return
}
err := e.Close()
if err != nil {
logger.Warn("Failed closing connection", logger.Ctx{"err": err})
}
cancelFunc()
}
defer closeFunc()
// Start reader from client.
go func() {
defer closeFunc()
buf := make([]byte, 1)
// This is used to determine whether the client has terminated.
_, err := e.Read(buf)
if err != nil && errors.Is(err, io.EOF) {
return
}
}()
if ctx.Err() != nil {
return
}
<-ctx.Done()
}
func (e *streamListenerConnection) WriteJSON(event any) error {
e.lock.Lock()
defer e.lock.Unlock()
err := e.SetWriteDeadline(time.Now().Add(5 * (time.Second)))
if err != nil {
return fmt.Errorf("Failed setting write deadline: %w", err)
}
err = json.NewEncoder(e.Conn).Encode(event)
if err != nil {
return fmt.Errorf("Failed sending event: %w", err)
}
return nil
}
func (e *streamListenerConnection) Close() error {
return e.Conn.Close()
}
// NewSimpleListenerConnection returns a new simple listener connection.
func NewSimpleListenerConnection(rwc io.ReadWriteCloser) EventListenerConnection {
return &simpleListenerConnection{
rwc: rwc,
}
}
func (e *simpleListenerConnection) Reader(ctx context.Context, recvFunc EventHandler) {
ctx, cancelFunc := context.WithCancel(ctx)
closeFunc := func() {
e.lock.Lock()
defer e.lock.Unlock()
if ctx.Err() != nil {
return
}
err := e.Close()
if err != nil {
logger.Warn("Failed closing connection", logger.Ctx{"err": err})
}
cancelFunc()
}
defer closeFunc()
// Start reader from client.
go func() {
defer closeFunc()
buf := make([]byte, 1)
// This is used to determine whether the client has terminated.
_, err := e.rwc.Read(buf)
if err != nil && errors.Is(err, io.EOF) {
return
}
}()
if ctx.Err() != nil {
return
}
<-ctx.Done()
}
func (e *simpleListenerConnection) WriteJSON(event any) error {
err := json.NewEncoder(e.rwc).Encode(event)
if err != nil {
return err
}
return nil
}
func (e *simpleListenerConnection) Close() error {
return e.rwc.Close()
}
func (e *simpleListenerConnection) LocalAddr() net.Addr { // Used for logging
return nil
}
func (e *simpleListenerConnection) RemoteAddr() net.Addr { // Used for logging
return nil
}
|