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

fix(production): Updating to docker container v1.8.4

README.md

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

bin/server.js

@@ -24,31 +24,37 @@ const config = require('../config') // this first.
 const AdminLib = require('../src/adapters/admin')
 const errorMiddleware = require('../src/controllers/rest-api/middleware/error')
 const { wlogger } = require('../src/adapters/wlogger')
+const Controllers = require('../src/controllers')
 
 class Server {
   constructor () {
+    // Encapsulate dependencies
     this.adminLib = new AdminLib()
+    this.controllers = new Controllers()
+    this.mongoose = mongoose
+    this.config = config
+    this.process = process
   }
 
   async startServer () {
     try {
       // Create a Koa instance.
       const app = new Koa()
-      app.keys = [config.session]
+      app.keys = [this.config.session]
 
       // Connect to the Mongo Database.
-      mongoose.Promise = global.Promise
-      mongoose.set('useCreateIndex', true) // Stop deprecation warning.
+      this.mongoose.Promise = global.Promise
+      this.mongoose.set('useCreateIndex', true) // Stop deprecation warning.
       console.log(
-        `Connecting to MongoDB with this connection string: ${config.database}`
+        `Connecting to MongoDB with this connection string: ${this.config.database}`
       )
-      await mongoose.connect(config.database, {
+      await this.mongoose.connect(this.config.database, {
         useUnifiedTopology: true,
         useNewUrlParser: true
       })
 
-      console.log(`Starting environment: ${config.env}`)
-      console.log(`Debug level: ${config.debugLevel}`)
+      console.log(`Starting environment: ${this.config.env}`)
+      console.log(`Debug level: ${this.config.debugLevel}`)
 
       // MIDDLEWARE START
 
@@ -74,19 +80,17 @@ class Server {
       app.use(cors({ origin: '*' }))
 
       // Attach REST API and JSON RPC controllers to the app.
-      const Controllers = require('../src/controllers')
-      const controllers = new Controllers()
-      await controllers.attachRESTControllers(app)
+      await this.controllers.attachRESTControllers(app)
 
-      app.controllers = controllers
+      app.controllers = this.controllers
 
       // MIDDLEWARE END
 
-      console.log(`Running server in environment: ${config.env}`)
-      wlogger.info(`Running server in environment: ${config.env}`)
+      console.log(`Running server in environment: ${this.config.env}`)
+      wlogger.info(`Running server in environment: ${this.config.env}`)
 
-      await app.listen(config.port)
-      console.log(`Server started on ${config.port}`)
+      this.server = await app.listen(this.config.port)
+      console.log(`Server started on ${this.config.port}`)
 
       // Create the system admin user.
       const success = await this.adminLib.createSystemUser()
@@ -94,10 +98,16 @@ class Server {
 
       // Attach the other IPFS controllers.
       // Skip if this is a test environment.
-      if (config.env !== 'test') {
-        await controllers.attachControllers(app)
+      if (this.config.env !== 'test') {
+        await this.controllers.attachControllers(app)
       }
 
+      // Display configuration settings
+      console.log('\nConfiguration:')
+      console.log(`Circuit Relay: ${this.config.isCircuitRelay}`)
+      console.log(`IPFS TCP port: ${this.config.ipfsTcpPort}`)
+      console.log(`IPFS WS port: ${this.config.ipfsWsPort}\n`)
+
       return app
     } catch (err) {
       console.error('Could not start server. Error: ', err)
@@ -105,14 +115,14 @@ class Server {
       console.log(
         'Exiting after 5 seconds. Depending on process manager to restart.'
       )
-      await sleep(5000)
-      process.exit(1)
+      await this.sleep(5000)
+      this.process.exit(1)
     }
   }
+
+  sleep (ms) {
+    return new Promise((resolve) => setTimeout(resolve, ms))
+  }
 }
 
-function sleep (ms) {
-  return new Promise((resolve) => setTimeout(resolve, ms))
-}
-
 module.exports = Server

config/env/common.js

@@ -98,5 +98,7 @@ module.exports = {
   ipfsHost: process.env.IPFS_HOST ? process.env.IPFS_HOST : 'localhost',
   ipfsApiPort: process.env.IPFS_API_PORT
     ? parseInt(process.env.IPFS_API_PORT)
-    : 5001
+    : 5001,
+
+  chatPubSubChan: 'psf-ipfs-chat-001'
 }

package.json

@@ -24,11 +24,11 @@
   "repository": "Permissionless-Software-Foundation/ipfs-bch-wallet-consumer",
   "dependencies": {
     "@psf/bch-js": "6.4.1",
-    "axios": "0.25.0",
+    "axios": "0.27.2",
     "bcryptjs": "2.4.3",
     "glob": "7.1.6",
-    "ipfs": "0.60.0",
-    "ipfs-coord": "7.1.6",
+    "ipfs": "0.62.3",
+    "ipfs-coord": "7.1.19",
     "ipfs-http-client": "55.0.0",
     "jsonrpc-lite": "2.2.0",
     "jsonwebtoken": "8.5.1",
@@ -45,9 +45,9 @@
     "koa-static": "5.0.0",
     "koa2-ratelimit": "0.9.1",
     "line-reader": "0.4.0",
-    "mongoose": "5.11.15",
+    "mongoose": "5.13.14",
     "node-fetch": "npm:@achingbrain/node-fetch@2.6.7",
-    "nodemailer": "6.4.17",
+    "nodemailer": "6.7.5",
     "passport-local": "1.0.0",
     "public-ip": "4.0.4",
     "semver": "^7.3.5",
@@ -55,7 +55,7 @@
     "winston-daily-rotate-file": "4.5.0"
   },
   "devDependencies": {
-    "apidoc": "0.26.0",
+    "apidoc": "0.51.1",
     "chai": "4.3.0",
     "coveralls": "3.1.0",
     "eslint": "7.19.0",
@@ -65,10 +65,10 @@
     "eslint-plugin-prettier": "3.3.1",
     "eslint-plugin-standard": "4.0.0",
     "husky": "4.3.8",
-    "lodash.clonedeep": "^4.5.0",
-    "mocha": "8.2.1",
+    "lodash.clonedeep": "4.5.0",
+    "mocha": "10.0.0",
     "nyc": "15.1.0",
-    "semantic-release": "17.4.4",
+    "semantic-release": "19.0.3",
     "sinon": "9.2.4",
     "standard": "16.0.3",
     "uuid": "8.3.2"

production/docker/Dockerfile

@@ -69,7 +69,7 @@ VOLUME /home/safeuser/keys
 EXPOSE 5010
 
 # Start the application.
-COPY start-production.sh start-production.sh
+#COPY start-production.sh start-production.sh
 CMD ["./start-production.sh"]
 
 #CMD ["npm", "start"]

production/docker/docker-compose.yml

@@ -14,7 +14,7 @@ services:
     restart: always
 
   ipfs-bch-consumer:
-    image: ipfs/go-ipfs:v0.12.0
+    image: ipfs/go-ipfs:v0.13.0
     container_name: ipfs-bch-consumer
     environment:
       MY_ENV_VAR: 'placeholder'
@@ -44,7 +44,7 @@ services:
 
   bch-consumer:
     #build: .
-    image: christroutner/ipfs-bch-wallet-consumer:v1.8.0
+    image: christroutner/ipfs-bch-wallet-consumer:v1.8.4
     container_name: bch-consumer
     logging:
       driver: 'json-file'
@@ -58,5 +58,6 @@ services:
     ports:
       - '5010:5010' # <host port>:<container port>
     volumes:
-      - ../data/ipfsdata:/home/safeuser/ipfs-service-provider/.ipfsdata
+      - ../data/ipfsdata:/home/safeuser/ipfs-bch-wallet-consumer/.ipfsdata
+      - ./start-production.sh:/home/safeuser/ipfs-bch-wallet-consumer/start-production.sh
     restart: always

shell-scripts/local-external-ipfs-node.sh

@@ -28,4 +28,6 @@ export IPFS_TCP_PORT=4001
 # MongoDB connection string.
 export DBURL=mongodb://localhost:27017/ipfs-service-dev
 
+export CONSUMER_ENV=production
+
 npm start

src/adapters/index.js

@@ -60,6 +60,8 @@ class Adapters {
 
       // Start the IPFS node.
       await this.ipfs.start()
+
+      return true
     } catch (err) {
       console.error('Error in adapters/index.js/start()')
       throw err

src/adapters/ipfs/index.js

@@ -2,6 +2,7 @@
   top-level IPFS library that combines the individual IPFS-based libraries.
 */
 
+// Local libraries
 const IpfsAdapter = require('./ipfs')
 const IpfsCoordAdapter = require('./ipfs-coord')
 
@@ -45,6 +46,9 @@ class IPFS {
       await this.ipfsCoordAdapter.start()
       console.log('ipfs-coord is ready.')
 
+      // Subscribe to the chat pubsub channel
+      await this.ipfsCoordAdapter.subscribeToChat()
+
       return true
     } catch (err) {
       console.error('Error in adapters/ipfs/index.js/start()')

src/adapters/ipfs/ipfs-coord.js

@@ -301,6 +301,15 @@ class IpfsCoordAdapter {
   //     // Do not throw error. This is a top-level function.
   //   }
   // }
+
+  // Subscribe to the chat pubsub channel
+  async subscribeToChat () {
+    await this.ipfsCoord.adapters.pubsub.subscribeToPubsubChannel(
+      this.config.chatPubSubChan,
+      console.log,
+      this.ipfsCoord.thisNode
+    )
+  }
 }
 
 module.exports = IpfsCoordAdapter

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

@@ -0,0 +1,53 @@
+/*
+  Unit tests for the adapters index.js library
+*/
+
+// Global npm libraries
+const assert = require('chai').assert
+const sinon = require('sinon')
+
+// Local libraries
+const Adapters = require('../../../src/adapters')
+
+describe('#adapters', () => {
+  let uut, sandbox
+
+  beforeEach(() => {
+    uut = new Adapters()
+
+    sandbox = sinon.createSandbox()
+  })
+
+  afterEach(() => {
+    sandbox.restore()
+  })
+
+  describe('#start', () => {
+    it('should start the async adapters', async () => {
+      // Mock dependencies
+      uut.config.getJwtAtStartup = true
+      sandbox.stub(uut.fullStackJwt, 'getJWT').resolves()
+      sandbox.stub(uut.fullStackJwt, 'instanceBchjs').resolves()
+      sandbox.stub(uut.ipfs, 'start').resolves()
+
+      const result = await uut.start()
+
+      assert.equal(result, true)
+    })
+
+    it('should catch and throw an error', async () => {
+      try {
+      // Force an error
+        uut.config.getJwtAtStartup = false
+        sandbox.stub(uut.ipfs, 'start').rejects(new Error('test error'))
+
+        await uut.start()
+
+        assert.fail('Unexpected result')
+      } catch (err) {
+        // console.log('err: ', err)
+        assert.include(err.message, 'test error')
+      }
+    })
+  })
+})

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

@@ -180,4 +180,20 @@ describe('#IPFS', () => {
   //     assert.isOk(true, 'Not throwing an error is a success.')
   //   })
   // })
+
+  describe('#subscribeToChat', () => {
+    it('should subscribe to the chat channel', async () => {
+      // Mock dependencies
+      uut.ipfsCoord = {
+        adapters: {
+          pubsub: {
+            subscribeToPubsubChannel: async () => {
+            }
+          }
+        }
+      }
+
+      await uut.subscribeToChat()
+    })
+  })
 })

test/unit/misc/server-unit.js

@@ -0,0 +1,63 @@
+/*
+  Unit tests for the bin/server.js file
+*/
+
+// Public npm libraries
+const assert = require('chai').assert
+const sinon = require('sinon')
+
+// Local libraries
+const Server = require('../../../bin/server')
+
+describe('#server', () => {
+  let uut, sandbox
+
+  beforeEach(() => {
+    sandbox = sinon.createSandbox()
+
+    uut = new Server()
+  })
+
+  afterEach(() => sandbox.restore())
+
+  describe('#startServer', () => {
+    it('should start the server', async () => {
+      // Mock dependencies
+      sandbox.stub(uut.mongoose, 'connect').resolves()
+      sandbox.stub(uut.controllers, 'attachRESTControllers').resolves()
+      sandbox.stub(uut.adminLib, 'createSystemUser').resolves(true)
+      sandbox.stub(uut.controllers, 'attachControllers').resolves()
+      uut.config.env = 'dev'
+
+      const result = await uut.startServer()
+      // console.log('result: ', result)
+
+      assert.property(result, 'env')
+
+      // Turn off the server.
+      uut.server.close()
+
+      // Restor config env
+      uut.config.env = 'test'
+    })
+
+    it('should exit on failure', async () => {
+      // Force an error
+      sandbox.stub(uut.mongoose, 'connect').rejects(new Error('test error'))
+
+      // Prevent default behavior of exiting the program.
+      sandbox.stub(uut, 'sleep').resolves()
+      sandbox.stub(uut.process, 'exit').returns()
+
+      await uut.startServer()
+
+      // Not throwing an error is a success
+    })
+  })
+
+  describe('#sleep', () => {
+    it('should execute', async () => {
+      await uut.sleep(1)
+    })
+  })
+})

test/unit/mocks/ipfs-coord-mock.js

@@ -8,6 +8,8 @@ class IPFSCoord {
   }
 
   async start () {}
+
+  async subscribeToChat() {}
 }
 
 module.exports = IPFSCoord