helix-im 0.1.39

基于 Helix Core 的确定性 MessageV3 IM 业务模块
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
//! 批量消息回执人员投影。
//!
//! Go 只提供消息创建时的 receiver snapshot 顺序与内部 readBits;这里在 Helix 内部完成
//! O(n) 对齐后,向 Angular 只交付 snapshotId、有序用户 ID 与绝对计数。原始 bitmap、成员
//! 快照和兼容字段不跨越 `im:post:readers` 边界。

use bytes::Bytes;
use helix_core::effect::{DomainEventBytes, Effect};
use serde_json::{json, Value};
use std::collections::HashSet;

/// 将批量 HTTP 回包拆成逐条 canonical 回执事件,避免向 Angular 泄漏查询聚合外壳。
pub(crate) fn emit(body: &Value) -> Vec<Effect> {
    project(body).into_iter().map(emit_value).collect()
}

/// 在线性扫描中把 Go 回执行转换为 Angular 可直接消费的绝对态。
pub(crate) fn project(body: &Value) -> Vec<Value> {
    let Some(rows) = body.get("data").and_then(Value::as_array) else {
        return Vec::new();
    };
    rows.iter().filter_map(project_row).collect()
}

/// 将一行 Go DTO 投影成严格 allowlist,损坏行只生成不可用终态。
fn project_row(item: &Value) -> Option<Value> {
    let post_id = item.get("postId")?.as_str()?.trim();
    if post_id.is_empty() {
        return None;
    }
    let channel_id = item
        .get("channelId")
        .and_then(Value::as_str)
        .unwrap_or_default()
        .trim();
    let snapshot_id = item
        .get("snapshotId")
        .and_then(Value::as_str)
        .unwrap_or_default()
        .trim();
    if item.get("status").and_then(Value::as_str) == Some("unavailable") {
        let reason = item
            .get("unavailableReason")
            .and_then(Value::as_str)
            .filter(|reason| !reason.trim().is_empty())
            .unwrap_or("receipt unavailable");
        return Some(unavailable_receipt(
            post_id,
            channel_id,
            snapshot_id,
            reason,
        ));
    }

    let Some(author_user_id) = item.get("authorUserId").and_then(Value::as_str) else {
        return Some(unavailable_receipt(
            post_id,
            channel_id,
            snapshot_id,
            "receipt author is missing",
        ));
    };
    let Some(read_bits) = item.get("readBits").and_then(Value::as_str) else {
        return Some(unavailable_receipt(
            post_id,
            channel_id,
            snapshot_id,
            "member snapshot and readBits are inconsistent",
        ));
    };
    let Some(member_values) = item.get("memberIds").and_then(Value::as_array) else {
        return Some(unavailable_receipt(
            post_id,
            channel_id,
            snapshot_id,
            "member snapshot and readBits are inconsistent",
        ));
    };
    let member_ids: Option<Vec<&str>> = member_values
        .iter()
        .map(|value| {
            value
                .as_str()
                .filter(|id| !id.is_empty() && id.trim() == *id)
        })
        .collect();
    let Some(member_ids) = member_ids else {
        return Some(unavailable_receipt(
            post_id,
            channel_id,
            snapshot_id,
            "member snapshot and readBits are inconsistent",
        ));
    };
    let mut seen = HashSet::with_capacity(member_ids.len());
    let unique = member_ids.iter().all(|id| seen.insert(*id));
    let author_user_id = author_user_id.trim();
    let author_count = member_ids
        .iter()
        .filter(|user_id| **user_id == author_user_id)
        .count();
    let valid = !channel_id.is_empty()
        && !snapshot_id.is_empty()
        && !author_user_id.is_empty()
        && unique
        && author_count <= 1
        && read_bits.len() == member_ids.len()
        && read_bits.bytes().all(|bit| bit == b'0' || bit == b'1');
    if !valid {
        return Some(unavailable_receipt(
            post_id,
            channel_id,
            snapshot_id,
            "member snapshot and readBits are inconsistent",
        ));
    }

    let mut read_user_ids = Vec::with_capacity(member_ids.len());
    let mut unread_user_ids = Vec::with_capacity(member_ids.len());
    // canonical: Go 已排作者;legacy 行若仍含作者,也在同一快照顺序中剔除。
    for (index, user_id) in member_ids.into_iter().enumerate() {
        if user_id == author_user_id {
            continue;
        }
        if read_bits.as_bytes()[index] == b'1' {
            read_user_ids.push(user_id);
        } else {
            unread_user_ids.push(user_id);
        }
    }
    // 接收者集合为空(viewers 只覆盖作者,例如文字接龙草稿声明)时,服务端并没有"所有人都读过"
    // 的事实:这类行只能表达"没有接收者",不能投影成 allRead=true。消费方据此保持空白,
    // 而不是给用户一个假的"全部已读"。
    let no_receivers = read_user_ids.is_empty() && unread_user_ids.is_empty();
    // 只允许公开合同字段;任何内部 DTO 字段都不能从输入对象复制到事件。
    let mut receipt = json!({
        "postId": post_id,
        "channelId": channel_id,
        "snapshotId": snapshot_id,
        "receiptKey": "snapshotId",
        "state": if no_receivers { "no_receivers" } else { "ready" },
        "readUserIds": read_user_ids,
        "unreadUserIds": unread_user_ids,
        "readCount": read_user_ids.len(),
        "unreadCount": unread_user_ids.len(),
        "allRead": !no_receivers && unread_user_ids.is_empty(),
        "authorExcluded": true,
    });
    // 快照版本是服务端对账锚;缺失时保持兼容,但不伪造版本号。
    if let Some(snapshot_version) = item.get("snapshotVersion").and_then(Value::as_i64) {
        receipt["snapshotVersion"] = json!(snapshot_version);
    }
    Some(receipt)
}

/// 构造不泄漏 bitmap 的逐消息不可用终态,并保留诊断原因。
fn unavailable_receipt(post_id: &str, channel_id: &str, snapshot_id: &str, error: &str) -> Value {
    let receipt_key = if !snapshot_id.is_empty() {
        Some("snapshotId")
    } else if !channel_id.is_empty() {
        Some("channelIdCreateAtFallback")
    } else {
        None
    };
    let mut receipt = json!({
        "postId": post_id,
        "channelId": channel_id,
        "snapshotId": snapshot_id,
        "state": "unavailable",
        "error": error,
        "readUserIds": [],
        "unreadUserIds": [],
        "readCount": 0,
        "unreadCount": 0,
        "allRead": false,
        "authorExcluded": true,
    });
    // 诊断态也保留可对账的身份键,但不泄漏原始快照/bitmap。
    if let Some(receipt_key) = receipt_key {
        receipt["receiptKey"] = json!(receipt_key);
    }
    receipt
}

/// 将一条 render-ready 回执包装成冻结的 `im:post:readers` 事件。
fn emit_value(data: Value) -> Effect {
    let payload = json!({ "event": "im:post:readers", "data": data });
    Effect::Emit {
        event: DomainEventBytes(Bytes::from(
            serde_json::to_vec(&payload).expect("static receipt projection must serialize"),
        )),
    }
}

/// 从 `authorUserId` / `createBy` 读消息作者;`userId` 在已读回执里是 reader 语义,不当作者。
fn author_of(object: &serde_json::Map<String, Value>) -> String {
    object
        .get("authorUserId")
        .or_else(|| object.get("createBy"))
        .and_then(Value::as_str)
        .unwrap_or_default()
        .trim()
        .to_string()
}

/// 读回执里的 reader(单视角终态用 `readerId`,wire 别名 `readerUserId`)。
fn reader_of(object: &serde_json::Map<String, Value>) -> String {
    object
        .get("readerId")
        .or_else(|| object.get("readerUserId"))
        .and_then(Value::as_str)
        .unwrap_or_default()
        .trim()
        .to_string()
}

/// 把单条已读回执归一为 Angular 可直接渲染的绝对态(INV-06 / INV-07)。
///
/// - 返回 `false` 表示该回执必须被整条丢弃:当前 viewer 自己创建的消息的自读回执不产生业务事件
///   (T134 批量已读过滤在客户端侧的等价面)。
/// - `snapshotId` 存在即为权威键;否则只有 `channelId + createAt` 齐备时标记修复回退。
/// - 一旦携带 `memberIds` 有序快照,就在同一次 O(n) 扫描里剔除作者、生成有序
///   `readUserIds` / `unreadUserIds` 与绝对计数,并**删除外发 `readBits`**:
///   Angular 永不接触 bitmap。快照与 bitmap 不一致时 fail-closed 为 `unavailable`,
///   同样不外发 bitmap。
pub(crate) fn render_ready_post_read(data: &mut Value, viewer_user_id: &str) -> bool {
    let Some(object) = data.as_object_mut() else {
        return true;
    };
    let author_user_id = author_of(object);
    let reader_user_id = reader_of(object);
    if let Some(post_id) = object
        .get("postId")
        .or_else(|| object.get("id"))
        .and_then(Value::as_str)
        .map(str::to_string)
    {
        object.insert("postId".to_string(), json!(post_id));
    }
    if !reader_user_id.is_empty() {
        object.insert("readerUserId".to_string(), json!(reader_user_id));
    }
    object.remove("id");
    object.remove("readerId");
    if !viewer_user_id.is_empty()
        && author_user_id == viewer_user_id
        && reader_user_id == viewer_user_id
    {
        return false;
    }

    let snapshot_id = object
        .get("snapshotId")
        .and_then(Value::as_str)
        .unwrap_or_default()
        .trim()
        .to_string();
    if !snapshot_id.is_empty() {
        object.insert("snapshotId".to_string(), json!(snapshot_id));
        object.insert("receiptKey".to_string(), json!("snapshotId"));
    } else if object.contains_key("channelId") && object.contains_key("createAt") {
        object.insert("receiptKey".to_string(), json!("channelIdCreateAtFallback"));
    }

    let Some(member_values) = object.get("memberIds").and_then(Value::as_array).cloned() else {
        object.insert("state".to_string(), json!("unavailable"));
        object.insert("error".to_string(), json!("missing member snapshot"));
        object.insert("readCount".to_string(), json!(0));
        object.insert("unreadCount".to_string(), json!(0));
        object.insert("allRead".to_string(), json!(false));
        object.insert("readUserIds".to_string(), json!([]));
        object.insert("unreadUserIds".to_string(), json!([]));
        object.remove("readBits");
        object.remove("readerIds");
        object.remove("memberIds");
        return true;
    };
    let member_ids: Vec<String> = member_values
        .iter()
        .filter_map(Value::as_str)
        .filter(|id| !id.trim().is_empty())
        .map(str::to_string)
        .collect();
    let read_bits = object
        .get("readBits")
        .and_then(Value::as_str)
        .unwrap_or_default()
        .to_string();
    let mut seen = HashSet::with_capacity(member_ids.len());
    let consistent = member_ids.len() == member_values.len()
        && member_ids.iter().all(|id| seen.insert(id.clone()))
        && read_bits.len() == member_ids.len()
        && read_bits.bytes().all(|bit| bit == b'0' || bit == b'1')
        && member_ids
            .iter()
            .filter(|user_id| *user_id == &author_user_id)
            .count()
            <= 1;

    let mut read_user_ids: Vec<String> = Vec::with_capacity(member_ids.len());
    let mut unread_user_ids: Vec<String> = Vec::with_capacity(member_ids.len());
    if consistent {
        // INV-06:固定使用消息创建时的成员顺序,并剔除发送者——发送者不占 readBits。
        for (index, user_id) in member_ids.into_iter().enumerate() {
            if user_id == author_user_id {
                continue;
            }
            if read_bits.as_bytes()[index] == b'1' {
                read_user_ids.push(user_id);
            } else {
                unread_user_ids.push(user_id);
            }
        }
    } else {
        object.insert("state".to_string(), json!("unavailable"));
        object.insert(
            "error".to_string(),
            json!("member snapshot and readBits are inconsistent"),
        );
    }
    // 接收者集合为空(viewers 只覆盖作者,例如文字接龙草稿声明)时,服务端并没有"所有人都读过"
    // 的事实:只能标成 no_receivers 并保持 allRead=false,与 project_row 同口径。
    let no_receivers = consistent && read_user_ids.is_empty() && unread_user_ids.is_empty();
    if consistent {
        object.insert(
            "state".to_string(),
            json!(if no_receivers { "no_receivers" } else { "ready" }),
        );
    }
    object.insert("readCount".to_string(), json!(read_user_ids.len()));
    object.insert("unreadCount".to_string(), json!(unread_user_ids.len()));
    object.insert(
        "allRead".to_string(),
        json!(consistent && !no_receivers && unread_user_ids.is_empty()),
    );
    object.insert("authorExcluded".to_string(), json!(true));
    object.insert("readUserIds".to_string(), json!(read_user_ids));
    object.insert("unreadUserIds".to_string(), json!(unread_user_ids));
    // INV-07:bitmap 与原始成员快照都不外发,Angular 只能消费上面的有序绝对态。
    object.remove("readBits");
    object.remove("readerIds");
    object.remove("memberIds");
    true
}

#[cfg(test)]
mod render_ready_post_read_tests {
    use super::render_ready_post_read;
    use serde_json::{json, Value};

    /// 构造带成员快照的单条已读回执 wire 形态。
    fn receipt(author: &str, reader: &str, members: Value, bits: &str) -> Value {
        json!({
            "id": "post-template-001",
            "channelId": "channel-phase1-001",
            "authorUserId": author,
            "readerId": reader,
            "snapshotId": "snapshot-post-template-001",
            "memberIds": members,
            "readBits": bits,
            "receiptRevision": 1_700_000_000_000_i64,
        })
    }

    /// 构造 `im_post_read_list` 的单行 Go DTO(批量回执投影入口)。
    fn batch_dto(author: &str, members: Value, bits: &str) -> Value {
        json!({
            "postId": "post-batch-001",
            "channelId": "channel-phase1-001",
            "authorUserId": author,
            "snapshotId": "snapshot-post-template-001",
            "status": "ready",
            "memberIds": members,
            "readBits": bits,
            "readCount": 0,
            "unreadCount": 0,
            "allRead": true,
        })
    }

    #[test]
    fn empty_receiver_batch_row_is_projected_as_no_receivers() {
        // 接龙草稿声明的 viewers 只覆盖作者:接收者集合为空,服务端没有"所有人都读过"的事实。
        let body = json!({
            "data": [batch_dto("user-actor-444", json!(["user-actor-444"]), "1")],
        });
        let rows = super::project(&body);

        assert_eq!(rows.len(), 1);
        assert_eq!(rows[0]["state"], json!("no_receivers"));
        assert_eq!(rows[0]["allRead"], json!(false));
        assert_eq!(rows[0]["readCount"], json!(0));
        assert_eq!(rows[0]["unreadCount"], json!(0));
        assert_eq!(rows[0]["readUserIds"], json!([]));
        assert_eq!(rows[0]["unreadUserIds"], json!([]));
    }

    #[test]
    fn non_empty_receiver_batch_row_keeps_ready_semantics() {
        let body = json!({
            "data": [batch_dto("user-actor-444", json!(["user-actor-444", "user-receiver-445"]), "10")],
        });
        let rows = super::project(&body);

        assert_eq!(rows[0]["state"], json!("ready"));
        assert_eq!(rows[0]["allRead"], json!(false));
        assert_eq!(rows[0]["unreadCount"], json!(1));
    }

    #[test]
    fn self_only_receiver_never_claims_all_read() {
        // readers 只有作者自己时不得投影成 allRead(否则 UI 显示"全部已读")。
        let mut data = receipt(
            "user-actor-444",
            "user-actor-444",
            json!(["user-actor-444"]),
            "1",
        );
        assert!(render_ready_post_read(&mut data, "user-receiver-445"));

        assert_eq!(data["state"], json!("no_receivers"));
        assert_eq!(data["allRead"], json!(false));
        assert_eq!(data["readCount"], json!(0));
        assert_eq!(data["unreadCount"], json!(0));
    }

    #[test]
    fn ordered_lists_replace_bitmap_and_never_leak_read_bits() {
        let mut data = receipt(
            "user-actor-444",
            "user-actor-444",
            json!(["user-actor-444", "user-receiver-445", "user-receiver-446"]),
            "110",
        );
        assert!(render_ready_post_read(&mut data, "user-receiver-445"));
        let object = data.as_object().expect("receipt object");
        assert!(
            !object.contains_key("readBits"),
            "INV-07: 出站投影不得含 readBits,got {object:?}"
        );
        assert!(!object.contains_key("memberIds"));
        assert_eq!(data["readUserIds"], json!(["user-receiver-445"]));
        assert_eq!(data["unreadUserIds"], json!(["user-receiver-446"]));
        assert_eq!(data["readCount"], json!(1));
        assert_eq!(data["unreadCount"], json!(1));
        assert_eq!(data["allRead"], json!(false));
        assert_eq!(data["state"], json!("ready"));
    }

    #[test]
    fn author_never_occupies_a_read_bit_even_when_its_bit_is_set() {
        // 作者位是 1(发送者"已读"自己的消息),仍不得出现在任何一侧列表。
        let mut data = receipt(
            "user-actor-444",
            "user-receiver-445",
            json!(["user-actor-444", "user-receiver-445"]),
            "10",
        );
        assert!(render_ready_post_read(&mut data, "user-receiver-445"));
        assert_eq!(data["readUserIds"], json!([]));
        assert_eq!(data["unreadUserIds"], json!(["user-receiver-445"]));
        assert_eq!(data["readCount"], json!(0));
        assert_eq!(data["unreadCount"], json!(1));
        assert_eq!(data["authorExcluded"], json!(true));
    }

    #[test]
    fn snapshot_order_is_preserved_and_not_sorted() {
        let mut data = receipt(
            "user-actor-444",
            "user-receiver-446",
            json!(["user-receiver-446", "user-receiver-445"]),
            "10",
        );
        assert!(render_ready_post_read(&mut data, "user-actor-999"));
        assert_eq!(data["readUserIds"], json!(["user-receiver-446"]));
        assert_eq!(data["unreadUserIds"], json!(["user-receiver-445"]));
    }

    #[test]
    fn self_authored_self_read_receipt_is_dropped() {
        let mut data = receipt(
            "user-actor-444",
            "user-actor-444",
            json!(["user-actor-444", "user-receiver-445"]),
            "10",
        );
        assert!(
            !render_ready_post_read(&mut data, "user-actor-444"),
            "T134: 当前用户自己创建的消息的自读回执必须被过滤"
        );
    }

    #[test]
    fn other_viewer_keeps_receipt_for_the_same_authored_message() {
        let mut data = receipt(
            "user-actor-444",
            "user-actor-444",
            json!(["user-actor-444", "user-receiver-445"]),
            "10",
        );
        assert!(render_ready_post_read(&mut data, "user-receiver-445"));
    }

    #[test]
    fn snapshot_id_is_the_authoritative_receipt_key() {
        let mut data = receipt(
            "user-actor-444",
            "user-receiver-445",
            json!(["user-receiver-445"]),
            "1",
        );
        assert!(render_ready_post_read(&mut data, "user-receiver-445"));
        assert_eq!(data["receiptKey"], json!("snapshotId"));
        assert_eq!(data["snapshotId"], json!("snapshot-post-template-001"));
    }

    #[test]
    fn missing_snapshot_id_falls_back_to_channel_and_create_at() {
        let mut data = json!({
            "id": "post-template-001",
            "channelId": "channel-phase1-001",
            "createAt": 1_700_000_000_000_i64,
            "readerId": "user-receiver-445",
        });
        assert!(render_ready_post_read(&mut data, "user-receiver-445"));
        assert_eq!(data["receiptKey"], json!("channelIdCreateAtFallback"));
    }

    #[test]
    fn inconsistent_snapshot_fails_closed_without_leaking_bitmap() {
        let mut data = receipt(
            "user-actor-444",
            "user-receiver-445",
            json!(["user-actor-444", "user-receiver-445"]),
            "1",
        );
        assert!(render_ready_post_read(&mut data, "user-receiver-445"));
        assert_eq!(data["state"], json!("unavailable"));
        assert!(!data.as_object().expect("object").contains_key("readBits"));
        assert_eq!(data["readUserIds"], json!([]));
        assert_eq!(data["unreadUserIds"], json!([]));
        assert_eq!(data["allRead"], json!(false));
    }

    #[test]
    fn receipt_without_member_snapshot_fails_closed_without_bitmap() {
        // 旧 Go 节点缺 receiver snapshot 时不得把内部 bitmap 重新暴露给 Angular。
        let mut data = json!({
            "id": "post-template-001",
            "channelId": "channel-phase1-001",
            "readBits": "010",
            "readerId": "g14-reader",
            "receiptRevision": 1_700_001_400_020_i64,
        });
        assert!(render_ready_post_read(&mut data, "g14-author"));
        assert_eq!(data["state"], json!("unavailable"));
        assert_eq!(data["postId"], json!("post-template-001"));
        assert_eq!(data["readerUserId"], json!("g14-reader"));
        assert_eq!(data["readUserIds"], json!([]));
        assert_eq!(data["unreadUserIds"], json!([]));
        assert!(!data.as_object().expect("object").contains_key("readBits"));
    }
}