feat(events): distinguish ResourceExhausted causes with an mxgw-reason trailer (mxaccessgw#216)
Event-queue overflow, alarm-feed overflow, subscriber cap, session limit and oversized commands all surfaced as ResourceExhausted. The status code is unchanged; the gateway now attaches a machine-readable `mxgw-reason` trailer (constants in Contracts ResourceExhaustedReasons). The .NET client maps ResourceExhausted to MxGatewayResourceExhaustedException (an MxGatewayException subclass; additive) exposing Reason/IsOverflow/ IsSubscriberLimit. Documented in docs/ClientBehaviorFixtures.md; the other clients get a doc note only. Claude-Session: https://claude.ai/code/session_01GT67AEHd2Acv1YPwGfXEoV
This commit is contained in:
@@ -0,0 +1,51 @@
|
||||
using Grpc.Core;
|
||||
using ZB.MOM.WW.MxGateway.Contracts;
|
||||
|
||||
namespace ZB.MOM.WW.MxGateway.Client;
|
||||
|
||||
/// <summary>
|
||||
/// Exception thrown when the gateway answers gRPC <c>ResourceExhausted</c>. The
|
||||
/// <see cref="Reason"/> distinguishes "you fell behind and events were lost" (re-subscribe and
|
||||
/// resync) from "a limit was reached" (back off, do not retry immediately). It derives from
|
||||
/// <see cref="MxGatewayException"/>, so existing catch blocks keep working.
|
||||
/// </summary>
|
||||
public sealed class MxGatewayResourceExhaustedException : MxGatewayException
|
||||
{
|
||||
/// <summary>Initializes a new instance.</summary>
|
||||
/// <param name="message">Diagnostic message describing the failure.</param>
|
||||
/// <param name="reason">The gateway's machine-readable reason code, or null when absent (older gateway).</param>
|
||||
/// <param name="innerException">The underlying <see cref="RpcException"/>.</param>
|
||||
public MxGatewayResourceExhaustedException(string message, string? reason, Exception? innerException = null)
|
||||
: base(message, innerException)
|
||||
{
|
||||
Reason = reason;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the reason code from the <c>mxgw-reason</c> trailer (see <see cref="ResourceExhaustedReasons"/>),
|
||||
/// or null when the gateway sent none.
|
||||
/// </summary>
|
||||
public string? Reason { get; }
|
||||
|
||||
/// <summary>Gets a value indicating whether events were lost because the subscriber fell behind (event-stream or alarm-feed overflow); the caller should re-subscribe and resync.</summary>
|
||||
public bool IsOverflow =>
|
||||
Reason is ResourceExhaustedReasons.EventQueueOverflow or ResourceExhaustedReasons.AlarmFeedOverflow;
|
||||
|
||||
/// <summary>Gets a value indicating whether the failure was a subscriber-count limit rejection.</summary>
|
||||
public bool IsSubscriberLimit =>
|
||||
Reason is ResourceExhaustedReasons.SubscriberLimit or ResourceExhaustedReasons.SubscriberAlreadyActive;
|
||||
|
||||
internal static string? ReadReason(RpcException exception)
|
||||
{
|
||||
foreach (Metadata.Entry entry in exception.Trailers)
|
||||
{
|
||||
if (!entry.IsBinary
|
||||
&& string.Equals(entry.Key, ResourceExhaustedReasons.TrailerKey, StringComparison.OrdinalIgnoreCase))
|
||||
{
|
||||
return entry.Value;
|
||||
}
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user