Sakurai/pdf.js
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[api-minor] Limit the PDFDocumentLoadingTask.onUnsupportedFeature functionality to GENERIC builds (PR 15758 follow-up)

Browse Source 
This was deprecated in PR 15758 but it's unfortunately quite difficult to tell if third-party users are depending on this, e.g. to implement custom error reporting, and if so to what extent.
However, thanks to the pre-processor we can limit *most* of this code to GENERIC builds which still seem like a worthwhile change.

These changes reduce the bundle size of the Firefox PDF Viewer by 3.8 kB in total.
This commit is contained in:
Jonas Jenwald 2023-01-01 16:57:57 +01:00
parent 0c1fb4e740
commit 1a69d537c1
6 changed files with 159 additions and 105 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/core/document.js
View File

@ -222,11 +222,13 @@ class Page {
*/ */
_onSubStreamError(handler, reason, objId) { _onSubStreamError(handler, reason, objId) {
if (this.evaluatorOptions.ignoreErrors) { if (this.evaluatorOptions.ignoreErrors) {
if (typeof PDFJSDev === "undefined" || PDFJSDev.test("GENERIC")) {
// Error(s) when reading one of the /Contents sub-streams -- sending // Error(s) when reading one of the /Contents sub-streams -- sending
// unsupported feature notification and allow parsing to continue. // unsupported feature notification and allow parsing to continue.
handler.send("UnsupportedFeature", { handler.send("UnsupportedFeature", {
featureId: UNSUPPORTED_FEATURES.errorContentSubStream, featureId: UNSUPPORTED_FEATURES.errorContentSubStream,
}); });
}
warn(`getContentStream - ignoring sub-stream (${objId}): "${reason}".`); warn(`getContentStream - ignoring sub-stream (${objId}): "${reason}".`);
return; return;
} }

37
src/core/evaluator.js
View File

@ -929,11 +929,13 @@ class PartialEvaluator {
return; return;
} }
if (this.options.ignoreErrors) { if (this.options.ignoreErrors) {
if (typeof PDFJSDev === "undefined" || PDFJSDev.test("GENERIC")) {
// Error(s) in the TilingPattern -- sending unsupported feature // Error(s) in the TilingPattern -- sending unsupported feature
// notification and allow rendering to continue. // notification and allow rendering to continue.
this.handler.send("UnsupportedFeature", { this.handler.send("UnsupportedFeature", {
featureId: UNSUPPORTED_FEATURES.errorTilingPattern, featureId: UNSUPPORTED_FEATURES.errorTilingPattern,
}); });
}
warn(`handleTilingType - ignoring pattern: "${reason}".`); warn(`handleTilingType - ignoring pattern: "${reason}".`);
return; return;
} }
@ -975,11 +977,13 @@ class PartialEvaluator {
return translated; return translated;
}) })
.catch(reason => { .catch(reason => {
if (typeof PDFJSDev === "undefined" || PDFJSDev.test("GENERIC")) {
// Error in the font data -- sending unsupported feature // Error in the font data -- sending unsupported feature
// notification. // notification.
this.handler.send("UnsupportedFeature", { this.handler.send("UnsupportedFeature", {
featureId: UNSUPPORTED_FEATURES.errorFontLoadType3, featureId: UNSUPPORTED_FEATURES.errorFontLoadType3,
}); });
}
return new TranslatedFont({ return new TranslatedFont({
loadedName: "g_font_error", loadedName: "g_font_error",
font: new ErrorFont(`Type3 font load error: ${reason}`), font: new ErrorFont(`Type3 font load error: ${reason}`),
@ -1029,11 +1033,13 @@ class PartialEvaluator {
); );
if (this.options.ignoreErrors) { if (this.options.ignoreErrors) {
if (typeof PDFJSDev === "undefined" || PDFJSDev.test("GENERIC")) {
// Missing setFont operator before text rendering operator -- sending // Missing setFont operator before text rendering operator -- sending
// unsupported feature notification and allow rendering to continue. // unsupported feature notification and allow rendering to continue.
this.handler.send("UnsupportedFeature", { this.handler.send("UnsupportedFeature", {
featureId: UNSUPPORTED_FEATURES.errorFontState, featureId: UNSUPPORTED_FEATURES.errorFontState,
}); });
}
warn(`ensureStateFont: "${reason}".`); warn(`ensureStateFont: "${reason}".`);
return; return;
} }
@ -1191,10 +1197,12 @@ class PartialEvaluator {
warn(`${partialMsg}.`); warn(`${partialMsg}.`);
return errorFont(); return errorFont();
} }
if (typeof PDFJSDev === "undefined" || PDFJSDev.test("GENERIC")) {
// Font not found -- sending unsupported feature notification. // Font not found -- sending unsupported feature notification.
this.handler.send("UnsupportedFeature", { this.handler.send("UnsupportedFeature", {
featureId: UNSUPPORTED_FEATURES.errorFontMissing, featureId: UNSUPPORTED_FEATURES.errorFontMissing,
}); });
}
warn(`${partialMsg} -- attempting to fallback to a default font.`); warn(`${partialMsg} -- attempting to fallback to a default font.`);
// Falling back to a default font to avoid completely broken rendering, // Falling back to a default font to avoid completely broken rendering,
@ -1313,10 +1321,12 @@ class PartialEvaluator {
}) })
.catch(reason => { .catch(reason => {
// TODO fontCapability.reject? // TODO fontCapability.reject?
if (typeof PDFJSDev === "undefined" || PDFJSDev.test("GENERIC")) {
// Error in the font data -- sending unsupported feature notification. // Error in the font data -- sending unsupported feature notification.
this.handler.send("UnsupportedFeature", { this.handler.send("UnsupportedFeature", {
featureId: UNSUPPORTED_FEATURES.errorFontTranslate, featureId: UNSUPPORTED_FEATURES.errorFontTranslate,
}); });
}
warn(`loadFont - translateFont failed: "${reason}".`); warn(`loadFont - translateFont failed: "${reason}".`);
fontCapability.resolve( fontCapability.resolve(
@ -1422,11 +1432,13 @@ class PartialEvaluator {
return null; return null;
} }
if (this.options.ignoreErrors) { if (this.options.ignoreErrors) {
if (typeof PDFJSDev === "undefined" || PDFJSDev.test("GENERIC")) {
// Error(s) in the ColorSpace -- sending unsupported feature // Error(s) in the ColorSpace -- sending unsupported feature
// notification and allow rendering to continue. // notification and allow rendering to continue.
this.handler.send("UnsupportedFeature", { this.handler.send("UnsupportedFeature", {
featureId: UNSUPPORTED_FEATURES.errorColorSpace, featureId: UNSUPPORTED_FEATURES.errorColorSpace,
}); });
}
warn(`parseColorSpace - ignoring ColorSpace: "${reason}".`); warn(`parseColorSpace - ignoring ColorSpace: "${reason}".`);
return null; return null;
} }
@ -1811,11 +1823,16 @@ class PartialEvaluator {
return; return;
} }
if (self.options.ignoreErrors) { if (self.options.ignoreErrors) {
if (
typeof PDFJSDev === "undefined" ||
PDFJSDev.test("GENERIC")
) {
// Error(s) in the XObject -- sending unsupported feature // Error(s) in the XObject -- sending unsupported feature
// notification and allow rendering to continue. // notification and allow rendering to continue.
self.handler.send("UnsupportedFeature", { self.handler.send("UnsupportedFeature", {
featureId: UNSUPPORTED_FEATURES.errorXObject, featureId: UNSUPPORTED_FEATURES.errorXObject,
}); });
}
warn(`getOperatorList - ignoring XObject: "${reason}".`); warn(`getOperatorList - ignoring XObject: "${reason}".`);
return; return;
} }
@ -2130,11 +2147,16 @@ class PartialEvaluator {
return; return;
} }
if (self.options.ignoreErrors) { if (self.options.ignoreErrors) {
if (
typeof PDFJSDev === "undefined" ||
PDFJSDev.test("GENERIC")
) {
// Error(s) in the ExtGState -- sending unsupported feature // Error(s) in the ExtGState -- sending unsupported feature
// notification and allow parsing/rendering to continue. // notification and allow parsing/rendering to continue.
self.handler.send("UnsupportedFeature", { self.handler.send("UnsupportedFeature", {
featureId: UNSUPPORTED_FEATURES.errorExtGState, featureId: UNSUPPORTED_FEATURES.errorExtGState,
}); });
}
warn(`getOperatorList - ignoring ExtGState: "${reason}".`); warn(`getOperatorList - ignoring ExtGState: "${reason}".`);
return; return;
} }
@ -2182,9 +2204,14 @@ class PartialEvaluator {
return; return;
} }
if (self.options.ignoreErrors) { if (self.options.ignoreErrors) {
if (
typeof PDFJSDev === "undefined" ||
PDFJSDev.test("GENERIC")
) {
self.handler.send("UnsupportedFeature", { self.handler.send("UnsupportedFeature", {
featureId: UNSUPPORTED_FEATURES.errorMarkedContent, featureId: UNSUPPORTED_FEATURES.errorMarkedContent,
}); });
}
warn( warn(
`getOperatorList - ignoring beginMarkedContentProps: "${reason}".` `getOperatorList - ignoring beginMarkedContentProps: "${reason}".`
); );
@ -2235,11 +2262,13 @@ class PartialEvaluator {
return; return;
} }
if (this.options.ignoreErrors) { if (this.options.ignoreErrors) {
if (typeof PDFJSDev === "undefined" || PDFJSDev.test("GENERIC")) {
// Error(s) in the OperatorList -- sending unsupported feature // Error(s) in the OperatorList -- sending unsupported feature
// notification and allow rendering to continue. // notification and allow rendering to continue.
this.handler.send("UnsupportedFeature", { this.handler.send("UnsupportedFeature", {
featureId: UNSUPPORTED_FEATURES.errorOperatorList, featureId: UNSUPPORTED_FEATURES.errorOperatorList,
}); });
}
warn( warn(
`getOperatorList - ignoring errors during "${task.name}" ` + `getOperatorList - ignoring errors during "${task.name}" ` +
`task: "${reason}".` `task: "${reason}".`
@ -3734,11 +3763,13 @@ class PartialEvaluator {
return null; return null;
} }
if (this.options.ignoreErrors) { if (this.options.ignoreErrors) {
if (typeof PDFJSDev === "undefined" || PDFJSDev.test("GENERIC")) {
// Error in the ToUnicode data -- sending unsupported feature // Error in the ToUnicode data -- sending unsupported feature
// notification and allow font parsing to continue. // notification and allow font parsing to continue.
this.handler.send("UnsupportedFeature", { this.handler.send("UnsupportedFeature", {
featureId: UNSUPPORTED_FEATURES.errorFontToUnicode, featureId: UNSUPPORTED_FEATURES.errorFontToUnicode,
}); });
}
warn(`readToUnicode - ignoring ToUnicode data: "${reason}".`); warn(`readToUnicode - ignoring ToUnicode data: "${reason}".`);
return null; return null;
} }
@ -4312,11 +4343,13 @@ class PartialEvaluator {
]); ]);
} catch (reason) { } catch (reason) {
if (evaluatorOptions.ignoreErrors) { if (evaluatorOptions.ignoreErrors) {
// Error in the font data -- sending unsupported feature notification if (typeof PDFJSDev === "undefined" || PDFJSDev.test("GENERIC")) {
// and allow glyph path building to continue. // Error in the font data -- sending unsupported feature
// notification and allow glyph path building to continue.
handler.send("UnsupportedFeature", { handler.send("UnsupportedFeature", {
featureId: UNSUPPORTED_FEATURES.errorFontBuildPath, featureId: UNSUPPORTED_FEATURES.errorFontBuildPath,
}); });
}
warn(`buildFontPaths - ignoring ${glyphName} glyph: "${reason}".`); warn(`buildFontPaths - ignoring ${glyphName} glyph: "${reason}".`);
return; return;
} }

2
src/core/pattern.js
View File

@ -82,9 +82,11 @@ class Pattern {
if (ex instanceof MissingDataException) { if (ex instanceof MissingDataException) {
throw ex; throw ex;
} }
if (typeof PDFJSDev === "undefined" || PDFJSDev.test("GENERIC")) {
handler.send("UnsupportedFeature", { handler.send("UnsupportedFeature", {
featureId: UNSUPPORTED_FEATURES.shadingPattern, featureId: UNSUPPORTED_FEATURES.shadingPattern,
}); });
}
warn(ex); warn(ex);
return new DummyShading(); return new DummyShading();
} }

6
src/display/api.js
View File

@ -609,11 +609,13 @@ class PDFDocumentLoadingTask {
* @type {function} * @type {function}
*/ */
set onUnsupportedFeature(callback) { set onUnsupportedFeature(callback) {
if (typeof PDFJSDev === "undefined" || PDFJSDev.test("GENERIC")) {
deprecated( deprecated(
"The PDFDocumentLoadingTask onUnsupportedFeature property will be removed in the future." "The PDFDocumentLoadingTask onUnsupportedFeature property will be removed in the future."
); );
this.#onUnsupportedFeature = callback; this.#onUnsupportedFeature = callback;
} }
}
/** /**
* Promise for document loading task completion. * Promise for document loading task completion.
@ -2748,10 +2750,12 @@ class WorkerTransport {
}); });
}); });
if (typeof PDFJSDev === "undefined" || PDFJSDev.test("GENERIC")) {
messageHandler.on( messageHandler.on(
"UnsupportedFeature", "UnsupportedFeature",
this._onUnsupportedFeature.bind(this) this._onUnsupportedFeature.bind(this)
); );
}
messageHandler.on("FetchBuiltInCMap", data => { messageHandler.on("FetchBuiltInCMap", data => {
if (this.destroyed) { if (this.destroyed) {
@ -2783,11 +2787,13 @@ class WorkerTransport {
} }
_onUnsupportedFeature({ featureId }) { _onUnsupportedFeature({ featureId }) {
if (typeof PDFJSDev === "undefined" || PDFJSDev.test("GENERIC")) {
if (this.destroyed) { if (this.destroyed) {
return; // Ignore any pending requests if the worker was terminated. return; // Ignore any pending requests if the worker was terminated.
} }
this.loadingTask.onUnsupportedFeature?.(featureId); this.loadingTask.onUnsupportedFeature?.(featureId);
} }
}
getData() { getData() {
return this.messageHandler.sendWithPromise("GetData", null); return this.messageHandler.sendWithPromise("GetData", null);

8
src/display/font_loader.js
View File

@ -30,7 +30,9 @@ class FontLoader {
ownerDocument = globalThis.document, ownerDocument = globalThis.document,
styleElement = null, // For testing only. styleElement = null, // For testing only.
}) { }) {
if (typeof PDFJSDev === "undefined" || PDFJSDev.test("GENERIC")) {
this._onUnsupportedFeature = onUnsupportedFeature; this._onUnsupportedFeature = onUnsupportedFeature;
}
this._document = ownerDocument; this._document = ownerDocument;
this.nativeFontFaces = []; this.nativeFontFaces = [];
@ -88,9 +90,11 @@ class FontLoader {
try { try {
await nativeFontFace.loaded; await nativeFontFace.loaded;
} catch (ex) { } catch (ex) {
if (typeof PDFJSDev === "undefined" || PDFJSDev.test("GENERIC")) {
this._onUnsupportedFeature({ this._onUnsupportedFeature({
featureId: UNSUPPORTED_FEATURES.errorFontLoadNative, featureId: UNSUPPORTED_FEATURES.errorFontLoadNative,
}); });
}
warn(`Failed to load font '${nativeFontFace.family}': '${ex}'.`); warn(`Failed to load font '${nativeFontFace.family}': '${ex}'.`);
// When font loading failed, fall back to the built-in font renderer. // When font loading failed, fall back to the built-in font renderer.
@ -340,7 +344,9 @@ class FontFaceObject {
this.isEvalSupported = isEvalSupported !== false; this.isEvalSupported = isEvalSupported !== false;
this.disableFontFace = disableFontFace === true; this.disableFontFace = disableFontFace === true;
this.ignoreErrors = ignoreErrors === true; this.ignoreErrors = ignoreErrors === true;
if (typeof PDFJSDev === "undefined" || PDFJSDev.test("GENERIC")) {
this._onUnsupportedFeature = onUnsupportedFeature; this._onUnsupportedFeature = onUnsupportedFeature;
}
this.fontRegistry = fontRegistry; this.fontRegistry = fontRegistry;
} }
@ -403,9 +409,11 @@ class FontFaceObject {
if (!this.ignoreErrors) { if (!this.ignoreErrors) {
throw ex; throw ex;
} }
if (typeof PDFJSDev === "undefined" || PDFJSDev.test("GENERIC")) {
this._onUnsupportedFeature({ this._onUnsupportedFeature({
featureId: UNSUPPORTED_FEATURES.errorFontGetPath, featureId: UNSUPPORTED_FEATURES.errorFontGetPath,
}); });
}
warn(`getPathGenerator - ignoring character: "${ex}".`); warn(`getPathGenerator - ignoring character: "${ex}".`);
return (this.compiledGlyphs[character] = function (c, size) { return (this.compiledGlyphs[character] = function (c, size) {

7
src/shared/util.js
View File

@ -346,7 +346,9 @@ const OPS = {
constructPath: 91, constructPath: 91,
}; };
const UNSUPPORTED_FEATURES = { const UNSUPPORTED_FEATURES =
typeof PDFJSDev === "undefined" || PDFJSDev.test("GENERIC")
? {
forms: "forms", forms: "forms",
javaScript: "javaScript", javaScript: "javaScript",
signatures: "signatures", signatures: "signatures",
@ -367,7 +369,8 @@ const UNSUPPORTED_FEATURES = {
errorFontGetPath: "errorFontGetPath", errorFontGetPath: "errorFontGetPath",
errorMarkedContent: "errorMarkedContent", errorMarkedContent: "errorMarkedContent",
errorContentSubStream: "errorContentSubStream", errorContentSubStream: "errorContentSubStream",
}; }
: null;
const PasswordResponses = { const PasswordResponses = {
NEED_PASSWORD: 1, NEED_PASSWORD: 1,