forked from berserker/microblog
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.main
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 @@ |
||||
# frozen_string_literal: true |
||||
|
||||
class REST::V1::FilterSerializer < ActiveModel::Serializer |
||||
attributes :id, :phrase, :context, :whole_word, :expires_at, |
||||
:irreversible |
||||
|
||||
delegate :context, :expires_at, to: :custom_filter |
||||
|
||||
def id |
||||
object.id.to_s |
||||
end |
||||
|
||||
def phrase |
||||
object.keyword |
||||
end |
||||
|
||||
def irreversible |
||||
custom_filter.irreversible? |
||||
end |
||||
|
||||
private |
||||
|
||||
def custom_filter |
||||
object.custom_filter |
||||
end |
||||
end |
@ -1,16 +0,0 @@ |
||||
.fields-row |
||||
.fields-row__column.fields-row__column-6.fields-group |
||||
= f.input :phrase, as: :string, wrapper: :with_label, hint: false |
||||
.fields-row__column.fields-row__column-6.fields-group |
||||
= f.input :expires_in, wrapper: :with_label, collection: [30.minutes, 1.hour, 6.hours, 12.hours, 1.day, 1.week].map(&:to_i), label_method: lambda { |i| I18n.t("invites.expires_in.#{i}") }, include_blank: I18n.t('invites.expires_in_prompt') |
||||
|
||||
.fields-group |
||||
= f.input :context, wrapper: :with_block_label, collection: CustomFilter::VALID_CONTEXTS, as: :check_boxes, collection_wrapper_tag: 'ul', item_wrapper_tag: 'li', label_method: lambda { |context| I18n.t("filters.contexts.#{context}") }, include_blank: false |
||||
|
||||
%hr.spacer/ |
||||
|
||||
.fields-group |
||||
= f.input :irreversible, wrapper: :with_label |
||||
|
||||
.fields-group |
||||
= f.input :whole_word, wrapper: :with_label |
@ -0,0 +1,32 @@ |
||||
.filters-list__item{ class: [filter.expired? && 'expired'] } |
||||
= link_to edit_filter_path(filter), class: 'filters-list__item__title' do |
||||
= filter.title |
||||
|
||||
- if filter.expires? |
||||
.expiration{ title: t('filters.index.expires_on', date: l(filter.expires_at)) } |
||||
- if filter.expired? |
||||
= t('invites.expired') |
||||
- else |
||||
= t('filters.index.expires_in', distance: distance_of_time_in_words_to_now(filter.expires_at)) |
||||
|
||||
.filters-list__item__permissions |
||||
%ul.permissions-list |
||||
- unless filter.keywords.empty? |
||||
%li.permissions-list__item |
||||
.permissions-list__item__icon |
||||
= fa_icon('paragraph') |
||||
.permissions-list__item__text |
||||
.permissions-list__item__text__title |
||||
= t('filters.index.keywords', count: filter.keywords.size) |
||||
.permissions-list__item__text__type |
||||
- keywords = filter.keywords.map(&:keyword) |
||||
- keywords = keywords.take(5) + ['…'] if keywords.size > 5 # TODO |
||||
= keywords.join(', ') |
||||
|
||||
.announcements-list__item__action-bar |
||||
.announcements-list__item__meta |
||||
= t('filters.index.contexts', contexts: filter.context.map { |context| I18n.t("filters.contexts.#{context}") }.join(', ')) |
||||
|
||||
%div |
||||
= table_link_to 'pencil', t('filters.edit.title'), edit_filter_path(filter) |
||||
= table_link_to 'times', t('filters.index.delete'), filter_path(filter), method: :delete, data: { confirm: t('admin.accounts.are_you_sure') } |
@ -0,0 +1,33 @@ |
||||
.fields-row |
||||
.fields-row__column.fields-row__column-6.fields-group |
||||
= f.input :title, as: :string, wrapper: :with_label, hint: false |
||||
.fields-row__column.fields-row__column-6.fields-group |
||||
= f.input :expires_in, wrapper: :with_label, collection: [30.minutes, 1.hour, 6.hours, 12.hours, 1.day, 1.week].map(&:to_i), label_method: lambda { |i| I18n.t("invites.expires_in.#{i}") }, include_blank: I18n.t('invites.expires_in_prompt') |
||||
|
||||
.fields-group |
||||
= f.input :context, wrapper: :with_block_label, collection: CustomFilter::VALID_CONTEXTS, as: :check_boxes, collection_wrapper_tag: 'ul', item_wrapper_tag: 'li', label_method: lambda { |context| I18n.t("filters.contexts.#{context}") }, include_blank: false |
||||
|
||||
%hr.spacer/ |
||||
|
||||
.fields-group |
||||
= f.input :filter_action, as: :radio_buttons, collection: %i(warn hide), include_blank: false, wrapper: :with_block_label, label_method: ->(action) { safe_join([t("simple_form.labels.filters.actions.#{action}"), content_tag(:span, t("simple_form.hints.filters.actions.#{action}"), class: 'hint')]) }, hint: t('simple_form.hints.filters.action'), required: true |
||||
|
||||
%hr.spacer/ |
||||
|
||||
%h4= t('filters.edit.keywords') |
||||
|
||||
.table-wrapper |
||||
%table.table.keywords-table |
||||
%thead |
||||
%tr |
||||
%th= t('simple_form.labels.defaults.phrase') |
||||
%th= t('simple_form.labels.defaults.whole_word') |
||||
%th |
||||
%tbody |
||||
= f.simple_fields_for :keywords do |keyword| |
||||
= render 'keyword_fields', f: keyword |
||||
%tfoot |
||||
%tr |
||||
%td{ colspan: 3} |
||||
= link_to_add_association f, :keywords, class: 'table-action-link', partial: 'keyword_fields', 'data-association-insertion-node': '.keywords-table tbody', 'data-association-insertion-method': 'append' do |
||||
= safe_join([fa_icon('plus'), t('filters.edit.add_keyword')]) |
@ -0,0 +1,8 @@ |
||||
%tr.nested-fields |
||||
%td= f.input :keyword, as: :string |
||||
%td |
||||
.label_input__wrapper= f.input_field :whole_word |
||||
%td |
||||
= f.hidden_field :id if f.object&.persisted? # Required so Rails doesn't put the field outside of the <tr/> |
||||
= link_to_remove_association(f, class: 'table-action-link') do |
||||
= safe_join([fa_icon('times'), t('filters.index.delete')]) |
@ -0,0 +1,13 @@ |
||||
# frozen_string_literal: true |
||||
|
||||
class CreateCustomFilterKeywords < ActiveRecord::Migration[6.1] |
||||
def change |
||||
create_table :custom_filter_keywords do |t| |
||||
t.belongs_to :custom_filter, foreign_key: { on_delete: :cascade }, null: false |
||||
t.text :keyword, null: false, default: '' |
||||
t.boolean :whole_word, null: false, default: true |
||||
|
||||
t.timestamps |
||||
end |
||||
end |
||||
end |
@ -0,0 +1,34 @@ |
||||
# frozen_string_literal: true |
||||
|
||||
class MigrateCustomFilters < ActiveRecord::Migration[6.1] |
||||
def up |
||||
# Preserve IDs as much as possible to not confuse existing clients. |
||||
# As long as this migration is irreversible, we do not have to deal with conflicts. |
||||
safety_assured do |
||||
execute <<-SQL.squish |
||||
INSERT INTO custom_filter_keywords (id, custom_filter_id, keyword, whole_word, created_at, updated_at) |
||||
SELECT id, id, phrase, whole_word, created_at, updated_at |
||||
FROM custom_filters |
||||
SQL |
||||
end |
||||
end |
||||
|
||||
def down |
||||
# Copy back changes from custom filters guaranteed to be from the old API |
||||
safety_assured do |
||||
execute <<-SQL.squish |
||||
UPDATE custom_filters |
||||
SET phrase = custom_filter_keywords.keyword, whole_word = custom_filter_keywords.whole_word |
||||
FROM custom_filter_keywords |
||||
WHERE custom_filters.id = custom_filter_keywords.id AND custom_filters.id = custom_filter_keywords.custom_filter_id |
||||
SQL |
||||
end |
||||
|
||||
# Drop every keyword as we can't safely provide a 1:1 mapping |
||||
safety_assured do |
||||
execute <<-SQL.squish |
||||
TRUNCATE custom_filter_keywords RESTART IDENTITY |
||||
SQL |
||||
end |
||||
end |
||||
end |
@ -0,0 +1,20 @@ |
||||
# frozen_string_literal: true |
||||
require Rails.root.join('lib', 'mastodon', 'migration_helpers') |
||||
|
||||
class AddActionToCustomFilters < ActiveRecord::Migration[6.1] |
||||
include Mastodon::MigrationHelpers |
||||
|
||||
disable_ddl_transaction! |
||||
|
||||
def up |
||||
safety_assured do |
||||
add_column_with_default :custom_filters, :action, :integer, allow_null: false, default: 0 |
||||
execute 'UPDATE custom_filters SET action = 1 WHERE irreversible IS TRUE' |
||||
end |
||||
end |
||||
|
||||
def down |
||||
execute 'UPDATE custom_filters SET irreversible = (action = 1)' |
||||
remove_column :custom_filters, :action |
||||
end |
||||
end |
@ -0,0 +1,20 @@ |
||||
# frozen_string_literal: true |
||||
require Rails.root.join('lib', 'mastodon', 'migration_helpers') |
||||
|
||||
class RemoveWholeWordFromCustomFilters < ActiveRecord::Migration[6.1] |
||||
include Mastodon::MigrationHelpers |
||||
|
||||
disable_ddl_transaction! |
||||
|
||||
def up |
||||
safety_assured do |
||||
remove_column :custom_filters, :whole_word |
||||
end |
||||
end |
||||
|
||||
def down |
||||
safety_assured do |
||||
add_column_with_default :custom_filters, :whole_word, :boolean, default: true, allow_null: false |
||||
end |
||||
end |
||||
end |
@ -0,0 +1,20 @@ |
||||
# frozen_string_literal: true |
||||
require Rails.root.join('lib', 'mastodon', 'migration_helpers') |
||||
|
||||
class RemoveIrreversibleFromCustomFilters < ActiveRecord::Migration[6.1] |
||||
include Mastodon::MigrationHelpers |
||||
|
||||
disable_ddl_transaction! |
||||
|
||||
def up |
||||
safety_assured do |
||||
remove_column :custom_filters, :irreversible |
||||
end |
||||
end |
||||
|
||||
def down |
||||
safety_assured do |
||||
add_column_with_default :custom_filters, :irreversible, :boolean, allow_null: false, default: false |
||||
end |
||||
end |
||||
end |
@ -0,0 +1,142 @@ |
||||
require 'rails_helper' |
||||
|
||||
RSpec.describe Api::V1::Filters::KeywordsController, type: :controller do |
||||
render_views |
||||
|
||||
let(:user) { Fabricate(:user) } |
||||
let(:token) { Fabricate(:accessible_access_token, resource_owner_id: user.id, scopes: scopes) } |
||||
let(:filter) { Fabricate(:custom_filter, account: user.account) } |
||||
let(:other_user) { Fabricate(:user) } |
||||
let(:other_filter) { Fabricate(:custom_filter, account: other_user.account) } |
||||
|
||||
before do |
||||
allow(controller).to receive(:doorkeeper_token) { token } |
||||
end |
||||
|
||||
describe 'GET #index' do |
||||
let(:scopes) { 'read:filters' } |
||||
let!(:keyword) { Fabricate(:custom_filter_keyword, custom_filter: filter) } |
||||
|
||||
it 'returns http success' do |
||||
get :index, params: { filter_id: filter.id } |
||||
expect(response).to have_http_status(200) |
||||
end |
||||
|
||||
context "when trying to access another's user filters" do |
||||
it 'returns http not found' do |
||||
get :index, params: { filter_id: other_filter.id } |
||||
expect(response).to have_http_status(404) |
||||
end |
||||
end |
||||
end |
||||
|
||||
describe 'POST #create' do |
||||
let(:scopes) { 'write:filters' } |
||||
let(:filter_id) { filter.id } |
||||
|
||||
before do |
||||
post :create, params: { filter_id: filter_id, keyword: 'magic', whole_word: false } |
||||
end |
||||
|
||||
it 'returns http success' do |
||||
expect(response).to have_http_status(200) |
||||
end |
||||
|
||||
it 'returns a keyword' do |
||||
json = body_as_json |
||||
expect(json[:keyword]).to eq 'magic' |
||||
expect(json[:whole_word]).to eq false |
||||
end |
||||
|
||||
it 'creates a keyword' do |
||||
filter = user.account.custom_filters.first |
||||
expect(filter).to_not be_nil |
||||
expect(filter.keywords.pluck(:keyword)).to eq ['magic'] |
||||
end |
||||
|
||||
context "when trying to add to another another's user filters" do |
||||
let(:filter_id) { other_filter.id } |
||||
|
||||
it 'returns http not found' do |
||||
expect(response).to have_http_status(404) |
||||
end |
||||
end |
||||
end |
||||
|
||||
describe 'GET #show' do |
||||
let(:scopes) { 'read:filters' } |
||||
let(:keyword) { Fabricate(:custom_filter_keyword, keyword: 'foo', whole_word: false, custom_filter: filter) } |
||||
|
||||
before do |
||||
get :show, params: { id: keyword.id } |
||||
end |
||||
|
||||
it 'returns http success' do |
||||
expect(response).to have_http_status(200) |
||||
end |
||||
|
||||
it 'returns expected data' do |
||||
json = body_as_json |
||||
expect(json[:keyword]).to eq 'foo' |
||||
expect(json[:whole_word]).to eq false |
||||
end |
||||
|
||||
context "when trying to access another user's filter keyword" do |
||||
let(:keyword) { Fabricate(:custom_filter_keyword, custom_filter: other_filter) } |
||||
|
||||
it 'returns http not found' do |
||||
expect(response).to have_http_status(404) |
||||
end |
||||
end |
||||
end |
||||
|
||||
describe 'PUT #update' do |
||||
let(:scopes) { 'write:filters' } |
||||
let(:keyword) { Fabricate(:custom_filter_keyword, custom_filter: filter) } |
||||
|
||||
before do |
||||
get :update, params: { id: keyword.id, keyword: 'updated' } |
||||
end |
||||
|
||||
it 'returns http success' do |
||||
expect(response).to have_http_status(200) |
||||
end |
||||
|
||||
it 'updates the keyword' do |
||||
expect(keyword.reload.keyword).to eq 'updated' |
||||
end |
||||
|
||||
context "when trying to update another user's filter keyword" do |
||||
let(:keyword) { Fabricate(:custom_filter_keyword, custom_filter: other_filter) } |
||||
|
||||
it 'returns http not found' do |
||||
expect(response).to have_http_status(404) |
||||
end |
||||
end |
||||
end |
||||
|
||||
describe 'DELETE #destroy' do |
||||
let(:scopes) { 'write:filters' } |
||||
let(:keyword) { Fabricate(:custom_filter_keyword, custom_filter: filter) } |
||||
|
||||
before do |
||||
delete :destroy, params: { id: keyword.id } |
||||
end |
||||
|
||||
it 'returns http success' do |
||||
expect(response).to have_http_status(200) |
||||
end |
||||
|
||||
it 'removes the filter' do |
||||
expect { keyword.reload }.to raise_error ActiveRecord::RecordNotFound |
||||
end |
||||
|
||||
context "when trying to update another user's filter keyword" do |
||||
let(:keyword) { Fabricate(:custom_filter_keyword, custom_filter: other_filter) } |
||||
|
||||
it 'returns http not found' do |
||||
expect(response).to have_http_status(404) |
||||
end |
||||
end |
||||
end |
||||
end |
@ -0,0 +1,121 @@ |
||||
require 'rails_helper' |
||||
|
||||
RSpec.describe Api::V2::FiltersController, type: :controller do |
||||
render_views |
||||
|
||||
let(:user) { Fabricate(:user) } |
||||
let(:token) { Fabricate(:accessible_access_token, resource_owner_id: user.id, scopes: scopes) } |
||||
|
||||
before do |
||||
allow(controller).to receive(:doorkeeper_token) { token } |
||||
end |
||||
|
||||
describe 'GET #index' do |
||||
let(:scopes) { 'read:filters' } |
||||
let!(:filter) { Fabricate(:custom_filter, account: user.account) } |
||||
|
||||
it 'returns http success' do |
||||
get :index |
||||
expect(response).to have_http_status(200) |
||||
end |
||||
end |
||||
|
||||
describe 'POST #create' do |
||||
let(:scopes) { 'write:filters' } |
||||
|
||||
before do |
||||
post :create, params: { title: 'magic', context: %w(home), filter_action: 'hide', keywords_attributes: [keyword: 'magic'] } |
||||
end |
||||
|
||||
it 'returns http success' do |
||||
expect(response).to have_http_status(200) |
||||
end |
||||
|
||||
it 'returns a filter with keywords' do |
||||
json = body_as_json |
||||
expect(json[:title]).to eq 'magic' |
||||
expect(json[:filter_action]).to eq 'hide' |
||||
expect(json[:context]).to eq ['home'] |
||||
expect(json[:keywords].map { |keyword| keyword.slice(:keyword, :whole_word) }).to eq [{ keyword: 'magic', whole_word: true }] |
||||
end |
||||
|
||||
it 'creates a filter' do |
||||
filter = user.account.custom_filters.first |
||||
expect(filter).to_not be_nil |
||||
expect(filter.keywords.pluck(:keyword)).to eq ['magic'] |
||||
expect(filter.context).to eq %w(home) |
||||
expect(filter.irreversible?).to be true |
||||
expect(filter.expires_at).to be_nil |
||||
end |
||||
end |
||||
|
||||
describe 'GET #show' do |
||||
let(:scopes) { 'read:filters' } |
||||
let(:filter) { Fabricate(:custom_filter, account: user.account) } |
||||
|
||||
it 'returns http success' do |
||||
get :show, params: { id: filter.id } |
||||
expect(response).to have_http_status(200) |
||||
end |
||||
end |
||||
|
||||
describe 'PUT #update' do |
||||
let(:scopes) { 'write:filters' } |
||||
let!(:filter) { Fabricate(:custom_filter, account: user.account) } |
||||
let!(:keyword) { Fabricate(:custom_filter_keyword, custom_filter: filter) } |
||||
|
||||
context 'updating filter parameters' do |
||||
before do |
||||
put :update, params: { id: filter.id, title: 'updated', context: %w(home public) } |
||||
end |
||||
|
||||
it 'returns http success' do |
||||
expect(response).to have_http_status(200) |
||||
end |
||||
|
||||
it 'updates the filter title' do |
||||
expect(filter.reload.title).to eq 'updated' |
||||
end |
||||
|
||||
it 'updates the filter context' do |
||||
expect(filter.reload.context).to eq %w(home public) |
||||
end |
||||
end |
||||
|
||||
context 'updating keywords in bulk' do |
||||
before do |
||||
allow(redis).to receive_messages(publish: nil) |
||||
put :update, params: { id: filter.id, keywords_attributes: [{ id: keyword.id, keyword: 'updated' }] } |
||||
end |
||||
|
||||
it 'returns http success' do |
||||
expect(response).to have_http_status(200) |
||||
end |
||||
|
||||
it 'updates the keyword' do |
||||
expect(keyword.reload.keyword).to eq 'updated' |
||||
end |
||||
|
||||
it 'sends exactly one filters_changed event' do |
||||
expect(redis).to have_received(:publish).with("timeline:#{user.account.id}", Oj.dump(event: :filters_changed)).once |
||||
end |
||||
end |
||||
end |
||||
|
||||
describe 'DELETE #destroy' do |
||||
let(:scopes) { 'write:filters' } |
||||
let(:filter) { Fabricate(:custom_filter, account: user.account) } |
||||
|
||||
before do |
||||
delete :destroy, params: { id: filter.id } |
||||
end |
||||
|
||||
it 'returns http success' do |
||||
expect(response).to have_http_status(200) |
||||
end |
||||
|
||||
it 'removes the filter' do |
||||
expect { filter.reload }.to raise_error ActiveRecord::RecordNotFound |
||||
end |
||||
end |
||||
end |
@ -0,0 +1,4 @@ |
||||
Fabricator(:custom_filter_keyword) do |
||||
custom_filter |
||||
keyword 'discourse' |
||||
end |
@ -0,0 +1,4 @@ |
||||
require 'rails_helper' |
||||
|
||||
RSpec.describe CustomFilterKeyword, type: :model do |
||||
end |
Loading…
Reference in new issue