mirror of
https://github.com/Sea-Haven-Industries/shoc-backend.git
synced 2026-09-30 04:53:11 +00:00
7d245eb717
* 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
71 lines
2.3 KiB
C#
71 lines
2.3 KiB
C#
using Api.SeaHavenIndustries.Helper;
|
|
using FluentAssertions;
|
|
using Microsoft.Extensions.Logging;
|
|
using Moq;
|
|
using Xunit;
|
|
|
|
namespace Api.SeaHavenIndustries.Tests;
|
|
|
|
public class SanitizedErrorsTests
|
|
{
|
|
[Fact]
|
|
public void Sanitize_ReturnsStableMessageAndNeverExposesExceptionText()
|
|
{
|
|
var logger = new Mock<ILogger>();
|
|
logger.Setup(x => x.IsEnabled(It.IsAny<LogLevel>())).Returns(true);
|
|
|
|
var message = logger.Object.Sanitize(new InvalidOperationException("SUPER-SECRET-internal-detail"));
|
|
|
|
message.Should().NotContain("SUPER-SECRET");
|
|
message.Should().NotContain("internal-detail");
|
|
message.Should().StartWith("An unexpected error occurred");
|
|
message.Should().Contain("reference");
|
|
}
|
|
|
|
[Fact]
|
|
public void Sanitize_UsesProvidedPublicMessageInsteadOfExceptionText()
|
|
{
|
|
var logger = new Mock<ILogger>();
|
|
logger.Setup(x => x.IsEnabled(It.IsAny<LogLevel>())).Returns(true);
|
|
|
|
var message = logger.Object.Sanitize(
|
|
new InvalidOperationException("SUPER-SECRET-internal-detail"),
|
|
"Vendor not found");
|
|
|
|
message.Should().Contain("Vendor not found");
|
|
message.Should().NotContain("SUPER-SECRET");
|
|
message.Should().Contain("reference");
|
|
}
|
|
|
|
[Fact]
|
|
public void Sanitize_LogsOriginalExceptionAtErrorLevel()
|
|
{
|
|
var logger = new Mock<ILogger>();
|
|
logger.Setup(x => x.IsEnabled(It.IsAny<LogLevel>())).Returns(true);
|
|
var exception = new InvalidOperationException("SUPER-SECRET-internal-detail");
|
|
|
|
logger.Object.Sanitize(exception);
|
|
|
|
logger.Verify(
|
|
x => x.Log(
|
|
LogLevel.Error,
|
|
It.IsAny<EventId>(),
|
|
It.IsAny<It.IsAnyType>(),
|
|
It.Is<Exception>(ex => ex == exception),
|
|
It.IsAny<Func<It.IsAnyType, Exception?, string>>()),
|
|
Times.Once);
|
|
}
|
|
|
|
[Fact]
|
|
public void Sanitize_ProducesUniqueCorrelationReferencesAcrossCalls()
|
|
{
|
|
var logger = new Mock<ILogger>();
|
|
logger.Setup(x => x.IsEnabled(It.IsAny<LogLevel>())).Returns(true);
|
|
var exception = new InvalidOperationException("detail");
|
|
|
|
var first = logger.Object.Sanitize(exception);
|
|
var second = logger.Object.Sanitize(exception);
|
|
|
|
first.Should().NotBe(second);
|
|
}
|
|
}
|