mirror of
https://github.com/shaka-project/shaka-player.git
synced 2026-06-25 17:45:03 +03:00
Joey Parrish
49c7c0c94c
When merging config objects, we accidentally used the same object reference for multiple key systems. This caused settings meant for one to affect another. The clone util had to be updated to handle Uint8Arrays, which may be present in DRM configs. Closes #1524 Change-Id: I66c8dc114573605471b1eeb38e890bbd4d29e2d4
102 lines
3.7 KiB
JavaScript
102 lines
3.7 KiB
JavaScript
/**
|
|
* @license
|
|
* Copyright 2016 Google Inc.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
goog.provide('shaka.util.ConfigUtils');
|
|
|
|
goog.require('goog.asserts');
|
|
goog.require('shaka.log');
|
|
|
|
|
|
/**
|
|
* @param {!Object} destination
|
|
* @param {!Object} source
|
|
* @param {!Object} template supplies default values
|
|
* @param {!Object} overrides
|
|
* Supplies override type checking. When the current path matches the key in
|
|
* this object, each sub-value must match the type in this object. If this
|
|
* contains an Object, it is used as the template.
|
|
* @param {string} path to this part of the config
|
|
* @return {boolean}
|
|
*/
|
|
shaka.util.ConfigUtils.mergeConfigObjects =
|
|
function(destination, source, template, overrides, path) {
|
|
goog.asserts.assert(destination, 'Destination config must not be null!');
|
|
|
|
/**
|
|
* @type {boolean}
|
|
* If true, don't validate the keys in the next level.
|
|
*/
|
|
let ignoreKeys = path in overrides;
|
|
|
|
let isValid = true;
|
|
|
|
for (let k in source) {
|
|
let subPath = path + '.' + k;
|
|
let subTemplate = ignoreKeys ? overrides[path] : template[k];
|
|
|
|
// The order of these checks is important.
|
|
if (!ignoreKeys && !(k in destination)) {
|
|
shaka.log.error('Invalid config, unrecognized key ' + subPath);
|
|
isValid = false;
|
|
} else if (source[k] === undefined) {
|
|
// An explicit 'undefined' value causes the key to be deleted from the
|
|
// destination config and replaced with a default from the template if
|
|
// possible.
|
|
if (subTemplate === undefined || ignoreKeys) {
|
|
// There is nothing in the template, so delete.
|
|
delete destination[k];
|
|
} else {
|
|
// There is something in the template, so go back to that.
|
|
destination[k] = shaka.util.ObjectUtils.cloneObject(subTemplate);
|
|
}
|
|
} else if (subTemplate.constructor == Object &&
|
|
source[k] &&
|
|
source[k].constructor == Object) {
|
|
// These are plain Objects with no other constructor.
|
|
|
|
if (!destination[k]) {
|
|
// The only way we should see a null destination is when ignoreKeys is
|
|
// true, so assert that it is.
|
|
goog.asserts.assert(ignoreKeys, 'Null destination without ignoreKeys!');
|
|
// Initialize the destination with the template so that normal merging
|
|
// and type-checking can happen.
|
|
destination[k] = shaka.util.ObjectUtils.cloneObject(subTemplate);
|
|
}
|
|
|
|
let subMergeValid = shaka.util.ConfigUtils.mergeConfigObjects(
|
|
destination[k], source[k], subTemplate, overrides, subPath);
|
|
isValid = isValid && subMergeValid;
|
|
} else if (typeof source[k] != typeof subTemplate ||
|
|
source[k] == null ||
|
|
source[k].constructor != subTemplate.constructor) {
|
|
// The source is the wrong type. This check allows objects to be nulled,
|
|
// but does not allow null for any non-object fields.
|
|
shaka.log.error('Invalid config, wrong type for ' + subPath);
|
|
isValid = false;
|
|
} else if (typeof destination[k] == 'function' &&
|
|
destination[k].length != source[k].length) {
|
|
shaka.log.warning(
|
|
'Invalid config, wrong number of arguments for ' + subPath);
|
|
destination[k] = source[k];
|
|
} else {
|
|
destination[k] = source[k];
|
|
}
|
|
}
|
|
|
|
return isValid;
|
|
};
|