test: ensure the gossipsub-mesh-peer is added upon grafting, and removed at pruning

Author: maschad

test/gossip.spec.ts

@@ -10,7 +10,7 @@ import { mockNetwork } from '@libp2p/interface-mocks'
 import { stubInterface } from 'ts-sinon'
 import { Registrar } from '@libp2p/interface-registrar'
 import { createEd25519PeerId } from '@libp2p/peer-id-factory'
-import { PeerStore } from '@libp2p/interface-peer-store'
+import { PeerStore, Tag } from '@libp2p/interface-peer-store'
 import { ConnectionManager } from '@libp2p/interface-connection-manager'
 
 describe('gossip', () => {
@@ -80,6 +80,86 @@ describe('gossip', () => {
     nodeASpy.pushGossip.restore()
   })
 
+  it('should add the tag gossipsub-mesh-peer upon grafting', async function () {
+    this.timeout(10e4)
+    const topic = 'Z'
+    // add subscriptions to each node
+    nodes.forEach((n) => n.pubsub.subscribe(topic))
+
+    // every node connected to every other
+    await connectAllPubSubNodes(nodes)
+
+    // wait for subscriptions to be transmitted
+    await Promise.all(nodes.map(async (n) => await pEvent(n.pubsub, 'subscription-change')))
+
+    // await mesh rebalancing
+    await Promise.all(nodes.map(async (n) => await pEvent(n.pubsub, 'gossipsub:heartbeat')))
+
+    // const allTags: Tag[][] = []
+
+    // nodes.forEach(async (subscribedPeer) => {
+    //   allTags.push(await subscribedPeer.components.peerStore.getTags(subscribedPeer.components.peerId))
+    // })
+
+    // // gossip happens during the heartbeat
+    // await pEvent(nodes[nodes.length - 1].pubsub, 'gossipsub:heartbeat')
+
+    // expect(
+    //   allTags.map((tags) => {
+    //     tags.map((tag) => {
+    //       tag.name.toString()
+    //     })
+    //   })
+    // ).to.include('gossipsub-mesh-peer')
+
+    await pEvent(nodes[nodes.length - 1].pubsub, 'gossipsub:heartbeat')
+
+    expect(
+      (await nodes[0].components.peerStore.getTags(nodes[0].components.peerId)).map((tag) => tag.name.toString())
+    ).to.include('gossipsub-mesh-peer')
+  })
+
+  it('should remove the tag gossipsub-mesh-peer upon pruning', async function () {
+    this.timeout(10e4)
+    const topic = 'Z'
+    // add subscriptions to each node
+    nodes.forEach((n) => n.pubsub.subscribe(topic))
+
+    // every node connected to every other
+    await connectAllPubSubNodes(nodes)
+
+    // wait for subscriptions to be transmitted
+    await Promise.all(nodes.map(async (n) => await pEvent(n.pubsub, 'subscription-change')))
+
+    // disconnect some peers from the mesh to get some PRUNEs and the store the disconnected peers
+    const unsubscribedPeers: GossipSubAndComponents[] = []
+
+    nodes.slice(0, 5).forEach((ps) => {
+      ps.pubsub.unsubscribe(topic)
+      unsubscribedPeers.push(ps)
+    })
+
+    // await mesh rebalancing
+    await Promise.all(nodes.map(async (n) => await pEvent(n.pubsub, 'gossipsub:heartbeat')))
+
+    const allTags: Tag[][] = []
+
+    unsubscribedPeers.forEach(async (unsubscribedPeer) => {
+      allTags.push(await unsubscribedPeer.components.peerStore.getTags(unsubscribedPeer.components.peerId))
+    })
+
+    // gossip happens during the heartbeat
+    await pEvent(unsubscribedPeers[4].pubsub, 'gossipsub:heartbeat')
+
+    expect(
+      allTags.map((tags) => {
+        tags.map((tag) => {
+          tag.name.toString()
+        })
+      })
+    ).to.not.include('gossipsub-mesh-peer')
+  })
+
   it('should reject incoming messages bigger than maxInboundDataLength limit', async function () {
     this.timeout(10e4)
     const nodeA = nodes[0]