fix(brave): no port collisions

Before starting embedded js-ipfs we now check if API and Gateway ports are free.
If not, we find available ones and update the config.

This way user does not need to deal with "port taken" errors and
embedded node provides seamless experience without surprises.

Author: lidel

add-on/src/lib/ipfs-client/embedded-chromesockets.js

@@ -16,18 +16,16 @@ const Ipfs = require('ipfs')
 const HttpApi = require('ipfs/src/http')
 const multiaddr = require('multiaddr')
 const maToUri = require('multiaddr-to-uri')
+const getPort = require('get-port')
 
 const { optionDefaults } = require('../options')
 
 // js-ipfs with embedded hapi HTTP server
 let node = null
 let nodeHttpApi = null
 
-exports.init = function init (opts) {
-  log('init embedded:chromesockets')
-
+async function buildConfig (opts) {
   const defaultOpts = JSON.parse(optionDefaults.ipfsNodeConfig)
-
   defaultOpts.libp2p = {
     config: {
       dht: {
@@ -36,9 +34,31 @@ exports.init = function init (opts) {
       }
     }
   }
-
   const userOpts = JSON.parse(opts.ipfsNodeConfig)
-  const ipfsOpts = mergeOptions.call({ concatArrays: true }, defaultOpts, userOpts, { start: false })
+  const ipfsNodeConfig = mergeOptions.call({ concatArrays: true }, defaultOpts, userOpts, { start: false })
+
+  // Detect when API or Gateway port is not available (taken by something else)
+  // We find the next free port and update configuration to use it instead
+  const multiaddr2port = (ma) => parseInt(new URL(multiaddr2httpUrl(ma)).port, 10)
+  const gatewayPort = multiaddr2port(ipfsNodeConfig.config.Addresses.Gateway)
+  const apiPort = multiaddr2port(ipfsNodeConfig.config.Addresses.API)
+  log(`checking if ports are available: api: ${apiPort}, gateway: ${gatewayPort}`)
+  const freeGatewayPort = await getPort({ port: getPort.makeRange(gatewayPort, gatewayPort + 100) })
+  const freeApiPort = await getPort({ port: getPort.makeRange(apiPort, apiPort + 100) })
+  if (gatewayPort !== freeGatewayPort || apiPort !== freeApiPort) {
+    log(`updating config to available ports: api: ${freeApiPort}, gateway: ${freeGatewayPort}`)
+    const addrs = ipfsNodeConfig.config.Addresses
+    addrs.Gateway = addrs.Gateway.replace(gatewayPort.toString(), freeGatewayPort.toString())
+    addrs.API = addrs.API.replace(apiPort.toString(), freeApiPort.toString())
+  }
+
+  return ipfsNodeConfig
+}
+
+exports.init = async function init (opts) {
+  log('init embedded:chromesockets')
+
+  const ipfsOpts = await buildConfig(opts)
   log('creating js-ipfs with opts: ', ipfsOpts)
   node = new Ipfs(ipfsOpts)
 
@@ -90,9 +110,9 @@ async function updateConfigWithHttpEndpoints (ipfs, opts) {
       ipfsApiUrl: httpApi,
       ipfsNodeConfig: JSON.stringify(ipfsNodeConfig, null, 2)
     }
-    // update current runtime config (in place, effective without restart)
+    // update current runtime config (in place)
     Object.assign(opts, configChanges)
-    // update user config in storage (effective on next run)
+    // update user config in storage (triggers async client restart if ports changed)
     log(`synchronizing ipfsNodeConfig with customGatewayUrl (${configChanges.customGatewayUrl}) and ipfsApiUrl (${configChanges.ipfsApiUrl})`)
     await browser.storage.local.set(configChanges)
   }

package.json

@@ -123,6 +123,7 @@
     "drag-and-drop-files": "0.0.1",
     "file-type": "11.1.0",
     "filesize": "4.1.2",
+    "get-port": "5.0.0",
     "http-dns": "3.0.1",
     "http-node": "1.2.0",
     "ipfs": "https://github.com/lidel/js-ipfs/tarball/4081cbd69a252ec8adcec1e965724246669c9e9f/js-ipfs.tar.gz",

yarn.lock

@@ -5613,6 +5613,13 @@ get-iterator@^1.0.0:
   resolved "https://registry.yarnpkg.com/get-iterator/-/get-iterator-1.0.1.tgz#8a284d9b4df9213269c56646dbedb5a90996595f"
   integrity sha512-syV4W5X/I+HlT/RsqTwJ23P95JtaoD10EthArBIgWqxO8jtBqf2k2eNzye2cxvVLeOmz08Ya4wyv7vzCDtx6MQ==
 
+[email protected]:
+  version "5.0.0"
+  resolved "https://registry.yarnpkg.com/get-port/-/get-port-5.0.0.tgz#aa22b6b86fd926dd7884de3e23332c9f70c031a6"
+  integrity sha512-imzMU0FjsZqNa6BqOjbbW6w5BivHIuQKopjpPqcnx0AVHJQKCxK1O+Ab3OrVXhrekqfVMjwA9ZYu062R+KcIsQ==
+  dependencies:
+    type-fest "^0.3.0"
+
 get-port@^4.0.0:
   version "4.0.0"
   resolved "https://registry.yarnpkg.com/get-port/-/get-port-4.0.0.tgz#373c85960138ee20027c070e3cb08019fea29816"
@@ -13895,6 +13902,11 @@ [email protected], type-detect@^4.0.0, type-detect@^4.0.5:
   resolved "https://registry.yarnpkg.com/type-detect/-/type-detect-4.0.8.tgz#7646fb5f18871cfbb7749e69bd39a6388eb7450c"
   integrity sha512-0fr/mIH1dlO+x7TlcMy+bIDqKPsw/70tVyeHW787goQjhmqaZe10uwLujubK9q9Lg6Fiho1KUKDYz0Z7k7g5/g==
 
+type-fest@^0.3.0:
+  version "0.3.1"
+  resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-0.3.1.tgz#63d00d204e059474fe5e1b7c011112bbd1dc29e1"
+  integrity sha512-cUGJnCdr4STbePCgqNFbpVNCepa+kAVohJs1sLhxzdH+gnEoOd8VhbYa7pD3zZYGiURWM2xzEII3fQcRizDkYQ==
+
 type-fest@^0.4.1:
   version "0.4.1"
   resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-0.4.1.tgz#8bdf77743385d8a4f13ba95f610f5ccd68c728f8"