Files
OwnCord/docs/plans/infrastructure-roadmap.md
T
J3vbandClaude Fable 5 f5faf82a60 infra: observability, backups, guardrails, and deployment hardening (#1376)
* docs: add infrastructure roadmap plan

Records the verified recommendations from an infrastructure review in three
tracks: raising the single-instance ceiling, cheap seams for a possible
multi-instance future, and ops hygiene. Includes explicit anti-recommendations
and sequencing. Security-sensitive detail is intentionally excluded per
docs/security.md.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017RtDNHSYWwPKArL8MsRdbj

* feat(server): real health checks and saturation metrics

/api/v1/metrics now exposes signals that were already computed in memory but
never surfaced: reconnect replay tier hits, event-persister counters, SQLite
writer-pool wait stats, aggregate per-client backpressure counters (including
previously invisible low-priority drops), and permission-cache hit/miss.

/health now returns a real verdict: hub dispatch-loop liveness, a bounded
database ping, and a free-disk check, returning 503 with a subsystem reason
when degraded. Checks are cached so the unauthenticated endpoint cannot
amplify load. The hub's panic breaker now exits the process so a supervisor
can restart it, instead of leaving broadcast delivery silently dead while
clients still appear online.

OTel instruments that were declared but never recorded are now wired
(ws_active_connections, ws_broadcast_latency_seconds, ws_messages_total,
ws_events_dropped_total, voice gauges) or removed (db_query_duration_seconds).
Also corrects the docs/api.md description of broadcast_drops, which counts
hub-queue overflow, not client send-queue overflow.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017RtDNHSYWwPKArL8MsRdbj

* feat(server): implement scheduled backups, retention, and backup verification

The backup_schedule and backup_retention settings have existed in the admin
panel and API since the initial schema but were never read by any code. The
15-minute maintenance loop now enforces them: a scheduled backup is taken
when the newest backup on disk is older than the schedule interval (manual
backups reset the clock), and retention prunes backups older than the
configured days while always keeping the newest one.

Backups are now verified with PRAGMA integrity_check immediately after
VACUUM INTO (a failed backup is removed rather than listed as restorable)
and again before a restore may overwrite the live database. A failed VACUUM
INTO also cleans up its partial output file — but never a pre-existing one.

The backup directory is configurable via a new backup.dir key (default
data/backups) so operators can point backups at another disk or an off-host
mount, mirroring the SetDatabasePath plumb.

Restore-handler tests now use real SQLite fixtures (the integrity gate
correctly refuses text files) with the mid-copy failure injected through a
test-only copy hook. Also adds audited gosec suppressions to the Windows
disk-free syscall added in the previous commit, which the Windows lint leg
flagged.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017RtDNHSYWwPKArL8MsRdbj

* feat(server): capacity and failure-mode guardrails

- server.max_ws_connections: optional cap on concurrent WebSocket clients,
  checked before the upgrade with a 503 + Retry-After; rejections are counted
  and exposed as ws_conn_rejects in /api/v1/metrics.
- Single-process database lock: an OS-level advisory lock (flock / exclusive
  handle) beside the SQLite file makes a second server process fail fast with
  a clear message instead of silently fighting the first over process-local
  state. A bounded retry covers the self-update/restore restart handoff, and
  the lock mechanism failing (e.g. network filesystems) only warns.
- Disk-space awareness: boot-time warnings for the data and backup volumes,
  plus a disk_free_mb metrics field, via a small cross-platform diskutil
  package (already used by /health).
- Upload storage failures: storage.Save now marks server-side filesystem
  failures with a sentinel (storage.ErrIO); handlers return 507 for those
  instead of blaming the client with a 400, and the emoji route stops echoing
  raw storage errors (which embed absolute paths) into responses.
- Unknown config keys now warn at startup — a typo like admin_alowed_cidrs
  previously kept the default silently while the operator believed the
  setting changed. Never fatal: newer servers tolerate older configs.
- Admin settings honesty: the three stored-but-inert settings (server_icon,
  max_upload_bytes, voice_quality) are shown read-only with a note pointing
  at the real config.yaml keys, instead of pretending to apply.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017RtDNHSYWwPKArL8MsRdbj

* perf(db): write-path efficiency and capacity knobs

- channel_focus/mark_read now skip the read-state UPSERT when the stored row
  already matches (same last_message_id, no mentions) — refocus events fire
  at up to 10/s/user and every no-op write still occupied the single SQLite
  writer connection. The extra existence check runs on the reader pool, which
  doesn't serialize. Same shape as the session-touch throttle.
- DeleteExpiredSessions is now sargable: migration 031 normalizes legacy
  expiry formats to the RFC3339-Z layout the server writes and indexes
  expires_at, replacing the strftime full-table scan that ran on the writer
  every 15 minutes.
- Boot-time ANALYZE runs only when a migration actually applied; unchanged
  schemas get the cheap PRAGMA optimize instead (which also covers
  crash-restarts that never reached the shutdown optimize).
- The read/write SQL router gets a table-driven test with explicit expected
  values (INSERT ... RETURNING must hit the writer despite being :one).
- New knobs, all defaulting to current behavior: database.max_readers,
  security.auth_rate_limit_multiplier (for shared-NAT communities),
  event_persistence.replay_ring_size and replay_cold_limit.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017RtDNHSYWwPKArL8MsRdbj

* fix(server): shutdown lifecycle ordering

- The event pruner and maintenance loop are now joined (bounded) before the
  database closes: bgCtx cancellation used to run AFTER database.Close via
  LIFO defers, contradicting its own comment, and neither goroutine was ever
  waited on — a mid-tick scheduled backup or prune could still hold the
  writer while the pool tore down. StartEventPruner returns a done channel
  with the same join contract EventPersister.Stop already had.
- srv.Shutdown now runs before hub.GracefulStop, so in-flight HTTP handlers'
  broadcasts still reach a live hub and the event persister instead of
  vanishing from the replay/event store across a restart. Shutdown does not
  wait on hijacked WebSocket connections, so the swap adds no delay.
- GracefulStopContext threads the 30s shutdown budget into the hub: the 5s
  client-notice window (matching the countdown clients are shown) ends early
  when the budget expires, and is skipped entirely when nobody is connected —
  early-return startup paths and idle servers no longer sleep 5s for an
  audience of zero.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017RtDNHSYWwPKArL8MsRdbj

* build(deploy): systemd unit, compose hardening, boot-smoked releases, CI polish

- deploy/owncord.service: hardened systemd unit template with the two
  verified caveats encoded (install dir stays writable for self-update under
  ProtectSystem=strict; CAP_NET_BIND_SERVICE for ACME's :80), plus a
  'Linux (systemd)' deployment docs section — the Linux service story was
  previously 'Docker or nothing'.
- New 'Reverse Proxy Topology' docs section with a working nginx snippet and
  the correct signaling-vs-media distinction: /livekit/* is already proxied
  by the server, only WebRTC media ports must be directly reachable.
- docker-compose: log rotation, commented resource limits, and a healthcheck
  backed by a new 'chatserver healthcheck' subcommand (the distroless image
  has no shell) that probes /health without config side effects.
- release.yml: a concurrency group (queue, never cancel), and boot-smoke
  gates — the freshly built server binaries and the Docker image are cold
  booted and probed healthy BEFORE anything is signed or pushed. The release
  feed drives signed self-updates, so a binary that compiles but dies on
  boot previously would have shipped itself to every auto-updating instance.
- ci.yml: client-check/client-tests move to ubuntu with the reasoning
  recorded (no win32 code paths, LF enforced repo-wide); admin-e2e gets a
  written graduation criterion instead of an open-ended non-blocking status.
- docs: Tailscale guide notes the CGNAT range vs the default admin CIDRs;
  architecture overview records presence/voice state as the fifth
  single-instance blocker and the macOS client scope decision.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017RtDNHSYWwPKArL8MsRdbj

* perf(server): measured load tooling, narrowed invalidation, presence coalescing, storage and CIDR seams

- Fix scripts/k6/ws-load.js against the real wire protocol: envelope-wrapped
  frames, correct message types (typing_start, presence_update), the correct
  /api/v1/ws path, and thresholds that fail a run where nobody authenticated
  or went ready — the script had drifted to pre-envelope framing and reported
  100% green while every auth failed on the first frame. A new
  workflow_dispatch-only load-baseline workflow boots a real server, seeds
  users through the setup/invite APIs, runs the script, and uploads the k6
  summary plus a metrics snapshot for before/after comparison.
- Role-scoped channel-override changes now evict only the affected role's
  members from the permission cache (fail-safe: unreadable member list still
  flushes everything). InvalidateAll here repopulated every connected user —
  two reads each — synchronously inside the admin request via
  RefreshChannelVisibility, a stampede that scaled with total population
  rather than the role's size. Same pattern the per-user override endpoints
  already used.
- Connect/disconnect presence broadcasts now pass through a 300ms latest-wins
  coalescer (QueuePresence): each un-coalesced presence change is a sequenced
  global broadcast (an O(clients) fan-out under seqMu), so a reconnect storm
  fired O(users) of them from the connect critical path. A flap inside the
  window collapses to its final state; the wire format, seq ordering, and
  replay behaviour are unchanged, and the delivery path (BroadcastPresence)
  is untouched.
- Storage seam: api handlers now consume a FileStore interface (consumer-side,
  same pattern as service.Store) with Open returning a seekable storage.File —
  writing down the contract (range-request seeks included) an alternative
  backend would have to meet, without building one.
- The metrics surfaces and the LiveKit webhook/health endpoints get their own
  allowlist keys (metrics_allowed_cidrs, livekit_webhook_allowed_cidrs, both
  defaulting to admin_allowed_cidrs), so a central Prometheus scraper or an
  externally-hosted LiveKit no longer requires widening the admin panel's
  perimeter. Startup now also warns when admin_allowed_cidrs is customized
  while trusted_proxies is empty — behind a proxy or container network the
  check would otherwise compare the proxy's private address, not the client's.
- The container healthcheck probe now PINS the server's own certificate from
  disk (VerifyConnection, exact-match) instead of skipping TLS verification,
  addressing the CodeQL finding on the previous commit; WebPKI verification
  is used when no local cert exists (ACME).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017RtDNHSYWwPKArL8MsRdbj

* fix(server): address self-review findings on the hardening branch

Seven fixes from a high-effort review of the full branch diff:

- healthcheck CLI now works under tls.mode acme: it overrides ServerName
  with the configured domain for WebPKI verification instead of pinning a
  cert that doesn't exist (or is stale) in that mode. Previously an ACME
  deployment's container healthcheck failed forever.
- /health pings the READER pool (new db.PingRead): the writer ping queued
  behind a scheduled backup's VACUUM INTO and reported the server degraded
  for the whole backup — which an autoheal watchdog would turn into a
  nightly mid-backup restart.
- /health runs its cached checks under context.WithoutCancel so a probe
  that disconnects mid-request cannot poison the shared cache with a false
  degraded verdict for the next 5 seconds.
- The token CLI uses a new db.OpenShared that skips the single-process
  lock: minting a token against a running server is safe under WAL and was
  a documented workflow the lock had broken.
- The per-user TOTP failure cap is no longer scaled by
  security.auth_rate_limit_multiplier — that knob exists for per-IP limits;
  scaling the only cross-IP brute-force defence multiplied an attacker's
  distributed guess budget. Mirrors the unscaled per-user login threshold.
- A direct presence_update now drops the user's queued entry in the
  connect/disconnect coalescer, so a stale connect-time presence can no
  longer flush 300ms later over the user's fresher chosen status.
- The scheduled-backup filename collision loop breaks on any stat error
  and bounds its suffix probing, instead of spinning the maintenance
  goroutine forever on a persistent EACCES.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017RtDNHSYWwPKArL8MsRdbj

* test(admin): real SQLite fixture for the merged Close-failure restore test

TestHandleRestoreBackup_RestartsWhenCloseFails arrived from main (#1375)
with a plain-text backup fixture; this branch's restore handler verifies
backups with integrity_check before touching the live database, so the text
fixture was (correctly) refused with 400 before the Close-failure branch
under test was reached. Use a real backup via BackupToSafe, matching the
other restore tests.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017RtDNHSYWwPKArL8MsRdbj

---------

Co-authored-by: Claude <noreply@anthropic.com>
2026-08-15 20:50:47 +02:00

11 KiB
Raw Blame History

Infrastructure roadmap — design

Date: 2026-08-15 Status: implemented 2026-08-15 (same PR), with two deliberate leftovers: the TOTP/partial-auth persister seam (Track 2 §3 — lowest impact, cut to bound the change) and published capacity numbers (Track 3 §7 — the load-baseline workflow now exists to produce them; publish only measured values).

Problem

OwnCord is deliberately single-instance (D8, docs/architecture/system-overview.md), and that decision holds. A multi-model review pass (inventory sweep, eight review lenses, adversarial verification) concluded the runtime is further along than the operations story: the biggest growth risks are operational gaps, not throughput ceilings. This roadmap records the verified, non-sensitive recommendations in three tracks. Findings with security-sensitive detail were reported to the maintainer separately per docs/security.md and are intentionally not itemized here.

Overall verdict: no re-architecting needed. The codebase already fixes its own bottlenecks where it finds them (session-touch throttle, batched audit/event writers, WAL reader/writer pool split, the auth lockout persister seam). The work below lets a single instance absorb roughly a 10x user increase without revisiting D8.

Track 1 — Raise the single-instance ceiling

Ordered by leverage. All stay inside D8; no new subsystems.

  1. Hub dispatch-loop liveness. The hub's panic breaker (3 panics/60s, Server/ws/hub.go) stops broadcast delivery permanently with nothing observing it — clients still connect and appear online. On trip: os.Exit(1) so a supervisor restarts the process, and expose dispatch-loop liveness on /health. Do not attempt in-process self-recovery.
  2. Connection capacity guardrail. Add a configurable global ceiling on concurrent WebSocket connections, checked before the upgrade and returning 503 when reached. Static value; no adaptive logic.
  3. Presence broadcast coalescing. Connect/disconnect presence broadcasts go through the sequenced path and fan out to all clients; a reconnect storm (proxy blip, deploy) multiplies that. Coalesce into one frame per ~250500 ms window. Do not restructure seqMu's fan-out itself — per-client FIFO ordering depends on it (see "What not to do").
  4. Narrow permission-cache invalidation. Role-scoped channel-override edits call InvalidateAll() and then RefreshChannelVisibility, repopulating ~2×N entries synchronously inside the admin request. Narrow to the affected role's users — the per-user endpoints already use InvalidateUser with exactly this rationale (Server/admin/handlers_channel_perms.go).
  5. Read-state write short-circuit. channel_focus/mark_read UPSERT the read-state row on the single writer even when it is already correct (Server/service/channel.go). Skip the write when latestID matches and mention_count is 0; optionally debounce bursts. Same shape as the session-touch throttle already in Server/api/middleware.go.
  6. Single-process file lock. Take an exclusive flock on a .lock beside the SQLite file and fail fast with a legible message (warn-and-continue if the lock syscall errors — network filesystems). Process-local presence/replay state assumes one process owns the DB; make that assumption enforced.
  7. Small DB items. Make the replay ring (1000) and cold-replay cap (5000) configurable; add database.max_readers with a sane bound; rewrite DeleteExpiredSessions to be index-friendly (note: expires_at is stored in RFC3339 T format — format the cutoff to match or migrate the data); gate boot-time ANALYZE on schema change plus a cheap PRAGMA optimize; add a table-driven test for the read/write SQL router (isReadOnlySQL).

Track 2 — Cheap seams for a multi-instance future

Interfaces and documentation only. Nothing here builds distributed systems.

  1. Storage backend interface. *storage.Storage is threaded concretely through ~9 handler signatures. Carve a consumer-side interface in api/ (repo precedent: service.Store). Note Open must return io.ReadSeekCloser + size/modtime because both serve paths use http.ServeContent — that constraint is exactly what makes an S3 backend nontrivial, and discovering it now is the point. Do not implement S3.
  2. Split the admin CIDR list by purpose. /admin, /api/v1/metrics, the Prometheus exporter, and the LiveKit webhook all share admin_allowed_cidrs. The webhook is already cryptographically authenticated; metrics scraping and human admin access are different trust domains. Separate config keys so moving one off-box never widens another. Cheapest seam for voice as a separate scaling unit.
  3. Persist TOTP/partial-auth stores via the existing persister seam. RateLimiter already has the optional-persister shape; give UsedTOTPCodeStore/PartialAuthStore the same (store hashes, not raw codes). Do not persist the rate-limiter sliding windows — hottest path, benefit only exists post-multi-instance.
  4. Document the fifth D8 blocker. Boot-time presence/voice reset (Server/main.go) is a single-instance assumption missing from D8's blocker list. One doc bullet: "process-local presence/voice state, wiped and rebuilt per process."

Track 3 — Ops hygiene

The highest-impact track. Ordered.

  1. Implement the backup scheduler and retention — or visibly disable the controls. backup_schedule/backup_retention exist in the settings table, admin UI, and API docs, but nothing reads them; a fresh install shows "Daily" selected and never backs up. Implement inside the existing 15-min maintenance loop (retention is in days, per the UI), or grey the controls out today. Do not build a general job scheduler.
  2. Enrich the default-build metrics surface. /api/v1/metrics omits signals already computed in memory: reconnect tier stats, event-persister stats, writer-pool WaitCount/WaitDuration (the single most direct signal for the single-writer bottleneck), aggregate per-client backpressure counters, and permission-cache hit/miss. ~60 lines across ~4 files; do this before touching the otel path. Also wire or delete the seven declared-but-never- recorded OTel instruments in Server/telemetry/metrics.go.
  3. Make /health honest. It returns a static "ok" — never checks the DB, disk, or hub dispatch loop. Add a bounded SELECT 1, disk-free check, and hub liveness; return 503 with a reason. Cache the result — the endpoint is unauthenticated and rate-limit exempt.
  4. Boot-smoke release artifacts. The release pipeline signs and publishes server binaries and a Docker image it never executes. Boot each artifact against a scratch dir, poll /health, kill it; gate signing/publishing on that. This is the failure whose blast radius scales with adoption via self-update.
  5. Bare-metal Linux posture. Ship a systemd unit template (note: ProtectSystem=strict breaks the self-updater unless the install dir is writable; ACME needs AmbientCapabilities=CAP_NET_BIND_SERVICE; TimeoutStopSec=35 matches the 30s drain), a "Linux (systemd)" deployment section, and a cron backup one-liner. Add a "Reverse Proxy Topology" section with a working nginx snippet — and state correctly that LiveKit signaling is already proxied at /livekit/*; only WebRTC media (UDP range / TCP fallback) must be directly reachable.
  6. Backup robustness. Make the backup directory configurable (mirror the SetDatabasePath plumb), document an optional post-backup hook command for off-host shipping (rsync/rclone left to the operator), remove the output file on VACUUM INTO error, and run PRAGMA integrity_check before listing a backup as restorable. Document that backups stall writes for their duration and schedule them off-peak. No S3, no manifests.
  7. Fix the k6 load script, then publish one capacity number. Server/scripts/k6/ws-load.js predates the envelope protocol: auth fails on the first frame, three of four message types are wrong, and the only assertion checks HTTP 101 — a fully broken run reports green. Fix it, gate VU-connected on auth_ok/ready, add a workflow_dispatch-only job, and publish one reference sizing (connections vs p99 broadcast latency vs CPU/RAM) naming the two real bottlenecks. Do not gate main CI on it.
  8. Config and admin-settings honesty. Warn (never fail) on unknown config keys — capture the koanf key set after the defaults layer as the allow-list and diff a second instance loaded from the file. Remove or disable the five admin-settings fields nothing reads (server_icon, backup_schedule, backup_retention, max_upload_bytes, voice_quality) and document which require config.yaml + restart. Add a boot-time disk-free warning and a metric (needs a build-tagged Windows path). Return 507/503, not 400, when upload storage fails at the OS level.
  9. CI/release polish. Add a concurrency group to release.yml (cancel-in-progress: false); move client-check/client-tests off windows-latest or write down why they are there; record a graduation criterion for the non-blocking admin-e2e job; record the macOS scope decision near D8 rather than adding an unsigned build. Add the Tailscale CGNAT range note to docs/tailscale.md (admin routes 403 by default from 100.x.y.z addresses).

What not to do

  • Do not decompose the hub's seqMu fan-out or make its queue sizes tunable — per-client FIFO ordering depends on the current structure (Server/ws/hub_broadcast.go, Server/ws/CLAUDE.md). Architecture fix or nothing; never a dial.
  • Do not derive broadcast audience from pubsub subscribers — hub_broadcast.go documents why that was rejected.
  • Do not build S3, a job scheduler, cloud backup shipping, disk-based admission control, adaptive connection limits, or settings hot-reload.
  • Do not persist rate-limiter sliding windows or carve a pub/sub-slash-replay interface — speculative abstraction over the most delicate code in the repo.
  • Do not publish capacity numbers before the k6 script is fixed.
  • Do not attempt hub self-recovery after the panic breaker trips.

Suggested sequencing

  1. Track 3 #1 (backup scheduler) — the current UI state misleads operators.
  2. Track 3 #2 + #3 (metrics + health) — everything in Track 1 is guesswork without these signals.
  3. Track 3 #4 (release boot-smoke) — blast radius scales with adoption.
  4. Track 3 #5 + #6 (systemd + proxy docs + backup dir) — one coherent bare-metal pass; also the prerequisite for the hub breaker os.Exit(1).
  5. Track 1 #1 + #2 (hub liveness + connection ceiling) — small, self-contained, no locking changes.

Follow-up review passes suggested where this one was thin: release-path supply chain, TLS/ACME renewal failure handling and secrets at rest, and voice/LiveKit failure and scaling behavior.