-
Notifications
You must be signed in to change notification settings - Fork 5.1k
Add write-raw APIs to Utf8JsonWriter #54254
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.
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
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
2b9a5ec
Add write-raw APIs to Utf8JsonWriter
layomia 3ac5592
Address review feedback
layomia e47ee37
Address review feedback
layomia eea5f1b
Address review feedback
layomia e158057
Make long-running tests outerloop
layomia 86584f0
Fix call to core logic
layomia File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
201 changes: 201 additions & 0 deletions
201
src/libraries/System.Text.Json/src/System/Text/Json/Writer/Utf8JsonWriter.WriteValues.Raw.cs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,201 @@ | ||
// Licensed to the .NET Foundation under one or more agreements. | ||
// The .NET Foundation licenses this file to you under the MIT license. | ||
|
||
using System.Buffers; | ||
using System.Diagnostics; | ||
|
||
namespace System.Text.Json | ||
{ | ||
public sealed partial class Utf8JsonWriter | ||
{ | ||
/// <summary> | ||
/// Writes the input as JSON content. It is expected that the input content is a single complete JSON value. | ||
/// </summary> | ||
/// <param name="json">The raw JSON content to write.</param> | ||
/// <param name="skipInputValidation">Whether to validate if the input is an RFC 8259-compliant JSON payload.</param> | ||
/// <exception cref="ArgumentNullException">Thrown if <paramref name="json"/> is <see langword="null"/>.</exception> | ||
/// <exception cref="ArgumentException">Thrown if the length of the input is zero or greater than 715,827,882 (<see cref="int.MaxValue"/> / 3).</exception> | ||
/// <exception cref="JsonException"> | ||
/// Thrown if <paramref name="skipInputValidation"/> is <see langword="false"/>, and the input | ||
/// is not a valid, complete, single JSON value according to the JSON RFC (https://tools.ietf.org/html/rfc8259) | ||
/// or the input JSON exceeds a recursive depth of 64. | ||
/// </exception> | ||
/// <remarks> | ||
/// When writing untrused JSON values, do not set <paramref name="skipInputValidation"/> to <see langword="true"/> as this can result in invalid JSON | ||
/// being written, and/or the overall payload being written to the writer instance being invalid. | ||
/// | ||
/// When using this method, the input content will be written to the writer destination as-is, unless validation fails (when it is enabled). | ||
/// | ||
/// The <see cref="JsonWriterOptions.SkipValidation"/> value for the writer instance is honored when using this method. | ||
/// | ||
/// The <see cref="JsonWriterOptions.Indented"/> and <see cref="JsonWriterOptions.Encoder"/> values for the writer instance are not applied when using this method. | ||
/// </remarks> | ||
public void WriteRawValue(string json, bool skipInputValidation = false) | ||
{ | ||
if (!_options.SkipValidation) | ||
{ | ||
ValidateWritingValue(); | ||
} | ||
|
||
if (json == null) | ||
layomia marked this conversation as resolved.
Show resolved
Hide resolved
|
||
{ | ||
throw new ArgumentNullException(nameof(json)); | ||
} | ||
|
||
TranscodeAndWriteRawValue(json.AsSpan(), skipInputValidation); | ||
} | ||
|
||
/// <summary> | ||
/// Writes the input as JSON content. It is expected that the input content is a single complete JSON value. | ||
/// </summary> | ||
/// <param name="json">The raw JSON content to write.</param> | ||
/// <param name="skipInputValidation">Whether to validate if the input is an RFC 8259-compliant JSON payload.</param> | ||
/// <exception cref="ArgumentException">Thrown if the length of the input is zero or greater than 715,827,882 (<see cref="int.MaxValue"/> / 3).</exception> | ||
/// <exception cref="JsonException"> | ||
/// Thrown if <paramref name="skipInputValidation"/> is <see langword="false"/>, and the input | ||
/// is not a valid, complete, single JSON value according to the JSON RFC (https://tools.ietf.org/html/rfc8259) | ||
/// or the input JSON exceeds a recursive depth of 64. | ||
/// </exception> | ||
/// <remarks> | ||
/// When writing untrused JSON values, do not set <paramref name="skipInputValidation"/> to <see langword="true"/> as this can result in invalid JSON | ||
/// being written, and/or the overall payload being written to the writer instance being invalid. | ||
/// | ||
/// When using this method, the input content will be written to the writer destination as-is, unless validation fails (when it is enabled). | ||
/// | ||
/// The <see cref="JsonWriterOptions.SkipValidation"/> value for the writer instance is honored when using this method. | ||
/// | ||
/// The <see cref="JsonWriterOptions.Indented"/> and <see cref="JsonWriterOptions.Encoder"/> values for the writer instance are not applied when using this method. | ||
/// </remarks> | ||
public void WriteRawValue(ReadOnlySpan<char> json, bool skipInputValidation = false) | ||
layomia marked this conversation as resolved.
Show resolved
Hide resolved
|
||
{ | ||
if (!_options.SkipValidation) | ||
{ | ||
ValidateWritingValue(); | ||
} | ||
|
||
TranscodeAndWriteRawValue(json, skipInputValidation); | ||
} | ||
|
||
/// <summary> | ||
/// Writes the input as JSON content. It is expected that the input content is a single complete JSON value. | ||
/// </summary> | ||
/// <param name="utf8Json">The raw JSON content to write.</param> | ||
/// <param name="skipInputValidation">Whether to validate if the input is an RFC 8259-compliant JSON payload.</param> | ||
/// <exception cref="ArgumentException">Thrown if the length of the input is zero or equal to <see cref="int.MaxValue"/>.</exception> | ||
/// <exception cref="JsonException"> | ||
/// Thrown if <paramref name="skipInputValidation"/> is <see langword="false"/>, and the input | ||
/// is not a valid, complete, single JSON value according to the JSON RFC (https://tools.ietf.org/html/rfc8259) | ||
/// or the input JSON exceeds a recursive depth of 64. | ||
/// </exception> | ||
/// <remarks> | ||
/// When writing untrused JSON values, do not set <paramref name="skipInputValidation"/> to <see langword="true"/> as this can result in invalid JSON | ||
/// being written, and/or the overall payload being written to the writer instance being invalid. | ||
/// | ||
/// When using this method, the input content will be written to the writer destination as-is, unless validation fails (when it is enabled). | ||
/// | ||
/// The <see cref="JsonWriterOptions.SkipValidation"/> value for the writer instance is honored when using this method. | ||
/// | ||
/// The <see cref="JsonWriterOptions.Indented"/> and <see cref="JsonWriterOptions.Encoder"/> values for the writer instance are not applied when using this method. | ||
/// </remarks> | ||
public void WriteRawValue(ReadOnlySpan<byte> utf8Json, bool skipInputValidation = false) | ||
{ | ||
if (!_options.SkipValidation) | ||
{ | ||
ValidateWritingValue(); | ||
} | ||
|
||
if (utf8Json.Length == int.MaxValue) | ||
{ | ||
ThrowHelper.ThrowArgumentException_ValueTooLarge(int.MaxValue); | ||
} | ||
|
||
WriteRawValueCore(utf8Json, skipInputValidation); | ||
} | ||
|
||
private void TranscodeAndWriteRawValue(ReadOnlySpan<char> json, bool skipInputValidation) | ||
{ | ||
if (json.Length > JsonConstants.MaxUtf16RawValueLength) | ||
{ | ||
ThrowHelper.ThrowArgumentException_ValueTooLarge(json.Length); | ||
} | ||
|
||
byte[]? tempArray = null; | ||
|
||
// For performance, avoid obtaining actual byte count unless memory usage is higher than the threshold. | ||
Span<byte> utf8Json = json.Length <= (JsonConstants.ArrayPoolMaxSizeBeforeUsingNormalAlloc / JsonConstants.MaxExpansionFactorWhileTranscoding) ? | ||
// Use a pooled alloc. | ||
tempArray = ArrayPool<byte>.Shared.Rent(json.Length * JsonConstants.MaxExpansionFactorWhileTranscoding) : | ||
// Use a normal alloc since the pool would create a normal alloc anyway based on the threshold (per current implementation) | ||
// and by using a normal alloc we can avoid the Clear(). | ||
new byte[JsonReaderHelper.GetUtf8ByteCount(json)]; | ||
|
||
try | ||
{ | ||
int actualByteCount = JsonReaderHelper.GetUtf8FromText(json, utf8Json); | ||
utf8Json = utf8Json.Slice(0, actualByteCount); | ||
WriteRawValueCore(utf8Json, skipInputValidation); | ||
} | ||
finally | ||
{ | ||
if (tempArray != null) | ||
{ | ||
utf8Json.Clear(); | ||
ArrayPool<byte>.Shared.Return(tempArray); | ||
} | ||
} | ||
} | ||
|
||
private void WriteRawValueCore(ReadOnlySpan<byte> utf8Json, bool skipInputValidation) | ||
{ | ||
int len = utf8Json.Length; | ||
|
||
if (len == 0) | ||
{ | ||
ThrowHelper.ThrowArgumentException(SR.ExpectedJsonTokens); | ||
} | ||
|
||
// In the UTF-16-based entry point methods above, we validate that the payload length <= int.MaxValue /3. | ||
// The result of this division will be rounded down, so even if every input character needs to be transcoded | ||
// (with expansion factor of 3), the resulting payload would be less than int.MaxValue, | ||
// as (int.MaxValue/3) * 3 is less than int.MaxValue. | ||
Debug.Assert(len < int.MaxValue); | ||
|
||
if (skipInputValidation) | ||
{ | ||
// Treat all unvalidated raw JSON value writes as string. If the payload is valid, this approach does | ||
// not affect structural validation since a string token is equivalent to a complete object, array, | ||
// or other complete JSON tokens when considering structural validation on subsequent writer calls. | ||
// If the payload is not valid, then we make no guarantees about the structural validation of the final payload. | ||
_tokenType = JsonTokenType.String; | ||
} | ||
else | ||
{ | ||
// Utilize reader validation. | ||
Utf8JsonReader reader = new(utf8Json); | ||
while (reader.Read()); | ||
_tokenType = reader.TokenType; | ||
} | ||
|
||
// TODO (https://github.com/dotnet/runtime/issues/29293): | ||
// investigate writing this in chunks, rather than requesting one potentially long, contiguous buffer. | ||
int maxRequired = len + 1; // Optionally, 1 list separator. We've guarded against integer overflow earlier in the call stack. | ||
|
||
if (_memory.Length - BytesPending < maxRequired) | ||
layomia marked this conversation as resolved.
Show resolved
Hide resolved
|
||
{ | ||
Grow(maxRequired); | ||
} | ||
|
||
Span<byte> output = _memory.Span; | ||
|
||
if (_currentDepth < 0) | ||
{ | ||
output[BytesPending++] = JsonConstants.ListSeparator; | ||
} | ||
|
||
utf8Json.CopyTo(output.Slice(BytesPending)); | ||
BytesPending += len; | ||
|
||
layomia marked this conversation as resolved.
Show resolved
Hide resolved
|
||
SetFlagToAddListSeparatorBeforeNextItem(); | ||
} | ||
} | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.