mirror of
https://github.com/Sea-Haven-Industries/shoc-backend.git
synced 2026-10-07 03:32:11 +00:00
* refactor(api): enforce service and data-service boundaries * refactor(api): complete feature service boundaries * refactor(identity): enforce service and data boundaries * refactor(vendors): enforce service and data boundaries * refactor(workorders): enforce service and data boundaries * refactor(backend): enforce architecture and optimize dispatch * style(backend): format changed architecture files * fix(architecture): address backend review follow-ups * fix(backend): sanitize exception disclosure in changed API endpoints Replace raw exception-message disclosure (ex.Message) returned to API callers with a stable sanitized public message plus correlated structured internal logging, across the endpoints changed in this PR. - Add SanitizedErrors helper: logs the original exception at Error with a generated correlation id and returns a stable public message referencing it so support can trace without exposing internals. - Inject ILogger<T> into the 14 changed controllers and route every ex.Message/dbex.Message disclosure through the helper, preserving status codes, response shapes, and business data (e.g. OpenWorkOrders). - Leave FluentValidation (vex.Errors) and existing fixed-message catches untouched; out-of-scope controllers (Account/Contact/Employee/Asset/ PMSchedule) are unchanged. - Add focused tests proving internal exception text is not returned and that Error logging carrying the original exception is invoked. * fix(architecture): abstract job run state access * style: format board update service * test: use collection assertion idiom
76 lines
3.5 KiB
C#
76 lines
3.5 KiB
C#
using System.Reflection;
|
|
using Api.SeaHavenIndustries.Controllers;
|
|
using Data.SeaHavenIndustries;
|
|
using FluentAssertions;
|
|
using Microsoft.AspNetCore.Mvc;
|
|
using Microsoft.EntityFrameworkCore;
|
|
using Microsoft.Extensions.Configuration;
|
|
using SeaHaven.DataServices.Implementation;
|
|
using SeaHaven.Services.Implementation;
|
|
using Xunit;
|
|
|
|
namespace Api.SeaHavenIndustries.Tests;
|
|
|
|
public class ArchitectureTests
|
|
{
|
|
private static readonly Assembly ApiAssembly = typeof(VendorPortalController).Assembly;
|
|
private static readonly Assembly ServicesAssembly = typeof(VendorService).Assembly;
|
|
private static readonly Assembly DataServicesAssembly = typeof(VendorDataService).Assembly;
|
|
|
|
private const string ServiceImplementationNamespace = "SeaHaven.Services.Implementation";
|
|
private const string DataServiceImplementationNamespace = "SeaHaven.DataServices.Implementation";
|
|
|
|
private static IEnumerable<Type> ApiControllers =>
|
|
ApiAssembly.GetTypes()
|
|
.Where(t => t.IsClass && !t.IsAbstract && typeof(ControllerBase).IsAssignableFrom(t));
|
|
|
|
private static IEnumerable<Type> BusinessServiceImplementations =>
|
|
ServicesAssembly.GetTypes()
|
|
.Where(t => t.IsClass && !t.IsAbstract && !t.IsGenericType)
|
|
.Where(t => t.GetInterfaces().Any(i => i.Name == "I" + t.Name));
|
|
|
|
private static bool IsConcrete(Type type) => type.IsClass && !type.IsAbstract && !type.IsInterface;
|
|
|
|
private static bool IsDbContext(Type type) => typeof(DbContext).IsAssignableFrom(type);
|
|
|
|
private static bool IsConcreteServiceImplementation(Type type) =>
|
|
type.Namespace == ServiceImplementationNamespace && IsConcrete(type);
|
|
|
|
private static bool IsConcreteDataService(Type type) =>
|
|
type.Namespace == DataServiceImplementationNamespace && IsConcrete(type);
|
|
|
|
private static IEnumerable<ParameterInfo> ParametersOf(IEnumerable<Type> types) =>
|
|
types.SelectMany(t => t.GetConstructors().SelectMany(c => c.GetParameters()));
|
|
|
|
[Fact]
|
|
public void Controllers_DoNotInject_DbContext_ConcreteDataServices_Or_ConcreteServiceImplementations()
|
|
{
|
|
ApiControllers.Should().NotBeEmpty("the API must expose controllers for this invariant to be meaningful");
|
|
|
|
var violations = ParametersOf(ApiControllers)
|
|
.Where(p => IsDbContext(p.ParameterType)
|
|
|| IsConcreteDataService(p.ParameterType)
|
|
|| IsConcreteServiceImplementation(p.ParameterType))
|
|
.Select(p => $"{p.Member.DeclaringType!.Name} depends on {p.ParameterType.FullName} ({p.Name})")
|
|
.ToList();
|
|
|
|
violations.Should().BeEmpty(
|
|
"controllers must depend only on interfaces/abstractions, never on DbContext, concrete data services, or concrete service implementations");
|
|
}
|
|
|
|
[Fact]
|
|
public void BusinessServices_DoNotInject_DbContext_Or_IConfiguration()
|
|
{
|
|
BusinessServiceImplementations.Should().NotBeEmpty(
|
|
"business services must be discovered for this invariant to be meaningful");
|
|
|
|
var violations = ParametersOf(BusinessServiceImplementations)
|
|
.Where(p => IsDbContext(p.ParameterType)
|
|
|| typeof(IConfiguration).IsAssignableFrom(p.ParameterType))
|
|
.Select(p => $"{p.Member.DeclaringType!.Name} depends on {p.ParameterType.FullName} ({p.Name})")
|
|
.ToList();
|
|
|
|
violations.Should().BeEmpty(
|
|
"business services must depend on data-service interfaces and typed options, never on DbContext or IConfiguration");
|
|
}
|
|
}
|