In RazorCompiler, fix bug about attribute nodes having wrong sequence

numbers. Make tests explicit about sequence numbers.
This commit is contained in:
Steve Sanderson 2018-01-30 15:36:17 +00:00
parent cc053ddbbf
commit 1c9c74c801
3 changed files with 88 additions and 60 deletions

View File

@ -36,13 +36,11 @@ namespace Microsoft.AspNetCore.Blazor.Build.Core.RazorCompilation.Engine
private struct PendingAttribute private struct PendingAttribute
{ {
public int SourceSequence;
public object AttributeValue; public object AttributeValue;
} }
private struct PendingAttributeToken private struct PendingAttributeToken
{ {
public int SourceSequence;
public IntermediateToken AttributeValue; public IntermediateToken AttributeValue;
} }
@ -114,7 +112,6 @@ namespace Microsoft.AspNetCore.Blazor.Build.Core.RazorCompilation.Engine
var token = (IntermediateToken)node.Children.Single(); var token = (IntermediateToken)node.Children.Single();
_currentElementAttributeTokens.Add(new PendingAttributeToken _currentElementAttributeTokens.Add(new PendingAttributeToken
{ {
SourceSequence = _sourceSequence++,
AttributeValue = token AttributeValue = token
}); });
return; return;
@ -165,12 +162,10 @@ namespace Microsoft.AspNetCore.Blazor.Build.Core.RazorCompilation.Engine
public override void WriteHtmlAttribute(CodeRenderingContext context, HtmlAttributeIntermediateNode node) public override void WriteHtmlAttribute(CodeRenderingContext context, HtmlAttributeIntermediateNode node)
{ {
var attributeSourceSequence = _sourceSequence++;
_currentAttributeValues = new List<object>(); _currentAttributeValues = new List<object>();
context.RenderChildren(node); context.RenderChildren(node);
_currentElementAttributes[node.AttributeName] = new PendingAttribute _currentElementAttributes[node.AttributeName] = new PendingAttribute
{ {
SourceSequence = attributeSourceSequence,
AttributeValue = _currentAttributeValues AttributeValue = _currentAttributeValues
}; };
_currentAttributeValues = null; _currentAttributeValues = null;
@ -249,14 +244,14 @@ namespace Microsoft.AspNetCore.Blazor.Build.Core.RazorCompilation.Engine
foreach (var attribute in nextTag.Attributes) foreach (var attribute in nextTag.Attributes)
{ {
WriteAttribute(codeWriter, _sourceSequence++, attribute.Key, attribute.Value); WriteAttribute(codeWriter, attribute.Key, attribute.Value);
} }
if (_currentElementAttributes.Count > 0) if (_currentElementAttributes.Count > 0)
{ {
foreach (var pair in _currentElementAttributes) foreach (var pair in _currentElementAttributes)
{ {
WriteAttribute(codeWriter, pair.Value.SourceSequence, pair.Key, pair.Value.AttributeValue); WriteAttribute(codeWriter, pair.Key, pair.Value.AttributeValue);
} }
_currentElementAttributes.Clear(); _currentElementAttributes.Clear();
} }
@ -267,7 +262,7 @@ namespace Microsoft.AspNetCore.Blazor.Build.Core.RazorCompilation.Engine
{ {
codeWriter codeWriter
.WriteStartMethodInvocation($"{builderVarName}.{nameof(RenderTreeBuilder.AddAttribute)}") .WriteStartMethodInvocation($"{builderVarName}.{nameof(RenderTreeBuilder.AddAttribute)}")
.Write(token.SourceSequence.ToString()) .Write((_sourceSequence++).ToString())
.WriteParameterSeparator() .WriteParameterSeparator()
.Write(token.AttributeValue.Content) .Write(token.AttributeValue.Content)
.WriteEndMethodInvocation(); .WriteEndMethodInvocation();
@ -330,11 +325,11 @@ namespace Microsoft.AspNetCore.Blazor.Build.Core.RazorCompilation.Engine
} }
} }
private static void WriteAttribute(CodeWriter codeWriter, int sourceSequence, string key, object value) private void WriteAttribute(CodeWriter codeWriter, string key, object value)
{ {
codeWriter codeWriter
.WriteStartMethodInvocation($"{builderVarName}.{nameof(RenderTreeBuilder.AddAttribute)}") .WriteStartMethodInvocation($"{builderVarName}.{nameof(RenderTreeBuilder.AddAttribute)}")
.Write(sourceSequence.ToString()) .Write((_sourceSequence++).ToString())
.WriteParameterSeparator() .WriteParameterSeparator()
.WriteStringLiteral(key) .WriteStringLiteral(key)
.WriteParameterSeparator(); .WriteParameterSeparator();

View File

@ -97,7 +97,7 @@ namespace Microsoft.AspNetCore.Blazor.Build.Test
// Assert // Assert
Assert.Collection(treeBuilder.GetNodes(), Assert.Collection(treeBuilder.GetNodes(),
node => AssertNode.Text(node, "Some plain text")); node => AssertNode.Text(node, "Some plain text", 0));
} }
[Fact] [Fact]
@ -112,11 +112,17 @@ namespace Microsoft.AspNetCore.Blazor.Build.Test
"); ");
// Assert // Assert
var nodes = GetRenderTree(component).Where(NotWhitespace); var nodes = GetRenderTree(component);
Assert.Collection(nodes, Assert.Collection(nodes,
node => AssertNode.Text(node, "Hello"), node => AssertNode.Whitespace(node, 0),
node => AssertNode.Text(node, "123"), node => AssertNode.Text(node, "Hello", 1),
node => AssertNode.Text(node, new object().ToString())); node => AssertNode.Whitespace(node, 2),
node => AssertNode.Whitespace(node, 3), // @((object)null)
node => AssertNode.Whitespace(node, 4),
node => AssertNode.Text(node, "123", 5),
node => AssertNode.Whitespace(node, 6),
node => AssertNode.Text(node, new object().ToString(), 7),
node => AssertNode.Whitespace(node, 8));
} }
[Fact] [Fact]
@ -133,11 +139,14 @@ namespace Microsoft.AspNetCore.Blazor.Build.Test
"); ");
// Assert // Assert
var nodes = GetRenderTree(component).Where(NotWhitespace); var nodes = GetRenderTree(component);
Assert.Collection(nodes, Assert.Collection(nodes,
node => AssertNode.Text(node, "First"), node => AssertNode.Whitespace(node, 0),
node => AssertNode.Text(node, "Second"), node => AssertNode.Text(node, "First", 1),
node => AssertNode.Text(node, "Third")); node => AssertNode.Text(node, "Second", 1),
node => AssertNode.Text(node, "Third", 1),
node => AssertNode.Whitespace(node, 2),
node => AssertNode.Whitespace(node, 3));
} }
[Fact] [Fact]
@ -148,8 +157,8 @@ namespace Microsoft.AspNetCore.Blazor.Build.Test
// Assert // Assert
Assert.Collection(GetRenderTree(component), Assert.Collection(GetRenderTree(component),
node => AssertNode.Element(node, "myelem", 1), node => AssertNode.Element(node, "myelem", 1, 0),
node => AssertNode.Text(node, "Hello")); node => AssertNode.Text(node, "Hello", 1));
} }
[Fact] [Fact]
@ -160,8 +169,8 @@ namespace Microsoft.AspNetCore.Blazor.Build.Test
// Assert // Assert
Assert.Collection(GetRenderTree(component), Assert.Collection(GetRenderTree(component),
node => AssertNode.Text(node, "Some text so elem isn't at position 0 "), node => AssertNode.Text(node, "Some text so elem isn't at position 0 ", 0),
node => AssertNode.Element(node, "myelem", 1)); node => AssertNode.Element(node, "myelem", 1, 1));
} }
[Fact] [Fact]
@ -172,8 +181,8 @@ namespace Microsoft.AspNetCore.Blazor.Build.Test
// Assert // Assert
Assert.Collection(GetRenderTree(component), Assert.Collection(GetRenderTree(component),
node => AssertNode.Text(node, "Some text so elem isn't at position 0 "), node => AssertNode.Text(node, "Some text so elem isn't at position 0 ", 0),
node => AssertNode.Element(node, "img", 1)); node => AssertNode.Element(node, "img", 1, 1));
} }
[Fact] [Fact]
@ -184,9 +193,9 @@ namespace Microsoft.AspNetCore.Blazor.Build.Test
// Assert // Assert
Assert.Collection(GetRenderTree(component), Assert.Collection(GetRenderTree(component),
node => AssertNode.Element(node, "elem", 2), node => AssertNode.Element(node, "elem", 2, 0),
node => AssertNode.Attribute(node, "attrib-one", "Value 1"), node => AssertNode.Attribute(node, "attrib-one", "Value 1", 1),
node => AssertNode.Attribute(node, "a2", "v2")); node => AssertNode.Attribute(node, "a2", "v2", 2));
} }
[Fact] [Fact]
@ -199,8 +208,8 @@ namespace Microsoft.AspNetCore.Blazor.Build.Test
// Assert // Assert
Assert.Collection(GetRenderTree(component), Assert.Collection(GetRenderTree(component),
node => AssertNode.Element(node, "elem", 1), node => AssertNode.Element(node, "elem", 1, 0),
node => AssertNode.Attribute(node, "attr", "My string")); node => AssertNode.Attribute(node, "attr", "My string", 1));
} }
[Fact] [Fact]
@ -213,8 +222,8 @@ namespace Microsoft.AspNetCore.Blazor.Build.Test
// Assert // Assert
Assert.Collection(GetRenderTree(component), Assert.Collection(GetRenderTree(component),
node => AssertNode.Element(node, "elem", 1), node => AssertNode.Element(node, "elem", 1, 0),
node => AssertNode.Attribute(node, "attr", "123")); node => AssertNode.Attribute(node, "attr", "123", 1));
} }
[Fact] [Fact]
@ -227,8 +236,8 @@ namespace Microsoft.AspNetCore.Blazor.Build.Test
// Assert // Assert
Assert.Collection(GetRenderTree(component), Assert.Collection(GetRenderTree(component),
node => AssertNode.Element(node, "elem", 1), node => AssertNode.Element(node, "elem", 1, 0),
node => AssertNode.Attribute(node, "attr", "Hello, WORLD with number 246!")); node => AssertNode.Attribute(node, "attr", "Hello, WORLD with number 246!", 1));
} }
[Fact] [Fact]
@ -249,16 +258,18 @@ namespace Microsoft.AspNetCore.Blazor.Build.Test
// Assert // Assert
Assert.False((bool)handlerWasCalledProperty.GetValue(component)); Assert.False((bool)handlerWasCalledProperty.GetValue(component));
Assert.Collection(GetRenderTree(component).Where(NotWhitespace), Assert.Collection(GetRenderTree(component),
node => AssertNode.Element(node, "elem", 1), node => AssertNode.Element(node, "elem", 1, 0),
node => node =>
{ {
Assert.Equal(RenderTreeNodeType.Attribute, node.NodeType); Assert.Equal(RenderTreeNodeType.Attribute, node.NodeType);
Assert.Equal(1, node.Sequence);
Assert.NotNull(node.AttributeValue); Assert.NotNull(node.AttributeValue);
((UIEventHandler)node.AttributeValue)(null); ((UIEventHandler)node.AttributeValue)(null);
Assert.True((bool)handlerWasCalledProperty.GetValue(component)); Assert.True((bool)handlerWasCalledProperty.GetValue(component));
}); },
node => AssertNode.Whitespace(node, 2));
} }
[Fact] [Fact]
@ -271,19 +282,22 @@ namespace Microsoft.AspNetCore.Blazor.Build.Test
public bool DidInvokeCode { get; set; } = false; public bool DidInvokeCode { get; set; } = false;
}"); }");
var didInvokeCodeProperty = component.GetType().GetProperty("DidInvokeCode"); var didInvokeCodeProperty = component.GetType().GetProperty("DidInvokeCode");
var nodes = GetRenderTree(component);
// Assert // Assert
Assert.False((bool)didInvokeCodeProperty.GetValue(component)); Assert.False((bool)didInvokeCodeProperty.GetValue(component));
Assert.Collection(GetRenderTree(component).Where(NotWhitespace), Assert.Collection(nodes,
node => AssertNode.Element(node, "elem", 1), node => AssertNode.Element(node, "elem", 1, 0),
node => node =>
{ {
Assert.Equal(RenderTreeNodeType.Attribute, node.NodeType); Assert.Equal(RenderTreeNodeType.Attribute, node.NodeType);
Assert.NotNull(node.AttributeValue); Assert.NotNull(node.AttributeValue);
Assert.Equal(1, node.Sequence);
((UIEventHandler)node.AttributeValue)(null); ((UIEventHandler)node.AttributeValue)(null);
Assert.True((bool)didInvokeCodeProperty.GetValue(component)); Assert.True((bool)didInvokeCodeProperty.GetValue(component));
}); },
node => AssertNode.Whitespace(node, 2));
} }
[Fact] [Fact]
@ -293,14 +307,15 @@ namespace Microsoft.AspNetCore.Blazor.Build.Test
var treeBuilder = new RenderTreeBuilder(new TestRenderer()); var treeBuilder = new RenderTreeBuilder(new TestRenderer());
// Arrange/Act // Arrange/Act
var component = CompileToComponent(@" var component = CompileToComponent(
@using System.Collections.Generic @"@using System.Collections.Generic
@(typeof(List<string>).FullName)"); @(typeof(List<string>).FullName)");
component.BuildRenderTree(treeBuilder); component.BuildRenderTree(treeBuilder);
// Assert // Assert
Assert.Collection(treeBuilder.GetNodes().Where(NotWhitespace), Assert.Collection(treeBuilder.GetNodes(),
node => AssertNode.Text(node, typeof(List<string>).FullName)); node => AssertNode.Whitespace(node, 0),
node => AssertNode.Text(node, typeof(List<string>).FullName, 1));
} }
[Fact] [Fact]
@ -320,16 +335,18 @@ namespace Microsoft.AspNetCore.Blazor.Build.Test
// Assert // Assert
Assert.False((bool)didInvokeCodeProperty.GetValue(component)); Assert.False((bool)didInvokeCodeProperty.GetValue(component));
Assert.Collection(GetRenderTree(component).Where(NotWhitespace), Assert.Collection(GetRenderTree(component),
node => AssertNode.Element(node, "elem", 1), node => AssertNode.Element(node, "elem", 1, 0),
node => node =>
{ {
Assert.Equal(RenderTreeNodeType.Attribute, node.NodeType); Assert.Equal(RenderTreeNodeType.Attribute, node.NodeType);
Assert.NotNull(node.AttributeValue); Assert.NotNull(node.AttributeValue);
Assert.Equal(1, node.Sequence);
((UIEventHandler)node.AttributeValue)(null); ((UIEventHandler)node.AttributeValue)(null);
Assert.True((bool)didInvokeCodeProperty.GetValue(component)); Assert.True((bool)didInvokeCodeProperty.GetValue(component));
}); },
node => AssertNode.Whitespace(node, 2));
} }
[Fact] [Fact]
@ -345,13 +362,9 @@ namespace Microsoft.AspNetCore.Blazor.Build.Test
// Assert // Assert
Assert.Collection(treeBuilder.GetNodes(), Assert.Collection(treeBuilder.GetNodes(),
node => AssertNode.Component<TestComponent>(node)); node => AssertNode.Component<TestComponent>(node, 0));
} }
private static bool NotWhitespace(RenderTreeNode node)
=> node.NodeType != RenderTreeNodeType.Text
|| !string.IsNullOrWhiteSpace(node.TextContent);
private static ArrayRange<RenderTreeNode> GetRenderTree(IComponent component) private static ArrayRange<RenderTreeNode> GetRenderTree(IComponent component)
{ {
var treeBuilder = new RenderTreeBuilder(new TestRenderer()); var treeBuilder = new RenderTreeBuilder(new TestRenderer());

View File

@ -1,6 +1,7 @@
// Copyright (c) .NET Foundation. All rights reserved. // Copyright (c) .NET Foundation. All rights reserved.
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information. // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
using System;
using Microsoft.AspNetCore.Blazor.Components; using Microsoft.AspNetCore.Blazor.Components;
using Microsoft.AspNetCore.Blazor.RenderTree; using Microsoft.AspNetCore.Blazor.RenderTree;
using Xunit; using Xunit;
@ -9,42 +10,61 @@ namespace Microsoft.AspNetCore.Blazor.Test.Shared
{ {
internal static class AssertNode internal static class AssertNode
{ {
public static void Text(RenderTreeNode node, string textContent) public static void Sequence(RenderTreeNode node, int? sequence = null)
{
if (sequence.HasValue)
{
Assert.Equal(sequence.Value, node.Sequence);
}
}
public static void Text(RenderTreeNode node, string textContent, int? sequence = null)
{ {
Assert.Equal(RenderTreeNodeType.Text, node.NodeType); Assert.Equal(RenderTreeNodeType.Text, node.NodeType);
Assert.Equal(textContent, node.TextContent); Assert.Equal(textContent, node.TextContent);
Assert.Equal(0, node.ElementDescendantsEndIndex); Assert.Equal(0, node.ElementDescendantsEndIndex);
AssertNode.Sequence(node, sequence);
} }
public static void Element(RenderTreeNode node, string elementName, int descendantsEndIndex) public static void Element(RenderTreeNode node, string elementName, int descendantsEndIndex, int? sequence = null)
{ {
Assert.Equal(RenderTreeNodeType.Element, node.NodeType); Assert.Equal(RenderTreeNodeType.Element, node.NodeType);
Assert.Equal(elementName, node.ElementName); Assert.Equal(elementName, node.ElementName);
Assert.Equal(descendantsEndIndex, node.ElementDescendantsEndIndex); Assert.Equal(descendantsEndIndex, node.ElementDescendantsEndIndex);
AssertNode.Sequence(node, sequence);
} }
public static void Attribute(RenderTreeNode node, string attributeName) public static void Attribute(RenderTreeNode node, string attributeName, int? sequence = null)
{ {
Assert.Equal(RenderTreeNodeType.Attribute, node.NodeType); Assert.Equal(RenderTreeNodeType.Attribute, node.NodeType);
Assert.Equal(attributeName, node.AttributeName); Assert.Equal(attributeName, node.AttributeName);
AssertNode.Sequence(node, sequence);
} }
public static void Attribute(RenderTreeNode node, string attributeName, string attributeValue) public static void Attribute(RenderTreeNode node, string attributeName, string attributeValue, int? sequence = null)
{ {
AssertNode.Attribute(node, attributeName); AssertNode.Attribute(node, attributeName, sequence);
Assert.Equal(attributeValue, node.AttributeValue); Assert.Equal(attributeValue, node.AttributeValue);
} }
public static void Attribute(RenderTreeNode node, string attributeName, UIEventHandler attributeEventHandlerValue) public static void Attribute(RenderTreeNode node, string attributeName, UIEventHandler attributeEventHandlerValue, int? sequence = null)
{ {
AssertNode.Attribute(node, attributeName); AssertNode.Attribute(node, attributeName, sequence);
Assert.Equal(attributeEventHandlerValue, node.AttributeValue); Assert.Equal(attributeEventHandlerValue, node.AttributeValue);
} }
public static void Component<T>(RenderTreeNode node) where T : IComponent public static void Component<T>(RenderTreeNode node, int? sequence = null) where T : IComponent
{ {
Assert.Equal(RenderTreeNodeType.Component, node.NodeType); Assert.Equal(RenderTreeNodeType.Component, node.NodeType);
Assert.Equal(typeof(T), node.ComponentType); Assert.Equal(typeof(T), node.ComponentType);
AssertNode.Sequence(node, sequence);
}
public static void Whitespace(RenderTreeNode node, int? sequence = null)
{
Assert.Equal(RenderTreeNodeType.Text, node.NodeType);
AssertNode.Sequence(node, sequence);
Assert.True(string.IsNullOrWhiteSpace(node.TextContent));
} }
} }
} }