Previously we would write to class/style as strings `element.className` and `element.style.cssText`. Turns out that approach is good for initial render but not good for updates. Updates using this approach are problematic because we have to check to see if there was an out of bound write to style and than perform reconciliation. This also requires the browser to bring up CSS parser which is expensive. Another problem with old approach is that we had to queue the DOM writes and flush them twice. Once on element advance instruction and once in `hostBindings`. The double flushing is expensive but it also means that a directive can observe that styles are not yet written (they are written after directive executes.) The new approach uses `element.classList.add/remove` and `element.style.setProperty/removeProperty` API for updates only (it continues to use `element.className` and `element.style.cssText` for initial render as it is cheaper.) The other change is that the styling changes are applied immediately (no queueing). This means that it is the instruction which computes priority. In some circumstances it may result in intermediate writes which are than overwritten with new value. (This should be rare) Overall this change deletes most of the previous code and replaces it with new simplified implement. The simplification results in code savings. PR Close #34804
285 lines
10 KiB
TypeScript
285 lines
10 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright Google Inc. All Rights Reserved.
|
|
*
|
|
* 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 {DOCUMENT, ɵgetDOM as getDOM} from '@angular/common';
|
|
import {DomElementSchemaRegistry} from '@angular/compiler';
|
|
import {Inject, Injectable, NgZone, Renderer2, RendererFactory2, RendererStyleFlags2, RendererType2, ViewEncapsulation} from '@angular/core';
|
|
import {EventManager, ɵNAMESPACE_URIS as NAMESPACE_URIS, ɵSharedStylesHost as SharedStylesHost, ɵflattenStyles as flattenStyles, ɵshimContentAttribute as shimContentAttribute, ɵshimHostAttribute as shimHostAttribute} from '@angular/platform-browser';
|
|
|
|
const EMPTY_ARRAY: any[] = [];
|
|
|
|
const DEFAULT_SCHEMA = new DomElementSchemaRegistry();
|
|
|
|
@Injectable()
|
|
export class ServerRendererFactory2 implements RendererFactory2 {
|
|
private rendererByCompId = new Map<string, Renderer2>();
|
|
private defaultRenderer: Renderer2;
|
|
private schema = DEFAULT_SCHEMA;
|
|
|
|
constructor(
|
|
private eventManager: EventManager, private ngZone: NgZone,
|
|
@Inject(DOCUMENT) private document: any, private sharedStylesHost: SharedStylesHost) {
|
|
this.defaultRenderer = new DefaultServerRenderer2(eventManager, document, ngZone, this.schema);
|
|
}
|
|
|
|
createRenderer(element: any, type: RendererType2|null): Renderer2 {
|
|
if (!element || !type) {
|
|
return this.defaultRenderer;
|
|
}
|
|
switch (type.encapsulation) {
|
|
case ViewEncapsulation.Native:
|
|
case ViewEncapsulation.Emulated: {
|
|
let renderer = this.rendererByCompId.get(type.id);
|
|
if (!renderer) {
|
|
renderer = new EmulatedEncapsulationServerRenderer2(
|
|
this.eventManager, this.document, this.ngZone, this.sharedStylesHost, this.schema,
|
|
type);
|
|
this.rendererByCompId.set(type.id, renderer);
|
|
}
|
|
(<EmulatedEncapsulationServerRenderer2>renderer).applyToHost(element);
|
|
return renderer;
|
|
}
|
|
default: {
|
|
if (!this.rendererByCompId.has(type.id)) {
|
|
const styles = flattenStyles(type.id, type.styles, []);
|
|
this.sharedStylesHost.addStyles(styles);
|
|
this.rendererByCompId.set(type.id, this.defaultRenderer);
|
|
}
|
|
return this.defaultRenderer;
|
|
}
|
|
}
|
|
}
|
|
|
|
begin() {}
|
|
end() {}
|
|
}
|
|
|
|
class DefaultServerRenderer2 implements Renderer2 {
|
|
data: {[key: string]: any} = Object.create(null);
|
|
|
|
constructor(
|
|
private eventManager: EventManager, protected document: any, private ngZone: NgZone,
|
|
private schema: DomElementSchemaRegistry) {}
|
|
|
|
destroy(): void {}
|
|
|
|
destroyNode: null;
|
|
|
|
createElement(name: string, namespace?: string, debugInfo?: any): any {
|
|
if (namespace) {
|
|
const doc = this.document || getDOM().getDefaultDocument();
|
|
return doc.createElementNS(NAMESPACE_URIS[namespace], name);
|
|
}
|
|
|
|
return getDOM().createElement(name, this.document);
|
|
}
|
|
|
|
createComment(value: string, debugInfo?: any): any {
|
|
return getDOM().getDefaultDocument().createComment(value);
|
|
}
|
|
|
|
createText(value: string, debugInfo?: any): any {
|
|
const doc = getDOM().getDefaultDocument();
|
|
return doc.createTextNode(value);
|
|
}
|
|
|
|
appendChild(parent: any, newChild: any): void { parent.appendChild(newChild); }
|
|
|
|
insertBefore(parent: any, newChild: any, refChild: any): void {
|
|
if (parent) {
|
|
parent.insertBefore(newChild, refChild);
|
|
}
|
|
}
|
|
|
|
removeChild(parent: any, oldChild: any): void {
|
|
if (parent) {
|
|
parent.removeChild(oldChild);
|
|
}
|
|
}
|
|
|
|
selectRootElement(selectorOrNode: string|any, debugInfo?: any): any {
|
|
let el: any;
|
|
if (typeof selectorOrNode === 'string') {
|
|
el = this.document.querySelector(selectorOrNode);
|
|
if (!el) {
|
|
throw new Error(`The selector "${selectorOrNode}" did not match any elements`);
|
|
}
|
|
} else {
|
|
el = selectorOrNode;
|
|
}
|
|
while (el.firstChild) {
|
|
el.removeChild(el.firstChild);
|
|
}
|
|
return el;
|
|
}
|
|
|
|
parentNode(node: any): any { return node.parentNode; }
|
|
|
|
nextSibling(node: any): any { return node.nextSibling; }
|
|
|
|
setAttribute(el: any, name: string, value: string, namespace?: string): void {
|
|
if (namespace) {
|
|
el.setAttributeNS(NAMESPACE_URIS[namespace], namespace + ':' + name, value);
|
|
} else {
|
|
el.setAttribute(name, value);
|
|
}
|
|
}
|
|
|
|
removeAttribute(el: any, name: string, namespace?: string): void {
|
|
if (namespace) {
|
|
el.removeAttributeNS(NAMESPACE_URIS[namespace], name);
|
|
} else {
|
|
el.removeAttribute(name);
|
|
}
|
|
}
|
|
|
|
addClass(el: any, name: string): void { el.classList.add(name); }
|
|
|
|
removeClass(el: any, name: string): void { el.classList.remove(name); }
|
|
|
|
setStyle(el: any, style: string, value: any, flags: RendererStyleFlags2): void {
|
|
style = style.replace(/([a-z])([A-Z])/g, '$1-$2').toLowerCase();
|
|
const styleMap = _readStyleAttribute(el);
|
|
styleMap[style] = value == null ? '' : value;
|
|
_writeStyleAttribute(el, styleMap);
|
|
}
|
|
|
|
removeStyle(el: any, style: string, flags: RendererStyleFlags2): void {
|
|
// IE requires '' instead of null
|
|
// see https://github.com/angular/angular/issues/7916
|
|
this.setStyle(el, style, '', flags);
|
|
}
|
|
|
|
// The value was validated already as a property binding, against the property name.
|
|
// To know this value is safe to use as an attribute, the security context of the
|
|
// attribute with the given name is checked against that security context of the
|
|
// property.
|
|
private _isSafeToReflectProperty(tagName: string, propertyName: string): boolean {
|
|
return this.schema.securityContext(tagName, propertyName, true) ===
|
|
this.schema.securityContext(tagName, propertyName, false);
|
|
}
|
|
|
|
setProperty(el: any, name: string, value: any): void {
|
|
checkNoSyntheticProp(name, 'property');
|
|
if (name === 'innerText') {
|
|
// Domino does not support innerText. Just map it to textContent.
|
|
el.textContent = value;
|
|
}
|
|
(<any>el)[name] = value;
|
|
// Mirror property values for known HTML element properties in the attributes.
|
|
// Skip `innerhtml` which is conservatively marked as an attribute for security
|
|
// purposes but is not actually an attribute.
|
|
const tagName = (el.tagName as string).toLowerCase();
|
|
if (value != null && (typeof value === 'number' || typeof value == 'string') &&
|
|
name.toLowerCase() !== 'innerhtml' && this.schema.hasElement(tagName, EMPTY_ARRAY) &&
|
|
this.schema.hasProperty(tagName, name, EMPTY_ARRAY) &&
|
|
this._isSafeToReflectProperty(tagName, name)) {
|
|
this.setAttribute(el, name, value.toString());
|
|
}
|
|
}
|
|
|
|
setValue(node: any, value: string): void { node.textContent = value; }
|
|
|
|
listen(
|
|
target: 'document'|'window'|'body'|any, eventName: string,
|
|
callback: (event: any) => boolean): () => void {
|
|
checkNoSyntheticProp(eventName, 'listener');
|
|
if (typeof target === 'string') {
|
|
return <() => void>this.eventManager.addGlobalEventListener(
|
|
target, eventName, this.decoratePreventDefault(callback));
|
|
}
|
|
return <() => void>this.eventManager.addEventListener(
|
|
target, eventName, this.decoratePreventDefault(callback)) as() => void;
|
|
}
|
|
|
|
private decoratePreventDefault(eventHandler: Function): Function {
|
|
return (event: any) => {
|
|
// Ivy uses `Function` as a special token that allows us to unwrap the function
|
|
// so that it can be invoked programmatically by `DebugNode.triggerEventHandler`.
|
|
if (event === Function) {
|
|
return eventHandler;
|
|
}
|
|
|
|
// Run the event handler inside the ngZone because event handlers are not patched
|
|
// by Zone on the server. This is required only for tests.
|
|
const allowDefaultBehavior = this.ngZone.runGuarded(() => eventHandler(event));
|
|
if (allowDefaultBehavior === false) {
|
|
event.preventDefault();
|
|
event.returnValue = false;
|
|
}
|
|
|
|
return undefined;
|
|
};
|
|
}
|
|
}
|
|
|
|
const AT_CHARCODE = '@'.charCodeAt(0);
|
|
function checkNoSyntheticProp(name: string, nameKind: string) {
|
|
if (name.charCodeAt(0) === AT_CHARCODE) {
|
|
throw new Error(
|
|
`Found the synthetic ${nameKind} ${name}. Please include either "BrowserAnimationsModule" or "NoopAnimationsModule" in your application.`);
|
|
}
|
|
}
|
|
|
|
class EmulatedEncapsulationServerRenderer2 extends DefaultServerRenderer2 {
|
|
private contentAttr: string;
|
|
private hostAttr: string;
|
|
|
|
constructor(
|
|
eventManager: EventManager, document: any, ngZone: NgZone, sharedStylesHost: SharedStylesHost,
|
|
schema: DomElementSchemaRegistry, private component: RendererType2) {
|
|
super(eventManager, document, ngZone, schema);
|
|
// Add a 's' prefix to style attributes to indicate server.
|
|
const componentId = 's' + component.id;
|
|
const styles = flattenStyles(componentId, component.styles, []);
|
|
sharedStylesHost.addStyles(styles);
|
|
|
|
this.contentAttr = shimContentAttribute(componentId);
|
|
this.hostAttr = shimHostAttribute(componentId);
|
|
}
|
|
|
|
applyToHost(element: any) { super.setAttribute(element, this.hostAttr, ''); }
|
|
|
|
createElement(parent: any, name: string): Element {
|
|
const el = super.createElement(parent, name, this.document);
|
|
super.setAttribute(el, this.contentAttr, '');
|
|
return el;
|
|
}
|
|
}
|
|
|
|
function _readStyleAttribute(element: any): {[name: string]: string} {
|
|
const styleMap: {[name: string]: string} = {};
|
|
const styleAttribute = element.getAttribute('style');
|
|
if (styleAttribute) {
|
|
const styleList = styleAttribute.split(/;+/g);
|
|
for (let i = 0; i < styleList.length; i++) {
|
|
const style = styleList[i].trim();
|
|
if (style.length > 0) {
|
|
const colonIndex = style.indexOf(':');
|
|
if (colonIndex === -1) {
|
|
throw new Error(`Invalid CSS style: ${style}`);
|
|
}
|
|
const name = style.substr(0, colonIndex).trim();
|
|
styleMap[name] = style.substr(colonIndex + 1).trim();
|
|
}
|
|
}
|
|
}
|
|
return styleMap;
|
|
}
|
|
|
|
function _writeStyleAttribute(element: any, styleMap: {[name: string]: string}) {
|
|
let styleAttrValue = '';
|
|
for (const key in styleMap) {
|
|
const newValue = styleMap[key];
|
|
if (newValue != null) {
|
|
styleAttrValue += key + ':' + styleMap[key] + ';';
|
|
}
|
|
}
|
|
element.setAttribute('style', styleAttrValue);
|
|
}
|