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
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
//! `replyTo` / `threadRootId` validation and thread counts
//! (bd:JMAP-y3f2.3), and their `Message/changes` reporting
//! (bd:JMAP-y3f2.15).
//!
//! Oracles, quoted from draft-atwood-jmap-chat-00.md at jmap-chat-spec
//! 91672c9:
//!
//! - L632-633 `replyTo`: "The receiver-assigned `id` of the Message this
//!   replies to. Servers MUST validate that this ID exists in the same
//!   Chat before storing."
//! - L638-639 `replyCount`: "Count of messages in this chat with
//!   `replyTo` equal to this message's `id`. Present only when
//!   `supportsThreads` is `true`."
//! - L641-642 `unreadReplyCount`: "Count of replies to this message
//!   received after the owner's `ReadPosition.lastReadMessageId` in this
//!   Chat. Present only when `supportsThreads` is `true` and this message
//!   is a thread root (`threadRootId` is absent)."
//! - L591: "Message IDs are ULIDs, assigned by the **receiving** mailbox
//!   at storage time. ULIDs are lexicographically ordered by time".
//! - L1510-1514 thread root assignment: "A message with no `replyTo` is a
//!   potential thread root. `threadRootId` MUST be absent." / "A message
//!   replying to a thread root (the referenced message has no
//!   `threadRootId`): set `threadRootId` to the value of `replyTo`." / "A
//!   message replying to a non-root message: set `threadRootId` to the
//!   referenced message's `threadRootId`." / "Servers SHOULD validate them
//!   and MAY correct `threadRootId` if the client supplies an incorrect
//!   value."
//! - L1672 §Input Validation: "When a `Message/set` create or update fails
//!   one of these checks and this document names no other error for that
//!   check, the server MUST reject the entry with an `invalidProperties`
//!   SetError".
//! - L1506: "A thread is the set of Messages sharing a common
//!   `threadRootId`."
//! - jmap-chat-spec bead jmap-chat-spec-vz8p (Mark, 2026-10-30): which
//!   messages count as unread is implementation-defined, and this server
//!   does not count replies whose `senderId` is the accountId (the
//!   owner's own). The fixture Messages come from `OTHER_SENDER`.

mod common;

use common::{ACCOUNT_ID, MemoryBackend};
use jmap_chat_server::message::{
    handle_message_changes, handle_message_get, handle_message_query, handle_message_set,
};
use jmap_chat_server::{ChatLimits, handle_chat_set, handle_position_set};
use jmap_server::HandlerOutput;
use serde_json::{Value, json};

// Hand-picked ULIDs (Crockford base32, 26 chars) in ascending order.
const ROOT: &str = "01J0000000000000000000000A";
const A: &str = "01J0000000000000000000000B";
const B: &str = "01J0000000000000000000000C";
const C: &str = "01J0000000000000000000000D";
const OTHER_CHAT_MSG: &str = "01J0000000000000000000000E";
/// A reply to ROOT sent by the owner, sorting after every fixture id.
const OWN_REPLY: &str = "01J0000000000000000000000F";

/// A ChatContact other than the owner; the owner's own Messages carry the
/// accountId as `senderId`.
const OTHER_SENDER: &str = "contact-bob";

async fn create_group(backend: &MemoryBackend) -> String {
    let HandlerOutput { primary: resp, .. } = handle_chat_set(
        backend,
        &(),
        &std::collections::BTreeMap::new(),
        json!({
            "accountId": ACCOUNT_ID,
            "create": { "g": { "kind": "group", "name": "G", "memberIds": ["contact-bob"] } }
        }),
        &[],
    )
    .await
    .expect("Chat/set");
    resp["created"]["g"]["id"]
        .as_str()
        .unwrap_or_else(|| panic!("group not created: {resp}"))
        .to_owned()
}

/// Seed one stored Message with a fixed id.
fn seed_message(
    backend: &MemoryBackend,
    id: &str,
    chat_id: &str,
    reply_to: Option<&str>,
    root: Option<&str>,
) {
    seed_message_from(backend, OTHER_SENDER, id, chat_id, reply_to, root);
}

fn seed_message_from(
    backend: &MemoryBackend,
    sender_id: &str,
    id: &str,
    chat_id: &str,
    reply_to: Option<&str>,
    root: Option<&str>,
) {
    let mut msg = json!({
        "id": id,
        "senderMsgId": id,
        "senderId": sender_id,
        "chatId": chat_id,
        "body": "x",
        "bodyType": "text/plain",
        "attachments": [],
        "sentAt": "2024-01-01T00:00:00Z",
        "receivedAt": "2024-01-01T00:00:00Z",
        "deliveryState": "delivered",
    });
    if let Some(r) = reply_to {
        msg["replyTo"] = json!(r);
    }
    if let Some(r) = root {
        msg["threadRootId"] = json!(r);
    }
    backend.insert_object_for_test("Message", ACCOUNT_ID, id, msg);
}

/// Fixture thread in one Chat:
///
/// ```text
/// ROOT
/// ├── A  (replyTo ROOT, threadRootId ROOT)
/// │   └── B  (replyTo A, threadRootId ROOT)
/// └── C  (replyTo ROOT, threadRootId ROOT)
/// ```
///
/// plus OTHER_CHAT_MSG in a second Chat, and a ReadPosition for the
/// first Chat with `lastReadMessageId` = A.
async fn fixture(backend: &MemoryBackend) -> (String, String) {
    let chat = create_group(backend).await;
    let other = create_group(backend).await;
    seed_message(backend, ROOT, &chat, None, None);
    seed_message(backend, A, &chat, Some(ROOT), Some(ROOT));
    seed_message(backend, B, &chat, Some(A), Some(ROOT));
    seed_message(backend, C, &chat, Some(ROOT), Some(ROOT));
    seed_message(backend, OTHER_CHAT_MSG, &other, None, None);
    backend.insert_object_for_test(
        "ReadPosition",
        ACCOUNT_ID,
        "rp1",
        json!({
            "id": "rp1",
            "chatId": chat,
            "lastReadMessageId": A,
            "lastReadAt": "2024-01-01T00:00:00Z",
        }),
    );
    (chat, other)
}

fn threads_on(backend: &MemoryBackend) {
    backend.set_limits_for_test(Some(ChatLimits::default().with_supports_threads(true)));
}

async fn create(backend: &MemoryBackend, obj: Value) -> Value {
    let HandlerOutput { primary: resp, .. } = handle_message_set(
        backend,
        &(),
        &std::collections::BTreeMap::new(),
        json!({ "accountId": ACCOUNT_ID, "create": { "m": obj } }),
        &[],
    )
    .await
    .expect("Message/set");
    resp
}

fn reply(chat: &str, reply_to: &str, root: Option<&str>) -> Value {
    let mut obj = json!({
        "chatId": chat,
        "body": "re",
        "bodyType": "text/plain",
        "sentAt": "2024-01-01T00:00:00Z",
        "replyTo": reply_to,
    });
    if let Some(r) = root {
        obj["threadRootId"] = json!(r);
    }
    obj
}

async fn get(backend: &MemoryBackend, ids: &[&str]) -> Vec<Value> {
    let HandlerOutput { primary: resp, .. } = handle_message_get(
        backend,
        &(),
        json!({ "accountId": ACCOUNT_ID, "ids": ids }),
        &[],
    )
    .await
    .expect("Message/get");
    resp["list"].as_array().expect("list").clone()
}

fn by_id<'a>(list: &'a [Value], id: &str) -> &'a Value {
    list.iter()
        .find(|m| m["id"] == id)
        .unwrap_or_else(|| panic!("{id} missing from {list:?}"))
}

/// L632-633: a `replyTo` naming a Message of another Chat does not exist
/// "in the same Chat", so the create is rejected (L1672:
/// `invalidProperties` naming `replyTo`).
#[tokio::test]
async fn cross_chat_reply_to_rejected() {
    let backend = common::account_backend();
    let (chat, _) = fixture(&backend).await;
    let resp = create(&backend, reply(&chat, OTHER_CHAT_MSG, None)).await;
    assert_eq!(
        resp["notCreated"]["m"]["type"], "invalidProperties",
        "{resp}"
    );
    assert_eq!(
        resp["notCreated"]["m"]["properties"],
        json!(["replyTo"]),
        "{resp}"
    );
}

/// L632-633: a `replyTo` naming no Message at all is rejected the same way.
#[tokio::test]
async fn unknown_reply_to_rejected() {
    let backend = common::account_backend();
    let (chat, _) = fixture(&backend).await;
    let resp = create(&backend, reply(&chat, "01J00000000000000000000ZZZ", None)).await;
    assert_eq!(
        resp["notCreated"]["m"]["properties"],
        json!(["replyTo"]),
        "{resp}"
    );
}

/// L1510-1514: each `threadRootId` that breaks an assignment rule is
/// rejected with `invalidProperties` naming `threadRootId`.
#[tokio::test]
async fn invalid_thread_root_id_rejected() {
    let backend = common::account_backend();
    let (chat, _) = fixture(&backend).await;
    let no_reply = json!({
        "chatId": chat,
        "body": "x",
        "bodyType": "text/plain",
        "sentAt": "2024-01-01T00:00:00Z",
        "threadRootId": ROOT,
    });
    let cases = [
        // "A message with no `replyTo` ... `threadRootId` MUST be absent."
        no_reply,
        // Reply to the root ROOT: threadRootId must be ROOT, not A.
        reply(&chat, ROOT, Some(A)),
        // Reply to non-root A: threadRootId must be A's root, ROOT, not A.
        reply(&chat, A, Some(A)),
    ];
    for obj in cases {
        let resp = create(&backend, obj.clone()).await;
        assert_eq!(
            resp["notCreated"]["m"]["type"], "invalidProperties",
            "{obj} -> {resp}"
        );
        assert_eq!(
            resp["notCreated"]["m"]["properties"],
            json!(["threadRootId"]),
            "{obj} -> {resp}"
        );
    }
}

/// L1511-1512: a correct `threadRootId` is accepted, and an omitted one is
/// set by the server ("MAY correct") to the value the rules give.
#[tokio::test]
async fn thread_root_id_accepted_or_filled_in() {
    let backend = common::account_backend();
    let (chat, _) = fixture(&backend).await;
    let cases = [
        (reply(&chat, ROOT, Some(ROOT)), ROOT),
        (reply(&chat, B, Some(ROOT)), ROOT),
        (reply(&chat, ROOT, None), ROOT),
        (reply(&chat, B, None), ROOT),
    ];
    for (obj, root) in cases {
        let resp = create(&backend, obj.clone()).await;
        assert_eq!(
            resp["created"]["m"]["threadRootId"], root,
            "{obj} -> {resp}"
        );
    }
}

/// L638-642 against the fixture, counted by hand:
///
/// - ROOT: replies A and C -> replyCount 2; of those only C sorts after
///   lastReadMessageId A (L591) -> unreadReplyCount 1.
/// - A: reply B -> replyCount 1; A has a threadRootId, so it is not a
///   thread root and carries no unreadReplyCount.
/// - B, C: no replies -> replyCount 0, no unreadReplyCount.
#[tokio::test]
async fn reply_counts_match_fixture() {
    let backend = common::account_backend();
    let _ = fixture(&backend).await;
    threads_on(&backend);
    let list = get(&backend, &[ROOT, A, B, C]).await;
    let root = by_id(&list, ROOT);
    assert_eq!(root["replyCount"], 2, "{root}");
    assert_eq!(root["unreadReplyCount"], 1, "{root}");
    let a = by_id(&list, A);
    assert_eq!(a["replyCount"], 1, "{a}");
    assert!(a.get("unreadReplyCount").is_none(), "{a}");
    for id in [B, C] {
        let m = by_id(&list, id);
        assert_eq!(m["replyCount"], 0, "{m}");
        assert!(m.get("unreadReplyCount").is_none(), "{m}");
    }
}

/// L641-642 with no `lastReadMessageId`: no reply has been read, so the
/// unread count equals the reply count (ROOT: A and C -> 2).
#[tokio::test]
async fn unread_reply_count_without_read_position() {
    let backend = common::account_backend();
    let (chat, _) = fixture(&backend).await;
    backend.insert_object_for_test(
        "ReadPosition",
        ACCOUNT_ID,
        "rp1",
        json!({ "id": "rp1", "chatId": chat }),
    );
    threads_on(&backend);
    let list = get(&backend, &[ROOT]).await;
    assert_eq!(list[0]["unreadReplyCount"], 2, "{list:?}");
}

/// L639 / L642 "Present only when `supportsThreads` is `true`": with the
/// default `supportsThreads: false` neither count is returned.
#[tokio::test]
async fn counts_absent_without_supports_threads() {
    let backend = common::account_backend();
    let _ = fixture(&backend).await;
    let list = get(&backend, &[ROOT, A]).await;
    for m in &list {
        assert!(m.get("replyCount").is_none(), "{m}");
        assert!(m.get("unreadReplyCount").is_none(), "{m}");
    }
}

/// L1198 "`threadRootId` ... Valid only when `supportsThreads` is `true`"
/// and L1506: with threads on, the filter returns the Messages whose
/// `threadRootId` is ROOT, which are A, B and C.
#[tokio::test]
async fn thread_root_id_filter_with_supports_threads() {
    let backend = common::account_backend();
    let (chat, _) = fixture(&backend).await;
    threads_on(&backend);
    let HandlerOutput { primary: resp, .. } = handle_message_query(
        &backend,
        &(),
        json!({
            "accountId": ACCOUNT_ID,
            "filter": { "chatId": chat, "threadRootId": ROOT },
        }),
        &[],
    )
    .await
    .expect("Message/query");
    let mut ids: Vec<&str> = resp["ids"]
        .as_array()
        .expect("ids")
        .iter()
        .map(|v| v.as_str().expect("id"))
        .collect();
    ids.sort_unstable();
    assert_eq!(ids, [A, B, C], "{resp}");
}

// ---------------------------------------------------------------------------
// Count changes advance Message state (bd:JMAP-y3f2.15)
//
// RFC 8620 §5.1: "If the data changes, this string MUST change." §5.2
// `updated`: "An array of Ids for records that have been updated since
// the old state." `replyCount` and `unreadReplyCount` are Message data
// (L638-642), so a write that changes them must list the Message.
// ---------------------------------------------------------------------------

async fn message_state(backend: &MemoryBackend) -> String {
    let HandlerOutput { primary: resp, .. } = handle_message_get(
        backend,
        &(),
        json!({ "accountId": ACCOUNT_ID, "ids": [] }),
        &[],
    )
    .await
    .expect("Message/get");
    resp["state"].as_str().expect("state").to_owned()
}

async fn message_changes(backend: &MemoryBackend, since: &str) -> Value {
    let HandlerOutput { primary: resp, .. } = handle_message_changes(
        backend,
        &(),
        json!({ "accountId": ACCOUNT_ID, "sinceState": since }),
        &[],
    )
    .await
    .expect("Message/changes");
    resp
}

/// Creating a reply to A raises A's `replyCount` from 1 to 2 (L638-639),
/// so `Message/changes` lists A as updated and the reply as created.
#[tokio::test]
async fn reply_create_lists_parent_updated() {
    let backend = common::account_backend();
    let (chat, _) = fixture(&backend).await;
    threads_on(&backend);
    let since = message_state(&backend).await;
    let resp = create(&backend, reply(&chat, A, None)).await;
    let new_id = resp["created"]["m"]["id"].clone();
    let changes = message_changes(&backend, &since).await;
    assert_eq!(changes["created"], json!([new_id]), "{changes}");
    assert_eq!(changes["updated"], json!([A]), "{changes}");
}

/// Destroying B, the only reply to A, lowers A's `replyCount` from 1 to
/// 0, so `Message/changes` lists A as updated and B as destroyed.
#[tokio::test]
async fn reply_destroy_lists_parent_updated() {
    let backend = common::account_backend();
    let _ = fixture(&backend).await;
    threads_on(&backend);
    let since = message_state(&backend).await;
    let HandlerOutput { primary: resp, .. } = handle_message_set(
        &backend,
        &(),
        &std::collections::BTreeMap::new(),
        json!({ "accountId": ACCOUNT_ID, "destroy": [B] }),
        &[],
    )
    .await
    .expect("Message/set");
    assert_eq!(resp["destroyed"], json!([B]), "{resp}");
    let changes = message_changes(&backend, &since).await;
    assert_eq!(changes["destroyed"], json!([B]), "{changes}");
    assert_eq!(changes["updated"], json!([A]), "{changes}");
}

/// Moving `lastReadMessageId` from A to C (L641-642, ids ordered per
/// L591) marks reply C to ROOT read, so ROOT's `unreadReplyCount` drops
/// from 1 to 0 and ROOT is listed as updated. B also crosses the read
/// mark, but its parent A has a `threadRootId`, carries no
/// `unreadReplyCount`, and is not listed.
#[tokio::test]
async fn read_position_update_lists_thread_root_updated() {
    let backend = common::account_backend();
    let _ = fixture(&backend).await;
    threads_on(&backend);
    let since = message_state(&backend).await;
    let HandlerOutput { primary: resp, .. } = handle_position_set(
        &backend,
        &(),
        &std::collections::BTreeMap::new(),
        json!({
            "accountId": ACCOUNT_ID,
            "update": { "rp1": { "lastReadMessageId": C } },
        }),
    )
    .await
    .expect("ReadPosition/set");
    assert!(resp["updated"].get("rp1").is_some(), "{resp}");
    let changes = message_changes(&backend, &since).await;
    assert_eq!(changes["updated"], json!([ROOT]), "{changes}");
    assert_eq!(changes["created"], json!([]), "{changes}");
    assert_eq!(changes["destroyed"], json!([]), "{changes}");
}

/// Fixture plus OWN_REPLY to ROOT from the owner. Hand count for ROOT:
/// replies A, C and OWN_REPLY -> replyCount 3; after lastReadMessageId A
/// come C and OWN_REPLY, and the owner's reply is not counted
/// (jmap-chat-spec-vz8p) -> unreadReplyCount 1.
#[tokio::test]
async fn unread_reply_count_excludes_owner_replies() {
    let backend = common::account_backend();
    let (chat, _) = fixture(&backend).await;
    seed_message_from(
        &backend,
        ACCOUNT_ID,
        OWN_REPLY,
        &chat,
        Some(ROOT),
        Some(ROOT),
    );
    threads_on(&backend);
    let list = get(&backend, &[ROOT]).await;
    assert_eq!(list[0]["replyCount"], 3, "{list:?}");
    assert_eq!(list[0]["unreadReplyCount"], 1, "{list:?}");
}

/// Same, with no `lastReadMessageId`: of ROOT's replies A, C and
/// OWN_REPLY, only the two from OTHER_SENDER count -> 2.
#[tokio::test]
async fn unread_reply_count_excludes_owner_replies_without_read_position() {
    let backend = common::account_backend();
    let (chat, _) = fixture(&backend).await;
    seed_message_from(
        &backend,
        ACCOUNT_ID,
        OWN_REPLY,
        &chat,
        Some(ROOT),
        Some(ROOT),
    );
    backend.insert_object_for_test(
        "ReadPosition",
        ACCOUNT_ID,
        "rp1",
        json!({ "id": "rp1", "chatId": chat }),
    );
    threads_on(&backend);
    let list = get(&backend, &[ROOT]).await;
    assert_eq!(list[0]["unreadReplyCount"], 2, "{list:?}");
}

/// Moving `lastReadMessageId` from C to OWN_REPLY crosses only the
/// owner's reply, which is never counted, so ROOT's `unreadReplyCount`
/// stays 0 and `Message/changes` lists nothing as updated (RFC 8620
/// §5.2 `updated`: records "updated since the old state").
#[tokio::test]
async fn read_past_owner_reply_leaves_root_unchanged() {
    let backend = common::account_backend();
    let (chat, _) = fixture(&backend).await;
    seed_message_from(
        &backend,
        ACCOUNT_ID,
        OWN_REPLY,
        &chat,
        Some(ROOT),
        Some(ROOT),
    );
    threads_on(&backend);
    for last_read in [C, OWN_REPLY] {
        let since = message_state(&backend).await;
        let HandlerOutput { primary: resp, .. } = handle_position_set(
            &backend,
            &(),
            &std::collections::BTreeMap::new(),
            json!({
                "accountId": ACCOUNT_ID,
                "update": { "rp1": { "lastReadMessageId": last_read } },
            }),
        )
        .await
        .expect("ReadPosition/set");
        assert!(resp["updated"].get("rp1").is_some(), "{resp}");
        let changes = message_changes(&backend, &since).await;
        let expected = if last_read == C {
            json!([ROOT])
        } else {
            json!([])
        };
        assert_eq!(changes["updated"], expected, "{last_read}: {changes}");
    }
    let list = get(&backend, &[ROOT]).await;
    assert_eq!(list[0]["unreadReplyCount"], 0, "{list:?}");
}