Code(Cross-cutting concerns): Integrate Serilog into the project

src/Server/StellarChat.Server.Api/Program.cs

@@ -1,4 +1,5 @@
 using StellarChat.Shared.Infrastructure.Exceptions;
+using StellarChat.Shared.Infrastructure.Contexts;
 
 var builder = WebApplication.CreateBuilder(args);
 
@@ -7,6 +8,7 @@
 builder.Services.AddEndpointsApiExplorer();
 builder.Services.AddSwaggerGen();
 builder.Services.AddErrorHandling();
+builder.Services.AddContext();
 
 var app = builder.Build();
 
@@ -19,6 +21,7 @@
 
 app.UseHttpsRedirection();
 app.UseErrorHandling();
+app.UseContext();
 
 var summaries = new[]
 {

src/Server/StellarChat.Server.Api/appsettings.json

@@ -1,9 +1,49 @@
 {
-  "Logging": {
-    "LogLevel": {
-      "Default": "Information",
-      "Microsoft.AspNetCore": "Warning"
-    }
+  "app": {
+    "name": "Chat Stellar API",
+    "version": "0.0.1"
   },
-  "AllowedHosts": "*"
+  "AllowedHosts": "*",
+  "serilog": {
+    "level": "information",
+    "overrides": {
+      "Microsoft.AspNetCore": "Warning",
+      "Microsoft.EntityFrameworkCore.Database.Command": "Warning",
+      "Microsoft.EntityFrameworkCore.Infrastructure": "Warning"
+    },
+    "excludePaths": [
+      "/",
+      "/metrics",
+      "/ping"
+    ],
+    "excludeProperties": [
+      "api_key",
+      "access_key",
+      "apiKey",
+      "apiSecret",
+      "clientId",
+      "clientSecret",
+      "connectionString",
+      "password",
+      "email",
+      "login",
+      "secret",
+      "token",
+      "organizationId"
+    ],
+    "console": {
+      "enabled": true
+    },
+    "file": {
+      "enabled": false,
+      "path": "logs/logs.txt",
+      "interval": "day"
+    },
+    "seq": {
+      "enabled": true,
+      "url": "http://localhost:5341",
+      "apiKey": "secret"
+    },
+    "tags": {}
+  }
 }

src/Shared/StellarChat.Shared.Abstractions/Contexts/IContext.cs

@@ -0,0 +1,11 @@
+namespace StellarChat.Shared.Abstractions.Contexts;
+
+public interface IContext
+{
+    Guid RequestId { get; }
+    Guid CorrelationId { get; }
+    string TraceId { get; }
+    string IpAddress { get; }
+    string UserAgent { get; }
+    IIdentityContext Identity { get; }
+}

src/Shared/StellarChat.Shared.Abstractions/Contexts/IIdentityContext.cs

@@ -0,0 +1,9 @@
+namespace StellarChat.Shared.Abstractions.Contexts;
+
+public interface IIdentityContext
+{
+    bool IsAuthenticated { get; }
+    public Guid Id { get; }
+    string Role { get; }
+    Dictionary<string, IEnumerable<string>> Claims { get; }
+}

src/Shared/StellarChat.Shared.Abstractions/StellarChat.Shared.Abstractions.csproj

@@ -6,8 +6,8 @@
     <Nullable>enable</Nullable>
   </PropertyGroup>
 
-    <ItemGroup>
-	    <FrameworkReference Include="Microsoft.AspNetCore.App" />
-    </ItemGroup>
+  <ItemGroup>
+    <FrameworkReference Include="Microsoft.AspNetCore.App" />
+  </ItemGroup>
 
 </Project>

src/Shared/StellarChat.Shared.Infrastructure/AppOptions.cs

@@ -0,0 +1,8 @@
+namespace StellarChat.Shared.Infrastructure;
+
+internal class AppOptions
+{
+    public string Name { get; set; } = string.Empty;
+    public string Instance { get; set; } = string.Empty;
+    public string Version { get; set; } = string.Empty;
+}

src/Shared/StellarChat.Shared.Infrastructure/Contexts/Context.cs

@@ -0,0 +1,36 @@
+using Microsoft.AspNetCore.Http;
+using StellarChat.Shared.Abstractions.Contexts;
+
+namespace StellarChat.Shared.Infrastructure.Contexts;
+
+public class Context : IContext
+{
+    public Guid RequestId { get; } = Guid.NewGuid();
+    public Guid CorrelationId { get; }
+    public string TraceId { get; }
+    public string IpAddress { get; }
+    public string UserAgent { get; }
+    public IIdentityContext Identity { get; }
+
+    public Context() : this(Guid.NewGuid(), $"{Guid.NewGuid():N}", null)
+    {
+    }
+
+    public Context(HttpContext context) : this(context.TryGetCorrelationId(), context.TraceIdentifier,
+        new IdentityContext(context.User), context.GetUserIpAddress(),
+        context.Request.Headers["user-agent"])
+    {
+    }
+
+    public Context(Guid? correlationId, string traceId, IIdentityContext identity = null, string ipAddress = null,
+        string userAgent = null)
+    {
+        CorrelationId = correlationId ?? Guid.NewGuid();
+        TraceId = traceId;
+        Identity = identity ?? IdentityContext.Empty;
+        IpAddress = ipAddress;
+        UserAgent = userAgent;
+    }
+
+    public static IContext Empty => new Context();
+}

src/Shared/StellarChat.Shared.Infrastructure/Contexts/ContextAccessor.cs

@@ -0,0 +1,31 @@
+using StellarChat.Shared.Abstractions.Contexts;
+
+namespace StellarChat.Shared.Infrastructure.Contexts;
+
+public sealed class ContextAccessor
+{
+    private static readonly AsyncLocal<ContextHolder> Holder = new();
+
+    public IContext Context
+    {
+        get => Holder.Value?.Context;
+        set
+        {
+            var holder = Holder.Value;
+            if (holder != null)
+            {
+                holder.Context = null;
+            }
+
+            if (value != null)
+            {
+                Holder.Value = new ContextHolder { Context = value };
+            }
+        }
+    }
+
+    private class ContextHolder
+    {
+        public IContext Context;
+    }
+}

src/Shared/StellarChat.Shared.Infrastructure/Contexts/Extensions.cs

@@ -0,0 +1,27 @@
+using Microsoft.AspNetCore.Builder;
+using Microsoft.Extensions.DependencyInjection;
+
+namespace StellarChat.Shared.Infrastructure.Contexts;
+
+public static class Extensions
+{
+    public static IServiceCollection AddContext(this IServiceCollection services)
+    {
+        services.AddSingleton<ContextAccessor>();
+        services.AddTransient(sp => sp.GetRequiredService<ContextAccessor>().Context);
+
+        return services;
+    }
+
+    public static IApplicationBuilder UseContext(this IApplicationBuilder app)
+    {
+        app.Use((ctx, next) =>
+        {
+            ctx.RequestServices.GetRequiredService<ContextAccessor>().Context = new Context(ctx);
+
+            return next();
+        });
+
+        return app;
+    }
+}

src/Shared/StellarChat.Shared.Infrastructure/Contexts/IdentityContext.cs

@@ -0,0 +1,43 @@
+using StellarChat.Shared.Abstractions.Contexts;
+using System.Security.Claims;
+
+namespace StellarChat.Shared.Infrastructure.Contexts;
+
+public class IdentityContext : IIdentityContext
+{
+    public bool IsAuthenticated { get; }
+    public Guid Id { get; }
+    public string? Role { get; }
+    public Dictionary<string, IEnumerable<string>>? Claims { get; }
+
+    private IdentityContext() { }
+
+    public IdentityContext(Guid? id)
+    {
+        Id = id ?? Guid.Empty;
+        IsAuthenticated = id.HasValue;
+        Role = null;
+        Claims = null;
+    }
+
+    public IdentityContext(ClaimsPrincipal? principal)
+    {
+        if (principal?.Identity is null || string.IsNullOrWhiteSpace(principal.Identity?.Name))
+        {
+            IsAuthenticated = false;
+            Id = Guid.Empty;
+            Role = null;
+            Claims = null;
+            return;
+        }
+
+        IsAuthenticated = principal.Identity.IsAuthenticated;
+        Id = IsAuthenticated ? Guid.Parse(principal.Identity.Name) : Guid.Empty;
+        Role = principal.Claims.SingleOrDefault(x => x.Type == ClaimTypes.Role)?.Value;
+        Claims = principal.Claims.GroupBy(x => x.Type)
+            .ToDictionary(x => x.Key, x => x.Select(c => c.Value.ToString()));
+    }
+
+    public static IIdentityContext Empty => new IdentityContext();
+}
+

src/Shared/StellarChat.Shared.Infrastructure/Extensions.cs

@@ -1,11 +1,63 @@
-using System.Text.RegularExpressions;
+using Microsoft.AspNetCore.Builder;
+using Microsoft.AspNetCore.Http;
+using Microsoft.Extensions.Configuration;
+using System.Text.RegularExpressions;
 
 namespace StellarChat.Shared.Infrastructure;
 
 public static class Extensions
 {
+    private const string CorrelationIdKey = "correlation-id";
+
     public static string ToSnakeCase(this string input)
         => Regex.Replace(
             Regex.Replace(
                 Regex.Replace(input, @"([\p{Lu}]+)([\p{Lu}][\p{Ll}])", "$1_$2"), @"([\p{Ll}\d])([\p{Lu}])", "$1_$2"), @"[-\s]", "_").ToLower();
+
+    public static bool IsEmpty(this string value) 
+        => string.IsNullOrWhiteSpace(value);
+
+    public static bool IsNotEmpty(this string value)
+        => !value.IsEmpty();
+
+    public static IApplicationBuilder UseCorrelationId(this IApplicationBuilder app)
+    => app.Use((ctx, next) =>
+    {
+        ctx.Items.Add(CorrelationIdKey, Guid.NewGuid());
+        return next();
+    });
+
+    public static T BindOptions<T>(this IConfiguration configuration, string sectionName) where T : new()
+        => BindOptions<T>(configuration.GetSection(sectionName));
+
+    public static T BindOptions<T>(this IConfigurationSection section) where T : new()
+    {
+        var options = new T();
+        section.Bind(options);
+        return options;
+    }
+
+    public static Guid? TryGetCorrelationId(this HttpContext context)
+        => context.Items.TryGetValue(CorrelationIdKey, out var id) ? (Guid?)id : null;
+
+    public static string GetUserIpAddress(this HttpContext context)
+    {
+        if (context is null)
+        {
+            return string.Empty;
+        }
+
+        var ipAddress = context.Connection.RemoteIpAddress?.ToString();
+        if (context.Request.Headers.TryGetValue("x-forwarded-for", out var forwardedFor))
+        {
+            var ipAddresses = forwardedFor.ToString().Split(",", StringSplitOptions.RemoveEmptyEntries);
+
+            if (ipAddresses.Any())
+            {
+                ipAddress = ipAddresses[0];
+            }
+        }
+
+        return ipAddress ?? string.Empty;
+    }
 }