Merge pull request #41 from Permissionless-Software-Foundation/ct-unstable

fix(Docker): Increasing memory limit to 1GB

.gitignore

@@ -68,5 +68,6 @@ ipfsdata
 ipfs-service-provider.sh
 start-bch-wallet-service.sh
 data/
+run-dev.sh
 
 !README.md

README.md

@@ -29,14 +29,34 @@ This repository is one step in a longer path. Here are the major milestones of t
 
 ## Installation
 
+### Development Environment
+
+A development environment will allow you modify the code on-the-fly and contribute to the code base of this repository. [PM2](https://www.npmjs.com/package/pm2) is recommended for running this code base as an IPFS Circuit Relay.
+
+- [Video: Installing ipfs-service-provider](https://youtu.be/Z0NsboIVN44)
+- [Step-by-step installation instructions](https://gist.github.com/christroutner/3304a71d4c12a3a3e1664a438f64d9d0)
+
 ```bash
 git clone https://github.com/Permissionless-Software-Foundation/ipfs-bch-wallet-service
 cd ipfs-bch-wallet-service
-sudo npm install -g node-pre-gyp
+./install-mongo-sh
 npm install
-npm start
+./ipfs-bch-wallet-service.sh
 ```
 
+### Production Environment
+
+The [docker](./production/docker) directory contains a Dockerfile for building a production deployment. However, there is currently [a bug](https://github.com/Permissionless-Software-Foundation/ipfs-service-provider/issues/38) preventing the Docker container from being used as a Circuit Relay.
+
+```
+docker-compose build --no-cache
+docker-compose up -d
+```
+
+### Operation Notes
+
+- There is a memory leak in the version of js-ipfs. The app is currently configured to shut down every 8 hours to flush memory. It relies on a process manager like pm2, Docker, or systemd to restart the app after it shuts down, in order to ensure continuous operation.
+
 ## Structure
 
 The file layout of this repository differs from the koa-api-boilerplate. Instead, it follows the file layout of [Clean Architecture](troutsblog.com/blog/clean-architecture).

bin/server.js

@@ -100,6 +100,13 @@ class Server {
       // Attach the other IPFS controllers
       await controllers.attachControllers(app)
 
+      // ipfs-coord has a memory leak. This app shuts down after 4 hours. It
+      // expects to be run by Docker or pm2, which can automatically restart
+      // the app.
+      setTimeout(function () {
+        process.exit(0)
+      }, 60000 * 60 * 2) // 2 hours
+
       return app
     } catch (err) {
       console.error('Could not start server. Error: ', err)

config/env/common.js

@@ -13,6 +13,8 @@ const ipfsCoordName = process.env.COORD_NAME
   ? process.env.COORD_NAME
   : 'ipfs-bch-wallet-service'
 
+console.log('GET_JWT_AT_STARTUP: ', process.env.GET_JWT_AT_STARTUP)
+
 module.exports = {
   // Configure TCP port.
   port: process.env.PORT || 5001,
@@ -32,7 +34,7 @@ module.exports = {
     : 'emailpassword',
 
   // FullStack.cash account information, used for automatic JWT handling.
-  getJwtAtStartup: false,
+  getJwtAtStartup: process.env.GET_JWT_AT_STARTUP ? true : false,
   authServer: process.env.AUTHSERVER
     ? process.env.AUTHSERVER
     : 'https://auth.fullstack.cash',
@@ -48,6 +50,8 @@ module.exports = {
 
   // IPFS settings.
   isCircuitRelay: process.env.ENABLE_CIRCUIT_RELAY ? true : false,
+  // SSL domain used for websocket connection via browsers.
+  crDomain: process.env.CR_DOMAIN ? process.env.CR_DOMAIN : '',
 
   // Information passed to other IPFS peers about this node.
   apiInfo: 'https://ipfs-bch-wallet-service.fullstack.cash/',

package.json

@@ -23,51 +23,52 @@
   },
   "repository": "Permissionless-Software-Foundation/ipfs-bch-wallet-service",
   "dependencies": {
-    "@psf/bch-js": "^4.20.3",
-    "axios": "^0.21.1",
-    "bcryptjs": "^2.4.3",
-    "glob": "^7.1.6",
     "@chris.troutner/ipfs": "2.0.2",
-    "ipfs-coord": "^6.6.4",
-    "jsonrpc-lite": "^2.2.0",
-    "jsonwebtoken": "^8.5.1",
-    "jwt-bch-lib": "^1.3.0",
-    "kcors": "^2.2.2",
-    "koa": "^2.13.1",
-    "koa-bodyparser": "^4.3.0",
-    "koa-convert": "^2.0.0",
-    "koa-generic-session": "^2.1.1",
-    "koa-logger": "^3.2.1",
-    "koa-mount": "^4.0.0",
-    "koa-passport": "^4.1.3",
-    "koa-router": "^10.0.0",
-    "koa-static": "^5.0.0",
-    "koa2-ratelimit": "^0.9.0",
-    "line-reader": "^0.4.0",
-    "mongoose": "^5.11.15",
-    "node-fetch": "npm:@achingbrain/node-fetch@^2.6.7",
-    "nodemailer": "^6.4.17",
-    "passport-local": "^1.0.0",
-    "winston": "^3.3.3",
-    "winston-daily-rotate-file": "^4.5.0"
+    "@psf/bch-js": "4.20.13",
+    "axios": "0.21.1",
+    "bcryptjs": "2.4.3",
+    "glob": "7.1.6",
+    "ipfs-coord": "6.7.2",
+    "jsonrpc-lite": "2.2.0",
+    "jsonwebtoken": "8.5.1",
+    "jwt-bch-lib": "1.3.0",
+    "kcors": "2.2.2",
+    "koa": "2.13.1",
+    "koa-bodyparser": "4.3.0",
+    "koa-convert": "2.0.0",
+    "koa-generic-session": "2.1.1",
+    "koa-logger": "3.2.1",
+    "koa-mount": "4.0.0",
+    "koa-passport": "4.1.3",
+    "koa-router": "10.0.0",
+    "koa-static": "5.0.0",
+    "koa2-ratelimit": "0.9.0",
+    "line-reader": "0.4.0",
+    "mongoose": "5.11.15",
+    "node-fetch": "npm:@achingbrain/node-fetch@2.6.7",
+    "nodemailer": "6.4.17",
+    "passport-local": "1.0.0",
+    "public-ip": "4.0.4",
+    "winston": "3.3.3",
+    "winston-daily-rotate-file": "4.5.0"
   },
   "devDependencies": {
-    "apidoc": "^0.26.0",
-    "chai": "^4.3.0",
-    "coveralls": "^3.1.0",
+    "apidoc": "0.26.0",
+    "chai": "4.3.0",
+    "coveralls": "3.1.0",
     "eslint": "7.19.0",
-    "eslint-config-prettier": "^7.2.0",
-    "eslint-config-standard": "^16.0.2",
-    "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-prettier": "^3.3.1",
-    "eslint-plugin-standard": "^4.0.0",
-    "husky": "^4.3.8",
-    "mocha": "^8.2.1",
-    "nyc": "^15.1.0",
-    "semantic-release": "^17.4.4",
-    "sinon": "^9.2.4",
-    "standard": "^16.0.3",
-    "uuid": "^8.3.2"
+    "eslint-config-prettier": "7.2.0",
+    "eslint-config-standard": "16.0.2",
+    "eslint-plugin-node": "11.1.0",
+    "eslint-plugin-prettier": "3.3.1",
+    "eslint-plugin-standard": "4.0.0",
+    "husky": "4.3.8",
+    "mocha": "8.2.1",
+    "nyc": "15.1.0",
+    "semantic-release": "17.4.4",
+    "sinon": "9.2.4",
+    "standard": "16.0.3",
+    "uuid": "8.3.2"
   },
   "release": {
     "publish": [

production/docker/Dockerfile

@@ -2,32 +2,51 @@
 #
 
 #IMAGE BUILD COMMANDS
-# ct-base-ubuntu = ubuntu 18.04 + nodejs v10 LTS
-FROM christroutner/ct-base-ubuntu:latest
+FROM ubuntu:20.04
 MAINTAINER Chris Troutner <chris.troutner@gmail.com>
 
+#Update the OS and install any OS packages needed.
+RUN apt-get update
+RUN apt-get install -y sudo git curl nano gnupg wget
+
+#Install Node and NPM
+RUN curl -sL https://deb.nodesource.com/setup_14.x -o nodesource_setup.sh
+RUN bash nodesource_setup.sh
+RUN apt-get install -y nodejs build-essential
+
 #Create the user 'safeuser' and add them to the sudo group.
-#RUN useradd -ms /bin/bash safeuser
-#RUN adduser safeuser sudo
+RUN useradd -ms /bin/bash safeuser
+RUN adduser safeuser sudo
 
 #Set password to 'password' change value below if you want a different password
-#RUN echo safeuser:password | chpasswd
+RUN echo safeuser:password | chpasswd
 
 #Set the working directory to be the home directory
 WORKDIR /home/safeuser
 
 #Setup NPM for non-root global install
-#RUN mkdir /home/safeuser/.npm-global
-#RUN chown -R safeuser .npm-global
-#RUN echo "export PATH=~/.npm-global/bin:$PATH" >> /home/safeuser/.profile
-#RUN runuser -l safeuser -c "npm config set prefix '~/.npm-global'"
+RUN mkdir /home/safeuser/.npm-global
+RUN chown -R safeuser .npm-global
+RUN echo "export PATH=~/.npm-global/bin:$PATH" >> /home/safeuser/.profile
+RUN runuser -l safeuser -c "npm config set prefix '~/.npm-global'"
+
+# Update to the latest version of npm.
+# Working with npm@7.21.1
+RUN npm install -g npm
+
+# Update to the latest version of npm.
+# Working with npm@7.21.1
+RUN npm install -g npm@7.23.0
+
+# npm mirror to prevent direct dependency on npm.
+RUN npm set registry http://94.130.170.209:4873/
 
 # Switch to user account.
 #USER safeuser
 # Prep 'sudo' commands.
 #RUN echo 'abcd8765' | sudo -S pwd
 
-# Clone the rest.bitcoin.com repository
+# Clone the repository
 WORKDIR /home/safeuser
 RUN git clone https://github.com/Permissionless-Software-Foundation/ipfs-bch-wallet-service
 
@@ -39,7 +58,7 @@ WORKDIR /home/safeuser/ipfs-bch-wallet-service
 RUN git checkout ct-unstable
 
 # Install dependencies
-RUN npm install -g @mapbox/node-pre-gyp
+#RUN npm install -g @mapbox/node-pre-gyp
 RUN npm install
 
 # Generate the API docs

production/docker/docker-compose.yml

@@ -20,6 +20,7 @@ services:
       options:
         max-size: '10m'
         max-file: '10'
+    mem_limit: 1000mb
     links:
       - bch-wallet-mongodb
     ports:
@@ -28,4 +29,4 @@ services:
       - '5668:5668' # IPFS TCP Port
       - '5669:5669' # IPFS WS Port
     volumes:
-      - ../data/ipfsdata:/home/safeuser/ipfs-service-provider/.ipfsdata
+      - ../data/ipfsdata:/home/safeuser/ipfs-bch-wallet-service/.ipfsdata

production/docker/start-production.sh

@@ -4,13 +4,17 @@
 
 # This mnemonic is used to set up persistent public key for e2ee
 # Replace this with your own 12-word mnemonic.
+# You can get one at https://wallet.fullstack.cash.
 export MNEMONIC="olive two muscle bottom coral ancient wait legend bronze useful process session"
 
 # The human readable name this IPFS node identifies as.
-export COORD_NAME=ipfs-service-provider-generic
+export COORD_NAME=bch-wallet-service-generic
 
 # Allow this node to function as a circuit relay. It must not be behind a firewall.
 #export ENABLE_CIRCUIT_RELAY=true
+# For browsers to use your circuit realy, you must set up a domain, SSL certificate,
+# and you must forward that subdomain to the IPFS_WS_PORT.
+#export CR_DOMAIN=subdomain.yourdomain.com
 
 # Debug level. 0 = minimal info. 2 = max info.
 export DEBUG_LEVEL=1
@@ -22,6 +26,7 @@ export DEBUG_LEVEL=1
 export DBURL=mongodb://172.17.0.1:5555/ipfs-service-prod
 
 # Customize these environment variables for your own installation.
+export GET_JWT_AT_STARTUP=1
 export AUTHSERVER=https://auth.fullstack.cash
 export APISERVER=https://api.fullstack.cash/v5/
 export FULLSTACKLOGIN=demo@demo.com

shell-scripts/ipfs-bch-wallet-service.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+
+# This script is an example for running a generic ipfs-service-provider instance.
+
+# Ports
+export PORT=5001 # REST API port
+export IPFS_TCP_PORT=5268
+export IPFS_WS_PORT=5269
+
+# The human-readible name that is used when displaying data about this node.
+export COORD_NAME=ipfs-service-provider-generic
+
+# This is used for end-to-end encryption (e2ee).
+export MNEMONIC="churn aisle shield silver ladder swear hunt slim pen demand spoil veteran"
+
+# 0 = less verbose. 3 = most verbose
+export DEBUG_LEVEL=1
+
+# MongoDB connection string.
+#export DBURL=mongodb://localhost:27017/bch-service-dev
+
+npm start

shell-scripts/ipfs-service-provider-generic.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+
+# This script is an example for running a generic ipfs-service-provider instance.
+
+# Ports
+export PORT=5001 # REST API port
+export IPFS_TCP_PORT=5268
+export IPFS_WS_PORT=5269
+
+# The human-readible name that is used when displaying data about this node.
+export COORD_NAME=ipfs-service-provider-generic
+
+# This is used for end-to-end encryption (e2ee).
+export MNEMONIC="churn aisle shield silver ladder swear hunt slim pen demand spoil veteran"
+
+# 0 = less verbose. 3 = most verbose
+export DEBUG_LEVEL=1
+
+# MongoDB connection string.
+#export DBURL=mongodb://localhost:27017/bch-service-dev
+
+npm start

shell-scripts/ipfs-service-provider-relay.sh

@@ -0,0 +1,31 @@
+#!/bin/bash
+
+# This script is an example for running a ipfs-service-provider as a Circuit Relay.
+# Circuit Relays are help other nodes on the network communicate. They are
+# critical for reliable functioning of the network, and for circumventing
+# censorship.
+
+# Ports
+export PORT=5001 # REST API port
+export IPFS_TCP_PORT=5268
+export IPFS_WS_PORT=5269
+
+# The human-readible name that is used when displaying data about this node.
+export COORD_NAME=ipfs-service-provider-generic
+
+# This is used for end-to-end encryption (e2ee).
+export MNEMONIC="churn aisle shield silver ladder swear hunt slim pen demand spoil veteran"
+
+# 0 = less verbose. 3 = most verbose
+export DEBUG_LEVEL=1
+
+# MongoDB connection string.
+#export DBURL=mongodb://localhost:27017/bch-service-dev
+
+# Comment to disable circuit relay functionality. Or set to 1 to enable.
+export ENABLE_CIRCUIT_RELAY=1
+# For browsers to use your circuit realy, you must set up a domain, SSL certificate,
+# and you must forward that subdomain to the IPFS_WS_PORT.
+#export CR_DOMAIN=subdomain.yourdomain.com
+
+npm start

src/adapters/index.js

@@ -43,6 +43,8 @@ class Adapters {
         await this.fullStackJwt.getJWT()
         // Instantiate bch-js with the JWT token, and overwrite the placeholder for bch-js.
         this.bchjs = await this.fullStackJwt.instanceBchjs()
+      } else {
+        this.bchjs = new BCHJS({ restURL: this.config.apiServer })
       }
 
       // Start the IPFS node.

src/adapters/ipfs/index.js

@@ -10,6 +10,7 @@ class IPFS {
     // Encapsulate dependencies
     this.ipfsAdapter = new IpfsAdapter()
     this.IpfsCoordAdapter = IpfsCoordAdapter
+    this.process = process
 
     this.ipfsCoordAdapter = {} // placeholder
 
@@ -50,7 +51,7 @@ class IPFS {
       // If error is due to a lock file issue. Kill the process, so that
       // Docker or pm2 has a chance to restart the service.
       if (err.message.includes('Lock already being held')) {
-        process.exit(1)
+        this.process.exit(1)
       }
 
       throw err

src/adapters/ipfs/ipfs-coord.js

@@ -7,6 +7,7 @@
 // Global npm libraries
 const IpfsCoord = require('ipfs-coord')
 // const BCHJS = require('@psf/bch-js')
+const publicIp = require('public-ip')
 
 // Local libraries
 const config = require('../../../config')
@@ -35,6 +36,7 @@ class IpfsCoordAdapter {
     this.ipfsCoord = {}
     // this.rpc = new JSONRPC()
     this.config = config
+    this.publicIp = publicIp
 
     // Properties of this class instance.
     this.isReady = false
@@ -43,7 +45,23 @@ class IpfsCoordAdapter {
   }
 
   async start (localConfig = {}) {
-    // console.log('this.config.announceJsonLd: ', this.config.announceJsonLd)
+    const circuitRelayInfo = {}
+
+    // If configured as a Circuit Relay, get the public IP addresses for this node.
+    if (this.config.isCircuitRelay) {
+      try {
+        const ip4 = await this.publicIp.v4()
+        // const ip6 = await publicIp.v6()
+
+        circuitRelayInfo.ip4 = ip4
+        circuitRelayInfo.tcpPort = this.config.ipfsTcpPort
+
+        // Domain used by browser-based secure websocket connections.
+        circuitRelayInfo.crDomain = this.config.crDomain
+      } catch (err) {
+        /* exit quietly */
+      }
+    }
 
     this.ipfsCoord = new this.IpfsCoord({
       ipfs: this.ipfs,
@@ -52,6 +70,7 @@ class IpfsCoordAdapter {
       bchjs: this.bchjs,
       privateLog: console.log, // Default to console.log
       isCircuitRelay: this.config.isCircuitRelay,
+      circuitRelayInfo,
       apiInfo: this.config.apiInfo,
       announceJsonLd: this.config.announceJsonLd,
       mnemonic: this.config.mnemonic,

src/adapters/ipfs/ipfs.js

@@ -2,6 +2,10 @@
   Clean Architecture Adapter for IPFS.
   This library deals with IPFS so that the apps business logic doesn't need
   to have any specific knowledge of the js-ipfs library.
+
+  TODO: Add the external IP address to the list of multiaddrs advertised by
+  this node. See this GitHub Issue for details:
+  https://github.com/Permissionless-Software-Foundation/ipfs-service-provider/issues/38
 */
 
 // Global npm libraries
@@ -32,7 +36,7 @@ class IpfsAdapter {
           relay: {
             enabled: true, // enable circuit relay dialer and listener
             hop: {
-              enabled: true // enable circuit relay HOP (make this node a relay)
+              enabled: config.isCircuitRelay // enable circuit relay HOP (make this node a relay)
             }
           },
           pubsub: true, // enable pubsub
@@ -57,6 +61,10 @@ class IpfsAdapter {
       // Set the 'server' profile so the node does not scan private networks.
       await this.ipfs.config.profiles.apply('server')
 
+      // Debugging: Display IPFS config settings.
+      // const configSettings = await this.ipfs.config.getAll()
+      // console.log(`configSettings: ${JSON.stringify(configSettings, null, 2)}`)
+
       // Signal that this adapter is ready.
       this.isReady = true
 
@@ -69,6 +77,8 @@ class IpfsAdapter {
 
   async stop () {
     await this.ipfs.stop()
+
+    return true
   }
 }
 

src/controllers/index.js

@@ -26,18 +26,9 @@ class Controllers {
   }
 
   async attachControllers (app) {
-    // Get a JWT token and instantiate bch-js with it. Then pass that instance
-    // to all the rest of the apps controllers and adapters.
-    await this.adapters.fullStackJwt.getJWT()
-    // Instantiate bch-js with the JWT token, and overwrite the placeholder for bch-js.
-    this.adapters.bchjs = await this.adapters.fullStackJwt.instanceBchjs()
-
     // Wait for any startup processes to complete for the Adapters libraries.
     await this.adapters.start()
 
-    // Attach the REST controllers to the Koa app.
-    // this.attachRESTControllers(app)
-
     this.attachRPCControllers()
   }
 

src/controllers/json-rpc/index.js

@@ -58,7 +58,7 @@ class JSONRPC {
         wlogger.info(
           'Warning: Can not send JSON RPC response. Can not determine which peer this message came from.'
         )
-        return
+        return false
       }
 
       // Attempt to parse the incoming data as a JSON RPC string.
@@ -68,22 +68,24 @@ class JSONRPC {
       // Exit quietly if the incoming string is an invalid JSON RPC string.
       if (parsedData.type === 'invalid') {
         wlogger.info('Rejecting invalid JSON RPC command.')
-        return
+        return false
       }
 
       // Check for duplicate entries with same 'id' value.
       const alreadyProcessed = _this._checkIfAlreadyProcessed(parsedData)
       if (alreadyProcessed) {
-        return
+        return false
       } else {
+        // console.log(`parsedData: ${JSON.stringify(parsedData, null, 2)}`)
+
         // This node will regularly ping known circuit relays with an /about
         // JSON RPC call. These will be handled by ipfs-coord, but will percolate
-        // up to ipfs-coord. Ignore these messages.
+        // up to this library. Ignore these messages.
         if (
           parsedData.type.includes('success') &&
           parsedData.payload.method === undefined
         ) {
-          return
+          return false
         }
 
         // Log the incoming JSON RPC command.
@@ -156,6 +158,8 @@ class JSONRPC {
   // If the ID is new, the function adds it to the cache and return false.
   _checkIfAlreadyProcessed (data) {
     try {
+      // console.log('data: ', data)
+
       const id = data.payload.id
 
       // Check if the hash is in the array of already processed message.
@@ -175,7 +179,7 @@ class JSONRPC {
       return alreadyProcessed
     } catch (err) {
       console.error('Error in _checkIfAlreadyProcessed: ', err)
-      return false
+      return true
     }
   }
 

test/e2e/manual/consumer/lib/test-utils.js

@@ -5,7 +5,7 @@
 // Public npm libraries
 const BCHJS = require('@psf/bch-js')
 const IpfsCoord = require('ipfs-coord')
-const IPFS = require('ipfs')
+const IPFS = require('@chris.troutner/ipfs')
 const EventEmitter = require('events')
 const { v4: uid } = require('uuid')
 const jsonrpc = require('jsonrpc-lite')

test/e2e/manual/consumer/test-data.json

@@ -1,4 +1,4 @@
 {
-  "uutAddr": "/ip4/127.0.0.1/tcp/5701/p2p/QmWkjYRRTaxVEuGK8ip2X3trVyJShFs6U9g1h9x6fK5mZ2",
-  "uutId": "QmWkjYRRTaxVEuGK8ip2X3trVyJShFs6U9g1h9x6fK5mZ2"
+  "uutAddr": "/ip4/127.0.0.1/tcp/5268/p2p/QmdBGB8S6sEr19gaAxJYjhRbz5ZmMiH5a1JyyMmaxcRKnY",
+  "uutId": "QmdBGB8S6sEr19gaAxJYjhRbz5ZmMiH5a1JyyMmaxcRKnY"
 }

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

@@ -62,6 +62,20 @@ describe('#IPFS', () => {
 
       assert.equal(result, true)
     })
+
+    it('should get the public IP address if this node is a Circuit Relay', async () => {
+      // Mock dependencies.
+      uut.IpfsCoord = IPFSCoordMock
+      sandbox.stub(uut.publicIp, 'v4').returns('123')
+
+      // Force Circuit Relay
+      uut.config.isCircuitRelay = true
+
+      const result = await uut.start()
+      // console.log('result: ', result)
+
+      assert.equal(result, true)
+    })
   })
 
   describe('#attachRPCRouter', () => {
@@ -86,16 +100,19 @@ describe('#IPFS', () => {
       uut.attachRPCRouter(router)
     })
 
-    // it('should throw an error if ipfs-coord has not been instantiated', () => {
-    //   try {
-    //     const router = console.log
-    //
-    //     uut.attachRPCRouter(router)
-    //
-    //     assert.fail('Unexpected code path')
-    //   } catch (err) {
-    //     assert.include(err.message, 'Cannot read property')
-    //   }
-    // })
+    it('should catch and throw an error', () => {
+      try {
+        // Force an error
+        delete uut.ipfsCoord.adapters
+
+        const router = console.log
+
+        uut.attachRPCRouter(router)
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        assert.include(err.message, 'Cannot read property')
+      }
+    })
   })
 })

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

@@ -4,6 +4,7 @@
 
 const assert = require('chai').assert
 const sinon = require('sinon')
+const BCHJS = require('@psf/bch-js')
 
 const IPFSLib = require('../../../src/adapters/ipfs')
 const IPFSMock = require('../mocks/ipfs-mock')
@@ -12,9 +13,11 @@ const IPFSCoordMock = require('../mocks/ipfs-coord-mock')
 describe('#IPFS-adapter-index', () => {
   let uut
   let sandbox
+  let bchjs
 
   beforeEach(() => {
-    uut = new IPFSLib()
+    bchjs = new BCHJS()
+    uut = new IPFSLib({ bchjs })
 
     sandbox = sinon.createSandbox()
   })
@@ -59,5 +62,23 @@ describe('#IPFS-adapter-index', () => {
         assert.include(err.message, 'test error')
       }
     })
+
+    it('should handle lock-file errors', async () => {
+      try {
+        // Force an error
+        sandbox
+          .stub(uut.ipfsAdapter, 'start')
+          .rejects(new Error('Lock already being held'))
+
+        // Prevent process from exiting
+        sandbox.stub(uut.process, 'exit').returns()
+
+        await uut.start({ bchjs })
+
+        assert.fail('Unexpected code path.')
+      } catch (err) {
+        assert.include(err.message, 'Lock already being held')
+      }
+    })
   })
 })

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

@@ -47,4 +47,17 @@ describe('#IPFS-adapter', () => {
       }
     })
   })
+
+  describe('#stop', () => {
+    it('should stop the IPFS node', async () => {
+      // Mock dependencies
+      uut.ipfs = {
+        stop: () => {}
+      }
+
+      const result = await uut.stop()
+
+      assert.equal(result, true)
+    })
+  })
 })

test/unit/controllers/controllers.unit.js

@@ -45,9 +45,7 @@ describe('#Controllers', () => {
     it('should catch and throw errors', async () => {
       try {
         // Force an error
-        sandbox
-          .stub(uut.adapters.fullStackJwt, 'getJWT')
-          .rejects(new Error('test error'))
+        sandbox.stub(uut.adapters, 'start').rejects(new Error('test error'))
 
         const app = {
           use: () => {}

test/unit/controllers/json-rpc/json-rpc.controller.unit.js

@@ -207,5 +207,120 @@ describe('#JSON RPC', () => {
       assert.equal(obj.result.method, 'bch')
       assert.equal(obj.id, id)
     })
+
+    it('should exit quietly for duplicate RPC message', async () => {
+      const id = uid()
+      const json = jsonrpc.request(id, 'unknownMethod', {})
+
+      const str = JSON.stringify(json)
+
+      // Call router once.
+      await uut.router(str, 'peerA')
+
+      // Call the router again with the same input.
+      const result = await uut.router(str, 'peerA')
+
+      assert.equal(result, false)
+    })
+
+    it('should ignore metric queries from ipfs-coord', async () => {
+      const id = uid()
+      const json = jsonrpc.request(id, 'unknownMethod', {})
+
+      const str = JSON.stringify(json)
+
+      // Force the RPC type to be 'success', to indicate an RPC that was
+      // processed internal to ipfs-coord.
+      sandbox.stub(uut.jsonrpc, 'parse').returns({
+        payload: {},
+        type: 'success'
+      })
+
+      // Call the router again with the same input.
+      const result = await uut.router(str, 'peerA')
+
+      assert.equal(result, false)
+    })
+
+    it('should report errors when trying to send messages to peers', async () => {
+      const id = uid()
+      const json = jsonrpc.request(id, 'unknownMethod', {})
+
+      const str = JSON.stringify(json)
+
+      // Force issue with sendPrivateMessage()
+      sandbox
+        .stub(uut.ipfsCoord.useCases.peer, 'sendPrivateMessage')
+        .rejects('test error')
+
+      // Call the router again with the same input.
+      const result = await uut.router(str, 'peerA')
+      // console.log('result: ', result)
+
+      assert.property(result, 'from')
+      assert.property(result, 'retStr')
+    })
+  })
+
+  describe('#_checkIfAlreadyProcessed', () => {
+    it('should return false the first time an RPC command is seen', () => {
+      const data = {
+        payload: {
+          jsonrpc: '2.0',
+          id: '6c515f3c-cf8a-42ec-870e-e416edd4923f',
+          method: 'unknownMethod',
+          params: {}
+        },
+        type: 'request'
+      }
+
+      const result = uut._checkIfAlreadyProcessed(data)
+
+      assert.equal(result, false)
+    })
+
+    it('should return true the second time an RPC command is seen', () => {
+      const data = {
+        payload: {
+          jsonrpc: '2.0',
+          id: '6c515f3c-cf8a-42ec-870e-e416edd4923f',
+          method: 'unknownMethod',
+          params: {}
+        },
+        type: 'request'
+      }
+
+      // First call.
+      uut._checkIfAlreadyProcessed(data)
+
+      // Second call.
+      const result = uut._checkIfAlreadyProcessed(data)
+
+      assert.equal(result, true)
+    })
+
+    it('should push out old data from the cache for new data', () => {
+      const data = {
+        payload: {
+          jsonrpc: '2.0',
+          id: '6c515f3c-cf8a-42ec-870e-e416edd4923f',
+          method: 'unknownMethod',
+          params: {}
+        },
+        type: 'request'
+      }
+
+      uut.MSG_CACHE_SIZE = 0
+
+      const result = uut._checkIfAlreadyProcessed(data)
+
+      assert.equal(result, false)
+    })
+
+    it('should return true on error', () => {
+      const result = uut._checkIfAlreadyProcessed()
+
+      assert.equal(result, true)
+    })
   })
 })

test/unit/mocks/adapters/index.js

@@ -7,7 +7,13 @@ const ipfs = {
     ipfs: {}
   },
   ipfsCoordAdapter: {
-    ipfsCoord: {}
+    ipfsCoord: {
+      useCases: {
+        peer: {
+          sendPrivateMessage: () => {}
+        }
+      }
+    }
   }
 }