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

fix(bch-js): Selecting custom server when not using JWT token

.gitignore

@@ -68,5 +68,6 @@ ipfsdata
 ipfs-service-provider.sh
 start-bch-wallet-service.sh
 data/
+run-dev.sh
 
 !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)

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',

production/docker/Dockerfile

@@ -2,32 +2,44 @@
 #
 
 #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
 
 # 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
 

production/docker/start-production.sh

@@ -7,7 +7,7 @@
 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
@@ -22,6 +22,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

src/adapters/index.js

@@ -5,53 +5,55 @@
 */
 
 // Public NPM libraries
-const BCHJS = require('@psf/bch-js')
+const BCHJS = require("@psf/bch-js");
 
 // Load individual adapter libraries.
-const IPFSAdapter = require('./ipfs')
-const LocalDB = require('./localdb')
-const LogsAPI = require('./logapi')
-const Passport = require('./passport')
-const Nodemailer = require('./nodemailer')
+const IPFSAdapter = require("./ipfs");
+const LocalDB = require("./localdb");
+const LogsAPI = require("./logapi");
+const Passport = require("./passport");
+const Nodemailer = require("./nodemailer");
 // const { wlogger } = require('./wlogger')
-const JSONFiles = require('./json-files')
-const FullStackJWT = require('./fullstack-jwt')
+const JSONFiles = require("./json-files");
+const FullStackJWT = require("./fullstack-jwt");
 
-const config = require('../../config')
+const config = require("../../config");
 
 class Adapters {
-  constructor (localConfig = {}) {
+  constructor(localConfig = {}) {
     // Encapsulate dependencies
-    this.ipfs = new IPFSAdapter()
-    this.localdb = new LocalDB()
-    this.logapi = new LogsAPI()
-    this.passport = new Passport()
-    this.nodemailer = new Nodemailer()
-    this.jsonFiles = new JSONFiles()
-    this.bchjs = new BCHJS()
-    this.config = config
+    this.ipfs = new IPFSAdapter();
+    this.localdb = new LocalDB();
+    this.logapi = new LogsAPI();
+    this.passport = new Passport();
+    this.nodemailer = new Nodemailer();
+    this.jsonFiles = new JSONFiles();
+    this.bchjs = new BCHJS();
+    this.config = config;
 
     // Get a valid JWT API key and instance bch-js.
-    this.fullStackJwt = new FullStackJWT(config)
+    this.fullStackJwt = new FullStackJWT(config);
   }
 
-  async start () {
+  async start() {
     try {
       if (this.config.getJwtAtStartup) {
         // 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.fullStackJwt.getJWT()
+        await this.fullStackJwt.getJWT();
         // Instantiate bch-js with the JWT token, and overwrite the placeholder for bch-js.
-        this.bchjs = await this.fullStackJwt.instanceBchjs()
+        this.bchjs = await this.fullStackJwt.instanceBchjs();
+      } else {
+        this.bchjs = new BCHJS({ restURL: this.config.apiServer });
       }
 
       // Start the IPFS node.
-      await this.ipfs.start({ bchjs: this.bchjs })
+      await this.ipfs.start({ bchjs: this.bchjs });
     } catch (err) {
-      console.error('Error in adapters/index.js/start()')
-      throw err
+      console.error("Error in adapters/index.js/start()");
+      throw err;
     }
   }
 }
 
-module.exports = Adapters
+module.exports = Adapters;

src/adapters/ipfs/index.js

@@ -47,10 +47,16 @@ class IPFS {
     } 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)
+      // If we are not in a test environment.
+      if (process.env.SVC_ENV !== 'test') {
+        // 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')) {
+          console.log(
+            'Lock file issue with IPFS. Shutting down so that process manager can restart app.'
+          )
+          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/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

@@ -51,23 +51,23 @@ class JSONRPC {
   async router (str, from) {
     try {
       // console.log('router str: ', str)
-      // console.log('router from: ', from)
+      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('\nrouter from: ', from)
-      // 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
       }
 
@@ -75,6 +75,21 @@ class JSONRPC {
       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;

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: () => {}