Files
Warp/docs/README.md
T
tajniak81andClaude Opus 5.5 487e0f410b
CI / Test (ubuntu-latest) (push) Canceled after 0s
CI / Test (windows-latest) (push) Canceled after 0s
CI / Storage tests on PostgreSQL (push) Canceled after 0s
CI / Complement (federation off) (push) Canceled after 0s
CI / golangci-lint (push) Canceled after 0s
CI / Smoke test the binary (push) Canceled after 0s
Phase 10: hardening and ops
Implements PLAN.md Phase 10.

Simplified Sliding Sync (MSC4186) is served at the unstable
org.matrix.simplified_msc3575 endpoint and advertised in /versions. Lists
are sorted by activity and filtered by DM, invite, encryption, room type,
space and tag; room subscriptions, required_state with wildcards, $ME and
$LAZY, and the to_device, e2ee, account_data, receipts and typing
extensions are supported. Per-connection state is kept in memory and an
unknown pos answers M_UNKNOWN_POS.

Threads and relations: m.relates_to is indexed on roomserver_events
(migration 0012), /relations (with recursion) and /threads are served, and
every event a timeline read returns carries its m.thread, m.replace and
m.reference summaries in unsigned.m.relations. Notifications carry a
thread ID (migration 0013): threaded receipts clear only their thread, and
sync reports unread_thread_notifications when the filter asks.

Spaces: /hierarchy walks a space breadth first, asking other servers about
rooms this one is not in through the new federation hierarchy endpoint;
room_summary describes one room. /search runs on FTS5 (sqlite, pocketbase)
or tsvector (postgres), bounded to what each user may see, with context,
profiles, state, grouping and paging.

The PocketBase driver is real: the sqlite schema and store on an embedded
PocketBase app's database, with media in its filesystem, local or S3
(database.pocketbase.s3). It runs the full storage test suite.

Ops: OpenTelemetry tracing over OTLP/HTTP (tracing.*), with server spans
per route, component spans, and trace propagation on federation, push and
application service calls. New metrics for persisted events, waiting
syncs, sliding sync connections and the database pool, with a Grafana
dashboard. deploy/ adds a Compose setup (PostgreSQL, Prometheus, Grafana,
Jaeger) and a Helm chart; cmd/warp-loadtest loads a server and reports
request and delivery latencies.

The load tester found a long-standing bug, fixed here: on a server where
no account data had been written, every incremental /sync re-sent the push
rules and returned at once, and an all-zero token was taken for an initial
sync, so long polls became busy loops.

The PostgreSQL migrations and search dialect compile but were not run
against a live PostgreSQL in this change.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-17 20:21:31 +02:00

1.8 KiB

Documentation

Document What
configuration.md every setting, and its environment variable
development.md building, testing, Complement, adding a migration
event-core.md internal/matrix: canonical JSON, events, auth rules, state resolution
rooms.md internal/roomserver: the input pipeline, room storage, known gaps
sync.md internal/syncapi: stream tokens, long polling, filters, the ephemeral streams, Simplified Sliding Sync
relations.md threads, edits, reactions and references: /relations, /threads and unsigned.m.relations
spaces.md /hierarchy across servers, and room_summary
search.md /search on FTS5 and tsvector
federation.md the Server-Server API: discovery, keys, taking in events, joins across servers, the outbound queue, the switch
media.md internal/mediaapi: uploads, downloads, thumbnails, other servers' media, where the files go
e2ee.md internal/keyserver: device and one-time keys, cross-signing, device list tracking, key backup
push.md internal/pushrules and internal/pushserver: push rules, notification counts, pushers, the push gateway client
appservices.md internal/appservice: registration files, namespaces, acting as users, delivering events to bridges
admin-api.md /_warp/admin/v1: the operator API behind the admin panel
deployment.md storage drivers, the image, Compose, Helm, metrics and the dashboard, tracing, load testing

The design and roadmap are in PLAN.md at the repository root.