jmap-chat-server 0.4.2

JMAP Chat extension method handlers — backend-agnostic, plugs into jmap-server Dispatcher
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
# jmap-chat-server

> **Pre-stable (0.3.x).** The JMAP Chat crates (`jmap-chat-types`, `jmap-chat-server`,
> `jmap-chat-client`) do not yet have a stable API. Expect breaking changes,
> especially new required `ChatBackend` methods, until the 0.4 API freeze.

## What it is

JMAP Chat extension method handlers and the `ChatBackend` trait
([draft-atwood-jmap-chat]). Backend-agnostic — plugs into
`jmap-server::Dispatcher`. Consumers implement `ChatBackend` for their
storage; the crate handles all wire protocol, RFC 8620 conformance, and
non-trivial concurrency logic (Direct chat dedup, `Space/join` TOCTOU,
invite-use accounting).

## What it's for

Implements the JMAP Chat extension (draft-atwood-jmap-chat-00) — Chat,
Message, Space, ChatContact, ReadPosition, SpaceInvite, SpaceBan,
CustomEmoji, and PresenceStatus objects — so consumers can wire chat method
dispatch into their HTTP transport. Sibling to `jmap-mail-server` (the
canonical extension-server template) and the other `jmap-*-server` crates;
all of them inter-depend through the workspace `JmapHandler` trait in
`jmap-server`. The consumer supplies a `ChatBackend` impl (storage), a
`CallerCtx` type (auth identity), and wires the dispatcher into HTTP / SSE
/ WebSocket transport themselves.

## How to use

```rust,ignore
use std::sync::Arc;
use jmap_chat_server::{ChatBackend, register_chat_handlers};
use jmap_server::Dispatcher;

// 1. Implement ChatBackend for your storage layer. The impl must also
//    satisfy the JmapBackend supertrait (account_exists, get_objects,
//    get_state, get_changes, query_objects, query_changes) and declare
//    `type Error` and `type CallerCtx`. See the ChatBackend trait
//    section below for the full surface.

// 2. Construct a dispatcher parameterised on your CallerCtx type, then
//    register every Chat method in one call.
let mut dispatcher: Dispatcher<MyCallerCtx> = Dispatcher::new();
register_chat_handlers(&mut dispatcher, Arc::new(my_backend));

// 3. Dispatch JMAP requests (in your HTTP handler).
// let response = dispatcher.dispatch(request, caller_ctx, session_state).await;
```

`Dispatcher<C>` requires `B::CallerCtx = C`; `register_chat_handlers`
enforces the match at the type level. For a single-user dev server use
`Dispatcher<()>` with a backend whose `CallerCtx = ()`. For
multi-tenant production, define a typed caller context (e.g. a
principal-id newtype) and parameterise both sides on that type.

For a runnable, type-checked variant of this example, see the
[crate-level documentation](https://docs.rs/jmap-chat-server) — the
doctest in `lib.rs` is verified by `cargo test --doc`.

After `register_chat_handlers` returns, the dispatcher handles every method
name listed in the [Registered methods](#registered-methods) section below.
Each request's `CallerCtx` value is forwarded into the handler closure (see
[CallerCtx](#callerctx) below).

## Registered methods

`register_chat_handlers` installs handlers for all of the following:

| Object | Methods |
|---|---|
| `Chat` | `get`, `changes`, `query`, `queryChanges`, `set`, `typing` |
| `Message` | `get`, `changes`, `query`, `queryChanges`, `set` |
| `Space` | `get`, `changes`, `query`, `queryChanges`, `set`, `join` |
| `ChatContact` | `get`, `changes`, `query`, `queryChanges`, `set` |
| `ReadPosition` | `get`, `changes`, `set` |
| `SpaceInvite` | `get`, `changes`, `set` |
| `SpaceBan` | `get`, `changes`, `set` |
| `CustomEmoji` | `get`, `changes`, `query`, `queryChanges`, `set` |
| `PresenceStatus` | `get`, `changes`, `set` |

## `ChatBackend` trait

```rust,ignore
pub trait ChatBackend: JmapBackend {
    /// Create a new object. `build` receives the backend-assigned id and
    /// returns the object to store. Returns `(assigned_id, created_object)`.
    /// `create_id` is the client-side creation id from the `/set` request.
    fn create_object<O, F>(
        &self,
        caller: &Self::CallerCtx,
        account_id: &Id,
        create_id: &str,
        build: F,
    ) -> impl Future<Output = Result<(Id, O), BackendSetError<Self::Error>>> + Send
    where
        O: SetObject + Send + Sync,
        F: FnOnce(&Id) -> O + Send;

    /// Apply a partial update (patch) to an existing object.
    /// Returns `Some(updated_object)` if the backend modified any properties beyond
    /// what the client requested (RFC 8620 §5.3 server-set field echo), or `None`
    /// if the patch was applied verbatim.
    fn update_object<O: SetObject + Send + Sync>(
        &self,
        caller: &Self::CallerCtx,
        account_id: &Id,
        id: &Id,
        patch: O::Patch,
    ) -> impl Future<Output = Result<Option<O>, BackendSetError<Self::Error>>> + Send;

    /// Destroy an existing object by id.
    fn destroy_object<O: SetObject + Send + Sync>(
        &self,
        caller: &Self::CallerCtx,
        account_id: &Id,
        id: &Id,
    ) -> impl Future<Output = Result<(), BackendSetError<Self::Error>>> + Send;

    /// Returns `true` if this backend supports JMAP object type `O` for
    /// `account_id`, as seen by `caller`.
    /// Called by the session/capability builder — NOT called internally by handlers.
    fn supports_type<O: JmapObject>(&self, caller: &Self::CallerCtx, account_id: &Id) -> bool;

    /// Generate a cryptographically random invite code.
    /// MUST use a CSPRNG. Do NOT use timestamps or sequential counters.
    fn generate_invite_code(
        &self,
        caller: &Self::CallerCtx,
        account_id: &Id,
    ) -> impl Future<Output = Result<String, Self::Error>> + Send;

    /// Redeem the SpaceInvite `invite_id` for `Space/join`: add the owner to
    /// the invite's Space and increment the invite's `uses`.
    fn join_space_with_invite(
        &self,
        caller: &Self::CallerCtx,
        account_id: &Id,
        invite_id: &Id,
        joined_at: &UTCDate,
    ) -> impl Future<Output = Result<Result<(), InviteJoinRefusal>, Self::Error>> + Send;

    /// Apply a `readAt`-setting `patch` to the `burnOnRead` Message
    /// `message_id` and hard-delete it, as one atomic operation.
    fn read_and_burn_message(
        &self,
        caller: &Self::CallerCtx,
        account_id: &Id,
        message_id: &Id,
        patch: PatchObject,
    ) -> impl Future<Output = Result<(), BackendSetError<Self::Error>>> + Send;

    /// Apply a sequence of structural mutations to a Space (§Space/set).
    fn apply_space_patch(
        &self,
        caller: &Self::CallerCtx,
        account_id: &Id,
        space_id: &Id,
        ops: Vec<SpacePatchOp>,
    ) -> impl Future<Output = Result<Vec<OpResult>, BackendSetError<Self::Error>>> + Send;

    /// Apply a JSON Merge Patch to a Space's top-level metadata fields.
    fn apply_space_metadata_patch(
        &self,
        caller: &Self::CallerCtx,
        account_id: &Id,
        space_id: &Id,
        patch: SpaceMetadataPatch,
    ) -> impl Future<Output = Result<Option<Space>, BackendSetError<Self::Error>>> + Send;

    /// Permissions of the implicit `@everyone` role in `space`, the
    /// permission floor every member holds. No default.
    fn everyone_permissions(
        &self,
        caller: &Self::CallerCtx,
        account_id: &Id,
        space: &Space,
    ) -> impl Future<Output = Result<HashSet<ChatPermission>, Self::Error>> + Send;

    /// Blob lookup consulted for each Attachment of a Message create.
    fn attachment_blob(
        &self,
        caller: &Self::CallerCtx,
        account_id: &Id,
        blob_id: &Id,
    ) -> impl Future<Output = Result<Result<Option<AttachmentBlob>, SetError>, Self::Error>> + Send;

    // Methods with defaults (all take `caller: &Self::CallerCtx` first
    // except `retains_edit_history` and `maintains_unread_count`):
    // on_chat_destroyed, on_space_destroyed, on_space_ban_created,
    // on_outbound_event, limits, space_extension_properties,
    // protect_last_admin, retains_edit_history, maintains_unread_count,
    // is_contact_blocked, owner_user_id, may_set_custom_emoji,
    // may_broadcast_mention, may_set_pinned_messages, may_set_space_ban,
    // may_set_space_invite, may_get_space_invite, may_get_space_ban,
    // may_send_message, may_create_message, may_update_message,
    // may_update_chat, filenode_attachment, may_view_chat,
    // validate_pinned_message_ids, slow_mode_check, expire_message.
}
```

This block lists the required methods; see `src/backend.rs` for the full
signatures and contracts of the defaulted hooks.

The read-side operations (`get_objects`, `get_state`, `get_changes`, `query_objects`,
`query_changes`) are defined on the `JmapBackend` supertrait from `jmap-server`.

## Permission enforcement responsibilities

The handlers in this crate do **no** caller-identity checking. Per the
workspace AGENTS.md "Caller identity (foundation seam)" rule, backends
are canonical for authorization. Caller identity is read via
`JmapBackend::principal_id` on the `caller: &Self::CallerCtx`
parameter every backend method receives. In JMAP Chat the caller
acts as the account's owner, whose Space member entry is the
accountId (draft-atwood-jmap-chat-00 §Terminology), so authorization
splits three ways:

- **Account access** — the backend MUST verify that `caller` may act
  as the owner of `account_id` in `create_object`, `update_object`,
  `destroy_object`, `read_and_burn_message` and the other write
  methods, and return a `forbidden` SetError otherwise. Handlers do
  not check this, so a backend that trusts them lets any caller write
  any account.
- **Space permissions** — the backend decides them in the `may_*`
  hooks, `apply_space_patch`, `apply_space_metadata_patch` and
  `destroy_object::<Space>`, resolving the owner's permissions per
  §Space Permission Resolution (`everyone_permissions` supplies the
  `@everyone` floor). The hooks default to permit (fail-open,
  bd:JMAP-bghk).
- **Owner-relative rules on stored data** — group-admin and Message
  authorship rules are checked by the handler against the stored
  object and the accountId. A backend with concurrent writers
  re-verifies them atomically with the write.

The reference `memory::MemoryBackend` implements the Space-permission
hooks against the owner's member entry (except `may_set_custom_emoji`,
which permits every op), but returns `None` from `principal_id` and
does **not** check account access. Production backends MUST implement
every check below or they will silently accept JMAP requests that
draft-atwood-jmap-chat-00 mandates the server to reject. Denials are
`forbidden` SetErrors.

### Space/set and Space destroy (§Space/set, §Destroying a Space)

1. **`apply_space_patch` gates every op on its permission**:
   `manage_space`, `manage_channels`, `manage_members` or
   `manage_roles`, as `required_permissions_for_op` maps them. Role
   adds and edits, and role assignment, are limited to positions
   strictly below the caller's highest role; "servers SHOULD enforce
   this".

2. **Last-administrator protection.** When `protect_last_admin`
   returns `true`, reject any patch that leaves no member holding
   `manage_members` or `manage_space`; self-removal is exempt.

3. **Destroy requires `manage_space`**, checked atomically in
   `destroy_object::<Space>`: "The caller MUST hold `"manage_space"`".

### SpaceInvite/set and SpaceBan/set (§SpaceInvite/set, §SpaceBan/set)

4. **SpaceInvite create "Requires `"manage_members"` permission";
   destroy "Requires `"manage_members"` permission or ownership of the
   invite"** — `may_set_space_invite`.

5. **SpaceBan create, update and destroy each "Requires `"ban"`
   permission in the Space"** — `may_set_space_ban`.

6. **Visibility.** "Only members of the Space may retrieve its
   invites. Members with `"manage_members"` permission see all
   invites; other members see only invites they created"
   (`may_get_space_invite`). Members with `ban` see all SpaceBans of
   the Space; a banned user sees only their own (`may_get_space_ban`).

### Message/set and Message reads (§Message/set, §Message/query)

7. **Sender membership and `send`.** "The server MUST verify the
   sender is a current member of the target Chat … Non-members MUST
   receive a SetError of type `forbidden`", and channel senders need
   the `send` permission — `may_send_message`.

8. **Broadcast mentions** in a channel require `mention_broadcast`
   on create and update — `may_broadcast_mention`.

9. **Authorship (handler-checked).** Edits are allowed only "on a
   message where `senderId` is the accountId and `deletedAt` is
   absent"; `deletedForAll: true` and reaction changes for other
   senders are `forbidden`.

10. **Channel `view`.** "Messages in channels the caller cannot view
    MUST be omitted" from `Message/get` and `Message/query` —
    `may_view_chat`. A query without `chatId` spans Chats, so
    `query_objects` MUST itself omit them.

11. **Extension-bound Chats.** `may_create_message`,
    `may_update_message` and `may_update_chat` let a binding such as
    draft-atwood-jmap-chat-mimi-00 refuse writes to a Chat it
    restricts.

### Chat/set (§Chat)

12. **Group member changes "all require admin role, except leaving
    the group"** (handler-checked).

13. **`pinnedMessageIds`.** "For group chats, only admins may modify
    this list … For channel chats, only members with the `"pin"`
    Space permission may modify this list" — `may_set_pinned_messages`.

### CustomEmoji/set

14. **Implementation-defined.** `may_set_custom_emoji` decides every
    create, update and destroy, for server-global and Space-scoped
    emoji alike.

### Caller-identity-less backends

The reference `MemoryBackend` returns `None` from `principal_id` and
does not check account access (fail-open, bd:JMAP-bghk) — it is
suitable for single-user dev servers, fixtures, and the workspace's
own integration tests, but NOT for any deployment where more than one
principal can reach the JMAP dispatcher. A deployment that needs
access control MUST override `JmapBackend::principal_id` and implement
each of the checks above; the workspace ships no production-grade
reference impl.

## How it works

### Generic handlers

`*/get`, `*/changes`, `*/query`, and `*/queryChanges` all delegate to generic
implementations from `jmap-server`, ensuring RFC 8620 conformance across every object type
without duplication.

### `Chat/set` — Direct chat deduplication

Creating a `Chat` with `kind: "direct"` must be idempotent: if a Direct chat with the same
member set already exists, the caller should get back the existing chat rather than a
duplicate.

The handler uses optimistic create-then-validate deduplication:

1. Before the create loop, fetch all existing Direct chats for the account once (hoisted to
   avoid N+1 queries).
2. Attempt the create normally.
3. After the create, re-fetch to catch concurrent races where two clients create the same
   Direct chat simultaneously.
4. The canonical winner is the object with the lexicographically smallest ID. The loser
   destroys itself and returns an `alreadyExists` SetError pointing at the winner's ID.

### `Space/join` — invite-code and TOCTOU handling

`Space/join` is a non-standard method (not `/set`) that adds the caller as a member. It
accepts either an `inviteCode` or a `spaceId` (for public spaces).

- After the join write succeeds at the storage layer, the handler re-reads the member list
  to detect concurrent joins. If two callers both succeed, the racer with the later
  `joinedAt` timestamp undoes its write and returns a retryable error.
- `SpaceInvite.uses` is incremented only on the success path (after the TOCTOU check), so
  race-losses do not silently exhaust invite capacity.

### `Chat/typing` — ephemeral push

`Chat/typing` stores no state. It fires a push event via `JmapBackend::push_event` if the
backend implements push, then returns immediately. The wire response carries no payload
beyond the standard invocation envelope.

## CallerCtx

`register_chat_handlers` registers each method as a `ClosureHandler`
that forwards the dispatcher's `CallerCtx` value into the closure as `ctx`,
which the closure body then passes by reference (`&ctx`) into the standard
`handle_*` handler. The handler in turn forwards `caller: &B::CallerCtx` into
every `ChatBackend` (and inherited `JmapBackend`) method call.

To use this:

1. Pick a `CallerCtx` type for your backend — e.g. `()` if no auth context is
   needed, or a struct like `AuthCtx { user_id: Id, scopes: Vec<Scope> }`.
2. Implement `JmapBackend` with `type CallerCtx = AuthCtx;` (the bound is
   `Clone + Send + Sync + 'static`).
3. Use the matching `Dispatcher<AuthCtx>` and pass the constructed auth
   context as the second argument to `Dispatcher::dispatch(request, auth, …)`.
4. Inside `ChatBackend` method bodies, read `caller: &AuthCtx` to apply
   per-user visibility rules and the `may_*` permission hooks (e.g., that a
   caller can only modify their own `PresenceStatus`).

Backends that don't need an auth identity use `type CallerCtx = ();` and a
`Dispatcher<()>`. Both shapes register the same way.

## Gotchas

- **Direct chat deduplication is eventually consistent.** The `Chat/set` create handler uses optimistic create-then-validate to detect duplicate Direct chats. Under concurrent load two clients may both successfully create the same Direct chat; the loser's write is rolled back and it receives `alreadyExists`, but the duplicate briefly exists. Backends can eliminate this window by enforcing uniqueness atomically in `create_object`.
- **`Space/join` TOCTOU window.** After a successful join write, the handler re-reads the member list to detect concurrent joins. There is a brief window between the write and the re-read during which a second concurrent join can succeed. Both joiners will detect the race, but the loser's join is rolled back, not the winner's — so the final state is consistent.
- **Draft spec only.** `draft-atwood-jmap-chat` has not been submitted to the IETF; wire format and method semantics may change.

## Crate family

```
jmap-types
    ├── jmap-server          Dispatcher this crate plugs into
    └── jmap-chat-types      domain types (Chat, Message, Space, etc.)
            └── jmap-chat-server   ← this crate
```

## References

| Document | Covers |
|---|---|
| [draft-atwood-jmap-chat-00] | Core Chat objects and methods |
| [draft-atwood-jmap-chat-push-00] | Push notification payloads |
| [draft-atwood-jmap-chat-wss-00] | WebSocket ephemeral events |
| [RFC 8620] | JMAP Core (request format, SetError, ResultReference) |

[draft-atwood-jmap-chat]: https://github.com/MarkAtwood/jmap-chat-spec
[draft-atwood-jmap-chat-00]: https://github.com/MarkAtwood/jmap-chat-spec
[draft-atwood-jmap-chat-push-00]: https://github.com/MarkAtwood/jmap-chat-spec
[draft-atwood-jmap-chat-wss-00]: https://github.com/MarkAtwood/jmap-chat-spec
[RFC 8620]: https://www.rfc-editor.org/rfc/rfc8620