Fix additional type hints from Twisted upgrade #9518

clokep · 2021-03-01T18:49:12Z

Part of #9513, this is a grab bag of different improvements, but should be reviewable commit-by-commit. I think most of them are self-explanatory, but a couple are funkier. I'll try to mark the ones I think are questionable.

clokep · 2021-03-01T18:50:53Z

synapse/http/server.py

@@ -551,7 +558,7 @@ def __init__(
        request: Request,
        iterator: Iterator[bytes],
    ):
-        self._request = request
+        self._request = request  # type: Optional[Request]


We set it to None when we stop producing so we need to consider it optional here.

clokep · 2021-03-01T18:51:51Z

synapse/server.py

@@ -403,7 +404,7 @@ def get_room_shutdown_handler(self) -> RoomShutdownHandler:
        return RoomShutdownHandler(self)

    @cache_in_self
-    def get_sendmail(self) -> sendmail:
+    def get_sendmail(self) -> Callable[..., defer.Deferred]:


I started adding a better type signature here, but sendmail is fairly complicated and can take bytes and str as almost every argument.

tests/rest/client/v1/test_login.py

clokep · 2021-03-01T19:08:09Z

synapse/http/federation/matrix_federation_agent.py

@@ -116,7 +116,7 @@ def request(
        uri: bytes,
        headers: Optional[Headers] = None,
        bodyProducer: Optional[IBodyProducer] = None,
-    ) -> defer.Deferred:
+    ) -> Generator[defer.Deferred, Any, defer.Deferred]:


We haven't switched this to async since request is part of the IAgent interface.

anoadragon453

Thanks for wading through this! A couple questions and suggestions.

anoadragon453 · 2021-03-03T11:09:53Z

synapse/http/server.py

@@ -79,10 +81,12 @@ def return_json_error(f: failure.Failure, request: SynapseRequest) -> None:
    """Sends a JSON error response to clients."""

    if f.check(SynapseError):


Should we change this to isinstance(f.value, SynapseError) perhaps?

I don't think so. This is the proper way to check against twisted failures?

True, probably easier (and more likely) for us to remove a # type: ignore in the future than switch away from an isinstance.

I think my thought is that if we want to make that change we should do is as a discrete step, not bury it in this PR!

synapse/http/site.py

tests/rest/client/v1/test_login.py

Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>

@dklimpel

Synapse 1.29.0 (2021-03-08) =========================== Note that synapse now expects an `X-Forwarded-Proto` header when used with a reverse proxy. Please see [UPGRADE.rst](UPGRADE.rst#upgrading-to-v1290) for more details on this change. No significant changes. Synapse 1.29.0rc1 (2021-03-04) ============================== Features -------- - Add rate limiters to cross-user key sharing requests. ([\#8957](matrix-org/synapse#8957)) - Add `order_by` to the admin API `GET /_synapse/admin/v1/users/<user_id>/media`. Contributed by @dklimpel. ([\#8978](matrix-org/synapse#8978)) - Add some configuration settings to make users' profile data more private. ([\#9203](matrix-org/synapse#9203)) - The `no_proxy` and `NO_PROXY` environment variables are now respected in proxied HTTP clients with the lowercase form taking precedence if both are present. Additionally, the lowercase `https_proxy` environment variable is now respected in proxied HTTP clients on top of existing support for the uppercase `HTTPS_PROXY` form and takes precedence if both are present. Contributed by Timothy Leung. ([\#9372](matrix-org/synapse#9372)) - Add a configuration option, `user_directory.prefer_local_users`, which when enabled will make it more likely for users on the same server as you to appear above other users. ([\#9383](matrix-org/synapse#9383), [\#9385](matrix-org/synapse#9385)) - Add support for regenerating thumbnails if they have been deleted but the original image is still stored. ([\#9438](matrix-org/synapse#9438)) - Add support for `X-Forwarded-Proto` header when using a reverse proxy. ([\#9472](matrix-org/synapse#9472), [\#9501](matrix-org/synapse#9501), [\#9512](matrix-org/synapse#9512), [\#9539](matrix-org/synapse#9539)) Bugfixes -------- - Fix a bug where users' pushers were not all deleted when they deactivated their account. ([\#9285](matrix-org/synapse#9285), [\#9516](matrix-org/synapse#9516)) - Fix a bug where a lot of unnecessary presence updates were sent when joining a room. ([\#9402](matrix-org/synapse#9402)) - Fix a bug that caused multiple calls to the experimental `shared_rooms` endpoint to return stale results. ([\#9416](matrix-org/synapse#9416)) - Fix a bug in single sign-on which could cause a "No session cookie found" error. ([\#9436](matrix-org/synapse#9436)) - Fix bug introduced in v1.27.0 where allowing a user to choose their own username when logging in via single sign-on did not work unless an `idp_icon` was defined. ([\#9440](matrix-org/synapse#9440)) - Fix a bug introduced in v1.26.0 where some sequences were not properly configured when running `synapse_port_db`. ([\#9449](matrix-org/synapse#9449)) - Fix deleting pushers when using sharded pushers. ([\#9465](matrix-org/synapse#9465), [\#9466](matrix-org/synapse#9466), [\#9479](matrix-org/synapse#9479), [\#9536](matrix-org/synapse#9536)) - Fix missing startup checks for the consistency of certain PostgreSQL sequences. ([\#9470](matrix-org/synapse#9470)) - Fix a long-standing bug where the media repository could leak file descriptors while previewing media. ([\#9497](matrix-org/synapse#9497)) - Properly purge the event chain cover index when purging history. ([\#9498](matrix-org/synapse#9498)) - Fix missing chain cover index due to a schema delta not being applied correctly. Only affected servers that ran development versions. ([\#9503](matrix-org/synapse#9503)) - Fix a bug introduced in v1.25.0 where `/_synapse/admin/join/` would fail when given a room alias. ([\#9506](matrix-org/synapse#9506)) - Prevent presence background jobs from running when presence is disabled. ([\#9530](matrix-org/synapse#9530)) - Fix rare edge case that caused a background update to fail if the server had rejected an event that had duplicate auth events. ([\#9537](matrix-org/synapse#9537)) Improved Documentation ---------------------- - Update the example systemd config to propagate reloads to individual units. ([\#9463](matrix-org/synapse#9463)) Internal Changes ---------------- - Add documentation and type hints to `parse_duration`. ([\#9432](matrix-org/synapse#9432)) - Remove vestiges of `uploads_path` configuration setting. ([\#9462](matrix-org/synapse#9462)) - Add a comment about systemd-python. ([\#9464](matrix-org/synapse#9464)) - Test that we require validated email for email pushers. ([\#9496](matrix-org/synapse#9496)) - Allow python to generate bytecode for synapse. ([\#9502](matrix-org/synapse#9502)) - Fix incorrect type hints. ([\#9515](matrix-org/synapse#9515), [\#9518](matrix-org/synapse#9518)) - Add type hints to device and event report admin API. ([\#9519](matrix-org/synapse#9519)) - Add type hints to user admin API. ([\#9521](matrix-org/synapse#9521)) - Bump the versions of mypy and mypy-zope used for static type checking. ([\#9529](matrix-org/synapse#9529))

clokep added 9 commits March 1, 2021 12:33

Fix type hints in test_login.

db2e164

Fix type hint for sendmail.

99c1ce4

Deferreds do not resolve to a type.

7c2b13f

Fix re-declaration errors.

9ed6dbb

Use the proper types for inlineCallbacks returns.

5cf5863

Add a type hint for SynapseSite.

b9c941a

FIx additional type hints in server.py.

6926db7

Fix type hints in metrics.

01a3edb

Newsfragment

96b3466

clokep commented Mar 1, 2021

View reviewed changes

tests/rest/client/v1/test_login.py Show resolved Hide resolved

Fix a return type.

c9767e9

clokep commented Mar 1, 2021

View reviewed changes

clokep requested a review from a team March 2, 2021 11:57

anoadragon453 reviewed Mar 3, 2021

View reviewed changes

Clarify comments.

23d4438

Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>

clokep requested a review from anoadragon453 March 3, 2021 12:45

anoadragon453 approved these changes Mar 3, 2021

View reviewed changes

clokep merged commit 33a02f0 into develop Mar 3, 2021

clokep deleted the clokep/twisted-types branch March 3, 2021 20:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix additional type hints from Twisted upgrade #9518

Fix additional type hints from Twisted upgrade #9518

clokep commented Mar 1, 2021

clokep Mar 1, 2021

clokep Mar 1, 2021

clokep Mar 1, 2021

anoadragon453 left a comment

anoadragon453 Mar 3, 2021

clokep Mar 3, 2021

anoadragon453 Mar 3, 2021

clokep Mar 3, 2021

		@@ -79,10 +81,12 @@ def return_json_error(f: failure.Failure, request: SynapseRequest) -> None:
		"""Sends a JSON error response to clients."""

		if f.check(SynapseError):

Fix additional type hints from Twisted upgrade #9518

Fix additional type hints from Twisted upgrade #9518

Conversation

clokep commented Mar 1, 2021

clokep Mar 1, 2021

Choose a reason for hiding this comment

clokep Mar 1, 2021

Choose a reason for hiding this comment

clokep Mar 1, 2021

Choose a reason for hiding this comment

anoadragon453 left a comment

Choose a reason for hiding this comment

anoadragon453 Mar 3, 2021

Choose a reason for hiding this comment

clokep Mar 3, 2021

Choose a reason for hiding this comment

anoadragon453 Mar 3, 2021

Choose a reason for hiding this comment

clokep Mar 3, 2021

Choose a reason for hiding this comment