Add admin API to list users' local media

[dklimpel]

Add admin API GET /_synapse/admin/v1/users/<user_id>/media to get information of users' uploaded files.

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 [email protected]

[erikjohnston]

I'm afraid I think this really needs to be a paginated API, otherwise this can return a huge amount of data.

I think we'll also need to an index to local_media_repository so that the queries don't have to do a full table scan. 4cade96 is an example of how to do so

[dklimpel]

I'm afraid I think this really needs to be a paginated API, otherwise this can return a huge amount of data.

I think we'll also need to an index to local_media_repository so that the queries don't have to do a full table scan. 4cade96 is an example of how to do so

I am not sure what I have to do. I have to create a background task like this?

        self.db.updates.register_background_index_update(
            "users_have_local_media",
            index_name="users_have_local_media",
            table="local_media_repository",
            columns=["user_id"],
        )

And create a new sql file in folder 56 or a new folder 57 with:

INSERT INTO background_updates (update_name, progress_json) VALUES
  ('users_have_local_media', '{}');

Nothing like CREATE INDEX ...?

[erikjohnston]

Yup, that is about right. It should go in 58/, as that is the latest schema version (and only deltas in the last version get applied). The latest schema version is defined in synapse/storage/prepare_database.py, but is pretty much always just the latest directory.

If we're creating an index for this we may as well include the ordering clause (I suggest created_ts) to make the query even quicker, i.e.:

        self.db.updates.register_background_index_update(
            "users_have_local_media",
            index_name="users_have_local_media",
            table="local_media_repository",
            columns=["user_id", "created_ts"],
        )

[erikjohnston]

Awesome, thanks! :D