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

fix(memory-leak): Resetting app after 8 hours

.gitignore

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

README.md

@@ -78,3 +78,5 @@ Snapshots pinned to IPFS will be listed here.
 ## License
 
 [MIT](./LICENSE.md)
+
+a

bin/server.js

@@ -47,6 +47,9 @@ class Server {
         useNewUrlParser: true
       })
 
+      console.log(`Starting environment: ${config.env}`)
+      console.log(`Debug level: ${config.debugLevel}`)
+
       // MIDDLEWARE START
 
       app.use(convert(logger()))
@@ -68,7 +71,7 @@ class Server {
       // Attach REST API and JSON RPC controllers to the app.
       const Controllers = require('../src/controllers')
       const controllers = new Controllers()
-      await controllers.attachControllers(app)
+      await controllers.attachRESTControllers(app)
 
       app.controllers = controllers
 
@@ -94,6 +97,16 @@ class Server {
         )
       }
 
+      // Attach the other IPFS controllers
+      await controllers.attachControllers(app)
+
+      // ipfs-coord has a memory leak. This app shuts down after 8 hours. It
+      // expects to be run by Docker or pm2, which can automatically restart
+      // the app.
+      setTimeout(function () {
+        process.exit(0)
+      }, 60000 * 60 * 8)
+
       return app
     } catch (err) {
       console.error('Could not start server. Error: ', err)

config/env/common.js

@@ -73,5 +73,10 @@ module.exports = {
 
   // IPFS Ports
   ipfsTcpPort: process.env.IPFS_TCP_PORT ? process.env.IPFS_TCP_PORT : 5668,
-  ipfsWsPort: process.env.IPFS_WS_PORT ? process.env.IPFS_WS_PORT : 5669
+  ipfsWsPort: process.env.IPFS_WS_PORT ? process.env.IPFS_WS_PORT : 5669,
+
+  // BCH Mnemonic for generating encryption keys and payment address
+  mnemonic: process.env.MNEMONIC ? process.env.MNEMONIC : '',
+
+  debugLevel: process.env.DEBUG_LEVEL ? parseInt(process.env.DEBUG_LEVEL) : 2
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ipfs-bch-wallet-service",
-  "version": "1.11.0",
+  "version": "1.11.12",
   "description": "IPFS and REST service providing blockchain access needed by a wallet. ",
   "main": "index.js",
   "scripts": {
@@ -27,8 +27,8 @@
     "axios": "^0.21.1",
     "bcryptjs": "^2.4.3",
     "glob": "^7.1.6",
-    "ipfs": "0.55.4",
-    "ipfs-coord": "^6.1.2",
+    "@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",
@@ -45,6 +45,7 @@
     "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",

production/docker-compose.yml

@@ -1,28 +0,0 @@
-# Start the testnet server with the command 'docker-compose up -d'
-
-bch-wallet-mongodb:
-  image: mongo
-  container_name: mongo-bch-service
-  ports:
-    - '5555:27017' # <host port>:<container port>
-  volumes:
-    - ./database:/data/db
-  command: mongod --logpath=/dev/null # -- quiet
-  restart: always
-
-bch-wallet-service:
-  build: ./
-  dockerfile: Dockerfile
-  container_name: bch-wallet-service
-  links:
-    - bch-wallet-mongodb
-  ports:
-    # <host port>:<container port>
-    - '5001:5001' # REST API
-    - '5668:5668' # IPFS TCP Port
-    - '5669:5669' # IPFS WS Port
-  volumes:
-    - ../ipfsdata:/home/safeuser/ipfsdata
-    - ../orbitdb:/home/safeuser/orbitdb
-
-  restart: always

production/docker/Dockerfile

@@ -3,7 +3,7 @@
 
 #IMAGE BUILD COMMANDS
 # ct-base-ubuntu = ubuntu 18.04 + nodejs v10 LTS
-FROM christroutner/ct-base-ubuntu
+FROM christroutner/ct-base-ubuntu:latest
 MAINTAINER Chris Troutner <chris.troutner@gmail.com>
 
 #Create the user 'safeuser' and add them to the sudo group.
@@ -23,34 +23,33 @@ WORKDIR /home/safeuser
 #RUN runuser -l safeuser -c "npm config set prefix '~/.npm-global'"
 
 # Switch to user account.
-USER safeuser
+#USER safeuser
 # Prep 'sudo' commands.
-RUN echo 'abcd8765' | sudo -S pwd
+#RUN echo 'abcd8765' | sudo -S pwd
 
 # Clone the rest.bitcoin.com repository
 WORKDIR /home/safeuser
 RUN git clone https://github.com/Permissionless-Software-Foundation/ipfs-bch-wallet-service
-# RUN mv koa-api-boilerplate koa
-# RUN mkdir keys
 
 # Switch to the desired branch. `master` is usually stable,
 # and `stage` has the most up-to-date changes.
 WORKDIR /home/safeuser/ipfs-bch-wallet-service
 
 # For development: switch to unstable branch
-# RUN git checkout unstable
+RUN git checkout ct-unstable
 
 # Install dependencies
+RUN npm install -g @mapbox/node-pre-gyp
 RUN npm install
 
 # Generate the API docs
 RUN npm run docs
 
 # Calling out the directorys that should be mounted as external volumes.
-RUN mkdir /home/safeuser/ipfsdata
-RUN mkdir /home/safeuser/orbitdb
-VOLUME /home/safeuser/ipfsdata
-VOLUME /home/safeuser/orbitdb
+RUN mkdir /home/safeuser/.ipfsdata
+#RUN mkdir /home/safeuser/orbitdb
+#VOLUME /home/safeuser/ipfsdata
+#VOLUME /home/safeuser/orbitdb
 
 # Start the application.
 COPY start-production.sh start-production.sh

production/docker/docker-compose.yml

@@ -0,0 +1,31 @@
+# Start the service with the command 'docker-compose up -d'
+
+version: '2'
+services:
+  bch-wallet-mongodb:
+    image: mongo
+    container_name: mongo-bch-service
+    ports:
+      - '5555:27017' # <host port>:<container port>
+    volumes:
+      - ../data/mongodb:/data/db
+    command: mongod --logpath=/dev/null # -- quiet
+    restart: always
+
+  bch-wallet-service:
+    build: ./
+    container_name: bch-wallet-service
+    logging:
+      driver: 'json-file'
+      options:
+        max-size: '10m'
+        max-file: '10'
+    links:
+      - bch-wallet-mongodb
+    ports:
+      # <host port>:<container port>
+      - '5001:5001' # REST API
+      - '5668:5668' # IPFS TCP Port
+      - '5669:5669' # IPFS WS Port
+    volumes:
+      - ../data/ipfsdata:/home/safeuser/ipfs-service-provider/.ipfsdata

production/docker/start-production.sh

@@ -0,0 +1,36 @@
+#!/bin/bash
+
+# BEGIN: Optional configuration settings
+
+# This mnemonic is used to set up persistent public key for e2ee
+# Replace this with your own 12-word mnemonic.
+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
+
+# Allow this node to function as a circuit relay. It must not be behind a firewall.
+#export ENABLE_CIRCUIT_RELAY=true
+
+# Debug level. 0 = minimal info. 2 = max info.
+export DEBUG_LEVEL=1
+
+# END: Optional configuration settings
+
+
+# Production database connection string.
+export DBURL=mongodb://172.17.0.1:5555/ipfs-service-prod
+
+# Customize these environment variables for your own installation.
+export AUTHSERVER=https://auth.fullstack.cash
+export APISERVER=https://api.fullstack.cash/v5/
+export FULLSTACKLOGIN=demo@demo.com
+export FULLSTACKPASS=demo
+
+# Ports
+export PORT=5001 # REST API
+export IPFS_TCP_PORT=5668 # IPSF TCP Port
+export IPFS_WS_PORT=5669 # IPFS WS Port
+
+export SVC_ENV=production
+npm start

production/start-production.sh

@@ -1,20 +0,0 @@
-#!/bin/bash
-
-# Customize these environment variables for your own installation.
-export AUTHSERVER=https://auth.fullstack.cash
-export APISERVER=https://api.fullstack.cash/v5/
-export FULLSTACKLOGIN=demo@demo.com
-export FULLSTACKPASS=demo
-
-# Ports
-export PORT=5001 # REST API
-export IPFS_TCP_PORT=5668 # IPSF TCP Port
-export IPFS_WS_PORT=5669 # IPFS WS Port
-
-# Production database connection string.
-export DBURL=mongodb://172.17.0.1:5555/ipfs-service-prod
-
-#export ENABLE_CIRCUIT_RELAY=1
-
-export SVC_ENV=production
-npm start

src/adapters/ipfs/index.js

@@ -46,6 +46,13 @@ class IPFS {
       return true
     } catch (err) {
       console.error('Error in adapters/ipfs/index.js/start()')
+
+      // 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)
+      }
+
       throw err
     }
   }

src/adapters/ipfs/ipfs-coord.js

@@ -43,6 +43,8 @@ class IpfsCoordAdapter {
   }
 
   async start (localConfig = {}) {
+    // console.log('this.config.announceJsonLd: ', this.config.announceJsonLd)
+
     this.ipfsCoord = new this.IpfsCoord({
       ipfs: this.ipfs,
       type: 'node.js',
@@ -51,11 +53,13 @@ class IpfsCoordAdapter {
       privateLog: console.log, // Default to console.log
       isCircuitRelay: this.config.isCircuitRelay,
       apiInfo: this.config.apiInfo,
-      announceJsonLd: this.config.announceJsonLd
+      announceJsonLd: this.config.announceJsonLd,
+      mnemonic: this.config.mnemonic,
+      debugLevel: this.config.debugLevel
     })
 
     // Wait for the ipfs-coord library to signal that it is ready.
-    await this.ipfsCoord.start()
+    await this.ipfsCoord.start({ type: 'node.js' })
 
     // Signal that this adapter is ready.
     this.isReady = true

src/adapters/ipfs/ipfs.js

@@ -2,10 +2,15 @@
   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
-const IPFS = require('ipfs')
+// const IPFS = require('ipfs')
+const IPFS = require('@chris.troutner/ipfs')
 
 // Local libraries
 const config = require('../../../config')

src/adapters/wlogger.js

@@ -62,42 +62,11 @@ class Wlogger {
   }
 }
 
-// transport.on('rotate', notifyRotation)
-
-// function notifyRotation (oldFilename, newFilename) {
-//   wlogger.info('Rotating log files')
-// }
-
-// This controls what goes into the log FILES
-// const wlogger = winston.createLogger({
-//   level: 'verbose',
-//   format: winston.format.json(),
-//   transports: [
-//     //
-//     // - Write to all logs with level `info` and below to `combined.log`
-//     // - Write all logs error (and below) to `error.log`.
-//     //
-//     // new winston.transports.File({ filename: 'logs/error.log', level: 'error' }),
-//     // new winston.transports.File({ filename: 'logs/combined.log' })
-//     transport
-//   ]
-// })
-
-// function outputToConsole () {
-//   wlogger.add(
-//     new winston.transports.Console({
-//       format: winston.format.simple(),
-//       level: 'info'
-//     })
-//   )
-// }
-
-// This controls the logs to CONSOLE
-// if (config.env !== 'test') {
-//   outputToConsole()
-// }
-
 const logger = new Wlogger()
+
+// Allow the logger to write to the console.
+logger.outputToConsole()
+
 const wlogger = logger.wlogger
 
 module.exports = { wlogger, Wlogger }

src/controllers/index.js

@@ -36,7 +36,7 @@ class Controllers {
     await this.adapters.start()
 
     // Attach the REST controllers to the Koa app.
-    this.attachRESTControllers(app)
+    // this.attachRESTControllers(app)
 
     this.attachRPCControllers()
   }

src/controllers/json-rpc/index.js

@@ -38,6 +38,11 @@ class JSONRPC {
     this.aboutController = new AboutController()
     this.bchController = new BCHController(localConfig)
 
+    // Cache to store IDs of processed JSON RPC commands. Used to prevent
+    // duplicate processing.
+    this.msgCache = []
+    this.MSG_CACHE_SIZE = 30
+
     _this = this
   }
 
@@ -45,26 +50,48 @@ class JSONRPC {
   // which controller to route the instruction to.
   async router (str, from) {
     try {
-      console.log('router str: ', str)
-      console.log('router from: ', from)
+      // console.log('router str: ', str)
+      console.log('JSON RPC router recieved data from: ', from)
 
       // Exit quietly if 'from' is not specified.
       if (!from || typeof from !== 'string') {
-        // console.warn(
-        //   'Warning: Can not send JSON RPC response. Can not determine which peer this message came from.'
-        // )
+        wlogger.info(
+          'Warning: Can not send JSON RPC response. Can not determine which peer this message came from.'
+        )
         return
       }
 
       // Attempt to parse the incoming data as a JSON RPC string.
       const parsedData = _this.jsonrpc.parse(str)
-      // console.log('parsedData: ', parsedData)
+      // wlogger.debug(`parsedData: ${JSON.stringify(parsedData, null, 2)}`)
 
       // Exit quietly if the incoming string is an invalid JSON RPC string.
       if (parsedData.type === 'invalid') {
+        wlogger.info('Rejecting invalid JSON RPC command.')
         return
       }
 
+      // Check for duplicate entries with same 'id' value.
+      const alreadyProcessed = _this._checkIfAlreadyProcessed(parsedData)
+      if (alreadyProcessed) {
+        return
+      } else {
+        // 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.
+        if (
+          parsedData.type.includes('success') &&
+          parsedData.payload.method === undefined
+        ) {
+          return
+        }
+
+        // Log the incoming JSON RPC command.
+        wlogger.info(
+          `JSON RPC received from ${from}, ID: ${parsedData.payload.id}, type: ${parsedData.type}, method: ${parsedData.payload.method}`
+        )
+      }
+
       // Added the property "from" to the parsedData object;
       // necessary for calculating rate limits (based on the IPFS ID).
       parsedData.from = from
@@ -124,6 +151,34 @@ class JSONRPC {
     }
   }
 
+  // Checks the ID of the JSON RPC call, to see if the message has already been
+  // processed. Returns true if the ID exists in the cache of processed messages.
+  // If the ID is new, the function adds it to the cache and return false.
+  _checkIfAlreadyProcessed (data) {
+    try {
+      const id = data.payload.id
+
+      // Check if the hash is in the array of already processed message.
+      const alreadyProcessed = this.msgCache.includes(id)
+
+      // Update the msgCache if this is a new message.
+      if (!alreadyProcessed) {
+        // Add the hash to the array.
+        this.msgCache.push(id)
+
+        // If the array is at its max size, then remove the oldest element.
+        if (this.msgCache.length > this.MSG_CACHE_SIZE) {
+          this.msgCache.shift()
+        }
+      }
+
+      return alreadyProcessed
+    } catch (err) {
+      console.error('Error in _checkIfAlreadyProcessed: ', err)
+      return false
+    }
+  }
+
   // The default JSON RPC response if the incoming command could not be routed.
   defaultResponse () {
     const errorObj = {

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

@@ -45,12 +45,17 @@ class TestUtils {
   async sendRPC (ipfsId, cmdStr) {
     try {
       // Send the RPC command to the server/service.
-      await this.ipfsCoord.ipfs.orbitdb.sendToDb(ipfsId, cmdStr)
+      // await this.ipfsCoord.ipfs.orbitdb.sendToDb(ipfsId, cmdStr)
+      await this.ipfsCoord.useCases.peer.sendPrivateMessage(
+        ipfsId,
+        cmdStr,
+        this.ipfsCoord.thisNode
+      )
 
       let retData
 
       // This event is triggered when the response comes back.
-      this.eventEmitter.on('rpcData', inData => {
+      this.eventEmitter.on('rpcData', (inData) => {
         retData = inData
       })
 
@@ -98,11 +103,8 @@ class TestUtils {
         apiInfo: 'none',
         announceJsonLd: announceJsonLd
       })
-      await this.ipfsCoord.ipfs.start()
-      // some ipfs-coord versions do not have this function
-      if (this.ipfsCoord.isReady) {
-        await this.ipfsCoord.isReady()
-      }
+
+      await this.ipfsCoord.start()
 
       // Wait to let ipfs-coord connect to subnet peers.
       await this.bchjs.Util.sleep(30000)
@@ -126,10 +128,17 @@ class TestUtils {
       //   'ipfs-coord peer info: ',
       //   this.ipfsCoord.ipfs.peers.state.peers[ipfsId]
       // )
-      if (!this.ipfsCoord.ipfs.peers.state.peers[ipfsId]) {
+
+      const peers = this.ipfsCoord.thisNode.peerList
+      // console.log('peers: ', peers)
+      // console.log('Target peer in peerList? ', peers.includes(ipfsId))
+
+      // if (!this.ipfsCoord.ipfs.peers.state.peers[ipfsId]) {
+      if (!peers.includes(ipfsId)) {
         throw new Error('Could not find UUT in ipfs-coord list of peers.')
       }
     } catch (err) {
+      console.log(err)
       console.error('Error in connectToUut()')
       console.log(
         'Is the service running? Did you update the test-data.json file?'
@@ -215,7 +224,10 @@ class TestUtils {
       const result = await this.sendRPC(ipfsId, cmdStr)
       // console.log('result: ', result)
 
-      if (result.result.value.status && Array.isArray(result.result.value.transactions)) {
+      if (
+        result.result.value.status &&
+        Array.isArray(result.result.value.transactions)
+      ) {
         console.log('E2E TEST: transactions test passed.')
         return true
       } else {

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

@@ -1,4 +1,4 @@
 {
-  "uutAddr": "/ip4/192.168.43.115/tcp/5668/p2p/QmVBWvFxao7smhRjUUh1q8rNAEwMqbg4X3dqsQDMSjUpmx",
-  "uutId": "QmfUjMqUeXSCzNkFGrzvf79yvV62dtjsnwtBSYKx3wegXw"
+  "uutAddr": "/ip4/127.0.0.1/tcp/5701/p2p/QmWkjYRRTaxVEuGK8ip2X3trVyJShFs6U9g1h9x6fK5mZ2",
+  "uutId": "QmWkjYRRTaxVEuGK8ip2X3trVyJShFs6U9g1h9x6fK5mZ2"
 }