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
// 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 that specific language governing permissions and
// limitations under the License.
//! States and actions for the `RoomList` state machine.
use std::future::ready;
use matrix_sdk::{sliding_sync::Range, SlidingSync, SlidingSyncMode};
use super::Error;
pub const ALL_ROOMS_LIST_NAME: &str = "all_rooms";
/// The state of the [`super::RoomList`]' state machine.
#[derive(Clone, Debug, PartialEq)]
pub enum State {
/// That's the first initial state.
Init,
/// At this state, the first rooms have been synced.
SettingUp,
/// At this state, the system is recovering from `Error` or `Terminated`.
/// It's similar to `SettingUp` but some lists may already exist, actions
/// are then slightly different.
Recovering,
/// At this state, all rooms are syncing.
Running,
/// At this state, the sync has been stopped because an error happened.
Error { from: Box<State> },
/// At this state, the sync has been stopped because it was requested.
Terminated { from: Box<State> },
}
impl State {
/// Transition to the next state, and execute the associated transition's
/// [`Actions`].
pub(super) async fn next(&self, sliding_sync: &SlidingSync) -> Result<Self, Error> {
use State::*;
let next_state = match self {
Init => SettingUp,
SettingUp | Recovering => {
set_all_rooms_to_growing_sync_mode(sliding_sync).await?;
Running
}
Running => Running,
Error { from: previous_state } | Terminated { from: previous_state } => {
match previous_state.as_ref() {
// Unreachable state.
Error { .. } | Terminated { .. } => {
unreachable!(
"It's impossible to reach `Error` or `Terminated` from `Error` or `Terminated`"
);
}
// If the previous state was `Running`, we enter the `Recovering` state.
Running => {
set_all_rooms_to_selective_sync_mode(sliding_sync).await?;
Recovering
}
// Jump back to the previous state that led to this termination.
state => state.to_owned(),
}
}
};
Ok(next_state)
}
}
async fn set_all_rooms_to_growing_sync_mode(sliding_sync: &SlidingSync) -> Result<(), Error> {
sliding_sync
.on_list(ALL_ROOMS_LIST_NAME, |list| {
list.set_sync_mode(SlidingSyncMode::new_growing(ALL_ROOMS_DEFAULT_GROWING_BATCH_SIZE));
ready(())
})
.await
.ok_or_else(|| Error::UnknownList(ALL_ROOMS_LIST_NAME.to_owned()))
}
async fn set_all_rooms_to_selective_sync_mode(sliding_sync: &SlidingSync) -> Result<(), Error> {
sliding_sync
.on_list(ALL_ROOMS_LIST_NAME, |list| {
list.set_sync_mode(
SlidingSyncMode::new_selective().add_range(ALL_ROOMS_DEFAULT_SELECTIVE_RANGE),
);
ready(())
})
.await
.ok_or_else(|| Error::UnknownList(ALL_ROOMS_LIST_NAME.to_owned()))
}
/// Default `batch_size` for the selective sync-mode of the
/// `ALL_ROOMS_LIST_NAME` list.
pub const ALL_ROOMS_DEFAULT_SELECTIVE_RANGE: Range = 0..=19;
/// Default `batch_size` for the growing sync-mode of the `ALL_ROOMS_LIST_NAME`
/// list.
pub const ALL_ROOMS_DEFAULT_GROWING_BATCH_SIZE: u32 = 100;
#[cfg(test)]
mod tests {
use matrix_sdk_test::async_test;
use super::{super::tests::new_room_list, *};
#[async_test]
async fn test_states() -> Result<(), Error> {
let room_list = new_room_list().await?;
let sliding_sync = room_list.sliding_sync();
// First state.
let state = State::Init;
// Hypothetical error.
{
let state = State::Error { from: Box::new(state.clone()) }.next(sliding_sync).await?;
// Back to the previous state.
assert_eq!(state, State::Init);
}
// Hypothetical termination.
{
let state =
State::Terminated { from: Box::new(state.clone()) }.next(sliding_sync).await?;
// Back to the previous state.
assert_eq!(state, State::Init);
}
// Next state.
let state = state.next(sliding_sync).await?;
assert_eq!(state, State::SettingUp);
// Hypothetical error.
{
let state = State::Error { from: Box::new(state.clone()) }.next(sliding_sync).await?;
// Back to the previous state.
assert_eq!(state, State::SettingUp);
}
// Hypothetical termination.
{
let state =
State::Terminated { from: Box::new(state.clone()) }.next(sliding_sync).await?;
// Back to the previous state.
assert_eq!(state, State::SettingUp);
}
// Next state.
let state = state.next(sliding_sync).await?;
assert_eq!(state, State::Running);
// Hypothetical error.
{
let state = State::Error { from: Box::new(state.clone()) }.next(sliding_sync).await?;
// Jump to the **recovering** state!
assert_eq!(state, State::Recovering);
let state = state.next(sliding_sync).await?;
// Now, back to the previous state.
assert_eq!(state, State::Running);
}
// Hypothetical termination.
{
let state =
State::Terminated { from: Box::new(state.clone()) }.next(sliding_sync).await?;
// Jump to the **recovering** state!
assert_eq!(state, State::Recovering);
let state = state.next(sliding_sync).await?;
// Now, back to the previous state.
assert_eq!(state, State::Running);
}
// Hypothetical error when recovering.
{
let state =
State::Error { from: Box::new(State::Recovering) }.next(sliding_sync).await?;
// Back to the previous state.
assert_eq!(state, State::Recovering);
}
// Hypothetical termination when recovering.
{
let state =
State::Terminated { from: Box::new(State::Recovering) }.next(sliding_sync).await?;
// Back to the previous state.
assert_eq!(state, State::Recovering);
}
Ok(())
}
#[async_test]
async fn test_action_set_all_rooms_list_to_growing_and_selective_sync_mode() -> Result<(), Error>
{
let room_list = new_room_list().await?;
let sliding_sync = room_list.sliding_sync();
// List is present, in Selective mode.
assert_eq!(
sliding_sync
.on_list(ALL_ROOMS_LIST_NAME, |list| ready(matches!(
list.sync_mode(),
SlidingSyncMode::Selective { ranges } if ranges == vec![ALL_ROOMS_DEFAULT_SELECTIVE_RANGE]
)))
.await,
Some(true)
);
// Run the action!
set_all_rooms_to_growing_sync_mode(sliding_sync).await.unwrap();
// List is still present, in Growing mode.
assert_eq!(
sliding_sync
.on_list(ALL_ROOMS_LIST_NAME, |list| ready(matches!(
list.sync_mode(),
SlidingSyncMode::Growing {
batch_size, ..
} if batch_size == ALL_ROOMS_DEFAULT_GROWING_BATCH_SIZE
)))
.await,
Some(true)
);
// Run the other action!
set_all_rooms_to_selective_sync_mode(sliding_sync).await.unwrap();
// List is still present, in Selective mode.
assert_eq!(
sliding_sync
.on_list(ALL_ROOMS_LIST_NAME, |list| ready(matches!(
list.sync_mode(),
SlidingSyncMode::Selective { ranges } if ranges == vec![ALL_ROOMS_DEFAULT_SELECTIVE_RANGE]
)))
.await,
Some(true)
);
Ok(())
}
}