mirror/matrix-rust-sdk
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-rust-sdk.git synced 2026-05-03 21:45:51 -04:00
Code Issues Packages Projects Releases Wiki Activity

feat(sdk): SlidingSync is able to ignore some errors.

Browse Source 
All errors inside `SlidingSync` are stopping the sync-loop, and errors
are returned to the caller. However, in some situation, some errors
should be ignored, i.e. they should not stop the sync-loop and they
should not be returned to the caller: the sync-loop just continues to
run. This patch does that for `Error::ResponseAlreadyReceived`. More
errors will come.

Why is it annoying? When `matrix_sdk_ui::SyncService` sees an error,
it stops all the sync-loops (`RoomListService`, `EncryptionSync`…) and
restarts them properly. In the case of `Error::ResponseAlreadyReceived`,
this is a waste of time and resources. This error is an error from the
`SlidingSync` point of view, but _not_ from the caller point of view.
This commit is contained in:
Ivan Enderlin
2023-08-17 15:35:51 +02:00
parent 932b9dee6b
commit d4cbcd397d
1 changed files with 12 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
crates/matrix-sdk/src/sliding_sync/mod.rs
View File

@@ -717,6 +717,12 @@ impl SlidingSync {
yield Ok(updates); yield Ok(updates);
} }
// Here, errors we can safely ignore.
Err(crate::Error::SlidingSync(Error::ResponseAlreadyReceived { .. })) => {
continue;
}
// Here, errors we **cannot** ignore, and that must stop the sync-loop.
Err(error) => { Err(error) => {
if error.client_api_error_kind() == Some(&ErrorKind::UnknownPos) { if error.client_api_error_kind() == Some(&ErrorKind::UnknownPos) {
// The Sliding Sync session has expired. Let's reset `pos` and sticky parameters. // The Sliding Sync session has expired. Let's reset `pos` and sticky parameters.
@@ -1494,7 +1500,8 @@ mod tests {
// Next request isn't successful because it receives an already // Next request isn't successful because it receives an already
// received `pos` from the server. // received `pos` from the server.
{ {
let _mock_guard = Mock::given(SlidingSyncMatcher) // First response with an already seen `pos`.
let _mock_guard1 = Mock::given(SlidingSyncMatcher)
.respond_with(|request: &Request| { .respond_with(|request: &Request| {
// Repeat the txn_id in the response, if set. // Repeat the txn_id in the response, if set.
let request: PartialRequest = request.body_json().unwrap(); let request: PartialRequest = request.body_json().unwrap();
@@ -1504,44 +1511,19 @@ mod tests {
"pos": "0", // <- already received! "pos": "0", // <- already received!
})) }))
}) })
.up_to_n_times(1) // run this mock only once.
.mount_as_scoped(&server) .mount_as_scoped(&server)
.await; .await;
let next = sync.next().await; // Second response with a new `pos`.
assert_matches!( let _mock_guard2 = Mock::given(SlidingSyncMatcher)
next,
Some(Err(crate::Error::SlidingSync(Error::ResponseAlreadyReceived { pos }))) => {
assert_eq!(pos, Some("0".to_owned()));
}
);
// `sync` has been stopped.
assert!(sync.next().await.is_none());
// `pos` has not been updated.
assert_eq!(sliding_sync.inner.position.lock().await.pos, Some("1".to_owned()));
// `past_positions` has not been updated.
let past_positions = sliding_sync.inner.past_positions.read().unwrap();
assert_eq!(past_positions.len(), 2);
assert_eq!(past_positions.get(0).unwrap().pos, Some("0".to_owned()));
assert_eq!(past_positions.get(1).unwrap().pos, Some("1".to_owned()));
}
// Restart the sync.
let sync = sliding_sync.sync();
pin_mut!(sync);
// Next request is successful.
{
let _mock_guard = Mock::given(SlidingSyncMatcher)
.respond_with(|request: &Request| { .respond_with(|request: &Request| {
// Repeat the txn_id in the response, if set. // Repeat the txn_id in the response, if set.
let request: PartialRequest = request.body_json().unwrap(); let request: PartialRequest = request.body_json().unwrap();
ResponseTemplate::new(200).set_body_json(json!({ ResponseTemplate::new(200).set_body_json(json!({
"txn_id": request.txn_id, "txn_id": request.txn_id,
"pos": "2", "pos": "2", // <- new!
})) }))
}) })
.mount_as_scoped(&server) .mount_as_scoped(&server)