mirror of
https://github.com/matrix-org/matrix-rust-sdk.git
synced 2026-05-07 23:44:53 -04:00
69af5b3c6f
Prior to this patch, when `SlidingSync` was built with a storage key, the storage was read to find a previous `SlidingSync` version that was in a cache. To put a `SlidingSync` instance in the cache, it was serialized to JSON. When one reads from the cache, the value is deserialized. A problem happens when the internal representation of `SlidingSync` and other types (e.g. `SlidingSyncList`) have changed (due to an SDK update for example): Loading a previous state from the cache results in an error. After discussion with the teams, clients don't want to deal with obsolete cache values. In such a scenario, (i) they cannot interact with the cache to remove the obsolete entry, and (ii) their only possibility is to log out and log in the user again. What an unfriendly user experience! This patch modifies this behaviour. When loading a `SlidingSync` type or a `SlidingSyncList` type from the cache, 3 cases are now handled: 1. The cache entry exists and has been successfully deserialized: in this case, we do our business. 2. The cache entry exists, but it wasn't possible to deserialize it: the cache entry is declared as obsolete, and the entire `SlidingSync` cache is cleaned up, so all entries for `SlidingSync` and `SlidingSyncList` are removed from the storage, 3. The cache entry doesn't exist: we do nothing particular. Note that if one cache is obsolete, all cache entries are removed.