a9b23556eb
A caller addressing a standby central node directly (or hitting Traefik inside its /health/active probe window after a failover) used to get 503 STANDBY_NODE. The standby now relays the request verbatim to the active peer over HTTP (IStandbyRequestForwarder / HttpStandbyRequestForwarder) and replays the response; method scripts and Route.To() still execute only on the active node. - ScadaBridge:InboundApi:StandbyForwardPeerEndpoints (static list of the OTHER central node's HTTP base URL; empty = old 503 behaviour) + StandbyForwardTimeout (60s), both startup-validated. - Peers tried in order: peer 503 stamped X-ScadaBridge-Standby, connection failure or timeout → next peer; all fail → 503 ACTIVE_NODE_UNREACHABLE. A 503 without the marker is the active node's own answer and is replayed. - One-hop loop guard via X-ScadaBridge-Forwarded; 413 body cap now runs BEFORE the active-node check so a standby never buffers/relays an oversized body. - AuditWriteMiddleware skips its own ApiInbound row for a relayed request so a call is audited once, on the node that executed it. - Rig + env2 central nodes configured; spec (Component-InboundAPI.md → Standby forwarding), Component-Host.md options row, CLAUDE.md updated. - 20 new tests (filter decision + relay mechanics + validator). Claude-Session: https://claude.ai/code/session_019ZxXT5sxZs5XrtdwYzJDPV
121 lines
4.0 KiB
C#
121 lines
4.0 KiB
C#
using Microsoft.Extensions.Options;
|
|
|
|
namespace ZB.MOM.WW.ScadaBridge.InboundAPI.Tests;
|
|
|
|
/// <summary>
|
|
/// Arch-review 08 §1.5: <see cref="InboundApiOptions"/> feeds a per-request timeout
|
|
/// (<see cref="InboundApiOptions.DefaultMethodTimeout"/>) and a body-size cap
|
|
/// (<see cref="InboundApiOptions.MaxRequestBodyBytes"/>) into the inbound-API request
|
|
/// pipeline; a zero/negative timeout or a non-positive body cap must be rejected fast at
|
|
/// startup with a clear, key-naming message rather than silently degrading the endpoint.
|
|
/// The <see cref="InboundApiOptions.ApiKeyPepper"/> is deliberately NOT required non-empty
|
|
/// here (empty is a legitimate dev default; production pepper strength is enforced elsewhere).
|
|
/// </summary>
|
|
public class InboundApiOptionsValidatorTests
|
|
{
|
|
private static ValidateOptionsResult Validate(InboundApiOptions options) =>
|
|
new InboundApiOptionsValidator().Validate(Options.DefaultName, options);
|
|
|
|
[Fact]
|
|
public void DefaultOptions_AreValid()
|
|
{
|
|
var result = Validate(new InboundApiOptions());
|
|
Assert.True(result.Succeeded, result.FailureMessage);
|
|
}
|
|
|
|
[Fact]
|
|
public void EmptyApiKeyPepper_IsValid()
|
|
{
|
|
var result = Validate(new InboundApiOptions { ApiKeyPepper = string.Empty });
|
|
Assert.True(result.Succeeded, result.FailureMessage);
|
|
}
|
|
|
|
[Fact]
|
|
public void ZeroDefaultMethodTimeout_IsRejected()
|
|
{
|
|
var result = Validate(new InboundApiOptions { DefaultMethodTimeout = TimeSpan.Zero });
|
|
|
|
Assert.True(result.Failed);
|
|
Assert.Contains("DefaultMethodTimeout", result.FailureMessage);
|
|
}
|
|
|
|
[Fact]
|
|
public void NegativeDefaultMethodTimeout_IsRejected()
|
|
{
|
|
var result = Validate(new InboundApiOptions { DefaultMethodTimeout = TimeSpan.FromSeconds(-1) });
|
|
|
|
Assert.True(result.Failed);
|
|
Assert.Contains("DefaultMethodTimeout", result.FailureMessage);
|
|
}
|
|
|
|
[Fact]
|
|
public void ZeroMaxRequestBodyBytes_IsRejected()
|
|
{
|
|
var result = Validate(new InboundApiOptions { MaxRequestBodyBytes = 0 });
|
|
|
|
Assert.True(result.Failed);
|
|
Assert.Contains("MaxRequestBodyBytes", result.FailureMessage);
|
|
}
|
|
|
|
[Fact]
|
|
public void NegativeMaxRequestBodyBytes_IsRejected()
|
|
{
|
|
var result = Validate(new InboundApiOptions { MaxRequestBodyBytes = -1 });
|
|
|
|
Assert.True(result.Failed);
|
|
Assert.Contains("MaxRequestBodyBytes", result.FailureMessage);
|
|
}
|
|
|
|
[Fact]
|
|
public void ZeroApiMethodCacheTtl_IsRejected()
|
|
{
|
|
var result = Validate(new InboundApiOptions { ApiMethodCacheTtl = TimeSpan.Zero });
|
|
|
|
Assert.True(result.Failed);
|
|
Assert.Contains("ApiMethodCacheTtl", result.FailureMessage);
|
|
}
|
|
|
|
[Fact]
|
|
public void NegativeApiMethodCacheTtl_IsRejected()
|
|
{
|
|
var result = Validate(new InboundApiOptions { ApiMethodCacheTtl = TimeSpan.FromSeconds(-1) });
|
|
|
|
Assert.True(result.Failed);
|
|
Assert.Contains("ApiMethodCacheTtl", result.FailureMessage);
|
|
}
|
|
|
|
// --- Standby forwarding (2026-08-28) ---
|
|
|
|
[Fact]
|
|
public void StandbyForwardPeerEndpoints_AbsoluteHttpUrls_AreValid()
|
|
{
|
|
var result = Validate(new InboundApiOptions
|
|
{
|
|
StandbyForwardPeerEndpoints = { "http://central-b:5000", "https://central-b.example/" },
|
|
});
|
|
Assert.True(result.Succeeded, result.FailureMessage);
|
|
}
|
|
|
|
[Theory]
|
|
[InlineData("central-b:5000")]
|
|
[InlineData("/api")]
|
|
[InlineData("ftp://central-b")]
|
|
[InlineData("")]
|
|
public void StandbyForwardPeerEndpoints_NonHttpOrRelative_IsRejected(string peer)
|
|
{
|
|
var result = Validate(new InboundApiOptions { StandbyForwardPeerEndpoints = { peer } });
|
|
|
|
Assert.True(result.Failed);
|
|
Assert.Contains("StandbyForwardPeerEndpoints", result.FailureMessage);
|
|
}
|
|
|
|
[Fact]
|
|
public void ZeroStandbyForwardTimeout_IsRejected()
|
|
{
|
|
var result = Validate(new InboundApiOptions { StandbyForwardTimeout = TimeSpan.Zero });
|
|
|
|
Assert.True(result.Failed);
|
|
Assert.Contains("StandbyForwardTimeout", result.FailureMessage);
|
|
}
|
|
}
|