Node.js based forum software built for the modern web
refactor(activitypub): unify relay state into single sorted set with signed scores
Julian Lamadaa376fbce3
diff --git a/src/activitypub/relays.js b/src/activitypub/relays.jsindex af1ee9dc77..b1f536a788 100644--- a/src/activitypub/relays.js+++ b/src/activitypub/relays.js@@ -16,6 +16,16 @@ Relays.list = async () => {relays = relays.reduce((memo, { value, score }) => {let label = '[[admin/settings/activitypub:relays.state-0]]';switch(score) {+ case -2: {+ label = '[[admin/settings/activitypub:relays.state--2]]';+ break;+ }++ case -1: {+ label = '[[admin/settings/activitypub:relays.state--1]]';+ break;+ }+case 1: {label = '[[admin/settings/activitypub:relays.state-1]]';break;@@ -108,35 +118,22 @@ Relays.handshake = async (body) => {throw new Error('[[error:api.400]]');}- // Check if NodeBB is the target of the followconst target = typeof followActivity === 'object' ? followActivity.id : followActivity;- if (target === `${nconf.get('url')}/actor`) {- await Relays.addFollower(actor);-- if (type === 'Follow') {- await activitypub.send('uid', 0, actor, {- '@context': [- 'https://www.w3.org/ns/activitystreams',- 'https://pleroma.example/schemas/litepub-0.1.jsonld',- ],- id: `${nconf.get('url')}/actor#activity/accept/${encodeURIComponent(actor)}/${now.getTime()}`,- type: 'Accept',- to: [actor],- published: now.toISOString(),- object: followActivity,- });- }- return;- }-- // Confirm relay was added (NodeBB is the follower)- const exists = await db.isSortedSetMember('relays:createtime', actor);- if (!exists) {- throw new Error('[[error:api.400]]');- }+ const isUnsolicited = target === `${nconf.get('url')}/actor`;if (type === 'Follow') {- await db.sortedSetIncrBy('relays:state', 1, actor);+ if (isUnsolicited) {+ await db.sortedSetAdd('relays:state', -1, actor);+ await db.sortedSetAdd('relays:createtime', now.getTime(), actor);+ } else {+ // Confirm relay was added (NodeBB is the follower)+ const exists = await db.isSortedSetMember('relays:createtime', actor);+ if (!exists) {+ throw new Error('[[error:api.400]]');+ }+ await db.sortedSetIncrBy('relays:state', 1, actor);+ }+await activitypub.send('uid', 0, actor, {'@context': ['https://www.w3.org/ns/activitystreams',@@ -146,25 +143,27 @@ Relays.handshake = async (body) => {type: 'Accept',to: [actor],published: now.toISOString(),- object: body,+ object: isUnsolicited ? followActivity : body,});} else if (type === 'Accept') {+ if (isUnsolicited) {+ // Unsolicited Accept — should not happen, but handle gracefully+ return;+ }await db.sortedSetIncrBy('relays:state', 1, actor);} else {throw new Error('[[error:api.400]]');}};-Relays.addFollower = async (actor) => {- await db.sortedSetAdd('relays:followers', Date.now(), actor);-};-Relays.removeFollower = async (actor) => {- await db.sortedSetRemove('relays:followers', actor);+ await db.sortedSetRemove('relays:state', actor);+ await db.sortedSetRemove('relays:createtime', actor);};Relays.getFollowers = async () => {- return db.getSortedSetMembers('relays:followers');+ const relays = await db.getSortedSetMembersWithScores('relays:state');+ return relays.filter(({ score }) => score < 0).map(({ value }) => value);};Relays.broadcast = async (payload) => {diff --git a/test/activitypub/inbox.js b/test/activitypub/inbox.jsindex 934915ee77..01b333f3ee 100644--- a/test/activitypub/inbox.js+++ b/test/activitypub/inbox.js@@ -1135,12 +1135,13 @@ describe('Inbox', () => {await activitypub.inbox.follow({ body: activity });- const isFollower = await db.isSortedSetMember('relays:followers', relayActor);- assert.strictEqual(isFollower, true);+ const score = await db.sortedSetScore('relays:state', relayActor);+ assert.strictEqual(score, -1);});it('should remove a follower when a Follow activity is undone', async () => {- await activitypub.relays.addFollower(relayActor);+ await db.sortedSetAdd('relays:state', -1, relayActor);+ await db.sortedSetAdd('relays:createtime', Date.now(), relayActor);const followActivity = {id: `${nconf.get('url')}/actor#activity/follow/${relayActor}`,@@ -1155,12 +1156,13 @@ describe('Inbox', () => {await activitypub.inbox.undo({ body: undoActivity });- const isFollower = await db.isSortedSetMember('relays:followers', relayActor);- assert.strictEqual(isFollower, false);+ const score = await db.sortedSetScore('relays:state', relayActor);+ assert.strictEqual(score, null);});it('should broadcast a public activity received via announce to relay followers', async () => {- await activitypub.relays.addFollower(relayActor);+ await db.sortedSetAdd('relays:state', -1, relayActor);+ await db.sortedSetAdd('relays:createtime', Date.now(), relayActor);await activitypub.relays.add(relayActor);const { note, id } = helpers.mocks.note();@@ -1224,7 +1226,8 @@ describe('Inbox', () => {posts.getPostField = originalGetPostField;topics.getTopicField = originalGetTopicField;activitypub.relays.list = originalRelaysList;- await db.sortedSetRemove('relays:followers', relayActor);+ await db.sortedSetRemove('relays:state', relayActor);+ await db.sortedSetRemove('relays:createtime', relayActor);});});});diff --git a/test/activitypub/relays.js b/test/activitypub/relays.jsindex 2a52b94cf2..a320384a36 100644--- a/test/activitypub/relays.js+++ b/test/activitypub/relays.js@@ -8,27 +8,32 @@ describe('ActivityPub Relays', () => {const actor = 'https://example.com/actor';afterEach(async () => {- await db.sortedSetRemove('relays:followers', actor);+ await db.sortedSetRemove('relays:state', actor);+ await db.sortedSetRemove('relays:createtime', actor);});it('should add a relay follower', async () => {- await activitypub.relays.addFollower(actor);- const exists = await db.isSortedSetMember('relays:followers', actor);- assert.strictEqual(exists, true);+ await db.sortedSetAdd('relays:state', -1, actor);+ await db.sortedSetAdd('relays:createtime', Date.now(), actor);+ const score = await db.sortedSetScore('relays:state', actor);+ assert.strictEqual(score, -1);});it('should remove a relay follower', async () => {- await activitypub.relays.addFollower(actor);+ await db.sortedSetAdd('relays:state', -1, actor);+ await db.sortedSetAdd('relays:createtime', Date.now(), actor);await activitypub.relays.removeFollower(actor);- const exists = await db.isSortedSetMember('relays:followers', actor);- assert.strictEqual(exists, false);+ const score = await db.sortedSetScore('relays:state', actor);+ assert.strictEqual(score, null);});it('should get relay followers', async () => {const actor2 = 'https://example2.com/actor';await Promise.all([- activitypub.relays.addFollower(actor),- activitypub.relays.addFollower(actor2),+ db.sortedSetAdd('relays:state', -1, actor),+ db.sortedSetAdd('relays:createtime', Date.now(), actor),+ db.sortedSetAdd('relays:state', -1, actor2),+ db.sortedSetAdd('relays:createtime', Date.now(), actor2),]);const followers = await activitypub.relays.getFollowers();@@ -36,7 +41,8 @@ describe('ActivityPub Relays', () => {assert.ok(followers.includes(actor));assert.ok(followers.includes(actor2));- await db.sortedSetRemove('relays:followers', actor2);+ await db.sortedSetRemove('relays:state', actor2);+ await db.sortedSetRemove('relays:createtime', actor2);});it('should broadcast to relay followers', async () => {@@ -51,7 +57,10 @@ describe('ActivityPub Relays', () => {return true;};- await Promise.all(followers.map(f => activitypub.relays.addFollower(f)));+ await Promise.all(followers.map(f => Promise.all([+ db.sortedSetAdd('relays:state', -1, f),+ db.sortedSetAdd('relays:createtime', Date.now(), f),+ ])));await activitypub.relays.broadcast(payload);@@ -61,7 +70,9 @@ describe('ActivityPub Relays', () => {// Cleanupactivitypub.send = originalSend;- await db.sortedSetRemove('relays:followers', followers[0]);- await db.sortedSetRemove('relays:followers', followers[1]);+ await db.sortedSetRemove('relays:state', followers[0]);+ await db.sortedSetRemove('relays:createtime', followers[0]);+ await db.sortedSetRemove('relays:state', followers[1]);+ await db.sortedSetRemove('relays:createtime', followers[1]);});});