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>
121 lines
5.5 KiB
C#
121 lines
5.5 KiB
C#
using Grpc.Core;
|
|
using ZB.MOM.WW.MxGateway.Contracts.Proto;
|
|
|
|
namespace ZB.MOM.WW.MxGateway.Server.Grpc;
|
|
|
|
public sealed class MxAccessGrpcRequestValidator
|
|
{
|
|
/// <summary>Validates an open session request.</summary>
|
|
/// <param name="request">The request to validate.</param>
|
|
public void ValidateOpenSession(OpenSessionRequest request)
|
|
{
|
|
ArgumentNullException.ThrowIfNull(request);
|
|
|
|
if (request.CommandTimeout is not null && request.CommandTimeout.ToTimeSpan() <= TimeSpan.Zero)
|
|
{
|
|
throw InvalidArgument("Command timeout must be greater than zero when provided.");
|
|
}
|
|
}
|
|
|
|
/// <summary>Validates a close session request.</summary>
|
|
/// <param name="request">The request to validate.</param>
|
|
public void ValidateCloseSession(CloseSessionRequest request)
|
|
{
|
|
ArgumentNullException.ThrowIfNull(request);
|
|
RequireSessionId(request.SessionId);
|
|
}
|
|
|
|
/// <summary>Validates a stream events request.</summary>
|
|
/// <param name="request">The request to validate.</param>
|
|
public void ValidateStreamEvents(StreamEventsRequest request)
|
|
{
|
|
ArgumentNullException.ThrowIfNull(request);
|
|
RequireSessionId(request.SessionId);
|
|
}
|
|
|
|
/// <summary>Validates an invoke request with command payload.</summary>
|
|
/// <param name="request">The request to validate.</param>
|
|
public void ValidateInvoke(MxCommandRequest request)
|
|
{
|
|
ArgumentNullException.ThrowIfNull(request);
|
|
RequireSessionId(request.SessionId);
|
|
|
|
if (request.Command is null)
|
|
{
|
|
throw InvalidArgument("Invoke requires a command payload.");
|
|
}
|
|
|
|
if (request.Command.Kind is MxCommandKind.Unspecified)
|
|
{
|
|
throw InvalidArgument("Invoke requires a command kind.");
|
|
}
|
|
|
|
ValidateCommandPayload(request.Command);
|
|
}
|
|
|
|
private static void RequireSessionId(string sessionId)
|
|
{
|
|
if (string.IsNullOrWhiteSpace(sessionId))
|
|
{
|
|
throw InvalidArgument("Session id is required.");
|
|
}
|
|
}
|
|
|
|
private static void ValidateCommandPayload(MxCommand command)
|
|
{
|
|
MxCommand.PayloadOneofCase expectedPayload = ExpectedPayload(command.Kind);
|
|
if (command.PayloadCase != expectedPayload)
|
|
{
|
|
throw InvalidArgument(
|
|
$"Command kind {command.Kind} requires payload {expectedPayload} but received {command.PayloadCase}.");
|
|
}
|
|
}
|
|
|
|
private static MxCommand.PayloadOneofCase ExpectedPayload(MxCommandKind kind)
|
|
{
|
|
return kind switch
|
|
{
|
|
MxCommandKind.Register => MxCommand.PayloadOneofCase.Register,
|
|
MxCommandKind.Unregister => MxCommand.PayloadOneofCase.Unregister,
|
|
MxCommandKind.AddItem => MxCommand.PayloadOneofCase.AddItem,
|
|
MxCommandKind.AddItem2 => MxCommand.PayloadOneofCase.AddItem2,
|
|
MxCommandKind.RemoveItem => MxCommand.PayloadOneofCase.RemoveItem,
|
|
MxCommandKind.Advise => MxCommand.PayloadOneofCase.Advise,
|
|
MxCommandKind.UnAdvise => MxCommand.PayloadOneofCase.UnAdvise,
|
|
MxCommandKind.AdviseSupervisory => MxCommand.PayloadOneofCase.AdviseSupervisory,
|
|
MxCommandKind.AddBufferedItem => MxCommand.PayloadOneofCase.AddBufferedItem,
|
|
MxCommandKind.SetBufferedUpdateInterval => MxCommand.PayloadOneofCase.SetBufferedUpdateInterval,
|
|
MxCommandKind.Suspend => MxCommand.PayloadOneofCase.Suspend,
|
|
MxCommandKind.Activate => MxCommand.PayloadOneofCase.Activate,
|
|
MxCommandKind.Write => MxCommand.PayloadOneofCase.Write,
|
|
MxCommandKind.Write2 => MxCommand.PayloadOneofCase.Write2,
|
|
MxCommandKind.WriteSecured => MxCommand.PayloadOneofCase.WriteSecured,
|
|
MxCommandKind.WriteSecured2 => MxCommand.PayloadOneofCase.WriteSecured2,
|
|
MxCommandKind.AuthenticateUser => MxCommand.PayloadOneofCase.AuthenticateUser,
|
|
MxCommandKind.ArchestraUserToId => MxCommand.PayloadOneofCase.ArchestraUserToId,
|
|
MxCommandKind.AddItemBulk => MxCommand.PayloadOneofCase.AddItemBulk,
|
|
MxCommandKind.AdviseItemBulk => MxCommand.PayloadOneofCase.AdviseItemBulk,
|
|
MxCommandKind.RemoveItemBulk => MxCommand.PayloadOneofCase.RemoveItemBulk,
|
|
MxCommandKind.UnAdviseItemBulk => MxCommand.PayloadOneofCase.UnAdviseItemBulk,
|
|
MxCommandKind.SubscribeBulk => MxCommand.PayloadOneofCase.SubscribeBulk,
|
|
MxCommandKind.UnsubscribeBulk => MxCommand.PayloadOneofCase.UnsubscribeBulk,
|
|
MxCommandKind.WriteBulk => MxCommand.PayloadOneofCase.WriteBulk,
|
|
MxCommandKind.Write2Bulk => MxCommand.PayloadOneofCase.Write2Bulk,
|
|
MxCommandKind.WriteSecuredBulk => MxCommand.PayloadOneofCase.WriteSecuredBulk,
|
|
MxCommandKind.WriteSecured2Bulk => MxCommand.PayloadOneofCase.WriteSecured2Bulk,
|
|
MxCommandKind.ReadBulk => MxCommand.PayloadOneofCase.ReadBulk,
|
|
MxCommandKind.Ping => MxCommand.PayloadOneofCase.Ping,
|
|
MxCommandKind.GetSessionState => MxCommand.PayloadOneofCase.GetSessionState,
|
|
MxCommandKind.GetWorkerInfo => MxCommand.PayloadOneofCase.GetWorkerInfo,
|
|
MxCommandKind.DrainEvents => MxCommand.PayloadOneofCase.DrainEvents,
|
|
MxCommandKind.ShutdownWorker => MxCommand.PayloadOneofCase.ShutdownWorker,
|
|
_ => MxCommand.PayloadOneofCase.None,
|
|
};
|
|
}
|
|
|
|
private static RpcException InvalidArgument(string detail)
|
|
{
|
|
return new RpcException(new Status(StatusCode.InvalidArgument, detail));
|
|
}
|
|
}
|