fix(ai): improve validation error messages with better context #10154
+231
−26
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.
Background
When calling
safeValidateUIMessages, the errors were difficult to decipher since they didn't mention what was being validated (metadata, tool, etc.). This made debugging validation issues challenging for developers using the AI SDK.Summary
Enhanced the error messages in
safeValidateUIMessagesto provide better context about what's being validated:Each error now clearly indicates which part of the message structure failed validation and includes the message ID when applicable.
Manual Verification
I manually verified that the validation errors now include helpful context by running the tests and examining the error messages. For example, metadata validation errors now include "Metadata validation failed for message with ID [id]" in the error message.
Checklist
pnpm changesetin the project root)Related Issues
Fixes #10137 - Validation errors are difficult to read