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
// Copyright 2024 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 matrix_sdk::{Client, RoomListEntry};
use matrix_sdk_base::read_receipts::RoomReadReceipts;

use super::Filter;

type IsMarkedUnread = bool;

struct UnreadRoomMatcher<F>
where
    F: Fn(&RoomListEntry) -> Option<(RoomReadReceipts, IsMarkedUnread)>,
{
    read_receipts_and_unread: F,
}

impl<F> UnreadRoomMatcher<F>
where
    F: Fn(&RoomListEntry) -> Option<(RoomReadReceipts, IsMarkedUnread)>,
{
    fn matches(&self, room_list_entry: &RoomListEntry) -> bool {
        if !matches!(room_list_entry, RoomListEntry::Filled(_) | RoomListEntry::Invalidated(_)) {
            return false;
        }

        let Some((read_receipts, is_marked_unread)) =
            (self.read_receipts_and_unread)(room_list_entry)
        else {
            return false;
        };

        read_receipts.num_notifications > 0 || is_marked_unread
    }
}

/// Create a new filter that will accept all filled or invalidated entries, but
/// filters out rooms that have no unread notifications (different from unread
/// messages), or is not marked as unread.
pub fn new_filter(client: &Client) -> impl Filter {
    let client = client.clone();

    let matcher = UnreadRoomMatcher {
        read_receipts_and_unread: move |room| {
            let room_id = room.as_room_id()?;
            let room = client.get_room(room_id)?;

            Some((room.read_receipts(), room.is_marked_unread()))
        },
    };

    move |room_list_entry| -> bool { matcher.matches(room_list_entry) }
}

#[cfg(test)]
mod tests {
    use std::ops::Not;

    use matrix_sdk::RoomListEntry;
    use matrix_sdk_base::read_receipts::RoomReadReceipts;
    use ruma::room_id;

    use super::UnreadRoomMatcher;

    #[test]
    fn test_has_unread_notifications() {
        for is_marked_as_unread in [true, false] {
            let matcher = UnreadRoomMatcher {
                read_receipts_and_unread: |_| {
                    let mut read_receipts = RoomReadReceipts::default();
                    read_receipts.num_unread = 42;
                    read_receipts.num_notifications = 42;

                    Some((read_receipts, is_marked_as_unread))
                },
            };

            assert!(matcher.matches(&RoomListEntry::Empty).not());
            assert!(matcher.matches(&RoomListEntry::Filled(room_id!("!r0:bar.org").to_owned())));
            assert!(
                matcher.matches(&RoomListEntry::Invalidated(room_id!("!r0:bar.org").to_owned()))
            );
        }
    }

    #[test]
    fn test_has_unread_messages_but_no_unread_notifications_and_is_not_marked_as_unread() {
        let matcher = UnreadRoomMatcher {
            read_receipts_and_unread: |_| {
                let mut read_receipts = RoomReadReceipts::default();
                read_receipts.num_unread = 42;
                read_receipts.num_notifications = 0;

                Some((read_receipts, false))
            },
        };

        assert!(matcher.matches(&RoomListEntry::Empty).not());
        assert!(matcher.matches(&RoomListEntry::Filled(room_id!("!r0:bar.org").to_owned())).not());
        assert!(matcher
            .matches(&RoomListEntry::Invalidated(room_id!("!r0:bar.org").to_owned()))
            .not());
    }

    #[test]
    fn test_has_unread_messages_but_no_unread_notifications_and_is_marked_as_unread() {
        let matcher = UnreadRoomMatcher {
            read_receipts_and_unread: |_| {
                let mut read_receipts = RoomReadReceipts::default();
                read_receipts.num_unread = 42;
                read_receipts.num_notifications = 0;

                Some((read_receipts, true))
            },
        };

        assert!(matcher.matches(&RoomListEntry::Empty).not());
        assert!(matcher.matches(&RoomListEntry::Filled(room_id!("!r0:bar.org").to_owned())));
        assert!(matcher.matches(&RoomListEntry::Invalidated(room_id!("!r0:bar.org").to_owned())));
    }

    #[test]
    fn test_has_no_unread_notifications_and_is_not_marked_as_unread() {
        let matcher = UnreadRoomMatcher {
            read_receipts_and_unread: |_| Some((RoomReadReceipts::default(), false)),
        };

        assert!(matcher.matches(&RoomListEntry::Empty).not());
        assert!(matcher.matches(&RoomListEntry::Filled(room_id!("!r0:bar.org").to_owned())).not());
        assert!(matcher
            .matches(&RoomListEntry::Invalidated(room_id!("!r0:bar.org").to_owned()))
            .not());
    }

    #[test]
    fn test_has_no_unread_notifications_and_is_marked_as_unread() {
        let matcher = UnreadRoomMatcher {
            read_receipts_and_unread: |_| Some((RoomReadReceipts::default(), true)),
        };

        assert!(matcher.matches(&RoomListEntry::Empty).not());
        assert!(matcher.matches(&RoomListEntry::Filled(room_id!("!r0:bar.org").to_owned())));
        assert!(matcher.matches(&RoomListEntry::Invalidated(room_id!("!r0:bar.org").to_owned())));
    }

    #[test]
    fn test_read_receipts_cannot_be_found() {
        let matcher = UnreadRoomMatcher { read_receipts_and_unread: |_| None };

        assert!(matcher.matches(&RoomListEntry::Empty).not());
        assert!(matcher.matches(&RoomListEntry::Filled(room_id!("!r0:bar.org").to_owned())).not());
        assert!(matcher
            .matches(&RoomListEntry::Invalidated(room_id!("!r0:bar.org").to_owned()))
            .not());
    }
}