synapse/CHANGES.md

Synapse 1.96.1 (2023-11-17)

Synapse will soon be forked by Element under an AGPLv3.0 licence (with CLA, for proprietary dual licensing). You can read more about this here:

• https://matrix.org/blog/2023/11/06/future-of-synapse-dendrite/
• https://element.io/blog/element-to-adopt-agplv3/

The Matrix.org Foundation copy of the project will be archived. Any changes needed by server administrators will be communicated via our usual announcements channels, but we are striving to make this as seamless as possible.

This minor release was needed only because of CI-related trouble on v1.96.0, which was never released.

Internal Changes

• Fix building of wheels in CI. (#16653)

Synapse 1.96.0 (2023-11-16)

Bugfixes

• Fix "'int' object is not iterable" error in set_device_id_for_pushers background update introduced in Synapse 1.95.0. (#16594)

Synapse 1.96.0rc1 (2023-10-31)

Features

• Add experimental support to allow multiple workers to write to receipts stream. (#16432)
• Add a new module API for controller presence. (#16544)
• Add a new module API callback that allows adding extra fields to events' unsigned section when sent down to clients. (#16549)
• Improve the performance of claiming encryption keys. (#16565, #16570)

Bugfixes

• Fixed a bug in the example Grafana dashboard that prevents it from finding the correct datasource. Contributed by @MichaelSasser. (#16471)
• Fix a long-standing, exceedingly rare edge case where the first event persisted by a new event persister worker might not be sent down /sync. (#16473, #16557, #16561, #16578, #16580)
• Fix long-standing bug where /sync incorrectly did not mark a room as limited in a sync requests when there were missing remote events. (#16485)
• Fix a bug introduced in Synapse 1.41 where HTTP(S) forward proxy authorization would fail when using basic HTTP authentication with a long username:password string. (#16504)
• Force TLS certificate verification in user registration script. (#16530)
• Fix long-standing bug where /sync could tightloop after restart when using SQLite. (#16540)
• Fix ratelimiting of message sending when using workers, where the ratelimit would only be applied after most of the work has been done. (#16558)
• Fix a long-standing bug where invited/knocking users would not leave during a room purge. (#16559)

Improved Documentation

• Improve documentation of presence router. (#16529)
• Add a sentence to the opentracing docs on how you can have jaeger in a different place than synapse. (#16531)
• Correctly describe the meaning of unspecified rule lists in the alias_creation_rules and room_list_publication_rules config options and improve their descriptions more generally. (#16541)
• Pin the recommended poetry version in contributors' guide. (#16550)
• Fix a broken link to the client breakdown in the README. (#16569)

Internal Changes

• Improve performance of delete device messages query, cf issue 16479. (#16492)
• Reduce memory allocations. (#16505)
• Improve replication performance when purging rooms. (#16510)
• Run tests against Python 3.12. (#16511)
• Run trial & integration tests in continuous integration when .ci directory is modified. (#16512)
• Remove duplicate call to mark remote server 'awake' when using a federation sending worker. (#16515)
• Enable dirty runs on Complement CI, which is significantly faster. (#16520)
• Stop deleting from an unused table. (#16521)
• Improve type hints. (#16526, #16551)
• Fix running unit tests on Twisted trunk. (#16528)
• Reduce some spurious logging in worker mode. (#16555)
• Stop porting a table in port db that we're going to nuke and rebuild anyway. (#16563)
• Deal with warnings from running complement in CI. (#16567)
• Allow building with setuptools_rust 1.8.0. (#16574)

Updates to locked dependencies

• Bump black from 23.10.0 to 23.10.1. (#16575)
• Bump black from 23.9.1 to 23.10.0. (#16538)
• Bump cryptography from 41.0.4 to 41.0.5. (#16572)
• Bump gitpython from 3.1.37 to 3.1.40. (#16534)
• Bump phonenumbers from 8.13.22 to 8.13.23. (#16576)
• Bump pygithub from 1.59.1 to 2.1.1. (#16535)

• Bump matrix-synapse-ldap3 from 0.2.2 to 0.3.0. (#16539)

• Bump serde from 1.0.189 to 1.0.190. (#16577)
• Bump setuptools-rust from 1.7.0 to 1.8.0. (#16574)
• Bump types-pillow from 10.0.0.3 to 10.1.0.0. (#16536)
• Bump types-psycopg2 from 2.9.21.14 to 2.9.21.15. (#16573)
• Bump types-requests from 2.31.0.2 to 2.31.0.10. (#16537)
• Bump urllib3 from 1.26.17 to 1.26.18. (#16516)

Synapse 1.95.1 (2023-10-31)

Security advisory

The following issue is fixed in 1.95.1.

• GHSA-mp92-3jfm-3575 / CVE-2023-43796 — Moderate Severity

  Cached device information of remote users can be queried from Synapse. This can be used to enumerate the remote users known to a homeserver.

See the advisory for more details. If you have any questions, email security@matrix.org.

Synapse 1.95.0 (2023-10-24)

Internal Changes

• Build Debian packages for Ubuntu 23.10 Mantic Minotaur. (#16524)

Synapse 1.95.0rc1 (2023-10-17)

Bugfixes

• Remove legacy unspecced knock_state_events field returned in some responses. (#16403)
• Fix a bug introduced in Synapse 1.81.0 where an AttributeError would be raised when _matrix/client/v3/account/whoami is called over a unix socket. Contributed by @Sir-Photch. (#16404)
• Properly return inline media when content types have parameters. (#16440)
• Prevent the purging of large rooms from timing out when Postgres is in use. The timeout which causes this issue was introduced in Synapse 1.88.0. (#16455)
• Improve the performance of purging rooms, particularly encrypted rooms. (#16457)
• Fix a bug introduced in Synapse 1.59.0 where servers could be incorrectly marked as available after an error response was received. (#16506)

Improved Documentation

• Document internal background update mechanism. (#16420)
• Fix a typo in the sql for useful SQL for admins document. (#16477)

Internal Changes

• Bump pyo3 from 0.17.1 to 0.19.2. (#16162)
• Update registration of media repository URLs. (#16419)
• Improve type hints. (#16421, #16468, #16469, #16507)
• Refactor some code to simplify and better type receipts stream adjacent code. (#16426)
• Factor out MultiWriter token from RoomStreamToken. (#16427)
• Improve code comments. (#16428)
• Reduce memory allocations. (#16429, #16431, #16433, #16434, #16438, #16444)
• Remove unused method. (#16435)
• Improve rate limiting logic. (#16441)
• Do not block running of CI behind the check for sign-off on PRs. (#16454)
• Update the release script to remind releaser to check for special release notes. (#16461)
• Update complement.sh to match new public API shape. (#16466)
• Clean up logging on event persister endpoints. (#16488)
• Remove useless async job to delete device messages on sync, since we only deliver (and hence delete) up to 100 device messages at a time. (#16491)

Updates to locked dependencies

• Bump bleach from 6.0.0 to 6.1.0. (#16451)
• Bump jsonschema from 4.19.0 to 4.19.1. (#16500)
• Bump netaddr from 0.8.0 to 0.9.0. (#16453)
• Bump packaging from 23.1 to 23.2. (#16497)
• Bump pillow from 10.0.1 to 10.1.0. (#16498)
• Bump psycopg2 from 2.9.8 to 2.9.9. (#16452)
• Bump pyo3-log from 0.8.3 to 0.8.4. (#16495)
• Bump ruff from 0.0.290 to 0.0.292. (#16449)
• Bump sentry-sdk from 1.31.0 to 1.32.0. (#16496)
• Bump serde from 1.0.188 to 1.0.189. (#16494)
• Bump types-bleach from 6.0.0.4 to 6.1.0.0. (#16450)
• Bump types-jsonschema from 4.17.0.10 to 4.19.0.3. (#16499)

Synapse 1.94.0 (2023-10-10)

No significant changes since 1.94.0rc1. However, please take note of the security advisory that follows.

Security advisory

The following issue is fixed in 1.94.0 (and RC).

• GHSA-5chr-wjw5-3gq4 / CVE-2023-45129 — Moderate Severity

  A malicious server ACL event can impact performance temporarily or permanently leading to a persistent denial of service.

  Homeservers running on a closed federation (which presumably do not need to use server ACLs) are not affected.

See the advisory for more details. If you have any questions, email security@matrix.org.

Synapse 1.94.0rc1 (2023-10-03)

Features

• Render plain, CSS, CSV, JSON and common image formats in the browser (inline) when requested through the /download endpoint. (#15988)
• Add experimental support for MSC4028 to push all encrypted events to clients. (#16361)
• Minor performance improvement when sending presence to federated servers. (#16385)
• Minor performance improvement by caching server ACL checking. (#16360)

Improved Documentation

• Add developer documentation concerning gradual schema migrations with column alterations. (#15691)
• Improve documentation of the user directory search algorithm. (#16320)
• Fix rendering of user admin API documentation around deactivation. This was broken in Synapse 1.91.0. (#16355)
• Update documentation around message retention policies. (#16382)
• Add note to federation_domain_whitelist config option to clarify its usage. (#16416)
• Improve legacy release notes. (#16418)

Deprecations and Removals

• Remove Python version from /_synapse/admin/v1/server_version. (#16380)

Internal Changes

• Avoid running CI steps when the files they check have not been changed. (#14745, #16387)
• Improve type hints. (#14911, #16350, #16356, #16395)
• Added support for pydantic v2 in addition to pydantic v1. Contributed by Maxwell G (@gotmax23). (#16332)
• Get CI to check PRs have been signed-off. (#16348)
• Add missing licence header. (#16359)
• Improve type hints, and bump types-psycopg2 from 2.9.21.11 to 2.9.21.14. (#16381)
• Improve comments in StateGroupBackgroundUpdateStore. (#16383)
• Update maturin configuration. (#16394)
• Downgrade replication stream time out error log lines to warning. (#16401)

Updates to locked dependencies

• Bump actions/checkout from 3 to 4. (#16250)
• Bump cryptography from 41.0.3 to 41.0.4. (#16362)
• Bump dawidd6/action-download-artifact from 2.27.0 to 2.28.0. (#16374)
• Bump docker/setup-buildx-action from 2 to 3. (#16375)
• Bump gitpython from 3.1.35 to 3.1.37. (#16376)
• Bump msgpack from 1.0.5 to 1.0.6. (#16377)
• Bump msgpack from 1.0.6 to 1.0.7. (#16412)
• Bump phonenumbers from 8.13.19 to 8.13.22. (#16413)
• Bump psycopg2 from 2.9.7 to 2.9.8. (#16409)
• Bump pydantic from 2.3.0 to 2.4.2. (#16410)
• Bump regex from 1.9.5 to 1.9.6. (#16408)
• Bump sentry-sdk from 1.30.0 to 1.31.0. (#16378)
• Bump types-netaddr from 0.8.0.9 to 0.9.0.1. (#16411)
• Bump types-psycopg2 from 2.9.21.11 to 2.9.21.14. (#16381)
• Bump urllib3 from 1.26.15 to 1.26.17. (#16422)

Synapse 1.93.0 (2023-09-26)

No significant changes since 1.93.0rc1.

Security advisory

The following issues are fixed in 1.93.0 (and RCs).

• GHSA-4f74-84v3-j9q5 / CVE-2023-41335 — Low Severity

  Temporary storage of plaintext passwords during password changes.

• GHSA-7565-cq32-vx2x / CVE-2023-42453 — Low Severity

  Improper validation of receipts allows forged read receipts.

See the advisories for more details. If you have any questions, email security@matrix.org.

Synapse 1.93.0rc1 (2023-09-19)

Features

• Add automatic purge after all users have forgotten a room. (#15488)
• Restore room purge/shutdown after a Synapse restart. (#15488)
• Support resolving homeservers using matrix-fed DNS SRV records from MSC4040. (#16137)
• Add the ability to use G (GiB) and T (TiB) suffixes in configuration options that refer to numbers of bytes. (#16219)
• Add span information to requests sent to appservices. Contributed by MTRNord. (#16227)
• Add the ability to enable/disable registrations when using CAS. Contributed by Aurélien Grimpard. (#16262)
• Allow the /notifications endpoint to be routed to workers. (#16265)
• Enable users to easily unsubscribe to notifications emails via the List-Unsubscribe header. (#16274)
• Report whether a user is locked in the List Accounts admin API, and exclude locked users by default. (#16328)

Bugfixes

• Fix a long-standing bug where multi-device accounts could cause high load due to presence. (#16066, #16170, #16171, #16172, #16174)
• Fix a long-standing bug where appservices using MSC2409 to receive to_device messages would only get messages for one user. (#16251)
• Fix bug when using workers where Synapse could end up re-requesting the same remote device repeatedly. (#16252)
• Fix long-standing bug where we kept re-requesting a remote server's key repeatedly, potentially causing delays in receiving events over federation. (#16257)
• Avoid temporary storage of sensitive information. (#16272)
• Fix bug introduced in Synapse 1.49.0 when using dehydrated devices (MSC2697) and refresh tokens. Contributed by Hanadi. (#16288)
• Fix a long-standing bug where invalid receipts would be accepted. (#16327)
• Use standard name for UTF-8 charset in emails. (#16329)
• Don't try refetching device lists for users on remote hosts that are marked as "down". (#16298)

Improved Documentation

• Fix typos in the documentation. (#16282)
• Link to the Alpine Linux community package for Synapse. (#16304)
• Use string for federation_client_minimum_tls_version documentation examples. Contributed by @jcgruenhage. (#16353)

Internal Changes

• Allow modules to delete rooms. (#15997)
• Add GCC and GNU Make to the Nix flake development environment so that ruff can be compiled. (#16090, #16263)
• Fix type checking when using the new version of Twisted. (#16235)
• Delete device messages asynchronously and in staged batches using the task scheduler. (#16240, #16311, #16312, #16313)
• Bump minimum supported Rust version to 1.61.0. (#16248)
• Update rust to version 1.71.1 in the nix development environment. (#16260)
• Simplify server key storage. (#16261)
• Reduce CPU overhead of change password endpoint. (#16264)
• Stop purging from tables slated for removal. (#16273)
• Improve type hints. (#16276, #16301, #16325, #16326)
• Raise setuptools_rust version cap to 1.7.0. (#16277)
• Fix using the new task scheduler causing lots of CPU to be used. (#16278)
• Upgrade CI run of Python 3.12 from rc1 to rc2. (#16280)
• Include values in SQL debug when using execute_values with Postgres. (#16281)
• Enable additional linting checks. (#16283)
• Refactor receipts_graph Postgres transactions to stop error messages. (#16299)
• Small improvements to logging in replication code. (#16309)
• Remove a reference cycle in background processes. (#16314)
• Only use literal strings for background process names. (#16315)
• Refactor get_user_by_id. (#16316)
• Speed up task to delete to-device messages. (#16318)
• Avoid patching code in tests. (#16349)
• Test against PostgreSQL 16. (#16351)

Updates to locked dependencies

• Bump mypy from 1.4.1 to 1.5.1. (#16300)
• Bump black from 23.7.0 to 23.9.1. (#16295)
• Bump docker/build-push-action from 4 to 5. (#16336)
• Bump docker/login-action from 2 to 3. (#16339)
• Bump docker/metadata-action from 4 to 5. (#16337)
• Bump docker/setup-qemu-action from 2 to 3. (#16338)
• Bump furo from 2023.8.19 to 2023.9.10. (#16340)
• Bump gitpython from 3.1.32 to 3.1.35. (#16267, #16279)
• Bump mypy-zope from 1.0.0 to 1.0.1. (#16291)
• Bump pillow from 10.0.0 to 10.0.1. (#16344)
• Bump regex from 1.9.4 to 1.9.5. (#16233)
• Bump ruff from 0.0.286 to 0.0.290. (#16342)
• Bump serde_json from 1.0.105 to 1.0.107. (#16296, #16345)
• Bump twisted from 22.10.0 to 23.8.0. (#16235)
• Bump types-pillow from 10.0.0.2 to 10.0.0.3. (#16293)
• Bump types-setuptools from 68.0.0.3 to 68.2.0.0. (#16292)
• Bump typing-extensions from 4.7.1 to 4.8.0. (#16341)

Synapse 1.92.3 (2023-09-18)

This is again a security update targeted at mitigating CVE-2023-4863. It turns out that libwebp is bundled statically in Pillow wheels so we need to update this dependency instead of libwebp package at the OS level.

Unlike what was advertised in 1.92.2 changelog this release also impacts PyPI wheels and Debian packages from matrix.org.

We encourage admins to upgrade as soon as possible.

Internal Changes

• Pillow 10.0.1 is now mandatory because of libwebp CVE-2023-4863, since Pillow provides libwebp in the wheels. (#16347)

Updates to locked dependencies

• Bump pillow from 10.0.0 to 10.0.1. (#16344)

Synapse 1.92.2 (2023-09-15)

This is a Docker-only update to mitigate CVE-2023-4863, a critical vulnerability in libwebp. Server admins not using Docker should ensure that their libwebp is up to date (if installed). We encourage admins to upgrade as soon as possible.

Updates to the Docker image

• Update docker image to use Debian bookworm as the base. (#16324)

Synapse 1.92.1 (2023-09-12)

This minor release was needed only because of CI-related trouble on v1.92.0, which was never released.

Internal Changes

• Stop building Ubuntu Kinetic since it is EOL and repos seem to be dead.

Synapse 1.92.0 (2023-09-12)

This release includes the same bugfix as Synapse 1.91.2.

This version was never released following a CI build failure, cf v1.92.1 changelog.

Bugfixes

• Revert MSC3861 introspection cache, admin impersonation and account lock. (#16258)

Internal Changes

• Fix incorrect docstring for Ratelimiter. (#16255)
• Update the release script to work on macOS. (#16266)

Synapse 1.91.2 (2023-09-06)

Bugfixes

• Revert MSC3861 introspection cache, admin impersonation and account lock. (#16258)

Synapse 1.92.0rc1 (2023-09-05)

Features

• Add configuration setting for CAS protocol version. Contributed by Aurélien Grimpard. (#15816)
• Suppress notifications from message edits per MSC3958. (#16113)
• Experimental support for MSC4041: return a Retry-After header with M_LIMIT_EXCEEDED error responses. (#16136)
• Add last_seen_ts to the admin users API. (#16218)
• Improve resource usage when sending data to a large number of remote hosts that are marked as "down". (#16223)

Bugfixes

• Fix IPv6-related bugs on SMTP settings, adding groundwork to fix similar issues. Contributed by @evilham and @telmich (ungleich.ch). (#16155)
• Fix a spec compliance issue where requests to the /publicRooms federation API would specify include_all_networks as a string. (#16185)
• Fix inaccurate error message while attempting to ban or unban a user with the same or higher PL by spliting the conditional statements. Contributed by @leviosacz. (#16205)
• Fix a rare bug that broke looping calls, which could lead to e.g. linearly increasing memory usage. Introduced in v1.90.0. (#16210)
• Fix a long-standing bug where uploading images would fail if we could not generate thumbnails for them. (#16211)
• Fix a long-standing bug where we did not correctly back off from servers that had "gone" if they returned 4xx series error codes. (#16221)

Improved Documentation

• Update links to the matrix.org blog. (#16008)
• Document which admin APIs are disabled when experimental MSC3861 support is enabled. (#16168)
• Document exclude_rooms_from_sync configuration option. (#16178)

Internal Changes

• Prepare unit tests for Python 3.12. (#16099)
• Fix nightly CI jobs. (#16121, #16213)
• Describe which rate limiter was hit in logs. (#16135)
• Simplify presence code when using workers. (#16170)
• Track per-device information in the presence code. (#16171, #16172)
• Stop using the event_txn_id table. (#16175)
• Use AsyncMock instead of custom code. (#16179, #16180)
• Improve error reporting of invalid data passed to /_matrix/key/v2/query. (#16183)
• Task scheduler: add replication notify for new task to launch ASAP. (#16184)
• Improve type hints. (#16186, #16188, #16201)
• Bump black version to 23.7.0. (#16187)
• Log the details of background update failures. (#16212)
• Cache device resync requests over replication. (#16241)

Updates to locked dependencies

• Bump anyhow from 1.0.72 to 1.0.75. (#16141)
• Bump furo from 2023.7.26 to 2023.8.19. (#16238)
• Bump phonenumbers from 8.13.18 to 8.13.19. (#16237)
• Bump psycopg2 from 2.9.6 to 2.9.7. (#16196)
• Bump regex from 1.9.3 to 1.9.4. (#16195)
• Bump ruff from 0.0.277 to 0.0.286. (#16198)
• Bump sentry-sdk from 1.29.2 to 1.30.0. (#16236)
• Bump serde from 1.0.184 to 1.0.188. (#16194)
• Bump serde_json from 1.0.104 to 1.0.105. (#16140)
• Bump types-psycopg2 from 2.9.21.10 to 2.9.21.11. (#16200)
• Bump types-pyyaml from 6.0.12.10 to 6.0.12.11. (#16199)

Synapse 1.91.1 (2023-09-04)

Bugfixes

• Fix a performance regression introduced in Synapse 1.91.0 where event persistence would cause an excessive linear growth in CPU usage. (#16220)

Synapse 1.91.0 (2023-08-30)

No significant changes since 1.91.0rc1.

Synapse 1.91.0rc1 (2023-08-23)

Features

• Implements an admin API to lock an user without deactivating them. Based on MSC3939. (#15870)
• Implements a task scheduler for resumable potentially long running tasks. (#15891)
• Allow specifying client_secret_path as alternative to client_secret for OIDC providers. This avoids leaking the client secret in the homeserver config. Contributed by @Ma27. (#16030)
• Allow customising the IdP display name, icon, and brand for SAML and CAS providers (in addition to OIDC provider). (#16094)
• Add an admins query parameter to the List Accounts admin API, to include only admins or to exclude admins in user queries. (#16114)

Bugfixes

• Fix long-standing bug where concurrent requests to change a user's push rules could cause a deadlock. Contributed by Nick @ Beeper (@fizzadar). (#16052)
• Fix a long-standing bu in /sync where timeout=0 does not skip caching, resulting in slow calls in cases where there are no new changes. Contributed by @PlasmaIntec. (#16080)
• Fix performance of state resolutions for large, old rooms that did not have the full auth chain persisted. (#16116)
• Filter out user agent references to the sliding sync proxy and rust-sdk from the user_daily_visits table to ensure that Element X can be represented fully. (#16124)
• User constent and 3-PID changes capability cannot be enabled when using experimental MSC3861 support. (#16127, #16134)
• Fix a rare race that could block new events from being sent for up to two minutes. Introduced in v1.90.0. (#16133, #16169)
• Fix performance degredation when there are a lot of in-flight replication requests. (#16148)
• Fix a bug introduced in 1.87 where synapse would send an excessive amount of federation requests to servers which have been offline for a long time. Contributed by Nico. (#16156, #16164)

Improved Documentation

• Structured logging docs: add a link to explain the ELK stack (#16091)

Internal Changes

• Update dehydrated devices implementation. (#16010)
• Fix database performance of read/write worker locks. (#16061)
• Fix building the nix development environment on MacOS systems. (#16063)
• Override global statement timeout when creating indexes in Postgres. (#16085)
• Fix the type annotation on run_db_interaction in the Module API. (#16089)
• Clean-up the presence code. (#16092)
• Run pyupgrade for Python 3.8+. (#16110)
• Rename pagination and purge locks and add comments to explain why they exist and how they work. (#16112)
• Attempt to fix the twisted trunk job. (#16115)
• Cache token introspection response from OIDC provider. (#16117)
• Add cache to get_server_keys_json_for_remote. (#16123)
• Add an admin endpoint to allow authorizing server to signal token revocations. (#16125)
• Add response time metrics for introspection requests for delegated auth. (#16131)
• MSC3861: allow impersonation by an admin user using _oidc_admin_impersonate_user_id query parameter. (#16132)
• Increase performance of read/write locks. (#16149)
• Improve presence tests. (#16150, #16151, #16158)
• Raised the poetry-core version cap to 1.7.0. (#16152)
• Fix assertion in user directory unit tests. (#16157)
• Reduce scope of locks when paginating to alleviate DB contention. (#16159)
• Reduce DB contention on worker locks. (#16160)
• Task scheduler: mark task as active if we are scheduling as soon as possible. (#16165)

Updates to locked dependencies

• Bump click from 8.1.6 to 8.1.7. (#16145)
• Bump gitpython from 3.1.31 to 3.1.32. (#16103)
• Bump ijson from 3.2.1 to 3.2.3. (#16143)
• Bump isort from 5.11.5 to 5.12.0. (#16108)
• Bump log from 0.4.19 to 0.4.20. (#16109)
• Bump pygithub from 1.59.0 to 1.59.1. (#16144)
• Bump sentry-sdk from 1.28.1 to 1.29.2. (#16142)
• Bump serde from 1.0.183 to 1.0.184. (#16139)
• Bump txredisapi from 1.4.9 to 1.4.10. (#16107)
• Bump types-bleach from 6.0.0.3 to 6.0.0.4. (#16106)
• Bump types-pillow from 10.0.0.1 to 10.0.0.2. (#16105)
• Bump types-pyopenssl from 23.2.0.1 to 23.2.0.2. (#16146)

Synapse 1.91.0rc1 (2023-08-23)

Features

• Implements an admin API to lock an user without deactivating them. Based on MSC3939. (#15870)
• Allow specifying client_secret_path as alternative to client_secret for OIDC providers. This avoids leaking the client secret in the homeserver config. Contributed by @Ma27. (#16030)
• Allow customising the IdP display name, icon, and brand for SAML and CAS providers (in addition to OIDC provider). (#16094)
• Add an admins query parameter to the List Accounts admin API, to include only admins or to exclude admins in user queries. (#16114)

Bugfixes

• Fix long-standing bug where concurrent requests to change a user's push rules could cause a deadlock. Contributed by Nick @ Beeper (@fizzadar). (#16052)
• Fix a long-standing bug in /sync where timeout=0 does not skip caching, resulting in slow calls in cases where there are no new changes. Contributed by @PlasmaIntec. (#16080)
• Fix performance of state resolutions for large, old rooms that did not have the full auth chain persisted. (#16116)
• Filter out user agent references to the sliding sync proxy and rust-sdk from the user_daily_visits table to ensure that Element X can be represented fully. (#16124)
• User constent and third-party ID changes capability cannot be enabled when using experimental MSC3861 support. (#16127, #16134)
• Fix a rare race that could block new events from being sent for up to two minutes. Introduced in v1.90.0. (#16133, #16169)
• Fix performance degredation when there are a lot of in-flight replication requests. (#16148)
• Fix a bug introduced in 1.87 where synapse would send an excessive amount of federation requests to servers which have been offline for a long time. Contributed by Nico. (#16156, #16164)

Improved Documentation

• Structured logging docs: add a link to explain the ELK stack (#16091)

Internal Changes

• Update dehydrated devices implementation. (#16010)
• Fix database performance of read/write worker locks. (#16061)
• Fix building the nix development environment on MacOS systems. (#16063)
• Override global statement timeout when creating indexes in Postgres. (#16085)
• Fix the type annotation on run_db_interaction in the Module API. (#16089)
• Clean-up the presence code. (#16092)
• Run pyupgrade for Python 3.8+. (#16110)
• Rename pagination and purge locks and add comments to explain why they exist and how they work. (#16112)
• Attempt to fix the twisted trunk job. (#16115)
• Cache token introspection response from OIDC provider. (#16117)
• Add cache to get_server_keys_json_for_remote. (#16123)
• Add an admin endpoint to allow authorizing server to signal token revocations. (#16125)
• Add response time metrics for introspection requests for delegated auth. (#16131)
• MSC3861: allow impersonation by an admin user using _oidc_admin_impersonate_user_id query parameter. (#16132)
• Increase performance of read/write locks. (#16149)
• Improve presence tests. (#16150, #16151, #16158)
• Raised the poetry-core version cap to 1.7.0. (#16152)
• Fix assertion in user directory unit tests. (#16157)
• Reduce scope of locks when paginating to alleviate DB contention. (#16159)
• Reduce DB contention on worker locks. (#16160)
• Task scheduler: mark task as active if we are scheduling as soon as possible. (#16165)
• Implements a task scheduler for resumable potentially long running tasks. (#15891)

Updates to locked dependencies

• Bump click from 8.1.6 to 8.1.7. (#16145)
• Bump gitpython from 3.1.31 to 3.1.32. (#16103)
• Bump ijson from 3.2.1 to 3.2.3. (#16143)
• Bump isort from 5.11.5 to 5.12.0. (#16108)
• Bump log from 0.4.19 to 0.4.20. (#16109)
• Bump pygithub from 1.59.0 to 1.59.1. (#16144)
• Bump sentry-sdk from 1.28.1 to 1.29.2. (#16142)
• Bump serde from 1.0.183 to 1.0.184. (#16139)
• Bump txredisapi from 1.4.9 to 1.4.10. (#16107)
• Bump types-bleach from 6.0.0.3 to 6.0.0.4. (#16106)
• Bump types-pillow from 10.0.0.1 to 10.0.0.2. (#16105)
• Bump types-pyopenssl from 23.2.0.1 to 23.2.0.2. (#16146)

Synapse 1.90.0 (2023-08-15)

No significant changes since 1.90.0rc1.

Synapse 1.90.0rc1 (2023-08-08)

Features

• Scope transaction IDs to devices (implement MSC3970). (#15629)
• Remove old rows from the cache_invalidation_stream_by_instance table automatically (this table is unused in SQLite). (#15868)

Bugfixes

• Fix a long-standing bug where purging history and paginating simultaneously could lead to database corruption when using workers. (#15791)
• Fix a long-standing bug where profile endpoint returned a 404 when the user's display name was empty. (#16012)
• Fix a long-standing bug where the synapse_port_db failed to configure sequences for application services and partial stated rooms. (#16043)
• Fix long-standing bug with deletion in dehydrated devices v2. (#16046)

Updates to the Docker image

• Add org.opencontainers.image.version labels to Docker containers published by Matrix.org. Contributed by Mo Balaa. (#15972, #16009)

Improved Documentation

• Add a internal documentation page describing the "streams" used within Synapse. (#16015)
• Clarify comment on the keys/upload over replication enpoint. (#16016)
• Do not expose Admin API in caddy reverse proxy example. Contributed by @NilsIrl. (#16027)

Deprecations and Removals

• Remove support for legacy application service paths. (#15964)
• Move support for application service query parameter authorization behind a configuration option. (#16017)

Internal Changes

• Update SQL queries to inline boolean parameters as supported in SQLite 3.27. (#15525)
• Allow for the configuration of the backoff algorithm for federation destinations. (#15754)
• Allow modules to check whether the current worker is configured to run background tasks. (#15991)
• Update support for MSC3958 to match the latest revision of the MSC. (#15992)
• Allow modules to schedule delayed background calls. (#15993)
• Properly overwrite the redacts content-property for forwards-compatibility with room versions 1 through 10. (#16013)
• Fix building the nix development environment on MacOS systems. (#16019)
• Remove leading and trailing spaces when setting a display name. (#16031)
• Combine duplicated code. (#16023)
• Collect additional metrics from ResponseCache for eviction. (#16028)
• Fix endpoint improperly declaring support for MSC3814. (#16068)
• Drop backwards compat hack for event serialization. (#16069)

Updates to locked dependencies

• Update PyYAML to 6.0.1. (#16011)
• Bump cryptography from 41.0.2 to 41.0.3. (#16048)
• Bump furo from 2023.5.20 to 2023.7.26. (#16077)
• Bump immutabledict from 2.2.4 to 3.0.0. (#16034)
• Update certifi to 2023.7.22 and pygments to 2.15.1. (#16044)
• Bump jsonschema from 4.18.3 to 4.19.0. (#16081)
• Bump phonenumbers from 8.13.14 to 8.13.18. (#16076)
• Bump regex from 1.9.1 to 1.9.3. (#16073)
• Bump serde from 1.0.171 to 1.0.175. (#15982)
• Bump serde from 1.0.175 to 1.0.179. (#16033)
• Bump serde from 1.0.179 to 1.0.183. (#16074)
• Bump serde_json from 1.0.103 to 1.0.104. (#16032)
• Bump service-identity from 21.1.0 to 23.1.0. (#16038)
• Bump types-commonmark from 0.9.2.3 to 0.9.2.4. (#16037)
• Bump types-jsonschema from 4.17.0.8 to 4.17.0.10. (#16036)
• Bump types-netaddr from 0.8.0.8 to 0.8.0.9. (#16035)
• Bump types-opentracing from 2.4.10.5 to 2.4.10.6. (#16078)
• Bump types-setuptools from 68.0.0.0 to 68.0.0.3. (#16079)

Synapse 1.89.0 (2023-08-01)

No significant changes since 1.89.0rc1.

Synapse 1.89.0rc1 (2023-07-25)

Features

• Add Unix Socket support for HTTP Replication Listeners. Document and provide usage instructions for utilizing Unix sockets in Synapse. Contributed by Jason Little. (#15708, #15924)
• Allow + in Matrix IDs, per MSC4009. (#15911)
• Support room version 11 from MSC3820. (#15912)
• Allow configuring the set of workers to proxy outbound federation traffic through via outbound_federation_restricted_to. (#15913, #15969)
• Implement MSC3814, dehydrated devices v2/shrivelled sessions and move MSC2697 behind a config flag. Contributed by Nico from Famedly, H-Shay and poljar. (#15929)

Bugfixes

• Fix a long-standing bug where remote invites weren't correctly pushed. (#15820)
• Fix background schema updates failing over a large upgrade gap. (#15887)
• Fix a bug introduced in 1.86.0 where Synapse starting with an empty experimental_features configuration setting. (#15925)
• Fixed deploy annotations in the provided Grafana dashboard config, so that it shows for any homeserver and not just matrix.org. Contributed by @wrjlewis. (#15957)
• Ensure a long state res does not starve CPU by occasionally yielding to the reactor. (#15960)
• Properly handle redactions of creation events. (#15973)
• Fix a bug where resyncing stale device lists could block responding to federation transactions, and thus delay receiving new data from the remote server. (#15975)

Improved Documentation

• Better clarify how to run a worker instance (pass both configs). (#15921)
• Improve the documentation for the login as a user admin API. (#15938)
• Fix broken Arch Linux package link. Contributed by @SnipeXandrej. (#15981)

Deprecations and Removals

• Remove support for calling the /register endpoint with an unspecced user property for application services. (#15928)

Internal Changes

• Mark get_user_in_directory private since it is only used in tests. Also remove the cache from it. (#15884)
• Document which Python version runs on a given Linux distribution so we can more easily clean up later. (#15909)
• Add details to warning in log when we fail to fetch an alias. (#15922)
• Remove unneeded __init__. (#15926)
• Fix bug with read/write lock implementation. This is currently unused so has no observable effects. (#15933, #15958)
• Unbreak the nix development environment by pinning the Rust version to 1.70.0. (#15940)
• Update presence metrics to differentiate remote vs local users. (#15952)
• Stop reading from column user_id of table profiles. (#15955)
• Build packages for Debian Trixie. (#15961)
• Reduce the amount of state we pull out. (#15968)
• Speed up updating state in large rooms. (#15971)

Updates to locked dependencies

• Bump anyhow from 1.0.71 to 1.0.72. (#15949)
• Bump click from 8.1.3 to 8.1.6. (#15984)
• Bump cryptography from 41.0.1 to 41.0.2. (#15943)
• Bump jsonschema from 4.17.3 to 4.18.3. (#15948)
• Bump pillow from 9.4.0 to 10.0.0. (#15986)
• Bump prometheus-client from 0.17.0 to 0.17.1. (#15945)
• Bump pydantic from 1.10.10 to 1.10.11. (#15946)
• Bump pygithub from 1.58.2 to 1.59.0. (#15834)
• Bump pyo3-log from 0.8.2 to 0.8.3. (#15951)
• Bump sentry-sdk from 1.26.0 to 1.28.1. (#15985)
• Bump serde_json from 1.0.100 to 1.0.103. (#15950)
• Bump types-pillow from 9.5.0.4 to 10.0.0.1. (#15932)
• Bump types-requests from 2.31.0.1 to 2.31.0.2. (#15983)
• Bump typing-extensions from 4.5.0 to 4.7.1. (#15947)

Synapse 1.88.0 (2023-07-18)

This release

• raises the minimum supported version of Python to 3.8, as Python 3.7 is now end-of-life, and
• removes deprecated config options related to worker deployment.

See the upgrade notes for more information.

Bugfixes

• Revert "Stop writing to column user_id of tables profiles and user_filters", which was introduced in Synapse 1.88.0rc1. (#15953)

Synapse 1.88.0rc1 (2023-07-11)

Features

• Add not_user_type param to the list accounts admin API. (#15844)

Bugfixes

• Pin pydantic to ^=1.7.4 to avoid backwards-incompatible API changes from the 2.0.0 release. Contributed by @PaarthShah. (#15862)
• Correctly resize thumbnails with pillow version >=10. (#15876)

Improved Documentation

• Fixed header levels on the Admin API "Users" documentation page. Contributed by @sumnerevans at @beeper. (#15852)
• Remove deprecated worker_replication_host, worker_replication_http_port and worker_replication_http_tls configuration options. (#15872)

Deprecations and Removals

• Remove deprecated worker_replication_host, worker_replication_http_port and worker_replication_http_tls configuration options. See the upgrade notes for more details. (#15860)
• Remove support for Python 3.7 and hence for Debian Buster. (#15851, #15892, #15893, #15917)

Internal Changes

• Add foreign key constraint to event_forward_extremities. (#15751, #15907)
• Add read/write style cross-worker locks. (#15782)
• Stop writing to column user_id of tables profiles and user_filters. (#15787)
• Use lower isolation level when cleaning old presence stream data to avoid serialization errors. (#15826)
• Add tracing to media /upload code paths. (#15850, #15888)
• Add a timeout that aborts any Postgres statement taking more than 1 hour. (#15853)
• Fix the devenv up configuration which was ignoring the config overrides. (#15854)
• Optimised cleanup of old entries in device_lists_stream. (#15861)
• Update the Matrix clients link in the It works! Synapse is running landing page. (#15874)
• Fix building Synapse with the nightly Rust compiler. (#15906)
• Add Server to Access-Control-Expose-Headers header. (#15908)

Updates to locked dependencies

• Bump authlib from 1.2.0 to 1.2.1. (#15864)
• Bump importlib-metadata from 6.6.0 to 6.7.0. (#15865)
• Bump lxml from 4.9.2 to 4.9.3. (#15897)
• Bump regex from 1.8.4 to 1.9.1. (#15902)
• Bump ruff from 0.0.275 to 0.0.277. (#15900)
• Bump sentry-sdk from 1.25.1 to 1.26.0. (#15867)
• Bump serde_json from 1.0.99 to 1.0.100. (#15901)
• Bump types-pyopenssl from 23.2.0.0 to 23.2.0.1. (#15866)

Synapse 1.87.0 (2023-07-04)

Please note that this will be the last release of Synapse that is compatible with Python 3.7 and earlier. This is due to Python 3.7 now having reached End of Life; see our deprecation policy for more details.

Bugfixes

• Pin pydantic to ^1.7.4 to avoid backwards-incompatible API changes from the 2.0.0 release. Resolves https://github.com/matrix-org/synapse/issues/15858. Contributed by @PaarthShah. (#15862)

Internal Changes

• Split out 2022 changes from the changelog so the rendered version in GitHub doesn't timeout as much. (#15846)

Synapse 1.87.0rc1 (2023-06-27)

Features

• Improve /messages response time by avoiding backfill when we already have messages to return. (#15737)
• Add spam checker module API for logins. (#15838)

Bugfixes

• Fix a long-standing bug where media files were served in an unsafe manner. Contributed by @joshqou. (#15680)
• Avoid invalidating a cache that was just prefilled. (#15758)
• Fix requesting multiple keys at once over federation, related to MSC3983. (#15770)
• Fix joining rooms through aliases where the alias server isn't a real homeserver. Contributed by @tulir @ Beeper. (#15776)
• Fix a bug in push rules handling leading to an invalid (per spec) is_user_mention rule sent to clients. Also fix wrong rule names for is_user_mention and is_room_mention. (#15781)
• Fix a bug introduced in 1.57.0 where the wrong table would be locked on updating database rows when using SQLite as the database backend. (#15788)
• Fix Sytest environmental variable evaluation in CI. (#15804)
• Fix forgotten rooms missing from initial sync after rejoining them. Contributed by Nico from Famedly. (#15815)
• Fix sqlite user_filters upgrade introduced in v1.86.0. (#15817)

Improved Documentation

• Document looping_call() functionality that will wait for the given function to finish before scheduling another. (#15772)
• Fix a typo in the Admin API. (#15805)
• Fix typo in MSC number in faster remote room join architecture doc. (#15812)

Deprecations and Removals

• Remove experimental MSC2716 implementation to incrementally import history into existing rooms. (#15748)

Internal Changes

• Replace EventContext fields prev_group and delta_ids with field state_group_deltas. (#15233)
• Regularly try to send transactions to other servers after they failed instead of waiting for a new event to be available before trying. (#15743)
• Fix requesting multiple keys at once over federation, related to MSC3983. (#15755)
• Allow for the configuration of max request retries and min/max retry delays in the matrix federation client. (#15783)
• Switch from matrix:// to matrix-federation:// scheme for internal Synapse routing of outbound federation traffic. (#15806)
• Fix harmless exceptions being printed when running the port DB script. (#15814)

Updates to locked dependencies

• Bump attrs from 22.2.0 to 23.1.0. (#15801)
• Bump cryptography from 40.0.2 to 41.0.1. (#15800)
• Bump ijson from 3.2.0.post0 to 3.2.1. (#15802)
• Bump phonenumbers from 8.13.13 to 8.13.14. (#15798)
• Bump ruff from 0.0.265 to 0.0.272. (#15799)
• Bump ruff from 0.0.272 to 0.0.275. (#15833)
• Bump serde_json from 1.0.96 to 1.0.97. (#15797)
• Bump serde_json from 1.0.97 to 1.0.99. (#15832)
• Bump towncrier from 22.12.0 to 23.6.0. (#15831)
• Bump types-opentracing from 2.4.10.4 to 2.4.10.5. (#15830)
• Bump types-setuptools from 67.8.0.0 to 68.0.0.0. (#15835)

Synapse 1.86.0 (2023-06-20)

No significant changes since 1.86.0rc2.

Synapse 1.86.0rc2 (2023-06-14)

Bugfixes

• Fix an error when having workers of different versions running. (#15774)

Synapse 1.86.0rc1 (2023-06-13)

This version was tagged but never released.

Features

• Stable support for MSC3882 to allow an existing device/session to generate a login token for use on a new device/session. (#15388)
• Support resolving a room's canonical alias via the module API. (#15450)
• Enable support for MSC3952: intentional mentions. (#15520)
• Experimental MSC3861 support: delegate auth to an OIDC provider. (#15582)
• Add Synapse version deploy annotations to Grafana dashboard which enables easy correlation between behavior changes witnessed in a graph to a certain Synapse version and nail down regressions. (#15674)
• Add a catch-all * to the supported relation types when redacting an event and its related events. This is an update to MSC3912 implementation. (#15705)
• Speed up /messages by backfilling in the background when there are no backward extremities where we are directly paginating. (#15710)
• Expose a metric reporting the database background update status. (#15740)

Bugfixes

• Correctly clear caches when we delete a room. (#15609)
• Check permissions for enabling encryption earlier during room creation to avoid creating broken rooms. (#15695)

Improved Documentation

• Simplify query to find participating servers in a room. (#15732)

Internal Changes

• Log when events are (maybe unexpectedly) filtered out of responses in tests. (#14213)
• Read from column full_user_id rather than user_id of tables profiles and user_filters. (#15649)
• Add support for tracing functions which return Awaitables. (#15650)
• Cache requests for user's devices over federation. (#15675)
• Add fully qualified docker image names to Dockerfiles. (#15689)
• Remove some unused code. (#15690)
• Improve type hints. (#15694, #15697)
• Update docstring and traces on maybe_backfill() functions. (#15709)
• Add context for when/why to use the long_retries option when sending Federation requests. (#15721)
• Removed some unused fields. (#15723)
• Update federation error to more plainly explain we can only authorize our own membership events. (#15725)
• Prevent the latest_deps and twisted_trunk daily GitHub Actions workflows from running on forks of the codebase. (#15726)
• Improve performance of user directory search. (#15729)
• Remove redundant table join with room_memberships when doing a is_host_joined()/is_host_invited() call (membership is already part of the current_state_events). (#15731)
• Remove superfluous room_memberships join from background update. (#15733)
• Speed up typechecking CI. (#15752)
• Bump minimum supported Rust version to 1.60.0. (#15768)

Updates to locked dependencies

• Bump importlib-metadata from 6.1.0 to 6.6.0. (#15711)
• Bump library/redis from 6-bullseye to 7-bullseye in /docker. (#15712)
• Bump log from 0.4.18 to 0.4.19. (#15761)
• Bump phonenumbers from 8.13.11 to 8.13.13. (#15763)
• Bump pyasn1 from 0.4.8 to 0.5.0. (#15713)
• Bump pydantic from 1.10.8 to 1.10.9. (#15762)
• Bump pyo3-log from 0.8.1 to 0.8.2. (#15759)
• Bump pyopenssl from 23.1.1 to 23.2.0. (#15765)
• Bump regex from 1.7.3 to 1.8.4. (#15769)
• Bump sentry-sdk from 1.22.1 to 1.25.0. (#15714)
• Bump sentry-sdk from 1.25.0 to 1.25.1. (#15764)
• Bump serde from 1.0.163 to 1.0.164. (#15760)
• Bump types-jsonschema from 4.17.0.7 to 4.17.0.8. (#15716)
• Bump types-pyopenssl from 23.1.0.2 to 23.2.0.0. (#15766)
• Bump types-requests from 2.31.0.0 to 2.31.0.1. (#15715)

Synapse 1.85.2 (2023-06-08)

Bugfixes

• Fix regression where using TLS for HTTP replication between workers did not work. Introduced in v1.85.0. (#15746)

Synapse 1.85.1 (2023-06-07)

Note: this release only fixes a bug that stopped some deployments from upgrading to v1.85.0. There is no need to upgrade to v1.85.1 if successfully running v1.85.0.

Bugfixes

• Fix bug in schema delta that broke upgrades for some deployments. Introduced in v1.85.0. (#15738, #15739)

Synapse 1.85.0 (2023-06-06)

No significant changes since 1.85.0rc2.

Security advisory

The following issues are fixed in 1.85.0 (and RCs).

• GHSA-26c5-ppr8-f33p / CVE-2023-32682 — Low Severity

  It may be possible for a deactivated user to login when using uncommon configurations.

• GHSA-98px-6486-j7qc / CVE-2023-32683 — Low Severity

  A discovered oEmbed or image URL can bypass the url_preview_url_blacklist setting potentially allowing server side request forgery or bypassing network policies. Impact is limited to IP addresses allowed by the url_preview_ip_range_blacklist setting (by default this only allows public IPs).

See the advisories for more details. If you have any questions, email security@matrix.org.

Synapse 1.85.0rc2 (2023-06-01)

Bugfixes

• Fix a performance issue introduced in Synapse v1.83.0 which meant that purging rooms was very slow and database-intensive. (#15693)

Deprecations and Removals

• Deprecate calling the /register endpoint with an unspecced user property for application services. (#15703)

Internal Changes

• Speed up background jobs populate_full_user_id_user_filters and populate_full_user_id_profiles. (#15700)

Synapse 1.85.0rc1 (2023-05-30)

Features

• Improve performance of backfill requests by performing backfill of previously failed requests in the background. (#15585)
• Add a new admin API to create a new device for a user. (#15611)
• Add Unix socket support for Redis connections. Contributed by Jason Little. (#15644)

Bugfixes

• Fix a long-standing bug where setting the read marker could fail when using message retention. Contributed by Nick @ Beeper (@fizzadar). (#15464)
• Fix a long-standing bug where the url_preview_url_blacklist configuration setting was not applied to oEmbed or image URLs found while previewing a URL. (#15601)
• Fix a long-standing bug where filters with multiple backslashes were rejected. (#15607)
• Fix a bug introduced in Synapse 1.82.0 where the error message displayed when validation of the app_service_config_files config option fails would be incorrectly formatted. (#15614)
• Fix a long-standing bug where deactivated users were still able to login using the custom org.matrix.login.jwt login type (if enabled). (#15624)
• Fix a long-standing bug where deactivated users were able to login in uncommon situations. (#15634)

Improved Documentation

• Warn users that at least 3.75GB of space is needed for the nix Synapse development environment. (#15613)
• Remove outdated comment from the generated and sample homeserver log configs. (#15648)
• Improve contributor docs to make it more clear that Rust is a necessary prerequisite. Contributed by @grantm. (#15668)

Deprecations and Removals

• Remove the old version of the R30 (30-day retained users) phone-home metric. (#10428)

Internal Changes

• Create dependabot changelogs at release time. (#15481)
• Add not null constraint to column full_user_id of tables profiles and user_filters. (#15537)
• Allow connecting to HTTP Replication Endpoints by using worker_name when constructing the request. (#15578)
• Make the thread_id column on event_push_actions, event_push_actions_staging, and event_push_summary non-null. (#15597)
• Run mypy type checking with the minimum supported Python version to catch new usage that isn't backwards-compatible. (#15602)
• Fix subscriptable type usage in Python <3.9. (#15604)
• Update internal terminology. (#15606, #15620)
• Instrument state and state_group storage-related operations to better picture what's happening when tracing. (#15610, #15647)
• Trace how many new events from the backfill response we need to process. (#15633)
• Re-type config paths in ConfigErrors to be StrSequences instead of Iterable[str]s. (#15615)
• Update Mutual Rooms (MSC2666) implementation to match new proposal text. (#15621)
• Remove the unstable identifiers from faster joins (MSC3706). (#15625)
• Fix the olddeps CI. (#15626)
• Remove duplicate timestamp from test logs (_trial_temp/test.log). (#15636)
• Fix two memory leaks in trial test runs. (#15630)
• Limit the size of the HomeServerConfig cache in trial test runs. (#15646)
• Improve type hints. (#15658, #15659)
• Add requesting user id parameter to key claim methods in TransportLayerClient. (#15663)
• Speed up rebuilding of the user directory for local users. (#15665)
• Implement "option 2" for MSC3820: Room version 11. (#15666, #15678)

Updates to locked dependencies

• Bump furo from 2023.3.27 to 2023.5.20. (#15642)
• Bump log from 0.4.17 to 0.4.18. (#15681)
• Bump prometheus-client from 0.16.0 to 0.17.0. (#15682)
• Bump pydantic from 1.10.7 to 1.10.8. (#15685)
• Bump pygithub from 1.58.1 to 1.58.2. (#15643)
• Bump requests from 2.28.2 to 2.31.0. (#15651)
• Bump sphinx from 6.1.3 to 6.2.1. (#15641)
• Bump types-bleach from 6.0.0.1 to 6.0.0.3. (#15686)
• Bump types-pillow from 9.5.0.2 to 9.5.0.4. (#15640)
• Bump types-pyyaml from 6.0.12.9 to 6.0.12.10. (#15683)
• Bump types-requests from 2.30.0.0 to 2.31.0.0. (#15684)
• Bump types-setuptools from 67.7.0.2 to 67.8.0.0. (#15639)

Synapse 1.84.1 (2023-05-26)

This patch release fixes a major issue with homeservers that do not have an instance_map defined but which do use workers. If you have already upgraded to Synapse 1.84.0 and your homeserver is working normally, then there is no need to update to this patch release.

Bugfixes

• Fix a bug introduced in Synapse v1.84.0 where workers do not start up when no instance_map was provided. (#15672)

Internal Changes

• Add dch and notify-send to the development Nix flake so that the release script can be used. (#15673)

Synapse 1.84.0 (2023-05-23)

The worker_replication_* configuration settings have been deprecated in favour of configuring the main process consistently with other instances in the instance_map. The deprecated settings will be removed in Synapse v1.88.0, but changing your configuration in advance is recommended. See the upgrade notes for more information.

Bugfixes

• Fix a bug introduced in Synapse 1.84.0rc1 where errors during startup were not reported correctly on Python < 3.10. (#15599)

Synapse 1.84.0rc1 (2023-05-16)

Features

• Add an option to prevent media downloads from configured domains. (#15197)
• Add forget_rooms_on_leave config option to automatically forget rooms when users leave them or are removed from them. (#15224)
• Add redis TLS configuration options. (#15312)
• Add a config option to delay push notifications by a random amount, to discourage time-based profiling. (#15516)
• Stabilize support for MSC2659: application service ping endpoint. Contributed by Tulir @ Beeper. (#15528)
• Implement MSC4009 to expand the supported characters in Matrix IDs. (#15536)
• Advertise support for Matrix 1.6 on /_matrix/client/versions. (#15559)
• Print full error and stack-trace of any exception that occurs during startup/initialization. (#15569)

Bugfixes

• Don't fail on federation over TOR where SRV queries are not supported. Contributed by Zdzichu. (#15523)
• Experimental support for MSC4010 which rejects setting the "m.push_rules" via account data. (#15554, #15555)
• Fix a long-standing bug where an invalid membership event could cause an internal server error. (#15564)
• Require at least poetry-core v1.1.0. (#15566, #15571)

Deprecations and Removals

• Remove need for worker_replication_* based settings in worker configuration yaml by placing this data directly on the instance_map instead. (#15491)

Updates to the Docker image

• Add pkg-config package to Stage 0 to be able to build Dockerfile on ppc64le architecture. (#15567)

Improved Documentation

• Clarify documentation of the "Create or modify account" Admin API. (#15544)
• Fix path to the statistics/database/rooms admin API in documentation. (#15560)
• Update and improve Mastodon Single Sign-On documentation. (#15587)

Internal Changes

• Use oEmbed to generate URL previews for YouTube Shorts. (#15025)
• Create new Client for use with HTTP Replication between workers. Contributed by Jason Little. (#15470)
• Bump pyicu from 2.10.2 to 2.11. (#15509)
• Remove references to supporting per-user flag for MSC2654. (#15522)
• Don't use a trusted key server when running the demo scripts. (#15527)
• Speed up rebuilding of the user directory for local users. (#15529)
• Speed up deleting of old rows in event_push_actions. (#15531)
• Install the xmlsec and mdbook packages and switch back to the upstream cachix/devenv repo in the nix development environment. (#15532, #15533, #15545)
• Implement MSC3987 by removing "dont_notify" from the list of actions in default push rules. (#15534)
• Move various module API callback registration methods to a dedicated class. (#15535)
• Proxy /user/devices federation queries to application services for MSC3984. (#15539)
• Factor out an is_mine_server_name method. (#15542)
• Allow running Complement tests using podman by adding a PODMAN environment variable to scripts-dev/complement.sh. (#15543)
• Bump serde from 1.0.160 to 1.0.162. (#15548)
• Bump types-setuptools from 67.6.0.5 to 67.7.0.1. (#15549)
• Bump sentry-sdk from 1.19.1 to 1.22.1. (#15550)
• Bump ruff from 0.0.259 to 0.0.265. (#15551)
• Bump hiredis from 2.2.2 to 2.2.3. (#15552)
• Bump types-requests from 2.29.0.0 to 2.30.0.0. (#15553)
• Add org.matrix.msc3981 info to /_matrix/client/versions. (#15558)
• Declare unstable support for MSC3391 under /_matrix/client/versions if the experimental implementation is enabled. (#15562)
• Implement MSC3821 to update the redaction rules. (#15563)
• Implement updated redaction rules from MSC3389. (#15565)
• Allow pip install to use setuptools_rust 1.6.0 when building Synapse. (#15570)
• Deal with upcoming Github Actions deprecations. (#15576)
• Export run_as_background_process from the module API. (#15577)
• Update build system requirements to allow building with poetry-core==1.6.0. (#15588)
• Bump serde from 1.0.162 to 1.0.163. (#15589)
• Bump phonenumbers from 8.13.7 to 8.13.11. (#15590)
• Bump types-psycopg2 from 2.9.21.9 to 2.9.21.10. (#15591)
• Bump types-commonmark from 0.9.2.2 to 0.9.2.3. (#15592)
• Bump types-setuptools from 67.7.0.1 to 67.7.0.2. (#15594)

Synapse 1.83.0 (2023-05-09)

No significant changes since 1.83.0rc1.

Synapse 1.83.0rc1 (2023-05-02)

Features

• Experimental support to recursively provide relations per MSC3981. (#15315)
• Experimental support for MSC3970: Scope transaction IDs to devices. (#15318)
• Add an admin API endpoint to support per-user feature flags. (#15344)
• Add a module API to send an HTTP push notification. (#15387)
• Add an admin API endpoint to query the largest rooms by disk space used in the database. (#15482)

Bugfixes

• Disable push rule evaluation for rooms excluded from sync. (#15361)
• Fix a long-standing bug where cached server key results which were directly fetched would not be properly re-used. (#15417)
• Fix a bug introduced in Synapse 1.73.0 where some experimental push rules were returned by default. (#15494)

Improved Documentation

• Add Nginx loadbalancing example with sticky mxid for workers. (#15411)
• Update outdated development docs that mention restrictions in versions of SQLite that we no longer support. (#15498)

Internal Changes

• Speedup tests by caching HomeServerConfig instances. (#15284)
• Add denormalised event stream ordering column to membership state tables for future use. Contributed by Nick @ Beeper (@fizzadar). (#15356)
• Always use multi-user device resync replication endpoints. (#15418)
• Add column full_user_id to tables profiles and user_filters. (#15458)
• Update support for MSC3983 to allow always returning fallback-keys in a /keys/claim request. (#15462)
• Improve type hints. (#15465, #15496, #15497)
• Support claiming more than one OTK at a time. (#15468)
• Bump types-pyyaml from 6.0.12.8 to 6.0.12.9. (#15471)
• Bump pyasn1-modules from 0.2.8 to 0.3.0. (#15473)
• Bump cryptography from 40.0.1 to 40.0.2. (#15474)
• Bump types-netaddr from 0.8.0.7 to 0.8.0.8. (#15475)
• Bump types-jsonschema from 4.17.0.6 to 4.17.0.7. (#15476)
• Ask bug reporters to provide logs as text. (#15479)
• Add a Nix flake for use as a development environment. (#15495)
• Bump anyhow from 1.0.70 to 1.0.71. (#15507)
• Bump types-pillow from 9.4.0.19 to 9.5.0.2. (#15508)
• Bump packaging from 23.0 to 23.1. (#15510)
• Bump types-requests from 2.28.11.16 to 2.29.0.0. (#15511)
• Bump setuptools-rust from 1.5.2 to 1.6.0. (#15512)
• Update the check_schema_delta script to account for when the schema version has been bumped locally. (#15466)

Synapse 1.82.0 (2023-04-25)

No significant changes since 1.82.0rc1.

Synapse 1.82.0rc1 (2023-04-18)

Features

• Allow loading the /directory/room/{roomAlias} endpoint on workers. (#15333)
• Add some validation to instance_map configuration loading. (#15431)
• Allow loading the /capabilities endpoint on workers. (#15436)

Bugfixes

• Delete server-side backup keys when deactivating an account. (#15181)
• Fix and document untold assumption that on_logged_out module hooks will be called before the deletion of pushers. (#15410)
• Improve robustness when handling a perspective key response by deduplicating received server keys. (#15423)
• Synapse now correctly fails to start if the config option app_service_config_files is not a list. (#15425)
• Disable loading RefreshTokenServlet (/_matrix/client/(r0|v3|unstable)/refresh) on workers. (#15428)

Improved Documentation

• Note that the delete_stale_devices_after background job always runs on the main process. (#15452)

Deprecations and Removals

• Remove the broken, unspecced registration fallback. Note that the login fallback is unaffected by this change. (#15405)

Internal Changes

• Bump black from 23.1.0 to 23.3.0. (#15372)
• Bump pyopenssl from 23.1.0 to 23.1.1. (#15373)
• Bump types-psycopg2 from 2.9.21.8 to 2.9.21.9. (#15374)
• Bump types-netaddr from 0.8.0.6 to 0.8.0.7. (#15375)
• Bump types-opentracing from 2.4.10.3 to 2.4.10.4. (#15376)
• Bump dawidd6/action-download-artifact from 2.26.0 to 2.26.1. (#15404)
• Bump parameterized from 0.8.1 to 0.9.0. (#15412)
• Bump types-pillow from 9.4.0.17 to 9.4.0.19. (#15413)
• Bump sentry-sdk from 1.17.0 to 1.19.1. (#15414)
• Bump immutabledict from 2.2.3 to 2.2.4. (#15415)
• Bump dawidd6/action-download-artifact from 2.26.1 to 2.27.0. (#15441)
• Bump serde_json from 1.0.95 to 1.0.96. (#15442)
• Bump serde from 1.0.159 to 1.0.160. (#15443)
• Bump pillow from 9.4.0 to 9.5.0. (#15444)
• Bump furo from 2023.3.23 to 2023.3.27. (#15445)
• Bump types-pyopenssl from 23.1.0.0 to 23.1.0.2. (#15446)
• Bump mypy from 1.0.0 to 1.0.1. (#15447)
• Bump psycopg2 from 2.9.5 to 2.9.6. (#15448)
• Improve DB performance of clearing out old data from stream_ordering_to_exterm. (#15382, #15429)
• Implement MSC3989 redaction algorithm. (#15393)
• Implement MSC2175 to stop adding creator to create events. (#15394)
• Implement MSC2174 to move the redacts key to a content property. (#15395)
• Trust dtonlay/rust-toolchain in CI. (#15406)
• Explicitly install Synapse during typechecking in CI. (#15409)
• Only load the SSO redirect servlet if SSO is enabled. (#15421)
• Refactor SimpleHttpClient to pull out a base class. (#15427)
• Improve type hints. (#15432)
• Convert async to normal tests in TestSSOHandler. (#15433)
• Speed up the user directory background update. (#15435)
• Disable directory listing for static resources in /_matrix/static/. (#15438)
• Move various module API callback registration methods to a dedicated class. (#15453)

Synapse 1.81.0 (2023-04-11)

Synapse now attempts the versioned appservice paths before falling back to the legacy paths. Usage of the legacy routes should be considered deprecated.

Additionally, Synapse has supported sending the application service access token via the Authorization header since v1.70.0. For backwards compatibility it is also sent as the access_token query parameter. This is insecure and should be considered deprecated.

A future version of Synapse (v1.88.0 or later) will remove support for legacy application service routes and query parameter authorization.

No significant changes since 1.81.0rc2.

Synapse 1.81.0rc2 (2023-04-06)

Bugfixes

• Fix the set_device_id_for_pushers_txn background update crash. (#15391)

Internal Changes

• Update CI to run complement under the latest stable go version. (#15403)

Synapse 1.81.0rc1 (2023-04-04)

Features

• Add the ability to enable/disable registrations when in the OIDC flow. (#14978)
• Add a primitive helper script for listing worker endpoints. (#15243)
• Experimental support for passing One Time Key and device key requests to application services (MSC3983 and MSC3984). (#15314, #15321)
• Allow loading /password_policy endpoint on workers. (#15331)
• Add experimental support for Unix sockets. Contributed by Jason Little. (#15353)
• Build Debian packages for Ubuntu 23.04 (Lunar Lobster). (#15381)

Bugfixes

• Fix a long-standing bug where edits of non-m.room.message events would not be correctly bundled. (#15295)
• Fix a bug introduced in Synapse v1.55.0 which could delay remote homeservers being able to decrypt encrypted messages sent by local users. (#15297)
• Add a check to SQLite port_db script to ensure that the sqlite database passed to the script exists before trying to port from it. (#15306)
• Fix a bug introduced in Synapse 1.76.0 where responses from worker deployments could include an internal _INT_STREAM_POS key. (#15309)
• Fix a long-standing bug that Synpase only used the legacy appservice routes. (#15317)
• Fix a long-standing bug preventing users from rejoining rooms after being banned and unbanned over federation. Contributed by Nico. (#15323)
• Fix bug in worker mode where on a rolling restart of workers the "typing" worker would consume 100% CPU until it got restarted. (#15332)
• Fix a long-standing bug where some to_device messages could be dropped when using workers. (#15349)
• Fix a bug introduced in Synapse 1.70.0 where the background sync from a faster join could spin for hours when one of the events involved had been marked for backoff. (#15351)
• Fix missing app variable in mail subject for password resets. Contributed by Cyberes. (#15352)
• Fix a rare bug introduced in Synapse 1.66.0 where initial syncs would fail when the user had been kicked from a faster joined room that had not finished syncing. (#15383)

Improved Documentation

• Fix a typo in login requests ratelimit defaults. (#15341)
• Add some clarification to the doc/comments regarding TCP replication. (#15354)
• Note that Synapse 1.74 queued a rebuild of the user directory tables. (#15386)

Internal Changes

• Use immutabledict instead of frozendict. (#15113)
• Add developer documentation for the Federation Sender and add a documentation mechanism using Sphinx. (#15265, #15336)
• Make the pushers rely on the device_id instead of the access_token_id for various operations. (#15280)
• Bump sentry-sdk from 1.15.0 to 1.17.0. (#15285)
• Allow running the Twisted trunk job against other branches. (#15302)
• Remind the releaser to ask for changelog feedback in #synapse-dev. (#15303)
• Bump dtolnay/rust-toolchain from e12eda571dc9a5ee5d58eecf4738ec291c66f295 to fc3253060d0c959bea12a59f10f8391454a0b02d. (#15304)
• Reject events with an invalid "mentions" property per MSC3952. (#15311)
• As an optimisation, use TRUNCATE on Postgres when clearing the user directory tables. (#15316)
• Fix .gitignore rule for the Complement source tarball downloaded automatically by complement.sh. (#15319)
• Bump serde from 1.0.157 to 1.0.158. (#15324)
• Bump regex from 1.7.1 to 1.7.3. (#15325)
• Bump types-pyopenssl from 23.0.0.4 to 23.1.0.0. (#15326)
• Bump furo from 2022.12.7 to 2023.3.23. (#15327)
• Bump ruff from 0.0.252 to 0.0.259. (#15328)
• Bump cryptography from 40.0.0 to 40.0.1. (#15329)
• Bump mypy-zope from 0.9.0 to 0.9.1. (#15330)
• Speed up unit tests when using SQLite3. (#15334)
• Speed up pydantic CI job. (#15339)
• Speed up sample config CI job. (#15340)
• Fix copyright year in SSO footer template. (#15358)
• Bump peaceiris/actions-gh-pages from 3.9.2 to 3.9.3. (#15369)
• Bump serde from 1.0.158 to 1.0.159. (#15370)
• Bump serde_json from 1.0.94 to 1.0.95. (#15371)
• Speed up membership queries for users with forgotten rooms. (#15385)

Synapse 1.80.0 (2023-03-28)

No significant changes since 1.80.0rc2.

Synapse 1.80.0rc2 (2023-03-22)

Bugfixes

• Fix a bug in which the POST /_matrix/client/v3/rooms/{roomId}/report/{eventId} endpoint would return the wrong error if the user did not have permission to view the event. This aligns Synapse's implementation with MSC2249. (#15298, #15300)
• Fix a bug introduced in Synapse 1.75.0rc1 where the SQLite port_db script would fail to open the SQLite database. (#15301)

Synapse 1.80.0rc1 (2023-03-21)

Features

• Stabilise support for MSC3966: event_property_contains push condition. (#15187)
• Implement MSC2659: application service ping endpoint. Contributed by Tulir @ Beeper. (#15249)
• Allow loading /register/available endpoint on workers. (#15268)
• Improve performance of creating and authenticating events. (#15195)
• Add topic and name events to group of events that are batch persisted when creating a room. (#15229)

Bugfixes

• Fix a long-standing bug in which the user directory would assume any remote membership state events represent a profile change. (#14755, #14756)
• Implement MSC3873 to fix a long-standing bug where properties with dots were handled ambiguously in push rules. (#15190)
• Faster joins: Fix a bug introduced in Synapse 1.66 where spurious "Failed to find memberships ..." errors would be logged. (#15232)
• Fix a long-standing error when sending message into deleted room. (#15235)

Updates to the Docker image

• Ensure the Dockerfile builds on platforms that don't have a cryptography wheel. (#15239)
• Mirror images to the GitHub Container Registry (ghcr.io/matrix-org/synapse). (#15281, #15282)

Improved Documentation

• Add a missing endpoint to the workers documentation. (#15223)

Internal Changes

• Add additional functionality to declaring worker types when starting Complement in worker mode. (#14921)
• Add Synapse-Trace-Id to access-control-expose-headers header. (#14974)
• Make the HttpTransactionCache use the Requester in addition of the just the Request to build the transaction key. (#15200)
• Improve log lines when purging rooms. (#15222)
• Improve type hints. (#15230, #15231, #15238)
• Move various module API callback registration methods to a dedicated class. (#15237)
• Configure GitHub Actions for merge queues. (#15244)
• Add schema comments about the destinations and destination_rooms tables. (#15247)
• Skip processing of auto-join room behaviour if there are no auto-join rooms configured. (#15262)
• Remove unused store method _set_destination_retry_timings_emulated. (#15266)
• Reorganize URL preview code. (#15269)
• Clean-up direct TCP replication code. (#15272, #15274)
• Make configure_workers_and_start script used in Complement tests compatible with older versions of Python. (#15275)
• Add a /versions flag for MSC3952. (#15293)
• Bump hiredis from 2.2.1 to 2.2.2. (#15252)
• Bump serde from 1.0.152 to 1.0.155. (#15253)
• Bump pysaml2 from 7.2.1 to 7.3.1. (#15254)
• Bump msgpack from 1.0.4 to 1.0.5. (#15255)
• Bump gitpython from 3.1.30 to 3.1.31. (#15256)
• Bump cryptography from 39.0.1 to 39.0.2. (#15257)
• Bump pydantic from 1.10.4 to 1.10.6. (#15286)
• Bump serde from 1.0.155 to 1.0.157. (#15287)
• Bump anyhow from 1.0.69 to 1.0.70. (#15288)
• Bump txredisapi from 1.4.7 to 1.4.9. (#15289)
• Bump pygithub from 1.57 to 1.58.1. (#15290)
• Bump types-requests from 2.28.11.12 to 2.28.11.15. (#15291)

Synapse 1.79.0 (2023-03-14)

No significant changes since 1.79.0rc2.

Synapse 1.79.0rc2 (2023-03-13)

Bugfixes

• Fix a bug introduced in Synapse 1.79.0rc1 where attempting to register a on_remove_user_third_party_identifier module API callback would be a no-op. (#15227)
• Fix a rare bug introduced in Synapse 1.73 where events could remain unsent to other homeservers after a faster-join to a room. (#15248)

Internal Changes

• Refactor filter_events_for_server. (#15240)

Synapse 1.79.0rc1 (2023-03-07)

Features

• Add two new Third Party Rules module API callbacks: on_add_user_third_party_identifier and on_remove_user_third_party_identifier. (#15044)
• Experimental support for MSC3967 to not require UIA for setting up cross-signing on first use. (#15077)
• Add media information to the command line user data export tool. (#15107)
• Add an admin API to delete a specific event report. (#15116)
• Add support for knocking to workers. (#15133)
• Allow use of the /filter Client-Server APIs on workers. (#15134)
• Update support for MSC2677: remove support for server-side aggregation of reactions. (#15172)
• Stabilise support for MSC3758: event_property_is push condition. (#15185)

Bugfixes

• Fix a bug introduced in Synapse 1.75 that caused experimental support for deleting account data to raise an internal server error while using an account data writer worker. (#14869)
• Fix a long-standing bug where Synapse handled an unspecced field on push rules. (#15088)
• Fix a long-standing bug where a URL preview would break if the discovered oEmbed failed to download. (#15092)
• Fix a long-standing bug where an initial sync would not respond to changes to the list of ignored users if there was an initial sync cached. (#15163)
• Add the transaction_id in the events included in many endpoints' responses. (#15174)
• Fix a bug introduced in Synapse 1.78.0 where requests to claim dehydrated devices would fail with a 405 error. (#15180)
• Stop applying edits when bundling aggregations, per MSC3925. (#15193)
• Fix a long-standing bug where the user directory search was not case-insensitive for accented characters. (#15143)

Updates to the Docker image

• Improve startup logging in the with-workers Docker image. (#15186)

Improved Documentation

• Document how to use caches in a module. (#14026)
• Clarify which worker processes the ThirdPartyRules' on_new_event module API callback runs on. (#15071)
• Document using Shibboleth as an OpenID Provider. (#15112)
• Correct reference to federation_verify_certificates in configuration documentation. (#15139)
• Correct small documentation errors in some MatrixFederationHttpClient methods. (#15148)
• Correct the description of the behavior of registration_shared_secret_path on startup. (#15168)

Deprecations and Removals

• Deprecate the on_threepid_bind module callback, to be replaced by on_add_user_third_party_identifier. See upgrade notes. (#15044)
• Remove the unspecced room_alias field from the /createRoom response. (#15093)
• Remove the unspecced PUT on the /knock/{roomIdOrAlias} endpoint. (#15189)
• Remove the undocumented and unspecced type parameter to the /thumbnail endpoint. (#15137)
• Remove unspecced and buggy PUT method on the unstable /rooms/<room_id>/batch_send endpoint. (#15199)

Internal Changes

• Run the integration test suites with the asyncio reactor enabled in CI. (#14101)
• Batch up storing state groups when creating a new room. (#14918)
• Update MSC3952 support based on changes to the MSC. (#15051)
• Refactor writing json data in FileExfiltrationWriter. (#15095)
• Tighten the login ratelimit defaults. (#15135)
• Fix a typo in an experimental config setting. (#15138)
• Refactor the media modules. (#15146, #15175)
• Improve type hints. (#15164)
• Move get_event_report and get_event_reports_paginate from RoomStore to RoomWorkerStore. (#15165)
• Remove dangling reference to being a reference implementation in docstring. (#15167)
• Add an option to force a rebuild of the "editable" complement image. (#15184)
• Use nightly rustfmt in CI. (#15188)
• Add a get_next_txn method to StreamIdGenerator to match MultiWriterIdGenerator. (#15191)
• Combine AbstractStreamIdTracker and AbstractStreamIdGenerator. (#15192)
• Automatically fix errors with ruff. (#15194)
• Refactor database transaction for query users' devices to reduce database pool contention. (#15215)
• Correct test_icu_word_boundary_punctuation so that it passes with the ICU versions available in Alpine and macOS. (#15177)

Locked dependency updates

• Bump actions/checkout from 2 to 3. (#15155)
• Bump black from 22.12.0 to 23.1.0. (#15103)
• Bump dawidd6/action-download-artifact from 2.25.0 to 2.26.0. (#15152)
• Bump docker/login-action from 1 to 2. (#15154)
• Bump matrix-org/backend-meta from 1 to 2. (#15156)
• Bump ruff from 0.0.237 to 0.0.252. (#15159)
• Bump serde_json from 1.0.93 to 1.0.94. (#15214)
• Bump types-commonmark from 0.9.2.1 to 0.9.2.2. (#15209)
• Bump types-opentracing from 2.4.10.1 to 2.4.10.3. (#15158)
• Bump types-pillow from 9.4.0.13 to 9.4.0.17. (#15211)
• Bump types-psycopg2 from 2.9.21.4 to 2.9.21.8. (#15210)
• Bump types-pyopenssl from 22.1.0.2 to 23.0.0.4. (#15213)
• Bump types-setuptools from 67.3.0.1 to 67.4.0.3. (#15160)
• Bump types-setuptools from 67.4.0.3 to 67.5.0.0. (#15212)
• Bump typing-extensions from 4.4.0 to 4.5.0. (#15157)

Synapse 1.78.0 (2023-02-28)

Bugfixes

• Fix a bug introduced in Synapse 1.76 where 5s delays would occasionally occur in deployments using workers. (#15150)

Synapse 1.78.0rc1 (2023-02-21)

Features

• Implement the experimental exact_event_match push rule condition from MSC3758. (#14964)
• Add account data to the command line user data export tool. (#14969)
• Implement MSC3873 to disambiguate push rule keys with dots in them. (#15004)
• Allow Synapse to use a specific Redis logical database in worker-mode deployments. (#15034)
• Tag opentracing spans for federation requests with the name of the worker serving the request. (#15042)
• Implement the experimental exact_event_property_contains push rule condition from MSC3966. (#15045)
• Remove spurious dont_notify action from the defaults for the .m.rule.reaction pushrule. (#15073)
• Update the error code returned when user sends a duplicate annotation. (#15075)

Bugfixes

• Prevent clients from reporting nonexistent events. (#13779)
• Return spec-compliant JSON errors when unknown endpoints are requested. (#14605)
• Fix a long-standing bug where the room aliases returned could be corrupted. (#15038)
• Fix a bug introduced in Synapse 1.76.0 where partially-joined rooms could not be deleted using the purge room API. (#15068)
• Fix a long-standing bug where federated joins would fail if the first server in the list of servers to try is not in the room. (#15074)
• Fix a bug introduced in Synapse v1.74.0 where searching with colons when using ICU for search term tokenisation would fail with an error. (#15079)
• Reduce the likelihood of a rare race condition where rejoining a restricted room over federation would fail. (#15080)
• Fix a bug introduced in Synapse 1.76 where workers would fail to start if the health listener was configured. (#15096)
• Fix a bug introduced in Synapse 1.75 where the portdb script would fail to run after a room had been faster-joined. (#15108)

Improved Documentation

• Document how to start Synapse with Poetry. Contributed by @thezaidbintariq. (#14892, #15022)
• Update delegation documentation to clarify that SRV DNS delegation does not eliminate all needs to serve files from .well-known locations. Contributed by @williamkray. (#14959)
• Fix a mistake in registration_shared_secret_path docs. (#15078)
• Refer to a more recent blog post on the Database Maintenance Tools page. Contributed by @jahway603. (#15083)

Internal Changes

• Re-type hint some collections as read-only. (#13755)
• Faster joins: don't stall when another user joins during a partial-state room resync. (#14606)
• Add a class UnpersistedEventContext to allow for the batching up of storing state groups. (#14675)
• Add a check to ensure that locked dependencies have source distributions available. (#14742)
• Tweak comment on _is_local_room_accessible as part of room visibility in /hierarchy to clarify the condition for a room being visible. (#14834)
• Prevent WARNING: there is already a transaction in progress lines appearing in PostgreSQL's logs on some occasions. (#14840)
• Use StrCollection to avoid potential bugs with Collection[str]. (#14929)
• Improve performance of /sync in a few situations. (#14973)
• Limit concurrent event creation for a room to avoid state resolution when sending bursts of events to a local room. (#14977)
• Skip calculating unread push actions in /sync when enable_push is false. (#14980)
• Add a schema dump symlinks inside contrib, to make it easier for IDEs to interrogate Synapse's database schema. (#14982)
• Improve type hints. (#15008, #15026, #15027, #15028, #15031, #15035, #15052, #15072, #15084)
• Update MSC3952 support based on changes to the MSC. (#15037)
• Avoid mutating a cached value in get_user_devices_from_cache. (#15040)
• Fix a rare exception in logs on start up. (#15041)
• Update pyo3-log to v0.8.1. (#15043)
• Avoid mutating cached values in _generate_sync_entry_for_account_data. (#15047)
• Refactor arguments of try_unbind_threepid and _try_unbind_threepid_with_id_server to not use dictionaries. (#15053)
• Merge debug logging from the hotfixes branch. (#15054)
• Faster joins: omit device list updates originating from partial state rooms in /sync responses without lazy loading of members enabled. (#15069)
• Fix clashing database transaction name. (#15070)
• Upper-bound frozendict dependency. This works around us being unable to test installing our wheels against Python 3.11 in CI. (#15114)
• Tweak logging for when a worker waits for its view of a replication stream to catch up. (#15120)

Locked dependency updates

• Bump bleach from 5.0.1 to 6.0.0. (#15059)
• Bump cryptography from 38.0.4 to 39.0.1. (#15020)
• Bump ruff version from 0.0.230 to 0.0.237. (#15033)
• Bump dtolnay/rust-toolchain from 9cd00a88a73addc8617065438eff914dd08d0955 to 25dc93b901a87e864900a8aec6c12e9aa794c0c3. (#15060)
• Bump systemd-python from 234 to 235. (#15061)
• Bump serde_json from 1.0.92 to 1.0.93. (#15062)
• Bump types-requests from 2.28.11.8 to 2.28.11.12. (#15063)
• Bump types-pillow from 9.4.0.5 to 9.4.0.10. (#15064)
• Bump sentry-sdk from 1.13.0 to 1.15.0. (#15065)
• Bump types-jsonschema from 4.17.0.3 to 4.17.0.5. (#15099)
• Bump types-bleach from 5.0.3.1 to 6.0.0.0. (#15100)
• Bump dtolnay/rust-toolchain from 25dc93b901a87e864900a8aec6c12e9aa794c0c3 to e12eda571dc9a5ee5d58eecf4738ec291c66f295. (#15101)
• Bump dawidd6/action-download-artifact from 2.24.3 to 2.25.0. (#15102)
• Bump types-pillow from 9.4.0.10 to 9.4.0.13. (#15104)
• Bump types-setuptools from 67.1.0.0 to 67.3.0.1. (#15105)

Synapse 1.77.0 (2023-02-14)

No significant changes since 1.77.0rc2.

Synapse 1.77.0rc2 (2023-02-10)

Bugfixes

• Fix bug where retried replication requests would return a failure. Introduced in v1.76.0. (#15024)

Internal Changes

• Prepare for future database schema changes. (#15036)

Synapse 1.77.0rc1 (2023-02-07)

Features

• Experimental support for MSC3952: intentional mentions. (#14823, #14943, #14957, #14958)
• Experimental support to suppress notifications from message edits (MSC3958). (#14960, #15016)
• Add profile information, devices and connections to the command line user data export tool. (#14894)
• Improve performance when joining or sending an event in large rooms. (#14962)
• Improve performance of joining and leaving large rooms with many local users. (#14971)

Bugfixes

• Fix a bug introduced in Synapse 1.53.0 where next_batch tokens from /sync could not be used with the /relations endpoint. (#14866)
• Fix a bug introduced in Synapse 1.35.0 where the module API's send_local_online_presence_to would fail to send presence updates over federation. (#14880)
• Fix a bug introduced in Synapse 1.70.0 where the background updates to add non-thread unique indexes on receipts could fail when upgrading from 1.67.0 or earlier. (#14915)
• Fix a regression introduced in Synapse 1.69.0 which can result in database corruption when database migrations are interrupted on sqlite. (#14926)
• Fix a bug introduced in Synapse 1.68.0 where we were unable to service remote joins in rooms with @room notification levels set to null in their (malformed) power levels. (#14942)
• Fix a bug introduced in Synapse 1.64.0 where boolean power levels were erroneously permitted in v10 rooms. (#14944)
• Fix a long-standing bug where sending messages on servers with presence enabled would spam "Re-starting finished log context" log lines. (#14947)
• Fix a bug introduced in Synapse 1.68.0 where logging from the Rust module was not properly logged. (#14976)
• Fix various long-standing bugs in Synapse's config, event and request handling where booleans were unintentionally accepted where an integer was expected. (#14945)

Internal Changes

• Add missing type hints. (#14879, #14886, #14887, #14904, #14927, #14956, #14983, #14984, #14985, #14987, #14988, #14990, #14991, #14992, #15007)
• Use StrCollection to avoid potential bugs with Collection[str]. (#14922)
• Allow running the complement tests suites with the asyncio reactor enabled. (#14858)
• Improve performance of /sync in a few situations. (#14908, #14970)
• Document how to handle Dependabot pull requests. (#14916)
• Fix typo in release script. (#14920)
• Update build system requirements to allow building with poetry-core 1.5.0. (#14949, #15019)
• Add an lnav config file for Synapse logs to /contrib/lnav. (#14953)
• Faster joins: Refactor internal handling of servers in room to never store an empty list. (#14954)
• Faster joins: tag v2/send_join/ requests to indicate if they served a partial join response. (#14950)
• Allow running cargo without the extension-module option. (#14965)
• Preparatory work for adding a denormalised event stream ordering column in the future. Contributed by Nick @ Beeper (@fizzadar). (#14979, 9cd7610, f10caa7; see #15014)
• Add tests for _flatten_dict. (#14981, #15002)

Locked dependency updates

• Bump dtolnay/rust-toolchain from e645b0cf01249a964ec099494d38d2da0f0b349f to 9cd00a88a73addc8617065438eff914dd08d0955. (#14968)
• Bump docker/build-push-action from 3 to 4. (#14952)
• Bump ijson from 3.1.4 to 3.2.0.post0. (#14935)
• Bump types-pyyaml from 6.0.12.2 to 6.0.12.3. (#14936)
• Bump types-jsonschema from 4.17.0.2 to 4.17.0.3. (#14937)
• Bump types-pillow from 9.4.0.3 to 9.4.0.5. (#14938)
• Bump hiredis from 2.0.0 to 2.1.1. (#14939)
• Bump hiredis from 2.1.1 to 2.2.1. (#14993)
• Bump types-setuptools from 65.6.0.3 to 67.1.0.0. (#14994)
• Bump prometheus-client from 0.15.0 to 0.16.0. (#14995)
• Bump anyhow from 1.0.68 to 1.0.69. (#14996)
• Bump serde_json from 1.0.91 to 1.0.92. (#14997)
• Bump isort from 5.11.4 to 5.11.5. (#14998)
• Bump phonenumbers from 8.13.4 to 8.13.5. (#14999)

Synapse 1.76.0 (2023-01-31)

The 1.76 release is the first to enable faster joins (MSC3706 and MSC3902) by default. Admins can opt-out: see the upgrade notes for more details.

The upgrade from 1.75 to 1.76 changes the account data replication streams in a backwards-incompatible manner. Server operators running a multi-worker deployment should consult the upgrade notes.

Those who are poetry installing from source using our lockfile should ensure their poetry version is 1.3.2 or higher; see upgrade notes.

Notes on faster joins

The faster joins project sees the most benefit when joining a room with a large number of members (joined or historical). We expect it to be particularly useful for joining large public rooms like the Matrix HQ or Synapse Admins rooms.

After a faster join, Synapse considers that room "partially joined". In this state, you should be able to

• read incoming messages;
• see incoming state changes, e.g. room topic changes; and
• send messages, if the room is unencrypted.

Synapse has to spend more effort to complete the join in the background. Once this finishes, you will be able to

• send messages, if the room is in encrypted;
• retrieve room history from before your join, if permitted by the room settings; and
• access the full list of room members.

Improved Documentation

• Describe the ideas and the internal machinery behind faster joins. (#14677)

Synapse 1.76.0rc2 (2023-01-27)

Bugfixes

• Faster joins: Fix a bug introduced in Synapse 1.69 where device list EDUs could fail to be handled after a restart when a faster join sync is in progress. (#14914)

Internal Changes

• Faster joins: Improve performance of looking up partial-state status of rooms. (#14917)

Synapse 1.76.0rc1 (2023-01-25)

Features

• Update the default room version to v10 (MSC 3904). Contributed by @FSG-Cat. (#14111)
• Add a set_displayname() method to the module API for setting a user's display name. (#14629)
• Add a dedicated listener configuration for health endpoint. (#14747)
• Implement support for MSC3890: Remotely silence local notifications. (#14775)
• Implement experimental support for MSC3930: Push rules for (MSC3381) Polls. (#14787)
• Per MSC3925, bundle the whole of the replacement with any edited events, and optionally inhibit server-side replacement. (#14811)
• Faster joins: always serve a partial join response to servers that request it with the stable query param. (#14839)
• Faster joins: allow non-lazy-loading ("eager") syncs to complete after a partial join by omitting partial state rooms until they become fully stated. (#14870)
• Faster joins: request partial joins by default. Admins can opt-out of this for the time being---see the upgrade notes. (#14905)

Bugfixes

• Add index to improve performance of the /timestamp_to_event endpoint used for jumping to a specific date in the timeline of a room. (#14799)
• Fix a long-standing bug where Synapse would exhaust the stack when processing many federation requests where the remote homeserver has disconencted early. (#14812, #14842)
• Fix rare races when using workers. (#14820)
• Fix a bug introduced in Synapse 1.64.0 when using room version 10 with frozen events enabled. (#14864)
• Fix a long-standing bug where the populate_room_stats background job could fail on broken rooms. (#14873)
• Faster joins: Fix a bug in worker deployments where the room stats and user directory would not get updated when finishing a fast join until another event is sent or received. (#14874)
• Faster joins: Fix incompatibility with joins into restricted rooms where no local users have the ability to invite. (#14882)
• Fix a regression introduced in Synapse 1.69.0 which can result in database corruption when database migrations are interrupted on sqlite. (#14910)

Updates to the Docker image

• Bump default Python version in the Dockerfile from 3.9 to 3.11. (#14875)

Improved Documentation

• Include x_forwarded entry in the HTTP listener example configs and remove the remaining worker_main_http_uri entries. (#14667)
• Remove duplicate commands from the Code Style documentation page; point to the Contributing Guide instead. (#14773)
• Add missing documentation for tag to listeners section. (#14803)
• Updated documentation in configuration manual for user_directory.search_all_users. (#14818)
• Add worker_manhole to configuration manual. (#14824)
• Fix the example config missing the id field in application service documentation. (#14845)
• Minor corrections to the logging configuration documentation. (#14868)
• Document the export user data command. Contributed by @thezaidbintariq. (#14883)

Deprecations and Removals

• Poetry 1.3.2 or higher is now required when poetry installing from source. (#14860)

Internal Changes

• Faster remote room joins (worker mode): do not populate external hosts-in-room cache when sending events as this requires blocking for full state. (#14749)
• Enable Complement tests for Faster Remote Room Joins against worker-mode Synapse. (#14752)
• Add some clarifying comments and refactor a portion of the Keyring class for readability. (#14804)
• Add local poetry config files (poetry.toml) to .gitignore. (#14807)
• Add missing type hints. (#14816, #14885, #14889)
• Refactor push tests. (#14819)
• Re-enable some linting that was disabled when we switched to ruff. (#14821)
• Add cargo fmt and cargo clippy to the lint script. (#14822)
• Drop unused table presence. (#14825)
• Merge the two account data and the two device list replication streams. (#14826, #14833)
• Faster joins: use stable identifiers from MSC3706. (#14832, #14841)
• Add a parameter to control whether the federation client performs a partial state join. (#14843)
• Add check to avoid starting duplicate partial state syncs. (#14844)
• Add an early return when handling no-op presence updates. (#14855)
• Fix wait_for_stream_position to correctly wait for the right instance to advance its token. (#14856, #14872)
• Always notify replication when a stream advances automatically. (#14877)
• Reduce max time we wait for stream positions. (#14881)
• Faster joins: allow the resync process more time to fetch /state ids. (#14912)
• Bump regex from 1.7.0 to 1.7.1. (#14848)
• Bump peaceiris/actions-gh-pages from 3.9.1 to 3.9.2. (#14861)
• Bump ruff from 0.0.215 to 0.0.224. (#14862)
• Bump types-pillow from 9.4.0.0 to 9.4.0.3. (#14863)
• Bump types-opentracing from 2.4.10 to 2.4.10.1. (#14896)
• Bump ruff from 0.0.224 to 0.0.230. (#14897)
• Bump types-requests from 2.28.11.7 to 2.28.11.8. (#14899)
• Bump types-psycopg2 from 2.9.21.2 to 2.9.21.4. (#14900)
• Bump types-commonmark from 0.9.2 to 0.9.2.1. (#14901)

Synapse 1.75.0 (2023-01-17)

No significant changes since 1.75.0rc2.

Synapse 1.75.0rc2 (2023-01-12)

Bugfixes

• Fix a bug introduced in Synapse 1.75.0rc1 where device lists could be miscalculated with some sync filters. (#14810)
• Fix race where calling /members or /state with an at parameter could fail for newly created rooms, when using multiple workers. (#14817)

Synapse 1.75.0rc1 (2023-01-10)

Features

• Add a cached function to synapse.module_api that returns a decorator to cache return values of functions. (#14663)
• Add experimental support for MSC3391 (removing account data). (#14714)
• Support RFC7636 Proof Key for Code Exchange for OAuth single sign-on. (#14750)
• Support non-OpenID compliant userinfo claims for subject and picture. (#14753)
• Improve performance of /sync when filtering all rooms, message types, or senders. (#14786)
• Improve performance of the /hierarchy endpoint. (#14263)

Bugfixes

• Fix the MAU Limits section of the Grafana dashboard relying on a specific job name for the workers of a Synapse deployment. (#14644)
• Fix a bug introduced in Synapse 1.70.0 which could cause spurious UNIQUE constraint failed errors in the rotate_notifs background job. (#14669)
• Ensure stream IDs are always updated after caches get invalidated with workers. Contributed by Nick @ Beeper (@fizzadar). (#14723)
• Remove the unspecced device field from /pushrules responses. (#14727)
• Fix a bug introduced in Synapse 1.73.0 where the picture_claim configured under oidc_providers was unused (the default value of "picture" was used instead). (#14751)
• Unescape HTML entities in URL preview titles making use of oEmbed responses. (#14781)
• Disable sending confirmation email when 3pid is disabled. (#14725)

Improved Documentation

• Declare support for Python 3.11. (#14673)
• Fix target_memory_usage being used in the description for the actual cache_autotune sub-option target_cache_memory_usage. (#14674)
• Move email to Server section in config file documentation. (#14730)
• Fix broken links in the Synapse documentation. (#14744)
• Add missing worker settings to shared configuration documentation. (#14748)
• Document using Twitter as a OAuth 2.0 authentication provider. (#14778)
• Fix Synapse 1.74 upgrade notes to correctly explain how to install pyICU when installing Synapse from PyPI. (#14797)
• Update link to towncrier in contribution guide. (#14801)
• Use htmltest to check links in the Synapse documentation. (#14743)

Internal Changes

• Faster remote room joins: stream the un-partial-stating of events over replication. (#14545, #14546)
• Use ruff instead of flake8. (#14633, #14741)
• Change handle_new_client_event signature so that a 429 does not reach clients on PartialStateConflictError, and internally retry when needed instead. (#14665)
• Remove dependency on jQuery on reCAPTCHA page. (#14672)
• Faster joins: make compute_state_after_events consistent with other state-fetching functions that take a StateFilter. (#14676)
• Add missing type hints. (#14680, #14681, #14687)
• Improve type annotations for the helper methods on a CachedFunction. (#14685)
• Check that the SQLite database file exists before porting to PostgreSQL. (#14692)
• Add .direnv/ directory to .gitignore to prevent local state generated by the direnv development tool from being committed. (#14707)
• Batch up replication requests to request the resyncing of remote users's devices. (#14716)
• If debug logging is enabled, log the msgids of any to-device messages that are returned over /sync. (#14724)
• Change GHA CI job to follow best practices. (#14772)
• Switch to our fork of dh-virtualenv to work around an upstream Python 3.11 incompatibility. (#14774)
• Skip testing built wheels for PyPy 3.7 on Linux x86_64 as we lack new required dependencies in the build environment. (#14802)

Dependabot updates

• Bump JasonEtco/create-an-issue from 2.8.1 to 2.8.2. (#14693)
• Bump anyhow from 1.0.66 to 1.0.68. (#14694)
• Bump blake2 from 0.10.5 to 0.10.6. (#14695)
• Bump serde_json from 1.0.89 to 1.0.91. (#14696)
• Bump serde from 1.0.150 to 1.0.151. (#14697)
• Bump lxml from 4.9.1 to 4.9.2. (#14698)
• Bump types-jsonschema from 4.17.0.1 to 4.17.0.2. (#14700)
• Bump sentry-sdk from 1.11.1 to 1.12.0. (#14701)
• Bump types-setuptools from 65.6.0.1 to 65.6.0.2. (#14702)
• Bump minimum PyYAML to 3.13. (#14720)
• Bump JasonEtco/create-an-issue from 2.8.2 to 2.9.1. (#14731)
• Bump towncrier from 22.8.0 to 22.12.0. (#14732)
• Bump isort from 5.10.1 to 5.11.4. (#14733)
• Bump attrs from 22.1.0 to 22.2.0. (#14734)
• Bump black from 22.10.0 to 22.12.0. (#14735)
• Bump sentry-sdk from 1.12.0 to 1.12.1. (#14736)
• Bump setuptools from 65.3.0 to 65.5.1. (#14738)
• Bump serde from 1.0.151 to 1.0.152. (#14758)
• Bump ruff from 0.0.189 to 0.0.206. (#14759)
• Bump pydantic from 1.10.2 to 1.10.4. (#14760)
• Bump gitpython from 3.1.29 to 3.1.30. (#14761)
• Bump pillow from 9.3.0 to 9.4.0. (#14762)
• Bump types-requests from 2.28.11.5 to 2.28.11.7. (#14763)
• Bump dawidd6/action-download-artifact from 2.24.2 to 2.24.3. (#14779)
• Bump peaceiris/actions-gh-pages from 3.9.0 to 3.9.1. (#14791)
• Bump types-pillow from 9.3.0.4 to 9.4.0.0. (#14792)
• Bump pyopenssl from 22.1.0 to 23.0.0. (#14793)
• Bump types-setuptools from 65.6.0.2 to 65.6.0.3. (#14794)
• Bump importlib-metadata from 4.2.0 to 6.0.0. (#14795)
• Bump ruff from 0.0.206 to 0.0.215. (#14796)

Changelogs for older versions can be found here.