feat: support http-path in multiaddrs (#53)

Since the `http-path` tuple is now [well specified](https://github.com/multiformats/multiaddr/blob/master/protocols/http-path.md)
we can support parsing paths out of URIs.

Fixes #47

Author: achingbrain

src/index.ts

@@ -69,13 +69,17 @@ export interface MultiaddrFromUriOpts {
 export function uriToMultiaddr (uriStr: string, opts?: MultiaddrFromUriOpts): Multiaddr {
   opts = opts ?? {}
   const defaultDnsType = opts.defaultDnsType ?? 'dns4'
-  const { scheme, hostname, port } = parseUri(uriStr)
+  const { scheme, hostname, port, path } = parseUri(uriStr)
   const parts = [
     tupleForHostname(hostname, defaultDnsType),
     tupleForPort(port, scheme),
     tupleForScheme(scheme)
   ]
 
+  if (path != null) {
+    parts.push(tupleForPath(path))
+  }
+
   const multiaddrStr = '/' + parts
     .filter(x => Boolean(x))
     // @ts-expect-error ts cannot see we filter falsy values
@@ -85,7 +89,7 @@ export function uriToMultiaddr (uriStr: string, opts?: MultiaddrFromUriOpts): Mu
   return multiaddr(multiaddrStr)
 }
 
-function parseUri (uriStr: string): { scheme: string, hostname: string, port: string } {
+function parseUri (uriStr: string): { scheme: string, hostname: string, port: string, path?: string } {
   const [scheme] = uriStr.split(':')
 
   // browsers will only parse URLs with schemes they understand
@@ -94,7 +98,7 @@ function parseUri (uriStr: string): { scheme: string, hostname: string, port: st
   }
 
   // Use the WHATWG URL global, in node >= 10 and the browser
-  let { protocol, hostname, port } = new URL(uriStr)
+  let { protocol, hostname, port, pathname, search } = new URL(uriStr)
 
   if (port == null || port === '') {
     const protocolPort = portForProtocol(scheme)
@@ -110,7 +114,22 @@ function parseUri (uriStr: string): { scheme: string, hostname: string, port: st
     }
   }
 
-  return { scheme, hostname, port }
+  let path: string | undefined
+
+  if (pathname != null && pathname !== '' && pathname !== '/') {
+    if (pathname.startsWith('/')) {
+      pathname = pathname.substring(1)
+    }
+
+    path = pathname
+  }
+
+  if (search != null && search !== '') {
+    path = path ?? ''
+    path += search
+  }
+
+  return { scheme, hostname, port, path }
 }
 
 function tupleForHostname (hostname: string, defaultDnsType: string): [string, string] | undefined {
@@ -158,6 +177,14 @@ function tupleForScheme (scheme: string): [string] | undefined {
   return [scheme]
 }
 
+function tupleForPath (path: string): [string, string] | undefined {
+  if (path == null || path === '') {
+    return undefined
+  }
+
+  return ['http-path', encodeURIComponent(path)]
+}
+
 function portForProtocol (protocol: string): string | undefined {
   if (protocol == null || protocol === '' || portFor[protocol] == null) {
     return undefined

test/test.spec.ts

@@ -27,7 +27,8 @@ describe('uri-to-multiaddr', () => {
       ['/ip4/1.2.3.4/tcp/3456/wss', 'wss://1.2.3.4:3456'],
       ['/ip6/::/tcp/0/ws', 'ws://[::]:0'],
       ['/ip4/1.2.3.4/tcp/3456/wss', 'wss://1.2.3.4:3456'],
-      ['/ip6/::/tcp/0/wss', 'wss://[::]:0']
+      ['/ip6/::/tcp/0/wss', 'wss://[::]:0'],
+      ['/dns4/example.com/tcp/443/wss/http-path/foo', 'wss://example.com:443/foo']
     ]
 
     data.forEach(d => {