Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add JsonEncodedText.Value #76545

Merged
merged 2 commits into from
Oct 5, 2022
Merged

Add JsonEncodedText.Value #76545

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
74d98e5
Add Value property to JsonEncodedText
schoder-moreno Oct 3, 2022
98de957
Split test
schoder-moreno Oct 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/libraries/System.Text.Json/ref/System.Text.Json.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,7 @@ public void Reset() { }
private readonly object _dummy;
private readonly int _dummyPrimitive;
public System.ReadOnlySpan<byte> EncodedUtf8Bytes { get { throw null; } }
public string Value { get { throw null; } }
public static System.Text.Json.JsonEncodedText Encode(System.ReadOnlySpan<byte> utf8Value, System.Text.Encodings.Web.JavaScriptEncoder? encoder = null) { throw null; }
public static System.Text.Json.JsonEncodedText Encode(System.ReadOnlySpan<char> value, System.Text.Encodings.Web.JavaScriptEncoder? encoder = null) { throw null; }
public static System.Text.Json.JsonEncodedText Encode(string value, System.Text.Encodings.Web.JavaScriptEncoder? encoder = null) { throw null; }
Expand Down
5 changes: 5 additions & 0 deletions src/libraries/System.Text.Json/src/System/Text/Json/JsonEncodedText.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,11 @@ namespace System.Text.Json
/// </summary>
public ReadOnlySpan<byte> EncodedUtf8Bytes => _utf8Value;

/// <summary>
/// Returns the UTF-16 encoded representation of the pre-encoded JSON text as a <see cref="string"/>.
/// </summary>
public string Value => _value ?? string.Empty;

private JsonEncodedText(byte[] utf8Value)
{
Debug.Assert(utf8Value != null);
Expand Down
91 changes: 77 additions & 14 deletions src/libraries/System.Text.Json/tests/System.Text.Json.Tests/JsonEncodedTextTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ public static void Default()
{
JsonEncodedText text = default;
Assert.True(text.EncodedUtf8Bytes.IsEmpty);
Assert.Equal("", text.Value);

Assert.Equal(0, text.GetHashCode());
Assert.Equal("", text.ToString());
Expand All @@ -42,12 +43,20 @@ public static void Default()

JsonEncodedText textByteEmpty = JsonEncodedText.Encode(Array.Empty<byte>());
Assert.True(textByteEmpty.EncodedUtf8Bytes.IsEmpty);
Assert.Equal("", textByteEmpty.Value);
Assert.Equal("", textByteEmpty.ToString());

Assert.Equal(text.Value, textByteEmpty.Value);
Assert.False(text.Equals(textByteEmpty));

JsonEncodedText textCharEmpty = JsonEncodedText.Encode(Array.Empty<char>());
Assert.True(textCharEmpty.EncodedUtf8Bytes.IsEmpty);
Assert.Equal("", textCharEmpty.Value);
Assert.Equal("", textCharEmpty.ToString());

Assert.Equal(text.Value, textCharEmpty.Value);
Assert.False(text.Equals(textCharEmpty));

Assert.True(textCharEmpty.Equals(textByteEmpty));
Assert.Equal(textByteEmpty.GetHashCode(), textCharEmpty.GetHashCode());
}
Expand All @@ -60,9 +69,9 @@ public static void NullEncoder(string message, string expectedMessage)
JsonEncodedText textSpan = JsonEncodedText.Encode(message.AsSpan(), null);
JsonEncodedText textUtf8Span = JsonEncodedText.Encode(Encoding.UTF8.GetBytes(message), null);

Assert.Equal(expectedMessage, text.ToString());
Assert.Equal(expectedMessage, textSpan.ToString());
Assert.Equal(expectedMessage, textUtf8Span.ToString());
Assert.Equal(expectedMessage, text.Value);
Assert.Equal(expectedMessage, textSpan.Value);
Assert.Equal(expectedMessage, textUtf8Span.Value);

Assert.True(text.Equals(textSpan));
Assert.True(text.Equals(textUtf8Span));
Expand All @@ -80,9 +89,9 @@ public static void CustomEncoder(string message, string expectedMessage)
JsonEncodedText textSpan = JsonEncodedText.Encode(message.AsSpan(), encoder);
JsonEncodedText textUtf8Span = JsonEncodedText.Encode(Encoding.UTF8.GetBytes(message), encoder);

Assert.Equal(expectedMessage, text.ToString());
Assert.Equal(expectedMessage, textSpan.ToString());
Assert.Equal(expectedMessage, textUtf8Span.ToString());
Assert.Equal(expectedMessage, text.Value);
Assert.Equal(expectedMessage, textSpan.Value);
Assert.Equal(expectedMessage, textUtf8Span.Value);

Assert.True(text.Equals(textSpan));
Assert.True(text.Equals(textUtf8Span));
Expand All @@ -99,9 +108,9 @@ public static void CustomEncoderCantOverrideHtml(string message, string expected
JsonEncodedText textSpan = JsonEncodedText.Encode(message.AsSpan(), encoder);
JsonEncodedText textUtf8Span = JsonEncodedText.Encode(Encoding.UTF8.GetBytes(message), encoder);

Assert.Equal(expectedMessage, text.ToString());
Assert.Equal(expectedMessage, textSpan.ToString());
Assert.Equal(expectedMessage, textUtf8Span.ToString());
Assert.Equal(expectedMessage, text.Value);
Assert.Equal(expectedMessage, textSpan.Value);
Assert.Equal(expectedMessage, textUtf8Span.Value);

Assert.True(text.Equals(textSpan));
Assert.True(text.Equals(textUtf8Span));
Expand Down Expand Up @@ -315,6 +324,60 @@ public static void GetUtf8BytesLargeTest(int stringLength)
}
}

[Theory]
[MemberData(nameof(JsonEncodedTextStrings))]
public static void GetValueTest(string message, string expectedMessage)
{
JsonEncodedText text = JsonEncodedText.Encode(message);
JsonEncodedText textSpan = JsonEncodedText.Encode(message.AsSpan());
JsonEncodedText textUtf8Span = JsonEncodedText.Encode(Encoding.UTF8.GetBytes(message));

Assert.Equal(expectedMessage, text.Value);
Assert.Equal(expectedMessage, textSpan.Value);
Assert.Equal(expectedMessage, textUtf8Span.Value);
}

[Theory]
[InlineData(100)]
[InlineData(1_000)]
[InlineData(10_000)]
public static void GetValueLargeTest(int stringLength)
{
var message = new string('a', stringLength);
var expectedMessage = new string('a', stringLength);

JsonEncodedText text = JsonEncodedText.Encode(message);
JsonEncodedText textSpan = JsonEncodedText.Encode(message.AsSpan());
JsonEncodedText textUtf8Span = JsonEncodedText.Encode(Encoding.UTF8.GetBytes(message));

Assert.Equal(expectedMessage, text.Value);
Assert.Equal(expectedMessage, textSpan.Value);
Assert.Equal(expectedMessage, textUtf8Span.Value);
}

[Theory]
[InlineData(100)]
[InlineData(1_000)]
[InlineData(10_000)]
public static void GetValueLargeEscapedTest(int stringLength)
{
var message = new string('>', stringLength);
var builder = new StringBuilder();
for (int i = 0; i < stringLength; i++)
{
eiriktsarpalis marked this conversation as resolved.
Show resolved Hide resolved
builder.Append("\\u003E");
}
string expectedMessage = builder.ToString();

JsonEncodedText text = JsonEncodedText.Encode(message);
JsonEncodedText textSpan = JsonEncodedText.Encode(message.AsSpan());
JsonEncodedText textUtf8Span = JsonEncodedText.Encode(Encoding.UTF8.GetBytes(message));

Assert.Equal(expectedMessage, text.Value);
Assert.Equal(expectedMessage, textSpan.Value);
Assert.Equal(expectedMessage, textUtf8Span.Value);
}

[Fact]
public static void InvalidUTF16()
{
Expand All @@ -338,7 +401,7 @@ public static void InvalidUTF16()
public static void ReplacementCharacterUTF8(byte[] dataUtf8, string expected)
{
JsonEncodedText text = JsonEncodedText.Encode(dataUtf8);
Assert.Equal(expected, text.ToString());
Assert.Equal(expected, text.Value);
}

[Fact]
Expand Down Expand Up @@ -464,16 +527,16 @@ public static void CustomEncoderClass()
JsonEncodedText text;

text = JsonEncodedText.Encode(message);
Assert.Equal(expected, text.ToString());
Assert.Equal(expected, text.Value);

text = JsonEncodedText.Encode(message, null);
Assert.Equal(expected, text.ToString());
Assert.Equal(expected, text.Value);

text = JsonEncodedText.Encode(message, JavaScriptEncoder.Default);
Assert.Equal(expected, text.ToString());
Assert.Equal(expected, text.Value);

text = JsonEncodedText.Encode(message, new CustomEncoderAllowingPlusSign());
Assert.Equal("a+", text.ToString());
Assert.Equal("a+", text.Value);
}
}
}