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

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 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)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ipfs-bch-wallet-service",
-  "version": "1.11.4",
+  "version": "1.11.12",
   "description": "IPFS and REST service providing blockchain access needed by a wallet. ",
   "main": "index.js",
   "scripts": {
@@ -28,7 +28,7 @@
     "bcryptjs": "^2.4.3",
     "glob": "^7.1.6",
     "@chris.troutner/ipfs": "2.0.2",
-    "ipfs-coord": "^6.5.6",
+    "ipfs-coord": "^6.6.4",
     "jsonrpc-lite": "^2.2.0",
     "jsonwebtoken": "^8.5.1",
     "jwt-bch-lib": "^1.3.0",

production/docker/docker-compose.yml

@@ -1,27 +1,31 @@
-# Start the testnet server with the command 'docker-compose up -d'
+# Start the service 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:
-    - ../data/database:/data/db
-  command: mongod --logpath=/dev/null # -- quiet
-  restart: always
+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: ./
-  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:
-    - ../data/ipfsdata:/home/safeuser/ipfs-service-provider/.ipfsdata
-
-  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

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.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

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/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 = {