Skip to content
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

buck2_validation: tweak and slightly improve error message #769

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

thoughtpolice
Copy link
Contributor

Previously, when using ValidationInfo() with a failure, it ends up turning out an awkward message that turns

{ "status": "failure", "message": "you failed the test!" }

into

"you failed the test!".

After this patch, it comes out as:

you failed the test!

Which seems much more reasonable and easy to parse. It also gives the validation message more control over the punctuation.

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Sep 4, 2024
@thoughtpolice thoughtpolice force-pushed the aseipp/push-uxtzlovqlops branch 4 times, most recently from b7f8aaf to d93ae63 Compare September 8, 2024 22:26
@thoughtpolice thoughtpolice force-pushed the aseipp/push-uxtzlovqlops branch 2 times, most recently from 24e0bcf to 8b24471 Compare September 20, 2024 22:15
@thoughtpolice thoughtpolice force-pushed the aseipp/push-uxtzlovqlops branch from 8b24471 to 010f9b3 Compare September 29, 2024 01:28
@thoughtpolice thoughtpolice force-pushed the aseipp/push-uxtzlovqlops branch 2 times, most recently from e3b9f8d to 7aacdf1 Compare October 16, 2024 20:35
@thoughtpolice thoughtpolice force-pushed the aseipp/push-uxtzlovqlops branch from 7aacdf1 to 47c4740 Compare October 20, 2024 20:35
@thoughtpolice thoughtpolice force-pushed the aseipp/push-uxtzlovqlops branch from 47c4740 to ee9f2b1 Compare October 28, 2024 19:48
@thoughtpolice thoughtpolice force-pushed the aseipp/push-uxtzlovqlops branch 2 times, most recently from 43e16f1 to ab62fdc Compare November 12, 2024 22:29
Previously, when using `ValidationInfo()` with a failure, it ends up turning out
an awkward message that turns

    { "status": "failure", "message": "you failed the test!" }

into

    "you failed the test!".

After this patch, it comes out as:

    you failed the test!

Which seems much more reasonable and easy to parse. It also gives the validation
message more control over the punctuation.

Signed-off-by: Austin Seipp <[email protected]>
@thoughtpolice thoughtpolice force-pushed the aseipp/push-uxtzlovqlops branch from ab62fdc to 4705939 Compare November 19, 2024 23:05
Copy link
Contributor

@blackm00n blackm00n left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

First of all, thanks for the PR! @thoughtpolice do you mind also fixing the tests since we check the how validation messages are rendered in our e2e suite?

Comment on lines 43 to 48
pub(crate) fn rendered_message(&self) -> Cow<str> {
self.short_message.as_deref().map_or_else(
|| Cow::Borrowed("Diagnostic message is missing from validation result"),
|x| Cow::Owned(format!("\"{}\"", x)),
|x| Cow::Owned(format!("{}", x)),
)
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With this change it could be just simplified to return &str:

pub(crate) fn rendered_message(&self) -> &str {
    self.short_message.as_deref().unwrap_or("Diagnostic message is missing from validation result")
}

@facebook-github-bot
Copy link
Contributor

@facebook-github-bot has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants