feat: export ExpiredRequestException #692
Merged
Conversation
This file contains hidden or 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? Export `ExpiredRequestException`. WHY? So that users can: ```ts import { ExpiredRequestException, verifyRequest } from '@contentful/node-apps-toolkit' try { verifyRequest(/* ...*/) } catch (e) { if (e instanceof ExpiredRequestException) { // expiration-specific logic } } ``` Instead of doing workarounds like: ```ts import { verifyRequest } from '@contentful/node-apps-toolkit' import { ExpiredRequestException } from '@contentful/node-apps-toolkit/lib/requests/exceptions' // (...) ``` Or: ```ts try { verifyRequest(/* ... */) } catch (e) { if (e && e.constructor && e.constructor.name === 'ExpiredRequestException') { // expiration-specific logic } } ``` Both of which rely on internal implementation details. 
jjolton-contentful approved these changes Aug 23, 2024
contentful-automation bot added a commit that referenced this pull request Aug 23, 2024
# [3.7.0](v3.6.1...v3.7.0) (2024-08-23) ### Features * export ExpiredRequestException ([#692](#692)) ([c4e1390](c4e1390))
| 🎉 This PR is included in version 3.7.0 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
marcogrcr added a commit to marcogrcr/node-apps-toolkit that referenced this pull request Aug 27, 2024
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
2 participants
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?
Export
ExpiredRequestException.WHY?
So that users can:
Instead of doing workarounds like:
Or:
Both of which rely on internal implementation details.