catstodon/app/serializers/rest
Claire 02851848e9
Revamp post filtering system (#18058)
* Add model for custom filter keywords

* Use CustomFilterKeyword internally

Does not change the API

* Fix /filters/edit and /filters/new

* Add migration tests

* Remove whole_word column from custom_filters (covered by custom_filter_keywords)

* Redesign /filters

Instead of a list, present a card that displays more information and handles
multiple keywords per filter.

* Redesign /filters/new and /filters/edit to add and remove keywords

This adds a new gem dependency: cocoon, as well as a npm dependency:
cocoon-js-vanilla. Those are used to easily populate and remove form fields
from the user interface when manipulating multiple keyword filters at once.

* Add /api/v2/filters to edit filter with multiple keywords

Entities:
- `Filter`: `id`, `title`, `filter_action` (either `hide` or `warn`), `context`
  `keywords`
- `FilterKeyword`: `id`, `keyword`, `whole_word`

API endpoits:
- `GET /api/v2/filters` to list filters (including keywords)
- `POST /api/v2/filters` to create a new filter
  `keywords_attributes` can also be passed to create keywords in one request
- `GET /api/v2/filters/:id` to read a particular filter
- `PUT /api/v2/filters/:id` to update a new filter
  `keywords_attributes` can also be passed to edit, delete or add keywords in
   one request
- `DELETE /api/v2/filters/:id` to delete a particular filter
- `GET /api/v2/filters/:id/keywords` to list keywords for a filter
- `POST /api/v2/filters/:filter_id/keywords/:id` to add a new keyword to a
   filter
- `GET /api/v2/filter_keywords/:id` to read a particular keyword
- `PUT /api/v2/filter_keywords/:id` to edit a particular keyword
- `DELETE /api/v2/filter_keywords/:id` to delete a particular keyword

* Change from `irreversible` boolean to `action` enum

* Remove irrelevent `irreversible_must_be_within_context` check

* Fix /filters/new and /filters/edit with update for filter_action

* Fix Rubocop/Codeclimate complaining about task names

* Refactor FeedManager#phrase_filtered?

This moves regexp building and filter caching to the `CustomFilter` class.

This does not change the functional behavior yet, but this changes how the
cache is built, doing per-custom_filter regexps so that filters can be matched
independently, while still offering caching.

* Perform server-side filtering and output result in REST API

* Fix numerous filters_changed events being sent when editing multiple keywords at once

* Add some tests

* Use the new API in the WebUI

- use client-side logic for filters we have fetched rules for.
  This is so that filter changes can be retroactively applied without
  reloading the UI.
- use server-side logic for filters we haven't fetched rules for yet
  (e.g. network error, or initial timeline loading)

* Minor optimizations and refactoring

* Perform server-side filtering on the streaming server

* Change the wording of filter action labels

* Fix issues pointed out by linter

* Change design of “Show anyway” link in accordence to review comments

* Drop “irreversible” filtering behavior

* Move /api/v2/filter_keywords to /api/v1/filters/keywords

* Rename `filter_results` attribute to `filtered`

* Rename REST::LegacyFilterSerializer to REST::V1::FilterSerializer

* Fix systemChannelId value in streaming server

* Simplify code by removing client-side filtering code

The simplifcation comes at a cost though: filters aren't retroactively
applied anymore.
2022-06-28 09:42:13 +02:00
..
admin Add notifications for new reports (#18697) 2022-06-27 09:30:15 +02:00
keys Add E2EE API (#13820) 2020-06-02 19:24:53 +02:00
trends Add trending links (#16917) 2021-11-25 13:07:38 +01:00
v1 Revamp post filtering system (#18058) 2022-06-28 09:42:13 +02:00
account_serializer.rb Add limited attribute to accounts in REST API and a warning in web UI (#18344) 2022-05-10 09:44:35 +02:00
announcement_serializer.rb Refactor formatter (#17828) 2022-03-26 02:53:34 +01:00
application_serializer.rb Add vapid_key to the application entity in the REST API (#10058) 2019-02-16 05:27:05 +01:00
context_serializer.rb Refactor JSON templates to be generated with ActiveModelSerializers instead of Rabl (#4090) 2017-07-07 04:02:06 +02:00
conversation_serializer.rb Add unread indicator to conversations (#9009) 2018-10-19 01:47:29 +02:00
credential_account_serializer.rb Change silences to always require approval on follow (#11975) 2019-09-27 21:13:51 +02:00
custom_emoji_serializer.rb Add categories for custom emojis (#11196) 2019-06-28 15:54:10 +02:00
encrypted_message_serializer.rb Fix wrong route helper in encrypted messages controller (#13952) 2020-06-03 20:32:15 +02:00
familiar_followers_serializer.rb Add /api/v1/accounts/familiar_followers to REST API (#17700) 2022-03-07 09:36:47 +01:00
featured_tag_serializer.rb Use existing FeaturedTag serializer and delete AccountFeaturedTag serializer (#15415) 2020-12-23 16:43:38 +01:00
filter_keyword_serializer.rb Revamp post filtering system (#18058) 2022-06-28 09:42:13 +02:00
filter_result_serializer.rb Revamp post filtering system (#18058) 2022-06-28 09:42:13 +02:00
filter_serializer.rb Revamp post filtering system (#18058) 2022-06-28 09:42:13 +02:00
instance_serializer.rb Change brand color and logotypes (#18592) 2022-06-09 22:25:23 +02:00
list_serializer.rb Add configuration option to filter replies in lists (#9205) 2020-09-01 13:31:28 +02:00
marker_serializer.rb Add timeline read markers API (#11762) 2019-09-06 13:55:51 +02:00
media_attachment_serializer.rb Stop setting a shortcode to newly-created media attachments (#16730) 2021-09-13 18:59:37 +02:00
muted_account_serializer.rb Add duration parameter to muting. (#13831) 2020-10-13 01:01:14 +02:00
notification_serializer.rb Add notifications for new reports (#18697) 2022-06-27 09:30:15 +02:00
poll_serializer.rb Add voters count support (#11917) 2019-09-29 22:58:01 +02:00
preferences_serializer.rb Fix preferred posting language returning unusable value in REST API (#18428) 2022-05-16 19:13:36 +02:00
preview_card_serializer.rb Add blurhash to preview cards (#13984) 2020-06-05 23:10:41 +02:00
reaction_serializer.rb Add announcements (#12662) 2020-01-23 22:00:13 +01:00
relationship_serializer.rb Add option to be notified when a followed user posts (#13546) 2020-09-18 17:26:45 +02:00
report_serializer.rb Add notifications for new reports (#18697) 2022-06-27 09:30:15 +02:00
rule_serializer.rb Add server rules (#15769) 2021-02-21 19:50:12 +01:00
scheduled_status_serializer.rb Fix wrong param name in scheduled statuses and return params in API (#9725) 2019-01-06 12:03:27 +01:00
search_serializer.rb Remove deprecated GET /api/v1/search API (#11823) 2019-09-13 16:11:13 +02:00
status_edit_serializer.rb Refactor formatter (#17828) 2022-03-26 02:53:34 +01:00
status_serializer.rb Revamp post filtering system (#18058) 2022-06-28 09:42:13 +02:00
status_source_serializer.rb Add support for editing for published statuses (#16697) 2022-01-19 22:37:27 +01:00
suggestion_serializer.rb Add cold-start follow recommendations (#15945) 2021-04-12 12:37:14 +02:00
tag_serializer.rb Track trending tags (#7638) 2018-05-27 21:45:30 +02:00
web_push_subscription_serializer.rb Fix alerts booleans not being typecast correctly in push subscription (#11343) 2019-07-21 18:10:07 +02:00