mirror of
https://github.com/J3vb/OwnCord.git
synced 2026-09-03 03:50:00 +03:00
Claude
cf8e5aae24
Add docs/architecture/ — a curated blueprint set with 10 Mermaid diagrams covering system context, deployment topology, server package map, REST request lifecycle, WebSocket auth/replay/dispatch, the full data model (migrations 001-015), voice/E2EE flow, and the client module map. Add docs/audit-2026-07-19.md — successor to audit-2026-04-07.md: re-verifies carried-over findings, catalogues spec-vs-code drift in api.md/protocol.md/schema.md (incl. the announcement channel-type contradiction and the undocumented voice-E2EE protocol surface), records server/client/CI findings with file:line evidence, and closes with a 12-item prioritized improvement backlog. Link both from the README docs index. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UA17KPvqGBX3XbXYnMf1rA
113 lines
4.8 KiB
Markdown
113 lines
4.8 KiB
Markdown
# Client Architecture (Tauri)
|
||
|
||
**Verified against:** commit `ddc49f0`, 2026-07-19
|
||
|
||
Desktop client built on Tauri v2: a TypeScript webview (~31.7k LOC, vanilla TS —
|
||
no UI framework) plus ~2.3k LOC of Rust commands. State lives in a hand-rolled
|
||
reactive store (`src/lib/store.ts`: immutable updates, microtask-batched
|
||
notifications, selector subscriptions). Components are factory functions
|
||
returning `{ element, mount, destroy }` built with the `@lib/dom` helpers; a
|
||
2-page state machine (`src/lib/router.ts`) switches between the Connect and
|
||
Main pages.
|
||
|
||
> `docs/client-architecture.md` still describes a SolidJS-based client. The
|
||
> Solid migration was **abandoned** (per CHANGELOG); only a 154-LOC beachhead
|
||
> remains under `src/components/solid/`. This document reflects the actual
|
||
> state.
|
||
|
||
## D7 — Module map
|
||
|
||
```mermaid
|
||
flowchart TB
|
||
subgraph boot ["Bootstrap"]
|
||
MAIN["main.ts<br/>page orchestration, auth wiring,<br/>appearance pre-render"]
|
||
end
|
||
|
||
subgraph rust ["Rust (src-tauri)"]
|
||
WSP["ws_proxy.rs<br/>WSS + TOFU cert pinning"]
|
||
LKP["livekit_proxy.rs<br/>loopback TLS tunnel"]
|
||
CRED["credentials.rs<br/>OS keychain"]
|
||
PTT["ptt.rs<br/>push-to-talk polling"]
|
||
UPDC["update_commands.rs<br/>self-hosted updater"]
|
||
SET["commands.rs<br/>settings store (key allowlist)"]
|
||
end
|
||
|
||
subgraph comm ["Communication layer (src/lib)"]
|
||
API["api.ts<br/>REST client (tauri-plugin-http,<br/>allowSelfSigned=true)"]
|
||
WSC["ws.ts<br/>reconnect w/ backoff, seq replay,<br/>generation counters"]
|
||
DISP["dispatcher.ts<br/>~30 msg types → store mutators"]
|
||
LKS["livekitSession.ts (1.7k LOC)<br/>voice state machine + E2EE"]
|
||
end
|
||
|
||
subgraph state ["Stores (8 singletons)"]
|
||
AUTH2["auth"]
|
||
CHAN["channels"]
|
||
MSG["messages"]
|
||
MEM["members"]
|
||
VOICE["voice"]
|
||
DM["dm"]
|
||
ROLES["roles"]
|
||
UIS["ui"]
|
||
end
|
||
|
||
subgraph ui ["UI (imperative DOM)"]
|
||
CP["ConnectPage<br/>profiles + health polling"]
|
||
MP["MainPage<br/>SidebarArea / ChatArea /<br/>controllers"]
|
||
COMP["~30 component families<br/>message-list, settings tabs,<br/>voice widgets, overlays"]
|
||
SOLID["components/solid/<br/>abandoned beachhead"]
|
||
end
|
||
|
||
MAIN --> CP
|
||
MAIN --> MP
|
||
MAIN --> API
|
||
MAIN --> WSC
|
||
WSC --> WSP
|
||
WSC --> DISP
|
||
DISP --> AUTH2 & CHAN & MSG & MEM & VOICE & DM & ROLES & UIS
|
||
state --> ui
|
||
LKS --> LKP
|
||
VOICE --> LKS
|
||
MP --> COMP
|
||
API -.->|"no cert pinning<br/>(unlike WS path)"| SRV["Go server"]
|
||
WSP --> SRV
|
||
CRED -.-> MAIN
|
||
UPDC -.-> MAIN
|
||
|
||
%% cross-store coupling (audit finding)
|
||
AUTH2 -.->|clearAuth → leaveVoice| VOICE
|
||
VOICE -.-> MEM
|
||
|
||
classDef dead fill:none,stroke-dasharray: 5 5,opacity:0.6
|
||
class SOLID dead
|
||
```
|
||
|
||
**What this shows.** Data flows one way in the happy path: WS frame → Rust
|
||
`ws_proxy` → `ws.ts` → `dispatcher.ts` → store mutators → subscribed components
|
||
re-render. The dashed edges mark the audit findings: the HTTP path accepts any
|
||
certificate (`allowSelfSigned` hardcoded, no TOFU pinning — unlike the WS and
|
||
LiveKit paths, which pin fingerprints in Rust), the stores cross-import each
|
||
other (auth→voice→members), and the Solid beachhead is dead weight.
|
||
|
||
### Key mechanisms
|
||
|
||
| Concern | Where | How |
|
||
|---------|-------|-----|
|
||
| Reconnect | `src/lib/ws.ts` | Exponential backoff (cap 30s), heartbeat 30s, `last_seq` replay + bounded dedup set, generation counter invalidates stale listeners |
|
||
| Cert trust | `src-tauri/src/ws_proxy.rs` | TOFU: first fingerprint pinned per host (`certs.json`); mismatch → modal (`CertMismatchModal`) |
|
||
| Credentials | `src-tauri/src/credentials.rs` | OS keychain per host; password field `serde(skip)` so it never crosses IPC back to JS |
|
||
| Multi-server | `src/lib/profiles.ts` | Server profiles w/ 15s health polling and auto-connect; one active connection, quick-switch replaces WS + tunnels |
|
||
| Updates | `src/lib/updater.ts` + `update_commands.rs` | Endpoint derived from the connected server URL, https-only, TLS pinned to TOFU fingerprint, minisign-verified |
|
||
| Settings | `commands.rs` + `src/lib/preferences.ts` | Split persistence: Rust store (`settings.json`, key-allowlisted) *and* raw `localStorage` for UI prefs/themes |
|
||
| Theming | `src/lib/themes.ts` + `styles/tokens.css` | CSS custom properties; 4 built-in themes + custom overrides |
|
||
|
||
### Quality tooling
|
||
|
||
157 test files (~63k LOC — about 2× the source): Vitest unit + integration,
|
||
Playwright E2E (web and native Tauri suites), Stryker mutation testing, oxlint +
|
||
type-checked ESLint, Prettier, Knip, strict `tsc`. The client unit suite is
|
||
currently marked "KNOWN RED" and non-blocking in CI — an audit finding.
|
||
|
||
**Source of truth:** `src/main.ts`, `src/lib/dispatcher.ts`, `src/lib/ws.ts`,
|
||
`src/lib/api.ts`, `src/lib/store.ts`, `src/stores/*.store.ts`,
|
||
`src-tauri/src/lib.rs`, `src-tauri/tauri.conf.json`.
|