helia-coord 1.1.4 → 1.2.0

package/lib/adapters/ipfs-adapter.js

@@ -23,6 +23,12 @@ class IpfsAdapter {
       )
     }
 
+    // Bind 'this' object to all subfunctions
+    this.start = this.start.bind(this)
+    this.connectToPeer = this.connectToPeer.bind(this)
+    this.disconnectFromPeer = this.disconnectFromPeer.bind(this)
+    this.getPeers = this.getPeers.bind(this)
+
     // 'embedded' node type used as default, will use embedded js-ipfs.
     // Alternative is 'external' which will use ipfs-http-client to control an
     // external IPFS node.
@@ -69,23 +75,34 @@ class IpfsAdapter {
 
   // Attempts to connect to an IPFS peer, given its IPFS multiaddr.
   // Returns true if the connection succeeded. Otherwise returns false.
-  async connectToPeer (ipfsAddr) {
+  async connectToPeer (inObj = {}) {
     try {
+      // console.log('connectToPeer() inObj: ', inObj)
+
       // TODO: Throw error if ipfs ID is passed, instead of a multiaddr.
       // console.log('ipfsAddr: ', ipfsAddr)
 
+      const { multiaddr } = inObj
+
       // await this.ipfs.swarm.connect(ipfsAddr, { timeout: CONNECTION_TIMEOUT })
-      await this.ipfs.libp2p.dial(this.multiaddr(ipfsAddr))
+      await this.ipfs.libp2p.dial(this.multiaddr(multiaddr))
+      // console.log('connectToPeer() result: ', result)
 
-      this.log.statusLog(1, `Successfully connected to peer node ${ipfsAddr}`)
+      this.log.statusLog(1, `Successfully connected to peer node ${multiaddr}`)
 
-      return true
+      return {
+        success: true,
+        details: null
+      }
     } catch (err) {
       /* exit quietly */
+      // console.log('connectToPeer() Error connecting to peer: ', err)
+      this.log.statusLog(2, 'Error trying to connect to peer node : ', err.message)
 
-      this.log.statusLog(2, `Error trying to connect to peer node ${ipfsAddr}`)
-
-      return false
+      return {
+        success: false,
+        details: err.message
+      }
     }
   }
 

package/lib/use-cases/relay-use-cases.js

@@ -37,7 +37,7 @@ class RelayUseCases {
 
         // Attempt to connect to the Circuit Relay peer.
         const connectionStatus = await this.adapters.ipfs.connectToPeer(
-          thisRelay.multiaddr
+          { multiaddr: thisRelay.multiaddr }
         )
 
         const now = new Date()
@@ -92,7 +92,7 @@ class RelayUseCases {
         // console.log(`getCRGist() Connecting to Circuit Relay ${thisRelay.multiaddr}`)
         this.adapters.log.statusLog(1, `getCRGist() Connecting to Circuit Relay ${thisRelay.multiaddr}`)
         const connectionStatus = await this.adapters.ipfs.connectToPeer(
-          thisRelay.multiaddr
+          { multiaddr: thisRelay.multiaddr }
         )
 
         const now = new Date()
@@ -156,7 +156,7 @@ class RelayUseCases {
           // If this node is not connected, try to connect again.
           console.log(`Connecting to Circuit Relay ${thisRelay.multiaddr}`)
           thisRelay.connected = await this.adapters.ipfs.connectToPeer(
-            thisRelay.multiaddr
+            { multiaddr: thisRelay.multiaddr }
           )
           console.log(`thisRelay.connected: ${thisRelay.connected}`)
 
@@ -309,7 +309,7 @@ class RelayUseCases {
         // console.log('thisAddr: ', thisAddr)
 
         // Try to connect to the IPFS peer.
-        connectSuccess = await this.adapters.ipfs.connectToPeer(thisAddr)
+        connectSuccess = await this.adapters.ipfs.connectToPeer({ multiaddr: thisAddr })
 
         if (connectSuccess) {
           multiaddr = thisAddr

package/lib/use-cases/this-node-use-cases.js

@@ -289,7 +289,7 @@ class ThisNodeUseCases {
             this.adapters.log.statusLog(2, `refreshPeerConnections() connecting to peer with this multiaddr: ${multiaddr}`)
 
             // Attempt to connect to the node through a circuit relay.
-            const connected = await this.adapters.ipfs.connectToPeer(multiaddr)
+            const connected = await this.adapters.ipfs.connectToPeer({ multiaddr })
 
             // If the connection was successful, break out of the relay loop.
             // Otherwise try to connect through the next relay.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "helia-coord",
-  "version": "1.1.4",
+  "version": "1.2.0",
   "description": "A JS library for helping IPFS peers coordinate, find a common interest, and stay connected around that interest.",
   "main": "./index.js",
   "type": "module",

package/test/unit/adapters/ipfs-adapter-unit.js

@@ -104,18 +104,18 @@ describe('#Adapter - IPFS', () => {
       sandbox.stub(uut.ipfs.libp2p, 'dial').resolves()
       sandbox.stub(uut, 'multiaddr').returns()
 
-      const result = await uut.connectToPeer('fakeId')
+      const result = await uut.connectToPeer({ multiaddr: 'fakeId' })
 
-      assert.equal(result, true)
+      assert.equal(result.success, true)
     })
 
     it('should return false when issues connecting to peer', async () => {
       // Force an error
       sandbox.stub(uut.ipfs.swarm, 'connect').rejects(new Error('test error'))
 
-      const result = await uut.connectToPeer('fakeId')
+      const result = await uut.connectToPeer({ multiaddr: 'fakeId' })
 
-      assert.equal(result, false)
+      assert.equal(result.success, false)
     })
 
     it('should report connection errors at debugLevel 1', async () => {
@@ -124,9 +124,9 @@ describe('#Adapter - IPFS', () => {
       // Force an error
       sandbox.stub(uut.ipfs.swarm, 'connect').rejects(new Error('test error'))
 
-      const result = await uut.connectToPeer('fakeId')
+      const result = await uut.connectToPeer({ multiaddr: 'fakeId' })
 
-      assert.equal(result, false)
+      assert.equal(result.success, false)
     })
 
     it('should report full errors at debugLevel 2', async () => {
@@ -135,9 +135,9 @@ describe('#Adapter - IPFS', () => {
       // Force an error
       sandbox.stub(uut.ipfs.swarm, 'connect').rejects(new Error('test error'))
 
-      const result = await uut.connectToPeer('fakeId')
+      const result = await uut.connectToPeer({ multiaddr: 'fakeId' })
 
-      assert.equal(result, false)
+      assert.equal(result.success, false)
     })
   })