Files
OwnCord/Server/main.go
T
J3vb db0275a290 fix: batch of 29 correctness fixes across server and client (#1369)
* fix(ws): 2 defect(s) (OC-0013, OC-0140)

* fix(voice): 1 defect(s) (OC-0044)

* fix(ws): 1 defect(s) (OC-0024)

* fix(server): 1 defect(s) (OC-0027)

* fix(ws): 1 defect(s) (OC-0028)

* fix(server): 7 defect(s) (OC-0033, OC-0066, OC-0067, OC-0068, OC-0074, OC-0077, OC-0106)

* fix(ws): 1 defect(s) (OC-0051)

* fix(client): 1 defect(s) (OC-0053)

* fix(client): 1 defect(s) (OC-0055)

* fix(service): 1 defect(s) (OC-0069)

* fix(voice): 1 defect(s) (OC-0072)

* fix(service): 1 defect(s) (OC-0082)

* fix(client): 1 defect(s) (OC-0083)

* fix(plugin): 1 defect(s) (OC-0088)

* fix(plugin): 4 defect(s) (OC-0104, OC-0126, OC-0127, OC-0133)

* fix(admin): 1 defect(s) (OC-0110)

* fix(client): 1 defect(s) (OC-0114)

* fix(api): 1 defect(s) (OC-0139)

* fix(client): 1 defect(s) (OC-0149)

* test(server): adapt existing tests to updated OpenDM and IncrementMentionCounts signatures

* style(plugin): modernize loops and goroutine spawns in race test

* fix(ws): mirror the focus admission gate in the post-subscribe revalidation

* fix(service): detach DM post-commit side effects from the request ctx, fail delete closed, add empty-fan-out fallback

* fix(plugin): preserve enabled intent when upgrade reactivation hits a runtime-less build

* chore(skills): harden bughunt-fix workflow and fold review lessons into bughunt-run/db-change

* Add comprehensive documentation for task-observer skill

- Introduced environments.md to outline activation setup, compaction behavior, and handoff-doc mode.
- Created skill-authoring.md detailing taxonomy, licensing, confidentiality, and editing rules for skill creation.
- Added weekly-review.md for a structured review process of OPEN observations, including scheduled and in-session fallback modes.

* chore(go): pin toolchain go1.26.6 (stdlib CVE fixes flagged by govulncheck)
2026-08-14 10:05:40 +02:00

494 lines
18 KiB
Go

// OwnCord chat server — self-hosted, Windows-native.
// Build: go build -o chatserver.exe -ldflags "-s -w -X main.version=1.0.0" .
package main
import (
"context"
"errors"
"fmt"
"io"
stdlog "log"
"log/slog"
"net"
"net/http"
"os"
"os/signal"
"runtime"
"strings"
"syscall"
"time"
"github.com/owncord/server/admin"
"github.com/owncord/server/api"
"github.com/owncord/server/auth"
"github.com/owncord/server/config"
"github.com/owncord/server/db"
"github.com/owncord/server/logctx"
"github.com/owncord/server/plugin"
"github.com/owncord/server/storage"
"github.com/owncord/server/telemetry"
"github.com/owncord/server/ws"
)
// version is overridden at build time via -ldflags "-X main.version=1.0.0".
var version = "dev"
func main() {
// `server token ...` is a direct-to-DB CLI (mint/list/revoke API tokens) —
// handled before any server/logging setup so it stays quiet and standalone.
if len(os.Args) > 1 && os.Args[1] == "token" {
os.Exit(runTokenCLI(os.Args[2:]))
}
// Create ring buffer for admin log viewer, then build a multi-handler
// that tees log records to both stdout and the ring buffer.
logBuf := admin.NewRingBuffer(2000)
// levelVar controls both handlers' thresholds. It starts at INFO (the
// zero value) so early-startup logs are captured, then run() raises/lowers
// it once config.yaml / OWNCORD_LOGGING_LEVEL is loaded. The ring buffer
// shares it rather than hard-wiring DEBUG: with both sinks gated, Enabled
// returns false for suppressed levels and every gated Debug call across
// the server becomes a no-op instead of formatting a ring entry.
levelVar := new(slog.LevelVar)
stdoutHandler := slog.NewTextHandler(os.Stdout, &slog.HandlerOptions{Level: levelVar})
multiHandler := admin.NewMultiHandler(stdoutHandler, logBuf, levelVar)
// logctx enriches records logged with a request/trace context (the
// ...Context slog variants) with req_id and, under -tags otel, trace_id.
log := slog.New(logctx.New(multiHandler))
slog.SetDefault(log)
if err := run(log, logBuf, levelVar); err != nil {
_, _ = fmt.Fprintf(os.Stderr, "\n [ERROR] %v\n\n", err)
log.Error("server exited with error", "error", err)
os.Exit(1)
}
}
// run is the real entrypoint — separated for testability.
func run(log *slog.Logger, logBuf *admin.RingBuffer, levelVar *slog.LevelVar) error {
// bgCtx is a cancellable context shared by all background goroutines
// (event persister, event pruner, plugin loader, maintenance loop).
// It is cancelled early in the shutdown sequence so in-flight DB
// operations do not block after the database is being torn down.
bgCtx, bgCancel := context.WithCancel(context.Background())
defer bgCancel()
// Clean up old binary from a previous update.
exePath, exeErr := os.Executable()
if exeErr != nil {
log.Warn("failed to determine executable path", "error", exeErr)
} else {
oldPath := exePath + ".old"
if _, statErr := os.Stat(oldPath); statErr == nil {
if rmErr := os.Remove(oldPath); rmErr != nil {
log.Warn("failed to remove old binary", "path", oldPath, "error", rmErr)
} else {
log.Info("removed old binary from previous update", "path", oldPath)
}
}
}
// ── 1. Load configuration ──────────────────────────────────────────────
cfg, err := config.Load(config.DefaultPath)
if err != nil {
return fmt.Errorf("loading config: %w", err)
}
// Apply the configured log level. The admin panel's live log view (ring
// buffer) follows the same threshold — set logging.level to "debug" to
// capture debug records there.
if lvl, ok := config.ParseLevel(cfg.Logging.Level); ok {
levelVar.Set(lvl)
} else {
log.Warn("unknown logging.level, keeping info", "value", cfg.Logging.Level)
}
// ── 2. Ensure data directory exists ────────────────────────────────────
if mkdirErr := os.MkdirAll(cfg.Server.DataDir, 0o750); mkdirErr != nil {
return fmt.Errorf("creating data dir %s: %w", cfg.Server.DataDir, mkdirErr)
}
// ── 3. TLS ────────────────────────────────────────────────────────────
tlsResult, err := auth.LoadOrGenerate(cfg.TLS)
if err != nil {
return fmt.Errorf("configuring TLS: %w", err)
}
tlsCfg := tlsResult.TLSConfig
// Print startup banner first so it appears above all init logs.
printBanner(cfg, version, tlsCfg != nil)
// ── 4. Open database + run migrations ─────────────────────────────────
// SQLite is the only supported backend; the unfinished Postgres
// scaffolding (stubbed query layer, never wired into the runtime) was
// removed rather than completed.
if t := cfg.Database.Type; t != "" && t != "sqlite" {
return fmt.Errorf("database.type=%q is not supported; set \"sqlite\" or omit it", t)
}
database, err := db.Open(cfg.Database.Path)
if err != nil {
return fmt.Errorf("opening database: %w", err)
}
defer database.Close() //nolint:errcheck
if err := db.Migrate(database); err != nil {
return fmt.Errorf("running migrations: %w", err)
}
// Clear stale state from a previous run or crash. Startup work — nothing
// to inherit a context from yet.
if err := database.ResetAllUserStatuses(context.Background()); err != nil {
log.Warn("failed to reset stale user statuses", "error", err)
} else {
log.Info("reset all user statuses to offline")
}
if err := database.ClearAllVoiceStates(context.Background()); err != nil {
log.Warn("failed to clear stale voice states", "error", err)
} else {
log.Info("cleared stale voice states")
}
// ── 4b. Telemetry (Phase B Step 8) ─────────────────────────────────────
// Init can return (nil, err) when the otel build-tag skeleton hasn't been
// finished wiring to the upstream SDK. Normalise to a no-op shutdown so
// the deferred closure never calls a nil function.
telemetryShutdown, telErr := telemetry.Init(context.Background(), cfg.Telemetry)
if telErr != nil {
log.Warn("telemetry init failed; continuing without OpenTelemetry", "error", telErr)
}
if telemetryShutdown == nil {
telemetryShutdown = func(context.Context) error { return nil }
}
defer func() {
shutdownCtx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
if err := telemetryShutdown(shutdownCtx); err != nil {
log.Warn("telemetry shutdown returned error", "error", err)
}
}()
// ── 5a. Construct plugin runtime BEFORE the router so the router can
// wire the live registry into the plugin admin handler. ────────────────
var pluginRegistry *plugin.Registry
if cfg.Plugins.Enabled {
registry, plugErr := plugin.NewRegistry(plugin.Config{
Directory: cfg.Plugins.Directory,
MaxMemoryMB: cfg.Plugins.MaxMemoryMB,
CPUBudgetMs: cfg.Plugins.CPUBudgetMs,
HTTPAllowlist: cfg.Plugins.HTTPAllowlist,
Store: database,
})
if plugErr != nil {
log.Warn("plugin runtime init failed; continuing without plugins", "error", plugErr)
} else {
pluginRegistry = registry
if err := registry.LoadAll(bgCtx); err != nil {
log.Warn("plugin loader: failed to scan directory", "error", err)
}
defer func() {
closeCtx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
_ = registry.Close(closeCtx)
}()
}
}
// ── 5b. Build HTTP router ──────────────────────────────────────────────
router, hub, routerCleanup := api.NewRouter(cfg, database, version, logBuf, pluginRegistry)
defer routerCleanup()
// Backstop for every early return below (serve error, ACME shutdown
// failure, etc.): hub.GracefulStop is the only caller of
// LiveKitProcess.Stop(), so skipping it orphans the companion
// livekit-server process and leaves the hub's dispatch goroutine
// running. gracefulOnce makes it idempotent alongside the explicit call
// on the normal shutdown path below.
defer hub.GracefulStop()
// ── 5c. Wire event persistence (Phase B Step 7) ────────────────────────
if cfg.EventPersistence.Enabled && hub != nil {
// Seed the hub's in-memory seq counter from the persisted MAX(seq)
// so wrapped-payload seqs stay monotonic across restarts. Without
// this, the events table accumulates rows whose payload seqs reset
// to 1 after every restart, breaking the reconnect "events since
// last_seq" contract.
if maxSeq, seedErr := database.GetMaxEventSeq(bgCtx); seedErr != nil {
log.Warn("event persistence: failed to read MAX(events.seq); starting hub seq from 0", "error", seedErr)
} else if maxSeq > 0 {
hub.SeedSeq(uint64(maxSeq))
log.Info("event persistence: seeded hub seq from persisted events", "seq", maxSeq)
}
persister := ws.NewEventPersister(
database,
4096,
cfg.EventPersistence.BatchSize,
time.Duration(cfg.EventPersistence.BatchFlushMs)*time.Millisecond,
)
persister.Start(bgCtx)
hub.SetEventPersister(persister)
hub.SetEventStore(database)
retention := time.Duration(cfg.EventPersistence.RetentionHours) * time.Hour
prunerInterval := time.Duration(cfg.EventPersistence.PrunerIntervalMinutes) * time.Minute
ws.StartEventPruner(bgCtx, database, retention, prunerInterval)
defer func() {
stopCtx, stopCancel := context.WithTimeout(context.Background(), 5*time.Second)
defer stopCancel()
persister.Stop(stopCtx)
}()
}
// ── 5d. Async audit writer ─────────────────────────────────────────────
// Moves audit-log INSERTs off the request path: once the writer is
// installed, WriteAudit enqueues here and a background goroutine batches
// the writes (same shape as the event persister above). Paths that never
// install a writer — the token CLI, tests — keep the synchronous
// behavior. This defer is registered after `defer database.Close()` so
// LIFO ordering drains the queue before the database is torn down.
auditWriter := db.NewAuditWriter(database, 1024, 50, 100*time.Millisecond)
auditWriter.Start(bgCtx)
database.SetAuditWriter(auditWriter)
defer func() {
stopCtx, stopCancel := context.WithTimeout(context.Background(), 5*time.Second)
defer stopCancel()
auditWriter.Stop(stopCtx)
}()
// ── 6. Start server ────────────────────────────────────────────────────
addr := fmt.Sprintf(":%d", cfg.Server.Port)
srv := &http.Server{
Addr: addr,
Handler: router,
TLSConfig: tlsCfg,
ReadTimeout: 30 * time.Second,
WriteTimeout: 30 * time.Second,
IdleTimeout: 120 * time.Second,
ErrorLog: stdlog.New(io.Discard, "", 0), // suppress TLS handshake noise
}
// ── 6b. ACME HTTP challenge server on :80 ─────────────────────────────
// When using Let's Encrypt (tls.mode: acme), an HTTP server on port 80
// is needed for HTTP-01 challenge validation and HTTP→HTTPS redirect.
var acmeSrv *http.Server
if tlsResult.HTTPHandler != nil {
acmeSrv = &http.Server{
Addr: ":80",
Handler: tlsResult.HTTPHandler,
ReadTimeout: 10 * time.Second,
WriteTimeout: 10 * time.Second,
}
go func() {
log.Info("ACME HTTP challenge server starting on :80")
if err := acmeSrv.ListenAndServe(); err != nil && !errors.Is(err, http.ErrServerClosed) {
log.Error("ACME HTTP server error", "error", err)
}
}()
}
// ── 7. Background maintenance ────────────────────────────────────────
// Periodically purge expired sessions and orphaned attachments.
fileStorage, fileStorageErr := storage.New(cfg.Upload.StorageDir, cfg.Upload.MaxSizeMB)
if fileStorageErr != nil {
log.Warn("failed to create file storage for maintenance; orphan file cleanup disabled", "error", fileStorageErr)
}
stopMaintenance := make(chan struct{})
defer close(stopMaintenance) // backstop for early returns below; see hub.GracefulStop defer above
go func() {
ticker := time.NewTicker(15 * time.Minute)
defer ticker.Stop()
consecutiveFailures := 0
const maxConsecutiveFailures = 5
for {
select {
case <-ticker.C:
if consecutiveFailures >= maxConsecutiveFailures {
log.Error("maintenance loop: circuit breaker open, skipping tick",
"consecutive_failures", consecutiveFailures)
// Reset after one skip to allow retry next tick.
consecutiveFailures = maxConsecutiveFailures - 1
continue
}
tickFailed := false
if err := database.DeleteExpiredSessions(bgCtx); err != nil {
log.Warn("failed to delete expired sessions", "error", err)
tickFailed = true
}
// Clean up orphaned attachments (uploaded but never linked to a message).
//
// Skipped entirely with no file storage configured: the delete is
// atomic (row goes the instant it's selected, by design — see
// db/attachment_queries.go), so with fileStorage nil the returned
// stored_as names — the only remaining handle on those blobs —
// would just be discarded and the files stranded on disk with no
// query left able to name them. Leaving the rows in place keeps
// them reclaimable once storage is available again.
if fileStorage != nil {
cutoff := time.Now().Add(-1 * time.Hour)
orphanFiles, orphanErr := database.DeleteOrphanedAttachments(bgCtx, cutoff)
if orphanErr != nil {
log.Warn("failed to delete orphaned attachments", "error", orphanErr)
tickFailed = true
} else if len(orphanFiles) > 0 {
// Best-effort file cleanup.
for _, filename := range orphanFiles {
if delErr := fileStorage.Delete(filename); delErr != nil {
log.Warn("failed to delete orphan file", "file", filename, "error", delErr)
}
}
log.Info("cleaned up orphaned attachments", "count", len(orphanFiles))
}
}
if tickFailed {
consecutiveFailures++
} else {
consecutiveFailures = 0
}
case <-stopMaintenance:
return
}
}
}()
// Listen for OS signals for graceful shutdown.
ctx, stop := signal.NotifyContext(context.Background(), os.Interrupt, syscall.SIGTERM)
defer stop()
// Start serving in a goroutine.
serveErr := make(chan error, 1)
go func() {
log.Info("server starting", "addr", addr, "tls", tlsCfg != nil, "version", version)
for attempt := range 20 {
var listenErr error
if tlsCfg != nil {
listenErr = srv.ListenAndServeTLS("", "")
} else {
listenErr = srv.ListenAndServe()
}
if listenErr != nil && !errors.Is(listenErr, http.ErrServerClosed) {
// Check if it's an "address already in use" error (port not released yet from old process)
if attempt < 19 && isAddrInUse(listenErr) {
log.Warn("port in use, retrying...", "attempt", attempt+1, "error", listenErr)
time.Sleep(500 * time.Millisecond)
continue
}
serveErr <- listenErr
}
break
}
close(serveErr)
}()
// Wait for shutdown signal or server error.
select {
case err := <-serveErr:
if err != nil {
return fmt.Errorf("server error: %w", err)
}
case <-ctx.Done():
log.Info("shutdown signal received, draining connections (30s timeout)")
}
// Graceful shutdown.
shutdownCtx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
defer cancel()
if acmeSrv != nil {
if err := acmeSrv.Shutdown(shutdownCtx); err != nil {
log.Warn("ACME HTTP server shutdown error", "error", err)
}
}
// Stop the WebSocket hub: close all PeerConnections, voice rooms, and
// notify connected clients before draining HTTP connections.
hub.GracefulStop()
if err := srv.Shutdown(shutdownCtx); err != nil {
return fmt.Errorf("graceful shutdown: %w", err)
}
log.Info("server stopped cleanly")
return nil
}
// isAddrInUse checks if an error is an "address already in use" error.
func isAddrInUse(err error) bool {
return err != nil && (strings.Contains(err.Error(), "address already in use") || strings.Contains(err.Error(), "Only one usage of each socket address"))
}
// printBanner writes the startup banner to stderr (so it doesn't mix with
// the structured log output on stdout).
func printBanner(cfg *config.Config, ver string, tls bool) {
scheme := "http"
if tls {
scheme = "https"
}
localIP := getOutboundIP()
port := cfg.Server.Port
baseURL := fmt.Sprintf("%s://%s:%d", scheme, localIP, port)
adminURL := baseURL + "/admin"
tlsStatus := "disabled"
if tls {
tlsStatus = "enabled"
}
banner := fmt.Sprintf(`
___ ____ _
/ _ \__ ___ __ / ___|___ _ __ __| |
| | | \ \ /\ / / '_ \| | / _ \| '__/ _`+"`"+` |
| |_| |\ V V /| | | | |__| (_) | | | (_| |
\___/ \_/\_/ |_| |_|\____\___/|_| \__,_|
─────────────────────────────────────────────
Server %s
Version %s
TLS %s
Platform %s/%s
─────────────────────────────────────────────
API %s/api/v1/info
WebSocket %s/api/v1/ws
Admin %s
Health %s/health
─────────────────────────────────────────────
Press Ctrl+C to stop the server.
`, cfg.Server.Name, ver, tlsStatus, runtime.GOOS, runtime.GOARCH,
baseURL, wsURL(scheme, localIP, port), adminURL, baseURL)
_, _ = fmt.Fprint(os.Stderr, banner)
}
// wsURL builds the WebSocket URL with the correct scheme.
func wsURL(httpScheme, ip string, port int) string {
ws := "ws"
if httpScheme == "https" {
ws = "wss"
}
return fmt.Sprintf("%s://%s:%d", ws, ip, port)
}
// getOutboundIP returns the preferred outbound IP of this machine by dialing
// a known external address (no actual connection is made with UDP).
func getOutboundIP() string {
conn, err := net.Dial("udp", "8.8.8.8:80")
if err != nil {
return "localhost"
}
defer conn.Close() //nolint:errcheck
addr, ok := conn.LocalAddr().(*net.UDPAddr)
if !ok {
slog.Warn("getOutboundIP: unexpected LocalAddr type, falling back to localhost",
"type", fmt.Sprintf("%T", conn.LocalAddr()))
return "localhost"
}
return addr.IP.String()
}