feat: report xml2rfc errors for submissions #8000
Merged
Conversation
This file contains 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
May want to pass these back to the submitter, but let's watch them to see what sorts of sanitizing we should do first.
This reverts commit 959c54d.
This time without reformatting all the imports
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #8000 +/- ##
==========================================
+ Coverage 88.78% 88.88% +0.09%
==========================================
Files 296 304 +8
Lines 41320 41313 -7
==========================================
+ Hits 36687 36720 +33
+ Misses 4633 4593 -40 ☔ View full report in Codecov by Sentry. |
rjsparks
approved these changes
Oct 17, 2024
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This should help with #5696 and other issues related to opaque / unhelpful feedback when a submission fails.
The main improvement here is to fix a bug when calling
prep.prep(). Previously, the code checked whether its result wasNoneand attempted to passprep.errorsback in a way that shows up on the submission history. This didn't work becauseprep.prep()raises an exception ifprep.errorsis not empty rather than returningNone. With that fixed, the list of errors should appear on the submission page as intended.Before diagnosing that detail, I'd started down the path of capturing the output from xml2rfc with the intention of making that available to the submitter. That might be useful but it is also likely to reveal internal filesystem paths. Thus, instead of making it available, for now I'm just logging it. We can review this to decide whether it's useful and what sort of sanitizing will be needed.