Lists (#5703)

* Add structure for lists

* Add list timeline streaming API

* Add list APIs, bind list-account relation to follow relation

* Add API for adding/removing accounts from lists

* Add pagination to lists API

* Add pagination to list accounts API

* Adjust scopes for new APIs

- Creating and modifying lists merely requires "write" scope
- Fetching information about lists merely requires "read" scope

* Add test for wrong user context on list timeline

* Clean up tests

spec/controllers/api/v1/lists/accounts_controller_spec.rb

@@ -0,0 +1,54 @@
+require 'rails_helper'
+
+describe Api::V1::Lists::AccountsController do
+  render_views
+
+  let(:user)  { Fabricate(:user, account: Fabricate(:account, username: 'alice')) }
+  let(:token) { Fabricate(:accessible_access_token, resource_owner_id: user.id, scopes: 'read write') }
+  let(:list)  { Fabricate(:list, account: user.account) }
+
+  before do
+    follow = Fabricate(:follow, account: user.account)
+    list.accounts << follow.target_account
+    allow(controller).to receive(:doorkeeper_token) { token }
+  end
+
+  describe 'GET #index' do
+    it 'returns http success' do
+      get :show, params: { list_id: list.id }
+
+      expect(response).to have_http_status(:success)
+    end
+  end
+
+  describe 'POST #create' do
+    let(:bob) { Fabricate(:account, username: 'bob') }
+
+    before do
+      user.account.follow!(bob)
+      post :create, params: { list_id: list.id, account_ids: [bob.id] }
+    end
+
+    it 'returns http success' do
+      expect(response).to have_http_status(:success)
+    end
+
+    it 'adds account to the list' do
+      expect(list.accounts.include?(bob)).to be true
+    end
+  end
+
+  describe 'DELETE #destroy' do
+    before do
+      delete :destroy, params: { list_id: list.id, account_ids: [list.accounts.first.id] }
+    end
+
+    it 'returns http success' do
+      expect(response).to have_http_status(:success)
+    end
+
+    it 'removes account from the list' do
+      expect(list.accounts.count).to eq 0
+    end
+  end
+end

spec/controllers/api/v1/lists_controller_spec.rb

@@ -0,0 +1,68 @@
+require 'rails_helper'
+
+RSpec.describe Api::V1::ListsController, type: :controller do
+  render_views
+
+  let!(:user)  { Fabricate(:user, account: Fabricate(:account, username: 'alice')) }
+  let!(:token) { Fabricate(:accessible_access_token, resource_owner_id: user.id, scopes: 'read write') }
+  let!(:list)  { Fabricate(:list, account: user.account) }
+
+  before { allow(controller).to receive(:doorkeeper_token) { token } }
+
+  describe 'GET #index' do
+    it 'returns http success' do
+      get :index
+      expect(response).to have_http_status(:success)
+    end
+  end
+
+  describe 'GET #show' do
+    it 'returns http success' do
+      get :show, params: { id: list.id }
+      expect(response).to have_http_status(:success)
+    end
+  end
+
+  describe 'POST #create' do
+    before do
+      post :create, params: { title: 'Foo bar' }
+    end
+
+    it 'returns http success' do
+      expect(response).to have_http_status(:success)
+    end
+
+    it 'creates list' do
+      expect(List.where(account: user.account).count).to eq 2
+      expect(List.last.title).to eq 'Foo bar'
+    end
+  end
+
+  describe 'PUT #update' do
+    before do
+      put :update, params: { id: list.id, title: 'Updated title' }
+    end
+
+    it 'returns http success' do
+      expect(response).to have_http_status(:success)
+    end
+
+    it 'updates the list' do
+      expect(list.reload.title).to eq 'Updated title'
+    end
+  end
+
+  describe 'DELETE #destroy' do
+    before do
+      delete :destroy, params: { id: list.id }
+    end
+
+    it 'returns http success' do
+      expect(response).to have_http_status(:success)
+    end
+
+    it 'deletes the list' do
+      expect(List.find_by(id: list.id)).to be_nil
+    end
+  end
+end

spec/controllers/api/v1/timelines/list_controller_spec.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe Api::V1::Timelines::ListController do
+  render_views
+
+  let(:user) { Fabricate(:user, account: Fabricate(:account, username: 'alice')) }
+  let(:list) { Fabricate(:list, account: user.account) }
+
+  before do
+    allow(controller).to receive(:doorkeeper_token) { token }
+  end
+
+  context 'with a user context' do
+    let(:token) { Fabricate(:accessible_access_token, resource_owner_id: user.id, scopes: 'read') }
+
+    describe 'GET #show' do
+      before do
+        follow = Fabricate(:follow, account: user.account)
+        list.accounts << follow.target_account
+        PostStatusService.new.call(follow.target_account, 'New status for user home timeline.')
+      end
+
+      it 'returns http success' do
+        get :show, params: { id: list.id }
+        expect(response).to have_http_status(:success)
+      end
+    end
+  end
+
+  context 'with the wrong user context' do
+    let(:other_user) { Fabricate(:user, account: Fabricate(:account, username: 'bob')) }
+    let(:token)      { Fabricate(:accessible_access_token, resource_owner_id: other_user.id, scopes: 'read') }
+
+    describe 'GET #show' do
+      it 'returns http not found' do
+        get :show, params: { id: list.id }
+        expect(response).to have_http_status(:not_found)
+      end
+    end
+  end
+
+  context 'without a user context' do
+    let(:token) { Fabricate(:accessible_access_token, resource_owner_id: nil, scopes: 'read') }
+
+    describe 'GET #show' do
+      it 'returns http unprocessable entity' do
+        get :show, params: { id: list.id }
+
+        expect(response).to have_http_status(:unprocessable_entity)
+        expect(response.headers['Link']).to be_nil
+      end
+    end
+  end
+end

spec/controllers/api/v1/timelines/tag_controller_spec.rb

@@ -5,7 +5,7 @@ require 'rails_helper'
 describe Api::V1::Timelines::TagController do
   render_views
 
-  let(:user)  { Fabricate(:user, account: Fabricate(:account, username: 'alice')) }
+  let(:user) { Fabricate(:user, account: Fabricate(:account, username: 'alice')) }
 
   before do
     allow(controller).to receive(:doorkeeper_token) { token }

spec/fabricators/list_account_fabricator.rb

@@ -0,0 +1,5 @@
+Fabricator(:list_account) do
+  list    nil
+  account nil
+  follow  nil
+end

spec/fabricators/list_fabricator.rb

@@ -0,0 +1,4 @@
+Fabricator(:list) do
+  account nil
+  title   "MyString"
+end

spec/lib/feed_manager_spec.rb

@@ -148,21 +148,11 @@ RSpec.describe FeedManager do
       account = Fabricate(:account)
       status = Fabricate(:status)
       members = FeedManager::MAX_ITEMS.times.map { |count| [count, count] }
-      Redis.current.zadd("feed:type:#{account.id}", members)
+      Redis.current.zadd("feed:home:#{account.id}", members)
 
-      FeedManager.instance.push('type', account, status)
+      FeedManager.instance.push_to_home(account, status)
 
-      expect(Redis.current.zcard("feed:type:#{account.id}")).to eq FeedManager::MAX_ITEMS
-    end
-
-    it 'sends push updates for non-home timelines' do
-      account = Fabricate(:account)
-      status = Fabricate(:status)
-      allow(Redis.current).to receive_messages(publish: nil)
-
-      FeedManager.instance.push('type', account, status)
-
-      expect(Redis.current).to have_received(:publish).with("timeline:#{account.id}", any_args).at_least(:once)
+      expect(Redis.current.zcard("feed:home:#{account.id}")).to eq FeedManager::MAX_ITEMS
     end
 
     context 'reblogs' do
@@ -171,7 +161,7 @@ RSpec.describe FeedManager do
         reblogged = Fabricate(:status)
         reblog = Fabricate(:status, reblog: reblogged)
 
-        expect(FeedManager.instance.push('type', account, reblog)).to be true
+        expect(FeedManager.instance.push_to_home(account, reblog)).to be true
       end
 
       it 'does not save a new reblog of a recent status' do
@@ -179,9 +169,9 @@ RSpec.describe FeedManager do
         reblogged = Fabricate(:status)
         reblog = Fabricate(:status, reblog: reblogged)
 
-        FeedManager.instance.push('type', account, reblogged)
+        FeedManager.instance.push_to_home(account, reblogged)
 
-        expect(FeedManager.instance.push('type', account, reblog)).to be false
+        expect(FeedManager.instance.push_to_home(account, reblog)).to be false
       end
 
       it 'saves a new reblog of an old status' do
@@ -189,14 +179,14 @@ RSpec.describe FeedManager do
         reblogged = Fabricate(:status)
         reblog = Fabricate(:status, reblog: reblogged)
 
-        FeedManager.instance.push('type', account, reblogged)
+        FeedManager.instance.push_to_home(account, reblogged)
 
         # Fill the feed with intervening statuses
         FeedManager::REBLOG_FALLOFF.times do
-          FeedManager.instance.push('type', account, Fabricate(:status))
+          FeedManager.instance.push_to_home(account, Fabricate(:status))
         end
 
-        expect(FeedManager.instance.push('type', account, reblog)).to be true
+        expect(FeedManager.instance.push_to_home(account, reblog)).to be true
       end
 
       it 'does not save a new reblog of a recently-reblogged status' do
@@ -205,10 +195,10 @@ RSpec.describe FeedManager do
         reblogs = 2.times.map { Fabricate(:status, reblog: reblogged) }
 
         # The first reblog will be accepted
-        FeedManager.instance.push('type', account, reblogs.first)
+        FeedManager.instance.push_to_home(account, reblogs.first)
 
         # The second reblog should be ignored
-        expect(FeedManager.instance.push('type', account, reblogs.last)).to be false
+        expect(FeedManager.instance.push_to_home(account, reblogs.last)).to be false
       end
 
       it 'does not save a new reblog of a multiply-reblogged-then-unreblogged status' do
@@ -217,14 +207,14 @@ RSpec.describe FeedManager do
         reblogs = 3.times.map { Fabricate(:status, reblog: reblogged) }
 
         # Accept the reblogs
-        FeedManager.instance.push('type', account, reblogs[0])
-        FeedManager.instance.push('type', account, reblogs[1])
+        FeedManager.instance.push_to_home(account, reblogs[0])
+        FeedManager.instance.push_to_home(account, reblogs[1])
 
         # Unreblog the first one
-        FeedManager.instance.unpush('type', account, reblogs[0])
+        FeedManager.instance.unpush_from_home(account, reblogs[0])
 
         # The last reblog should still be ignored
-        expect(FeedManager.instance.push('type', account, reblogs.last)).to be false
+        expect(FeedManager.instance.push_to_home(account, reblogs.last)).to be false
       end
 
       it 'saves a new reblog of a long-ago-reblogged status' do
@@ -233,15 +223,15 @@ RSpec.describe FeedManager do
         reblogs = 2.times.map { Fabricate(:status, reblog: reblogged) }
 
         # The first reblog will be accepted
-        FeedManager.instance.push('type', account, reblogs.first)
+        FeedManager.instance.push_to_home(account, reblogs.first)
 
         # Fill the feed with intervening statuses
         FeedManager::REBLOG_FALLOFF.times do
-          FeedManager.instance.push('type', account, Fabricate(:status))
+          FeedManager.instance.push_to_home(account, Fabricate(:status))
         end
 
         # The second reblog should also be accepted
-        expect(FeedManager.instance.push('type', account, reblogs.last)).to be true
+        expect(FeedManager.instance.push_to_home(account, reblogs.last)).to be true
       end
     end
   end
@@ -253,11 +243,11 @@ RSpec.describe FeedManager do
       reblogged      = Fabricate(:status)
       status         = Fabricate(:status, reblog: reblogged)
       another_status = Fabricate(:status, reblog: reblogged)
-      reblogs_key    = FeedManager.instance.key('type', receiver.id, 'reblogs')
-      reblog_set_key = FeedManager.instance.key('type', receiver.id, "reblogs:#{reblogged.id}")
+      reblogs_key    = FeedManager.instance.key('home', receiver.id, 'reblogs')
+      reblog_set_key = FeedManager.instance.key('home', receiver.id, "reblogs:#{reblogged.id}")
 
-      FeedManager.instance.push('type', receiver, status)
-      FeedManager.instance.push('type', receiver, another_status)
+      FeedManager.instance.push_to_home(receiver, status)
+      FeedManager.instance.push_to_home(receiver, another_status)
 
       # We should have a tracking set and an entry in reblogs.
       expect(Redis.current.exists(reblog_set_key)).to be true
@@ -265,12 +255,12 @@ RSpec.describe FeedManager do
 
       # Push everything off the end of the feed.
       FeedManager::MAX_ITEMS.times do
-        FeedManager.instance.push('type', receiver, Fabricate(:status))
+        FeedManager.instance.push_to_home(receiver, Fabricate(:status))
       end
 
       # `trim` should be called automatically, but do it anyway, as
       # we're testing `trim`, not side effects of `push`.
-      FeedManager.instance.trim('type', receiver.id)
+      FeedManager.instance.trim('home', receiver.id)
 
       # We should not have any reblog tracking data.
       expect(Redis.current.exists(reblog_set_key)).to be false
@@ -285,32 +275,32 @@ RSpec.describe FeedManager do
       reblogged = Fabricate(:status)
       status    = Fabricate(:status, reblog: reblogged)
 
-      FeedManager.instance.push('type', receiver, reblogged)
-      FeedManager::REBLOG_FALLOFF.times { FeedManager.instance.push('type', receiver, Fabricate(:status)) }
-      FeedManager.instance.push('type', receiver, status)
+      FeedManager.instance.push_to_home(receiver, reblogged)
+      FeedManager::REBLOG_FALLOFF.times { FeedManager.instance.push_to_home(receiver, Fabricate(:status)) }
+      FeedManager.instance.push_to_home(receiver, status)
 
       # The reblogging status should show up under normal conditions.
-      expect(Redis.current.zrange("feed:type:#{receiver.id}", 0, -1)).to include(status.id.to_s)
+      expect(Redis.current.zrange("feed:home:#{receiver.id}", 0, -1)).to include(status.id.to_s)
 
-      FeedManager.instance.unpush('type', receiver, status)
+      FeedManager.instance.unpush_from_home(receiver, status)
 
       # Restore original status
-      expect(Redis.current.zrange("feed:type:#{receiver.id}", 0, -1)).to_not include(status.id.to_s)
-      expect(Redis.current.zrange("feed:type:#{receiver.id}", 0, -1)).to include(reblogged.id.to_s)
+      expect(Redis.current.zrange("feed:home:#{receiver.id}", 0, -1)).to_not include(status.id.to_s)
+      expect(Redis.current.zrange("feed:home:#{receiver.id}", 0, -1)).to include(reblogged.id.to_s)
     end
 
     it 'removes a reblogged status if it was only reblogged once' do
       reblogged = Fabricate(:status)
       status    = Fabricate(:status, reblog: reblogged)
 
-      FeedManager.instance.push('type', receiver, status)
+      FeedManager.instance.push_to_home(receiver, status)
 
       # The reblogging status should show up under normal conditions.
-      expect(Redis.current.zrange("feed:type:#{receiver.id}", 0, -1)).to eq [status.id.to_s]
+      expect(Redis.current.zrange("feed:home:#{receiver.id}", 0, -1)).to eq [status.id.to_s]
 
-      FeedManager.instance.unpush('type', receiver, status)
+      FeedManager.instance.unpush_from_home(receiver, status)
 
-      expect(Redis.current.zrange("feed:type:#{receiver.id}", 0, -1)).to be_empty
+      expect(Redis.current.zrange("feed:home:#{receiver.id}", 0, -1)).to be_empty
     end
 
     it 'leaves a multiply-reblogged status if another reblog was in feed' do
@@ -318,26 +308,26 @@ RSpec.describe FeedManager do
       reblogs   = 3.times.map { Fabricate(:status, reblog: reblogged) }
 
       reblogs.each do |reblog|
-        FeedManager.instance.push('type', receiver, reblog)
+        FeedManager.instance.push_to_home(receiver, reblog)
       end
 
       # The reblogging status should show up under normal conditions.
-      expect(Redis.current.zrange("feed:type:#{receiver.id}", 0, -1)).to eq [reblogs.first.id.to_s]
+      expect(Redis.current.zrange("feed:home:#{receiver.id}", 0, -1)).to eq [reblogs.first.id.to_s]
 
       reblogs[0...-1].each do |reblog|
-        FeedManager.instance.unpush('type', receiver, reblog)
+        FeedManager.instance.unpush_from_home(receiver, reblog)
       end
 
-      expect(Redis.current.zrange("feed:type:#{receiver.id}", 0, -1)).to eq [reblogs.last.id.to_s]
+      expect(Redis.current.zrange("feed:home:#{receiver.id}", 0, -1)).to eq [reblogs.last.id.to_s]
     end
 
     it 'sends push updates' do
       status  = Fabricate(:status)
 
-      FeedManager.instance.push('type', receiver, status)
+      FeedManager.instance.push_to_home(receiver, status)
 
       allow(Redis.current).to receive_messages(publish: nil)
-      FeedManager.instance.unpush('type', receiver, status)
+      FeedManager.instance.unpush_from_home(receiver, status)
 
       deletion = Oj.dump(event: :delete, payload: status.id.to_s)
       expect(Redis.current).to have_received(:publish).with("timeline:#{receiver.id}", deletion)

spec/models/account_moderation_note_spec.rb

@@ -1,5 +1,5 @@
 require 'rails_helper'
 
 RSpec.describe AccountModerationNote, type: :model do
-  pending "add some examples to (or delete) #{__FILE__}"
+
 end

spec/models/home_feed_spec.rb

@@ -1,9 +1,9 @@
 require 'rails_helper'
 
-RSpec.describe Feed, type: :model do
+RSpec.describe HomeFeed, type: :model do
   let(:account) { Fabricate(:account) }
 
-  subject { described_class.new(:home, account) }
+  subject { described_class.new(account) }
 
   describe '#get' do
     before do

spec/models/list_account_spec.rb

@@ -0,0 +1,5 @@
+require 'rails_helper'
+
+RSpec.describe ListAccount, type: :model do
+
+end

spec/models/list_spec.rb

@@ -0,0 +1,5 @@
+require 'rails_helper'
+
+RSpec.describe List, type: :model do
+
+end

spec/services/after_block_service_spec.rb

@@ -18,8 +18,8 @@ RSpec.describe AfterBlockService do
     end
 
     it "clears account's statuses" do
-      FeedManager.instance.push(:home, account, status)
-      FeedManager.instance.push(:home, account, other_account_status)
+      FeedManager.instance.push_to_home(account, status)
+      FeedManager.instance.push_to_home(account, other_account_status)
 
       is_expected.to change {
         Redis.current.zrange(home_timeline_key, 0, -1)

spec/services/batched_remove_status_service_spec.rb

@@ -30,11 +30,11 @@ RSpec.describe BatchedRemoveStatusService do
   end
 
   it 'removes statuses from author\'s home feed' do
-    expect(Feed.new(:home, alice).get(10)).to_not include([status1.id, status2.id])
+    expect(HomeFeed.new(alice).get(10)).to_not include([status1.id, status2.id])
   end
 
   it 'removes statuses from local follower\'s home feed' do
-    expect(Feed.new(:home, jeff).get(10)).to_not include([status1.id, status2.id])
+    expect(HomeFeed.new(jeff).get(10)).to_not include([status1.id, status2.id])
   end
 
   it 'notifies streaming API of followers' do

spec/services/fan_out_on_write_service_spec.rb

@@ -19,12 +19,12 @@ RSpec.describe FanOutOnWriteService do
   end
 
   it 'delivers status to home timeline' do
-    expect(Feed.new(:home, author).get(10).map(&:id)).to include status.id
+    expect(HomeFeed.new(author).get(10).map(&:id)).to include status.id
   end
 
   it 'delivers status to local followers' do
     pending 'some sort of problem in test environment causes this to sometimes fail'
-    expect(Feed.new(:home, follower).get(10).map(&:id)).to include status.id
+    expect(HomeFeed.new(follower).get(10).map(&:id)).to include status.id
   end
 
   it 'delivers status to hashtag' do

spec/services/mute_service_spec.rb

@@ -18,8 +18,8 @@ RSpec.describe MuteService do
     end
 
     it "clears account's statuses" do
-      FeedManager.instance.push(:home, account, status)
-      FeedManager.instance.push(:home, account, other_account_status)
+      FeedManager.instance.push_to_home(account, status)
+      FeedManager.instance.push_to_home(account, other_account_status)
 
       is_expected.to change {
         Redis.current.zrange(home_timeline_key, 0, -1)

spec/services/remove_status_service_spec.rb

@@ -25,11 +25,11 @@ RSpec.describe RemoveStatusService do
   end
 
   it 'removes status from author\'s home feed' do
-    expect(Feed.new(:home, alice).get(10)).to_not include(@status.id)
+    expect(HomeFeed.new(alice).get(10)).to_not include(@status.id)
   end
 
   it 'removes status from local follower\'s home feed' do
-    expect(Feed.new(:home, jeff).get(10)).to_not include(@status.id)
+    expect(HomeFeed.new(jeff).get(10)).to_not include(@status.id)
   end
 
   it 'sends PuSH update to PuSH subscribers' do

spec/workers/feed_insert_worker_spec.rb

@@ -11,41 +11,41 @@ describe FeedInsertWorker do
 
     context 'when there are no records' do
       it 'skips push with missing status' do
-        instance = double(push: nil)
+        instance = double(push_to_home: nil)
         allow(FeedManager).to receive(:instance).and_return(instance)
         result = subject.perform(nil, follower.id)
 
         expect(result).to eq true
-        expect(instance).not_to have_received(:push)
+        expect(instance).not_to have_received(:push_to_home)
       end
 
       it 'skips push with missing account' do
-        instance = double(push: nil)
+        instance = double(push_to_home: nil)
         allow(FeedManager).to receive(:instance).and_return(instance)
         result = subject.perform(status.id, nil)
 
         expect(result).to eq true
-        expect(instance).not_to have_received(:push)
+        expect(instance).not_to have_received(:push_to_home)
       end
     end
 
     context 'when there are real records' do
       it 'skips the push when there is a filter' do
-        instance = double(push: nil, filter?: true)
+        instance = double(push_to_home: nil, filter?: true)
         allow(FeedManager).to receive(:instance).and_return(instance)
         result = subject.perform(status.id, follower.id)
 
         expect(result).to be_nil
-        expect(instance).not_to have_received(:push)
+        expect(instance).not_to have_received(:push_to_home)
       end
 
       it 'pushes the status onto the home timeline without filter' do
-        instance = double(push: nil, filter?: false)
+        instance = double(push_to_home: nil, filter?: false)
         allow(FeedManager).to receive(:instance).and_return(instance)
         result = subject.perform(status.id, follower.id)
 
         expect(result).to be_nil
-        expect(instance).to have_received(:push).with(:home, follower, status)
+        expect(instance).to have_received(:push_to_home).with(follower, status)
       end
     end
   end