Add ability to run replication protocol over redis. #7040

erikjohnston · 2020-03-05T17:16:15Z

This still requires adding config and CI.

Based on #7187

richvdh

some initial thoughts

synapse/config/redis.py

synapse/replication/tcp/redis.py

richvdh · 2020-04-01T11:18:31Z

synapse/replication/tcp/redis.py

+        p.handler = self.handler
+        p.redis_connection = self.redis_connection
+        p.conn_id = self.conn_id
+        p.stream_name = self.stream_name


can these be declared in RedisSubscriber's constructor?

The library is a bit of a mess, really. If we add these to the protocol constructor then we'll need to fully override buildProtocol, which does things other than just instantiate the protocol. So its not really clear how you're meant to use this without doing this or copy and pasting bits of the code around (though the library is designed to be copied into your repo rather than using pip, so maybe that is how you're meant to do it)

I've added a comment to that effect for now.

though the library is designed to be copied into your repo rather than using pip

is it? god, that doesn't inspire much confidence. Maybe we should do that then?

TBH my comment here was mostly that I wanted some recognition of the existence of these attributes in RedisSubscriber - even setting them to None is fine, so I think you've addressed this comment.

one thought for a workaround would be to make self.protocol a callable which can add a few extra kwargs which RedisSubscriber.__init__ could intercept. I'm not sure that buys a great deal though.

though the library is designed to be copied into your repo rather than using pip

is it? god, that doesn't inspire much confidence. Maybe we should do that then?

Maybe, my bias is against doing so though.

synapse/replication/tcp/redis.py

mypy.ini

richvdh

i done a few more thinks

synapse/config/redis.py

synapse/replication/tcp/handler.py

synapse/replication/tcp/redis.py

richvdh · 2020-04-20T13:59:10Z

synapse/replication/tcp/redis.py

+    Due to the vagaries of `txredisapi` we don't want to have a custom
+    constructor, so instead we expect the defined attributes below to be set


I'm not entirely following why we can't have a custom constructor (even one that has *args, **kwargs that it passes through to super().__init__()), but i guess it's not super-important.

synapse/replication/tcp/redis.py

richvdh · 2020-04-20T14:13:50Z

synapse/replication/tcp/redis.py

+        p.handler = self.handler
+        p.redis_connection = self.redis_connection
+        p.conn_id = self.conn_id
+        p.stream_name = self.stream_name


though the library is designed to be copied into your repo rather than using pip

is it? god, that doesn't inspire much confidence. Maybe we should do that then?

TBH my comment here was mostly that I wanted some recognition of the existence of these attributes in RedisSubscriber - even setting them to None is fine, so I think you've addressed this comment.

one thought for a workaround would be to make self.protocol a callable which can add a few extra kwargs which RedisSubscriber.__init__ could intercept. I'm not sure that buys a great deal though.

erikjohnston · 2020-04-21T13:30:00Z

Oh, I've just realised that this doesn't include any metrics for inbound/outbound commands. Will add that back in in a bit

richvdh

lgtm, just a few nits now

synapse/replication/tcp/handler.py

richvdh · 2020-04-22T09:07:23Z

synapse/replication/tcp/redis.py

+    handler = None  # type: ReplicationCommandHandler
+    stream_name = None  # type: str
+    outbound_redis_connection = None  # type: txredisapi.RedisProtocol
+    conn_id = None  # type: str


some comments on what these mean would be good.

Turns out conn_id is now unused 🤦

synapse/replication/tcp/redis.py

synapse/app/homeserver.py

…cache-config-without-synctl * 'develop' of github.com:matrix-org/synapse: (76 commits) 1.12.4 Revert "Revert "Merge pull request #7315 from matrix-org/babolivier/request_token"" Revert "Merge pull request #7315 from matrix-org/babolivier/request_token" Stop the master relaying USER_SYNC for other workers (#7318) Config option to inhibit 3PID errors on /requestToken Fix replication metrics when using redis (#7325) formatting for the changelog Another go at fixing one-word commands (#7326) 1.12.4rc1 1.12.4rc1 fix changelog name Extend StreamChangeCache to support multiple entities per stream ID (#7303) Extend room admin api with additional attributes (#7225) Add ability to run replication protocol over redis. (#7040) Do not treat display names as globs for push rules. (#7271) Reduce logging verbosity of URL cache cleanup. (#7295) Query missing cross-signing keys on local sig upload (#7289) import urllib.parse when using urllib.parse.quote (#7319) Reduce federation logging on success (#7321) Fix changelog file ...

@nekatak

Synapse 1.13.0 (2020-05-19) =========================== This release brings some potential changes necessary for certain configurations of Synapse: * If your Synapse is configured to use SSO and have a custom `sso_redirect_confirm_template_dir` configuration option set, you will need to duplicate the new `sso_auth_confirm.html`, `sso_auth_success.html` and `sso_account_deactivated.html` templates into that directory. * Synapse plugins using the `complete_sso_login` method of `synapse.module_api.ModuleApi` should instead switch to the async/await version, `complete_sso_login_async`, which includes additional checks. The former version is now deprecated. * A bug was introduced in Synapse 1.4.0 which could cause the room directory to be incomplete or empty if Synapse was upgraded directly from v1.2.1 or earlier, to versions between v1.4.0 and v1.12.x. Please review [UPGRADE.rst](https://github.com/matrix-org/synapse/blob/master/UPGRADE.rst) for more details on these changes and for general upgrade guidance. Notice of change to the default `git` branch for Synapse -------------------------------------------------------- With the release of Synapse 1.13.0, the default `git` branch for Synapse has changed to `develop`, which is the development tip. This is more consistent with common practice and modern `git` usage. The `master` branch, which tracks the latest release, is still available. It is recommended that developers and distributors who have scripts which run builds using the default branch of Synapse should therefore consider pinning their scripts to `master`. Features -------- - Extend the `web_client_location` option to accept an absolute URL to use as a redirect. Adds a warning when running the web client on the same hostname as homeserver. Contributed by Martin Milata. ([\#7006](#7006)) - Set `Referrer-Policy` header to `no-referrer` on media downloads. ([\#7009](#7009)) - Add support for running replication over Redis when using workers. ([\#7040](#7040), [\#7325](#7325), [\#7352](#7352), [\#7401](#7401), [\#7427](#7427), [\#7439](#7439), [\#7446](#7446), [\#7450](#7450), [\#7454](#7454)) - Admin API `POST /_synapse/admin/v1/join/<roomIdOrAlias>` to join users to a room like `auto_join_rooms` for creation of users. ([\#7051](#7051)) - Add options to prevent users from changing their profile or associated 3PIDs. ([\#7096](#7096)) - Support SSO in the user interactive authentication workflow. ([\#7102](#7102), [\#7186](#7186), [\#7279](#7279), [\#7343](#7343)) - Allow server admins to define and enforce a password policy ([MSC2000](matrix-org/matrix-spec-proposals#2000)). ([\#7118](#7118)) - Improve the support for SSO authentication on the login fallback page. ([\#7152](#7152), [\#7235](#7235)) - Always whitelist the login fallback in the SSO configuration if `public_baseurl` is set. ([\#7153](#7153)) - Admin users are no longer required to be in a room to create an alias for it. ([\#7191](#7191)) - Require admin privileges to enable room encryption by default. This does not affect existing rooms. ([\#7230](#7230)) - Add a config option for specifying the value of the Accept-Language HTTP header when generating URL previews. ([\#7265](#7265)) - Allow `/requestToken` endpoints to hide the existence (or lack thereof) of 3PID associations on the homeserver. ([\#7315](#7315)) - Add a configuration setting to tweak the threshold for dummy events. ([\#7422](#7422)) Bugfixes -------- - Don't attempt to use an invalid sqlite config if no database configuration is provided. Contributed by @nekatak. ([\#6573](#6573)) - Fix single-sign on with CAS systems: pass the same service URL when requesting the CAS ticket and when calling the `proxyValidate` URL. Contributed by @Naugrimm. ([\#6634](#6634)) - Fix missing field `default` when fetching user-defined push rules. ([\#6639](#6639)) - Improve error responses when accessing remote public room lists. ([\#6899](#6899), [\#7368](#7368)) - Transfer alias mappings on room upgrade. ([\#6946](#6946)) - Ensure that a user interactive authentication session is tied to a single request. ([\#7068](#7068), [\#7455](#7455)) - Fix a bug in the federation API which could cause occasional "Failed to get PDU" errors. ([\#7089](#7089)) - Return the proper error (`M_BAD_ALIAS`) when a non-existant canonical alias is provided. ([\#7109](#7109)) - Fix a bug which meant that groups updates were not correctly replicated between workers. ([\#7117](#7117)) - Fix starting workers when federation sending not split out. ([\#7133](#7133)) - Ensure `is_verified` is a boolean in responses to `GET /_matrix/client/r0/room_keys/keys`. Also warn the user if they forgot the `version` query param. ([\#7150](#7150)) - Fix error page being shown when a custom SAML handler attempted to redirect when processing an auth response. ([\#7151](#7151)) - Avoid importing `sqlite3` when using the postgres backend. Contributed by David Vo. ([\#7155](#7155)) - Fix excessive CPU usage by `prune_old_outbound_device_pokes` job. ([\#7159](#7159)) - Fix a bug which could cause outbound federation traffic to stop working if a client uploaded an incorrect e2e device signature. ([\#7177](#7177)) - Fix a bug which could cause incorrect 'cyclic dependency' error. ([\#7178](#7178)) - Fix a bug that could cause a user to be invited to a server notices (aka System Alerts) room without any notice being sent. ([\#7199](#7199)) - Fix some worker-mode replication handling not being correctly recorded in CPU usage stats. ([\#7203](#7203)) - Do not allow a deactivated user to login via SSO. ([\#7240](#7240), [\#7259](#7259)) - Fix --help command-line argument. ([\#7249](#7249)) - Fix room publish permissions not being checked on room creation. ([\#7260](#7260)) - Reject unknown session IDs during user interactive authentication instead of silently creating a new session. ([\#7268](#7268)) - Fix a SQL query introduced in Synapse 1.12.0 which could cause large amounts of logging to the postgres slow-query log. ([\#7274](#7274)) - Persist user interactive authentication sessions across workers and Synapse restarts. ([\#7302](#7302)) - Fixed backwards compatibility logic of the first value of `trusted_third_party_id_servers` being used for `account_threepid_delegates.email`, which occurs when the former, deprecated option is set and the latter is not. ([\#7316](#7316)) - Fix a bug where event updates might not be sent over replication to worker processes after the stream falls behind. ([\#7337](#7337), [\#7358](#7358)) - Fix bad error handling that would cause Synapse to crash if it's provided with a YAML configuration file that's either empty or doesn't parse into a key-value map. ([\#7341](#7341)) - Fix incorrect metrics reporting for `renew_attestations` background task. ([\#7344](#7344)) - Prevent non-federating rooms from appearing in responses to federated `POST /publicRoom` requests when a filter was included. ([\#7367](#7367)) - Fix a bug which would cause the room durectory to be incorrectly populated if Synapse was upgraded directly from v1.2.1 or earlier to v1.4.0 or later. Note that this fix does not apply retrospectively; see the [upgrade notes](UPGRADE.rst#upgrading-to-v1130) for more information. ([\#7387](#7387)) - Fix bug in `EventContext.deserialize`. ([\#7393](#7393)) - Fix a long-standing bug which could cause messages not to be sent over federation, when state events with state keys matching user IDs (such as custom user statuses) were received. ([\#7376](#7376)) - Restore compatibility with non-compliant clients during the user interactive authentication process, fixing a problem introduced in v1.13.0rc1. ([\#7483](#7483)) - Hash passwords as early as possible during registration. ([\#7523](#7523)) Improved Documentation ---------------------- - Update Debian installation instructions to recommend installing the `virtualenv` package instead of `python3-virtualenv`. ([\#6892](#6892)) - Improve the documentation for database configuration. ([\#6988](#6988)) - Improve the documentation of application service configuration files. ([\#7091](#7091)) - Update pre-built package name for FreeBSD. ([\#7107](#7107)) - Update postgres docs with login troubleshooting information. ([\#7119](#7119)) - Clean up INSTALL.md a bit. ([\#7141](#7141)) - Add documentation for running a local CAS server for testing. ([\#7147](#7147)) - Improve README.md by being explicit about public IP recommendation for TURN relaying. ([\#7167](#7167)) - Fix a small typo in the `metrics_flags` config option. ([\#7171](#7171)) - Update the contributed documentation on managing synapse workers with systemd, and bring it into the core distribution. ([\#7234](#7234)) - Add documentation to the `password_providers` config option. Add known password provider implementations to docs. ([\#7238](#7238), [\#7248](#7248)) - Modify suggested nginx reverse proxy configuration to match Synapse's default file upload size. Contributed by @ProCycleDev. ([\#7251](#7251)) - Documentation of media_storage_providers options updated to avoid misunderstandings. Contributed by Tristan Lins. ([\#7272](#7272)) - Add documentation on monitoring workers with Prometheus. ([\#7357](#7357)) - Clarify endpoint usage in the users admin api documentation. ([\#7361](#7361)) Deprecations and Removals ------------------------- - Remove nonfunctional `captcha_bypass_secret` option from `homeserver.yaml`. ([\#7137](#7137)) Internal Changes ---------------- - Add benchmarks for LruCache. ([\#6446](#6446)) - Return total number of users and profile attributes in admin users endpoint. Contributed by Awesome Technologies Innovationslabor GmbH. ([\#6881](#6881)) - Change device list streams to have one row per ID. ([\#7010](#7010)) - Remove concept of a non-limited stream. ([\#7011](#7011)) - Move catchup of replication streams logic to worker. ([\#7024](#7024), [\#7195](#7195), [\#7226](#7226), [\#7239](#7239), [\#7286](#7286), [\#7290](#7290), [\#7318](#7318), [\#7326](#7326), [\#7378](#7378), [\#7421](#7421)) - Convert some of synapse.rest.media to async/await. ([\#7110](#7110), [\#7184](#7184), [\#7241](#7241)) - De-duplicate / remove unused REST code for login and auth. ([\#7115](#7115)) - Convert `*StreamRow` classes to inner classes. ([\#7116](#7116)) - Clean up some LoggingContext code. ([\#7120](#7120), [\#7181](#7181), [\#7183](#7183), [\#7408](#7408), [\#7426](#7426)) - Add explicit `instance_id` for USER_SYNC commands and remove implicit `conn_id` usage. ([\#7128](#7128)) - Refactored the CAS authentication logic to a separate class. ([\#7136](#7136)) - Run replication streamers on workers. ([\#7146](#7146)) - Add tests for outbound device pokes. ([\#7157](#7157)) - Fix device list update stream ids going backward. ([\#7158](#7158)) - Use `stream.current_token()` and remove `stream_positions()`. ([\#7172](#7172)) - Move client command handling out of TCP protocol. ([\#7185](#7185)) - Move server command handling out of TCP protocol. ([\#7187](#7187)) - Fix consistency of HTTP status codes reported in log lines. ([\#7188](#7188)) - Only run one background database update at a time. ([\#7190](#7190)) - Remove sent outbound device list pokes from the database. ([\#7192](#7192)) - Add a background database update job to clear out duplicate `device_lists_outbound_pokes`. ([\#7193](#7193)) - Remove some extraneous debugging log lines. ([\#7207](#7207)) - Add explicit Python build tooling as dependencies for the snapcraft build. ([\#7213](#7213)) - Add typing information to federation server code. ([\#7219](#7219)) - Extend room admin api (`GET /_synapse/admin/v1/rooms`) with additional attributes. ([\#7225](#7225)) - Unblacklist '/upgrade creates a new room' sytest for workers. ([\#7228](#7228)) - Remove redundant checks on `daemonize` from synctl. ([\#7233](#7233)) - Upgrade jQuery to v3.4.1 on fallback login/registration pages. ([\#7236](#7236)) - Change log line that told user to implement onLogin/onRegister fallback js functions to a warning, instead of an info, so it's more visible. ([\#7237](#7237)) - Correct the parameters of a test fixture. Contributed by Isaiah Singletary. ([\#7243](#7243)) - Convert auth handler to async/await. ([\#7261](#7261)) - Add some unit tests for replication. ([\#7278](#7278)) - Improve typing annotations in `synapse.replication.tcp.streams.Stream`. ([\#7291](#7291)) - Reduce log verbosity of url cache cleanup tasks. ([\#7295](#7295)) - Fix sample SAML Service Provider configuration. Contributed by @frcl. ([\#7300](#7300)) - Fix StreamChangeCache to work with multiple entities changing on the same stream id. ([\#7303](#7303)) - Fix an incorrect import in IdentityHandler. ([\#7319](#7319)) - Reduce logging verbosity for successful federation requests. ([\#7321](#7321)) - Convert some federation handler code to async/await. ([\#7338](#7338)) - Fix collation for postgres for unit tests. ([\#7359](#7359)) - Convert RegistrationWorkerStore.is_server_admin and dependent code to async/await. ([\#7363](#7363)) - Add an `instance_name` to `RDATA` and `POSITION` replication commands. ([\#7364](#7364)) - Thread through instance name to replication client. ([\#7369](#7369)) - Convert synapse.server_notices to async/await. ([\#7394](#7394)) - Convert synapse.notifier to async/await. ([\#7395](#7395)) - Fix issues with the Python package manifest. ([\#7404](#7404)) - Prevent methods in `synapse.handlers.auth` from polling the homeserver config every request. ([\#7420](#7420)) - Speed up fetching device lists changes when handling `/sync` requests. ([\#7423](#7423)) - Run group attestation renewal in series rather than parallel for performance. ([\#7442](#7442)) - Fix linting errors in new version of Flake8. ([\#7470](#7470)) - Update the version of dh-virtualenv we use to build debs, and add focal to the list of target distributions. ([\#7526](#7526))

This is configured via the `redis` config options.

erikjohnston changed the base branch from master to develop March 5, 2020 17:16

erikjohnston force-pushed the erikj/redis branch 3 times, most recently from 316a09e to 93a25e7 Compare March 6, 2020 09:56

erikjohnston force-pushed the erikj/redis branch 8 times, most recently from f2333b4 to b9a9059 Compare March 23, 2020 12:21

erikjohnston marked this pull request as ready for review March 23, 2020 12:28

erikjohnston force-pushed the erikj/redis branch 4 times, most recently from 55dfcd2 to 5f77ba3 Compare March 25, 2020 16:01

erikjohnston requested a review from a team March 25, 2020 16:21

erikjohnston mentioned this pull request Mar 26, 2020

Run replication streamers on workers #7146

Merged

erikjohnston force-pushed the erikj/redis branch 2 times, most recently from 3fd6a0d to 8535c32 Compare March 31, 2020 14:03

richvdh reviewed Apr 1, 2020

View reviewed changes

erikjohnston added 4 commits April 7, 2020 11:13

Add redis support

ccfadb2

Use 'check_requirements'

1618671

Rename client factories to include types

e1b1105

Use super()

73381c7

erikjohnston force-pushed the erikj/redis branch 2 times, most recently from b856886 to 1604976 Compare April 7, 2020 10:33

Fixup comments and docstring

3d64aa2

erikjohnston force-pushed the erikj/redis branch from 1604976 to d3ec39b Compare April 7, 2020 10:34

erikjohnston force-pushed the erikj/redis branch from b6f7b33 to ceb408c Compare April 7, 2020 10:40

erikjohnston added 2 commits April 7, 2020 11:41

Remove unused function

59c7341

Newsfile

0edd48f

erikjohnston force-pushed the erikj/redis branch from ceb408c to 0edd48f Compare April 7, 2020 10:41

erikjohnston requested a review from richvdh April 7, 2020 11:03

richvdh suggested changes Apr 20, 2020

View reviewed changes

erikjohnston added 6 commits April 21, 2020 10:39

Review comments

3e38f67

Move construction of outbound redis connection out

b1835b9

Add basic stub file for txredisapi

cdf399a

Fix typing

2a226da

Merge branch 'develop' of github.com:matrix-org/synapse into erikj/redis

e3f18eb

Merge command parsing

e46550a

erikjohnston requested a review from richvdh April 21, 2020 13:30

richvdh approved these changes Apr 22, 2020

View reviewed changes

erikjohnston added 2 commits April 22, 2020 10:19

Remove unused conn_id

c5fcff0

Review comments

dd46cb4

erikjohnston mentioned this pull request Apr 22, 2020

Add support for running worker mode against redis matrix-org/sytest#857

Merged

erikjohnston merged commit 51f7eaf into develop Apr 22, 2020

erikjohnston deleted the erikj/redis branch April 22, 2020 12:07

phil-flex pushed a commit to phil-flex/synapse that referenced this pull request Jun 16, 2020

Add ability to run replication protocol over redis. (matrix-org#7040)

cbdc853

This is configured via the `redis` config options.

ulope mentioned this pull request Jul 6, 2020

Upgrade Synapse to 1.19.1 raiden-network/raiden-service-bundle#180

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add ability to run replication protocol over redis. #7040

Add ability to run replication protocol over redis. #7040

erikjohnston commented Mar 5, 2020 •

edited

Loading

richvdh left a comment

richvdh Apr 1, 2020

erikjohnston Apr 6, 2020

erikjohnston Apr 7, 2020

richvdh Apr 20, 2020

erikjohnston Apr 21, 2020

richvdh left a comment

richvdh Apr 20, 2020

richvdh Apr 20, 2020

erikjohnston commented Apr 21, 2020

richvdh left a comment

richvdh Apr 22, 2020

erikjohnston Apr 22, 2020

		Due to the vagaries of `txredisapi` we don't want to have a custom
		constructor, so instead we expect the defined attributes below to be set

Add ability to run replication protocol over redis. #7040

Add ability to run replication protocol over redis. #7040

Conversation

erikjohnston commented Mar 5, 2020 • edited Loading

richvdh left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

richvdh left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

erikjohnston commented Apr 21, 2020

richvdh left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

erikjohnston commented Mar 5, 2020 •

edited

Loading