Add follower synchronization mechanism (#14510)
* Add support for followers synchronization on the receiving end Check the `collectionSynchronization` attribute on `Create` and `Announce` activities and synchronize followers from provided collection if possible. * Add tests for followers synchronization on the receiving end * Add support for follower synchronization on the sender's end * Add tests for the sending end * Switch from AS attributes to HTTP header Replace the custom `collectionSynchronization` ActivityStreams attribute by an HTTP header (`X-AS-Collection-Synchronization`) with the same syntax as the `Signature` header and the following fields: - `collectionId` to specify which collection to synchronize - `digest` for the SHA256 hex-digest of the list of followers known on the receiving instance (where “receiving instance” is determined by accounts sharing the same host name for their ActivityPub actor `id`) - `url` of a collection that should be fetched by the instance actor Internally, move away from the webfinger-based `domain` attribute and use account `uri` prefix to group accounts. * Add environment variable to disable followers synchronization Since the whole mechanism relies on some new preconditions that, in some extremely rare cases, might not be met, add an environment variable (DISABLE_FOLLOWERS_SYNCHRONIZATION) to disable the mechanism altogether and avoid followers being incorrectly removed. The current conditions are: 1. all managed accounts' actor `id` and inbox URL have the same URI scheme and netloc. 2. all accounts whose actor `id` or inbox URL share the same URI scheme and netloc as a managed account must be managed by the same Mastodon instance as well. As far as Mastodon is concerned, breaking those preconditions require extensive configuration changes in the reverse proxy and might also cause other issues. Therefore, this environment variable provides a way out for people with highly unusual configurations, and can be safely ignored for the overwhelming majority of Mastodon administrators. * Only set follower synchronization header on non-public statuses This is to avoid unnecessary computations and allow Follow-related activities to be handled by the usual codepath instead of going through the synchronization mechanism (otherwise, any Follow/Undo/Accept activity would trigger the synchronization mechanism even if processing the activity itself would be enough to re-introduce synchronization) * Change how ActivityPub::SynchronizeFollowersService handles follow requests If the remote lists a local follower which we only know has sent a follow request, consider the follow request as accepted instead of sending an Undo. * Integrate review feeback - rename X-AS-Collection-Synchronization to Collection-Synchronization - various minor refactoring and code style changes * Only select required fields when computing followers_hash * Use actor URI rather than webfinger domain in synchronization endpoint * Change hash computation to be a XOR of individual hashes Makes it much easier to be memory-efficient, and avoid sorting discrepancy issues. * Marginally improve followers_hash computation speed * Further improve hash computation performances by using pluck_eachmaster
ThibG
4 years ago
committed by
GitHub
parent
9649ca0fbe
commit
ca56527140
@ -0,0 +1,36 @@ |
||||
# frozen_string_literal: true |
||||
|
||||
class ActivityPub::FollowersSynchronizationsController < ActivityPub::BaseController |
||||
include SignatureVerification |
||||
include AccountOwnedConcern |
||||
|
||||
before_action :require_signature! |
||||
before_action :set_items |
||||
before_action :set_cache_headers |
||||
|
||||
def show |
||||
expires_in 0, public: false |
||||
render json: collection_presenter, |
||||
serializer: ActivityPub::CollectionSerializer, |
||||
adapter: ActivityPub::Adapter, |
||||
content_type: 'application/activity+json' |
||||
end |
||||
|
||||
private |
||||
|
||||
def uri_prefix |
||||
signed_request_account.uri[/http(s?):\/\/[^\/]+\//] |
||||
end |
||||
|
||||
def set_items |
||||
@items = @account.followers.where(Account.arel_table[:uri].matches(uri_prefix + '%', false, true)).pluck(:uri) |
||||
end |
||||
|
||||
def collection_presenter |
||||
ActivityPub::CollectionPresenter.new( |
||||
id: account_followers_synchronization_url(@account), |
||||
type: :ordered, |
||||
items: @items |
||||
) |
||||
end |
||||
end |
||||
@ -0,0 +1,13 @@ |
||||
# frozen_string_literal: true |
||||
|
||||
class ActivityPub::PrepareFollowersSynchronizationService < BaseService |
||||
include JsonLdHelper |
||||
|
||||
def call(account, params) |
||||
@account = account |
||||
|
||||
return if params['collectionId'] != @account.followers_url || invalid_origin?(params['url']) || @account.local_followers_hash == params['digest'] |
||||
|
||||
ActivityPub::FollowersSynchronizationWorker.perform_async(@account.id, params['url']) |
||||
end |
||||
end |
||||
@ -0,0 +1,74 @@ |
||||
# frozen_string_literal: true |
||||
|
||||
class ActivityPub::SynchronizeFollowersService < BaseService |
||||
include JsonLdHelper |
||||
include Payloadable |
||||
|
||||
def call(account, partial_collection_url) |
||||
@account = account |
||||
|
||||
items = collection_items(partial_collection_url) |
||||
return if items.nil? |
||||
|
||||
# There could be unresolved accounts (hence the call to .compact) but this |
||||
# should never happen in practice, since in almost all cases we keep an |
||||
# Account record, and should we not do that, we should have sent a Delete. |
||||
# In any case there is not much we can do if that occurs. |
||||
@expected_followers = items.map { |uri| ActivityPub::TagManager.instance.uri_to_resource(uri, Account) }.compact |
||||
|
||||
remove_unexpected_local_followers! |
||||
handle_unexpected_outgoing_follows! |
||||
end |
||||
|
||||
private |
||||
|
||||
def remove_unexpected_local_followers! |
||||
@account.followers.local.where.not(id: @expected_followers.map(&:id)).each do |unexpected_follower| |
||||
UnfollowService.new.call(unexpected_follower, @account) |
||||
end |
||||
end |
||||
|
||||
def handle_unexpected_outgoing_follows! |
||||
@expected_followers.each do |expected_follower| |
||||
next if expected_follower.following?(@account) |
||||
|
||||
if expected_follower.requested?(@account) |
||||
# For some reason the follow request went through but we missed it |
||||
expected_follower.follow_requests.find_by(target_account: @account)&.authorize! |
||||
else |
||||
# Since we were not aware of the follow from our side, we do not have an |
||||
# ID for it that we can include in the Undo activity. For this reason, |
||||
# the Undo may not work with software that relies exclusively on |
||||
# matching activity IDs and not the actor and target |
||||
follow = Follow.new(account: expected_follower, target_account: @account) |
||||
ActivityPub::DeliveryWorker.perform_async(build_undo_follow_json(follow), follow.account_id, follow.target_account.inbox_url) |
||||
end |
||||
end |
||||
end |
||||
|
||||
def build_undo_follow_json(follow) |
||||
Oj.dump(serialize_payload(follow, ActivityPub::UndoFollowSerializer)) |
||||
end |
||||
|
||||
def collection_items(collection_or_uri) |
||||
collection = fetch_collection(collection_or_uri) |
||||
return unless collection.is_a?(Hash) |
||||
|
||||
collection = fetch_collection(collection['first']) if collection['first'].present? |
||||
return unless collection.is_a?(Hash) |
||||
|
||||
case collection['type'] |
||||
when 'Collection', 'CollectionPage' |
||||
collection['items'] |
||||
when 'OrderedCollection', 'OrderedCollectionPage' |
||||
collection['orderedItems'] |
||||
end |
||||
end |
||||
|
||||
def fetch_collection(collection_or_uri) |
||||
return collection_or_uri if collection_or_uri.is_a?(Hash) |
||||
return if invalid_origin?(collection_or_uri) |
||||
|
||||
fetch_resource_without_id_validation(collection_or_uri, nil, true) |
||||
end |
||||
end |
||||
@ -0,0 +1,14 @@ |
||||
# frozen_string_literal: true |
||||
|
||||
class ActivityPub::FollowersSynchronizationWorker |
||||
include Sidekiq::Worker |
||||
|
||||
sidekiq_options queue: 'push', lock: :until_executed |
||||
|
||||
def perform(account_id, url) |
||||
@account = Account.find_by(id: account_id) |
||||
return true if @account.nil? |
||||
|
||||
ActivityPub::SynchronizeFollowersService.new.call(@account, url) |
||||
end |
||||
end |
||||
@ -0,0 +1,58 @@ |
||||
require 'rails_helper' |
||||
|
||||
RSpec.describe ActivityPub::FollowersSynchronizationsController, type: :controller do |
||||
let!(:account) { Fabricate(:account) } |
||||
let!(:follower_1) { Fabricate(:account, domain: 'example.com', uri: 'https://example.com/users/a') } |
||||
let!(:follower_2) { Fabricate(:account, domain: 'example.com', uri: 'https://example.com/users/b') } |
||||
let!(:follower_3) { Fabricate(:account, domain: 'foo.com', uri: 'https://foo.com/users/a') } |
||||
|
||||
before do |
||||
follower_1.follow!(account) |
||||
follower_2.follow!(account) |
||||
follower_3.follow!(account) |
||||
end |
||||
|
||||
before do |
||||
allow(controller).to receive(:signed_request_account).and_return(remote_account) |
||||
end |
||||
|
||||
describe 'GET #show' do |
||||
context 'without signature' do |
||||
let(:remote_account) { nil } |
||||
|
||||
before do |
||||
get :show, params: { account_username: account.username } |
||||
end |
||||
|
||||
it 'returns http not authorized' do |
||||
expect(response).to have_http_status(401) |
||||
end |
||||
end |
||||
|
||||
context 'with signature from example.com' do |
||||
let(:remote_account) { Fabricate(:account, domain: 'example.com', uri: 'https://example.com/instance') } |
||||
|
||||
before do |
||||
get :show, params: { account_username: account.username } |
||||
end |
||||
|
||||
it 'returns http success' do |
||||
expect(response).to have_http_status(200) |
||||
end |
||||
|
||||
it 'returns application/activity+json' do |
||||
expect(response.content_type).to eq 'application/activity+json' |
||||
end |
||||
|
||||
it 'returns orderedItems with followers from example.com' do |
||||
json = body_as_json |
||||
expect(json[:orderedItems]).to be_an Array |
||||
expect(json[:orderedItems].sort).to eq [follower_1.uri, follower_2.uri] |
||||
end |
||||
|
||||
it 'returns private Cache-Control header' do |
||||
expect(response.headers['Cache-Control']).to eq 'max-age=0, private' |
||||
end |
||||
end |
||||
end |
||||
end |
||||
@ -0,0 +1,105 @@ |
||||
require 'rails_helper' |
||||
|
||||
RSpec.describe ActivityPub::SynchronizeFollowersService, type: :service do |
||||
let(:actor) { Fabricate(:account, domain: 'example.com', uri: 'http://example.com/account', inbox_url: 'http://example.com/inbox') } |
||||
let(:alice) { Fabricate(:account, username: 'alice') } |
||||
let(:bob) { Fabricate(:account, username: 'bob') } |
||||
let(:eve) { Fabricate(:account, username: 'eve') } |
||||
let(:mallory) { Fabricate(:account, username: 'mallory') } |
||||
let(:collection_uri) { 'http://example.com/partial-followers' } |
||||
|
||||
let(:items) do |
||||
[ |
||||
ActivityPub::TagManager.instance.uri_for(alice), |
||||
ActivityPub::TagManager.instance.uri_for(eve), |
||||
ActivityPub::TagManager.instance.uri_for(mallory), |
||||
] |
||||
end |
||||
|
||||
let(:payload) do |
||||
{ |
||||
'@context': 'https://www.w3.org/ns/activitystreams', |
||||
type: 'Collection', |
||||
id: collection_uri, |
||||
items: items, |
||||
}.with_indifferent_access |
||||
end |
||||
|
||||
subject { described_class.new } |
||||
|
||||
shared_examples 'synchronizes followers' do |
||||
before do |
||||
alice.follow!(actor) |
||||
bob.follow!(actor) |
||||
mallory.request_follow!(actor) |
||||
|
||||
allow(ActivityPub::DeliveryWorker).to receive(:perform_async) |
||||
|
||||
subject.call(actor, collection_uri) |
||||
end |
||||
|
||||
it 'keeps expected followers' do |
||||
expect(alice.following?(actor)).to be true |
||||
end |
||||
|
||||
it 'removes local followers not in the remote list' do |
||||
expect(bob.following?(actor)).to be false |
||||
end |
||||
|
||||
it 'converts follow requests to follow relationships when they have been accepted' do |
||||
expect(mallory.following?(actor)).to be true |
||||
end |
||||
|
||||
it 'sends an Undo Follow to the actor' do |
||||
expect(ActivityPub::DeliveryWorker).to have_received(:perform_async).with(anything, eve.id, actor.inbox_url) |
||||
end |
||||
end |
||||
|
||||
describe '#call' do |
||||
context 'when the endpoint is a Collection of actor URIs' do |
||||
before do |
||||
stub_request(:get, collection_uri).to_return(status: 200, body: Oj.dump(payload)) |
||||
end |
||||
|
||||
it_behaves_like 'synchronizes followers' |
||||
end |
||||
|
||||
context 'when the endpoint is an OrderedCollection of actor URIs' do |
||||
let(:payload) do |
||||
{ |
||||
'@context': 'https://www.w3.org/ns/activitystreams', |
||||
type: 'OrderedCollection', |
||||
id: collection_uri, |
||||
orderedItems: items, |
||||
}.with_indifferent_access |
||||
end |
||||
|
||||
before do |
||||
stub_request(:get, collection_uri).to_return(status: 200, body: Oj.dump(payload)) |
||||
end |
||||
|
||||
it_behaves_like 'synchronizes followers' |
||||
end |
||||
|
||||
context 'when the endpoint is a paginated Collection of actor URIs' do |
||||
let(:payload) do |
||||
{ |
||||
'@context': 'https://www.w3.org/ns/activitystreams', |
||||
type: 'Collection', |
||||
id: collection_uri, |
||||
first: { |
||||
type: 'CollectionPage', |
||||
partOf: collection_uri, |
||||
items: items, |
||||
} |
||||
}.with_indifferent_access |
||||
end |
||||
|
||||
before do |
||||
stub_request(:get, collection_uri).to_return(status: 200, body: Oj.dump(payload)) |
||||
end |
||||
|
||||
it_behaves_like 'synchronizes followers' |
||||
end |
||||
end |
||||
end |
||||
Loading…
Reference in new issue