From e40ea5828a4c51e6fe96b5e004866c2b9eafa83f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Matias=20Niemel=C3=A4?= Date: Tue, 22 Oct 2019 15:18:40 -0700 Subject: [PATCH] perf(ivy): apply [style]/[class] bindings directly to style/className This patch ensures that the `[style]` and `[class]` based bindings are directly applied to an element's style and className attributes. This patch optimizes the algorithm so that it... - Doesn't construct an update an instance of `StylingMapArray` for `[style]` and `[class]` bindings - Doesn't apply `[style]` and `[class]` based entries using `classList` and `style` (direct attributes are used instead) - Doesn't split or iterate over all string-based tokens in a string value obtained from a `[class]` binding. This patch speeds up the following cases: - `
` and `
` - `
` and `
` The overall speec increase is by over 5x. --- .../core/src/render3/instructions/styling.ts | 54 ++++---- packages/core/src/render3/styling/bindings.ts | 124 +++++++++++++----- .../core/src/render3/styling/styling_debug.ts | 74 ++++++++++- .../styling_next/styling_debug_spec.ts | 7 + 4 files changed, 188 insertions(+), 71 deletions(-) diff --git a/packages/core/src/render3/instructions/styling.ts b/packages/core/src/render3/instructions/styling.ts index 168de69f36bd06..907bd0a5acee9e 100644 --- a/packages/core/src/render3/instructions/styling.ts +++ b/packages/core/src/render3/instructions/styling.ts @@ -189,8 +189,7 @@ function stylingProp( const sanitizerToUse = isClassBased ? null : sanitizer; const renderer = getRenderer(tNode, lView); updated = applyStylingValueDirectly( - renderer, context, native, lView, bindingIndex, prop, value, isClassBased, - isClassBased ? setClass : setStyle, sanitizerToUse); + renderer, context, native, lView, bindingIndex, prop, value, isClassBased, sanitizerToUse); if (sanitizerToUse) { // it's important we remove the current style sanitizer once the @@ -243,6 +242,7 @@ export function ɵɵstyleMap(styles: {[styleName: string]: any} | NO_CHANGE | nu const lView = getLView(); const tNode = getTNode(index, lView); const context = getStylesContext(tNode); + const hasDirectiveInput = hasStyleInput(tNode); // if a value is interpolated then it may render a `NO_CHANGE` value. // in this case we do not need to do anything, but the binding index @@ -253,18 +253,12 @@ export function ɵɵstyleMap(styles: {[styleName: string]: any} | NO_CHANGE | nu // inputs are only evaluated from a template binding into a directive, therefore, // there should not be a situation where a directive host bindings function // evaluates the inputs (this should only happen in the template function) - if (!isHostStyling() && hasStyleInput(tNode) && styles !== NO_CHANGE) { + if (!isHostStyling() && hasDirectiveInput && styles !== NO_CHANGE) { updateDirectiveInputValue(context, lView, tNode, bindingIndex, styles, false); styles = NO_CHANGE; } - const updated = stylingMap(index, context, bindingIndex, styles, false); - if (ngDevMode) { - ngDevMode.styleMap++; - if (updated) { - ngDevMode.styleMapCacheMiss++; - } - } + stylingMap(context, tNode, lView, bindingIndex, styles, false, hasDirectiveInput); } /** @@ -300,6 +294,7 @@ export function classMapInternal( const lView = getLView(); const tNode = getTNode(elementIndex, lView); const context = getClassesContext(tNode); + const hasDirectiveInput = hasClassInput(tNode); // if a value is interpolated then it may render a `NO_CHANGE` value. // in this case we do not need to do anything, but the binding index @@ -310,18 +305,12 @@ export function classMapInternal( // inputs are only evaluated from a template binding into a directive, therefore, // there should not be a situation where a directive host bindings function // evaluates the inputs (this should only happen in the template function) - if (!isHostStyling() && hasClassInput(tNode) && classes !== NO_CHANGE) { + if (!isHostStyling() && hasDirectiveInput && classes !== NO_CHANGE) { updateDirectiveInputValue(context, lView, tNode, bindingIndex, classes, true); classes = NO_CHANGE; } - const updated = stylingMap(elementIndex, context, bindingIndex, classes, true); - if (ngDevMode) { - ngDevMode.classMap++; - if (updated) { - ngDevMode.classMapCacheMiss++; - } - } + stylingMap(context, tNode, lView, bindingIndex, classes, true, hasDirectiveInput); } /** @@ -331,13 +320,10 @@ export function classMapInternal( * `[class]` bindings in Angular. */ function stylingMap( - elementIndex: number, context: TStylingContext, bindingIndex: number, - value: {[key: string]: any} | string | null, isClassBased: boolean): boolean { - let updated = false; - - const lView = getLView(); + context: TStylingContext, tNode: TNode, lView: LView, bindingIndex: number, + value: {[key: string]: any} | string | null, isClassBased: boolean, + hasDirectiveInput: boolean): void { const directiveIndex = getActiveDirectiveId(); - const tNode = getTNode(elementIndex, lView); const native = getNativeByTNode(tNode, lView) as RElement; const oldValue = getValue(lView, bindingIndex); const hostBindingsMode = isHostStyling(); @@ -359,17 +345,14 @@ function stylingMap( patchConfig(context, TStylingConfig.HasMapBindings); } - const stylingMapArr = - value === NO_CHANGE ? NO_CHANGE : normalizeIntoStylingMap(oldValue, value, !isClassBased); - // Direct Apply Case: bypass context resolution and apply the // style/class map values directly to the element if (allowDirectStyling(context, hostBindingsMode)) { const sanitizerToUse = isClassBased ? null : sanitizer; const renderer = getRenderer(tNode, lView); - updated = applyStylingMapDirectly( - renderer, context, native, lView, bindingIndex, stylingMapArr as StylingMapArray, - isClassBased, isClassBased ? setClass : setStyle, sanitizerToUse, valueHasChanged); + applyStylingMapDirectly( + renderer, context, native, lView, bindingIndex, value, isClassBased, sanitizerToUse, + valueHasChanged, hasDirectiveInput); if (sanitizerToUse) { // it's important we remove the current style sanitizer once the // element exits, otherwise it will be used by the next styling @@ -377,7 +360,9 @@ function stylingMap( setElementExitFn(stylingApply); } } else { - updated = valueHasChanged; + const stylingMapArr = + value === NO_CHANGE ? NO_CHANGE : normalizeIntoStylingMap(oldValue, value, !isClassBased); + activateStylingMapFeature(); // Context Resolution (or first update) Case: save the map value @@ -396,7 +381,12 @@ function stylingMap( setElementExitFn(stylingApply); } - return updated; + if (ngDevMode) { + isClassBased ? ngDevMode.classMap : ngDevMode.styleMap++; + if (valueHasChanged) { + isClassBased ? ngDevMode.classMapCacheMiss : ngDevMode.styleMapCacheMiss++; + } + } } /** diff --git a/packages/core/src/render3/styling/bindings.ts b/packages/core/src/render3/styling/bindings.ts index 8d9453e23767f1..8bf7f6f7f174db 100644 --- a/packages/core/src/render3/styling/bindings.ts +++ b/packages/core/src/render3/styling/bindings.ts @@ -10,7 +10,7 @@ import {StyleSanitizeFn, StyleSanitizeMode} from '../../sanitization/style_sanit import {ProceduralRenderer3, RElement, Renderer3, RendererStyleFlags3, isProceduralRenderer} from '../interfaces/renderer'; import {ApplyStylingFn, LStylingData, StylingMapArray, StylingMapArrayIndex, StylingMapsSyncMode, SyncStylingMapsFn, TStylingConfig, TStylingContext, TStylingContextIndex, TStylingContextPropConfigFlags} from '../interfaces/styling'; import {NO_CHANGE} from '../tokens'; -import {DEFAULT_BINDING_INDEX, DEFAULT_BINDING_VALUE, DEFAULT_GUARD_MASK_VALUE, MAP_BASED_ENTRY_PROP_NAME, TEMPLATE_DIRECTIVE_INDEX, getBindingValue, getConfig, getDefaultValue, getGuardMask, getInitialStylingValue, getMapProp, getMapValue, getProp, getPropValuesStartPosition, getStylingMapArray, getTotalSources, getValue, getValuesCount, hasConfig, hasValueChanged, isContextLocked, isHostStylingActive, isSanitizationRequired, isStylingValueDefined, lockContext, patchConfig, setDefaultValue, setGuardMask, setMapAsDirty, setValue} from '../util/styling_utils'; +import {DEFAULT_BINDING_INDEX, DEFAULT_BINDING_VALUE, DEFAULT_GUARD_MASK_VALUE, MAP_BASED_ENTRY_PROP_NAME, TEMPLATE_DIRECTIVE_INDEX, forceStylesAsString, getBindingValue, getConfig, getDefaultValue, getGuardMask, getInitialStylingValue, getMapProp, getMapValue, getProp, getPropValuesStartPosition, getStylingMapArray, getTotalSources, getValue, getValuesCount, hasConfig, hasValueChanged, isContextLocked, isHostStylingActive, isSanitizationRequired, isStylingValueDefined, lockContext, normalizeIntoStylingMap, patchConfig, setDefaultValue, setGuardMask, setMapAsDirty, setValue} from '../util/styling_utils'; import {getStylingState, resetStylingState} from './state'; @@ -655,44 +655,70 @@ export function applyStylingViaContext( */ export function applyStylingMapDirectly( renderer: any, context: TStylingContext, element: RElement, data: LStylingData, - bindingIndex: number, map: StylingMapArray, isClassBased: boolean, applyFn: ApplyStylingFn, - sanitizer?: StyleSanitizeFn | null, forceUpdate?: boolean): boolean { - if (forceUpdate || hasValueChanged(data[bindingIndex], map)) { - setValue(data, bindingIndex, map); - const initialStyles = - hasConfig(context, TStylingConfig.HasInitialStyling) ? getStylingMapArray(context) : null; - - for (let i = StylingMapArrayIndex.ValuesStartPosition; i < map.length; - i += StylingMapArrayIndex.TupleSize) { - const prop = getMapProp(map, i); - const value = getMapValue(map, i); + bindingIndex: number, value: {[key: string]: any} | string | null, isClassBased: boolean, + sanitizer?: StyleSanitizeFn | null, forceUpdate?: boolean, + bindingValueContainsInitial?: boolean): void { + const config = getConfig(context); + const writeToAttrDirectly = !(config & TStylingConfig.HasPropBindings); + const oldValue = getValue(data, bindingIndex); + if (!writeToAttrDirectly && value !== NO_CHANGE) { + value = normalizeIntoStylingMap(oldValue, value, !isClassBased); + } - // case 1: apply the map value (if it exists) - let applied = - applyStylingValue(renderer, element, prop, value, applyFn, bindingIndex, sanitizer); + if (forceUpdate || hasValueChanged(oldValue, value)) { + const hasInitial = config & TStylingConfig.HasInitialStyling; + setValue(data, bindingIndex, value); - // case 2: apply the initial value (if it exists) - if (!applied && initialStyles) { - applied = findAndApplyMapValue( - renderer, element, applyFn, initialStyles, prop, bindingIndex, sanitizer); + if (writeToAttrDirectly) { + const initialValue = + hasInitial && !bindingValueContainsInitial ? getInitialStylingValue(context) : null; + if (isClassBased) { + let valueToApply = typeof value === 'string' ? value : objectToClassName(value); + if (initialValue !== null) { + valueToApply = initialValue + ' ' + valueToApply; + } + setClassName(renderer, element, valueToApply); + } else { + let valueToApply = forceStylesAsString(value as{[key: string]: any}); + if (initialValue !== null) { + valueToApply = initialValue + ';' + valueToApply; + } + setStyleAttr(renderer, element, valueToApply); } + } else { + const applyFn = isClassBased ? setClass : setStyle; + const map = value as StylingMapArray; + const initialStyles = hasInitial ? getStylingMapArray(context) : null; + + for (let i = StylingMapArrayIndex.ValuesStartPosition; i < map.length; + i += StylingMapArrayIndex.TupleSize) { + const prop = getMapProp(map, i); + const value = getMapValue(map, i); + + // case 1: apply the map value (if it exists) + let applied = + applyStylingValue(renderer, element, prop, value, applyFn, bindingIndex, sanitizer); + + // case 2: apply the initial value (if it exists) + if (!applied && initialStyles) { + applied = findAndApplyMapValue( + renderer, element, applyFn, initialStyles, prop, bindingIndex, sanitizer); + } - // default case: apply `null` to remove the value - if (!applied) { - applyFn(renderer, element, prop, null, bindingIndex); + // default case: apply `null` to remove the value + if (!applied) { + applyFn(renderer, element, prop, null, bindingIndex); + } } - } - const state = getStylingState(element, TEMPLATE_DIRECTIVE_INDEX); - if (isClassBased) { - state.lastDirectClassMap = map; - } else { - state.lastDirectStyleMap = map; + const state = getStylingState(element, TEMPLATE_DIRECTIVE_INDEX); + if (isClassBased) { + state.lastDirectClassMap = map; + } else { + state.lastDirectStyleMap = map; + } } - - return true; } - return false; } /** @@ -727,11 +753,12 @@ export function applyStylingMapDirectly( */ export function applyStylingValueDirectly( renderer: any, context: TStylingContext, element: RElement, data: LStylingData, - bindingIndex: number, prop: string, value: any, isClassBased: boolean, applyFn: ApplyStylingFn, + bindingIndex: number, prop: string, value: any, isClassBased: boolean, sanitizer?: StyleSanitizeFn | null): boolean { let applied = false; if (hasValueChanged(data[bindingIndex], value)) { setValue(data, bindingIndex, value); + const applyFn = isClassBased ? setClass : setStyle; // case 1: apply the provided value (if it exists) applied = applyStylingValue(renderer, element, prop, value, applyFn, bindingIndex, sanitizer); @@ -888,6 +915,26 @@ export const setClass: ApplyStylingFn = } }; +export const setClassName = (renderer: Renderer3 | null, native: RElement, className: string) => { + if (renderer !== null) { + if (isProceduralRenderer(renderer)) { + renderer.setAttribute(native, 'class', className); + } else { + native.className = className; + } + } +}; + +export const setStyleAttr = (renderer: Renderer3 | null, native: RElement, value: string) => { + if (renderer !== null) { + if (isProceduralRenderer(renderer)) { + renderer.setAttribute(native, 'style', value); + } else { + native.setAttribute('style', value); + } + } +}; + /** * Iterates over all provided styling entries and renders them on the element. * @@ -914,3 +961,16 @@ export function renderStylingMap( } } } + +function objectToClassName(obj: {[key: string]: any} | null): string { + let str = ''; + if (obj) { + for (let key in obj) { + const value = obj[key]; + if (value) { + str += (str.length ? ' ' : '') + key; + } + } + } + return str; +} diff --git a/packages/core/src/render3/styling/styling_debug.ts b/packages/core/src/render3/styling/styling_debug.ts index 7b9e108c597e81..981f46d6218f94 100644 --- a/packages/core/src/render3/styling/styling_debug.ts +++ b/packages/core/src/render3/styling/styling_debug.ts @@ -5,12 +5,13 @@ * Use of this source code is governed by an MIT-style license that can be * found in the LICENSE file at https://angular.io/license */ +import {createProxy} from '../../debug/proxy'; import {StyleSanitizeFn} from '../../sanitization/style_sanitizer'; import {RElement} from '../interfaces/renderer'; import {ApplyStylingFn, LStylingData, TStylingConfig, TStylingContext, TStylingContextIndex} from '../interfaces/styling'; import {getCurrentStyleSanitizer} from '../state'; import {attachDebugObject} from '../util/debug_utils'; -import {MAP_BASED_ENTRY_PROP_NAME, TEMPLATE_DIRECTIVE_INDEX, allowDirectStyling as _allowDirectStyling, getBindingValue, getDefaultValue, getGuardMask, getProp, getPropValuesStartPosition, getValuesCount, hasConfig, isContextLocked, isSanitizationRequired, isStylingContext} from '../util/styling_utils'; +import {MAP_BASED_ENTRY_PROP_NAME, TEMPLATE_DIRECTIVE_INDEX, allowDirectStyling as _allowDirectStyling, getBindingValue, getDefaultValue, getGuardMask, getProp, getPropValuesStartPosition, getValue, getValuesCount, hasConfig, isContextLocked, isSanitizationRequired, isStylingContext, normalizeIntoStylingMap, setValue} from '../util/styling_utils'; import {applyStylingViaContext} from './bindings'; import {activateStylingMapFeature} from './map_based_bindings'; @@ -374,10 +375,52 @@ export class NodeStylingDebug implements DebugNodeStyling { */ get summary(): {[key: string]: DebugNodeStylingEntry} { const entries: {[key: string]: DebugNodeStylingEntry} = {}; - this._mapValues((prop: string, value: any, bindingIndex: number | null) => { + const config = this.config; + const isClassBased = this._isClassBased; + + let data = this._data; + + // the direct pass code doesn't convert [style] or [class] values + // into StylingMapArray instances. For this reason, the values + // need to be converted ahead of time since the styling debug + // relies on context resolution to figure out what styling + // values have been added/removed on the element. + if (config.allowDirectStyling && config.hasMapBindings) { + data = data.concat([]); // make a copy + this._convertMapBindingsToStylingMapArrays(data); + } + + this._mapValues(data, (prop: string, value: any, bindingIndex: number | null) => { entries[prop] = {prop, value, bindingIndex}; }); - return entries; + + // because the styling algorithm runs into two different + // modes: direct and context-resolution, the output of the entries + // object is different because the removed values are not + // saved between updates. For this reason a proxy is created + // so that the behavior is the same when examining values + // that are no longer active on the element. + return createProxy({ + get(target: {}, prop: string): DebugNodeStylingEntry{ + let value: DebugNodeStylingEntry = entries[prop]; if (!value) { + value = { + prop, + value: isClassBased ? false : null, + bindingIndex: null, + }; + } return value; + }, + set(target: {}, prop: string, value: any) { return false; }, + ownKeys() { return Object.keys(entries); }, + getOwnPropertyDescriptor(k: any) { + // we use a special property descriptor here so that enumeration operations + // such as `Object.keys` will work on this proxy. + return { + enumerable: true, + configurable: true, + }; + }, + }); } get config() { return buildConfig(this.context.context); } @@ -387,11 +430,28 @@ export class NodeStylingDebug implements DebugNodeStyling { */ get values(): {[key: string]: any} { const entries: {[key: string]: any} = {}; - this._mapValues((prop: string, value: any) => { entries[prop] = value; }); + this._mapValues(this._data, (prop: string, value: any) => { entries[prop] = value; }); return entries; } - private _mapValues(fn: (prop: string, value: string|null, bindingIndex: number|null) => any) { + private _convertMapBindingsToStylingMapArrays(data: LStylingData) { + const context = this.context.context; + const limit = getPropValuesStartPosition(context); + for (let i = + TStylingContextIndex.ValuesStartPosition + TStylingContextIndex.BindingsStartOffset; + i < limit; i++) { + const bindingIndex = context[i] as number; + const bindingValue = bindingIndex !== 0 ? getValue(data, bindingIndex) : null; + if (bindingValue && !Array.isArray(bindingValue)) { + const stylingMapArray = normalizeIntoStylingMap(null, bindingValue, !this._isClassBased); + setValue(data, bindingIndex, stylingMapArray); + } + } + } + + private _mapValues( + data: LStylingData, + fn: (prop: string, value: string|null, bindingIndex: number|null) => any) { // there is no need to store/track an element instance. The // element is only used when the styling algorithm attempts to // style the value (and we mock out the stylingApplyFn anyway). @@ -409,11 +469,11 @@ export class NodeStylingDebug implements DebugNodeStyling { // run the template bindings applyStylingViaContext( - this.context.context, null, mockElement, this._data, true, mapFn, sanitizer, false); + this.context.context, null, mockElement, data, true, mapFn, sanitizer, false); // and also the host bindings applyStylingViaContext( - this.context.context, null, mockElement, this._data, true, mapFn, sanitizer, true); + this.context.context, null, mockElement, data, true, mapFn, sanitizer, true); } } diff --git a/packages/core/test/render3/styling_next/styling_debug_spec.ts b/packages/core/test/render3/styling_next/styling_debug_spec.ts index f689316d18e64f..5c1497750a67c9 100644 --- a/packages/core/test/render3/styling_next/styling_debug_spec.ts +++ b/packages/core/test/render3/styling_next/styling_debug_spec.ts @@ -13,6 +13,8 @@ describe('styling debugging tools', () => { describe('NodeStylingDebug', () => { it('should list out each of the values in the context paired together with the provided data', () => { + if (isIE()) return; + const debug = makeContextWithDebug(false); const context = debug.context; const data: any[] = []; @@ -67,3 +69,8 @@ function makeContextWithDebug(isClassBased: boolean) { const ctx = allocTStylingContext(null, false); return attachStylingDebugObject(ctx, isClassBased); } + +function isIE() { + // note that this only applies to older IEs (not edge) + return typeof window !== 'undefined' && (window as any).document['documentMode'] ? true : false; +}