fix: extract clean error messages from API responses#64
Merged
Conversation
When API requests fail with non-JSON responses (like HTML error pages), error messages now show the HTTP status code (e.g., "HTTP 521 Web Server Is Down") instead of serializing the entire response body. Added getApiErrorMessage(error, response) utility that extracts clean error messages from ODS, OCAPI, and SCAPI error patterns with HTTP status fallback.
Update CLI command development and API client development skills to document the new getApiErrorMessage utility for handling API errors cleanly.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
When API requests fail with non-JSON responses (like HTML error pages from stopped sandboxes), error messages now show the HTTP status code instead of serializing the entire response body.
Before:
ERROR: Failed to fetch sites: <!DOCTYPE html><html lang="en">...After:
ERROR: Failed to fetch sites: HTTP 521 Web Server Is DownChanges
Added
getApiErrorMessage(error, response)utility in@salesforce/b2c-tooling-sdk/clientsthat extracts clean error messages from multiple API error patterns:error.error.messageerror.fault.messageerror.detailorerror.titleUpdated all CLI commands that were using
String(error)orJSON.stringify(error)to use the new utility:sites listscapi custom statusscapi schemas list/getslas clientcommands (5 files)odscommands (6 files)Added comprehensive test coverage for the new utility