Add account_id param to GET /api/v1/notifications (#10796)

* Add `from_account` to notifications API

this adds the ability to filter notifications by the account they
originated from

* passing a non-existent user should cause none to be returned

* Fix codeclimate warnings

* fix more codeclimate warnings

* make requested changes:

* use account id instead of user@domain
* name the param `account_id` instead of `from_account`

* Don't use `return` in a lambda
This commit is contained in:
Paul Woolcock 2019-05-21 07:28:49 -04:00 committed by Eugen Rochko
parent 4d65740663
commit 0c933c1b8c
3 changed files with 77 additions and 3 deletions

View file

@ -44,7 +44,7 @@ class Api::V1::NotificationsController < Api::BaseController
end end
def browserable_account_notifications def browserable_account_notifications
current_account.notifications.browserable(exclude_types) current_account.notifications.browserable(exclude_types, from_account)
end end
def target_statuses_from_notifications def target_statuses_from_notifications
@ -81,6 +81,10 @@ class Api::V1::NotificationsController < Api::BaseController
val val
end end
def from_account
params[:account_id]
end
def pagination_params(core_params) def pagination_params(core_params)
params.slice(:limit, :exclude_types).permit(:limit, exclude_types: []).merge(core_params) params.slice(:limit, :exclude_types).permit(:limit, exclude_types: []).merge(core_params)
end end

View file

@ -41,9 +41,13 @@ class Notification < ApplicationRecord
validates :account_id, uniqueness: { scope: [:activity_type, :activity_id] } validates :account_id, uniqueness: { scope: [:activity_type, :activity_id] }
validates :activity_type, inclusion: { in: TYPE_CLASS_MAP.values } validates :activity_type, inclusion: { in: TYPE_CLASS_MAP.values }
scope :browserable, ->(exclude_types = []) { scope :browserable, ->(exclude_types = [], account_id = nil) {
types = TYPE_CLASS_MAP.values - activity_types_from_types(exclude_types + [:follow_request]) types = TYPE_CLASS_MAP.values - activity_types_from_types(exclude_types + [:follow_request])
if account_id.nil?
where(activity_type: types) where(activity_type: types)
else
where(activity_type: types, from_account_id: account_id)
end
} }
cache_associated :from_account, status: STATUS_INCLUDES, mention: [status: STATUS_INCLUDES], favourite: [:account, status: STATUS_INCLUDES], follow: :account, poll: [status: STATUS_INCLUDES] cache_associated :from_account, status: STATUS_INCLUDES, mention: [status: STATUS_INCLUDES], favourite: [:account, status: STATUS_INCLUDES], follow: :account, poll: [status: STATUS_INCLUDES]

View file

@ -6,6 +6,7 @@ RSpec.describe Api::V1::NotificationsController, type: :controller do
let(:user) { Fabricate(:user, account: Fabricate(:account, username: 'alice')) } let(:user) { Fabricate(:user, account: Fabricate(:account, username: 'alice')) }
let(:token) { Fabricate(:accessible_access_token, resource_owner_id: user.id, scopes: scopes) } let(:token) { Fabricate(:accessible_access_token, resource_owner_id: user.id, scopes: scopes) }
let(:other) { Fabricate(:user, account: Fabricate(:account, username: 'bob')) } let(:other) { Fabricate(:user, account: Fabricate(:account, username: 'bob')) }
let(:third) { Fabricate(:user, account: Fabricate(:account, username: 'carol')) }
before do before do
allow(controller).to receive(:doorkeeper_token) { token } allow(controller).to receive(:doorkeeper_token) { token }
@ -55,6 +56,7 @@ RSpec.describe Api::V1::NotificationsController, type: :controller do
mentioning_status = PostStatusService.new.call(other.account, text: 'Hello @alice') mentioning_status = PostStatusService.new.call(other.account, text: 'Hello @alice')
@mention_from_status = mentioning_status.mentions.first @mention_from_status = mentioning_status.mentions.first
@favourite = FavouriteService.new.call(other.account, first_status) @favourite = FavouriteService.new.call(other.account, first_status)
@second_favourite = FavouriteService.new.call(third.account, first_status)
@follow = FollowService.new.call(other.account, 'alice') @follow = FollowService.new.call(other.account, 'alice')
end end
@ -84,6 +86,66 @@ RSpec.describe Api::V1::NotificationsController, type: :controller do
end end
end end
describe 'from specified user' do
before do
get :index, params: { account_id: third.account.id }
end
it 'returns http success' do
expect(response).to have_http_status(200)
end
it 'includes favourite' do
expect(assigns(:notifications).map(&:activity)).to include(@second_favourite)
end
it 'excludes favourite' do
expect(assigns(:notifications).map(&:activity)).to_not include(@favourite)
end
it 'excludes mention' do
expect(assigns(:notifications).map(&:activity)).to_not include(@mention_from_status)
end
it 'excludes reblog' do
expect(assigns(:notifications).map(&:activity)).to_not include(@reblog_of_first_status)
end
it 'excludes follow' do
expect(assigns(:notifications).map(&:activity)).to_not include(@follow)
end
end
describe 'from nonexistent user' do
before do
get :index, params: { account_id: 'foo' }
end
it 'returns http success' do
expect(response).to have_http_status(200)
end
it 'excludes favourite' do
expect(assigns(:notifications).map(&:activity)).to_not include(@favourite)
end
it 'excludes second favourite' do
expect(assigns(:notifications).map(&:activity)).to_not include(@second_favourite)
end
it 'excludes mention' do
expect(assigns(:notifications).map(&:activity)).to_not include(@mention_from_status)
end
it 'excludes reblog' do
expect(assigns(:notifications).map(&:activity)).to_not include(@reblog_of_first_status)
end
it 'excludes follow' do
expect(assigns(:notifications).map(&:activity)).to_not include(@follow)
end
end
describe 'with excluded mentions' do describe 'with excluded mentions' do
before do before do
get :index, params: { exclude_types: ['mention'] } get :index, params: { exclude_types: ['mention'] }
@ -105,6 +167,10 @@ RSpec.describe Api::V1::NotificationsController, type: :controller do
expect(assigns(:notifications).map(&:activity)).to include(@favourite) expect(assigns(:notifications).map(&:activity)).to include(@favourite)
end end
it 'includes third favourite' do
expect(assigns(:notifications).map(&:activity)).to include(@second_favourite)
end
it 'includes follow' do it 'includes follow' do
expect(assigns(:notifications).map(&:activity)).to include(@follow) expect(assigns(:notifications).map(&:activity)).to include(@follow)
end end