Skip to content
This repository has been archived by the owner on Sep 11, 2024. It is now read-only.

MSC3575 (Sliding Sync) add well-known proxy support #12307

Merged
merged 108 commits into from
Apr 30, 2024
Merged

MSC3575 (Sliding Sync) add well-known proxy support #12307

merged 108 commits into from
Apr 30, 2024

Conversation

EdGeraghty
Copy link
Contributor

@EdGeraghty EdGeraghty commented Mar 4, 2024 •
edited
Loading

Adds MSC3575 (Sliding Sync) proxy support from well-known. Removes the ability for adding custom sliding sync servers through Labs.

Signed-off-by: Ed Geraghty [email protected]

@EdGeraghty EdGeraghty requested a review from a team as a code owner March 4, 2024 19:52
@github-actions github-actions bot added the Z-Community-PR Issue is solved by a community member's PR label Mar 4, 2024
@EdGeraghty EdGeraghty mentioned this pull request Mar 4, 2024
Open
4 tasks
@t3chguy t3chguy added the T-Enhancement New features, changes in functionality, performance boosts, user-facing improvements label Mar 5, 2024
t3chguy
t3chguy suggested changes Mar 5, 2024
View reviewed changes
Copy link
Member

@t3chguy t3chguy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems like it wouldn't work if the value in the well-known was to be updated, as it would only ever be fetched when you enable Sliding Sync and you would not be able to update it AFAICT. This seems like a problem

src/components/views/dialogs/SlidingSyncOptionsDialog.tsx Outdated Show resolved Hide resolved
src/components/views/dialogs/SlidingSyncOptionsDialog.tsx Outdated Show resolved Hide resolved
@EdGeraghty EdGeraghty changed the title MSC3575 (Sliding Sync) "native" (proxy) support MSC3575 (Sliding Sync) add proxy support Mar 5, 2024
@EdGeraghty EdGeraghty marked this pull request as draft March 5, 2024 20:03
@EdGeraghty
Copy link
Contributor Author

This seems like it wouldn't work if the value in the well-known was to be updated, as it would only ever be fetched when you enable Sliding Sync and you would not be able to update it AFAICT. This seems like a problem

Yes. Perhaps adding a setting that it's a proxy and needs to get the client well-known on launch?

@t3chguy
Copy link
Member

t3chguy commented Mar 6, 2024

Yes. Perhaps adding a setting that it's a proxy and needs to get the client well-known on launch?

Yeah this would be a better option, happy for the proxy & "native" support to be removed in favour of the well-known check

@EdGeraghty
Copy link
Contributor Author

EdGeraghty commented Mar 8, 2024 •
edited
Loading

Yes. Perhaps adding a setting that it's a proxy and needs to get the client well-known on launch?

Yeah this would be a better option, happy for the proxy & "native" support to be removed in favour of the well-known check

So should I do away with the dialog altogether, allowing it to be enabled from labs iff ( proxySlidingSyncSupportCheck() || nativeSlidingSyncSupportCheck() ) && slidingSyncHealthCheck()?

I guess I could then add two settings at device level, slidingSyncEnabled and isProxy or similar so it knows whether to do the well-known check on start?

ETA:

Perhaps just set whether or not sliding sync has been enabled, then on open (if there isn't already a proxy url set) have a fail-through from "native" support on the unstable endpoint to a well-known check for the proxy? 🤔

I don't really know how all this stuff is handled in the views and dialogs...

ETA2: Thanks to feedback in the relevant matrix #, I'll:

  1. check if the labs flag is enabled; if not bail: no sliding sync
  2. check if the labs flag proxy url is set; if so: use sliding sync with that proxy url
  3. check if the well-known contains a proxy url; if so: use sliding sync with that proxy url
  4. fallback to "native" mode

Falling back in this order means that people with "native" support provided by their homeserver can still choose to use a proxy url...

@EdGeraghty
Initial commit
9d73b7c 
Signed-off-by: Ed Geraghty <[email protected]>
@EdGeraghty
Remove commented code
876f59c 
Signed-off-by: Ed Geraghty <[email protected]>
@EdGeraghty
Change function to reflect it's proxy not native support
c65b22b 
Signed-off-by: Ed Geraghty <[email protected]>
@EdGeraghty
Re-add check for servers with native support
e99ef75 
Signed-off-by: Ed Geraghty <[email protected]>
@EdGeraghty
Add native support check back in
6adac18 
Signed-off-by: Ed Geraghty <[email protected]>
@EdGeraghty
Re-add endpoint health check function
065e255 
Signed-off-by: Ed Geraghty <[email protected]>
@EdGeraghty
Use inbuilt getWellKnown function
1345379 
Signed-off-by: Ed Geraghty <[email protected]>
@EdGeraghty
Change the error message to the correct function
7736582 
Signed-off-by: Ed Geraghty <[email protected]>
@EdGeraghty
Stop storing the proxyurl in the settings for now
4f2c1f2 
Signed-off-by: Ed Geraghty <[email protected]>
@EdGeraghty
Make the logger messages more useful
cb78747 
Signed-off-by: Ed Geraghty <[email protected]>
@EdGeraghty
Merge branch 'edg/msc3575-native-support' of github.com:EdGeraghty/ma…
27830f8 
…trix-react-sdk into edg/msc3575-native-support
@EdGeraghty
Copy link
Contributor Author

🎉

t3chguy
t3chguy approved these changes Apr 30, 2024
View reviewed changes
Copy link
Member

@t3chguy t3chguy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM otherwise, thanks for persevering!!

src/SlidingSyncManager.ts Outdated Show resolved Hide resolved
@t3chguy
Copy link
Member

t3chguy commented Apr 30, 2024

Needs sign-off as per https://github.com/element-hq/element-web/blob/develop/CONTRIBUTING.md#sign-off

@t3chguy t3chguy enabled auto-merge April 30, 2024 17:51
@t3chguy t3chguy added this pull request to the merge queue Apr 30, 2024
Merged via the queue into matrix-org:develop with commit bb4f575 Apr 30, 2024
27 checks passed
@EdGeraghty EdGeraghty deleted the edg/msc3575-native-support branch April 30, 2024 18:35
richvdh
richvdh reviewed May 2, 2024
View reviewed changes
src/SlidingSyncManager.ts
Comment on lines +381 to +384
await client.http.authedRequest<void>(Method.Post, "/sync", undefined, undefined, {
localTimeoutMs: 10 * 1000, // 10s
prefix: "/_matrix/client/unstable/org.matrix.msc3575",
});
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is unsafe. It will cause the Sliding Sync proxy to start polling with our access token, which means that the SS proxy will receive our to-device messages, causing decryption errors.

@richvdh richvdh mentioned this pull request May 2, 2024
Closed
richvdh added a commit that referenced this pull request May 2, 2024
@richvdh
Revert "MSC3575 (Sliding Sync) add well-known proxy support (#12307)"
166ec7b 
This reverts commit bb4f575.
@richvdh richvdh mentioned this pull request May 2, 2024
Closed
@t3chguy t3chguy mentioned this pull request May 14, 2024
Merged
@EdGeraghty EdGeraghty mentioned this pull request May 26, 2024
Open
@MichaelSasser MichaelSasser mentioned this pull request Jun 27, 2024
Closed
netbsd-srcmastr pushed a commit to NetBSD/pkgsrc that referenced this pull request Jul 6, 2024
@Midar
Update devel/element-web to 1.11.69
aece2de 
Changes in [1.11.69](https://github.com/element-hq/element-web/releases/tag/v1.11.69) (2024-06-18)
==================================================================================================
## ✨ Features

* Change avatar setting component to use a menu ([#12585](matrix-org/matrix-react-sdk#12585)). Contributed by @dbkr.
* New user profile UI in User Settings ([#12548](matrix-org/matrix-react-sdk#12548)). Contributed by @dbkr.
* MSC4108 support OIDC QR code login ([#12370](matrix-org/matrix-react-sdk#12370)). Contributed by @t3chguy.

## 🐛 Bug Fixes

* Fix image upload preview size ([#12612](matrix-org/matrix-react-sdk#12612)). Contributed by @RiotRobot.
* Fix screen sharing in recent Chrome (matrix-org/matrix-js-sdk#4243).
* Fix roving tab index crash `compareDocumentPosition` ([#12594](matrix-org/matrix-react-sdk#12594)). Contributed by @t3chguy.
* Keep dialog glass border on narrow screens ([#12591](matrix-org/matrix-react-sdk#12591)). Contributed by @dbkr.
* Add missing a11y label to dismiss onboarding button in room list ([#12587](matrix-org/matrix-react-sdk#12587)). Contributed by @t3chguy.
* Add hover / active state on avatar setting upload button ([#12590](matrix-org/matrix-react-sdk#12590)). Contributed by @dbkr.
* Fix EditInPlace button styles ([#12589](matrix-org/matrix-react-sdk#12589)). Contributed by @dbkr.
* Fix incorrect assumptions about required fields in /search response ([#12575](matrix-org/matrix-react-sdk#12575)). Contributed by @t3chguy.
* Fix display of no avatar in avatar setting controls ([#12558](matrix-org/matrix-react-sdk#12558)). Contributed by @dbkr.
* Element-R: pass pickleKey in as raw key for indexeddb encryption ([#12543](matrix-org/matrix-react-sdk#12543)). Contributed by @richvdh.



Changes in [1.11.68](https://github.com/element-hq/element-web/releases/tag/v1.11.68) (2024-06-04)
==================================================================================================
## ✨ Features

* Tooltip: Improve accessibility for  context menus ([#12462](matrix-org/matrix-react-sdk#12462)). Contributed by @florianduros.
* Tooltip: Improve accessibility of space panel ([#12525](matrix-org/matrix-react-sdk#12525)). Contributed by @florianduros.

## 🐛 Bug Fixes

* Close the release announcement when a dialog is opened ([#12559](matrix-org/matrix-react-sdk#12559)). Contributed by @florianduros.
* Tooltip: close field tooltip when ESC is pressed ([#12553](matrix-org/matrix-react-sdk#12553)). Contributed by @florianduros.
* Fix tabbedview breakpoint width ([#12556](matrix-org/matrix-react-sdk#12556)). Contributed by @dbkr.
* Fix E2E icon display in room header ([#12545](matrix-org/matrix-react-sdk#12545)). Contributed by @florianduros.
* Tooltip: Improve placement for space settings ([#12541](matrix-org/matrix-react-sdk#12541)). Contributed by @florianduros.
* Fix deformed avatar in a call in a narrow timeline ([#12538](matrix-org/matrix-react-sdk#12538)). Contributed by @florianduros.
* Shown own sent state indicator even when showReadReceipts is disabled ([#12540](matrix-org/matrix-react-sdk#12540)). Contributed by @t3chguy.
* Ensure we do not fire the verification mismatch modal multiple times ([#12526](matrix-org/matrix-react-sdk#12526)). Contributed by @t3chguy.
* Fix avatar in chat export ([#12537](matrix-org/matrix-react-sdk#12537)). Contributed by @florianduros.
* Use `*` for italics as it doesn't break when used mid-word ([#12523](matrix-org/matrix-react-sdk#12523)). Contributed by @t3chguy.


Changes in [1.11.67](https://github.com/element-hq/element-web/releases/tag/v1.11.67) (2024-05-22)
==================================================================================================
## ✨ Features

* Tooltip: Improve the accessibility of the composer and the rich text editor ([#12459](matrix-org/matrix-react-sdk#12459)). Contributed by @florianduros.
* Allow explicit configuration of OIDC dynamic registration metadata ([#12514](matrix-org/matrix-react-sdk#12514)). Contributed by @t3chguy.
* Tooltip: improve accessibility for messages ([#12487](matrix-org/matrix-react-sdk#12487)). Contributed by @florianduros.
* Collapse UserSettings tabs to just icons on narrow screens ([#12505](matrix-org/matrix-react-sdk#12505)). Contributed by @dbkr.
* Add room topic to right panel room info ([#12503](matrix-org/matrix-react-sdk#12503)). Contributed by @t3chguy.
* OIDC: pass `id_token` via `id_token_hint` on Manage Account interaction ([#12499](matrix-org/matrix-react-sdk#12499)). Contributed by @t3chguy.
* Tooltip: improve accessibility in room ([#12493](matrix-org/matrix-react-sdk#12493)). Contributed by @florianduros.
* Tooltip: improve accessibility for call and voice messages ([#12489](matrix-org/matrix-react-sdk#12489)). Contributed by @florianduros.
* Move the active tab in user settings to the dialog title ([#12481](matrix-org/matrix-react-sdk#12481)). Contributed by @dbkr.
* Tooltip: improve accessibility of spaces ([#12497](matrix-org/matrix-react-sdk#12497)). Contributed by @florianduros.
* Tooltip: improve accessibility of the right panel ([#12490](matrix-org/matrix-react-sdk#12490)). Contributed by @florianduros.
* MSC3575 (Sliding Sync) add well-known proxy support ([#12307](matrix-org/matrix-react-sdk#12307)). Contributed by @EdGeraghty.

## 🐛 Bug Fixes

* Reuse single PlaybackWorker between Playback instances ([#12520](matrix-org/matrix-react-sdk#12520)). Contributed by @t3chguy.
* Fix well-known lookup for sliding sync labs check ([#12519](matrix-org/matrix-react-sdk#12519)). Contributed by @t3chguy.
* Fix `element-desktop-ssoid being` included in OIDC Authorization call ([#12495](matrix-org/matrix-react-sdk#12495)). Contributed by @t3chguy.
* Fix beta notifications reconciliation for intentional mentions push rules ([#12510](matrix-org/matrix-react-sdk#12510)). Contributed by @t3chguy.
* fix avatar stretched on 1:1 call ([#12494](matrix-org/matrix-react-sdk#12494)). Contributed by @I-lander.
* Check native sliding sync support against an unstable feature flag ([#12498](matrix-org/matrix-react-sdk#12498)). Contributed by @turt2live.
* Use OPTIONS for sliding sync detection poke ([#12492](matrix-org/matrix-react-sdk#12492)). Contributed by @turt2live.
* TAC: hide tooltip when the release announcement is displayed ([#12472](matrix-org/matrix-react-sdk#12472)). Contributed by @florianduros.



Changes in [1.11.66](https://github.com/element-hq/element-web/releases/tag/v1.11.66) (2024-05-07)
==================================================================================================
## ✨ Features

* Use a different error message for UTDs when you weren't in the room. ([#12453](matrix-org/matrix-react-sdk#12453)). Contributed by @uhoreg.
* Take the Threads Activity Centre out of labs ([#12439](matrix-org/matrix-react-sdk#12439)). Contributed by @dbkr.
* Expected UTDs: use a different message for UTDs sent before login ([#12391](matrix-org/matrix-react-sdk#12391)). Contributed by @richvdh.
* Add `Tooltip` to `AccessibleButton` ([#12443](matrix-org/matrix-react-sdk#12443)). Contributed by @florianduros.
* Add analytics to activity toggles ([#12418](matrix-org/matrix-react-sdk#12418)). Contributed by @dbkr.
* Decrypt events in reverse order without copying the array ([#12445](matrix-org/matrix-react-sdk#12445)). Contributed by @Johennes.
* Use new compound tooltip ([#12416](matrix-org/matrix-react-sdk#12416)). Contributed by @florianduros.
* Expected UTDs: report a different Posthog code ([#12389](matrix-org/matrix-react-sdk#12389)). Contributed by @richvdh.

## 🐛 Bug Fixes

* TAC: Fix accessibility issue when the Release announcement is displayed ([#12484](matrix-org/matrix-react-sdk#12484)). Contributed by @RiotRobot.
* TAC: Close Release Announcement when TAC button is clicked ([#12485](matrix-org/matrix-react-sdk#12485)). Contributed by @florianduros.
* MenuItem: fix caption usage ([#12455](matrix-org/matrix-react-sdk#12455)). Contributed by @florianduros.
* Show the local echo in previews ([#12451](matrix-org/matrix-react-sdk#12451)). Contributed by @langleyd.
* Fixed the drag and drop of X #27186 ([#12450](matrix-org/matrix-react-sdk#12450)). Contributed by @asimdelvi.
* Move the TAC to above the button ([#12438](matrix-org/matrix-react-sdk#12438)). Contributed by @dbkr.
* Use the same logic in previews as the timeline to hide events that should be hidden ([#12434](matrix-org/matrix-react-sdk#12434)). Contributed by @langleyd.
* Fix selector so maths support doesn't mangle divs ([#12433](matrix-org/matrix-react-sdk#12433)). Contributed by @uhoreg.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@morguldir morguldir morguldir left review comments

@richvdh richvdh richvdh left review comments

@t3chguy t3chguy t3chguy approved these changes

@florianduros florianduros Awaiting requested review from florianduros florianduros is a code owner automatically assigned from matrix-org/element-web-reviewers

Assignees
No one assigned
Labels
T-Enhancement New features, changes in functionality, performance boosts, user-facing improvements Z-Community-PR Issue is solved by a community member's PR
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@EdGeraghty @t3chguy @richvdh @morguldir