[api-minor] Add an option, in PDFDocumentProxy.cleanup, to allow fonts to remain attached to the DOM
#13172
Conversation
These two properties were *never* intended to be anything but "private", hence it really cannot hurt to actually indicate that they're *not* part of any official API.
…nts to remain attached to the DOM As mentioned in the JSDoc comment, this should not be used unless you know what you're doing, since it will lead to increased memory usage. However, in some situations (e.g. SVG-rendering), we still want to be able to run general clean-up on both the main/worker-thread while keeping loaded fonts attached to the DOM.[1] As part of these changes, `WorkerTransport.startCleanup` is converted to an async method and we'll also skip clean-up when destruction has started (since it's redundant). --- [1] The SVG-rendering mode is obviously not officially supported, since it's both rather incomplete and inherently slower. However with recent changes, whereby we cache repeated images on the document rather than the page level, memory usage can be *a lot* worse than before if we never attempt to release e.g. cached image-data when the viewer is in SVG-rendering mode.
Snuffleupagus
force-pushed
the
cleanup-keepFonts
branch
from
0c389cb to
232fbd2
Compare
|
/botio unittest |
From: Bot.io (Windows)ReceivedCommand cmd_unittest from @Snuffleupagus received. Current queue size: 0 Live output at: http://3.101.106.178:8877/162fba9695290ad/output.txt |
From: Bot.io (Linux m4)ReceivedCommand cmd_unittest from @Snuffleupagus received. Current queue size: 0 Live output at: http://54.67.70.0:8877/fc420404f90c703/output.txt |
From: Bot.io (Linux m4)SuccessFull output at http://54.67.70.0:8877/fc420404f90c703/output.txt Total script time: 3.71 mins
|
From: Bot.io (Windows)SuccessFull output at http://3.101.106.178:8877/162fba9695290ad/output.txt Total script time: 6.77 mins
|
|
This is inspired by, and extends, the functionality implemented in https://github.com/mozilla/pdf.js/pull/13146/files#diff-082d6b37ad01db7ac97cc07c6ddb0dc52040484c5ef91b110b072f50144d9f39 since as outlined above this makes general sense to expose in the API. |
|
Looks good! Given that a new release with |
As mentioned in the JSDoc comment, this should not be used unless you know what you're doing, since it will lead to increased memory usage. However, in some situations (e.g. SVG-rendering), we still want to be able to run general clean-up on both the main/worker-thread while keeping loaded fonts attached to the DOM.[1]
As part of these changes,
WorkerTransport.startCleanupis converted to an async method and we'll also skip clean-up when destruction has started (since it's redundant).[1] The SVG-rendering mode is obviously not officially supported, since it's both rather incomplete and inherently slower. However with recent changes, whereby we cache repeated images on the document rather than the page level, memory usage can be a lot worse than before if we never attempt to release e.g. cached image-data when the viewer is in SVG-rendering mode.