Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reduce duplication when handling "DocException" and "PasswordRequest" messages #19259

Merged
merged 1 commit into from
Dec 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 3 additions & 16 deletions src/core/worker.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,10 @@ import {
assert,
getVerbosityLevel,
info,
InvalidPDFException,
isNodeJS,
MissingPDFException,
PasswordException,
setVerbosityLevel,
stringToPDFString,
UnexpectedResponseException,
UnknownErrorException,
VerbosityLevel,
warn,
} from "../shared/util.js";
Expand All @@ -36,10 +32,10 @@ import {
} from "./core_utils.js";
import { Dict, isDict, Ref, RefSetCache } from "./primitives.js";
import { LocalPdfManager, NetworkPdfManager } from "./pdf_manager.js";
import { MessageHandler, wrapReason } from "../shared/message_handler.js";
import { AnnotationFactory } from "./annotation.js";
import { clearGlobalCaches } from "./cleanup_helper.js";
import { incrementalUpdate } from "./writer.js";
import { MessageHandler } from "../shared/message_handler.js";
import { PDFWorkerStream } from "./worker_stream.js";
import { StructTreeRoot } from "./struct_tree.js";

Expand Down Expand Up @@ -347,18 +343,9 @@ class WorkerMessageHandler {
finishWorkerTask(task);
handler.send("DocException", ex);
});
} else if (
ex instanceof InvalidPDFException ||
ex instanceof MissingPDFException ||
ex instanceof UnexpectedResponseException ||
ex instanceof UnknownErrorException
) {
handler.send("DocException", ex);
} else {
handler.send(
"DocException",
new UnknownErrorException(ex.message, ex.toString())
);
// Ensure that we always fallback to `UnknownErrorException`.
handler.send("DocException", wrapReason(ex));
}
}

Expand Down
51 changes: 12 additions & 39 deletions src/display/api.js
Original file line number Diff line number Diff line change
Expand Up @@ -24,17 +24,12 @@ import {
FeatureTest,
getVerbosityLevel,
info,
InvalidPDFException,
isNodeJS,
MAX_IMAGE_SIZE_TO_CACHE,
MissingPDFException,
PasswordException,
RenderingIntentFlag,
setVerbosityLevel,
shadow,
stringToBytes,
UnexpectedResponseException,
UnknownErrorException,
unreachable,
warn,
} from "../shared/util.js";
Expand All @@ -51,6 +46,7 @@ import {
RenderingCancelledException,
StatTimer,
} from "./display_utils.js";
import { MessageHandler, wrapReason } from "../shared/message_handler.js";
import {
NodeCanvasFactory,
NodeCMapReaderFactory,
Expand All @@ -63,7 +59,6 @@ import { DOMCMapReaderFactory } from "display-cmap_reader_factory";
import { DOMFilterFactory } from "./filter_factory.js";
import { DOMStandardFontDataFactory } from "display-standard_fontdata_factory";
import { GlobalWorkerOptions } from "./worker_options.js";
import { MessageHandler } from "../shared/message_handler.js";
import { Metadata } from "./metadata.js";
import { OptionalContentConfig } from "./optional_content_config.js";
import { PDFDataTransportStream } from "./transport_stream.js";
Expand Down Expand Up @@ -2731,50 +2726,28 @@ class WorkerTransport {
loadingTask._capability.resolve(new PDFDocumentProxy(pdfInfo, this));
});

messageHandler.on("DocException", function (ex) {
let reason;
switch (ex.name) {
case "PasswordException":
reason = new PasswordException(ex.message, ex.code);
break;
case "InvalidPDFException":
reason = new InvalidPDFException(ex.message);
break;
case "MissingPDFException":
reason = new MissingPDFException(ex.message);
break;
case "UnexpectedResponseException":
reason = new UnexpectedResponseException(ex.message, ex.status);
break;
case "UnknownErrorException":
reason = new UnknownErrorException(ex.message, ex.details);
break;
default:
unreachable("DocException - expected a valid Error.");
}
loadingTask._capability.reject(reason);
messageHandler.on("DocException", ex => {
loadingTask._capability.reject(wrapReason(ex));
});

messageHandler.on("PasswordRequest", exception => {
messageHandler.on("PasswordRequest", ex => {
this.#passwordCapability = Promise.withResolvers();

if (loadingTask.onPassword) {
try {
if (!loadingTask.onPassword) {
throw wrapReason(ex);
}

const updatePassword = password => {
if (password instanceof Error) {
this.#passwordCapability.reject(password);
} else {
this.#passwordCapability.resolve({ password });
}
};
try {
loadingTask.onPassword(updatePassword, exception.code);
} catch (ex) {
this.#passwordCapability.reject(ex);
}
} else {
this.#passwordCapability.reject(
new PasswordException(exception.message, exception.code)
);
loadingTask.onPassword(updatePassword, ex.code);
} catch (err) {
this.#passwordCapability.reject(err);
}
return this.#passwordCapability.promise;
});
Expand Down
39 changes: 23 additions & 16 deletions src/shared/message_handler.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
import {
AbortException,
assert,
InvalidPDFException,
MissingPDFException,
PasswordException,
UnexpectedResponseException,
Expand All @@ -24,13 +25,11 @@ import {
} from "./util.js";

const CallbackKind = {
UNKNOWN: 0,
DATA: 1,
ERROR: 2,
};

const StreamKind = {
UNKNOWN: 0,
CANCEL: 1,
CANCEL_COMPLETE: 2,
CLOSE: 3,
Expand All @@ -43,31 +42,39 @@ const StreamKind = {

function onFn() {}

function wrapReason(reason) {
function wrapReason(ex) {
if (
!(
reason instanceof Error ||
(typeof reason === "object" && reason !== null)
)
ex instanceof AbortException ||
ex instanceof InvalidPDFException ||
ex instanceof MissingPDFException ||
ex instanceof PasswordException ||
ex instanceof UnexpectedResponseException ||
ex instanceof UnknownErrorException
) {
// Avoid re-creating the exception when its type is already correct.
return ex;
}

if (!(ex instanceof Error || (typeof ex === "object" && ex !== null))) {
unreachable(
'wrapReason: Expected "reason" to be a (possibly cloned) Error.'
);
}
switch (reason.name) {
switch (ex.name) {
case "AbortException":
return new AbortException(reason.message);
return new AbortException(ex.message);
case "InvalidPDFException":
return new InvalidPDFException(ex.message);
case "MissingPDFException":
return new MissingPDFException(reason.message);
return new MissingPDFException(ex.message);
case "PasswordException":
return new PasswordException(reason.message, reason.code);
return new PasswordException(ex.message, ex.code);
case "UnexpectedResponseException":
return new UnexpectedResponseException(reason.message, reason.status);
return new UnexpectedResponseException(ex.message, ex.status);
case "UnknownErrorException":
return new UnknownErrorException(reason.message, reason.details);
default:
return new UnknownErrorException(reason.message, reason.toString());
return new UnknownErrorException(ex.message, ex.details);
}
return new UnknownErrorException(ex.message, ex.toString());
}

class MessageHandler {
Expand Down Expand Up @@ -532,4 +539,4 @@ class MessageHandler {
}
}

export { MessageHandler };
export { MessageHandler, wrapReason };
Loading