defaultMsgIdProvider alternative/test anonymize (#379)

* defaultMsgIdProvider alternative/test anonymize

* avoid freeze during flood tests

* avoid `empty message, skipping` situation

* test observers

* avoid double initPubSub

* fix gossip testing (specially when anonymize is on)

* make azure tests shorter

azure-pipelines.yml

@@ -119,7 +119,7 @@ steps:
       nimble install -y --depsOnly
 
       # run tests
-      nimble test
+      nimble test_slim
       nimble examples_build
     displayName: 'build and test'
 

libp2p.nimble

@@ -50,10 +50,18 @@ task testpubsub, "Runs pubsub tests":
   runTest("pubsub/testgossipinternal", sign = false, verify = false, moreoptions = "-d:pubsub_internal_testing")
   runTest("pubsub/testpubsub")
   runTest("pubsub/testpubsub", sign = false, verify = false)
+  runTest("pubsub/testpubsub", sign = false, verify = false, moreoptions = "-d:libp2p_pubsub_anonymize=true")
   runTest("pubsub/testgossipinternal10", sign = false, verify = false, moreoptions = "-d:pubsub_internal_testing")
   runTest("pubsub/testpubsub", moreoptions = "-d:fallback_gossipsub_10")
   runTest("pubsub/testpubsub", sign = false, verify = false, moreoptions = "-d:fallback_gossipsub_10")
 
+task testpubsub_slim, "Runs pubsub tests":
+  runTest("pubsub/testgossipinternal", sign = false, verify = false, moreoptions = "-d:pubsub_internal_testing")
+  runTest("pubsub/testpubsub")
+  runTest("pubsub/testpubsub", sign = false, verify = false, moreoptions = "-d:libp2p_pubsub_anonymize=true")
+  runTest("pubsub/testgossipinternal10", sign = false, verify = false, moreoptions = "-d:pubsub_internal_testing")
+  runTest("pubsub/testpubsub", moreoptions = "-d:fallback_gossipsub_10")
+
 task testfilter, "Run PKI filter test":
   runTest("testpkifilter",
            moreoptions = "-d:libp2p_pki_schemes=\"secp256k1\"")
@@ -71,5 +79,12 @@ task test, "Runs the test suite":
   exec "nimble testinterop"
   exec "nimble testfilter"
 
+task test_slim, "Runs the test suite":
+  exec "nimble testnative"
+  exec "nimble testpubsub_slim"
+  exec "nimble testdaemon"
+  exec "nimble testinterop"
+  exec "nimble testfilter"
+
 task examples_build, "Build the samples":
   buildSample("directchat")

libp2p/protocols/pubsub/pubsub.nim

@@ -125,7 +125,8 @@ method onPubSubPeerEvent*(p: PubSub, peer: PubsubPeer, event: PubsubPeerEvent) {
   # Peer event is raised for the send connection in particular
   case event.kind
   of PubSubPeerEventKind.Connected:
-    p.sendSubs(peer, toSeq(p.topics.keys), true)
+    if p.topics.len > 0:
+      p.sendSubs(peer, toSeq(p.topics.keys), true)
   of PubSubPeerEventKind.Disconnected:
     discard
 
@@ -357,7 +358,6 @@ proc init*[PubParams: object | bool](
         topics: initTable[string, Topic](),
         msgIdProvider: msgIdProvider,
         parameters: parameters)
-  pubsub.initPubSub()
 
   proc peerEventHandler(peerId: PeerID, event: PeerEvent) {.async.} =
     if event == PeerEvent.Joined:
@@ -369,6 +369,7 @@ proc init*[PubParams: object | bool](
   switch.addPeerEventHandler(peerEventHandler, PeerEvent.Left)
 
   pubsub.initPubSub()
+  
   return pubsub
 
 

libp2p/protocols/pubsub/rpc/message.nim

@@ -9,6 +9,7 @@
 
 {.push raises: [Defect].}
 
+import hashes
 import chronicles, metrics, stew/[byteutils, endians2]
 import ./messages,
        ./protobuf,
@@ -28,7 +29,10 @@ declareCounter(libp2p_pubsub_sig_verify_success, "pubsub successfully validated
 declareCounter(libp2p_pubsub_sig_verify_failure, "pubsub failed validated messages")
 
 func defaultMsgIdProvider*(m: Message): string =
-  byteutils.toHex(m.seqno) & $m.fromPeer
+  if m.seqno.len > 0 and m.fromPeer.data.len > 0:
+    byteutils.toHex(m.seqno) & $m.fromPeer
+  else:
+    $m.data.hash & $m.topicIDs.hash
 
 proc sign*(msg: Message, privateKey: PrivateKey): CryptoResult[seq[byte]] =
   ok((? privateKey.sign(PubSubPrefix & encodeMessage(msg, false))).getBytes())

tests/pubsub/testfloodsub.nim

@@ -326,7 +326,7 @@ suite "FloodSub":
 
       var pubs: seq[Future[int]]
       for i in 0..<runs:
-        pubs &= nodes[i].publish("foobar", "Hello!".toBytes())
+        pubs &= nodes[i].publish("foobar", ("Hello!" & $i).toBytes())
       await allFuturesThrowing(pubs)
 
       await allFuturesThrowing(futs.mapIt(it[0]))
@@ -379,7 +379,7 @@ suite "FloodSub":
 
       var pubs: seq[Future[int]]
       for i in 0..<runs:
-        pubs &= nodes[i].publish("foobar", "Hello!".toBytes())
+        pubs &= nodes[i].publish("foobar", ("Hello!" & $i).toBytes())
       await allFuturesThrowing(pubs)
 
       await allFuturesThrowing(futs.mapIt(it[0]))

tests/pubsub/testgossipsub.nim

@@ -426,8 +426,8 @@ suite "GossipSub":
           inc observed
         )
 
-      # nodes[1].addObserver(obs1)
-      # nodes[0].addObserver(obs2)
+      nodes[1].addObserver(obs1)
+      nodes[0].addObserver(obs2)
 
       tryPublish await nodes[0].publish("foobar", "Hello!".toBytes()), 1
 
@@ -457,7 +457,7 @@ suite "GossipSub":
       )
 
       await allFuturesThrowing(nodesFut.concat())
-      # check observed == 2
+      check observed == 2
 
     waitFor(runTests())
 
@@ -535,7 +535,6 @@ suite "GossipSub":
       await subscribeNodes(nodes)
 
       var seen: Table[string, int]
-      var subs: seq[Future[void]]
       var seenFut = newFuture[void]()
       for dialer in nodes:
         var handler: TopicHandler
@@ -549,14 +548,13 @@ suite "GossipSub":
             if not seenFut.finished() and seen.len >= runs:
               seenFut.complete()
 
-        subs &= dialer.subscribe("foobar", handler)
-
-      await allFuturesThrowing(subs).wait(30.seconds)
-
+        await dialer.subscribe("foobar", handler)
+        await waitSub(nodes[0], dialer, "foobar")
+  
       tryPublish await wait(nodes[0].publish("foobar",
                                     toBytes("from node " &
-                                    $nodes[1].peerInfo.peerId)),
-                                    1.minutes), runs, 5.seconds
+                                    $nodes[0].peerInfo.peerId)),
+                                    1.minutes), 1, 5.seconds
 
       await wait(seenFut, 2.minutes)
       check: seen.len >= runs
@@ -591,7 +589,6 @@ suite "GossipSub":
       await subscribeNodes(nodes)
 
       var seen: Table[PeerID, int]
-      var subs: seq[Future[void]]
       var seenFut = newFuture[void]()
       for dialer in nodes:
         var handler: TopicHandler
@@ -606,14 +603,13 @@ suite "GossipSub":
             if not seenFut.finished() and seen.len >= runs:
               seenFut.complete()
 
-        subs &= dialer.subscribe("foobar", handler)
-        subs &= waitSub(nodes[0], dialer, "foobar")
+        await dialer.subscribe("foobar", handler)
+        await waitSub(nodes[0], dialer, "foobar")
 
-      await allFuturesThrowing(subs)
       tryPublish await wait(nodes[0].publish("foobar",
                                     toBytes("from node " &
-                                    $nodes[1].peerInfo.peerId)),
-                                    1.minutes), 2, 5.seconds
+                                    $nodes[0].peerInfo.peerId)),
+                                    1.minutes), 1, 5.seconds
 
       await wait(seenFut, 5.minutes)
       check: seen.len >= runs

tests/pubsub/utils.nim

@@ -2,6 +2,7 @@
 const
   libp2p_pubsub_sign {.booldefine.} = true
   libp2p_pubsub_verify {.booldefine.} = true
+  libp2p_pubsub_anonymize {.booldefine.} = false
 
 import random
 import chronos
@@ -28,6 +29,7 @@ proc generateNodes*(
   gossip: bool = false,
   triggerSelf: bool = false,
   verifySignature: bool = libp2p_pubsub_verify,
+  anonymize: bool = libp2p_pubsub_anonymize,
   sign: bool = libp2p_pubsub_sign): seq[PubSub] =
 
   for i in 0..<num:
@@ -39,6 +41,7 @@ proc generateNodes*(
         verifySignature = verifySignature,
         sign = sign,
         msgIdProvider = msgIdProvider,
+        anonymize = anonymize,
         parameters = (var p = GossipSubParams.init(); p.floodPublish = false; p)).PubSub
     else:
       FloodSub.init(
@@ -46,7 +49,8 @@ proc generateNodes*(
         triggerSelf = triggerSelf,
         verifySignature = verifySignature,
         sign = sign,
-        msgIdProvider = msgIdProvider).PubSub
+        msgIdProvider = msgIdProvider,
+        anonymize = anonymize).PubSub
 
     switch.mount(pubsub)
     result.add(pubsub)