feat: add ValidationException #694
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
WHAT? Add `ValidationException` and throw it when `signRequest()` or `verifyRequest()` fail validation. WHY? When there's a validation error a `runtypes.ValidationError` is thrown. This is an internal implementation detail and as such, there is no supported way of detecting validation errors. Similar to [contentful#692], so that developers can: ```ts import { ValidationException, verifyRequest } from '@contentful/node-apps-toolkit' try { verifyRequest(/* ...*/) } catch (e) { if (e instanceof ValidationException) { if (e.constraintName === 'SecretLength') { // this is unexpected, return 500 status code and alarm } else { // this is expected, should return 400 or 403 status code } } } ``` [contentful#692]: contentful#692
marcogrcr
commented
Aug 27, 2024
There was a problem hiding this comment.
Note: This is the same as src/typings/validators.ts. The only difference is that all objects are wrapped in proxyValidationError().
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
WHAT?
Add
ValidationExceptionand throw it whensignRequest()orverifyRequest()fail validation.WHY?
When there's a validation error a
runtypes.ValidationErroris thrown. This is an internal implementation detail and as such, there is no supported way of detecting validation errors.Similar to #692, so that developers can: