Joseph Doherty
dc9c0c950c
Apply the ZB.MOM.WW. prefix to all gateway-side projects, folders,
.csproj/.sln contents, C# namespaces, using directives, generated proto
C# (csharp_namespace + checked-in generated files), InternalsVisibleTo
attributes, project-name string literals (LoadProject, .sln lookups,
worker exe paths, staticwebassets manifest), and the install/script/doc
references that point at any of the above. Migrate the solution from
.sln to .slnx via `dotnet sln migrate` and delete the old file.
External-runtime identifiers are intentionally NOT prefixed so external
configuration keeps working:
- GatewayMetrics.cs MeterName ("MxGateway.Server")
- DashboardAuthenticationDefaults Scheme/Policy ("MxGateway.Dashboard")
- GatewayRequestLoggingMiddleware logger category ("MxGateway.Request")
- StaRuntime thread name ("MxGateway.Worker.STA")
- appsettings.json root section "MxGateway" + env-var prefix
MxGateway__... and secret-name MxGateway:ApiKeyPepper
- C:\ProgramData\MxGateway\ data dir paths
Also fixes two tests that were not rename-related but became visible
while validating the rename:
- WorkerLiveMxAccessSmokeTests.ShutDownAsync: cancellation that the
gateway service correctly maps to RpcException(Cancelled) per gRPC
convention was being misclassified as a stream fault. Added a sibling
catch on RpcException with StatusCode.Cancelled.
- IntegrationTestEnvironment.ResolveRepositoryRoot: extracted IsRepositoryRoot
and made it accept either a .git marker OR a .sln/.slnx next to src/
so the worker-exe walker works in non-git working copies.
clients/proto/proto-inputs.json's protoRoot updated to point at
src/ZB.MOM.WW.MxGateway.Contracts/Protos.
Verified by `dotnet build` and a full `dotnet test` of the .slnx with
MXGATEWAY_RUN_LIVE_{MXACCESS,LDAP,GALAXY}_TESTS=1:
Tests: 472/472 pass
Worker.Tests: 280/280 pass (4 dev-rig [Fact(Skip=...)] skipped)
IntegrationTests: 18/18 pass
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
68 lines
2.6 KiB
C#
68 lines
2.6 KiB
C#
using Microsoft.Extensions.Primitives;
|
|
|
|
namespace ZB.MOM.WW.MxGateway.Server.Diagnostics;
|
|
|
|
/// <summary>Middleware extensions for structured gateway request logging with correlation context.</summary>
|
|
public static class GatewayRequestLoggingMiddlewareExtensions
|
|
{
|
|
/// <summary>Header name for the session ID.</summary>
|
|
public const string SessionIdHeaderName = "x-session-id";
|
|
|
|
/// <summary>Header name for the worker process ID.</summary>
|
|
public const string WorkerProcessIdHeaderName = "x-worker-process-id";
|
|
|
|
/// <summary>Header name for the correlation ID.</summary>
|
|
public const string CorrelationIdHeaderName = "x-correlation-id";
|
|
|
|
/// <summary>Header name for the command method name.</summary>
|
|
public const string CommandMethodHeaderName = "x-command-method";
|
|
|
|
/// <summary>Adds gateway request logging scope middleware that reads correlation headers and redacts sensitive data.</summary>
|
|
/// <param name="app">Application builder.</param>
|
|
public static IApplicationBuilder UseGatewayRequestLoggingScope(this IApplicationBuilder app)
|
|
{
|
|
ArgumentNullException.ThrowIfNull(app);
|
|
|
|
return app.Use(async (context, next) =>
|
|
{
|
|
ILogger logger = context.RequestServices
|
|
.GetRequiredService<ILoggerFactory>()
|
|
.CreateLogger("MxGateway.Request");
|
|
|
|
using IDisposable? scope = logger.BeginGatewayScope(new GatewayLogScope(
|
|
SessionId: ReadHeader(context, SessionIdHeaderName),
|
|
WorkerProcessId: ReadInt32Header(context, WorkerProcessIdHeaderName),
|
|
CorrelationId: ReadUInt64Header(context, CorrelationIdHeaderName),
|
|
CommandMethod: ReadHeader(context, CommandMethodHeaderName),
|
|
ClientIdentity: ReadHeader(context, "authorization")));
|
|
|
|
await next(context);
|
|
});
|
|
}
|
|
|
|
private static string? ReadHeader(HttpContext context, string headerName)
|
|
{
|
|
return context.Request.Headers.TryGetValue(headerName, out StringValues values)
|
|
? values.ToString()
|
|
: null;
|
|
}
|
|
|
|
private static int? ReadInt32Header(HttpContext context, string headerName)
|
|
{
|
|
string? value = ReadHeader(context, headerName);
|
|
|
|
return int.TryParse(value, out int parsedValue)
|
|
? parsedValue
|
|
: null;
|
|
}
|
|
|
|
private static ulong? ReadUInt64Header(HttpContext context, string headerName)
|
|
{
|
|
string? value = ReadHeader(context, headerName);
|
|
|
|
return ulong.TryParse(value, out ulong parsedValue)
|
|
? parsedValue
|
|
: null;
|
|
}
|
|
}
|