Consolidate 'finalize' result summaries into a single file #177
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
Pull Request Test Coverage Report for Build 15786856642Details
💛 - Coveralls |
jonavellecuerdo
force-pushed
the
IN-1323-improve-methods-for-processing-result-messages
branch
from
dc67866 to
3781203
Compare
Base automatically changed from
IN-1323-improve-methods-for-processing-result-messages
to
main
June 20, 2025 13:48
Why these changes are being introduced: * Simplify generated report via 'finalize' by keeping all DSS results for a batch in a single file How this addresses that need: * Update 'finalize' Jinja reporting templates to read all results from Workflow.events.processed_items * Create FinalizeReport.create_summary method to create content of email body * Fix Docker build and publish commands in Makefile Side effects of this change: * The emailed report sent via the 'finalize' command will comprise of a single CSV file attachment, containing the information from all parsed DSS result messages. Relevant ticket(s): * https://mitlibraries.atlassian.net/browse/IN-1320
jonavellecuerdo
force-pushed
the
IN-1320-consolidate-results-in-finalize-report
branch
from
9b5ac47 to
9e6705c
Compare
ghukill
approved these changes
Jun 20, 2025
There was a problem hiding this comment.
Approved! Consolidating seems like a no-brainer here.
One comment, totally optional, might be to reorder the columns in the report. Looking at the CSV I see the following column order:
item_identifier,result_message_body,ingested,dspace_handle,error
I think moving the more debugging-esque column result_message_body to the end could be helpful. I might propose an order like:
item_identifier,ingested,dspace_handle,error,result_message_body
But looks good otherewise.
Comment on lines
73
to
87
| def to_plain_text(self) -> str: | ||
| return self.jinja_template_plain_text.render( | ||
| workflow_name=self.workflow_name, | ||
| batch_id=self.batch_id, | ||
| report_date=self.report_date, | ||
| processed_items=self.events.processed_items, | ||
| ingested_items=self.get_ingested_items(), | ||
| errors=self.events.errors, | ||
| summary=self.create_summary(), | ||
| ) | ||
|
|
||
| def to_html(self) -> str: | ||
| return self.jinja_template_html.render( | ||
| workflow_name=self.workflow_name, | ||
| batch_id=self.batch_id, | ||
| report_date=self.report_date, | ||
| processed_items=self.events.processed_items, | ||
| ingested_items=self.get_ingested_items(), | ||
| errors=self.events.errors, | ||
| summary=self.create_summary(), | ||
| ) |
ehanson8
reviewed
Jun 20, 2025
jonavellecuerdo
deleted the
IN-1320-consolidate-results-in-finalize-report
branch
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.
Purpose and background context
Simplify generated report via 'finalize' by keeping all DSS results for a batch in a single file
Note: DO NOT MERGE UNTIL PR #176 is approved and merged! These changes build on the work in PR #176.
How can a reviewer manually see the effects of these changes?
A test run using a small sample of OpenCourseWare files was performed. The screenshot and file attachment shared below are from the email sent on June 16, 2025 at 10:24AM EST with subject heading:
DSpace Submission Results - opencourseware, batch='opencourseware-2025-04-22-stepfunctiontest'.finalizecommandIncludes new or updated dependencies?
NO
Changes expectations for external applications?
NO
What are the relevant tickets?
Developer
Code Reviewer(s)