Files
TREK/wiki/Real-Time-Collaboration.md
T
Maurice 2dd77aaac1 docs(wiki): the pages the 4.3.1 changes left behind
The check-in is an anchor now, not an earliest arrival, and a booked night
leads its check-in day, which the road trip and accommodation pages said
otherwise. Upgrading gains a 4.3.1 section for the reseat migration and for
what better-sqlite3 13 asks of a source install. The collaboration page knows
that links are chips and editable, the audit log knows the new admin action
and the SSO register row, and the MCP pages know the provider parameter and
the Google-only switch.
2026-09-22 13:30:12 +02:00

5.5 KiB

Real-Time Collaboration

TREK keeps every trip in sync across all connected members without requiring a page refresh. A dedicated Collab addon adds a second layer on top of that sync: group chat, shared notes, shared links, polls, and a "What's Next" widget showing upcoming assigned places.

The Collab tab: chat, shared notes, polls and the What's Next widget side by side

Real-time sync

All changes to a trip — places, day plans, reservations, budget entries, and packing lists — are broadcast instantly to every connected member via WebSocket. You see other people's edits as they happen.

WebSocket transport

Parameter Value
Path /ws
Scope One room per trip
Rate limit 30 messages per 10-second window, plus a looser ceiling of 200 frames per 10 seconds that every frame counts against before it is parsed. Live cursor frames (book:cursor) are exempt from the tighter limit, not from the looser one
Max payload 64 KB per message
Heartbeat Ping every 30 seconds; sockets that miss a pong are terminated
Origin check Only enforced when ALLOWED_ORIGINS is set: an upgrade whose Origin header is not an exact match for a list entry is refused with HTTP 403 during the handshake. An upgrade that sends no Origin header at all is always admitted

Authentication uses a short-lived ephemeral token passed as a query parameter on connect. If authentication fails, the server closes the connection with one of these codes:

  • 4001 — missing, invalid, or expired token; user not found
  • 4403 — site-wide MFA is required but the account does not have MFA enabled

An origin rejection happens before the socket exists, so it produces no close code at all — the browser just reports a failed connection. And because clients that send no Origin header are exempt, curl and other CLI clients keep connecting while every browser fails, which makes it look like a client bug. If real-time sync stops working behind a reverse proxy, check that ALLOWED_ORIGINS lists the exact scheme, host, and port the browser uses: the comparison is a plain string match, so https://trek.example.com matches neither http://trek.example.com nor https://trek.example.com:443. See Environment-Variables and Reverse-Proxy.

The Collab addon

The Collab addon (collab) must be enabled by an admin before the panel is visible inside a trip. Once enabled, it provides five sub-features that can each be toggled independently:

Sub-feature What it provides
Chat Group chat with reactions, replies, images, and URL previews
Notes Categorized, pinnable, markdown-formatted shared notes
Links Shared web addresses with a title, pinnable, synced live between members
Polls Single- or multiple-choice votes with optional deadlines
What's Next Upcoming assigned places across all trip days

Admin: enable the Collab addon and individual sub-features in Admin-Addons. Links is on by default, like the other four.

On desktop the panel shows Chat as a fixed 380 px column on the left when other sub-features are also enabled; if only Chat is on, it expands to fill the full width. Notes, Links, Polls, and What's Next share the remaining space on the right. On mobile a tab bar at the top lets you switch between the enabled sub-features one at a time. Disabled sub-features are hidden from the tab bar.

The Links tab collects the web addresses a trip runs on: the booking portal, the shared photo album, the restaurant's menu. Add link asks for a title and an http(s) address; anything else is refused. Each link is a chip with the site's favicon, the title and the host, two to a row where the panel is wide enough and one to a row where it is narrow, as in the Collab tab on the phone; a pinned chip is drawn in the accent tint. The whole chip is the link and opens the address in a new tab. Members with collab_edit can edit it in place (the pencil, for title and address alike), pin it to the top of the list or delete it, which asks first because the link goes for every member; the three sit faint in the chip's tail and come forward on hover, and are always shown on touch. Pinned links come first, then the newest. Adding, editing, pinning and deleting show up for every connected member at once.

Conflict handling

TREK uses a last-write-wins model. Each mutation is applied on the server and the resulting canonical state is broadcast to all connected clients. If two members edit the same field at the same time, the change that reaches the server last is the one that sticks; all clients converge to that server-authoritative state.

On reconnect, any locally queued mutations are flushed to the server before the client re-fetches trip data, so offline changes are applied before the latest state is read back.

There is no operational-transform or CRDT merge — simultaneous edits to the same field are not merged; one silently wins.

Access control

All Collab reads require trip membership. Writing — sending messages, creating notes, adding links, creating polls, voting — requires the collab_edit permission. Members without collab_edit can read but cannot post or interact.

Collab-Chat · Collab-Notes · Collab-Polls · Whats-Next-Widget · Trip-Planner-Overview · Admin-Addons