Reload cache factors from disk on SIGHUP #12673

DMRobertson · 2022-05-09T12:06:57Z

Tested as follows:

# 1.Change the logger.debug line added in this patch to warning so we'll see it.

#2 . Start demo and tail logs.
demo/start.sh
tail -f demo/8080/homeserver.log | \egrep --color=yes '^.*(ERROR|WARNING).*$|$'

# 3. Change the global_factor from commented out to 10.
vim demo/8080/homeserver.yaml 

#4. Reload.
kill -HUP `pgrep -f python.*8080`

The log file then includes:

2022-05-09 14:35:12,366 - synapse.util.caches.lrucache - 154 - INFO - LruCache._expire_old_entries-0 - Dropped 0 items from caches
2022-05-09 14:35:42,366 - synapse.util.caches.lrucache - 154 - INFO - LruCache._expire_old_entries-1 - Dropped 0 items from caches
2022-05-09 14:36:12,367 - synapse.util.caches.lrucache - 154 - INFO - LruCache._expire_old_entries-2 - Dropped 0 items from caches
2022-05-09 14:36:27,696 - root - 312 - INFO - sighup-0 - Reloaded log config from /home/dmr/workspace/synapse/demo/8080/localhost:8080.log.config due to SIGHUP
2022-05-09 14:36:27,696 - synapse.config.tls - 261 - INFO - sighup-0 - Loading TLS key from /home/dmr/workspace/synapse/demo/8080/localhost:8080.tls.key
2022-05-09 14:36:27,696 - synapse.config.tls - 248 - INFO - sighup-0 - Loading TLS certificate from /home/dmr/workspace/synapse/demo/8080/localhost:8080.tls.crt
2022-05-09 14:36:27,696 - synapse.app._base - 359 - INFO - sighup-0 - Updating context factories...
2022-05-09 14:36:27,697 - synapse.app._base - 367 - INFO - sighup-0 - Replacing TLS context factory on [::]:8480
2022-05-09 14:36:27,697 - synapse.app._base - 376 - INFO - sighup-0 - Context factories updated.
2022-05-09 14:36:27,697 - synapse.config._base - 778 - INFO - sighup-0 - Reloading config section 'caches'
2022-05-09 14:36:27,765 - synapse.app._base - 499 - WARNING - sighup-0 - New cache config: {'root': <synapse.config.homeserver.HomeServerConfig object at 0x7ff66eec1960>, 'default_template_dir': '/home/dmr/workspace/synapse/synapse/res/templates', 'event_cache_size': 10240, 'cache_factors': {}, 'global_factor': 10, 'track_memory_usage': False, 'expiry_time_msec': 1800000, 'sync_response_cache_duration': 0}
2022-05-09 14:36:42,367 - synapse.util.caches.lrucache - 154 - INFO - LruCache._expire_old_entries-3 - Dropped 0 items from caches

I came across a surprising piece of behaviour, which 1febfd6 (#12673) addresses.

Not tested under workers.

right below the definition of ConfigError.

Consider the following scenario: 1. Start synapse with config that omits a `caches.global_factor`. 2. `CacheProperties.default_factor_size` is now 0.5. 3. Edit config to set `caches.global_factor = 2`. 4. Reload config. 5. Read `CacheProperties.default_factor_size`. - Without patch: still 2 - With patch: backt to 0.5 Without this commit, when we reload config we will compute `self.global_factor` to be the _previous_ global cache factor. I think this is surprising: I would that factor to reflect what the config file says.

erikjohnston

Woop, this is awesome, just a bit of a Q around safety

erikjohnston · 2022-05-10T08:29:37Z

synapse/config/_base.py

+        logger.info("Reloading config section '%s'", section_name)
+
+        new_config_data = read_config_files(self.config_files)
+        existing_config.read_config(new_config_data)


What happens if we error half way through reading the config? I.e. if someone has put an invalid value in there? Do we end up in a messed up state where we've reloaded some of the config?

I guess ideally we should be reading the config into a new config class and then replacing the existing config with that once we've successfully read it?

Do we end up in a messed up state where we've reloaded some of the config?

We will, yes. I don't think that's the end of the world, because you can correct and re-reload the config. But it would be nice for this to be an atomic operation. I'll do this shortly

Note however that the CacheConfig in particular is naughty. When it reads in config it adjusts global state in its enclosing module. And it automatically re-evaluates cache sizes. I'll have to change this too.

Oh that's annoying :(

I've posted four commits which have a go at this. Could use somebody to sanity check that it works though.

Could use somebody to sanity check that it works though.

The reloading seems to work fine. Not sure how to check that the caches themselves have the appropriate size from the diffs?

so I can see what it actually contains

This ensures we don't partially overwrite the existing object if we encounter an exception during `read_config()`.

DMRobertson · 2022-05-10T15:44:32Z

Looks like I need to fixup some tests. And I probably need to mention this somewhere in the config manual.

erikjohnston · 2022-05-11T10:50:30Z

synapse/app/generic_worker.py

@@ -459,6 +459,7 @@ def start(config_options: List[str]) -> None:

    synapse.events.USE_FROZEN_DICTS = config.server.use_frozen_dicts
    synapse.util.caches.TRACK_MEMORY_USAGE = config.caches.track_memory_usage
+    config.caches.resize_all_caches()


Doesn't this need to be in the synapse/app/_base.py so that the main process picks it up too?

oh ffs. It was meant to be. thanks

See 55963ac. I also snuck in f199d82.

erikjohnston · 2022-05-11T10:51:39Z

synapse/app/_base.py

@@ -480,6 +483,22 @@ def run_sighup(*args: Any, **kwargs: Any) -> None:
        atexit.register(gc.freeze)


+def reload_cache_config(config: HomeServerConfig) -> None:
+    try:


Docstring pwease?

erikjohnston

Otherwise, yay, lgtm

erikjohnston · 2022-05-11T12:52:30Z

synapse/app/_base.py

@@ -499,6 +500,7 @@ def reload_cache_config(config: HomeServerConfig) -> None:
            previous_cache_config.__dict__,
            config.caches.__dict__,
        )
+        synapse.util.caches.TRACK_MEMORY_USAGE = config.caches.track_memory_usage


Hmm, so this is safe to update to False, but I'm not 100% sure its safe to update this to True. At the very least the metrics will be wrong for a while, as we won't track memory usage for anything that is already in the cache.

Happy for us to do one of:

Not update this

Only update this to False

Check its safe to update this to True and add a big comment about the fact it will underestimate the cache size for a while

I'll go for option 1 and update the docstring.

I'll also update the docs to only say that SIGHUP reloads cache factors.

One more look over please?

DMRobertson · 2022-05-11T13:40:39Z

Thanks. Took longer than I expected. :/

(Edit: but apparently less than Erik expected!)

@SpiritCroc

Synapse 1.60.0rc1 (2022-05-24) ============================== This release of Synapse adds a unique index to the `state_group_edges` table, in order to prevent accidentally introducing duplicate information (for example, because a database backup was restored multiple times). If your Synapse database already has duplicate rows in this table, this could fail with an error and require manual remediation. Additionally, the signature of the `check_event_for_spam` module callback has changed. The previous signature has been deprecated and remains working for now. Module authors should update their modules to use the new signature where possible. See [the upgrade notes](https://github.com/matrix-org/synapse/blob/develop/docs/upgrade.md#upgrading-to-v1600) for more details. Features -------- - Measure the time taken in spam-checking callbacks and expose those measurements as metrics. ([\#12513](#12513)) - Add a `default_power_level_content_override` config option to set default room power levels per room preset. ([\#12618](#12618)) - Add support for [MSC3787: Allowing knocks to restricted rooms](matrix-org/matrix-spec-proposals#3787). ([\#12623](#12623)) - Send `USER_IP` commands on a different Redis channel, in order to reduce traffic to workers that do not process these commands. ([\#12672](#12672), [\#12809](#12809)) - Synapse will now reload [cache config](https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#caching) when it receives a [SIGHUP](https://en.wikipedia.org/wiki/SIGHUP) signal. ([\#12673](#12673)) - Add a config options to allow for auto-tuning of caches. ([\#12701](#12701)) - Update [MSC2716](matrix-org/matrix-spec-proposals#2716) implementation to process marker events from the current state to avoid markers being lost in timeline gaps for federated servers which would cause the imported history to be undiscovered. ([\#12718](#12718)) - Add a `drop_federated_event` callback to `SpamChecker` to disregard inbound federated events before they take up much processing power, in an emergency. ([\#12744](#12744)) - Implement [MSC3818: Copy room type on upgrade](matrix-org/matrix-spec-proposals#3818). ([\#12786](#12786), [\#12792](#12792)) - Update to the `check_event_for_spam` module callback. Deprecate the current callback signature, replace it with a new signature that is both less ambiguous (replacing booleans with explicit allow/block) and more powerful (ability to return explicit error codes). ([\#12808](#12808)) Bugfixes -------- - Fix a bug introduced in Synapse 1.7.0 that would prevent events from being sent to clients if there's a retention policy in the room when the support for retention policies is disabled. ([\#12611](#12611)) - Fix a bug introduced in Synapse 1.57.0 where `/messages` would throw a 500 error when querying for a non-existent room. ([\#12683](#12683)) - Add a unique index to `state_group_edges` to prevent duplicates being accidentally introduced and the consequential impact to performance. ([\#12687](#12687)) - Fix a long-standing bug where an empty room would be created when a user with an insufficient power level tried to upgrade a room. ([\#12696](#12696)) - Fix a bug introduced in Synapse 1.30.0 where empty rooms could be automatically created if a monthly active users limit is set. ([\#12713](#12713)) - Fix push to dismiss notifications when read on another client. Contributed by @SpiritCroc @ Beeper. ([\#12721](#12721)) - Fix poor database performance when reading the cache invalidation stream for large servers with lots of workers. ([\#12747](#12747)) - Delete events from the `federation_inbound_events_staging` table when a room is purged through the admin API. ([\#12770](#12770)) - Give a meaningful error message when a client tries to create a room with an invalid alias localpart. ([\#12779](#12779)) - Fix a bug introduced in 1.43.0 where a file (`providers.json`) was never closed. Contributed by @arkamar. ([\#12794](#12794)) - Fix a long-standing bug where finished log contexts would be re-started when failing to contact remote homeservers. ([\#12803](#12803)) - Fix a bug, introduced in Synapse 1.21.0, that led to media thumbnails being unusable before the index has been added in the background. ([\#12823](#12823)) Updates to the Docker image --------------------------- - Fix the docker file after a dependency update. ([\#12853](#12853)) Improved Documentation ---------------------- - Fix a typo in the Media Admin API documentation. ([\#12715](#12715)) - Update the OpenID Connect example for Keycloak to be compatible with newer versions of Keycloak. Contributed by @nhh. ([\#12727](#12727)) - Fix typo in server listener documentation. ([\#12742](#12742)) - Link to the configuration manual from the welcome page of the documentation. ([\#12748](#12748)) - Fix typo in `run_background_tasks_on` option name in configuration manual documentation. ([\#12749](#12749)) - Add information regarding the `rc_invites` ratelimiting option to the configuration docs. ([\#12759](#12759)) - Add documentation for cancellation of request processing. ([\#12761](#12761)) - Recommend using docker to run tests against postgres. ([\#12765](#12765)) - Add missing user directory endpoint from the generic worker documentation. Contributed by @olmari. ([\#12773](#12773)) - Add additional info to documentation of config option `cache_autotuning`. ([\#12776](#12776)) - Update configuration manual documentation to document size-related suffixes. ([\#12777](#12777)) - Fix invalid YAML syntax in the example documentation for the `url_preview_accept_language` config option. ([\#12785](#12785)) Deprecations and Removals ------------------------- - Require a body in POST requests to `/rooms/{roomId}/receipt/{receiptType}/{eventId}`, as required by the [Matrix specification](https://spec.matrix.org/v1.2/client-server-api/#post_matrixclientv3roomsroomidreceiptreceipttypeeventid). This breaks compatibility with Element Android 1.2.0 and earlier: users of those clients will be unable to send read receipts. ([\#12709](#12709)) Internal Changes ---------------- - Improve event caching mechanism to avoid having multiple copies of an event in memory at a time. ([\#10533](#10533)) - Preparation for faster-room-join work: return subsets of room state which we already have, immediately. ([\#12498](#12498)) - Add `@cancellable` decorator, for use on endpoint methods that can be cancelled when clients disconnect. ([\#12586](#12586), [\#12588](#12588), [\#12630](#12630), [\#12694](#12694), [\#12698](#12698), [\#12699](#12699), [\#12700](#12700), [\#12705](#12705)) - Enable cancellation of `GET /rooms/$room_id/members`, `GET /rooms/$room_id/state` and `GET /rooms/$room_id/state/$event_type/*` requests. ([\#12708](#12708)) - Improve documentation of the `synapse.push` module. ([\#12676](#12676)) - Refactor functions to on `PushRuleEvaluatorForEvent`. ([\#12677](#12677)) - Preparation for database schema simplifications: stop writing to `event_reference_hashes`. ([\#12679](#12679)) - Remove code which updates unused database column `application_services_state.last_txn`. ([\#12680](#12680)) - Refactor `EventContext` class. ([\#12689](#12689)) - Remove an unneeded class in the push code. ([\#12691](#12691)) - Consolidate parsing of relation information from events. ([\#12693](#12693)) - Convert namespace class `Codes` into a string enum. ([\#12703](#12703)) - Optimize private read receipt filtering. ([\#12711](#12711)) - Drop the logging level of status messages for the URL preview cache expiry job from INFO to DEBUG. ([\#12720](#12720)) - Downgrade some OIDC errors to warnings in the logs, to reduce the noise of Sentry reports. ([\#12723](#12723)) - Update configs used by Complement to allow more invites/3PID validations during tests. ([\#12731](#12731)) - Fix a long-standing bug where the user directory background process would fail to make forward progress if a user included a null codepoint in their display name or avatar. ([\#12762](#12762)) - Tweak the mypy plugin so that `@cached` can accept `on_invalidate=None`. ([\#12769](#12769)) - Move methods that call `add_push_rule` to the `PushRuleStore` class. ([\#12772](#12772)) - Make handling of federation Authorization header (more) compliant with RFC7230. ([\#12774](#12774)) - Refactor `resolve_state_groups_for_events` to not pull out full state when no state resolution happens. ([\#12775](#12775)) - Do not keep going if there are 5 back-to-back background update failures. ([\#12781](#12781)) - Fix federation when using the demo scripts. ([\#12783](#12783)) - The `hash_password` script now fails when it is called without specifying a config file. Contributed by @jae1911. ([\#12789](#12789)) - Improve and fix type hints. ([\#12567](#12567), [\#12477](#12477), [\#12717](#12717), [\#12753](#12753), [\#12695](#12695), [\#12734](#12734), [\#12716](#12716), [\#12726](#12726), [\#12790](#12790), [\#12833](#12833)) - Update EventContext `get_current_event_ids` and `get_prev_event_ids` to accept state filters and update calls where possible. ([\#12791](#12791)) - Remove Caddy from the Synapse workers image used in Complement. ([\#12818](#12818)) - Add Complement's shared registration secret to the Complement worker image. This fixes tests that depend on it. ([\#12819](#12819)) - Support registering Application Services when running with workers under Complement. ([\#12826](#12826)) - Disable 'faster room join' Complement tests when testing against Synapse with workers. ([\#12842](#12842))

@SpiritCroc

Synapse 1.60.0 (2022-05-31) =========================== This release of Synapse adds a unique index to the `state_group_edges` table, in order to prevent accidentally introducing duplicate information (for example, because a database backup was restored multiple times). If your Synapse database already has duplicate rows in this table, this could fail with an error and require manual remediation. Additionally, the signature of the `check_event_for_spam` module callback has changed. The previous signature has been deprecated and remains working for now. Module authors should update their modules to use the new signature where possible. See [the upgrade notes](https://github.com/matrix-org/synapse/blob/develop/docs/upgrade.md#upgrading-to-v1600) for more details. Bugfixes -------- - Fix a bug introduced in Synapse 1.60.0rc1 that would break some imports from `synapse.module_api`. ([\matrix-org#12918](matrix-org#12918)) Synapse 1.60.0rc2 (2022-05-27) ============================== Features -------- - Add an option allowing users to use their password to reauthenticate for privileged actions even though password login is disabled. ([\matrix-org#12883](matrix-org#12883)) Bugfixes -------- - Explicitly close `ijson` coroutines once we are done with them, instead of leaving the garbage collector to close them. ([\matrix-org#12875](matrix-org#12875)) Internal Changes ---------------- - Improve URL previews by not including the content of media tags in the generated description. ([\matrix-org#12887](matrix-org#12887)) Synapse 1.60.0rc1 (2022-05-24) ============================== Features -------- - Measure the time taken in spam-checking callbacks and expose those measurements as metrics. ([\matrix-org#12513](matrix-org#12513)) - Add a `default_power_level_content_override` config option to set default room power levels per room preset. ([\matrix-org#12618](matrix-org#12618)) - Add support for [MSC3787: Allowing knocks to restricted rooms](matrix-org/matrix-spec-proposals#3787). ([\matrix-org#12623](matrix-org#12623)) - Send `USER_IP` commands on a different Redis channel, in order to reduce traffic to workers that do not process these commands. ([\matrix-org#12672](matrix-org#12672), [\matrix-org#12809](matrix-org#12809)) - Synapse will now reload [cache config](https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#caching) when it receives a [SIGHUP](https://en.wikipedia.org/wiki/SIGHUP) signal. ([\matrix-org#12673](matrix-org#12673)) - Add a config options to allow for auto-tuning of caches. ([\matrix-org#12701](matrix-org#12701)) - Update [MSC2716](matrix-org/matrix-spec-proposals#2716) implementation to process marker events from the current state to avoid markers being lost in timeline gaps for federated servers which would cause the imported history to be undiscovered. ([\matrix-org#12718](matrix-org#12718)) - Add a `drop_federated_event` callback to `SpamChecker` to disregard inbound federated events before they take up much processing power, in an emergency. ([\matrix-org#12744](matrix-org#12744)) - Implement [MSC3818: Copy room type on upgrade](matrix-org/matrix-spec-proposals#3818). ([\matrix-org#12786](matrix-org#12786), [\matrix-org#12792](matrix-org#12792)) - Update to the `check_event_for_spam` module callback. Deprecate the current callback signature, replace it with a new signature that is both less ambiguous (replacing booleans with explicit allow/block) and more powerful (ability to return explicit error codes). ([\matrix-org#12808](matrix-org#12808)) Bugfixes -------- - Fix a bug introduced in Synapse 1.7.0 that would prevent events from being sent to clients if there's a retention policy in the room when the support for retention policies is disabled. ([\matrix-org#12611](matrix-org#12611)) - Fix a bug introduced in Synapse 1.57.0 where `/messages` would throw a 500 error when querying for a non-existent room. ([\matrix-org#12683](matrix-org#12683)) - Add a unique index to `state_group_edges` to prevent duplicates being accidentally introduced and the consequential impact to performance. ([\matrix-org#12687](matrix-org#12687)) - Fix a long-standing bug where an empty room would be created when a user with an insufficient power level tried to upgrade a room. ([\matrix-org#12696](matrix-org#12696)) - Fix a bug introduced in Synapse 1.30.0 where empty rooms could be automatically created if a monthly active users limit is set. ([\matrix-org#12713](matrix-org#12713)) - Fix push to dismiss notifications when read on another client. Contributed by @SpiritCroc @ Beeper. ([\matrix-org#12721](matrix-org#12721)) - Fix poor database performance when reading the cache invalidation stream for large servers with lots of workers. ([\matrix-org#12747](matrix-org#12747)) - Delete events from the `federation_inbound_events_staging` table when a room is purged through the admin API. ([\matrix-org#12770](matrix-org#12770)) - Give a meaningful error message when a client tries to create a room with an invalid alias localpart. ([\matrix-org#12779](matrix-org#12779)) - Fix a bug introduced in 1.43.0 where a file (`providers.json`) was never closed. Contributed by @arkamar. ([\matrix-org#12794](matrix-org#12794)) - Fix a long-standing bug where finished log contexts would be re-started when failing to contact remote homeservers. ([\matrix-org#12803](matrix-org#12803)) - Fix a bug, introduced in Synapse 1.21.0, that led to media thumbnails being unusable before the index has been added in the background. ([\matrix-org#12823](matrix-org#12823)) Updates to the Docker image --------------------------- - Fix the docker file after a dependency update. ([\matrix-org#12853](matrix-org#12853)) Improved Documentation ---------------------- - Fix a typo in the Media Admin API documentation. ([\matrix-org#12715](matrix-org#12715)) - Update the OpenID Connect example for Keycloak to be compatible with newer versions of Keycloak. Contributed by @nhh. ([\matrix-org#12727](matrix-org#12727)) - Fix typo in server listener documentation. ([\matrix-org#12742](matrix-org#12742)) - Link to the configuration manual from the welcome page of the documentation. ([\matrix-org#12748](matrix-org#12748)) - Fix typo in `run_background_tasks_on` option name in configuration manual documentation. ([\matrix-org#12749](matrix-org#12749)) - Add information regarding the `rc_invites` ratelimiting option to the configuration docs. ([\matrix-org#12759](matrix-org#12759)) - Add documentation for cancellation of request processing. ([\matrix-org#12761](matrix-org#12761)) - Recommend using docker to run tests against postgres. ([\matrix-org#12765](matrix-org#12765)) - Add missing user directory endpoint from the generic worker documentation. Contributed by @olmari. ([\matrix-org#12773](matrix-org#12773)) - Add additional info to documentation of config option `cache_autotuning`. ([\matrix-org#12776](matrix-org#12776)) - Update configuration manual documentation to document size-related suffixes. ([\matrix-org#12777](matrix-org#12777)) - Fix invalid YAML syntax in the example documentation for the `url_preview_accept_language` config option. ([\matrix-org#12785](matrix-org#12785)) Deprecations and Removals ------------------------- - Require a body in POST requests to `/rooms/{roomId}/receipt/{receiptType}/{eventId}`, as required by the [Matrix specification](https://spec.matrix.org/v1.2/client-server-api/#post_matrixclientv3roomsroomidreceiptreceipttypeeventid). This breaks compatibility with Element Android 1.2.0 and earlier: users of those clients will be unable to send read receipts. ([\matrix-org#12709](matrix-org#12709)) Internal Changes ---------------- - Improve event caching mechanism to avoid having multiple copies of an event in memory at a time. ([\matrix-org#10533](matrix-org#10533)) - Preparation for faster-room-join work: return subsets of room state which we already have, immediately. ([\matrix-org#12498](matrix-org#12498)) - Add `@cancellable` decorator, for use on endpoint methods that can be cancelled when clients disconnect. ([\matrix-org#12586](matrix-org#12586), [\matrix-org#12588](matrix-org#12588), [\matrix-org#12630](matrix-org#12630), [\matrix-org#12694](matrix-org#12694), [\matrix-org#12698](matrix-org#12698), [\matrix-org#12699](matrix-org#12699), [\matrix-org#12700](matrix-org#12700), [\matrix-org#12705](matrix-org#12705)) - Enable cancellation of `GET /rooms/$room_id/members`, `GET /rooms/$room_id/state` and `GET /rooms/$room_id/state/$event_type/*` requests. ([\matrix-org#12708](matrix-org#12708)) - Improve documentation of the `synapse.push` module. ([\matrix-org#12676](matrix-org#12676)) - Refactor functions to on `PushRuleEvaluatorForEvent`. ([\matrix-org#12677](matrix-org#12677)) - Preparation for database schema simplifications: stop writing to `event_reference_hashes`. ([\matrix-org#12679](matrix-org#12679)) - Remove code which updates unused database column `application_services_state.last_txn`. ([\matrix-org#12680](matrix-org#12680)) - Refactor `EventContext` class. ([\matrix-org#12689](matrix-org#12689)) - Remove an unneeded class in the push code. ([\matrix-org#12691](matrix-org#12691)) - Consolidate parsing of relation information from events. ([\matrix-org#12693](matrix-org#12693)) - Convert namespace class `Codes` into a string enum. ([\matrix-org#12703](matrix-org#12703)) - Optimize private read receipt filtering. ([\matrix-org#12711](matrix-org#12711)) - Drop the logging level of status messages for the URL preview cache expiry job from INFO to DEBUG. ([\matrix-org#12720](matrix-org#12720)) - Downgrade some OIDC errors to warnings in the logs, to reduce the noise of Sentry reports. ([\matrix-org#12723](matrix-org#12723)) - Update configs used by Complement to allow more invites/3PID validations during tests. ([\matrix-org#12731](matrix-org#12731)) - Fix a long-standing bug where the user directory background process would fail to make forward progress if a user included a null codepoint in their display name or avatar. ([\matrix-org#12762](matrix-org#12762)) - Tweak the mypy plugin so that `@cached` can accept `on_invalidate=None`. ([\matrix-org#12769](matrix-org#12769)) - Move methods that call `add_push_rule` to the `PushRuleStore` class. ([\matrix-org#12772](matrix-org#12772)) - Make handling of federation Authorization header (more) compliant with RFC7230. ([\matrix-org#12774](matrix-org#12774)) - Refactor `resolve_state_groups_for_events` to not pull out full state when no state resolution happens. ([\matrix-org#12775](matrix-org#12775)) - Do not keep going if there are 5 back-to-back background update failures. ([\matrix-org#12781](matrix-org#12781)) - Fix federation when using the demo scripts. ([\matrix-org#12783](matrix-org#12783)) - The `hash_password` script now fails when it is called without specifying a config file. Contributed by @jae1911. ([\matrix-org#12789](matrix-org#12789)) - Improve and fix type hints. ([\matrix-org#12567](matrix-org#12567), [\matrix-org#12477](matrix-org#12477), [\matrix-org#12717](matrix-org#12717), [\matrix-org#12753](matrix-org#12753), [\matrix-org#12695](matrix-org#12695), [\matrix-org#12734](matrix-org#12734), [\matrix-org#12716](matrix-org#12716), [\matrix-org#12726](matrix-org#12726), [\matrix-org#12790](matrix-org#12790), [\matrix-org#12833](matrix-org#12833)) - Update EventContext `get_current_event_ids` and `get_prev_event_ids` to accept state filters and update calls where possible. ([\matrix-org#12791](matrix-org#12791)) - Remove Caddy from the Synapse workers image used in Complement. ([\matrix-org#12818](matrix-org#12818)) - Add Complement's shared registration secret to the Complement worker image. This fixes tests that depend on it. ([\matrix-org#12819](matrix-org#12819)) - Support registering Application Services when running with workers under Complement. ([\matrix-org#12826](matrix-org#12826)) - Disable 'faster room join' Complement tests when testing against Synapse with workers. ([\matrix-org#12842](matrix-org#12842))

@jcgruenhage

Upstream NEWS, less bugfixes and minor improvements: Synapse 1.61.0 (2022-06-14) =========================== This release removes support for the non-standard feature known both as 'groups' and as 'communities', which have been superseded by *Spaces*. Synapse 1.61.0rc1 (2022-06-07) ============================== Features -------- - Add new `media_retention` options to the homeserver config for routinely cleaning up non-recently accessed media. ([\#12732](matrix-org/synapse#12732), [\#12972](matrix-org/synapse#12972), [\#12977](matrix-org/synapse#12977)) - Experimental support for [MSC3772](matrix-org/matrix-spec-proposals#3772): Push rule for mutually related events. ([\#12740](matrix-org/synapse#12740), [\#12859](matrix-org/synapse#12859)) - Update to the `check_event_for_spam` module callback: Deprecate the current callback signature, replace it with a new signature that is both less ambiguous (replacing booleans with explicit allow/block) and more powerful (ability to return explicit error codes). ([\#12808](matrix-org/synapse#12808)) - Add storage and module API methods to get monthly active users (and their corresponding appservices) within an optionally specified time range. ([\#12838](matrix-org/synapse#12838), [\#12917](matrix-org/synapse#12917)) - Support the new error code `ORG.MATRIX.MSC3823.USER_ACCOUNT_SUSPENDED` from [MSC3823](matrix-org/matrix-spec-proposals#3823). ([\#12845](matrix-org/synapse#12845), [\#12923](matrix-org/synapse#12923)) - Add a configurable background job to delete stale devices. ([\#12855](matrix-org/synapse#12855)) - Allow updating a user's password using the admin API without logging out their devices. Contributed by @jcgruenhage. ([\#12952](matrix-org/synapse#12952)) Deprecations and Removals ------------------------- - Remove support for the non-standard groups/communities feature from Synapse. ([\#12553](matrix-org/synapse#12553), [\#12558](matrix-org/synapse#12558), [\#12563](matrix-org/synapse#12563), [\#12895](matrix-org/synapse#12895), [\#12897](matrix-org/synapse#12897), [\#12899](matrix-org/synapse#12899), [\#12900](matrix-org/synapse#12900), [\#12936](matrix-org/synapse#12936), [\#12966](matrix-org/synapse#12966)) - Remove contributed `kick_users.py` script. This is broken under Python 3, and is not added to the environment when `pip install`ing Synapse. ([\#12908](matrix-org/synapse#12908)) Synapse 1.60.0 (2022-05-31) =========================== This release of Synapse adds a unique index to the `state_group_edges` table, in order to prevent accidentally introducing duplicate information (for example, because a database backup was restored multiple times). If your Synapse database already has duplicate rows in this table, this could fail with an error and require manual remediation. Additionally, the signature of the `check_event_for_spam` module callback has changed. The previous signature has been deprecated and remains working for now. Module authors should update their modules to use the new signature where possible. Synapse 1.60.0rc2 (2022-05-27) ============================== Features -------- - Add an option allowing users to use their password to reauthenticate for privileged actions even though password login is disabled. ([\#12883](matrix-org/synapse#12883)) Synapse 1.60.0rc1 (2022-05-24) ============================== Features -------- - Measure the time taken in spam-checking callbacks and expose those measurements as metrics. ([\#12513](matrix-org/synapse#12513)) - Add a `default_power_level_content_override` config option to set default room power levels per room preset. ([\#12618](matrix-org/synapse#12618)) - Add support for [MSC3787: Allowing knocks to restricted rooms](matrix-org/matrix-spec-proposals#3787). ([\#12623](matrix-org/synapse#12623)) - Send `USER_IP` commands on a different Redis channel, in order to reduce traffic to workers that do not process these commands. ([\#12672](matrix-org/synapse#12672), [\#12809](matrix-org/synapse#12809)) - Synapse will now reload [cache config](https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#caching) when it receives a [SIGHUP](https://en.wikipedia.org/wiki/SIGHUP) signal. ([\#12673](matrix-org/synapse#12673)) - Add a config options to allow for auto-tuning of caches. ([\#12701](matrix-org/synapse#12701)) - Update [MSC2716](matrix-org/matrix-spec-proposals#2716) implementation to process marker events from the current state to avoid markers being lost in timeline gaps for federated servers which would cause the imported history to be undiscovered. ([\#12718](matrix-org/synapse#12718)) - Add a `drop_federated_event` callback to `SpamChecker` to disregard inbound federated events before they take up much processing power, in an emergency. ([\#12744](matrix-org/synapse#12744)) - Implement [MSC3818: Copy room type on upgrade](matrix-org/matrix-spec-proposals#3818). ([\#12786](matrix-org/synapse#12786), [\#12792](matrix-org/synapse#12792)) - Update to the `check_event_for_spam` module callback. Deprecate the current callback signature, replace it with a new signature that is both less ambiguous (replacing booleans with explicit allow/block) and more powerful (ability to return explicit error codes). ([\#12808](matrix-org/synapse#12808)) Deprecations and Removals ------------------------- - Require a body in POST requests to `/rooms/{roomId}/receipt/{receiptType}/{eventId}`, as required by the [Matrix specification](https://spec.matrix.org/v1.2/client-server-api/#post_matrixclientv3roomsroomidreceiptreceipttypeeventid). This breaks compatibility with Element Android 1.2.0 and earlier: users of those clients will be unable to send read receipts. ([\#12709](matrix-org/synapse#12709)) Synapse 1.59.1 (2022-05-18) =========================== This release fixes a long-standing issue which could prevent Synapse's user directory for updating properly. Synapse 1.59.0 (2022-05-17) =========================== Synapse 1.59 makes several changes that server administrators should be aware of: - Device name lookup over federation is now disabled by default. ([\#12616](matrix-org/synapse#12616)) - The `synapse.app.appservice` and `synapse.app.user_dir` worker application types are now deprecated. ([\#12452](matrix-org/synapse#12452), [\#12654](matrix-org/synapse#12654)) Additionally, this release removes the non-standard `m.login.jwt` login type from Synapse. It can be replaced with `org.matrix.login.jwt` for identical behaviour. This is only used if `jwt_config.enabled` is set to `true` in the configuration. ([\#12597](matrix-org/synapse#12597)) Synapse 1.59.0rc2 (2022-05-16) ============================== Synapse 1.59.0rc1 (2022-05-10) ============================== Features -------- - Support [MSC3266](matrix-org/matrix-spec-proposals#3266) room summaries over federation. ([\#11507](matrix-org/synapse#11507)) - Implement [changes](matrix-org/matrix-spec-proposals@4a77139) to [MSC2285 (hidden read receipts)](matrix-org/matrix-spec-proposals#2285). Contributed by @SimonBrandner. ([\#12168](matrix-org/synapse#12168), [\#12635](matrix-org/synapse#12635), [\#12636](matrix-org/synapse#12636), [\#12670](matrix-org/synapse#12670)) - Extend the [module API](https://github.com/matrix-org/synapse/blob/release-v1.59/synapse/module_api/__init__.py) to allow modules to change actions for existing push rules of local users. ([\#12406](matrix-org/synapse#12406)) - Add the `notify_appservices_from_worker` configuration option (superseding `notify_appservices`) to allow a generic worker to be designated as the worker to send traffic to Application Services. ([\#12452](matrix-org/synapse#12452)) - Add the `update_user_directory_from_worker` configuration option (superseding `update_user_directory`) to allow a generic worker to be designated as the worker to update the user directory. ([\#12654](matrix-org/synapse#12654)) - Add new `enable_registration_token_3pid_bypass` configuration option to allow registrations via token as an alternative to verifying a 3pid. ([\#12526](matrix-org/synapse#12526)) - Implement [MSC3786](matrix-org/matrix-spec-proposals#3786): Add a default push rule to ignore `m.room.server_acl` events. ([\#12601](matrix-org/synapse#12601)) - Add new `mau_appservice_trial_days` configuration option to specify a different trial period for users registered via an appservice. ([\#12619](matrix-org/synapse#12619)) Deprecations and Removals ------------------------- - Remove unstable identifiers from [MSC3069](matrix-org/matrix-spec-proposals#3069). ([\#12596](matrix-org/synapse#12596)) - Remove the unspecified `m.login.jwt` login type and the unstable `uk.half-shot.msc2778.login.application_service` from [MSC2778](matrix-org/matrix-spec-proposals#2778). ([\#12597](matrix-org/synapse#12597)) - Synapse now requires at least Python 3.7.1 (up from 3.7.0), for compatibility with the latest Twisted trunk. ([\#12613](matrix-org/synapse#12613))

David Robertson added 2 commits May 9, 2022 14:10

Fix minor typos in cache config docstring

d942823

Add drive-by annotations in s.config._base

077ce90

DMRobertson force-pushed the dmr/reload-cache-factors branch 2 times, most recently from f80e826 to 4bb436d Compare May 9, 2022 13:15

David Robertson added 4 commits May 9, 2022 14:20

Define RootConfig.reload_config_section

1f668be

Move format_config_error to s.config._base

2a5ce2f

right below the definition of ConfigError.

Reload cache config on sighup

69da4ca

Changelog

85f4385

DMRobertson force-pushed the dmr/reload-cache-factors branch from 4bb436d to 85f4385 Compare May 9, 2022 13:21

DMRobertson force-pushed the dmr/reload-cache-factors branch from b0e05ce to 1febfd6 Compare May 9, 2022 13:50

DMRobertson marked this pull request as ready for review May 9, 2022 13:51

DMRobertson requested a review from a team as a code owner May 9, 2022 13:51

erikjohnston reviewed May 10, 2022

View reviewed changes

David Robertson added 4 commits May 10, 2022 14:52

Annotate CacheConfig's instance vars at the top

4039b2d

so I can see what it actually contains

Separate reading and applying cache config

b7a6ec5

Remove redundant assert

519f98b

Create a new config object when reloading

b9595ad

This ensures we don't partially overwrite the existing object if we encounter an exception during `read_config()`.

DMRobertson requested a review from erikjohnston May 10, 2022 13:55

David Robertson added 2 commits May 10, 2022 17:09

Fix tests oops

1118b9f

Document the ability to reload cache config

f6e1394

erikjohnston reviewed May 11, 2022

View reviewed changes

David Robertson added 3 commits May 11, 2022 12:21

Master process needs to apply cache config too.

55963ac

Update TRACK_MEMORY_USAGE on cache config reload

f199d82

Overly comprehensive docstring

412414d

DMRobertson requested a review from erikjohnston May 11, 2022 12:08

erikjohnston approved these changes May 11, 2022

View reviewed changes

Don't update TRACK_MEMORY_USAGE; update docs

a7418c0

DMRobertson requested a review from erikjohnston May 11, 2022 13:15

erikjohnston approved these changes May 11, 2022

View reviewed changes

DMRobertson changed the title ~~Reload cache config on SIGHUP.~~ Reload cache factors from disk on SIGHUP May 11, 2022

DMRobertson enabled auto-merge (squash) May 11, 2022 13:40

DMRobertson merged commit d38d242 into develop May 11, 2022

DMRobertson deleted the dmr/reload-cache-factors branch May 11, 2022 13:43

DMRobertson mentioned this pull request Jul 21, 2022

Reload opentracing config on SIGHUP #13351

Open

DMRobertson mentioned this pull request Oct 21, 2022

TypeError: not all arguments converted during string formatting on SIGHUP #14257

Closed

DMRobertson mentioned this pull request Aug 7, 2023

systemctl reload matrix-synapse only reloads cache configuration #16071

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Reload cache factors from disk on SIGHUP #12673

Reload cache factors from disk on SIGHUP #12673

DMRobertson commented May 9, 2022 •

edited

Loading

erikjohnston left a comment

erikjohnston May 10, 2022

DMRobertson May 10, 2022

DMRobertson May 10, 2022

erikjohnston May 10, 2022

DMRobertson May 10, 2022

DMRobertson May 10, 2022

DMRobertson commented May 10, 2022

erikjohnston May 11, 2022

DMRobertson May 11, 2022

DMRobertson May 11, 2022

erikjohnston May 11, 2022

DMRobertson May 11, 2022

erikjohnston left a comment

erikjohnston May 11, 2022

DMRobertson May 11, 2022

erikjohnston May 11, 2022

DMRobertson May 11, 2022

DMRobertson commented May 11, 2022 •

edited

Loading

Reload cache factors from disk on SIGHUP #12673

Reload cache factors from disk on SIGHUP #12673

Conversation

DMRobertson commented May 9, 2022 • edited Loading

Not tested under workers.

erikjohnston 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

Choose a reason for hiding this comment

DMRobertson commented May 10, 2022

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

erikjohnston 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

DMRobertson commented May 11, 2022 • edited Loading

DMRobertson commented May 9, 2022 •

edited

Loading

DMRobertson commented May 11, 2022 •

edited

Loading