Add an option to disable purge in delete room admin API #7964

dklimpel · 2020-07-27T18:57:02Z

Add option purge to POST /_synapse/admin/v1/rooms/<room_id>/delete
Fixes: #3761

So you can remove rooms without repointing users elsewhere an do not delete from server.
You can shutdown a room and you can decide whether you want to delete it or not from your server.

Pull Request Checklist

Pull request is based on the develop branch
Pull request includes a changelog file. The entry should:
- Be a short description of your change which makes sense to users. "Fixed a bug that prevented receiving messages from other servers." instead of "Moved X method from EventStore to EventWorkerStore.".
- Use markdown where necessary, mostly for code blocks.
- End with either a period (.) or an exclamation mark (!).
- Start with a capital letter.
Pull request includes a sign off
Code style is correct (run the linters)

Signed-off-by: Dirk Klimpel dirk@klimpel.org

anoadragon453

Add option purge to DELETE /_synapse/admin/v1/rooms/<room_id>

POST /_synapse/admin/v1/rooms/<room_id>/delete* :)

Thanks for this! Looks good otherwise, just a few small things.

anoadragon453 · 2020-07-28T00:34:47Z

docs/admin_api/rooms.md

@@ -369,7 +369,7 @@ to the new room will have power level `-10` by default, and thus be unable to sp
 If `block` is `True` it prevents new joins to the old room.

 This API will remove all trace of the old room from your database after removing
-all local users.
+all local users. If you do not like to remove the trace set `purge` to `False`.


I would probably rewrite this sentence as something like:

If purge is true (the default), all traces of the old room will be removed from your database after removing all local users. If you do not want this to happen, set purge to false.

docs/admin_api/rooms.md

tests/rest/admin/test_room.py

Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>

anoadragon453

lgtm, thanks!

@lugino-emeritus

Synapse 1.19.0rc1 (2020-08-13) ============================== Removal warning --------------- As outlined in the [previous release](https://github.com/matrix-org/synapse/releases/tag/v1.18.0), we are no longer publishing Docker images with the `-py3` tag suffix. On top of that, we have also removed the `latest-py3` tag. Please see [the announcement in the upgrade notes for 1.18.0](https://github.com/matrix-org/synapse/blob/develop/UPGRADE.rst#upgrading-to-v1180). Features -------- - Add option to allow server admins to join rooms which fail complexity checks. Contributed by @lugino-emeritus. ([\#7902](#7902)) - Add an option to purge room or not with delete room admin endpoint (`POST /_synapse/admin/v1/rooms/<room_id>/delete`). Contributed by @dklimpel. ([\#7964](#7964)) - Add rate limiting to users joining rooms. ([\#8008](#8008)) - Add a `/health` endpoint to every configured HTTP listener that can be used as a health check endpoint by load balancers. ([\#8048](#8048)) - Allow login to be blocked based on the values of SAML attributes. ([\#8052](#8052)) - Allow guest access to the `GET /_matrix/client/r0/rooms/{room_id}/members` endpoint, according to MSC2689. Contributed by Awesome Technologies Innovationslabor GmbH. ([\#7314](#7314)) Bugfixes -------- - Fix a bug introduced in Synapse v1.7.2 which caused inaccurate membership counts in the room directory. ([\#7977](#7977)) - Fix a long standing bug: 'Duplicate key value violates unique constraint "event_relations_id"' when message retention is configured. ([\#7978](#7978)) - Fix "no create event in auth events" when trying to reject invitation after inviter leaves. Bug introduced in Synapse v1.10.0. ([\#7980](#7980)) - Fix various comments and minor discrepencies in server notices code. ([\#7996](#7996)) - Fix a long standing bug where HTTP HEAD requests resulted in a 400 error. ([\#7999](#7999)) - Fix a long-standing bug which caused two copies of some log lines to be written when synctl was used along with a MemoryHandler logger. ([\#8011](#8011), [\#8012](#8012)) Updates to the Docker image --------------------------- - We no longer publish Docker images with the `-py3` tag suffix, as [announced in the upgrade notes](https://github.com/matrix-org/synapse/blob/develop/UPGRADE.rst#upgrading-to-v1180). ([\#8056](#8056)) Improved Documentation ---------------------- - Document how to set up a client .well-known file and fix several pieces of outdated documentation. ([\#7899](#7899)) - Improve workers docs. ([\#7990](#7990), [\#8000](#8000)) - Fix typo in `docs/workers.md`. ([\#7992](#7992)) - Add documentation for how to undo a room shutdown. ([\#7998](#7998), [\#8010](#8010)) Internal Changes ---------------- - Reduce the amount of whitespace in JSON stored and sent in responses. Contributed by David Vo. ([\#7372](#7372)) - Switch to the JSON implementation from the standard library and bump the minimum version of the canonicaljson library to 1.2.0. ([\#7936](#7936), [\#7979](#7979)) - Convert various parts of the codebase to async/await. ([\#7947](#7947), [\#7948](#7948), [\#7949](#7949), [\#7951](#7951), [\#7963](#7963), [\#7973](#7973), [\#7975](#7975), [\#7976](#7976), [\#7981](#7981), [\#7987](#7987), [\#7989](#7989), [\#8003](#8003), [\#8014](#8014), [\#8016](#8016), [\#8027](#8027), [\#8031](#8031), [\#8032](#8032), [\#8035](#8035), [\#8042](#8042), [\#8044](#8044), [\#8045](#8045), [\#8061](#8061), [\#8062](#8062), [\#8063](#8063), [\#8066](#8066), [\#8069](#8069), [\#8070](#8070)) - Move some database-related log lines from the default logger to the database/transaction loggers. ([\#7952](#7952)) - Add a script to detect source code files using non-unix line terminators. ([\#7965](#7965), [\#7970](#7970)) - Log the SAML session ID during creation. ([\#7971](#7971)) - Implement new experimental push rules for some users. ([\#7997](#7997)) - Remove redundant and unreliable signature check for v1 Identity Service lookup responses. ([\#8001](#8001)) - Improve the performance of the register endpoint. ([\#8009](#8009)) - Reduce less useful output in the newsfragment CI step. Add a link to the changelog section of the contributing guide on error. ([\#8024](#8024)) - Rename storage layer objects to be more sensible. ([\#8033](#8033)) - Change the default log config to reduce disk I/O and storage for new servers. ([\#8040](#8040)) - Add an assertion on `prev_events` in `create_new_client_event`. ([\#8041](#8041)) - Add a comment to `ServerContextFactory` about the use of `SSLv23_METHOD`. ([\#8043](#8043)) - Log `OPTIONS` requests at `DEBUG` rather than `INFO` level to reduce amount logged at `INFO`. ([\#8049](#8049)) - Reduce amount of outbound request logging at `INFO` level. ([\#8050](#8050)) - It is no longer necessary to explicitly define `filters` in the logging configuration. (Continuing to do so is redundant but harmless.) ([\#8051](#8051)) - Add and improve type hints. ([\#8058](#8058), [\#8064](#8064), [\#8060](#8060), [\#8067](#8067))

* commit '3950ae51e': Ensure that remove_pusher is always async (#7981) Ensure the msg property of HttpResponseException is a string. (#7979) Remove from the event_relations table when purging historical events. (#7978) Add additional logging for SAML sessions. (#7971) Add MSC reference to changelog for #7736 Re-implement unread counts (#7736) Various improvements to the docs (#7899) Convert storage layer to async/await. (#7963) Add an option to disable purge in delete room admin API (#7964) Move some log lines from default logger to sql/transaction loggers (#7952) Use the JSON module from the std library instead of simplejson. (#7936) Fix exit code for `check_line_terminators.sh` (#7970) Option to allow server admins to join complex rooms (#7902) Fix typo in metrics docs (#7966) Add script for finding files with unix line terminators (#7965) Convert the remaining media repo code to async / await. (#7947) Convert a synapse.events to async/await. (#7949) Convert groups and visibility code to async / await. (#7951) Convert push to async/await. (#7948)

DMRobertson · 2021-11-01T14:57:37Z

tests/rest/admin/test_room.py

+        # Assert one user in room
+        self._is_member(room_id=self.room_id, user_id=self.other_user)
+
+        body = json.dumps({"block": False, "purge": False})


Is this a typo? Should this have been "block": True?

Good catch. I think so.
Neither block nor purge is certainly not a good use case.
My PR #11223 needs an update, too.

Neither block nor purge is certainly not a good use case.

To check my understanding, I think no block and no purge would

kick all local users out of the room

retain events for that room

all users would be free rejoin

I agree that this isn't a useful mode of operation! Sounds like it ought to caught and rejected with 400 bad request

I don't think you have to check everything. Maybe it's a edge case.

My concern is that someone might accidentally use the API in this way, and not realise that the room can come back to haunt them.

(Is there a use case for shutting down the room with block: False at all?)

I have no idea for an use case {"block": False, "purge": False} and remove all users.

found there: matrix-org#7964 (comment)

dklimpel added 2 commits July 27, 2020 20:50

Add an option to disable purge in delete room admin API

1e555b3

Add changelog

133a210

dklimpel force-pushed the delete_room_option_purge branch from b85b5a7 to 133a210 Compare July 27, 2020 20:18

anoadragon453 suggested changes Jul 28, 2020

View reviewed changes

richvdh added the X-Awaiting-Changes A contributed PR which needs changes and re-review before it can be merged label Jul 28, 2020

dklimpel and others added 3 commits July 28, 2020 17:37

Apply suggestions from code review

0354646

Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>

Apply suggestions for documentation

390d035

Merge 'develop' into delete_room_option_purge

926de16

dklimpel requested a review from anoadragon453 July 28, 2020 16:05

anoadragon453 approved these changes Jul 28, 2020

View reviewed changes

anoadragon453 merged commit e866e3b into matrix-org:develop Jul 28, 2020

dklimpel deleted the delete_room_option_purge branch July 28, 2020 19:08

DMRobertson removed the X-Awaiting-Changes A contributed PR which needs changes and re-review before it can be merged label Nov 1, 2021

DMRobertson reviewed Nov 1, 2021

View reviewed changes

dklimpel added a commit to dklimpel/synapse_archive that referenced this pull request Nov 1, 2021

Fix wrong unit test test_block_room_and_not_purge

6ddcc8e

found there: matrix-org#7964 (comment)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add an option to disable purge in delete room admin API #7964

Add an option to disable purge in delete room admin API #7964

dklimpel commented Jul 27, 2020 •

edited

anoadragon453 left a comment

anoadragon453 Jul 28, 2020

anoadragon453 left a comment

DMRobertson Nov 1, 2021

dklimpel Nov 1, 2021

DMRobertson Nov 1, 2021 •

edited

dklimpel Nov 1, 2021

DMRobertson Nov 1, 2021

dklimpel Nov 1, 2021

Add an option to disable purge in delete room admin API #7964

Add an option to disable purge in delete room admin API #7964

Conversation

dklimpel commented Jul 27, 2020 • edited

Pull Request Checklist

anoadragon453 left a comment

Choose a reason for hiding this comment

anoadragon453 Jul 28, 2020

Choose a reason for hiding this comment

anoadragon453 left a comment

Choose a reason for hiding this comment

DMRobertson Nov 1, 2021

Choose a reason for hiding this comment

dklimpel Nov 1, 2021

Choose a reason for hiding this comment

DMRobertson Nov 1, 2021 • edited

Choose a reason for hiding this comment

dklimpel Nov 1, 2021

Choose a reason for hiding this comment

DMRobertson Nov 1, 2021

Choose a reason for hiding this comment

dklimpel Nov 1, 2021

Choose a reason for hiding this comment

dklimpel commented Jul 27, 2020 •

edited

DMRobertson Nov 1, 2021 •

edited