10216327022

Committed 02 Aug 2024 01:20PM UTC coverage: 58.758% (-0.2%) from 58.917%

Build # 10216327022

Build Type

push

github

Committed by

pwelter34

Commit Message

Update QueryStringEncoder.cs

Run Details

379 of 753 branches covered (50.33%)

Branch coverage included in aggregate %.

4 of 4 new or added lines in 1 file covered. (100.0%)

3 existing lines in 1 file now uncovered.

1097 of 1759 relevant lines covered (62.36%)

22.28 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

78.15

/src/MediatR.CommandQuery/Services/QueryStringEncoder.cs

using System.Buffers;
using System.IO.Compression;
using System.Text.Json;

namespace MediatR.CommandQuery.Services;

public static class QueryStringEncoder
{
    public static string? Encode<T>(T value, JsonSerializerOptions? jsonSerializerOptions = null)
    {
        if (value is null)
            return null;

        jsonSerializerOptions ??= new JsonSerializerOptions(JsonSerializerDefaults.Web);

        using var outputStream = new MemoryStream();
        using var compressionStream = new GZipStream(outputStream, CompressionMode.Compress);
        using var jsonWriter = new Utf8JsonWriter(compressionStream);

        JsonSerializer.Serialize(jsonWriter, value);

        var jsonBytes = outputStream.ToArray();

        return Base64UrlEncode(jsonBytes);
    }

    public static T? Decode<T>(string? encodedQueryString, JsonSerializerOptions? jsonSerializerOptions = null)
    {
        if (string.IsNullOrWhiteSpace(encodedQueryString))
            return default;

        var jsonBytes = Base64UrlDecode(encodedQueryString);

        jsonSerializerOptions ??= new JsonSerializerOptions(JsonSerializerDefaults.Web);

        using var inputStream = new MemoryStream(jsonBytes);
        using var compressionStream = new GZipStream(inputStream, CompressionMode.Decompress);

        return JsonSerializer.Deserialize<T>(compressionStream, jsonSerializerOptions);
    }


    public static string Base64UrlEncode(ReadOnlySpan<byte> input)
    {
        const int StackAllocThreshold = 128;

        if (input.IsEmpty)
            return string.Empty;

        int bufferSize = GetArraySizeRequiredToEncode(input.Length);

        char[]? bufferToReturnToPool = null;

        Span<char> buffer = bufferSize <= StackAllocThreshold
            ? stackalloc char[StackAllocThreshold]
            : bufferToReturnToPool = ArrayPool<char>.Shared.Rent(bufferSize);

        var numBase64Chars = Base64UrlEncode(input, buffer);
        var base64Url = new string(buffer.Slice(0, numBase64Chars));

        if (bufferToReturnToPool != null)
            ArrayPool<char>.Shared.Return(bufferToReturnToPool);

        return base64Url;
    }

    public static byte[] Base64UrlDecode(string input)
    {
        if (input is null)
            throw new ArgumentNullException(nameof(input));

        var count = input.Length;
        if (count == 0)
            return [];

        var offset = 0;
        var buffer = new char[GetArraySizeRequiredToDecode(count)];
        var bufferOffset = 0;

        var paddingCharsToAdd = GetNumBase64PaddingCharsToAddForDecode(count);
        var arraySizeRequired = checked(count + paddingCharsToAdd);

        // Copy input into buffer, fixing up '-' -> '+' and '_' -> '/'.
        var i = bufferOffset;
        for (var j = offset; i - bufferOffset < count; i++, j++)
        {
            var ch = input[j];
            if (ch == '-')
                buffer[i] = '+';
            else if (ch == '_')
                buffer[i] = '/';
            else
                buffer[i] = ch;
        }

        // Add the padding characters back.
        for (; paddingCharsToAdd > 0; i++, paddingCharsToAdd--)
            buffer[i] = '=';

        return Convert.FromBase64CharArray(buffer, bufferOffset, arraySizeRequired);
    }


    private static int Base64UrlEncode(ReadOnlySpan<byte> input, Span<char> output)
    {
        if (input.IsEmpty)
            return 0;

        Convert.TryToBase64Chars(input, output, out int charsWritten);

        // Fix up '+' -> '-' and '/' -> '_'. Drop padding characters.
        for (var i = 0; i < charsWritten; i++)
        {
            var ch = output[i];
            if (ch == '+')
                output[i] = '-';
            else if (ch == '/')
                output[i] = '_';
            else if (ch == '=')
                return i; // We've reached a padding character; truncate the remainder.
        }

        return charsWritten;
    }

    private static int GetArraySizeRequiredToEncode(int count)
    {
        var numWholeOrPartialInputBlocks = checked(count + 2) / 3;
        return checked(numWholeOrPartialInputBlocks * 4);
    }


    private static int GetArraySizeRequiredToDecode(int count)
    {
        if (count == 0)
            return 0;

        var numPaddingCharsToAdd = GetNumBase64PaddingCharsToAddForDecode(count);

        return checked(count + numPaddingCharsToAdd);
    }

    private static int GetNumBase64PaddingCharsToAddForDecode(int inputLength)
    {
        return (inputLength % 4) switch
        {
            0 => 0,
            2 => 2,
            3 => 1,
            _ => throw new FormatException($"Malformed input: {inputLength} is an invalid input length."),
        };
    }
}

1	using System.Buffers;
2	using System.IO.Compression;
3	using System.Text.Json;
4
5	namespace MediatR.CommandQuery.Services;
6
7	public static class QueryStringEncoder
8	{
9	public static string? Encode<T>(T value, JsonSerializerOptions? jsonSerializerOptions = null)
10	{
11	if (value is null)	3!
12	return null;	×
13
14	jsonSerializerOptions ??= new JsonSerializerOptions(JsonSerializerDefaults.Web);	3✔
15
16	using var outputStream = new MemoryStream();	3✔
17	using var compressionStream = new GZipStream(outputStream, CompressionMode.Compress);	3✔
18	using var jsonWriter = new Utf8JsonWriter(compressionStream);	3✔
19
20	JsonSerializer.Serialize(jsonWriter, value);	3✔
21
22	var jsonBytes = outputStream.ToArray();	3✔
23
24	return Base64UrlEncode(jsonBytes);	3✔
25	}	3✔
26
27	public static T? Decode<T>(string? encodedQueryString, JsonSerializerOptions? jsonSerializerOptions = null)
28	{
29	if (string.IsNullOrWhiteSpace(encodedQueryString))	3!
30	return default;	×
31
32	var jsonBytes = Base64UrlDecode(encodedQueryString);	3✔
33
34	jsonSerializerOptions ??= new JsonSerializerOptions(JsonSerializerDefaults.Web);	3✔
35
36	using var inputStream = new MemoryStream(jsonBytes);	3✔
37	using var compressionStream = new GZipStream(inputStream, CompressionMode.Decompress);	3✔
38
39	return JsonSerializer.Deserialize<T>(compressionStream, jsonSerializerOptions);	3✔
40	}	3✔
41
42
43	public static string Base64UrlEncode(ReadOnlySpan<byte> input)
44	{
45	const int StackAllocThreshold = 128;
46
47	if (input.IsEmpty)	3!
48	return string.Empty;	×
49
50	int bufferSize = GetArraySizeRequiredToEncode(input.Length);	3✔
51
52	char[]? bufferToReturnToPool = null;	3✔
53
54	Span<char> buffer = bufferSize <= StackAllocThreshold	3!
55	? stackalloc char[StackAllocThreshold]	3✔
56	: bufferToReturnToPool = ArrayPool<char>.Shared.Rent(bufferSize);	3✔
57
58	var numBase64Chars = Base64UrlEncode(input, buffer);	3✔
59	var base64Url = new string(buffer.Slice(0, numBase64Chars));	3✔
60
61	if (bufferToReturnToPool != null)	3✔
62	ArrayPool<char>.Shared.Return(bufferToReturnToPool);	3✔
63
64	return base64Url;	3✔
65	}
66
67	public static byte[] Base64UrlDecode(string input)
68	{
69	if (input is null)	3!
70	throw new ArgumentNullException(nameof(input));	×
71
72	var count = input.Length;	3✔
73	if (count == 0)	3!
74	return [];	×
75
76	var offset = 0;	3✔
77	var buffer = new char[GetArraySizeRequiredToDecode(count)];	3✔
78	var bufferOffset = 0;	3✔
79
80	var paddingCharsToAdd = GetNumBase64PaddingCharsToAddForDecode(count);	3✔
81	var arraySizeRequired = checked(count + paddingCharsToAdd);	3✔
82
83	// Copy input into buffer, fixing up '-' -> '+' and '_' -> '/'.
84	var i = bufferOffset;	3✔
85	for (var j = offset; i - bufferOffset < count; i++, j++)	1,374✔
86	{
87	var ch = input[j];	456✔
88	if (ch == '-')	456✔
89	buffer[i] = '+';	6✔
90	else if (ch == '_')	450✔
91	buffer[i] = '/';	15✔
92	else
93	buffer[i] = ch;	435✔
94	}
95
96	// Add the padding characters back.
97	for (; paddingCharsToAdd > 0; i++, paddingCharsToAdd--)	3!
UNCOV 98	buffer[i] = '=';	×
99
100	return Convert.FromBase64CharArray(buffer, bufferOffset, arraySizeRequired);	3✔
101	}
102
103
104	private static int Base64UrlEncode(ReadOnlySpan<byte> input, Span<char> output)
105	{
106	if (input.IsEmpty)	3!
107	return 0;	×
108
109	Convert.TryToBase64Chars(input, output, out int charsWritten);	3✔
110
111	// Fix up '+' -> '-' and '/' -> '_'. Drop padding characters.
112	for (var i = 0; i < charsWritten; i++)	918✔
113	{
114	var ch = output[i];	456✔
115	if (ch == '+')	456✔
116	output[i] = '-';	6✔
117	else if (ch == '/')	450✔
118	output[i] = '_';	15✔
119	else if (ch == '=')	435!
UNCOV 120	return i; // We've reached a padding character; truncate the remainder.	×
121	}
122
123	return charsWritten;	3✔
124	}
125
126	private static int GetArraySizeRequiredToEncode(int count)
127	{
128	var numWholeOrPartialInputBlocks = checked(count + 2) / 3;	3✔
129	return checked(numWholeOrPartialInputBlocks * 4);	3✔
130	}
131
132
133	private static int GetArraySizeRequiredToDecode(int count)
134	{
135	if (count == 0)	3!
136	return 0;	×
137
138	var numPaddingCharsToAdd = GetNumBase64PaddingCharsToAddForDecode(count);	3✔
139
140	return checked(count + numPaddingCharsToAdd);	3✔
141	}
142
143	private static int GetNumBase64PaddingCharsToAddForDecode(int inputLength)
144	{
145	return (inputLength % 4) switch	6!
146	{	6✔
147	0 => 0,	6✔
148	2 => 2,	×
UNCOV 149	3 => 1,	×
150	_ => throw new FormatException($"Malformed input: {inputLength} is an invalid input length."),	×
151	};	6✔
152	}
153	}

loresoft / MediatR.CommandQuery / 10216327022

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous