perf: improve allocations in OwinEnvironment

[DeagleGross]

OwinEnvironment allocates a Dictionary<string, FeatureMap> with at least 23 entries of string and FeatureMap objects per request.

In most cases, Owin abstraction is used only to get the data in the specific format (i.e. access the HTTP method via OwinConstants.RequestMethod key), but not to remove \ add entries or rebuild the whole FeatureMap dictionary.

Therefore I am introducing the OwinEntries class (not visible to users), which allocates the static readonly entries dictionary (similar to what existed before) and uses that for the key-value access (so a single allocation per app lifetime against the per-request allocation). However, OwinEnvironment has a rich API to modify the dictionary (i.e. remove entries or clear them completely). Therefore I am doing the following to fully support existing API and dont introduce breaking changes:

1. for API OwinEnvironment.FeatureMaps returning IDictionary<string, FeatureMap> there is no way to securely determine if the dictionary instance will be changed, and because of that we can't avoid performing the deep-copy of static _entries (same perf loss as existed). Next interaction with OwinEnvironment will be using _contextEntries (request-lifetime) instead of static _entries.
2. for API OwinEnvironment.Remove(string key) I am using a separate HashSet<string> _deletedKeys to keep track of deleted entries per request lifetime. Even if all original entries are deleted, this is still a more lightweight flow than existed before
3. for API OwinEnvironment.Clear() I am falling back to _contextEntries usage (request-lifetime)

Note: there are some FeatureMap objects, which are dependent on the HttpContext passed into OwinEnvironment, so I keep them separately in a dedicated Dictionary<string, FeatureMap>. It's contains a single entry so far.

I have added the microbenchmark (see PR), with a code that performs multiple requests using the default HttpContext, and used the new OwinEnvironment implementation against the old one:

    [Benchmark]
    public async Task ProcessMultipleRequests()
    {
        foreach (var i in Enumerable.Range(0, 10000))
        {
            await _requestDelegate(_httpContext);
        }
    }

Benchmark results:

Method	Mean	Error	StdDev	Gen 0	Gen 1	Gen 2	Allocated
OwinRequest_NoOperation (old)	27.46 ms	0.508 ms	0.821 ms	2750.0000	62.5000	-	133 MB
OwinRequest_AccessPorts (old)	29.45 ms	0.577 ms	0.931 ms	2750.0000	62.5000	-	133 MB
OwinRequest_AccessHeaders (old)	28.52 ms	0.565 ms	1.344 ms	2781.2500	93.7500	-	133 MB
OwinRequest_NoOperation (fix)	6.162 ms	0.1208 ms	0.1984 ms	234.3750	-	-	12 MB
OwinRequest_AccessPorts (fix)	6.388 ms	0.1219 ms	0.1304 ms	234.3750	-	-	12 MB
OwinRequest_AccessHeaders (fix)	6.478 ms	0.0921 ms	0.0817 ms	250.0000	-	-	12 MB

(thanks to @deanward81 for the idea)

Closes #58916

[DeagleGross]

TODO:

• include DictionaryStringValuesWrapper and DictionaryStringArrayWrapper enumerator improvements
• improve allocations for port string conversion

[mgravell]

concept looks solid, nice; added some thoughts

[danmoseley]

could you please resolve conflict @DeagleGross

[danmoseley]

can this not share as public struct Enumerator : IEnumerator<KeyValuePair<string, T>>, IEnumerator with the one above? ConvertingEnumerator or something

[DeagleGross]

renamed to ConvertingEnumerator. I dont think I can make a generic impl for inner enumerator of DictionaryStringArrayWrapper and DictionaryStringValuesWrapper. That was your idea, right?

[danmoseley]

You'd have to pass in a Convert delegate to reuse the same one. Maybe not worth the bother.

[Copilot]

Copilot reviewed 5 out of 12 changed files in this pull request and generated 2 comments.

Files not reviewed (7)

• AspNetCore.sln: Language not supported
• src/Http/HttpAbstractions.slnf: Language not supported
• src/Http/Owin/benchmarks/Microsoft.AspNetCore.Owin.Microbenchmarks/Microsoft.AspNetCore.Owin.Microbenchmarks.csproj: Language not supported
• src/Http/samples/MinimalSampleOwin/MinimalSampleOwin.csproj: Language not supported
• src/Http/samples/MinimalSampleOwin/Properties/launchSettings.json: Language not supported
• src/Http/Owin/src/DictionaryStringValuesWrapper.cs: Evaluated as low risk
• src/Http/Owin/src/DictionaryStringArrayWrapper.cs: Evaluated as low risk

[Copilot]

The method does not correctly handle the case where _contextEntries is not initialized and _deletedKeys contains the key. Add a check for _deletedKeys before returning false when _contextEntries is not initialized.

[Copilot]

The method does not correctly handle the case where _contextEntries is not initialized and _deletedKeys contains the key. Add a check for _deletedKeys before returning false when _contextEntries is not initialized.

[DeagleGross]

/azp run

[azure-pipelines]

Azure Pipelines will not run the associated pipelines, because the pull request was updated after the run command was issued. Review the pull request again and issue a new run command.