VxAdmin: Disable PDF preview/export for large reports #5343
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
jonahkagan
changed the title
jonahkagan
force-pushed
the
jonah/disable-large-report-previews
branch
from
56f307a
to
cbe3104
Compare
jonahkagan
force-pushed
the
jonah/disable-large-report-previews
branch
from
8d20bfc
to
d4567b6
Compare
carolinemodic
approved these changes
Sep 4, 2024
| @@ -88,14 +88,19 @@ export async function generateBallotCountReportPreview({ | |||
|
|
|||
| ...reportProps | |||
| }: BallotCountReportPreviewProps): Promise<BallotCountReportPreview> { | |||
| const report = buildBallotCountReport(reportProps); | |||
| await logger.logAsCurrentRole(LogEventId.ElectionReportPreviewed, { | |||
| message: `User previewed a ballot count report.`, | |||
| disposition: 'success', | |||
There was a problem hiding this comment.
is it possible to make this log as a failure if there is an error in getting the report preview?
There was a problem hiding this comment.
good call, thanks 2bdba80
| @@ -121,12 +120,18 @@ export async function generateTallyReportPreview({ | |||
| message: `User previewed a tally report.`, | |||
| disposition: 'success', | |||
| /** | ||
| * Returns a PDF preview of the write-in adjudication report, as a buffer. | ||
| */ | ||
| export async function generateWriteInAdjudicationReportPreview({ | ||
| logger, | ||
|
|
||
| ...reportProps | ||
| }: WriteInAdjudicationReportPreviewProps): Promise<Buffer> { | ||
| }: WriteInAdjudicationReportPreviewProps): Promise<WriteInAdjudicationReportPreview> { | ||
| const report = buildWriteInAdjudicationReport(reportProps); | ||
| await logger.logAsCurrentRole(LogEventId.ElectionReportPreviewed, { | ||
| message: `User previewed the write-in adjudication report.`, | ||
| disposition: 'success', |
Chromium crashes with an out of memory error when trying to generate a PDF for very large documents. Set a limit well below that point to prevent crashes and return a usable error code.
We'll use the preview error to disable the buttons to print/export PDF reports, so we don't need to propagate those errors.
At around 100 pages, the browser starts crashing occasionally during scrolling. To prevent this, set a conservative limit of 50 pages.
Previously, reports with no data showed up as a blank page. Instead, we don't render them at all.
In the report builder, changing the parameters would remove the current PDF preview but leave the page count.
We don't expect any of these PDFs to reach the length limit. If they do, it's an unexpected error, so we can crash explicitly, since that's an improvement over hanging or crashing with a Chromium error.
jonahkagan
force-pushed
the
jonah/disable-large-report-previews
branch
from
d4567b6
to
40d199c
Compare
jonahkagan
force-pushed
the
jonah/disable-large-report-previews
branch
from
40d199c
to
2bdba80
Compare
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.
Overview
Fixes: #5278
When report PDFs are very very long (~1000 pages), Chromium will crash when trying to render them. In addition, the frontend PDF preview can crash at ~100 pages.
To prevent this, we set two limits:
This PR also fixes two small bugs:
Demo Video or Screenshot
Screen.Recording.2024-08-29.at.4.49.19.PM.mov
Testing Plan
To set the limits, I tested a variety of content lengths and chose conservative numbers. I also updated automated tests
Checklist