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

feat(test): Added e2e test simulating a consumer of JSON RPC

bin/server.js

@@ -29,6 +29,9 @@ async function startServer () {
   // Connect to the Mongo Database.
   mongoose.Promise = global.Promise
   mongoose.set('useCreateIndex', true) // Stop deprecation warning.
+  console.log(
+    `Connecting to MongoDB with this connection string: ${config.database}`
+  )
   await mongoose.connect(config.database, {
     useUnifiedTopology: true,
     useNewUrlParser: true

config/env/common.js

@@ -5,6 +5,10 @@
 
 /* eslint  no-unneeded-ternary:0 */
 
+const ipfsCoordName = process.env.COORD_NAME
+  ? process.env.COORD_NAME
+  : 'ipfs-bch-wallet-service'
+
 module.exports = {
   // Configure TCP port.
   port: process.env.PORT || 5001,
@@ -39,13 +43,15 @@ module.exports = {
   isCircuitRelay: process.env.ENABLE_CIRCUIT_RELAY ? true : false,
 
   // Information passed to other IPFS peers about this node.
-  apiInfo: 'https://ipfs-service-provider.fullstack.cash/',
+  apiInfo: 'https://ipfs-bch-wallet-service.fullstack.cash/',
+
+  ipfsCoordName: ipfsCoordName,
 
   // JSON-LD and Schema.org schema with info about this app.
   announceJsonLd: {
     '@context': 'https://schema.org/',
     '@type': 'WebAPI',
-    name: 'ipfs-bch-wallet-service',
+    name: ipfsCoordName,
     description:
       'IPFS service providing BCH blockchain access needed by a wallet.',
     documentation: 'https://ipfs-bch-wallet-service.fullstack.cash/',

package-lock.json

@@ -8,6 +8,7 @@
       "version": "1.0.0",
       "license": "MIT",
       "dependencies": {
+        "@open-rpc/client-js": "^1.7.0",
         "@psf/bch-js": "^4.20.2",
         "axios": "^0.21.1",
         "bcryptjs": "^2.4.3",
@@ -1670,6 +1671,17 @@
         "@octokit/openapi-types": "^6.0.0"
       }
     },
+    "node_modules/@open-rpc/client-js": {
+      "version": "1.7.0",
+      "resolved": "https://registry.npmjs.org/@open-rpc/client-js/-/client-js-1.7.0.tgz",
+      "integrity": "sha512-cRGJbXTgdhJNU49vWzJIATRmKBLP2x6tuHJzX9Jg3N8f1VEkge0riUEek2LFIrZiM4TdUp8XV4Ns1W0SZzdfSw==",
+      "dependencies": {
+        "isomorphic-fetch": "^3.0.0",
+        "isomorphic-ws": "^4.0.1",
+        "strict-event-emitter-types": "^2.0.0",
+        "ws": "^7.0.0"
+      }
+    },
     "node_modules/@protobufjs/aspromise": {
       "version": "1.1.2",
       "resolved": "https://registry.npmjs.org/@protobufjs/aspromise/-/aspromise-1.1.2.tgz",
@@ -12810,6 +12822,23 @@
         "node": ">=10"
       }
     },
+    "node_modules/isomorphic-fetch": {
+      "version": "3.0.0",
+      "resolved": "https://registry.npmjs.org/isomorphic-fetch/-/isomorphic-fetch-3.0.0.tgz",
+      "integrity": "sha512-qvUtwJ3j6qwsF3jLxkZ72qCgjMysPzDfeV240JHiGZsANBYd+EEuu35v7dfrJ9Up0Ak07D7GGSkGhCHTqg/5wA==",
+      "dependencies": {
+        "node-fetch": "^2.6.1",
+        "whatwg-fetch": "^3.4.1"
+      }
+    },
+    "node_modules/isomorphic-ws": {
+      "version": "4.0.1",
+      "resolved": "https://registry.npmjs.org/isomorphic-ws/-/isomorphic-ws-4.0.1.tgz",
+      "integrity": "sha512-BhBvN2MBpWTaSHdWRb/bwdZJ1WaehQ2L1KngkCkfLUGF0mAWAT1sQUQacEmQ0jXkFw/czDXPNQSL5u2/Krsz1w==",
+      "peerDependencies": {
+        "ws": "*"
+      }
+    },
     "node_modules/isstream": {
       "version": "0.1.2",
       "resolved": "https://registry.npmjs.org/isstream/-/isstream-0.1.2.tgz",
@@ -24716,6 +24745,11 @@
         "node": ">=10"
       }
     },
+    "node_modules/strict-event-emitter-types": {
+      "version": "2.0.0",
+      "resolved": "https://registry.npmjs.org/strict-event-emitter-types/-/strict-event-emitter-types-2.0.0.tgz",
+      "integrity": "sha512-Nk/brWYpD85WlOgzw5h173aci0Teyv8YdIAEtV+N88nDB0dLlazZyJMIsN6eo1/AR61l+p6CJTG1JIyFaoNEEA=="
+    },
     "node_modules/string_decoder": {
       "version": "1.3.0",
       "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.3.0.tgz",
@@ -25812,6 +25846,11 @@
         "@zxing/text-encoding": "0.9.0"
       }
     },
+    "node_modules/whatwg-fetch": {
+      "version": "3.6.2",
+      "resolved": "https://registry.npmjs.org/whatwg-fetch/-/whatwg-fetch-3.6.2.tgz",
+      "integrity": "sha512-bJlen0FcuU/0EMLrdbJ7zOnW6ITZLrZMIarMUVmdKtsGvZna8vxKYaexICWPfZ8qwf9fzNq+UEIZrnSaApt6RA=="
+    },
     "node_modules/which": {
       "version": "2.0.2",
       "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz",
@@ -27586,6 +27625,17 @@
         "@octokit/openapi-types": "^6.0.0"
       }
     },
+    "@open-rpc/client-js": {
+      "version": "1.7.0",
+      "resolved": "https://registry.npmjs.org/@open-rpc/client-js/-/client-js-1.7.0.tgz",
+      "integrity": "sha512-cRGJbXTgdhJNU49vWzJIATRmKBLP2x6tuHJzX9Jg3N8f1VEkge0riUEek2LFIrZiM4TdUp8XV4Ns1W0SZzdfSw==",
+      "requires": {
+        "isomorphic-fetch": "^3.0.0",
+        "isomorphic-ws": "^4.0.1",
+        "strict-event-emitter-types": "^2.0.0",
+        "ws": "^7.0.0"
+      }
+    },
     "@protobufjs/aspromise": {
       "version": "1.1.2",
       "resolved": "https://registry.npmjs.org/@protobufjs/aspromise/-/aspromise-1.1.2.tgz",
@@ -37019,6 +37069,21 @@
       "resolved": "https://registry.npmjs.org/iso-url/-/iso-url-0.4.7.tgz",
       "integrity": "sha512-27fFRDnPAMnHGLq36bWTpKET+eiXct3ENlCcdcMdk+mjXrb2kw3mhBUg1B7ewAC0kVzlOPhADzQgz1SE6Tglog=="
     },
+    "isomorphic-fetch": {
+      "version": "3.0.0",
+      "resolved": "https://registry.npmjs.org/isomorphic-fetch/-/isomorphic-fetch-3.0.0.tgz",
+      "integrity": "sha512-qvUtwJ3j6qwsF3jLxkZ72qCgjMysPzDfeV240JHiGZsANBYd+EEuu35v7dfrJ9Up0Ak07D7GGSkGhCHTqg/5wA==",
+      "requires": {
+        "node-fetch": "^2.6.1",
+        "whatwg-fetch": "^3.4.1"
+      }
+    },
+    "isomorphic-ws": {
+      "version": "4.0.1",
+      "resolved": "https://registry.npmjs.org/isomorphic-ws/-/isomorphic-ws-4.0.1.tgz",
+      "integrity": "sha512-BhBvN2MBpWTaSHdWRb/bwdZJ1WaehQ2L1KngkCkfLUGF0mAWAT1sQUQacEmQ0jXkFw/czDXPNQSL5u2/Krsz1w==",
+      "requires": {}
+    },
     "isstream": {
       "version": "0.1.2",
       "resolved": "https://registry.npmjs.org/isstream/-/isstream-0.1.2.tgz",
@@ -46632,6 +46697,11 @@
       "resolved": "https://registry.npmjs.org/streaming-iterables/-/streaming-iterables-5.0.4.tgz",
       "integrity": "sha512-nEs6hBGIPsVz6uq6pscGGKfoPDQWrDQW0b0UHurtSDysekfKLmkPg7FQVRE2sj3Rad6yUo9E1sGTxOWyYsHQ/g=="
     },
+    "strict-event-emitter-types": {
+      "version": "2.0.0",
+      "resolved": "https://registry.npmjs.org/strict-event-emitter-types/-/strict-event-emitter-types-2.0.0.tgz",
+      "integrity": "sha512-Nk/brWYpD85WlOgzw5h173aci0Teyv8YdIAEtV+N88nDB0dLlazZyJMIsN6eo1/AR61l+p6CJTG1JIyFaoNEEA=="
+    },
     "string_decoder": {
       "version": "1.3.0",
       "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.3.0.tgz",
@@ -47538,6 +47608,11 @@
         "@zxing/text-encoding": "0.9.0"
       }
     },
+    "whatwg-fetch": {
+      "version": "3.6.2",
+      "resolved": "https://registry.npmjs.org/whatwg-fetch/-/whatwg-fetch-3.6.2.tgz",
+      "integrity": "sha512-bJlen0FcuU/0EMLrdbJ7zOnW6ITZLrZMIarMUVmdKtsGvZna8vxKYaexICWPfZ8qwf9fzNq+UEIZrnSaApt6RA=="
+    },
     "which": {
       "version": "2.0.2",
       "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz",

src/controllers/json-rpc/index.js

@@ -45,8 +45,8 @@ 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('router from: ', from)
 
       // Exit quietly if 'from' is not specified.
       if (!from || typeof from !== 'string') {

test/e2e/manual/consumer/README.md

@@ -0,0 +1,11 @@
+# Consumer Simulation E2E Test
+
+The files in this directory simulates a consumer of web services, using JSON RPC over IPFS. It starts a new IPFS node that connects to the ipfs-bch-wallet-service and exercises each JSON RPC endpoint.
+
+## Instructions
+
+Execute these steps in order to run the test:
+
+1. Run your local copy of ipfs-bch-wallet-service service provider.
+2. Update the [test-data.json](./test-data.json) file with the IPFS ID of the ipfs-bch-wallet-service.
+3. In another terminal, run the client simulation with `node client.e2e.js`

test/e2e/manual/consumer/consumer.e2e.js

@@ -0,0 +1,29 @@
+/*
+  An end-to-end (e2e) test simulating a client connecting over IPFS and
+  that exercises each JSON RPC endpoint.
+*/
+
+const TestUtils = require('./lib/test-utils')
+const testUtils = new TestUtils()
+
+const testData = require('./test-data.json')
+
+async function startTest () {
+  try {
+    console.log('E2E TEST: Starting consumer E2E tests...')
+
+    await testUtils.startIpfs()
+
+    await testUtils.connectToUut(testData.uutAddr, testData.uutId)
+
+    await testUtils.testBalance(testData.uutId)
+
+    await testUtils.testTransaction(testData.uutId)
+
+    console.log('E2E TEST: Tests completed successfully!')
+    process.exit()
+  } catch (err) {
+    console.error('Error in startTest(): ', err)
+  }
+}
+startTest()

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

@@ -0,0 +1,217 @@
+/*
+  A class library of test utility functions.
+*/
+
+// Public npm libraries
+const BCHJS = require('@psf/bch-js')
+const IpfsCoord = require('ipfs-coord')
+const IPFS = require('ipfs')
+const EventEmitter = require('events')
+const { v4: uid } = require('uuid')
+const jsonrpc = require('jsonrpc-lite')
+
+let _this
+
+class TestUtils {
+  constructor (localConfig = {}) {
+    // Encapsulate dependencies.
+    this.bchjs = new BCHJS()
+    this.eventEmitter = new EventEmitter()
+    this.uid = uid
+    this.jsonrpc = jsonrpc
+
+    _this = this
+  }
+
+  // This handler function recieves data from other ipfs-coord peers, like
+  // the ipfs-bch-wallet-service that we're testing.
+  // It emits the data as an 'rpcData' event. The tests will listen for this
+  // event.
+  rpcHandler (inData) {
+    try {
+      // console.log('Data recieved by rpcHandler: ', inData)
+
+      const jsonData = JSON.parse(inData)
+
+      _this.eventEmitter.emit('rpcData', jsonData)
+    } catch (err) {
+      console.error('Error in rpcHandler: ', err)
+      // Do not throw an error. This is a top-level function.
+    }
+  }
+
+  // Send the RPC command to the service, wait a period of time for a response.
+  // Timeout if a response is not recieved.
+  async sendRPC (ipfsId, cmdStr) {
+    try {
+      // Send the RPC command to the server/service.
+      await this.ipfsCoord.ipfs.orbitdb.sendToDb(ipfsId, cmdStr)
+
+      let retData
+
+      // This event is triggered when the response comes back.
+      this.eventEmitter.on('rpcData', inData => {
+        retData = inData
+      })
+
+      // Used for calculating the timeout.
+      const start = new Date()
+      let now = start
+      let timeDiff = 0
+
+      // Wait for the response from the server. Exit once the response is
+      // recieved, or a timeout occurs.
+      do {
+        await this.bchjs.Util.sleep(1000)
+
+        now = new Date()
+
+        timeDiff = now.getTime() - start.getTime()
+        // console.log('timeDiff: ', timeDiff)
+      } while (
+        // Exit once the RPC data comes back, or if a period of time passes.
+        !retData || // eslint-disable-line no-unmodified-loop-condition
+        timeDiff > 10000
+      )
+
+      return retData
+    } catch (err) {
+      console.error('Error in sendRPC')
+      throw err
+    }
+  }
+
+  async startIpfs () {
+    try {
+      // Start the IPFS node.
+      this.ipfs = await IPFS.create()
+      await this.ipfs.config.profiles.apply('server')
+
+      // Start ipfs-coord.
+      this.ipfsCoord = new IpfsCoord({
+        ipfs: this.ipfs,
+        type: 'node.js',
+        // type: 'browser',
+        bchjs: this.bchjs,
+        privateLog: this.rpcHandler, // Default to console.log
+        isCircuitRelay: false,
+        apiInfo: 'none',
+        announceJsonLd: announceJsonLd
+      })
+      await this.ipfsCoord.ipfs.start()
+      await this.ipfsCoord.isReady()
+
+      // Wait to let ipfs-coord connect to subnet peers.
+      await this.bchjs.Util.sleep(30000)
+    } catch (err) {
+      console.error('Error in startIpfs().')
+      throw err
+    }
+  }
+
+  // Connect to the unit under test (uut)
+  async connectToUut (addr, ipfsId) {
+    try {
+      try {
+        await this.ipfs.swarm.connect(addr)
+        console.log(`E2E TEST: Connected to IPFS node ${addr}`)
+      } catch (err) {
+        throw new Error('Could not connect to UUT IPFS node.')
+      }
+
+      // console.log(
+      //   'ipfs-coord peer info: ',
+      //   this.ipfsCoord.ipfs.peers.state.peers[ipfsId]
+      // )
+      if (!this.ipfsCoord.ipfs.peers.state.peers[ipfsId]) {
+        throw new Error('Could not find UUT in ipfs-coord list of peers.')
+      }
+    } catch (err) {
+      console.error('Error in connectToUut()')
+      console.log(
+        'Is the service running? Did you update the test-data.json file?'
+      )
+      process.exit()
+    }
+  }
+
+  // Get the balance for a BCH address over JSON RPC.
+  async testBalance (ipfsId) {
+    try {
+      // Generate the JSON RPC command
+      const id = uid()
+      const cmd = jsonrpc.request(id, 'bch', {
+        endpoint: 'balance',
+        addresses: ['bitcoincash:qrl2nlsaayk6ekxn80pq0ks32dya8xfclyktem2mqj']
+      })
+      const cmdStr = JSON.stringify(cmd)
+
+      // console.log(`Publishing message to ${ipfsId}`)
+
+      console.log('E2E TEST: Sending Balance command...')
+      const result = await this.sendRPC(ipfsId, cmdStr)
+      // console.log('result: ', result)
+
+      if (result.result.value.success && result.result.value.balances) {
+        console.log('E2E TEST: balance test passed.')
+        return true
+      } else {
+        console.log('E2E TEST: balance test failed.')
+        this.failTest()
+      }
+    } catch (err) {
+      console.error('Error in testBalance()')
+      throw err
+    }
+  }
+
+  // Get the info a on transaction over JSON RPC.
+  async testTransaction (ipfsId) {
+    try {
+      // Generate the JSON RPC command
+      const id = uid()
+      const cmd = jsonrpc.request(id, 'bch', {
+        endpoint: 'transaction',
+        txid: '01517ff1587fa5ffe6f5eb91c99cf3f2d22330cd7ee847e928ce90ca95bf781b'
+      })
+      const cmdStr = JSON.stringify(cmd)
+
+      // console.log(`Publishing message to ${ipfsId}`)
+
+      console.log('E2E TEST: Sending Transaction command...')
+      const result = await this.sendRPC(ipfsId, cmdStr)
+      // console.log('result: ', result)
+
+      if (result.result.value.status && result.result.value.confirmations) {
+        console.log('E2E TEST: transaction test passed.')
+        return true
+      } else {
+        console.log('E2E TEST: transaction test failed.')
+        this.failTest()
+      }
+    } catch (err) {
+      console.error('Error in testTransaction()')
+      throw err
+    }
+  }
+
+  failTest () {
+    console.log('Exiting test program.')
+    process.exit()
+  }
+}
+
+const announceJsonLd = {
+  '@context': 'https://schema.org/',
+  '@type': 'WebAPI',
+  name: 'e2e-test-client',
+  description: 'A test client runing e2e tests on ipfs-bch-wallet-service.',
+  documentation: 'https://ipfs-bch-wallet-service.fullstack.cash/',
+  provider: {
+    '@type': 'Organization',
+    name: 'Permissionless Software Foundation',
+    url: 'https://PSFoundation.cash'
+  }
+}
+
+module.exports = TestUtils

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

@@ -0,0 +1,4 @@
+{
+  "uutAddr": "/ip4/127.0.0.1/tcp/5668/p2p/QmZSyLnRQWMBknVNjUroLQnrcmDnUVAUU4pMQ2LGhh6b9v",
+  "uutId": "QmZSyLnRQWMBknVNjUroLQnrcmDnUVAUU4pMQ2LGhh6b9v"
+}