Add structured error metadata for validation failures#145
Open
GBOYEE wants to merge 1 commit into
Open
Conversation
Adds field/reason/valueType metadata to all GuildPassError throws in validation.ts and sdkConfig.ts. Consumers can now identify which field failed without parsing human-readable message strings. Fixes Adamantine-guild#129
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.
Fixes #129
What changed
Added structured
field,reason, andvalueTypemetadata to allGuildPassErrorthrows across:src/utils/validation.ts—validateAddress,validateGuildId,validateResourceId,validateRoleIdsrc/config/sdkConfig.ts—validateConfig(apiUrl, timeoutMs, cacheTtl, sendClientMetadata, clientName, clientVersion, retry config, fetch transport)Why
Consumers currently have to parse human-readable error messages to determine which field failed. The new
detailsobject provides a machine-readable contract:Tests
tests/validation-metadata.test.ts— covers all validation helperstests/config-validation-metadata.test.ts— covers config validation paths