mirror/matrix-rust-sdk
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-rust-sdk.git synced 2026-06-22 07:08:32 -04:00
Code Issues Packages Projects Releases Wiki Activity

read receipts: update the API shape of compute_notifications

Browse Source
This commit is contained in:
Benjamin Bouvier
2023-12-21 12:50:56 +01:00
parent 4a686229e1
commit 2a77aaa068
2 changed files with 23 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
crates/matrix-sdk-base/src/read_receipts.rs
View File

@@ -45,7 +45,7 @@ use matrix_sdk_common::deserialized_responses::SyncTimelineEvent;
use ruma::{
events::{
poll::{start::PollStartEventContent, unstable_start::UnstablePollStartEventContent},
receipt::{ReceiptThread, ReceiptType},
receipt::{ReceiptEventContent, ReceiptThread, ReceiptType},
room::message::Relation,
AnySyncMessageLikeEvent, AnySyncTimelineEvent, OriginalSyncMessageLikeEvent,
SyncMessageLikeEvent,
@@ -56,8 +56,7 @@ use ruma::{
use serde::{Deserialize, Serialize};
use tracing::{instrument, trace};
use super::BaseClient;
use crate::{error::Result, store::StateChanges, RoomInfo};
use crate::error::Result;
/// Information about read receipts collected during processing of that room.
#[derive(Clone, Debug, Serialize, Deserialize, Default)]
@@ -152,25 +151,25 @@ impl PreviousEventsProvider for () {
}
/// Given a set of events coming from sync, for a room, update the
/// [`RoomInfo`]'s counts of unread messages, notifications and highlights' in
/// place.
/// [`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_info.room_id))]
#[instrument(skip_all, fields(room_id = %room_id, ?read_receipts))]
pub(crate) fn compute_notifications<PEP: PreviousEventsProvider>(
client: &BaseClient,
changes: &StateChanges,
user_id: &UserId,
room_id: &RoomId,
receipt_event: Option<&ReceiptEventContent>,
previous_events_provider: &PEP,
new_events: &[SyncTimelineEvent],
room_info: &mut RoomInfo,
read_receipts: &mut RoomReadReceipts,
) -> Result<()> {
let user_id = &client.session_meta().unwrap().user_id;
let prev_latest_receipt_event_id = room_info.read_receipts.latest_read_receipt_event_id.clone();
let prev_latest_receipt_event_id = read_receipts.latest_read_receipt_event_id.clone();
if let Some(receipt_event) = changes.receipts.get(room_info.room_id()) {
if let Some(receipt_event) = receipt_event {
trace!("Got a new receipt event!");
// Find a private or public read receipt for the current user.
@@ -192,13 +191,12 @@ pub(crate) fn compute_notifications<PEP: PreviousEventsProvider>(
// about.
// First, save the event id as the latest one that has a read receipt.
room_info.read_receipts.latest_read_receipt_event_id = Some(receipt_event_id.clone());
read_receipts.latest_read_receipt_event_id = Some(receipt_event_id.clone());
// Try to find if the read receipt refers to an event from the current sync, to
// avoid searching the cached timeline events.
trace!("We got a new event with a read receipt: {receipt_event_id}. Search in new events...");
if room_info.read_receipts.find_and_count_events(&receipt_event_id, user_id, new_events)
{
if read_receipts.find_and_count_events(&receipt_event_id, user_id, new_events) {
// It did, so our work here is done.
return Ok(());
}
@@ -206,10 +204,10 @@ pub(crate) fn compute_notifications<PEP: PreviousEventsProvider>(
// We didn't find the event attached to the receipt in the new batches of
// events. It's possible it's referring to an event we've already
// seen. In that case, try to find it.
let previous_events = previous_events_provider.for_room(&room_info.room_id);
let previous_events = previous_events_provider.for_room(room_id);
trace!("Couldn't find the event attached to the receipt in the new events; looking in past events too now...");
if room_info.read_receipts.find_and_count_events(
if read_receipts.find_and_count_events(
&receipt_event_id,
user_id,
previous_events.iter().chain(new_events.iter()),
@@ -225,7 +223,7 @@ pub(crate) fn compute_notifications<PEP: PreviousEventsProvider>(
// properly processed, and we only need to process the new events based
// on the previous receipt.
trace!("No new receipts, or couldn't find attached event; looking if the past latest known receipt refers to a new event...");
if room_info.read_receipts.find_and_count_events(&receipt_event_id, user_id, new_events) {
if read_receipts.find_and_count_events(&receipt_event_id, user_id, new_events) {
// We found the event to which the previous receipt attached to, so our work is
// done here.
return Ok(());
@@ -240,7 +238,7 @@ pub(crate) fn compute_notifications<PEP: PreviousEventsProvider>(
// for the next receipt.
trace!("Default path: including all new events for the receipts count.");
for event in new_events {
room_info.read_receipts.update_for_event(event, user_id);
read_receipts.update_for_event(event, user_id);
}
Ok(())

9
crates/matrix-sdk-base/src/sliding_sync.rs
View File

@@ -224,6 +224,8 @@ impl BaseClient {
// Rooms in `new_rooms.join` either have a timeline update, or a new read
// receipt. Update the read receipt accordingly.
let user_id = &self.session_meta().expect("logged in user").user_id;
for (room_id, joined_room_update) in &mut new_rooms.join {
if let Some(mut room_info) = changes
.room_infos
@@ -233,11 +235,12 @@ impl BaseClient {
{
// TODO only add the room if there was an update
compute_notifications(
self,
&changes,
user_id,
room_id,
changes.receipts.get(room_id),
previous_events_provider,
&joined_room_update.timeline.events,
&mut room_info,
&mut room_info.read_receipts,
)?;
changes.add_room(room_info);