WinHttpHandler HTTP/2 trailing headers

[JamesNK]

WinHTTP has added support for HTTP/2 trailing headers in modern versions of Windows.

WinHttpHandler should set trailers into the HttpResponseMessage.TrailingHeaders collection in .NET Core 3+.

An idea that the gRPC team is thinking about is using WinHttpHandler to support Grpc.Net.Client on .NET Framework. For that to work the trailing headers would need to be available in .NET Framework, which doesn't have the HttpResponseMessage.TrailingHeaders API.

A possible solution that doesn't involve adding new API to .NET Framework could be to set the trailing headers collection as a value in HttpRequestMessage.Properties using a known key, e.g. __Http2ResponseTrailingHeaders.

Tagging subscribers to this area: @dotnet/ncl
See info in area-owners.md if you want to be subscribed.

Details

Issue Details

Description:	WinHTTP has added support for HTTP/2 trailing headers in modern versions of Windows. WinHttpHandler should set trailers into the HttpResponseMessage.TrailingHeaders collection in .NET Core 3+. An idea I'm thinking about with gRPC support on .NET Framework is using WinHttpHandler for HTTP/2. For that to work the trailing headers would need to be available in .NET Framework, which doesn't have the HttpResponseMessage.TrailingHeaders API. A possible solution that doesn't involve adding new API to .NET Framework could be to set the trailing headers collection as a value in HttpRequestMessage.Properties using a known key, e.g. __Http2TrailingHeaders.
Author:	JamesNK
Assignees:	-
Labels:	area-System.Net.Http
Milestone:	-

[JamesNK]

Example of what hacking in trailing headers could look like:

        public static HttpResponseHeaders GetTrailingHeaders(this HttpResponseMessage responseMessage)
        {
#if !NET472
            return responseMessage.TrailingHeaders;
#else
            if (!responseMessage.RequestMessage.Properties.TryGetValue("__Http2ResponseTrailingHeaders", out var headers))
            {
                throw new InvalidOperationException();
            }
            return (HttpResponseHeaders)headers;
#endif
        }

[karelz]

Triage: Making it compatible with .NET Core 3.0+ makes sense.
If it is worth exposing on .NET Framework is subject to discussion (which we will have tomorrow) and should be split off into separate issue.

[antonfirsov]

Following up on #46602 (comment) I also think that we should continue API discussions here, under the issue, before going further with implementation details.

At the moment I'm a bit pessimistic, since I don't see a good way to expose this without going against established BCL practices. A list of challanges I see:

• HttpRequestMessage.Properties is obsolete since .NET 5. Although there is no obsoletion warning when building against .NET Framework, exposing a new feature trough this bag doesn't look good
• There aren't many precedents for exchanging information with the help of arbitrary property-bag keys. The only thing I was able to find is [browser][wasm] Configuring request options in Browser WebAssembly #39182 / Configuring request options in Browser WebAssembly #34168
• In general, extensibility is not a strong point of HttpRequestMessage, especially when targeting multiple frameworks
• API (header container) differs depending on the target, behaviors differs depending on the OS

The best thing I can think of to overcome these challanges is to introduce an extension method within the WinHttpHandler lib, so we can at least hide some of this mess:

[Edit] Changed the proposal so the method throws WinHttpException instead of returning false.

public static class WinHttpExtensions
{
    // Returns a header collection if WINHTTP_QUERY_FLAG_TRAILERS is supported, throws WinHttpException otherwise.
    // Hides the access of the property bag as an implementation detail.
    // We may decide to also set HttpResponseMessage.TrailingHeaders for consistency, but the recommended way to access them is to use the extension method.
    [SupportedOSPlatform("windows10.0.BUILD")]
    public static HttpResponseHeaders GetWinHttpTrailingHeaders(this HttpResponseMessage responseMessage);
}