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 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622
// Copyright 2023 The Matrix.org Foundation C.I.C.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//! # Client-side read receipts computation
//!
//! While Matrix servers have the ability to provide basic information about the
//! unread status of rooms, via [`crate::sync::UnreadNotificationsCount`], it's
//! not reliable for encrypted rooms. Indeed, the server doesn't have access to
//! the content of encrypted events, so it can only makes guesses when
//! estimating unread and highlight counts.
//!
//! Instead, this module provides facilities to compute the number of unread
//! messages, unread notifications and unread highlights in a room.
//!
//! Counting unread messages is performed by looking at the latest receipt of
//! the current user, and inferring which events are following it, according to
//! the sync ordering.
//!
//! For notifications and highlights to be precisely accounted for, we also need
//! to pay attention to the user's notification settings. Fortunately, this is
//! also something we need to for notifications, so we can reuse this code.
//!
//! Of course, not all events are created equal, and some are less interesting
//! than others, and shouldn't cause a room to be marked unread. This module's
//! `marks_as_unread` function shows the opiniated set of rules that will filter
//! out uninterested events.
//!
//! The only `pub(crate)` method in that module is `compute_unread_counts`,
//! which updates the `RoomInfo` in place according to the new counts.
//!
//! ## Implementation details: How to get the latest receipt?
//!
//! ### Preliminary context
//!
//! We do have an unbounded, in-memory cache for sync events, as part of sliding
//! sync. It's reset as soon as we get a "limited" (gappy) sync for a room. Not
//! as ideal as an on-disk timeline, but it's sufficient to do some interesting
//! computations already.
//!
//! ### How-to
//!
//! When we call `compute_unread_counts`, that's for one of two reasons (and
//! maybe both at once, or maybe none at all):
//! - we received a new receipt
//! - new events came in.
//!
//! A read receipt is considered _active_ if it's been received from sync
//! *and* it matches a known event in the in-memory sync events cache.
//!
//! The *latest active* receipt is the one that's active, with the latest order
//! (according to sync ordering, aka position in the sync cache).
//!
//! The problem of keeping a precise read count is thus equivalent to finding
//! the latest active receipt, and counting interesting events after it (in the
//! sync ordering).
//!
//! When we get new events, we'll incorporate them into an inverse mapping of
//! event id -> sync order (`event_id_to_pos`). This gives us a simple way to
//! select a "better" active receipt, using the `ReceiptSelector`. An event that
//! has a read receipt can be passed to `ReceiptSelector::try_select_later`,
//! which compares the order of the current best active, to that of the new
//! event, and records the better one, if applicable.
//!
//! When we receive a new receipt event in
//! `ReceiptSelector::handle_new_receipt`, if we find a {public|private}
//! {main-threaded|unthreaded} receipt attached to an event, there are two
//! possibilities:
//! - we knew the event, so we can immediately try to select it as a better
//! event with `try_select_later`,
//! - or we don't, which may mean the receipt refers to a past event we lost
//! track of (because of a restart of the app — remember the cache is mostly
//! memory-only, and a few items on disk), or the receipt refers to a future
//! event. To cover for the latter possibility, we stash the receipt and mark
//! it as pending (we only keep a limited number of pending read receipts
//! using a `RingBuffer`).
//!
//! That means that when we receive new events, we'll check if their id matches
//! one of the pending receipts in `handle_pending_receipts`; if so, we can
//! remove it from the pending set, and try to consider it a better receipt with
//! `try_select_later`. If not, it's still pending, until it'll be forgotten or
//! matched.
//!
//! Once we have a new *better active receipt*, we'll save it in the
//! `RoomReadReceipt` data (stored in `RoomInfo`), and we'll compute the counts,
//! starting from the event the better active receipt was referring to.
//!
//! If we *don't* have a better active receipt, that means that all the events
//! received in that sync batch aren't referred to by a known read receipt,
//! _and_ we didn't get a new better receipt that matched known events. In that
//! case, we can just consider that all the events are new, and count them as
//! such.
//!
//! ### Edge cases
//!
//! - `compute_unread_counts` is called after receiving a sliding sync response,
//! at a time where we haven't tried to "reconcile" the cached timeline items
//! with the new ones. The only kind of reconciliation we'd do anyways is
//! clearing the timeline if it was limited, which equates to having common
//! events ids in both sets. As a matter of fact, we have to manually handle
//! this edge case here. I hope that having an event database will help avoid
//! this kind of workaround here later.
//! - In addition to that, and as noted in the timeline code, it seems that the
//! sliding-sync proxy could return the same event multiple times in a sync
//! timeline, leading to incorrect results. We have to take that into account
//! by resetting the read counts *every* time we see an event that was the
//! target of the latest active read receipt.
#![allow(dead_code)] // too many different build configurations, I give up
use std::{
collections::{BTreeMap, BTreeSet},
num::NonZeroUsize,
};
use eyeball_im::Vector;
use matrix_sdk_common::{deserialized_responses::SyncTimelineEvent, ring_buffer::RingBuffer};
use ruma::{
events::{
poll::{start::PollStartEventContent, unstable_start::UnstablePollStartEventContent},
receipt::{ReceiptEventContent, ReceiptThread, ReceiptType},
room::message::Relation,
AnySyncMessageLikeEvent, AnySyncTimelineEvent, OriginalSyncMessageLikeEvent,
SyncMessageLikeEvent,
},
serde::Raw,
EventId, OwnedEventId, OwnedUserId, RoomId, UserId,
};
use serde::{Deserialize, Serialize};
use tracing::{debug, instrument, trace, warn};
#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
struct LatestReadReceipt {
/// The id of the event the read receipt is referring to. (Not the read
/// receipt event id.)
event_id: OwnedEventId,
}
/// Public data about read receipts collected during processing of that room.
///
/// Remember that each time a field of `RoomReadReceipts` is updated in
/// `compute_unread_counts`, this function must return true!
#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
pub struct RoomReadReceipts {
/// Does the room have unread messages?
pub num_unread: u64,
/// Does the room have unread events that should notify?
pub num_notifications: u64,
/// Does the room have messages causing highlights for the users? (aka
/// mentions)
pub num_mentions: u64,
/// The latest read receipt (main-threaded or unthreaded) known for the
/// room.
#[serde(default)]
latest_active: Option<LatestReadReceipt>,
/// Read receipts that haven't been matched to their event.
///
/// This might mean that the read receipt is in the past further than we
/// recall (i.e. before the first event we've ever cached), or in the
/// future (i.e. the event is lagging behind because of federation).
///
/// Note: this contains event ids of the event *targets* of the receipts,
/// not the event ids of the receipt events themselves.
#[serde(default = "new_nonempty_ring_buffer")]
pending: RingBuffer<OwnedEventId>,
}
impl Default for RoomReadReceipts {
fn default() -> Self {
Self {
num_unread: Default::default(),
num_notifications: Default::default(),
num_mentions: Default::default(),
latest_active: Default::default(),
pending: new_nonempty_ring_buffer(),
}
}
}
fn new_nonempty_ring_buffer() -> RingBuffer<OwnedEventId> {
// 10 pending read receipts per room should be enough for everyone.
// SAFETY: `unwrap` is safe because 10 is not zero.
RingBuffer::new(NonZeroUsize::new(10).unwrap())
}
impl RoomReadReceipts {
/// Update the [`RoomReadReceipts`] unread counts according to the new
/// event.
///
/// Returns whether a new event triggered a new unread/notification/mention.
#[inline(always)]
fn process_event(&mut self, event: &SyncTimelineEvent, user_id: &UserId) {
if marks_as_unread(event.raw(), user_id) {
self.num_unread += 1;
}
let mut has_notify = false;
let mut has_mention = false;
for action in &event.push_actions {
if !has_notify && action.should_notify() {
self.num_notifications += 1;
has_notify = true;
}
if !has_mention && action.is_highlight() {
self.num_mentions += 1;
has_mention = true;
}
}
}
#[inline(always)]
fn reset(&mut self) {
self.num_unread = 0;
self.num_notifications = 0;
self.num_mentions = 0;
}
/// Try to find the event to which the receipt attaches to, and if found,
/// will update the notification count in the room.
#[instrument(skip_all)]
fn find_and_process_events<'a>(
&mut self,
receipt_event_id: &EventId,
user_id: &UserId,
events: impl IntoIterator<Item = &'a SyncTimelineEvent>,
) -> bool {
let mut counting_receipts = false;
for event in events {
// The sliding sync proxy sometimes sends the same event multiple times, so it
// can be at the beginning and end of a batch, for instance. In that
// case, just reset every time we see the event matching the
// receipt. NOTE: SS proxy workaround.
if let Some(event_id) = event.event_id() {
if event_id == receipt_event_id {
// Bingo! Switch over to the counting state, after resetting the
// previous counts.
trace!("Found the event the receipt was referring to! Starting to count.");
self.reset();
counting_receipts = true;
continue;
}
}
if counting_receipts {
self.process_event(event, user_id);
}
}
counting_receipts
}
}
/// Provider for timeline events prior to the current sync.
pub trait PreviousEventsProvider: Send + Sync {
/// Returns the list of known timeline events, in sync order, for the given
/// room.
fn for_room(&self, room_id: &RoomId) -> Vector<SyncTimelineEvent>;
}
impl PreviousEventsProvider for () {
fn for_room(&self, _: &RoomId) -> Vector<SyncTimelineEvent> {
Vector::new()
}
}
/// Small helper to select the "best" receipt (that with the biggest sync
/// order).
struct ReceiptSelector {
/// Mapping of known event IDs to their sync order.
event_id_to_pos: BTreeMap<OwnedEventId, usize>,
/// The event with the greatest sync order, for which we had a read-receipt,
/// so far.
latest_event_with_receipt: Option<OwnedEventId>,
/// The biggest sync order attached to the `best_receipt`.
latest_event_pos: Option<usize>,
}
impl ReceiptSelector {
fn new(
all_events: &Vector<SyncTimelineEvent>,
latest_active_receipt_event: Option<&EventId>,
) -> Self {
let event_id_to_pos = Self::create_sync_index(all_events.iter());
let best_pos =
latest_active_receipt_event.and_then(|event_id| event_id_to_pos.get(event_id)).copied();
// Note: `best_receipt` isn't initialized to the latest active receipt, if set,
// so that `finish` will return only *new* better receipts, making it
// possible to take the fast path in `compute_unread_counts` where every
// event is considered new.
Self { latest_event_pos: best_pos, latest_event_with_receipt: None, event_id_to_pos }
}
/// Create a mapping of `event_id` -> sync order for all events that have an
/// `event_id`.
fn create_sync_index<'a>(
events: impl Iterator<Item = &'a SyncTimelineEvent> + 'a,
) -> BTreeMap<OwnedEventId, usize> {
// TODO: this should be cached and incrementally updated.
BTreeMap::from_iter(
events
.enumerate()
.filter_map(|(pos, event)| event.event_id().map(|event_id| (event_id, pos))),
)
}
/// Consider the current event and its position as a better read receipt.
#[instrument(skip(self), fields(prev_pos = ?self.latest_event_pos, prev_receipt = ?self.latest_event_with_receipt))]
fn try_select_later(&mut self, event_id: &EventId, event_pos: usize) {
// We now have a position for an event that had a read receipt, but wasn't found
// before. Consider if it is the most recent now.
if let Some(best_pos) = self.latest_event_pos.as_mut() {
// Note: by using a lax comparison here, we properly handle the case where we
// received events that we have already seen with a persisted read
// receipt.
if event_pos >= *best_pos {
*best_pos = event_pos;
self.latest_event_with_receipt = Some(event_id.to_owned());
debug!("saving better");
} else {
trace!("not better, keeping previous");
}
} else {
// We didn't have a previous receipt, this is the first one we
// store: remember it.
self.latest_event_pos = Some(event_pos);
self.latest_event_with_receipt = Some(event_id.to_owned());
debug!("saving for the first time");
}
}
/// Try to match pending receipts against new events.
#[instrument(skip_all)]
fn handle_pending_receipts(&mut self, pending: &mut RingBuffer<OwnedEventId>) {
// Try to match stashed receipts against the new events.
pending.retain(|event_id| {
if let Some(event_pos) = self.event_id_to_pos.get(event_id) {
// Maybe select this read receipt as it might be better than the ones we had.
trace!(%event_id, "matching event against its stashed receipt");
self.try_select_later(event_id, *event_pos);
// Remove this stashed read receipt from the pending list, as it's been
// reconciled with its event.
false
} else {
// Keep it for further iterations.
true
}
});
}
/// Try to match the receipts inside a receipt event against any of the
/// events we know about.
///
/// If we find a receipt (for the current user) for an event we know, call
/// `try_select_later` to see whether this is our new latest receipted
/// event.
///
/// Returns any receipts (for the current user) that we could not match
/// against any event - these are "pending".
#[instrument(skip_all)]
fn handle_new_receipt(
&mut self,
user_id: &UserId,
receipt_event: &ReceiptEventContent,
) -> Vec<OwnedEventId> {
let mut pending = Vec::new();
// Now consider new receipts.
for (event_id, receipts) in &receipt_event.0 {
for ty in [ReceiptType::Read, ReceiptType::ReadPrivate] {
if let Some(receipt) = receipts.get(&ty).and_then(|receipts| receipts.get(user_id))
{
if matches!(receipt.thread, ReceiptThread::Main | ReceiptThread::Unthreaded) {
trace!(%event_id, "found new candidate");
if let Some(event_pos) = self.event_id_to_pos.get(event_id) {
self.try_select_later(event_id, *event_pos);
} else {
// It's a new pending receipt.
trace!(%event_id, "stashed as pending");
pending.push(event_id.clone());
}
}
}
}
}
pending
}
/// Try to match an implicit receipt, that is, the one we get for events we
/// sent ourselves.
#[instrument(skip_all)]
fn try_match_implicit(&mut self, user_id: &UserId, new_events: &[SyncTimelineEvent]) {
for ev in new_events {
// Get the `sender` field, if any, or skip this event.
let Ok(Some(sender)) = ev.raw().get_field::<OwnedUserId>("sender") else { continue };
if sender == user_id {
// Get the event id, if any, or skip this event.
let Some(event_id) = ev.event_id() else { continue };
if let Some(event_pos) = self.event_id_to_pos.get(&event_id) {
trace!(%event_id, "found an implicit receipt candidate");
self.try_select_later(&event_id, *event_pos);
}
}
}
}
/// Returns the event id referred to by a new later active read receipt.
///
/// If it's not set, we can consider that each new event is *after* the
/// previous active read receipt.
fn select(self) -> Option<LatestReadReceipt> {
self.latest_event_with_receipt.map(|event_id| LatestReadReceipt { event_id })
}
}
/// Returns true if there's an event common to both groups of events, based on
/// their event id.
fn events_intersects<'a>(
previous_events: impl Iterator<Item = &'a SyncTimelineEvent>,
new_events: &[SyncTimelineEvent],
) -> bool {
let previous_events_ids = BTreeSet::from_iter(previous_events.filter_map(|ev| ev.event_id()));
new_events
.iter()
.any(|ev| ev.event_id().map_or(false, |event_id| previous_events_ids.contains(&event_id)))
}
/// Given a set of events coming from sync, for a room, update the
/// [`RoomReadReceipts`]'s counts of unread messages, notifications and
/// highlights' in place.
///
/// A provider of previous events may be required to reconcile a read receipt
/// that has been just received for an event that came in a previous sync.
///
/// See this module's documentation for more information.
#[instrument(skip_all, fields(room_id = %room_id))]
pub(crate) fn compute_unread_counts(
user_id: &UserId,
room_id: &RoomId,
receipt_event: Option<&ReceiptEventContent>,
previous_events: Vector<SyncTimelineEvent>,
new_events: &[SyncTimelineEvent],
read_receipts: &mut RoomReadReceipts,
) {
debug!(?read_receipts, "Starting.");
let all_events = if events_intersects(previous_events.iter(), new_events) {
// The previous and new events sets can intersect, for instance if we restored
// previous events from the disk cache, or a timeline was limited. This
// means the old events will be cleared, because we don't reconcile
// timelines in sliding sync (yet). As a result, forget
// about the previous events.
Vector::from_iter(new_events.iter().cloned())
} else {
let mut all_events = previous_events;
all_events.extend(new_events.iter().cloned());
all_events
};
let new_receipt = {
let mut selector = ReceiptSelector::new(
&all_events,
read_receipts.latest_active.as_ref().map(|receipt| &*receipt.event_id),
);
selector.try_match_implicit(user_id, new_events);
selector.handle_pending_receipts(&mut read_receipts.pending);
if let Some(receipt_event) = receipt_event {
let new_pending = selector.handle_new_receipt(user_id, receipt_event);
if !new_pending.is_empty() {
read_receipts.pending.extend(new_pending);
}
}
selector.select()
};
if let Some(new_receipt) = new_receipt {
// We've found the id of an event to which the receipt attaches. The associated
// event may either come from the new batch of events associated to
// this sync, or it may live in the past timeline events we know
// about.
let event_id = new_receipt.event_id.clone();
// First, save the event id as the latest one that has a read receipt.
trace!(%event_id, "Saving a new active read receipt");
read_receipts.latest_active = Some(new_receipt);
// The event for the receipt is in `all_events`, so we'll find it and can count
// safely from here.
read_receipts.find_and_process_events(&event_id, user_id, all_events.iter());
debug!(?read_receipts, "after finding a better receipt");
return;
}
// If we haven't returned at this point, it means we don't have any new "active"
// read receipt. So either there was a previous one further in the past, or
// none.
//
// In that case, accumulate all events as part of the current batch, and wait
// for the next receipt.
for event in new_events {
read_receipts.process_event(event, user_id);
}
debug!(?read_receipts, "no better receipt, {} new events", new_events.len());
}
/// Is the event worth marking a room as unread?
fn marks_as_unread(event: &Raw<AnySyncTimelineEvent>, user_id: &UserId) -> bool {
let event = match event.deserialize() {
Ok(event) => event,
Err(err) => {
warn!(
"couldn't deserialize event {:?}: {err}",
event.get_field::<String>("event_id").ok().flatten()
);
return false;
}
};
if event.sender() == user_id {
// Not interested in one's own events.
return false;
}
match event {
AnySyncTimelineEvent::MessageLike(event) => {
// Filter out redactions.
let Some(content) = event.original_content() else {
tracing::trace!("not interesting because redacted");
return false;
};
// Filter out edits.
if matches!(
content.relation(),
Some(ruma::events::room::encrypted::Relation::Replacement(..))
) {
tracing::trace!("not interesting because edited");
return false;
}
match event {
AnySyncMessageLikeEvent::CallAnswer(_)
| AnySyncMessageLikeEvent::CallInvite(_)
| AnySyncMessageLikeEvent::CallNotify(_)
| AnySyncMessageLikeEvent::CallHangup(_)
| AnySyncMessageLikeEvent::CallCandidates(_)
| AnySyncMessageLikeEvent::CallNegotiate(_)
| AnySyncMessageLikeEvent::CallReject(_)
| AnySyncMessageLikeEvent::CallSelectAnswer(_)
| AnySyncMessageLikeEvent::PollResponse(_)
| AnySyncMessageLikeEvent::UnstablePollResponse(_)
| AnySyncMessageLikeEvent::Reaction(_)
| AnySyncMessageLikeEvent::RoomRedaction(_)
| AnySyncMessageLikeEvent::KeyVerificationStart(_)
| AnySyncMessageLikeEvent::KeyVerificationReady(_)
| AnySyncMessageLikeEvent::KeyVerificationCancel(_)
| AnySyncMessageLikeEvent::KeyVerificationAccept(_)
| AnySyncMessageLikeEvent::KeyVerificationDone(_)
| AnySyncMessageLikeEvent::KeyVerificationMac(_)
| AnySyncMessageLikeEvent::KeyVerificationKey(_) => false,
// For some reason, Ruma doesn't handle these two in `content.relation()` above.
AnySyncMessageLikeEvent::PollStart(SyncMessageLikeEvent::Original(
OriginalSyncMessageLikeEvent {
content:
PollStartEventContent { relates_to: Some(Relation::Replacement(_)), .. },
..
},
))
| AnySyncMessageLikeEvent::UnstablePollStart(SyncMessageLikeEvent::Original(
OriginalSyncMessageLikeEvent {
content: UnstablePollStartEventContent::Replacement(_),
..
},
)) => false,
AnySyncMessageLikeEvent::Message(_)
| AnySyncMessageLikeEvent::PollStart(_)
| AnySyncMessageLikeEvent::UnstablePollStart(_)
| AnySyncMessageLikeEvent::PollEnd(_)
| AnySyncMessageLikeEvent::UnstablePollEnd(_)
| AnySyncMessageLikeEvent::RoomEncrypted(_)
| AnySyncMessageLikeEvent::RoomMessage(_)
| AnySyncMessageLikeEvent::Sticker(_) => true,
_ => {
// What I don't know about, I don't care about.
warn!("unhandled timeline event type: {}", event.event_type());
false
}
}
}
AnySyncTimelineEvent::State(_) => false,
}
}
#[cfg(test)]
mod tests {
use std::{num::NonZeroUsize, ops::Not as _};
use eyeball_im::Vector;
use matrix_sdk_common::{deserialized_responses::SyncTimelineEvent, ring_buffer::RingBuffer};
use matrix_sdk_test::{sync_timeline_event, EventBuilder};
use ruma::{
event_id,
events::receipt::{ReceiptThread, ReceiptType},
owned_event_id, owned_user_id,
push::Action,
room_id, user_id, EventId, UserId,
};
use super::compute_unread_counts;
use crate::read_receipts::{marks_as_unread, ReceiptSelector, RoomReadReceipts};
#[test]
fn test_room_message_marks_as_unread() {
let user_id = user_id!("@alice:example.org");
let other_user_id = user_id!("@bob:example.org");
// A message from somebody else marks the room as unread...
let ev = sync_timeline_event!({
"sender": other_user_id,
"type": "m.room.message",
"event_id": "$ida",
"origin_server_ts": 12344446,
"content": { "body":"A", "msgtype": "m.text" },
});
assert!(marks_as_unread(&ev, user_id));
// ... but a message from ourselves doesn't.
let ev = sync_timeline_event!({
"sender": user_id,
"type": "m.room.message",
"event_id": "$ida",
"origin_server_ts": 12344446,
"content": { "body":"A", "msgtype": "m.text" },
});
assert!(marks_as_unread(&ev, user_id).not());
}
#[test]
fn test_room_edit_doesnt_mark_as_unread() {
let user_id = user_id!("@alice:example.org");
let other_user_id = user_id!("@bob:example.org");
// An edit to a message from somebody else doesn't mark the room as unread.
let ev = sync_timeline_event!({
"sender": other_user_id,
"type": "m.room.message",
"event_id": "$ida",
"origin_server_ts": 12344446,
"content": {
"body": " * edited message",
"m.new_content": {
"body": "edited message",
"msgtype": "m.text"
},
"m.relates_to": {
"event_id": "$someeventid:localhost",
"rel_type": "m.replace"
},
"msgtype": "m.text"
},
});
assert!(marks_as_unread(&ev, user_id).not());
}
#[test]
fn test_redaction_doesnt_mark_room_as_unread() {
let user_id = user_id!("@alice:example.org");
let other_user_id = user_id!("@bob:example.org");
// A redact of a message from somebody else doesn't mark the room as unread.
let ev = sync_timeline_event!({
"content": {
"reason": "🛑"
},
"event_id": "$151957878228ssqrJ:localhost",
"origin_server_ts": 151957878000000_u64,
"sender": other_user_id,
"type": "m.room.redaction",
"redacts": "$151957878228ssqrj:localhost",
"unsigned": {
"age": 85
}
});
assert!(marks_as_unread(&ev, user_id).not());
}
#[test]
fn test_reaction_doesnt_mark_room_as_unread() {
let user_id = user_id!("@alice:example.org");
let other_user_id = user_id!("@bob:example.org");
// A reaction from somebody else to a message doesn't mark the room as unread.
let ev = sync_timeline_event!({
"content": {
"m.relates_to": {
"event_id": "$15275047031IXQRi:localhost",
"key": "👍",
"rel_type": "m.annotation"
}
},
"event_id": "$15275047031IXQRi:localhost",
"origin_server_ts": 159027581000000_u64,
"sender": other_user_id,
"type": "m.reaction",
"unsigned": {
"age": 85
}
});
assert!(marks_as_unread(&ev, user_id).not());
}
#[test]
fn test_state_event_doesnt_mark_as_unread() {
let user_id = user_id!("@alice:example.org");
let event_id = event_id!("$1");
let ev = sync_timeline_event!({
"content": {
"displayname": "Alice",
"membership": "join",
},
"event_id": event_id,
"origin_server_ts": 1432135524678u64,
"sender": user_id,
"state_key": user_id,
"type": "m.room.member",
});
assert!(marks_as_unread(&ev, user_id).not());
let other_user_id = user_id!("@bob:example.org");
assert!(marks_as_unread(&ev, other_user_id).not());
}
#[test]
fn test_count_unread_and_mentions() {
fn make_event(user_id: &UserId, push_actions: Vec<Action>) -> SyncTimelineEvent {
SyncTimelineEvent::new_with_push_actions(
sync_timeline_event!({
"sender": user_id,
"type": "m.room.message",
"event_id": "$ida",
"origin_server_ts": 12344446,
"content": { "body":"A", "msgtype": "m.text" },
}),
push_actions,
)
}
let user_id = user_id!("@alice:example.org");
// An interesting event from oneself doesn't count as a new unread message.
let event = make_event(user_id, Vec::new());
let mut receipts = RoomReadReceipts::default();
receipts.process_event(&event, user_id);
assert_eq!(receipts.num_unread, 0);
assert_eq!(receipts.num_mentions, 0);
assert_eq!(receipts.num_notifications, 0);
// An interesting event from someone else does count as a new unread message.
let event = make_event(user_id!("@bob:example.org"), Vec::new());
let mut receipts = RoomReadReceipts::default();
receipts.process_event(&event, user_id);
assert_eq!(receipts.num_unread, 1);
assert_eq!(receipts.num_mentions, 0);
assert_eq!(receipts.num_notifications, 0);
// Push actions computed beforehand are respected.
let event = make_event(user_id!("@bob:example.org"), vec![Action::Notify]);
let mut receipts = RoomReadReceipts::default();
receipts.process_event(&event, user_id);
assert_eq!(receipts.num_unread, 1);
assert_eq!(receipts.num_mentions, 0);
assert_eq!(receipts.num_notifications, 1);
let event = make_event(
user_id!("@bob:example.org"),
vec![Action::SetTweak(ruma::push::Tweak::Highlight(true))],
);
let mut receipts = RoomReadReceipts::default();
receipts.process_event(&event, user_id);
assert_eq!(receipts.num_unread, 1);
assert_eq!(receipts.num_mentions, 1);
assert_eq!(receipts.num_notifications, 0);
let event = make_event(
user_id!("@bob:example.org"),
vec![Action::SetTweak(ruma::push::Tweak::Highlight(true)), Action::Notify],
);
let mut receipts = RoomReadReceipts::default();
receipts.process_event(&event, user_id);
assert_eq!(receipts.num_unread, 1);
assert_eq!(receipts.num_mentions, 1);
assert_eq!(receipts.num_notifications, 1);
// Technically this `push_actions` set would be a bug somewhere else, but let's
// make sure to resist against it.
let event = make_event(user_id!("@bob:example.org"), vec![Action::Notify, Action::Notify]);
let mut receipts = RoomReadReceipts::default();
receipts.process_event(&event, user_id);
assert_eq!(receipts.num_unread, 1);
assert_eq!(receipts.num_mentions, 0);
assert_eq!(receipts.num_notifications, 1);
}
#[test]
fn test_find_and_process_events() {
let ev0 = event_id!("$0");
let user_id = user_id!("@alice:example.org");
// When provided with no events, we report not finding the event to which the
// receipt relates.
let mut receipts = RoomReadReceipts::default();
assert!(receipts.find_and_process_events(ev0, user_id, &[]).not());
assert_eq!(receipts.num_unread, 0);
assert_eq!(receipts.num_notifications, 0);
assert_eq!(receipts.num_mentions, 0);
// When provided with one event, that's not the receipt event, we don't count
// it.
fn make_event(event_id: &EventId) -> SyncTimelineEvent {
SyncTimelineEvent::new(sync_timeline_event!({
"sender": "@bob:example.org",
"type": "m.room.message",
"event_id": event_id,
"origin_server_ts": 12344446,
"content": { "body":"A", "msgtype": "m.text" },
}))
}
let mut receipts = RoomReadReceipts {
num_unread: 42,
num_notifications: 13,
num_mentions: 37,
..Default::default()
};
assert!(receipts
.find_and_process_events(ev0, user_id, &[make_event(event_id!("$1"))],)
.not());
assert_eq!(receipts.num_unread, 42);
assert_eq!(receipts.num_notifications, 13);
assert_eq!(receipts.num_mentions, 37);
// When provided with one event that's the receipt target, we find it, reset the
// count, and since there's nothing else, we stop there and end up with
// zero counts.
let mut receipts = RoomReadReceipts {
num_unread: 42,
num_notifications: 13,
num_mentions: 37,
..Default::default()
};
assert!(receipts.find_and_process_events(ev0, user_id, &[make_event(ev0)]));
assert_eq!(receipts.num_unread, 0);
assert_eq!(receipts.num_notifications, 0);
assert_eq!(receipts.num_mentions, 0);
// When provided with multiple events and not the receipt event, we do not count
// anything..
let mut receipts = RoomReadReceipts {
num_unread: 42,
num_notifications: 13,
num_mentions: 37,
..Default::default()
};
assert!(receipts
.find_and_process_events(
ev0,
user_id,
&[
make_event(event_id!("$1")),
make_event(event_id!("$2")),
make_event(event_id!("$3"))
],
)
.not());
assert_eq!(receipts.num_unread, 42);
assert_eq!(receipts.num_notifications, 13);
assert_eq!(receipts.num_mentions, 37);
// When provided with multiple events including one that's the receipt event, we
// find it and count from it.
let mut receipts = RoomReadReceipts {
num_unread: 42,
num_notifications: 13,
num_mentions: 37,
..Default::default()
};
assert!(receipts.find_and_process_events(
ev0,
user_id,
&[
make_event(event_id!("$1")),
make_event(ev0),
make_event(event_id!("$2")),
make_event(event_id!("$3"))
],
));
assert_eq!(receipts.num_unread, 2);
assert_eq!(receipts.num_notifications, 0);
assert_eq!(receipts.num_mentions, 0);
// Even if duplicates are present in the new events list, the count is correct.
let mut receipts = RoomReadReceipts {
num_unread: 42,
num_notifications: 13,
num_mentions: 37,
..Default::default()
};
assert!(receipts.find_and_process_events(
ev0,
user_id,
&[
make_event(ev0),
make_event(event_id!("$1")),
make_event(ev0),
make_event(event_id!("$2")),
make_event(event_id!("$3"))
],
));
assert_eq!(receipts.num_unread, 2);
assert_eq!(receipts.num_notifications, 0);
assert_eq!(receipts.num_mentions, 0);
}
fn sync_timeline_message(
sender: &UserId,
event_id: impl serde::Serialize,
body: impl serde::Serialize,
) -> SyncTimelineEvent {
SyncTimelineEvent::new(sync_timeline_event!({
"sender": sender,
"type": "m.room.message",
"event_id": event_id,
"origin_server_ts": 42,
"content": { "body": body, "msgtype": "m.text" },
}))
}
/// Smoke test for `compute_unread_counts`.
#[test]
fn test_basic_compute_unread_counts() {
let user_id = user_id!("@alice:example.org");
let other_user_id = user_id!("@bob:example.org");
let room_id = room_id!("!room:example.org");
let receipt_event_id = event_id!("$1");
let mut previous_events = Vector::new();
let ev1 = sync_timeline_message(other_user_id, receipt_event_id, "A");
let ev2 = sync_timeline_message(other_user_id, "$2", "A");
let receipt_event = EventBuilder::new().make_receipt_event_content([(
receipt_event_id.to_owned(),
ReceiptType::Read,
user_id.to_owned(),
ReceiptThread::Unthreaded,
)]);
let mut read_receipts = Default::default();
compute_unread_counts(
user_id,
room_id,
Some(&receipt_event),
previous_events.clone(),
&[ev1.clone(), ev2.clone()],
&mut read_receipts,
);
// It did find the receipt event (ev1).
assert_eq!(read_receipts.num_unread, 1);
// Receive the same receipt event, with a new sync event.
previous_events.push_back(ev1);
previous_events.push_back(ev2);
let new_event = sync_timeline_message(other_user_id, "$3", "A");
compute_unread_counts(
user_id,
room_id,
Some(&receipt_event),
previous_events,
&[new_event],
&mut read_receipts,
);
// Only the new event should be added.
assert_eq!(read_receipts.num_unread, 2);
}
fn make_test_events(user_id: &UserId) -> Vector<SyncTimelineEvent> {
let ev1 = sync_timeline_message(user_id, "$1", "With the lights out, it's less dangerous");
let ev2 = sync_timeline_message(user_id, "$2", "Here we are now, entertain us");
let ev3 = sync_timeline_message(user_id, "$3", "I feel stupid and contagious");
let ev4 = sync_timeline_message(user_id, "$4", "Here we are now, entertain us");
let ev5 = sync_timeline_message(user_id, "$5", "Hello, hello, hello, how low?");
vec![ev1, ev2, ev3, ev4, ev5].into()
}
/// Test that when multiple receipts come in a single event, we can still
/// find the latest one according to the sync order.
#[test]
fn test_compute_unread_counts_multiple_receipts_in_one_event() {
let user_id = user_id!("@alice:example.org");
let room_id = room_id!("!room:example.org");
let all_events = make_test_events(user_id!("@bob:example.org"));
let head_events: Vector<_> = all_events.iter().take(2).cloned().collect();
let tail_events: Vec<_> = all_events.iter().skip(2).cloned().collect();
// Given a receipt event marking events 1-3 as read using a combination of
// different thread and privacy types,
for receipt_type_1 in &[ReceiptType::Read, ReceiptType::ReadPrivate] {
for receipt_thread_1 in &[ReceiptThread::Unthreaded, ReceiptThread::Main] {
for receipt_type_2 in &[ReceiptType::Read, ReceiptType::ReadPrivate] {
for receipt_thread_2 in &[ReceiptThread::Unthreaded, ReceiptThread::Main] {
let receipt_event = EventBuilder::new().make_receipt_event_content([
(
owned_event_id!("$2"),
receipt_type_1.clone(),
user_id.to_owned(),
receipt_thread_1.clone(),
),
(
owned_event_id!("$3"),
receipt_type_2.clone(),
user_id.to_owned(),
receipt_thread_2.clone(),
),
(
owned_event_id!("$1"),
receipt_type_1.clone(),
user_id.to_owned(),
receipt_thread_2.clone(),
),
]);
// When I compute the notifications for this room (with no new events),
let mut read_receipts = RoomReadReceipts::default();
compute_unread_counts(
user_id,
room_id,
Some(&receipt_event),
all_events.clone(),
&[],
&mut read_receipts,
);
assert!(
read_receipts != Default::default(),
"read receipts have been updated"
);
// Then events 1-3 are considered read, but 4 and 5 are not.
assert_eq!(read_receipts.num_unread, 2);
assert_eq!(read_receipts.num_mentions, 0);
assert_eq!(read_receipts.num_notifications, 0);
// And when I compute notifications again, with some old and new events,
let mut read_receipts = RoomReadReceipts::default();
compute_unread_counts(
user_id,
room_id,
Some(&receipt_event),
head_events.clone(),
&tail_events,
&mut read_receipts,
);
assert!(
read_receipts != Default::default(),
"read receipts have been updated"
);
// Then events 1-3 are considered read, but 4 and 5 are not.
assert_eq!(read_receipts.num_unread, 2);
assert_eq!(read_receipts.num_mentions, 0);
assert_eq!(read_receipts.num_notifications, 0);
}
}
}
}
}
/// Updating the pending list should cause a change in the
/// `RoomReadReceipts` fields, and `compute_unread_counts` should return
/// true then.
#[test]
fn test_compute_unread_counts_updated_after_field_tracking() {
let user_id = owned_user_id!("@alice:example.org");
let room_id = room_id!("!room:example.org");
let events = make_test_events(user_id!("@bob:example.org"));
let receipt_event = EventBuilder::new().make_receipt_event_content([(
owned_event_id!("$6"),
ReceiptType::Read,
user_id.clone(),
ReceiptThread::Unthreaded,
)]);
let mut read_receipts = RoomReadReceipts::default();
assert!(read_receipts.pending.is_empty());
// Given a receipt event that contains a read receipt referring to an unknown
// event, and some preexisting events with different ids,
compute_unread_counts(
&user_id,
room_id,
Some(&receipt_event),
events,
&[], // no new events
&mut read_receipts,
);
// Then there are no unread events,
assert_eq!(read_receipts.num_unread, 0);
// And the event referred to by the read receipt is in the pending state.
assert_eq!(read_receipts.pending.len(), 1);
assert!(read_receipts.pending.iter().any(|ev| ev == event_id!("$6")));
}
#[test]
fn test_compute_unread_counts_limited_sync() {
let user_id = owned_user_id!("@alice:example.org");
let room_id = room_id!("!room:example.org");
let events = make_test_events(user_id!("@bob:example.org"));
let receipt_event = EventBuilder::new().make_receipt_event_content([(
owned_event_id!("$1"),
ReceiptType::Read,
user_id.clone(),
ReceiptThread::Unthreaded,
)]);
// Sync with a read receipt *and* a single event that was already known: in that
// case, only consider the new events in isolation, and compute the
// correct count.
let mut read_receipts = RoomReadReceipts::default();
assert!(read_receipts.pending.is_empty());
let ev0 = events[0].clone();
compute_unread_counts(
&user_id,
room_id,
Some(&receipt_event),
events,
&[ev0], // duplicate event!
&mut read_receipts,
);
// All events are unread, and there's no pending receipt.
assert_eq!(read_receipts.num_unread, 0);
assert!(read_receipts.pending.is_empty());
}
#[test]
fn test_receipt_selector_create_sync_index() {
let uid = user_id!("@bob:example.org");
let events = make_test_events(uid);
// An event with no id.
let ev6 = SyncTimelineEvent::new(sync_timeline_event!({
"sender": uid,
"type": "m.room.message",
"origin_server_ts": 42,
"content": { "body": "yolo", "msgtype": "m.text" },
}));
let index = ReceiptSelector::create_sync_index(events.iter().chain(&[ev6]));
assert_eq!(*index.get(event_id!("$1")).unwrap(), 0);
assert_eq!(*index.get(event_id!("$2")).unwrap(), 1);
assert_eq!(*index.get(event_id!("$3")).unwrap(), 2);
assert_eq!(*index.get(event_id!("$4")).unwrap(), 3);
assert_eq!(*index.get(event_id!("$5")).unwrap(), 4);
assert_eq!(index.get(event_id!("$6")), None);
assert_eq!(index.len(), 5);
// Sync order are set according to the position in the vector.
let index = ReceiptSelector::create_sync_index(
[events[1].clone(), events[2].clone(), events[4].clone()].iter(),
);
assert_eq!(*index.get(event_id!("$2")).unwrap(), 0);
assert_eq!(*index.get(event_id!("$3")).unwrap(), 1);
assert_eq!(*index.get(event_id!("$5")).unwrap(), 2);
assert_eq!(index.len(), 3);
}
#[test]
fn test_receipt_selector_try_select_later() {
let events = make_test_events(user_id!("@bob:example.org"));
{
// No initial active receipt, so the first receipt we get *will* win.
let mut selector = ReceiptSelector::new(&vec![].into(), None);
selector.try_select_later(event_id!("$1"), 0);
let best_receipt = selector.select();
assert_eq!(best_receipt.unwrap().event_id, event_id!("$1"));
}
{
// $3 is at pos 2, $1 at position 0, so $3 wins => no new change.
let mut selector = ReceiptSelector::new(&events, Some(event_id!("$3")));
selector.try_select_later(event_id!("$1"), 0);
let best_receipt = selector.select();
assert!(best_receipt.is_none());
}
{
// The initial active receipt is returned, when it's part of the scanned
// elements.
let mut selector = ReceiptSelector::new(&events, Some(event_id!("$1")));
selector.try_select_later(event_id!("$1"), 0);
let best_receipt = selector.select();
assert_eq!(best_receipt.unwrap().event_id, event_id!("$1"));
}
{
// $3 is at pos 2, $4 at position 3, so $4 wins.
let mut selector = ReceiptSelector::new(&events, Some(event_id!("$3")));
selector.try_select_later(event_id!("$4"), 3);
let best_receipt = selector.select();
assert_eq!(best_receipt.unwrap().event_id, event_id!("$4"));
}
}
#[test]
fn test_receipt_selector_handle_pending_receipts_noop() {
let sender = user_id!("@bob:example.org");
let ev1 = sync_timeline_message(sender, event_id!("$1"), "yo");
let ev2 = sync_timeline_message(sender, event_id!("$2"), "well?");
let events: Vector<_> = vec![ev1, ev2].into();
{
// No pending receipt => no better receipt.
let mut selector = ReceiptSelector::new(&events, None);
let mut pending = RingBuffer::new(NonZeroUsize::new(16).unwrap());
selector.handle_pending_receipts(&mut pending);
assert!(pending.is_empty());
let best_receipt = selector.select();
assert!(best_receipt.is_none());
}
{
// No pending receipt, and there was an active last receipt => no better
// receipt.
let mut selector = ReceiptSelector::new(&events, Some(event_id!("$1")));
let mut pending = RingBuffer::new(NonZeroUsize::new(16).unwrap());
selector.handle_pending_receipts(&mut pending);
assert!(pending.is_empty());
let best_receipt = selector.select();
assert!(best_receipt.is_none());
}
}
#[test]
fn test_receipt_selector_handle_pending_receipts_doesnt_match_known_events() {
let sender = user_id!("@bob:example.org");
let ev1 = sync_timeline_message(sender, event_id!("$1"), "yo");
let ev2 = sync_timeline_message(sender, event_id!("$2"), "well?");
let events: Vector<_> = vec![ev1, ev2].into();
{
// A pending receipt for an event that is still missing => no better receipt.
let mut selector = ReceiptSelector::new(&events, None);
let mut pending = RingBuffer::new(NonZeroUsize::new(16).unwrap());
pending.push(owned_event_id!("$3"));
selector.handle_pending_receipts(&mut pending);
assert_eq!(pending.len(), 1);
let best_receipt = selector.select();
assert!(best_receipt.is_none());
}
{
// Ditto but there was an active receipt => no better receipt.
let mut selector = ReceiptSelector::new(&events, Some(event_id!("$1")));
let mut pending = RingBuffer::new(NonZeroUsize::new(16).unwrap());
pending.push(owned_event_id!("$3"));
selector.handle_pending_receipts(&mut pending);
assert_eq!(pending.len(), 1);
let best_receipt = selector.select();
assert!(best_receipt.is_none());
}
}
#[test]
fn test_receipt_selector_handle_pending_receipts_matches_known_events_no_initial() {
let sender = user_id!("@bob:example.org");
let ev1 = sync_timeline_message(sender, event_id!("$1"), "yo");
let ev2 = sync_timeline_message(sender, event_id!("$2"), "well?");
let events: Vector<_> = vec![ev1, ev2].into();
{
// A pending receipt for an event that is present => better receipt.
let mut selector = ReceiptSelector::new(&events, None);
let mut pending = RingBuffer::new(NonZeroUsize::new(16).unwrap());
pending.push(owned_event_id!("$2"));
selector.handle_pending_receipts(&mut pending);
// The receipt for $2 has been found.
assert!(pending.is_empty());
// The new receipt has been returned.
let best_receipt = selector.select();
assert_eq!(best_receipt.unwrap().event_id, event_id!("$2"));
}
{
// Mixed found and not found receipt => better receipt.
let mut selector = ReceiptSelector::new(&events, None);
let mut pending = RingBuffer::new(NonZeroUsize::new(16).unwrap());
pending.push(owned_event_id!("$1"));
pending.push(owned_event_id!("$3"));
selector.handle_pending_receipts(&mut pending);
// The receipt for $1 has been found, but not that for $3.
assert_eq!(pending.len(), 1);
assert!(pending.iter().any(|ev| ev == event_id!("$3")));
let best_receipt = selector.select();
assert_eq!(best_receipt.unwrap().event_id, event_id!("$1"));
}
}
#[test]
fn test_receipt_selector_handle_pending_receipts_matches_known_events_with_initial() {
let sender = user_id!("@bob:example.org");
let ev1 = sync_timeline_message(sender, event_id!("$1"), "yo");
let ev2 = sync_timeline_message(sender, event_id!("$2"), "well?");
let events: Vector<_> = vec![ev1, ev2].into();
{
// Same, and there was an initial receipt that was less good than the one we
// selected => better receipt.
let mut selector = ReceiptSelector::new(&events, Some(event_id!("$1")));
let mut pending = RingBuffer::new(NonZeroUsize::new(16).unwrap());
pending.push(owned_event_id!("$2"));
selector.handle_pending_receipts(&mut pending);
// The receipt for $2 has been found.
assert!(pending.is_empty());
// The new receipt has been returned.
let best_receipt = selector.select();
assert_eq!(best_receipt.unwrap().event_id, event_id!("$2"));
}
{
// Same, but the previous receipt was better => no better receipt.
let mut selector = ReceiptSelector::new(&events, Some(event_id!("$2")));
let mut pending = RingBuffer::new(NonZeroUsize::new(16).unwrap());
pending.push(owned_event_id!("$1"));
selector.handle_pending_receipts(&mut pending);
// The receipt for $1 has been found.
assert!(pending.is_empty());
let best_receipt = selector.select();
assert!(best_receipt.is_none());
}
}
#[test]
fn test_receipt_selector_handle_new_receipt() {
let myself = owned_user_id!("@alice:example.org");
let events = make_test_events(user_id!("@bob:example.org"));
{
// Thread receipts are ignored.
let mut selector = ReceiptSelector::new(&events, None);
let receipt_event = EventBuilder::new().make_receipt_event_content([(
owned_event_id!("$5"),
ReceiptType::Read,
myself.clone(),
ReceiptThread::Thread(owned_event_id!("$2")),
)]);
let pending = selector.handle_new_receipt(&myself, &receipt_event);
assert!(pending.is_empty());
let best_receipt = selector.select();
assert!(best_receipt.is_none());
}
for receipt_type in [ReceiptType::Read, ReceiptType::ReadPrivate] {
for receipt_thread in [ReceiptThread::Main, ReceiptThread::Unthreaded] {
{
// Receipt for an event we don't know about => it's pending, and no better
// receipt.
let mut selector = ReceiptSelector::new(&events, None);
let receipt_event = EventBuilder::new().make_receipt_event_content([(
owned_event_id!("$6"),
receipt_type.clone(),
myself.clone(),
receipt_thread.clone(),
)]);
let pending = selector.handle_new_receipt(&myself, &receipt_event);
assert_eq!(pending[0], event_id!("$6"));
assert_eq!(pending.len(), 1);
let best_receipt = selector.select();
assert!(best_receipt.is_none());
}
{
// Receipt for an event we knew about, no initial active receipt => better
// receipt.
let mut selector = ReceiptSelector::new(&events, None);
let receipt_event = EventBuilder::new().make_receipt_event_content([(
owned_event_id!("$3"),
receipt_type.clone(),
myself.clone(),
receipt_thread.clone(),
)]);
let pending = selector.handle_new_receipt(&myself, &receipt_event);
assert!(pending.is_empty());
let best_receipt = selector.select();
assert_eq!(best_receipt.unwrap().event_id, event_id!("$3"));
}
{
// Receipt for an event we knew about, initial active receipt was better => no
// better receipt.
let mut selector = ReceiptSelector::new(&events, Some(event_id!("$4")));
let receipt_event = EventBuilder::new().make_receipt_event_content([(
owned_event_id!("$3"),
receipt_type.clone(),
myself.clone(),
receipt_thread.clone(),
)]);
let pending = selector.handle_new_receipt(&myself, &receipt_event);
assert!(pending.is_empty());
let best_receipt = selector.select();
assert!(best_receipt.is_none());
}
{
// Receipt for an event we knew about, initial active receipt was less good =>
// new better receipt.
let mut selector = ReceiptSelector::new(&events, Some(event_id!("$2")));
let receipt_event = EventBuilder::new().make_receipt_event_content([(
owned_event_id!("$3"),
receipt_type.clone(),
myself.clone(),
receipt_thread.clone(),
)]);
let pending = selector.handle_new_receipt(&myself, &receipt_event);
assert!(pending.is_empty());
let best_receipt = selector.select();
assert_eq!(best_receipt.unwrap().event_id, event_id!("$3"));
}
}
} // end for
{
// Final boss: multiple receipts in the receipt event, the best one is used =>
// new better receipt.
let mut selector = ReceiptSelector::new(&events, Some(event_id!("$2")));
let receipt_event = EventBuilder::new().make_receipt_event_content([
(
owned_event_id!("$4"),
ReceiptType::ReadPrivate,
myself.clone(),
ReceiptThread::Unthreaded,
),
(
owned_event_id!("$6"),
ReceiptType::ReadPrivate,
myself.clone(),
ReceiptThread::Main,
),
(owned_event_id!("$3"), ReceiptType::Read, myself.clone(), ReceiptThread::Main),
]);
let pending = selector.handle_new_receipt(&myself, &receipt_event);
assert_eq!(pending.len(), 1);
assert_eq!(pending[0], event_id!("$6"));
let best_receipt = selector.select();
assert_eq!(best_receipt.unwrap().event_id, event_id!("$4"));
}
}
#[test]
fn test_try_match_implicit() {
let myself = owned_user_id!("@alice:example.org");
let bob = user_id!("@bob:example.org");
let mut events = make_test_events(bob);
// When the selector sees only other users' events,
let mut selector = ReceiptSelector::new(&events, None);
// And I search for my implicit read receipt,
selector.try_match_implicit(&myself, &events.iter().cloned().collect::<Vec<_>>());
// Then I don't find any.
let best_receipt = selector.select();
assert!(best_receipt.is_none());
// Now, if there are events I've written too...
events.push_back(sync_timeline_message(&myself, "$6", "A mulatto, an albino"));
events.push_back(sync_timeline_message(bob, "$7", "A mosquito, my libido"));
let mut selector = ReceiptSelector::new(&events, None);
// And I search for my implicit read receipt,
selector.try_match_implicit(&myself, &events.iter().cloned().collect::<Vec<_>>());
// Then my last sent event counts as a read receipt.
let best_receipt = selector.select();
assert_eq!(best_receipt.unwrap().event_id, event_id!("$6"));
}
#[test]
fn test_compute_unread_counts_with_implicit_receipt() {
let user_id = owned_user_id!("@alice:example.org");
let bob = user_id!("@bob:example.org");
let room_id = room_id!("!room:example.org");
// Given a set of events sent by Bob,
let mut events = make_test_events(bob);
// One by me,
events.push_back(sync_timeline_message(&user_id, "$6", "A mulatto, an albino"));
// And others by Bob,
events.push_back(sync_timeline_message(bob, "$7", "A mosquito, my libido"));
events.push_back(sync_timeline_message(bob, "$8", "A denial, a denial"));
let events: Vec<_> = events.into_iter().collect();
// I have a read receipt attached to one of Bob's event sent before my message,
let receipt_event = EventBuilder::new().make_receipt_event_content([(
owned_event_id!("$3"),
ReceiptType::Read,
user_id.clone(),
ReceiptThread::Unthreaded,
)]);
let mut read_receipts = RoomReadReceipts::default();
// And I compute the unread counts for all those new events (no previous events
// in that room),
compute_unread_counts(
&user_id,
room_id,
Some(&receipt_event),
Vector::new(),
&events,
&mut read_receipts,
);
// Only the last two events sent by Bob count as unread.
assert_eq!(read_receipts.num_unread, 2);
// There are no pending receipts.
assert!(read_receipts.pending.is_empty());
// And the active receipt is the implicit one on my event.
assert_eq!(read_receipts.latest_active.unwrap().event_id, event_id!("$6"));
}
}