feat(openapi): throw OpenAPIValidatorMiddlewareError #446
Conversation
🦋 Changeset detectedLatest commit: a6151c5 The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
✅ Deploy Preview for openpayments-preview canceled.
|
mkurapov
changed the title
| @@ -0,0 +1,8 @@ | |||
| --- | |||
| '@interledger/openapi': major | |||
There was a problem hiding this comment.
I think it should be major since it changes how createValidatorMiddleware is used.
But don't mind using minor since its just Rafiki using it
There was a problem hiding this comment.
Major sounds right, if I'm understanding correctly. This will break consumers where NODE_ENV is production and a response will fail validation.
| const validateResponse = | ||
| process.env.NODE_ENV !== 'production' && | ||
| spec.createResponseValidator(options) |
There was a problem hiding this comment.
I feel like directly using process.env.NODE_ENV is not a fun time.
Will update Rafiki to have validationOptions.validateReponse: process.env.NODE_ENV !== 'production' instead
| } else if (isValidationError(err)) { | ||
| ctx.throw(err.status ?? 500, err.errors[0]) | ||
| } else { | ||
| console.log('err=', err) |
There was a problem hiding this comment.
removing pesky console.log here
packages/openapi/src/index.ts
Outdated
| status?: number | ||
| errors: string[] | ||
| errors: ReturnType<typeof errorTransformer>[] |
There was a problem hiding this comment.
The return type of errorTransformer is
{
message: string
}Might it make sense to define that and use it here and the errorTransformer signature?
There was a problem hiding this comment.
Yup, I think I went with this since I didn't have a good name for the type 😆
There was a problem hiding this comment.
Notice that I didn't offer a name myself lol
Changes proposed in this pull request
Changes to the
createValidatorMiddlewarebehaviour inpackages/openapi:OpenAPIValidatorMiddlewareErrorinstead of directly using Koa'sctx.throwfunction. This error class hasmessageandstatusproperties that describe the exact validation error as well as the status code that should be thrown.validationOptionsargument that determines whether to validate just the request, the response or both. By default, both are validated, and the middleware no longer usesprocess.env.NODE_ENVto determine whether to validate the response or not.Context
Fixes #445