/** * @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 {RenderFlags} from '@angular/core/src/render3'; import {defineComponent, defineDirective} from '../../src/render3/index'; import {NO_CHANGE, bind, container, containerRefreshEnd, containerRefreshStart, elementAttribute, elementClassNamed, elementEnd, elementProperty, elementStart, elementStyleNamed, embeddedViewEnd, embeddedViewStart, interpolation1, interpolation2, interpolation3, interpolation4, interpolation5, interpolation6, interpolation7, interpolation8, interpolationV, load, loadDirective, projection, projectionDef, text, textBinding} from '../../src/render3/instructions'; import {LViewFlags} from '../../src/render3/interfaces/view'; import {sanitizeUrl} from '../../src/sanitization/sanitization'; import {Sanitizer, SecurityContext} from '../../src/sanitization/security'; import {ComponentFixture, containerEl, renderToHtml} from './render_util'; describe('render3 integration test', () => { describe('render', () => { it('should render basic template', () => { expect(renderToHtml(Template, {})).toEqual('Greetings'); function Template(rf: RenderFlags, ctx: any) { if (rf & RenderFlags.Create) { elementStart(0, 'span', ['title', 'Hello']); { text(1, 'Greetings'); } elementEnd(); } } expect(ngDevMode).toHaveProperties({ firstTemplatePass: 1, tNode: 3, // 1 for div, 1 for text, 1 for host element tView: 1, rendererCreateElement: 1, }); }); it('should render and update basic "Hello, World" template', () => { expect(renderToHtml(Template, 'World')).toEqual('

Hello, World!

'); expect(renderToHtml(Template, 'New World')).toEqual('

Hello, New World!

'); function Template(rf: RenderFlags, ctx: any) { if (rf & RenderFlags.Create) { elementStart(0, 'h1'); { text(1); } elementEnd(); } if (rf & RenderFlags.Update) { textBinding(1, interpolation1('Hello, ', ctx, '!')); } } }); }); describe('text bindings', () => { it('should render "undefined" as "" when used with `bind()`', () => { function Template(rf: RenderFlags, name: string) { if (rf & RenderFlags.Create) { text(0); } if (rf & RenderFlags.Update) { textBinding(0, bind(name)); } } expect(renderToHtml(Template, 'benoit')).toEqual('benoit'); expect(renderToHtml(Template, undefined)).toEqual(''); expect(ngDevMode).toHaveProperties({ firstTemplatePass: 0, tNode: 2, tView: 1, rendererSetText: 2, }); }); it('should render "null" as "" when used with `bind()`', () => { function Template(rf: RenderFlags, name: string) { if (rf & RenderFlags.Create) { text(0); } if (rf & RenderFlags.Update) { textBinding(0, bind(name)); } } expect(renderToHtml(Template, 'benoit')).toEqual('benoit'); expect(renderToHtml(Template, null)).toEqual(''); expect(ngDevMode).toHaveProperties({ firstTemplatePass: 0, tNode: 2, tView: 1, rendererSetText: 2, }); }); it('should support creation-time values in text nodes', () => { function Template(rf: RenderFlags, value: string) { if (rf & RenderFlags.Create) { text(0); } if (rf & RenderFlags.Update) { textBinding(0, rf & RenderFlags.Create ? value : NO_CHANGE); } } expect(renderToHtml(Template, 'once')).toEqual('once'); expect(renderToHtml(Template, 'twice')).toEqual('once'); expect(ngDevMode).toHaveProperties({ firstTemplatePass: 0, tNode: 2, tView: 1, rendererSetText: 1, }); }); }); describe('Siblings update', () => { it('should handle a flat list of static/bound text nodes', () => { function Template(rf: RenderFlags, name: string) { if (rf & RenderFlags.Create) { text(0, 'Hello '); text(1); text(2, '!'); } if (rf & RenderFlags.Update) { textBinding(1, bind(name)); } } expect(renderToHtml(Template, 'world')).toEqual('Hello world!'); expect(renderToHtml(Template, 'monde')).toEqual('Hello monde!'); }); it('should handle a list of static/bound text nodes as element children', () => { function Template(rf: RenderFlags, name: string) { if (rf & RenderFlags.Create) { elementStart(0, 'b'); { text(1, 'Hello '); text(2); text(3, '!'); } elementEnd(); } if (rf & RenderFlags.Update) { textBinding(2, bind(name)); } } expect(renderToHtml(Template, 'world')).toEqual('Hello world!'); expect(renderToHtml(Template, 'mundo')).toEqual('Hello mundo!'); }); it('should render/update text node as a child of a deep list of elements', () => { function Template(rf: RenderFlags, name: string) { if (rf & RenderFlags.Create) { elementStart(0, 'b'); { elementStart(1, 'b'); { elementStart(2, 'b'); { elementStart(3, 'b'); { text(4); } elementEnd(); } elementEnd(); } elementEnd(); } elementEnd(); } if (rf & RenderFlags.Update) { textBinding(4, interpolation1('Hello ', name, '!')); } } expect(renderToHtml(Template, 'world')).toEqual('Hello world!'); expect(renderToHtml(Template, 'mundo')).toEqual('Hello mundo!'); }); it('should update 2 sibling elements', () => { function Template(rf: RenderFlags, id: any) { if (rf & RenderFlags.Create) { elementStart(0, 'b'); { elementStart(1, 'span'); elementEnd(); elementStart(2, 'span', ['class', 'foo']); {} elementEnd(); } elementEnd(); } if (rf & RenderFlags.Update) { elementAttribute(2, 'id', bind(id)); } } expect(renderToHtml(Template, 'foo')) .toEqual(''); expect(renderToHtml(Template, 'bar')) .toEqual(''); }); it('should handle sibling text node after element with child text node', () => { function Template(rf: RenderFlags, ctx: any) { if (rf & RenderFlags.Create) { elementStart(0, 'p'); { text(1, 'hello'); } elementEnd(); text(2, 'world'); } } expect(renderToHtml(Template, null)).toEqual('

hello

world'); }); }); describe('basic components', () => { class TodoComponent { value = ' one'; static ngComponentDef = defineComponent({ type: TodoComponent, selectors: [['todo']], template: function TodoTemplate(rf: RenderFlags, ctx: any) { if (rf & RenderFlags.Create) { elementStart(0, 'p'); { text(1, 'Todo'); text(2); } elementEnd(); } if (rf & RenderFlags.Update) { textBinding(2, bind(ctx.value)); } }, factory: () => new TodoComponent }); } const defs = [TodoComponent]; it('should support a basic component template', () => { function Template(rf: RenderFlags, ctx: any) { if (rf & RenderFlags.Create) { elementStart(0, 'todo'); elementEnd(); } } expect(renderToHtml(Template, null, defs)).toEqual('

Todo one

'); }); it('should support a component template with sibling', () => { function Template(rf: RenderFlags, ctx: any) { if (rf & RenderFlags.Create) { elementStart(0, 'todo'); elementEnd(); text(1, 'two'); } } expect(renderToHtml(Template, null, defs)).toEqual('

Todo one

two'); }); it('should support a component template with component sibling', () => { /** * * */ function Template(rf: RenderFlags, ctx: any) { if (rf & RenderFlags.Create) { elementStart(0, 'todo'); elementEnd(); elementStart(1, 'todo'); elementEnd(); } } expect(renderToHtml(Template, null, defs)) .toEqual('

Todo one

Todo one

'); }); it('should support a component with binding on host element', () => { let cmptInstance: TodoComponentHostBinding|null; class TodoComponentHostBinding { title = 'one'; static ngComponentDef = defineComponent({ type: TodoComponentHostBinding, selectors: [['todo']], template: function TodoComponentHostBindingTemplate( rf: RenderFlags, ctx: TodoComponentHostBinding) { if (rf & RenderFlags.Create) { text(0); } if (rf & RenderFlags.Update) { textBinding(0, bind(ctx.title)); } }, factory: () => cmptInstance = new TodoComponentHostBinding, hostBindings: function(directiveIndex: number, elementIndex: number): void { // host bindings elementProperty( elementIndex, 'title', bind(loadDirective(directiveIndex).title)); } }); } function Template(rf: RenderFlags, ctx: any) { if (rf & RenderFlags.Create) { elementStart(0, 'todo'); elementEnd(); } } const defs = [TodoComponentHostBinding]; expect(renderToHtml(Template, {}, defs)).toEqual('one'); cmptInstance !.title = 'two'; expect(renderToHtml(Template, {}, defs)).toEqual('two'); }); it('should support root component with host attribute', () => { class HostAttributeComp { static ngComponentDef = defineComponent({ type: HostAttributeComp, selectors: [['host-attr-comp']], factory: () => new HostAttributeComp(), template: (rf: RenderFlags, ctx: HostAttributeComp) => {}, attributes: ['role', 'button'] }); } const fixture = new ComponentFixture(HostAttributeComp); expect(fixture.hostElement.getAttribute('role')).toEqual('button'); }); it('should support component with bindings in template', () => { /**

{{ name }}

*/ class MyComp { name = 'Bess'; static ngComponentDef = defineComponent({ type: MyComp, selectors: [['comp']], template: function MyCompTemplate(rf: RenderFlags, ctx: any) { if (rf & RenderFlags.Create) { elementStart(0, 'p'); { text(1); } elementEnd(); } if (rf & RenderFlags.Update) { textBinding(1, bind(ctx.name)); } }, factory: () => new MyComp }); } function Template(rf: RenderFlags, ctx: any) { if (rf & RenderFlags.Create) { elementStart(0, 'comp'); elementEnd(); } } expect(renderToHtml(Template, null, [MyComp])).toEqual('

Bess

'); }); it('should support a component with sub-views', () => { /** * % if (condition) { *
text
* % } */ class MyComp { condition: boolean; static ngComponentDef = defineComponent({ type: MyComp, selectors: [['comp']], template: function MyCompTemplate(rf: RenderFlags, ctx: any) { if (rf & RenderFlags.Create) { container(0); } if (rf & RenderFlags.Update) { containerRefreshStart(0); { if (ctx.condition) { let rf1 = embeddedViewStart(0); if (rf1 & RenderFlags.Create) { elementStart(0, 'div'); { text(1, 'text'); } elementEnd(); } embeddedViewEnd(); } } containerRefreshEnd(); } }, factory: () => new MyComp, inputs: {condition: 'condition'} }); } /** */ function Template(rf: RenderFlags, ctx: any) { if (rf & RenderFlags.Create) { elementStart(0, 'comp'); elementEnd(); } if (rf & RenderFlags.Update) { elementProperty(0, 'condition', bind(ctx.condition)); } } const defs = [MyComp]; expect(renderToHtml(Template, {condition: true}, defs)) .toEqual('
text
'); expect(renderToHtml(Template, {condition: false}, defs)).toEqual(''); }); }); describe('tree', () => { interface Tree { beforeLabel?: string; subTrees?: Tree[]; afterLabel?: string; } interface ParentCtx { beforeTree: Tree; projectedTree: Tree; afterTree: Tree; } function showLabel(rf: RenderFlags, ctx: {label: string | undefined}) { if (rf & RenderFlags.Create) { container(0); } if (rf & RenderFlags.Update) { containerRefreshStart(0); { if (ctx.label != null) { let rf1 = embeddedViewStart(0); if (rf1 & RenderFlags.Create) { text(0); } if (rf1 & RenderFlags.Update) { textBinding(0, bind(ctx.label)); } embeddedViewEnd(); } } containerRefreshEnd(); } } function showTree(rf: RenderFlags, ctx: {tree: Tree}) { if (rf & RenderFlags.Create) { container(0); container(1); container(2); } containerRefreshStart(0); { const rf0 = embeddedViewStart(0); { showLabel(rf0, {label: ctx.tree.beforeLabel}); } embeddedViewEnd(); } containerRefreshEnd(); containerRefreshStart(1); { for (let subTree of ctx.tree.subTrees || []) { const rf0 = embeddedViewStart(0); { showTree(rf0, {tree: subTree}); } embeddedViewEnd(); } } containerRefreshEnd(); containerRefreshStart(2); { const rf0 = embeddedViewStart(0); { showLabel(rf0, {label: ctx.tree.afterLabel}); } embeddedViewEnd(); } containerRefreshEnd(); } class ChildComponent { beforeTree: Tree; afterTree: Tree; static ngComponentDef = defineComponent({ selectors: [['child']], type: ChildComponent, template: function ChildComponentTemplate( rf: RenderFlags, ctx: {beforeTree: Tree, afterTree: Tree}) { if (rf & RenderFlags.Create) { projectionDef(0); container(1); projection(2, 0); container(3); } containerRefreshStart(1); { const rf0 = embeddedViewStart(0); { showTree(rf0, {tree: ctx.beforeTree}); } embeddedViewEnd(); } containerRefreshEnd(); containerRefreshStart(3); { const rf0 = embeddedViewStart(0); { showTree(rf0, {tree: ctx.afterTree}); } embeddedViewEnd(); } containerRefreshEnd(); }, factory: () => new ChildComponent, inputs: {beforeTree: 'beforeTree', afterTree: 'afterTree'} }); } function parentTemplate(rf: RenderFlags, ctx: ParentCtx) { if (rf & RenderFlags.Create) { elementStart(0, 'child'); { container(1); } elementEnd(); } if (rf & RenderFlags.Update) { elementProperty(0, 'beforeTree', bind(ctx.beforeTree)); elementProperty(0, 'afterTree', bind(ctx.afterTree)); containerRefreshStart(1); { const rf0 = embeddedViewStart(0); { showTree(rf0, {tree: ctx.projectedTree}); } embeddedViewEnd(); } containerRefreshEnd(); } } it('should work with a tree', () => { const ctx: ParentCtx = { beforeTree: {subTrees: [{beforeLabel: 'a'}]}, projectedTree: {beforeLabel: 'p'}, afterTree: {afterLabel: 'z'} }; const defs = [ChildComponent]; expect(renderToHtml(parentTemplate, ctx, defs)).toEqual('apz'); ctx.projectedTree = {subTrees: [{}, {}, {subTrees: [{}, {}]}, {}]}; ctx.beforeTree.subTrees !.push({afterLabel: 'b'}); expect(renderToHtml(parentTemplate, ctx, defs)).toEqual('abz'); ctx.projectedTree.subTrees ![1].afterLabel = 'h'; expect(renderToHtml(parentTemplate, ctx, defs)).toEqual('abhz'); ctx.beforeTree.subTrees !.push({beforeLabel: 'c'}); expect(renderToHtml(parentTemplate, ctx, defs)).toEqual('abchz'); // To check the context easily: // console.log(JSON.stringify(ctx)); }); }); describe('element bindings', () => { describe('elementAttribute', () => { it('should support attribute bindings', () => { const ctx: {title: string | null} = {title: 'Hello'}; function Template(rf: RenderFlags, ctx: any) { if (rf & RenderFlags.Create) { elementStart(0, 'span'); elementEnd(); } if (rf & RenderFlags.Update) { elementAttribute(0, 'title', bind(ctx.title)); } } // initial binding expect(renderToHtml(Template, ctx)).toEqual(''); // update binding ctx.title = 'Hi!'; expect(renderToHtml(Template, ctx)).toEqual(''); // remove attribute ctx.title = null; expect(renderToHtml(Template, ctx)).toEqual(''); }); it('should stringify values used attribute bindings', () => { const ctx: {title: any} = {title: NaN}; function Template(rf: RenderFlags, ctx: any) { if (rf & RenderFlags.Create) { elementStart(0, 'span'); elementEnd(); } if (rf & RenderFlags.Update) { elementAttribute(0, 'title', bind(ctx.title)); } } expect(renderToHtml(Template, ctx)).toEqual(''); ctx.title = {toString: () => 'Custom toString'}; expect(renderToHtml(Template, ctx)).toEqual(''); }); it('should update bindings', () => { function Template(rf: RenderFlags, c: any) { if (rf & RenderFlags.Create) { elementStart(0, 'b'); elementEnd(); } if (rf & RenderFlags.Update) { elementAttribute(0, 'a', interpolationV(c)); elementAttribute(0, 'a0', bind(c[1])); elementAttribute(0, 'a1', interpolation1(c[0], c[1], c[16])); elementAttribute(0, 'a2', interpolation2(c[0], c[1], c[2], c[3], c[16])); elementAttribute(0, 'a3', interpolation3(c[0], c[1], c[2], c[3], c[4], c[5], c[16])); elementAttribute( 0, 'a4', interpolation4(c[0], c[1], c[2], c[3], c[4], c[5], c[6], c[7], c[16])); elementAttribute( 0, 'a5', interpolation5(c[0], c[1], c[2], c[3], c[4], c[5], c[6], c[7], c[8], c[9], c[16])); elementAttribute( 0, 'a6', interpolation6( c[0], c[1], c[2], c[3], c[4], c[5], c[6], c[7], c[8], c[9], c[10], c[11], c[16])); elementAttribute( 0, 'a7', interpolation7( c[0], c[1], c[2], c[3], c[4], c[5], c[6], c[7], c[8], c[9], c[10], c[11], c[12], c[13], c[16])); elementAttribute( 0, 'a8', interpolation8( c[0], c[1], c[2], c[3], c[4], c[5], c[6], c[7], c[8], c[9], c[10], c[11], c[12], c[13], c[14], c[15], c[16])); } } let args = ['(', 0, 'a', 1, 'b', 2, 'c', 3, 'd', 4, 'e', 5, 'f', 6, 'g', 7, ')']; expect(renderToHtml(Template, args)) .toEqual( ''); args = args.reverse(); expect(renderToHtml(Template, args)) .toEqual( ''); args = args.reverse(); expect(renderToHtml(Template, args)) .toEqual( ''); }); it('should not update DOM if context has not changed', () => { const ctx: {title: string | null} = {title: 'Hello'}; function Template(rf: RenderFlags, ctx: any) { if (rf & RenderFlags.Create) { elementStart(0, 'span'); container(1); elementEnd(); } if (rf & RenderFlags.Update) { elementAttribute(0, 'title', bind(ctx.title)); containerRefreshStart(1); { if (true) { let rf1 = embeddedViewStart(1); { if (rf1 & RenderFlags.Create) { elementStart(0, 'b'); {} elementEnd(); } elementAttribute(0, 'title', bind(ctx.title)); } embeddedViewEnd(); } } containerRefreshEnd(); } } // initial binding expect(renderToHtml(Template, ctx)) .toEqual(''); // update DOM manually containerEl.querySelector('b') !.setAttribute('title', 'Goodbye'); // refresh with same binding expect(renderToHtml(Template, ctx)) .toEqual(''); // refresh again with same binding expect(renderToHtml(Template, ctx)) .toEqual(''); }); it('should support host attribute bindings', () => { let hostBindingDir: HostBindingDir; class HostBindingDir { /* @HostBinding('attr.aria-label') */ label = 'some label'; static ngDirectiveDef = defineDirective({ type: HostBindingDir, selectors: [['', 'hostBindingDir', '']], factory: function HostBindingDir_Factory() { return hostBindingDir = new HostBindingDir(); }, hostBindings: function HostBindingDir_HostBindings(dirIndex: number, elIndex: number) { elementAttribute( elIndex, 'aria-label', bind(loadDirective(dirIndex).label)); } }); } function Template(rf: RenderFlags, ctx: any) { if (rf & RenderFlags.Create) { elementStart(0, 'div', ['hostBindingDir', '']); elementEnd(); } } const defs = [HostBindingDir]; expect(renderToHtml(Template, {}, defs)) .toEqual(`
`); hostBindingDir !.label = 'other label'; expect(renderToHtml(Template, {}, defs)) .toEqual(`
`); }); }); describe('elementStyle', () => { it('should support binding to styles', () => { function Template(rf: RenderFlags, ctx: any) { if (rf & RenderFlags.Create) { elementStart(0, 'span'); elementEnd(); } if (rf & RenderFlags.Update) { elementStyleNamed(0, 'border-color', bind(ctx)); } } expect(renderToHtml(Template, 'red')).toEqual(''); expect(renderToHtml(Template, 'green')) .toEqual(''); expect(renderToHtml(Template, null)).toEqual(''); }); it('should support binding to styles with suffix', () => { function Template(rf: RenderFlags, ctx: any) { if (rf & RenderFlags.Create) { elementStart(0, 'span'); elementEnd(); } if (rf & RenderFlags.Update) { elementStyleNamed(0, 'font-size', bind(ctx), 'px'); } } expect(renderToHtml(Template, '100')).toEqual(''); expect(renderToHtml(Template, 200)).toEqual(''); expect(renderToHtml(Template, null)).toEqual(''); }); }); describe('elementClass', () => { it('should support CSS class toggle', () => { function Template(rf: RenderFlags, ctx: any) { if (rf & RenderFlags.Create) { elementStart(0, 'span'); elementEnd(); } if (rf & RenderFlags.Update) { elementClassNamed(0, 'active', bind(ctx)); } } expect(renderToHtml(Template, true)).toEqual(''); expect(renderToHtml(Template, false)).toEqual(''); // truthy values expect(renderToHtml(Template, 'a_string')).toEqual(''); expect(renderToHtml(Template, 10)).toEqual(''); // falsy values expect(renderToHtml(Template, '')).toEqual(''); expect(renderToHtml(Template, 0)).toEqual(''); }); it('should work correctly with existing static classes', () => { function Template(rf: RenderFlags, ctx: any) { if (rf & RenderFlags.Create) { elementStart(0, 'span', ['class', 'existing']); elementEnd(); } if (rf & RenderFlags.Update) { elementClassNamed(0, 'active', bind(ctx)); } } expect(renderToHtml(Template, true)).toEqual(''); expect(renderToHtml(Template, false)).toEqual(''); }); }); }); describe('template data', () => { it('should re-use template data and node data', () => { /** * % if (condition) { *
* % } */ function Template(rf: RenderFlags, ctx: any) { if (rf & RenderFlags.Create) { container(0); } if (rf & RenderFlags.Update) { containerRefreshStart(0); { if (ctx.condition) { let rf1 = embeddedViewStart(0); if (rf1 & RenderFlags.Create) { elementStart(0, 'div'); elementEnd(); } embeddedViewEnd(); } } containerRefreshEnd(); } } expect((Template as any).ngPrivateData).toBeUndefined(); renderToHtml(Template, {condition: true}); const oldTemplateData = (Template as any).ngPrivateData; const oldContainerData = (oldTemplateData as any).data[0]; const oldElementData = oldContainerData.tViews[0][0]; expect(oldContainerData).not.toBeNull(); expect(oldElementData).not.toBeNull(); renderToHtml(Template, {condition: false}); renderToHtml(Template, {condition: true}); const newTemplateData = (Template as any).ngPrivateData; const newContainerData = (oldTemplateData as any).data[0]; const newElementData = oldContainerData.tViews[0][0]; expect(newTemplateData === oldTemplateData).toBe(true); expect(newContainerData === oldContainerData).toBe(true); expect(newElementData === oldElementData).toBe(true); }); }); describe('sanitization', () => { it('should sanitize data using the provided sanitization interface', () => { class SanitizationComp { static ngComponentDef = defineComponent({ type: SanitizationComp, selectors: [['sanitize-this']], factory: () => new SanitizationComp(), template: (rf: RenderFlags, ctx: SanitizationComp) => { if (rf & RenderFlags.Create) { elementStart(0, 'a'); elementEnd(); } if (rf & RenderFlags.Update) { elementProperty(0, 'href', bind(ctx.href), sanitizeUrl); } } }); private href = ''; updateLink(href: any) { this.href = href; } } const sanitizer = new LocalSanitizer((value) => { return 'http://bar'; }); const fixture = new ComponentFixture(SanitizationComp, {sanitizer}); fixture.component.updateLink('http://foo'); fixture.update(); const element = fixture.hostElement.querySelector('a') !; expect(element.getAttribute('href')).toEqual('http://bar'); fixture.component.updateLink(sanitizer.bypassSecurityTrustUrl('http://foo')); fixture.update(); expect(element.getAttribute('href')).toEqual('http://foo'); }); }); }); class LocalSanitizedValue { constructor(public value: any) {} toString() { return this.value; } } class LocalSanitizer implements Sanitizer { constructor(private _interceptor: (value: string|null|any) => string) {} sanitize(context: SecurityContext, value: LocalSanitizedValue|string|null): string|null { if (value instanceof LocalSanitizedValue) { return value.toString(); } return this._interceptor(value); } bypassSecurityTrustHtml(value: string) {} bypassSecurityTrustStyle(value: string) {} bypassSecurityTrustScript(value: string) {} bypassSecurityTrustResourceUrl(value: string) {} bypassSecurityTrustUrl(value: string) { return new LocalSanitizedValue(value); } }