[api-minor] Fix the AnnotationStorage usage properly in the viewer/tests (PR 12107 and 12143 follow-up)
#12147
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
…tests (PR 12107 and 12143 follow-up)
*The [api-minor] label probably ought to have been added to the original PR, given the changes to the `createAnnotationLayerBuilder` signature (if nothing else).*
This patch fixes the following things:
- Let the `AnnotationLayer.render` method create an `AnnotationStorage`-instance if none was provided, thus making the parameter *properly* optional. This not only fixes the reference tests, it also prevents issues when the viewer components are used.
- Stop exporting `AnnotationStorage` in the official API, i.e. the `src/pdf.js` file, since it's no longer necessary given the change above. Generally speaking, unless absolutely necessary we probably shouldn't export unused things in the API.
- Fix a number of JSDocs `typedef`s, in `src/display/` and `web/` code, to actually account for the new `annotationStorage` parameter.
- Update `web/interfaces.js` to account for the changes in `createAnnotationLayerBuilder`.
- Initialize the storage, in `AnnotationStorage`, using `Object.create(null)` rather than `{}` (which is the PDF.js default).
Snuffleupagus
force-pushed
the
fix-AnnotationStorage-usage
branch
from
ad98eeb to
346afd1
Compare
… as cloning a `PageViewport`, when no annotations exist for a page
|
/botio test |
From: Bot.io (Linux m4)ReceivedCommand cmd_test from @Snuffleupagus received. Current queue size: 0 Live output at: http://54.67.70.0:8877/bf37c8009b1cde8/output.txt |
From: Bot.io (Windows)ReceivedCommand cmd_test from @Snuffleupagus received. Current queue size: 0 Live output at: http://54.215.176.217:8877/e6d0aa755e12bcc/output.txt |
From: Bot.io (Linux m4)FailedFull output at http://54.67.70.0:8877/bf37c8009b1cde8/output.txt Total script time: 26.83 mins
Image differences available at: http://54.67.70.0:8877/bf37c8009b1cde8/reftest-analyzer.html#web=eq.log |
From: Bot.io (Windows)FailedFull output at http://54.215.176.217:8877/e6d0aa755e12bcc/output.txt Total script time: 29.18 mins
Image differences available at: http://54.215.176.217:8877/e6d0aa755e12bcc/reftest-analyzer.html#web=eq.log |
timvandermeij
added
annotations
form-acroform
Gecko 81
timvandermeij
approved these changes
Jul 31, 2020
|
Thank you for improving this! |
|
I also marked the original PR as |
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.
The [api-minor] label probably ought to have been added to the original PR, given the changes to the
createAnnotationLayerBuildersignature (if nothing else).This patch fixes the following things:
AnnotationLayer.rendermethod create anAnnotationStorage-instance if none was provided, thus making the parameter properly optional. This not only fixes the reference tests, it also prevents issues when the viewer components are used.AnnotationStoragein the official API, i.e. thesrc/pdf.jsfile, since it's no longer necessary given the change above. Generally speaking, unless absolutely necessary we probably shouldn't export unused things in the API.typedefs, insrc/display/andweb/code, to actually account for the newannotationStorageparameter.web/interfaces.jsto account for the changes increateAnnotationLayerBuilder.AnnotationStorage, usingObject.create(null)rather than{}(which is the PDF.js default).