forked from treehouse/mastodon
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.rebase/4.0.0rc1
Claire
7 months ago
committed by
GitHub
parent
5823ae70c4
commit
02851848e9
60 changed files with 1292 additions and 250 deletions
@ -0,0 +1,50 @@ |
||||
# frozen_string_literal: true |
||||
|
||||
class Api::V1::Filters::KeywordsController < Api::BaseController |
||||
before_action -> { doorkeeper_authorize! :read, :'read:filters' }, only: [:index, :show] |
||||
before_action -> { doorkeeper_authorize! :write, :'write:filters' }, except: [:index, :show] |
||||
before_action :require_user! |
||||
|
||||
before_action :set_keywords, only: :index |
||||
before_action :set_keyword, only: [:show, :update, :destroy] |
||||
|
||||
def index |
||||
render json: @keywords, each_serializer: REST::FilterKeywordSerializer |
||||
end |
||||
|
||||
def create |
||||
@keyword = current_account.custom_filters.find(params[:filter_id]).keywords.create!(resource_params) |
||||
|
||||
render json: @keyword, serializer: REST::FilterKeywordSerializer |
||||
end |
||||
|
||||
def show |
||||
render json: @keyword, serializer: REST::FilterKeywordSerializer |
||||
end |
||||
|
||||
def update |
||||
@keyword.update!(resource_params) |
||||
|
||||
render json: @keyword, serializer: REST::FilterKeywordSerializer |
||||
end |
||||
|
||||
def destroy |
||||
@keyword.destroy! |
||||
render_empty |
||||
end |
||||
|
||||
private |
||||
|
||||
def set_keywords |
||||
filter = current_account.custom_filters.includes(:keywords).find(params[:filter_id]) |
||||
@keywords = filter.keywords |
||||
end |
||||
|
||||
def set_keyword |
||||
@keyword = CustomFilterKeyword.includes(:custom_filter).where(custom_filter: { account: current_account }).find(params[:id]) |
||||
end |
||||
|
||||
def resource_params |
||||
params.permit(:keyword, :whole_word) |
||||
end |
||||
end |
||||
@ -0,0 +1,48 @@ |
||||
# frozen_string_literal: true |
||||
|
||||
class Api::V2::FiltersController < Api::BaseController |
||||
before_action -> { doorkeeper_authorize! :read, :'read:filters' }, only: [:index, :show] |
||||
before_action -> { doorkeeper_authorize! :write, :'write:filters' }, except: [:index, :show] |
||||
before_action :require_user! |
||||
before_action :set_filters, only: :index |
||||
before_action :set_filter, only: [:show, :update, :destroy] |
||||
|
||||
def index |
||||
render json: @filters, each_serializer: REST::FilterSerializer, rules_requested: true |
||||
end |
||||
|
||||
def create |
||||
@filter = current_account.custom_filters.create!(resource_params) |
||||
|
||||
render json: @filter, serializer: REST::FilterSerializer, rules_requested: true |
||||
end |
||||
|
||||
def show |
||||
render json: @filter, serializer: REST::FilterSerializer, rules_requested: true |
||||
end |
||||
|
||||
def update |
||||
@filter.update!(resource_params) |
||||
|
||||
render json: @filter, serializer: REST::FilterSerializer, rules_requested: true |
||||
end |
||||
|
||||
def destroy |
||||
@filter.destroy! |
||||
render_empty |
||||
end |
||||
|
||||
private |
||||
|
||||
def set_filters |
||||
@filters = current_account.custom_filters.includes(:keywords) |
||||
end |
||||
|
||||
def set_filter |
||||
@filter = current_account.custom_filters.find(params[:id]) |
||||
end |
||||
|
||||
def resource_params |
||||
params.permit(:title, :expires_in, :filter_action, context: [], keywords_attributes: [:id, :keyword, :whole_word, :_destroy]) |
||||
end |
||||
end |
||||
@ -1,26 +0,0 @@ |
||||
import api from '../api'; |
||||
|
||||
export const FILTERS_FETCH_REQUEST = 'FILTERS_FETCH_REQUEST'; |
||||
export const FILTERS_FETCH_SUCCESS = 'FILTERS_FETCH_SUCCESS'; |
||||
export const FILTERS_FETCH_FAIL = 'FILTERS_FETCH_FAIL'; |
||||
|
||||
export const fetchFilters = () => (dispatch, getState) => { |
||||
dispatch({ |
||||
type: FILTERS_FETCH_REQUEST, |
||||
skipLoading: true, |
||||
}); |
||||
|
||||
api(getState) |
||||
.get('/api/v1/filters') |
||||
.then(({ data }) => dispatch({ |
||||
type: FILTERS_FETCH_SUCCESS, |
||||
filters: data, |
||||
skipLoading: true, |
||||
})) |
||||
.catch(err => dispatch({ |
||||
type: FILTERS_FETCH_FAIL, |
||||
err, |
||||
skipLoading: true, |
||||
skipAlert: true, |
||||
})); |
||||
}; |
||||
@ -0,0 +1,34 @@ |
||||
# frozen_string_literal: true |
||||
# == Schema Information |
||||
# |
||||
# Table name: custom_filter_keywords |
||||
# |
||||
# id :bigint not null, primary key |
||||
# custom_filter_id :bigint not null |
||||
# keyword :text default(""), not null |
||||
# whole_word :boolean default(TRUE), not null |
||||
# created_at :datetime not null |
||||
# updated_at :datetime not null |
||||
# |
||||
|
||||
class CustomFilterKeyword < ApplicationRecord |
||||
belongs_to :custom_filter |
||||
|
||||
validates :keyword, presence: true |
||||
|
||||
alias_attribute :phrase, :keyword |
||||
|
||||
before_save :prepare_cache_invalidation! |
||||
before_destroy :prepare_cache_invalidation! |
||||
after_commit :invalidate_cache! |
||||
|
||||
private |
||||
|
||||
def prepare_cache_invalidation! |
||||
custom_filter.prepare_cache_invalidation! |
||||
end |
||||
|
||||
def invalidate_cache! |
||||
custom_filter.invalidate_cache! |
||||
end |
||||
end |
||||
@ -0,0 +1,5 @@ |
||||
# frozen_string_literal: true |
||||
|
||||
class FilterResultPresenter < ActiveModelSerializers::Model |
||||
attributes :filter, :keyword_matches |
||||
end |
||||
@ -0,0 +1,9 @@ |
||||
# frozen_string_literal: true |
||||
|
||||
class REST::FilterKeywordSerializer < ActiveModel::Serializer |
||||
attributes :id, :keyword, :whole_word |
||||
|
||||
def id |
||||
object.id.to_s |
||||
end |
||||
end |
||||
@ -0,0 +1,6 @@ |
||||
# frozen_string_literal: true |
||||
|
||||
class REST::FilterResultSerializer < ActiveModel::Serializer |
||||
belongs_to :filter, serializer: REST::FilterSerializer |
||||
has_many :keyword_matches |
||||
end |
||||
@ -1,10 +1,14 @@ |
||||
# frozen_string_literal: true |
||||
|
||||
class REST::FilterSerializer < ActiveModel::Serializer |
||||
attributes :id, :phrase, :context, :whole_word, :expires_at, |
||||
:irreversible |
||||
attributes :id, :title, :context, :expires_at, :filter_action |
||||
has_many :keywords, serializer: REST::FilterKeywordSerializer, if: :rules_requested? |
||||
|
||||
def id |
||||
object.id.to_s |
||||
end |
||||
|
||||
def rules_requested? |
||||
instance_options[:rules_requested] |
||||
end |
||||
end |
||||
|
||||
@ -0,0 +1,26 @@ |
||||