deactivated flag refactored to filter deactivated users. #16874

afechler · 2024-01-30T07:34:42Z

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.
- Feel free to credit yourself, by adding a sentence "Contributed by @github_username." or "Contributed by [Your Name]." to the end of the entry.
Code style is correct
(run the linters)

Signed-off-by: Alexander Fechler [email protected]

CLAassistant · 2024-01-30T07:34:48Z

All committers have signed the CLA.

dklimpel · 2024-01-31T15:22:42Z

changelog.d/16874.feature

@@ -0,0 +1 @@
+Query parameter `deactivated` of [List Accounts](https://matrix-org.github.io/synapse/v1.99/admin_api/user_admin_api.html#list-accounts) [admin API](https://matrix-org.github.io/synapse/v1.99/usage/administration/admin_api/index.html) refactored, to filter deactivated users in user queries.


Current doc links: https://element-hq.github.io/synapse/v1.99/

I have the doc links adjusted.

anoadragon453 · 2024-02-19T13:44:09Z

docs/admin_api/user_admin_api.md

@@ -226,8 +226,10 @@ The following parameters should be set in the URL:
  Defaults to `true` to include guest users. This parameter is not supported when MSC3861 is enabled. [See #15582](https://github.com/matrix-org/synapse/pull/15582)
 - `admins` - Optional flag to filter admins. If `true`, only admins are queried. If `false`, admins are excluded from
  the query. When the flag is absent (the default), **both** admins and non-admins are included in the search results.
- `deactivated` - string representing a bool - Is optional and if `true` will **include** deactivated users.
-  Defaults to `false` to exclude deactivated users.
+- `deactivated` - Optional flag to filter deactivated users. If `true`, only deactivated users are queried. 


I'm afraid that this is a backward-incompatible change (the same query would return different results before and after merging this PR).

I can see the value in only returning deactivated users from this API, and I like the chosen behaviour of the new API. Would you be willing to refactor this PR to add a /v3 version of the "List Accounts" endpoint, where the deactivated endpoint behaves as you desire? While preserving the /v2 endpoint with the original behaviour?

I've refactored the PR. Now the pipeline breaks. But I don't understand the reason. The markdown looks fine for me.

This looks like that other documents have links to #list-accounts but this does not exists anymore because of renaming the headline.

Thank you, i've adjusted it.

The fact that the build doesn't work has nothing to do with my changes or have I miss something?

I believe this was just a race condition in SyTest and can be ignored. Sorry about that!

…rvletV3

- 16874.feature: link fixed.

anoadragon453

Hi @afechler, thanks for your patience on this one. I've left some minor changes, but overall things look good. Thanks for adding unit tests!

synapse/rest/admin/users.py

docs/admin_api/user_admin_api.md

synapse/rest/admin/users.py

tests/rest/admin/test_user.py

changelog.d/16874.feature

Co-authored-by: Andrew Morgan <[email protected]>

anoadragon453

LGTM. Thank you for your patience :)

@SpiritCroc

# Synapse 1.104.0 (2024-04-02) ### Bugfixes - Fix regression when using OIDC provider. Introduced in v1.104.0rc1. ([\#17031](element-hq/synapse#17031)) # Synapse 1.104.0rc1 (2024-03-26) ### Features - Add an OIDC config to specify extra parameters for the authorization grant URL. IT can be useful to pass an ACR value for example. ([\#16971](element-hq/synapse#16971)) - Add support for OIDC provider returning JWT. ([\#16972](element-hq/synapse#16972), [\#17031](element-hq/synapse#17031)) ### Bugfixes - Fix a bug which meant that, under certain circumstances, we might never retry sending events or to-device messages over federation after a failure. ([\#16925](element-hq/synapse#16925)) - Fix various long-standing bugs which could cause incorrect state to be returned from `/sync` in certain situations. ([\#16949](element-hq/synapse#16949)) - Fix case in which `m.fully_read` marker would not get updated. Contributed by @SpiritCroc. ([\#16990](element-hq/synapse#16990)) - Fix bug which did not retract a user's pending knocks at rooms when their account was deactivated. Contributed by @hanadi92. ([\#17010](element-hq/synapse#17010)) ### Updates to the Docker image - Updated `start.py` to generate config using the correct user ID when running as root (fixes [\#16824](element-hq/synapse#16824), [\#15202](element-hq/synapse#15202)). ([\#16978](element-hq/synapse#16978)) ### Improved Documentation - Add a query to force a refresh of a remote user's device list to the "Useful SQL for Admins" documentation page. ([\#16892](element-hq/synapse#16892)) - Minor grammatical corrections to the upgrade documentation. ([\#16965](element-hq/synapse#16965)) - Fix the sort order for the documentation version picker, so that newer releases appear above older ones. ([\#16966](element-hq/synapse#16966)) - Remove recommendation for a specific poetry version from contributing guide. ([\#17002](element-hq/synapse#17002)) ### Internal Changes - Improve lock performance when a lot of locks are all waiting for a single lock to be released. ([\#16840](element-hq/synapse#16840)) - Update power level default for public rooms. ([\#16907](element-hq/synapse#16907)) - Improve event validation. ([\#16908](element-hq/synapse#16908)) - Multi-worker-docker-container: disable log buffering. ([\#16919](element-hq/synapse#16919)) - Refactor state delta calculation in `/sync` handler. ([\#16929](element-hq/synapse#16929)) - Clarify docs for some room state functions. ([\#16950](element-hq/synapse#16950)) - Specify IP subnets in canonical form. ([\#16953](element-hq/synapse#16953)) - As done for SAML mapping provider, let's pass the module API to the OIDC one so the mapper can do more logic in its code. ([\#16974](element-hq/synapse#16974)) - Allow containers building on top of Synapse's Complement container is use the included PostgreSQL cluster. ([\#16985](element-hq/synapse#16985)) - Raise poetry-core version cap to 1.9.0. ([\#16986](element-hq/synapse#16986)) - Patch the db conn pool sooner in tests. ([\#17017](element-hq/synapse#17017)) ### Updates to locked dependencies * Bump anyhow from 1.0.80 to 1.0.81. ([\#17009](element-hq/synapse#17009)) * Bump black from 23.10.1 to 24.2.0. ([\#16936](element-hq/synapse#16936)) * Bump cryptography from 41.0.7 to 42.0.5. ([\#16958](element-hq/synapse#16958)) * Bump dawidd6/action-download-artifact from 3.1.1 to 3.1.2. ([\#16960](element-hq/synapse#16960)) * Bump dawidd6/action-download-artifact from 3.1.2 to 3.1.4. ([\#17008](element-hq/synapse#17008)) * Bump jinja2 from 3.1.2 to 3.1.3. ([\#17005](element-hq/synapse#17005)) * Bump log from 0.4.20 to 0.4.21. ([\#16977](element-hq/synapse#16977)) * Bump mypy from 1.5.1 to 1.8.0. ([\#16901](element-hq/synapse#16901)) * Bump netaddr from 0.9.0 to 1.2.1. ([\#17006](element-hq/synapse#17006)) * Bump pydantic from 2.6.0 to 2.6.4. ([\#17004](element-hq/synapse#17004)) * Bump pyo3 from 0.20.2 to 0.20.3. ([\#16962](element-hq/synapse#16962)) * Bump ruff from 0.1.14 to 0.3.2. ([\#16994](element-hq/synapse#16994)) * Bump serde from 1.0.196 to 1.0.197. ([\#16963](element-hq/synapse#16963)) * Bump serde_json from 1.0.113 to 1.0.114. ([\#16961](element-hq/synapse#16961)) * Bump types-jsonschema from 4.21.0.20240118 to 4.21.0.20240311. ([\#17007](element-hq/synapse#17007)) * Bump types-psycopg2 from 2.9.21.16 to 2.9.21.20240311. ([\#16995](element-hq/synapse#16995)) * Bump types-pyopenssl from 23.3.0.0 to 24.0.0.20240311. ([\#17003](element-hq/synapse#17003)) # Synapse 1.103.0 (2024-03-19) No significant changes since 1.103.0rc1. # Synapse 1.103.0rc1 (2024-03-12) ### Features - Add a new [List Accounts v3](https://element-hq.github.io/synapse/v1.103/admin_api/user_admin_api.html#list-accounts-v3) Admin API with improved deactivated user filtering capabilities. ([\#16874](element-hq/synapse#16874)) - Include `Retry-After` header by default per [MSC4041](matrix-org/matrix-spec-proposals#4041). Contributed by @clokep. ([\#16947](element-hq/synapse#16947)) ### Bugfixes - Fix joining remote rooms when a module uses the `on_new_event` callback. This callback may now pass partial state events instead of the full state for remote rooms. Introduced in v1.76.0. ([\#16973](element-hq/synapse#16973)) - Fix performance issue when joining very large rooms that can cause the server to lock up. Introduced in v1.100.0. Contributed by @ggogel. ([\#16968](element-hq/synapse#16968)) ### Improved Documentation - Add HAProxy example for single port operation to reverse proxy documentation. Contributed by Georg Pfuetzenreuter (@tacerus). ([\#16768](element-hq/synapse#16768)) - Improve the documentation around running Complement tests with new configuration parameters. ([\#16946](element-hq/synapse#16946)) - Add docs on upgrading from a very old version. ([\#16951](element-hq/synapse#16951)) ### Updates to locked dependencies * Bump JasonEtco/create-an-issue from 2.9.1 to 2.9.2. ([\#16934](element-hq/synapse#16934)) * Bump anyhow from 1.0.79 to 1.0.80. ([\#16935](element-hq/synapse#16935)) * Bump dawidd6/action-download-artifact from 3.0.0 to 3.1.1. ([\#16933](element-hq/synapse#16933)) * Bump furo from 2023.9.10 to 2024.1.29. ([\#16939](element-hq/synapse#16939)) * Bump pyopenssl from 23.3.0 to 24.0.0. ([\#16937](element-hq/synapse#16937)) * Bump types-netaddr from 0.10.0.20240106 to 1.2.0.20240219. ([\#16938](element-hq/synapse#16938))

afechler requested a review from a team as a code owner January 30, 2024 07:34

github-actions bot deployed to PR Documentation Preview January 30, 2024 07:35 Active

afechler force-pushed the pr/filter-deactivated-users branch from c81f17e to 86b6a88 Compare January 30, 2024 07:42

github-actions bot deployed to PR Documentation Preview January 30, 2024 07:43 Active

dklimpel reviewed Jan 31, 2024

View reviewed changes

github-actions bot deployed to PR Documentation Preview February 1, 2024 09:17 Active

anoadragon453 reviewed Feb 19, 2024

View reviewed changes

afechler force-pushed the pr/filter-deactivated-users branch from 33e22a9 to 495942b Compare February 23, 2024 12:36

github-actions bot deployed to PR Documentation Preview February 23, 2024 14:40 Active

github-actions bot deployed to PR Documentation Preview February 23, 2024 14:51 Active

afechler added 6 commits February 23, 2024 15:53

deactivated flag refactored to filter deactivated users.

a590303

Doclinks in the changelog adjusted.

9f68a68

Changed behaviour of query parameter deactivated moved to UsersRestSe…

0b6e3d6

…rvletV3

Remove empty line.

5c305a0

- __parse_parameter_deactivated renamed to _parse_parameter_deactivated

53a777a

- 16874.feature: link fixed.

Linter errors fixed.

01af9ab

afechler force-pushed the pr/filter-deactivated-users branch from a02fde2 to 01af9ab Compare February 23, 2024 14:53

github-actions bot deployed to PR Documentation Preview February 23, 2024 14:54 Active

anoadragon453 requested changes Mar 1, 2024

View reviewed changes

afechler and others added 6 commits March 4, 2024 11:51

Update synapse/rest/admin/users.py

bbf6528

Co-authored-by: Andrew Morgan <[email protected]>

Update docs/admin_api/user_admin_api.md

189e385

Co-authored-by: Andrew Morgan <[email protected]>

Update docs/admin_api/user_admin_api.md

9d0aede

Co-authored-by: Andrew Morgan <[email protected]>

Update synapse/rest/admin/users.py

e2ef77b

Co-authored-by: Andrew Morgan <[email protected]>

Update tests/rest/admin/test_user.py

c705a1a

Co-authored-by: Andrew Morgan <[email protected]>

Update changelog.d/16874.feature

48276fa

Co-authored-by: Andrew Morgan <[email protected]>

github-actions bot deployed to PR Documentation Preview March 4, 2024 10:56 Active

Linting error fixed.

2e85bc2

github-actions bot deployed to PR Documentation Preview March 4, 2024 13:48 Active

anoadragon453 approved these changes Mar 11, 2024

View reviewed changes

anoadragon453 merged commit 48f59d3 into element-hq:develop Mar 11, 2024
40 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

deactivated flag refactored to filter deactivated users. #16874

deactivated flag refactored to filter deactivated users. #16874

afechler commented Jan 30, 2024 •

edited

Loading

CLAassistant commented Jan 30, 2024 •

edited

Loading

dklimpel Jan 31, 2024

afechler Feb 1, 2024

anoadragon453 Feb 19, 2024

afechler Feb 23, 2024

dklimpel Feb 23, 2024

afechler Feb 23, 2024

afechler Feb 26, 2024

anoadragon453 Mar 1, 2024

anoadragon453 left a comment

anoadragon453 left a comment

		@@ -0,0 +1 @@
		Query parameter `deactivated` of [List Accounts](https://matrix-org.github.io/synapse/v1.99/admin_api/user_admin_api.html#list-accounts) [admin API](https://matrix-org.github.io/synapse/v1.99/usage/administration/admin_api/index.html) refactored, to filter deactivated users in user queries.

deactivated flag refactored to filter deactivated users. #16874

deactivated flag refactored to filter deactivated users. #16874

Conversation

afechler commented Jan 30, 2024 • edited Loading

Pull Request Checklist

CLAassistant commented Jan 30, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

anoadragon453 left a comment

Choose a reason for hiding this comment

anoadragon453 left a comment

Choose a reason for hiding this comment

afechler commented Jan 30, 2024 •

edited

Loading

CLAassistant commented Jan 30, 2024 •

edited

Loading