matrix-sdk-ui 0.19.0

// 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.

use std::{sync::Arc, time::Duration};

use assert_matches2::{assert_let, assert_matches};
use eyeball_im::VectorDiff;
use futures_core::Stream;
use futures_util::{FutureExt as _, StreamExt as _};
use imbl::vector;
use matrix_sdk::assert_next_matches_with_timeout;
use matrix_sdk_base::store::QueueWedgeError;
use matrix_sdk_test::{ALICE, BOB, async_test};
use ruma::{
    EventId, MilliSecondsSinceUnixEpoch, OwnedEventId, event_id,
    events::{AnyMessageLikeEventContent, reaction::ReactionEventContent, relation::Annotation},
    owned_event_id, server_name, uint,
};
use stream_assert::{assert_next_matches, assert_pending};
use tokio::time::timeout;

use crate::timeline::{
    EventSendState, TimelineEventItemId, TimelineItem, event_item::RemoteEventOrigin,
    tests::TestTimeline,
};

const REACTION_KEY: &str = "👍";

/// Assert that we receive an item update for an event at the given item index,
/// for the given event id.
///
/// A macro rather than a function to help lower compile times and get better
/// error locations.
macro_rules! assert_item_update {
    ($stream:expr, $event_id:expr, $index:expr) => {{
        // Expect an event timeline item update, with a short timeout.
        assert_let!(
            Ok(Some(VectorDiff::Set { index: i, value: event })) =
                timeout(Duration::from_secs(1), $stream.next()).await
        );

        // Expect at the right position.
        assert_eq!(i, $index);

        // Expect on the right event.
        let event_item = event.as_event().unwrap();
        assert_eq!(event_item.event_id().unwrap(), $event_id);

        event_item.clone()
    }};
}

/// Checks that the reaction to an event in a timeline item has accordingly
/// updated.
///
/// A macro rather than a function to help lower compile times and get better
/// error locations.
macro_rules! assert_reaction_is_updated {
    ($stream:expr, $event_id:expr, $index:expr, $is_remote_echo:literal) => {{
        let event = assert_item_update!($stream, $event_id, $index);
        let reactions = event.content().reactions().cloned().unwrap_or_default();
        let reactions = reactions.get(&REACTION_KEY.to_owned()).unwrap();
        let reaction = reactions.get(*ALICE).unwrap();
        match &reaction.send_state {
            Some(EventSendState::NotSentYet { .. } | EventSendState::SendingFailed { .. }) => {
                assert!(!$is_remote_echo)
            }
            Some(EventSendState::Sent { .. }) | None => assert!($is_remote_echo),
        };
        event
    }};
}

#[async_test]
async fn test_add_reaction_on_non_existent_event() {
    let timeline = TestTimeline::new().await;
    let mut stream = timeline.subscribe().await;

    let event_id = EventId::parse("$nonexisting_unique_id").unwrap();
    timeline
        .toggle_reaction_local(&TimelineEventItemId::EventId(event_id), REACTION_KEY)
        .await
        .unwrap_err();

    assert!(stream.next().now_or_never().is_none());
}

#[async_test]
async fn test_add_reaction_success() {
    let timeline = TestTimeline::new().await;
    let mut stream = timeline.subscribe().await;
    let (item_id, event_id, item_pos) = send_first_message(&timeline, &mut stream).await;

    // If I toggle a reaction on an event which didn't have any…
    timeline.toggle_reaction_local(&item_id, REACTION_KEY).await.unwrap();

    // The timeline item is updated, with a local echo for the reaction.
    assert_reaction_is_updated!(stream, &event_id, item_pos, false);

    // An event of the right kind is sent over to the server.
    {
        let sent_events = &timeline.data().sent_events.read().await;
        assert_eq!(sent_events.len(), 1);
        assert_matches!(&sent_events[0], AnyMessageLikeEventContent::Reaction(..));
    }

    // When the remote echo is received from sync,
    timeline
        .handle_live_event(timeline.factory.reaction(&event_id, REACTION_KEY).sender(*ALICE))
        .await;

    // The reaction is still present on the item, as a remote echo.
    assert_reaction_is_updated!(stream, &event_id, item_pos, true);

    assert!(stream.next().now_or_never().is_none());
}

#[async_test]
async fn test_add_reaction_with_extra_content() {
    let timeline = TestTimeline::new().await;
    let mut stream = timeline.subscribe().await;
    let (item_id, _event_id, _item_pos) = send_first_message(&timeline, &mut stream).await;

    let mut extra_content = serde_json::Map::new();
    extra_content.insert("com.example.key".to_owned(), "value".into());

    timeline
        .toggle_reaction_local_with_extra_content(&item_id, REACTION_KEY, Some(extra_content))
        .await
        .unwrap();

    // The extra content is forwarded along with the reaction.
    let sent_extra_content = &timeline.data().sent_extra_content.read().await;
    assert_eq!(sent_extra_content.len(), 1);
    assert_let!(Some(extra_content) = &sent_extra_content[0]);
    assert_eq!(extra_content.get("com.example.key").unwrap(), "value");
}

#[async_test]
async fn test_redact_reaction_success() {
    let timeline = TestTimeline::new().await;
    let f = &timeline.factory;

    let mut stream = timeline.subscribe().await;
    let (item_id, event_id, item_pos) = send_first_message(&timeline, &mut stream).await;

    // A reaction is added by sync.
    let reaction_id = event_id!("$reaction_id");
    timeline
        .handle_live_event(f.reaction(&event_id, REACTION_KEY).sender(&ALICE).event_id(reaction_id))
        .await;
    assert_reaction_is_updated!(stream, &event_id, item_pos, true);

    // Toggling the reaction locally…
    timeline.toggle_reaction_local(&item_id, REACTION_KEY).await.unwrap();

    // Will immediately redact it on the item.
    let event = assert_item_update!(stream, &event_id, item_pos);
    assert!(
        event
            .content()
            .reactions()
            .cloned()
            .unwrap_or_default()
            .get(&REACTION_KEY.to_owned())
            .is_none()
    );

    // And send a redaction request for that reaction.
    {
        let redacted_events = &timeline.data().redacted.read().await;
        assert_eq!(redacted_events.len(), 1);
        assert_eq!(&redacted_events[0], reaction_id);
    }

    // When that redaction is confirmed by the server,
    timeline
        .handle_live_event(f.redaction(reaction_id).sender(*ALICE).event_id(event_id!("$idb")))
        .await;

    // Nothing happens, because the reaction was already redacted.
    assert_pending!(stream);
}

#[async_test]
async fn test_reactions_store_timestamp() {
    let timeline = TestTimeline::new().await;
    let mut stream = timeline.subscribe().await;
    let (item_id, event_id, msg_pos) = send_first_message(&timeline, &mut stream).await;

    // Creating a reaction adds a valid timestamp.
    let timestamp_before = MilliSecondsSinceUnixEpoch::now();

    timeline.toggle_reaction_local(&item_id, REACTION_KEY).await.unwrap();

    let event = assert_reaction_is_updated!(stream, &event_id, msg_pos, false);
    let reactions = event.content().reactions().cloned().unwrap_or_default();
    let reactions = reactions.get(&REACTION_KEY.to_owned()).unwrap();
    let timestamp = reactions.values().next().unwrap().timestamp;

    let now = MilliSecondsSinceUnixEpoch::now();
    assert!((timestamp_before..=now).contains(&timestamp));
}

#[async_test]
async fn test_initial_reaction_timestamp_is_stored() {
    let timeline = TestTimeline::new().await;

    let f = &timeline.factory;
    let message_event_id = EventId::new_v1(server_name!("dummy.server"));
    let reaction_timestamp = MilliSecondsSinceUnixEpoch(uint!(39845));

    timeline
        .controller
        .handle_remote_events_with_diffs(
            vec![VectorDiff::Append {
                values: vector![
                    // Reaction comes first.
                    f.reaction(&message_event_id, REACTION_KEY)
                        .sender(*ALICE)
                        .server_ts(reaction_timestamp)
                        .into_event(),
                    // Event comes next.
                    f.text_msg("A").sender(*ALICE).event_id(&message_event_id).into_event(),
                ],
            }],
            RemoteEventOrigin::Sync,
        )
        .await;

    let items = timeline.controller.items().await;
    let reactions = items
        .last()
        .unwrap()
        .as_event()
        .unwrap()
        .content()
        .reactions()
        .cloned()
        .unwrap_or_default();
    let entry = reactions.get(&REACTION_KEY.to_owned()).unwrap();

    assert_eq!(entry.values().next().unwrap().timestamp, reaction_timestamp);
}

/// Returns the unique item id, the event id, and position of the message.
async fn send_first_message(
    timeline: &TestTimeline,
    stream: &mut (impl Stream<Item = VectorDiff<Arc<TimelineItem>>> + Unpin),
) -> (TimelineEventItemId, OwnedEventId, usize) {
    timeline.handle_live_event(timeline.factory.text_msg("I want you to react").sender(&BOB)).await;

    let item = assert_next_matches!(*stream, VectorDiff::PushBack { value } => value);
    let event_item = item.as_event().unwrap();
    let item_id = event_item.identifier();
    let event_id = event_item.event_id().unwrap().to_owned();
    let position = timeline.len().await - 1;

    let date_divider = assert_next_matches!(*stream, VectorDiff::PushFront { value } => value);
    assert!(date_divider.is_date_divider());

    (item_id, event_id, position)
}

#[async_test]
async fn test_reinserted_item_keeps_reactions() {
    // This test checks that after deduplicating events, the reactions attached to
    // the deduplicated event are not lost.
    let timeline = TestTimeline::new().await;
    let f = &timeline.factory;

    // We receive an initial update with one event and a reaction to this event.
    let reaction_target = event_id!("$1");
    let target_event = f.text_msg("hey").sender(&BOB).event_id(reaction_target).into_event();
    let reaction_event = f
        .reaction(reaction_target, REACTION_KEY)
        .sender(&ALICE)
        .event_id(event_id!("$2"))
        .into_event();

    let mut stream = timeline.subscribe_events().await;

    timeline
        .handle_event_update(
            vec![VectorDiff::Append { values: vector![target_event.clone(), reaction_event] }],
            RemoteEventOrigin::Sync,
        )
        .await;

    // Get the event.
    assert_next_matches_with_timeout!(stream, VectorDiff::PushBack { value: item } => {
        assert_eq!(item.content().as_message().unwrap().body(), "hey");
        assert!(item.content().reactions().cloned().unwrap_or_default().is_empty());
    });

    // Get the reaction.
    assert_next_matches_with_timeout!(stream, VectorDiff::Set { index: 0, value: item } => {
        assert_eq!(item.content().as_message().unwrap().body(), "hey");
        let reactions = item.content().reactions().cloned().unwrap_or_default();
        assert_eq!(reactions.len(), 1);
        reactions.get(REACTION_KEY).unwrap().get(*ALICE).unwrap();
    });

    // And that's it for now.
    assert_pending!(stream);

    // Then the event is removed and reinserted. This sequences of update is
    // possible if the event cache decided to deduplicate a given event.
    timeline
        .handle_event_update(
            vec![
                VectorDiff::Remove { index: 0 },
                VectorDiff::Insert { index: 0, value: target_event },
            ],
            RemoteEventOrigin::Sync,
        )
        .await;

    // The duplicate event is removed…
    assert_next_matches_with_timeout!(stream, VectorDiff::Remove { index: 0 });

    // …And reinserted.
    assert_next_matches_with_timeout!(stream, VectorDiff::Insert { index: 0, value: item } => {
        assert_eq!(item.content().as_message().unwrap().body(), "hey");
        // And it still includes the reaction from Alice.
        let reactions = item.content().reactions().cloned().unwrap_or_default();
        assert_eq!(reactions.len(), 1);
        reactions.get(REACTION_KEY).unwrap().get(*ALICE).unwrap();
    });

    // No other updates.
    assert_pending!(stream);
}

#[async_test]
async fn test_local_reaction_send_state_failed_then_sent() {
    let timeline = TestTimeline::new().await;
    let mut stream = timeline.subscribe_events().await;
    let f = &timeline.factory;

    let event_id = owned_event_id!("$1");
    timeline.handle_live_event(f.text_msg("hello").sender(*ALICE).event_id(&event_id)).await;
    assert_next_matches!(stream, VectorDiff::PushBack { .. });

    let txn_id = timeline
        .handle_local_event(
            ReactionEventContent::new(Annotation::new(event_id.clone(), "👍".to_owned())).into(),
        )
        .await;
    let item = assert_next_matches!(stream, VectorDiff::Set { index: 0, value } => value);
    let info = item.content().reactions().unwrap().get("👍").unwrap().get(*ALICE).unwrap();
    assert_matches!(&info.send_state, Some(EventSendState::NotSentYet { .. }));

    let error = Arc::new(matrix_sdk::Error::SendQueueWedgeError(Box::new(
        QueueWedgeError::GenericApiError { msg: "nope".to_owned() },
    )));
    timeline
        .controller
        .update_event_send_state(
            &txn_id,
            EventSendState::SendingFailed { error, is_recoverable: false },
        )
        .await;
    let item = assert_next_matches!(stream, VectorDiff::Set { index: 0, value } => value);
    let info = item.content().reactions().unwrap().get("👍").unwrap().get(*ALICE).unwrap();
    assert_matches!(&info.send_state, Some(EventSendState::SendingFailed { .. }));

    let reaction_id = owned_event_id!("$r");
    timeline
        .controller
        .update_event_send_state(&txn_id, EventSendState::Sent { event_id: reaction_id.clone() })
        .await;
    let item = assert_next_matches!(stream, VectorDiff::Set { index: 0, value } => value);
    let info = item.content().reactions().unwrap().get("👍").unwrap().get(*ALICE).unwrap();
    assert_matches!(&info.send_state, Some(EventSendState::Sent { .. }));

    // Remote echo: nothing pending anymore.
    timeline
        .handle_live_event(f.reaction(&event_id, "👍").sender(*ALICE).event_id(&reaction_id))
        .await;
    let item = assert_next_matches!(stream, VectorDiff::Set { index: 0, value } => value);
    let info = item.content().reactions().unwrap().get("👍").unwrap().get(*ALICE).unwrap();
    assert!(info.send_state.is_none());

    assert_pending!(stream);
}

#[async_test]
async fn test_reaction_remote_echo_before_sent_leaves_no_pending_state() {
    let timeline = TestTimeline::new().await;
    let mut stream = timeline.subscribe_events().await;
    let f = &timeline.factory;

    let event_id = owned_event_id!("$1");
    timeline.handle_live_event(f.text_msg("hello").sender(*ALICE).event_id(&event_id)).await;
    assert_next_matches!(stream, VectorDiff::PushBack { .. });

    let txn_id = timeline
        .handle_local_event(
            ReactionEventContent::new(Annotation::new(event_id.clone(), "👍".to_owned())).into(),
        )
        .await;
    assert_next_matches!(stream, VectorDiff::Set { index: 0, .. });

    // The remote echo arrives before the send queue reports the send.
    let reaction_id = owned_event_id!("$r");
    timeline
        .handle_live_event(f.reaction(&event_id, "👍").sender(*ALICE).event_id(&reaction_id))
        .await;
    let item = assert_next_matches!(stream, VectorDiff::Set { index: 0, value } => value);
    let info = item.content().reactions().unwrap().get("👍").unwrap().get(*ALICE).unwrap();
    assert!(info.send_state.is_none());

    // The late `Sent` must not bring a pending state back.
    timeline
        .controller
        .update_event_send_state(&txn_id, EventSendState::Sent { event_id: reaction_id })
        .await;
    assert_pending!(stream);
}

#[async_test]
async fn test_toggle_reaction_again_after_removing_a_sent_one() {
    let timeline = TestTimeline::new().await;
    let mut stream = timeline.subscribe_events().await;
    let f = &timeline.factory;

    let event_id = owned_event_id!("$1");
    timeline.handle_live_event(f.text_msg("hello").sender(*ALICE).event_id(&event_id)).await;
    let item = assert_next_matches!(stream, VectorDiff::PushBack { value } => value);
    let item_id = item.identifier();

    // React, and let the reaction be sent.
    let txn_id = timeline
        .handle_local_event(
            ReactionEventContent::new(Annotation::new(event_id.clone(), "👍".to_owned())).into(),
        )
        .await;
    assert_next_matches!(stream, VectorDiff::Set { index: 0, .. });
    timeline
        .controller
        .update_event_send_state(&txn_id, EventSendState::Sent { event_id: owned_event_id!("$r") })
        .await;
    assert_next_matches!(stream, VectorDiff::Set { index: 0, .. });

    // Toggling removes it from the item, before any redaction echo comes back.
    timeline.toggle_reaction_local(&item_id, "👍").await.unwrap();
    let item = assert_next_matches!(stream, VectorDiff::Set { index: 0, value } => value);
    assert!(item.content().reactions().unwrap().is_empty());

    // Toggling again must add a new reaction, not try to remove the old one.
    timeline.toggle_reaction_local(&item_id, "👍").await.unwrap();
    let item = assert_next_matches!(stream, VectorDiff::Set { index: 0, value } => value);
    let info = item.content().reactions().unwrap().get("👍").unwrap().get(*ALICE).unwrap();
    assert_matches!(&info.send_state, Some(EventSendState::NotSentYet { .. }));

    assert_pending!(stream);
}