feat(sdk): Do not send a room subscription that has already been sent #3874
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This patch adds the `commit` method on the `StickyData` trait. It is called by `SlidingSyncStickyManager::maybe_commit` when we are sure the data can be validated because of a valid response to the sent request.
This patch introduces the `RoomSubscriptionState` type, to represent whether a room subscription has already been correctly sent to the server.
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #3874 +/- ##
=======================================
Coverage 84.09% 84.10%
=======================================
Files 261 261
Lines 27656 27669 +13
=======================================
+ Hits 23257 23270 +13
Misses 4399 4399 ☔ View full report in Codecov by Sentry. |
|
Night thought: If sticky parameters are "disabled" (i.e. the server doesn't return the |
This patch uses the new `RoomSubscriptionState` enum to filter room subscriptions that have already been sent, when building a `http::Request` with the sticky parameters. By default, to start, a `http::request::RoomSubscription` is in the state `Pending`, i.e. it's not sent yet. Once the sticky parameters are committed, the state is updated to `Applied`. When the sticky parameters are applied, only the `Pending` room subscriptions are added. This patch contains one test to specifically assert this behaviour.
This patch fixes a test. It now fails, for my own personal joy. The new behaviour is much better.
Hywan
force-pushed
the
fix-sdk-sliding-sync-room-subscriptions-mark-as-sent
branch
from
36640e0 to
4110a1d
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This patch should ideally be reviewed commit-by-commit.
The problem the patch is trying to solve is the following: in sliding sync, for every new room subscriptions, all the previous room subscriptions are part of the request to be send. This is a waste of bandwidth. This patch adds the following feature: when a room subscription has been sent, it won't be part of the next request anymore. All room subscriptions are kept in memory though, but they are marked as
Appliedinstead ofPending(see the newRoomSubscriptionStatetype).