Rename storage classes #12913

erikjohnston · 2022-05-30T08:31:25Z

As per #11733

richvdh

#11733 (comment) suggests some changes to the packages too. Please can they happen?

erikjohnston · 2022-05-30T12:38:32Z

Yay, this is going to cause all the merge conflicts.

richvdh

while you're renaming properties, please can you give them underscore prefixes?

richvdh · 2022-05-30T13:10:46Z

synapse/federation/federation_server.py

@@ -109,7 +109,7 @@ def __init__(self, hs: "HomeServer"):
        super().__init__(hs)

        self.handler = hs.get_federation_handler()
-        self.storage = hs.get_storage()
+        self.storage_controllers = hs.get_storage_controllers()


if this isn't used, let's get rid of it.

updated

richvdh

lgtm in general.

Please update the docstring at

synapse/synapse/storage/__init__.py

Line 17 in 4302238

The storage layer is split up into multiple parts to allow Synapse to run

to mention storage controllers.

synapse/state/__init__.py

synapse/storage/controllers/state.py

richvdh · 2022-05-30T13:45:21Z

synapse/storage/state.py

@@ -578,318 +573,3 @@ def must_await_full_state(self, is_mine_id: Callable[[str], bool]) -> bool:
    types=frozendict({EventTypes.Member: frozenset()}), include_others=True
 )
 _NONE_STATE_FILTER = StateFilter(types=frozendict(), include_others=False)


I wonder if we ought to move the StateFilter stuff too. Is it used anywhere other than to pass down to StateGroupStorage ?

I'd be tempted to leave it where it is TBH, we tend to define types that are external to the synapse.storage module in top level files 🤷

I don't disagree, but I don't follow your reasoning.

we tend to define types that are external to the synapse.storage module in top level files

... like what? And this is a type internal to the synapse.storage module, so how is it relevant?

synapse.storage.roommember has a bunch of types in it for example?

And this is a type internal to the synapse.storage module, so how is it relevant?

The StateFilter is used all over the code base to specify the filter. If you mean _NONE_STATE_FILTER and co, then they are used solely by the StateFilter class?

oh right. by "external" you mean "part of the external api", sorry.

I'm not convinced that's a convention we actually follow, but I don't mind it staying here for now anyway.

richvdh

some word-wrangling, lgtm otherwise

synapse/storage/__init__.py

@olmari

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*. See [the upgrade notes](https://github.com/matrix-org/synapse/blob/develop/docs/upgrade.md#upgrading-to-v1610) for more details. Improved Documentation ---------------------- - Mention removed community/group worker endpoints in [upgrade.md](https://github.com/matrix-org/synapse/blob/develop/docs/upgrade.md#upgrading-to-v1610s). Contributed by @olmari. ([\matrix-org#13023](matrix-org#13023)) 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. ([\matrix-org#12732](matrix-org#12732), [\matrix-org#12972](matrix-org#12972), [\matrix-org#12977](matrix-org#12977)) - Experimental support for [MSC3772](matrix-org/matrix-spec-proposals#3772): Push rule for mutually related events. ([\matrix-org#12740](matrix-org#12740), [\matrix-org#12859](matrix-org#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). ([\matrix-org#12808](matrix-org#12808)) - Add storage and module API methods to get monthly active users (and their corresponding appservices) within an optionally specified time range. ([\matrix-org#12838](matrix-org#12838), [\matrix-org#12917](matrix-org#12917)) - Support the new error code `ORG.MATRIX.MSC3823.USER_ACCOUNT_SUSPENDED` from [MSC3823](matrix-org/matrix-spec-proposals#3823). ([\matrix-org#12845](matrix-org#12845), [\matrix-org#12923](matrix-org#12923)) - Add a configurable background job to delete stale devices. ([\matrix-org#12855](matrix-org#12855)) - Improve URL previews for pages with empty elements. ([\matrix-org#12951](matrix-org#12951)) - Allow updating a user's password using the admin API without logging out their devices. Contributed by @jcgruenhage. ([\matrix-org#12952](matrix-org#12952)) Bugfixes -------- - Always send an `access_token` in `/thirdparty/` requests to appservices, as required by the [Application Service API specification](https://spec.matrix.org/v1.1/application-service-api/#third-party-networks). ([\matrix-org#12746](matrix-org#12746)) - Implement [MSC3816](matrix-org/matrix-spec-proposals#3816): sending the root event in a thread should count as having 'participated' in it. ([\matrix-org#12766](matrix-org#12766)) - Delete events from the `federation_inbound_events_staging` table when a room is purged through the admin API. ([\matrix-org#12784](matrix-org#12784)) - Fix a bug where we did not correctly handle invalid device list updates over federation. Contributed by Carl Bordum Hansen. ([\matrix-org#12829](matrix-org#12829)) - Fix a bug which allowed multiple async operations to access database locks concurrently. Contributed by @sumnerevans @ Beeper. ([\matrix-org#12832](matrix-org#12832)) - Fix an issue introduced in Synapse 0.34 where the `/notifications` endpoint would only return notifications if a user registered at least one pusher. Contributed by Famedly. ([\matrix-org#12840](matrix-org#12840)) - Fix a bug where servers using a Postgres database would fail to backfill from an insertion event when MSC2716 is enabled (`experimental_features.msc2716_enabled`). ([\matrix-org#12843](matrix-org#12843)) - Fix [MSC3787](matrix-org/matrix-spec-proposals#3787) rooms being omitted from room directory, room summary and space hierarchy responses. ([\matrix-org#12858](matrix-org#12858)) - Fix a bug introduced in Synapse 1.54.0 which could sometimes cause exceptions when handling federated traffic. ([\matrix-org#12877](matrix-org#12877)) - Fix a bug introduced in Synapse 1.59.0 which caused room deletion to fail with a foreign key violation error. ([\matrix-org#12889](matrix-org#12889)) - Fix a long-standing bug which caused the `/messages` endpoint to return an incorrect `end` attribute when there were no more events. Contributed by @Vetchu. ([\matrix-org#12903](matrix-org#12903)) - Fix a bug introduced in Synapse 1.58.0 where `/sync` would fail if the most recent event in a room was a redaction of an event that has since been purged. ([\matrix-org#12905](matrix-org#12905)) - Fix a potential memory leak when generating thumbnails. ([\matrix-org#12932](matrix-org#12932)) - Fix a long-standing bug where a URL preview would break if the image failed to download. ([\matrix-org#12950](matrix-org#12950)) Improved Documentation ---------------------- - Fix typographical errors in documentation. ([\matrix-org#12863](matrix-org#12863)) - Fix documentation incorrectly stating the `sendToDevice` endpoint can be directed at generic workers. Contributed by Nick @ Beeper. ([\matrix-org#12867](matrix-org#12867)) Deprecations and Removals ------------------------- - Remove support for the non-standard groups/communities feature from Synapse. ([\matrix-org#12553](matrix-org#12553), [\matrix-org#12558](matrix-org#12558), [\matrix-org#12563](matrix-org#12563), [\matrix-org#12895](matrix-org#12895), [\matrix-org#12897](matrix-org#12897), [\matrix-org#12899](matrix-org#12899), [\matrix-org#12900](matrix-org#12900), [\matrix-org#12936](matrix-org#12936), [\matrix-org#12966](matrix-org#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. ([\matrix-org#12908](matrix-org#12908)) - Remove `contrib/jitsimeetbridge`. This was an unused experiment that hasn't been meaningfully changed since 2014. ([\matrix-org#12909](matrix-org#12909)) - Remove unused `contrib/experiements/cursesio.py` script, which fails to run under Python 3. ([\matrix-org#12910](matrix-org#12910)) - Remove unused `contrib/experiements/test_messaging.py` script. This fails to run on Python 3. ([\matrix-org#12911](matrix-org#12911)) Internal Changes ---------------- - Test Synapse against Complement with workers. ([\matrix-org#12810](matrix-org#12810), [\matrix-org#12933](matrix-org#12933)) - Reduce the amount of state we pull from the DB. ([\matrix-org#12811](matrix-org#12811), [\matrix-org#12964](matrix-org#12964)) - Try other homeservers when re-syncing state for rooms with partial state. ([\matrix-org#12812](matrix-org#12812)) - Resume state re-syncing for rooms with partial state after a Synapse restart. ([\matrix-org#12813](matrix-org#12813)) - Remove Mutual Rooms' ([MSC2666](matrix-org/matrix-spec-proposals#2666)) endpoint dependency on the User Directory. ([\matrix-org#12836](matrix-org#12836)) - Experimental: expand `check_event_for_spam` with ability to return additional fields. This enables spam-checker implementations to experiment with mechanisms to give users more information about why they are blocked and whether any action is needed from them to be unblocked. ([\matrix-org#12846](matrix-org#12846)) - Remove `dont_notify` from the `.m.rule.room.server_acl` rule. ([\matrix-org#12849](matrix-org#12849)) - Remove the unstable `/hierarchy` endpoint from [MSC2946](matrix-org/matrix-spec-proposals#2946). ([\matrix-org#12851](matrix-org#12851)) - Pull out less state when handling gaps in room DAG. ([\matrix-org#12852](matrix-org#12852), [\matrix-org#12904](matrix-org#12904)) - Clean-up the push rules datastore. ([\matrix-org#12856](matrix-org#12856)) - Correct a type annotation in the URL preview source code. ([\matrix-org#12860](matrix-org#12860)) - Update `pyjwt` dependency to [2.4.0](https://github.com/jpadilla/pyjwt/releases/tag/2.4.0). ([\matrix-org#12865](matrix-org#12865)) - Enable the `/account/whoami` endpoint on synapse worker processes. Contributed by Nick @ Beeper. ([\matrix-org#12866](matrix-org#12866)) - Enable the `batch_send` endpoint on synapse worker processes. Contributed by Nick @ Beeper. ([\matrix-org#12868](matrix-org#12868)) - Don't generate empty AS transactions when the AS is flagged as down. Contributed by Nick @ Beeper. ([\matrix-org#12869](matrix-org#12869)) - Fix up the variable `state_store` naming. ([\matrix-org#12871](matrix-org#12871)) - Faster room joins: when querying the current state of the room, wait for state to be populated. ([\matrix-org#12872](matrix-org#12872)) - Avoid running queries which will never result in deletions. ([\matrix-org#12879](matrix-org#12879)) - Use constants for EDU types. ([\matrix-org#12884](matrix-org#12884)) - Reduce database load of `/sync` when presence is enabled. ([\matrix-org#12885](matrix-org#12885)) - Refactor `have_seen_events` to reduce memory consumed when processing federation traffic. ([\matrix-org#12886](matrix-org#12886)) - Refactor receipt linearization code. ([\matrix-org#12888](matrix-org#12888)) - Add type annotations to `synapse.logging.opentracing`. ([\matrix-org#12894](matrix-org#12894)) - Remove PyNaCl occurrences directly used in Synapse code. ([\matrix-org#12902](matrix-org#12902)) - Bump types-jsonschema from 4.4.1 to 4.4.6. ([\matrix-org#12912](matrix-org#12912)) - Rename storage classes. ([\matrix-org#12913](matrix-org#12913)) - Preparation for database schema simplifications: stop reading from `event_edges.room_id`. ([\matrix-org#12914](matrix-org#12914)) - Check if we are in a virtual environment before overriding the `PYTHONPATH` environment variable in the demo script. ([\matrix-org#12916](matrix-org#12916)) - Improve the logging when signature checks on events fail. ([\matrix-org#12925](matrix-org#12925)) # -----BEGIN PGP SIGNATURE----- # # iQFEBAABCgAuFiEEBTGR3/RnAzBGUif3pULk7RsPrAkFAmKoaa0QHGVyaWtAbWF0 # cml4Lm9yZwAKCRClQuTtGw+sCVn3B/sF8hdhrZ7hWW40ST3eG9cEKNFrj/xZXiaI # zho3ryrxaQF68BSKot15AvZSprEdwBXWrb8WeTjyw+QH7vTKrCQDZ0p7qubn10Z7 # BuKq9hyYjyCLjBZrgy8d4U3Y8gsSByuO59YKHNLn+UTJLOs5GTH8Wprwh4mpU3Jl # +o+cC+lMSVcyZij2hihFymcSxWq/I9WL0dsjRif8x0BUQwRXwmXc6+mhlgLBe2Zs # 2dUouzJ8NVZcjfWvsg4noXPrNQ/IiyCVZlSIgaDftDIxVSPk5/rXiUUNex8Tn1+I # TnOgnXhpOQD1vwVGYS8LrcfA0ubSili7xUJ8k2e5TkCjpkaVnYNu # =q+7N # -----END PGP SIGNATURE----- # gpg: Signature made Tue Jun 14 11:57:49 2022 BST # gpg: using RSA key 053191DFF4670330465227F7A542E4ED1B0FAC09 # gpg: issuer "[email protected]" # gpg: WARNING: server 'dirmngr' is older than us (2.2.34 < 2.3.6) # gpg: Note: Outdated servers may lack important security fixes. # gpg: Note: Use the command "gpgconf --kill all" to restart them. # gpg: Can't check signature: No public key # Conflicts: # docs/workers.md # synapse/handlers/message.py # synapse/handlers/pagination.py # synapse/push/bulk_push_rule_evaluator.py # synapse/push/push_rule_evaluator.py # synapse/rest/client/receipts.py # synapse/storage/databases/main/appservice.py # tests/push/test_push_rule_evaluator.py

erikjohnston added 2 commits May 30, 2022 09:20

Rename storage classes

0b7f62c

Rename vars

78211cb

erikjohnston mentioned this pull request May 30, 2022

our storage classes are hella confusing #11733

Open

5 tasks

erikjohnston marked this pull request as ready for review May 30, 2022 08:39

erikjohnston requested a review from a team as a code owner May 30, 2022 08:39

erikjohnston added 2 commits May 30, 2022 09:59

Rename Storage and vars

c188ed6

Newsfile

cc94571

erikjohnston force-pushed the erikj/rename_storages branch from 8e7b2f5 to cc94571 Compare May 30, 2022 08:59

erikjohnston added 2 commits May 30, 2022 10:37

Fix tests

77aa3ae

Commit unsaved files...

25b5c86

richvdh self-assigned this May 30, 2022

richvdh previously requested changes May 30, 2022

View reviewed changes

richvdh removed their assignment May 30, 2022

richvdh mentioned this pull request May 30, 2022

Wait for lazy join to complete when getting current state #12872

Merged

Mvoe stuff to storage.controllers

179e1c3

richvdh reviewed May 30, 2022

View reviewed changes

Rename vars

4302238

richvdh self-assigned this May 30, 2022

richvdh reviewed May 30, 2022

View reviewed changes

richvdh removed their assignment May 30, 2022

erikjohnston added 3 commits May 30, 2022 17:03

Fix missing rename

2c7a4f7

Spurious newline

8dbf7fd

Mention storage controllers

4dd4d30

erikjohnston requested a review from richvdh May 30, 2022 16:09

richvdh approved these changes May 30, 2022

View reviewed changes

synapse/storage/__init__.py Outdated Show resolved Hide resolved

erikjohnston added 2 commits May 31, 2022 12:46

Fix wording

caf2dba

Merge remote-tracking branch 'origin/develop' into erikj/rename_storages

1af0e91

erikjohnston enabled auto-merge (squash) May 31, 2022 11:48

erikjohnston merged commit 1e45305 into develop May 31, 2022

erikjohnston deleted the erikj/rename_storages branch May 31, 2022 12:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rename storage classes #12913

Rename storage classes #12913

erikjohnston commented May 30, 2022

richvdh left a comment

erikjohnston commented May 30, 2022

richvdh left a comment

richvdh May 30, 2022

richvdh left a comment

richvdh May 30, 2022

erikjohnston May 30, 2022

richvdh May 30, 2022

erikjohnston May 30, 2022

richvdh May 30, 2022

richvdh left a comment

Rename storage classes #12913

Rename storage classes #12913

Conversation

erikjohnston commented May 30, 2022

richvdh left a comment

Choose a reason for hiding this comment

erikjohnston commented May 30, 2022

richvdh left a comment

Choose a reason for hiding this comment

richvdh May 30, 2022

Choose a reason for hiding this comment

richvdh left a comment

Choose a reason for hiding this comment

richvdh May 30, 2022

Choose a reason for hiding this comment

erikjohnston May 30, 2022

Choose a reason for hiding this comment

richvdh May 30, 2022

Choose a reason for hiding this comment

erikjohnston May 30, 2022

Choose a reason for hiding this comment

richvdh May 30, 2022

Choose a reason for hiding this comment

richvdh left a comment

Choose a reason for hiding this comment