fix!(sdk): Client::sync_once defaults to reuse previous token

Introduces a new `SyncToken` enum for the `SyncSettings::token` field.
The enum has 3 variants: ReusePrevious (default), NoToken, Specific(String).

Some tests were changed to use the old default (NoToken).

Author: dragonfly1033

crates/matrix-sdk-ui/tests/integration/timeline/focus_event.rs

@@ -19,7 +19,10 @@ use std::time::Duration;
 use assert_matches2::assert_let;
 use eyeball_im::VectorDiff;
 use futures_util::StreamExt;
-use matrix_sdk::{config::SyncSettings, test_utils::logged_in_client_with_server};
+use matrix_sdk::{
+    config::{SyncSettings, SyncToken},
+    test_utils::logged_in_client_with_server,
+};
 use matrix_sdk_test::{
     ALICE, BOB, JoinedRoomBuilder, SyncResponseBuilder, async_test, event_factory::EventFactory,
     mocks::mock_encryption_state,
@@ -189,7 +192,8 @@ async fn test_new_focused() {
 async fn test_live_aggregations_are_reflected_on_focused_timelines() {
     let room_id = room_id!("!a98sd12bjh:example.org");
     let (client, server) = logged_in_client_with_server().await;
-    let sync_settings = SyncSettings::new().timeout(Duration::from_millis(3000));
+    let sync_settings =
+        SyncSettings::new().timeout(Duration::from_millis(3000)).token(SyncToken::NoToken);
 
     let mut sync_response_builder = SyncResponseBuilder::new();
     sync_response_builder.add_joined_room(JoinedRoomBuilder::new(room_id));

crates/matrix-sdk-ui/tests/integration/timeline/pagination.rs

@@ -23,7 +23,7 @@ use futures_util::{
 };
 use matrix_sdk::{
     assert_let_timeout,
-    config::SyncSettings,
+    config::{SyncSettings, SyncToken},
     event_cache::RoomPaginationStatus,
     test_utils::{
         logged_in_client_with_server,
@@ -412,7 +412,8 @@ async fn test_wait_for_token() {
     let room_id = room_id!("!a98sd12bjh:example.org");
     let (client, server) = logged_in_client_with_server().await;
 
-    let sync_settings = SyncSettings::new().timeout(Duration::from_millis(3000));
+    let sync_settings =
+        SyncSettings::new().timeout(Duration::from_millis(3000)).token(SyncToken::NoToken);
 
     let f = EventFactory::new();
     let mut sync_builder = SyncResponseBuilder::new();
@@ -535,7 +536,8 @@ async fn test_dedup_pagination() {
 async fn test_timeline_reset_while_paginating() {
     let room_id = room_id!("!a98sd12bjh:example.org");
     let (client, server) = logged_in_client_with_server().await;
-    let sync_settings = SyncSettings::new().timeout(Duration::from_millis(3000));
+    let sync_settings =
+        SyncSettings::new().timeout(Duration::from_millis(3000)).token(SyncToken::NoToken);
 
     let f = EventFactory::new();
     let mut sync_builder = SyncResponseBuilder::new();

crates/matrix-sdk-ui/tests/integration/timeline/profiles.rs

@@ -15,7 +15,10 @@
 use std::{sync::Arc, time::Duration};
 
 use assert_matches::assert_matches;
-use matrix_sdk::{config::SyncSettings, test_utils::logged_in_client_with_server};
+use matrix_sdk::{
+    config::{SyncSettings, SyncToken},
+    test_utils::logged_in_client_with_server,
+};
 use matrix_sdk_common::executor::spawn;
 use matrix_sdk_test::{
     ALICE, BOB, CAROL, DEFAULT_TEST_ROOM_ID, JoinedRoomBuilder, SyncResponseBuilder, async_test,
@@ -34,7 +37,8 @@ use crate::mock_sync;
 #[async_test]
 async fn test_update_sender_profiles() {
     let (client, server) = logged_in_client_with_server().await;
-    let sync_settings = SyncSettings::new().timeout(Duration::from_millis(3000));
+    let sync_settings =
+        SyncSettings::new().timeout(Duration::from_millis(3000)).token(SyncToken::NoToken);
 
     let f = EventFactory::new();
     let mut sync_builder = SyncResponseBuilder::new();

crates/matrix-sdk-ui/tests/integration/timeline/queue.rs

@@ -18,7 +18,11 @@ use assert_matches::assert_matches;
 use assert_matches2::assert_let;
 use eyeball_im::VectorDiff;
 use futures_util::StreamExt;
-use matrix_sdk::{Error, config::SyncSettings, test_utils::logged_in_client_with_server};
+use matrix_sdk::{
+    Error,
+    config::{SyncSettings, SyncToken},
+    test_utils::logged_in_client_with_server,
+};
 use matrix_sdk_base::store::QueueWedgeError;
 use matrix_sdk_test::{
     ALICE, JoinedRoomBuilder, SyncResponseBuilder, async_test, event_factory::EventFactory,
@@ -314,7 +318,8 @@ async fn test_reloaded_failed_local_echoes_are_marked_as_failed() {
 async fn test_clear_with_echoes() {
     let room_id = room_id!("!a98sd12bjh:example.org");
     let (client, server) = logged_in_client_with_server().await;
-    let sync_settings = SyncSettings::new().timeout(Duration::from_millis(3000));
+    let sync_settings =
+        SyncSettings::new().timeout(Duration::from_millis(3000)).token(SyncToken::NoToken);
 
     let f = EventFactory::new();
     let mut sync_builder = SyncResponseBuilder::new();
@@ -403,7 +408,8 @@ async fn test_clear_with_echoes() {
 async fn test_no_duplicate_date_divider() {
     let room_id = room_id!("!a98sd12bjh:example.org");
     let (client, server) = logged_in_client_with_server().await;
-    let sync_settings = SyncSettings::new().timeout(Duration::from_millis(3000));
+    let sync_settings =
+        SyncSettings::new().timeout(Duration::from_millis(3000)).token(SyncToken::NoToken);
 
     let mut sync_response_builder = SyncResponseBuilder::new();
     sync_response_builder.add_joined_room(JoinedRoomBuilder::new(room_id));

crates/matrix-sdk-ui/tests/integration/timeline/subscribe.rs

@@ -18,7 +18,10 @@ use assert_matches::assert_matches;
 use assert_matches2::assert_let;
 use eyeball_im::VectorDiff;
 use futures_util::StreamExt;
-use matrix_sdk::{config::SyncSettings, test_utils::logged_in_client_with_server};
+use matrix_sdk::{
+    config::{SyncSettings, SyncToken},
+    test_utils::logged_in_client_with_server,
+};
 use matrix_sdk_common::executor::spawn;
 use matrix_sdk_test::{
     ALICE, BOB, GlobalAccountDataTestEvent, JoinedRoomBuilder, SyncResponseBuilder, async_test,
@@ -42,7 +45,8 @@ use crate::mock_sync;
 async fn test_batched() {
     let room_id = room_id!("!a98sd12bjh:example.org");
     let (client, server) = logged_in_client_with_server().await;
-    let sync_settings = SyncSettings::new().timeout(Duration::from_millis(3000));
+    let sync_settings =
+        SyncSettings::new().timeout(Duration::from_millis(3000)).token(SyncToken::NoToken);
 
     let f = EventFactory::new();
     let mut sync_builder = SyncResponseBuilder::new();
@@ -84,7 +88,8 @@ async fn test_batched() {
 async fn test_event_filter() {
     let room_id = room_id!("!a98sd12bjh:example.org");
     let (client, server) = logged_in_client_with_server().await;
-    let sync_settings = SyncSettings::new().timeout(Duration::from_millis(3000));
+    let sync_settings =
+        SyncSettings::new().timeout(Duration::from_millis(3000)).token(SyncToken::NoToken);
     let f = EventFactory::new();
 
     let mut sync_builder = SyncResponseBuilder::new();
@@ -174,7 +179,8 @@ async fn test_event_filter() {
 async fn test_timeline_is_reset_when_a_user_is_ignored_or_unignored() {
     let room_id = room_id!("!a98sd12bjh:example.org");
     let (client, server) = logged_in_client_with_server().await;
-    let sync_settings = SyncSettings::new().timeout(Duration::from_millis(3000));
+    let sync_settings =
+        SyncSettings::new().timeout(Duration::from_millis(3000)).token(SyncToken::NoToken);
 
     let mut sync_builder = SyncResponseBuilder::new();
     sync_builder.add_joined_room(JoinedRoomBuilder::new(room_id));
@@ -289,7 +295,8 @@ async fn test_timeline_is_reset_when_a_user_is_ignored_or_unignored() {
 async fn test_profile_updates() {
     let room_id = room_id!("!a98sd12bjh:example.org");
     let (client, server) = logged_in_client_with_server().await;
-    let sync_settings = SyncSettings::new().timeout(Duration::from_millis(3000));
+    let sync_settings =
+        SyncSettings::new().timeout(Duration::from_millis(3000)).token(SyncToken::NoToken);
     let f = EventFactory::new();
 
     let mut sync_builder = SyncResponseBuilder::new();

crates/matrix-sdk/CHANGELOG.md

@@ -38,6 +38,8 @@ All notable changes to this project will be documented in this file.
 
 ### Refactor
 
+- [**breaking**] `SyncSettings` token is now `SyncToken` enum type which has default behaviour of `SyncToken::ReusePrevious` token. This breaks `Client::sync_once`.
+  For old behaviour, set the token to `SyncToken::NoToken` with the usual `SyncSettings::token` setter.
 - [**breaking**] Change the upload_encrypted_file and make it clone the client instead of owning it. The lifetime of the `UploadEncryptedFile` request returned by `Client::upload_encrypted_file()` only depends on the request lifetime now.
 - [**breaking**] Add an `IsPrefix = False` bound to the `account_data()` and
   `fetch_account_data_static()` methods of `Account`. These methods only worked

crates/matrix-sdk/src/client/mod.rs

@@ -85,7 +85,7 @@ use crate::{
         matrix::MatrixAuth, oauth::OAuth, AuthCtx, AuthData, ReloadSessionCallback,
         SaveSessionCallback,
     },
-    config::RequestConfig,
+    config::{RequestConfig, SyncToken},
     deduplicating_handler::DeduplicatingHandler,
     error::HttpResult,
     event_cache::EventCache,
@@ -2349,9 +2349,15 @@ impl Client {
             error!(error = ?e, "Error while sending outgoing E2EE requests");
         }
 
+        let token = match sync_settings.token {
+            SyncToken::Specific(token) => Some(token),
+            SyncToken::NoToken => None,
+            SyncToken::ReusePrevious => self.sync_token().await,
+        };
+
         let request = assign!(sync_events::v3::Request::new(), {
             filter: sync_settings.filter.map(|f| *f),
-            since: sync_settings.token,
+            since: token,
             full_state: sync_settings.full_state,
             set_presence: sync_settings.set_presence,
             timeout: sync_settings.timeout,
@@ -2649,10 +2655,6 @@ impl Client {
         let mut timeout = None;
         let mut last_sync_time: Option<Instant> = None;
 
-        if sync_settings.token.is_none() {
-            sync_settings.token = self.sync_token().await;
-        }
-
         let parent_span = Span::current();
 
         async_stream::stream!({

crates/matrix-sdk/src/config/mod.rs

@@ -19,4 +19,4 @@ mod sync;
 
 pub use matrix_sdk_base::store::StoreConfig;
 pub use request::RequestConfig;
-pub use sync::SyncSettings;
+pub use sync::{SyncSettings, SyncToken};

crates/matrix-sdk/src/config/sync.rs

@@ -19,14 +19,48 @@ use ruma::{api::client::sync::sync_events, presence::PresenceState};
 
 const DEFAULT_SYNC_TIMEOUT: Duration = Duration::from_secs(30);
 
+/// Token to be used in the next sync request.
+#[derive(Clone, Default, Debug)]
+pub enum SyncToken {
+    /// Provide a specific token.
+    Specific(String),
+    /// Enforce no tokens at all.
+    NoToken,
+    /// Use a previous token if the client saw one in the past, and none
+    /// otherwise.
+    ///
+    /// This is the default value.
+    #[default]
+    ReusePrevious,
+}
+
+impl<T> From<T> for SyncToken
+where
+    T: Into<String>,
+{
+    fn from(token: T) -> SyncToken {
+        SyncToken::Specific(token.into())
+    }
+}
+
+impl SyncToken {
+    /// Convert a token that may exist into a [`SyncToken`]
+    pub fn from_optional_token(maybe_token: Option<String>) -> SyncToken {
+        match maybe_token {
+            Some(token) => SyncToken::Specific(token),
+            None => SyncToken::default(),
+        }
+    }
+}
+
 /// Settings for a sync call.
 #[derive(Clone)]
 pub struct SyncSettings {
     // Filter is pretty big at 1000 bytes, box it to reduce stack size
     pub(crate) filter: Option<Box<sync_events::v3::Filter>>,
     pub(crate) timeout: Option<Duration>,
     pub(crate) ignore_timeout_on_first_sync: bool,
-    pub(crate) token: Option<String>,
+    pub(crate) token: SyncToken,
     pub(crate) full_state: bool,
     pub(crate) set_presence: PresenceState,
 }
@@ -66,7 +100,7 @@ impl SyncSettings {
             filter: None,
             timeout: Some(DEFAULT_SYNC_TIMEOUT),
             ignore_timeout_on_first_sync: false,
-            token: None,
+            token: SyncToken::default(),
             full_state: false,
             set_presence: PresenceState::Online,
         }
@@ -78,8 +112,8 @@ impl SyncSettings {
     ///
     /// * `token` - The sync token that should be used for the sync call.
     #[must_use]
-    pub fn token(mut self, token: impl Into<String>) -> Self {
-        self.token = Some(token.into());
+    pub fn token(mut self, token: impl Into<SyncToken>) -> Self {
+        self.token = token.into();
         self
     }
 

crates/matrix-sdk/src/sync.rs

@@ -315,7 +315,7 @@ impl Client {
 
         match response {
             Ok(r) => {
-                sync_settings.token = Some(r.next_batch.clone());
+                sync_settings.token = r.next_batch.clone().into();
                 Ok(r)
             }
             Err(e) => {