Introduce new states for XML Validation #2804
Merged
Conversation
This file contains hidden or 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
josephsnyder
force-pushed
the
introdue_submission_validation_enum
branch
from
2d82def to
b3e3841
Compare
williamjallen
requested changes
Apr 15, 2025
josephsnyder
force-pushed
the
introdue_submission_validation_enum
branch
from
b3e3841 to
5e53cf4
Compare
williamjallen
requested changes
Apr 16, 2025
josephsnyder
force-pushed
the
introdue_submission_validation_enum
branch
2 times, most recently
from
bd28661 to
43d3b75
Compare
williamjallen
requested changes
Apr 18, 2025
| $this->failProcessing($filename, 400, "XML validation failed for $filename:" . PHP_EOL . $e->getMessage()); | ||
| } | ||
| $message = $e->getMessage(); | ||
| Log::info($message); |
There was a problem hiding this comment.
You could use report() here to include the stack trace in the log while reporting back a nicer error to the user.
Suggested change
| Log::info($message); | |
| report($e); |
Comment on lines
164
to
166
| $message = "XML validation failed: Found issues with file $filename:" . PHP_EOL . $error_string; | ||
| // We always log validation failures, but we only send messages back to the client if configured to do so | ||
| Log::warning("Submission validation failed for file '$filename':" . PHP_EOL); | ||
| if ((bool) config('cdash.validate_xml_submissions') === true) { | ||
| $this->failProcessing($filename, 400, "XML validation failed: rejected file $filename:" . PHP_EOL . $error_string); | ||
| Log::info($message); |
There was a problem hiding this comment.
Logging this entire message including all of the specific errors could result in very lengthy error messages in the logs. Additionally, I think we should avoid multi-line log messages in general unless there is a good rationale for it. Perhaps just report the "XML validation failed: Found issues with file $filename:" part in the logs and send the rest back to the user?
josephsnyder
force-pushed
the
introdue_submission_validation_enum
branch
4 times, most recently
from
e6ed50c to
603448f
Compare
williamjallen
requested changes
Apr 23, 2025
Change the name of the environment variable from VALIDATE_XML_SUBMISSIONS
to VALIDATE_SUBMISSIONS
Change the handling of the XML validation in the environment to be a
string setting instead of a boolean.
The new state should be as follows
No Value or "SILENT": Log a message in the CDash logs and attempt to parse XML
"WARN" : Log, return a message with a warning label in the
http response of the submission, and attempt to parse XML
"REJECT" : Log and return 400 to prevent further submissions and do not attempt
to process the XML
josephsnyder
force-pushed
the
introdue_submission_validation_enum
branch
from
603448f to
e2c8de2
Compare
williamjallen
approved these changes
Apr 23, 2025
github-merge-queue bot
pushed a commit
that referenced
this pull request
May 12, 2025
The "email administrator" project setting has gradually become obsolete, now only used to report submissions which cannot be parsed. This is no longer necessary in light of our [recent effort](#2804) to rethink the submission validation process. This PR removes the setting and all related logic.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Change the name of the environment variable from VALIDATE_XML_SUBMISSIONS to VALIDATE_SUBMISSIONS
Change the handling of the XML validation in the environment to be a string setting instead of a boolean.
The new state should be as follows
No Value or "SILENT": Log a message in the CDash logs and attempt to parse XML
"WARN" : Log, return a message with a warning label in the
http response of the submission, and attempt to parse XML
"REJECT" : Log and return 400 to prevent further submissions and do not attempt
to process the XML