[api-minor] Ensure that PDFDocumentProxy.hasJSActions won't fail if MissingDataExceptions are thrown during the associated worker-thread parsing
#13234
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
…Object
Given that this only an internal helper method, used by the `Catalog.{javaScript, jsActions}` getters, this change simplifies iteration of the returned data.
We can also (slightly) re-factor the code of the `jsActions` getter, and remove an obsolete[1] JSDoc-comment from the `openAction` getter.
---
[1] Not really relevant now that we've got proper scripting support.
… `MissingDataException`s are thrown during the associated worker-thread parsing With the current implementation of `PDFDocument.hasJSActions`, in the worker-thread, we're not actually handling not-yet-loaded data correctly. This can thus fail in *two* different ways: - The `PDFDocument.fieldObjects` getter (and its helper method), while it may *return* a Promise, still fetches all of its data synchronously and it can thus throw a `MissingDataException` during parsing. - The `Catalog.jsActions` getter, which is completely synchronous, can obviously throw a `MissingDataException` during parsing. If either of these cases occur currently, the `PDFDocumentProxy.hasJSActions` method in the API can either return a *rejected* Promise (which it never should) or possibly "hang" and never resolve. *Please note:* While I've not *yet* seen this error in an actual PDF document, it can happen during loading if you're unlucky enough with e.g. the structure of the PDF document and/or the download speed offered by the server. This patch is thus based on code-inspection *and* on manually throwing a `MissingDataException` on the first access of `Catalog.jsActions` to simulate this situation. Finally, this patch adds a couple of *API* unit-tests for this (since none existed).
|
/botio test |
From: Bot.io (Windows)ReceivedCommand cmd_test from @Snuffleupagus received. Current queue size: 0 Live output at: http://3.101.106.178:8877/81dbe4b3194315a/output.txt |
From: Bot.io (Linux m4)ReceivedCommand cmd_test from @Snuffleupagus received. Current queue size: 0 Live output at: http://54.67.70.0:8877/17bafef863cfe8e/output.txt |
From: Bot.io (Linux m4)FailedFull output at http://54.67.70.0:8877/17bafef863cfe8e/output.txt Total script time: 25.09 mins
Image differences available at: http://54.67.70.0:8877/17bafef863cfe8e/reftest-analyzer.html#web=eq.log |
From: Bot.io (Windows)FailedFull output at http://3.101.106.178:8877/81dbe4b3194315a/output.txt Total script time: 28.58 mins
Image differences available at: http://3.101.106.178:8877/81dbe4b3194315a/reftest-analyzer.html#web=eq.log |
timvandermeij
approved these changes
Apr 13, 2021
|
Nice find, and thanks for adding more unit test coverage! |
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.
With the current implementation of
PDFDocument.hasJSActions, in the worker-thread, we're not actually handling not-yet-loaded data correctly. This can thus fail in two different ways:PDFDocument.fieldObjectsgetter (and its helper method), while it may return a Promise, still fetches all of its data synchronously and it can thus throw aMissingDataExceptionduring parsing.Catalog.jsActionsgetter, which is completely synchronous, can obviously throw aMissingDataExceptionduring parsing.If either of these cases occur currently, the
PDFDocumentProxy.hasJSActionsmethod in the API can either return a rejected Promise (which it never should) or possibly "hang" and never resolve.Please note: While I've not yet seen this error in an actual PDF document, it can happen during loading if you're unlucky enough with e.g. the structure of the PDF document and/or the download speed offered by the server.
This patch is thus based on code-inspection and on manually throwing a
MissingDataExceptionon the first access ofCatalog.jsActionsto simulate this situation.Finally, this patch adds a couple of API unit-tests for this (since none existed).