feat(central): one central cache-invalidation topic; role-mapping and external-definition caches follow peer edits (ScadaBridge#100 item 3, ScadaBridge#83)
The #96 site-psk-invalidation topic was the first cross-node invalidation broadcast. It is generalised into ONE central DistributedPubSub topic, central-cache-invalidation, carrying typed messages (Commons ICentralCacheInvalidation: SitePskInvalidated, RoleMappingsInvalidated, ExternalDefinitionsInvalidated, InboundApiMethodInvalidated) in an envelope stamped with the publisher's process-unique origin id. - Host: CentralCacheInvalidationBus (ICentralCacheInvalidationPublisher, no-op until the mediator is set, never throws) and CentralCacheInvalidationSubscriber, which skips its own node's envelopes and hands the peer's to every registered ICentralCacheInvalidationHandler (a failing handler does not stop the rest). Replaces SitePskInvalidationSubscriber. - Migration of #96: SitePskRotationInvalidator publishes through the bus and is the PSK handler; SitePskInvalidated keeps its type name and is also published bare on site-psk-invalidation, which the subscriber still listens to, so a mixed-version central pair keeps exchanging PSK invalidations. Remove after one release. - Audit D1: RoleMappingCache is a handler; ManagementActor's post-commit role-mapping invalidation also publishes RoleMappingsInvalidated, so a revocation is immediate on the peer instead of after RoleMappingCacheSeconds. - Audit D3 / #83 (peer half): ExternalDefinitionLookupCache is a handler; the 9 ManagementActor handlers and the Transport bundle importer publish ExternalDefinitionsInvalidated after commit. (#83's local import half was already in.) TTLs remain the fallback for a lost broadcast or a direct SQL edit. Tests: bus and subscriber unit tests (origin filter, legacy topic), peer-node tests through the real caches in ManagementService.Tests, importer publish, composition root, and a real two-node cluster from the production HOCON (CentralCacheInvalidationTwoNodeTests) proving every message type crosses with the production serializer. Docs: Host, Communication, Security, ManagementService, ESG, and the #85 cache audit. Claude-Session: https://claude.ai/code/session_01GT67AEHd2Acv1YPwGfXEoV
This commit is contained in:
Joseph Doherty
@@ -0,0 +1,80 @@
|
||||
using Akka.Actor;
|
||||
using Akka.Cluster.Tools.PublishSubscribe;
|
||||
using Akka.TestKit.Xunit2;
|
||||
using Microsoft.Extensions.Logging.Abstractions;
|
||||
using ZB.MOM.WW.ScadaBridge.Commons.Interfaces.Services;
|
||||
using ZB.MOM.WW.ScadaBridge.Commons.Messages.Communication;
|
||||
|
||||
namespace ZB.MOM.WW.ScadaBridge.Host.Tests;
|
||||
|
||||
/// <summary>
|
||||
/// ScadaBridge#100 item 3: the central cache-invalidation bus publishes typed invalidations on
|
||||
/// one topic, and the subscriber hands the peer's (never its own) to every handler.
|
||||
/// </summary>
|
||||
public class CentralCacheInvalidationBusTests : TestKit
|
||||
{
|
||||
private sealed class RecordingHandler : ICentralCacheInvalidationHandler
|
||||
{
|
||||
public List<ICentralCacheInvalidation> Applied { get; } = new();
|
||||
|
||||
public void Apply(ICentralCacheInvalidation invalidation)
|
||||
{
|
||||
lock (Applied) Applied.Add(invalidation);
|
||||
}
|
||||
}
|
||||
|
||||
private sealed class ThrowingHandler : ICentralCacheInvalidationHandler
|
||||
{
|
||||
public void Apply(ICentralCacheInvalidation invalidation) => throw new InvalidOperationException("boom");
|
||||
}
|
||||
|
||||
private readonly CentralCacheInvalidationBus _bus = new(NullLogger<CentralCacheInvalidationBus>.Instance);
|
||||
|
||||
/// <summary>Publishing wraps the invalidation with this node's origin id on the shared topic.</summary>
|
||||
[Fact]
|
||||
public void Publish_SendsAnEnvelopeOnTheSharedTopic()
|
||||
{
|
||||
var mediator = CreateTestProbe();
|
||||
_bus.SetMediator(mediator.Ref);
|
||||
|
||||
_bus.Publish(new RoleMappingsInvalidated());
|
||||
|
||||
var publish = mediator.ExpectMsg<Publish>();
|
||||
Assert.Equal("central-cache-invalidation", publish.Topic);
|
||||
var envelope = Assert.IsType<CentralCacheInvalidationEnvelope>(publish.Message);
|
||||
Assert.Equal(_bus.OriginId, envelope.OriginId);
|
||||
Assert.IsType<RoleMappingsInvalidated>(envelope.Invalidation);
|
||||
mediator.ExpectNoMsg(TimeSpan.FromMilliseconds(100)); // only PSK also uses the legacy topic
|
||||
}
|
||||
|
||||
/// <summary>Before the mediator exists publishing is a silent no-op.</summary>
|
||||
[Fact]
|
||||
public void Publish_WithoutAMediator_DoesNotThrow()
|
||||
{
|
||||
_bus.Publish(new ExternalDefinitionsInvalidated());
|
||||
}
|
||||
|
||||
/// <summary>The peer's invalidation reaches every handler; this node's own broadcast is skipped.</summary>
|
||||
[Fact]
|
||||
public void Subscriber_AppliesPeerInvalidations_AndSkipsItsOwn()
|
||||
{
|
||||
var handler = new RecordingHandler();
|
||||
var subscriber = Sys.ActorOf(Props.Create(() => new CentralCacheInvalidationSubscriber(
|
||||
_bus, new ICentralCacheInvalidationHandler[] { new ThrowingHandler(), handler })));
|
||||
|
||||
subscriber.Tell(new CentralCacheInvalidationEnvelope(_bus.OriginId, new RoleMappingsInvalidated()));
|
||||
subscriber.Tell(new CentralCacheInvalidationEnvelope("peer", new ExternalDefinitionsInvalidated()));
|
||||
subscriber.Tell(new CentralCacheInvalidationEnvelope("peer", new InboundApiMethodInvalidated("M")));
|
||||
|
||||
AwaitAssert(() =>
|
||||
{
|
||||
lock (handler.Applied)
|
||||
{
|
||||
// A throwing handler ahead of it does not stop delivery.
|
||||
Assert.Equal(
|
||||
new ICentralCacheInvalidation[] { new ExternalDefinitionsInvalidated(), new InboundApiMethodInvalidated("M") },
|
||||
handler.Applied);
|
||||
}
|
||||
});
|
||||
}
|
||||
}
|
||||
@@ -419,6 +419,26 @@ public class CentralCompositionRootTests : IDisposable
|
||||
_factory.Services.GetService<ZB.MOM.WW.Secrets.Abstractions.ISecretCacheInvalidator>());
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// ScadaBridge#100 item 3: central publishes peer invalidations through the shared bus, and
|
||||
/// every cache that takes part (site PSK, role mappings, external definitions) is registered
|
||||
/// as a handler for the subscriber.
|
||||
/// </summary>
|
||||
[Fact]
|
||||
public void Central_CacheInvalidation_BusAndHandlersAreRegistered()
|
||||
{
|
||||
Assert.IsType<CentralCacheInvalidationBus>(
|
||||
_factory.Services.GetService<ZB.MOM.WW.ScadaBridge.Commons.Interfaces.Services.ICentralCacheInvalidationPublisher>());
|
||||
var handlers = _factory.Services
|
||||
.GetServices<ZB.MOM.WW.ScadaBridge.Commons.Interfaces.Services.ICentralCacheInvalidationHandler>()
|
||||
.Select(h => h.GetType())
|
||||
.ToList();
|
||||
Assert.Contains(typeof(SitePskRotationInvalidator), handlers);
|
||||
Assert.Contains(typeof(ZB.MOM.WW.ScadaBridge.Security.RoleMappingCache), handlers);
|
||||
Assert.Contains(typeof(ZB.MOM.WW.ScadaBridge.ExternalSystemGateway.ExternalDefinitionLookupCache), handlers);
|
||||
Assert.Equal(handlers.Count, handlers.Distinct().Count());
|
||||
}
|
||||
|
||||
/// <summary>Verifies that the shared audit seam resolves to the central direct-write bridge.</summary>
|
||||
[Fact]
|
||||
public void Central_SharedAuditSeam_IsTheCentralDirectWriteBridge()
|
||||
|
||||
@@ -3,6 +3,8 @@ using Akka.Cluster.Tools.PublishSubscribe;
|
||||
using Akka.TestKit.Xunit2;
|
||||
using Microsoft.Extensions.Logging.Abstractions;
|
||||
using NSubstitute;
|
||||
using ZB.MOM.WW.ScadaBridge.Commons.Interfaces.Services;
|
||||
using ZB.MOM.WW.ScadaBridge.Commons.Messages.Communication;
|
||||
using ZB.MOM.WW.ScadaBridge.Communication.Grpc;
|
||||
using ZB.MOM.WW.Secrets.Abstractions;
|
||||
|
||||
@@ -10,35 +12,43 @@ namespace ZB.MOM.WW.ScadaBridge.Host.Tests;
|
||||
|
||||
/// <summary>
|
||||
/// Gitea #96: an in-place rotation of <c>SB-GRPC-PSK-{siteId}</c> written through the secrets
|
||||
/// write path must drop central's cached key on this node and on the peer central node.
|
||||
/// write path must drop central's cached key on this node and on the peer central node. Since
|
||||
/// ScadaBridge#100 item 3 the peer is told over the shared central cache-invalidation topic.
|
||||
/// </summary>
|
||||
public class SitePskRotationInvalidatorTests : TestKit
|
||||
{
|
||||
private readonly ISecretCacheInvalidator _inner = Substitute.For<ISecretCacheInvalidator>();
|
||||
private readonly ISitePskProvider _psk = Substitute.For<ISitePskProvider>();
|
||||
private readonly CentralCacheInvalidationBus _bus = new(NullLogger<CentralCacheInvalidationBus>.Instance);
|
||||
|
||||
private SitePskRotationInvalidator Create() =>
|
||||
new(_inner, _psk, NullLogger<SitePskRotationInvalidator>.Instance);
|
||||
private SitePskRotationInvalidator Create(ICentralCacheInvalidationPublisher? publisher) =>
|
||||
new(_inner, _psk, publisher, NullLogger<SitePskRotationInvalidator>.Instance);
|
||||
|
||||
/// <summary>
|
||||
/// Verifies that writing a site's PSK secret evicts the resolver cache, drops the site's
|
||||
/// cached key and publishes the invalidation to the peer.
|
||||
/// cached key and publishes the invalidation on the shared topic and, for a mixed-version
|
||||
/// peer, bare on the legacy #96 topic.
|
||||
/// </summary>
|
||||
[Fact]
|
||||
public void WritingAPskSecret_DropsTheCachedKey_AndTellsThePeer()
|
||||
{
|
||||
var mediator = CreateTestProbe();
|
||||
var invalidator = Create();
|
||||
invalidator.SetMediator(mediator.Ref);
|
||||
_bus.SetMediator(mediator.Ref);
|
||||
var invalidator = Create(_bus);
|
||||
|
||||
// The secrets library lowercases names, so the site id arrives lowercased too.
|
||||
invalidator.Invalidate(new SecretName("SB-GRPC-PSK-site-a"));
|
||||
|
||||
_inner.Received(1).Invalidate(new SecretName("SB-GRPC-PSK-site-a"));
|
||||
_psk.Received(1).Invalidate("site-a");
|
||||
var publish = mediator.ExpectMsg<Publish>();
|
||||
Assert.Equal(SitePskRotationInvalidator.Topic, publish.Topic);
|
||||
Assert.Equal(new SitePskInvalidated("site-a"), publish.Message);
|
||||
var shared = mediator.ExpectMsg<Publish>();
|
||||
Assert.Equal(CentralCacheInvalidationBus.Topic, shared.Topic);
|
||||
var envelope = Assert.IsType<CentralCacheInvalidationEnvelope>(shared.Message);
|
||||
Assert.Equal(new SitePskInvalidated("site-a"), envelope.Invalidation);
|
||||
Assert.Equal(_bus.OriginId, envelope.OriginId);
|
||||
var legacy = mediator.ExpectMsg<Publish>();
|
||||
Assert.Equal("site-psk-invalidation", legacy.Topic);
|
||||
Assert.Equal(new SitePskInvalidated("site-a"), legacy.Message);
|
||||
}
|
||||
|
||||
/// <summary>Negative control: any other secret only evicts the resolver cache.</summary>
|
||||
@@ -46,8 +56,8 @@ public class SitePskRotationInvalidatorTests : TestKit
|
||||
public void WritingAnyOtherSecret_OnlyEvictsTheResolverCache()
|
||||
{
|
||||
var mediator = CreateTestProbe();
|
||||
var invalidator = Create();
|
||||
invalidator.SetMediator(mediator.Ref);
|
||||
_bus.SetMediator(mediator.Ref);
|
||||
var invalidator = Create(_bus);
|
||||
|
||||
invalidator.Invalidate(new SecretName("SMTP-PASSWORD"));
|
||||
|
||||
@@ -56,13 +66,15 @@ public class SitePskRotationInvalidatorTests : TestKit
|
||||
mediator.ExpectNoMsg(TimeSpan.FromMilliseconds(200));
|
||||
}
|
||||
|
||||
/// <summary>Verifies that before the actor system exists an invalidation still applies locally.</summary>
|
||||
/// <summary>Verifies that without a publisher (or before the actor system exists) an invalidation still applies locally.</summary>
|
||||
[Fact]
|
||||
public void WithoutAMediator_TheLocalInvalidationStillApplies()
|
||||
public void WithoutAPublisher_TheLocalInvalidationStillApplies()
|
||||
{
|
||||
Create().Invalidate(new SecretName("SB-GRPC-PSK-site-a"));
|
||||
Create(null).Invalidate(new SecretName("SB-GRPC-PSK-site-a"));
|
||||
Create(_bus).Invalidate(new SecretName("SB-GRPC-PSK-site-b")); // bus has no mediator yet
|
||||
|
||||
_psk.Received(1).Invalidate("site-a");
|
||||
_psk.Received(1).Invalidate("site-b");
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
@@ -73,11 +85,12 @@ public class SitePskRotationInvalidatorTests : TestKit
|
||||
public void Subscriber_AppliesAPeerInvalidation_WithoutRepublishing()
|
||||
{
|
||||
var mediator = CreateTestProbe();
|
||||
var invalidator = Create();
|
||||
invalidator.SetMediator(mediator.Ref);
|
||||
var subscriber = Sys.ActorOf(Props.Create(() => new SitePskInvalidationSubscriber(invalidator)));
|
||||
_bus.SetMediator(mediator.Ref);
|
||||
var invalidator = Create(_bus);
|
||||
var subscriber = Sys.ActorOf(Props.Create(() => new CentralCacheInvalidationSubscriber(
|
||||
_bus, new ICentralCacheInvalidationHandler[] { invalidator })));
|
||||
|
||||
subscriber.Tell(new SitePskInvalidated("site-b"));
|
||||
subscriber.Tell(new CentralCacheInvalidationEnvelope("peer-node", new SitePskInvalidated("site-b")));
|
||||
|
||||
AwaitAssert(() =>
|
||||
{
|
||||
@@ -86,4 +99,20 @@ public class SitePskRotationInvalidatorTests : TestKit
|
||||
});
|
||||
mediator.ExpectNoMsg(TimeSpan.FromMilliseconds(200));
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Migration: a bare <see cref="SitePskInvalidated"/> from a peer still on the #96 topic is
|
||||
/// applied too.
|
||||
/// </summary>
|
||||
[Fact]
|
||||
public void Subscriber_AppliesALegacyBarePskInvalidation()
|
||||
{
|
||||
var invalidator = Create(_bus);
|
||||
var subscriber = Sys.ActorOf(Props.Create(() => new CentralCacheInvalidationSubscriber(
|
||||
_bus, new ICentralCacheInvalidationHandler[] { invalidator })));
|
||||
|
||||
subscriber.Tell(new SitePskInvalidated("site-c"));
|
||||
|
||||
AwaitAssert(() => _psk.Received(1).Invalidate("site-c"));
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user