Unfucked.HTTP 0.0.1-beta.24

🧰 Unfucked.HTTP

Fix egregiously missing or broken functionality in HttpClient. Inspired by JAX-RS and Jersey Client.

• Installation
• Configuration
• Usage
• All Unfucked libraries

Installation

dotnet add package Unfucked.HTTP

using Unfucked;
using Unfucked.HTTP;

Configuration

• Drop-in subclasses of HttpClient and HttpMessageHandler, and extension methods

  HttpClient http = new UnfuckedHttpClient(); // set the subclass
  http = new UnfuckedHttpClient(new SocketsHttpHandler(){ AllowAutoRedirect = false }); // custom handlers are wrapped automatically
  

Usage

• Immutable builder pattern for HTTP request URLs, headers, verbs, and response representations that is fluent, composable, and avoids accidentally reusing stale state and sending to corrupted URLs

  JsonNode responseBody = await http.Target("https://httpbin.org")
      .Path("get")
      .Accept(MediaTypeNames.Application.Json)
      .Get<JsonNode>();
  

• Request and response filtering

  PrintRequests filter = new PrintRequests();
  http.Register((ClientRequestFilter) filter);
  http.Register((ClientResponseFilter) filter);
  
  class PrintRequests: ClientRequestFilter, ClientResponseFilter {
      public async ValueTask<HttpRequestMessage> Filter(HttpRequestMessage request, CancellationToken cancellationToken) {
          Console.WriteLine(">> {0} {1}", request.Method, request.RequestUri);
          return request;
      }
  
      public async ValueTask<HttpResponseMessage> Filter(HttpResponseMessage response, CancellationToken cancellationToken) {
          Console.WriteLine("<< {0} {1}", (int) response.StatusCode, response.RequestMessage?.RequestUri);
          return response;
      }
  }
  

• Wire logging (requires .NET ≥ 8 and HTTP 1.1)

  NLog.Logger wireLogger = NLog.LogManager.GetLogger("wire"); // you can plug in any logging implementation, such as NLog or Microsoft.Extensions.Logging
  HttpClient http = new UnfuckedHttpClient();
  http.Register(new WireLoggingFilter(new WireLoggingFilter.Config {
      LogRequestTransmitted = (message, id) => wireLogger.Trace("{0} >> {1}", id, message),
      LogResponseReceived   = (message, id) => wireLogger.Trace("{0} << {1}", id, message),
      IsLogEnabled          = () => wireLogger.IsTraceEnabled
  }));
  

• Type-safe property registration

  // set on shared client or ClientConfig
  http.Property(PropertyKey.JsonSerializerOptions, new JsonSerializerOptions()); 
  
  // set on immutable request target
  WebTarget target = http.Target("https://httpbin.org")
      .Property(PropertyKey.ThrowOnUnsuccessfulStatusCode, false); 
  

• Automatic response deserialization to given types from XML, JSON, and pluggable custom representations

  // automatically mapped from JSON or XML depending on response content type, falling back to content sniffing
  MyClass response = await http.Target(url).Get<MyClass>();
  

• Rich exception class hierarchy

  try {
      string response = await http.Target(url).Get<string>();
  } catch(NotFoundException) {       // 404
  } catch(NotAuthorizedException) {  // 401
  } catch(ServerErrorException) {    // 5xx
  } catch(WebApplicationException) { // any unsuccessful status code
  } catch(ProcessingException) { }   // network or deserialization error, like DNS, connection refused, timeout
  

• Mockable and verifiable in unit or layer tests

All Unfucked libraries

• Unfucked
• Unfucked.Caching
• Unfucked.Compression
• Unfucked.DateTime
• Unfucked.DI
• Unfucked.HTTP
• Unfucked.ICS
• Unfucked.OBS
• Unfucked.PGP
• Unfucked.STUN
• Unfucked.Twitch
• Unfucked.Windows