Joseph Doherty
d6b2f24c3f
One cross-client conformance pass; also closes first-cycle CLI-08. CLI-37: an MxStatusProxy entry is a failure iff `category != MX_STATUS_CATEGORY_OK`. The proto contract has always said so — `success` is the raw 16-bit COM member carried verbatim for diagnostics, not a boolean — but four clients branched on `success` alone and .NET required both, so the same gateway reply produced opposite verdicts per language. An absent entry stays success; a present entry with an UNSPECIFIED category is a failure, because the worker always maps a category and an unmapped one is not proven OK. CLI-38: a reply fails on HRESULT iff `hresult` is present and negative, so positive COM success codes such as S_FALSE (1) pass. .NET/Go/Java used `!= 0`, which errored on a parity-preserving S_FALSE that Python and Rust accepted. This makes the existing ClientLibrariesDesign.md claim true rather than rewriting the doc to describe the divergence. Four shared fixtures pin both rules cross-client, and each language suite also carries a table test for the two edges a fixture cannot express (absent entry, UNSPECIFIED category). A Java test fake that built a status with a bare `setSuccess(1)` and no category is fixed — under the category rule that reply was never a success.
108 lines
4.0 KiB
C#
108 lines
4.0 KiB
C#
using ZB.MOM.WW.MxGateway.Contracts.Proto;
|
|
|
|
namespace ZB.MOM.WW.MxGateway.Client;
|
|
|
|
/// <summary>Extension methods for checking MxCommandReply success conditions.</summary>
|
|
public static class MxCommandReplyExtensions
|
|
{
|
|
/// <summary>Validates that the reply has a successful protocol status (Ok or MxAccessFailure), throwing a gateway exception if not.</summary>
|
|
/// <param name="reply">The command reply to check.</param>
|
|
/// <returns>The same reply, for chaining.</returns>
|
|
public static MxCommandReply EnsureProtocolSuccess(this MxCommandReply reply)
|
|
{
|
|
ArgumentNullException.ThrowIfNull(reply);
|
|
|
|
ProtocolStatusCode code = reply.ProtocolStatus?.Code
|
|
?? ProtocolStatusCode.Unspecified;
|
|
|
|
if (code is ProtocolStatusCode.Ok or ProtocolStatusCode.MxaccessFailure)
|
|
{
|
|
return reply;
|
|
}
|
|
|
|
throw CreateProtocolException(reply, code);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Validates that the reply indicates MXAccess success, throwing MxAccessException if not.
|
|
/// Following COM semantics, only a negative HResult is a failure — positive success codes
|
|
/// such as <c>S_FALSE</c> pass — and a status entry fails only when its category is not Ok.
|
|
/// </summary>
|
|
/// <param name="reply">The command reply to check.</param>
|
|
/// <returns>The same reply, for chaining.</returns>
|
|
public static MxCommandReply EnsureMxAccessSuccess(this MxCommandReply reply)
|
|
{
|
|
ArgumentNullException.ThrowIfNull(reply);
|
|
|
|
bool mxAccessFailure = reply.ProtocolStatus?.Code is ProtocolStatusCode.MxaccessFailure;
|
|
bool hResultFailure = reply.HasHresult && reply.Hresult < 0;
|
|
bool statusFailure = reply.Statuses.Any(status => !status.IsSuccess());
|
|
|
|
if (!mxAccessFailure && !hResultFailure && !statusFailure)
|
|
{
|
|
return reply;
|
|
}
|
|
|
|
throw new MxAccessException(CreateMxAccessMessage(reply), reply);
|
|
}
|
|
|
|
private static MxGatewayException CreateProtocolException(
|
|
MxCommandReply reply,
|
|
ProtocolStatusCode code)
|
|
{
|
|
string message = CreateProtocolMessage(reply);
|
|
int? hResult = reply.HasHresult ? reply.Hresult : null;
|
|
MxStatusProxy[] statuses = reply.Statuses.ToArray();
|
|
|
|
return code switch
|
|
{
|
|
ProtocolStatusCode.SessionNotFound or ProtocolStatusCode.SessionNotReady
|
|
=> new MxGatewaySessionException(
|
|
message,
|
|
reply.SessionId,
|
|
reply.CorrelationId,
|
|
reply.ProtocolStatus,
|
|
hResult,
|
|
statuses),
|
|
ProtocolStatusCode.WorkerUnavailable
|
|
=> new MxGatewayWorkerException(
|
|
message,
|
|
reply.SessionId,
|
|
reply.CorrelationId,
|
|
reply.ProtocolStatus,
|
|
hResult,
|
|
statuses),
|
|
_
|
|
=> new MxGatewayCommandException(
|
|
message,
|
|
reply.SessionId,
|
|
reply.CorrelationId,
|
|
reply.ProtocolStatus,
|
|
hResult,
|
|
statuses),
|
|
};
|
|
}
|
|
|
|
private static string CreateProtocolMessage(MxCommandReply reply)
|
|
{
|
|
string statusMessage = string.IsNullOrWhiteSpace(reply.ProtocolStatus?.Message)
|
|
? "Gateway protocol failure."
|
|
: reply.ProtocolStatus.Message;
|
|
|
|
return $"{statusMessage} code={reply.ProtocolStatus?.Code}; session={reply.SessionId}; correlation={reply.CorrelationId}";
|
|
}
|
|
|
|
private static string CreateMxAccessMessage(MxCommandReply reply)
|
|
{
|
|
string statusSummary = reply.Statuses.Count is 0
|
|
? "no MXSTATUS_PROXY entries"
|
|
: string.Join("; ", reply.Statuses.Select(status => status.ToDiagnosticSummary()));
|
|
|
|
string hResult = reply.HasHresult
|
|
? $"0x{reply.Hresult:X8}"
|
|
: "none";
|
|
|
|
return $"MXAccess command failed. kind={reply.Kind}; hresult={hResult}; statuses={statusSummary}";
|
|
}
|
|
}
|