a212283104
WP2.6 (arch-review remediation, cross-cutting misc): - SiteExternalSystemRepository: name/ID-indexed ExternalSystemDefinitionCache replaces the fetch-all + reverse-map scan on every by-ID/method lookup; loaded once per redeploy, invalidated by DeploymentManagerActor after HandleDeployArtifacts applies external-system changes. Static JsonSerializerOptions for method-list parsing. - Inbound API: short-TTL ApiMethodCache fronts the per-request ApiMethod repository fetch; invalidated by name via the existing ScriptArtifactChangeSubscriber/ IScriptArtifactChangeBus pipeline, self-healing via TTL for changes the bus doesn't cover (e.g. Management API edits). - StoreAndForward: the cached-call audit-observer queue — the one unbounded channel left in the system — is now bounded (ObserverQueueCapacity, default 10,000) with DropOldest overflow and a dropped-notification counter. - SiteStreamManager: alarm state changes now travel a dedicated publish source/broadcast hub, isolated from the (far higher-volume) attribute path, so an attribute storm can no longer evict a pending alarm transition; the alarm hand-off queue is bounded with a drop counter surfaced on the site health report (SiteStreamAlarmDropCount via the new SiteStreamAlarmDropReporter), and publishing is skipped entirely at zero subscribers on either path. - CLI ManagementHttpClient: explicit 30s HttpClient.Timeout on the shared construction (was the 100s framework default), overridable via SCADABRIDGE_HTTP_TIMEOUT_SECONDS. Deviation: the failback-probe heartbeat item is NOT included — its only viable surface (CentralChannelProvider.cs / heartbeat consumers) lives entirely in the Communication project, explicitly off-limits to this work package this phase. Tests: SiteRuntime.Tests (550), InboundAPI.Tests (278), StoreAndForward.Tests (133), CLI.Tests (390), HealthMonitoring.Tests (97) — all green after full solution build.
262 lines
12 KiB
C#
262 lines
12 KiB
C#
using System.Net.Http.Headers;
|
|
using System.Text;
|
|
using System.Text.Json;
|
|
|
|
namespace ZB.MOM.WW.ScadaBridge.CLI;
|
|
|
|
public class ManagementHttpClient : IDisposable
|
|
{
|
|
private readonly HttpClient _httpClient;
|
|
|
|
/// <summary>
|
|
/// WP2.6e (arch-review misc — CLI HttpClient timeout): default overall
|
|
/// <see cref="HttpClient.Timeout"/> for the shared client construction (30 s). This
|
|
/// bounds a hung/black-holed connection — before this, the public constructor left
|
|
/// <see cref="HttpClient.Timeout"/> at its framework default (100 s), silently longer
|
|
/// than most CLI callers' own per-request <c>TimeSpan timeout</c> argument
|
|
/// (<see cref="SendCommandAsync"/>/<see cref="SendGetAsync"/>/<see cref="SendPostAsync"/>
|
|
/// already bound each call via their own <see cref="CancellationTokenSource"/>, but a
|
|
/// connection attempt that never completes at all — no response headers, ever — is
|
|
/// bounded by <see cref="HttpClient.Timeout"/> instead, since that governs the whole
|
|
/// request/response including connect). Config-overridable via the
|
|
/// <c>SCADABRIDGE_HTTP_TIMEOUT_SECONDS</c> environment variable, consistent with how
|
|
/// every other CLI setting is overridden (see <see cref="CliConfig"/>) — kept
|
|
/// self-contained here (no <see cref="CliConfig"/>/command-file plumbing) since CLI
|
|
/// commands are owned by a separate work package this phase.
|
|
/// </summary>
|
|
public static readonly TimeSpan DefaultTimeout = TimeSpan.FromSeconds(30);
|
|
|
|
/// <summary>Test seam (WP2.6e) — the effective <see cref="HttpClient.Timeout"/> this instance was constructed with.</summary>
|
|
internal TimeSpan EffectiveTimeout { get; }
|
|
|
|
/// <summary>
|
|
/// Resolves the effective default timeout: the <c>SCADABRIDGE_HTTP_TIMEOUT_SECONDS</c>
|
|
/// environment variable when set to a positive integer, otherwise <see cref="DefaultTimeout"/>.
|
|
/// </summary>
|
|
private static TimeSpan ResolveDefaultTimeout()
|
|
{
|
|
var env = Environment.GetEnvironmentVariable("SCADABRIDGE_HTTP_TIMEOUT_SECONDS");
|
|
if (!string.IsNullOrWhiteSpace(env)
|
|
&& int.TryParse(env, out var seconds)
|
|
&& seconds > 0)
|
|
{
|
|
return TimeSpan.FromSeconds(seconds);
|
|
}
|
|
|
|
return DefaultTimeout;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Initializes a new instance of the <see cref="ManagementHttpClient"/> class, with
|
|
/// <see cref="HttpClient.Timeout"/> set to <see cref="ResolveDefaultTimeout"/>
|
|
/// (30 s, or the <c>SCADABRIDGE_HTTP_TIMEOUT_SECONDS</c> override).
|
|
/// </summary>
|
|
/// <param name="baseUrl">The base URL for the management API.</param>
|
|
/// <param name="username">The username for HTTP Basic authentication.</param>
|
|
/// <param name="password">The password for HTTP Basic authentication.</param>
|
|
public ManagementHttpClient(string baseUrl, string username, string password)
|
|
: this(new HttpClient { Timeout = ResolveDefaultTimeout() }, baseUrl, username, password)
|
|
{
|
|
}
|
|
|
|
/// <summary>
|
|
/// Test-only constructor that accepts a pre-built <see cref="HttpClient"/> (typically
|
|
/// over a stub <see cref="HttpMessageHandler"/>) so the request/response handling can
|
|
/// be exercised without a live server.
|
|
/// </summary>
|
|
/// <param name="httpClient">The HTTP client to use for requests.</param>
|
|
/// <param name="baseUrl">The base URL for the management API.</param>
|
|
/// <param name="username">The username for HTTP Basic authentication.</param>
|
|
/// <param name="password">The password for HTTP Basic authentication.</param>
|
|
internal ManagementHttpClient(HttpClient httpClient, string baseUrl, string username, string password)
|
|
{
|
|
_httpClient = httpClient;
|
|
// Test seam (WP2.6e): exposes the constructed HttpClient's effective Timeout
|
|
// without requiring reflection.
|
|
EffectiveTimeout = httpClient.Timeout;
|
|
_httpClient.BaseAddress = new Uri(baseUrl.TrimEnd('/') + "/");
|
|
var credentials = Convert.ToBase64String(Encoding.UTF8.GetBytes($"{username}:{password}"));
|
|
_httpClient.DefaultRequestHeaders.Authorization =
|
|
new AuthenticationHeaderValue("Basic", credentials);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Sends a management command to the management API.
|
|
/// </summary>
|
|
/// <param name="commandName">The command name to execute.</param>
|
|
/// <param name="payload">The command payload.</param>
|
|
/// <param name="timeout">The request timeout.</param>
|
|
/// <returns>A management response containing status and data.</returns>
|
|
public async Task<ManagementResponse> SendCommandAsync(string commandName, object payload, TimeSpan timeout)
|
|
{
|
|
using var cts = new CancellationTokenSource(timeout);
|
|
|
|
var body = JsonSerializer.Serialize(new { command = commandName, payload },
|
|
new JsonSerializerOptions { PropertyNamingPolicy = JsonNamingPolicy.CamelCase });
|
|
|
|
var content = new StringContent(body, Encoding.UTF8, "application/json");
|
|
|
|
HttpResponseMessage httpResponse;
|
|
try
|
|
{
|
|
httpResponse = await _httpClient.PostAsync("management", content, cts.Token);
|
|
}
|
|
catch (TaskCanceledException)
|
|
{
|
|
return new ManagementResponse(504, null, "Request timed out.", "TIMEOUT");
|
|
}
|
|
catch (HttpRequestException ex)
|
|
{
|
|
return new ManagementResponse(0, null, $"Connection failed: {ex.Message}", "CONNECTION_FAILED");
|
|
}
|
|
|
|
var responseBody = await httpResponse.Content.ReadAsStringAsync(cts.Token);
|
|
|
|
if (httpResponse.IsSuccessStatusCode)
|
|
{
|
|
return new ManagementResponse((int)httpResponse.StatusCode, responseBody, null, null);
|
|
}
|
|
|
|
// Parse error response
|
|
string? error = null;
|
|
string? code = null;
|
|
try
|
|
{
|
|
using var doc = JsonDocument.Parse(responseBody);
|
|
error = doc.RootElement.TryGetProperty("error", out var e) ? e.GetString() : responseBody;
|
|
code = doc.RootElement.TryGetProperty("code", out var c) ? c.GetString() : null;
|
|
}
|
|
catch
|
|
{
|
|
error = responseBody;
|
|
}
|
|
|
|
return new ManagementResponse((int)httpResponse.StatusCode, null, error, code);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Issues a plain HTTP <c>GET</c> against a REST endpoint (e.g. the audit
|
|
/// <c>/api/audit/query</c> endpoint) and returns the
|
|
/// response body. Unlike <see cref="SendCommandAsync"/>, this does not wrap the call
|
|
/// in the <c>POST /management</c> command envelope — the audit endpoints are plain
|
|
/// REST resources. Authentication (HTTP Basic) and the base address are shared.
|
|
/// </summary>
|
|
/// <param name="relativePath">Path relative to the base URL, with query string.</param>
|
|
/// <param name="timeout">The request timeout.</param>
|
|
/// <returns>A management response containing status and data.</returns>
|
|
public async Task<ManagementResponse> SendGetAsync(string relativePath, TimeSpan timeout)
|
|
{
|
|
using var cts = new CancellationTokenSource(timeout);
|
|
|
|
HttpResponseMessage httpResponse;
|
|
try
|
|
{
|
|
httpResponse = await _httpClient.GetAsync(relativePath, cts.Token);
|
|
}
|
|
catch (TaskCanceledException)
|
|
{
|
|
return new ManagementResponse(504, null, "Request timed out.", "TIMEOUT");
|
|
}
|
|
catch (HttpRequestException ex)
|
|
{
|
|
return new ManagementResponse(0, null, $"Connection failed: {ex.Message}", "CONNECTION_FAILED");
|
|
}
|
|
|
|
var responseBody = await httpResponse.Content.ReadAsStringAsync(cts.Token);
|
|
|
|
if (httpResponse.IsSuccessStatusCode)
|
|
{
|
|
return new ManagementResponse((int)httpResponse.StatusCode, responseBody, null, null);
|
|
}
|
|
|
|
string? error = null;
|
|
string? code = null;
|
|
try
|
|
{
|
|
using var doc = JsonDocument.Parse(responseBody);
|
|
error = doc.RootElement.TryGetProperty("error", out var e) ? e.GetString() : responseBody;
|
|
code = doc.RootElement.TryGetProperty("code", out var c) ? c.GetString() : null;
|
|
}
|
|
catch
|
|
{
|
|
error = responseBody;
|
|
}
|
|
|
|
return new ManagementResponse((int)httpResponse.StatusCode, null, error, code);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Issues a plain HTTP <c>POST</c> against a REST endpoint (e.g. the audit
|
|
/// maintenance endpoints) with a JSON body and returns the response. Unlike
|
|
/// <see cref="SendCommandAsync"/>, this does not wrap the call in the
|
|
/// <c>POST /management</c> command envelope — these are plain REST resources.
|
|
/// Authentication (HTTP Basic) and the base address are shared.
|
|
/// </summary>
|
|
/// <param name="relativePath">Path relative to the base URL.</param>
|
|
/// <param name="body">The JSON body to send, or <c>null</c> for an empty body.</param>
|
|
/// <param name="timeout">The request timeout.</param>
|
|
/// <returns>A management response containing status and data.</returns>
|
|
public async Task<ManagementResponse> SendPostAsync(string relativePath, string? body, TimeSpan timeout)
|
|
{
|
|
using var cts = new CancellationTokenSource(timeout);
|
|
|
|
var content = new StringContent(body ?? "{}", Encoding.UTF8, "application/json");
|
|
|
|
HttpResponseMessage httpResponse;
|
|
try
|
|
{
|
|
httpResponse = await _httpClient.PostAsync(relativePath, content, cts.Token);
|
|
}
|
|
catch (TaskCanceledException)
|
|
{
|
|
return new ManagementResponse(504, null, "Request timed out.", "TIMEOUT");
|
|
}
|
|
catch (HttpRequestException ex)
|
|
{
|
|
return new ManagementResponse(0, null, $"Connection failed: {ex.Message}", "CONNECTION_FAILED");
|
|
}
|
|
|
|
var responseBody = await httpResponse.Content.ReadAsStringAsync(cts.Token);
|
|
|
|
if (httpResponse.IsSuccessStatusCode)
|
|
{
|
|
return new ManagementResponse((int)httpResponse.StatusCode, responseBody, null, null);
|
|
}
|
|
|
|
string? error = null;
|
|
string? code = null;
|
|
try
|
|
{
|
|
using var doc = JsonDocument.Parse(responseBody);
|
|
error = doc.RootElement.TryGetProperty("error", out var e) ? e.GetString() : responseBody;
|
|
code = doc.RootElement.TryGetProperty("code", out var c) ? c.GetString() : null;
|
|
}
|
|
catch
|
|
{
|
|
error = responseBody;
|
|
}
|
|
|
|
return new ManagementResponse((int)httpResponse.StatusCode, null, error, code);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Issues a plain HTTP <c>GET</c> and returns the raw <see cref="HttpResponseMessage"/>
|
|
/// so the caller can stream the response body without buffering it in memory — used
|
|
/// by <c>audit export</c>, where the response can be many megabytes. The caller owns
|
|
/// disposing the returned message. The <see cref="HttpCompletionOption.ResponseHeadersRead"/>
|
|
/// option ensures the body is not pre-buffered.
|
|
/// </summary>
|
|
/// <param name="relativePath">Path relative to the base URL, with query string.</param>
|
|
/// <param name="cancellationToken">A cancellation token that can be used to cancel the operation.</param>
|
|
/// <returns>The raw HTTP response message for streaming.</returns>
|
|
public async Task<HttpResponseMessage> SendGetStreamAsync(string relativePath, CancellationToken cancellationToken)
|
|
=> await _httpClient.GetAsync(relativePath, HttpCompletionOption.ResponseHeadersRead, cancellationToken);
|
|
|
|
/// <summary>
|
|
/// Disposes the underlying HTTP client.
|
|
/// </summary>
|
|
public void Dispose() => _httpClient.Dispose();
|
|
}
|
|
|
|
public record ManagementResponse(int StatusCode, string? JsonData, string? Error, string? ErrorCode);
|