Skip to content

Re-factor the BaseException.name handling, and clean-up some code #13886

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

Merged
merged 3 commits into from
Aug 11, 2021
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
20 changes: 16 additions & 4 deletions src/core/core_utils.js
Original file line number Diff line number Diff line change
Expand Up @@ -52,17 +52,29 @@ function getArrayLookupTableFactory(initializer) {

class MissingDataException extends BaseException {
constructor(begin, end) {
super(`Missing data [${begin}, ${end})`);
super(`Missing data [${begin}, ${end})`, "MissingDataException");
this.begin = begin;
this.end = end;
}
}

class ParserEOFException extends BaseException {}
class ParserEOFException extends BaseException {
constructor(msg) {
super(msg, "ParserEOFException");
}
}

class XRefEntryException extends BaseException {}
class XRefEntryException extends BaseException {
constructor(msg) {
super(msg, "XRefEntryException");
}
}

class XRefParseException extends BaseException {}
class XRefParseException extends BaseException {
constructor(msg) {
super(msg, "XRefParseException");
}
}

/**
* Get the value of an inheritable property.
Expand Down
2 changes: 1 addition & 1 deletion src/core/jbig2.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import { CCITTFaxDecoder } from "./ccitt.js";

class Jbig2Error extends BaseException {
constructor(msg) {
super(`JBIG2 error: ${msg}`);
super(`JBIG2 error: ${msg}`, "Jbig2Error");
}
}

Expand Down
10 changes: 7 additions & 3 deletions src/core/jpg.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,22 @@ import { readUint16 } from "./core_utils.js";

class JpegError extends BaseException {
constructor(msg) {
super(`JPEG error: ${msg}`);
super(`JPEG error: ${msg}`, "JpegError");
}
}

class DNLMarkerError extends BaseException {
constructor(message, scanLines) {
super(message);
super(message, "DNLMarkerError");
this.scanLines = scanLines;
}
}

class EOIMarkerError extends BaseException {}
class EOIMarkerError extends BaseException {
constructor(msg) {
super(msg, "EOIMarkerError");
}
}

/**
* This code was forked from https://github.com/notmasteryet/jpgjs.
Expand Down
2 changes: 1 addition & 1 deletion src/core/jpx.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import { ArithmeticDecoder } from "./arithmetic_decoder.js";

class JpxError extends BaseException {
constructor(msg) {
super(`JPX error: ${msg}`);
super(`JPX error: ${msg}`, "JpxError");
}
}

Expand Down
13 changes: 2 additions & 11 deletions src/display/api.js
Original file line number Diff line number Diff line change
Expand Up @@ -2565,17 +2565,8 @@ class WorkerTransport {
case "UnknownErrorException":
reason = new UnknownErrorException(ex.message, ex.details);
break;
}
if (!(reason instanceof Error)) {
const msg = "DocException - expected a valid Error.";
if (
typeof PDFJSDev === "undefined" ||
PDFJSDev.test("!PRODUCTION || TESTING")
) {
unreachable(msg);
} else {
warn(msg);
}
default:
unreachable("DocException - expected a valid Error.");
}
loadingTask._capability.reject(reason);
});
Expand Down
2 changes: 1 addition & 1 deletion src/display/display_utils.js
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,7 @@ class PageViewport {

class RenderingCancelledException extends BaseException {
constructor(msg, type) {
super(msg);
super(msg, "RenderingCancelledException");
this.type = type;
}
}
Expand Down
24 changes: 14 additions & 10 deletions src/shared/message_handler.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import {
MissingPDFException,
UnexpectedResponseException,
UnknownErrorException,
warn,
} from "./util.js";

const CallbackKind = {
Expand All @@ -42,18 +43,21 @@ const StreamKind = {

function wrapReason(reason) {
if (
typeof PDFJSDev === "undefined" ||
PDFJSDev.test("!PRODUCTION || TESTING")
) {
assert(
!(
reason instanceof Error ||
(typeof reason === "object" && reason !== null),
'wrapReason: Expected "reason" to be a (possibly cloned) Error.'
);
} else {
if (typeof reason !== "object" || reason === null) {
return reason;
(typeof reason === "object" && reason !== null)
)
) {
if (
typeof PDFJSDev === "undefined" ||
PDFJSDev.test("!PRODUCTION || TESTING")
) {
throw new Error(
'wrapReason: Expected "reason" to be a (possibly cloned) Error.'
);
}
warn('wrapReason: Expected "reason" to be a (possibly cloned) Error.');
return reason;
}
switch (reason.name) {
case "AbortException":
Expand Down
34 changes: 25 additions & 9 deletions src/shared/util.js
Original file line number Diff line number Diff line change
Expand Up @@ -459,12 +459,12 @@ function shadow(obj, prop, value) {
*/
const BaseException = (function BaseExceptionClosure() {
// eslint-disable-next-line no-shadow
function BaseException(message) {
function BaseException(message, name) {
if (this.constructor === BaseException) {
unreachable("Cannot initialize BaseException.");
}
this.message = message;
this.name = this.constructor.name;
this.name = name;
}
BaseException.prototype = new Error();
BaseException.constructor = BaseException;
Expand All @@ -474,38 +474,54 @@ const BaseException = (function BaseExceptionClosure() {

class PasswordException extends BaseException {
constructor(msg, code) {
super(msg);
super(msg, "PasswordException");
this.code = code;
}
}

class UnknownErrorException extends BaseException {
constructor(msg, details) {
super(msg);
super(msg, "UnknownErrorException");
this.details = details;
}
}

class InvalidPDFException extends BaseException {}
class InvalidPDFException extends BaseException {
constructor(msg) {
super(msg, "InvalidPDFException");
}
}

class MissingPDFException extends BaseException {}
class MissingPDFException extends BaseException {
constructor(msg) {
super(msg, "MissingPDFException");
}
}

class UnexpectedResponseException extends BaseException {
constructor(msg, status) {
super(msg);
super(msg, "UnexpectedResponseException");
this.status = status;
}
}

/**
* Error caused during parsing PDF data.
*/
class FormatError extends BaseException {}
class FormatError extends BaseException {
constructor(msg) {
super(msg, "FormatError");
}
}

/**
* Error used to indicate task cancellation.
*/
class AbortException extends BaseException {}
class AbortException extends BaseException {
constructor(msg) {
super(msg, "AbortException");
}
}

const NullCharactersRegExp = /\x00/g;

Expand Down
12 changes: 7 additions & 5 deletions web/app.js
Original file line number Diff line number Diff line change
Expand Up @@ -323,11 +323,11 @@ const PDFViewerApplication = {
*/
async _parseHashParameters() {
if (!AppOptions.get("pdfBugEnabled")) {
return undefined;
return;
}
const hash = document.location.hash.substring(1);
if (!hash) {
return undefined;
return;
}
const params = parseQueryString(hash),
waitOn = [];
Expand Down Expand Up @@ -389,11 +389,13 @@ const PDFViewerApplication = {
}

if (waitOn.length === 0) {
return undefined;
return;
}
return Promise.all(waitOn).catch(reason => {
try {
await Promise.all(waitOn);
} catch (reason) {
console.error(`_parseHashParameters: "${reason.message}".`);
});
}
},

/**
Expand Down
30 changes: 8 additions & 22 deletions web/base_viewer.js
Original file line number Diff line number Diff line change
Expand Up @@ -152,8 +152,6 @@ class BaseViewer {
`The API version "${version}" does not match the Viewer version "${viewerVersion}".`
);
}
this._name = this.constructor.name;

this.container = options.container;
this.viewer = options.viewer || options.container.firstElementChild;

Expand Down Expand Up @@ -267,9 +265,7 @@ class BaseViewer {
}
// The intent can be to just reset a scroll position and/or scale.
if (!this._setCurrentPageNumber(val, /* resetCurrentPageView = */ true)) {
console.error(
`${this._name}.currentPageNumber: "${val}" is not a valid page.`
);
console.error(`currentPageNumber: "${val}" is not a valid page.`);
}
}

Expand Down Expand Up @@ -328,9 +324,7 @@ class BaseViewer {
}
// The intent can be to just reset a scroll position and/or scale.
if (!this._setCurrentPageNumber(page, /* resetCurrentPageView = */ true)) {
console.error(
`${this._name}.currentPageLabel: "${val}" is not a valid page.`
);
console.error(`currentPageLabel: "${val}" is not a valid page.`);
}
}

Expand Down Expand Up @@ -642,7 +636,7 @@ class BaseViewer {
!(Array.isArray(labels) && this.pdfDocument.numPages === labels.length)
) {
this._pageLabels = null;
console.error(`${this._name}.setPageLabels: Invalid page labels.`);
console.error(`setPageLabels: Invalid page labels.`);
} else {
this._pageLabels = labels;
}
Expand Down Expand Up @@ -808,9 +802,7 @@ class BaseViewer {
scale = Math.min(MAX_AUTO_SCALE, horizontalScale);
break;
default:
console.error(
`${this._name}._setScale: "${value}" is an unknown zoom value.`
);
console.error(`_setScale: "${value}" is an unknown zoom value.`);
return;
}
this._setScaleUpdatePages(scale, value, noScroll, /* preset = */ true);
Expand Down Expand Up @@ -875,8 +867,7 @@ class BaseViewer {
Number.isInteger(pageNumber) && this._pages[pageNumber - 1];
if (!pageView) {
console.error(
`${this._name}.scrollPageIntoView: ` +
`"${pageNumber}" is not a valid pageNumber parameter.`
`scrollPageIntoView: "${pageNumber}" is not a valid pageNumber parameter.`
);
return;
}
Expand Down Expand Up @@ -955,8 +946,7 @@ class BaseViewer {
break;
default:
console.error(
`${this._name}.scrollPageIntoView: ` +
`"${destArray[1].name}" is not a valid destination type.`
`scrollPageIntoView: "${destArray[1].name}" is not a valid destination type.`
);
return;
}
Expand Down Expand Up @@ -1143,9 +1133,7 @@ class BaseViewer {
pageNumber <= this.pagesCount
)
) {
console.error(
`${this._name}.isPageVisible: "${pageNumber}" is not a valid page.`
);
console.error(`isPageVisible: "${pageNumber}" is not a valid page.`);
return false;
}
return this._getVisiblePages().views.some(function (view) {
Expand All @@ -1167,9 +1155,7 @@ class BaseViewer {
pageNumber <= this.pagesCount
)
) {
console.error(
`${this._name}.isPageCached: "${pageNumber}" is not a valid page.`
);
console.error(`isPageCached: "${pageNumber}" is not a valid page.`);
return false;
}
const pageView = this._pages[pageNumber - 1];
Expand Down