1.131.0

Co-Authored-By: Andrew Morgan <andrew@amorgan.xyz>

.ci/scripts/calculate_jobs.py

@@ -120,7 +120,6 @@ sytest_tests = [
         "postgres": "multi-postgres",
         "workers": "workers",
         "reactor": "asyncio",
-        "failure_allowed": True,
     },
 ]
 

.github/workflows/docs.yaml

@@ -78,18 +78,6 @@ jobs:
           mdbook build
           cp book/welcome_and_overview.html book/index.html
 
-      - name: Prepare and publish schema files
-        run: |
-          sudo apt-get update && sudo apt-get install -y yq
-          mkdir -p book/schema
-          # Remove developer notice before publishing.
-          rm schema/v*/Do\ not\ edit\ files\ in\ this\ folder
-          # Copy schema files that are independent from current Synapse version.
-          cp -r -t book/schema schema/v*/
-          # Convert config schema from YAML source file to JSON.
-          yq < schema/synapse-config.schema.yaml \
-            > book/schema/synapse-config.schema.json
-
       # Deploy to the target directory.
       - name: Deploy to gh pages
         uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4.0.0

.github/workflows/schema.yaml

@@ -1,54 +0,0 @@
-name: Schema
-
-on:
-  pull_request:
-    paths:
-      - schema/**
-      - docs/usage/configuration/config_documentation.md
-
-jobs:
-  validate-schema:
-    name: Ensure Synapse config schema is valid
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
-      - uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55 # v5.5.0
-        with:
-          python-version: "3.x"
-      - name: Install check-jsonschema
-        run: pip install check-jsonschema==0.33.0
-
-      - name: Validate meta schema
-        run: check-jsonschema --check-metaschema schema/v*/meta.schema.json
-      - name: Validate schema
-        run: |-
-          # Please bump on introduction of a new meta schema.
-          LATEST_META_SCHEMA_VERSION=v1
-          check-jsonschema \
-            --schemafile="schema/$LATEST_META_SCHEMA_VERSION/meta.schema.json" \
-            schema/synapse-config.schema.yaml
-      - name: Validate default config
-      # Populates the empty instance with default values and checks against the schema.
-        run: |-
-          echo "{}" | check-jsonschema \
-            --fill-defaults --schemafile=schema/synapse-config.schema.yaml -
-
-  check-doc-generation:
-    name: Ensure generated documentation is up-to-date
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
-      - uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55 # v5.5.0
-        with:
-          python-version: "3.x"
-      - name: Install PyYAML
-        run: pip install PyYAML==6.0.2
-
-      - name: Regenerate config documentation
-        run: |
-          scripts-dev/gen_config_documentation.py \
-            schema/synapse-config.schema.yaml \
-          > docs/usage/configuration/config_documentation.md
-      - name: Error in case of any differences
-      # Errors if there are now any modified files (untracked files are ignored).
-        run: 'git diff || ! git status --porcelain=1 | grep "^ M"'

.github/workflows/tests.yml

@@ -525,11 +525,6 @@ jobs:
       - name: Run SyTest
         run: /bootstrap.sh synapse
         working-directory: /src
-        # Prevent failures of this configuration from causing all of CI to
-        # marked as failed. This is useful for testing a new Synapse configuration
-        # in anger without causing sporatic CI failures.
-        continue-on-error: ${{ matrix.job.failure_allowed || false }}
-
       - name: Summarise results.tap
         if: ${{ always() }}
         run: /sytest/scripts/tap_to_gha.pl /logs/results.tap

CHANGES.md

@@ -1,3 +1,57 @@
+# Synapse 1.131.0 (2025-06-03)
+
+No significant changes since 1.131.0rc1.
+
+# Synapse 1.131.0rc1 (2025-05-28)
+
+### Features
+
+- Add `msc4263_limit_key_queries_to_users_who_share_rooms` config option as per [MSC4263](https://github.com/matrix-org/matrix-spec-proposals/pull/4263). ([\#18180](https://github.com/element-hq/synapse/issues/18180))
+- Add option to allow registrations that begin with `_`. Contributed by `_` (@hex5f). ([\#18262](https://github.com/element-hq/synapse/issues/18262))
+- Include room ID in response to the [Room Deletion Status Admin API](https://element-hq.github.io/synapse/latest/admin_api/rooms.html#status-of-deleting-rooms). ([\#18318](https://github.com/element-hq/synapse/issues/18318))
+- Add support for calling Policy Servers ([MSC4284](https://github.com/matrix-org/matrix-spec-proposals/pull/4284)) to mark events as spam. ([\#18387](https://github.com/element-hq/synapse/issues/18387))
+
+### Bugfixes
+
+- Prevent race-condition in `_maybe_retry_device_resync` entrance. ([\#18391](https://github.com/element-hq/synapse/issues/18391))
+- Fix the `tests.handlers.test_worker_lock.WorkerLockTestCase.test_lock_contention` test which could spuriously time out on RISC-V architectures due to performance differences. ([\#18430](https://github.com/element-hq/synapse/issues/18430))
+- Fix admin redaction endpoint not redacting encrypted messages. ([\#18434](https://github.com/element-hq/synapse/issues/18434))
+
+### Improved Documentation
+
+- Update `room_list_publication_rules` docs to consider defaults that changed in v1.126.0. Contributed by @HarHarLinks. ([\#18286](https://github.com/element-hq/synapse/issues/18286))
+- Add advice for upgrading between major PostgreSQL versions to the database documentation. ([\#18445](https://github.com/element-hq/synapse/issues/18445))
+
+### Internal Changes
+
+- Fix a memory leak in `_NotifierUserStream`. ([\#18380](https://github.com/element-hq/synapse/issues/18380))
+- Fix a couple type annotations in the `RootConfig`/`Config`. ([\#18409](https://github.com/element-hq/synapse/issues/18409))
+- Explicitly enable PyPy builds in `cibuildwheel`s config to avoid it being disabled on a future upgrade to `cibuildwheel` v3. ([\#18417](https://github.com/element-hq/synapse/issues/18417))
+- Update the PR review template to remove an erroneous line break from the final bullet point. ([\#18419](https://github.com/element-hq/synapse/issues/18419))
+- Explain why we `flush_buffer()` for Python `print(...)` output. ([\#18420](https://github.com/element-hq/synapse/issues/18420))
+- Add lint to ensure we don't add a `CREATE/DROP INDEX` in a schema delta. ([\#18440](https://github.com/element-hq/synapse/issues/18440))
+- Allow checking only for the existence of a field in an SSO provider's response, rather than requiring the value(s) to check. ([\#18454](https://github.com/element-hq/synapse/issues/18454))
+- Add unit tests for homeserver usage statistics. ([\#18463](https://github.com/element-hq/synapse/issues/18463))
+- Don't move invited users to new room when shutting down room. ([\#18471](https://github.com/element-hq/synapse/issues/18471))
+
+
+
+### Updates to locked dependencies
+
+* Bump actions/setup-python from 5.5.0 to 5.6.0. ([\#18398](https://github.com/element-hq/synapse/issues/18398))
+* Bump authlib from 1.5.1 to 1.5.2. ([\#18452](https://github.com/element-hq/synapse/issues/18452))
+* Bump docker/build-push-action from 6.15.0 to 6.17.0. ([\#18397](https://github.com/element-hq/synapse/issues/18397), [\#18449](https://github.com/element-hq/synapse/issues/18449))
+* Bump lxml from 5.3.0 to 5.4.0. ([\#18480](https://github.com/element-hq/synapse/issues/18480))
+* Bump mypy-zope from 1.0.9 to 1.0.11. ([\#18428](https://github.com/element-hq/synapse/issues/18428))
+* Bump pyo3 from 0.23.5 to 0.24.2. ([\#18460](https://github.com/element-hq/synapse/issues/18460))
+* Bump pyo3-log from 0.12.3 to 0.12.4. ([\#18453](https://github.com/element-hq/synapse/issues/18453))
+* Bump pyopenssl from 25.0.0 to 25.1.0. ([\#18450](https://github.com/element-hq/synapse/issues/18450))
+* Bump ruff from 0.7.3 to 0.11.11. ([\#18451](https://github.com/element-hq/synapse/issues/18451), [\#18482](https://github.com/element-hq/synapse/issues/18482))
+* Bump tornado from 6.4.2 to 6.5.0. ([\#18459](https://github.com/element-hq/synapse/issues/18459))
+* Bump setuptools from 72.1.0 to 78.1.1. ([\#18461](https://github.com/element-hq/synapse/issues/18461))
+* Bump types-jsonschema from 4.23.0.20241208 to 4.23.0.20250516. ([\#18481](https://github.com/element-hq/synapse/issues/18481))
+* Bump types-requests from 2.32.0.20241016 to 2.32.0.20250328. ([\#18427](https://github.com/element-hq/synapse/issues/18427))
+
 # Synapse 1.130.0 (2025-05-20)
 
 ### Bugfixes

changelog.d/17892.doc

@@ -1 +0,0 @@
-Generate config documentation from JSON Schema file.

changelog.d/18180.feature

@@ -1 +0,0 @@
-Add `msc4263_limit_key_queries_to_users_who_share_rooms` config option as per [MSC4263](https://github.com/matrix-org/matrix-spec-proposals/pull/4263).

changelog.d/18252.misc

@@ -1 +0,0 @@
-Mark dehydrated devices in the [List All User Devices Admin API](https://element-hq.github.io/synapse/latest/admin_api/user_admin_api.html#list-all-devices).

changelog.d/18262.feature

@@ -1 +0,0 @@
-Add option to allow registrations that begin with `_`. Contributed by `_` (@hex5f).

changelog.d/18286.doc

@@ -1 +0,0 @@
-Update `room_list_publication_rules` docs to consider defaults that changed in v1.126.0. Contributed by @HarHarLinks.

changelog.d/18318.feature

@@ -1 +0,0 @@
-Include room ID in room deletion status response.

changelog.d/18380.misc

@@ -1 +0,0 @@
-Fix a memory leak in `_NotifierUserStream`.

changelog.d/18387.feature

@@ -1 +0,0 @@
-Add support for calling Policy Servers ([MSC4284](https://github.com/matrix-org/matrix-spec-proposals/pull/4284)) to mark events as spam.

changelog.d/18391.bugfix

@@ -1 +0,0 @@
-Prevent race-condition in `_maybe_retry_device_resync` entrance.

changelog.d/18409.misc

@@ -1 +0,0 @@
-Fix a couple type annotations in the `RootConfig`/`Config`.

changelog.d/18417.misc

@@ -1 +0,0 @@
-Explicitly enable PyPy builds in `cibuildwheel`s config to avoid it being disabled on a future upgrade to `cibuildwheel` v3.

changelog.d/18419.misc

@@ -1 +0,0 @@
-Update the PR review template to remove an erroneous line break from the final bullet point.

changelog.d/18420.misc

@@ -1 +0,0 @@
-Explain why we `flush_buffer()` for Python `print(...)` output.

changelog.d/18430.bugfix

@@ -1 +0,0 @@
-Fix the `tests.handlers.test_worker_lock.WorkerLockTestCase.test_lock_contention` test which could spuriously time out on RISC-V architectures due to performance differences.

changelog.d/18434.bugfix

@@ -1 +0,0 @@
-Fix admin redaction endpoint not redacting encrypted messages.

changelog.d/18440.misc

@@ -1 +0,0 @@
-Add lint to ensure we don't add a `CREATE/DROP INDEX` in a schema delta.

changelog.d/18445.doc

@@ -1 +0,0 @@
-Add advice for upgrading between major PostgreSQL versions to the database documentation.

changelog.d/18451.misc

@@ -1 +0,0 @@
-Bump ruff from 0.7.3 to 0.11.10.

changelog.d/18454.misc

@@ -1 +0,0 @@
-Allow checking only for the existence of a field in an SSO provider's response, rather than requiring the value(s) to check.

changelog.d/18459.misc

@@ -1 +0,0 @@
-Bump tornado from 6.4.2 to 6.5.0.

changelog.d/18460.misc

@@ -1 +0,0 @@
-Bump pyo3 from 0.23.5 to 0.24.2.

changelog.d/18463.misc

@@ -1 +0,0 @@
-Add unit tests for homeserver usage statistics.

changelog.d/18471.misc

@@ -1 +0,0 @@
-Don't move invited users to new room when shutting down room.

debian/changelog

@@ -1,3 +1,15 @@
+matrix-synapse-py3 (1.131.0) stable; urgency=medium
+
+  * New Synapse release 1.131.0.
+
+ -- Synapse Packaging team <packages@matrix.org>  Tue, 03 Jun 2025 14:36:55 +0100
+
+matrix-synapse-py3 (1.131.0~rc1) stable; urgency=medium
+
+  * New synapse release 1.131.0rc1.
+
+ -- Synapse Packaging team <packages@matrix.org>  Wed, 28 May 2025 10:25:44 +0000
+
 matrix-synapse-py3 (1.130.0) stable; urgency=medium
 
   * New Synapse release 1.130.0.

docs/README.md

@@ -63,18 +63,6 @@ mdbook serve
 
 The URL at which the docs can be viewed at will be logged.
 
-## Synapse configuration documentation
-
-The [Configuration
-Manual](https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html)
-page is generated from a YAML file,
-[schema/synapse-config.schema.yaml](../schema/synapse-config.schema.yaml). To
-add new options or modify existing ones, first edit that file, then run
-[scripts-dev/gen_config_documentation.py](../scripts-dev/gen_config_documentation.py)
-to generate an updated Configuration Manual markdown file.
-
-Build the book as described above to preview it in a web browser.
-
 ## Configuration and theming
 
 The look and behaviour of the website is configured by the [book.toml](../book.toml) file

docs/admin_api/user_admin_api.md

@@ -954,8 +954,7 @@ A response body like the following is returned:
       "last_seen_ip": "1.2.3.4",
       "last_seen_user_agent": "Mozilla/5.0 (X11; Linux x86_64; rv:103.0) Gecko/20100101 Firefox/103.0",
       "last_seen_ts": 1474491775024,
-      "user_id": "<user_id>",
-      "dehydrated": false
+      "user_id": "<user_id>"
     },
     {
       "device_id": "AUIECTSRND",
@@ -963,8 +962,7 @@ A response body like the following is returned:
       "last_seen_ip": "1.2.3.5",
       "last_seen_user_agent": "Mozilla/5.0 (X11; Linux x86_64; rv:103.0) Gecko/20100101 Firefox/103.0",
       "last_seen_ts": 1474491775025,
-      "user_id": "<user_id>",
-      "dehydrated": false
+      "user_id": "<user_id>"
     }
   ],
   "total": 2
@@ -994,7 +992,6 @@ The following fields are returned in the JSON response body:
   - `last_seen_ts` - The timestamp (in milliseconds since the unix epoch) when this
     devices was last seen. (May be a few minutes out of date, for efficiency reasons).
   - `user_id` - Owner of  device.
-  - `dehydrated` - Whether the device is a dehydrated device.
 
 - `total` - Total number of user's devices.
 

docs/usage/administration/admin_faq.md

@@ -255,7 +255,7 @@ line to `/etc/default/matrix-synapse`:
 
     LD_PRELOAD=/usr/lib/x86_64-linux-gnu/libjemalloc.so.2
 
-*Note*: You may need to set `PYTHONMALLOC=malloc` to ensure that `jemalloc` can accurately calculate memory usage. By default, Python uses its internal small-object allocator, which may interfere with jemalloc's ability to track memory consumption correctly. This could prevent the [cache_autotuning](../configuration/config_documentation.md#caches) feature from functioning as expected, as the Python allocator may not reach the memory threshold set by `max_cache_memory_usage`, thus not triggering the cache eviction process.
+*Note*: You may need to set `PYTHONMALLOC=malloc` to ensure that `jemalloc` can accurately calculate memory usage. By default, Python uses its internal small-object allocator, which may interfere with jemalloc's ability to track memory consumption correctly. This could prevent the [cache_autotuning](../configuration/config_documentation.md#caches-and-associated-values) feature from functioning as expected, as the Python allocator may not reach the memory threshold set by `max_cache_memory_usage`, thus not triggering the cache eviction process.
 
 This made a significant difference on Python 2.7 - it's unclear how
 much of an improvement it provides on Python 3.x.

pyproject.toml

@@ -97,7 +97,7 @@ module-name = "synapse.synapse_rust"
 
 [tool.poetry]
 name = "matrix-synapse"
-version = "1.130.0"
+version = "1.131.0"
 description = "Homeserver for the Matrix decentralised comms protocol"
 authors = ["Matrix.org Team and Contributors <packages@matrix.org>"]
 license = "AGPL-3.0-or-later"

schema/v1/Do not edit files in this folder

@@ -1,2 +0,0 @@
-If you want to update the meta schema, copy this folder and increase its version
-number instead.

schema/v1/meta.schema.json

@@ -1,29 +0,0 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://element-hq.github.io/synapse/latest/schema/v1/meta.schema.json",
-  "$vocabulary": {
-    "https://json-schema.org/draft/2020-12/vocab/core": true,
-    "https://json-schema.org/draft/2020-12/vocab/applicator": true,
-    "https://json-schema.org/draft/2020-12/vocab/unevaluated": true,
-    "https://json-schema.org/draft/2020-12/vocab/validation": true,
-    "https://json-schema.org/draft/2020-12/vocab/meta-data": true,
-    "https://json-schema.org/draft/2020-12/vocab/format-annotation": true,
-    "https://json-schema.org/draft/2020-12/vocab/content": true,
-    "https://element-hq.github.io/synapse/latest/schema/v1/vocab/documentation": false
-  },
-  "$ref": "https://json-schema.org/draft/2020-12/schema",
-  "properties": {
-    "io.element.type_name": {
-      "type": "string",
-      "description": "Human-readable type of a schema that is displayed instead of the standard JSON Schema types like `object` or `integer`. In case the JSON Schema type contains `null`, this information should be presented alongside the human-readable type name.",
-      "examples": ["duration", "byte size"]
-    },
-    "io.element.post_description": {
-      "type": "string",
-      "description": "Additional description of a schema, better suited to be placed less prominently in the generated documentation, e.g., at the end of a section after listings of items and properties.",
-      "examples": [
-        "### Advanced uses\n\nThe spent coffee grounds can be added to compost for improving soil and growing plants."
-      ]
-    }
-  }
-}

schema/v1/vocab/documentation.html

@@ -1,11 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-    <head>
-        <meta http-equiv="refresh" content="0; URL=../meta.schema.json">
-        <meta charset="UTF-8">
-        <title>Redirecting to ../meta.schema.json…</title>
-    </head>
-    <body>
-        <p>Redirecting to <a href="../meta.schema.json">../meta.schema.json</a>…</p>
-    </body>
-</html>

scripts-dev/gen_config_documentation.py

@@ -1,503 +0,0 @@
-#!/usr/bin/env python3
-"""Generate Synapse documentation from JSON Schema file."""
-
-import json
-import re
-import sys
-from typing import Any, Optional
-
-import yaml
-
-HEADER = """<!-- Document auto-generated by scripts-dev/gen_config_documentation.py -->
-
-# Configuring Synapse
-
-This is intended as a guide to the Synapse configuration. The behavior of a Synapse instance can be modified
-through the many configuration settings documented here — each config option is explained,
-including what the default is, how to change the default and what sort of behaviour the setting governs.
-Also included is an example configuration for each setting. If you don't want to spend a lot of time
-thinking about options, the config as generated sets sensible defaults for all values. Do note however that the
-database defaults to SQLite, which is not recommended for production usage. You can read more on this subject
-[here](../../setup/installation.md#using-postgresql).
-
-## Config Conventions
-
-Configuration options that take a time period can be set using a number
-followed by a letter. Letters have the following meanings:
-
-* `s` = second
-* `m` = minute
-* `h` = hour
-* `d` = day
-* `w` = week
-* `y` = year
-
-For example, setting `redaction_retention_period: 5m` would remove redacted
-messages from the database after 5 minutes, rather than 5 months.
-
-In addition, configuration options referring to size use the following suffixes:
-
-* `K` = KiB, or 1024 bytes
-* `M` = MiB, or 1,048,576 bytes
-* `G` = GiB, or 1,073,741,824 bytes
-* `T` = TiB, or 1,099,511,627,776 bytes
-
-For example, setting `max_avatar_size: 10M` means that Synapse will not accept files larger than 10,485,760 bytes
-for a user avatar.
-
-## Config Validation
-
-The configuration file can be validated with the following command:
-```bash
-python -m synapse.config read <config key to print> -c <path to config>
-```
-
-To validate the entire file, omit `read <config key to print>`:
-```bash
-python -m synapse.config -c <path to config>
-```
-
-To see how to set other options, check the help reference:
-```bash
-python -m synapse.config --help
-```
-
-### YAML
-The configuration file is a [YAML](https://yaml.org/) file, which means that certain syntax rules
-apply if you want your config file to be read properly. A few helpful things to know:
-* `#` before any option in the config will comment out that setting and either a default (if available) will
-   be applied or Synapse will ignore the setting. Thus, in example #1 below, the setting will be read and
-   applied, but in example #2 the setting will not be read and a default will be applied.
-
-   Example #1:
-   ```yaml
-   pid_file: DATADIR/homeserver.pid
-   ```
-   Example #2:
-   ```yaml
-   #pid_file: DATADIR/homeserver.pid
-   ```
-* Indentation matters! The indentation before a setting
-  will determine whether a given setting is read as part of another
-  setting, or considered on its own. Thus, in example #1, the `enabled` setting
-  is read as a sub-option of the `presence` setting, and will be properly applied.
-
-  However, the lack of indentation before the `enabled` setting in example #2 means
-  that when reading the config, Synapse will consider both `presence` and `enabled` as
-  different settings. In this case, `presence` has no value, and thus a default applied, and `enabled`
-  is an option that Synapse doesn't recognize and thus ignores.
-
-  Example #1:
-  ```yaml
-  presence:
-    enabled: false
-  ```
-  Example #2:
-  ```yaml
-  presence:
-  enabled: false
-  ```
-  In this manual, all top-level settings (ones with no indentation) are identified
-  at the beginning of their section (i.e. "### `example_setting`") and
-  the sub-options, if any, are identified and listed in the body of the section.
-  In addition, each setting has an example of its usage, with the proper indentation
-  shown.
-"""
-SECTION_HEADERS = {
-    "modules": {
-        "title": "Modules",
-        "description": (
-            "Server admins can expand Synapse's functionality with external "
-            "modules.\n\n"
-            "See [here](../../modules/index.md) for more documentation on how "
-            "to configure or create custom modules for Synapse."
-        ),
-    },
-    "server_name": {
-        "title": "Server",
-        "description": "Define your homeserver name and other base options.",
-    },
-    "admin_contact": {
-        "title": "Homeserver blocking",
-        "description": "Useful options for Synapse admins.",
-    },
-    "tls_certificate_path": {
-        "title": "TLS",
-        "description": "Options related to TLS.",
-    },
-    "federation_domain_whitelist": {
-        "title": "Federation",
-        "description": "Options related to federation.",
-    },
-    "event_cache_size": {
-        "title": "Caching",
-        "description": "Options related to caching.",
-    },
-    "database": {
-        "title": "Database",
-        "description": "Config options related to database settings.",
-    },
-    "log_config": {
-        "title": "Logging",
-        "description": ("Config options related to logging."),
-    },
-    "rc_message": {
-        "title": "Ratelimiting",
-        "description": (
-            "Options related to ratelimiting in Synapse.\n\n"
-            "Each ratelimiting configuration is made of two parameters:\n"
-            "- `per_second`: number of requests a client can send per second.\n"
-            "- `burst_count`: number of requests a client can send before "
-            "being throttled."
-        ),
-    },
-    "enable_authenticated_media": {
-        "title": "Media Store",
-        "description": "Config options related to Synapse's media store.",
-    },
-    "recaptcha_public_key": {
-        "title": "Captcha",
-        "description": (
-            "See [here](../../CAPTCHA_SETUP.md) for full details on setting up captcha."
-        ),
-    },
-    "turn_uris": {
-        "title": "TURN",
-        "description": ("Options related to adding a TURN server to Synapse."),
-    },
-    "enable_registration": {
-        "title": "Registration",
-        "description": (
-            "Registration can be rate-limited using the parameters in the "
-            "[Ratelimiting](#ratelimiting) section of this manual."
-        ),
-    },
-    "session_lifetime": {
-        "title": "User session management",
-        "description": ("Config options related to user session management."),
-    },
-    "enable_metrics": {
-        "title": "Metrics",
-        "description": ("Config options related to metrics."),
-    },
-    "room_prejoin_state": {
-        "title": "API Configuration",
-        "description": ("Config settings related to the client/server API."),
-    },
-    "signing_key_path": {
-        "title": "Signing Keys",
-        "description": ("Config options relating to signing keys."),
-    },
-    "saml2_config": {
-        "title": "Single sign-on integration",
-        "description": (
-            "The following settings can be used to make Synapse use a single sign-on provider for authentication, instead of its internal password database.\n\n"
-            "You will probably also want to set the following options to `false` to disable the regular login/registration flows:\n"
-            "* [`enable_registration`](#enable_registration)\n"
-            "* [`password_config.enabled`](#password_config)"
-        ),
-    },
-    "push": {
-        "title": "Push",
-        "description": ("Configuration settings related to push notifications."),
-    },
-    "encryption_enabled_by_default_for_room_type": {
-        "title": "Rooms",
-        "description": ("Config options relating to rooms."),
-    },
-    "opentracing": {
-        "title": "Opentracing",
-        "description": ("Configuration options related to Opentracing support."),
-    },
-    "worker_replication_secret": {
-        "title": "Coordinating workers",
-        "description": (
-            "Configuration options related to workers which belong in the main config file (usually called `homeserver.yaml`). A Synapse deployment can scale horizontally by running multiple Synapse processes called _workers_. Incoming requests are distributed between workers to handle higher loads. Some workers are privileged and can accept requests from other workers.\n\n"
-            "As a result, the worker configuration is divided into two parts.\n\n"
-            "1. The first part (in this section of the manual) defines which shardable tasks are delegated to privileged workers. This allows unprivileged workers to make requests to a privileged worker to act on their behalf.\n"
-            "2. [The second part](#individual-worker-configuration) controls the behaviour of individual workers in isolation.\n\n"
-            "For guidance on setting up workers, see the [worker documentation](../../workers.md)."
-        ),
-    },
-    "worker_app": {
-        "title": "Individual worker configuration",
-        "description": (
-            "These options configure an individual worker, in its worker configuration file. They should be not be provided when configuring the main process.\n\n"
-            "Note also the configuration above for [coordinating a cluster of workers](#coordinating-workers).\n\n"
-            "For guidance on setting up workers, see the [worker documentation](../../workers.md)."
-        ),
-    },
-    "background_updates": {
-        "title": "Background Updates",
-        "description": ("Configuration settings related to background updates."),
-    },
-    "auto_accept_invites": {
-        "title": "Auto Accept Invites",
-        "description": (
-            "Configuration settings related to automatically accepting invites."
-        ),
-    },
-}
-INDENT = "  "
-
-
-has_error = False
-
-
-def error(text: str) -> None:
-    global has_error
-    print(f"ERROR: {text}", file=sys.stderr)
-    has_error = True
-
-
-def indent(text: str, first_line: bool = True) -> str:
-    """Indents each non-empty line of the given text."""
-    text = re.sub(r"(\n)([^\n])", r"\1" + INDENT + r"\2", text)
-    if first_line:
-        text = re.sub(r"^([^\n])", INDENT + r"\1", text)
-
-    return text
-
-
-def em(s: Optional[str]) -> str:
-    """Add emphasis to text."""
-    return f"*{s}*" if s else ""
-
-
-def a(s: Optional[str], suffix: str = " ") -> str:
-    """Appends a space if the given string is not empty."""
-    return s + suffix if s else ""
-
-
-def p(s: Optional[str], prefix: str = " ") -> str:
-    """Prepend a space if the given string is not empty."""
-    return prefix + s if s else ""
-
-
-def resolve_local_refs(schema: dict) -> dict:
-    """Returns the given schema with local $ref properties replaced by their keywords.
-
-    Crude approximation that will override keywords.
-    """
-    defs = schema["$defs"]
-
-    def replace_ref(d: Any) -> Any:
-        if isinstance(d, dict):
-            the_def = {}
-            if "$ref" in d:
-                # Found a "$ref" key.
-                def_name = d["$ref"].removeprefix("#/$defs/")
-                del d["$ref"]
-                the_def = defs[def_name]
-
-            new_dict = {k: replace_ref(v) for k, v in d.items()}
-            if common_keys := (new_dict.keys() & the_def.keys()) - {"properties"}:
-                print(
-                    f"WARN: '{def_name}' overrides keys '{common_keys}'",
-                    file=sys.stderr,
-                )
-
-            new_dict_props = new_dict.get("properties", {})
-            the_def_props = the_def.get("properties", {})
-            if common_props := new_dict_props.keys() & the_def_props.keys():
-                print(
-                    f"WARN: '{def_name}' overrides properties '{common_props}'",
-                    file=sys.stderr,
-                )
-            if merged_props := {**new_dict_props, **the_def_props}:
-                return {**new_dict, **the_def, "properties": merged_props}
-            else:
-                return {**new_dict, **the_def}
-
-        elif isinstance(d, list):
-            return [replace_ref(v) for v in d]
-        else:
-            return d
-
-    return replace_ref(schema)
-
-
-def sep(values: dict) -> str:
-    """Separator between parts of the description."""
-    # If description is multiple paragraphs already, add new ones. Otherwise
-    # append to same paragraph.
-    return "\n\n" if "\n\n" in values.get("description", "") else " "
-
-
-def type_str(values: dict) -> str:
-    """Type of the current value."""
-    if t := values.get("io.element.type_name"):
-        # Allow custom overrides for the type name, for documentation clarity
-        return f"({t})"
-    if not (t := values.get("type")):
-        return ""
-    if not isinstance(t, list):
-        t = [t]
-    joined = "|".join(t)
-    return f"({joined})"
-
-
-def items(values: dict) -> str:
-    """A block listing properties of array items."""
-    if not (items := values.get("items")):
-        return ""
-    if not (item_props := items.get("properties")):
-        return ""
-    return "\nOptions for each entry include:\n\n" + "\n".join(
-        sub_section(k, v) for k, v in item_props.items()
-    )
-
-
-def properties(values: dict) -> str:
-    """A block listing object properties."""
-    if not (properties := values.get("properties")):
-        return ""
-    return "\nThis setting has the following sub-options:\n\n" + "\n".join(
-        sub_section(k, v) for k, v in properties.items()
-    )
-
-
-def sub_section(prop: str, values: dict) -> str:
-    """Formats a bullet point about the given sub-property."""
-    sep = lambda: globals()["sep"](values)
-    type_str = lambda: globals()["type_str"](values)
-    items = lambda: globals()["items"](values)
-    properties = lambda: globals()["properties"](values)
-
-    def default() -> str:
-        try:
-            default = values["default"]
-            return f"Defaults to `{json.dumps(default)}`."
-        except KeyError:
-            return ""
-
-    def description() -> str:
-        if not (description := values.get("description")):
-            error(f"missing description for {prop}")
-            return "MISSING DESCRIPTION\n"
-
-        return f"{description}{p(default(), sep())}\n"
-
-    return (
-        f"* `{prop}`{p(type_str())}: "
-        + f"{indent(description(), first_line=False)}"
-        + indent(items())
-        + indent(properties())
-    )
-
-
-def section(prop: str, values: dict) -> str:
-    """Formats a section about the given property."""
-    sep = lambda: globals()["sep"](values)
-    type_str = lambda: globals()["type_str"](values)
-    items = lambda: globals()["items"](values)
-    properties = lambda: globals()["properties"](values)
-
-    def is_simple_default() -> bool:
-        """Whether the given default is simple enough for a one-liner."""
-        if not (d := values.get("default")):
-            return True
-        return not isinstance(d, dict) and not isinstance(d, list)
-
-    def default_str() -> str:
-        try:
-            default = values["default"]
-        except KeyError:
-            t = values.get("type", [])
-            if "object" == t or "object" in t:
-                # Skip objects as they probably have child defaults.
-                return ""
-            return "There is no default for this option."
-
-        if not is_simple_default():
-            # Show complex defaults as a code block instead.
-            return ""
-        return f"Defaults to `{json.dumps(default)}`."
-
-    def header() -> str:
-        try:
-            title = SECTION_HEADERS[prop]["title"]
-            description = SECTION_HEADERS[prop]["description"]
-            return f"## {title}\n\n{description}\n\n---\n"
-        except KeyError:
-            return ""
-
-    def title() -> str:
-        return f"### `{prop}`\n"
-
-    def description() -> str:
-        if not (description := values.get("description")):
-            error(f"missing description for {prop}")
-            return "MISSING DESCRIPTION\n"
-        return f"\n{a(em(type_str()))}{description}{p(default_str(), sep())}\n"
-
-    def example_str(example: Any) -> str:
-        return "```yaml\n" + f"{yaml.dump({prop: example}, sort_keys=False)}" + "```\n"
-
-    def default_example() -> str:
-        if is_simple_default():
-            return ""
-        default_cfg = example_str(values["default"])
-        return f"\nDefault configuration:\n{default_cfg}"
-
-    def examples() -> str:
-        if not (examples := values.get("examples")):
-            return ""
-
-        examples_str = "\n".join(example_str(e) for e in examples)
-
-        if len(examples) >= 2:
-            return f"\nExample configurations:\n{examples_str}"
-        else:
-            return f"\nExample configuration:\n{examples_str}"
-
-    def post_description() -> str:
-        # Sometimes it's helpful to have a description after the list of fields,
-        # e.g. with a subsection that consists only of text.
-        # This helps with that.
-        if not (description := values.get("io.element.post_description")):
-            return ""
-        return f"\n{description}\n\n"
-
-    return (
-        "---\n"
-        + header()
-        + title()
-        + description()
-        + items()
-        + properties()
-        + default_example()
-        + examples()
-        + post_description()
-    )
-
-
-def main() -> None:
-    def usage(err_msg: str) -> int:
-        script_name = (sys.argv[:1] or ["__main__.py"])[0]
-        print(err_msg, file=sys.stderr)
-        print(f"Usage: {script_name} <JSON Schema file>", file=sys.stderr)
-        print(f"\n{__doc__}", file=sys.stderr)
-        exit(1)
-
-    def read_json_file_arg() -> Any:
-        if len(sys.argv) > 2:
-            exit(usage("Too many arguments."))
-        if not (filepath := (sys.argv[1:] or [""])[0]):
-            exit(usage("No schema file provided."))
-        with open(filepath) as f:
-            return yaml.safe_load(f)
-
-    schema = read_json_file_arg()
-    schema = resolve_local_refs(schema)
-
-    sections = (section(k, v) for k, v in schema["properties"].items())
-    print(HEADER + "".join(sections), end="")
-
-    if has_error:
-        print("There were errors.", file=sys.stderr)
-        exit(2)
-
-
-if __name__ == "__main__":
-    main()

scripts-dev/release.py

@@ -254,12 +254,6 @@ def _prepare() -> None:
     # Update the version specified in pyproject.toml.
     subprocess.check_output(["poetry", "version", new_version])
 
-    # Update config schema $id.
-    schema_file = "schema/synapse-config.schema.yaml"
-    major_minor_version = ".".join(new_version.split(".")[:2])
-    url = f"https://element-hq.github.io/synapse/schema/synapse/v{major_minor_version}/synapse-config.schema.json"
-    subprocess.check_output(["sed", "-i", f"0,/^\\$id: .*/s||$id: {url}|", schema_file])
-
     # Generate changelogs.
     generate_and_write_changelog(synapse_repo, current_version, new_version)
 

synapse/rest/admin/devices.py

@@ -145,17 +145,6 @@ class DevicesGetRestServlet(RestServlet):
         devices = await self.device_worker_handler.get_devices_by_user(
             target_user.to_string()
         )
-
-        # mark the dehydrated device by adding a "dehydrated" flag
-        dehydrated_device_info = await self.device_worker_handler.get_dehydrated_device(
-            target_user.to_string()
-        )
-        if dehydrated_device_info:
-            dehydrated_device_id = dehydrated_device_info[0]
-            for device in devices:
-                is_dehydrated = device["device_id"] == dehydrated_device_id
-                device["dehydrated"] = is_dehydrated
-
         return HTTPStatus.OK, {"devices": devices, "total": len(devices)}
 
 

tests/rest/admin/test_device.py

@@ -27,7 +27,7 @@ from twisted.test.proto_helpers import MemoryReactor
 import synapse.rest.admin
 from synapse.api.errors import Codes
 from synapse.handlers.device import DeviceHandler
-from synapse.rest.client import devices, login
+from synapse.rest.client import login
 from synapse.server import HomeServer
 from synapse.util import Clock
 
@@ -299,7 +299,6 @@ class DeviceRestTestCase(unittest.HomeserverTestCase):
 class DevicesRestTestCase(unittest.HomeserverTestCase):
     servlets = [
         synapse.rest.admin.register_servlets,
-        devices.register_servlets,
         login.register_servlets,
     ]
 
@@ -391,63 +390,15 @@ class DevicesRestTestCase(unittest.HomeserverTestCase):
         self.assertEqual(0, channel.json_body["total"])
         self.assertEqual(0, len(channel.json_body["devices"]))
 
-    @unittest.override_config(
-        {"experimental_features": {"msc2697_enabled": False, "msc3814_enabled": True}}
-    )
     def test_get_devices(self) -> None:
         """
         Tests that a normal lookup for devices is successfully
         """
         # Create devices
         number_devices = 5
-        # we create 2 fewer devices in the loop, because we will create another
-        # login after the loop, and we will create a dehydrated device
-        for _ in range(number_devices - 2):
+        for _ in range(number_devices):
             self.login("user", "pass")
 
-        other_user_token = self.login("user", "pass")
-        dehydrated_device_url = (
-            "/_matrix/client/unstable/org.matrix.msc3814.v1/dehydrated_device"
-        )
-        content = {
-            "device_data": {
-                "algorithm": "m.dehydration.v1.olm",
-            },
-            "device_id": "dehydrated_device",
-            "initial_device_display_name": "foo bar",
-            "device_keys": {
-                "user_id": "@user:test",
-                "device_id": "dehydrated_device",
-                "valid_until_ts": "80",
-                "algorithms": [
-                    "m.olm.curve25519-aes-sha2",
-                ],
-                "keys": {
-                    "<algorithm>:<device_id>": "<key_base64>",
-                },
-                "signatures": {
-                    "@user:test": {"<algorithm>:<device_id>": "<signature_base64>"}
-                },
-            },
-            "fallback_keys": {
-                "alg1:device1": "f4llb4ckk3y",
-                "signed_<algorithm>:<device_id>": {
-                    "fallback": "true",
-                    "key": "f4llb4ckk3y",
-                    "signatures": {
-                        "@user:test": {"<algorithm>:<device_id>": "<key_base64>"}
-                    },
-                },
-            },
-            "one_time_keys": {"alg1:k1": "0net1m3k3y"},
-        }
-        self.make_request(
-            "PUT",
-            dehydrated_device_url,
-            access_token=other_user_token,
-            content=content,
-        )
-
         # Get devices
         channel = self.make_request(
             "GET",
@@ -459,22 +410,13 @@ class DevicesRestTestCase(unittest.HomeserverTestCase):
         self.assertEqual(number_devices, channel.json_body["total"])
         self.assertEqual(number_devices, len(channel.json_body["devices"]))
         self.assertEqual(self.other_user, channel.json_body["devices"][0]["user_id"])
-        # Check that all fields are available, and that the dehydrated device is marked as dehydrated
-        found_dehydrated = False
+        # Check that all fields are available
         for d in channel.json_body["devices"]:
             self.assertIn("user_id", d)
             self.assertIn("device_id", d)
             self.assertIn("display_name", d)
             self.assertIn("last_seen_ip", d)
             self.assertIn("last_seen_ts", d)
-            if d["device_id"] == "dehydrated_device":
-                self.assertTrue(d.get("dehydrated"))
-                found_dehydrated = True
-            else:
-                # Either the field is not present, or set to False
-                self.assertFalse(d.get("dehydrated"))
-
-        self.assertTrue(found_dehydrated)
 
 
 class DeleteDevicesRestTestCase(unittest.HomeserverTestCase):