Optimize HttpUtility.JavaScriptStringEncode by using SearchValues #102917

TrayanZapryanov · 2024-05-31T11:40:56Z

Optimize HttpUtility.JavaScriptStringEncode by using SearchValues for invalid JavaScript characters.

Benchmark

[MemoryDiagnoser]
public class HttpUtilityBenchmarks
{
	[Params(true, false)]
	public bool AddQuotes { get; set; }

	[Benchmark(Baseline = true)]
	public string JavaScriptStringEncode_NoEscape() => HttpUtility.JavaScriptStringEncode("No escaping needed.", AddQuotes);

	[Benchmark]
	public string JavaScriptStringEncode_NoEscape_PR() => MyHttpUtility.JavaScriptStringEncode("No escaping needed.", AddQuotes);

	[Benchmark]
	public string JavaScriptStringEncode_Escape() => HttpUtility.JavaScriptStringEncode("The \t and \n will need to be escaped.", AddQuotes);

	[Benchmark]
	public string JavaScriptStringEncode_Escape_PR() => MyHttpUtility.JavaScriptStringEncode("The \t and \n will need to be escaped.", AddQuotes);
}

Results:

Method	AddQuotes	Mean	Error	StdDev	Ratio	RatioSD	Gen0	Allocated	Alloc Ratio
JavaScriptStringEncode_NoEscape	False	27.485 ns	0.2172 ns	0.2032 ns	1.00	0.00	-	-	NA
JavaScriptStringEncode_NoEscape_PR	False	2.558 ns	0.0873 ns	0.0857 ns	0.09	0.00	-	-	NA
JavaScriptStringEncode_Escape	False	75.264 ns	0.7011 ns	0.5854 ns	2.74	0.02	0.0315	264 B	NA
JavaScriptStringEncode_Escape_PR	False	36.093 ns	0.5054 ns	0.3945 ns	1.31	0.02	0.0315	264 B	NA

JavaScriptStringEncode_NoEscape	True	35.001 ns	0.4262 ns	0.3778 ns	1.00	0.00	0.0076	64 B	1.00
JavaScriptStringEncode_NoEscape_PR	True	8.809 ns	0.2115 ns	0.3100 ns	0.26	0.01	0.0076	64 B	1.00
JavaScriptStringEncode_Escape	True	86.737 ns	1.7250 ns	1.6136 ns	2.48	0.04	0.0440	368 B	5.75
JavaScriptStringEncode_Escape_PR	True	37.486 ns	0.7770 ns	1.4971 ns	1.10	0.03	0.0315	264 B	4.12

TrayanZapryanov · 2024-05-31T12:18:24Z

@EgorBot -arm64 -amd

using System.Web;
using BenchmarkDotNet.Attributes;
using BenchmarkDotNet.Running;

BenchmarkRunner.Run<HttpUtilityBenchmarks>(args: args);

public class HttpUtilityBenchmarks
{
    [Benchmark(Baseline = true)]
    public string JavaScriptStringEncode() => 
        HttpUtility.JavaScriptStringEncode("No escaping needed.");

    [Benchmark]
    public string JavaScriptStringEncode_Encode() => 
        HttpUtility.JavaScriptStringEncode("The \t and \n will need to be escaped.");
}

EgorBo · 2024-05-31T12:24:11Z

@TrayanZapryanov please avoid using -arm64 if PR is not arch specific 🙂 I host this bot on my personal subscription

src/libraries/System.Web.HttpUtility/src/System/Web/Util/HttpEncoder.cs

MihaZupan · 2024-05-31T18:13:02Z

I see we had similar ideas @gfoidl :)

TrayanZapryanov · 2024-05-31T18:59:07Z

@gfoidl, @MihaZupan thanks for good ideas.
I've applied all of them and here are results

Method	AddQuotes	Mean	Error	StdDev	Ratio	RatioSD	Gen0	Allocated	Alloc Ratio
JavaScriptStringEncode_NoEscape	False	24.483 ns	0.4342 ns	0.3625 ns	1.00	0.00	-	-	NA
JavaScriptStringEncode_NoEscape_PR	False	4.922 ns	0.0432 ns	0.0383 ns	0.20	0.00	-	-	NA
JavaScriptStringEncode_Escape	False	78.210 ns	1.2223 ns	0.9543 ns	3.20	0.07	0.0315	264 B	NA
JavaScriptStringEncode_Escape_PR	False	42.045 ns	0.5002 ns	0.4679 ns	1.72	0.03	0.0124	104 B	NA

JavaScriptStringEncode_NoEscape	True	36.507 ns	0.3863 ns	0.3614 ns	1.00	0.00	0.0076	64 B	1.00
JavaScriptStringEncode_NoEscape_PR	True	16.740 ns	0.2302 ns	0.1922 ns	0.46	0.01	0.0076	64 B	1.00
JavaScriptStringEncode_Escape	True	86.635 ns	1.6189 ns	1.3518 ns	2.37	0.04	0.0440	368 B	5.75
JavaScriptStringEncode_Escape_PR	True	43.646 ns	0.8023 ns	0.7504 ns	1.20	0.03	0.0124	104 B	1.62

Allocations are much better, although there is a small regression(most probably due to ValueStringBuilder). In General PR gives good perf wins even now.

MihaZupan · 2024-05-31T19:27:13Z

although there is a small regression(most probably due to ValueStringBuilder)

Do you see it go away if you move the fallback (everything after return addDoubleQuotes ? $"\"{value}\"" : value;) to a separate helper (to move the stackalloc out of the fast path)?

E.g. string EncodeCore(ReadOnlySpan<char> value, int i)

src/libraries/System.Web.HttpUtility/src/System/Web/Util/HttpEncoder.cs

TrayanZapryanov · 2024-06-03T08:04:23Z

@MihaZupan requested changes are applied.
I've measured your suggestion for removing if(string.IsnullorEmpty(XXX)) and looks like without this check results are slightly worst. Here are results:
Without check for null(like in the PR code at the moment):

Method	AddQuotes	Mean	Error	StdDev	Median	Ratio	RatioSD	Gen0	Allocated	Alloc Ratio
JavaScriptStringEncode_NoEscape	False	23.716 ns	0.1315 ns	0.1098 ns	23.710 ns	1.00	0.00	-	-	NA
JavaScriptStringEncode_NoEscape_PR	False	3.035 ns	0.0135 ns	0.0120 ns	3.033 ns	0.13	0.00	-	-	NA
JavaScriptStringEncode_Escape	False	85.928 ns	1.8087 ns	5.3047 ns	84.196 ns	3.79	0.21	0.0315	264 B	NA
JavaScriptStringEncode_Escape_PR	False	46.633 ns	0.7838 ns	0.7331 ns	46.815 ns	1.97	0.03	0.0124	104 B	NA

JavaScriptStringEncode_NoEscape	True	37.540 ns	0.6752 ns	0.5639 ns	37.431 ns	1.00	0.00	0.0076	64 B	1.00
JavaScriptStringEncode_NoEscape_PR	True	15.981 ns	0.3474 ns	0.4000 ns	15.940 ns	0.42	0.01	0.0076	64 B	1.00
JavaScriptStringEncode_Escape	True	92.901 ns	1.8431 ns	5.2286 ns	91.220 ns	2.54	0.13	0.0440	368 B	5.75
JavaScriptStringEncode_Escape_PR	True	46.662 ns	0.9257 ns	0.8659 ns	46.474 ns	1.24	0.03	0.0124	104 B	1.62

string.IsNullOrEmpty:

Method	AddQuotes	Mean	Error	StdDev	Median	Ratio	RatioSD	Gen0	Allocated	Alloc Ratio
JavaScriptStringEncode_NoEscape	False	26.880 ns	0.3227 ns	0.2695 ns	26.949 ns	1.00	0.00	-	-	NA
JavaScriptStringEncode_NoEscape_PR	False	2.495 ns	0.0395 ns	0.0370 ns	2.501 ns	0.09	0.00	-	-	NA
JavaScriptStringEncode_Escape	False	81.711 ns	1.1379 ns	0.9502 ns	81.718 ns	3.04	0.06	0.0315	264 B	NA
JavaScriptStringEncode_Escape_PR	False	47.066 ns	0.6737 ns	0.5972 ns	46.978 ns	1.75	0.02	0.0124	104 B	NA

JavaScriptStringEncode_NoEscape	True	37.651 ns	0.7910 ns	0.7399 ns	37.339 ns	1.00	0.00	0.0076	64 B	1.00
JavaScriptStringEncode_NoEscape_PR	True	10.082 ns	0.3532 ns	1.0304 ns	9.684 ns	0.30	0.03	0.0076	64 B	1.00
JavaScriptStringEncode_Escape	True	90.945 ns	1.7183 ns	3.9480 ns	90.059 ns	2.49	0.13	0.0440	368 B	5.75
JavaScriptStringEncode_Escape_PR	True	46.321 ns	0.9600 ns	2.6441 ns	46.369 ns	1.19	0.06	0.0124	104 B	1.62

I don't think this is so performance critical code, so both ways shows performance increase and it is up to you to decide which one do you prefer.

MihaZupan

Thanks.

Looks like this one hit a merge conflict after #102805

src/libraries/System.Web.HttpUtility/src/System/Web/Util/HttpEncoder.cs

… invalid JavaScript characters.

ghost added the area-System.Net label May 31, 2024

dotnet-policy-service bot added the community-contribution Indicates that the PR has been added by a community member label May 31, 2024

This was referenced May 31, 2024

tracing/eventpipe/providervalidation/providervalidation/providervalidation.cmd test failure #101759

Closed

Crash in Microsoft.Extensions.Logging.Generators.Roslyn4.0.Tests.WorkItemExecution #90019

Open

gfoidl reviewed May 31, 2024

View reviewed changes

MihaZupan reviewed May 31, 2024

View reviewed changes

MihaZupan added this to the 9.0.0 milestone May 31, 2024

MihaZupan reviewed May 31, 2024

View reviewed changes

src/libraries/System.Web.HttpUtility/src/System/Web/Util/HttpEncoder.cs Outdated Show resolved Hide resolved

MihaZupan approved these changes Jun 3, 2024

View reviewed changes

src/libraries/System.Web.HttpUtility/src/System/Web/Util/HttpEncoder.cs Outdated Show resolved Hide resolved

Trayan-Zapryanov added 5 commits June 4, 2024 14:44

Optimize HttpUtility.JavaScriptStringEncode by using SearchValues for…

1d51ecb

… invalid JavaScript characters.

remove duplicated test

9fba64e

more suggestions

eed1378

EncodeCore and AppendSpanFormattable

583bab4

Remove check for null

5d498a4

TrayanZapryanov force-pushed the optimize_HttpUtility_JavaScriptStringEncode branch from 9ae9832 to 5d498a4 Compare June 4, 2024 11:49

Use StackallocThreshold const

76e7e44

MihaZupan merged commit ddd19a7 into dotnet:main Jun 6, 2024

TrayanZapryanov deleted the optimize_HttpUtility_JavaScriptStringEncode branch June 6, 2024 15:37

MihaZupan mentioned this pull request Jun 7, 2024

Reduce allocation in HttpUtility.UrlPathEncode. #102909

Merged

github-actions bot locked and limited conversation to collaborators Jul 7, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Optimize HttpUtility.JavaScriptStringEncode by using SearchValues #102917

Optimize HttpUtility.JavaScriptStringEncode by using SearchValues #102917

Uh oh!

TrayanZapryanov commented May 31, 2024

Uh oh!

TrayanZapryanov commented May 31, 2024

Uh oh!

EgorBo commented May 31, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MihaZupan commented May 31, 2024

Uh oh!

TrayanZapryanov commented May 31, 2024

Uh oh!

MihaZupan commented May 31, 2024 •

edited

Loading

Uh oh!

Uh oh!

TrayanZapryanov commented Jun 3, 2024

Uh oh!

MihaZupan left a comment

Uh oh!

Uh oh!

Uh oh!

Optimize HttpUtility.JavaScriptStringEncode by using SearchValues #102917

Optimize HttpUtility.JavaScriptStringEncode by using SearchValues #102917

Uh oh!

Conversation

TrayanZapryanov commented May 31, 2024

Uh oh!

TrayanZapryanov commented May 31, 2024

Uh oh!

EgorBo commented May 31, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MihaZupan commented May 31, 2024

Uh oh!

TrayanZapryanov commented May 31, 2024

Uh oh!

MihaZupan commented May 31, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

TrayanZapryanov commented Jun 3, 2024

Uh oh!

MihaZupan left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

MihaZupan commented May 31, 2024 •

edited

Loading