Uniformize spam-checker API, part 1: the `Code` enum. #12703

Yoric · 2022-05-11T08:39:49Z

This PR is part of an ongoing refactoring to make the spam-checker API more powerful and more uniform.

In this PR, we introduce a string enum Code that regroups all known error codes. This will help us progressively replace some string-typing in error codes by strong typing. In particular, this is necessary for the ongoing refactoring.

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.
Pull request includes a sign off
Code style is correct
(run the linters)

Yoric · 2022-05-11T08:40:20Z

(this is currently a draft, as I haven't updated the documentation and tests)

Yoric · 2022-05-11T10:06:33Z

I just realized that several of the spam-check APIs have no tests. I'll try and add some while I'm at it.

reivilibre

This seems sensible as a whole, but I don't have full time to review it right now, so I'll put it back on the queue with what I have so far

synapse/api/errors.py

synapse/events/spamcheck.py

Yoric · 2022-05-20T06:53:53Z

As requested, cutting this in several smaller PRs.

This is a first step towards a refactoring of the Spam-checker API towards more uniform and more powerful API/type signatures.

synapse/api/errors.py

babolivier · 2022-05-20T09:20:56Z

synapse/api/errors.py

+    def __str__(self) -> str:
+        return self.value
+
+    def __repr__(self) -> str:
+        return repr(self.value)


What are these for? I can't see a difference in behaviour between this version and how it works on develop:

This branch:

>>> from synapse.api.errors import Codes >>> str(Codes.MISSING_TOKEN) 'M_MISSING_TOKEN' >>> repr(Codes.MISSING_TOKEN) "'M_MISSING_TOKEN'" >>>

develop:

>>> from synapse.api.errors import Codes >>> str(Codes.MISSING_TOKEN) 'M_MISSING_TOKEN' >>> repr(Codes.MISSING_TOKEN) "'M_MISSING_TOKEN'" >>>

Yes, that's to allow backwards compatibility.

Without these, Codes.foo becomes a Codes, which won't covert to a str, so we break all the sites that call e.g. Codes.MISSING_TOKEN.

Without these, Codes.foo becomes a Codes, which won't covert to a str

But with current develop I'm able to do str(Codes.MISSING_TOKEN) and it returns the same thing than it does with this change (I've just noticed I didn't paste my snippet correctly above, fixed now), so I'm not sure I understand what you're talking about. Can you show me an example of code that wouldn't work without this change?

My bad, it doesn't seem necessary.

Are you sure?

>>> from enum import Enum >>> class Codes(str, Enum): ... MISSING_TOKEN = "M_MISSING_TOKEN" ... >>> f"{Codes.MISSING_TOKEN}" 'M_MISSING_TOKEN' >>> "%s" % (Codes.MISSING_TOKEN,) 'Codes.MISSING_TOKEN' >>> str(Codes.MISSING_TOKEN) 'Codes.MISSING_TOKEN'

@SpiritCroc

Synapse 1.60.0rc1 (2022-05-24) ============================== This release of Synapse adds a unique index to the `state_group_edges` table, in order to prevent accidentally introducing duplicate information (for example, because a database backup was restored multiple times). If your Synapse database already has duplicate rows in this table, this could fail with an error and require manual remediation. Additionally, the signature of the `check_event_for_spam` module callback has changed. The previous signature has been deprecated and remains working for now. Module authors should update their modules to use the new signature where possible. See [the upgrade notes](https://github.com/matrix-org/synapse/blob/develop/docs/upgrade.md#upgrading-to-v1600) for more details. Features -------- - Measure the time taken in spam-checking callbacks and expose those measurements as metrics. ([\#12513](#12513)) - Add a `default_power_level_content_override` config option to set default room power levels per room preset. ([\#12618](#12618)) - Add support for [MSC3787: Allowing knocks to restricted rooms](matrix-org/matrix-spec-proposals#3787). ([\#12623](#12623)) - Send `USER_IP` commands on a different Redis channel, in order to reduce traffic to workers that do not process these commands. ([\#12672](#12672), [\#12809](#12809)) - Synapse will now reload [cache config](https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#caching) when it receives a [SIGHUP](https://en.wikipedia.org/wiki/SIGHUP) signal. ([\#12673](#12673)) - Add a config options to allow for auto-tuning of caches. ([\#12701](#12701)) - Update [MSC2716](matrix-org/matrix-spec-proposals#2716) implementation to process marker events from the current state to avoid markers being lost in timeline gaps for federated servers which would cause the imported history to be undiscovered. ([\#12718](#12718)) - Add a `drop_federated_event` callback to `SpamChecker` to disregard inbound federated events before they take up much processing power, in an emergency. ([\#12744](#12744)) - Implement [MSC3818: Copy room type on upgrade](matrix-org/matrix-spec-proposals#3818). ([\#12786](#12786), [\#12792](#12792)) - Update to the `check_event_for_spam` module callback. Deprecate the current callback signature, replace it with a new signature that is both less ambiguous (replacing booleans with explicit allow/block) and more powerful (ability to return explicit error codes). ([\#12808](#12808)) Bugfixes -------- - Fix a bug introduced in Synapse 1.7.0 that would prevent events from being sent to clients if there's a retention policy in the room when the support for retention policies is disabled. ([\#12611](#12611)) - Fix a bug introduced in Synapse 1.57.0 where `/messages` would throw a 500 error when querying for a non-existent room. ([\#12683](#12683)) - Add a unique index to `state_group_edges` to prevent duplicates being accidentally introduced and the consequential impact to performance. ([\#12687](#12687)) - Fix a long-standing bug where an empty room would be created when a user with an insufficient power level tried to upgrade a room. ([\#12696](#12696)) - Fix a bug introduced in Synapse 1.30.0 where empty rooms could be automatically created if a monthly active users limit is set. ([\#12713](#12713)) - Fix push to dismiss notifications when read on another client. Contributed by @SpiritCroc @ Beeper. ([\#12721](#12721)) - Fix poor database performance when reading the cache invalidation stream for large servers with lots of workers. ([\#12747](#12747)) - Delete events from the `federation_inbound_events_staging` table when a room is purged through the admin API. ([\#12770](#12770)) - Give a meaningful error message when a client tries to create a room with an invalid alias localpart. ([\#12779](#12779)) - Fix a bug introduced in 1.43.0 where a file (`providers.json`) was never closed. Contributed by @arkamar. ([\#12794](#12794)) - Fix a long-standing bug where finished log contexts would be re-started when failing to contact remote homeservers. ([\#12803](#12803)) - Fix a bug, introduced in Synapse 1.21.0, that led to media thumbnails being unusable before the index has been added in the background. ([\#12823](#12823)) Updates to the Docker image --------------------------- - Fix the docker file after a dependency update. ([\#12853](#12853)) Improved Documentation ---------------------- - Fix a typo in the Media Admin API documentation. ([\#12715](#12715)) - Update the OpenID Connect example for Keycloak to be compatible with newer versions of Keycloak. Contributed by @nhh. ([\#12727](#12727)) - Fix typo in server listener documentation. ([\#12742](#12742)) - Link to the configuration manual from the welcome page of the documentation. ([\#12748](#12748)) - Fix typo in `run_background_tasks_on` option name in configuration manual documentation. ([\#12749](#12749)) - Add information regarding the `rc_invites` ratelimiting option to the configuration docs. ([\#12759](#12759)) - Add documentation for cancellation of request processing. ([\#12761](#12761)) - Recommend using docker to run tests against postgres. ([\#12765](#12765)) - Add missing user directory endpoint from the generic worker documentation. Contributed by @olmari. ([\#12773](#12773)) - Add additional info to documentation of config option `cache_autotuning`. ([\#12776](#12776)) - Update configuration manual documentation to document size-related suffixes. ([\#12777](#12777)) - Fix invalid YAML syntax in the example documentation for the `url_preview_accept_language` config option. ([\#12785](#12785)) Deprecations and Removals ------------------------- - Require a body in POST requests to `/rooms/{roomId}/receipt/{receiptType}/{eventId}`, as required by the [Matrix specification](https://spec.matrix.org/v1.2/client-server-api/#post_matrixclientv3roomsroomidreceiptreceipttypeeventid). This breaks compatibility with Element Android 1.2.0 and earlier: users of those clients will be unable to send read receipts. ([\#12709](#12709)) Internal Changes ---------------- - Improve event caching mechanism to avoid having multiple copies of an event in memory at a time. ([\#10533](#10533)) - Preparation for faster-room-join work: return subsets of room state which we already have, immediately. ([\#12498](#12498)) - Add `@cancellable` decorator, for use on endpoint methods that can be cancelled when clients disconnect. ([\#12586](#12586), [\#12588](#12588), [\#12630](#12630), [\#12694](#12694), [\#12698](#12698), [\#12699](#12699), [\#12700](#12700), [\#12705](#12705)) - Enable cancellation of `GET /rooms/$room_id/members`, `GET /rooms/$room_id/state` and `GET /rooms/$room_id/state/$event_type/*` requests. ([\#12708](#12708)) - Improve documentation of the `synapse.push` module. ([\#12676](#12676)) - Refactor functions to on `PushRuleEvaluatorForEvent`. ([\#12677](#12677)) - Preparation for database schema simplifications: stop writing to `event_reference_hashes`. ([\#12679](#12679)) - Remove code which updates unused database column `application_services_state.last_txn`. ([\#12680](#12680)) - Refactor `EventContext` class. ([\#12689](#12689)) - Remove an unneeded class in the push code. ([\#12691](#12691)) - Consolidate parsing of relation information from events. ([\#12693](#12693)) - Convert namespace class `Codes` into a string enum. ([\#12703](#12703)) - Optimize private read receipt filtering. ([\#12711](#12711)) - Drop the logging level of status messages for the URL preview cache expiry job from INFO to DEBUG. ([\#12720](#12720)) - Downgrade some OIDC errors to warnings in the logs, to reduce the noise of Sentry reports. ([\#12723](#12723)) - Update configs used by Complement to allow more invites/3PID validations during tests. ([\#12731](#12731)) - Fix a long-standing bug where the user directory background process would fail to make forward progress if a user included a null codepoint in their display name or avatar. ([\#12762](#12762)) - Tweak the mypy plugin so that `@cached` can accept `on_invalidate=None`. ([\#12769](#12769)) - Move methods that call `add_push_rule` to the `PushRuleStore` class. ([\#12772](#12772)) - Make handling of federation Authorization header (more) compliant with RFC7230. ([\#12774](#12774)) - Refactor `resolve_state_groups_for_events` to not pull out full state when no state resolution happens. ([\#12775](#12775)) - Do not keep going if there are 5 back-to-back background update failures. ([\#12781](#12781)) - Fix federation when using the demo scripts. ([\#12783](#12783)) - The `hash_password` script now fails when it is called without specifying a config file. Contributed by @jae1911. ([\#12789](#12789)) - Improve and fix type hints. ([\#12567](#12567), [\#12477](#12477), [\#12717](#12717), [\#12753](#12753), [\#12695](#12695), [\#12734](#12734), [\#12716](#12716), [\#12726](#12726), [\#12790](#12790), [\#12833](#12833)) - Update EventContext `get_current_event_ids` and `get_prev_event_ids` to accept state filters and update calls where possible. ([\#12791](#12791)) - Remove Caddy from the Synapse workers image used in Complement. ([\#12818](#12818)) - Add Complement's shared registration secret to the Complement worker image. This fixes tests that depend on it. ([\#12819](#12819)) - Support registering Application Services when running with workers under Complement. ([\#12826](#12826)) - Disable 'faster room join' Complement tests when testing against Synapse with workers. ([\#12842](#12842))

See also: - Part 1: #12703 - Part 2: #12808 - Adding an error code for suspended accounts #12845

…e`, `user_may_send_3pid_invite`, `user_may_create_room`, `user_may_create_room_alias`, `user_may_publish_room`, `check_media_file_for_spam` to more powerful and less ambiguous `Union[Literal["NOT_SPAM"], Codes]`. This is a followup to #12703, #12808, #12846 and builds towards giving the spam-checker API the ability to inform users of *why* their event or operation has been rejected. WIP: Applying feedback.

@SpiritCroc

Synapse 1.60.0 (2022-05-31) =========================== This release of Synapse adds a unique index to the `state_group_edges` table, in order to prevent accidentally introducing duplicate information (for example, because a database backup was restored multiple times). If your Synapse database already has duplicate rows in this table, this could fail with an error and require manual remediation. Additionally, the signature of the `check_event_for_spam` module callback has changed. The previous signature has been deprecated and remains working for now. Module authors should update their modules to use the new signature where possible. See [the upgrade notes](https://github.com/matrix-org/synapse/blob/develop/docs/upgrade.md#upgrading-to-v1600) for more details. Bugfixes -------- - Fix a bug introduced in Synapse 1.60.0rc1 that would break some imports from `synapse.module_api`. ([\matrix-org#12918](matrix-org#12918)) Synapse 1.60.0rc2 (2022-05-27) ============================== Features -------- - Add an option allowing users to use their password to reauthenticate for privileged actions even though password login is disabled. ([\matrix-org#12883](matrix-org#12883)) Bugfixes -------- - Explicitly close `ijson` coroutines once we are done with them, instead of leaving the garbage collector to close them. ([\matrix-org#12875](matrix-org#12875)) Internal Changes ---------------- - Improve URL previews by not including the content of media tags in the generated description. ([\matrix-org#12887](matrix-org#12887)) Synapse 1.60.0rc1 (2022-05-24) ============================== Features -------- - Measure the time taken in spam-checking callbacks and expose those measurements as metrics. ([\matrix-org#12513](matrix-org#12513)) - Add a `default_power_level_content_override` config option to set default room power levels per room preset. ([\matrix-org#12618](matrix-org#12618)) - Add support for [MSC3787: Allowing knocks to restricted rooms](matrix-org/matrix-spec-proposals#3787). ([\matrix-org#12623](matrix-org#12623)) - Send `USER_IP` commands on a different Redis channel, in order to reduce traffic to workers that do not process these commands. ([\matrix-org#12672](matrix-org#12672), [\matrix-org#12809](matrix-org#12809)) - Synapse will now reload [cache config](https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#caching) when it receives a [SIGHUP](https://en.wikipedia.org/wiki/SIGHUP) signal. ([\matrix-org#12673](matrix-org#12673)) - Add a config options to allow for auto-tuning of caches. ([\matrix-org#12701](matrix-org#12701)) - Update [MSC2716](matrix-org/matrix-spec-proposals#2716) implementation to process marker events from the current state to avoid markers being lost in timeline gaps for federated servers which would cause the imported history to be undiscovered. ([\matrix-org#12718](matrix-org#12718)) - Add a `drop_federated_event` callback to `SpamChecker` to disregard inbound federated events before they take up much processing power, in an emergency. ([\matrix-org#12744](matrix-org#12744)) - Implement [MSC3818: Copy room type on upgrade](matrix-org/matrix-spec-proposals#3818). ([\matrix-org#12786](matrix-org#12786), [\matrix-org#12792](matrix-org#12792)) - Update to the `check_event_for_spam` module callback. Deprecate the current callback signature, replace it with a new signature that is both less ambiguous (replacing booleans with explicit allow/block) and more powerful (ability to return explicit error codes). ([\matrix-org#12808](matrix-org#12808)) Bugfixes -------- - Fix a bug introduced in Synapse 1.7.0 that would prevent events from being sent to clients if there's a retention policy in the room when the support for retention policies is disabled. ([\matrix-org#12611](matrix-org#12611)) - Fix a bug introduced in Synapse 1.57.0 where `/messages` would throw a 500 error when querying for a non-existent room. ([\matrix-org#12683](matrix-org#12683)) - Add a unique index to `state_group_edges` to prevent duplicates being accidentally introduced and the consequential impact to performance. ([\matrix-org#12687](matrix-org#12687)) - Fix a long-standing bug where an empty room would be created when a user with an insufficient power level tried to upgrade a room. ([\matrix-org#12696](matrix-org#12696)) - Fix a bug introduced in Synapse 1.30.0 where empty rooms could be automatically created if a monthly active users limit is set. ([\matrix-org#12713](matrix-org#12713)) - Fix push to dismiss notifications when read on another client. Contributed by @SpiritCroc @ Beeper. ([\matrix-org#12721](matrix-org#12721)) - Fix poor database performance when reading the cache invalidation stream for large servers with lots of workers. ([\matrix-org#12747](matrix-org#12747)) - Delete events from the `federation_inbound_events_staging` table when a room is purged through the admin API. ([\matrix-org#12770](matrix-org#12770)) - Give a meaningful error message when a client tries to create a room with an invalid alias localpart. ([\matrix-org#12779](matrix-org#12779)) - Fix a bug introduced in 1.43.0 where a file (`providers.json`) was never closed. Contributed by @arkamar. ([\matrix-org#12794](matrix-org#12794)) - Fix a long-standing bug where finished log contexts would be re-started when failing to contact remote homeservers. ([\matrix-org#12803](matrix-org#12803)) - Fix a bug, introduced in Synapse 1.21.0, that led to media thumbnails being unusable before the index has been added in the background. ([\matrix-org#12823](matrix-org#12823)) Updates to the Docker image --------------------------- - Fix the docker file after a dependency update. ([\matrix-org#12853](matrix-org#12853)) Improved Documentation ---------------------- - Fix a typo in the Media Admin API documentation. ([\matrix-org#12715](matrix-org#12715)) - Update the OpenID Connect example for Keycloak to be compatible with newer versions of Keycloak. Contributed by @nhh. ([\matrix-org#12727](matrix-org#12727)) - Fix typo in server listener documentation. ([\matrix-org#12742](matrix-org#12742)) - Link to the configuration manual from the welcome page of the documentation. ([\matrix-org#12748](matrix-org#12748)) - Fix typo in `run_background_tasks_on` option name in configuration manual documentation. ([\matrix-org#12749](matrix-org#12749)) - Add information regarding the `rc_invites` ratelimiting option to the configuration docs. ([\matrix-org#12759](matrix-org#12759)) - Add documentation for cancellation of request processing. ([\matrix-org#12761](matrix-org#12761)) - Recommend using docker to run tests against postgres. ([\matrix-org#12765](matrix-org#12765)) - Add missing user directory endpoint from the generic worker documentation. Contributed by @olmari. ([\matrix-org#12773](matrix-org#12773)) - Add additional info to documentation of config option `cache_autotuning`. ([\matrix-org#12776](matrix-org#12776)) - Update configuration manual documentation to document size-related suffixes. ([\matrix-org#12777](matrix-org#12777)) - Fix invalid YAML syntax in the example documentation for the `url_preview_accept_language` config option. ([\matrix-org#12785](matrix-org#12785)) Deprecations and Removals ------------------------- - Require a body in POST requests to `/rooms/{roomId}/receipt/{receiptType}/{eventId}`, as required by the [Matrix specification](https://spec.matrix.org/v1.2/client-server-api/#post_matrixclientv3roomsroomidreceiptreceipttypeeventid). This breaks compatibility with Element Android 1.2.0 and earlier: users of those clients will be unable to send read receipts. ([\matrix-org#12709](matrix-org#12709)) Internal Changes ---------------- - Improve event caching mechanism to avoid having multiple copies of an event in memory at a time. ([\matrix-org#10533](matrix-org#10533)) - Preparation for faster-room-join work: return subsets of room state which we already have, immediately. ([\matrix-org#12498](matrix-org#12498)) - Add `@cancellable` decorator, for use on endpoint methods that can be cancelled when clients disconnect. ([\matrix-org#12586](matrix-org#12586), [\matrix-org#12588](matrix-org#12588), [\matrix-org#12630](matrix-org#12630), [\matrix-org#12694](matrix-org#12694), [\matrix-org#12698](matrix-org#12698), [\matrix-org#12699](matrix-org#12699), [\matrix-org#12700](matrix-org#12700), [\matrix-org#12705](matrix-org#12705)) - Enable cancellation of `GET /rooms/$room_id/members`, `GET /rooms/$room_id/state` and `GET /rooms/$room_id/state/$event_type/*` requests. ([\matrix-org#12708](matrix-org#12708)) - Improve documentation of the `synapse.push` module. ([\matrix-org#12676](matrix-org#12676)) - Refactor functions to on `PushRuleEvaluatorForEvent`. ([\matrix-org#12677](matrix-org#12677)) - Preparation for database schema simplifications: stop writing to `event_reference_hashes`. ([\matrix-org#12679](matrix-org#12679)) - Remove code which updates unused database column `application_services_state.last_txn`. ([\matrix-org#12680](matrix-org#12680)) - Refactor `EventContext` class. ([\matrix-org#12689](matrix-org#12689)) - Remove an unneeded class in the push code. ([\matrix-org#12691](matrix-org#12691)) - Consolidate parsing of relation information from events. ([\matrix-org#12693](matrix-org#12693)) - Convert namespace class `Codes` into a string enum. ([\matrix-org#12703](matrix-org#12703)) - Optimize private read receipt filtering. ([\matrix-org#12711](matrix-org#12711)) - Drop the logging level of status messages for the URL preview cache expiry job from INFO to DEBUG. ([\matrix-org#12720](matrix-org#12720)) - Downgrade some OIDC errors to warnings in the logs, to reduce the noise of Sentry reports. ([\matrix-org#12723](matrix-org#12723)) - Update configs used by Complement to allow more invites/3PID validations during tests. ([\matrix-org#12731](matrix-org#12731)) - Fix a long-standing bug where the user directory background process would fail to make forward progress if a user included a null codepoint in their display name or avatar. ([\matrix-org#12762](matrix-org#12762)) - Tweak the mypy plugin so that `@cached` can accept `on_invalidate=None`. ([\matrix-org#12769](matrix-org#12769)) - Move methods that call `add_push_rule` to the `PushRuleStore` class. ([\matrix-org#12772](matrix-org#12772)) - Make handling of federation Authorization header (more) compliant with RFC7230. ([\matrix-org#12774](matrix-org#12774)) - Refactor `resolve_state_groups_for_events` to not pull out full state when no state resolution happens. ([\matrix-org#12775](matrix-org#12775)) - Do not keep going if there are 5 back-to-back background update failures. ([\matrix-org#12781](matrix-org#12781)) - Fix federation when using the demo scripts. ([\matrix-org#12783](matrix-org#12783)) - The `hash_password` script now fails when it is called without specifying a config file. Contributed by @jae1911. ([\matrix-org#12789](matrix-org#12789)) - Improve and fix type hints. ([\matrix-org#12567](matrix-org#12567), [\matrix-org#12477](matrix-org#12477), [\matrix-org#12717](matrix-org#12717), [\matrix-org#12753](matrix-org#12753), [\matrix-org#12695](matrix-org#12695), [\matrix-org#12734](matrix-org#12734), [\matrix-org#12716](matrix-org#12716), [\matrix-org#12726](matrix-org#12726), [\matrix-org#12790](matrix-org#12790), [\matrix-org#12833](matrix-org#12833)) - Update EventContext `get_current_event_ids` and `get_prev_event_ids` to accept state filters and update calls where possible. ([\matrix-org#12791](matrix-org#12791)) - Remove Caddy from the Synapse workers image used in Complement. ([\matrix-org#12818](matrix-org#12818)) - Add Complement's shared registration secret to the Complement worker image. This fixes tests that depend on it. ([\matrix-org#12819](matrix-org#12819)) - Support registering Application Services when running with workers under Complement. ([\matrix-org#12826](matrix-org#12826)) - Disable 'faster room join' Complement tests when testing against Synapse with workers. ([\matrix-org#12842](matrix-org#12842))

Yoric force-pushed the yoric/spam-errors branch from f8f6eea to b257743 Compare May 11, 2022 10:11

Yoric marked this pull request as ready for review May 11, 2022 10:49

Yoric requested a review from a team as a code owner May 11, 2022 10:49

reivilibre reviewed May 13, 2022

View reviewed changes

synapse/api/errors.py Outdated Show resolved Hide resolved

synapse/api/errors.py Outdated Show resolved Hide resolved

synapse/events/spamcheck.py Outdated Show resolved Hide resolved

reivilibre requested a review from a team May 13, 2022 15:06

Yoric mentioned this pull request May 16, 2022

add SpamChecker callback for silently dropping inbound federated events #12744

Merged

4 tasks

Yoric force-pushed the yoric/spam-errors branch 4 times, most recently from 9f8f6a5 to 73bc9dd Compare May 20, 2022 06:51

Yoric changed the title ~~Uniformize spam-checker API:~~ Uniformize spam-checker API, part 1: the Code enum. May 20, 2022

Introduce an enum Code to replace the namespace class Codes.

4657d28

This is a first step towards a refactoring of the Spam-checker API towards more uniform and more powerful API/type signatures.

Yoric force-pushed the yoric/spam-errors branch from 73bc9dd to 4657d28 Compare May 20, 2022 07:34

Yoric requested a review from reivilibre May 20, 2022 08:00

babolivier suggested changes May 20, 2022

View reviewed changes

synapse/api/errors.py Outdated Show resolved Hide resolved

WIP: Applied feedback

5e38930

Yoric requested a review from babolivier May 20, 2022 09:09

babolivier reviewed May 20, 2022

View reviewed changes

WIP: Simplifying Codes

0aeff5e

babolivier approved these changes May 20, 2022

View reviewed changes

babolivier merged commit 10280fc into develop May 20, 2022

babolivier deleted the yoric/spam-errors branch May 20, 2022 12:53

Yoric added a commit that referenced this pull request May 30, 2022

WIP: Applied feedback

4079736

See also: - Part 1: #12703 - Part 2: #12808 - Adding an error code for suspended accounts #12845

Yoric added a commit that referenced this pull request May 30, 2022

WIP: Applied feedback

c5e36ca

See also: - Part 1: #12703 - Part 2: #12808 - Adding an error code for suspended accounts #12845

Yoric mentioned this pull request Jun 1, 2022

Uniformize spam-checker API, part 3: Expand check_event_for_spam with the ability to return additional fields #12846

Merged

4 tasks

This was referenced Jun 8, 2022

Uniformize spam-checker API, part 4: port other spam-checker callbacks to return Union[Allow, Codes]. #12857

Merged

Uniformize spam-checker API, part 2: check_event_for_spam #12808

Merged

Yoric mentioned this pull request Jun 14, 2022

Uniformize spam-checker API, part 5: expand other spam-checker callbacks to return Tuple[Codes, dict] #13044

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uniformize spam-checker API, part 1: the `Code` enum. #12703

Uniformize spam-checker API, part 1: the `Code` enum. #12703

Yoric commented May 11, 2022 •

edited by MadLittleMods

Loading

Yoric commented May 11, 2022

Yoric commented May 11, 2022

reivilibre left a comment

Yoric commented May 20, 2022

babolivier May 20, 2022 •

edited

Loading

Yoric May 20, 2022

babolivier May 20, 2022 •

edited

Loading

Yoric May 20, 2022

squahtx May 20, 2022

Uniformize spam-checker API, part 1: the Code enum. #12703

Uniformize spam-checker API, part 1: the Code enum. #12703

Conversation

Yoric commented May 11, 2022 • edited by MadLittleMods Loading

Pull Request Checklist

Yoric commented May 11, 2022

Yoric commented May 11, 2022

reivilibre left a comment

Choose a reason for hiding this comment

Yoric commented May 20, 2022

babolivier May 20, 2022 • edited Loading

Choose a reason for hiding this comment

Yoric May 20, 2022

Choose a reason for hiding this comment

babolivier May 20, 2022 • edited Loading

Choose a reason for hiding this comment

Yoric May 20, 2022

Choose a reason for hiding this comment

squahtx May 20, 2022

Choose a reason for hiding this comment

Uniformize spam-checker API, part 1: the `Code` enum. #12703

Uniformize spam-checker API, part 1: the `Code` enum. #12703

Yoric commented May 11, 2022 •

edited by MadLittleMods

Loading

babolivier May 20, 2022 •

edited

Loading

babolivier May 20, 2022 •

edited

Loading