Mark dehydrated devices in admin get devices endpoint #18252
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
anoadragon453
requested changes
Apr 28, 2025
There was a problem hiding this comment.
LGTM overall! Apologies for the long delay on a review :(
Thanks for adding a test! Could you please update the relevant documentation to include the new field as well?
tests/rest/admin/test_device.py
Outdated
| else: | ||
| self.assertNotIn("dehydrated", d) | ||
|
|
||
| self.assertEqual(True, found_dehydrated) |
There was a problem hiding this comment.
Suggested change
| self.assertEqual(True, found_dehydrated) | |
| self.assertTrue(found_dehydrated) |
tests/rest/admin/test_device.py
Outdated
| for d in channel.json_body["devices"]: | ||
| self.assertIn("user_id", d) | ||
| self.assertIn("device_id", d) | ||
| self.assertIn("display_name", d) | ||
| self.assertIn("last_seen_ip", d) | ||
| self.assertIn("last_seen_ts", d) | ||
| if d["device_id"] == "dehydrated_device": | ||
| self.assertEqual(True, d.get("dehydrated")) |
There was a problem hiding this comment.
Suggested change
| self.assertEqual(True, d.get("dehydrated")) | |
| self.assertTrue(d.get("dehydrated")) |
tests/rest/admin/test_device.py
Outdated
| self.assertEqual(True, d.get("dehydrated")) | ||
| found_dehydrated = True | ||
| else: | ||
| self.assertNotIn("dehydrated", d) |
There was a problem hiding this comment.
To align with the suggestion above.
Suggested change
| self.assertNotIn("dehydrated", d) | |
| # Either the field is not present, or set to False | |
| self.assertFalse(d["dehydrated]) |
synapse/rest/admin/devices.py
Outdated
Comment on lines
153
to
154
| if device["device_id"] == dehydrated_device_id: | ||
| device["dehydrated"] = True |
There was a problem hiding this comment.
I think it might be nicer from an Admin API standpoint if the dehydrated field was always present?
Suggested change
| if device["device_id"] == dehydrated_device_id: | |
| device["dehydrated"] = True | |
| is_dehydrated = device["device_id"] == dehydrated_device_id | |
| device["dehydrated"] = is_dehydrated |
|
Looks like I forgot to re-request review 🤦 |
anoadragon453
approved these changes
May 28, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Mark the dehydrated device. This is needed for dehydrated devices and MAS, because MAS tries to delete all the devices that it doesn't know about, so it needs to know about the dehydrated device so that it can ignore it.
Companion PR: element-hq/matrix-authentication-service#4268
Part of a fix to element-hq/element-meta#2784
Pull Request Checklist
EventStoretoEventWorkerStore.".code blocks.(run the linters)