mirror of
https://github.com/element-hq/synapse.git
synced 2026-07-29 03:20:23 +00:00
Eric EastwoodandGitHub
c5e5abb822
Use weakref to Python `DatabasePool` to allow homeserver to cleanly shutdown Spawning from [upgrading](https://github.com/element-hq/synapse-small-hosts/pull/420#discussion_r3661700252) the Synapse version in Synapse Pro for small hosts and seeing our tenant deprovision tests failing (end-to-end Complement tests). Specifically, it was failing with a test in [`TestLogging`](https://github.com/element-hq/synapse-small-hosts/blob/f24ee731ff419890680d1d80ef6eafe44f87f2c2/complement/tests/multi_synapse/logging_test.go#L328-L385) in CI but was equally reproducible with any test where we deprovision (`deployment.StopServer(...)`) like [`TestProvisionHomeserverTenant/deprovision_homeserver_tenant`](https://github.com/element-hq/synapse-small-hosts/blob/f24ee731ff419890680d1d80ef6eafe44f87f2c2/complement/tests/multi_synapse/provision_test.go#L48-L58). Clean homeserver shutdown specifically regressed with the changes from https://github.com/element-hq/synapse/pull/19878. The `PythonDatabasePoolWrapper` in Rust holds onto a reference to the Python `DatabasePool` which references the Python `HomeServer` and keeps the `HomeServer` from being garbage collected on the Python side. This PR updates `PythonDatabasePoolWrapper` to use a weak reference. ### Dev notes Previous PR where we had to deal with Rust <-> Python reference cycles, https://github.com/element-hq/synapse/pull/19837#discussion_r3425358096 PyO3 garbage collector docs (`__traverse__`, `__clear__`): https://pyo3.rs/v0.28.3/class/protocols#garbage-collector-integration ### Pull Request Checklist <!-- Please read https://element-hq.github.io/synapse/latest/development/contributing_guide.html before submitting your pull request --> * [x] Pull request is based on the develop branch * [x] Pull request includes a [changelog file](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#changelog). The entry should: - Be a short description of your change which makes sense to users. "Fixed a bug that prevented receiving messages from other servers." instead of "Moved X method from `EventStore` to `EventWorkerStore`.". - Use markdown where necessary, mostly for `code blocks`. - End with either a period (.) or an exclamation mark (!). - Start with a capital letter. - Feel free to credit yourself, by adding a sentence "Contributed by @github_username." or "Contributed by [Your Name]." to the end of the entry. * [x] [Code style](https://element-hq.github.io/synapse/latest/code_style.html) is correct (run the [linters](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#run-the-linters))