Stop using the source-object when sending "GetDocRequest"

Looking at the code on the worker-thread, there doesn't appear to be any particular reason for placing *some* of the properties in a `source`-object when sending them with "GetDocRequest".
As is often the case the explanation for this structure is rather "for historical reasons", since originally we simply sent the `source`-object as-is. Doing that was obviously a bad idea, for a couple of reasons:
 - It makes it less clear what is/isn't actually needed on the worker-thread.
 - Sending unused properties will unnecessarily increase memory usage.
 - The `source`-object may contain unclonable data, which would break the library.
This commit is contained in:
Jonas Jenwald 2022-10-09 11:30:24 +02:00
parent c84b717773
commit 8a4f6aca97
2 changed files with 29 additions and 26 deletions

View File

@ -97,7 +97,7 @@ class WorkerMessageHandler {
const WorkerTasks = []; const WorkerTasks = [];
const verbosity = getVerbosityLevel(); const verbosity = getVerbosityLevel();
const apiVersion = docParams.apiVersion; const { docId, apiVersion } = docParams;
const workerVersion = const workerVersion =
typeof PDFJSDev !== "undefined" && !PDFJSDev.test("TESTING") typeof PDFJSDev !== "undefined" && !PDFJSDev.test("TESTING")
? PDFJSDev.eval("BUNDLE_VERSION") ? PDFJSDev.eval("BUNDLE_VERSION")
@ -142,10 +142,7 @@ class WorkerMessageHandler {
throw new Error(partialMsg + "please update to a supported browser."); throw new Error(partialMsg + "please update to a supported browser.");
} }
} }
const workerHandlerName = docId + "_worker";
const docId = docParams.docId;
const docBaseUrl = docParams.docBaseUrl;
const workerHandlerName = docParams.docId + "_worker";
let handler = new MessageHandler(workerHandlerName, docId, port); let handler = new MessageHandler(workerHandlerName, docId, port);
function ensureNotTerminated() { function ensureNotTerminated() {
@ -204,17 +201,25 @@ class WorkerMessageHandler {
return { numPages, fingerprints, htmlForXfa }; return { numPages, fingerprints, htmlForXfa };
} }
function getPdfManager(data, evaluatorOptions, enableXfa) { function getPdfManager({
data,
password,
disableAutoFetch,
rangeChunkSize,
length,
docBaseUrl,
enableXfa,
evaluatorOptions,
}) {
const pdfManagerCapability = createPromiseCapability(); const pdfManagerCapability = createPromiseCapability();
let newPdfManager; let newPdfManager;
const source = data.source; if (data) {
if (source.data) {
try { try {
newPdfManager = new LocalPdfManager( newPdfManager = new LocalPdfManager(
docId, docId,
source.data, data,
source.password, password,
handler, handler,
evaluatorOptions, evaluatorOptions,
enableXfa, enableXfa,
@ -242,19 +247,19 @@ class WorkerMessageHandler {
if (!fullRequest.isRangeSupported) { if (!fullRequest.isRangeSupported) {
return; return;
} }
// We don't need auto-fetch when streaming is enabled. // We don't need auto-fetch when streaming is enabled.
const disableAutoFetch = disableAutoFetch =
source.disableAutoFetch || fullRequest.isStreamingSupported; disableAutoFetch || fullRequest.isStreamingSupported;
newPdfManager = new NetworkPdfManager( newPdfManager = new NetworkPdfManager(
docId, docId,
pdfStream, pdfStream,
{ {
msgHandler: handler, msgHandler: handler,
password: source.password, password,
length: fullRequest.contentLength, length: fullRequest.contentLength,
disableAutoFetch, disableAutoFetch,
rangeChunkSize: source.rangeChunkSize, rangeChunkSize,
}, },
evaluatorOptions, evaluatorOptions,
enableXfa, enableXfa,
@ -279,7 +284,7 @@ class WorkerMessageHandler {
let loaded = 0; let loaded = 0;
const flushChunks = function () { const flushChunks = function () {
const pdfFile = arraysToBytes(cachedChunks); const pdfFile = arraysToBytes(cachedChunks);
if (source.length && pdfFile.length !== source.length) { if (length && pdfFile.length !== length) {
warn("reported HTTP length is different from actual"); warn("reported HTTP length is different from actual");
} }
// the data is array, instantiating directly from it // the data is array, instantiating directly from it
@ -287,7 +292,7 @@ class WorkerMessageHandler {
newPdfManager = new LocalPdfManager( newPdfManager = new LocalPdfManager(
docId, docId,
pdfFile, pdfFile,
source.password, password,
handler, handler,
evaluatorOptions, evaluatorOptions,
enableXfa, enableXfa,
@ -405,7 +410,7 @@ class WorkerMessageHandler {
ensureNotTerminated(); ensureNotTerminated();
getPdfManager(data, data.evaluatorOptions, data.enableXfa) getPdfManager(data)
.then(function (newPdfManager) { .then(function (newPdfManager) {
if (terminated) { if (terminated) {
// We were in a process of setting up the manager, but it got // We were in a process of setting up the manager, but it got

View File

@ -503,20 +503,18 @@ async function _fetchDocument(worker, source, pdfDataRangeTransport, docId) {
} }
const workerId = await worker.messageHandler.sendWithPromise( const workerId = await worker.messageHandler.sendWithPromise(
"GetDocRequest", "GetDocRequest",
// Only send the required properties, and *not* the entire `source` object.
{ {
docId, docId,
apiVersion: apiVersion:
typeof PDFJSDev !== "undefined" && !PDFJSDev.test("TESTING") typeof PDFJSDev !== "undefined" && !PDFJSDev.test("TESTING")
? PDFJSDev.eval("BUNDLE_VERSION") ? PDFJSDev.eval("BUNDLE_VERSION")
: null, : null,
// Only send the required properties, and *not* the entire object. data: source.data,
source: { password: source.password,
data: source.data, disableAutoFetch: source.disableAutoFetch,
password: source.password, rangeChunkSize: source.rangeChunkSize,
disableAutoFetch: source.disableAutoFetch, length: source.length,
rangeChunkSize: source.rangeChunkSize,
length: source.length,
},
docBaseUrl: source.docBaseUrl, docBaseUrl: source.docBaseUrl,
enableXfa: source.enableXfa, enableXfa: source.enableXfa,
evaluatorOptions: { evaluatorOptions: {