Version picker added for v1.70 docs

.ci/scripts/calculate_jobs.py

@@ -46,7 +46,7 @@ if not IS_PR:
             "database": "sqlite",
             "extras": "all",
         }
-        for version in ("3.8", "3.9", "3.10", "3.11")
+        for version in ("3.8", "3.9", "3.10")
     )
 
 
@@ -54,7 +54,7 @@ trial_postgres_tests = [
     {
         "python-version": "3.7",
         "database": "postgres",
-        "postgres-version": "11",
+        "postgres-version": "10",
         "extras": "all",
     }
 ]
@@ -62,9 +62,9 @@ trial_postgres_tests = [
 if not IS_PR:
     trial_postgres_tests.append(
         {
-            "python-version": "3.11",
+            "python-version": "3.10",
             "database": "postgres",
-            "postgres-version": "15",
+            "postgres-version": "14",
             "extras": "all",
         }
     )

.editorconfig

@@ -4,7 +4,7 @@
 root = true
 
 # 4 space indentation
-[*.{py,pyi}]
+[*.py]
 indent_style = space
 indent_size = 4
 max_line_length = 88

.flake8

@@ -8,11 +8,4 @@
 #  E203: whitespace before ':' (which is contrary to pep8?)
 #  E731: do not assign a lambda expression, use a def
 #  E501: Line too long (black enforces this for us)
-#
-# flake8-bugbear runs extra checks. Its error codes are described at
-# https://github.com/PyCQA/flake8-bugbear#list-of-warnings
-#  B019: Use of functools.lru_cache or functools.cache on methods can lead to memory leaks
-#  B023: Functions defined inside a loop must not use variables redefined in the loop
-#  B024: Abstract base class with no abstract method.
-
-ignore=W503,W504,E203,E731,E501,B019,B023,B024
+ignore=W503,W504,E203,E731,E501

.github/ISSUE_TEMPLATE/BUG_REPORT.yml

@@ -74,36 +74,6 @@ body:
         - Debian packages from packages.matrix.org
         - pip (from PyPI)
         - Other (please mention below)
-        - I don't know
-    validations:
-      required: true
-  - type: input
-    id: database
-    attributes:
-      label: Database
-      description: |
-        Are you using SQLite or PostgreSQL? What's the version of your database?
-
-        If PostgreSQL, please also answer the following:
-         - are you using a single PostgreSQL server
-        or [separate servers for `main` and `state`](https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#databases)?
-         - have you previously ported from SQLite using the Synapse "portdb" script?
-         - have you previously restored from a backup?
-    validations:
-      required: true
-  - type: dropdown
-    id: workers
-    attributes:
-      label: Workers
-      description: |
-        Are you running a single Synapse process, or are you running
-        [2 or more workers](https://matrix-org.github.io/synapse/latest/workers.html)?
-      options:
-        - Single process
-        - Multiple workers
-        - I don't know
-    validations:
-      required: true
   - type: textarea
     id: platform
     attributes:
@@ -113,28 +83,17 @@ body:
         e.g. distro, hardware, if it's running in a vm/container, etc.
     validations:
       required: true
-  - type: textarea
-    id: config
-    attributes:
-      label: Configuration
-      description: |
-        Do you have any unusual config options turned on? If so, please provide details.
-
-        - Experimental or undocumented features
-        - [Presence](https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#presence)
-        - [Message retention](https://matrix-org.github.io/synapse/latest/message_retention_policies.html)
-        - [Synapse modules](https://matrix-org.github.io/synapse/latest/modules/index.html)
   - type: textarea
     id: logs
     attributes:
       label: Relevant log output
       description: |
         Please copy and paste any relevant log output, ideally at INFO or DEBUG log level.
-        This will be automatically formatted into code, so there is no need for backticks (`\``).
+        This will be automatically formatted into code, so there is no need for backticks.
 
         Please be careful to remove any personal or private data.
 
-        **Bug reports are usually impossible to diagnose without logging.**
+        **Bug reports are usually very difficult to diagnose without logging.**
       render: shell
     validations:
       required: true

.github/dependabot.yml

@@ -18,6 +18,5 @@ updates:
 
   - package-ecosystem: "cargo"
     directory: "/"
-    versioning-strategy: "lockfile-only"
     schedule:
       interval: "weekly"

.github/workflows/docs-pr-netlify.yaml

@@ -1,34 +0,0 @@
-name: Deploy documentation PR preview
-
-on:
-  workflow_run:
-    workflows: [ "Prepare documentation PR preview" ]
-    types:
-      - completed
-
-jobs:
-  netlify:
-    if: github.event.workflow_run.conclusion == 'success' && github.event.workflow_run.event == 'pull_request'
-    runs-on: ubuntu-latest
-    steps:
-      # There's a 'download artifact' action, but it hasn't been updated for the workflow_run action
-      # (https://github.com/actions/download-artifact/issues/60) so instead we get this mess:
-      - name: 📥 Download artifact
-        uses: dawidd6/action-download-artifact@e6e25ac3a2b93187502a8be1ef9e9603afc34925 # v2.24.2
-        with:
-          workflow: docs-pr.yaml
-          run_id: ${{ github.event.workflow_run.id }}
-          name: book
-          path: book
-
-      - name: 📤 Deploy to Netlify
-        uses: matrix-org/netlify-pr-preview@v1
-        with:
-          path: book
-          owner: ${{ github.event.workflow_run.head_repository.owner.login }}
-          branch: ${{ github.event.workflow_run.head_branch }}
-          revision: ${{ github.event.workflow_run.head_sha }}
-          token: ${{ secrets.NETLIFY_AUTH_TOKEN }}
-          site_id: ${{ secrets.NETLIFY_SITE_ID }}
-          desc: Documentation preview
-          deployment_env: PR Documentation Preview

.github/workflows/docs-pr.yaml

@@ -1,34 +0,0 @@
-name: Prepare documentation PR preview
-
-on:
-  pull_request:
-    paths:
-      - docs/**
-
-jobs:
-  pages:
-    name: GitHub Pages
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-
-      - name: Setup mdbook
-        uses: peaceiris/actions-mdbook@adeb05db28a0c0004681db83893d56c0388ea9ea # v1.2.0
-        with:
-          mdbook-version: '0.4.17'
-
-      - name: Build the documentation
-        # mdbook will only create an index.html if we're including docs/README.md in SUMMARY.md.
-        # However, we're using docs/README.md for other purposes and need to pick a new page
-        # as the default. Let's opt for the welcome page instead.
-        run: |
-          mdbook build
-          cp book/welcome_and_overview.html book/index.html
-
-      - name: Upload Artifact
-        uses: actions/upload-artifact@v3
-        with:
-          name: book
-          path: book
-          # We'll only use this in a workflow_run, then we're done with it
-          retention-days: 1

.github/workflows/docs.yaml

@@ -20,7 +20,7 @@ jobs:
       - uses: actions/checkout@v3
 
       - name: Setup mdbook
-        uses: peaceiris/actions-mdbook@adeb05db28a0c0004681db83893d56c0388ea9ea # v1.2.0
+        uses: peaceiris/actions-mdbook@4b5ef36b314c2599664ca107bb8c02412548d79d # v1.1.14
         with:
           mdbook-version: '0.4.17'
 
@@ -58,7 +58,7 @@ jobs:
           
       # Deploy to the target directory.
       - name: Deploy to gh pages
-        uses: peaceiris/actions-gh-pages@de7ea6f8efb354206b205ef54722213d99067935 # v3.9.0
+        uses: peaceiris/actions-gh-pages@068dc23d9710f1ba62e86896f84735d869951305 # v3.8.0
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./book

.github/workflows/latest_deps.yml

@@ -27,9 +27,10 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - name: Install Rust
-        uses: dtolnay/rust-toolchain@e645b0cf01249a964ec099494d38d2da0f0b349f
+        uses: actions-rs/toolchain@v1
         with:
-          toolchain: stable
+            toolchain: stable
+            override: true
       - uses: Swatinem/rust-cache@v2
 
       # The dev dependencies aren't exposed in the wheel metadata (at least with current
@@ -61,9 +62,10 @@ jobs:
       - uses: actions/checkout@v3
 
       - name: Install Rust
-        uses: dtolnay/rust-toolchain@e645b0cf01249a964ec099494d38d2da0f0b349f
+        uses: actions-rs/toolchain@v1
         with:
-          toolchain: stable
+            toolchain: stable
+            override: true
       - uses: Swatinem/rust-cache@v2
 
       - run: sudo apt-get -qq install xmlsec1
@@ -134,9 +136,10 @@ jobs:
       - uses: actions/checkout@v3
 
       - name: Install Rust
-        uses: dtolnay/rust-toolchain@e645b0cf01249a964ec099494d38d2da0f0b349f
+        uses: actions-rs/toolchain@v1
         with:
-          toolchain: stable
+            toolchain: stable
+            override: true
       - uses: Swatinem/rust-cache@v2
 
       - name: Ensure sytest runs `pip install`
@@ -208,7 +211,7 @@ jobs:
 
     steps:
       - uses: actions/checkout@v3
-      - uses: JasonEtco/create-an-issue@77399b6110ef82b94c1c9f9f615acf9e604f7f56 # v2.5.0, 2020-12-06
+      - uses: JasonEtco/create-an-issue@5d9504915f79f9cc6d791934b8ef34f2353dd74d # v2.5.0, 2020-12-06
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:

.github/workflows/push_complement_image.yml

@@ -1,74 +0,0 @@
-# This task does not run complement tests, see tests.yaml instead.
-# This task does not build docker images for synapse for use on docker hub, see docker.yaml instead
-
-name: Store complement-synapse image in ghcr.io
-on:
-  push:
-    branches: [ "master" ]
-  schedule:
-    - cron: '0 5 * * *'
-  workflow_dispatch:
-    inputs:
-      branch:
-        required: true
-        default: 'develop'
-        type: choice
-        options:
-          - develop
-          - master
-
-# Only run this action once per pull request/branch; restart if a new commit arrives.
-# C.f. https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#concurrency
-# and https://docs.github.com/en/actions/reference/context-and-expression-syntax-for-github-actions#github-context
-concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: true
-
-jobs:
-  build:
-    name: Build and push complement image
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      packages: write
-    steps:
-      - name: Checkout specific branch (debug build)
-        uses: actions/checkout@v3
-        if: github.event_name == 'workflow_dispatch'
-        with:
-          ref: ${{ inputs.branch }}
-      - name: Checkout clean copy of develop (scheduled build)
-        uses: actions/checkout@v3
-        if: github.event_name == 'schedule'
-        with:
-          ref: develop
-      - name: Checkout clean copy of master (on-push)
-        uses: actions/checkout@v3
-        if: github.event_name == 'push'
-        with:
-          ref: master
-      - name: Login to registry
-        uses: docker/login-action@v1
-        with:
-          registry: ghcr.io
-          username: ${{ github.actor }}
-          password: ${{ secrets.GITHUB_TOKEN }}
-      - name: Work out labels for complement image
-        id: meta
-        uses: docker/metadata-action@v4
-        with:
-          images: ghcr.io/${{ github.repository }}/complement-synapse
-          tags: |
-            type=schedule,pattern=nightly,enable=${{ github.event_name == 'schedule'}}
-            type=raw,value=develop,enable=${{ github.event_name == 'schedule' || inputs.branch == 'develop' }}
-            type=raw,value=latest,enable=${{ github.event_name == 'push' || inputs.branch == 'master' }}
-            type=sha,format=long
-      - name: Run scripts-dev/complement.sh to generate complement-synapse:latest image.
-        run: scripts-dev/complement.sh --build-only
-      - name: Tag and push generated image
-        run: |
-          for TAG in ${{ join(fromJson(steps.meta.outputs.json).tags, ' ') }}; do 
-            echo "tag and push $TAG"
-            docker tag complement-synapse $TAG
-            docker push $TAG
-          done

.github/workflows/release-artifacts.yml

@@ -99,7 +99,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ubuntu-20.04, macos-11]
+        os: [ubuntu-20.04, macos-10.15]
         arch: [x86_64, aarch64]
         # is_pr is a flag used to exclude certain jobs from the matrix on PRs.
         # It is not read by the rest of the workflow.
@@ -109,9 +109,9 @@ jobs:
         exclude:
           # Don't build macos wheels on PR CI.
           - is_pr: true
-            os: "macos-11"
+            os: "macos-10.15"
           # Don't build aarch64 wheels on mac.
-          - os: "macos-11"
+          - os: "macos-10.15"
             arch: aarch64
           # Don't build aarch64 wheels on PR CI.
           - is_pr: true

.github/workflows/tests.yml

@@ -27,15 +27,12 @@ jobs:
           rust:
             - 'rust/**'
             - 'Cargo.toml'
-            - 'Cargo.lock'
 
   check-sampleconfig:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-python@v4
-        with:
-          python-version: "3.x"
       - uses: matrix-org/setup-python-poetry@v1
         with:
           extras: "all"
@@ -47,8 +44,6 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-python@v4
-        with:
-          python-version: "3.x"
       - run: "pip install 'click==8.1.1' 'GitPython>=3.1.20'"
       - run: scripts-dev/check_schema_delta.py --force-colors
 
@@ -73,8 +68,6 @@ jobs:
           ref: ${{ github.event.pull_request.head.sha }}
           fetch-depth: 0
       - uses: actions/setup-python@v4
-        with:
-          python-version: "3.x"
       - run: "pip install 'towncrier>=18.6.0rc1'"
       - run: scripts-dev/check-newsfragment.sh
         env:
@@ -100,38 +93,14 @@ jobs:
       - uses: actions/checkout@v3
 
       - name: Install Rust
-        # There don't seem to be versioned releases of this action per se: for each rust
-        # version there is a branch which gets constantly rebased on top of master.
-        # We pin to a specific commit for paranoia's sake.
-        uses: dtolnay/rust-toolchain@e645b0cf01249a964ec099494d38d2da0f0b349f
+        uses: actions-rs/toolchain@v1
         with:
             toolchain: 1.58.1
+            override: true
             components: clippy
       - uses: Swatinem/rust-cache@v2
 
-      - run: cargo clippy -- -D warnings
-
-  # We also lint against a nightly rustc so that we can lint the benchmark
-  # suite, which requires a nightly compiler.
-  lint-clippy-nightly:
-    runs-on: ubuntu-latest
-    needs: changes
-    if: ${{ needs.changes.outputs.rust == 'true' }}
-
-    steps:
-      - uses: actions/checkout@v3
-
-      - name: Install Rust
-        # There don't seem to be versioned releases of this action per se: for each rust
-        # version there is a branch which gets constantly rebased on top of master.
-        # We pin to a specific commit for paranoia's sake.
-        uses: dtolnay/rust-toolchain@e645b0cf01249a964ec099494d38d2da0f0b349f
-        with:
-            toolchain: nightly-2022-12-01
-            components: clippy
-      - uses: Swatinem/rust-cache@v2
-
-      - run: cargo clippy --all-features -- -D warnings
+      - run: cargo clippy
 
   lint-rustfmt:
     runs-on: ubuntu-latest
@@ -142,13 +111,11 @@ jobs:
       - uses: actions/checkout@v3
 
       - name: Install Rust
-        # There don't seem to be versioned releases of this action per se: for each rust
-        # version there is a branch which gets constantly rebased on top of master.
-        # We pin to a specific commit for paranoia's sake.
-        uses: dtolnay/rust-toolchain@e645b0cf01249a964ec099494d38d2da0f0b349f
+        uses: actions-rs/toolchain@v1
         with:
-          toolchain: 1.58.1
-          components: rustfmt
+            toolchain: 1.58.1
+            override: true
+            components: rustfmt
       - uses: Swatinem/rust-cache@v2
 
       - run: cargo fmt --check
@@ -176,8 +143,6 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-python@v4
-        with:
-          python-version: "3.x"
       - id: get-matrix
         run: .ci/scripts/calculate_jobs.py
     outputs:
@@ -202,16 +167,6 @@ jobs:
             -e POSTGRES_PASSWORD=postgres \
             -e POSTGRES_INITDB_ARGS="--lc-collate C --lc-ctype C --encoding UTF8" \
             postgres:${{ matrix.job.postgres-version }}
-
-      - name: Install Rust
-        # There don't seem to be versioned releases of this action per se: for each rust
-        # version there is a branch which gets constantly rebased on top of master.
-        # We pin to a specific commit for paranoia's sake.
-        uses: dtolnay/rust-toolchain@e645b0cf01249a964ec099494d38d2da0f0b349f
-        with:
-            toolchain: 1.58.1
-      - uses: Swatinem/rust-cache@v2
-
       - uses: matrix-org/setup-python-poetry@v1
         with:
           python-version: ${{ matrix.job.python-version }}
@@ -248,12 +203,10 @@ jobs:
       - uses: actions/checkout@v3
 
       - name: Install Rust
-        # There don't seem to be versioned releases of this action per se: for each rust
-        # version there is a branch which gets constantly rebased on top of master.
-        # We pin to a specific commit for paranoia's sake.
-        uses: dtolnay/rust-toolchain@e645b0cf01249a964ec099494d38d2da0f0b349f
+        uses: actions-rs/toolchain@v1
         with:
             toolchain: 1.58.1
+            override: true
       - uses: Swatinem/rust-cache@v2
 
       # There aren't wheels for some of the older deps, so we need to install
@@ -366,12 +319,10 @@ jobs:
         run: cat sytest-blacklist .ci/worker-blacklist > synapse-blacklist-with-workers
 
       - name: Install Rust
-        # There don't seem to be versioned releases of this action per se: for each rust
-        # version there is a branch which gets constantly rebased on top of master.
-        # We pin to a specific commit for paranoia's sake.
-        uses: dtolnay/rust-toolchain@e645b0cf01249a964ec099494d38d2da0f0b349f
+        uses: actions-rs/toolchain@v1
         with:
             toolchain: 1.58.1
+            override: true
       - uses: Swatinem/rust-cache@v2
 
       - name: Run SyTest
@@ -432,10 +383,10 @@ jobs:
       matrix:
         include:
           - python-version: "3.7"
-            postgres-version: "11"
+            postgres-version: "10"
 
-          - python-version: "3.11"
-            postgres-version: "15"
+          - python-version: "3.10"
+            postgres-version: "14"
 
     services:
       postgres:
@@ -453,15 +404,6 @@ jobs:
 
     steps:
       - uses: actions/checkout@v3
-      - name: Add PostgreSQL apt repository
-        # We need a version of pg_dump that can handle the version of
-        # PostgreSQL being tested against. The Ubuntu package repository lags
-        # behind new releases, so we have to use the PostreSQL apt repository.
-        # Steps taken from https://www.postgresql.org/download/linux/ubuntu/
-        run: |
-          sudo sh -c 'echo "deb http://apt.postgresql.org/pub/repos/apt $(lsb_release -cs)-pgdg main" > /etc/apt/sources.list.d/pgdg.list'
-          wget --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | sudo apt-key add -
-          sudo apt-get update
       - run: sudo apt-get -qq install xmlsec1 postgresql-client
       - uses: matrix-org/setup-python-poetry@v1
         with:
@@ -509,12 +451,10 @@ jobs:
           path: synapse
 
       - name: Install Rust
-        # There don't seem to be versioned releases of this action per se: for each rust
-        # version there is a branch which gets constantly rebased on top of master.
-        # We pin to a specific commit for paranoia's sake.
-        uses: dtolnay/rust-toolchain@e645b0cf01249a964ec099494d38d2da0f0b349f
+        uses: actions-rs/toolchain@v1
         with:
             toolchain: 1.58.1
+            override: true
       - uses: Swatinem/rust-cache@v2
 
       - name: Prepare Complement's Prerequisites
@@ -537,12 +477,10 @@ jobs:
       - uses: actions/checkout@v3
 
       - name: Install Rust
-        # There don't seem to be versioned releases of this action per se: for each rust
-        # version there is a branch which gets constantly rebased on top of master.
-        # We pin to a specific commit for paranoia's sake.
-        uses: dtolnay/rust-toolchain@e645b0cf01249a964ec099494d38d2da0f0b349f
+        uses: actions-rs/toolchain@v1
         with:
             toolchain: 1.58.1
+            override: true
       - uses: Swatinem/rust-cache@v2
 
       - run: cargo test

.github/workflows/triage-incoming.yml

@@ -5,11 +5,24 @@ on:
     types: [ opened ]
 
 jobs:
-  triage:
-    uses: matrix-org/backend-meta/.github/workflows/triage-incoming.yml@v1
-    with: 
-      project_id: 'PVT_kwDOAIB0Bs4AFDdZ'
-      content_id: ${{ github.event.issue.node_id }}
-    secrets: 
-      github_access_token: ${{ secrets.ELEMENT_BOT_TOKEN }}
-          
+  add_new_issues:
+    name: Add new issues to the triage board
+    runs-on: ubuntu-latest
+    steps:
+      - uses: octokit/graphql-action@v2.x
+        id: add_to_project
+        with:
+          headers: '{"GraphQL-Features": "projects_next_graphql"}'
+          query: |
+              mutation add_to_project($projectid:ID!,$contentid:ID!) {
+                addProjectV2ItemById(input: {projectId: $projectid contentId: $contentid}) {
+                item {
+                  id
+                  }
+                }
+              }
+          projectid: ${{ env.PROJECT_ID }}
+          contentid: ${{ github.event.issue.node_id }}
+        env:
+          PROJECT_ID: "PVT_kwDOAIB0Bs4AFDdZ"
+          GITHUB_TOKEN: ${{ secrets.ELEMENT_BOT_TOKEN }}

.github/workflows/triage_labelled.yml

@@ -11,34 +11,34 @@ jobs:
     if: >
       contains(github.event.issue.labels.*.name, 'X-Needs-Info')
     steps:
-      - uses: actions/add-to-project@main
-        id: add_project
+      - uses: octokit/graphql-action@v2.x
+        id: add_to_project
         with:
-          project-url: "https://github.com/orgs/matrix-org/projects/67"
-          github-token: ${{ secrets.ELEMENT_BOT_TOKEN }}
-      - name: Set status
-        env:
-          GITHUB_TOKEN: ${{ secrets.ELEMENT_BOT_TOKEN }}
-        run: |
-          gh api graphql -f query='
-          mutation(
-              $project: ID!
-              $item: ID!
-              $fieldid: ID!
-              $columnid: String!
-            )  {
-            updateProjectV2ItemFieldValue(
-              input: {
-               projectId: $project
-                itemId: $item
-                fieldId: $fieldid
-                value: { 
-                  singleSelectOptionId: $columnid
+          headers: '{"GraphQL-Features": "projects_next_graphql"}'
+          query: |
+            mutation {
+              updateProjectV2ItemFieldValue(
+                input: {
+                  projectId: $projectid
+                  itemId: $contentid
+                  fieldId: $fieldid
+                  value: {
+                    singleSelectOptionId: "Todo"
                   }
-              }
-            ) {
-              projectV2Item {
-                id
+                }
+              ) {
+                projectV2Item {
+                  id
+                }
               }
             }
-          }' -f project="PVT_kwDOAIB0Bs4AFDdZ" -f item=${{ steps.add_project.outputs.itemId }} -f fieldid="PVTSSF_lADOAIB0Bs4AFDdZzgC6ZA4" -f columnid=ba22e43c --silent
+
+          projectid: ${{ env.PROJECT_ID }}
+          contentid: ${{ github.event.issue.node_id }}
+          fieldid: ${{ env.FIELD_ID }}
+          optionid: ${{ env.OPTION_ID }}
+        env:
+          PROJECT_ID: "PVT_kwDOAIB0Bs4AFDdZ"
+          GITHUB_TOKEN: ${{ secrets.ELEMENT_BOT_TOKEN }}
+          FIELD_ID: "PVTSSF_lADOAIB0Bs4AFDdZzgC6ZA4"
+          OPTION_ID: "ba22e43c"

.github/workflows/twisted_trunk.yml

@@ -18,9 +18,10 @@ jobs:
       - uses: actions/checkout@v3
 
       - name: Install Rust
-        uses: dtolnay/rust-toolchain@e645b0cf01249a964ec099494d38d2da0f0b349f
+        uses: actions-rs/toolchain@v1
         with:
-          toolchain: stable
+            toolchain: stable
+            override: true
       - uses: Swatinem/rust-cache@v2
 
       - uses: matrix-org/setup-python-poetry@v1
@@ -43,9 +44,10 @@ jobs:
       - run: sudo apt-get -qq install xmlsec1
 
       - name: Install Rust
-        uses: dtolnay/rust-toolchain@e645b0cf01249a964ec099494d38d2da0f0b349f
+        uses: actions-rs/toolchain@v1
         with:
-          toolchain: stable
+            toolchain: stable
+            override: true
       - uses: Swatinem/rust-cache@v2
 
       - uses: matrix-org/setup-python-poetry@v1
@@ -82,9 +84,10 @@ jobs:
       - uses: actions/checkout@v3
 
       - name: Install Rust
-        uses: dtolnay/rust-toolchain@e645b0cf01249a964ec099494d38d2da0f0b349f
+        uses: actions-rs/toolchain@v1
         with:
-          toolchain: stable
+            toolchain: stable
+            override: true
       - uses: Swatinem/rust-cache@v2
 
       - name: Patch dependencies
@@ -148,11 +151,12 @@ jobs:
         run: |
           set -x
           DEBIAN_FRONTEND=noninteractive sudo apt-get install -yqq python3 pipx
-          pipx install poetry==1.2.0
+          pipx install poetry==1.1.14
 
           poetry remove -n twisted
           poetry add -n --extras tls git+https://github.com/twisted/twisted.git#trunk
           poetry lock --no-update
+          # NOT IN 1.1.14 poetry lock --check
         working-directory: synapse
 
       - run: |
@@ -174,7 +178,7 @@ jobs:
 
     steps:
       - uses: actions/checkout@v3
-      - uses: JasonEtco/create-an-issue@77399b6110ef82b94c1c9f9f615acf9e604f7f56 # v2.5.0, 2020-12-06
+      - uses: JasonEtco/create-an-issue@5d9504915f79f9cc6d791934b8ef34f2353dd74d # v2.5.0, 2020-12-06
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:

CHANGES.md

@@ -1,274 +1,3 @@
-Synapse 1.73.0rc2 (2022-12-01)
-==============================
-
-Please note that legacy Prometheus metric names have been removed in this release; see [the upgrade notes](https://github.com/matrix-org/synapse/blob/release-v1.73/docs/upgrade.md#legacy-prometheus-metric-names-have-now-been-removed) for more details.
-
-Bugfixes
---------
-
-- Fix a regression in Synapse 1.73.0rc1 where Synapse's main process would stop responding to HTTP requests when a user with a large number of devices logs in. ([\#14582](https://github.com/matrix-org/synapse/issues/14582))
-
-
-Synapse 1.73.0rc1 (2022-11-29)
-==============================
-
-Features
---------
-
-- Speed-up `/messages` with `filter_events_for_client` optimizations. ([\#14527](https://github.com/matrix-org/synapse/issues/14527))
-- Improve DB performance by reducing amount of data that gets read in `device_lists_changes_in_room`. ([\#14534](https://github.com/matrix-org/synapse/issues/14534))
-- Adds support for handling avatar in SSO login. Contributed by @ashfame. ([\#13917](https://github.com/matrix-org/synapse/issues/13917))
-- Move MSC3030 `/timestamp_to_event` endpoints to stable `v1` location (`/_matrix/client/v1/rooms/<roomID>/timestamp_to_event?ts=<timestamp>&dir=<direction>`, `/_matrix/federation/v1/timestamp_to_event/<roomID>?ts=<timestamp>&dir=<direction>`). ([\#14471](https://github.com/matrix-org/synapse/issues/14471))
-- Reduce database load of [Client-Server endpoints](https://spec.matrix.org/v1.5/client-server-api/#aggregations) which return bundled aggregations. ([\#14491](https://github.com/matrix-org/synapse/issues/14491), [\#14508](https://github.com/matrix-org/synapse/issues/14508), [\#14510](https://github.com/matrix-org/synapse/issues/14510))
-- Add unstable support for an Extensible Events room version (`org.matrix.msc1767.10`) via [MSC1767](https://github.com/matrix-org/matrix-spec-proposals/pull/1767), [MSC3931](https://github.com/matrix-org/matrix-spec-proposals/pull/3931), [MSC3932](https://github.com/matrix-org/matrix-spec-proposals/pull/3932), and [MSC3933](https://github.com/matrix-org/matrix-spec-proposals/pull/3933). ([\#14520](https://github.com/matrix-org/synapse/issues/14520), [\#14521](https://github.com/matrix-org/synapse/issues/14521), [\#14524](https://github.com/matrix-org/synapse/issues/14524))
-- Prune user's old devices on login if they have too many. ([\#14038](https://github.com/matrix-org/synapse/issues/14038), [\#14580](https://github.com/matrix-org/synapse/issues/14580))
-
-
-Bugfixes
---------
-
-- Fix a long-standing bug where paginating from the start of a room did not work. Contributed by @gnunicorn. ([\#14149](https://github.com/matrix-org/synapse/issues/14149))
-- Fix a bug introduced in Synapse 1.58.0 where a user with presence state `org.matrix.msc3026.busy` would mistakenly be set to `online` when calling `/sync` or `/events` on a worker process. ([\#14393](https://github.com/matrix-org/synapse/issues/14393))
-- Fix a bug introduced in Synapse 1.70.0 where a receipt's thread ID was not sent over federation. ([\#14466](https://github.com/matrix-org/synapse/issues/14466))
-- Fix a long-standing bug where the [List media admin API](https://matrix-org.github.io/synapse/latest/admin_api/media_admin_api.html#list-all-media-in-a-room) would fail when processing an image with broken thumbnail information. ([\#14537](https://github.com/matrix-org/synapse/issues/14537))
-- Fix a bug introduced in Synapse 1.67.0 where two logging context warnings would be logged on startup. ([\#14574](https://github.com/matrix-org/synapse/issues/14574))
-- In application service transactions that include the experimental `org.matrix.msc3202.device_one_time_key_counts` key, include a duplicate key of `org.matrix.msc3202.device_one_time_keys_count` to match the name proposed by [MSC3202](https://github.com/matrix-org/matrix-spec-proposals/pull/3202). ([\#14565](https://github.com/matrix-org/synapse/issues/14565))
-- Fix a bug introduced in Synapse 0.9 where Synapse would fail to fetch server keys whose IDs contain a forward slash. ([\#14490](https://github.com/matrix-org/synapse/issues/14490))
-
-
-Improved Documentation
-----------------------
-
-- Fixed link to 'Synapse administration endpoints'. ([\#14499](https://github.com/matrix-org/synapse/issues/14499))
-
-
-Deprecations and Removals
--------------------------
-
-- Remove legacy Prometheus metrics names. They were deprecated in Synapse v1.69.0 and disabled by default in Synapse v1.71.0. ([\#14538](https://github.com/matrix-org/synapse/issues/14538))
-
-
-Internal Changes
-----------------
-
-- Improve type hinting throughout Synapse. ([\#14055](https://github.com/matrix-org/synapse/issues/14055), [\#14412](https://github.com/matrix-org/synapse/issues/14412), [\#14529](https://github.com/matrix-org/synapse/issues/14529), [\#14452](https://github.com/matrix-org/synapse/issues/14452)).
-- Remove old stream ID tracking code. Contributed by Nick @Beeper (@fizzadar). ([\#14376](https://github.com/matrix-org/synapse/issues/14376), [\#14468](https://github.com/matrix-org/synapse/issues/14468))
-- Remove the `worker_main_http_uri` configuration setting. This is now handled via internal replication. ([\#14400](https://github.com/matrix-org/synapse/issues/14400), [\#14476](https://github.com/matrix-org/synapse/issues/14476))
-- Refactor `federation_sender` and `pusher` configuration loading. ([\#14496](https://github.com/matrix-org/synapse/issues/14496))
-([\#14509](https://github.com/matrix-org/synapse/issues/14509), [\#14573](https://github.com/matrix-org/synapse/issues/14573))
-- Faster joins: do not wait for full state when creating events to send. ([\#14403](https://github.com/matrix-org/synapse/issues/14403))
-- Faster joins: filter out non local events when a room doesn't have its full state. ([\#14404](https://github.com/matrix-org/synapse/issues/14404))
-- Faster joins: send events to initial list of servers if we don't have the full state yet. ([\#14408](https://github.com/matrix-org/synapse/issues/14408))
-- Faster joins: use servers list approximation received during `send_join` (potentially updated with received membership events) in `assert_host_in_room`. ([\#14515](https://github.com/matrix-org/synapse/issues/14515))
-- Fix type logic in TCP replication code that prevented correctly ignoring blank commands. ([\#14449](https://github.com/matrix-org/synapse/issues/14449))
-- Remove option to skip locking of tables when performing emulated upserts, to avoid a class of bugs in future. ([\#14469](https://github.com/matrix-org/synapse/issues/14469))
-- `scripts-dev/federation_client`: Fix routing on servers with `.well-known` files. ([\#14479](https://github.com/matrix-org/synapse/issues/14479))
-- Reduce default third party invite rate limit to 216 invites per day. ([\#14487](https://github.com/matrix-org/synapse/issues/14487))
-- Refactor conversion of device list changes in room to outbound pokes to track unconverted rows using a `(stream ID, room ID)` position instead of updating the `converted_to_destinations` flag on every row. ([\#14516](https://github.com/matrix-org/synapse/issues/14516))
-- Add more prompts to the bug report form. ([\#14522](https://github.com/matrix-org/synapse/issues/14522))
-- Extend editorconfig rules on indent and line length to `.pyi` files. ([\#14526](https://github.com/matrix-org/synapse/issues/14526))
-- Run Rust CI when `Cargo.lock` changes. This is particularly useful for dependabot updates. ([\#14571](https://github.com/matrix-org/synapse/issues/14571))
-- Fix a possible variable shadow in `create_new_client_event`. ([\#14575](https://github.com/matrix-org/synapse/issues/14575))
-- Bump various dependencies in the `poetry.lock` file and in CI scripts. ([\#14557](https://github.com/matrix-org/synapse/issues/14557), [\#14559](https://github.com/matrix-org/synapse/issues/14559), [\#14560](https://github.com/matrix-org/synapse/issues/14560), [\#14500](https://github.com/matrix-org/synapse/issues/14500), [\#14501](https://github.com/matrix-org/synapse/issues/14501), [\#14502](https://github.com/matrix-org/synapse/issues/14502), [\#14503](https://github.com/matrix-org/synapse/issues/14503), [\#14504](https://github.com/matrix-org/synapse/issues/14504), [\#14505](https://github.com/matrix-org/synapse/issues/14505)).
-
-
-Synapse 1.72.0 (2022-11-22)
-===========================
-
-Please note that Synapse now only supports PostgreSQL 11+, because PostgreSQL 10 has reached end-of-life, c.f. our [Deprecation Policy](https://github.com/matrix-org/synapse/blob/develop/docs/deprecation_policy.md).
-
-Bugfixes
---------
-
-- Update forgotten references to legacy metrics in the included Grafana dashboard. ([\#14477](https://github.com/matrix-org/synapse/issues/14477))
-
-
-Synapse 1.72.0rc1 (2022-11-16)
-==============================
-
-Features
---------
-
-- Add experimental support for [MSC3912](https://github.com/matrix-org/matrix-spec-proposals/pull/3912): Relation-based redactions. ([\#14260](https://github.com/matrix-org/synapse/issues/14260))
-- Build Debian packages for Ubuntu 22.10 (Kinetic Kudu). ([\#14396](https://github.com/matrix-org/synapse/issues/14396))
-- Add an [Admin API](https://matrix-org.github.io/synapse/latest/usage/administration/admin_api/index.html) endpoint for user lookup based on third-party ID (3PID). Contributed by @ashfame. ([\#14405](https://github.com/matrix-org/synapse/issues/14405))
-- Faster joins: include heroes' membership events in the partial join response, for rooms without a name or canonical alias. ([\#14442](https://github.com/matrix-org/synapse/issues/14442))
-
-
-Bugfixes
---------
-
-- Faster joins: do not block creation of or queries for room aliases during the resync. ([\#14292](https://github.com/matrix-org/synapse/issues/14292))
-- Fix a bug introduced in Synapse 1.64.0rc1 which could cause log spam when fetching events from other homeservers. ([\#14347](https://github.com/matrix-org/synapse/issues/14347))
-- Fix a bug introduced in 1.66 which would not send certain pushrules to clients. Contributed by Nico. ([\#14356](https://github.com/matrix-org/synapse/issues/14356))
-- Fix a bug introduced in v1.71.0rc1 where the power level event was incorrectly created during initial room creation. ([\#14361](https://github.com/matrix-org/synapse/issues/14361))
-- Fix the refresh token endpoint to be under /r0 and /v3 instead of /v1. Contributed by Tulir @ Beeper. ([\#14364](https://github.com/matrix-org/synapse/issues/14364))
-- Fix a long-standing bug where Synapse would raise an error when encountering an unrecognised field in a `/sync` filter, instead of ignoring it for forward compatibility. ([\#14369](https://github.com/matrix-org/synapse/issues/14369))
-- Fix a background database update, introduced in Synapse 1.64.0, which could cause poor database performance. ([\#14374](https://github.com/matrix-org/synapse/issues/14374))
-- Fix PostgreSQL sometimes using table scans for queries against the `event_search` table, taking a long time and a large amount of IO. ([\#14409](https://github.com/matrix-org/synapse/issues/14409))
-- Fix rendering of some HTML templates (including emails). Introduced in v1.71.0. ([\#14448](https://github.com/matrix-org/synapse/issues/14448))
-- 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. ([\#14453](https://github.com/matrix-org/synapse/issues/14453))
-
-
-Updates to the Docker image
----------------------------
-
-- Add all Stream Writer worker types to `configure_workers_and_start.py`. ([\#14197](https://github.com/matrix-org/synapse/issues/14197))
-- Remove references to legacy worker types in the multi-worker Dockerfile. ([\#14294](https://github.com/matrix-org/synapse/issues/14294))
-
-
-Improved Documentation
-----------------------
-
-- Upload documentation PRs to Netlify. ([\#12947](https://github.com/matrix-org/synapse/issues/12947), [\#14370](https://github.com/matrix-org/synapse/issues/14370))
-- Add addtional TURN server configuration example based on [eturnal](https://github.com/processone/eturnal) and adjust general TURN server doc structure. ([\#14293](https://github.com/matrix-org/synapse/issues/14293))
-- Add example on how to load balance /sync requests. Contributed by [aceArt](https://aceart.de). ([\#14297](https://github.com/matrix-org/synapse/issues/14297))
-- Edit sample Nginx reverse proxy configuration to use HTTP/1.1. Contributed by Brad Jones. ([\#14414](https://github.com/matrix-org/synapse/issues/14414))
-
-
-Deprecations and Removals
--------------------------
-
-- Remove support for PostgreSQL 10. ([\#14392](https://github.com/matrix-org/synapse/issues/14392), [\#14397](https://github.com/matrix-org/synapse/issues/14397))
-
-
-Internal Changes
-----------------
-
-- Run unit tests against Python 3.11. ([\#13812](https://github.com/matrix-org/synapse/issues/13812))
-- Add TLS support for generic worker endpoints. ([\#14128](https://github.com/matrix-org/synapse/issues/14128), [\#14455](https://github.com/matrix-org/synapse/issues/14455))
-- Switch to a maintained action for installing Rust in CI. ([\#14313](https://github.com/matrix-org/synapse/issues/14313))
-- Add override ability to `complement.sh` command line script to request certain types of workers. ([\#14324](https://github.com/matrix-org/synapse/issues/14324))
-- Enabling testing of [MSC3874](https://github.com/matrix-org/matrix-spec-proposals/pull/3874) (filtering of `/messages` by relation type) in complement. ([\#14339](https://github.com/matrix-org/synapse/issues/14339))
-- Concisely log a failure to resolve state due to missing `prev_events`. ([\#14346](https://github.com/matrix-org/synapse/issues/14346))
-- Use a maintained Github action to install Rust. ([\#14351](https://github.com/matrix-org/synapse/issues/14351))
-- Cleanup old worker datastore classes. Contributed by Nick @ Beeper (@fizzadar). ([\#14375](https://github.com/matrix-org/synapse/issues/14375))
-- Test against PostgreSQL 15 in CI. ([\#14394](https://github.com/matrix-org/synapse/issues/14394))
-- Remove unreachable code. ([\#14410](https://github.com/matrix-org/synapse/issues/14410))
-- Clean-up event persistence code. ([\#14411](https://github.com/matrix-org/synapse/issues/14411))
-- Update docstring to clarify that `get_partial_state_events_batch` does not just give you completely arbitrary partial-state events. ([\#14417](https://github.com/matrix-org/synapse/issues/14417))
-- Fix mypy errors introduced by bumping the locked version of `attrs` and `gitpython`. ([\#14433](https://github.com/matrix-org/synapse/issues/14433))
-- Make Dependabot only bump Rust deps in the lock file. ([\#14434](https://github.com/matrix-org/synapse/issues/14434))
-- Fix an incorrect stub return type for `PushRuleEvaluator.run`. ([\#14451](https://github.com/matrix-org/synapse/issues/14451))
-- Improve performance of `/context` in large rooms. ([\#14461](https://github.com/matrix-org/synapse/issues/14461))
-
-
-Synapse 1.71.0 (2022-11-08)
-===========================
-
-Please note that, as announced in the release notes for Synapse 1.69.0, legacy Prometheus metric names are now disabled by default.
-They will be removed altogether in Synapse 1.73.0.
-If not already done, server administrators should update their dashboards and alerting rules to avoid using the deprecated metric names.
-See the [upgrade notes](https://matrix-org.github.io/synapse/v1.71/upgrade.html#upgrading-to-v1710) for more details.
-
-**Note:** in line with our [deprecation policy](https://matrix-org.github.io/synapse/latest/deprecation_policy.html) for platform dependencies, this will be the last release to support PostgreSQL 10, which reaches upstream end-of-life on November 10th, 2022. Future releases of Synapse will require PostgreSQL 11+.
-
-No significant changes since 1.71.0rc2.
-
-
-Synapse 1.71.0rc2 (2022-11-04)
-==============================
-
-Improved Documentation
-----------------------
-
-- Document the changes to monthly active user metrics due to deprecation of legacy Prometheus metric names. ([\#14358](https://github.com/matrix-org/synapse/issues/14358), [\#14360](https://github.com/matrix-org/synapse/issues/14360))
-
-
-Deprecations and Removals
--------------------------
-
-- Disable legacy Prometheus metric names by default. They can still be re-enabled for now, but they will be removed altogether in Synapse 1.73.0. ([\#14353](https://github.com/matrix-org/synapse/issues/14353))
-
-
-Internal Changes
-----------------
-
-- Run unit tests against Python 3.11. ([\#13812](https://github.com/matrix-org/synapse/issues/13812))
-
-
-Synapse 1.71.0rc1 (2022-11-01)
-==============================
-
-Features
---------
-
-- Support back-channel logouts from OpenID Connect providers. ([\#11414](https://github.com/matrix-org/synapse/issues/11414))
-- Allow use of Postgres and SQLlite full-text search operators in search queries. ([\#11635](https://github.com/matrix-org/synapse/issues/11635), [\#14310](https://github.com/matrix-org/synapse/issues/14310), [\#14311](https://github.com/matrix-org/synapse/issues/14311))
-- Implement [MSC3664](https://github.com/matrix-org/matrix-doc/pull/3664), Pushrules for relations. Contributed by Nico. ([\#11804](https://github.com/matrix-org/synapse/issues/11804))
-- Improve aesthetics of HTML templates. Note that these changes do not retroactively apply to templates which have been [customised](https://matrix-org.github.io/synapse/latest/templates.html#templates) by server admins. ([\#13652](https://github.com/matrix-org/synapse/issues/13652))
-- Enable write-ahead logging for SQLite installations. Contributed by [@asymmetric](https://github.com/asymmetric). ([\#13897](https://github.com/matrix-org/synapse/issues/13897))
-- Show erasure status when [listing users](https://matrix-org.github.io/synapse/latest/admin_api/user_admin_api.html#query-user-account) in the Admin API. ([\#14205](https://github.com/matrix-org/synapse/issues/14205))
-- Provide a specific error code when a `/sync` request provides a filter which doesn't represent a JSON object. ([\#14262](https://github.com/matrix-org/synapse/issues/14262))
-
-
-Bugfixes
---------
-
-- Fix a long-standing bug where the `update_synapse_database` script could not be run with multiple databases. Contributed by @thefinn93 @ Beeper. ([\#13422](https://github.com/matrix-org/synapse/issues/13422))
-- Fix a bug which prevented setting an avatar on homeservers which have an explicit port in their `server_name` and have `max_avatar_size` and/or `allowed_avatar_mimetypes` configuration. Contributed by @ashfame. ([\#13927](https://github.com/matrix-org/synapse/issues/13927))
-- Check appservice user interest against the local users instead of all users in the room to align with [MSC3905](https://github.com/matrix-org/matrix-spec-proposals/pull/3905). ([\#13958](https://github.com/matrix-org/synapse/issues/13958))
-- Fix a long-standing bug where Synapse would accidentally include extra information in the response to [`PUT /_matrix/federation/v2/invite/{roomId}/{eventId}`](https://spec.matrix.org/v1.4/server-server-api/#put_matrixfederationv2inviteroomideventid). ([\#14064](https://github.com/matrix-org/synapse/issues/14064))
-- Fix a bug introduced in Synapse 1.64.0 where presence updates could be missing from `/sync` responses. ([\#14243](https://github.com/matrix-org/synapse/issues/14243))
-- Fix a bug introduced in Synapse 1.60.0 which caused an error to be logged when Synapse received a SIGHUP signal if debug logging was enabled. ([\#14258](https://github.com/matrix-org/synapse/issues/14258))
-- Prevent history insertion ([MSC2716](https://github.com/matrix-org/matrix-spec-proposals/pull/2716)) during an partial join ([MSC3706](https://github.com/matrix-org/matrix-spec-proposals/pull/3706)). ([\#14291](https://github.com/matrix-org/synapse/issues/14291))
-- Fix a bug introduced in Synapse 1.34.0 where device names would be returned via a federation user key query request when `allow_device_name_lookup_over_federation` was set to `false`. ([\#14304](https://github.com/matrix-org/synapse/issues/14304))
-- Fix a bug introduced in Synapse 0.34.0 where logs could include error spam when background processes are measured as taking a negative amount of time. ([\#14323](https://github.com/matrix-org/synapse/issues/14323))
-- Fix a bug introduced in Synapse 1.70.0 where clients were unable to PUT new [dehydrated devices](https://github.com/matrix-org/matrix-spec-proposals/pull/2697). ([\#14336](https://github.com/matrix-org/synapse/issues/14336))
-
-
-Improved Documentation
-----------------------
-
-- Explain how to disable the use of [`trusted_key_servers`](https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#trusted_key_servers). ([\#13999](https://github.com/matrix-org/synapse/issues/13999))
-- Add workers settings to [configuration manual](https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#individual-worker-configuration). ([\#14086](https://github.com/matrix-org/synapse/issues/14086))
-- Correct the name of the config option [`encryption_enabled_by_default_for_room_type`](https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#encryption_enabled_by_default_for_room_type). ([\#14110](https://github.com/matrix-org/synapse/issues/14110))
-- Update docstrings of `SynapseError` and `FederationError` to bettter describe what they are used for and the effects of using them are. ([\#14191](https://github.com/matrix-org/synapse/issues/14191))
-
-
-Internal Changes
-----------------
-
-- Remove unused `@lru_cache` decorator. ([\#13595](https://github.com/matrix-org/synapse/issues/13595))
-- Save login tokens in database and prevent login token reuse. ([\#13844](https://github.com/matrix-org/synapse/issues/13844))
-- Refactor OIDC tests to better mimic an actual OIDC provider. ([\#13910](https://github.com/matrix-org/synapse/issues/13910))
-- Fix type annotation causing import time error in the Complement forking launcher. ([\#14084](https://github.com/matrix-org/synapse/issues/14084))
-- Refactor [MSC3030](https://github.com/matrix-org/matrix-spec-proposals/pull/3030) `/timestamp_to_event` endpoint to loop over federation destinations with standard pattern and error handling. ([\#14096](https://github.com/matrix-org/synapse/issues/14096))
-- Add initial power level event to batch of bulk persisted events when creating a new room. ([\#14228](https://github.com/matrix-org/synapse/issues/14228))
-- Refactor `/key/` endpoints to use `RestServlet` classes. ([\#14229](https://github.com/matrix-org/synapse/issues/14229))
-- Switch to using the `matrix-org/backend-meta` version of `triage-incoming` for new issues in CI. ([\#14230](https://github.com/matrix-org/synapse/issues/14230))
-- Build wheels on macos 11, not 10.15. ([\#14249](https://github.com/matrix-org/synapse/issues/14249))
-- Add debugging to help diagnose lost device list updates. ([\#14268](https://github.com/matrix-org/synapse/issues/14268))
-- Add Rust cache to CI for `trial` runs. ([\#14287](https://github.com/matrix-org/synapse/issues/14287))
-- Improve type hinting of `RawHeaders`. ([\#14303](https://github.com/matrix-org/synapse/issues/14303))
-- Use Poetry 1.2.0 in the Twisted Trunk CI job. ([\#14305](https://github.com/matrix-org/synapse/issues/14305))
-
-<details>
-<summary>Dependency updates</summary>
-
-Runtime:
-
-- Bump anyhow from 1.0.65 to 1.0.66. ([\#14278](https://github.com/matrix-org/synapse/issues/14278))
-- Bump jinja2 from 3.0.3 to 3.1.2. ([\#14271](https://github.com/matrix-org/synapse/issues/14271))
-- Bump prometheus-client from 0.14.0 to 0.15.0. ([\#14274](https://github.com/matrix-org/synapse/issues/14274))
-- Bump psycopg2 from 2.9.4 to 2.9.5. ([\#14331](https://github.com/matrix-org/synapse/issues/14331))
-- Bump pysaml2 from 7.1.2 to 7.2.1. ([\#14270](https://github.com/matrix-org/synapse/issues/14270))
-- Bump sentry-sdk from 1.5.11 to 1.10.1. ([\#14330](https://github.com/matrix-org/synapse/issues/14330))
-- Bump serde from 1.0.145 to 1.0.147. ([\#14277](https://github.com/matrix-org/synapse/issues/14277))
-- Bump serde_json from 1.0.86 to 1.0.87. ([\#14279](https://github.com/matrix-org/synapse/issues/14279))
-
-Tooling and CI:
-
-- Bump black from 22.3.0 to 22.10.0. ([\#14328](https://github.com/matrix-org/synapse/issues/14328))
-- Bump flake8-bugbear from 21.3.2 to 22.9.23. ([\#14042](https://github.com/matrix-org/synapse/issues/14042))
-- Bump peaceiris/actions-gh-pages from 3.8.0 to 3.9.0. ([\#14276](https://github.com/matrix-org/synapse/issues/14276))
-- Bump peaceiris/actions-mdbook from 1.1.14 to 1.2.0. ([\#14275](https://github.com/matrix-org/synapse/issues/14275))
-- Bump setuptools-rust from 1.5.1 to 1.5.2. ([\#14273](https://github.com/matrix-org/synapse/issues/14273))
-- Bump twine from 3.8.0 to 4.0.1. ([\#14332](https://github.com/matrix-org/synapse/issues/14332))
-- Bump types-opentracing from 2.4.7 to 2.4.10. ([\#14133](https://github.com/matrix-org/synapse/issues/14133))
-- Bump types-requests from 2.28.11 to 2.28.11.2. ([\#14272](https://github.com/matrix-org/synapse/issues/14272))
-</details>
-
 Synapse 1.70.1 (2022-10-28)
 ===========================
 

Cargo.lock

@@ -13,9 +13,9 @@ dependencies = [
 
 [[package]]
 name = "anyhow"
-version = "1.0.66"
+version = "1.0.65"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "216261ddc8289130e551ddcd5ce8a064710c0d064a4d2895c67151c92b5443f6"
+checksum = "98161a4e3e2184da77bb14f02184cdd111e83bbbcc9979dfee3c44b9a85f5602"
 
 [[package]]
 name = "arc-swap"
@@ -37,9 +37,9 @@ checksum = "bef38d45163c2f1dde094a7dfd33ccf595c92905c8f8f4fdc18d06fb1037718a"
 
 [[package]]
 name = "blake2"
-version = "0.10.5"
+version = "0.10.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "b12e5fd123190ce1c2e559308a94c9bacad77907d4c6005d9e58fe1a0689e55e"
+checksum = "b9cf849ee05b2ee5fba5e36f97ff8ec2533916700fc0758d40d92136a42f3388"
 dependencies = [
  "digest",
 ]
@@ -194,9 +194,9 @@ dependencies = [
 
 [[package]]
 name = "pyo3"
-version = "0.17.3"
+version = "0.17.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "268be0c73583c183f2b14052337465768c07726936a260f480f0857cb95ba543"
+checksum = "201b6887e5576bf2f945fe65172c1fcbf3fcf285b23e4d71eb171d9736e38d32"
 dependencies = [
  "anyhow",
  "cfg-if",
@@ -212,9 +212,9 @@ dependencies = [
 
 [[package]]
 name = "pyo3-build-config"
-version = "0.17.3"
+version = "0.17.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "28fcd1e73f06ec85bf3280c48c67e731d8290ad3d730f8be9dc07946923005c8"
+checksum = "bf0708c9ed01692635cbf056e286008e5a2927ab1a5e48cdd3aeb1ba5a6fef47"
 dependencies = [
  "once_cell",
  "target-lexicon",
@@ -222,9 +222,9 @@ dependencies = [
 
 [[package]]
 name = "pyo3-ffi"
-version = "0.17.3"
+version = "0.17.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "0f6cb136e222e49115b3c51c32792886defbfb0adead26a688142b346a0b9ffc"
+checksum = "90352dea4f486932b72ddf776264d293f85b79a1d214de1d023927b41461132d"
 dependencies = [
  "libc",
  "pyo3-build-config",
@@ -243,9 +243,9 @@ dependencies = [
 
 [[package]]
 name = "pyo3-macros"
-version = "0.17.3"
+version = "0.17.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "94144a1266e236b1c932682136dc35a9dee8d3589728f68130c7c3861ef96b28"
+checksum = "7eb24b804a2d9e88bfcc480a5a6dd76f006c1e3edaf064e8250423336e2cd79d"
 dependencies = [
  "proc-macro2",
  "pyo3-macros-backend",
@@ -255,9 +255,9 @@ dependencies = [
 
 [[package]]
 name = "pyo3-macros-backend"
-version = "0.17.3"
+version = "0.17.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "c8df9be978a2d2f0cdebabb03206ed73b11314701a5bfe71b0d753b81997777f"
+checksum = "f22bb49f6a7348c253d7ac67a6875f2dc65f36c2ae64a82c381d528972bea6d6"
 dependencies = [
  "proc-macro2",
  "quote",
@@ -294,9 +294,9 @@ dependencies = [
 
 [[package]]
 name = "regex"
-version = "1.7.0"
+version = "1.6.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e076559ef8e241f2ae3479e36f97bd5741c0330689e217ad51ce2c76808b868a"
+checksum = "4c4eb3267174b8c6c2f654116623910a0fef09c4753f8dd83db29c48a0df988b"
 dependencies = [
  "aho-corasick",
  "memchr",
@@ -323,18 +323,18 @@ checksum = "d29ab0c6d3fc0ee92fe66e2d99f700eab17a8d57d1c1d3b748380fb20baa78cd"
 
 [[package]]
 name = "serde"
-version = "1.0.148"
+version = "1.0.145"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e53f64bb4ba0191d6d0676e1b141ca55047d83b74f5607e6d8eb88126c52c2dc"
+checksum = "728eb6351430bccb993660dfffc5a72f91ccc1295abaa8ce19b27ebe4f75568b"
 dependencies = [
  "serde_derive",
 ]
 
 [[package]]
 name = "serde_derive"
-version = "1.0.148"
+version = "1.0.145"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a55492425aa53521babf6137309e7d34c20bbfbbfcfe2c7f3a047fd1f6b92c0c"
+checksum = "81fa1584d3d1bcacd84c277a0dfe21f5b0f6accf4a23d04d4c6d61f1af522b4c"
 dependencies = [
  "proc-macro2",
  "quote",
@@ -343,9 +343,9 @@ dependencies = [
 
 [[package]]
 name = "serde_json"
-version = "1.0.89"
+version = "1.0.86"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "020ff22c755c2ed3f8cf162dbb41a7268d934702f3ed3631656ea597e08fc3db"
+checksum = "41feea4228a6f1cd09ec7a3593a682276702cd67b5273544757dae23c096f074"
 dependencies = [
  "itoa",
  "ryu",
@@ -366,9 +366,9 @@ checksum = "6bdef32e8150c2a081110b42772ffe7d7c9032b606bc226c8260fd97e0976601"
 
 [[package]]
 name = "syn"
-version = "1.0.104"
+version = "1.0.102"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "4ae548ec36cf198c0ef7710d3c230987c2d6d7bd98ad6edc0274462724c585ce"
+checksum = "3fcd952facd492f9be3ef0d0b7032a6e442ee9b361d4acc2b1d0c4aaa5f613a1"
 dependencies = [
  "proc-macro2",
  "quote",

Cargo.toml

@@ -3,7 +3,3 @@
 
 [workspace]
 members = ["rust"]
-
-[profile.dbgrelease]
-inherits = "release"
-debug = true

book.toml

@@ -34,6 +34,14 @@ additional-css = [
     "docs/website_files/table-of-contents.css",
     "docs/website_files/remove-nav-buttons.css",
     "docs/website_files/indent-section-headers.css",
+    "docs/website_files/version-picker.css",
 ]
-additional-js = ["docs/website_files/table-of-contents.js"]
-theme = "docs/website_files/theme"
+additional-js = [
+    "docs/website_files/table-of-contents.js",
+    "docs/website_files/version-picker.js",
+    "docs/website_files/version.js",
+]
+theme = "docs/website_files/theme"
+
+[preprocessor.schema_versions]
+command = "./scripts-dev/schema_versions.py"

changelog.d/14255.misc

@@ -1 +0,0 @@
-Optimise push badge count calculations. Contributed by Nick @ Beeper (@fizzadar).

changelog.d/14490.feature

@@ -1 +0,0 @@
-Stop using deprecated `keyIds` parameter when calling `/_matrix/key/v2/server`.

changelog.d/14493.doc

@@ -1 +0,0 @@
-Update worker settings for `pusher` and `federation_sender` functionality.

changelog.d/14517.doc

@@ -1 +0,0 @@
-Add links to third party package repositories, and point to the bug which highlights Ubuntu's out-of-date packages.

changelog.d/14525.feature

@@ -1 +0,0 @@
-Stop using deprecated `keyIds` parameter when calling `/_matrix/key/v2/server`.

changelog.d/14528.misc

@@ -1 +0,0 @@
-Share the `ClientRestResource` for both workers and the main process.

changelog.d/14549.misc

@@ -1 +0,0 @@
-Faster joins: use servers list approximation to send read receipts when in partial state instead of waiting for the full state of the room.

changelog.d/14551.feature

@@ -1 +0,0 @@
-Add new `push.enabled` config option to allow opting out of push notification calculation.

changelog.d/14568.misc

@@ -1 +0,0 @@
-Modernize unit tests configuration related to workers.

changelog.d/14576.feature

@@ -1 +0,0 @@
-Advertise support for Matrix 1.5 on `/_matrix/client/versions`.

changelog.d/14591.misc

@@ -1 +0,0 @@
-Bump jsonschema from 4.17.0 to 4.17.3.

changelog.d/14592.bugfix

@@ -1 +0,0 @@
-Fix a long-standing bug where a device list update might not be sent to clients in certain circumstances.

changelog.d/14597.misc

@@ -1 +0,0 @@
-Add missing type hints.

changelog.d/14602.misc

@@ -1 +0,0 @@
-Fix Rust lint CI.

changelog.d/14607.misc

@@ -1 +0,0 @@
-Bump JasonEtco/create-an-issue from 2.5.0 to 2.8.1.

debian/changelog

@@ -1,45 +1,3 @@
-matrix-synapse-py3 (1.73.0~rc2) stable; urgency=medium
-
-  * New Synapse release 1.73.0rc2.
-
- -- Synapse Packaging team <packages@matrix.org>  Thu, 01 Dec 2022 10:02:19 +0000
-
-matrix-synapse-py3 (1.73.0~rc1) stable; urgency=medium
-
-  * New Synapse release 1.73.0rc1.
-
- -- Synapse Packaging team <packages@matrix.org>  Tue, 29 Nov 2022 12:28:13 +0000
-
-matrix-synapse-py3 (1.72.0) stable; urgency=medium
-
-  * New Synapse release 1.72.0.
-
- -- Synapse Packaging team <packages@matrix.org>  Tue, 22 Nov 2022 10:57:30 +0000
-
-matrix-synapse-py3 (1.72.0~rc1) stable; urgency=medium
-
-  * New Synapse release 1.72.0rc1.
-
- -- Synapse Packaging team <packages@matrix.org>  Wed, 16 Nov 2022 15:10:59 +0000
-
-matrix-synapse-py3 (1.71.0) stable; urgency=medium
-
-  * New Synapse release 1.71.0.
-
- -- Synapse Packaging team <packages@matrix.org>  Tue, 08 Nov 2022 10:38:10 +0000
-
-matrix-synapse-py3 (1.71.0~rc2) stable; urgency=medium
-
-  * New Synapse release 1.71.0rc2.
-
- -- Synapse Packaging team <packages@matrix.org>  Fri, 04 Nov 2022 12:00:33 +0000
-
-matrix-synapse-py3 (1.71.0~rc1) stable; urgency=medium
-
-  * New Synapse release 1.71.0rc1.
-
- -- Synapse Packaging team <packages@matrix.org>  Tue, 01 Nov 2022 12:10:17 +0000
-
 matrix-synapse-py3 (1.70.1) stable; urgency=medium
 
   * New Synapse release 1.70.1.

docker/complement/conf/start_for_complement.sh

@@ -45,12 +45,7 @@ esac
 
 if [[ -n "$SYNAPSE_COMPLEMENT_USE_WORKERS" ]]; then
   # Specify the workers to test with
-  # Allow overriding by explicitly setting SYNAPSE_WORKER_TYPES outside, while still
-  # utilizing WORKERS=1 for backwards compatibility.
-  # -n True if the length of string is non-zero.
-  # -z True if the length of string is zero.
-  if [[ -z "$SYNAPSE_WORKER_TYPES" ]]; then
-    export SYNAPSE_WORKER_TYPES="\
+  export SYNAPSE_WORKER_TYPES="\
       event_persister, \
       event_persister, \
       background_worker, \
@@ -66,8 +61,6 @@ if [[ -n "$SYNAPSE_COMPLEMENT_USE_WORKERS" ]]; then
       appservice, \
       pusher"
 
-  fi
-  log "Workers requested: $SYNAPSE_WORKER_TYPES"
   # Improve startup times by using a launcher based on fork()
   export SYNAPSE_USE_EXPERIMENTAL_FORKING_LAUNCHER=1
 else

docker/complement/conf/workers-shared-extra.yaml.j2

@@ -92,6 +92,8 @@ allow_device_name_lookup_over_federation: true
 ## Experimental Features ##
 
 experimental_features:
+  # Enable spaces support
+  spaces_enabled: true
   # Enable history backfilling support
   msc2716_enabled: true
   # server-side support for partial state in /send_join responses
@@ -100,8 +102,8 @@ experimental_features:
   # client-side support for partial state in /send_join responses
   faster_joins: true
   {% endif %}
-  # Filtering /messages by relation type.
-  msc3874_enabled: true
+  # Enable jump to date endpoint
+  msc3030_enabled: true
 
 server_notices:
   system_mxid_localpart: _server

docker/configure_workers_and_start.py

@@ -20,7 +20,7 @@
 #   * SYNAPSE_SERVER_NAME: The desired server_name of the homeserver.
 #   * SYNAPSE_REPORT_STATS: Whether to report stats.
 #   * SYNAPSE_WORKER_TYPES: A comma separated list of worker names as specified in WORKER_CONFIG
-#         below. Leave empty for no workers.
+#         below. Leave empty for no workers, or set to '*' for all possible workers.
 #   * SYNAPSE_AS_REGISTRATION_DIR: If specified, a directory in which .yaml and .yml files
 #         will be treated as Application Service registration files.
 #   * SYNAPSE_TLS_CERT: Path to a TLS certificate in PEM format.
@@ -50,18 +50,13 @@ from jinja2 import Environment, FileSystemLoader
 
 MAIN_PROCESS_HTTP_LISTENER_PORT = 8080
 
-# Workers with exposed endpoints needs either "client", "federation", or "media" listener_resources
-# Watching /_matrix/client needs a "client" listener
-# Watching /_matrix/federation needs a "federation" listener
-# Watching /_matrix/media and related needs a "media" listener
-# Stream Writers require "client" and "replication" listeners because they
-#   have to attach by instance_map to the master process and have client endpoints.
+
 WORKERS_CONFIG: Dict[str, Dict[str, Any]] = {
     "pusher": {
-        "app": "synapse.app.generic_worker",
+        "app": "synapse.app.pusher",
         "listener_resources": [],
         "endpoint_patterns": [],
-        "shared_extra_conf": {},
+        "shared_extra_conf": {"start_pushers": False},
         "worker_extra_conf": "",
     },
     "user_dir": {
@@ -84,11 +79,7 @@ WORKERS_CONFIG: Dict[str, Dict[str, Any]] = {
             "^/_synapse/admin/v1/media/.*$",
             "^/_synapse/admin/v1/quarantine_media/.*$",
         ],
-        # The first configured media worker will run the media background jobs
-        "shared_extra_conf": {
-            "enable_media_repo": False,
-            "media_instance_running_background_jobs": "media_repository1",
-        },
+        "shared_extra_conf": {"enable_media_repo": False},
         "worker_extra_conf": "enable_media_repo: true",
     },
     "appservice": {
@@ -99,10 +90,10 @@ WORKERS_CONFIG: Dict[str, Dict[str, Any]] = {
         "worker_extra_conf": "",
     },
     "federation_sender": {
-        "app": "synapse.app.generic_worker",
+        "app": "synapse.app.federation_sender",
         "listener_resources": [],
         "endpoint_patterns": [],
-        "shared_extra_conf": {},
+        "shared_extra_conf": {"send_federation": False},
         "worker_extra_conf": "",
     },
     "synchrotron": {
@@ -140,7 +131,6 @@ WORKERS_CONFIG: Dict[str, Dict[str, Any]] = {
             "^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/event",
             "^/_matrix/client/(api/v1|r0|v3|unstable)/joined_rooms",
             "^/_matrix/client/(api/v1|r0|v3|unstable/.*)/rooms/.*/aliases",
-            "^/_matrix/client/v1/rooms/.*/timestamp_to_event$",
             "^/_matrix/client/(api/v1|r0|v3|unstable)/search",
         ],
         "shared_extra_conf": {},
@@ -164,7 +154,6 @@ WORKERS_CONFIG: Dict[str, Dict[str, Any]] = {
             "^/_matrix/federation/(v1|v2)/invite/",
             "^/_matrix/federation/(v1|v2)/query_auth/",
             "^/_matrix/federation/(v1|v2)/event_auth/",
-            "^/_matrix/federation/v1/timestamp_to_event/",
             "^/_matrix/federation/(v1|v2)/exchange_third_party_invite/",
             "^/_matrix/federation/(v1|v2)/user/devices/",
             "^/_matrix/federation/(v1|v2)/get_groups_publicised$",
@@ -211,54 +200,14 @@ WORKERS_CONFIG: Dict[str, Dict[str, Any]] = {
         "worker_extra_conf": "",
     },
     "frontend_proxy": {
-        "app": "synapse.app.generic_worker",
+        "app": "synapse.app.frontend_proxy",
         "listener_resources": ["client", "replication"],
         "endpoint_patterns": ["^/_matrix/client/(api/v1|r0|v3|unstable)/keys/upload"],
         "shared_extra_conf": {},
-        "worker_extra_conf": "",
-    },
-    "account_data": {
-        "app": "synapse.app.generic_worker",
-        "listener_resources": ["client", "replication"],
-        "endpoint_patterns": [
-            "^/_matrix/client/(r0|v3|unstable)/.*/tags",
-            "^/_matrix/client/(r0|v3|unstable)/.*/account_data",
-        ],
-        "shared_extra_conf": {},
-        "worker_extra_conf": "",
-    },
-    "presence": {
-        "app": "synapse.app.generic_worker",
-        "listener_resources": ["client", "replication"],
-        "endpoint_patterns": ["^/_matrix/client/(api/v1|r0|v3|unstable)/presence/"],
-        "shared_extra_conf": {},
-        "worker_extra_conf": "",
-    },
-    "receipts": {
-        "app": "synapse.app.generic_worker",
-        "listener_resources": ["client", "replication"],
-        "endpoint_patterns": [
-            "^/_matrix/client/(r0|v3|unstable)/rooms/.*/receipt",
-            "^/_matrix/client/(r0|v3|unstable)/rooms/.*/read_markers",
-        ],
-        "shared_extra_conf": {},
-        "worker_extra_conf": "",
-    },
-    "to_device": {
-        "app": "synapse.app.generic_worker",
-        "listener_resources": ["client", "replication"],
-        "endpoint_patterns": ["^/_matrix/client/(r0|v3|unstable)/sendToDevice/"],
-        "shared_extra_conf": {},
-        "worker_extra_conf": "",
-    },
-    "typing": {
-        "app": "synapse.app.generic_worker",
-        "listener_resources": ["client", "replication"],
-        "endpoint_patterns": [
-            "^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/typing"
-        ],
-        "shared_extra_conf": {},
-        "worker_extra_conf": "",
+        "worker_extra_conf": (
+            "worker_main_http_uri: http://127.0.0.1:%d"
+            % (MAIN_PROCESS_HTTP_LISTENER_PORT,)
+        ),
     },
 }
 
@@ -322,14 +271,14 @@ def convert(src: str, dst: str, **template_vars: object) -> None:
         outfile.write(rendered)
 
 
-def add_worker_roles_to_shared_config(
+def add_sharding_to_shared_config(
     shared_config: dict,
     worker_type: str,
     worker_name: str,
     worker_port: int,
 ) -> None:
     """Given a dictionary representing a config file shared across all workers,
-    append appropriate worker information to it for the current worker_type instance.
+    append sharded worker information to it for the current worker_type instance.
 
     Args:
         shared_config: The config dict that all worker instances share (after being converted to YAML)
@@ -360,19 +309,9 @@ def add_worker_roles_to_shared_config(
             "port": worker_port,
         }
 
-    elif worker_type in ["account_data", "presence", "receipts", "to_device", "typing"]:
-        # Update the list of stream writers
-        # It's convenient that the name of the worker type is the same as the stream to write
-        shared_config.setdefault("stream_writers", {}).setdefault(
-            worker_type, []
-        ).append(worker_name)
-
-        # Map of stream writer instance names to host/ports combos
-        # For now, all stream writers need http replication ports
-        instance_map[worker_name] = {
-            "host": "localhost",
-            "port": worker_port,
-        }
+    elif worker_type == "media_repository":
+        # The first configured media worker will run the media background jobs
+        shared_config.setdefault("media_instance_running_background_jobs", worker_name)
 
 
 def generate_base_homeserver_config() -> None:
@@ -482,7 +421,8 @@ def generate_worker_files(
         if worker_config:
             worker_config = worker_config.copy()
         else:
-            error(worker_type + " is an unknown worker type! Please fix!")
+            log(worker_type + " is an unknown worker type! It will be ignored")
+            continue
 
         new_worker_count = worker_type_counter.setdefault(worker_type, 0) + 1
         worker_type_counter[worker_type] = new_worker_count
@@ -501,11 +441,11 @@ def generate_worker_files(
 
         # Check if more than one instance of this worker type has been specified
         worker_type_total_count = worker_types.count(worker_type)
-
-        # Update the shared config with sharding-related options if necessary
-        add_worker_roles_to_shared_config(
-            shared_config, worker_type, worker_name, worker_port
-        )
+        if worker_type_total_count > 1:
+            # Update the shared config with sharding-related options if necessary
+            add_sharding_to_shared_config(
+                shared_config, worker_type, worker_name, worker_port
+            )
 
         # Enable the worker in supervisord
         worker_descriptors.append(worker_config)

docs/SUMMARY.md

@@ -9,8 +9,6 @@
   - [Configuring a Reverse Proxy](reverse_proxy.md)
   - [Configuring a Forward/Outbound Proxy](setup/forward_proxy.md)
   - [Configuring a Turn Server](turn-howto.md)
-    - [coturn TURN server](setup/turn/coturn.md)
-    - [eturnal TURN server](setup/turn/eturnal.md)
   - [Delegation](delegate.md)
 
 # Upgrading

docs/admin_api/user_admin_api.md

@@ -37,7 +37,6 @@ It returns a JSON body like the following:
     "is_guest": 0,
     "admin": 0,
     "deactivated": 0,
-    "erased": false,
     "shadow_banned": 0,
     "creation_ts": 1560432506,
     "appservice_id": null,
@@ -168,7 +167,6 @@ A response body like the following is returned:
             "admin": 0,
             "user_type": null,
             "deactivated": 0,
-            "erased": false,
             "shadow_banned": 0,
             "displayname": "<User One>",
             "avatar_url": null,
@@ -179,7 +177,6 @@ A response body like the following is returned:
             "admin": 1,
             "user_type": null,
             "deactivated": 0,
-            "erased": false,
             "shadow_banned": 0,
             "displayname": "<User Two>",
             "avatar_url": "<avatar_url>",
@@ -250,7 +247,6 @@ The following fields are returned in the JSON response body:
   - `user_type` - string - Type of the user. Normal users are type `None`.
     This allows user type specific behaviour. There are also types `support` and `bot`. 
   - `deactivated` - bool - Status if that user has been marked as deactivated.
-  - `erased` - bool - Status if that user has been marked as erased.
   - `shadow_banned` - bool - Status if that user has been marked as shadow banned.
   - `displayname` - string - The user's display name if they have set one.
   - `avatar_url` - string -  The user's avatar URL if they have set one.
@@ -1197,42 +1193,3 @@ Returns a `404` HTTP status code if no user was found, with a response body like
 ```
 
 _Added in Synapse 1.68.0._
-
-
-### Find a user based on their Third Party ID (ThreePID or 3PID)
-
-The API is:
-
-```
-GET /_synapse/admin/v1/threepid/$medium/users/$address
-```
-
-When a user matched the given address for the given medium, an HTTP code `200` with a response body like the following is returned:
-
-```json
-{
-    "user_id": "@hello:example.org"
-}
-```
-
-**Parameters**
-
-The following parameters should be set in the URL:
-
-- `medium` - Kind of third-party ID, either `email` or `msisdn`.
-- `address` - Value of the third-party ID.
-
-The `address` may have characters that are not URL-safe, so it is advised to URL-encode those parameters.
-
-**Errors**
-
-Returns a `404` HTTP status code if no user was found, with a response body like this:
-
-```json
-{
-    "errcode":"M_NOT_FOUND",
-    "error":"User not found"
-}
-```
-
-_Added in Synapse 1.72.0._

docs/development/contributing_guide.md

@@ -324,12 +324,6 @@ The above will run a monolithic (single-process) Synapse with SQLite as the data
 
 - Passing `POSTGRES=1` as an environment variable to use the Postgres database instead.
 - Passing `WORKERS=1` as an environment variable to use a workerised setup instead. This option implies the use of Postgres.
-  - If setting `WORKERS=1`, optionally set `WORKER_TYPES=` to declare which worker
-    types you wish to test. A simple comma-delimited string containing the worker types
-    defined from the `WORKERS_CONFIG` template in
-    [here](https://github.com/matrix-org/synapse/blob/develop/docker/configure_workers_and_start.py#L54).
-    A safe example would be `WORKER_TYPES="federation_inbound, federation_sender, synchrotron"`.
-    See the [worker documentation](../workers.md) for additional information on workers.
 
 To increase the log level for the tests, set `SYNAPSE_TEST_LOG_LEVEL`, e.g:
 ```sh

docs/metrics-howto.md

@@ -209,9 +209,6 @@ altogether in Synapse v1.73.0.**
 | synapse_http_httppusher_http_pushes_failed_total                             | synapse_http_httppusher_http_pushes_failed                             |
 | synapse_http_httppusher_badge_updates_processed_total                        | synapse_http_httppusher_badge_updates_processed                        |
 | synapse_http_httppusher_badge_updates_failed_total                           | synapse_http_httppusher_badge_updates_failed                           |
-| synapse_admin_mau_current                                                    | synapse_admin_mau:current                                              |
-| synapse_admin_mau_max                                                        | synapse_admin_mau:max                                                  |
-| synapse_admin_mau_registered_reserved_users                                  | synapse_admin_mau:registered_reserved_users                            |
 
 Removal of deprecated metrics & time based counters becoming histograms in 0.31.0
 ---------------------------------------------------------------------------------

docs/openid.md

@@ -49,13 +49,6 @@ setting in your configuration file.
 See the [configuration manual](usage/configuration/config_documentation.md#oidc_providers) for some sample settings, as well as
 the text below for example configurations for specific providers.
 
-## OIDC Back-Channel Logout
-
-Synapse supports receiving [OpenID Connect Back-Channel Logout](https://openid.net/specs/openid-connect-backchannel-1_0.html) notifications.
-
-This lets the OpenID Connect Provider notify Synapse when a user logs out, so that Synapse can end that user session.
-This feature can be enabled by setting the `backchannel_logout_enabled` property to `true` in the provider configuration, and setting the following URL as destination for Back-Channel Logout notifications in your OpenID Connect Provider: `[synapse public baseurl]/_synapse/client/oidc/backchannel_logout`
-
 ## Sample configs
 
 Here are a few configs for providers that should work with Synapse.
@@ -130,9 +123,6 @@ oidc_providers:
 
 [Keycloak][keycloak-idp] is an opensource IdP maintained by Red Hat.
 
-Keycloak supports OIDC Back-Channel Logout, which sends logout notification to Synapse, so that Synapse users get logged out when they log out from Keycloak.
-This can be optionally enabled by setting `backchannel_logout_enabled` to `true` in the Synapse configuration, and by setting the "Backchannel Logout URL" in Keycloak.
-
 Follow the [Getting Started Guide](https://www.keycloak.org/getting-started) to install Keycloak and set up a realm.
 
 1. Click `Clients` in the sidebar and click `Create`
@@ -154,8 +144,6 @@ Follow the [Getting Started Guide](https://www.keycloak.org/getting-started) to
 | Client Protocol | `openid-connect` |
 | Access Type | `confidential` |
 | Valid Redirect URIs | `[synapse public baseurl]/_synapse/client/oidc/callback` |
-| Backchannel Logout URL (optional) | `[synapse public baseurl]/_synapse/client/oidc/backchannel_logout` |
-| Backchannel Logout Session Required (optional) | `On` |
 
 5. Click `Save`
 6. On the Credentials tab, update the fields:
@@ -179,9 +167,7 @@ oidc_providers:
       config:
         localpart_template: "{{ user.preferred_username }}"
         display_name_template: "{{ user.name }}"
-    backchannel_logout_enabled: true # Optional
 ```
-
 ### Auth0
 
 [Auth0][auth0] is a hosted SaaS IdP solution.

docs/reverse_proxy.md

@@ -79,9 +79,6 @@ server {
         # Nginx by default only allows file uploads up to 1M in size
         # Increase client_max_body_size to match max_upload_size defined in homeserver.yaml
         client_max_body_size 50M;
-	
-	# Synapse responses may be chunked, which is an HTTP/1.1 feature.
-	proxy_http_version 1.1;
     }
 }
 ```

docs/sample_log_config.yaml

@@ -6,7 +6,7 @@
 # Synapse also supports structured logging for machine readable logs which can
 # be ingested by ELK stacks. See [2] for details.
 #
-# [1]: https://docs.python.org/3/library/logging.config.html#configuration-dictionary-schema
+# [1]: https://docs.python.org/3.7/library/logging.config.html#configuration-dictionary-schema
 # [2]: https://matrix-org.github.io/synapse/latest/structured_logging.html
 
 version: 1

docs/setup/installation.md

@@ -84,9 +84,7 @@ file when you upgrade the Debian package to a later version.
 
 ##### Downstream Debian packages
 
-Andrej Shadura maintains a
-[`matrix-synapse`](https://packages.debian.org/sid/matrix-synapse) package in
-the Debian repositories.
+Andrej Shadura maintains a `matrix-synapse` package in the Debian repositories.
 For `bookworm` and `sid`, it can be installed simply with:
 
 ```sh
@@ -102,27 +100,23 @@ for information on how to use backports.
 ##### Downstream Ubuntu packages
 
 We do not recommend using the packages in the default Ubuntu repository
-at this time, as they are [old and suffer from known security vulnerabilities](
-    https://bugs.launchpad.net/ubuntu/+source/matrix-synapse/+bug/1848709
-).
+at this time, as they are old and suffer from known security vulnerabilities.
 The latest version of Synapse can be installed from [our repository](#matrixorg-packages).
 
 #### Fedora
 
-Synapse is in the Fedora repositories as
-[`matrix-synapse`](https://src.fedoraproject.org/rpms/matrix-synapse):
+Synapse is in the Fedora repositories as `matrix-synapse`:
 
 ```sh
 sudo dnf install matrix-synapse
 ```
 
-Additionally, Oleg Girko provides Fedora RPMs at
+Oleg Girko provides Fedora RPMs at
 <https://obs.infoserver.lv/project/monitor/matrix-synapse>
 
 #### OpenSUSE
 
-Synapse is in the OpenSUSE repositories as
-[`matrix-synapse`](https://software.opensuse.org/package/matrix-synapse):
+Synapse is in the OpenSUSE repositories as `matrix-synapse`:
 
 ```sh
 sudo zypper install matrix-synapse
@@ -157,8 +151,7 @@ sudo pip install py-bcrypt
 
 #### Void Linux
 
-Synapse can be found in the void repositories as
-['synapse'](https://github.com/void-linux/void-packages/tree/master/srcpkgs/synapse):
+Synapse can be found in the void repositories as 'synapse':
 
 ```sh
 xbps-install -Su

docs/setup/turn/coturn.md

@@ -1,188 +0,0 @@
-# coturn TURN server
-
-The following sections describe how to install [coturn](<https://github.com/coturn/coturn>) (which implements the TURN REST API).
-
-## `coturn` setup
-
-### Initial installation
-
-The TURN daemon `coturn` is available from a variety of sources such as native package managers, or installation from source.
-
-#### Debian and Ubuntu based distributions
-
-Just install the debian package:
-
-```sh
-sudo apt install coturn
-```
-
-This will install and start a systemd service called `coturn`.
-
-#### Source installation
-
-1. Download the [latest release](https://github.com/coturn/coturn/releases/latest) from github.  Unpack it and `cd` into the directory.
-
-1.  Configure it:
-
-    ```sh
-    ./configure
-    ```
-
-    You may need to install `libevent2`: if so, you should do so in
-    the way recommended by your operating system. You can ignore
-    warnings about lack of database support: a database is unnecessary
-    for this purpose.
-
-1.  Build and install it:
-
-    ```sh
-    make
-    sudo make install
-    ```
-
-### Configuration
-
-1.  Create or edit the config file in `/etc/turnserver.conf`. The relevant
-    lines, with example values, are:
-
-    ```
-    use-auth-secret
-    static-auth-secret=[your secret key here]
-    realm=turn.myserver.org
-    ```
-
-    See `turnserver.conf` for explanations of the options. One way to generate
-    the `static-auth-secret` is with `pwgen`:
-
-    ```sh
-    pwgen -s 64 1
-    ```
-
-    A `realm` must be specified, but its value is somewhat arbitrary. (It is
-    sent to clients as part of the authentication flow.) It is conventional to
-    set it to be your server name.
-
-1.  You will most likely want to configure `coturn` to write logs somewhere. The
-    easiest way is normally to send them to the syslog:
-
-    ```sh
-    syslog
-    ```
-
-    (in which case, the logs will be available via `journalctl -u coturn` on a
-    systemd system). Alternatively, `coturn` can be configured to write to a
-    logfile - check the example config file supplied with `coturn`.
-
-1.  Consider your security settings. TURN lets users request a relay which will
-    connect to arbitrary IP addresses and ports. The following configuration is
-    suggested as a minimum starting point:
-
-    ```
-    # VoIP traffic is all UDP. There is no reason to let users connect to arbitrary TCP endpoints via the relay.
-    no-tcp-relay
-
-    # don't let the relay ever try to connect to private IP address ranges within your network (if any)
-    # given the turn server is likely behind your firewall, remember to include any privileged public IPs too.
-    denied-peer-ip=10.0.0.0-10.255.255.255
-    denied-peer-ip=192.168.0.0-192.168.255.255
-    denied-peer-ip=172.16.0.0-172.31.255.255
-
-    # recommended additional local peers to block, to mitigate external access to internal services.
-    # https://www.rtcsec.com/article/slack-webrtc-turn-compromise-and-bug-bounty/#how-to-fix-an-open-turn-relay-to-address-this-vulnerability
-    no-multicast-peers
-    denied-peer-ip=0.0.0.0-0.255.255.255
-    denied-peer-ip=100.64.0.0-100.127.255.255
-    denied-peer-ip=127.0.0.0-127.255.255.255
-    denied-peer-ip=169.254.0.0-169.254.255.255
-    denied-peer-ip=192.0.0.0-192.0.0.255
-    denied-peer-ip=192.0.2.0-192.0.2.255
-    denied-peer-ip=192.88.99.0-192.88.99.255
-    denied-peer-ip=198.18.0.0-198.19.255.255
-    denied-peer-ip=198.51.100.0-198.51.100.255
-    denied-peer-ip=203.0.113.0-203.0.113.255
-    denied-peer-ip=240.0.0.0-255.255.255.255
-
-    # special case the turn server itself so that client->TURN->TURN->client flows work
-    # this should be one of the turn server's listening IPs
-    allowed-peer-ip=10.0.0.1
-
-    # consider whether you want to limit the quota of relayed streams per user (or total) to avoid risk of DoS.
-    user-quota=12 # 4 streams per video call, so 12 streams = 3 simultaneous relayed calls per user.
-    total-quota=1200
-    ```
-
-1.  Also consider supporting TLS/DTLS. To do this, add the following settings
-    to `turnserver.conf`:
-
-    ```
-    # TLS certificates, including intermediate certs.
-    # For Let's Encrypt certificates, use `fullchain.pem` here.
-    cert=/path/to/fullchain.pem
-
-    # TLS private key file
-    pkey=/path/to/privkey.pem
-
-    # Ensure the configuration lines that disable TLS/DTLS are commented-out or removed
-    #no-tls
-    #no-dtls
-    ```
-
-    In this case, replace the `turn:` schemes in the `turn_uris` settings below
-    with `turns:`.
-
-    We recommend that you only try to set up TLS/DTLS once you have set up a
-    basic installation and got it working.
-
-    NB: If your TLS certificate was provided by Let's Encrypt, TLS/DTLS will
-    not work with any Matrix client that uses Chromium's WebRTC library. This
-    currently includes Element Android & iOS; for more details, see their
-    [respective](https://github.com/vector-im/element-android/issues/1533)
-    [issues](https://github.com/vector-im/element-ios/issues/2712) as well as the underlying
-    [WebRTC issue](https://bugs.chromium.org/p/webrtc/issues/detail?id=11710).
-    Consider using a ZeroSSL certificate for your TURN server as a working alternative.
-
-1.  Ensure your firewall allows traffic into the TURN server on the ports
-    you've configured it to listen on (By default: 3478 and 5349 for TURN
-    traffic (remember to allow both TCP and UDP traffic), and ports 49152-65535
-    for the UDP relay.)
-
-1.  If your TURN server is behind NAT, the NAT gateway must have an external,
-    publicly-reachable IP address. You must configure `coturn` to advertise that
-    address to connecting clients:
-
-    ```
-    external-ip=EXTERNAL_NAT_IPv4_ADDRESS
-    ```
-
-    You may optionally limit the TURN server to listen only on the local
-    address that is mapped by NAT to the external address:
-
-    ```
-    listening-ip=INTERNAL_TURNSERVER_IPv4_ADDRESS
-    ```
-
-    If your NAT gateway is reachable over both IPv4 and IPv6, you may
-    configure `coturn` to advertise each available address:
-
-    ```
-    external-ip=EXTERNAL_NAT_IPv4_ADDRESS
-    external-ip=EXTERNAL_NAT_IPv6_ADDRESS
-    ```
-
-    When advertising an external IPv6 address, ensure that the firewall and
-    network settings of the system running your TURN server are configured to
-    accept IPv6 traffic, and that the TURN server is listening on the local
-    IPv6 address that is mapped by NAT to the external IPv6 address.
-
-1.  (Re)start the turn server:
-
-    * If you used the Debian package (or have set up a systemd unit yourself):
-      ```sh
-      sudo systemctl restart coturn
-      ```
-
-    * If you built from source:
-
-      ```sh
-      /usr/local/bin/turnserver -o
-      ```

docs/setup/turn/eturnal.md

@@ -1,170 +0,0 @@
-# eturnal TURN server
-
-The following sections describe how to install [eturnal](<https://github.com/processone/eturnal>) 
-(which implements the TURN REST API).
-
-## `eturnal` setup
-
-### Initial installation
-
-The `eturnal` TURN server implementation is available from a variety of sources 
-such as native package managers, binary packages, installation from source or 
-[container image](https://eturnal.net/documentation/code/docker.html). They are 
-all described [here](https://github.com/processone/eturnal#installation).
-
-Quick-Test instructions in a [Linux Shell](https://github.com/processone/eturnal/blob/master/QUICK-TEST.md) 
-or with [Docker](https://github.com/processone/eturnal/blob/master/docker-k8s/QUICK-TEST.md) 
-are available as well.
-
-### Configuration
-
-After installation, `eturnal` usually ships a [default configuration file](https://github.com/processone/eturnal/blob/master/config/eturnal.yml) 
-here: `/etc/eturnal.yml` (and, if not found there, there is a backup file here: 
-`/opt/eturnal/etc/eturnal.yml`). It uses the (indentation-sensitive!) [YAML](https://en.wikipedia.org/wiki/YAML) 
-format. The file contains further explanations.
-
-Here are some hints how to configure eturnal on your [host machine](https://github.com/processone/eturnal#configuration) 
-or when using e.g. [Docker](https://eturnal.net/documentation/code/docker.html).
-You may also further deep dive into the [reference documentation](https://eturnal.net/documentation/).
-
-`eturnal` runs out of the box with the default configuration. To enable TURN and 
-to integrate it with your homeserver, some aspects in `eturnal`'s default configuration file 
-must be edited:
-
-1.  Homeserver's [`turn_shared_secret`](../../usage/configuration/config_documentation.md#turn_shared_secret) 
-    and eturnal's shared `secret` for authentication
-
-    Both need to have the same value. Uncomment and adjust this line in `eturnal`'s 
-    configuration file:
-
-    ```yaml
-    secret: "long-and-cryptic"     # Shared secret, CHANGE THIS.
-    ```
-
-    One way to generate a `secret` is with `pwgen`:
-
-    ```sh
-    pwgen -s 64 1
-    ```
-
-1.  Public IP address
-
-    If your TURN server is behind NAT, the NAT gateway must have an external,
-    publicly-reachable IP address. `eturnal` tries to autodetect the public IP address, 
-    however, it may also be configured by uncommenting and adjusting this line, so 
-    `eturnal` advertises that address to connecting clients:
-
-    ```yaml
-    relay_ipv4_addr: "203.0.113.4" # The server's public IPv4 address.
-    ```
-
-    If your NAT gateway is reachable over both IPv4 and IPv6, you may
-    configure `eturnal` to advertise each available address:
-
-    ```yaml
-    relay_ipv4_addr: "203.0.113.4" # The server's public IPv4 address.
-    relay_ipv6_addr: "2001:db8::4" # The server's public IPv6 address (optional).
-    ```
-
-    When advertising an external IPv6 address, ensure that the firewall and
-    network settings of the system running your TURN server are configured to
-    accept IPv6 traffic, and that the TURN server is listening on the local
-    IPv6 address that is mapped by NAT to the external IPv6 address.
-
-1.  Logging
-
-    If `eturnal` was started by systemd, log files are written into the
-    `/var/log/eturnal` directory by default. In order to log to the [journal](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html)
-    instead, the `log_dir` option can be set to `stdout` in the configuration file.
-
-1.  Security considerations
-
-    Consider your security settings. TURN lets users request a relay which will
-    connect to arbitrary IP addresses and ports. The following configuration is
-    suggested as a minimum starting point, [see also the official documentation](https://eturnal.net/documentation/#blacklist):
-
-    ```yaml
-    ## Reject TURN relaying from/to the following addresses/networks:
-    blacklist:                 # This is the default blacklist.
-        - "127.0.0.0/8"        # IPv4 loopback.
-        - "::1"                # IPv6 loopback.
-        - recommended          # Expands to a number of networks recommended to be
-                               # blocked, but includes private networks. Those
-                               # would have to be 'whitelist'ed if eturnal serves
-                               # local clients/peers within such networks.
-    ```
-
-    To whitelist IP addresses or specific (private) networks, you need to **add** a 
-    whitelist part into the configuration file, e.g.:
-
-    ```yaml
-    whitelist:
-        - "192.168.0.0/16"
-        - "203.0.113.113"
-        - "2001:db8::/64"
-    ```
-
-    The more specific, the better.
-
-1.  TURNS (TURN via TLS/DTLS)
-
-    Also consider supporting TLS/DTLS. To do this, adjust the following settings
-    in the `eturnal.yml` configuration file (TLS parts should not be commented anymore):
-
-    ```yaml
-    listen:
-        - ip: "::"
-          port: 3478
-          transport: udp
-        - ip: "::"
-          port: 3478
-          transport: tcp
-        - ip: "::"
-          port: 5349
-          transport: tls
-
-    ## TLS certificate/key files (must be readable by 'eturnal' user!):
-    tls_crt_file: /etc/eturnal/tls/crt.pem
-    tls_key_file: /etc/eturnal/tls/key.pem
-    ```
-
-    In this case, replace the `turn:` schemes in homeserver's `turn_uris` settings
-    with `turns:`. More is described [here](../../usage/configuration/config_documentation.md#turn_uris).
-
-    We recommend that you only try to set up TLS/DTLS once you have set up a
-    basic installation and got it working.
-
-    NB: If your TLS certificate was provided by Let's Encrypt, TLS/DTLS will
-    not work with any Matrix client that uses Chromium's WebRTC library. This
-    currently includes Element Android & iOS; for more details, see their
-    [respective](https://github.com/vector-im/element-android/issues/1533)
-    [issues](https://github.com/vector-im/element-ios/issues/2712) as well as the underlying
-    [WebRTC issue](https://bugs.chromium.org/p/webrtc/issues/detail?id=11710).
-    Consider using a ZeroSSL certificate for your TURN server as a working alternative.
-
-1.  Firewall
-
-    Ensure your firewall allows traffic into the TURN server on the ports
-    you've configured it to listen on (By default: 3478 and 5349 for TURN
-    traffic (remember to allow both TCP and UDP traffic), and ports 49152-65535
-    for the UDP relay.)
-
-1.  Reload/ restarting `eturnal`
-
-    Changes in the configuration file require `eturnal` to reload/ restart, this
-    can be achieved by:
-
-    ```sh
-    eturnalctl reload
-    ```
-    
-    `eturnal` performs a configuration check before actually reloading/ restarting
-    and provides hints, if something is not correctly configured.
-
-### eturnalctl opterations script
-
-`eturnal` offers a handy [operations script](https://eturnal.net/documentation/#Operation) 
-which can be called e.g. to check, whether the service is up, to restart the service, 
-to query how many active sessions exist, to change logging behaviour and so on.
-
-Hint: If `eturnalctl` is not part of your `$PATH`, consider either sym-linking it (e.g. ´ln -s /opt/eturnal/bin/eturnalctl /usr/local/bin/eturnalctl´) or call it from the default `eturnal` directory directly: e.g. `/opt/eturnal/bin/eturnalctl info`

docs/turn-howto.md

@@ -9,28 +9,222 @@ allows the homeserver to generate credentials that are valid for use on the
 TURN server through the use of a secret shared between the homeserver and the
 TURN server.
 
-This documentation provides two TURN server configuration examples:
-
-* [coturn](setup/turn/coturn.md)
-* [eturnal](setup/turn/eturnal.md)
+The following sections describe how to install [coturn](<https://github.com/coturn/coturn>) (which implements the TURN REST API) and integrate it with synapse.
 
 ## Requirements
 
-For TURN relaying to work, the TURN service must be hosted on a server/endpoint with a public IP.
+For TURN relaying with `coturn` to work, it must be hosted on a server/endpoint with a public IP.
 
 Hosting TURN behind NAT requires port forwaring and for the NAT gateway to have a public IP.
 However, even with appropriate configuration, NAT is known to cause issues and to often not work.
 
-Afterwards, the homeserver needs some further configuration.
+## `coturn` setup
+
+### Initial installation
+
+The TURN daemon `coturn` is available from a variety of sources such as native package managers, or installation from source.
+
+#### Debian installation
+
+Just install the debian package:
+
+```sh
+apt install coturn
+```
+
+This will install and start a systemd service called `coturn`.
+
+#### Source installation
+
+1. Download the [latest release](https://github.com/coturn/coturn/releases/latest) from github.  Unpack it and `cd` into the directory.
+
+1.  Configure it:
+
+    ```sh
+    ./configure
+    ```
+
+    You may need to install `libevent2`: if so, you should do so in
+    the way recommended by your operating system. You can ignore
+    warnings about lack of database support: a database is unnecessary
+    for this purpose.
+
+1.  Build and install it:
+
+    ```sh
+    make
+    make install
+    ```
+
+### Configuration
+
+1.  Create or edit the config file in `/etc/turnserver.conf`. The relevant
+    lines, with example values, are:
+
+    ```
+    use-auth-secret
+    static-auth-secret=[your secret key here]
+    realm=turn.myserver.org
+    ```
+
+    See `turnserver.conf` for explanations of the options. One way to generate
+    the `static-auth-secret` is with `pwgen`:
+
+    ```sh
+    pwgen -s 64 1
+    ```
+
+    A `realm` must be specified, but its value is somewhat arbitrary. (It is
+    sent to clients as part of the authentication flow.) It is conventional to
+    set it to be your server name.
+
+1.  You will most likely want to configure coturn to write logs somewhere. The
+    easiest way is normally to send them to the syslog:
+
+    ```sh
+    syslog
+    ```
+
+    (in which case, the logs will be available via `journalctl -u coturn` on a
+    systemd system). Alternatively, coturn can be configured to write to a
+    logfile - check the example config file supplied with coturn.
+
+1.  Consider your security settings. TURN lets users request a relay which will
+    connect to arbitrary IP addresses and ports. The following configuration is
+    suggested as a minimum starting point:
+
+    ```
+    # VoIP traffic is all UDP. There is no reason to let users connect to arbitrary TCP endpoints via the relay.
+    no-tcp-relay
+
+    # don't let the relay ever try to connect to private IP address ranges within your network (if any)
+    # given the turn server is likely behind your firewall, remember to include any privileged public IPs too.
+    denied-peer-ip=10.0.0.0-10.255.255.255
+    denied-peer-ip=192.168.0.0-192.168.255.255
+    denied-peer-ip=172.16.0.0-172.31.255.255
+
+    # recommended additional local peers to block, to mitigate external access to internal services.
+    # https://www.rtcsec.com/article/slack-webrtc-turn-compromise-and-bug-bounty/#how-to-fix-an-open-turn-relay-to-address-this-vulnerability
+    no-multicast-peers
+    denied-peer-ip=0.0.0.0-0.255.255.255
+    denied-peer-ip=100.64.0.0-100.127.255.255
+    denied-peer-ip=127.0.0.0-127.255.255.255
+    denied-peer-ip=169.254.0.0-169.254.255.255
+    denied-peer-ip=192.0.0.0-192.0.0.255
+    denied-peer-ip=192.0.2.0-192.0.2.255
+    denied-peer-ip=192.88.99.0-192.88.99.255
+    denied-peer-ip=198.18.0.0-198.19.255.255
+    denied-peer-ip=198.51.100.0-198.51.100.255
+    denied-peer-ip=203.0.113.0-203.0.113.255
+    denied-peer-ip=240.0.0.0-255.255.255.255
+
+    # special case the turn server itself so that client->TURN->TURN->client flows work
+    # this should be one of the turn server's listening IPs
+    allowed-peer-ip=10.0.0.1
+
+    # consider whether you want to limit the quota of relayed streams per user (or total) to avoid risk of DoS.
+    user-quota=12 # 4 streams per video call, so 12 streams = 3 simultaneous relayed calls per user.
+    total-quota=1200
+    ```
+
+1.  Also consider supporting TLS/DTLS. To do this, add the following settings
+    to `turnserver.conf`:
+
+    ```
+    # TLS certificates, including intermediate certs.
+    # For Let's Encrypt certificates, use `fullchain.pem` here.
+    cert=/path/to/fullchain.pem
+
+    # TLS private key file
+    pkey=/path/to/privkey.pem
+
+    # Ensure the configuration lines that disable TLS/DTLS are commented-out or removed
+    #no-tls
+    #no-dtls
+    ```
+
+    In this case, replace the `turn:` schemes in the `turn_uris` settings below
+    with `turns:`.
+
+    We recommend that you only try to set up TLS/DTLS once you have set up a
+    basic installation and got it working.
+
+    NB: If your TLS certificate was provided by Let's Encrypt, TLS/DTLS will
+    not work with any Matrix client that uses Chromium's WebRTC library. This
+    currently includes Element Android & iOS; for more details, see their
+    [respective](https://github.com/vector-im/element-android/issues/1533)
+    [issues](https://github.com/vector-im/element-ios/issues/2712) as well as the underlying
+    [WebRTC issue](https://bugs.chromium.org/p/webrtc/issues/detail?id=11710).
+    Consider using a ZeroSSL certificate for your TURN server as a working alternative.
+
+1.  Ensure your firewall allows traffic into the TURN server on the ports
+    you've configured it to listen on (By default: 3478 and 5349 for TURN
+    traffic (remember to allow both TCP and UDP traffic), and ports 49152-65535
+    for the UDP relay.)
+
+1.  If your TURN server is behind NAT, the NAT gateway must have an external,
+    publicly-reachable IP address. You must configure coturn to advertise that
+    address to connecting clients:
+
+    ```
+    external-ip=EXTERNAL_NAT_IPv4_ADDRESS
+    ```
+
+    You may optionally limit the TURN server to listen only on the local
+    address that is mapped by NAT to the external address:
+
+    ```
+    listening-ip=INTERNAL_TURNSERVER_IPv4_ADDRESS
+    ```
+
+    If your NAT gateway is reachable over both IPv4 and IPv6, you may
+    configure coturn to advertise each available address:
+
+    ```
+    external-ip=EXTERNAL_NAT_IPv4_ADDRESS
+    external-ip=EXTERNAL_NAT_IPv6_ADDRESS
+    ```
+
+    When advertising an external IPv6 address, ensure that the firewall and
+    network settings of the system running your TURN server are configured to
+    accept IPv6 traffic, and that the TURN server is listening on the local
+    IPv6 address that is mapped by NAT to the external IPv6 address.
+
+1.  (Re)start the turn server:
+
+    * If you used the Debian package (or have set up a systemd unit yourself):
+      ```sh
+      systemctl restart coturn
+      ```
+
+    * If you installed from source:
+
+      ```sh
+      bin/turnserver -o
+      ```
 
 ## Synapse setup
 
 Your homeserver configuration file needs the following extra keys:
 
-1.  [`turn_uris`](usage/configuration/config_documentation.md#turn_uris)
-2.  [`turn_shared_secret`](usage/configuration/config_documentation.md#turn_shared_secret)
-3.  [`turn_user_lifetime`](usage/configuration/config_documentation.md#turn_user_lifetime)
-4.  [`turn_allow_guests`](usage/configuration/config_documentation.md#turn_allow_guests)
+1.  "`turn_uris`": This needs to be a yaml list of public-facing URIs
+    for your TURN server to be given out to your clients. Add separate
+    entries for each transport your TURN server supports.
+2.  "`turn_shared_secret`": This is the secret shared between your
+    homeserver and your TURN server, so you should set it to the same
+    string you used in turnserver.conf.
+3.  "`turn_user_lifetime`": This is the amount of time credentials
+    generated by your homeserver are valid for (in milliseconds).
+    Shorter times offer less potential for abuse at the expense of
+    increased traffic between web clients and your homeserver to
+    refresh credentials. The TURN REST API specification recommends
+    one day (86400000).
+4.  "`turn_allow_guests`": Whether to allow guest users to use the
+    TURN server. This is enabled by default, as otherwise VoIP will
+    not work reliably for guests. However, it does introduce a
+    security risk as it lets guests connect to arbitrary endpoints
+    without having gone through a CAPTCHA or similar to register a
+    real account.
 
 As an example, here is the relevant section of the config file for `matrix.org`. The
 `turn_uris` are appropriate for TURN servers listening on the default ports, with no TLS.
@@ -69,7 +263,7 @@ Here are a few things to try:
  * Check that you have opened your firewall to allow UDP traffic to the UDP
    relay ports (49152-65535 by default).
 
- * Try disabling TLS/DTLS listeners and enable only its (unencrypted)
+ * Try disabling `coturn`'s TLS/DTLS listeners and enable only its (unencrypted)
    TCP/UDP listeners. (This will only leave signaling traffic unencrypted;
    voice & video WebRTC traffic is always encrypted.)
 
@@ -94,19 +288,12 @@ Here are a few things to try:
 
     * ensure that your TURN server uses the NAT gateway as its default route.
 
- * Enable more verbose logging, in `coturn` via the `verbose` setting:
+ * Enable more verbose logging in coturn via the `verbose` setting:
 
    ```
    verbose
    ```
 
-    or with `eturnal` with the shell command `eturnalctl loglevel debug` or in the configuration file (the service needs to [reload](https://eturnal.net/documentation/#Operation) for it to become effective):
-
-    ```yaml
-        ## Logging configuration:
-            log_level: debug
-    ```
-
    ... and then see if there are any clues in its logs.
 
  * If you are using a browser-based client under Chrome, check
@@ -130,7 +317,7 @@ Here are a few things to try:
       matrix client to your homeserver in your browser's network inspector. In
       the response you should see `username` and `password`. Or:
 
-    * Use the following shell commands for `coturn`:
+    * Use the following shell commands:
 
       ```sh
       secret=staticAuthSecretHere
@@ -140,16 +327,11 @@ Here are a few things to try:
       echo -e "username: $u\npassword: $p"
       ```
 
-      or for `eturnal`
+      Or:
 
-      ```sh
-      eturnalctl credentials
-      ```
-      
-
-    * Or (**coturn only**): Temporarily configure `coturn` to accept a static
-      username/password. To do this, comment out `use-auth-secret` and
-      `static-auth-secret` and add the following:
+    * Temporarily configure coturn to accept a static username/password. To do
+      this, comment out `use-auth-secret` and `static-auth-secret` and add the
+      following:
 
       ```
       lt-cred-mech

docs/upgrade.md

@@ -88,82 +88,6 @@ process, for example:
     dpkg -i matrix-synapse-py3_1.3.0+stretch1_amd64.deb
     ```
 
-# Upgrading to v1.73.0
-
-## Legacy Prometheus metric names have now been removed
-
-Synapse v1.69.0 included the deprecation of legacy Prometheus metric names
-and offered an option to disable them.
-Synapse v1.71.0 disabled legacy Prometheus metric names by default.
-
-This version, v1.73.0, removes those legacy Prometheus metric names entirely.
-This also means that the `enable_legacy_metrics` configuration option has been
-removed; it will no longer be possible to re-enable the legacy metric names.
-
-If you use metrics and have not yet updated your Grafana dashboard(s),
-Prometheus console(s) or alerting rule(s), please consider doing so when upgrading
-to this version.
-Note that the included Grafana dashboard was updated in v1.72.0 to correct some
-metric names which were missed when legacy metrics were disabled by default.
-
-See [v1.69.0: Deprecation of legacy Prometheus metric names](#deprecation-of-legacy-prometheus-metric-names)
-for more context.
-
-
-# Upgrading to v1.72.0
-
-## Dropping support for PostgreSQL 10
-
-In line with our [deprecation policy](deprecation_policy.md), we've dropped
-support for PostgreSQL 10, as it is no longer supported upstream.
-
-This release of Synapse requires PostgreSQL 11+.
-
-
-# Upgrading to v1.71.0
-
-## Removal of the `generate_short_term_login_token` module API method
-
-As announced with the release of [Synapse 1.69.0](#deprecation-of-the-generate_short_term_login_token-module-api-method), the deprecated `generate_short_term_login_token` module method has been removed.
-
-Modules relying on it can instead use the `create_login_token` method.
-
-
-## Changes to the events received by application services (interest)
-
-To align with spec (changed in
-[MSC3905](https://github.com/matrix-org/matrix-spec-proposals/pull/3905)), Synapse now
-only considers local users to be interesting. In other words, the `users` namespace
-regex is only be applied against local users of the homeserver.
-
-Please note, this probably doesn't affect the expected behavior of your application
-service, since an interesting local user in a room still means all messages in the room
-(from local or remote users) will still be considered interesting. And matching a room
-with the `rooms` or `aliases` namespace regex will still consider all events sent in the
-room to be interesting to the application service.
-
-If one of your application service's `users` regex was intending to match a remote user,
-this will no longer match as you expect. The behavioral mismatch between matching all
-local users and some remote users is why the spec was changed/clarified and this
-caveat is no longer supported.
-
-
-## Legacy Prometheus metric names are now disabled by default
-
-Synapse v1.71.0 disables legacy Prometheus metric names by default.
-For administrators that still rely on them and have not yet had chance to update their
-uses of the metrics, it's still possible to specify `enable_legacy_metrics: true` in
-the configuration to re-enable them temporarily.
-
-Synapse v1.73.0 will **remove legacy metric names altogether** and at that point,
-it will no longer be possible to re-enable them.
-
-If you do not use metrics or you have already updated your Grafana dashboard(s),
-Prometheus console(s) and alerting rule(s), there is no action needed.
-
-See [v1.69.0: Deprecation of legacy Prometheus metric names](#deprecation-of-legacy-prometheus-metric-names).
-
-
 # Upgrading to v1.69.0
 
 ## Changes to the receipts replication streams

docs/usage/administration/admin_api/README.md

@@ -19,7 +19,7 @@ already on your `$PATH` depending on how Synapse was installed.
 Finding your user's `access_token` is client-dependent, but will usually be shown in the client's settings.
 
 ## Making an Admin API request
-For security reasons, we [recommend](../../../reverse_proxy.md#synapse-administration-endpoints)
+For security reasons, we [recommend](reverse_proxy.md#synapse-administration-endpoints)
 that the Admin API (`/_synapse/admin/...`) should be hidden from public view using a
 reverse proxy. This means you should typically query the Admin API from a terminal on
 the machine which runs Synapse.

docs/usage/administration/monthly_active_users.md

@@ -73,12 +73,12 @@ When a request is blocked, the response will have the `errcode` `M_RESOURCE_LIMI
 
 Synapse records several different prometheus metrics for MAU.
 
-`synapse_admin_mau_current` records the current MAU figure for native (non-application-service) users.
+`synapse_admin_mau:current` records the current MAU figure for native (non-application-service) users.
 
-`synapse_admin_mau_max` records the maximum MAU as dictated by the `max_mau_value` config value.
+`synapse_admin_mau:max` records the maximum MAU as dictated by the `max_mau_value` config value.
 
 `synapse_admin_mau_current_mau_by_service` records the current MAU including application service users. The label `app_service` can be used
 to filter by a specific service ID. This *also* includes non-application-service users under `app_service=native` .
 
-`synapse_admin_mau_registered_reserved_users` records the number of users specified in `mau_limits_reserved_threepids` which have
+`synapse_admin_mau:registered_reserved_users` records the number of users specified in `mau_limits_reserved_threepids` which have
 registered accounts on the homeserver.

docs/usage/configuration/config_documentation.md

@@ -99,7 +99,7 @@ modules:
     config: {}
 ```
 ---
-## Server
+## Server ##
 
 Define your homeserver name and other base options.
 
@@ -159,7 +159,7 @@ including _matrix/...). This is the same URL a user might enter into the
 'Custom Homeserver URL' field on their client. If you use Synapse with a
 reverse proxy, this should be the URL to reach Synapse via the proxy.
 Otherwise, it should be the URL to reach Synapse's client HTTP listener (see
-['listeners'](#listeners) below).
+'listeners' below).
 
 Defaults to `https://<server_name>/`.
 
@@ -570,7 +570,7 @@ Example configuration:
 delete_stale_devices_after: 1y
 ```
 
-## Homeserver blocking
+## Homeserver blocking ##
 Useful options for Synapse admins.
 
 ---
@@ -858,7 +858,7 @@ which are older than the room's maximum retention period. Synapse will also
 filter events received over federation so that events that should have been
 purged are ignored and not stored again.
 
-The message retention policies feature is disabled by default. Please be advised
+The message retention policies feature is disabled by default. Please be advised 
 that enabling this feature carries some risk. There are known bugs with the implementation
 which can cause database corruption. Setting retention to delete older history
 is less risky than deleting newer history but in general caution is advised when enabling this
@@ -922,7 +922,7 @@ retention:
       interval: 1d
 ```
 ---
-## TLS
+## TLS ##
 
 Options related to TLS.
 
@@ -1012,7 +1012,7 @@ federation_custom_ca_list:
   - myCA3.pem
 ```
 ---
-## Federation
+## Federation ##
 
 Options related to federation.
 
@@ -1071,7 +1071,7 @@ Example configuration:
 allow_device_name_lookup_over_federation: true
 ```
 ---
-## Caching
+## Caching ##
 
 Options related to caching.
 
@@ -1185,7 +1185,7 @@ file in Synapse's `contrib` directory, you can send a `SIGHUP` signal by using
 `systemctl reload matrix-synapse`.
 
 ---
-## Database
+## Database ##
 Config options related to database settings.
 
 ---
@@ -1332,21 +1332,20 @@ databases:
       cp_max: 10
 ```
 ---
-## Logging
+## Logging ##
 Config options related to logging.
 
 ---
 ### `log_config`
 
-This option specifies a yaml python logging config file as described
-[here](https://docs.python.org/3/library/logging.config.html#configuration-dictionary-schema).
+This option specifies a yaml python logging config file as described [here](https://docs.python.org/3.7/library/logging.config.html#configuration-dictionary-schema).
 
 Example configuration:
 ```yaml
 log_config: "CONFDIR/SERVERNAME.log.config"
 ```
 ---
-## Ratelimiting
+## Ratelimiting ##
 Options related to ratelimiting in Synapse.
 
 Each ratelimiting configuration is made of two parameters:
@@ -1577,7 +1576,7 @@ Example configuration:
 federation_rr_transactions_per_room_per_second: 40
 ```
 ---
-## Media Store
+## Media Store ##
 Config options related to Synapse's media store.
 
 ---
@@ -1767,7 +1766,7 @@ url_preview_ip_range_blacklist:
   - 'ff00::/8'
   - 'fec0::/10'
 ```
----
+----
 ### `url_preview_ip_range_whitelist`
 
 This option sets a list of IP address CIDR ranges that the URL preview spider is allowed
@@ -1861,7 +1860,7 @@ Example configuration:
    - 'fr;q=0.8'
    - '*;q=0.7'
 ```
----
+----
 ### `oembed`
 
 oEmbed allows for easier embedding content from a website. It can be
@@ -1878,7 +1877,7 @@ oembed:
     - oembed/my_providers.json
 ```
 ---
-## Captcha
+## Captcha ##
 
 See [here](../../CAPTCHA_SETUP.md) for full details on setting up captcha.
 
@@ -1927,7 +1926,7 @@ Example configuration:
 recaptcha_siteverify_api: "https://my.recaptcha.site"
 ```
 ---
-## TURN
+## TURN ##
 Options related to adding a TURN server to Synapse.
 
 ---
@@ -1948,7 +1947,7 @@ Example configuration:
 ```yaml
 turn_shared_secret: "YOUR_SHARED_SECRET"
 ```
----
+----
 ### `turn_username` and `turn_password`
 
 The Username and password if the TURN server needs them and does not use a token.
@@ -2367,7 +2366,7 @@ Example configuration:
 ```yaml
 session_lifetime: 24h
 ```
----
+----
 ### `refresh_access_token_lifetime`
 
 Time that an access token remains valid for, if the session is using refresh tokens.
@@ -2423,7 +2422,7 @@ nonrefreshable_access_token_lifetime: 24h
 ```
 
 ---
-## Metrics
+## Metrics ###
 Config options related to metrics.
 
 ---
@@ -2437,6 +2436,31 @@ Example configuration:
 enable_metrics: true
 ```
 ---
+### `enable_legacy_metrics`
+
+Set to `true` to publish both legacy and non-legacy Prometheus metric names,
+or to `false` to only publish non-legacy Prometheus metric names.
+Defaults to `true`. Has no effect if `enable_metrics` is `false`.
+**In Synapse v1.71.0, this will default to `false` before being removed in Synapse v1.73.0.**
+
+Legacy metric names include:
+- metrics containing colons in the name, such as `synapse_util_caches_response_cache:hits`, because colons are supposed to be reserved for user-defined recording rules;
+- counters that don't end with the `_total` suffix, such as `synapse_federation_client_sent_edus`, therefore not adhering to the OpenMetrics standard.
+
+These legacy metric names are unconventional and not compliant with OpenMetrics standards.
+They are included for backwards compatibility.
+
+Example configuration:
+```yaml
+enable_legacy_metrics: false
+```
+
+See https://github.com/matrix-org/synapse/issues/11106 for context.
+
+*Since v1.67.0.*
+
+**Will be removed in v1.73.0.**
+---
 ### `sentry`
 
 Use this option to enable sentry integration. Provide the DSN assigned to you by sentry
@@ -2495,7 +2519,7 @@ Example configuration:
 report_stats_endpoint: https://example.com/report-usage-stats/push
 ```
 ---
-## API Configuration
+## API Configuration ##
 Config settings related to the client/server API
 
 ---
@@ -2595,7 +2619,7 @@ Example configuration:
 form_secret: <PRIVATE STRING>
 ```
 ---
-## Signing Keys
+## Signing Keys ##
 Config options relating to signing keys
 
 ---
@@ -2656,12 +2680,6 @@ is still supported for backwards-compatibility, but it is deprecated.
 warning on start-up. To suppress this warning, set
 `suppress_key_server_warning` to true.
 
-If the use of a trusted key server has to be deactivated, e.g. in a private
-federation or for privacy reasons, this can be realised by setting
-an empty array (`trusted_key_servers: []`). Then Synapse will request the keys
-directly from the server that owns the keys. If Synapse does not get keys directly
-from the server, the events of this server will be rejected.
-
 Options for each entry in the list include:
 * `server_name`: the name of the server. Required.
 * `verify_keys`: an optional map from key id to base64-encoded public key.
@@ -2710,7 +2728,7 @@ Example configuration:
 key_server_signing_keys_path: "key_server_signing_keys.key"
 ```
 ---
-## Single sign-on integration
+## Single sign-on integration ##
 
 The following settings can be used to make Synapse use a single sign-on
 provider for authentication, instead of its internal password database.
@@ -2968,17 +2986,10 @@ Options for each entry include:
 
         For the default provider, the following settings are available:
 
-       * `subject_claim`: name of the claim containing a unique identifier
+       * subject_claim: name of the claim containing a unique identifier
          for the user. Defaults to 'sub', which OpenID Connect
          compliant providers should provide.
 
-       * `picture_claim`: name of the claim containing an url for the user's profile picture.
-         Defaults to 'picture', which OpenID Connect compliant providers should provide
-         and has to refer to a direct image file such as PNG, JPEG, or GIF image file.
-         
-         Currently only supported in monolithic (single-process) server configurations
-         where the media repository runs within the Synapse process.
-
        * `localpart_template`: Jinja2 template for the localpart of the MXID.
           If this is not set, the user will be prompted to choose their
           own username (see the documentation for the `sso_auth_account_details.html`
@@ -3003,15 +3014,6 @@ Options for each entry include:
      which is set to the claims returned by the UserInfo Endpoint and/or
      in the ID Token.
 
-* `backchannel_logout_enabled`: set to `true` to process OIDC Back-Channel Logout notifications.
-  Those notifications are expected to be received on `/_synapse/client/oidc/backchannel_logout`.
-  Defaults to `false`.
-
-* `backchannel_logout_ignore_sub`: by default, the OIDC Back-Channel Logout feature checks that the
-  `sub` claim matches the subject claim received during login. This check can be disabled by setting
-  this to `true`. Defaults to `false`.
-
-  You might want to disable this if the `subject_claim` returned by the mapping provider is not `sub`.
 
 It is possible to configure Synapse to only allow logins if certain attributes
 match particular values in the OIDC userinfo. The requirements can be listed under
@@ -3346,7 +3348,7 @@ email:
     email_validation: "[%(server_name)s] Validate your email"
 ```
 ---
-## Push
+## Push ##
 Configuration settings related to push notifications
 
 ---
@@ -3355,10 +3357,6 @@ Configuration settings related to push notifications
 This setting defines options for push notifications.
 
 This option has a number of sub-options. They are as follows:
-* `enable_push`: Enables or disables push notification calculation. Note, disabling this will also
-   stop unread counts being calculated for rooms. This mode of operation is intended
-   for homeservers which may only have bots or appservice users connected, or are otherwise
-   not interested in push/unread counters. This is enabled by default.
 * `include_content`: Clients requesting push notifications can either have the body of
    the message sent in the notification poke along with other details
    like the sender, or just the event ID and room ID (`event_id_only`).
@@ -3379,16 +3377,15 @@ This option has a number of sub-options. They are as follows:
 Example configuration:
 ```yaml
 push:
-  enable_push: true
   include_content: false
   group_unread_count_by_room: false
 ```
 ---
-## Rooms
+## Rooms ##
 Config options relating to rooms.
 
 ---
-### `encryption_enabled_by_default_for_room_type`
+### `encryption_enabled_by_default`
 
 Controls whether locally-created rooms should be end-to-end encrypted by
 default.
@@ -3425,7 +3422,7 @@ This option has the following sub-options:
     NB. If you set this to true, and the last time the user_directory search
     indexes were (re)built was before Synapse 1.44, you'll have to
     rebuild the indexes in order to search through all known users.
-
+    
     These indexes are built the first time Synapse starts; admins can
     manually trigger a rebuild via the API following the instructions
     [for running background updates](../administration/admin_api/background_updates.md#run),
@@ -3630,7 +3627,7 @@ default_power_level_content_override:
 ```
 
 ---
-## Opentracing
+## Opentracing ##
 Configuration options related to Opentracing support.
 
 ---
@@ -3673,78 +3670,14 @@ opentracing:
         false
 ```
 ---
-## Coordinating workers
-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.
-
-As a result, the worker configuration is divided into two parts.
-
-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.
-1. [The second part](#individual-worker-configuration)
-   controls the behaviour of individual workers in isolation.
-
-For guidance on setting up workers, see the [worker documentation](../../workers.md).
-
----
-### `worker_replication_secret`
-
-A shared secret used by the replication APIs on the main process to authenticate
-HTTP requests from workers.
-
-The default, this value is omitted (equivalently `null`), which means that
-traffic between the workers and the main process is not authenticated.
-
-Example configuration:
-```yaml
-worker_replication_secret: "secret_secret"
-```
----
-### `start_pushers`
-
-Unnecessary to set if using [`pusher_instances`](#pusher_instances) with [`generic_workers`](../../workers.md#synapseappgeneric_worker).
-
-Controls sending of push notifications on the main process. Set to `false`
-if using a [pusher worker](../../workers.md#synapseapppusher). Defaults to `true`.
-
-Example configuration:
-```yaml
-start_pushers: false
-```
----
-### `pusher_instances`
-
-It is possible to scale the processes that handle sending push notifications to [sygnal](https://github.com/matrix-org/sygnal)
-and email by running a [`generic_worker`](../../workers.md#synapseappgeneric_worker) and adding it's [`worker_name`](#worker_name) to
-a `pusher_instances` map. Doing so will remove handling of this function from the main
-process. Multiple workers can be added to this map, in which case the work is balanced
-across them. Ensure the main process and all pusher workers are restarted after changing
-this option.
-
-Example configuration for a single worker:
-```yaml
-pusher_instances:
-  - pusher_worker1
-```
-And for multiple workers:
-```yaml
-pusher_instances:
-  - pusher_worker1
-  - pusher_worker2
-```
+## Workers ##
+Configuration options related to workers.
 
 ---
 ### `send_federation`
 
-Unnecessary to set if using [`federation_sender_instances`](#federation_sender_instances) with [`generic_workers`](../../workers.md#synapseappgeneric_worker).
-
 Controls sending of outbound federation transactions on the main process.
-Set to `false` if using a [federation sender worker](../../workers.md#synapseappfederation_sender).
-Defaults to `true`.
+Set to false if using a federation sender worker. Defaults to true.
 
 Example configuration:
 ```yaml
@@ -3753,37 +3686,24 @@ send_federation: false
 ---
 ### `federation_sender_instances`
 
-It is possible to scale the processes that handle sending outbound federation requests
-by running a [`generic_worker`](../../workers.md#synapseappgeneric_worker) and adding it's [`worker_name`](#worker_name) to
-a `federation_sender_instances` map. Doing so will remove handling of this function from
-the main process. Multiple workers can be added to this map, in which case the work is
-balanced across them.
+It is possible to run multiple federation sender workers, in which case the
+work is balanced across them. Use this setting to list the senders.
 
-This configuration setting must be shared between all workers handling federation
-sending, and if changed all federation sender workers must be stopped at the same time
-and then started, to ensure that all instances are running with the same config (otherwise
+This configuration setting must be shared between all federation sender workers, and if
+changed all federation sender workers must be stopped at the same time and then
+started, to ensure that all instances are running with the same config (otherwise
 events may be dropped).
 
-Example configuration for a single worker:
+Example configuration:
 ```yaml
 federation_sender_instances:
   - federation_sender1
 ```
-And for multiple workers:
-```yaml
-federation_sender_instances:
-  - federation_sender1
-  - federation_sender2
-```
 ---
 ### `instance_map`
 
-When using workers this should be a map from [`worker_name`](#worker_name) to the
+When using workers this should be a map from worker name to the
 HTTP replication listener of the worker, if configured.
-Each worker declared under [`stream_writers`](../../workers.md#stream-writers) needs
-a HTTP replication listener, and that listener should be included in the `instance_map`.
-(The main process also needs an HTTP replication listener, but it should not be
-listed in the `instance_map`.)
 
 Example configuration:
 ```yaml
@@ -3796,11 +3716,8 @@ instance_map:
 ### `stream_writers`
 
 Experimental: When using workers you can define which workers should
-handle writing to streams such as event persistence and typing notifications.
-Any worker specified here must also be in the [`instance_map`](#instance_map).
-
-See the list of available streams in the
-[worker documentation](../../workers.md#stream-writers).
+handle event persistence and typing notifications. Any worker
+specified here must also be in the `instance_map`.
 
 Example configuration:
 ```yaml
@@ -3811,18 +3728,29 @@ stream_writers:
 ---
 ### `run_background_tasks_on`
 
-The [worker](../../workers.md#background-tasks) that is used to run
-background tasks (e.g. cleaning up expired data). If not provided this
-defaults to the main process.
+The worker that is used to run background tasks (e.g. cleaning up expired
+data). If not provided this defaults to the main process.
 
 Example configuration:
 ```yaml
 run_background_tasks_on: worker1
 ```
 ---
+### `worker_replication_secret`
+
+A shared secret used by the replication APIs to authenticate HTTP requests
+from workers.
+
+By default this is unused and traffic is not authenticated.
+
+Example configuration:
+```yaml
+worker_replication_secret: "secret_secret"
+```
 ### `redis`
 
-Configuration for Redis when using workers. This *must* be enabled when using workers.
+Configuration for Redis when using workers. This *must* be enabled when
+using workers (unless using old style direct TCP configuration).
 This setting has the following sub-options:
 * `enabled`: whether to use Redis support. Defaults to false.
 * `host` and `port`: Optional host and port to use to connect to redis. Defaults to
@@ -3837,143 +3765,7 @@ redis:
   port: 6379
   password: <secret_password>
 ```
----
-## Individual worker configuration
-These options configure an individual worker, in its worker configuration file.
-They should be not be provided when configuring the main process.
-
-Note also the configuration above for
-[coordinating a cluster of workers](#coordinating-workers).
-
-For guidance on setting up workers, see the [worker documentation](../../workers.md).
-
----
-### `worker_app`
-
-The type of worker. The currently available worker applications are listed
-in [worker documentation](../../workers.md#available-worker-applications).
-
-The most common worker is the
-[`synapse.app.generic_worker`](../../workers.md#synapseappgeneric_worker).
-
-Example configuration:
-```yaml
-worker_app: synapse.app.generic_worker
-```
----
-### `worker_name`
-
-A unique name for the worker. The worker needs a name to be addressed in
-further parameters and identification in log files. We strongly recommend
-giving each worker a unique `worker_name`.
-
-Example configuration:
-```yaml
-worker_name: generic_worker1
-```
----
-### `worker_replication_host`
-
-The HTTP replication endpoint that it should talk to on the main Synapse process.
-The main Synapse process defines this with a `replication` resource in
-[`listeners` option](#listeners).
-
-Example configuration:
-```yaml
-worker_replication_host: 127.0.0.1
-```
----
-### `worker_replication_http_port`
-
-The HTTP replication port that it should talk to on the main Synapse process.
-The main Synapse process defines this with a `replication` resource in
-[`listeners` option](#listeners).
-
-Example configuration:
-```yaml
-worker_replication_http_port: 9093
-```
----
-### `worker_replication_http_tls`
-
-Whether TLS should be used for talking to the HTTP replication port on the main
-Synapse process.
-The main Synapse process defines this with the `tls` option on its [listener](#listeners) that
-has the `replication` resource enabled.
-
-**Please note:** by default, it is not safe to expose replication ports to the
-public Internet, even with TLS enabled.
-See [`worker_replication_secret`](#worker_replication_secret).
-
-Defaults to `false`.
-
-*Added in Synapse 1.72.0.*
-
-Example configuration:
-```yaml
-worker_replication_http_tls: true
-```
----
-### `worker_listeners`
-
-A worker can handle HTTP requests. To do so, a `worker_listeners` option
-must be declared, in the same way as the [`listeners` option](#listeners)
-in the shared config.
-
-Workers declared in [`stream_writers`](#stream_writers) will need to include a
-`replication` listener here, in order to accept internal HTTP requests from
-other workers.
-
-Example configuration:
-```yaml
-worker_listeners:
-  - type: http
-    port: 8083
-    resources:
-      - names: [client, federation]
-```
----
-### `worker_daemonize`
-
-Specifies whether the worker should be started as a daemon process.
-If Synapse is being managed by [systemd](../../systemd-with-workers/README.md), this option
-must be omitted or set to `false`.
-
-Defaults to `false`.
-
-Example configuration:
-```yaml
-worker_daemonize: true
-```
----
-### `worker_pid_file`
-
-When running a worker as a daemon, we need a place to store the
-[PID](https://en.wikipedia.org/wiki/Process_identifier) of the worker.
-This option defines the location of that "pid file".
-
-This option is required if `worker_daemonize` is `true` and ignored
-otherwise. It has no default.
-
-See also the [`pid_file` option](#pid_file) option for the main Synapse process.
-
-Example configuration:
-```yaml
-worker_pid_file: DATADIR/generic_worker1.pid
-```
----
-### `worker_log_config`
-
-This option specifies a yaml python logging config file as described
-[here](https://docs.python.org/3/library/logging.config.html#configuration-dictionary-schema).
-See also the [`log_config` option](#log_config) option for the main Synapse process.
-
-Example configuration:
-```yaml
-worker_log_config: /etc/matrix-synapse/generic-worker-log.yaml
-```
----
-## Background Updates
+## Background Updates ##
 Configuration settings related to background updates.
 
 ---
@@ -4002,3 +3794,4 @@ background_updates:
     min_batch_size: 10
     default_batch_size: 50
 ```
+

docs/website_files/README.md

@@ -24,6 +24,11 @@ Finally, we also stylise the chapter titles in the left sidebar by indenting the
 slightly so that they are more visually distinguishable from the section headers
 (the bold titles). This is done through the `indent-section-headers.css` file.
 
+In addition to these modifications, we have added a version picker to the documentation.
+Users can switch between documentations for different versions of Synapse.
+This functionality was implemented through the `version-picker.js` and
+`version-picker.css` files.
+
 More information can be found in mdbook's official documentation for
 [injecting page JS/CSS](https://rust-lang.github.io/mdBook/format/config.html)
 and

docs/website_files/theme/index.hbs

@@ -131,6 +131,18 @@
                             <i class="fa fa-search"></i>
                         </button>
                         {{/if}}
+                        <div class="version-picker">
+                            <div class="dropdown">
+                                <div class="select">
+                                    <span></span>
+                                    <i class="fa fa-chevron-down"></i>
+                                </div>
+                                <input type="hidden" name="version">
+                                <ul class="dropdown-menu">
+                                    <!-- Versions will be added dynamically in version-picker.js -->
+                                </ul>
+                            </div>
+                        </div>      
                     </div>
 
                     <h1 class="menu-title">{{ book_title }}</h1>
@@ -309,4 +321,4 @@
         {{/if}}
 
     </body>
-</html>
+</html>

docs/website_files/version-picker.css

@@ -0,0 +1,78 @@
+.version-picker {
+    display: flex;
+    align-items: center;
+}
+
+.version-picker .dropdown {
+    width: 130px;
+    max-height: 29px;
+    margin-left: 10px;
+    display: inline-block;
+    border-radius: 4px;
+    border: 1px solid var(--theme-popup-border);
+    position: relative;
+    font-size: 13px;
+    color: var(--fg);
+    height: 100%;
+    text-align: left;
+}
+.version-picker .dropdown .select {
+    cursor: pointer;
+    display: block;
+    padding: 5px 2px 5px 15px;
+}
+.version-picker .dropdown .select > i {
+    font-size: 10px;
+    color: var(--fg);
+    cursor: pointer;
+    float: right;
+    line-height: 20px !important;
+}
+.version-picker .dropdown:hover {
+    border: 1px solid var(--theme-popup-border);
+}
+.version-picker .dropdown:active {
+    background-color: var(--theme-popup-bg);
+}
+.version-picker .dropdown.active:hover,
+.version-picker .dropdown.active {
+    border: 1px solid var(--theme-popup-border);
+    border-radius: 2px 2px 0 0;
+    background-color: var(--theme-popup-bg);
+}
+.version-picker .dropdown.active .select > i {
+    transform: rotate(-180deg);
+}
+.version-picker .dropdown .dropdown-menu {
+    position: absolute;
+    background-color: var(--theme-popup-bg);
+    width: 100%;
+    left: -1px;
+    right: 1px;
+    margin-top: 1px;
+    border: 1px solid var(--theme-popup-border);
+    border-radius: 0 0 4px 4px;
+    overflow: hidden;
+    display: none;
+    max-height: 300px;
+    overflow-y: auto;
+    z-index: 9;
+}
+.version-picker .dropdown .dropdown-menu li {
+    font-size: 12px;
+    padding: 6px 20px;
+    cursor: pointer;
+} 
+.version-picker .dropdown .dropdown-menu {
+    padding: 0;
+    list-style: none;
+}
+.version-picker .dropdown .dropdown-menu li:hover {
+    background-color: var(--theme-hover);
+}
+.version-picker .dropdown .dropdown-menu li.active::before {
+    display: inline-block;
+    content: "✓";
+    margin-inline-start: -14px;
+    width: 14px;
+}

docs/website_files/version-picker.js

@@ -0,0 +1,127 @@
+
+const dropdown = document.querySelector('.version-picker .dropdown');
+const dropdownMenu = dropdown.querySelector('.dropdown-menu');
+
+fetchVersions(dropdown, dropdownMenu).then(() => {
+    initializeVersionDropdown(dropdown, dropdownMenu);
+});
+
+/**
+ * Initialize the dropdown functionality for version selection.
+ * 
+ * @param {Element} dropdown - The dropdown element.
+ * @param {Element} dropdownMenu - The dropdown menu element.
+ */
+function initializeVersionDropdown(dropdown, dropdownMenu) {
+    // Toggle the dropdown menu on click
+    dropdown.addEventListener('click', function () {
+        this.setAttribute('tabindex', 1);
+        this.classList.toggle('active');
+        dropdownMenu.style.display = (dropdownMenu.style.display === 'block') ? 'none' : 'block';
+    });
+  
+    // Remove the 'active' class and hide the dropdown menu on focusout
+    dropdown.addEventListener('focusout', function () {
+        this.classList.remove('active');
+        dropdownMenu.style.display = 'none';
+    });
+  
+    // Handle item selection within the dropdown menu
+    const dropdownMenuItems = dropdownMenu.querySelectorAll('li');    
+    dropdownMenuItems.forEach(function (item) {
+        item.addEventListener('click', function () {
+            dropdownMenuItems.forEach(function (item) {
+                item.classList.remove('active');
+            });
+            this.classList.add('active');
+            dropdown.querySelector('span').textContent = this.textContent;
+            dropdown.querySelector('input').value = this.getAttribute('id');
+
+            window.location.href = changeVersion(window.location.href, this.textContent);
+        });
+    });
+};
+
+/**
+ * This function fetches the available versions from a GitHub repository
+ * and inserts them into the version picker.
+ * 
+ * @param {Element} dropdown - The dropdown element.
+ * @param {Element} dropdownMenu - The dropdown menu element.
+ * @returns {Promise<Array<string>>} A promise that resolves with an array of available versions.
+ */
+function fetchVersions(dropdown, dropdownMenu) {
+    return new Promise((resolve, reject) => {
+        window.addEventListener("load", () => {
+
+            fetch("https://api.github.com/repos/matrix-org/synapse/git/trees/gh-pages", {
+                cache: "force-cache",
+            }).then(res => 
+                res.json()
+            ).then(resObject => {
+                const excluded = ['dev-docs', 'v1.91.0', 'v1.80.0', 'v1.69.0'];
+                const tree = resObject.tree.filter(item => item.type === "tree" && !excluded.includes(item.path));
+                const versions = tree.map(item => item.path).sort(sortVersions);
+
+                // Create a list of <li> items for versions
+                versions.forEach((version) => {
+                    const li = document.createElement("li");
+                    li.textContent = version;
+                    li.id = version;
+    
+                    if (window.SYNAPSE_VERSION === version) {
+                        li.classList.add('active');
+                        dropdown.querySelector('span').textContent = version;
+                        dropdown.querySelector('input').value = version;
+                    }
+    
+                    dropdownMenu.appendChild(li);
+                });
+
+                resolve(versions);
+
+            }).catch(ex => {
+                console.error("Failed to fetch version data", ex);
+                reject(ex);
+            })
+        });
+    });
+}
+
+/**
+ * Custom sorting function to sort an array of version strings.
+ *
+ * @param {string} a - The first version string to compare.
+ * @param {string} b - The second version string to compare.
+ * @returns {number} - A negative number if a should come before b, a positive number if b should come before a, or 0 if they are equal.
+ */
+function sortVersions(a, b) {
+    // Put 'develop' and 'latest' at the top
+    if (a === 'develop' || a === 'latest') return -1;
+    if (b === 'develop' || b === 'latest') return 1;
+
+    const versionA = (a.match(/v\d+(\.\d+)+/) || [])[0];
+    const versionB = (b.match(/v\d+(\.\d+)+/) || [])[0];
+
+    return versionB.localeCompare(versionA);
+}
+
+/**
+ * Change the version in a URL path.
+ *
+ * @param {string} url - The original URL to be modified.
+ * @param {string} newVersion - The new version to replace the existing version in the URL.
+ * @returns {string} The updated URL with the new version.
+ */
+function changeVersion(url, newVersion) {
+    const parsedURL = new URL(url);
+    const pathSegments = parsedURL.pathname.split('/');
+  
+    // Modify the version
+    pathSegments[2] = newVersion;
+
+    // Reconstruct the URL
+    parsedURL.pathname = pathSegments.join('/');
+  
+    return parsedURL.href;
+}

docs/website_files/version.js

@@ -0,0 +1 @@
+window.SYNAPSE_VERSION = 'v1.70';

docs/workers.md

@@ -88,12 +88,10 @@ shared configuration file.
 ### Shared configuration
 
 Normally, only a couple of changes are needed to make an existing configuration
-file suitable for use with workers. First, you need to enable an
-["HTTP replication listener"](usage/configuration/config_documentation.md#listeners)
-for the main process; and secondly, you need to enable
-[redis-based replication](usage/configuration/config_documentation.md#redis).
-Optionally, a [shared secret](usage/configuration/config_documentation.md#worker_replication_secret)
-can be used to authenticate HTTP traffic between workers. For example:
+file suitable for use with workers. First, you need to enable an "HTTP replication
+listener" for the main process; and secondly, you need to enable redis-based
+replication. Optionally, a shared secret can be used to authenticate HTTP
+traffic between workers. For example:
 
 ```yaml
 # extend the existing `listeners` section. This defines the ports that the
@@ -113,30 +111,27 @@ redis:
     enabled: true
 ```
 
-See the [configuration manual](usage/configuration/config_documentation.md)
-for the full documentation of each option.
+See the [configuration manual](usage/configuration/config_documentation.html) for the full documentation of each option.
 
 Under **no circumstances** should the replication listener be exposed to the
 public internet; replication traffic is:
 
 * always unencrypted
-* unauthenticated, unless [`worker_replication_secret`](usage/configuration/config_documentation.md#worker_replication_secret)
-  is configured
+* unauthenticated, unless `worker_replication_secret` is configured
 
 
 ### Worker configuration
 
 In the config file for each worker, you must specify:
- * The type of worker ([`worker_app`](usage/configuration/config_documentation.md#worker_app)).
-   The currently available worker applications are listed [below](#available-worker-applications).
- * A unique name for the worker ([`worker_name`](usage/configuration/config_documentation.md#worker_name)).
+ * The type of worker (`worker_app`). The currently available worker applications are listed below.
+ * A unique name for the worker (`worker_name`).
  * The HTTP replication endpoint that it should talk to on the main synapse process
-   ([`worker_replication_host`](usage/configuration/config_documentation.md#worker_replication_host) and
-   [`worker_replication_http_port`](usage/configuration/config_documentation.md#worker_replication_http_port)).
- * If handling HTTP requests, a [`worker_listeners`](usage/configuration/config_documentation.md#worker_listeners) option
-   with an `http` listener.
- * **Synapse 1.72 and older:** if handling the `^/_matrix/client/v3/keys/upload` endpoint, the HTTP URI for
-   the main process (`worker_main_http_uri`). This config option is no longer required and is ignored when running Synapse 1.73 and newer.
+   (`worker_replication_host` and `worker_replication_http_port`)
+ * If handling HTTP requests, a `worker_listeners` option with an `http`
+   listener, in the same way as the [`listeners`](usage/configuration/config_documentation.md#listeners)
+   option in the shared config.
+ * If handling the `^/_matrix/client/v3/keys/upload` endpoint, the HTTP URI for
+   the main process (`worker_main_http_uri`).
 
 For example:
 
@@ -151,6 +146,7 @@ plain HTTP endpoint on port 8083 separately serving various endpoints, e.g.
 Obviously you should configure your reverse-proxy to route the relevant
 endpoints to the worker (`localhost:8083` in the above example).
 
+
 ### Running Synapse with workers
 
 Finally, you need to start your worker processes. This can be done with either
@@ -191,7 +187,6 @@ information.
     ^/_matrix/federation/(v1|v2)/send_leave/
     ^/_matrix/federation/(v1|v2)/invite/
     ^/_matrix/federation/v1/event_auth/
-    ^/_matrix/federation/v1/timestamp_to_event/
     ^/_matrix/federation/v1/exchange_third_party_invite/
     ^/_matrix/federation/v1/user/devices/
     ^/_matrix/key/v2/query
@@ -219,10 +214,10 @@ information.
     ^/_matrix/client/(api/v1|r0|v3|unstable)/voip/turnServer$
     ^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/event/
     ^/_matrix/client/(api/v1|r0|v3|unstable)/joined_rooms$
-    ^/_matrix/client/v1/rooms/.*/timestamp_to_event$
     ^/_matrix/client/(api/v1|r0|v3|unstable)/search$
 
     # Encryption requests
+    # Note that ^/_matrix/client/(r0|v3|unstable)/keys/upload/ requires `worker_main_http_uri`
     ^/_matrix/client/(r0|v3|unstable)/keys/query$
     ^/_matrix/client/(r0|v3|unstable)/keys/changes$
     ^/_matrix/client/(r0|v3|unstable)/keys/claim$
@@ -293,8 +288,7 @@ For multiple workers not handling the SSO endpoints properly, see
 [#9427](https://github.com/matrix-org/synapse/issues/9427).
 
 Note that a [HTTP listener](usage/configuration/config_documentation.md#listeners)
-with `client` and `federation` `resources` must be configured in the
-[`worker_listeners`](usage/configuration/config_documentation.md#worker_listeners)
+with `client` and `federation` `resources` must be configured in the `worker_listeners`
 option in the worker config.
 
 #### Load balancing
@@ -306,11 +300,9 @@ may wish to run multiple groups of workers handling different endpoints so that
 load balancing can be done in different ways.
 
 For `/sync` and `/initialSync` requests it will be more efficient if all
-requests from a particular user are routed to a single instance. This can
-be done e.g. in nginx via IP `hash $http_x_forwarded_for;` or via
-`hash $http_authorization consistent;` which contains the users access token.
-
-Admins may additionally wish to separate out `/sync`
+requests from a particular user are routed to a single instance. Extracting a
+user ID from the access token or `Authorization` header is currently left as an
+exercise for the reader. Admins may additionally wish to separate out `/sync`
 requests that have a `since` query parameter from those that don't (and
 `/initialSync`), as requests that don't are known as "initial sync" that happens
 when a user logs in on a new device and can be *very* resource intensive, so
@@ -339,10 +331,9 @@ of the main process to a particular worker.
 
 To enable this, the worker must have a
 [HTTP `replication` listener](usage/configuration/config_documentation.md#listeners) configured,
-have a [`worker_name`](usage/configuration/config_documentation.md#worker_name)
-and be listed in the [`instance_map`](usage/configuration/config_documentation.md#instance_map)
-config. The same worker can handle multiple streams, but unless otherwise documented,
-each stream can only have a single writer.
+have a `worker_name` and be listed in the `instance_map` config. The same worker
+can handle multiple streams, but unless otherwise documented, each stream can only
+have a single writer.
 
 For example, to move event persistence off to a dedicated worker, the shared
 configuration would include:
@@ -369,26 +360,9 @@ streams and the endpoints associated with them:
 
 ##### The `events` stream
 
-The `events` stream experimentally supports having multiple writer workers, where load
-is sharded between them by room ID. Each writer is called an _event persister_. They are
-responsible for
-- receiving new events,
-- linking them to those already in the room [DAG](development/room-dag-concepts.md),
-- persisting them to the DB, and finally
-- updating the events stream.
-
-Because load is sharded in this way, you *must* restart all worker instances when
-adding or removing event persisters.
-
-An `event_persister` should not be mistaken for an `event_creator`.
-An `event_creator` listens for requests from clients to create new events and does
-so. It will then pass those events over HTTP replication to any configured event
-persisters (or the main process if none are configured).
-
-Note that `event_creator`s and `event_persister`s are implemented using the same
-[`synapse.app.generic_worker`](#synapse.app.generic_worker).
-
-An example [`stream_writers`](usage/configuration/config_documentation.md#stream_writers)
+The `events` stream experimentally supports having multiple writers, where work
+is sharded between them by room ID. Note that you *must* restart all worker
+instances when adding or removing event persisters. An example `stream_writers`
 configuration with multiple writers:
 
 ```yaml
@@ -442,18 +416,16 @@ worker. Background tasks are run periodically or started via replication. Exactl
 which tasks are configured to run depends on your Synapse configuration (e.g. if
 stats is enabled). This worker doesn't handle any REST endpoints itself.
 
-To enable this, the worker must have a unique
-[`worker_name`](usage/configuration/config_documentation.md#worker_name)
-and can be configured to run background tasks. For example, to move background tasks
-to a dedicated worker, the shared configuration would include:
+To enable this, the worker must have a `worker_name` and can be configured to run
+background tasks. For example, to move background tasks to a dedicated worker,
+the shared configuration would include:
 
 ```yaml
 run_background_tasks_on: background_worker
 ```
 
-You might also wish to investigate the
-[`update_user_directory_from_worker`](#updating-the-user-directory) and
-[`media_instance_running_background_jobs`](#synapseappmedia_repository) settings.
+You might also wish to investigate the `update_user_directory_from_worker` and
+`media_instance_running_background_jobs` settings.
 
 An example for a dedicated background worker instance:
 
@@ -505,21 +477,14 @@ worker application type.
 
 ### `synapse.app.pusher`
 
-It is likely this option will be deprecated in the future and is not recommended for new
-installations. Instead, [use `synapse.app.generic_worker` with the `pusher_instances`](usage/configuration/config_documentation.md#pusher_instances).
-
 Handles sending push notifications to sygnal and email. Doesn't handle any
-REST endpoints itself, but you should set
-[`start_pushers: false`](usage/configuration/config_documentation.md#start_pushers) in the
+REST endpoints itself, but you should set `start_pushers: False` in the
 shared configuration file to stop the main synapse sending push notifications.
 
-To run multiple instances at once the
-[`pusher_instances`](usage/configuration/config_documentation.md#pusher_instances)
-option should list all pusher instances by their
-[`worker_name`](usage/configuration/config_documentation.md#worker_name), e.g.:
+To run multiple instances at once the `pusher_instances` option should list all
+pusher instances by their worker name, e.g.:
 
 ```yaml
-start_pushers: false
 pusher_instances:
     - pusher_worker1
     - pusher_worker2
@@ -546,24 +511,16 @@ Note this worker cannot be load-balanced: only one instance should be active.
 
 ### `synapse.app.federation_sender`
 
-It is likely this option will be deprecated in the future and not recommended for
-new installations. Instead, [use `synapse.app.generic_worker` with the `federation_sender_instances`](usage/configuration/config_documentation.md#federation_sender_instances). 
-
 Handles sending federation traffic to other servers. Doesn't handle any
-REST endpoints itself, but you should set
-[`send_federation: false`](usage/configuration/config_documentation.md#send_federation)
-in the shared configuration file to stop the main synapse sending this traffic.
+REST endpoints itself, but you should set `send_federation: False` in the
+shared configuration file to stop the main synapse sending this traffic.
 
 If running multiple federation senders then you must list each
-instance in the
-[`federation_sender_instances`](usage/configuration/config_documentation.md#federation_sender_instances)
-option by their
-[`worker_name`](usage/configuration/config_documentation.md#worker_name).
+instance in the `federation_sender_instances` option by their `worker_name`.
 All instances must be stopped and started when adding or removing instances.
 For example:
 
 ```yaml
-send_federation: false
 federation_sender_instances:
     - federation_sender1
     - federation_sender2
@@ -590,9 +547,7 @@ Handles the media repository. It can handle all endpoints starting with:
     ^/_synapse/admin/v1/quarantine_media/.*$
     ^/_synapse/admin/v1/users/.*/media$
 
-You should also set
-[`enable_media_repo: False`](usage/configuration/config_documentation.md#enable_media_repo)
-in the shared configuration
+You should also set `enable_media_repo: False` in the shared configuration
 file to stop the main synapse running background jobs related to managing the
 media repository. Note that doing so will prevent the main process from being
 able to handle the above endpoints.
@@ -645,9 +600,7 @@ equivalent to `synapse.app.generic_worker`:
  * `synapse.app.client_reader`
  * `synapse.app.event_creator`
  * `synapse.app.federation_reader`
- * `synapse.app.federation_sender`
  * `synapse.app.frontend_proxy`
- * `synapse.app.pusher`
  * `synapse.app.synchrotron`
 
 

mypy.ini

@@ -11,7 +11,6 @@ warn_unused_ignores = True
 local_partial_types = True
 no_implicit_optional = True
 disallow_untyped_defs = True
-strict_equality = True
 
 files =
   docker/,
@@ -57,8 +56,24 @@ exclude = (?x)
    |tests/rest/media/v1/test_media_storage.py
    |tests/server.py
    |tests/server_notices/test_resource_limits_server_notices.py
+   |tests/test_metrics.py
    |tests/test_state.py
    |tests/test_terms_auth.py
+   |tests/util/caches/test_cached_call.py
+   |tests/util/caches/test_deferred_cache.py
+   |tests/util/caches/test_descriptors.py
+   |tests/util/caches/test_response_cache.py
+   |tests/util/caches/test_ttlcache.py
+   |tests/util/test_async_helpers.py
+   |tests/util/test_batching_queue.py
+   |tests/util/test_dict_cache.py
+   |tests/util/test_expiring_cache.py
+   |tests/util/test_file_consumer.py
+   |tests/util/test_linearizer.py
+   |tests/util/test_logcontext.py
+   |tests/util/test_lrucache.py
+   |tests/util/test_rwlock.py
+   |tests/util/test_wheel_timer.py
    )$
 
 [mypy-synapse.federation.transport.client]
@@ -91,9 +106,6 @@ disallow_untyped_defs = False
 [mypy-tests.handlers.test_user_directory]
 disallow_untyped_defs = True
 
-[mypy-tests.metrics.test_background_process_metrics]
-disallow_untyped_defs = True
-
 [mypy-tests.push.test_bulk_push_rule_evaluator]
 disallow_untyped_defs = True
 
@@ -103,15 +115,9 @@ disallow_untyped_defs = True
 [mypy-tests.state.test_profile]
 disallow_untyped_defs = True
 
-[mypy-tests.storage.test_id_generators]
-disallow_untyped_defs = True
-
 [mypy-tests.storage.test_profile]
 disallow_untyped_defs = True
 
-[mypy-tests.handlers.test_sso]
-disallow_untyped_defs = True
-
 [mypy-tests.storage.test_user_directory]
 disallow_untyped_defs = True
 
@@ -121,18 +127,10 @@ disallow_untyped_defs = True
 [mypy-tests.federation.transport.test_client]
 disallow_untyped_defs = True
 
-[mypy-tests.util.caches.*]
-disallow_untyped_defs = True
-
-[mypy-tests.util.caches.test_descriptors]
-disallow_untyped_defs = False
-
-[mypy-tests.util.*]
-disallow_untyped_defs = True
-
 [mypy-tests.utils]
 disallow_untyped_defs = True
 
+
 ;; Dependencies without annotations
 ;; Before ignoring a module, check to see if type stubs are available.
 ;; The `typeshed` project maintains stubs here:

pyproject.toml

@@ -57,7 +57,7 @@ manifest-path = "rust/Cargo.toml"
 
 [tool.poetry]
 name = "matrix-synapse"
-version = "1.73.0rc2"
+version = "1.70.1"
 description = "Homeserver for the Matrix decentralised comms protocol"
 authors = ["Matrix.org Team and Contributors <packages@matrix.org>"]
 license = "Apache-2.0"
@@ -192,7 +192,7 @@ psycopg2 = { version = ">=2.8", markers = "platform_python_implementation != 'Py
 psycopg2cffi = { version = ">=2.8", markers = "platform_python_implementation == 'PyPy'", optional = true }
 psycopg2cffi-compat = { version = "==1.1", markers = "platform_python_implementation == 'PyPy'", optional = true }
 pysaml2 = { version = ">=4.5.0", optional = true }
-authlib = { version = ">=0.15.1", optional = true }
+authlib = { version = ">=0.14.0", optional = true }
 # systemd-python is necessary for logging to the systemd journal via
 # `systemd.journal.JournalHandler`, as is documented in
 # `contrib/systemd/log_config.yaml`.

rust/benches/evaluator.rs

@@ -33,12 +33,10 @@ fn bench_match_exact(b: &mut Bencher) {
     let eval = PushRuleEvaluator::py_new(
         flattened_keys,
         10,
-        Some(0),
+        0,
         Default::default(),
         Default::default(),
         true,
-        vec![],
-        false,
     )
     .unwrap();
 
@@ -69,12 +67,10 @@ fn bench_match_word(b: &mut Bencher) {
     let eval = PushRuleEvaluator::py_new(
         flattened_keys,
         10,
-        Some(0),
+        0,
         Default::default(),
         Default::default(),
         true,
-        vec![],
-        false,
     )
     .unwrap();
 
@@ -105,12 +101,10 @@ fn bench_match_word_miss(b: &mut Bencher) {
     let eval = PushRuleEvaluator::py_new(
         flattened_keys,
         10,
-        Some(0),
+        0,
         Default::default(),
         Default::default(),
         true,
-        vec![],
-        false,
     )
     .unwrap();
 
@@ -141,12 +135,10 @@ fn bench_eval_message(b: &mut Bencher) {
     let eval = PushRuleEvaluator::py_new(
         flattened_keys,
         10,
-        Some(0),
+        0,
         Default::default(),
         Default::default(),
         true,
-        vec![],
-        false,
     )
     .unwrap();
 

rust/benches/tree_cache.rs

@@ -1,77 +0,0 @@
-// Copyright 2022 The Matrix.org Foundation C.I.C.
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-#![feature(test)]
-
-use synapse::tree_cache::TreeCache;
-use test::Bencher;
-
-extern crate test;
-
-#[bench]
-fn bench_tree_cache_get_non_empty(b: &mut Bencher) {
-    let mut cache: TreeCache<&str, &str> = TreeCache::new();
-
-    cache.set(["a", "b", "c", "d"], "f").unwrap();
-
-    b.iter(|| cache.get(&["a", "b", "c", "d"]));
-}
-
-#[bench]
-fn bench_tree_cache_get_empty(b: &mut Bencher) {
-    let cache: TreeCache<&str, &str> = TreeCache::new();
-
-    b.iter(|| cache.get(&["a", "b", "c", "d"]));
-}
-
-#[bench]
-fn bench_tree_cache_set(b: &mut Bencher) {
-    let mut cache: TreeCache<&str, &str> = TreeCache::new();
-
-    b.iter(|| cache.set(["a", "b", "c", "d"], "f").unwrap());
-}
-
-#[bench]
-fn bench_tree_cache_length(b: &mut Bencher) {
-    let mut cache: TreeCache<u32, u32> = TreeCache::new();
-
-    for c1 in 0..=10 {
-        for c2 in 0..=10 {
-            for c3 in 0..=10 {
-                for c4 in 0..=10 {
-                    cache.set([c1, c2, c3, c4], 1).unwrap()
-                }
-            }
-        }
-    }
-
-    b.iter(|| cache.len());
-}
-
-#[bench]
-fn tree_cache_iterate(b: &mut Bencher) {
-    let mut cache: TreeCache<u32, u32> = TreeCache::new();
-
-    for c1 in 0..=10 {
-        for c2 in 0..=10 {
-            for c3 in 0..=10 {
-                for c4 in 0..=10 {
-                    cache.set([c1, c2, c3, c4], 1).unwrap()
-                }
-            }
-        }
-    }
-
-    b.iter(|| cache.items().count());
-}

rust/src/lib.rs

@@ -1,7 +1,6 @@
 use pyo3::prelude::*;
 
 pub mod push;
-pub mod tree_cache;
 
 /// Returns the hash of all the rust source files at the time it was compiled.
 ///
@@ -27,7 +26,6 @@ fn synapse_rust(py: Python<'_>, m: &PyModule) -> PyResult<()> {
     m.add_function(wrap_pyfunction!(get_rust_file_digest, m)?)?;
 
     push::register_module(py, m)?;
-    tree_cache::binding::register_module(py, m)?;
 
     Ok(())
 }

rust/src/push/base_rules.rs

@@ -25,7 +25,6 @@ use crate::push::Action;
 use crate::push::Condition;
 use crate::push::EventMatchCondition;
 use crate::push::PushRule;
-use crate::push::RelatedEventMatchCondition;
 use crate::push::SetTweak;
 use crate::push::TweakValue;
 
@@ -115,22 +114,6 @@ pub const BASE_APPEND_OVERRIDE_RULES: &[PushRule] = &[
         default: true,
         default_enabled: true,
     },
-    PushRule {
-        rule_id: Cow::Borrowed("global/override/.im.nheko.msc3664.reply"),
-        priority_class: 5,
-        conditions: Cow::Borrowed(&[Condition::Known(KnownCondition::RelatedEventMatch(
-            RelatedEventMatchCondition {
-                key: Some(Cow::Borrowed("sender")),
-                pattern: None,
-                pattern_type: Some(Cow::Borrowed("user_id")),
-                rel_type: Cow::Borrowed("m.in_reply_to"),
-                include_fallbacks: None,
-            },
-        ))]),
-        actions: Cow::Borrowed(&[Action::Notify, HIGHLIGHT_ACTION, SOUND_ACTION]),
-        default: true,
-        default_enabled: true,
-    },
     PushRule {
         rule_id: Cow::Borrowed("global/override/.m.rule.contains_display_name"),
         priority_class: 5,
@@ -274,156 +257,6 @@ pub const BASE_APPEND_UNDERRIDE_RULES: &[PushRule] = &[
         default: true,
         default_enabled: true,
     },
-    PushRule {
-        rule_id: Cow::Borrowed(
-            "global/underride/.org.matrix.msc3933.rule.extensible.encrypted_room_one_to_one",
-        ),
-        priority_class: 1,
-        conditions: Cow::Borrowed(&[
-            Condition::Known(KnownCondition::EventMatch(EventMatchCondition {
-                key: Cow::Borrowed("type"),
-                // MSC3933: Type changed from template rule - see MSC.
-                pattern: Some(Cow::Borrowed("org.matrix.msc1767.encrypted")),
-                pattern_type: None,
-            })),
-            Condition::Known(KnownCondition::RoomMemberCount {
-                is: Some(Cow::Borrowed("2")),
-            }),
-            // MSC3933: Add condition on top of template rule - see MSC.
-            Condition::Known(KnownCondition::RoomVersionSupports {
-                // RoomVersionFeatures::ExtensibleEvents.as_str(), ideally
-                feature: Cow::Borrowed("org.matrix.msc3932.extensible_events"),
-            }),
-        ]),
-        actions: Cow::Borrowed(&[Action::Notify, SOUND_ACTION, HIGHLIGHT_FALSE_ACTION]),
-        default: true,
-        default_enabled: true,
-    },
-    PushRule {
-        rule_id: Cow::Borrowed(
-            "global/underride/.org.matrix.msc3933.rule.extensible.message.room_one_to_one",
-        ),
-        priority_class: 1,
-        conditions: Cow::Borrowed(&[
-            Condition::Known(KnownCondition::EventMatch(EventMatchCondition {
-                key: Cow::Borrowed("type"),
-                // MSC3933: Type changed from template rule - see MSC.
-                pattern: Some(Cow::Borrowed("org.matrix.msc1767.message")),
-                pattern_type: None,
-            })),
-            Condition::Known(KnownCondition::RoomMemberCount {
-                is: Some(Cow::Borrowed("2")),
-            }),
-            // MSC3933: Add condition on top of template rule - see MSC.
-            Condition::Known(KnownCondition::RoomVersionSupports {
-                // RoomVersionFeatures::ExtensibleEvents.as_str(), ideally
-                feature: Cow::Borrowed("org.matrix.msc3932.extensible_events"),
-            }),
-        ]),
-        actions: Cow::Borrowed(&[Action::Notify, SOUND_ACTION, HIGHLIGHT_FALSE_ACTION]),
-        default: true,
-        default_enabled: true,
-    },
-    PushRule {
-        rule_id: Cow::Borrowed(
-            "global/underride/.org.matrix.msc3933.rule.extensible.file.room_one_to_one",
-        ),
-        priority_class: 1,
-        conditions: Cow::Borrowed(&[
-            Condition::Known(KnownCondition::EventMatch(EventMatchCondition {
-                key: Cow::Borrowed("type"),
-                // MSC3933: Type changed from template rule - see MSC.
-                pattern: Some(Cow::Borrowed("org.matrix.msc1767.file")),
-                pattern_type: None,
-            })),
-            Condition::Known(KnownCondition::RoomMemberCount {
-                is: Some(Cow::Borrowed("2")),
-            }),
-            // MSC3933: Add condition on top of template rule - see MSC.
-            Condition::Known(KnownCondition::RoomVersionSupports {
-                // RoomVersionFeatures::ExtensibleEvents.as_str(), ideally
-                feature: Cow::Borrowed("org.matrix.msc3932.extensible_events"),
-            }),
-        ]),
-        actions: Cow::Borrowed(&[Action::Notify, SOUND_ACTION, HIGHLIGHT_FALSE_ACTION]),
-        default: true,
-        default_enabled: true,
-    },
-    PushRule {
-        rule_id: Cow::Borrowed(
-            "global/underride/.org.matrix.msc3933.rule.extensible.image.room_one_to_one",
-        ),
-        priority_class: 1,
-        conditions: Cow::Borrowed(&[
-            Condition::Known(KnownCondition::EventMatch(EventMatchCondition {
-                key: Cow::Borrowed("type"),
-                // MSC3933: Type changed from template rule - see MSC.
-                pattern: Some(Cow::Borrowed("org.matrix.msc1767.image")),
-                pattern_type: None,
-            })),
-            Condition::Known(KnownCondition::RoomMemberCount {
-                is: Some(Cow::Borrowed("2")),
-            }),
-            // MSC3933: Add condition on top of template rule - see MSC.
-            Condition::Known(KnownCondition::RoomVersionSupports {
-                // RoomVersionFeatures::ExtensibleEvents.as_str(), ideally
-                feature: Cow::Borrowed("org.matrix.msc3932.extensible_events"),
-            }),
-        ]),
-        actions: Cow::Borrowed(&[Action::Notify, SOUND_ACTION, HIGHLIGHT_FALSE_ACTION]),
-        default: true,
-        default_enabled: true,
-    },
-    PushRule {
-        rule_id: Cow::Borrowed(
-            "global/underride/.org.matrix.msc3933.rule.extensible.video.room_one_to_one",
-        ),
-        priority_class: 1,
-        conditions: Cow::Borrowed(&[
-            Condition::Known(KnownCondition::EventMatch(EventMatchCondition {
-                key: Cow::Borrowed("type"),
-                // MSC3933: Type changed from template rule - see MSC.
-                pattern: Some(Cow::Borrowed("org.matrix.msc1767.video")),
-                pattern_type: None,
-            })),
-            Condition::Known(KnownCondition::RoomMemberCount {
-                is: Some(Cow::Borrowed("2")),
-            }),
-            // MSC3933: Add condition on top of template rule - see MSC.
-            Condition::Known(KnownCondition::RoomVersionSupports {
-                // RoomVersionFeatures::ExtensibleEvents.as_str(), ideally
-                feature: Cow::Borrowed("org.matrix.msc3932.extensible_events"),
-            }),
-        ]),
-        actions: Cow::Borrowed(&[Action::Notify, SOUND_ACTION, HIGHLIGHT_FALSE_ACTION]),
-        default: true,
-        default_enabled: true,
-    },
-    PushRule {
-        rule_id: Cow::Borrowed(
-            "global/underride/.org.matrix.msc3933.rule.extensible.audio.room_one_to_one",
-        ),
-        priority_class: 1,
-        conditions: Cow::Borrowed(&[
-            Condition::Known(KnownCondition::EventMatch(EventMatchCondition {
-                key: Cow::Borrowed("type"),
-                // MSC3933: Type changed from template rule - see MSC.
-                pattern: Some(Cow::Borrowed("org.matrix.msc1767.audio")),
-                pattern_type: None,
-            })),
-            Condition::Known(KnownCondition::RoomMemberCount {
-                is: Some(Cow::Borrowed("2")),
-            }),
-            // MSC3933: Add condition on top of template rule - see MSC.
-            Condition::Known(KnownCondition::RoomVersionSupports {
-                // RoomVersionFeatures::ExtensibleEvents.as_str(), ideally
-                feature: Cow::Borrowed("org.matrix.msc3932.extensible_events"),
-            }),
-        ]),
-        actions: Cow::Borrowed(&[Action::Notify, SOUND_ACTION, HIGHLIGHT_FALSE_ACTION]),
-        default: true,
-        default_enabled: true,
-    },
     PushRule {
         rule_id: Cow::Borrowed("global/underride/.m.rule.message"),
         priority_class: 1,
@@ -452,126 +285,6 @@ pub const BASE_APPEND_UNDERRIDE_RULES: &[PushRule] = &[
         default: true,
         default_enabled: true,
     },
-    PushRule {
-        rule_id: Cow::Borrowed("global/underride/.org.matrix.msc1767.rule.extensible.encrypted"),
-        priority_class: 1,
-        conditions: Cow::Borrowed(&[
-            Condition::Known(KnownCondition::EventMatch(EventMatchCondition {
-                key: Cow::Borrowed("type"),
-                // MSC3933: Type changed from template rule - see MSC.
-                pattern: Some(Cow::Borrowed("m.encrypted")),
-                pattern_type: None,
-            })),
-            // MSC3933: Add condition on top of template rule - see MSC.
-            Condition::Known(KnownCondition::RoomVersionSupports {
-                // RoomVersionFeatures::ExtensibleEvents.as_str(), ideally
-                feature: Cow::Borrowed("org.matrix.msc3932.extensible_events"),
-            }),
-        ]),
-        actions: Cow::Borrowed(&[Action::Notify, HIGHLIGHT_FALSE_ACTION]),
-        default: true,
-        default_enabled: true,
-    },
-    PushRule {
-        rule_id: Cow::Borrowed("global/underride/.org.matrix.msc1767.rule.extensible.message"),
-        priority_class: 1,
-        conditions: Cow::Borrowed(&[
-            Condition::Known(KnownCondition::EventMatch(EventMatchCondition {
-                key: Cow::Borrowed("type"),
-                // MSC3933: Type changed from template rule - see MSC.
-                pattern: Some(Cow::Borrowed("m.message")),
-                pattern_type: None,
-            })),
-            // MSC3933: Add condition on top of template rule - see MSC.
-            Condition::Known(KnownCondition::RoomVersionSupports {
-                // RoomVersionFeatures::ExtensibleEvents.as_str(), ideally
-                feature: Cow::Borrowed("org.matrix.msc3932.extensible_events"),
-            }),
-        ]),
-        actions: Cow::Borrowed(&[Action::Notify, HIGHLIGHT_FALSE_ACTION]),
-        default: true,
-        default_enabled: true,
-    },
-    PushRule {
-        rule_id: Cow::Borrowed("global/underride/.org.matrix.msc1767.rule.extensible.file"),
-        priority_class: 1,
-        conditions: Cow::Borrowed(&[
-            Condition::Known(KnownCondition::EventMatch(EventMatchCondition {
-                key: Cow::Borrowed("type"),
-                // MSC3933: Type changed from template rule - see MSC.
-                pattern: Some(Cow::Borrowed("m.file")),
-                pattern_type: None,
-            })),
-            // MSC3933: Add condition on top of template rule - see MSC.
-            Condition::Known(KnownCondition::RoomVersionSupports {
-                // RoomVersionFeatures::ExtensibleEvents.as_str(), ideally
-                feature: Cow::Borrowed("org.matrix.msc3932.extensible_events"),
-            }),
-        ]),
-        actions: Cow::Borrowed(&[Action::Notify, HIGHLIGHT_FALSE_ACTION]),
-        default: true,
-        default_enabled: true,
-    },
-    PushRule {
-        rule_id: Cow::Borrowed("global/underride/.org.matrix.msc1767.rule.extensible.image"),
-        priority_class: 1,
-        conditions: Cow::Borrowed(&[
-            Condition::Known(KnownCondition::EventMatch(EventMatchCondition {
-                key: Cow::Borrowed("type"),
-                // MSC3933: Type changed from template rule - see MSC.
-                pattern: Some(Cow::Borrowed("m.image")),
-                pattern_type: None,
-            })),
-            // MSC3933: Add condition on top of template rule - see MSC.
-            Condition::Known(KnownCondition::RoomVersionSupports {
-                // RoomVersionFeatures::ExtensibleEvents.as_str(), ideally
-                feature: Cow::Borrowed("org.matrix.msc3932.extensible_events"),
-            }),
-        ]),
-        actions: Cow::Borrowed(&[Action::Notify, HIGHLIGHT_FALSE_ACTION]),
-        default: true,
-        default_enabled: true,
-    },
-    PushRule {
-        rule_id: Cow::Borrowed("global/underride/.org.matrix.msc1767.rule.extensible.video"),
-        priority_class: 1,
-        conditions: Cow::Borrowed(&[
-            Condition::Known(KnownCondition::EventMatch(EventMatchCondition {
-                key: Cow::Borrowed("type"),
-                // MSC3933: Type changed from template rule - see MSC.
-                pattern: Some(Cow::Borrowed("m.video")),
-                pattern_type: None,
-            })),
-            // MSC3933: Add condition on top of template rule - see MSC.
-            Condition::Known(KnownCondition::RoomVersionSupports {
-                // RoomVersionFeatures::ExtensibleEvents.as_str(), ideally
-                feature: Cow::Borrowed("org.matrix.msc3932.extensible_events"),
-            }),
-        ]),
-        actions: Cow::Borrowed(&[Action::Notify, HIGHLIGHT_FALSE_ACTION]),
-        default: true,
-        default_enabled: true,
-    },
-    PushRule {
-        rule_id: Cow::Borrowed("global/underride/.org.matrix.msc1767.rule.extensible.audio"),
-        priority_class: 1,
-        conditions: Cow::Borrowed(&[
-            Condition::Known(KnownCondition::EventMatch(EventMatchCondition {
-                key: Cow::Borrowed("type"),
-                // MSC3933: Type changed from template rule - see MSC.
-                pattern: Some(Cow::Borrowed("m.audio")),
-                pattern_type: None,
-            })),
-            // MSC3933: Add condition on top of template rule - see MSC.
-            Condition::Known(KnownCondition::RoomVersionSupports {
-                // RoomVersionFeatures::ExtensibleEvents.as_str(), ideally
-                feature: Cow::Borrowed("org.matrix.msc3932.extensible_events"),
-            }),
-        ]),
-        actions: Cow::Borrowed(&[Action::Notify, HIGHLIGHT_FALSE_ACTION]),
-        default: true,
-        default_enabled: true,
-    },
     PushRule {
         rule_id: Cow::Borrowed("global/underride/.im.vector.jitsi"),
         priority_class: 1,

rust/src/push/evaluator.rs

@@ -23,39 +23,11 @@ use regex::Regex;
 use super::{
     utils::{get_glob_matcher, get_localpart_from_id, GlobMatchType},
     Action, Condition, EventMatchCondition, FilteredPushRules, KnownCondition,
-    RelatedEventMatchCondition,
 };
 
 lazy_static! {
     /// Used to parse the `is` clause in the room member count condition.
     static ref INEQUALITY_EXPR: Regex = Regex::new(r"^([=<>]*)([0-9]+)$").expect("valid regex");
-
-    /// Used to determine which MSC3931 room version feature flags are actually known to
-    /// the push evaluator.
-    static ref KNOWN_RVER_FLAGS: Vec<String> = vec![
-        RoomVersionFeatures::ExtensibleEvents.as_str().to_string(),
-    ];
-
-    /// The "safe" rule IDs which are not affected by MSC3932's behaviour (room versions which
-    /// declare Extensible Events support ultimately *disable* push rules which do not declare
-    /// *any* MSC3931 room_version_supports condition).
-    static ref SAFE_EXTENSIBLE_EVENTS_RULE_IDS: Vec<String> = vec![
-        "global/override/.m.rule.master".to_string(),
-        "global/override/.m.rule.roomnotif".to_string(),
-        "global/content/.m.rule.contains_user_name".to_string(),
-    ];
-}
-
-enum RoomVersionFeatures {
-    ExtensibleEvents,
-}
-
-impl RoomVersionFeatures {
-    fn as_str(&self) -> &'static str {
-        match self {
-            RoomVersionFeatures::ExtensibleEvents => "org.matrix.msc3932.extensible_events",
-        }
-    }
 }
 
 /// Allows running a set of push rules against a particular event.
@@ -77,36 +49,17 @@ pub struct PushRuleEvaluator {
     /// The power level of the sender of the event, or None if event is an
     /// outlier.
     sender_power_level: Option<i64>,
-
-    /// The related events, indexed by relation type. Flattened in the same manner as
-    /// `flattened_keys`.
-    related_events_flattened: BTreeMap<String, BTreeMap<String, String>>,
-
-    /// If msc3664, push rules for related events, is enabled.
-    related_event_match_enabled: bool,
-
-    /// If MSC3931 is applicable, the feature flags for the room version.
-    room_version_feature_flags: Vec<String>,
-
-    /// If MSC3931 (room version feature flags) is enabled. Usually controlled by the same
-    /// flag as MSC1767 (extensible events core).
-    msc3931_enabled: bool,
 }
 
 #[pymethods]
 impl PushRuleEvaluator {
     /// Create a new `PushRuleEvaluator`. See struct docstring for details.
-    #[allow(clippy::too_many_arguments)]
     #[new]
     pub fn py_new(
         flattened_keys: BTreeMap<String, String>,
         room_member_count: u64,
         sender_power_level: Option<i64>,
         notification_power_levels: BTreeMap<String, i64>,
-        related_events_flattened: BTreeMap<String, BTreeMap<String, String>>,
-        related_event_match_enabled: bool,
-        room_version_feature_flags: Vec<String>,
-        msc3931_enabled: bool,
     ) -> Result<Self, Error> {
         let body = flattened_keys
             .get("content.body")
@@ -119,10 +72,6 @@ impl PushRuleEvaluator {
             room_member_count,
             notification_power_levels,
             sender_power_level,
-            related_events_flattened,
-            related_event_match_enabled,
-            room_version_feature_flags,
-            msc3931_enabled,
         })
     }
 
@@ -145,19 +94,7 @@ impl PushRuleEvaluator {
                 continue;
             }
 
-            let rule_id = &push_rule.rule_id().to_string();
-            let extev_flag = &RoomVersionFeatures::ExtensibleEvents.as_str().to_string();
-            let supports_extensible_events = self.room_version_feature_flags.contains(extev_flag);
-            let safe_from_rver_condition = SAFE_EXTENSIBLE_EVENTS_RULE_IDS.contains(rule_id);
-            let mut has_rver_condition = false;
-
             for condition in push_rule.conditions.iter() {
-                has_rver_condition |= matches!(
-                    condition,
-                    // per MSC3932, we just need *any* room version condition to match
-                    Condition::Known(KnownCondition::RoomVersionSupports { feature: _ }),
-                );
-
                 match self.match_condition(condition, user_id, display_name) {
                     Ok(true) => {}
                     Ok(false) => continue 'outer,
@@ -168,13 +105,6 @@ impl PushRuleEvaluator {
                 }
             }
 
-            // MSC3932: Disable push rules in extensible event-supporting room versions if they
-            // don't describe *any* MSC3931 room version condition, unless the rule is on the
-            // safe list.
-            if !has_rver_condition && !safe_from_rver_condition && supports_extensible_events {
-                continue;
-            }
-
             let actions = push_rule
                 .actions
                 .iter()
@@ -226,9 +156,6 @@ impl PushRuleEvaluator {
             KnownCondition::EventMatch(event_match) => {
                 self.match_event_match(event_match, user_id)?
             }
-            KnownCondition::RelatedEventMatch(event_match) => {
-                self.match_related_event_match(event_match, user_id)?
-            }
             KnownCondition::ContainsDisplayName => {
                 if let Some(dn) = display_name {
                     if !dn.is_empty() {
@@ -262,15 +189,6 @@ impl PushRuleEvaluator {
                     false
                 }
             }
-            KnownCondition::RoomVersionSupports { feature } => {
-                if !self.msc3931_enabled {
-                    false
-                } else {
-                    let flag = feature.to_string();
-                    KNOWN_RVER_FLAGS.contains(&flag)
-                        && self.room_version_feature_flags.contains(&flag)
-                }
-            }
         };
 
         Ok(result)
@@ -321,79 +239,6 @@ impl PushRuleEvaluator {
         compiled_pattern.is_match(haystack)
     }
 
-    /// Evaluates a `related_event_match` condition. (MSC3664)
-    fn match_related_event_match(
-        &self,
-        event_match: &RelatedEventMatchCondition,
-        user_id: Option<&str>,
-    ) -> Result<bool, Error> {
-        // First check if related event matching is enabled...
-        if !self.related_event_match_enabled {
-            return Ok(false);
-        }
-
-        // get the related event, fail if there is none.
-        let event = if let Some(event) = self.related_events_flattened.get(&*event_match.rel_type) {
-            event
-        } else {
-            return Ok(false);
-        };
-
-        // If we are not matching fallbacks, don't match if our special key indicating this is a
-        // fallback relation is not present.
-        if !event_match.include_fallbacks.unwrap_or(false)
-            && event.contains_key("im.vector.is_falling_back")
-        {
-            return Ok(false);
-        }
-
-        // if we have no key, accept the event as matching, if it existed without matching any
-        // fields.
-        let key = if let Some(key) = &event_match.key {
-            key
-        } else {
-            return Ok(true);
-        };
-
-        let pattern = if let Some(pattern) = &event_match.pattern {
-            pattern
-        } else if let Some(pattern_type) = &event_match.pattern_type {
-            // The `pattern_type` can either be "user_id" or "user_localpart",
-            // either way if we don't have a `user_id` then the condition can't
-            // match.
-            let user_id = if let Some(user_id) = user_id {
-                user_id
-            } else {
-                return Ok(false);
-            };
-
-            match &**pattern_type {
-                "user_id" => user_id,
-                "user_localpart" => get_localpart_from_id(user_id)?,
-                _ => return Ok(false),
-            }
-        } else {
-            return Ok(false);
-        };
-
-        let haystack = if let Some(haystack) = event.get(&**key) {
-            haystack
-        } else {
-            return Ok(false);
-        };
-
-        // For the content.body we match against "words", but for everything
-        // else we match against the entire value.
-        let match_type = if key == "content.body" {
-            GlobMatchType::Word
-        } else {
-            GlobMatchType::Whole
-        };
-
-        let mut compiled_pattern = get_glob_matcher(pattern, match_type)?;
-        compiled_pattern.is_match(haystack)
-    }
-
     /// Match the member count against an 'is' condition
     /// The `is` condition can be things like '>2', '==3' or even just '4'.
     fn match_member_count(&self, is: &str) -> Result<bool, Error> {
@@ -422,70 +267,9 @@ impl PushRuleEvaluator {
 fn push_rule_evaluator() {
     let mut flattened_keys = BTreeMap::new();
     flattened_keys.insert("content.body".to_string(), "foo bar bob hello".to_string());
-    let evaluator = PushRuleEvaluator::py_new(
-        flattened_keys,
-        10,
-        Some(0),
-        BTreeMap::new(),
-        BTreeMap::new(),
-        true,
-        vec![],
-        true,
-    )
-    .unwrap();
+    let evaluator =
+        PushRuleEvaluator::py_new(flattened_keys, 10, Some(0), BTreeMap::new()).unwrap();
 
     let result = evaluator.run(&FilteredPushRules::default(), None, Some("bob"));
     assert_eq!(result.len(), 3);
 }
-
-#[test]
-fn test_requires_room_version_supports_condition() {
-    use std::borrow::Cow;
-
-    use crate::push::{PushRule, PushRules};
-
-    let mut flattened_keys = BTreeMap::new();
-    flattened_keys.insert("content.body".to_string(), "foo bar bob hello".to_string());
-    let flags = vec![RoomVersionFeatures::ExtensibleEvents.as_str().to_string()];
-    let evaluator = PushRuleEvaluator::py_new(
-        flattened_keys,
-        10,
-        Some(0),
-        BTreeMap::new(),
-        BTreeMap::new(),
-        false,
-        flags,
-        true,
-    )
-    .unwrap();
-
-    // first test: are the master and contains_user_name rules excluded from the "requires room
-    // version condition" check?
-    let mut result = evaluator.run(
-        &FilteredPushRules::default(),
-        Some("@bob:example.org"),
-        None,
-    );
-    assert_eq!(result.len(), 3);
-
-    // second test: if an appropriate push rule is in play, does it get handled?
-    let custom_rule = PushRule {
-        rule_id: Cow::from("global/underride/.org.example.extensible"),
-        priority_class: 1, // underride
-        conditions: Cow::from(vec![Condition::Known(
-            KnownCondition::RoomVersionSupports {
-                feature: Cow::from(RoomVersionFeatures::ExtensibleEvents.as_str().to_string()),
-            },
-        )]),
-        actions: Cow::from(vec![Action::Notify]),
-        default: false,
-        default_enabled: true,
-    };
-    let rules = PushRules::new(vec![custom_rule]);
-    result = evaluator.run(
-        &FilteredPushRules::py_new(rules, BTreeMap::new(), true, true),
-        None,
-        None,
-    );
-    assert_eq!(result.len(), 1);
-}

rust/src/push/mod.rs

@@ -267,8 +267,6 @@ pub enum Condition {
 #[serde(tag = "kind")]
 pub enum KnownCondition {
     EventMatch(EventMatchCondition),
-    #[serde(rename = "im.nheko.msc3664.related_event_match")]
-    RelatedEventMatch(RelatedEventMatchCondition),
     ContainsDisplayName,
     RoomMemberCount {
         #[serde(skip_serializing_if = "Option::is_none")]
@@ -277,10 +275,6 @@ pub enum KnownCondition {
     SenderNotificationPermission {
         key: Cow<'static, str>,
     },
-    #[serde(rename = "org.matrix.msc3931.room_version_supports")]
-    RoomVersionSupports {
-        feature: Cow<'static, str>,
-    },
 }
 
 impl IntoPy<PyObject> for Condition {
@@ -305,20 +299,6 @@ pub struct EventMatchCondition {
     pub pattern_type: Option<Cow<'static, str>>,
 }
 
-/// The body of a [`Condition::RelatedEventMatch`]
-#[derive(Serialize, Deserialize, Debug, Clone)]
-pub struct RelatedEventMatchCondition {
-    #[serde(skip_serializing_if = "Option::is_none")]
-    pub key: Option<Cow<'static, str>>,
-    #[serde(skip_serializing_if = "Option::is_none")]
-    pub pattern: Option<Cow<'static, str>>,
-    #[serde(skip_serializing_if = "Option::is_none")]
-    pub pattern_type: Option<Cow<'static, str>>,
-    pub rel_type: Cow<'static, str>,
-    #[serde(skip_serializing_if = "Option::is_none")]
-    pub include_fallbacks: Option<bool>,
-}
-
 /// The collection of push rules for a user.
 #[derive(Debug, Clone, Default)]
 #[pyclass(frozen)]
@@ -411,24 +391,15 @@ impl PushRules {
 pub struct FilteredPushRules {
     push_rules: PushRules,
     enabled_map: BTreeMap<String, bool>,
-    msc3664_enabled: bool,
-    msc1767_enabled: bool,
 }
 
 #[pymethods]
 impl FilteredPushRules {
     #[new]
-    pub fn py_new(
-        push_rules: PushRules,
-        enabled_map: BTreeMap<String, bool>,
-        msc3664_enabled: bool,
-        msc1767_enabled: bool,
-    ) -> Self {
+    pub fn py_new(push_rules: PushRules, enabled_map: BTreeMap<String, bool>) -> Self {
         Self {
             push_rules,
             enabled_map,
-            msc3664_enabled,
-            msc1767_enabled,
         }
     }
 
@@ -443,29 +414,13 @@ impl FilteredPushRules {
     /// Iterates over all the rules and their enabled state, including base
     /// rules, in the order they should be executed in.
     fn iter(&self) -> impl Iterator<Item = (&PushRule, bool)> {
-        self.push_rules
-            .iter()
-            .filter(|rule| {
-                // Ignore disabled experimental push rules
-                if !self.msc3664_enabled
-                    && rule.rule_id == "global/override/.im.nheko.msc3664.reply"
-                {
-                    return false;
-                }
-
-                if !self.msc1767_enabled && rule.rule_id.contains("org.matrix.msc1767") {
-                    return false;
-                }
-
-                true
-            })
-            .map(|r| {
-                let enabled = *self
-                    .enabled_map
-                    .get(&*r.rule_id)
-                    .unwrap_or(&r.default_enabled);
-                (r, enabled)
-            })
+        self.push_rules.iter().map(|r| {
+            let enabled = *self
+                .enabled_map
+                .get(&*r.rule_id)
+                .unwrap_or(&r.default_enabled);
+            (r, enabled)
+        })
     }
 }
 
@@ -491,29 +446,6 @@ fn test_deserialize_condition() {
     let _: Condition = serde_json::from_str(json).unwrap();
 }
 
-#[test]
-fn test_deserialize_unstable_msc3664_condition() {
-    let json = r#"{"kind":"im.nheko.msc3664.related_event_match","key":"content.body","pattern":"coffee","rel_type":"m.in_reply_to"}"#;
-
-    let condition: Condition = serde_json::from_str(json).unwrap();
-    assert!(matches!(
-        condition,
-        Condition::Known(KnownCondition::RelatedEventMatch(_))
-    ));
-}
-
-#[test]
-fn test_deserialize_unstable_msc3931_condition() {
-    let json =
-        r#"{"kind":"org.matrix.msc3931.room_version_supports","feature":"org.example.feature"}"#;
-
-    let condition: Condition = serde_json::from_str(json).unwrap();
-    assert!(matches!(
-        condition,
-        Condition::Known(KnownCondition::RoomVersionSupports { feature: _ })
-    ));
-}
-
 #[test]
 fn test_deserialize_custom_condition() {
     let json = r#"{"kind":"custom_tag"}"#;

rust/src/tree_cache/binding.rs

@@ -1,247 +0,0 @@
-use std::hash::Hash;
-
-use anyhow::Error;
-use pyo3::{
-    pyclass, pymethods,
-    types::{PyModule, PyTuple},
-    IntoPy, PyAny, PyObject, PyResult, Python, ToPyObject,
-};
-
-use super::TreeCache;
-
-pub fn register_module(py: Python<'_>, m: &PyModule) -> PyResult<()> {
-    let child_module = PyModule::new(py, "tree_cache")?;
-    child_module.add_class::<PythonTreeCache>()?;
-    child_module.add_class::<StringTreeCache>()?;
-
-    m.add_submodule(child_module)?;
-
-    // We need to manually add the module to sys.modules to make `from
-    // synapse.synapse_rust import push` work.
-    py.import("sys")?
-        .getattr("modules")?
-        .set_item("synapse.synapse_rust.tree_cache", child_module)?;
-
-    Ok(())
-}
-
-#[derive(Clone)]
-struct HashablePyObject {
-    obj: PyObject,
-    hash: isize,
-}
-
-impl HashablePyObject {
-    pub fn new(obj: &PyAny) -> Result<Self, Error> {
-        let hash = obj.hash()?;
-
-        Ok(HashablePyObject {
-            obj: obj.to_object(obj.py()),
-            hash,
-        })
-    }
-}
-
-impl IntoPy<PyObject> for HashablePyObject {
-    fn into_py(self, _: Python<'_>) -> PyObject {
-        self.obj.clone()
-    }
-}
-
-impl IntoPy<PyObject> for &HashablePyObject {
-    fn into_py(self, _: Python<'_>) -> PyObject {
-        self.obj.clone()
-    }
-}
-
-impl ToPyObject for HashablePyObject {
-    fn to_object(&self, _py: Python<'_>) -> PyObject {
-        self.obj.clone()
-    }
-}
-
-impl Hash for HashablePyObject {
-    fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
-        self.hash.hash(state);
-    }
-}
-
-impl PartialEq for HashablePyObject {
-    fn eq(&self, other: &Self) -> bool {
-        let equal = Python::with_gil(|py| {
-            let result = self.obj.as_ref(py).eq(other.obj.as_ref(py));
-            result.unwrap_or(false)
-        });
-
-        equal
-    }
-}
-
-impl Eq for HashablePyObject {}
-
-#[pyclass]
-struct PythonTreeCache(TreeCache<HashablePyObject, PyObject>);
-
-#[pymethods]
-impl PythonTreeCache {
-    #[new]
-    fn new() -> Self {
-        PythonTreeCache(Default::default())
-    }
-
-    pub fn set(&mut self, key: &PyAny, value: PyObject) -> Result<(), Error> {
-        let v: Vec<HashablePyObject> = key
-            .iter()?
-            .map(|obj| HashablePyObject::new(obj?))
-            .collect::<Result<_, _>>()?;
-
-        self.0.set(v, value)?;
-
-        Ok(())
-    }
-
-    pub fn get_node<'a>(
-        &'a self,
-        py: Python<'a>,
-        key: &'a PyAny,
-    ) -> Result<Option<Vec<(&'a PyTuple, &'a PyObject)>>, Error> {
-        let v: Vec<HashablePyObject> = key
-            .iter()?
-            .map(|obj| HashablePyObject::new(obj?))
-            .collect::<Result<_, _>>()?;
-
-        let Some(node) = self.0.get_node(v.clone())? else {
-            return Ok(None)
-        };
-
-        let items = node
-            .items()
-            .map(|(k, value)| {
-                let vec = v.iter().chain(k.iter().map(|a| *a)).collect::<Vec<_>>();
-                let nk = PyTuple::new(py, vec);
-                (nk, value)
-            })
-            .collect::<Vec<_>>();
-
-        Ok(Some(items))
-    }
-
-    pub fn get(&self, key: &PyAny) -> Result<Option<&PyObject>, Error> {
-        let v: Vec<HashablePyObject> = key
-            .iter()?
-            .map(|obj| HashablePyObject::new(obj?))
-            .collect::<Result<_, _>>()?;
-
-        Ok(self.0.get(&v)?)
-    }
-
-    pub fn pop_node<'a>(
-        &'a mut self,
-        py: Python<'a>,
-        key: &'a PyAny,
-    ) -> Result<Option<Vec<(&'a PyTuple, PyObject)>>, Error> {
-        let v: Vec<HashablePyObject> = key
-            .iter()?
-            .map(|obj| HashablePyObject::new(obj?))
-            .collect::<Result<_, _>>()?;
-
-        let Some(node) = self.0.pop_node(v.clone())? else {
-            return Ok(None)
-        };
-
-        let items = node
-            .into_items()
-            .map(|(k, value)| {
-                let vec = v.iter().chain(k.iter()).collect::<Vec<_>>();
-                let nk = PyTuple::new(py, vec);
-                (nk, value)
-            })
-            .collect::<Vec<_>>();
-
-        Ok(Some(items))
-    }
-
-    pub fn pop(&mut self, key: &PyAny) -> Result<Option<PyObject>, Error> {
-        let v: Vec<HashablePyObject> = key
-            .iter()?
-            .map(|obj| HashablePyObject::new(obj?))
-            .collect::<Result<_, _>>()?;
-
-        Ok(self.0.pop(&v)?)
-    }
-
-    pub fn clear(&mut self) {
-        self.0.clear()
-    }
-
-    pub fn len(&self) -> usize {
-        self.0.len()
-    }
-
-    pub fn values(&self) -> Vec<&PyObject> {
-        self.0.values().collect()
-    }
-
-    pub fn items(&self) -> Vec<(Vec<&HashablePyObject>, &PyObject)> {
-        todo!()
-    }
-}
-
-#[pyclass]
-struct StringTreeCache(TreeCache<String, String>);
-
-#[pymethods]
-impl StringTreeCache {
-    #[new]
-    fn new() -> Self {
-        StringTreeCache(Default::default())
-    }
-
-    pub fn set(&mut self, key: &PyAny, value: String) -> Result<(), Error> {
-        let key = key
-            .iter()?
-            .map(|o| o.expect("iter failed").extract().expect("not a string"));
-
-        self.0.set(key, value)?;
-
-        Ok(())
-    }
-
-    // pub fn get_node(&self, key: &PyAny) -> Result<Option<&TreeCacheNode<K, PyObject>>, Error> {
-    //     todo!()
-    // }
-
-    pub fn get(&self, key: &PyAny) -> Result<Option<&String>, Error> {
-        let key = key.iter()?.map(|o| {
-            o.expect("iter failed")
-                .extract::<String>()
-                .expect("not a string")
-        });
-
-        Ok(self.0.get(key)?)
-    }
-
-    // pub fn pop_node(&mut self, key: &PyAny) -> Result<Option<TreeCacheNode<K, PyObject>>, Error> {
-    //     todo!()
-    // }
-
-    pub fn pop(&mut self, key: Vec<String>) -> Result<Option<String>, Error> {
-        Ok(self.0.pop(&key)?)
-    }
-
-    pub fn clear(&mut self) {
-        self.0.clear()
-    }
-
-    pub fn len(&self) -> usize {
-        self.0.len()
-    }
-
-    pub fn values(&self) -> Vec<&String> {
-        self.0.values().collect()
-    }
-
-    pub fn items(&self) -> Vec<(Vec<&HashablePyObject>, &PyObject)> {
-        todo!()
-    }
-}

rust/src/tree_cache/mod.rs

@@ -1,421 +0,0 @@
-use std::{borrow::Borrow, collections::HashMap, hash::Hash};
-
-use anyhow::{bail, Error};
-
-pub mod binding;
-
-pub enum TreeCacheNode<K, V> {
-    Leaf(V),
-    Branch(usize, HashMap<K, TreeCacheNode<K, V>>),
-}
-
-impl<K, V> TreeCacheNode<K, V> {
-    pub fn new_branch() -> Self {
-        TreeCacheNode::Branch(0, Default::default())
-    }
-
-    fn len(&self) -> usize {
-        match self {
-            TreeCacheNode::Leaf(_) => 1,
-            TreeCacheNode::Branch(size, _) => *size,
-        }
-    }
-}
-
-impl<'a, K: Eq + Hash + 'a, V> TreeCacheNode<K, V> {
-    pub fn set(
-        &mut self,
-        mut key: impl Iterator<Item = K>,
-        value: V,
-    ) -> Result<(usize, usize), Error> {
-        if let Some(k) = key.next() {
-            match self {
-                TreeCacheNode::Leaf(_) => bail!("Given key is too long"),
-                TreeCacheNode::Branch(size, map) => {
-                    let node = map.entry(k).or_insert_with(TreeCacheNode::new_branch);
-                    let (added, removed) = node.set(key, value)?;
-
-                    *size += added;
-                    *size -= removed;
-
-                    Ok((added, removed))
-                }
-            }
-        } else {
-            let added = if let TreeCacheNode::Branch(_, map) = self {
-                (1, map.len())
-            } else {
-                (0, 0)
-            };
-
-            *self = TreeCacheNode::Leaf(value);
-
-            Ok(added)
-        }
-    }
-
-    pub fn pop<Q>(
-        &mut self,
-        current_key: Q,
-        mut next_keys: impl Iterator<Item = Q>,
-    ) -> Result<Option<TreeCacheNode<K, V>>, Error>
-    where
-        Q: Borrow<K>,
-        Q: Hash + Eq + 'a,
-    {
-        if let Some(next_key) = next_keys.next() {
-            match self {
-                TreeCacheNode::Leaf(_) => bail!("Given key is too long"),
-                TreeCacheNode::Branch(size, map) => {
-                    let node = if let Some(node) = map.get_mut(current_key.borrow()) {
-                        node
-                    } else {
-                        return Ok(None);
-                    };
-
-                    if let Some(popped) = node.pop(next_key, next_keys)? {
-                        *size -= node.len();
-
-                        Ok(Some(popped))
-                    } else {
-                        Ok(None)
-                    }
-                }
-            }
-        } else {
-            match self {
-                TreeCacheNode::Leaf(_) => bail!("Given key is too long"),
-                TreeCacheNode::Branch(size, map) => {
-                    if let Some(node) = map.remove(current_key.borrow()) {
-                        *size -= node.len();
-
-                        Ok(Some(node))
-                    } else {
-                        Ok(None)
-                    }
-                }
-            }
-        }
-    }
-
-    pub fn items(&'a self) -> impl Iterator<Item = (Vec<&K>, &V)> {
-        // To avoid a lot of mallocs we guess the length of the key. Ideally
-        // we'd know this.
-        let capacity_guesstimate = 10;
-
-        let mut stack = vec![(Vec::with_capacity(capacity_guesstimate), self)];
-
-        std::iter::from_fn(move || {
-            while let Some((prefix, node)) = stack.pop() {
-                match node {
-                    TreeCacheNode::Leaf(value) => return Some((prefix, value)),
-                    TreeCacheNode::Branch(_, map) => {
-                        stack.extend(map.iter().map(|(k, v)| {
-                            let mut new_prefix = Vec::with_capacity(capacity_guesstimate);
-                            new_prefix.extend_from_slice(&prefix);
-                            new_prefix.push(k);
-                            (new_prefix, v)
-                        }));
-                    }
-                }
-            }
-
-            None
-        })
-    }
-
-    pub fn values(&'a self) -> impl Iterator<Item = &V> {
-        let mut stack = vec![self];
-
-        std::iter::from_fn(move || {
-            while let Some(node) = stack.pop() {
-                match node {
-                    TreeCacheNode::Leaf(value) => return Some(value),
-                    TreeCacheNode::Branch(_, map) => {
-                        stack.extend(map.iter().map(|(_k, v)| v));
-                    }
-                }
-            }
-
-            None
-        })
-    }
-}
-
-impl<'a, K: Clone + Eq + Hash + 'a, V> TreeCacheNode<K, V> {
-    pub fn into_items(self) -> impl Iterator<Item = (Vec<K>, V)> {
-        let mut stack = vec![(Vec::new(), self)];
-
-        std::iter::from_fn(move || {
-            while let Some((prefix, node)) = stack.pop() {
-                match node {
-                    TreeCacheNode::Leaf(value) => return Some((prefix, value)),
-                    TreeCacheNode::Branch(_, map) => {
-                        stack.extend(map.into_iter().map(|(k, v)| {
-                            let mut prefix = prefix.clone();
-                            prefix.push(k);
-                            (prefix, v)
-                        }));
-                    }
-                }
-            }
-
-            None
-        })
-    }
-}
-
-impl<K, V> Default for TreeCacheNode<K, V> {
-    fn default() -> Self {
-        TreeCacheNode::new_branch()
-    }
-}
-
-pub struct TreeCache<K, V> {
-    root: TreeCacheNode<K, V>,
-}
-
-impl<K, V> TreeCache<K, V> {
-    pub fn new() -> Self {
-        TreeCache {
-            root: TreeCacheNode::new_branch(),
-        }
-    }
-}
-
-impl<'a, K: Eq + Hash + 'a, V> TreeCache<K, V> {
-    pub fn set(&mut self, key: impl IntoIterator<Item = K>, value: V) -> Result<(), Error> {
-        self.root.set(key.into_iter(), value)?;
-
-        Ok(())
-    }
-
-    pub fn get_node<Q>(
-        &self,
-        key: impl IntoIterator<Item = Q>,
-    ) -> Result<Option<&TreeCacheNode<K, V>>, Error>
-    where
-        Q: Borrow<K>,
-        Q: Hash + Eq + 'a,
-    {
-        let mut node = &self.root;
-
-        for k in key {
-            match node {
-                TreeCacheNode::Leaf(_) => bail!("Given key is too long"),
-                TreeCacheNode::Branch(_, map) => {
-                    node = if let Some(node) = map.get(k.borrow()) {
-                        node
-                    } else {
-                        return Ok(None);
-                    };
-                }
-            }
-        }
-
-        Ok(Some(node))
-    }
-
-    pub fn get<Q>(&self, key: impl IntoIterator<Item = Q>) -> Result<Option<&V>, Error>
-    where
-        Q: Borrow<K>,
-        Q: Hash + Eq + 'a,
-    {
-        if let Some(node) = self.get_node(key)? {
-            match node {
-                TreeCacheNode::Leaf(value) => Ok(Some(value)),
-                TreeCacheNode::Branch(_, _) => bail!("Given key is too short"),
-            }
-        } else {
-            Ok(None)
-        }
-    }
-
-    pub fn pop_node<Q>(
-        &mut self,
-        key: impl IntoIterator<Item = Q>,
-    ) -> Result<Option<TreeCacheNode<K, V>>, Error>
-    where
-        Q: Borrow<K>,
-        Q: Hash + Eq + 'a,
-    {
-        let mut key_iter = key.into_iter();
-
-        let k = if let Some(k) = key_iter.next() {
-            k
-        } else {
-            let node = std::mem::replace(&mut self.root, TreeCacheNode::new_branch());
-            return Ok(Some(node));
-        };
-
-        self.root.pop(k, key_iter)
-    }
-
-    pub fn pop(&mut self, key: &[K]) -> Result<Option<V>, Error> {
-        if let Some(node) = self.pop_node(key)? {
-            match node {
-                TreeCacheNode::Leaf(value) => Ok(Some(value)),
-                TreeCacheNode::Branch(_, _) => bail!("Given key is too short"),
-            }
-        } else {
-            Ok(None)
-        }
-    }
-
-    pub fn clear(&mut self) {
-        self.root = TreeCacheNode::new_branch();
-    }
-
-    pub fn len(&self) -> usize {
-        match self.root {
-            TreeCacheNode::Leaf(_) => 1,
-            TreeCacheNode::Branch(size, _) => size,
-        }
-    }
-
-    pub fn values(&self) -> impl Iterator<Item = &V> {
-        let mut stack = vec![&self.root];
-
-        std::iter::from_fn(move || {
-            while let Some(node) = stack.pop() {
-                match node {
-                    TreeCacheNode::Leaf(value) => return Some(value),
-                    TreeCacheNode::Branch(_, map) => {
-                        stack.extend(map.values());
-                    }
-                }
-            }
-
-            None
-        })
-    }
-
-    pub fn items(&self) -> impl Iterator<Item = (Vec<&K>, &V)> {
-        self.root.items()
-    }
-}
-
-impl<K, V> Default for TreeCache<K, V> {
-    fn default() -> Self {
-        TreeCache::new()
-    }
-}
-
-#[cfg(test)]
-mod test {
-    use std::collections::BTreeSet;
-
-    use super::*;
-
-    #[test]
-    fn get_set() -> Result<(), Error> {
-        let mut cache = TreeCache::new();
-
-        cache.set(vec!["a", "b"], "c")?;
-
-        assert_eq!(cache.get(&["a", "b"])?, Some(&"c"));
-
-        let node = cache.get_node(&["a"])?.unwrap();
-
-        match node {
-            TreeCacheNode::Leaf(_) => bail!("expected branch"),
-            TreeCacheNode::Branch(_, map) => {
-                assert_eq!(map.len(), 1);
-                assert!(map.contains_key("b"));
-            }
-        }
-
-        Ok(())
-    }
-
-    #[test]
-    fn length() -> Result<(), Error> {
-        let mut cache = TreeCache::new();
-
-        cache.set(vec!["a", "b"], "c")?;
-
-        assert_eq!(cache.len(), 1);
-
-        cache.set(vec!["a", "b"], "d")?;
-
-        assert_eq!(cache.len(), 1);
-
-        cache.set(vec!["e", "f"], "g")?;
-
-        assert_eq!(cache.len(), 2);
-
-        cache.set(vec!["e", "h"], "i")?;
-
-        assert_eq!(cache.len(), 3);
-
-        cache.set(vec!["e"], "i")?;
-
-        assert_eq!(cache.len(), 2);
-
-        cache.pop_node(&["a"])?;
-
-        assert_eq!(cache.len(), 1);
-
-        Ok(())
-    }
-
-    #[test]
-    fn clear() -> Result<(), Error> {
-        let mut cache = TreeCache::new();
-
-        cache.set(vec!["a", "b"], "c")?;
-
-        assert_eq!(cache.len(), 1);
-
-        cache.clear();
-
-        assert_eq!(cache.len(), 0);
-
-        assert_eq!(cache.get(&["a", "b"])?, None);
-
-        Ok(())
-    }
-
-    #[test]
-    fn pop() -> Result<(), Error> {
-        let mut cache = TreeCache::new();
-
-        cache.set(vec!["a", "b"], "c")?;
-        assert_eq!(cache.pop(&["a", "b"])?, Some("c"));
-        assert_eq!(cache.pop(&["a", "b"])?, None);
-
-        Ok(())
-    }
-
-    #[test]
-    fn values() -> Result<(), Error> {
-        let mut cache = TreeCache::new();
-
-        cache.set(vec!["a", "b"], "c")?;
-
-        let expected = ["c"].iter().collect();
-        assert_eq!(cache.values().collect::<BTreeSet<_>>(), expected);
-
-        cache.set(vec!["d", "e"], "f")?;
-
-        let expected = ["c", "f"].iter().collect();
-        assert_eq!(cache.values().collect::<BTreeSet<_>>(), expected);
-
-        Ok(())
-    }
-
-    #[test]
-    fn items() -> Result<(), Error> {
-        let mut cache = TreeCache::new();
-
-        cache.set(vec!["a", "b"], "c")?;
-        cache.set(vec!["d", "e"], "f")?;
-
-        let expected = [(vec![&"a", &"b"], &"c"), (vec![&"d", &"e"], &"f")]
-            .into_iter()
-            .collect();
-        assert_eq!(cache.items().collect::<BTreeSet<_>>(), expected);
-
-        Ok(())
-    }
-}

scripts-dev/build_debian_packages.py

@@ -27,7 +27,6 @@ DISTS = (
     "debian:sid",
     "ubuntu:focal",  # 20.04 LTS (our EOL forced by Py38 on 2024-10-14)
     "ubuntu:jammy",  # 22.04 LTS (EOL 2027-04)
-    "ubuntu:kinetic",  # 22.10 (EOL 2023-07-20)
 )
 
 DESC = """\

scripts-dev/complement.sh

@@ -126,7 +126,7 @@ export COMPLEMENT_BASE_IMAGE=complement-synapse
 
 extra_test_args=()
 
-test_tags="synapse_blacklist,msc3787,msc3874"
+test_tags="synapse_blacklist,msc3787"
 
 # All environment variables starting with PASS_ will be shared.
 # (The prefix is stripped off before reaching the container.)
@@ -139,9 +139,6 @@ if [[ -n "$WORKERS" ]]; then
   # Use workers.
   export PASS_SYNAPSE_COMPLEMENT_USE_WORKERS=true
 
-  # Pass through the workers defined. If none, it will be an empty string
-  export PASS_SYNAPSE_WORKER_TYPES="$WORKER_TYPES"
-
   # Workers can only use Postgres as a database.
   export PASS_SYNAPSE_COMPLEMENT_DATABASE=postgres
 
@@ -162,9 +159,9 @@ else
   # We only test faster room joins on monoliths, because they are purposefully
   # being developed without worker support to start with.
   #
-  # The tests for importing historical messages (MSC2716) also only pass with monoliths,
-  # currently.
-  test_tags="$test_tags,faster_joins,msc2716"
+  # The tests for importing historical messages (MSC2716) and jump to date (MSC3030)
+  # also only pass with monoliths, currently.
+  test_tags="$test_tags,faster_joins,msc2716,msc3030"
 fi
 
 

scripts-dev/federation_client.py

@@ -46,12 +46,11 @@ import signedjson.key
 import signedjson.types
 import srvlookup
 import yaml
-from requests import PreparedRequest, Response
 from requests.adapters import HTTPAdapter
 from urllib3 import HTTPConnectionPool
 
 # uncomment the following to enable debug logging of http requests
-# from http.client import HTTPConnection
+# from httplib import HTTPConnection
 # HTTPConnection.debuglevel = 1
 
 
@@ -104,7 +103,6 @@ def request(
     destination: str,
     path: str,
     content: Optional[str],
-    verify_tls: bool,
 ) -> requests.Response:
     if method is None:
         if content is None:
@@ -143,6 +141,7 @@ def request(
     s.mount("matrix://", MatrixConnectionAdapter())
 
     headers: Dict[str, str] = {
+        "Host": destination,
         "Authorization": authorization_headers[0],
     }
 
@@ -153,7 +152,7 @@ def request(
         method=method,
         url=dest,
         headers=headers,
-        verify=verify_tls,
+        verify=False,
         data=content,
         stream=True,
     )
@@ -203,12 +202,6 @@ def main() -> None:
 
     parser.add_argument("--body", help="Data to send as the body of the HTTP request")
 
-    parser.add_argument(
-        "--insecure",
-        action="store_true",
-        help="Disable TLS certificate verification",
-    )
-
     parser.add_argument(
         "path", help="request path, including the '/_matrix/federation/...' prefix."
     )
@@ -234,7 +227,6 @@ def main() -> None:
         args.destination,
         args.path,
         content=args.body,
-        verify_tls=not args.insecure,
     )
 
     sys.stderr.write("Status Code: %d\n" % (result.status_code,))
@@ -262,93 +254,36 @@ def read_args_from_config(args: argparse.Namespace) -> None:
 
 
 class MatrixConnectionAdapter(HTTPAdapter):
-    def send(
-        self,
-        request: PreparedRequest,
-        *args: Any,
-        **kwargs: Any,
-    ) -> Response:
-        # overrides the send() method in the base class.
-
-        # We need to look for .well-known redirects before passing the request up to
-        # HTTPAdapter.send().
-        assert isinstance(request.url, str)
-        parsed = urlparse.urlsplit(request.url)
-        server_name = parsed.netloc
-        well_known = self._get_well_known(parsed.netloc)
-
-        if well_known:
-            server_name = well_known
-
-        # replace the scheme in the uri with https, so that cert verification is done
-        # also replace the hostname if we got a .well-known result
-        request.url = urlparse.urlunsplit(
-            ("https", server_name, parsed.path, parsed.query, parsed.fragment)
-        )
-
-        # at this point we also add the host header (otherwise urllib will add one
-        # based on the `host` from the connection returned by `get_connection`,
-        # which will be wrong if there is an SRV record).
-        request.headers["Host"] = server_name
-
-        return super().send(request, *args, **kwargs)
-
-    def get_connection(
-        self, url: str, proxies: Optional[Dict[str, str]] = None
-    ) -> HTTPConnectionPool:
-        # overrides the get_connection() method in the base class
-        parsed = urlparse.urlsplit(url)
-        (host, port, ssl_server_name) = self._lookup(parsed.netloc)
-        print(
-            f"Connecting to {host}:{port} with SNI {ssl_server_name}", file=sys.stderr
-        )
-        return self.poolmanager.connection_from_host(
-            host,
-            port=port,
-            scheme="https",
-            pool_kwargs={"server_hostname": ssl_server_name},
-        )
-
     @staticmethod
-    def _lookup(server_name: str) -> Tuple[str, int, str]:
-        """
-        Do an SRV lookup on a server name and return the host:port to connect to
-        Given the server_name (after any .well-known lookup), return the host, port and
-        the ssl server name
-        """
-        if server_name[-1] == "]":
+    def lookup(s: str, skip_well_known: bool = False) -> Tuple[str, int]:
+        if s[-1] == "]":
             # ipv6 literal (with no port)
-            return server_name, 8448, server_name
+            return s, 8448
 
-        if ":" in server_name:
-            # explicit port
-            out = server_name.rsplit(":", 1)
+        if ":" in s:
+            out = s.rsplit(":", 1)
             try:
                 port = int(out[1])
             except ValueError:
-                raise ValueError("Invalid host:port '%s'" % (server_name,))
-            return out[0], port, out[0]
+                raise ValueError("Invalid host:port '%s'" % s)
+            return out[0], port
+
+        # try a .well-known lookup
+        if not skip_well_known:
+            well_known = MatrixConnectionAdapter.get_well_known(s)
+            if well_known:
+                return MatrixConnectionAdapter.lookup(well_known, skip_well_known=True)
 
         try:
-            srv = srvlookup.lookup("matrix", "tcp", server_name)[0]
-            print(
-                f"SRV lookup on _matrix._tcp.{server_name} gave {srv}",
-                file=sys.stderr,
-            )
-            return srv.host, srv.port, server_name
+            srv = srvlookup.lookup("matrix", "tcp", s)[0]
+            return srv.host, srv.port
         except Exception:
-            return server_name, 8448, server_name
+            return s, 8448
 
     @staticmethod
-    def _get_well_known(server_name: str) -> Optional[str]:
-        if ":" in server_name:
-            # explicit port, or ipv6 literal. Either way, no .well-known
-            return None
-
-        # TODO: check for ipv4 literals
-
-        uri = f"https://{server_name}/.well-known/matrix/server"
-        print(f"fetching {uri}", file=sys.stderr)
+    def get_well_known(server_name: str) -> Optional[str]:
+        uri = "https://%s/.well-known/matrix/server" % (server_name,)
+        print("fetching %s" % (uri,), file=sys.stderr)
 
         try:
             resp = requests.get(uri)
@@ -369,6 +304,19 @@ class MatrixConnectionAdapter(HTTPAdapter):
             print("Invalid response from %s: %s" % (uri, e), file=sys.stderr)
         return None
 
+    def get_connection(
+        self, url: str, proxies: Optional[Dict[str, str]] = None
+    ) -> HTTPConnectionPool:
+        parsed = urlparse.urlparse(url)
+
+        (host, port) = self.lookup(parsed.netloc)
+        netloc = "%s:%d" % (host, port)
+        print("Connecting to %s" % (netloc,), file=sys.stderr)
+        url = urlparse.urlunparse(
+            ("https", netloc, parsed.path, parsed.params, parsed.query, parsed.fragment)
+        )
+        return super().get_connection(url, proxies)
+
 
 if __name__ == "__main__":
     main()

scripts-dev/release.py

@@ -219,7 +219,9 @@ def _prepare() -> None:
                 update_branch(repo)
 
             # Create the new release branch
-            repo.create_head(release_branch_name, commit=base_branch)
+            # Type ignore will no longer be needed after GitPython 3.1.28.
+            # See https://github.com/gitpython-developers/GitPython/pull/1419
+            repo.create_head(release_branch_name, commit=base_branch)  # type: ignore[arg-type]
 
         # Special-case SyTest: we don't actually prepare any files so we may
         # as well push it now (and only when we create a release branch;

stubs/synapse/synapse_rust/push.pyi

@@ -1,4 +1,4 @@
-from typing import Any, Collection, Dict, Mapping, Optional, Sequence, Tuple, Union
+from typing import Any, Collection, Dict, Mapping, Optional, Sequence, Set, Tuple, Union
 
 from synapse.types import JsonDict
 
@@ -25,13 +25,7 @@ class PushRules:
     def rules(self) -> Collection[PushRule]: ...
 
 class FilteredPushRules:
-    def __init__(
-        self,
-        push_rules: PushRules,
-        enabled_map: Dict[str, bool],
-        msc3664_enabled: bool,
-        msc1767_enabled: bool,
-    ): ...
+    def __init__(self, push_rules: PushRules, enabled_map: Dict[str, bool]): ...
     def rules(self) -> Collection[Tuple[PushRule, bool]]: ...
 
 def get_base_rule_ids() -> Collection[str]: ...
@@ -43,14 +37,10 @@ class PushRuleEvaluator:
         room_member_count: int,
         sender_power_level: Optional[int],
         notification_power_levels: Mapping[str, int],
-        related_events_flattened: Mapping[str, Mapping[str, str]],
-        related_event_match_enabled: bool,
-        room_version_feature_flags: list[str],
-        msc3931_enabled: bool,
     ): ...
     def run(
         self,
         push_rules: FilteredPushRules,
         user_id: Optional[str],
         display_name: Optional[str],
-    ) -> Collection[Union[Mapping, str]]: ...
+    ) -> Collection[dict]: ...

synapse/_scripts/update_synapse_database.py

@@ -15,6 +15,7 @@
 
 import argparse
 import logging
+import sys
 from typing import cast
 
 import yaml
@@ -99,6 +100,13 @@ def main() -> None:
     # Load, process and sanity-check the config.
     hs_config = yaml.safe_load(args.database_config)
 
+    if "database" not in hs_config and "databases" not in hs_config:
+        sys.stderr.write(
+            "The configuration file must have a 'database' or 'databases' section. "
+            "See https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#database"
+        )
+        sys.exit(4)
+
     config = HomeServerConfig()
     config.parse_config_dict(hs_config, "", "")
 

synapse/api/constants.py

@@ -125,8 +125,6 @@ class EventTypes:
     MSC2716_BATCH: Final = "org.matrix.msc2716.batch"
     MSC2716_MARKER: Final = "org.matrix.msc2716.marker"
 
-    Reaction: Final = "m.reaction"
-
 
 class ToDeviceEventTypes:
     RoomKeyRequest: Final = "m.room_key_request"

synapse/api/errors.py

@@ -155,13 +155,7 @@ class RedirectException(CodeMessageException):
 
 class SynapseError(CodeMessageException):
     """A base exception type for matrix errors which have an errcode and error
-    message (as well as an HTTP status code). These often bubble all the way up to the
-    client API response so the error code and status often reach the client directly as
-    defined here. If the error doesn't make sense to present to a client, then it
-    probably shouldn't be a `SynapseError`. For example, if we contact another
-    homeserver over federation, we shouldn't automatically ferry response errors back to
-    the client on our end (a 500 from a remote server does not make sense to a client
-    when our server did not experience a 500).
+    message (as well as an HTTP status code).
 
     Attributes:
         errcode: Matrix error code e.g 'M_FORBIDDEN'
@@ -606,20 +600,8 @@ def cs_error(msg: str, code: str = Codes.UNKNOWN, **kwargs: Any) -> "JsonDict":
 
 
 class FederationError(RuntimeError):
-    """
-    Raised when we process an erroneous PDU.
-
-    There are two kinds of scenarios where this exception can be raised:
-
-    1. We may pull an invalid PDU from a remote homeserver (e.g. during backfill). We
-       raise this exception to signal an error to the rest of the application.
-    2. We may be pushed an invalid PDU as part of a `/send` transaction from a remote
-       homeserver. We raise so that we can respond to the transaction and include the
-       error string in the "PDU Processing Result". The message which will likely be
-       ignored by the remote homeserver and is not machine parse-able since it's just a
-       string.
-
-    TODO: In the future, we should split these usage scenarios into their own error types.
+    """This class is used to inform remote homeservers about erroneous
+    PDUs they sent us.
 
     FATAL: The remote server could not interpret the source event.
         (e.g., it was missing a required field)
@@ -713,7 +695,7 @@ class HttpResponseException(CodeMessageException):
         set to the reason code from the HTTP response.
 
         Returns:
-            The error converted to a SynapseError.
+            SynapseError:
         """
         # try to parse the body as json, to get better errcode/msg, but
         # default to M_UNKNOWN with the HTTP status as the error text

synapse/api/filtering.py

@@ -43,7 +43,7 @@ if TYPE_CHECKING:
     from synapse.server import HomeServer
 
 FILTER_SCHEMA = {
-    "additionalProperties": True,  # Allow new fields for forward compatibility
+    "additionalProperties": False,
     "type": "object",
     "properties": {
         "limit": {"type": "number"},
@@ -63,7 +63,7 @@ FILTER_SCHEMA = {
 }
 
 ROOM_FILTER_SCHEMA = {
-    "additionalProperties": True,  # Allow new fields for forward compatibility
+    "additionalProperties": False,
     "type": "object",
     "properties": {
         "not_rooms": {"$ref": "#/definitions/room_id_array"},
@@ -77,7 +77,7 @@ ROOM_FILTER_SCHEMA = {
 }
 
 ROOM_EVENT_FILTER_SCHEMA = {
-    "additionalProperties": True,  # Allow new fields for forward compatibility
+    "additionalProperties": False,
     "type": "object",
     "properties": {
         "limit": {"type": "number"},
@@ -143,7 +143,7 @@ USER_FILTER_SCHEMA = {
             },
         },
     },
-    "additionalProperties": True,  # Allow new fields for forward compatibility
+    "additionalProperties": False,
 }
 
 

synapse/api/room_versions.py

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from typing import Callable, Dict, List, Optional
+from typing import Callable, Dict, Optional
 
 import attr
 
@@ -51,13 +51,6 @@ class RoomDisposition:
     UNSTABLE = "unstable"
 
 
-class PushRuleRoomFlag:
-    """Enum for listing possible MSC3931 room version feature flags, for push rules"""
-
-    # MSC3932: Room version supports MSC1767 Extensible Events.
-    EXTENSIBLE_EVENTS = "org.matrix.msc3932.extensible_events"
-
-
 @attr.s(slots=True, frozen=True, auto_attribs=True)
 class RoomVersion:
     """An object which describes the unique attributes of a room version."""
@@ -98,12 +91,6 @@ class RoomVersion:
     msc3787_knock_restricted_join_rule: bool
     # MSC3667: Enforce integer power levels
     msc3667_int_only_power_levels: bool
-    # MSC3931: Adds a push rule condition for "room version feature flags", making
-    # some push rules room version dependent. Note that adding a flag to this list
-    # is not enough to mark it "supported": the push rule evaluator also needs to
-    # support the flag. Unknown flags are ignored by the evaluator, making conditions
-    # fail if used.
-    msc3931_push_features: List[str]  # values from PushRuleRoomFlag
 
 
 class RoomVersions:
@@ -124,7 +111,6 @@ class RoomVersions:
         msc2716_redactions=False,
         msc3787_knock_restricted_join_rule=False,
         msc3667_int_only_power_levels=False,
-        msc3931_push_features=[],
     )
     V2 = RoomVersion(
         "2",
@@ -143,7 +129,6 @@ class RoomVersions:
         msc2716_redactions=False,
         msc3787_knock_restricted_join_rule=False,
         msc3667_int_only_power_levels=False,
-        msc3931_push_features=[],
     )
     V3 = RoomVersion(
         "3",
@@ -162,7 +147,6 @@ class RoomVersions:
         msc2716_redactions=False,
         msc3787_knock_restricted_join_rule=False,
         msc3667_int_only_power_levels=False,
-        msc3931_push_features=[],
     )
     V4 = RoomVersion(
         "4",
@@ -181,7 +165,6 @@ class RoomVersions:
         msc2716_redactions=False,
         msc3787_knock_restricted_join_rule=False,
         msc3667_int_only_power_levels=False,
-        msc3931_push_features=[],
     )
     V5 = RoomVersion(
         "5",
@@ -200,7 +183,6 @@ class RoomVersions:
         msc2716_redactions=False,
         msc3787_knock_restricted_join_rule=False,
         msc3667_int_only_power_levels=False,
-        msc3931_push_features=[],
     )
     V6 = RoomVersion(
         "6",
@@ -219,7 +201,6 @@ class RoomVersions:
         msc2716_redactions=False,
         msc3787_knock_restricted_join_rule=False,
         msc3667_int_only_power_levels=False,
-        msc3931_push_features=[],
     )
     MSC2176 = RoomVersion(
         "org.matrix.msc2176",
@@ -238,7 +219,6 @@ class RoomVersions:
         msc2716_redactions=False,
         msc3787_knock_restricted_join_rule=False,
         msc3667_int_only_power_levels=False,
-        msc3931_push_features=[],
     )
     V7 = RoomVersion(
         "7",
@@ -257,7 +237,6 @@ class RoomVersions:
         msc2716_redactions=False,
         msc3787_knock_restricted_join_rule=False,
         msc3667_int_only_power_levels=False,
-        msc3931_push_features=[],
     )
     V8 = RoomVersion(
         "8",
@@ -276,7 +255,6 @@ class RoomVersions:
         msc2716_redactions=False,
         msc3787_knock_restricted_join_rule=False,
         msc3667_int_only_power_levels=False,
-        msc3931_push_features=[],
     )
     V9 = RoomVersion(
         "9",
@@ -295,7 +273,6 @@ class RoomVersions:
         msc2716_redactions=False,
         msc3787_knock_restricted_join_rule=False,
         msc3667_int_only_power_levels=False,
-        msc3931_push_features=[],
     )
     MSC3787 = RoomVersion(
         "org.matrix.msc3787",
@@ -314,7 +291,6 @@ class RoomVersions:
         msc2716_redactions=False,
         msc3787_knock_restricted_join_rule=True,
         msc3667_int_only_power_levels=False,
-        msc3931_push_features=[],
     )
     V10 = RoomVersion(
         "10",
@@ -333,7 +309,6 @@ class RoomVersions:
         msc2716_redactions=False,
         msc3787_knock_restricted_join_rule=True,
         msc3667_int_only_power_levels=True,
-        msc3931_push_features=[],
     )
     MSC2716v4 = RoomVersion(
         "org.matrix.msc2716v4",
@@ -352,27 +327,6 @@ class RoomVersions:
         msc2716_redactions=True,
         msc3787_knock_restricted_join_rule=False,
         msc3667_int_only_power_levels=False,
-        msc3931_push_features=[],
-    )
-    MSC1767v10 = RoomVersion(
-        # MSC1767 (Extensible Events) based on room version "10"
-        "org.matrix.msc1767.10",
-        RoomDisposition.UNSTABLE,
-        EventFormatVersions.ROOM_V4_PLUS,
-        StateResolutionVersions.V2,
-        enforce_key_validity=True,
-        special_case_aliases_auth=False,
-        strict_canonicaljson=True,
-        limit_notifications_power_levels=True,
-        msc2176_redaction_rules=False,
-        msc3083_join_rules=True,
-        msc3375_redaction_rules=True,
-        msc2403_knocking=True,
-        msc2716_historical=False,
-        msc2716_redactions=False,
-        msc3787_knock_restricted_join_rule=True,
-        msc3667_int_only_power_levels=True,
-        msc3931_push_features=[PushRuleRoomFlag.EXTENSIBLE_EVENTS],
     )
 
 

synapse/api/urls.py

@@ -28,7 +28,7 @@ FEDERATION_V1_PREFIX = FEDERATION_PREFIX + "/v1"
 FEDERATION_V2_PREFIX = FEDERATION_PREFIX + "/v2"
 FEDERATION_UNSTABLE_PREFIX = FEDERATION_PREFIX + "/unstable"
 STATIC_PREFIX = "/_matrix/static"
-SERVER_KEY_PREFIX = "/_matrix/key"
+SERVER_KEY_V2_PREFIX = "/_matrix/key/v2"
 MEDIA_R0_PREFIX = "/_matrix/media/r0"
 MEDIA_V3_PREFIX = "/_matrix/media/v3"
 LEGACY_MEDIA_PREFIX = "/_matrix/media/v1"

synapse/app/_base.py

@@ -47,7 +47,6 @@ from twisted.internet.tcp import Port
 from twisted.logger import LoggingFile, LogLevel
 from twisted.protocols.tls import TLSMemoryBIOFactory
 from twisted.python.threadpool import ThreadPool
-from twisted.web.resource import Resource
 
 import synapse.util.caches
 from synapse.api.constants import MAX_PDU_SIZE
@@ -56,13 +55,12 @@ from synapse.app.phone_stats_home import start_phone_stats_home
 from synapse.config import ConfigError
 from synapse.config._base import format_config_error
 from synapse.config.homeserver import HomeServerConfig
-from synapse.config.server import ListenerConfig, ManholeConfig
+from synapse.config.server import ManholeConfig
 from synapse.crypto import context_factory
 from synapse.events.presence_router import load_legacy_presence_router
 from synapse.events.spamcheck import load_legacy_spam_checkers
 from synapse.events.third_party_rules import load_legacy_third_party_event_rules
 from synapse.handlers.auth import load_legacy_password_auth_providers
-from synapse.http.site import SynapseSite
 from synapse.logging.context import PreserveLoggingContext
 from synapse.logging.opentracing import init_tracer
 from synapse.metrics import install_gc_manager, register_threadpool
@@ -266,18 +264,26 @@ def register_start(
     reactor.callWhenRunning(lambda: defer.ensureDeferred(wrapper()))
 
 
-def listen_metrics(bind_addresses: Iterable[str], port: int) -> None:
+def listen_metrics(
+    bind_addresses: Iterable[str], port: int, enable_legacy_metric_names: bool
+) -> None:
     """
     Start Prometheus metrics server.
     """
     from prometheus_client import start_http_server as start_http_server_prometheus
 
-    from synapse.metrics import RegistryProxy
+    from synapse.metrics import (
+        RegistryProxy,
+        start_http_server as start_http_server_legacy,
+    )
 
     for host in bind_addresses:
         logger.info("Starting metrics listener on %s:%d", host, port)
-        _set_prometheus_client_use_created_metrics(False)
-        start_http_server_prometheus(port, addr=host, registry=RegistryProxy)
+        if enable_legacy_metric_names:
+            start_http_server_legacy(port, addr=host, registry=RegistryProxy)
+        else:
+            _set_prometheus_client_use_created_metrics(False)
+            start_http_server_prometheus(port, addr=host, registry=RegistryProxy)
 
 
 def _set_prometheus_client_use_created_metrics(new_value: bool) -> None:
@@ -351,55 +357,6 @@ def listen_tcp(
     return r  # type: ignore[return-value]
 
 
-def listen_http(
-    listener_config: ListenerConfig,
-    root_resource: Resource,
-    version_string: str,
-    max_request_body_size: int,
-    context_factory: Optional[IOpenSSLContextFactory],
-    reactor: ISynapseReactor = reactor,
-) -> List[Port]:
-    port = listener_config.port
-    bind_addresses = listener_config.bind_addresses
-    tls = listener_config.tls
-
-    assert listener_config.http_options is not None
-
-    site_tag = listener_config.http_options.tag
-    if site_tag is None:
-        site_tag = str(port)
-
-    site = SynapseSite(
-        "synapse.access.%s.%s" % ("https" if tls else "http", site_tag),
-        site_tag,
-        listener_config,
-        root_resource,
-        version_string,
-        max_request_body_size=max_request_body_size,
-        reactor=reactor,
-    )
-    if tls:
-        # refresh_certificate should have been called before this.
-        assert context_factory is not None
-        ports = listen_ssl(
-            bind_addresses,
-            port,
-            site,
-            context_factory,
-            reactor=reactor,
-        )
-        logger.info("Synapse now listening on TCP port %d (TLS)", port)
-    else:
-        ports = listen_tcp(
-            bind_addresses,
-            port,
-            site,
-            reactor=reactor,
-        )
-        logger.info("Synapse now listening on TCP port %d", port)
-    return ports
-
-
 def listen_ssl(
     bind_addresses: Collection[str],
     port: int,
@@ -601,7 +558,7 @@ def reload_cache_config(config: HomeServerConfig) -> None:
             logger.warning(f)
     else:
         logger.debug(
-            "New cache config. Was:\n %s\nNow:\n %s",
+            "New cache config. Was:\n %s\nNow:\n",
             previous_cache_config.__dict__,
             config.caches.__dict__,
         )

synapse/app/admin_cmd.py

@@ -28,6 +28,10 @@ from synapse.config.homeserver import HomeServerConfig
 from synapse.config.logger import setup_logging
 from synapse.events import EventBase
 from synapse.handlers.admin import ExfiltrationWriter
+from synapse.replication.slave.storage.devices import SlavedDeviceStore
+from synapse.replication.slave.storage.events import SlavedEventStore
+from synapse.replication.slave.storage.filtering import SlavedFilteringStore
+from synapse.replication.slave.storage.push_rule import SlavedPushRuleStore
 from synapse.server import HomeServer
 from synapse.storage.database import DatabasePool, LoggingDatabaseConnection
 from synapse.storage.databases.main.account_data import AccountDataWorkerStore
@@ -36,24 +40,10 @@ from synapse.storage.databases.main.appservice import (
     ApplicationServiceWorkerStore,
 )
 from synapse.storage.databases.main.deviceinbox import DeviceInboxWorkerStore
-from synapse.storage.databases.main.devices import DeviceWorkerStore
-from synapse.storage.databases.main.event_federation import EventFederationWorkerStore
-from synapse.storage.databases.main.event_push_actions import (
-    EventPushActionsWorkerStore,
-)
-from synapse.storage.databases.main.events_worker import EventsWorkerStore
-from synapse.storage.databases.main.filtering import FilteringWorkerStore
-from synapse.storage.databases.main.push_rule import PushRulesWorkerStore
 from synapse.storage.databases.main.receipts import ReceiptsWorkerStore
 from synapse.storage.databases.main.registration import RegistrationWorkerStore
-from synapse.storage.databases.main.relations import RelationsWorkerStore
 from synapse.storage.databases.main.room import RoomWorkerStore
-from synapse.storage.databases.main.roommember import RoomMemberWorkerStore
-from synapse.storage.databases.main.signatures import SignatureWorkerStore
-from synapse.storage.databases.main.state import StateGroupWorkerStore
-from synapse.storage.databases.main.stream import StreamWorkerStore
 from synapse.storage.databases.main.tags import TagsWorkerStore
-from synapse.storage.databases.main.user_erasure_store import UserErasureWorkerStore
 from synapse.types import StateMap
 from synapse.util import SYNAPSE_VERSION
 from synapse.util.logcontext import LoggingContext
@@ -62,25 +52,17 @@ logger = logging.getLogger("synapse.app.admin_cmd")
 
 
 class AdminCmdSlavedStore(
-    FilteringWorkerStore,
-    DeviceWorkerStore,
+    SlavedFilteringStore,
+    SlavedPushRuleStore,
+    SlavedEventStore,
+    SlavedDeviceStore,
     TagsWorkerStore,
     DeviceInboxWorkerStore,
     AccountDataWorkerStore,
-    PushRulesWorkerStore,
     ApplicationServiceTransactionWorkerStore,
     ApplicationServiceWorkerStore,
-    RoomMemberWorkerStore,
-    RelationsWorkerStore,
-    EventFederationWorkerStore,
-    EventPushActionsWorkerStore,
-    StateGroupWorkerStore,
-    SignatureWorkerStore,
-    UserErasureWorkerStore,
-    ReceiptsWorkerStore,
-    StreamWorkerStore,
-    EventsWorkerStore,
     RegistrationWorkerStore,
+    ReceiptsWorkerStore,
     RoomWorkerStore,
 ):
     def __init__(

synapse/app/complement_fork_starter.py

@@ -55,13 +55,13 @@ import os
 import signal
 import sys
 from types import FrameType
-from typing import Any, Callable, Dict, List, Optional
+from typing import Any, Callable, List, Optional
 
 from twisted.internet.main import installReactor
 
 # a list of the original signal handlers, before we installed our custom ones.
 # We restore these in our child processes.
-_original_signal_handlers: Dict[int, Any] = {}
+_original_signal_handlers: dict[int, Any] = {}
 
 
 class ProxiedReactor:

synapse/app/generic_worker.py

@@ -14,19 +14,21 @@
 # limitations under the License.
 import logging
 import sys
-from typing import Dict, List
+from typing import Dict, List, Optional, Tuple
 
+from twisted.internet import address
 from twisted.web.resource import Resource
 
 import synapse
 import synapse.events
+from synapse.api.errors import HttpResponseException, RequestSendFailed, SynapseError
 from synapse.api.urls import (
     CLIENT_API_PREFIX,
     FEDERATION_PREFIX,
     LEGACY_MEDIA_PREFIX,
     MEDIA_R0_PREFIX,
     MEDIA_V3_PREFIX,
-    SERVER_KEY_PREFIX,
+    SERVER_KEY_V2_PREFIX,
 )
 from synapse.app import _base
 from synapse.app._base import (
@@ -41,13 +43,53 @@ from synapse.config.logger import setup_logging
 from synapse.config.server import ListenerConfig
 from synapse.federation.transport.server import TransportLayerServer
 from synapse.http.server import JsonResource, OptionsResource
+from synapse.http.servlet import RestServlet, parse_json_object_from_request
+from synapse.http.site import SynapseRequest, SynapseSite
 from synapse.logging.context import LoggingContext
 from synapse.metrics import METRICS_PREFIX, MetricsResource, RegistryProxy
 from synapse.replication.http import REPLICATION_PREFIX, ReplicationRestResource
-from synapse.rest import ClientRestResource
+from synapse.replication.slave.storage.devices import SlavedDeviceStore
+from synapse.replication.slave.storage.events import SlavedEventStore
+from synapse.replication.slave.storage.filtering import SlavedFilteringStore
+from synapse.replication.slave.storage.keys import SlavedKeyStore
+from synapse.replication.slave.storage.push_rule import SlavedPushRuleStore
+from synapse.replication.slave.storage.pushers import SlavedPusherStore
 from synapse.rest.admin import register_servlets_for_media_repo
+from synapse.rest.client import (
+    account_data,
+    events,
+    initial_sync,
+    login,
+    presence,
+    profile,
+    push_rule,
+    read_marker,
+    receipts,
+    relations,
+    room,
+    room_batch,
+    room_keys,
+    sendtodevice,
+    sync,
+    tags,
+    user_directory,
+    versions,
+    voip,
+)
+from synapse.rest.client._base import client_patterns
+from synapse.rest.client.account import ThreepidRestServlet, WhoamiRestServlet
+from synapse.rest.client.devices import DevicesRestServlet
+from synapse.rest.client.keys import (
+    KeyChangesServlet,
+    KeyQueryServlet,
+    OneTimeKeyServlet,
+)
+from synapse.rest.client.register import (
+    RegisterRestServlet,
+    RegistrationTokenValidityRestServlet,
+)
 from synapse.rest.health import HealthResource
-from synapse.rest.key.v2 import KeyResource
+from synapse.rest.key.v2 import KeyApiV2Resource
 from synapse.rest.synapse.client import build_synapse_client_resource_tree
 from synapse.rest.well_known import well_known_resource
 from synapse.server import HomeServer
@@ -59,16 +101,8 @@ from synapse.storage.databases.main.appservice import (
 from synapse.storage.databases.main.censor_events import CensorEventsStore
 from synapse.storage.databases.main.client_ips import ClientIpWorkerStore
 from synapse.storage.databases.main.deviceinbox import DeviceInboxWorkerStore
-from synapse.storage.databases.main.devices import DeviceWorkerStore
 from synapse.storage.databases.main.directory import DirectoryWorkerStore
 from synapse.storage.databases.main.e2e_room_keys import EndToEndRoomKeyStore
-from synapse.storage.databases.main.event_federation import EventFederationWorkerStore
-from synapse.storage.databases.main.event_push_actions import (
-    EventPushActionsWorkerStore,
-)
-from synapse.storage.databases.main.events_worker import EventsWorkerStore
-from synapse.storage.databases.main.filtering import FilteringWorkerStore
-from synapse.storage.databases.main.keys import KeyStore
 from synapse.storage.databases.main.lock import LockStore
 from synapse.storage.databases.main.media_repository import MediaRepositoryStore
 from synapse.storage.databases.main.metrics import ServerMetricsStore
@@ -77,31 +111,118 @@ from synapse.storage.databases.main.monthly_active_users import (
 )
 from synapse.storage.databases.main.presence import PresenceStore
 from synapse.storage.databases.main.profile import ProfileWorkerStore
-from synapse.storage.databases.main.push_rule import PushRulesWorkerStore
-from synapse.storage.databases.main.pusher import PusherWorkerStore
 from synapse.storage.databases.main.receipts import ReceiptsWorkerStore
 from synapse.storage.databases.main.registration import RegistrationWorkerStore
-from synapse.storage.databases.main.relations import RelationsWorkerStore
 from synapse.storage.databases.main.room import RoomWorkerStore
 from synapse.storage.databases.main.room_batch import RoomBatchStore
-from synapse.storage.databases.main.roommember import RoomMemberWorkerStore
 from synapse.storage.databases.main.search import SearchStore
 from synapse.storage.databases.main.session import SessionStore
-from synapse.storage.databases.main.signatures import SignatureWorkerStore
-from synapse.storage.databases.main.state import StateGroupWorkerStore
 from synapse.storage.databases.main.stats import StatsStore
-from synapse.storage.databases.main.stream import StreamWorkerStore
 from synapse.storage.databases.main.tags import TagsWorkerStore
 from synapse.storage.databases.main.transactions import TransactionWorkerStore
 from synapse.storage.databases.main.ui_auth import UIAuthWorkerStore
 from synapse.storage.databases.main.user_directory import UserDirectoryStore
-from synapse.storage.databases.main.user_erasure_store import UserErasureWorkerStore
+from synapse.types import JsonDict
 from synapse.util import SYNAPSE_VERSION
 from synapse.util.httpresourcetree import create_resource_tree
 
 logger = logging.getLogger("synapse.app.generic_worker")
 
 
+class KeyUploadServlet(RestServlet):
+    """An implementation of the `KeyUploadServlet` that responds to read only
+    requests, but otherwise proxies through to the master instance.
+    """
+
+    PATTERNS = client_patterns("/keys/upload(/(?P<device_id>[^/]+))?$")
+
+    def __init__(self, hs: HomeServer):
+        """
+        Args:
+            hs: server
+        """
+        super().__init__()
+        self.auth = hs.get_auth()
+        self.store = hs.get_datastores().main
+        self.http_client = hs.get_simple_http_client()
+        self.main_uri = hs.config.worker.worker_main_http_uri
+
+    async def on_POST(
+        self, request: SynapseRequest, device_id: Optional[str]
+    ) -> Tuple[int, JsonDict]:
+        requester = await self.auth.get_user_by_req(request, allow_guest=True)
+        user_id = requester.user.to_string()
+        body = parse_json_object_from_request(request)
+
+        if device_id is not None:
+            # passing the device_id here is deprecated; however, we allow it
+            # for now for compatibility with older clients.
+            if requester.device_id is not None and device_id != requester.device_id:
+                logger.warning(
+                    "Client uploading keys for a different device "
+                    "(logged in as %s, uploading for %s)",
+                    requester.device_id,
+                    device_id,
+                )
+        else:
+            device_id = requester.device_id
+
+        if device_id is None:
+            raise SynapseError(
+                400, "To upload keys, you must pass device_id when authenticating"
+            )
+
+        if body:
+            # They're actually trying to upload something, proxy to main synapse.
+
+            # Proxy headers from the original request, such as the auth headers
+            # (in case the access token is there) and the original IP /
+            # User-Agent of the request.
+            headers = {
+                header: request.requestHeaders.getRawHeaders(header, [])
+                for header in (b"Authorization", b"User-Agent")
+            }
+            # Add the previous hop to the X-Forwarded-For header.
+            x_forwarded_for = request.requestHeaders.getRawHeaders(
+                b"X-Forwarded-For", []
+            )
+            # we use request.client here, since we want the previous hop, not the
+            # original client (as returned by request.getClientAddress()).
+            if isinstance(request.client, (address.IPv4Address, address.IPv6Address)):
+                previous_host = request.client.host.encode("ascii")
+                # If the header exists, add to the comma-separated list of the first
+                # instance of the header. Otherwise, generate a new header.
+                if x_forwarded_for:
+                    x_forwarded_for = [x_forwarded_for[0] + b", " + previous_host]
+                    x_forwarded_for.extend(x_forwarded_for[1:])
+                else:
+                    x_forwarded_for = [previous_host]
+            headers[b"X-Forwarded-For"] = x_forwarded_for
+
+            # Replicate the original X-Forwarded-Proto header. Note that
+            # XForwardedForRequest overrides isSecure() to give us the original protocol
+            # used by the client, as opposed to the protocol used by our upstream proxy
+            # - which is what we want here.
+            headers[b"X-Forwarded-Proto"] = [
+                b"https" if request.isSecure() else b"http"
+            ]
+
+            try:
+                result = await self.http_client.post_json_get_json(
+                    self.main_uri + request.uri.decode("ascii"), body, headers=headers
+                )
+            except HttpResponseException as e:
+                raise e.to_synapse_error() from e
+            except RequestSendFailed as e:
+                raise SynapseError(502, "Failed to talk to master") from e
+
+            return 200, result
+        else:
+            # Just interested in counts.
+            result = await self.store.count_e2e_one_time_keys(user_id, device_id)
+            return 200, {"one_time_key_counts": result}
+
+
 class GenericWorkerSlavedStore(
     # FIXME(#3714): We need to add UserDirectoryStore as we write directly
     # rather than going via the correct worker.
@@ -111,36 +232,26 @@ class GenericWorkerSlavedStore(
     EndToEndRoomKeyStore,
     PresenceStore,
     DeviceInboxWorkerStore,
-    DeviceWorkerStore,
+    SlavedDeviceStore,
+    SlavedPushRuleStore,
     TagsWorkerStore,
     AccountDataWorkerStore,
+    SlavedPusherStore,
     CensorEventsStore,
     ClientIpWorkerStore,
-    # KeyStore isn't really safe to use from a worker, but for now we do so and hope that
-    # the races it creates aren't too bad.
-    KeyStore,
+    SlavedEventStore,
+    SlavedKeyStore,
     RoomWorkerStore,
     RoomBatchStore,
     DirectoryWorkerStore,
-    PushRulesWorkerStore,
     ApplicationServiceTransactionWorkerStore,
     ApplicationServiceWorkerStore,
     ProfileWorkerStore,
-    FilteringWorkerStore,
+    SlavedFilteringStore,
     MonthlyActiveUsersWorkerStore,
     MediaRepositoryStore,
     ServerMetricsStore,
-    PusherWorkerStore,
-    RoomMemberWorkerStore,
-    RelationsWorkerStore,
-    EventFederationWorkerStore,
-    EventPushActionsWorkerStore,
-    StateGroupWorkerStore,
-    SignatureWorkerStore,
-    UserErasureWorkerStore,
     ReceiptsWorkerStore,
-    StreamWorkerStore,
-    EventsWorkerStore,
     RegistrationWorkerStore,
     SearchStore,
     TransactionWorkerStore,
@@ -157,9 +268,15 @@ class GenericWorkerServer(HomeServer):
     DATASTORE_CLASS = GenericWorkerSlavedStore  # type: ignore
 
     def _listen_http(self, listener_config: ListenerConfig) -> None:
+        port = listener_config.port
+        bind_addresses = listener_config.bind_addresses
 
         assert listener_config.http_options is not None
 
+        site_tag = listener_config.http_options.tag
+        if site_tag is None:
+            site_tag = str(port)
+
         # We always include a health resource.
         resources: Dict[str, Resource] = {"/health": HealthResource()}
 
@@ -168,15 +285,53 @@ class GenericWorkerServer(HomeServer):
                 if name == "metrics":
                     resources[METRICS_PREFIX] = MetricsResource(RegistryProxy)
                 elif name == "client":
-                    resource: Resource = ClientRestResource(self)
+                    resource = JsonResource(self, canonical_json=False)
 
-                    resources[CLIENT_API_PREFIX] = resource
+                    RegisterRestServlet(self).register(resource)
+                    RegistrationTokenValidityRestServlet(self).register(resource)
+                    login.register_servlets(self, resource)
+                    ThreepidRestServlet(self).register(resource)
+                    WhoamiRestServlet(self).register(resource)
+                    DevicesRestServlet(self).register(resource)
+
+                    # Read-only
+                    KeyUploadServlet(self).register(resource)
+                    KeyQueryServlet(self).register(resource)
+                    KeyChangesServlet(self).register(resource)
+                    OneTimeKeyServlet(self).register(resource)
+
+                    voip.register_servlets(self, resource)
+                    push_rule.register_servlets(self, resource)
+                    versions.register_servlets(self, resource)
+
+                    profile.register_servlets(self, resource)
+
+                    sync.register_servlets(self, resource)
+                    events.register_servlets(self, resource)
+                    room.register_servlets(self, resource, is_worker=True)
+                    relations.register_servlets(self, resource)
+                    room.register_deprecated_servlets(self, resource)
+                    initial_sync.register_servlets(self, resource)
+                    room_batch.register_servlets(self, resource)
+                    room_keys.register_servlets(self, resource)
+                    tags.register_servlets(self, resource)
+                    account_data.register_servlets(self, resource)
+                    receipts.register_servlets(self, resource)
+                    read_marker.register_servlets(self, resource)
+
+                    sendtodevice.register_servlets(self, resource)
+
+                    user_directory.register_servlets(self, resource)
+
+                    presence.register_servlets(self, resource)
+
+                    resources.update({CLIENT_API_PREFIX: resource})
 
                     resources.update(build_synapse_client_resource_tree(self))
-                    resources["/.well-known"] = well_known_resource(self)
+                    resources.update({"/.well-known": well_known_resource(self)})
 
                 elif name == "federation":
-                    resources[FEDERATION_PREFIX] = TransportLayerServer(self)
+                    resources.update({FEDERATION_PREFIX: TransportLayerServer(self)})
                 elif name == "media":
                     if self.config.media.can_load_media_repo:
                         media_repo = self.get_media_repository_resource()
@@ -204,12 +359,16 @@ class GenericWorkerServer(HomeServer):
                     # Only load the openid resource separately if federation resource
                     # is not specified since federation resource includes openid
                     # resource.
-                    resources[FEDERATION_PREFIX] = TransportLayerServer(
-                        self, servlet_groups=["openid"]
+                    resources.update(
+                        {
+                            FEDERATION_PREFIX: TransportLayerServer(
+                                self, servlet_groups=["openid"]
+                            )
+                        }
                     )
 
                 if name in ["keys", "federation"]:
-                    resources[SERVER_KEY_PREFIX] = KeyResource(self)
+                    resources[SERVER_KEY_V2_PREFIX] = KeyApiV2Resource(self)
 
                 if name == "replication":
                     resources[REPLICATION_PREFIX] = ReplicationRestResource(self)
@@ -220,15 +379,23 @@ class GenericWorkerServer(HomeServer):
 
         root_resource = create_resource_tree(resources, OptionsResource())
 
-        _base.listen_http(
-            listener_config,
-            root_resource,
-            self.version_string,
-            max_request_body_size(self.config),
-            self.tls_server_context_factory,
+        _base.listen_tcp(
+            bind_addresses,
+            port,
+            SynapseSite(
+                "synapse.access.http.%s" % (site_tag,),
+                site_tag,
+                listener_config,
+                root_resource,
+                self.version_string,
+                max_request_body_size=max_request_body_size(self.config),
+                reactor=self.get_reactor(),
+            ),
             reactor=self.get_reactor(),
         )
 
+        logger.info("Synapse worker now listening on port %d", port)
+
     def start_listening(self) -> None:
         for listener in self.config.worker.worker_listeners:
             if listener.type == "http":
@@ -250,6 +417,7 @@ class GenericWorkerServer(HomeServer):
                     _base.listen_metrics(
                         listener.bind_addresses,
                         listener.port,
+                        enable_legacy_metric_names=self.config.metrics.enable_legacy_metrics,
                     )
             else:
                 logger.warning("Unsupported listener type: %s", listener.type)

synapse/app/homeserver.py

@@ -31,13 +31,14 @@ from synapse.api.urls import (
     LEGACY_MEDIA_PREFIX,
     MEDIA_R0_PREFIX,
     MEDIA_V3_PREFIX,
-    SERVER_KEY_PREFIX,
+    SERVER_KEY_V2_PREFIX,
     STATIC_PREFIX,
 )
 from synapse.app import _base
 from synapse.app._base import (
     handle_startup_exception,
-    listen_http,
+    listen_ssl,
+    listen_tcp,
     max_request_body_size,
     redirect_stdio_to_logs,
     register_start,
@@ -52,13 +53,14 @@ from synapse.http.server import (
     RootOptionsRedirectResource,
     StaticResource,
 )
+from synapse.http.site import SynapseSite
 from synapse.logging.context import LoggingContext
 from synapse.metrics import METRICS_PREFIX, MetricsResource, RegistryProxy
 from synapse.replication.http import REPLICATION_PREFIX, ReplicationRestResource
 from synapse.rest import ClientRestResource
 from synapse.rest.admin import AdminRestResource
 from synapse.rest.health import HealthResource
-from synapse.rest.key.v2 import KeyResource
+from synapse.rest.key.v2 import KeyApiV2Resource
 from synapse.rest.synapse.client import build_synapse_client_resource_tree
 from synapse.rest.well_known import well_known_resource
 from synapse.server import HomeServer
@@ -81,6 +83,8 @@ class SynapseHomeServer(HomeServer):
         self, config: HomeServerConfig, listener_config: ListenerConfig
     ) -> Iterable[Port]:
         port = listener_config.port
+        bind_addresses = listener_config.bind_addresses
+        tls = listener_config.tls
         # Must exist since this is an HTTP listener.
         assert listener_config.http_options is not None
         site_tag = listener_config.http_options.tag
@@ -136,15 +140,37 @@ class SynapseHomeServer(HomeServer):
         else:
             root_resource = OptionsResource()
 
-        ports = listen_http(
+        site = SynapseSite(
+            "synapse.access.%s.%s" % ("https" if tls else "http", site_tag),
+            site_tag,
             listener_config,
             create_resource_tree(resources, root_resource),
             self.version_string,
-            max_request_body_size(self.config),
-            self.tls_server_context_factory,
+            max_request_body_size=max_request_body_size(self.config),
             reactor=self.get_reactor(),
         )
 
+        if tls:
+            # refresh_certificate should have been called before this.
+            assert self.tls_server_context_factory is not None
+            ports = listen_ssl(
+                bind_addresses,
+                port,
+                site,
+                self.tls_server_context_factory,
+                reactor=self.get_reactor(),
+            )
+            logger.info("Synapse now listening on TCP port %d (TLS)", port)
+
+        else:
+            ports = listen_tcp(
+                bind_addresses,
+                port,
+                site,
+                reactor=self.get_reactor(),
+            )
+            logger.info("Synapse now listening on TCP port %d", port)
+
         return ports
 
     def _configure_named_resource(
@@ -189,22 +215,30 @@ class SynapseHomeServer(HomeServer):
             consent_resource: Resource = ConsentResource(self)
             if compress:
                 consent_resource = gz_wrap(consent_resource)
-            resources["/_matrix/consent"] = consent_resource
+            resources.update({"/_matrix/consent": consent_resource})
 
         if name == "federation":
             federation_resource: Resource = TransportLayerServer(self)
             if compress:
                 federation_resource = gz_wrap(federation_resource)
-            resources[FEDERATION_PREFIX] = federation_resource
+            resources.update({FEDERATION_PREFIX: federation_resource})
 
         if name == "openid":
-            resources[FEDERATION_PREFIX] = TransportLayerServer(
-                self, servlet_groups=["openid"]
+            resources.update(
+                {
+                    FEDERATION_PREFIX: TransportLayerServer(
+                        self, servlet_groups=["openid"]
+                    )
+                }
             )
 
         if name in ["static", "client"]:
-            resources[STATIC_PREFIX] = StaticResource(
-                os.path.join(os.path.dirname(synapse.__file__), "static")
+            resources.update(
+                {
+                    STATIC_PREFIX: StaticResource(
+                        os.path.join(os.path.dirname(synapse.__file__), "static")
+                    )
+                }
             )
 
         if name in ["media", "federation", "client"]:
@@ -223,7 +257,7 @@ class SynapseHomeServer(HomeServer):
                 )
 
         if name in ["keys", "federation"]:
-            resources[SERVER_KEY_PREFIX] = KeyResource(self)
+            resources[SERVER_KEY_V2_PREFIX] = KeyApiV2Resource(self)
 
         if name == "metrics" and self.config.metrics.enable_metrics:
             metrics_resource: Resource = MetricsResource(RegistryProxy)
@@ -265,6 +299,7 @@ class SynapseHomeServer(HomeServer):
                     _base.listen_metrics(
                         listener.bind_addresses,
                         listener.port,
+                        enable_legacy_metric_names=self.config.metrics.enable_legacy_metrics,
                     )
             else:
                 # this shouldn't happen, as the listener type should have been checked

synapse/appservice/__init__.py

@@ -32,9 +32,9 @@ if TYPE_CHECKING:
 
 logger = logging.getLogger(__name__)
 
-# Type for the `device_one_time_keys_count` field in an appservice transaction
+# Type for the `device_one_time_key_counts` field in an appservice transaction
 #   user ID -> {device ID -> {algorithm -> count}}
-TransactionOneTimeKeysCount = Dict[str, Dict[str, Dict[str, int]]]
+TransactionOneTimeKeyCounts = Dict[str, Dict[str, Dict[str, int]]]
 
 # Type for the `device_unused_fallback_key_types` field in an appservice transaction
 #   user ID -> {device ID -> [algorithm]}
@@ -172,24 +172,12 @@ class ApplicationService:
         Returns:
             True if this service would like to know about this room.
         """
-        # We can use `get_local_users_in_room(...)` here because an application service
-        # can only be interested in local users of the server it's on (ignore any remote
-        # users that might match the user namespace regex).
-        #
-        # In the future, we can consider re-using
-        # `store.get_app_service_users_in_room` which is very similar to this
-        # function but has a slightly worse performance than this because we
-        # have an early escape-hatch if we find a single user that the
-        # appservice is interested in. The juice would be worth the squeeze if
-        # `store.get_app_service_users_in_room` was used in more places besides
-        # an experimental MSC. But for now we can avoid doing more work and
-        # barely using it later.
-        local_user_ids = await store.get_local_users_in_room(
+        member_list = await store.get_users_in_room(
             room_id, on_invalidate=cache_context.invalidate
         )
 
         # check joined member events
-        for user_id in local_user_ids:
+        for user_id in member_list:
             if self.is_interested_in_user(user_id):
                 return True
         return False
@@ -376,7 +364,7 @@ class AppServiceTransaction:
         events: List[EventBase],
         ephemeral: List[JsonDict],
         to_device_messages: List[JsonDict],
-        one_time_keys_count: TransactionOneTimeKeysCount,
+        one_time_key_counts: TransactionOneTimeKeyCounts,
         unused_fallback_keys: TransactionUnusedFallbackKeys,
         device_list_summary: DeviceListUpdates,
     ):
@@ -385,7 +373,7 @@ class AppServiceTransaction:
         self.events = events
         self.ephemeral = ephemeral
         self.to_device_messages = to_device_messages
-        self.one_time_keys_count = one_time_keys_count
+        self.one_time_key_counts = one_time_key_counts
         self.unused_fallback_keys = unused_fallback_keys
         self.device_list_summary = device_list_summary
 
@@ -402,7 +390,7 @@ class AppServiceTransaction:
             events=self.events,
             ephemeral=self.ephemeral,
             to_device_messages=self.to_device_messages,
-            one_time_keys_count=self.one_time_keys_count,
+            one_time_key_counts=self.one_time_key_counts,
             unused_fallback_keys=self.unused_fallback_keys,
             device_list_summary=self.device_list_summary,
             txn_id=self.id,

synapse/appservice/api.py

@@ -23,7 +23,7 @@ from synapse.api.constants import EventTypes, Membership, ThirdPartyEntityKind
 from synapse.api.errors import CodeMessageException
 from synapse.appservice import (
     ApplicationService,
-    TransactionOneTimeKeysCount,
+    TransactionOneTimeKeyCounts,
     TransactionUnusedFallbackKeys,
 )
 from synapse.events import EventBase
@@ -262,7 +262,7 @@ class ApplicationServiceApi(SimpleHttpClient):
         events: List[EventBase],
         ephemeral: List[JsonDict],
         to_device_messages: List[JsonDict],
-        one_time_keys_count: TransactionOneTimeKeysCount,
+        one_time_key_counts: TransactionOneTimeKeyCounts,
         unused_fallback_keys: TransactionUnusedFallbackKeys,
         device_list_summary: DeviceListUpdates,
         txn_id: Optional[int] = None,
@@ -310,13 +310,10 @@ class ApplicationServiceApi(SimpleHttpClient):
 
         # TODO: Update to stable prefixes once MSC3202 completes FCP merge
         if service.msc3202_transaction_extensions:
-            if one_time_keys_count:
+            if one_time_key_counts:
                 body[
                     "org.matrix.msc3202.device_one_time_key_counts"
-                ] = one_time_keys_count
-                body[
-                    "org.matrix.msc3202.device_one_time_keys_count"
-                ] = one_time_keys_count
+                ] = one_time_key_counts
             if unused_fallback_keys:
                 body[
                     "org.matrix.msc3202.device_unused_fallback_key_types"

synapse/appservice/scheduler.py

@@ -64,7 +64,7 @@ from typing import (
 from synapse.appservice import (
     ApplicationService,
     ApplicationServiceState,
-    TransactionOneTimeKeysCount,
+    TransactionOneTimeKeyCounts,
     TransactionUnusedFallbackKeys,
 )
 from synapse.appservice.api import ApplicationServiceApi
@@ -258,7 +258,7 @@ class _ServiceQueuer:
                 ):
                     return
 
-                one_time_keys_count: Optional[TransactionOneTimeKeysCount] = None
+                one_time_key_counts: Optional[TransactionOneTimeKeyCounts] = None
                 unused_fallback_keys: Optional[TransactionUnusedFallbackKeys] = None
 
                 if (
@@ -269,7 +269,7 @@ class _ServiceQueuer:
                     # for the users which are mentioned in this transaction,
                     # as well as the appservice's sender.
                     (
-                        one_time_keys_count,
+                        one_time_key_counts,
                         unused_fallback_keys,
                     ) = await self._compute_msc3202_otk_counts_and_fallback_keys(
                         service, events, ephemeral, to_device_messages_to_send
@@ -281,7 +281,7 @@ class _ServiceQueuer:
                         events,
                         ephemeral,
                         to_device_messages_to_send,
-                        one_time_keys_count,
+                        one_time_key_counts,
                         unused_fallback_keys,
                         device_list_summary,
                     )
@@ -296,7 +296,7 @@ class _ServiceQueuer:
         events: Iterable[EventBase],
         ephemerals: Iterable[JsonDict],
         to_device_messages: Iterable[JsonDict],
-    ) -> Tuple[TransactionOneTimeKeysCount, TransactionUnusedFallbackKeys]:
+    ) -> Tuple[TransactionOneTimeKeyCounts, TransactionUnusedFallbackKeys]:
         """
         Given a list of the events, ephemeral messages and to-device messages,
         - first computes a list of application services users that may have
@@ -367,7 +367,7 @@ class _TransactionController:
         events: List[EventBase],
         ephemeral: Optional[List[JsonDict]] = None,
         to_device_messages: Optional[List[JsonDict]] = None,
-        one_time_keys_count: Optional[TransactionOneTimeKeysCount] = None,
+        one_time_key_counts: Optional[TransactionOneTimeKeyCounts] = None,
         unused_fallback_keys: Optional[TransactionUnusedFallbackKeys] = None,
         device_list_summary: Optional[DeviceListUpdates] = None,
     ) -> None:
@@ -380,7 +380,7 @@ class _TransactionController:
             events: The persistent events to include in the transaction.
             ephemeral: The ephemeral events to include in the transaction.
             to_device_messages: The to-device messages to include in the transaction.
-            one_time_keys_count: Counts of remaining one-time keys for relevant
+            one_time_key_counts: Counts of remaining one-time keys for relevant
                 appservice devices in the transaction.
             unused_fallback_keys: Lists of unused fallback keys for relevant
                 appservice devices in the transaction.
@@ -397,7 +397,7 @@ class _TransactionController:
                 events=events,
                 ephemeral=ephemeral or [],
                 to_device_messages=to_device_messages or [],
-                one_time_keys_count=one_time_keys_count or {},
+                one_time_key_counts=one_time_key_counts or {},
                 unused_fallback_keys=unused_fallback_keys or {},
                 device_list_summary=device_list_summary or DeviceListUpdates(),
             )

synapse/config/experimental.py

@@ -16,7 +16,6 @@ from typing import Any, Optional
 
 import attr
 
-from synapse.api.room_versions import KNOWN_ROOM_VERSIONS, RoomVersions
 from synapse.config._base import Config
 from synapse.types import JsonDict
 
@@ -54,6 +53,9 @@ class ExperimentalConfig(Config):
         # MSC3266 (room summary api)
         self.msc3266_enabled: bool = experimental.get("msc3266_enabled", False)
 
+        # MSC3030 (Jump to date API endpoint)
+        self.msc3030_enabled: bool = experimental.get("msc3030_enabled", False)
+
         # MSC2409 (this setting only relates to optionally sending to-device messages).
         # Presence, typing and read receipt EDUs are already sent to application services that
         # have opted in to receive them. If enabled, this adds to-device messages to that list.
@@ -96,9 +98,6 @@ class ExperimentalConfig(Config):
         # MSC3773: Thread notifications
         self.msc3773_enabled: bool = experimental.get("msc3773_enabled", False)
 
-        # MSC3664: Pushrules to match on related events
-        self.msc3664_enabled: bool = experimental.get("msc3664_enabled", False)
-
         # MSC3848: Introduce errcodes for specific event sending failures
         self.msc3848_enabled: bool = experimental.get("msc3848_enabled", False)
 
@@ -126,13 +125,3 @@ class ExperimentalConfig(Config):
         self.msc3886_endpoint: Optional[str] = experimental.get(
             "msc3886_endpoint", None
         )
-
-        # MSC3912: Relation-based redactions.
-        self.msc3912_enabled: bool = experimental.get("msc3912_enabled", False)
-
-        # MSC1767 and friends: Extensible Events
-        self.msc1767_enabled: bool = experimental.get("msc1767_enabled", False)
-        if self.msc1767_enabled:
-            # Enable room version (and thus applicable push rules from MSC3931/3932)
-            version_id = RoomVersions.MSC1767v10.identifier
-            KNOWN_ROOM_VERSIONS[version_id] = RoomVersions.MSC1767v10

synapse/config/logger.py

@@ -53,7 +53,7 @@ DEFAULT_LOG_CONFIG = Template(
 # Synapse also supports structured logging for machine readable logs which can
 # be ingested by ELK stacks. See [2] for details.
 #
-# [1]: https://docs.python.org/3/library/logging.config.html#configuration-dictionary-schema
+# [1]: https://docs.python.org/3.7/library/logging.config.html#configuration-dictionary-schema
 # [2]: https://matrix-org.github.io/synapse/latest/structured_logging.html
 
 version: 1
@@ -317,9 +317,10 @@ def setup_logging(
     Set up the logging subsystem.
 
     Args:
-        config: configuration data
+        config (LoggingConfig | synapse.config.worker.WorkerConfig):
+            configuration data
 
-        use_worker_options: True to use the 'worker_log_config' option
+        use_worker_options (bool): True to use the 'worker_log_config' option
             instead of 'log_config'.
 
         logBeginner: The Twisted logBeginner to use.

synapse/config/metrics.py

@@ -43,6 +43,8 @@ class MetricsConfig(Config):
     def read_config(self, config: JsonDict, **kwargs: Any) -> None:
         self.enable_metrics = config.get("enable_metrics", False)
 
+        self.enable_legacy_metrics = config.get("enable_legacy_metrics", True)
+
         self.report_stats = config.get("report_stats", None)
         self.report_stats_endpoint = config.get(
             "report_stats_endpoint", "https://matrix.org/report-usage-stats/push"

synapse/config/oidc.py

@@ -123,8 +123,6 @@ OIDC_PROVIDER_CONFIG_SCHEMA = {
         "userinfo_endpoint": {"type": "string"},
         "jwks_uri": {"type": "string"},
         "skip_verification": {"type": "boolean"},
-        "backchannel_logout_enabled": {"type": "boolean"},
-        "backchannel_logout_ignore_sub": {"type": "boolean"},
         "user_profile_method": {
             "type": "string",
             "enum": ["auto", "userinfo_endpoint"],
@@ -294,10 +292,6 @@ def _parse_oidc_config_dict(
         token_endpoint=oidc_config.get("token_endpoint"),
         userinfo_endpoint=oidc_config.get("userinfo_endpoint"),
         jwks_uri=oidc_config.get("jwks_uri"),
-        backchannel_logout_enabled=oidc_config.get("backchannel_logout_enabled", False),
-        backchannel_logout_ignore_sub=oidc_config.get(
-            "backchannel_logout_ignore_sub", False
-        ),
         skip_verification=oidc_config.get("skip_verification", False),
         user_profile_method=oidc_config.get("user_profile_method", "auto"),
         allow_existing_users=oidc_config.get("allow_existing_users", False),
@@ -374,12 +368,6 @@ class OidcProviderConfig:
     # "openid" scope is used.
     jwks_uri: Optional[str]
 
-    # Whether Synapse should react to backchannel logouts
-    backchannel_logout_enabled: bool
-
-    # Whether Synapse should ignore the `sub` claim in backchannel logouts or not.
-    backchannel_logout_ignore_sub: bool
-
     # Whether to skip metadata verification
     skip_verification: bool
 

synapse/config/push.py

@@ -26,7 +26,6 @@ class PushConfig(Config):
     def read_config(self, config: JsonDict, **kwargs: Any) -> None:
         push_config = config.get("push") or {}
         self.push_include_content = push_config.get("include_content", True)
-        self.enable_push = push_config.get("enabled", True)
         self.push_group_unread_count_by_room = push_config.get(
             "group_unread_count_by_room", True
         )

synapse/config/ratelimiting.py

@@ -150,5 +150,8 @@ class RatelimitConfig(Config):
 
         self.rc_third_party_invite = RatelimitSettings(
             config.get("rc_third_party_invite", {}),
-            defaults={"per_second": 0.0025, "burst_count": 5},
+            defaults={
+                "per_second": self.rc_message.per_second,
+                "burst_count": self.rc_message.burst_count,
+            },
         )

synapse/config/workers.py

@@ -29,6 +29,20 @@ from ._base import (
 )
 from .server import DIRECT_TCP_ERROR, ListenerConfig, parse_listener_def
 
+_FEDERATION_SENDER_WITH_SEND_FEDERATION_ENABLED_ERROR = """
+The send_federation config option must be disabled in the main
+synapse process before they can be run in a separate worker.
+
+Please add ``send_federation: false`` to the main config
+"""
+
+_PUSHER_WITH_START_PUSHERS_ENABLED_ERROR = """
+The start_pushers config option must be disabled in the main
+synapse process before they can be run in a separate worker.
+
+Please add ``start_pushers: false`` to the main config
+"""
+
 _DEPRECATED_WORKER_DUTY_OPTION_USED = """
 The '%s' configuration option is deprecated and will be removed in a future
 Synapse version. Please use ``%s: name_of_worker`` instead.
@@ -53,7 +67,6 @@ class InstanceLocationConfig:
 
     host: str
     port: int
-    tls: bool = False
 
 
 @attr.s
@@ -136,25 +149,13 @@ class WorkerConfig(Config):
         # The port on the main synapse for HTTP replication endpoint
         self.worker_replication_http_port = config.get("worker_replication_http_port")
 
-        # The tls mode on the main synapse for HTTP replication endpoint.
-        # For backward compatibility this defaults to False.
-        self.worker_replication_http_tls = config.get(
-            "worker_replication_http_tls", False
-        )
-
         # The shared secret used for authentication when connecting to the main synapse.
         self.worker_replication_secret = config.get("worker_replication_secret", None)
 
         self.worker_name = config.get("worker_name", self.worker_app)
         self.instance_name = self.worker_name or "master"
 
-        # FIXME: Remove this check after a suitable amount of time.
         self.worker_main_http_uri = config.get("worker_main_http_uri", None)
-        if self.worker_main_http_uri is not None:
-            logger.warning(
-                "The config option worker_main_http_uri is unused since Synapse 1.73. "
-                "It can be safely removed from your configuration."
-            )
 
         # This option is really only here to support `--manhole` command line
         # argument.
@@ -168,12 +169,40 @@ class WorkerConfig(Config):
                 )
             )
 
-        federation_sender_instances = self._worker_names_performing_this_duty(
-            config,
-            "send_federation",
-            "synapse.app.federation_sender",
-            "federation_sender_instances",
-        )
+        # Handle federation sender configuration.
+        #
+        # There are two ways of configuring which instances handle federation
+        # sending:
+        #   1. The old way where "send_federation" is set to false and running a
+        #      `synapse.app.federation_sender` worker app.
+        #   2. Specifying the workers sending federation in
+        #      `federation_sender_instances`.
+        #
+
+        send_federation = config.get("send_federation", True)
+
+        federation_sender_instances = config.get("federation_sender_instances")
+        if federation_sender_instances is None:
+            # Default to an empty list, which means "another, unknown, worker is
+            # responsible for it".
+            federation_sender_instances = []
+
+            # If no federation sender instances are set we check if
+            # `send_federation` is set, which means use master
+            if send_federation:
+                federation_sender_instances = ["master"]
+
+            if self.worker_app == "synapse.app.federation_sender":
+                if send_federation:
+                    # If we're running federation senders, and not using
+                    # `federation_sender_instances`, then we should have
+                    # explicitly set `send_federation` to false.
+                    raise ConfigError(
+                        _FEDERATION_SENDER_WITH_SEND_FEDERATION_ENABLED_ERROR
+                    )
+
+                federation_sender_instances = [self.worker_name]
+
         self.send_federation = self.instance_name in federation_sender_instances
         self.federation_shard_config = ShardedWorkerHandlingConfig(
             federation_sender_instances
@@ -240,12 +269,27 @@ class WorkerConfig(Config):
         )
 
         # Handle sharded push
-        pusher_instances = self._worker_names_performing_this_duty(
-            config,
-            "start_pushers",
-            "synapse.app.pusher",
-            "pusher_instances",
-        )
+        start_pushers = config.get("start_pushers", True)
+        pusher_instances = config.get("pusher_instances")
+        if pusher_instances is None:
+            # Default to an empty list, which means "another, unknown, worker is
+            # responsible for it".
+            pusher_instances = []
+
+            # If no pushers instances are set we check if `start_pushers` is
+            # set, which means use master
+            if start_pushers:
+                pusher_instances = ["master"]
+
+            if self.worker_app == "synapse.app.pusher":
+                if start_pushers:
+                    # If we're running pushers, and not using
+                    # `pusher_instances`, then we should have explicitly set
+                    # `start_pushers` to false.
+                    raise ConfigError(_PUSHER_WITH_START_PUSHERS_ENABLED_ERROR)
+
+                pusher_instances = [self.instance_name]
+
         self.start_pushers = self.instance_name in pusher_instances
         self.pusher_shard_config = ShardedWorkerHandlingConfig(pusher_instances)
 
@@ -368,64 +412,6 @@ class WorkerConfig(Config):
         # (By this point, these are either the same value or only one is not None.)
         return bool(new_option_should_run_here or legacy_option_should_run_here)
 
-    def _worker_names_performing_this_duty(
-        self,
-        config: Dict[str, Any],
-        legacy_option_name: str,
-        legacy_app_name: str,
-        modern_instance_list_name: str,
-    ) -> List[str]:
-        """
-        Retrieves the names of the workers handling a given duty, by either legacy
-        option or instance list.
-
-        There are two ways of configuring which instances handle a given duty, e.g.
-        for configuring pushers:
-
-        1. The old way where "start_pushers" is set to false and running a
-          `synapse.app.pusher'` worker app.
-        2. Specifying the workers sending federation in `pusher_instances`.
-
-        Args:
-            config: settings read from yaml.
-            legacy_option_name: the old way of enabling options. e.g. 'start_pushers'
-            legacy_app_name: The historical app name. e.g. 'synapse.app.pusher'
-            modern_instance_list_name: the string name of the new instance_list. e.g.
-            'pusher_instances'
-
-        Returns:
-            A list of worker instance names handling the given duty.
-        """
-
-        legacy_option = config.get(legacy_option_name, True)
-
-        worker_instances = config.get(modern_instance_list_name)
-        if worker_instances is None:
-            # Default to an empty list, which means "another, unknown, worker is
-            # responsible for it".
-            worker_instances = []
-
-            # If no worker instances are set we check if the legacy option
-            # is set, which means use the main process.
-            if legacy_option:
-                worker_instances = ["master"]
-
-            if self.worker_app == legacy_app_name:
-                if legacy_option:
-                    # If we're using `legacy_app_name`, and not using
-                    # `modern_instance_list_name`, then we should have
-                    # explicitly set `legacy_option_name` to false.
-                    raise ConfigError(
-                        f"The '{legacy_option_name}' config option must be disabled in "
-                        "the main synapse process before they can be run in a separate "
-                        "worker.\n"
-                        f"Please add `{legacy_option_name}: false` to the main config.\n",
-                    )
-
-                worker_instances = [self.worker_name]
-
-        return worker_instances
-
     def read_arguments(self, args: argparse.Namespace) -> None:
         # We support a bunch of command line arguments that override options in
         # the config. A lot of these options have a worker_* prefix when running

synapse/crypto/keyring.py

@@ -14,6 +14,7 @@
 
 import abc
 import logging
+import urllib
 from typing import TYPE_CHECKING, Callable, Dict, Iterable, List, Optional, Tuple
 
 import attr
@@ -212,7 +213,7 @@ class Keyring:
 
     def verify_json_objects_for_server(
         self, server_and_json: Iterable[Tuple[str, dict, int]]
-    ) -> List["defer.Deferred[None]"]:
+    ) -> List[defer.Deferred]:
         """Bulk verifies signatures of json objects, bulk fetching keys as
         necessary.
 
@@ -225,9 +226,10 @@ class Keyring:
                 valid.
 
         Returns:
-            For each input triplet, a deferred indicating success or failure to
-            verify each json object's signature for the given server_name. The
-            deferreds run their callbacks in the sentinel logcontext.
+            List<Deferred[None]>: for each input triplet, a deferred indicating success
+                or failure to verify each json object's signature for the given
+                server_name. The deferreds run their callbacks in the sentinel
+                logcontext.
         """
         return [
             run_in_background(
@@ -812,27 +814,31 @@ class ServerKeyFetcher(BaseV2KeyFetcher):
 
         results = {}
 
-        async def get_keys(key_to_fetch_item: _FetchKeyRequest) -> None:
+        async def get_key(key_to_fetch_item: _FetchKeyRequest) -> None:
             server_name = key_to_fetch_item.server_name
+            key_ids = key_to_fetch_item.key_ids
 
             try:
-                keys = await self.get_server_verify_keys_v2_direct(server_name)
+                keys = await self.get_server_verify_key_v2_direct(server_name, key_ids)
                 results[server_name] = keys
             except KeyLookupError as e:
-                logger.warning("Error looking up keys from %s: %s", server_name, e)
+                logger.warning(
+                    "Error looking up keys %s from %s: %s", key_ids, server_name, e
+                )
             except Exception:
-                logger.exception("Error getting keys from %s", server_name)
+                logger.exception("Error getting keys %s from %s", key_ids, server_name)
 
-        await yieldable_gather_results(get_keys, keys_to_fetch)
+        await yieldable_gather_results(get_key, keys_to_fetch)
         return results
 
-    async def get_server_verify_keys_v2_direct(
-        self, server_name: str
+    async def get_server_verify_key_v2_direct(
+        self, server_name: str, key_ids: Iterable[str]
     ) -> Dict[str, FetchKeyResult]:
         """
 
         Args:
-            server_name: Server to request keys from
+            server_name:
+            key_ids:
 
         Returns:
             Map from key ID to lookup result
@@ -840,41 +846,57 @@ class ServerKeyFetcher(BaseV2KeyFetcher):
         Raises:
             KeyLookupError if there was a problem making the lookup
         """
-        time_now_ms = self.clock.time_msec()
-        try:
-            response = await self.client.get_json(
-                destination=server_name,
-                path="/_matrix/key/v2/server",
-                ignore_backoff=True,
-                # we only give the remote server 10s to respond. It should be an
-                # easy request to handle, so if it doesn't reply within 10s, it's
-                # probably not going to.
-                #
-                # Furthermore, when we are acting as a notary server, we cannot
-                # wait all day for all of the origin servers, as the requesting
-                # server will otherwise time out before we can respond.
-                #
-                # (Note that get_json may make 4 attempts, so this can still take
-                # almost 45 seconds to fetch the headers, plus up to another 60s to
-                # read the response).
-                timeout=10000,
-            )
-        except (NotRetryingDestination, RequestSendFailed) as e:
-            # these both have str() representations which we can't really improve
-            # upon
-            raise KeyLookupError(str(e))
-        except HttpResponseException as e:
-            raise KeyLookupError("Remote server returned an error: %s" % (e,))
+        keys: Dict[str, FetchKeyResult] = {}
 
-        assert isinstance(response, dict)
-        if response["server_name"] != server_name:
-            raise KeyLookupError(
-                "Expected a response for server %r not %r"
-                % (server_name, response["server_name"])
-            )
+        for requested_key_id in key_ids:
+            # we may have found this key as a side-effect of asking for another.
+            if requested_key_id in keys:
+                continue
 
-        return await self.process_v2_response(
-            from_server=server_name,
-            response_json=response,
-            time_added_ms=time_now_ms,
-        )
+            time_now_ms = self.clock.time_msec()
+            try:
+                response = await self.client.get_json(
+                    destination=server_name,
+                    path="/_matrix/key/v2/server/"
+                    + urllib.parse.quote(requested_key_id),
+                    ignore_backoff=True,
+                    # we only give the remote server 10s to respond. It should be an
+                    # easy request to handle, so if it doesn't reply within 10s, it's
+                    # probably not going to.
+                    #
+                    # Furthermore, when we are acting as a notary server, we cannot
+                    # wait all day for all of the origin servers, as the requesting
+                    # server will otherwise time out before we can respond.
+                    #
+                    # (Note that get_json may make 4 attempts, so this can still take
+                    # almost 45 seconds to fetch the headers, plus up to another 60s to
+                    # read the response).
+                    timeout=10000,
+                )
+            except (NotRetryingDestination, RequestSendFailed) as e:
+                # these both have str() representations which we can't really improve
+                # upon
+                raise KeyLookupError(str(e))
+            except HttpResponseException as e:
+                raise KeyLookupError("Remote server returned an error: %s" % (e,))
+
+            assert isinstance(response, dict)
+            if response["server_name"] != server_name:
+                raise KeyLookupError(
+                    "Expected a response for server %r not %r"
+                    % (server_name, response["server_name"])
+                )
+
+            response_keys = await self.process_v2_response(
+                from_server=server_name,
+                response_json=response,
+                time_added_ms=time_now_ms,
+            )
+            await self.store.store_server_verify_keys(
+                server_name,
+                time_now_ms,
+                ((server_name, key_id, key) for key_id, key in response_keys.items()),
+            )
+            keys.update(response_keys)
+
+        return keys

synapse/events/__init__.py

@@ -597,7 +597,8 @@ def _event_type_from_format_version(
         format_version: The event format version
 
     Returns:
-        A type that can be initialized as per the initializer of `FrozenEvent`
+        type: A type that can be initialized as per the initializer of
+        `FrozenEvent`
     """
 
     if format_version == EventFormatVersions.ROOM_V1_V2:

synapse/events/builder.py

@@ -128,7 +128,6 @@ class EventBuilder:
                 state_filter=StateFilter.from_types(
                     auth_types_for_event(self.room_version, self)
                 ),
-                await_full_state=False,
             )
             auth_event_ids = self._event_auth_handler.compute_auth_events(
                 self, state_ids