Skip to content

feat: report xml2rfc errors for submissions#8000

Merged
rjsparks merged 11 commits intoietf-tools:mainfrom
jennifer-richards:submission-errors
Oct 17, 2024
Merged

feat: report xml2rfc errors for submissions#8000
rjsparks merged 11 commits intoietf-tools:mainfrom
jennifer-richards:submission-errors

Conversation

@jennifer-richards
Copy link
Copy Markdown
Member

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 was None and attempted to pass prep.errors back in a way that shows up on the submission history. This didn't work because prep.prep() raises an exception if prep.errors is not empty rather than returning None. 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.

May want to pass these back to the submitter, but
let's watch them to see what sorts of sanitizing we
should do first.
@codecov
Copy link
Copy Markdown

codecov Bot commented Oct 16, 2024

Codecov Report

Attention: Patch coverage is 57.44681% with 20 lines in your changes missing coverage. Please review.

Project coverage is 88.88%. Comparing base (c7f6bde) to head (98d733b).
Report is 104 commits behind head on main.

Files with missing lines Patch % Lines
ietf/submit/utils.py 57.44% 20 Missing ⚠️
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.
📢 Have feedback on the report? Share it here.

@rjsparks rjsparks merged commit de2e66e into ietf-tools:main Oct 17, 2024
@github-actions github-actions Bot locked as resolved and limited conversation to collaborators Oct 22, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants