add WebSocket support #2388

krombel · 2017-07-26T15:25:48Z

This is my working version for websocket support in synapse.

The Specification for the protocol can be found here
a working riot-web client can be build by using my matrix-js-sdk fork (or my hosted version)
to activate the websocket component (and to decide if compression should be used or not) you need to enable "websocket" as ressource
discussion can take place in #matrix-websockets:matrix.org

Example config to enable Websocket which shall be reverse-proxied can look like:

 - port: 8008
    tls: false
    bind_address: '127.0.0.1'
    type: http
    x_forwarded: true
    resources:
      - names: [client]
        compress: false
      - names: [websocket]
        compress: true

Signed-off-by: Matthias Kesler [email protected]

matrixbot · 2017-07-26T15:25:50Z

Can one of the admins verify this patch?

matrixbot · 2017-07-26T15:25:50Z

Can one of the admins verify this patch?

matrixbot · 2017-07-26T15:25:50Z

Can one of the admins verify this patch?

MTRNord · 2018-09-02T19:20:53Z

Hi any updates planned in the future? /me hopes this would be a better alternative for Android without GCM than doing requests every few minutes.

krombel · 2018-09-06T16:10:21Z

@MTRNord further development is currently stalled. I am using it daily on my server and are rebasing this from time to time.
There are currently tests missing for this part (as I currently don't know how to do them) but else I think, this is following MSC1148

ara4n · 2018-09-06T16:30:01Z

See also matrix-org/matrix-js-sdk#461 for the js-sdk side of this.

I realised that we've only fed back in #riot-dev and #matrix-dev on this, but for the record: the work here looks really good. I'm still unclear on how much of a benefit WS is actually providing (in terms of bandwidth usage or latency) as per matrix-org/matrix-js-sdk#461 (comment), and we haven't had bandwidth to evaluate it ourselves, otherwise we might be in a position to prioritise it higher.

However, we otherwise simply don't have bandwidth in the core team to shepherd it through currently - we are putting all our effort into fixing synapse's core stability problems and getting the spec to a 1.0 (and synapse to a 1.0) rather than adding new features. So either it needs to be clearly a massive improvement, or we need someone else to step in and review it and benchmark it and make the case for prioritising it. Sorry that it's got stuck for so long :(

richvdh · 2018-09-06T17:05:59Z

To add to what matthew said: it's not just about shepherding this into synapse. Even if it did make a big improvement, it's rare that something substantial like this lands and immediately integrates perfectly with other software, so we'd have to budget for some time to handle any issues that might come up. I'm very keen that we don't get distracted into bug-fixing of new features rather than stabilising what we have.

krombel · 2018-09-06T23:09:40Z

Your mentions are valid. I started this websocket project as POC because people were asking for this.
And since then I continued using it on my server - mainly probably because I have developed it.
I opened this PR (and the one in matrix-js-sdk) in the intention to get it merged, but currently I see it as a reference for other people who want to experiment with.
And I am currently updating it from time to time to keep it in a working state.

…telist_login_fallback Always whitelist the login fallback for SSO

* Don't show the login forms if we're currently logging in with a password or a token. * Submit directly the SSO login form, showing only a spinner to the user, in order to eliminate from the clunkiness of SSO through this fallback.

… fix log-output in a special case - when synapse was run via a terminal where utf8 is not possible/enabled but there is an utf8-character send, the output causes an Exception

- fix ref-errors - handle presence at init to not show the user as offline all the time while beeing connected

- now the presence-state will reset to known presence on every method which will be used when the user is online - although he has set to appear as offline

- do not set the presence on each request but instead "just bump" the presence time when a new event (caused by manual interaction) gets received - remove usage of unneeded lambda terms - rename "content" to "params" to be consistent to other _handle_*() - throw SynapseError(400) instead of KeyError when more than allowed params were passed

- enable websocket-endpoint by using ressource "websocket" - enable compression based on config - make use of remote host (or x-forwarded-for) (based on config)

Some debug tools I have found do not allow setting a WebSocket protocol. To be able to use them evaluate the parameter and only throw an Exception (which leads to socket termination) when a not-allowed protocol is passed (currently all beside "m.json") Default: m.json in case no protocol was specified

- avoid usage of self.factory

binarymaster · 2021-10-29T16:28:29Z

Any updates? This feature might decrease network traffic consumption, so it will utilize low network bandwidth cases better.

Also:

This branch has conflicts that must be resolved

richvdh · 2021-11-26T11:18:10Z

sadly, given we haven't found time to merge this in 4.5 years, I can't see that situation changing any time soon, so I'm going to go ahead and close it.

amytimed · 2023-04-02T14:45:20Z

Would like to see this merged

turt2live mentioned this pull request Mar 6, 2018

Support for websockets matrix-org/matrix-spec-proposals#3798

Open

krombel force-pushed the websocket branch from 8b565d0 to c94b619 Compare March 26, 2018 15:49

krombel force-pushed the websocket branch from d6900a5 to a03faa0 Compare April 3, 2018 13:13

krombel force-pushed the websocket branch from 8b46ec2 to 95b0c45 Compare June 4, 2018 21:03

krombel force-pushed the websocket branch from 95b0c45 to 74abc10 Compare July 24, 2018 17:16

krombel force-pushed the websocket branch from 74abc10 to fba91fe Compare September 6, 2018 16:02

krombel force-pushed the websocket branch from fba91fe to 12541c2 Compare March 23, 2020 16:52

babolivier and others added 15 commits March 26, 2020 18:58

Whitelist the login fallback by default for SSO

c2ab0b3

Regenerate sample config

7083147

Changelog

48b37f6

Lint

bdf3cda

Update the wording of the config comment

63aea69

Merge pull request matrix-org#7153 from matrix-org/babolivier/sso_whi…

319c41f

…telist_login_fallback Always whitelist the login fallback for SSO

Initial draft of websocket factory class

62efcc2

first running version with implementing WebSockets (incomplete)

d446768

implement read_markers, send, typing and state endpoints

6c87612

use reactor to do the sync-loop (fix issue with max recursion depth);…

78962b8

… fix log-output in a special case - when synapse was run via a terminal where utf8 is not possible/enabled but there is an utf8-character send, the output causes an Exception

implement handling of full_state on WebSockets; cleanups

826f728

enable permessage-deflate compression

6c44a75

fix tests concerning formatting

835b3a6

add presence handler; better error handling

fdc2b20

krombel added 16 commits March 28, 2020 17:59

further implemenation of presence-handling

d749569

- fix ref-errors - handle presence at init to not show the user as offline all the time while beeing connected

further implementation of presence-handling

42487ed

- now the presence-state will reset to known presence on every method which will be used when the user is online - although he has set to appear as offline

make websocket configurable by config-file

234528e

- enable websocket-endpoint by using ressource "websocket" - enable compression based on config - make use of remote host (or x-forwarded-for) (based on config)

code reorder; change severity of some logs from info to debug

5c36984

add myself to AUTHORS.rst

6255c68

Fix missing line: enable state handling

fa5f5d1

add example nginx config for reverse proxying WebSocket

ece84b4

fix test

27fbb74

use msg.id for deduplication of execution

fc47f52

restrict cache to only send and state

7cf83e6

use event_creation_handler

b7f91f7

add metric synapse_websocket_connection_count

5ee6946

updates and fixes

df9368b

namespace HttpTransactionCache for user; refactoring

149e091

- avoid usage of self.factory

krombel force-pushed the websocket branch from 12541c2 to 149e091 Compare March 28, 2020 16:59

clokep mentioned this pull request Apr 15, 2020

move parse_filter to synapse.api.filtering #2393

Closed

erikjohnston added the z-blocked (Deprecated Label) label May 20, 2021

richvdh closed this Nov 26, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add WebSocket support #2388

add WebSocket support #2388

krombel commented Jul 26, 2017

matrixbot commented Jul 26, 2017

matrixbot commented Jul 26, 2017

matrixbot commented Jul 26, 2017

MTRNord commented Sep 2, 2018

krombel commented Sep 6, 2018

ara4n commented Sep 6, 2018

richvdh commented Sep 6, 2018

krombel commented Sep 6, 2018

binarymaster commented Oct 29, 2021

richvdh commented Nov 26, 2021

amytimed commented Apr 2, 2023

add WebSocket support #2388

add WebSocket support #2388

Conversation

krombel commented Jul 26, 2017

matrixbot commented Jul 26, 2017

matrixbot commented Jul 26, 2017

matrixbot commented Jul 26, 2017

MTRNord commented Sep 2, 2018

krombel commented Sep 6, 2018

ara4n commented Sep 6, 2018

richvdh commented Sep 6, 2018

krombel commented Sep 6, 2018

binarymaster commented Oct 29, 2021

richvdh commented Nov 26, 2021

amytimed commented Apr 2, 2023