handle empty backups according to latest spec proposal

changelog.d/4123.bugfix

@@ -0,0 +1 @@
+fix return code of empty key backups

synapse/handlers/e2e_room_keys.py

@@ -63,13 +63,13 @@ def get_room_keys(self, user_id, version, room_id=None, session_id=None):
  # we deliberately take the lock to get keys so that changing the version
  # works atomically
  with (yield self._upload_linearizer.queue(user_id)):
+ # make sure the backup version exists
+ yield self.store.get_e2e_room_keys_version_info(user_id, version)
+
  results = yield self.store.get_e2e_room_keys(
  user_id, version, room_id, session_id
  )
 
- if results['rooms'] == {}:
- raise SynapseError(404, "No room_keys found")
-
  defer.returnValue(results)
 
  @defer.inlineCallbacks

synapse/rest/client/v2_alpha/room_keys.py

@@ -209,9 +209,15 @@ def on_GET(self, request, room_id, session_id):
  )
 
  if session_id:
- room_keys = room_keys['rooms'][room_id]['sessions'][session_id]
+ if room_keys['rooms'] == {}:
+ raise SynapseError(404, "No room_keys found", Codes.NOT_FOUND)
+ else:
+ room_keys = room_keys['rooms'][room_id]['sessions'][session_id]
  elif room_id:
- room_keys = room_keys['rooms'][room_id]
+ if room_keys['rooms'] == {}:
+ room_keys = {'sessions': {}}
+ else:
+ room_keys = room_keys['rooms'][room_id]
 
  defer.returnValue((200, room_keys))
 

tests/handlers/test_e2e_room_keys.py

@@ -169,8 +169,8 @@ def test_delete_version(self):
  self.assertEqual(res, 404)
 
  @defer.inlineCallbacks
- def test_get_missing_room_keys(self):
- """Check that we get a 404 on querying missing room_keys
+ def test_get_missing_backup(self):
+ """Check that we get a 404 on querying missing backup
  """
  res = None
  try:
@@ -179,19 +179,20 @@ def test_get_missing_room_keys(self):
  res = e.code
  self.assertEqual(res, 404)
 
- # check we also get a 404 even if the version is valid
+ @defer.inlineCallbacks
+ def test_get_missing_room_keys(self):
+ """Check we get an empty response from an empty backup
+ """
  version = yield self.handler.create_version(self.local_user, {
  "algorithm": "m.megolm_backup.v1",
  "auth_data": "first_version_auth_data",
  })
  self.assertEqual(version, "1")
 
- res = None
- try:
- yield self.handler.get_room_keys(self.local_user, version)
- except errors.SynapseError as e:
- res = e.code
- self.assertEqual(res, 404)
+ res = yield self.handler.get_room_keys(self.local_user, version)
+ self.assertDictEqual(res, {
+ "rooms": {}
+ })
 
  # TODO: test the locking semantics when uploading room_keys,
  # although this is probably best done in sytest
@@ -345,17 +346,15 @@ def test_delete_room_keys(self):
  # check for bulk-delete
  yield self.handler.upload_room_keys(self.local_user, version, room_keys)
  yield self.handler.delete_room_keys(self.local_user, version)
- res = None
- try:
- yield self.handler.get_room_keys(
- self.local_user,
- version,
- room_id="!abc:matrix.org",
- session_id="c0ff33",
- )
- except errors.SynapseError as e:
- res = e.code
- self.assertEqual(res, 404)
+ res = yield self.handler.get_room_keys(
+ self.local_user,
+ version,
+ room_id="!abc:matrix.org",
+ session_id="c0ff33",
+ )
+ self.assertDictEqual(res, {
+ "rooms": {}
+ })
 
  # check for bulk-delete per room
  yield self.handler.upload_room_keys(self.local_user, version, room_keys)
@@ -364,17 +363,15 @@ def test_delete_room_keys(self):
  version,
  room_id="!abc:matrix.org",
  )
- res = None
- try:
- yield self.handler.get_room_keys(
- self.local_user,
- version,
- room_id="!abc:matrix.org",
- session_id="c0ff33",
- )
- except errors.SynapseError as e:
- res = e.code
- self.assertEqual(res, 404)
+ res = yield self.handler.get_room_keys(
+ self.local_user,
+ version,
+ room_id="!abc:matrix.org",
+ session_id="c0ff33",
+ )
+ self.assertDictEqual(res, {
+ "rooms": {}
+ })
 
  # check for bulk-delete per session
  yield self.handler.upload_room_keys(self.local_user, version, room_keys)
@@ -384,14 +381,12 @@ def test_delete_room_keys(self):
  room_id="!abc:matrix.org",
  session_id="c0ff33",
  )
- res = None
- try:
- yield self.handler.get_room_keys(
- self.local_user,
- version,
- room_id="!abc:matrix.org",
- session_id="c0ff33",
- )
- except errors.SynapseError as e:
- res = e.code
- self.assertEqual(res, 404)
+ res = yield self.handler.get_room_keys(
+ self.local_user,
+ version,
+ room_id="!abc:matrix.org",
+ session_id="c0ff33",
+ )
+ self.assertDictEqual(res, {
+ "rooms": {}
+ })