Merge pull request #3 from tableflip/always-add-port

fix: add default port for protocol

Author: olizilla

README.md

@@ -2,7 +2,7 @@
 
 [![Build Status](https://travis-ci.org/tableflip/uri-to-multiaddr.svg?branch=master)](https://travis-ci.org/tableflip/uri-to-multiaddr) [![dependencies Status](https://david-dm.org/tableflip/uri-to-multiaddr/status.svg)](https://david-dm.org/tableflip/uri-to-multiaddr) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
 
-> Convert a URI to a [Multiaddr](https://multiformats.io/multiaddr/): https://protocol.ai -> /dns4/protocol.ai/https
+> Convert a URI to a [Multiaddr](https://multiformats.io/multiaddr/): https://protocol.ai -> /dns4/protocol.ai/tcp/443/https
 
 ## Install
 
@@ -16,7 +16,7 @@ npm install uri-to-multiaddr
 const toMultiaddr = require('uri-to-multiaddr')
 
 console.log(toMultiaddr('https://protocol.ai'))
-// -> /dns4/protocol.ai/https
+// -> /dns4/protocol.ai/tcp/443/https
 ```
 
 Domain names can represent one of
@@ -32,15 +32,15 @@ in an options object as the second parameter to override it:
 ```js
 const toMultiaddr = require('uri-to-multiaddr')
 
-console.log(toMultiaddr('https://protocol.ai'), {defaultDnsType: 'dnsaddr'})
-// -> /dnsaddr/protocol.ai/https
+console.log(toMultiaddr('https://protocol.ai'), { defaultDnsType: 'dns6' })
+// -> /dns6/protocol.ai/tcp/443/https
 ```
 
 See [test.js](./test.js) for the currently supported conversions.
 
 **Note**: `uri-to-multiaddr` will throw if the passed URI:
   - is not a valid, according the WHATWG URL spec implementation used.
-  - is not supported yet e.g. quic
+  - is not supported yet
 
 ## Related
 

index.js

@@ -1,13 +1,12 @@
-const url = require('url')
 const isIp = require('is-ip')
 const Multiaddr = require('multiaddr')
 
 /**
  * Convert a URI to a multiaddr
  *
- *        http://foobar.com => /dns4/foobar.com/https
- *  https://foobar.com:8080 => /dns4/foobar.com/tcp/8080/https
- *          ws://foobar.com => /dns4/foobar.com/ws
+ *        http://foobar.com => /dns4/foobar.com/tcp/80/http
+ *       https://foobar.com => /dns4/foobar.com/tcp/443/https
+ *  https://foobar.com:5001 => /dns4/foobar.com/tcp/5001/https
  *   https://127.0.0.1:8080 => /ip4/127.0.0.1/tcp/8080/https
  *        http://[::1]:8080 => /ip6/::1/tcp/8080/http
  *    tcp://foobar.com:8080 => /dns4/foobar.com/tcp/8080
@@ -33,15 +32,16 @@ function multiaddrFromUri (uriStr, opts) {
 
 function parseUri (uriStr) {
   // Use the WHATWG URL global, in node >= 10 and the browser
-  const { protocol, hostname } = new URL(uriStr)
-  // WHATWG URL hides port when it's the default for the scheme...
-  const port = url.parse(uriStr).port
+  let { protocol, hostname, port } = new URL(uriStr)
   const scheme = protocol.slice(0, -1)
+  if (!port && port !== 0) {
+    port = portForProtocol(scheme)
+  }
   return { scheme, hostname, port }
 }
 
 function tupleForHostname (hostname, defaultDnsType) {
-  if (!hostname) throw new Error('hostname is requried')
+  if (!hostname) return null
   if (isIp.v4(hostname)) {
     return ['ip4', hostname]
   }
@@ -69,10 +69,21 @@ function tupleForPort (port, scheme) {
 }
 
 function tupleForScheme (scheme) {
-  if (scheme.match(/^https?$|^wss?$/)) {
-    return [scheme]
+  if (scheme.match(/^tcp$|^udp$/)) {
+    return null
+  }
+  return [scheme]
+}
+
+function portForProtocol (protocol) {
+  if (!protocol) return null
+  const portFor = {
+    http: '80',
+    https: '443',
+    ws: '80',
+    wss: '443'
   }
-  return null
+  return portFor[protocol]
 }
 
 module.exports = multiaddrFromUri

package-lock.json

@@ -6,7 +6,7 @@
   "dependencies": {
     "ava": "^0.25.0",
     "is-ip": "^2.0.0",
-    "multiaddr": "^5.0.0"
+    "multiaddr": "^6.0.3"
   },
   "devDependencies": {
     "standard": "^12.0.1"

package.json

@@ -3,8 +3,8 @@ const toMultiaddr = require('./')
 
 test('should convert URIs to multiaddrs', (t) => {
   const data = [
-    ['/ip4/127.0.0.1/http', 'http://127.0.0.1'],
-    ['/ip6/fc00::/http', 'http://[fc00::]'],
+    ['/ip4/127.0.0.1/tcp/80/http', 'http://127.0.0.1'],
+    ['/ip6/fc00::/tcp/80/http', 'http://[fc00::]'],
     ['/ip4/0.0.7.6/tcp/1234', 'tcp://0.0.7.6:1234'],
     ['/ip4/0.0.7.6/tcp/1234/http', 'http://0.0.7.6:1234'],
     ['/ip4/0.0.7.6/tcp/1234/https', 'https://0.0.7.6:1234'],
@@ -14,17 +14,22 @@ test('should convert URIs to multiaddrs', (t) => {
     ['/dns4/protocol.ai/tcp/80', 'tcp://protocol.ai:80'],
     ['/dns4/protocol.ai/tcp/80/http', 'http://protocol.ai:80'],
     ['/dns4/protocol.ai/tcp/80/https', 'https://protocol.ai:80'],
-    ['/dns4/ipfs.io/ws', 'ws://ipfs.io'],
-    ['/dns4/ipfs.io/http', 'http://ipfs.io'],
-    ['/dns4/ipfs.io/https', 'https://ipfs.io'],
+    ['/dns4/ipfs.io/tcp/80/ws', 'ws://ipfs.io'],
+    ['/dns4/ipfs.io/tcp/443/wss', 'wss://ipfs.io'],
+    ['/dns4/ipfs.io/tcp/80/http', 'http://ipfs.io'],
+    ['/dns4/ipfs.io/tcp/443/https', 'https://ipfs.io'],
     ['/ip4/1.2.3.4/tcp/3456/ws', 'ws://1.2.3.4:3456'],
+    ['/ip4/1.2.3.4/tcp/3456/wss', 'wss://1.2.3.4:3456'],
     ['/ip6/::/tcp/0/ws', 'ws://[::]:0'],
-    ['/dns4/ipfs.io/wss', 'wss://ipfs.io'],
     ['/ip4/1.2.3.4/tcp/3456/wss', 'wss://1.2.3.4:3456'],
     ['/ip6/::/tcp/0/wss', 'wss://[::]:0']
   ]
-
-  data.forEach(d => t.is(toMultiaddr(d[1]).toString(), d[0], `Converts ${d[1]} to ${d[0]}`))
+  data.forEach(d => {
+    const input = d[1]
+    const expected = d[0]
+    const output = toMultiaddr(input).toString()
+    t.is(output, expected, `Converts ${input} to ${expected}`)
+  })
 })
 
 test('should use the defaultDnsType where provided', (t) => {
@@ -37,6 +42,15 @@ test('should use the defaultDnsType where provided', (t) => {
   data.forEach(d => t.is(toMultiaddr(d[1], d[2]).toString(), d[0], `Converts ${d[1]} to ${d[0]} with opts ${d[2]}`))
 })
 
-test('should throw for unsupported protocol', (t) => {
-  t.throws(() => toMultiaddr('quic://'))
+test('should throw for on invalid url', (t) => {
+  t.throws(() => {
+    toMultiaddr('whoosh.fast')
+  }, /Invalid URL/)
+})
+
+test('should throw for unknown protocol', (t) => {
+  t.throws(() => {
+    // NOTE: `data` is a valid uri protocol but isn't a valid multiaddr protocol yet
+    toMultiaddr('data:image/svg+xml;base64,test')
+  }, 'no protocol with name: data')
 })