-
Notifications
You must be signed in to change notification settings - Fork 5.2k
feat: implement standardized error handling for WhatsApp API responses #1918
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.
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
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
10a2c00
feat: implement standardized error handling for WhatsApp API responses
79438c9
refactor: lint fix
16c0a80
add stringify
05fcdd9
refactor: melhora na formatação do log de erro da API do WhatsApp
ab4bec3
Merge branch 'develop' into main
4378c33
Merge branch 'develop' into main_
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| import { HttpStatus } from '@api/routes/index.router'; | ||
|
|
||
| export interface MetaErrorResponse { | ||
| status: number; | ||
| error: string; | ||
| message: string; | ||
| details: { | ||
| whatsapp_error: string; | ||
| whatsapp_code: string | number; | ||
| error_user_title: string; | ||
| error_user_msg: string; | ||
| error_type: string; | ||
| error_subcode: number | null; | ||
| fbtrace_id: string | null; | ||
| context: string; | ||
| type: string; | ||
| }; | ||
| timestamp: string; | ||
| } | ||
|
|
||
| /** | ||
| * Creates standardized error response for Meta/WhatsApp API errors | ||
| */ | ||
| export function createMetaErrorResponse(error: any, context: string): MetaErrorResponse { | ||
| // Extract Meta/WhatsApp specific error fields | ||
| const metaError = error.template || error; | ||
| const errorUserTitle = metaError.error_user_title || metaError.message || 'Unknown error'; | ||
| const errorUserMsg = metaError.error_user_msg || metaError.message || 'Unknown error'; | ||
|
|
||
| return { | ||
| status: HttpStatus.BAD_REQUEST, | ||
| error: 'Bad Request', | ||
| message: errorUserTitle, | ||
| details: { | ||
| whatsapp_error: errorUserMsg, | ||
| whatsapp_code: metaError.code || 'UNKNOWN_ERROR', | ||
| error_user_title: errorUserTitle, | ||
| error_user_msg: errorUserMsg, | ||
| error_type: metaError.type || 'UNKNOWN', | ||
| error_subcode: metaError.error_subcode || null, | ||
| fbtrace_id: metaError.fbtrace_id || null, | ||
| context, | ||
| type: 'whatsapp_api_error', | ||
| }, | ||
| timestamp: new Date().toISOString(), | ||
| }; | ||
| } | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
suggestion: The error response always uses BAD_REQUEST status, which may not fit all error scenarios.
Allow the status code to be set dynamically based on the error type, so responses can accurately reflect server or authorization errors.
Suggested implementation:
You will need to update all usages of
createMetaErrorResponseto optionally pass thestatusanderrorStringparameters where appropriate, e.g.: