Merge pull request #2

mt89vein · web-flow · commit 15a3225c3d79 · 2025-04-02T23:20:52.000+05:00
Allow to filter additional data from domain exception that will be added to ProblemDetails
diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json
@@ -0,0 +1,13 @@
+{
+  "version": 1,
+  "isRoot": true,
+  "tools": {
+    "husky": {
+      "version": "0.7.2",
+      "commands": [
+        "husky"
+      ],
+      "rollForward": false
+    }
+  }
+}
diff --git a/.gitignore b/.gitignore
@@ -330,3 +330,5 @@ ASALocalRun/
 #Ocelot.json
 ocelot.json
 data/
+
+!.husky/csx/
diff --git a/.husky/commit-msg b/.husky/commit-msg
@@ -0,0 +1,8 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+dotnet husky run -v --group "commit-msg" --args "$1"
+
+echo
+echo Great work! 🥂
+echo
diff --git a/.husky/csx/commit-lint.csx b/.husky/csx/commit-lint.csx
@@ -0,0 +1,82 @@
+/// <summary>
+/// Commit linter
+/// https://www.conventionalcommits.org/en/v1.0.0/
+/// https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#type
+/// </summary>
+
+#r "System.dll"
+#r "System.Linq.dll"
+
+using System;
+using System.Linq;
+using System.Text.RegularExpressions;
+
+private static var tasksPrefixes = new [] { "SSTV" };
+
+private static var allowedCommitTypes = new []
+{
+    "feat",
+    "bug",
+    "ci",
+    "wip",
+    "fix",
+    "perf",
+    "refactor",
+    "docs",
+    "build",
+    "chore",
+    "revert",
+    "style",
+    "test"
+};
+
+private var pattern = $@"^(?=.{{1,90}}$)(?:{string.Join("|", allowedCommitTypes)})(?:\((?<scope>.+)\)|)(|!)(?::)\s.{{4,}}(?<![\.\s])$";
+
+private var msg = File.ReadAllLines(Args[0])[0];
+
+private var match = Regex.Match(msg, pattern);
+
+if (!match.Success)
+{
+   return Fail(msg);
+}
+
+private var scope = match.Groups["scope"]?.Value;
+
+if (string.IsNullOrWhiteSpace(scope))
+{
+    return 0;
+}
+
+private var isTaskScope = tasksPrefixes.Any(tp => scope?.StartsWith($"{tp}-") == true);
+
+if (isTaskScope)
+{
+   return 0;
+}
+
+return Fail(msg);
+
+private static int Fail(string msg)
+{
+    Console.ForegroundColor = ConsoleColor.Red;
+    Console.WriteLine("Invalid commit message: {0}", msg);
+    Console.ResetColor();
+    Console.Write($"commit type must be one of [{string.Join(", ", allowedCommitTypes)}]");
+
+    if (tasksPrefixes.Length > 0)
+    {
+        Console.WriteLine($" or [{string.Join("|", tasksPrefixes.Select(tp => tp + "-XXX"))}] ");
+        Console.WriteLine($"e.g: '{allowedCommitTypes[0]}({tasksPrefixes[0]}-1234): subject' or '{allowedCommitTypes[0]}: subject'");
+    }
+    else
+    {
+        Console.WriteLine();
+        Console.WriteLine($"e.g: '{allowedCommitTypes[0]}: subject'");
+    }
+
+    Console.ForegroundColor = ConsoleColor.Gray;
+    Console.WriteLine("more info: https://www.conventionalcommits.org/en/v1.0.0/");
+
+    return 1;
+}
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+dotnet husky run -v --group "pre-commit"
diff --git a/.husky/pre-push b/.husky/pre-push
@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+dotnet husky run -v --group "pre-push"
diff --git a/.husky/task-runner.json b/.husky/task-runner.json
@@ -0,0 +1,32 @@
+{
+  "$schema": "https://alirezanet.github.io/Husky.Net/schema.json",
+   "tasks": [
+      {
+         "name": "commit-message-linter",
+         "group": "commit-msg",
+         "command": "dotnet",
+         "args": ["husky", "exec", ".husky/csx/commit-lint.csx", "--args", "${args}"]
+      },
+      {
+         "name": "dotnet-format",
+         "group": "commit-msg",
+         "command": "dotnet",
+         "output": "verbose",
+         "args": ["format", "-v", "normal", "--include", "${staged}"]
+      },
+      {
+         "name": "dotnet-build",
+         "group": "pre-push",
+         "command": "dotnet",
+         "args": ["build", "--no-restore"],
+         "include": ["**/*.cs"]
+      },
+      {
+         "name": "dotnet-test",
+         "group": "pre-push",
+         "command": "dotnet",
+         "args": ["test", "--no-restore", "--no-build", "--filter", "\"TestCategory=UnitTests\""],
+         "include": ["**/*.cs"]
+      }
+   ]
+}
diff --git a/Sstv.DomainExceptions.Extensions.ProblemDetails/CHANGELOG.md b/Sstv.DomainExceptions.Extensions.ProblemDetails/CHANGELOG.md
@@ -14,11 +14,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## [3.1.0] - 2025-03-06
+## [3.1.0] - 2025-04-02
 
 ### Added
 
 - Added Microsoft.CodeAnalysis.PublicApiAnalyzers to control shipped API
+- Allow to filter additional data from domain exception that will be added to ProblemDetails. Specify DomainExceptionSettings.AdditionalDataResponseIncludingFilter.
+
+### Fixed
+- DetailedMessage from DomainException not passed to ProblemDetails response
 
 
 ## [3.0.0] - 2024-12-05
diff --git a/Sstv.DomainExceptions.Extensions.ProblemDetails/ErrorCodeProblemDetails.cs b/Sstv.DomainExceptions.Extensions.ProblemDetails/ErrorCodeProblemDetails.cs
@@ -1,4 +1,4 @@
-﻿using System.Collections;
+using System.Collections;
 using System.Text.Json.Serialization;
 
 namespace Sstv.DomainExceptions.Extensions.ProblemDetails;
@@ -38,6 +38,8 @@ public ErrorCodeProblemDetails(DomainException domainException)
     {
         ArgumentNullException.ThrowIfNull(domainException);
 
+        Detail = domainException.DetailedMessage;
+
         foreach (DictionaryEntry e in domainException.Data)
         {
             var stringKey = e.Key as string ?? e.Key.ToString();
@@ -46,7 +48,13 @@ public ErrorCodeProblemDetails(DomainException domainException)
             {
                 stringKey = System.Text.Json.JsonNamingPolicy.CamelCase.ConvertName(stringKey);
 
-                Extensions.TryAdd(stringKey, e.Value);
+                var filter = DomainExceptionSettings.Instance.AdditionalDataResponseIncludingFilter;
+                var add = filter is null || filter.Invoke(new AdditionalDataPropertyFilterArgs(domainException, stringKey, e.Value));
+
+                if (add)
+                {
+                    Extensions.TryAdd(stringKey, e.Value);
+                }
             }
         }
     }
diff --git a/Sstv.DomainExceptions.Extensions.ProblemDetails/README.md b/Sstv.DomainExceptions.Extensions.ProblemDetails/README.md
@@ -12,19 +12,19 @@ This library brings to Sstv.DomainExceptions additional capabilities to create r
 You can install using Nuget Package Manager:
 
 ```bash
-Install-Package Sstv.DomainExceptions.Extensions.ProblemDetails -Version 3.0.0
+Install-Package Sstv.DomainExceptions.Extensions.ProblemDetails -Version 3.1.0
 ```
 
 via the .NET CLI:
 
 ```bash
-dotnet add package Sstv.DomainExceptions.Extensions.ProblemDetails --version 3.0.0
+dotnet add package Sstv.DomainExceptions.Extensions.ProblemDetails --version 3.1.0
 ```
 
 or you can add package reference manually:
 
 ```xml
-<PackageReference Include="Sstv.DomainExceptions.Extensions.ProblemDetails" Version="3.0.0" />
+<PackageReference Include="Sstv.DomainExceptions.Extensions.ProblemDetails" Version="3.1.0" />
 ```
 
 ## How to use?
@@ -65,6 +65,8 @@ services.AddProblemDetails(x =>
 })
 ```
 
+Please, look at [here](./../Sstv.Host/ServiceCollectionExtensions.cs) for additional examples.
+
 ### Add exception handler middlware
 
 ```csharp
@@ -82,6 +84,7 @@ throw ErrorCodes.NotEnoughMoney.ToException()
 {
     "type": "https://help.myproject.ru/error-codes/not-enough-money",
     "title": "You have not enough money",
+    "detail": "You want 500, but your account balance is 300.",
     "status": 200,
     "code": "SSTV10001",
     "criticalityLevel": "Low",
diff --git a/Sstv.DomainExceptions.Extensions.SerilogEnricher/CHANGELOG.md b/Sstv.DomainExceptions.Extensions.SerilogEnricher/CHANGELOG.md
@@ -14,7 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## [3.1.0] - 2025-03-06
+## [3.1.0] - 2025-04-02
 
 ### Added
 
diff --git a/Sstv.DomainExceptions.Extensions.SerilogEnricher/README.md b/Sstv.DomainExceptions.Extensions.SerilogEnricher/README.md
@@ -13,19 +13,19 @@ When you write to log, serilog can attach some extra data to you logging message
 You can install using Nuget Package Manager:
 
 ```bash
-Install-Package Sstv.DomainExceptions.Extensions.SerilogEnricher -Version 3.0.0
+Install-Package Sstv.DomainExceptions.Extensions.SerilogEnricher -Version 3.1.0
 ```
 
 via the .NET CLI:
 
 ```bash
-dotnet add package Sstv.DomainExceptions.Extensions.SerilogEnricher --version 3.0.0
+dotnet add package Sstv.DomainExceptions.Extensions.SerilogEnricher --version 3.1.0
 ```
 
 or you can add package reference manually:
 
 ```xml
-<PackageReference Include="Sstv.DomainExceptions.Extensions.SerilogEnricher" Version="3.0.0" />
+<PackageReference Include="Sstv.DomainExceptions.Extensions.SerilogEnricher" Version="3.1.0" />
 ```
 
 ### How to use?
diff --git a/Sstv.DomainExceptions/AdditionalDataPropertyFilterArgs.cs b/Sstv.DomainExceptions/AdditionalDataPropertyFilterArgs.cs
@@ -0,0 +1,77 @@
+namespace Sstv.DomainExceptions;
+
+/// <summary>
+/// Arguments for filtering additional data.
+/// </summary>
+public readonly struct AdditionalDataPropertyFilterArgs : IEquatable<AdditionalDataPropertyFilterArgs>
+{
+    /// <summary>
+    /// Domain exception that processing.
+    /// </summary>
+    public DomainException DomainException { get; }
+
+    /// <summary>
+    /// The key.
+    /// </summary>
+    public string? Key { get; }
+
+    /// <summary>
+    /// value
+    /// </summary>
+    public object? Value { get; }
+
+    /// <summary>
+    /// Arguments for filtering additional data.
+    /// </summary>
+    /// <param name="domainException">Domain exception that processing.</param>
+    /// <param name="key">The key.</param>
+    /// <param name="value">It's value.</param>
+    public AdditionalDataPropertyFilterArgs(DomainException domainException, string? key, object? value)
+    {
+        DomainException = domainException;
+        Key = key;
+        Value = value;
+    }
+
+    /// <inheritdoc />
+    public bool Equals(AdditionalDataPropertyFilterArgs other)
+    {
+        return DomainException.Equals(other.DomainException) &&
+               string.Equals(Key, other.Key, StringComparison.OrdinalIgnoreCase) &&
+               Equals(Value, other.Value);
+    }
+
+    /// <inheritdoc />
+    public override bool Equals(object? obj)
+    {
+        return obj is AdditionalDataPropertyFilterArgs other && Equals(other);
+    }
+
+    /// <inheritdoc />
+    public override int GetHashCode()
+    {
+        unchecked
+        {
+            var hashCode = DomainException.GetHashCode();
+            hashCode = (hashCode * 397) ^ (Key != null ? StringComparer.OrdinalIgnoreCase.GetHashCode(Key) : 0);
+            hashCode = (hashCode * 397) ^ (Value != null ? Value.GetHashCode() : 0);
+            return hashCode;
+        }
+    }
+
+    /// <summary>
+    /// Equality operator.
+    /// </summary>
+    public static bool operator ==(AdditionalDataPropertyFilterArgs left, AdditionalDataPropertyFilterArgs right)
+    {
+        return left.Equals(right);
+    }
+
+    /// <summary>
+    /// Unequality operator.
+    /// </summary>
+    public static bool operator !=(AdditionalDataPropertyFilterArgs left, AdditionalDataPropertyFilterArgs right)
+    {
+        return !left.Equals(right);
+    }
+}
diff --git a/Sstv.DomainExceptions/CHANGELOG.md b/Sstv.DomainExceptions/CHANGELOG.md
@@ -14,11 +14,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## [3.1.0] - 2025-03-06
+## [3.1.0] - 2025-04-02
 
 ### Added
 
 - Added Microsoft.CodeAnalysis.PublicApiAnalyzers to control shipped API
+- Allow to filter additional data from domain exception that will be added to ProblemDetails. Specify DomainExceptionSettings.AdditionalDataResponseIncludingFilter.
+
+### Fixed
+- DetailedMessage from DomainException not passed to ProblemDetails response
 
 
 ## [3.0.0] - 2024-12-05
diff --git a/Sstv.DomainExceptions/DomainExceptionSettings.cs b/Sstv.DomainExceptions/DomainExceptionSettings.cs
@@ -1,4 +1,4 @@
-﻿namespace Sstv.DomainExceptions;
+namespace Sstv.DomainExceptions;
 
 /// <summary>
 /// Settings.
@@ -40,6 +40,11 @@ public sealed class DomainExceptionSettings
     /// </summary>
     public bool GenerateExceptionIdAutomatically { get; set; } = true;
 
+    /// <summary>
+    /// Allows to filter additonal data from DomainException to ProblemDetails response.
+    /// </summary>
+    public Func<AdditionalDataPropertyFilterArgs, bool>? AdditionalDataResponseIncludingFilter { get; set; }
+
     /// <summary>
     /// Add criticality level to additional data.
     /// </summary>
diff --git a/Sstv.DomainExceptions/PublicAPI/netstandard2.0/PublicAPI.Shipped.txt b/Sstv.DomainExceptions/PublicAPI/netstandard2.0/PublicAPI.Shipped.txt
diff --git a/Sstv.DomainExceptions/README.md b/Sstv.DomainExceptions/README.md
diff --git a/Sstv.DomainExceptions/Sstv.DomainExceptions.csproj b/Sstv.DomainExceptions/Sstv.DomainExceptions.csproj
diff --git a/Sstv.Host/ServiceCollectionExtensions.cs b/Sstv.Host/ServiceCollectionExtensions.cs
diff --git a/Sstv.Host/Sstv.Host.csproj b/Sstv.Host/Sstv.Host.csproj

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-using System.Collections;`
	`1`	`+using System.Collections;`
`2`	`2`	`using System.Text.Json.Serialization;`
`3`	`3`
`4`	`4`	`namespace Sstv.DomainExceptions.Extensions.ProblemDetails;`
`@@ -38,6 +38,8 @@ public ErrorCodeProblemDetails(DomainException domainException)`
`38`	`38`	`{`
`39`	`39`	`ArgumentNullException.ThrowIfNull(domainException);`
`40`	`40`
	`41`	`+ Detail = domainException.DetailedMessage;`
	`42`	`+`
`41`	`43`	`foreach (DictionaryEntry e in domainException.Data)`
`42`	`44`	`{`
`43`	`45`	`var stringKey = e.Key as string ?? e.Key.ToString();`
`@@ -46,7 +48,13 @@ public ErrorCodeProblemDetails(DomainException domainException)`
`46`	`48`	`{`
`47`	`49`	`stringKey = System.Text.Json.JsonNamingPolicy.CamelCase.ConvertName(stringKey);`
`48`	`50`
`49`		`- Extensions.TryAdd(stringKey, e.Value);`
	`51`	`+ var filter = DomainExceptionSettings.Instance.AdditionalDataResponseIncludingFilter;`
	`52`	`+ var add = filter is null \|\| filter.Invoke(new AdditionalDataPropertyFilterArgs(domainException, stringKey, e.Value));`
	`53`	`+`
	`54`	`+ if (add)`
	`55`	`+ {`
	`56`	`+ Extensions.TryAdd(stringKey, e.Value);`
	`57`	`+ }`
`50`	`58`	`}`
`51`	`59`	`}`
`52`	`60`	`}`