Joseph Doherty
0c2e852a62
(a) Inbound API compile state (#75) is per central node: a recompile cleared the known-bad record only on the node that answered, and the peer kept refusing the unchanged script with SCRIPT_COMPILE_FAILED (the per-request revision check only notices a changed script). Create / update / delete (ManagementActor post-commit), RecompileApiMethod, and API methods written by a Transport bundle import now publish InboundApiMethodInvalidated on the central cache-invalidation topic (#100 item 3). The new InboundApiCacheInvalidationHandler drops that method's compiled handler, known-bad record and cached ApiMethod row on the peer, which compiles the current text on its next request. (b) docs/components/InboundAPI.md no longer claims a direct DB edit stays stale until restart: the per-request revision check picks it up once the node's cached row expires (ApiMethodCacheTtl, 5 s). Component-InboundAPI, Component-Host and the #85 cache audit describe the peer invalidation. (c) Decision: the import's locked-override warnings keep EXACT (ordinal) name matching, because FlatteningService matches override names ordinally. An override differing from a locked member only by case never reaches that member's lock check (the flattener drops it as unresolved), so a "targets a LOCKED member" warning for it would be false. The comparer is now named (LockedOverrideNameComparer) and documented, and pinned by tests on both sides (flattener + import). Tests: the peer's known-bad record is cleared by a recompile (and validate leaves it alone); create/update/delete and the import publish the invalidation; the handler drops only the named method; composition root registers the handler; case-only override gets no lock warning; the flattener matches override names exactly. Claude-Session: https://claude.ai/code/session_01GT67AEHd2Acv1YPwGfXEoV
62 lines
3.4 KiB
C#
62 lines
3.4 KiB
C#
using Microsoft.Extensions.DependencyInjection;
|
|
using Microsoft.Extensions.DependencyInjection.Extensions;
|
|
using Microsoft.Extensions.Options;
|
|
using ZB.MOM.WW.ScadaBridge.Commons.Interfaces.Services;
|
|
|
|
namespace ZB.MOM.WW.ScadaBridge.InboundAPI;
|
|
|
|
public static class ServiceCollectionExtensions
|
|
{
|
|
/// <summary>
|
|
/// Registers all inbound API services (script executor, route helper, and endpoint filter).
|
|
/// </summary>
|
|
/// <param name="services">The service collection to register into.</param>
|
|
/// <returns>The same <see cref="IServiceCollection"/> to allow chaining.</returns>
|
|
public static IServiceCollection AddInboundAPI(this IServiceCollection services)
|
|
{
|
|
// Inbound authentication is handled by the shared
|
|
// ZB.MOM.WW.Auth.ApiKeys verifier (Bearer sbk_<keyId>_<secret>), registered by
|
|
// AddZbApiKeyAuth in the Host composition root. The legacy ApiKeyValidator +
|
|
// peppered IApiKeyHasher and the SQL Server ApiKey store were retired, so this
|
|
// extension no longer registers them.
|
|
services.AddSingleton<InboundScriptExecutor>();
|
|
services.AddScoped<RouteHelper>();
|
|
|
|
// Short-TTL cache of resolved ApiMethod rows, sitting in front of the
|
|
// per-request repository fetch in EndpointExtensions. Invalidated by name via
|
|
// ScriptArtifactChangeSubscriber (below) and self-heals via TTL expiry for
|
|
// changes the bus does not cover.
|
|
services.AddSingleton(sp => new ApiMethodCache(
|
|
sp.GetRequiredService<IOptions<InboundApiOptions>>().Value.ApiMethodCacheTtl));
|
|
|
|
// Routed calls go through the IInstanceRouter seam; the
|
|
// production implementation delegates to CommunicationService.
|
|
services.AddScoped<IInstanceRouter, CommunicationServiceInstanceRouter>();
|
|
|
|
// Endpoint filter enforcing the request
|
|
// body size cap and active-node gating for POST /api/{methodName}.
|
|
services.AddSingleton<InboundApiEndpointFilter>();
|
|
|
|
// Standby-node forwarding (2026-08-28): a standby relays POST /api/{methodName}
|
|
// to the active peer over HTTP instead of answering 503 STANDBY_NODE. The
|
|
// named client has no HttpClient.Timeout of its own — the forwarder's per-attempt
|
|
// CTS (InboundApiOptions.StandbyForwardTimeout) is the single deadline, so a
|
|
// long-running method on the active node is not cut off by a second, hidden cap.
|
|
services.AddHttpClient(HttpStandbyRequestForwarder.HttpClientName)
|
|
.ConfigureHttpClient(c => c.Timeout = Timeout.InfiniteTimeSpan);
|
|
services.AddSingleton<IStandbyRequestForwarder, HttpStandbyRequestForwarder>();
|
|
|
|
// N1: the ApiMethod consumer of the script-artifact invalidation bus.
|
|
// The bus parameter is optional — hosts without a registered
|
|
// IScriptArtifactChangeBus (site roles, plain test hosts) start it as a no-op
|
|
// and the executor's per-request revision check alone keeps handlers fresh.
|
|
services.AddHostedService<ScriptArtifactChangeSubscriber>();
|
|
|
|
// ScadaBridge#103: a create / update / delete / recompile made through the other central
|
|
// node drops this node's handler, known-bad record and cached row for the method.
|
|
services.TryAddEnumerable(ServiceDescriptor.Singleton<ICentralCacheInvalidationHandler, InboundApiCacheInvalidationHandler>());
|
|
|
|
return services;
|
|
}
|
|
}
|