Skip to content

Commit

Permalink
Re-factor how the compatibilityParams, in the viewer, are handled
Browse files Browse the repository at this point in the history
Previously we'd simply export this directly from `web/app_options.js`, which meant that it'd be technically possible to *accidentally* modify the `compatibilityParams` Object when accessing it.
To avoid this we instead introduce a new `AppOptions`-method that is used to lookup data in `compatibilityParams`, which means that we no longer need to export this Object.

Based on these changes, it's now possible to simplify some existing code in `AppOptions` by taking full advantage of the nullish coalescing (`??`) operator.
  • Loading branch information
Snuffleupagus committed Feb 20, 2024
1 parent 90b2664 commit 38004b6
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 24 deletions.
34 changes: 14 additions & 20 deletions web/app_options.js
Original file line number Diff line number Diff line change
Expand Up @@ -438,16 +438,17 @@ class AppOptions {
throw new Error("Cannot initialize AppOptions.");
}

static getCompat(name) {
return compatibilityParams[name] ?? undefined;
}

static get(name) {
const userOption = userOptions[name];
if (userOption !== undefined) {
return userOption;
}
const defaultOption = defaultOptions[name];
if (defaultOption !== undefined) {
return compatibilityParams[name] ?? defaultOption.value;
}
return undefined;
return (
userOptions[name] ??
compatibilityParams[name] ??
defaultOptions[name]?.value ??
undefined
);
}

static getAll(kind = null, defaultOnly = false) {
Expand All @@ -458,16 +459,9 @@ class AppOptions {
if (kind && !(kind & defaultOption.kind)) {
continue;
}
if (defaultOnly) {
options[name] = defaultOption.value;
continue;
}
const userOption = userOptions[name];

options[name] =
userOption !== undefined
? userOption
: compatibilityParams[name] ?? defaultOption.value;
options[name] = defaultOnly
? defaultOption.value
: userOptions[name] ?? compatibilityParams[name] ?? defaultOption.value;
}
return options;
}
Expand Down Expand Up @@ -501,4 +495,4 @@ class AppOptions {
}
}

export { AppOptions, compatibilityParams, OptionKind };
export { AppOptions, OptionKind };
8 changes: 4 additions & 4 deletions web/pdf_page_view.js
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ import {
} from "./ui_utils.js";
import { AnnotationEditorLayerBuilder } from "./annotation_editor_layer_builder.js";
import { AnnotationLayerBuilder } from "./annotation_layer_builder.js";
import { compatibilityParams } from "./app_options.js";
import { AppOptions } from "./app_options.js";
import { DrawLayerBuilder } from "./draw_layer_builder.js";
import { GenericL10n } from "web-null_l10n";
import { SimpleLinkService } from "./pdf_link_service.js";
Expand Down Expand Up @@ -83,8 +83,6 @@ import { XfaLayerBuilder } from "./xfa_layer_builder.js";
* the necessary layer-properties.
*/

const MAX_CANVAS_PIXELS = compatibilityParams.maxCanvasPixels || 16777216;

const DEFAULT_LAYER_PROPERTIES =
typeof PDFJSDev === "undefined" || !PDFJSDev.test("COMPONENTS")
? null
Expand Down Expand Up @@ -152,7 +150,9 @@ class PDFPageView {
this.#annotationMode =
options.annotationMode ?? AnnotationMode.ENABLE_FORMS;
this.imageResourcesPath = options.imageResourcesPath || "";
this.maxCanvasPixels = options.maxCanvasPixels ?? MAX_CANVAS_PIXELS;
this.maxCanvasPixels =
options.maxCanvasPixels ??
(AppOptions.getCompat("maxCanvasPixels") || 16777216);
this.pageColors = options.pageColors || null;

this.eventBus = options.eventBus;
Expand Down

0 comments on commit 38004b6

Please sign in to comment.