Skip to content

feat: Improve Semantic Manifest validation error messages with detailed error info #11549

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

crStiv
Copy link

@crStiv crStiv commented Apr 28, 2025

Resolves #9849

Problem

The current error message for Semantic Manifest validation failures is not informative enough. When validation fails, users only see a generic message "Semantic Manifest validation failed" without any details about what specific validation errors occurred. This makes it difficult for users to understand and fix issues with their Semantic Manifest.

Solution

I've improved the error message by including the specific validation errors in the failure message. Now when validation fails, the error message will contain all the individual validation errors with descriptive messages for each issue detected.

Specifically:

  1. Modified the validate() method in SemanticManifest class to return a list of validation errors instead of just a boolean
  2. Updated the code in the manifest parser to use these validation errors in the error message
  3. Added tests to verify the improved error handling

This change makes it much easier for users to understand and fix validation errors in their Semantic Manifests.

Checklist

  • I have read the contributing guide and understand what's expected of me.
  • I have run this code in development, and it appears to resolve the stated issue.
  • This PR includes tests, or tests are not required or relevant for this PR.
  • This PR has no interface changes (e.g., macros, CLI, logs, JSON artifacts, config files, adapter interface, etc.) or this PR has already received feedback and approval from Product or DX.
  • This PR includes type annotations for new and modified functions.

@crStiv crStiv requested a review from a team as a code owner April 28, 2025 20:00
Copy link

cla-bot bot commented Apr 28, 2025

Thanks for your pull request, and welcome to our community! We require contributors to sign our Contributor License Agreement and we don't seem to have your signature on file. Check out this article for more information on why we have a CLA.

In order for us to review and merge your code, please submit the Individual Contributor License Agreement form attached above above. If you have questions about the CLA, or if you believe you've received this message in error, please reach out through a comment on this PR.

CLA has not been signed by users: @crStiv

Copy link
Contributor

Thank you for your pull request! We could not find a changelog entry for this change. For details on how to document a change, see the contributing guide.

@github-actions github-actions bot added the community This PR is from a community member label Apr 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community This PR is from a community member
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature] Improve Semantic Manifest parsing error message
1 participant