/** * @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 {HtmlAttrAst, HtmlCommentAst, HtmlElementAst, HtmlExpansionAst, HtmlExpansionCaseAst, HtmlTextAst} from '@angular/compiler/src/html_ast'; import {HtmlTokenType} from '@angular/compiler/src/html_lexer'; import {HtmlParseTreeResult, HtmlParser, HtmlTreeError} from '@angular/compiler/src/html_parser'; import {ParseError} from '@angular/compiler/src/parse_util'; import {afterEach, beforeEach, ddescribe, describe, expect, iit, it, xit} from '@angular/core/testing/testing_internal'; import {humanizeDom, humanizeDomSourceSpans, humanizeLineColumn} from './html_ast_spec_utils'; export function main() { describe('HtmlParser', () => { var parser: HtmlParser; beforeEach(() => { parser = new HtmlParser(); }); describe('parse', () => { describe('text nodes', () => { it('should parse root level text nodes', () => { expect(humanizeDom(parser.parse('a', 'TestComp'))).toEqual([[HtmlTextAst, 'a', 0]]); }); it('should parse text nodes inside regular elements', () => { expect(humanizeDom(parser.parse('
a
', 'TestComp'))).toEqual([ [HtmlElementAst, 'div', 0], [HtmlTextAst, 'a', 1] ]); }); it('should parse text nodes inside template elements', () => { expect(humanizeDom(parser.parse('', 'TestComp'))).toEqual([ [HtmlElementAst, 'template', 0], [HtmlTextAst, 'a', 1] ]); }); it('should parse CDATA', () => { expect(humanizeDom(parser.parse('', 'TestComp'))).toEqual([ [HtmlTextAst, 'text', 0] ]); }); }); describe('elements', () => { it('should parse root level elements', () => { expect(humanizeDom(parser.parse('
', 'TestComp'))).toEqual([ [HtmlElementAst, 'div', 0] ]); }); it('should parse elements inside of regular elements', () => { expect(humanizeDom(parser.parse('
', 'TestComp'))).toEqual([ [HtmlElementAst, 'div', 0], [HtmlElementAst, 'span', 1] ]); }); it('should parse elements inside of template elements', () => { expect(humanizeDom(parser.parse('', 'TestComp'))) .toEqual([[HtmlElementAst, 'template', 0], [HtmlElementAst, 'span', 1]]); }); it('should support void elements', () => { expect(humanizeDom(parser.parse('', 'TestComp'))) .toEqual([ [HtmlElementAst, 'link', 0], [HtmlAttrAst, 'rel', 'author license'], [HtmlAttrAst, 'href', '/about'], ]); }); it('should not error on void elements from HTML5 spec', () => { // http://www.w3.org/TR/html-markup/syntax.html#syntax-elements without: // - it can be present in head only // - it can be present in head only // - obsolete // - obsolete ['', '

', '', '
', '

', '
', '
', '/', '', '', '

', ].forEach((html) => { expect(parser.parse(html, 'TestComp').errors).toEqual([]); }); }); it('should close void elements on text nodes', () => { expect(humanizeDom(parser.parse('

before
after

', 'TestComp'))).toEqual([ [HtmlElementAst, 'p', 0], [HtmlTextAst, 'before', 1], [HtmlElementAst, 'br', 1], [HtmlTextAst, 'after', 1], ]); }); it('should support optional end tags', () => { expect(humanizeDom(parser.parse('

1

2

', 'TestComp'))).toEqual([ [HtmlElementAst, 'div', 0], [HtmlElementAst, 'p', 1], [HtmlTextAst, '1', 2], [HtmlElementAst, 'p', 1], [HtmlTextAst, '2', 2], ]); }); it('should support nested elements', () => { expect(humanizeDom(parser.parse('
', 'TestComp'))) .toEqual([ [HtmlElementAst, 'ul', 0], [HtmlElementAst, 'li', 1], [HtmlElementAst, 'ul', 2], [HtmlElementAst, 'li', 3], ]); }); it('should add the requiredParent', () => { expect( humanizeDom(parser.parse( '
', 'TestComp'))) .toEqual([ [HtmlElementAst, 'table', 0], [HtmlElementAst, 'thead', 1], [HtmlElementAst, 'tr', 2], [HtmlAttrAst, 'head', ''], [HtmlElementAst, 'tbody', 1], [HtmlElementAst, 'tr', 2], [HtmlAttrAst, 'noparent', ''], [HtmlElementAst, 'tbody', 1], [HtmlElementAst, 'tr', 2], [HtmlAttrAst, 'body', ''], [HtmlElementAst, 'tfoot', 1], [HtmlElementAst, 'tr', 2], [HtmlAttrAst, 'foot', ''], ]); }); it('should append the required parent considering ng-container', () => { expect(humanizeDom(parser.parse( '
', 'TestComp'))) .toEqual([ [HtmlElementAst, 'table', 0], [HtmlElementAst, 'tbody', 1], [HtmlElementAst, 'ng-container', 2], [HtmlElementAst, 'tr', 3], ]); }); it('should special case ng-container when adding a required parent', () => { expect(humanizeDom(parser.parse( '
', 'TestComp'))) .toEqual([ [HtmlElementAst, 'table', 0], [HtmlElementAst, 'thead', 1], [HtmlElementAst, 'ng-container', 2], [HtmlElementAst, 'tr', 3], ]); }); it('should not add the requiredParent when the parent is a template', () => { expect(humanizeDom(parser.parse('', 'TestComp'))).toEqual([ [HtmlElementAst, 'template', 0], [HtmlElementAst, 'tr', 1], ]); }); // https://github.com/angular/angular/issues/5967 it('should not add the requiredParent to a template root element', () => { expect(humanizeDom(parser.parse('', 'TestComp'))).toEqual([ [HtmlElementAst, 'tr', 0], ]); }); it('should support explicit mamespace', () => { expect(humanizeDom(parser.parse('', 'TestComp'))).toEqual([ [HtmlElementAst, ':myns:div', 0] ]); }); it('should support implicit mamespace', () => { expect(humanizeDom(parser.parse('', 'TestComp'))).toEqual([ [HtmlElementAst, ':svg:svg', 0] ]); }); it('should propagate the namespace', () => { expect(humanizeDom(parser.parse('

', 'TestComp'))).toEqual([ [HtmlElementAst, ':myns:div', 0], [HtmlElementAst, ':myns:p', 1] ]); }); it('should match closing tags case sensitive', () => { let errors = parser.parse('

', 'TestComp').errors; expect(errors.length).toEqual(2); expect(humanizeErrors(errors)).toEqual([ ['p', 'Unexpected closing tag "p"', '0:8'], ['dIv', 'Unexpected closing tag "dIv"', '0:12'], ]); }); it('should support self closing void elements', () => { expect(humanizeDom(parser.parse('', 'TestComp'))).toEqual([ [HtmlElementAst, 'input', 0] ]); }); it('should support self closing foreign elements', () => { expect(humanizeDom(parser.parse('', 'TestComp'))).toEqual([ [HtmlElementAst, ':math:math', 0] ]); }); it('should ignore LF immediately after textarea, pre and listing', () => { expect(humanizeDom(parser.parse( '

\n

\n\n
\n\n', 'TestComp'))) .toEqual([ [HtmlElementAst, 'p', 0], [HtmlTextAst, '\n', 1], [HtmlElementAst, 'textarea', 0], [HtmlElementAst, 'pre', 0], [HtmlTextAst, '\n', 1], [HtmlElementAst, 'listing', 0], [HtmlTextAst, '\n', 1], ]); }); }); describe('attributes', () => { it('should parse attributes on regular elements case sensitive', () => { expect(humanizeDom(parser.parse('
', 'TestComp'))).toEqual([ [HtmlElementAst, 'div', 0], [HtmlAttrAst, 'kEy', 'v'], [HtmlAttrAst, 'key2', 'v2'], ]); }); it('should parse attributes without values', () => { expect(humanizeDom(parser.parse('
', 'TestComp'))).toEqual([ [HtmlElementAst, 'div', 0], [HtmlAttrAst, 'k', ''] ]); }); it('should parse attributes on svg elements case sensitive', () => { expect(humanizeDom(parser.parse('', 'TestComp'))).toEqual([ [HtmlElementAst, ':svg:svg', 0], [HtmlAttrAst, 'viewBox', '0'] ]); }); it('should parse attributes on template elements', () => { expect(humanizeDom(parser.parse('', 'TestComp'))).toEqual([ [HtmlElementAst, 'template', 0], [HtmlAttrAst, 'k', 'v'] ]); }); it('should support namespace', () => { expect(humanizeDom(parser.parse('', 'TestComp'))).toEqual([ [HtmlElementAst, ':svg:use', 0], [HtmlAttrAst, ':xlink:href', 'Port'] ]); }); }); describe('comments', () => { it('should preserve comments', () => { expect(humanizeDom(parser.parse('
', 'TestComp'))).toEqual([ [HtmlCommentAst, 'comment', 0], [HtmlElementAst, 'div', 0] ]); }); }); describe('expansion forms', () => { it('should parse out expansion forms', () => { let parsed = parser.parse( `
before{messages.length, plural, =0 {You have no messages} =1 {One {{message}}}}after
`, 'TestComp', true); expect(humanizeDom(parsed)).toEqual([ [HtmlElementAst, 'div', 0], [HtmlTextAst, 'before', 1], [HtmlExpansionAst, 'messages.length', 'plural', 1], [HtmlExpansionCaseAst, '=0', 2], [HtmlExpansionCaseAst, '=1', 2], [HtmlTextAst, 'after', 1], ]); let cases = (parsed.rootNodes[0]).children[1].cases; expect(humanizeDom(new HtmlParseTreeResult(cases[0].expression, []))).toEqual([ [HtmlTextAst, 'You have ', 0], [HtmlElementAst, 'b', 0], [HtmlTextAst, 'no', 1], [HtmlTextAst, ' messages', 0], ]); expect(humanizeDom(new HtmlParseTreeResult(cases[1].expression, [ ]))).toEqual([[HtmlTextAst, 'One {{message}}', 0]]); }); it('should parse out nested expansion forms', () => { let parsed = parser.parse( `{messages.length, plural, =0 { {p.gender, gender, =m {m}} }}`, 'TestComp', true); expect(humanizeDom(parsed)).toEqual([ [HtmlExpansionAst, 'messages.length', 'plural', 0], [HtmlExpansionCaseAst, '=0', 1], ]); let firstCase = (parsed.rootNodes[0]).cases[0]; expect(humanizeDom(new HtmlParseTreeResult(firstCase.expression, []))).toEqual([ [HtmlExpansionAst, 'p.gender', 'gender', 0], [HtmlExpansionCaseAst, '=m', 1], [HtmlTextAst, ' ', 0], ]); }); it('should error when expansion form is not closed', () => { let p = parser.parse(`{messages.length, plural, =0 {one}`, 'TestComp', true); expect(humanizeErrors(p.errors)).toEqual([ [null, 'Invalid expansion form. Missing \'}\'.', '0:34'] ]); }); it('should error when expansion case is not closed', () => { let p = parser.parse(`{messages.length, plural, =0 {one`, 'TestComp', true); expect(humanizeErrors(p.errors)).toEqual([ [null, 'Invalid expansion form. Missing \'}\'.', '0:29'] ]); }); it('should error when invalid html in the case', () => { let p = parser.parse(`{messages.length, plural, =0 {}`, 'TestComp', true); expect(humanizeErrors(p.errors)).toEqual([ ['b', 'Only void and foreign elements can be self closed "b"', '0:30'] ]); }); }); describe('source spans', () => { it('should store the location', () => { expect(humanizeDomSourceSpans(parser.parse( '
\na\n
', 'TestComp'))) .toEqual([ [HtmlElementAst, 'div', 0, '
'], [HtmlAttrAst, '[prop]', 'v1', '[prop]="v1"'], [HtmlAttrAst, '(e)', 'do()', '(e)="do()"'], [HtmlAttrAst, 'attr', 'v2', 'attr="v2"'], [HtmlAttrAst, 'noValue', '', 'noValue'], [HtmlTextAst, '\na\n', 1, '\na\n'], ]); }); it('should set the start and end source spans', () => { let node = parser.parse('
a
', 'TestComp').rootNodes[0]; expect(node.startSourceSpan.start.offset).toEqual(0); expect(node.startSourceSpan.end.offset).toEqual(5); expect(node.endSourceSpan.start.offset).toEqual(6); expect(node.endSourceSpan.end.offset).toEqual(12); }); }); describe('errors', () => { it('should report unexpected closing tags', () => { let errors = parser.parse('

', 'TestComp').errors; expect(errors.length).toEqual(1); expect(humanizeErrors(errors)).toEqual([['p', 'Unexpected closing tag "p"', '0:5']]); }); it('should report subsequent open tags without proper close tag', () => { let errors = parser.parse('', 'TestComp').errors; expect(errors.length).toEqual(1); expect(humanizeErrors(errors)).toEqual([['div', 'Unexpected closing tag "div"', '0:4']]); }); it('should report closing tag for void elements', () => { let errors = parser.parse('', 'TestComp').errors; expect(errors.length).toEqual(1); expect(humanizeErrors(errors)).toEqual([ ['input', 'Void elements do not have end tags "input"', '0:7'] ]); }); it('should report self closing html element', () => { let errors = parser.parse('

', 'TestComp').errors; expect(errors.length).toEqual(1); expect(humanizeErrors(errors)).toEqual([ ['p', 'Only void and foreign elements can be self closed "p"', '0:0'] ]); }); it('should report self closing custom element', () => { let errors = parser.parse('', 'TestComp').errors; expect(errors.length).toEqual(1); expect(humanizeErrors(errors)).toEqual([ ['my-cmp', 'Only void and foreign elements can be self closed "my-cmp"', '0:0'] ]); }); it('should also report lexer errors', () => { let errors = parser.parse('

', 'TestComp').errors; expect(errors.length).toEqual(2); expect(humanizeErrors(errors)).toEqual([ [HtmlTokenType.COMMENT_START, 'Unexpected character "e"', '0:3'], ['p', 'Unexpected closing tag "p"', '0:14'] ]); }); }); }); }); } export function humanizeErrors(errors: ParseError[]): any[] { return errors.map(e => { if (e instanceof HtmlTreeError) { // Parser errors return [e.elementName, e.msg, humanizeLineColumn(e.span.start)]; } // Tokenizer errors return [(e).tokenType, e.msg, humanizeLineColumn(e.span.start)]; }); }