Make get_device return None if the device doesn't exist rather than raising an exception.

changelog.d/11565.misc

@@ -0,0 +1 @@
+Make `get_device` return `None` if the device doesn't exist rather than raising an exception.

synapse/handlers/auth.py

@@ -997,9 +997,7 @@ async def create_access_token_for_user_id(
  # really don't want is active access_tokens without a record of the
  # device, so we double-check it here.
  if device_id is not None:
- try:
- await self.store.get_device(user_id, device_id)
- except StoreError:
+ if await self.store.get_device(user_id, device_id) is None:
  await self.store.delete_access_token(access_token)
  raise StoreError(400, "Login raced against device deletion")
 

synapse/handlers/device.py

@@ -106,10 +106,10 @@ async def get_device(self, user_id: str, device_id: str) -> JsonDict:
  Raises:
  errors.NotFoundError: if the device was not found
  """
- try:
-  device = await self.store.get_device(user_id, device_id)
- except errors.StoreError:
- raise errors.NotFoundError
+ device = await self.store.get_device(user_id, device_id)
+ if device is None:
+  raise errors.NotFoundError()
+
  ips = await self.store.get_last_client_ip_by_device(user_id, device_id)
  _update_device_from_client_ips(device, ips)
 
@@ -602,6 +602,8 @@ async def rehydrate_device(
  access_token, device_id
  )
  old_device = await self.store.get_device(user_id, old_device_id)
+ if old_device is None:
+ raise errors.NotFoundError()
  await self.store.update_device(user_id, device_id, old_device["display_name"])
  # can't call self.delete_device because that will clobber the
  # access token so call the storage layer directly

synapse/rest/admin/devices.py

@@ -63,6 +63,8 @@ async def on_GET(
  device = await self.device_handler.get_device(
  target_user.to_string(), device_id
  )
+ if device is None:
+ raise NotFoundError("No device found")
  return HTTPStatus.OK, device
 
  async def on_DELETE(

synapse/rest/client/devices.py

@@ -17,17 +17,17 @@
 from typing import TYPE_CHECKING, Tuple
 
 from synapse.api import errors
+from synapse.api.errors import NotFoundError
 from synapse.http.server import HttpServer
 from synapse.http.servlet import (
  RestServlet,
  assert_params_in_dict,
  parse_json_object_from_request,
 )
 from synapse.http.site import SynapseRequest
+from synapse.rest.client._base import client_patterns, interactive_auth_handler
 from synapse.types import JsonDict
 
-from ._base import client_patterns, interactive_auth_handler
-
 if TYPE_CHECKING:
  from synapse.server import HomeServer
 
@@ -116,6 +116,8 @@ async def on_GET(
  device = await self.device_handler.get_device(
  requester.user.to_string(), device_id
  )
+ if device is None:
+ raise NotFoundError("No device found")
  return 200, device
 
  @interactive_auth_handler

synapse/storage/databases/main/devices.py

@@ -101,23 +101,25 @@ def count_devices_by_users_txn(txn, user_ids):
  "count_devices_by_users", count_devices_by_users_txn, user_ids
  )
 
- async def get_device(self, user_id: str, device_id: str) -> Dict[str, Any]:
+ async def get_device(
+ self, user_id: str, device_id: str
+ ) -> Optional[Dict[str, Any]]:
  """Retrieve a device. Only returns devices that are not marked as
  hidden.
 
  Args:
  user_id: The ID of the user which owns the device
  device_id: The ID of the device to retrieve
  Returns:
- A dict containing the device information
- Raises:
- StoreError: if the device is not found
+ A dict containing the device information, or `None` if the device does not
+ exist.
  """
  return await self.db_pool.simple_select_one(
  table="devices",
  keyvalues={"user_id": user_id, "device_id": device_id, "hidden": False},
  retcols=("user_id", "device_id", "display_name"),
  desc="get_device",
+ allow_none=True,
  )
 
  async def get_devices_by_user(self, user_id: str) -> Dict[str, Dict[str, str]]: