mirror of
https://github.com/coder/coder.git
synced 2026-06-03 04:58:23 +00:00
Spike Curtis
49b34a716a
Upgrades to slog v3 which includes a small, but backward incompatible API change to the acceptible call arguments when logging. This change allows us to verify via compile time type checking that arguments are correct and won't cause a panic, as was possible in slog v1, which this replaces (v2 was tagged but never used in coder/coder). It also updates dependencies that also use slog and were updated. I've left the `aibridge` dependency as a commit SHA, under the assumption that the team there (cc @pawbana @dannykopping ) will tag and update the dependency soon and on their own schedule. Other dependencies, I pushed new tags.
71 lines
1.6 KiB
Go
71 lines
1.6 KiB
Go
package httpapi
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"time"
|
|
|
|
"golang.org/x/xerrors"
|
|
|
|
"cdr.dev/slog/v3"
|
|
|
|
"github.com/coder/websocket"
|
|
)
|
|
|
|
const HeartbeatInterval time.Duration = 15 * time.Second
|
|
|
|
// Heartbeat loops to ping a WebSocket to keep it alive.
|
|
// Default idle connection timeouts are typically 60 seconds.
|
|
// See: https://docs.aws.amazon.com/elasticloadbalancing/latest/application/application-load-balancers.html#connection-idle-timeout
|
|
func Heartbeat(ctx context.Context, conn *websocket.Conn) {
|
|
ticker := time.NewTicker(HeartbeatInterval)
|
|
defer ticker.Stop()
|
|
for {
|
|
select {
|
|
case <-ctx.Done():
|
|
return
|
|
case <-ticker.C:
|
|
}
|
|
err := conn.Ping(ctx)
|
|
if err != nil {
|
|
return
|
|
}
|
|
}
|
|
}
|
|
|
|
// Heartbeat loops to ping a WebSocket to keep it alive. It calls `exit` on ping
|
|
// failure.
|
|
func HeartbeatClose(ctx context.Context, logger slog.Logger, exit func(), conn *websocket.Conn) {
|
|
ticker := time.NewTicker(HeartbeatInterval)
|
|
defer ticker.Stop()
|
|
|
|
for {
|
|
select {
|
|
case <-ctx.Done():
|
|
return
|
|
case <-ticker.C:
|
|
}
|
|
err := pingWithTimeout(ctx, conn, HeartbeatInterval)
|
|
if err != nil {
|
|
// context.DeadlineExceeded is expected when the client disconnects without sending a close frame
|
|
if !errors.Is(err, context.DeadlineExceeded) {
|
|
logger.Error(ctx, "failed to heartbeat ping", slog.Error(err))
|
|
}
|
|
_ = conn.Close(websocket.StatusGoingAway, "Ping failed")
|
|
exit()
|
|
return
|
|
}
|
|
}
|
|
}
|
|
|
|
func pingWithTimeout(ctx context.Context, conn *websocket.Conn, timeout time.Duration) error {
|
|
ctx, cancel := context.WithTimeout(ctx, timeout)
|
|
defer cancel()
|
|
err := conn.Ping(ctx)
|
|
if err != nil {
|
|
return xerrors.Errorf("failed to ping: %w", err)
|
|
}
|
|
|
|
return nil
|
|
}
|