feat(RECAPDocument): Validate attachment number against document type #4703
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
…ocument_type - Added validation to ensure attachment_number is null for main PACER documents. - Moved the preexisting attachment validation from othe save method to the clean method to enhance separation of concerns. - Updated save to call clean ensuring model-wide validation
…ark a doc as an attachment
… ATTACHMENT for RECAPDocuments with attachment_number
- Separated handling of `DoesNotExist` and `MultipleObjectsReturned` exceptions in the document creation process. - Added logging for cases where multiple `RECAPDocument` objects are unexpectedly returned. - Retained existing behavior of creating a new `RECAPDocument` in these cases, with Sentry logging for future debugging.
- Refined error message to reflect possible causes, including unique constraint violations or document type validation issues.
- Added the `attach_stacktrace` setting in Sentry configuration to include stack traces in logged errors.
…ean method - Added tests to verify that attachments must have an attachment_number. - Ensured main PACER documents do not have an attachment_number. - Checked that appropriate ValidationErrors are raised with correct messages. - Confirmed that valid scenarios save without errors.
mlissner
approved these changes
Nov 18, 2024
ERosendo
approved these changes
Nov 19, 2024
There was a problem hiding this comment.
@elisa-a-v Code looks good. Thanks for updating the comments. There's just one small detail we need to address before merging.
Suspect IssuesThis pull request was deployed and Sentry observed the following issues:
Did you find this useful? React with a 👍 or 👎 |
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.
Resolves #3982
This PR adds a model-wide validation for the RECAPDocument model that checks that:
It also fixes an issue where previously empty RECAPDocuments didn't have their document_type updated, so if the
rdwas an attachment, the attachment number was added but the document type remained as a main PACER document. We now update the document type every time, so this should not happen again.Given the nature of the changes, we're now logging errors in several places for future troubleshooting, and a new sentry setting was added which enables attaching the entire stack trace to sentry logs.
this also adds tests and updates docs to reflect changes.