chore: address review

Author: vasco-santos

README.md

@@ -30,6 +30,7 @@ js-multiaddr
       - [Browser: `<script>` Tag](#browser-script-tag)
   - [Usage](#usage)
   - [API](#api)
+  - [Resolvers](#resolvers)
   - [Contribute](#contribute)
   - [License](#license)
 
@@ -117,6 +118,25 @@ $ node
 
 https://multiformats.github.io/js-multiaddr/
 
+## Resolvers
+
+`multiaddr` allows multiaddrs to be resolved when appropriate resolvers are provided. This module already has resolvers available, but you can also create your own. To provide multiaddr resolvers you can do:
+
+```js
+const multiaddr = require('multiaddr')
+const resolvers = require('multiaddr/src/resolvers')
+
+multiaddr.resolvers.set('dnsaddr', resolvers.dnsaddrResolver)
+```
+
+The available resolvers are:
+
+|     Name    | type | Description |
+|-------------|------|-------------|
+| `dnsaddrResolver` | `dnsaddr` | dnsaddr resolution with TXT Records |
+
+A resolver receives a `Multiaddr` as a parameter and returns a `Promise<Array<string>>`.
+
 ## Contribute
 
 Contributions welcome. Please check out [the issues](https://github.com/multiformats/js-multiaddr/issues).

package.json

@@ -18,9 +18,6 @@
     "docs": "aegir docs",
     "size": "aegir build -b"
   },
-  "browser": {
-    "./src/resolvers/dns.js": "./src/resolvers/dns.browser.js"
-  },
   "files": [
     "src",
     "dist"

src/index.d.ts

@@ -52,8 +52,6 @@ declare class Multiaddr {
 
   bytes: Uint8Array;
 
-  resolvers: Map<string, (addr: Multiaddr) => Promise<Array<string>>>
-
   /**
    * Returns Multiaddr as a String
    */
@@ -162,6 +160,8 @@ declare class Multiaddr {
 }
 
 declare namespace Multiaddr {
+  const resolvers: Map < string, (addr: Multiaddr) => Promise < Array < string >>>
+
   /**
    * Creates a Multiaddr from a node-friendly address object
    */

src/index.js

@@ -10,6 +10,8 @@ const inspect = Symbol.for('nodejs.util.inspect.custom')
 const uint8ArrayToString = require('uint8arrays/to-string')
 const uint8ArrayEquals = require('uint8arrays/equals')
 
+const resolvers = new Map()
+
 /**
  * Creates a [multiaddr](https://github.com/multiformats/multiaddr) from
  * a Uint8Array, String or another Multiaddr instance
@@ -46,8 +48,6 @@ const Multiaddr = withIs.proto(function (addr) {
   } else {
     throw new Error('addr must be a string, Buffer, or another Multiaddr')
   }
-
-  this.resolvers = new Map()
 }, { className: 'Multiaddr', symbolName: '@multiformats/js-multiaddr/multiaddr' })
 
 /**
@@ -375,8 +375,8 @@ Multiaddr.prototype.equals = function equals (addr) {
  * @param {object} options
  * @returns {Promise<Array<Multiaddr>>}
  * @example
+ * Multiaddr.resolvers.set('dnsaddr', resolverFunction)
  * const mh1 = Multiaddr('/dnsaddr/bootstrap.libp2p.io/p2p/QmbLHAnMoJPWSCR5Zhtx6BHJX9KiKNN6tpvbUcqanj75Nb')
- * mh1.resolvers.set('dnsaddr', resolverFunction)
  * const resolvedMultiaddrs = await mh1.resolve()
  * // [
  * //   <Multiaddr 04934b5353060fa1a503221220c10f9319dac35c270a6b74cd644cb3acfc1f6efc8c821f8eb282599fd1814f64 - /ip4/147.75.83.83/tcp/4001/p2p/QmbLHAnMoJPWSCR5Zhtx6BHJX9KiKNN6tpvbUcqanj75Nb>,
@@ -392,7 +392,7 @@ Multiaddr.prototype.resolve = async function resolve () {
     return [this]
   }
 
-  const resolver = this.resolvers.get(resolvableProto.name)
+  const resolver = resolvers.get(resolvableProto.name)
   if (!resolver) {
     throw errCode(new Error(`no available resolver for ${resolvableProto.name}`), 'ERR_NO_AVAILABLE_RESOLVER')
   }
@@ -551,4 +551,5 @@ Multiaddr.resolve = function resolve (addr) {
   return Promise.reject(new Error('not implemented yet'))
 }
 
+Multiaddr.resolvers = resolvers
 exports = module.exports = Multiaddr

src/resolvers/dns.browser.js

@@ -1,3 +1,11 @@
 'use strict'
 
-module.exports = require('dns').promises
+let dns
+
+try {
+  dns = require('dns').promises
+} catch (err) {
+  dns = require('dns-over-http-resolver')
+}
+
+module.exports = dns

src/resolvers/dns.js

@@ -1,6 +1,9 @@
 'use strict'
 
 const Multiaddr = require('..') // eslint-disable-line  no-unused-vars
+const protocols = require('../protocols-table')
+
+const { code: dnsaddrCode } = protocols('dnsaddr')
 
 /**
  * Resolver for dnsaddr addresses.
@@ -13,7 +16,7 @@ async function dnsaddrResolver (addr) {
   const resolver = new Resolver()
 
   const peerId = addr.getPeerId()
-  const hostname = addr.toString().split('dnsaddr')[1].split('/')[1]
+  const [, hostname] = addr.stringTuples().find(([proto]) => proto === dnsaddrCode) || []
 
   const records = await resolver.resolveTxt(`_dnsaddr.${hostname}`)
   // @ts-ignore

src/resolvers/index.js

@@ -27,17 +27,22 @@ const dnsaddrStub2 = [
 ]
 
 describe('multiaddr resolve', () => {
+  it('should throw if no resolver is available', async () => {
+    const ma = multiaddr('/dnsaddr/bootstrap.libp2p.io')
+
+    // Resolve
+    await expect(ma.resolve()).to.eventually.be.rejected()
+      .and.to.have.property('code', 'ERR_NO_AVAILABLE_RESOLVER')
+  })
+
   describe('dnsaddr', () => {
-    afterEach(() => {
-      sinon.restore()
+    before(() => {
+      // Set resolvers
+      multiaddr.resolvers.set('dnsaddr', resolvers.dnsaddrResolver)
     })
 
-    it('should throw if no resolver is available', async () => {
-      const ma = multiaddr('/dnsaddr/bootstrap.libp2p.io')
-
-      // Resolve
-      await expect(ma.resolve()).to.eventually.be.rejected()
-        .and.to.have.property('code', 'ERR_NO_AVAILABLE_RESOLVER')
+    afterEach(() => {
+      sinon.restore()
     })
 
     it('can resolve dnsaddr without no peerId', async () => {
@@ -47,7 +52,7 @@ describe('multiaddr resolve', () => {
       stub.onCall(0).returns(Promise.resolve(dnsaddrStub1))
 
       // Set resolvers
-      ma.resolvers.set('dnsaddr', resolvers.dnsaddrResolver)
+      // ma.resolvers.set('dnsaddr', resolvers.dnsaddrResolver)
 
       // Resolve
       const resolvedMas = await ma.resolve()
@@ -68,7 +73,7 @@ describe('multiaddr resolve', () => {
       stub.onCall(1).returns(Promise.resolve(dnsaddrStub2))
 
       // Set resolvers
-      ma.resolvers.set('dnsaddr', resolvers.dnsaddrResolver)
+      // ma.resolvers.set('dnsaddr', resolvers.dnsaddrResolver)
 
       // Resolve
       const resolvedMas = await ma.resolve()
@@ -85,12 +90,12 @@ describe('multiaddr resolve', () => {
       stub.onCall(1).returns(Promise.resolve(dnsaddrStub2))
 
       // Set resolvers
-      ma.resolvers.set('dnsaddr', resolvers.dnsaddrResolver)
+      // ma.resolvers.set('dnsaddr', resolvers.dnsaddrResolver)
 
       // Resolve
       const resolvedInitialMas = await ma.resolve()
       const resolvedSecondMas = await Promise.all(resolvedInitialMas.map(nm => {
-        nm.resolvers.set('dnsaddr', resolvers.dnsaddrResolver)
+        //  nm.resolvers.set('dnsaddr', resolvers.dnsaddrResolver)
         return nm.resolve()
       }))
       // @ts-ignore