Added synchronous responses for rules engine invalid quote errors (#127)

* Added synchronous responses for rules engine invalid quote errors

* Corrected import

* Corrected error variable name

* Moved response handling out of model, into handlers

* Fixed tests

package.json

@@ -61,6 +61,7 @@
     "@mojaloop/central-services-shared": "8.7.1",
     "@mojaloop/event-sdk": "8.6.2",
     "@mojaloop/ml-number": "8.2.0",
+    "@mojaloop/sdk-standard-components": "^8.6.9",
     "axios": "0.19.0",
     "blipp": "4.0.1",
     "eslint-config-standard": "14.1.0",

src/handlers/quotes.js

@@ -78,14 +78,13 @@ module.exports = {
       // call the quote request handler in the model
       const result = await model.handleQuoteRequest(request.headers, request.payload, span)
       request.server.log(['info'], `POST quote request succeeded and returned: ${util.inspect(result)}`)
+      return h.response().code(Enum.Http.ReturnCodes.ACCEPTED.CODE)
     } catch (err) {
       // something went wrong, use the model to handle the error in a sensible way
       request.server.log(['error'], `ERROR - POST /quotes: ${LibUtil.getStackOrInspect(err)}`)
       const fspiopError = ErrorHandler.ReformatFSPIOPError(err)
-      await model.handleException(fspiopSource, quoteId, fspiopError, request.headers, span)
-    } finally {
-      // eslint-disable-next-line no-unsafe-finally
-      return h.response().code(Enum.Http.ReturnCodes.ACCEPTED.CODE)
+      const { body, code } = await model.handleException(fspiopSource, quoteId, fspiopError, request.headers, span)
+      return h.response(body).code(code)
     }
   }
 }

src/handlers/quotes/{id}.js

@@ -78,13 +78,12 @@ module.exports = {
       // will send the callback to the correct party regardless.
       const result = await model.handleQuoteGet(request.headers, quoteId, span)
       request.server.log(['info'], `GET quotes/{id} request succeeded and returned: ${util.inspect(result)}`)
+      return h.response().code(202)
     } catch (err) {
       // something went wrong, use the model to handle the error in a sensible way
       request.server.log(['error'], `ERROR - GET /quotes/{id}: ${LibUtil.getStackOrInspect(err)}`)
-      await model.handleException(fspiopSource, quoteId, err, request.headers, span)
-    } finally {
-      // eslint-disable-next-line no-unsafe-finally
-      return h.response().code(202)
+      const { body, code } = await model.handleException(fspiopSource, quoteId, err, request.headers, span)
+      return h.response(body).code(code)
     }
   },
 
@@ -121,13 +120,12 @@ module.exports = {
       // call the quote update handler in the model
       const result = await model.handleQuoteUpdate(request.headers, quoteId, request.payload, span)
       request.server.log(['info'], `PUT quote request succeeded and returned: ${util.inspect(result)}`)
+      return h.response().code(202)
     } catch (err) {
       // something went wrong, use the model to handle the error in a sensible way
       request.server.log(['error'], `ERROR - PUT /quotes/{id}: ${LibUtil.getStackOrInspect(err)}`)
-      await model.handleException(fspiopSource, quoteId, err, request.headers, span)
-    } finally {
-      // eslint-disable-next-line no-unsafe-finally
-      return h.response().code(202)
+      const { body, code } = await model.handleException(fspiopSource, quoteId, err, request.headers, span)
+      return h.response(body).code(code)
     }
   }
 }

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

@@ -76,13 +76,12 @@ module.exports = {
       // call the quote error handler in the model
       const result = await model.handleQuoteError(request.headers, quoteId, request.payload.errorInformation, span)
       request.server.log(['info'], `PUT quote error request succeeded and returned: ${util.inspect(result)}`)
+      return h.response().code(Enum.Http.ReturnCodes.OK.CODE)
     } catch (err) {
       // something went wrong, use the model to handle the error in a sensible way
       request.server.log(['error'], `ERROR - PUT /quotes/{id}/error: ${LibUtil.getStackOrInspect(err)}`)
-      await model.handleException(fspiopSource, quoteId, err, request.headers)
-    } finally {
-      // eslint-disable-next-line no-unsafe-finally
-      return h.response().code(Enum.Http.ReturnCodes.OK.CODE)
+      const { body, code } = await model.handleException(fspiopSource, quoteId, err, request.headers, span)
+      return h.response(body).code(code)
     }
   }
 }

src/model/quotes.js

@@ -37,6 +37,7 @@ const axios = require('axios')
 const crypto = require('crypto')
 const util = require('util')
 
+const { MojaloopApiErrorCodes } = require('@mojaloop/sdk-standard-components').Errors
 const ENUM = require('@mojaloop/central-services-shared').Enum
 const ErrorHandler = require('@mojaloop/central-services-error-handling')
 const EventSdk = require('@mojaloop/event-sdk')
@@ -826,7 +827,28 @@ class QuotesModel {
     const childSpan = span.getChild('qs_quote_sendErrorCallback')
     try {
       await childSpan.audit({ headers, params: { quoteId } }, EventSdk.AuditEventAction.start)
-      return await this.sendErrorCallback(fspiopSource, fspiopError, quoteId, headers, childSpan)
+      const syncErrorCodes = [
+        MojaloopApiErrorCodes.MISSING_ELEMENT.code,
+        MojaloopApiErrorCodes.PAYEE_ERROR.code,
+        MojaloopApiErrorCodes.PAYEE_UNSUPPORTED_CURRENCY.code,
+        MojaloopApiErrorCodes.PAYER_ERROR.code,
+        MojaloopApiErrorCodes.PAYER_UNSUPPORTED_CURRENCY.code
+      ];
+      if (error.name === 'FSPIOPError' && syncErrorCodes.includes(error.apiErrorCode.code)) {
+        // We should respond synchronously
+        const envConfig = new Config()
+        return {
+          body: error.toApiErrorObject(envConfig.errorHandling),
+          code: ENUM.Http.ReturnCodes.BADREQUEST
+        }
+      }
+      else {
+        // We should respond asynchronously
+        await this.sendErrorCallback(fspiopSource, fspiopError, quoteId, headers, childSpan)
+        return {
+          code: ENUM.Http.ReturnCodes.ACCEPTED.CODE
+        }
+      }
     } catch (err) {
       // any-error
       // not much we can do other than log the error

test/unit/handlers/quotes.test.js

@@ -73,7 +73,7 @@ describe('/quotes', () => {
 
     it('fails to create a quote', async () => {
       // Arrange
-      const handleException = jest.fn()
+      const handleException = jest.fn(() => ({ code: Enum.Http.ReturnCodes.ACCEPTED.CODE }))
       QuotesModel.mockImplementationOnce(() => ({
         handleQuoteRequest: () => {
           throw new Error('Create Quote Test Error')

test/unit/handlers/quotes/{id}.test.js

@@ -63,7 +63,7 @@ describe('/quotes/{id}', () => {
 
     it('handles an error with the model', async () => {
       // Arrange
-      const handleException = jest.fn()
+      const handleException = jest.fn(() => ({ code: 202 }))
       QuotesModel.mockImplementationOnce(() => {
         return {
           handleQuoteGet: () => {
@@ -113,7 +113,7 @@ describe('/quotes/{id}', () => {
 
     it('handles an error with the model', async () => {
       // Arrange
-      const handleException = jest.fn()
+      const handleException = jest.fn(() => ({ code: 202 }))
       QuotesModel.mockImplementationOnce(() => {
         return {
           handleQuoteUpdate: () => {

test/unit/handlers/quotes/{id}/error.test.js

@@ -83,7 +83,7 @@ describe('/quotes/{id}', () => {
           }
         }
       }
-      const handleException = jest.fn()
+      const handleException = jest.fn(() => ({ code: Enum.Http.ReturnCodes.OK.CODE }))
       QuotesModel.mockImplementationOnce(() => {
         return {
           handleQuoteError: () => {

test/unit/model/quotes.test.js

@@ -1815,7 +1815,7 @@ describe('QuotesModel', () => {
 
       // Assert
       expect(quotesModel.sendErrorCallback).toHaveBeenCalledWith('payeefsp', expectedError, mockData.quoteId, mockData.headers, mockChildSpan)
-      expect(result).toBe(true)
+      expect(result).toStrictEqual({ code: 202 })
       expect(mockChildSpan.finish).toHaveBeenCalledTimes(1)
     })