Merge commit '1381cd05b' into anoa/dinsic_release_1_31_0

2021-04-23 12:22:55 +01:00
parent 2e3baa1f49 1381cd05b0
commit 5a514a3e11
46 changed files with 103 additions and 55 deletions
--- a/.circleci/config.yml
+++ b/.circleci/config.yml
@@ -14,7 +14,7 @@ jobs:
          platforms: linux/amd64
      - docker_build:
          tag: -t matrixdotorg/synapse:${CIRCLE_TAG}
-          platforms: linux/amd64,linux/arm/v7,linux/arm64
+          platforms: linux/amd64,linux/arm64

  dockerhubuploadlatest:
    docker:
@@ -27,7 +27,7 @@ jobs:
      # until all of the platforms are built.
      - docker_build:
          tag: -t matrixdotorg/synapse:latest
-          platforms: linux/amd64,linux/arm/v7,linux/arm64
+          platforms: linux/amd64,linux/arm64

 workflows:
  build:
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -1,3 +1,92 @@
+Synapse 1.28.0rc1 (2021-02-18)
+==============================
+
+Note that this release drops support for ARMv7 in the official Docker images, due to repeated problems building for ARMv7 (and the associated maintenance burden this entails).
+
+This release also fixes the documentation included in v1.27.0 around the callback URI for SAML2 identity providers. If your server is configured to use single sign-on via a SAML2 IdP, you may need to make configuration changes. Please review [UPGRADE.rst](UPGRADE.rst) for more details on these changes.
+
+Removal warning
+---------------
+
+The v1 list accounts API is deprecated and will be removed in a future release.
+This API was undocumented and misleading. It can be replaced by the
+[v2 list accounts API](https://github.com/matrix-org/synapse/blob/master/docs/admin_api/user_admin_api.rst#list-accounts),
+which has been available since Synapse 1.7.0 (2019-12-13).
+
+Please check if you're using any scripts which use the admin API and replace
+`GET /_synapse/admin/v1/users/<user_id>` with `GET /_synapse/admin/v2/users`.
+
+
+Features
+--------
+
+- New API /_synapse/admin/rooms/{roomId}/context/{eventId}. ([\#9150](https://github.com/matrix-org/synapse/issues/9150))
+- Further improvements to the user experience of registration via single sign-on. ([\#9300](https://github.com/matrix-org/synapse/issues/9300), [\#9301](https://github.com/matrix-org/synapse/issues/9301))
+- Add hook to spam checker modules that allow checking file uploads and remote downloads. ([\#9311](https://github.com/matrix-org/synapse/issues/9311))
+- Add support for receiving OpenID Connect authentication responses via form `POST`s rather than `GET`s. ([\#9376](https://github.com/matrix-org/synapse/issues/9376))
+- Add the shadow-banning status to the display user admin API. ([\#9400](https://github.com/matrix-org/synapse/issues/9400))
+
+
+Bugfixes
+--------
+
+- Fix long-standing bug where sending email push would fail for rooms that the server had since left. ([\#9257](https://github.com/matrix-org/synapse/issues/9257))
+- Fix bug in Synapse 1.27.0rc1 which meant the "session expired" error page during SSO registration was badly formatted. ([\#9296](https://github.com/matrix-org/synapse/issues/9296))
+- Assert a maximum length for some parameters for spec compliance. ([\#9321](https://github.com/matrix-org/synapse/issues/9321), [\#9393](https://github.com/matrix-org/synapse/issues/9393))
+- Fix additional errors when previewing URLs: "AttributeError 'NoneType' object has no attribute 'xpath'" and "ValueError: Unicode strings with encoding declaration are not supported. Please use bytes input or XML fragments without declaration.". ([\#9333](https://github.com/matrix-org/synapse/issues/9333))
+- Fix a bug causing Synapse to impose the wrong type constraints on fields when processing responses from appservices to `/_matrix/app/v1/thirdparty/user/{protocol}`. ([\#9361](https://github.com/matrix-org/synapse/issues/9361))
+- Fix bug where Synapse would occaisonally stop reconnecting after the connection was lost. ([\#9391](https://github.com/matrix-org/synapse/issues/9391))
+- Fix a long-standing bug when upgrading a room: "TypeError: '>' not supported between instances of 'NoneType' and 'int'". ([\#9395](https://github.com/matrix-org/synapse/issues/9395))
+- Reduce the amount of memory used when generating the URL preview of a file that is larger than the `max_spider_size`. ([\#9421](https://github.com/matrix-org/synapse/issues/9421))
+- Fix a long-standing bug in the deduplication of old presence, resulting in no deduplication. ([\#9425](https://github.com/matrix-org/synapse/issues/9425))
+- The `ui_auth.session_timeout` configuration setting can now be specified in terms of number of seconds/minutes/etc/. Contributed by Rishabh Arya. ([\#9426](https://github.com/matrix-org/synapse/issues/9426))
+- Fix a bug introduced in v1.27.0: "TypeError: int() argument must be a string, a bytes-like object or a number, not 'NoneType." related to the user directory. ([\#9428](https://github.com/matrix-org/synapse/issues/9428))
+
+
+Updates to the Docker image
+---------------------------
+
+- Drop support for ARMv7 in Docker images. ([\#9433](https://github.com/matrix-org/synapse/issues/9433))
+
+
+Improved Documentation
+----------------------
+
+- Reorganizing CHANGELOG.md. ([\#9281](https://github.com/matrix-org/synapse/issues/9281))
+- Add note to `auto_join_rooms` config option explaining existing rooms must be publicly joinable. ([\#9291](https://github.com/matrix-org/synapse/issues/9291))
+- Correct name of Synapse's service file in TURN howto. ([\#9308](https://github.com/matrix-org/synapse/issues/9308))
+- Fix the braces in the `oidc_providers` section of the sample config. ([\#9317](https://github.com/matrix-org/synapse/issues/9317))
+- Update installation instructions on Fedora. ([\#9322](https://github.com/matrix-org/synapse/issues/9322))
+- Add HTTP/2 support to the nginx example configuration. Contributed by David Vo. ([\#9390](https://github.com/matrix-org/synapse/issues/9390))
+- Update docs for using Gitea as OpenID provider. ([\#9404](https://github.com/matrix-org/synapse/issues/9404))
+- Document that pusher instances are shardable. ([\#9407](https://github.com/matrix-org/synapse/issues/9407))
+- Fix erroneous documentation from v1.27.0 about updating the SAML2 callback URL. ([\#9434](https://github.com/matrix-org/synapse/issues/9434))
+
+
+Deprecations and Removals
+-------------------------
+
+- Deprecate old admin API `GET /_synapse/admin/v1/users/<user_id>`. ([\#9429](https://github.com/matrix-org/synapse/issues/9429))
+
+
+Internal Changes
+----------------
+
+- Fix 'object name reserved for internal use' errors with recent versions of SQLite. ([\#9003](https://github.com/matrix-org/synapse/issues/9003))
+- Add experimental support for running Synapse with PyPy. ([\#9123](https://github.com/matrix-org/synapse/issues/9123))
+- Deny access to additional IP addresses by default. ([\#9240](https://github.com/matrix-org/synapse/issues/9240))
+- Update the `Cursor` type hints to better match PEP 249. ([\#9299](https://github.com/matrix-org/synapse/issues/9299))
+- Add debug logging for SRV lookups. Contributed by @Bubu. ([\#9305](https://github.com/matrix-org/synapse/issues/9305))
+- Improve logging for OIDC login flow. ([\#9307](https://github.com/matrix-org/synapse/issues/9307))
+- Share the code for handling required attributes between the CAS and SAML handlers. ([\#9326](https://github.com/matrix-org/synapse/issues/9326))
+- Clean up the code to load the metadata for OpenID Connect identity providers. ([\#9362](https://github.com/matrix-org/synapse/issues/9362))
+- Convert tests to use `HomeserverTestCase`. ([\#9377](https://github.com/matrix-org/synapse/issues/9377), [\#9396](https://github.com/matrix-org/synapse/issues/9396))
+- Update the version of black used to 20.8b1. ([\#9381](https://github.com/matrix-org/synapse/issues/9381))
+- Allow OIDC config to override discovered values. ([\#9384](https://github.com/matrix-org/synapse/issues/9384))
+- Remove some dead code from the acceptance of room invites path. ([\#9394](https://github.com/matrix-org/synapse/issues/9394))
+- Clean up an unused method in the presence handler code. ([\#9408](https://github.com/matrix-org/synapse/issues/9408))
+
+
 Synapse 1.27.0 (2021-02-16)
 ===========================

--- a/changelog.d/9003.misc
+++ b/changelog.d/9003.misc
@@ -1 +0,0 @@
-Fix 'object name reserved for internal use' errors with recent versions of SQLite.
--- a/changelog.d/9123.misc
+++ b/changelog.d/9123.misc
@@ -1 +0,0 @@
-Add experimental support for running Synapse with PyPy.
--- a/changelog.d/9150.feature
+++ b/changelog.d/9150.feature
@@ -1 +0,0 @@
-New API /_synapse/admin/rooms/{roomId}/context/{eventId}.
--- a/changelog.d/9240.misc
+++ b/changelog.d/9240.misc
@@ -1 +0,0 @@
-Deny access to additional IP addresses by default.
--- a/changelog.d/9257.bugfix
+++ b/changelog.d/9257.bugfix
@@ -1 +0,0 @@
-Fix long-standing bug where sending email push would fail for rooms that the server had since left.
--- a/changelog.d/9281.doc
+++ b/changelog.d/9281.doc
@@ -1 +0,0 @@
-Reorganizing CHANGELOG.md.
--- a/changelog.d/9291.doc
+++ b/changelog.d/9291.doc
@@ -1 +0,0 @@
-Add note to `auto_join_rooms` config option explaining existing rooms must be publicly joinable.
--- a/changelog.d/9296.bugfix
+++ b/changelog.d/9296.bugfix
@@ -1 +0,0 @@
-Fix bug in Synapse 1.27.0rc1 which meant the "session expired" error page during SSO registration was badly formatted.
--- a/changelog.d/9299.misc
+++ b/changelog.d/9299.misc
@@ -1 +0,0 @@
-Update the `Cursor` type hints to better match PEP 249.
--- a/changelog.d/9300.feature
+++ b/changelog.d/9300.feature
@@ -1 +0,0 @@
-Further improvements to the user experience of registration via single sign-on.
--- a/changelog.d/9301.feature
+++ b/changelog.d/9301.feature
@@ -1 +0,0 @@
-Further improvements to the user experience of registration via single sign-on.
--- a/changelog.d/9305.misc
+++ b/changelog.d/9305.misc
@@ -1 +0,0 @@
-Add debug logging for SRV lookups. Contributed by @Bubu.
--- a/changelog.d/9307.misc
+++ b/changelog.d/9307.misc
@@ -1 +0,0 @@
-Improve logging for OIDC login flow.
--- a/changelog.d/9308.doc
+++ b/changelog.d/9308.doc
@@ -1 +0,0 @@
-Correct name of Synapse's service file in TURN howto.
--- a/changelog.d/9311.feature
+++ b/changelog.d/9311.feature
@@ -1 +0,0 @@
-Add hook to spam checker modules that allow checking file uploads and remote downloads.
--- a/changelog.d/9317.doc
+++ b/changelog.d/9317.doc
@@ -1 +0,0 @@
-Fix the braces in the `oidc_providers` section of the sample config.
--- a/changelog.d/9321.bugfix
+++ b/changelog.d/9321.bugfix
@@ -1 +0,0 @@
-Assert a maximum length for some parameters for spec compliance.
--- a/changelog.d/9322.doc
+++ b/changelog.d/9322.doc
@@ -1 +0,0 @@
-Update installation instructions on Fedora.
--- a/changelog.d/9326.misc
+++ b/changelog.d/9326.misc
@@ -1 +0,0 @@
-Share the code for handling required attributes between the CAS and SAML handlers.
--- a/changelog.d/9333.bugfix
+++ b/changelog.d/9333.bugfix
@@ -1 +0,0 @@
-Fix additional errors when previewing URLs: "AttributeError 'NoneType' object has no attribute 'xpath'" and "ValueError: Unicode strings with encoding declaration are not supported. Please use bytes input or XML fragments without declaration.".
--- a/changelog.d/9361.bugfix
+++ b/changelog.d/9361.bugfix
@@ -1 +0,0 @@
-Fix a bug causing Synapse to impose the wrong type constraints on fields when processing responses from appservices to `/_matrix/app/v1/thirdparty/user/{protocol}`.
--- a/changelog.d/9362.misc
+++ b/changelog.d/9362.misc
@@ -1 +0,0 @@
-Clean up the code to load the metadata for OpenID Connect identity providers.
--- a/changelog.d/9376.feature
+++ b/changelog.d/9376.feature
@@ -1 +0,0 @@
-Add support for receiving OpenID Connect authentication responses via form `POST`s rather than `GET`s.
--- a/changelog.d/9377.misc
+++ b/changelog.d/9377.misc
@@ -1 +0,0 @@
-Convert tests to use `HomeserverTestCase`.
--- a/changelog.d/9381.misc
+++ b/changelog.d/9381.misc
@@ -1 +0,0 @@
-Update the version of black used to 20.8b1.
--- a/changelog.d/9384.misc
+++ b/changelog.d/9384.misc
@@ -1 +0,0 @@
-Allow OIDC config to override discovered values.
--- a/changelog.d/9390.doc
+++ b/changelog.d/9390.doc
@@ -1 +0,0 @@
-Add HTTP/2 support to the nginx example configuration. Contributed by David Vo.
--- a/changelog.d/9391.bugfix
+++ b/changelog.d/9391.bugfix
@@ -1 +0,0 @@
-Fix bug where Synapse would occaisonally stop reconnecting after the connection was lost.
--- a/changelog.d/9393.bugfix
+++ b/changelog.d/9393.bugfix
@@ -1 +0,0 @@
-Assert a maximum length for some parameters for spec compliance.
--- a/changelog.d/9394.misc
+++ b/changelog.d/9394.misc
@@ -1 +0,0 @@
-Remove some dead code from the acceptance of room invites path.
--- a/changelog.d/9395.bugfix
+++ b/changelog.d/9395.bugfix
@@ -1 +0,0 @@
-Fix a long-standing bug when upgrading a room: "TypeError: '>' not supported between instances of 'NoneType' and 'int'".
--- a/changelog.d/9396.misc
+++ b/changelog.d/9396.misc
@@ -1 +0,0 @@
-Convert tests to use `HomeserverTestCase`.
--- a/changelog.d/9400.feature
+++ b/changelog.d/9400.feature
@@ -1 +0,0 @@
-Add the shadow-banning status to the display user admin API.
--- a/changelog.d/9404.doc
+++ b/changelog.d/9404.doc
@@ -1 +0,0 @@
-Update docs for using Gitea as OpenID provider.
--- a/changelog.d/9407.doc
+++ b/changelog.d/9407.doc
@@ -1 +0,0 @@
-Document that pusher instances are shardable.
--- a/changelog.d/9408.misc
+++ b/changelog.d/9408.misc
@@ -1 +0,0 @@
-Clean up an unused method in the presence handler code.
--- a/changelog.d/9421.bugfix
+++ b/changelog.d/9421.bugfix
@@ -1 +0,0 @@
-Reduce the amount of memory used when generating the URL preview of a file that is larger than the `max_spider_size`.
--- a/changelog.d/9425.bugfix
+++ b/changelog.d/9425.bugfix
@@ -1 +0,0 @@
-Fix a long-standing bug in the deduplication of old presence, resulting in no deduplication.
--- a/changelog.d/9428.bugfix
+++ b/changelog.d/9428.bugfix
@@ -1 +0,0 @@
-Fix a bug introduced in v1.27.0: "TypeError: int() argument must be a string, a bytes-like object or a number, not 'NoneType." related to the user directory.
--- a/docs/sample_config.yaml
+++ b/docs/sample_config.yaml
@@ -2408,8 +2408,8 @@ password_config:
      #require_uppercase: true

 ui_auth:
-    # The number of milliseconds to allow a user-interactive authentication
-    # session to be active.
+    # The amount of time to allow a user-interactive authentication session
+    # to be active.
    #
    # This defaults to 0, meaning the user is queried for their credentials
    # before every action, but this can be overridden to allow a single
@@ -2420,7 +2420,7 @@ ui_auth:
    # Uncomment below to allow for credential validation to last for 15
    # seconds.
    #
-    #session_timeout: 15000
+    #session_timeout: "15s"


 # Configuration for sending emails from Synapse.
--- a/synapse/init.py
+++ b/synapse/init.py
@@ -48,7 +48,7 @@ try:
 except ImportError:
    pass

-__version__ = "1.27.0"
+__version__ = "1.28.0rc1"

 if bool(os.environ.get("SYNAPSE_TEST_PATCH_LOG_CONTEXTS", False)):
    # We import here so that we don't have to install a bunch of deps when
--- a/synapse/config/auth.py
+++ b/synapse/config/auth.py
@@ -37,7 +37,9 @@ class AuthConfig(Config):

        # User-interactive authentication
        ui_auth = config.get("ui_auth") or {}
-        self.ui_auth_session_timeout = ui_auth.get("session_timeout", 0)
+        self.ui_auth_session_timeout = self.parse_duration(
+            ui_auth.get("session_timeout", 0)
+        )

    def generate_config_section(self, config_dir_path, server_name, **kwargs):
        return """\
@@ -93,8 +95,8 @@ class AuthConfig(Config):
              #require_uppercase: true

        ui_auth:
-            # The number of milliseconds to allow a user-interactive authentication
-            # session to be active.
+            # The amount of time to allow a user-interactive authentication session
+            # to be active.
            #
            # This defaults to 0, meaning the user is queried for their credentials
            # before every action, but this can be overridden to allow a single
@@ -105,5 +107,5 @@ class AuthConfig(Config):
            # Uncomment below to allow for credential validation to last for 15
            # seconds.
            #
-            #session_timeout: 15000
+            #session_timeout: "15s"
        """
--- a/synapse/rest/synapse/client/init.py
+++ b/synapse/rest/synapse/client/init.py
@@ -54,11 +54,7 @@ def build_synapse_client_resource_tree(hs: "HomeServer") -> Mapping[str, Resourc
    if hs.config.saml2_enabled:
        from synapse.rest.synapse.client.saml2 import SAML2Resource

-        res = SAML2Resource(hs)
-        resources["/_synapse/client/saml2"] = res
-
-        # This is also mounted under '/_matrix' for backwards-compatibility.
-        resources["/_matrix/saml2"] = res
+        resources["/_synapse/client/saml2"] = SAML2Resource(hs)

    return resources

--- a/tests/rest/client/v2_alpha/test_auth.py
+++ b/tests/rest/client/v2_alpha/test_auth.py
@@ -343,7 +343,7 @@ class UIAuthTests(unittest.HomeserverTestCase):
            },
        )

-    @unittest.override_config({"ui_auth": {"session_timeout": 5 * 1000}})
+    @unittest.override_config({"ui_auth": {"session_timeout": "5s"}})
    def test_can_reuse_session(self):
        """
        The session can be reused if configured.
				`@@ -1 +0,0 @@`
				`Fix 'object name reserved for internal use' errors with recent versions of SQLite.`
				`@@ -1 +0,0 @@`
				`Add experimental support for running Synapse with PyPy.`
				`@@ -1 +0,0 @@`
				`New API /_synapse/admin/rooms/{roomId}/context/{eventId}.`
				`@@ -1 +0,0 @@`
				`Deny access to additional IP addresses by default.`
				`@@ -1 +0,0 @@`
				`Fix long-standing bug where sending email push would fail for rooms that the server had since left.`
				`@@ -1 +0,0 @@`
				Add note to `auto_join_rooms` config option explaining existing rooms must be publicly joinable.
				`@@ -1 +0,0 @@`
				`Fix bug in Synapse 1.27.0rc1 which meant the "session expired" error page during SSO registration was badly formatted.`
				`@@ -1 +0,0 @@`
				Update the `Cursor` type hints to better match PEP 249.
				`@@ -1 +0,0 @@`
				`Further improvements to the user experience of registration via single sign-on.`
				`@@ -1 +0,0 @@`
				`Add debug logging for SRV lookups. Contributed by @Bubu.`