[api-minor] Ensure that the PDFDocumentLoadingTask-promise is rejected when cancelling the PasswordPrompt (bug 1754421)

This is essentially a *continuation* of PR 7926, where we added support for rejecting the current `PDFDocumentLoadingTask`-promise by throwing inside of the `onPassword`-callback.
Hence the naive way to address [bug 1754421](https://bugzilla.mozilla.org/show_bug.cgi?id=1754421) would be to simply throw in the `onPassword`-callback used in the default viewer. However it unfortunately turns out to not work, since the password input/validation is asynchronous, and we thus need another approach.

The simplest solution that I can come up with here, is thus to *extend* the `onPassword`-callback to also reject the current `PDFDocumentLoadingTask`-instance if an `Error` is explicitly passed as the input to the callback function. (This doesn't feel great, but I cannot see a better solution that isn't really complicated.)
This commit is contained in:
Jonas Jenwald 2022-02-09 13:48:29 +01:00
parent acc758c40c
commit 1f0fb270b1
3 changed files with 48 additions and 9 deletions

View File

@ -2644,9 +2644,11 @@ class WorkerTransport {
if (loadingTask.onPassword) {
const updatePassword = password => {
this._passwordCapability.resolve({
password,
});
if (password instanceof Error) {
this._passwordCapability.reject(password);
} else {
this._passwordCapability.resolve({ password });
}
};
try {
loadingTask.onPassword(updatePassword, exception.code);

View File

@ -239,7 +239,7 @@ describe("api", function () {
const passwordNeededCapability = createPromiseCapability();
const passwordIncorrectCapability = createPromiseCapability();
// Attach the callback that is used to request a password;
// similarly to how viewer.js handles passwords.
// similarly to how the default viewer handles passwords.
loadingTask.onPassword = function (updatePassword, reason) {
if (
reason === PasswordResponses.NEED_PASSWORD &&
@ -405,6 +405,38 @@ describe("api", function () {
}
);
it(
"creates pdf doc from password protected PDF file and passes an Error " +
"(asynchronously) to the onPassword callback (bug 1754421)",
async function () {
const loadingTask = getDocument(
buildGetDocumentParams("issue3371.pdf")
);
expect(loadingTask instanceof PDFDocumentLoadingTask).toEqual(true);
// Attach the callback that is used to request a password;
// similarly to how the default viewer handles passwords.
loadingTask.onPassword = function (updatePassword, reason) {
waitSome(() => {
updatePassword(new Error("Should reject the loadingTask."));
});
};
await loadingTask.promise.then(
function () {
// Shouldn't get here.
expect(false).toEqual(true);
},
function (reason) {
expect(reason instanceof PasswordException).toEqual(true);
expect(reason.code).toEqual(PasswordResponses.NEED_PASSWORD);
}
);
await loadingTask.destroy();
}
);
it("creates pdf doc from empty typed array", async function () {
const loadingTask = getDocument(new Uint8Array(0));
expect(loadingTask instanceof PDFDocumentLoadingTask).toEqual(true);

View File

@ -51,18 +51,18 @@ class PasswordPrompt {
this.reason = null;
// Attach the event listeners.
this.submitButton.addEventListener("click", this.verify.bind(this));
this.cancelButton.addEventListener("click", this.close.bind(this));
this.submitButton.addEventListener("click", this.#verify.bind(this));
this.cancelButton.addEventListener("click", this.#cancel.bind(this));
this.input.addEventListener("keydown", e => {
if (e.keyCode === /* Enter = */ 13) {
this.verify();
this.#verify();
}
});
this.overlayManager.register(
this.overlayName,
this.container,
this.close.bind(this),
this.#cancel.bind(this),
true
);
}
@ -87,7 +87,7 @@ class PasswordPrompt {
});
}
verify() {
#verify() {
const password = this.input.value;
if (password?.length > 0) {
this.close();
@ -95,6 +95,11 @@ class PasswordPrompt {
}
}
#cancel() {
this.close();
this.updateCallback(new Error("PasswordPrompt cancelled."));
}
setUpdateCallback(updateCallback, reason) {
this.updateCallback = updateCallback;
this.reason = reason;