tajniak81andClaude Opus 5
d187ad0d17
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
Implements PLAN.md Phase 4: the read model. /sync, /messages and /context, the filters that narrow them, and the streams a response carries that are not room events — typing, receipts, presence and to-device messages. With this a client can be used against Warp, which is milestone M1. The one architectural choice is that the syncapi has no copy of the rooms: it reads them through the roomserver. Dendrite gives its syncapi its own tables and feeds them from the output stream, which is right for a design where the two can be separate processes, and Dendrite's could be. Warp is one process by decision, and there the copy buys nothing and costs the hardest class of bug a homeserver has — a read model that disagrees with the room, where a client is shown a message that was rejected and the only way to find out is to compare two tables. So the roomserver grew a read model (stream.go, roomsync.go, visibility.go) rather than exporting its store: reading an event means parsing it under its room's version, and a second copy of the version registry, the parser and the client projection would be a second place for them to disagree. syncapi: stream tokens naming a position in each of five independent streams, so a client that has seen receipt 7 but only event 4 can say so in one opaque string. A token with fewer positions than this build writes is accepted and the rest read as zero, which is what lets a token stored before a stream existed go on working. The PDU position comes from MAX(stream_ordering) and not from the counter row the other four use: the counter is advanced inside the writing transaction, so a token taken from it would name a position whose event no reader can see yet, and the event would be skipped for good once that transaction committed. Long polling goes through a notifier that wakes by room and by user rather than globally — an event wakes the listeners of its room, a membership event also wakes the user it names, so an invite reaches a client that is not in the room yet. A wake-up is only ever a hint: the listener re-reads the streams and decides for itself what changed, which is what makes it safe for the notifier to hold no state about what each client has seen. The listener registers before the read, so an event landing in between leaves the channel signalled and the sync reads again rather than blocking on a change it just missed. EventPersisted must not block, because it is called with the room's write lock still held. "Something happened" is not "a token moved". A stream can move without this user being concerned by it, and returning on every such move would turn a long poll back into a busy loop. The same trap caught presence twice over: a client says it is still online by syncing, so ?set_presence= makes every sync a presence write, and a stream that moved each time would wake every peer, which would sync, which would move it again. SetPresence therefore reports whether anything a peer would notice actually changed, and a write that only refreshes the last-active timestamp leaves the stream alone. Timeline windows are named by their two ends and a direction, Low exclusive and High inclusive in both directions, rather than by "from" and "to" as the wire format spells them. Each of those would otherwise be the low bound in one direction and the high bound in the other, which is exactly the off-by-one every pagination bug is made of; the handlers translate once and nothing below them thinks about it again. A sync's timeline is read backwards and reported forwards, because a client wants the newest events of the window it missed — a forward read with a limit hands it the oldest and then calls the rest a gap. visibility: history visibility is now a span rather than a yes or no, which is what Phase 3 deferred here. A user who has left a room is served the room as it was when they left — their state reads, their members and their timeline — instead of being refused, and is bounded above at their own membership event so a kicked client cannot go on streaming. Their span is found from their own member events, so a user who joined, left and rejoined sees their latest span. ?at= on /members is honoured for the same reason. What is left is that the span is computed from the room's current history_visibility where the spec judges each event by the one in force when it was sent; that is a state read per event and belongs with open question 1. Typing is held in memory and nowhere else: notifications expire in seconds, are worthless across a restart, and arrive one per keystroke-burst per room, so persisting them would be the busiest table in the database holding the least valuable data in it. Receipts only ever advance, compared on the position of the event acknowledged rather than on arrival, because two of a user's clients read at different speeds and the slower one must not drag the marker backwards. To-device queues are per device and drained by the next sync rather than by the one that delivered them, so a client that crashes in between gets the batch again — the right way round, since a lost key share leaves a message permanently undecryptable and a duplicate is ignored. A wildcard addressee is expanded when sent, not stored, because "every device" means the ones that existed then. Presence is off by default, which answers PLAN.md open question 3. It is the noisiest thing in Matrix and the one genuinely fan-out notification here; a private homeserver gains little from it. With it off the endpoints refuse rather than disappearing, because a client that gets a 404 from /presence concludes the server is too old to have it and stops asking. storage: one migration per driver adding the receipt, to-device, presence and filter tables with a counter row each, and a stream position on the existing account data table rather than a parallel one — there is exactly one current value per (user, room, type), and a second table would be a second thing to keep in step. Account data is reported in an event list but is not an event, so it gets its own response type: a room event with an empty sender and no timestamp would make a client decide what that meant. Deliberately missing, each named in docs/sync.md: notification counts (they need push rules, Phase 8), device lists (the keyserver, Phase 7), anything remote (Phase 5), threads (Phase 10). device_lists is sent as two empty lists because a client reads a missing one as malformed; the notification counts are left out entirely, because a zero there is a claim and an absent field is not. Tested through HTTP rather than against the builder, because what is worth pinning down is the response a client sees — which section a room lands in, whether a token handed back can be handed in again, whether paging terminates and loses nothing. The storage tests run against both SQL drivers; the notifier has its own tests for the concurrent case. A live server was driven end to end, which is what caught the two bugs the unit tests had missed: a backwards /messages page must be in reverse chronological order, and `start` must name where the page began rather than position zero when ?from= was omitted. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
180 lines
7.4 KiB
Plaintext
180 lines
7.4 KiB
Plaintext
# Warp homeserver configuration.
|
|
#
|
|
# Copy to warp.yaml and edit. Every field below is optional except
|
|
# global.server_name; the values shown are the defaults.
|
|
#
|
|
# Any field can also be set from the environment, which wins over this
|
|
# file. The variable name is on the right of each line below, e.g.
|
|
# WARP_SERVER_NAME=warp.example WARP_FEDERATION_ENABLED=true warp serve
|
|
# List values are comma-separated; a single "-" clears a list.
|
|
|
|
version: 1
|
|
|
|
global:
|
|
# The Matrix server name. It appears in every user, room and event ID
|
|
# and CANNOT be changed after the first event is written. WARP_SERVER_NAME
|
|
server_name: warp.example
|
|
|
|
# ed25519 signing key, created by `warp generate-keys`. WARP_PRIVATE_KEY
|
|
private_key: ./keys/signing.key
|
|
|
|
well_known:
|
|
# Advertised to clients as m.homeserver.base_url.
|
|
# Defaults to https://<server_name>. WARP_WELL_KNOWN_CLIENT_BASE_URL
|
|
client_base_url: ""
|
|
|
|
# Optional identity server. WARP_WELL_KNOWN_IDENTITY_SERVER_BASE_URL
|
|
identity_server_base_url: ""
|
|
|
|
# Advertised to other homeservers as m.server, e.g. "warp.example:8448".
|
|
# Only served while federation is enabled; empty means other servers
|
|
# fall back to SRV/A resolution. WARP_WELL_KNOWN_SERVER_ADDRESS
|
|
server_address: ""
|
|
|
|
listen:
|
|
address: ":8008" # WARP_LISTEN_ADDRESS
|
|
read_header_timeout: 10s # WARP_READ_HEADER_TIMEOUT
|
|
read_timeout: 60s # WARP_READ_TIMEOUT
|
|
write_timeout: 120s # WARP_WRITE_TIMEOUT
|
|
idle_timeout: 120s # WARP_IDLE_TIMEOUT
|
|
max_header_bytes: 1048576 # WARP_MAX_HEADER_BYTES
|
|
shutdown_timeout: 30s # WARP_SHUTDOWN_TIMEOUT
|
|
|
|
database:
|
|
# sqlite (dev, single user), postgres (production) or pocketbase
|
|
# (appliance; not implemented yet). WARP_DB_DRIVER
|
|
driver: sqlite
|
|
|
|
# sqlite: file:warp.db?_pragma=journal_mode(WAL)
|
|
# postgres: postgres://warp:secret@localhost/warp?sslmode=disable
|
|
# WARP_DB_CONNECTION_STRING
|
|
connection_string: "file:warp.db?_pragma=journal_mode(WAL)&_pragma=busy_timeout(10000)&_pragma=foreign_keys(1)"
|
|
|
|
max_open_conns: 10 # WARP_DB_MAX_OPEN_CONNS (ignored by sqlite:
|
|
max_idle_conns: 5 # WARP_DB_MAX_IDLE_CONNS one writer only)
|
|
conn_max_lifetime: 1h # WARP_DB_CONN_MAX_LIFETIME
|
|
|
|
# Apply pending migrations on startup. Set false to gate schema changes
|
|
# behind an explicit `warp migrate`. WARP_DB_AUTO_MIGRATE
|
|
auto_migrate: true
|
|
|
|
client_api:
|
|
# The Matrix spec expects a homeserver to allow any origin. Narrow this
|
|
# if only your own web client talks to it. WARP_CORS_ALLOWED_ORIGINS
|
|
cors_allowed_origins: ["*"]
|
|
|
|
# Take the client address from X-Forwarded-For instead of the socket.
|
|
# Turn this on ONLY behind a reverse proxy that overwrites the header:
|
|
# anyone can send it, and the rate limiter keys on the result.
|
|
# WARP_TRUST_X_FORWARDED_FOR
|
|
trust_x_forwarded_for: false
|
|
|
|
# Expire access tokens after this long. 0 (the default) issues tokens
|
|
# that never expire, which is what clients without refresh-token
|
|
# support need. With a lifetime set, clients that ask for
|
|
# refresh_token on login get one. WARP_ACCESS_TOKEN_LIFETIME
|
|
access_token_lifetime: 0s
|
|
|
|
# How long a refresh token may be exchanged for a new access token.
|
|
# 0 means no expiry. WARP_REFRESH_TOKEN_LIFETIME
|
|
refresh_token_lifetime: 0s
|
|
|
|
# Per-endpoint rate limiting. Each bucket allows `burst` requests back
|
|
# to back and returns one slot every `interval`, per client address.
|
|
# Login and registration get their own, tighter, buckets because they
|
|
# are the two endpoints worth brute-forcing.
|
|
#
|
|
# Only `enabled` has an environment override (the three buckets share a
|
|
# type, so per-bucket variables would collide): set
|
|
# WARP_RATE_LIMIT_ENABLED=false to turn the whole thing off, which is
|
|
# what a test harness such as Complement wants.
|
|
rate_limit:
|
|
enabled: true # WARP_RATE_LIMIT_ENABLED
|
|
default:
|
|
burst: 30
|
|
interval: 100ms
|
|
login:
|
|
burst: 10
|
|
interval: 1s
|
|
register:
|
|
burst: 5
|
|
interval: 2s
|
|
# Creating a room writes a dozen events and joining one writes a
|
|
# membership event that everybody in the room then sees, so both are
|
|
# deliberately slower than a read.
|
|
room_create:
|
|
burst: 10
|
|
interval: 1s
|
|
join:
|
|
burst: 10
|
|
interval: 1s
|
|
# /sync and the chatty writes behind it: typing, receipts, to-device
|
|
# messages and presence. The loosest bucket of the lot on purpose — a
|
|
# client lives in /sync, and a long poll that is refused leaves it
|
|
# reconnecting in a loop, which is the one case where rate limiting
|
|
# makes the load worse rather than better.
|
|
sync:
|
|
burst: 100
|
|
interval: 20ms
|
|
|
|
sync:
|
|
# Presence — who is online, and the status message they set. Off by
|
|
# default: it is the noisiest thing in Matrix, because every user's
|
|
# state change is published to everybody they share a room with, and a
|
|
# private homeserver gains little from it. With it off, the presence
|
|
# endpoints answer M_FORBIDDEN and a sync's presence section is empty.
|
|
# WARP_SYNC_PRESENCE
|
|
presence: false
|
|
|
|
# How long a typing notification lasts without being renewed, and the
|
|
# cap on what a client may ask for. A notification that outlived its
|
|
# sender's session would leave a room claiming somebody was typing.
|
|
# WARP_SYNC_TYPING_TIMEOUT
|
|
typing_timeout: 30s
|
|
|
|
# The cap on a /sync's ?timeout=, whatever the client asks for. Holding
|
|
# a connection open longer buys nothing — a blocked sync is woken the
|
|
# moment anything happens — so this only decides how often an idle
|
|
# client re-establishes its request.
|
|
# WARP_SYNC_LONG_POLL_TIMEOUT
|
|
long_poll_timeout: 30s
|
|
|
|
federation:
|
|
# Off by default: a new install is a private homeserver until you say
|
|
# otherwise. WARP_FEDERATION_ENABLED
|
|
enabled: false
|
|
|
|
# Non-empty = federate ONLY with these servers.
|
|
# WARP_FEDERATION_ALLOWLIST
|
|
allowlist: []
|
|
|
|
# Always blocked, even if listed above. WARP_FEDERATION_DENYLIST
|
|
denylist: []
|
|
|
|
# Let the admin API flip `enabled` without a restart. When true, the
|
|
# stored setting overrides the value above on boot.
|
|
# WARP_FEDERATION_ALLOW_RUNTIME_TOGGLE
|
|
allow_runtime_toggle: true
|
|
|
|
registration:
|
|
# Off by default. Make the first account with
|
|
# `warp create-account --username you --admin`, then turn registration
|
|
# on from the admin API if you want others to sign up.
|
|
enabled: false # WARP_REGISTRATION_ENABLED
|
|
allow_runtime_toggle: true # WARP_REGISTRATION_ALLOW_RUNTIME_TOGGLE
|
|
|
|
# Non-empty = registration also requires one of these tokens, as the
|
|
# m.login.registration_token stage of the sign-up flow. Per-token use
|
|
# counts and expiry arrive with admin token management in Phase 9.
|
|
# WARP_REGISTRATION_TOKENS
|
|
tokens: []
|
|
|
|
logging:
|
|
level: info # debug, info, warn, error WARP_LOG_LEVEL
|
|
format: text # text or json WARP_LOG_FORMAT
|
|
add_source: false # WARP_LOG_ADD_SOURCE
|
|
|
|
metrics:
|
|
enabled: true # WARP_METRICS_ENABLED
|
|
path: /metrics # WARP_METRICS_PATH
|