Feature/1468 support for bulk quotes post passthrough

.ncurc.json

@@ -1,5 +1,6 @@
 {
   "reject": [
-    "json-rules-engine"
+    "json-rules-engine",
+    "@mojaloop/sdk-standard-components"
   ]
 }

package.json

@@ -2,7 +2,7 @@
   "name": "quoting-service",
   "description": "Quoting Service hosted by a scheme",
   "license": "Apache-2.0",
-  "version": "10.5.5",
+  "version": "10.6.0",
   "author": "ModusBox",
   "contributors": [
     "James Bush <james.bush@modusbox.com>",
@@ -60,10 +60,10 @@
   "dependencies": {
     "@hapi/good": "9.0.0",
     "@hapi/hapi": "19.1.1",
-    "@mojaloop/central-services-error-handling": "10.4.1",
-    "@mojaloop/central-services-logger": "10.4.0",
-    "@mojaloop/central-services-shared": "10.5.3",
-    "@mojaloop/event-sdk": "10.4.0",
+    "@mojaloop/central-services-error-handling": "10.6.0",
+    "@mojaloop/central-services-logger": "10.6.0",
+    "@mojaloop/central-services-shared": "10.6.2",
+    "@mojaloop/event-sdk": "10.6.0",
     "@mojaloop/ml-number": "8.2.0",
     "@mojaloop/sdk-standard-components": "10.3.2",
     "axios": "0.19.2",
@@ -72,7 +72,7 @@
     "good-console": "8.0.0",
     "good-squeeze": "5.1.0",
     "json-rules-engine": "5.0.2",
-    "knex": "0.21.1",
+    "knex": "0.21.2",
     "memory-cache": "0.2.0",
     "minimist": "1.2.5",
     "mysql": "2.18.1",
@@ -81,11 +81,11 @@
     "rc": "1.2.8"
   },
   "devDependencies": {
-    "@types/jest": "26.0.3",
-    "eslint": "7.3.1",
+    "@types/jest": "26.0.4",
+    "eslint": "7.4.0",
     "jest": "26.1.0",
     "jest-junit": "11.0.1",
-    "npm-audit-resolver": "2.2.0",
+    "npm-audit-resolver": "2.2.1",
     "npm-check-updates": "7.0.1",
     "nyc": "15.1.0",
     "pre-commit": "1.2.2",

src/handlers/bulkQuotes.js

@@ -27,12 +27,18 @@
 
  * Henk Kodde <henk.kodde@modusbox.com>
  * Georgi Georgiev <georgi.georgiev@modusbox.com>
+ * Rajiv Mothilal <rajiv.mothilal@modusbox.com>
  --------------
  ******/
 
 'use strict'
 
+const util = require('util')
+const Enum = require('@mojaloop/central-services-shared').Enum
 const ErrorHandler = require('@mojaloop/central-services-error-handling')
+const EventSdk = require('@mojaloop/event-sdk')
+const LibUtil = require('../lib/util')
+const BulkQuotesModel = require('../model/bulkQuotes')
 
 /**
  * Operations on /bulkQuotes
@@ -45,7 +51,40 @@ module.exports = {
      * produces: application/json
      * responses: 202, 400, 401, 403, 404, 405, 406, 501, 503
      */
-  post: function BulkQuotes (context, request, h) {
-    throw ErrorHandler.CreateFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.NOT_IMPLEMENTED, 'Bulk quotes not implemented')
+  post: async function BulkQuotes (context, request, h) {
+    // log request
+    request.server.log(['info'], `got a POST /bulkQuotes request: ${util.inspect(request.payload)}`)
+
+    // instantiate a new quote model
+    const model = new BulkQuotesModel({
+      db: request.server.app.database,
+      requestId: request.info.id
+    })
+
+    // extract some things from the request we may need if we have to deal with an error e.g. the
+    // originator and quoteId
+    const bulkQuoteId = request.payload.bulkQuoteId
+    const fspiopSource = request.headers[Enum.Http.Headers.FSPIOP.SOURCE]
+
+    const span = request.span
+    try {
+      const spanTags = LibUtil.getSpanTags(request, Enum.Events.Event.Type.BULK_QUOTE, Enum.Events.Event.Action.PREPARE)
+      span.setTags(spanTags)
+      await span.audit({
+        headers: request.headers,
+        payload: request.payload
+      }, EventSdk.AuditEventAction.start)
+
+      // call the quote request handler in the model
+      model.handleBulkQuoteRequest(request.headers, request.payload, span)
+    } catch (err) {
+      // something went wrong, use the model to handle the error in a sensible way
+      request.server.log(['error'], `ERROR - POST /bulkQuotes: ${LibUtil.getStackOrInspect(err)}`)
+      const fspiopError = ErrorHandler.ReformatFSPIOPError(err)
+      model.handleException(fspiopSource, bulkQuoteId, fspiopError, request.headers, span)
+    } finally {
+      // eslint-disable-next-line no-unsafe-finally
+      return h.response().code(Enum.Http.ReturnCodes.ACCEPTED.CODE)
+    }
   }
 }

src/handlers/bulkQuotes/{id}.js

@@ -32,30 +32,97 @@
 
 'use strict'
 
-const ErrorHandler = require('@mojaloop/central-services-error-handling')
-
+const util = require('util')
+const Enum = require('@mojaloop/central-services-shared').Enum
+const EventSdk = require('@mojaloop/event-sdk')
+const LibUtil = require('../../lib/util')
+const BulkQuotesModel = require('../../model/bulkQuotes.js')
 /**
  * Operations on /bulkQuotes/{id}
  */
 module.exports = {
   /**
-     * summary: BulkQuotesById
+     * summary: getBulkQuotesById
      * description: The HTTP request GET /bulkQuotes/<id> is used to get information regarding an earlier created or requested bulk quote. The <id> in the URI should contain the bulkQuoteId that was used for the creation of the bulk quote.
      * parameters: Accept
      * produces: application/json
      * responses: 202, 400, 401, 403, 404, 405, 406, 501, 503
      */
-  get: function BulkQuotesById (context, request, h) {
-    throw ErrorHandler.CreateFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.NOT_IMPLEMENTED, 'Bulk quotes not implemented')
+  get: async function getBulkQuotesById (context, request, h) {
+    // log request
+    request.server.log(['info'], `got a GET /bulkQuotes/{id} request for bulkQuoteId ${request.params.id}`)
+
+    // instantiate a new quote model
+    const model = new BulkQuotesModel({
+      db: request.server.app.database,
+      requestId: request.info.id
+    })
+
+    // extract some things from the request we may need if we have to deal with an error e.g. the
+    // originator and quoteId
+    const bulkQuoteId = request.params.id
+    const fspiopSource = request.headers[Enum.Http.Headers.FSPIOP.SOURCE]
+
+    const span = request.span
+    try {
+      const spanTags = LibUtil.getSpanTags(request, Enum.Events.Event.Type.BULK_QUOTE, Enum.Events.Event.Action.GET)
+      span.setTags(spanTags)
+      await span.audit({
+        headers: request.headers,
+        payload: request.payload
+      }, EventSdk.AuditEventAction.start)
+      // call the model to re-forward the quote update to the correct party
+      // note that we do not check if our caller is the correct party, but we
+      // will send the callback to the correct party regardless.
+      model.handleBulkQuoteGet(request.headers, bulkQuoteId, span)
+    } catch (err) {
+      // something went wrong, use the model to handle the error in a sensible way
+      request.server.log(['error'], `ERROR - GET /bulkQuotes/{id}: ${LibUtil.getStackOrInspect(err)}`)
+      model.handleException(fspiopSource, bulkQuoteId, err, request.headers, span)
+    } finally {
+      // eslint-disable-next-line no-unsafe-finally
+      return h.response().code(Enum.Http.ReturnCodes.ACCEPTED.CODE)
+    }
   },
   /**
-     * summary: BulkQuotesById
+     * summary: putBulkQuotesById
      * description: The callback PUT /bulkQuotes/<id> is used to inform the client of a requested or created bulk quote. The <id> in the URI should contain the bulkQuoteId that was used for the creation of the bulk quote, or the <id> that was used in the GET /bulkQuotes/<id>.
      * parameters: body, Content-Length
      * produces: application/json
      * responses: 200, 400, 401, 403, 404, 405, 406, 501, 503
      */
-  put: function BulkQuotesById1 (context, request, h) {
-    throw ErrorHandler.CreateFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.NOT_IMPLEMENTED, 'Bulk quotes not implemented')
+  put: async function putBulkQuotesById (context, request, h) {
+    // log request
+    request.server.log(['info'], `got a PUT /bulkQuotes/{id} request: ${util.inspect(request.payload)}`)
+
+    // instantiate a new quote model
+    const model = new BulkQuotesModel({
+      db: request.server.app.database,
+      requestId: request.info.id
+    })
+
+    // extract some things from the request we may need if we have to deal with an error e.g. the
+    // originator and quoteId
+    const bulkQuoteId = request.params.id
+    const fspiopSource = request.headers[Enum.Http.Headers.FSPIOP.SOURCE]
+
+    const span = request.span
+    try {
+      const spanTags = LibUtil.getSpanTags(request, Enum.Events.Event.Type.BULK_QUOTE, Enum.Events.Event.Action.FULFIL)
+      span.setTags(spanTags)
+      await span.audit({
+        headers: request.headers,
+        payload: request.payload
+      }, EventSdk.AuditEventAction.start)
+      // call the quote update handler in the model
+      model.handleBulkQuoteUpdate(request.headers, bulkQuoteId, request.payload, span)
+    } catch (err) {
+      // something went wrong, use the model to handle the error in a sensible way
+      request.server.log(['error'], `ERROR - PUT /bulkQuotes/{id}: ${LibUtil.getStackOrInspect(err)}`)
+      model.handleException(fspiopSource, bulkQuoteId, err, request.headers, span)
+    } finally {
+      // eslint-disable-next-line no-unsafe-finally
+      return h.response().code(Enum.Http.ReturnCodes.OK.CODE)
+    }
   }
 }

src/handlers/bulkQuotes/{id}/error.js

@@ -32,8 +32,11 @@
 
 'use strict'
 
-const ErrorHandler = require('@mojaloop/central-services-error-handling')
-
+const util = require('util')
+const Enum = require('@mojaloop/central-services-shared').Enum
+const EventSdk = require('@mojaloop/event-sdk')
+const LibUtil = require('../../../lib/util')
+const BulkQuotesModel = require('../../../model/bulkQuotes')
 /**
  * Operations on /bulkQuotes/{id}/error
  */
@@ -45,7 +48,38 @@ module.exports = {
      * produces: application/json
      * responses: 200, 400, 401, 403, 404, 405, 406, 501, 503
      */
-  put: function BulkQuotesErrorById (context, request, h) {
-    throw ErrorHandler.CreateFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.NOT_IMPLEMENTED, 'Bulk quotes not implemented')
+  put: async function BulkQuotesErrorById (context, request, h) {
+    // log request
+    request.server.log(['info'], `got a PUT /bulkQuotes/{id}/error request: ${util.inspect(request.payload)}`)
+
+    // instantiate a new quote model
+    const model = new BulkQuotesModel({
+      db: request.server.app.database,
+      requestId: request.info.id
+    })
+
+    // extract some things from the request we may need if we have to deal with an error e.g. the
+    // originator and quoteId
+    const bulkQuoteId = request.params.id
+    const fspiopSource = request.headers[Enum.Http.Headers.FSPIOP.SOURCE]
+
+    const span = request.span
+    try {
+      const spanTags = LibUtil.getSpanTags(request, Enum.Events.Event.Type.BULK_QUOTE, Enum.Events.Event.Action.ABORT)
+      span.setTags(spanTags)
+      await span.audit({
+        headers: request.headers,
+        payload: request.payload
+      }, EventSdk.AuditEventAction.start)
+      // call the quote error handler in the model
+      model.handleBulkQuoteError(request.headers, bulkQuoteId, request.payload.errorInformation, span)
+    } catch (err) {
+      // something went wrong, use the model to handle the error in a sensible way
+      request.server.log(['error'], `ERROR - PUT /bulkQuotes/{id}/error: ${LibUtil.getStackOrInspect(err)}`)
+      model.handleException(fspiopSource, bulkQuoteId, err, request.headers)
+    } finally {
+      // eslint-disable-next-line no-unsafe-finally
+      return h.response().code(Enum.Http.ReturnCodes.OK.CODE)
+    }
   }
 }

src/lib/util.js

@@ -33,6 +33,7 @@
 'use strict'
 
 const util = require('util')
+const crypto = require('crypto')
 const Enum = require('@mojaloop/central-services-shared').Enum
 const Logger = require('@mojaloop/central-services-logger')
 
@@ -92,9 +93,98 @@ function getSafe (path, obj) {
   return path.reduce((xs, x) => (xs && xs[x]) ? xs[x] : undefined, obj)
 }
 
+/**
+ * Utility function to remove null and undefined keys from an object.
+ * This is useful for removing "nulls" that come back from database queries
+ * when projecting into API spec objects
+ *
+ * @returns {object}
+ */
+function removeEmptyKeys (originalObject) {
+  const obj = { ...originalObject }
+  Object.keys(obj).forEach(key => {
+    if (obj[key] && typeof obj[key] === 'object') {
+      if (Object.keys(obj[key]).length < 1) {
+        // remove empty object
+        delete obj[key]
+      } else {
+        // recurse
+        obj[key] = removeEmptyKeys(obj[key])
+      }
+    } else if (obj[key] == null) {
+      // null or undefined, remove it
+      delete obj[key]
+    }
+  })
+  return obj
+}
+
+/**
+ * Generates and returns an object containing API spec compliant HTTP request headers
+ *
+ * @returns {object}
+ */
+function generateRequestHeaders (headers, noAccept) {
+  const ret = {
+    'Content-Type': headers['content-type'] || headers['Content-Type'],
+    Date: headers.date,
+    'FSPIOP-Source': headers['fspiop-source'],
+    'FSPIOP-Destination': headers['fspiop-destination'],
+    'FSPIOP-HTTP-Method': headers['fspiop-http-method'],
+    'FSPIOP-Signature': headers['fspiop-signature'],
+    'FSPIOP-URI': headers['fspiop-uri'],
+    Accept: null
+  }
+
+  if (!noAccept) {
+    ret.Accept = headers.accept || headers.Accept
+  }
+
+  return removeEmptyKeys(ret)
+}
+
+/**
+ * Generates and returns an object containing API spec compliant lowercase HTTP request headers for JWS Signing
+ *
+ * @returns {object}
+ */
+function generateRequestHeadersForJWS (headers, noAccept) {
+  const ret = {
+    'Content-Type': headers['content-type'] || headers['Content-Type'],
+    date: headers.date,
+    'fspiop-source': headers['fspiop-source'],
+    'fspiop-destination': headers['fspiop-destination'],
+    'fspiop-http-method': headers['fspiop-http-method'],
+    'fspiop-signature': headers['fspiop-signature'],
+    'fspiop-uri': headers['fspiop-uri'],
+    Accept: null
+  }
+
+  if (!noAccept) {
+    ret.Accept = headers.accept || headers.Accept
+  }
+
+  return removeEmptyKeys(ret)
+}
+
+/**
+ * Returns the SHA-256 hash of the supplied request object
+ *
+ * @returns {undefined}
+ */
+function calculateRequestHash (request) {
+  // calculate a SHA-256 of the request
+  const requestStr = JSON.stringify(request)
+  return crypto.createHash('sha256').update(requestStr).digest('hex')
+}
+
 module.exports = {
   failActionHandler,
   getSafe,
   getSpanTags,
-  getStackOrInspect
+  getStackOrInspect,
+  generateRequestHeaders,
+  generateRequestHeadersForJWS,
+  calculateRequestHash,
+  removeEmptyKeys
 }