Add support for MSC3575: Sliding Sync #2242
Merged
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
Mostly c/p from sync.ts. Define interfaces for MSC3575 sliding sync types. Complete WIP!
Enough to make ele-web actually load okay with 0 rooms.
Still needs some work but it's a start.
…n for list updates. - Have atomic getList/setList operations on SlidingSync to update windows etc - Add a list callback which is invoked with the list indicies and joined count.
dbkr
approved these changes
Mar 16, 2022
This comment was marked as outdated.
This comment was marked as outdated.
kegsay
commented
Jun 17, 2022
| @@ -5888,6 +5899,9 @@ export class MatrixClient extends TypedEventEmitter<EmittedEvents, ClientEventHa | |||
| // There can be only room-kind push rule per room | |||
| // and its id is the room id. | |||
| if (this.pushRules) { | |||
| if (!this.pushRules[scope] || !this.pushRules[scope].room) { | |||
| return; | |||
| } | |||
There was a problem hiding this comment.
Defensive programming when the server returns {}. There's no guarantees that scope will exist.
t3chguy
reviewed
Jul 1, 2022
t3chguy
reviewed
Jul 1, 2022
And ensure all the tests actually test the right things.
t3chguy
approved these changes
Jul 11, 2022
su-ex
added a commit
to SchildiChat/matrix-js-sdk
that referenced
this pull request
Aug 22, 2022
* Remove unstable support for `m.room_key.withheld` ([\matrix-org#2512](matrix-org#2512)). Fixes matrix-org#2233. * Sliding sync: add missing filters from latest MSC ([\matrix-org#2555](matrix-org#2555)). * Use stable prefixes for MSC3827 ([\matrix-org#2537](matrix-org#2537)). * Add support for MSC3575: Sliding Sync ([\matrix-org#2242](matrix-org#2242)). * Correct the units in TURN servers expiry documentation ([\matrix-org#2520](matrix-org#2520)). * Re-insert room IDs when decrypting bundled redaction events returned by `/sync` ([\matrix-org#2531](matrix-org#2531)). Contributed by @duxovni.
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 PR adds API support for Sliding Sync. This is a big change and can be broken down into sliding sync specific changes and general JS SDK changes (which are inherently more risky and needs closer attention).
JS SDK changes:
IRequestOptsinhttp-api.tsnow accepts an optionalbaseUrl. It already accepts aprefixbut that isn't enough for sliding sync because we want to redirect/syncrequests to a different server entirely (the proxy server), hence this was added.slidingSynchas been added as a function toMatrixClient. This function just makes a/syncrequest: it doesn't handle the loop or retries.IStartClientOptsinclient.tsnow accepts an optionalslidingSyncobject, which must be of typeSlidingSync. If this is present, JS SDK operates in Sliding Sync mode.Sliding Sync changes:
sliding-sync.ts: contains the core sliding sync API and event loop handling. Does not handle interactions with JS SDK innards. Exposes an event emitter for sliding sync data.siding-sync-sdk.ts: contains JS SDK <--> sliding sync data mappings. Listens for events emitted bySlidingSync.conn-management.ts: factored out keep-alive code. Same as sync v2 otherwise.Limitations:
sliding-sync-sdk.tsare very bare bones currently - only state/timeline events are handled (not ephemeral/account/to-device/E2EE). This will be expanded upon in the future.Contains integration tests for
SlidingSync. No tests exist yet forSlidingSyncSdk.Here's what your changelog entry will look like:
✨ Features