feat: Add options to broadcast Peer info on seeing a new subscription

src/index.ts

@@ -116,6 +116,17 @@ export interface PubsubPeerDiscoveryInit {
    * If true, we will not broadcast our peer data
    */
   listenOnly?: boolean
+
+  /**
+   * If true, we will broadcast our data when we see new peers on the peer discovery topic (default: false).
+   * listenOnly must not be set to false for this capability to be applied.
+   */
+  broadcastOnSubscribe?: boolean
+
+  /**
+   * Randomized backoff in milliseconds to wait before broadcasting on seeing a new subscription (default: 0.1 * interval).
+   */
+  backoffOnSubscribe?: number
 }
 
 export interface PubSubPeerDiscoveryComponents {
@@ -135,6 +146,8 @@ export class PubSubPeerDiscovery extends TypedEventEmitter<PeerDiscoveryEvents>
   private readonly interval: number
   private readonly listenOnly: boolean
   private readonly topics: string[]
+  private readonly broadcastOnSubscribe: boolean
+  private readonly backoffOnSubscribe: number
   private intervalId?: ReturnType<typeof setInterval>
   private readonly components: PubSubPeerDiscoveryComponents
   private readonly log: Logger
@@ -145,12 +158,16 @@ export class PubSubPeerDiscovery extends TypedEventEmitter<PeerDiscoveryEvents>
     const {
       interval,
       topics,
-      listenOnly
+      listenOnly,
+      broadcastOnSubscribe,
+      backoffOnSubscribe,
     } = init
 
     this.components = components
     this.interval = interval ?? 10000
     this.listenOnly = listenOnly ?? false
+    this.broadcastOnSubscribe = broadcastOnSubscribe ?? false
+    this.backoffOnSubscribe = backoffOnSubscribe ?? this.interval * 0.1;
     this.log = components.logger.forComponent('libp2p:discovery:pubsub')
 
     // Ensure we have topics
@@ -197,6 +214,20 @@ export class PubSubPeerDiscovery extends TypedEventEmitter<PeerDiscoveryEvents>
       return
     }
 
+    // Broadcast on Subscribe from other peers
+    if (this.broadcastOnSubscribe) {
+      pubsub.addEventListener('subscription-change', subChangeEvt => {
+        // Check if the PubSub peer cares about PubSub Peer Discovery
+        const discoverySubs = subChangeEvt.detail.subscriptions.filter(sub => this.topics.includes(sub.topic));
+
+        // The Peer is interested in PubSub Peer Discovery -> broadcast
+        if (discoverySubs.length > 0) {
+          const backoff = this.backoffOnSubscribe * Math.random()
+          setTimeout(() => { this._broadcast() }, backoff)
+        }
+      })
+    }
+
     // Broadcast immediately, and then run on interval
     this._broadcast()