chore: refactors to remove .closure., .gcsafe for .async. procs, and added callback compatibility to daemonapi (#1240)

Author: richard-ramos

libp2p/daemon/daemonapi.nim

@@ -146,7 +146,7 @@ type
 
   PubsubTicket* = ref object
     topic*: string
-    handler*: P2PPubSubCallback
+    handler*: P2PPubSubCallback2
     transp*: StreamTransport
 
   PubSubMessage* = object
@@ -162,8 +162,10 @@ type
   .}
   P2PPubSubCallback* = proc(
     api: DaemonAPI, ticket: PubsubTicket, message: PubSubMessage
-  ): Future[bool] {.gcsafe, async: (raises: [CatchableError]).}
-
+  ): Future[bool] {.gcsafe, raises: [CatchableError].}
+  P2PPubSubCallback2* = proc(
+    api: DaemonAPI, ticket: PubsubTicket, message: PubSubMessage
+  ): Future[bool] {.async: (raises: [CatchableError]).}
   DaemonError* = object of LPError
   DaemonRemoteError* = object of DaemonError
   DaemonLocalError* = object of DaemonError
@@ -1480,7 +1482,7 @@ proc pubsubLoop(
       break
 
 proc pubsubSubscribe*(
-    api: DaemonAPI, topic: string, handler: P2PPubSubCallback
+    api: DaemonAPI, topic: string, handler: P2PPubSubCallback2
 ): Future[PubsubTicket] {.
     async: (
       raises:
@@ -1508,6 +1510,18 @@ proc pubsubSubscribe*(
     await api.closeConnection(transp)
     raise exc
 
+proc pubsubSubscribe*(
+    api: DaemonAPI, topic: string, handler: P2PPubSubCallback
+): Future[PubsubTicket] {.
+    async: (raises: [CatchableError]), deprecated: "Use P2PPubSubCallback2 instead"
+.} =
+  proc wrap(
+      api: DaemonAPI, ticket: PubsubTicket, message: PubSubMessage
+  ): Future[bool] {.async: (raises: [CatchableError]).} =
+    await handler(api, ticket, message)
+
+  await pubsubSubscribe(api, topic, wrap)
+
 proc shortLog*(pinfo: PeerInfo): string =
   ## Get string representation of ``PeerInfo`` object.
   result = newStringOfCap(128)

libp2p/nameresolving/dnsresolver.nim

@@ -64,7 +64,7 @@ proc getDnsResponse(
 
   proc datagramDataReceived(
       transp: DatagramTransport, raddr: TransportAddress
-  ): Future[void] {.async: (raises: []), closure.} =
+  ): Future[void] {.async: (raises: []).} =
     receivedDataFuture.complete()
 
   let sock =

libp2p/protocols/pubsub/pubsub.nim

@@ -359,9 +359,13 @@ method getOrCreatePeer*(
       peer[].codec = protoNegotiated
     return peer[]
 
-  proc getConn(): Future[Connection] {.async: (raises: [GetConnDialError]).} =
+  proc getConn(): Future[Connection] {.
+      async: (raises: [CancelledError, GetConnDialError])
+  .} =
     try:
       return await p.switch.dial(peerId, protosToDial)
+    except CancelledError as exc:
+      raise exc
     except CatchableError as e:
       raise (ref GetConnDialError)(parent: e)
 

libp2p/protocols/pubsub/pubsubpeer.nim

@@ -81,7 +81,8 @@ type
   PubSubPeerEvent* = object
     kind*: PubSubPeerEventKind
 
-  GetConn* = proc(): Future[Connection] {.gcsafe, async: (raises: [GetConnDialError]).}
+  GetConn* =
+    proc(): Future[Connection] {.async: (raises: [CancelledError, GetConnDialError]).}
   DropConn* = proc(peer: PubSubPeer) {.gcsafe, raises: [].}
     # have to pass peer as it's unknown during init
   OnEvent* = proc(peer: PubSubPeer, event: PubSubPeerEvent) {.gcsafe, raises: [].}
@@ -123,9 +124,8 @@ type
       # The max number of elements allowed in the non-priority queue.
     disconnected: bool
 
-  RPCHandler* = proc(peer: PubSubPeer, data: seq[byte]): Future[void] {.
-    gcsafe, async: (raises: [])
-  .}
+  RPCHandler* =
+    proc(peer: PubSubPeer, data: seq[byte]): Future[void] {.async: (raises: []).}
 
 when defined(libp2p_agents_metrics):
   func shortAgent*(p: PubSubPeer): string =

libp2p/transports/quictransport.nim

@@ -197,7 +197,7 @@ method dial*(
     hostname: string,
     address: MultiAddress,
     peerId: Opt[PeerId] = Opt.none(PeerId),
-): Future[P2PConnection] {.async, gcsafe.} =
+): Future[P2PConnection] {.async.} =
   let connection = await dial(initTAddress(address).tryGet)
   return transport.wrapConnection(connection)
 

tests/pubsub/testgossipsub.nim

@@ -724,7 +724,7 @@ suite "GossipSub":
       var handler: TopicHandler
       closureScope:
         var peerName = $dialer.peerInfo.peerId
-        handler = proc(topic: string, data: seq[byte]) {.async, closure.} =
+        handler = proc(topic: string, data: seq[byte]) {.async.} =
           seen.mgetOrPut(peerName, 0).inc()
           check topic == "foobar"
           if not seenFut.finished() and seen.len >= runs:
@@ -772,7 +772,7 @@ suite "GossipSub":
       var handler: TopicHandler
       capture dialer, i:
         var peerName = $dialer.peerInfo.peerId
-        handler = proc(topic: string, data: seq[byte]) {.async, closure.} =
+        handler = proc(topic: string, data: seq[byte]) {.async.} =
           try:
             if peerName notin seen:
               seen[peerName] = 0

tests/pubsub/testgossipsub2.nim

@@ -65,7 +65,7 @@ suite "GossipSub":
       var handler: TopicHandler
       closureScope:
         var peerName = $dialer.peerInfo.peerId
-        handler = proc(topic: string, data: seq[byte]) {.async, closure.} =
+        handler = proc(topic: string, data: seq[byte]) {.async.} =
           seen.mgetOrPut(peerName, 0).inc()
           info "seen up", count = seen.len
           check topic == "foobar"
@@ -272,7 +272,7 @@ suite "GossipSub":
       var handler: TopicHandler
       closureScope:
         var peerName = $dialer.peerInfo.peerId
-        handler = proc(topic: string, data: seq[byte]) {.async, closure.} =
+        handler = proc(topic: string, data: seq[byte]) {.async.} =
           seen.mgetOrPut(peerName, 0).inc()
           check topic == "foobar"
           if not seenFut.finished() and seen.len >= runs:

tests/pubsub/utils.nim

@@ -27,9 +27,13 @@ randomize()
 type TestGossipSub* = ref object of GossipSub
 
 proc getPubSubPeer*(p: TestGossipSub, peerId: PeerId): PubSubPeer =
-  proc getConn(): Future[Connection] {.async: (raises: [GetConnDialError]).} =
+  proc getConn(): Future[Connection] {.
+      async: (raises: [CancelledError, GetConnDialError])
+  .} =
     try:
       return await p.switch.dial(peerId, GossipSubCodec_12)
+    except CancelledError as exc:
+      raise exc
     except CatchableError as e:
       raise (ref GetConnDialError)(parent: e)
 

tests/testping.nim

@@ -45,7 +45,7 @@ suite "Ping":
     transport1 = TcpTransport.new(upgrade = Upgrade())
     transport2 = TcpTransport.new(upgrade = Upgrade())
 
-    proc handlePing(peer: PeerId) {.async, closure.} =
+    proc handlePing(peer: PeerId) {.async.} =
       inc pingReceivedCount
 
     pingProto1 = Ping.new()
@@ -96,7 +96,7 @@ suite "Ping":
   asyncTest "bad ping data ack":
     type FakePing = ref object of LPProtocol
     let fakePingProto = FakePing()
-    proc fakeHandle(conn: Connection, proto: string) {.async, closure.} =
+    proc fakeHandle(conn: Connection, proto: string) {.async.} =
       var
         buf: array[32, byte]
         fakebuf: array[32, byte]