mirror of
https://github.com/J3vb/OwnCord.git
synced 2026-09-03 03:50:00 +03:00
Applied from a deadcode (RTA from mains, all build tags) sweep with
per-symbol adversarial verification:
Deleted (nothing but their own self-tests used them):
- admin.Handler (deprecated since Phase 6; production mounts NewHandler)
plus its two self-tests
- ws.Hub.broadcastVoiceStateUpdate + wrapper + two self-tests (pre-V2
leftover; the live voice_state path is the hub voice routines)
- ws.VoiceLeaveEvent + methods ('retained as scaffolding', never
constructed in production; MsgTypeVoiceLeaveBC stays — live via the
leave routine)
- ws.parseIdentity (production calls parseParticipantIdentity directly;
ParseIdentityForTest now exercises the real parser)
- telemetry.Float64 (String/Int64 are used; the float case is covered by
the otel-tagged internal test, re-addable when a caller appears)
Moved into export_test.go so they leave the production binary (all
callers are same-package tests): the eight ws test-client constructors
and voice/E2EE setters from ws/client.go, admin.SetBackupBaseDir
(new admin/export_test.go), api.SecurityHeaders (test-only wrapper;
production uses SecurityHeadersWithTLS — docs/api.md updated to the
real name). Client.getVoiceJoinToken/setVoiceChID inlined into their
existing ForTest wrappers; TestSetVoiceChID_* self-tests deleted.
Kept after verification: updater.SetBaseURL (11 cross-package test call
sites) and telemetry.resetAppMetricsForInit (live under -tags otel —
untagged deadcode false positive).
Full gate green: gofmt/vet, 4 build-tag variants, full suite, deadlock,
race.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
267 lines
8.4 KiB
Go
267 lines
8.4 KiB
Go
package ws
|
|
|
|
import (
|
|
"context"
|
|
"log/slog"
|
|
"time"
|
|
|
|
"github.com/owncord/server/db"
|
|
"github.com/owncord/server/syncutil"
|
|
)
|
|
|
|
const (
|
|
sendBufSize = 256 // per-client outbound send-channel capacity (normal priority)
|
|
sendHighBufSize = 64 // high-priority buffer (DMs, mentions)
|
|
sendLowBufSize = 64 // low-priority buffer (typing, presence)
|
|
)
|
|
|
|
// SessionCheckInterval is the number of messages processed between periodic
|
|
// session-expiry checks in readPump. Exported so tests can trigger the check
|
|
// without waiting for a real ticker.
|
|
const SessionCheckInterval = 10
|
|
|
|
// Client represents a single authenticated WebSocket connection.
|
|
// The underlying transport (conn) is set by ServeWS; in tests it remains nil.
|
|
type Client struct {
|
|
hub *Hub
|
|
conn wsConn // interface — nil in unit tests
|
|
ctx context.Context // derived from WS upgrade request; cancelled on disconnect
|
|
userID int64
|
|
user *db.User
|
|
channelID int64 // currently viewed channel for channel-scoped broadcasts
|
|
voiceChID int64 // voice channel the user is in (0 = not in voice); guarded by voiceMu
|
|
voiceJoinToken string // opaque join-instance token for the current voice session; guarded by voiceMu
|
|
e2eePubKey string // ECDH P-256 public key (base64) for voice E2EE; guarded by voiceMu
|
|
roleName string // cached role name for chat_message broadcasts
|
|
tokenHash string // SHA-256 hex of the session token; used for periodic revalidation
|
|
lastSeq uint64 // last_seq sent by the client during auth; 0 = fresh connection (e.g. F5 reload)
|
|
connectedAt time.Time // when the WS connection was established
|
|
remoteAddr string // client IP:port from the HTTP upgrade request
|
|
msgCount int // count of messages processed; resets after session check
|
|
msgsReceived int64 // total messages received over the lifetime of this connection
|
|
msgsSent int64 // total messages sent over the lifetime of this connection
|
|
msgsDropped int64 // messages dropped due to full send buffer
|
|
invalidCount int // consecutive invalid messages; reset on valid parse
|
|
lastActivity time.Time // last message received from this client; guarded by mu
|
|
sendClosed bool // true after all send channels have been closed
|
|
send chan []byte // normal-priority outbound messages (chat messages, reactions)
|
|
sendHigh chan []byte // high-priority outbound messages (DMs, mentions)
|
|
sendLow chan []byte // low-priority outbound messages (typing, presence) — dropped on overflow
|
|
mu syncutil.Mutex // guards sendClosed, msgCount, channelID, lastActivity, msgsReceived, msgsSent, msgsDropped
|
|
voiceMu syncutil.Mutex // guards voiceChID and voiceJoinToken
|
|
}
|
|
|
|
// wsConn is the subset of github.com/coder/websocket.Conn used by writePump/readPump.
|
|
// Defining it as an interface lets us avoid importing github.com/coder/websocket here,
|
|
// keeping the core hub logic free from that dependency during unit tests.
|
|
type wsConn interface {
|
|
// intentionally empty — methods used only in serve.go/client_pump.go
|
|
}
|
|
|
|
// newClient creates a real client wrapping a WebSocket connection (set by serve.go).
|
|
func newClient(hub *Hub, conn wsConn, user *db.User, tokenHash string, lastSeq uint64, ctx context.Context) *Client {
|
|
now := time.Now()
|
|
return &Client{
|
|
hub: hub,
|
|
conn: conn,
|
|
ctx: ctx,
|
|
userID: user.ID,
|
|
user: user,
|
|
tokenHash: tokenHash,
|
|
lastSeq: lastSeq,
|
|
connectedAt: now,
|
|
lastActivity: now,
|
|
send: make(chan []byte, sendBufSize),
|
|
sendHigh: make(chan []byte, sendHighBufSize),
|
|
sendLow: make(chan []byte, sendLowBufSize),
|
|
}
|
|
}
|
|
|
|
// GetTokenHash returns the session token hash stored on this client.
|
|
// Exported for tests.
|
|
func (c *Client) GetTokenHash() string {
|
|
return c.tokenHash
|
|
}
|
|
|
|
// touch updates the last activity timestamp and increments the received counter.
|
|
func (c *Client) touch() {
|
|
c.mu.Lock()
|
|
c.lastActivity = time.Now()
|
|
c.msgsReceived++
|
|
c.mu.Unlock()
|
|
}
|
|
|
|
// getLastActivity returns the last activity timestamp under mu.
|
|
func (c *Client) getLastActivity() time.Time {
|
|
c.mu.Lock()
|
|
defer c.mu.Unlock()
|
|
return c.lastActivity
|
|
}
|
|
|
|
// getChannelID returns the currently focused channel ID under mu.
|
|
func (c *Client) getChannelID() int64 {
|
|
c.mu.Lock()
|
|
defer c.mu.Unlock()
|
|
return c.channelID
|
|
}
|
|
|
|
// getVoiceChID returns the voice channel ID under voiceMu.
|
|
func (c *Client) getVoiceChID() int64 {
|
|
c.voiceMu.Lock()
|
|
defer c.voiceMu.Unlock()
|
|
return c.voiceChID
|
|
}
|
|
|
|
func (c *Client) getVoiceState() (int64, string) {
|
|
c.voiceMu.Lock()
|
|
defer c.voiceMu.Unlock()
|
|
return c.voiceChID, c.voiceJoinToken
|
|
}
|
|
|
|
func (c *Client) setVoiceState(chID int64, joinToken string) {
|
|
c.voiceMu.Lock()
|
|
defer c.voiceMu.Unlock()
|
|
c.voiceChID = chID
|
|
c.voiceJoinToken = joinToken
|
|
}
|
|
|
|
// clearVoiceChID clears the voice channel ID and returns the old value.
|
|
func (c *Client) clearVoiceChID() int64 {
|
|
oldChID, _ := c.clearVoiceState()
|
|
return oldChID
|
|
}
|
|
|
|
func (c *Client) clearVoiceState() (int64, string) {
|
|
c.voiceMu.Lock()
|
|
defer c.voiceMu.Unlock()
|
|
oldChID := c.voiceChID
|
|
oldJoinToken := c.voiceJoinToken
|
|
c.voiceChID = 0
|
|
c.voiceJoinToken = ""
|
|
c.e2eePubKey = ""
|
|
return oldChID, oldJoinToken
|
|
}
|
|
|
|
// setE2EEPubKey stores the ECDH public key for voice E2EE key exchange.
|
|
func (c *Client) setE2EEPubKey(key string) {
|
|
c.voiceMu.Lock()
|
|
defer c.voiceMu.Unlock()
|
|
c.e2eePubKey = key
|
|
}
|
|
|
|
// getE2EEPubKey returns the stored ECDH public key.
|
|
func (c *Client) getE2EEPubKey() string {
|
|
c.voiceMu.Lock()
|
|
defer c.voiceMu.Unlock()
|
|
return c.e2eePubKey
|
|
}
|
|
|
|
// sendMsg queues a normal-priority message (chat messages, reactions, channel events).
|
|
// If the buffer is full, the client is disconnected to force a reconnect
|
|
// with replay recovery instead of silently losing messages (BUG-124).
|
|
func (c *Client) sendMsg(msg []byte) {
|
|
c.mu.Lock()
|
|
defer c.mu.Unlock()
|
|
if c.sendClosed {
|
|
return
|
|
}
|
|
select {
|
|
case c.send <- msg:
|
|
c.msgsSent++
|
|
default:
|
|
c.msgsDropped++
|
|
slog.Warn("ws: client send buffer full, closing connection to force reconnect",
|
|
"user_id", c.userID)
|
|
c.closeAllSendLocked()
|
|
}
|
|
}
|
|
|
|
// sendHighMsg queues a high-priority message (DMs, direct mentions).
|
|
// High-priority messages are drained before normal and low-priority messages
|
|
// by writePump. If the high-priority buffer is full, falls back to the normal
|
|
// buffer. If both are full, disconnects the client.
|
|
func (c *Client) sendHighMsg(msg []byte) {
|
|
c.mu.Lock()
|
|
defer c.mu.Unlock()
|
|
if c.sendClosed {
|
|
return
|
|
}
|
|
select {
|
|
case c.sendHigh <- msg:
|
|
c.msgsSent++
|
|
default:
|
|
// Fall back to normal priority channel.
|
|
select {
|
|
case c.send <- msg:
|
|
c.msgsSent++
|
|
default:
|
|
c.msgsDropped++
|
|
slog.Warn("ws: client high+normal buffers full, closing connection",
|
|
"user_id", c.userID)
|
|
c.closeAllSendLocked()
|
|
}
|
|
}
|
|
}
|
|
|
|
// sendLowMsg queues a low-priority message (typing indicators, presence updates).
|
|
// If the buffer is full the message is silently dropped — the client is NOT
|
|
// disconnected, since these events are ephemeral and can be safely lost.
|
|
func (c *Client) sendLowMsg(msg []byte) {
|
|
c.mu.Lock()
|
|
defer c.mu.Unlock()
|
|
if c.sendClosed {
|
|
return
|
|
}
|
|
select {
|
|
case c.sendLow <- msg:
|
|
c.msgsSent++
|
|
default:
|
|
c.msgsDropped++
|
|
// Do NOT disconnect — low-priority messages are safely droppable.
|
|
}
|
|
}
|
|
|
|
// trySendMsg queues a normal-priority message and returns true if it was
|
|
// accepted, false if the buffer is full or the channel is closed.
|
|
// On buffer overflow, the client is disconnected to force a reconnect (BUG-124).
|
|
func (c *Client) trySendMsg(msg []byte) bool {
|
|
c.mu.Lock()
|
|
defer c.mu.Unlock()
|
|
if c.sendClosed {
|
|
return false
|
|
}
|
|
select {
|
|
case c.send <- msg:
|
|
c.msgsSent++
|
|
return true
|
|
default:
|
|
c.msgsDropped++
|
|
slog.Warn("ws: client send buffer full (trySend), closing connection to force reconnect",
|
|
"user_id", c.userID)
|
|
c.closeAllSendLocked()
|
|
return false
|
|
}
|
|
}
|
|
|
|
// closeSend marks all send channels closed and closes them exactly once.
|
|
// Safe to call from any goroutine.
|
|
func (c *Client) closeSend() {
|
|
c.mu.Lock()
|
|
defer c.mu.Unlock()
|
|
c.closeAllSendLocked()
|
|
}
|
|
|
|
// closeAllSendLocked closes all three send channels. Caller must hold c.mu.
|
|
func (c *Client) closeAllSendLocked() {
|
|
if !c.sendClosed {
|
|
c.sendClosed = true
|
|
close(c.send)
|
|
if c.sendHigh != c.send {
|
|
close(c.sendHigh)
|
|
}
|
|
if c.sendLow != c.send && c.sendLow != c.sendHigh {
|
|
close(c.sendLow)
|
|
}
|
|
}
|
|
}
|