Add type validation to the default_preferences generation (PR 10548 follow-up)

The generated `default_preferences.json` file is necessary when initializing the Firefox preferences, which only supports certain types, hence this patch adds additional validation to help prevent run-time errors in Firefox.

Given that these changes add a code-path to `AppOptions.getAll` which could throw, the `OptionKind.PREFERENCE` branch is also modified to require *exact* matching to prevent (future) errors in the viewer.

Finally the conditionally defined `defaultOptions` will no longer (potentially) be considered during the `gulp default_preferences` task, to make it more difficult for them to be accidentally included.
This commit is contained in:
Jonas Jenwald 2019-03-03 11:40:56 +01:00
parent c43396c2b7
commit f7cc331654
4 changed files with 14 additions and 8 deletions

View file

@ -222,7 +222,7 @@ const defaultOptions = {
},
};
if (typeof PDFJSDev === 'undefined' ||
PDFJSDev.test('!PRODUCTION || GENERIC')) {
PDFJSDev.test('!PRODUCTION || (GENERIC && !LIB)')) {
defaultOptions.disablePreferences = {
/** @type {boolean} */
value: false,
@ -262,9 +262,15 @@ class AppOptions {
if ((kind & defaultOption.kind) === 0) {
continue;
}
if ((kind & OptionKind.PREFERENCE) !== 0) {
options[name] = defaultOption.value;
continue;
if (kind === OptionKind.PREFERENCE) {
const value = defaultOption.value, valueType = typeof value;
if (valueType === 'boolean' || valueType === 'string' ||
(valueType === 'number' && Number.isInteger(value))) {
options[name] = value;
continue;
}
throw new Error(`Invalid type for preference: ${name}`);
}
}
const userOption = userOptions[name];