Implement delete_devices API #1993
Conversation
This implements the proposal here https://docs.google.com/document/d/1C-25Gqz3TXy2jIAoeOKxpNtmme0jI4g3yFGqv5GlAAk for deleting multiple devices at once in a single request.
| def on_POST(self, request): | ||
| try: | ||
| body = servlet.parse_json_object_from_request(request) | ||
|
|
There was a problem hiding this comment.
Bit of a spurious newline here.
| # the same as those that pass an empty dict | ||
| body = {} | ||
| else: | ||
| raise |
There was a problem hiding this comment.
Generally its best to do raise e, as if you later add a yield foo then you will re-raise the wrong error
| defer.returnValue((401, result)) | ||
|
|
||
| requester = yield self.auth.get_user_by_req(request) | ||
| for d_id in body['devices']: |
There was a problem hiding this comment.
This is fine for the first cut, but might be nice to change delete_device to delete_devices and then pass around the list through everywhere. This has a number of advantages: a) it reduces work as a lot of things are cheaper to do in bulk, b) it makes it easier to make the API either succeed or fail, rather than partially succeed if something fails halfway through
| """ | ||
| Args: | ||
| hs (synapse.server.HomeServer): server | ||
| """ |
There was a problem hiding this comment.
Pointless docstring is pointless
| @@ -45,6 +45,52 @@ def on_GET(self, request): | |||
| ) | |||
| defer.returnValue((200, {"devices": devices})) | |||
|
|
|||
| class DeleteDevicesRestServlet(servlet.RestServlet): | |||
| PATTERNS = client_v2_patterns("/delete_devices", releases=[], v2_alpha=False) | |||
There was a problem hiding this comment.
Could you add a docstring to say what this and what form the API roughly takes, e.g.:
API for bulk deletion of devices. Accepts a json object with a
deviceskey which lists the device_ids to delete. Requires user interactive auth.
(But this doesn't implement the same for deleting access tokens or e2e keys. Also respond to code review.
|
PTAL @erikjohnston |
|
what is the rationale for this ooi? (as I thought element-hq/element-web#2464 was a sufficient fix...) |
|
@ara4n Riot web cheekily implements bulk deletion of devices by caching the password temporarily, if i understand correctly, so I think it makes sense to have a bulk deletion API. (It also means we only notify about device changes once than for each individual device). |
|
lgtm |
|
ok... would be helpful if there was a matching riot bug for this, if nothing else to aid prioritisation relative to the other fires on the riot side (and to ensure the clientside of the api actually gets implemented!) |
|
@ara4n it's on my list of todos, and overlaps nicely with https://github.com/vector-im/riot-web/issues/3268 as it will need a similar multi-select table |
This implements the proposal here https://docs.google.com/document/d/1C-25Gqz3TXy2jIAoeOKxpNtmme0jI4g3yFGqv5GlAAk for deleting multiple devices using a single request.