add aspnet common stuff

Author: hhvrc

Common.AspNet/Common.AspNet.csproj

@@ -0,0 +1,9 @@
+<Project Sdk="Microsoft.NET.Sdk.Web">
+  <PropertyGroup>
+    <OutputType>Library</OutputType>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\Common\Common.csproj" />
+  </ItemGroup>
+</Project>

Common.AspNet/Errors/ExceptionError.cs

@@ -0,0 +1,8 @@
+using OpenShock.Common.Problems;
+
+namespace OpenShock.Common.Errors;
+
+public static class ExceptionError
+{
+    public static ExceptionProblem Exception => new ExceptionProblem();
+}

Common.AspNet/ExceptionHandling/OpenShockExceptionHandler.cs

@@ -0,0 +1,63 @@
+using System.Net;
+using System.Text.Json;
+using Microsoft.AspNetCore.Diagnostics;
+using Microsoft.AspNetCore.Http;
+using Microsoft.Extensions.Hosting;
+using Microsoft.Extensions.Logging;
+using OpenShock.Common.Errors;
+
+namespace OpenShock.Common.ExceptionHandling;
+
+public sealed class OpenShockExceptionHandler : IExceptionHandler
+{
+    private readonly IHostEnvironment _env;
+    private readonly ILogger _logger;
+    private readonly JsonSerializerOptions _jsonSerializerOptions;
+
+    public OpenShockExceptionHandler(IHostEnvironment env, ILoggerFactory loggerFactory, JsonSerializerOptions jsonSerializerOptions)
+    {
+        _env = env;
+        _logger = loggerFactory.CreateLogger("RequestInfo");
+        _jsonSerializerOptions = jsonSerializerOptions;
+    }
+
+    public async ValueTask<bool> TryHandleAsync(HttpContext context, Exception exception, CancellationToken cancellationToken)
+    {
+        context.Response.StatusCode = (int)HttpStatusCode.InternalServerError;
+        _logger.LogError(exception, "Unhandled exception for {Method} {Path}", context.Request.Method, context.Request.Path);
+
+        if (_env.IsDevelopment())
+        {
+            await PrintRequestInfo(context);
+        }
+
+        await ExceptionError.Exception.WriteAsJsonAsync(context, _jsonSerializerOptions, cancellationToken);
+        return context.Response.HasStarted;
+    }
+
+    private async Task PrintRequestInfo(HttpContext context)
+    {
+        // Rewind our body reader, so we can read it again.
+        context.Request.Body.Seek(0, SeekOrigin.Begin);
+        // Used to read from the body stream.
+        using var stream = new StreamReader(context.Request.Body);
+
+        // Create Dictionaries to be logging in our RequestInfo object for both Header values and Query parameters.
+        var headers = context.Request.Headers.ToDictionary(x => x.Key, x => x.Value.ToString());
+        var queryParams = context.Request.Query.ToDictionary(x => x.Key, x => x.Value.ToString());
+
+        // Create our RequestInfo object.
+        var requestInfo = new RequestInfo
+        {
+            Body = await stream.ReadToEndAsync(),
+            Headers = headers,
+            TraceId = context.TraceIdentifier,
+            Method = context.Request.Method,
+            Path = context.Request.Path.Value,
+            Query = queryParams
+        };
+
+        // Finally log this object on Information level.
+        _logger.LogInformation("{@RequestInfo}", requestInfo);
+    }
+}

Common.AspNet/OpenShockControllerBase.cs

@@ -0,0 +1,10 @@
+using Microsoft.AspNetCore.Mvc;
+using OpenShock.Common.Problems;
+
+namespace OpenShock.Common;
+
+public class OpenShockControllerBase : ControllerBase
+{
+    [NonAction]
+    public ObjectResult Problem(OpenShockProblem problem) => problem.ToObjectResult(HttpContext);
+}

Common.AspNet/Problems/ExceptionProblem.cs

@@ -0,0 +1,11 @@
+using System.Net;
+
+namespace OpenShock.Common.Problems;
+
+public sealed class ExceptionProblem : OpenShockProblem
+{
+    public ExceptionProblem() : base("Exception", "An unknown exception occurred", HttpStatusCode.InternalServerError,
+        "An unknown error occurred. Please try again later. If the issue persists reach out to support.")
+    {
+    }
+}

Common.AspNet/Problems/OpenShockProblem.cs

@@ -0,0 +1,52 @@
+using System.Net;
+using System.Net.Mime;
+using System.Text.Json;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Mvc;
+
+namespace OpenShock.Common.Problems;
+
+/// <summary>
+/// Represents a problem
+/// </summary>
+public class OpenShockProblem : ProblemDetails
+{
+    public OpenShockProblem(string type, string title, HttpStatusCode status = HttpStatusCode.BadRequest,
+        string? detail = null) : this(type, title, (int)status, detail)
+    {
+    }
+
+    private OpenShockProblem(string type, string title, int status = 400, string? detail = null)
+    {
+        Type = type;
+        Title = title;
+        Detail = detail;
+        Status = status;
+    }
+
+    [Obsolete("This is the exact same as title or detail if present, refer to using title in the future")]
+    public string Message => Detail ?? Title!;
+
+    [Obsolete("This is the exact same as requestId, refer to using requestId in the future")]
+    public string? TraceId => RequestId;
+
+    public string? RequestId { get; set; }
+
+    public ObjectResult ToObjectResult(HttpContext context)
+    {
+        RequestId = context.TraceIdentifier;
+
+        return new ObjectResult(this)
+        {
+            StatusCode = Status
+        };
+    }
+
+    public Task WriteAsJsonAsync(HttpContext context, JsonSerializerOptions jsonSerializerOptions, CancellationToken cancellationToken)
+    {
+        context.Response.StatusCode = Status ?? StatusCodes.Status400BadRequest;
+        RequestId = context.TraceIdentifier;
+
+        return context.Response.WriteAsJsonAsync(this, jsonSerializerOptions, MediaTypeNames.Application.ProblemJson, cancellationToken);
+    }
+}

Common.slnx

@@ -1,5 +1,6 @@
 <Solution>
   <Project Path="Common\Common.csproj" Type="Classic C#" />
+  <Project Path="Common.AspNet\Common.AspNet.csproj" Type="Classic C#" />
   <Project Path="Common.Tests\Common.Tests.csproj" Type="Classic C#" />
   <Project Path="DynamicLinq\DynamicLinq.csproj" Type="Classic C#" />
   <Project Path="DynamicLinq.Tests\DynamicLinq.Tests.csproj" Type="Classic C#" />

Common/ExceptionHandling/RequestInfo.cs

@@ -0,0 +1,12 @@
+// ReSharper disable UnusedAutoPropertyAccessor.Global
+namespace OpenShock.Common.ExceptionHandling;
+
+public sealed class RequestInfo
+{
+    public required string? Path { get; set; }
+    public required IDictionary<string, string> Query { get; set; }
+    public required string Body { get; set; }
+    public required string Method { get; set; }
+    public required string TraceId { get; set; }
+    public required IDictionary<string, string> Headers { get; set; }
+}