Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Add type hints to synapse/storage/databases/main/e2e_room_keys.py #11549

Merged
merged 8 commits into from
Dec 14, 2021
Merged

Add type hints to synapse/storage/databases/main/e2e_room_keys.py #11549

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
f3fbbed
Add type hints to `synapse/storage/databases/main/e2e_room_keys.py`
Dec 9, 2021
4e6f213
Rename newsfile
Dec 9, 2021
bd26484
Tidy up handling of versions and add missing handling of non-numeric …
Dec 13, 2021
3d599bc
Rename JsonObject to JsonSerializable
Dec 13, 2021
3cbc0e9
Actually rename JsonObject to JsonSerializable
Dec 13, 2021
6772c87
Add docstring to EndToEndRoomKeyStore
Dec 13, 2021
320ccc1
Improve 404 error descriptions
Dec 14, 2021
d716c34
Merge branch 'develop' into squah/type_hint_e2e_room_keys
squahtx Dec 14, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/11549.misc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add missing type hints to storage classes.
4 changes: 3 additions & 1 deletion mypy.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@ exclude = (?x)
|synapse/storage/databases/main/account_data.py
|synapse/storage/databases/main/cache.py
|synapse/storage/databases/main/devices.py
|synapse/storage/databases/main/e2e_room_keys.py
|synapse/storage/databases/main/end_to_end_keys.py
|synapse/storage/databases/main/event_federation.py
|synapse/storage/databases/main/event_push_actions.py
Expand Down Expand Up @@ -187,6 +186,9 @@ disallow_untyped_defs = True
[mypy-synapse.storage.databases.main.directory]
disallow_untyped_defs = True

[mypy-synapse.storage.databases.main.e2e_room_keys]
disallow_untyped_defs = True

[mypy-synapse.storage.databases.main.events_worker]
disallow_untyped_defs = True

Expand Down
15 changes: 10 additions & 5 deletions synapse/handlers/e2e_room_keys.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@
# limitations under the License.

import logging
from typing import TYPE_CHECKING, List, Optional
from typing import TYPE_CHECKING, Dict, Optional

from typing_extensions import Literal

from synapse.api.errors import (
Codes,
Expand All @@ -24,6 +26,7 @@
SynapseError,
)
from synapse.logging.opentracing import log_kv, trace
from synapse.storage.databases.main.e2e_room_keys import RoomKey
from synapse.types import JsonDict
from synapse.util.async_helpers import Linearizer

Expand Down Expand Up @@ -58,7 +61,9 @@ async def get_room_keys(
version: str,
DMRobertson marked this conversation as resolved.
Show resolved Hide resolved
room_id: Optional[str] = None,
session_id: Optional[str] = None,
) -> List[JsonDict]:
) -> Dict[
Literal["rooms"], Dict[str, Dict[Literal["sessions"], Dict[str, RoomKey]]]
]:
Comment on lines +64 to +66
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The previous annotation was incorrect. The caller and tests expect a JsonDict to be returned:

synapse/synapse/rest/client/room_keys.py

Lines 199 to 223 in 0cc3bf9

room_keys = await self.e2e_room_keys_handler.get_room_keys(
user_id, version, room_id, session_id
)
# Convert room_keys to the right format to return.
if session_id:
# If the client requests a specific session, but that session was
# not backed up, then return an M_NOT_FOUND.
if room_keys["rooms"] == {}:
raise NotFoundError("No room_keys found")
else:
room_keys = room_keys["rooms"][room_id]["sessions"][session_id]
elif room_id:
# If the client requests all sessions from a room, but no sessions
# are found, then return an empty result rather than an error, so
# that clients don't have to handle an error condition, and an
# empty result is valid. (Similarly if the client requests all
# sessions from the backup, but in that case, room_keys is already
# in the right format, so we don't need to do anything about it.)
if room_keys["rooms"] == {}:
room_keys = {"sessions": {}}
else:
room_keys = room_keys["rooms"][room_id]
return 200, room_keys

synapse/tests/handlers/test_e2e_room_keys.py

Lines 404 to 409 in 0cc3bf9

res = self.get_success(
self.handler.get_room_keys(
self.local_user, version, room_id="!abc:matrix.org"
)
)
self.assertDictEqual(res, room_keys)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any idea why mypy didn't spot this? I guess the tests aren't checked, but I'd hope room_keys was

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like e2e_room_keys_handler.get_room_keys has a @trace decorator, which isn't annotated

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting! I think @H-Shay is taking a look at annotating that file, maybe this will show up the problem.

"""Bulk get the E2E room keys for a given backup, optionally filtered to a given
room, or a given session.
See EndToEndRoomKeyStore.get_e2e_room_keys for full details.
Expand All @@ -72,8 +77,8 @@ async def get_room_keys(
Raises:
NotFoundError: if the backup version does not exist
Returns:
A list of dicts giving the session_data and message metadata for
these room keys.
A dict giving the session_data and message metadata for these room keys.
`{"rooms": {room_id: {"sessions": {session_id: room_key}}}}`
"""

# we deliberately take the lock to get keys so that changing the version
Expand Down Expand Up @@ -273,7 +278,7 @@ async def upload_room_keys(

@staticmethod
def _should_replace_room_key(
current_room_key: Optional[JsonDict], room_key: JsonDict
current_room_key: Optional[RoomKey], room_key: RoomKey
) -> bool:
"""
Determine whether to replace a given current_room_key (if any)
Expand Down
Loading