Skip to content
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
3 changes: 2 additions & 1 deletion src/core/component.js
Original file line number Diff line number Diff line change
Expand Up @@ -426,7 +426,8 @@ Component.prototype = {

// Parse the new value into attrValue (re-using objects where possible)
var newAttrValue = key ? this.attrValue[key] : this.attrValue;
newAttrValue = parseProperty(newValue, propertySchema, newAttrValue);
// Some property types (like selectors) depend on external state (e.g. DOM) during parsing and can't be cached.
newAttrValue = propertySchema.isCacheable ? parseProperty(newValue, propertySchema, newAttrValue) : newValue;
// In case the output is a string, store the unparsed value (no double parsing and helps inspector)
if (typeof newAttrValue === 'string') {
// Quirk: empty strings aren't considered values for single-property schemas
Expand Down
15 changes: 8 additions & 7 deletions src/core/propertyTypes.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
var coordinates = require('../utils/coordinates');
var debug = require('debug');

var error = debug('core:propertyTypes:warn');
var warn = debug('core:propertyTypes:warn');

var propertyTypes = module.exports.propertyTypes = {};
Expand All @@ -13,15 +12,15 @@ registerPropertyType('audio', '', assetParse);
registerPropertyType('array', [], arrayParse, arrayStringify, arrayEquals);
registerPropertyType('asset', '', assetParse);
registerPropertyType('boolean', false, boolParse);
registerPropertyType('color', '#FFF', defaultParse, defaultStringify);
registerPropertyType('color', '#FFF');
registerPropertyType('int', 0, intParse);
registerPropertyType('number', 0, numberParse);
registerPropertyType('map', '', assetParse);
registerPropertyType('model', '', assetParse);
registerPropertyType('selector', null, selectorParse, selectorStringify);
registerPropertyType('selectorAll', null, selectorAllParse, selectorAllStringify);
registerPropertyType('selector', null, selectorParse, selectorStringify, defaultEquals, false);
registerPropertyType('selectorAll', null, selectorAllParse, selectorAllStringify, arrayEquals, false);
registerPropertyType('src', '', srcParse);
registerPropertyType('string', '', defaultParse, defaultStringify);
registerPropertyType('string', '');
registerPropertyType('time', 0, intParse);
registerPropertyType('vec2', {x: 0, y: 0}, vecParse, coordinates.stringify, coordinates.equals);
registerPropertyType('vec3', {x: 0, y: 0, z: 0}, vecParse, coordinates.stringify, coordinates.equals);
Expand All @@ -37,8 +36,9 @@ registerPropertyType('vec4', {x: 0, y: 0, z: 0, w: 1}, vecParse, coordinates.str
* @param {function} [parse=defaultParse] - Parse string function.
* @param {function} [stringify=defaultStringify] - Stringify to DOM function.
* @param {function} [equals=defaultEquals] - Equality comparator.
* @param {boolean} [cachable=false] - Whether or not the parsed value of a property can be cached.
*/
function registerPropertyType (type, defaultValue, parse, stringify, equals) {
function registerPropertyType (type, defaultValue, parse, stringify, equals, cacheable) {
if (type in propertyTypes) {
throw new Error('Property type ' + type + ' is already registered.');
}
Expand All @@ -47,7 +47,8 @@ function registerPropertyType (type, defaultValue, parse, stringify, equals) {
default: defaultValue,
parse: parse || defaultParse,
stringify: stringify || defaultStringify,
equals: equals || defaultEquals
equals: equals || defaultEquals,
isCacheable: cacheable !== false
};
}
module.exports.registerPropertyType = registerPropertyType;
Expand Down
1 change: 1 addition & 0 deletions src/core/schema.js
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ function processPropertyDefinition (propDefinition, componentName) {
propDefinition.parse = propDefinition.parse || propType.parse;
propDefinition.stringify = propDefinition.stringify || propType.stringify;
propDefinition.equals = propDefinition.equals || propType.equals;
propDefinition.isCacheable = propDefinition.isCacheable === true || propType.isCacheable;

// Fill in type name.
propDefinition.type = typeName;
Expand Down
27 changes: 27 additions & 0 deletions tests/core/a-entity.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -455,6 +455,33 @@ suite('a-entity', function () {
assert.notOk(geometry.width);
});

test('do not cache properties with non-cacheable types', function () {
el.setAttribute('light', { target: '#some-element' });
assert.deepEqual(el.components.light.attrValue, {target: '#some-element'});

const light = el.getAttribute('light');
assert.notOk(light.target);
});

test('non-cacheable selectors are parsed at component initialization', function (done) {
const newEl = document.createElement('a-entity');
newEl.setAttribute('light', { target: '#target-element' });

// Light refers to target that doesn't exist yet.
assert.deepEqual(newEl.components.light.attrValue, {target: '#target-element'});
assert.notOk(newEl.getAttribute('light').target);

// Setup target element.
el.id = 'target-element';
el.appendChild(newEl);

newEl.addEventListener('loaded', function () {
assert.deepEqual(newEl.components.light.attrValue, {target: '#target-element'});
assert.strictEqual(newEl.getAttribute('light').target, el);
done();
});
});

test('parses individual properties when passing object', function (done) {
AFRAME.registerComponent('foo', {
schema: {
Expand Down