Skip to content

964-CreateHapiPluginToValidateErrorCodesOnPreHandler #72

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rmothilal merged 13 commits into from
Oct 1, 2019
Merged

964-CreateHapiPluginToValidateErrorCodesOnPreHandler #72

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
cd8ab00
964-CreateHapiPluginToValidateErrorCodesOnPreHandler
Sep 19, 2019
062e03a
964-ValidateErrorCodes
Sep 24, 2019
a3d62c3
964-ValidateIncomingErrorCodes
gibaros Sep 27, 2019
32dbb1f
964-ValidateIncomingErrorCodes
gibaros Sep 27, 2019
c3ff629
964-ValidateIncomingErrorCodes
gibaros Sep 27, 2019
fc70aa5
964-FixVulnerabilityCheck
gibaros Oct 1, 2019
580ad42
Issue964-AddAndConfigureNyc
gibaros Oct 1, 2019
416ab0a
Issue964-UpdateDependencies
gibaros Oct 1, 2019
6a09752
Issue964-RenameAuditResolvToAuditResolve
gibaros Oct 1, 2019
8c6f207
Issue964-RenameOnPreHandlerToValidateIncomingErrorCode
gibaros Oct 1, 2019
27dfe15
RemovedUnusedSinonImport
gibaros Oct 1, 2019
2dc3ded
Issue964-BumpRepoVersionTo8dot2dot0
gibaros Oct 1, 2019
19e794e
Issue964-UpdateNcurcAndNycrc
gibaros Oct 1, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions src/handler.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@

const Factory = require('./factory')
const Errors = require('./enums').FSPIOPErrorCodes
const ErrorFactory = require('./factory')

const getReplyToFromRequestHeaders = (request) => {
return (request.headers && request.headers['fspiop-source']) ? request.headers['fspiop-source'] : null
Expand Down Expand Up @@ -99,3 +100,34 @@ exports.onPreResponse = function (request, reply) {

return reply.continue
}

/**
* Function to be used to handle the 'onPreHandler' Hapi server extension.
* This validates the error is a FSPIOPError and that it contains a valid error code
* format as per section 7.6 of "API Definition v1.0.docx".
*
* @param request the http request
* @param reply
* @returns {boolean|reply.continue|continue|((key?: IDBValidKey) => void)}
*/
exports.onPreHandler = function (request, reply) {
const response = request.response
let incomingErrorCode
if (response instanceof ErrorFactory.FSPIOPError || response.isBoom) {
try {
incomingErrorCode = response.toApiErrorObject.ErrorInformation.errorCode

@mdebarros mdebarros Sep 20, 2019

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is unnecessary overhead as you can just get the errorCode directly from the error object. Use instead response.apiErrorCode.code (ref: https://github.com/mojaloop/sdk-standard-components/blob/master/src/lib/errors/index.js#L120)

Also, I do not believe that you will be receiving an FSPIOPError here. You are going to be receiving an errorInformation object in the payload. So the above recommendation is not really applicable. You should be instead checking the request.payload.errorInformation.errorCode.

@gibaros gibaros Sep 24, 2019

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed with last commit

if (!ErrorFactory.validateFSPIOPErrorCode(incomingErrorCode)) {
// TODO: validateFSPIOPErrorCode throws an exception if code is not valid at which point
// we nee to call response.takeover()
// response.takeover(ErrorFactory.createFSPIOPError(Errors.VALIDATION_ERROR, `The incoming error code: ${incomingErrorCode} is not a valid mojaloop specification error code`))
return reply.response(ErrorFactory.createFSPIOPError(Errors.VALIDATION_ERROR, `The incoming error code: ${incomingErrorCode} is not a valid mojaloop specification error code`)).code(400)

@mdebarros mdebarros Sep 20, 2019

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two things here:

  1. I believe you need to add the .takeover() at the end of the calling stack
  2. You will need to ensure that you toApiErrorObject the error is also called on the FSPIOPError assuming that the prehandler is skipped (which would have done this for you). Please verify if this is required.

@gibaros gibaros Sep 24, 2019

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed with last commit

}
} catch (err) {
// TODO: validateFSPIOPErrorCode throws an exception if code is not valid at which point
// we nee to call response.takeover()
// response.takeover(ErrorFactory.createFSPIOPError(Errors.VALIDATION_ERROR, `The incoming error code: ${incomingErrorCode} is not a valid mojaloop specification error code`))
return reply.response(ErrorFactory.createFSPIOPError(Errors.VALIDATION_ERROR, `The incoming error code: ${incomingErrorCode} is not a valid mojaloop specification error code`)).code(400)

@mdebarros mdebarros Sep 20, 2019

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Point 2 above applies here as well.

@gibaros gibaros Sep 24, 2019

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed with last commit

}
}
return reply.continue
}
8 changes: 8 additions & 0 deletions src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,13 @@ const plugin = {
}
}

const validateFspioperrorCodeByCategoryPlugin = {
name: 'validate-fspioperror-code-by-category',
register: function (server) {
server.ext('onPreHandler', Handler.onPreHandler)
}
}

const validateRoutes = (options = {}) => {
options.abortEarly = false
const language = options.language || {}
Expand All @@ -54,6 +61,7 @@ const validateRoutes = (options = {}) => {

module.exports = {
plugin,
validateFspioperrorCodeByCategoryPlugin,
validateRoutes,
Factory: Factory,
Enums: Enums,
Expand Down