fix(admin-ui): isolate UNS callers and recover confirmed-write refreshes

This commit is contained in:
Joseph Doherty
2026-11-14 01:14:15 -05:00
parent 575f81abe4
commit aa919ceef2
44 changed files with 1937 additions and 87 deletions
@@ -76,6 +76,22 @@ public sealed class TreeRecoveryTests:BunitContext
cut.FindAll("button").Single(b=>b.TextContent=="Clear filter").Click();
cut.Find("input").GetAttribute("value").ShouldBeNullOrEmpty();cut.Markup.ShouldContain("Press 1");reads.Calls.ShouldBe(1);reads.OtherCalls.ShouldBe(0);
}
[Theory]
[InlineData(true)]
[InlineData(false)]
public async Task ViewReadLifetime_DisposalIsIdempotent(bool raw)
{
if(raw)
{
Services.AddSingleton(DispatchProxy.Create<IRawTreeService,TreeReads>());var cut=Render<RawPage>();
await cut.InvokeAsync(()=>{cut.Instance.Dispose();cut.Instance.Dispose();});
}
else
{
Services.AddSingleton(DispatchProxy.Create<IUnsTreeService,TreeReads>());var cut=Render<UnsPage>();
await cut.InvokeAsync(()=>{cut.Instance.Dispose();cut.Instance.Dispose();});
}
}
public class TreeReads:DispatchProxy
{
public bool Fail=true;public IReadOnlyList<UnsNode> UnsRoots=[];public int Calls,OtherCalls;public CancellationToken Token;public TaskCompletionSource<IReadOnlyList<RawNode>>? Hold;
@@ -0,0 +1,188 @@
using System.Reflection;
using Bunit;
using Bunit.TestDoubles;
using Microsoft.Extensions.DependencyInjection;
using Shouldly;
using Xunit;
using ZB.MOM.WW.OtOpcUa.AdminUI.Components.Shared.Uns;
using ZB.MOM.WW.OtOpcUa.AdminUI.Uns;
using UnsPage=ZB.MOM.WW.OtOpcUa.AdminUI.Components.Pages.Uns.GlobalUns;
namespace ZB.MOM.WW.OtOpcUa.AdminUI.Tests.Pages;
[Trait("Category","Unit")]
public sealed class UnsCallerPresentationTests:BunitContext
{
private readonly IUnsTreeService _service;
private Calls Service=>(Calls)(object)_service;
private static UnsNode Cluster(string id)=>new(){Kind=UnsNodeKind.Cluster,Key="cluster:"+id,EntityId=id,ClusterId=id,DisplayName=id};
private static UnsNode Area(string id)=>new(){Kind=UnsNodeKind.Area,Key="area:"+id,EntityId=id,ClusterId="cluster",DisplayName=id};
public UnsCallerPresentationTests()
{
JSInterop.Mode=JSRuntimeMode.Loose;JSInterop.Setup<bool>("otDialog.activate",_=>true).SetResult(true);ComponentFactories.AddStub(t=>new[]{"AreaModal","LineModal","ImportEquipmentModal"}.Contains(t.Name));AddAuthorization().SetAuthorized("fixture");
_service=DispatchProxy.Create<IUnsTreeService,Calls>();Services.AddSingleton(_service);
}
private static async Task Call(IRenderedComponent<UnsPage> cut,string method,params object[] args)
{
await cut.InvokeAsync(async()=>{var result=typeof(UnsPage).GetMethod(method,BindingFlags.Instance|BindingFlags.NonPublic)!.Invoke(cut.Instance,args);if(result is Task task)await task;});
cut.Render(); // Simulate the render normally supplied by the parent event callback.
}
[Fact]
public async Task DeferredEditLoad_CannotOpenOverReplacementImport()
{
var pending=new TaskCompletionSource<AreaEditDto?>(TaskCreationOptions.RunContinuationsAsynchronously);Service.AreaRead=_=>pending.Task;var cut=Render<UnsPage>();
var edit=Call(cut,"HandleEdit",Area("a"));cut.WaitForAssertion(()=>Service.AreaReads.Count.ShouldBe(1));await Call(cut,"OpenImportModal");
pending.SetResult(new("a","Area A",null,"cluster",[1]));await edit;
cut.FindComponent<Stub<AreaModal>>().Instance.Parameters.Get(x=>x.Visible).ShouldBeFalse();cut.FindComponent<Stub<ImportEquipmentModal>>().Instance.Parameters.Get(x=>x.Visible).ShouldBeTrue();
}
[Fact]
public async Task SavedA_RefreshCompletionCannotCloseReplacementImportB()
{
var cut=Render<UnsPage>();await Call(cut,"HandleAddChild",Cluster("a"));var callback=cut.FindComponent<Stub<AreaModal>>().Instance.Parameters.Get(x=>x.OnSaved);
var pending=new TaskCompletionSource<IReadOnlyList<UnsNode>>(TaskCreationOptions.RunContinuationsAsynchronously);Service.RootRead=()=>pending.Task;
var saved=cut.InvokeAsync(()=>callback.InvokeAsync());cut.WaitForAssertion(()=>Service.RootReads.ShouldBe(2));await Call(cut,"OpenImportModal");
pending.SetResult([]);await saved;cut.FindComponent<Stub<ImportEquipmentModal>>().Instance.Parameters.Get(x=>x.Visible).ShouldBeTrue();
}
[Fact]
public async Task ReplacedDelete_DoesNotDispatchAfterItsPrerequisiteReadReturns()
{
var pending=new TaskCompletionSource<AreaEditDto?>(TaskCreationOptions.RunContinuationsAsynchronously);Service.AreaRead=_=>pending.Task;var cut=Render<UnsPage>();await Call(cut,"HandleDelete",Area("a"));
var deleting=cut.Find("button.btn-danger").ClickAsync(new());cut.WaitForAssertion(()=>Service.AreaReads.Count.ShouldBe(1));await Call(cut,"HandleDelete",Cluster("b"));
pending.SetResult(new("a","Area A",null,"cluster",[1]));await deleting;Service.Deletes.ShouldBeEmpty();
}
[Fact]
public async Task DispatchedDeleteA_CannotPutFailureOnReplacementB()
{
var pending=new TaskCompletionSource<UnsMutationResult>(TaskCreationOptions.RunContinuationsAsynchronously);Service.ClusterDelete=_=>pending.Task;var cut=Render<UnsPage>();await Call(cut,"HandleDelete",Cluster("a"));
var deleting=cut.Find("button.btn-danger").ClickAsync(new());cut.WaitForAssertion(()=>Service.Deletes.ShouldBe(new[]{"a"}));await Call(cut,"HandleDelete",Cluster("b"));
pending.SetResult(new(false,"Failure belonging only to A"));await deleting;cut.Markup.ShouldNotContain("Failure belonging only to A");cut.Markup.ShouldContain("b");
}
[Fact]
public async Task OutOfOrderSavedRefreshes_PreserveTheLatestStructure()
{
var cut=Render<UnsPage>();await Call(cut,"HandleAddChild",Cluster("a"));var first=cut.FindComponent<Stub<AreaModal>>().Instance.Parameters.Get(x=>x.OnSaved);
var a=new TaskCompletionSource<IReadOnlyList<UnsNode>>(TaskCreationOptions.RunContinuationsAsynchronously);var b=new TaskCompletionSource<IReadOnlyList<UnsNode>>(TaskCreationOptions.RunContinuationsAsynchronously);Service.RootRead=()=>Service.RootReads==2?a.Task:b.Task;
var saveA=cut.InvokeAsync(()=>first.InvokeAsync());cut.WaitForAssertion(()=>Service.RootReads.ShouldBe(2));await Call(cut,"HandleAddChild",Cluster("b"));var second=cut.FindComponent<Stub<AreaModal>>().Instance.Parameters.Get(x=>x.OnSaved);
var saveB=cut.InvokeAsync(()=>second.InvokeAsync());cut.WaitForAssertion(()=>Service.RootReads.ShouldBe(3));b.SetResult([Cluster("Latest structure B")]);await saveB;a.SetResult([Cluster("Retired structure A")]);await saveA;
cut.Markup.ShouldContain("Latest structure B");cut.Markup.ShouldNotContain("Retired structure A");
}
[Fact]
public async Task DisposalDuringEditRead_DoesNotOpenALateModal()
{
var pending=new TaskCompletionSource<AreaEditDto?>(TaskCreationOptions.RunContinuationsAsynchronously);Service.AreaRead=_=>pending.Task;var cut=Render<UnsPage>();var edit=Call(cut,"HandleEdit",Area("a"));
cut.WaitForAssertion(()=>Service.AreaReads.Count.ShouldBe(1));await cut.InvokeAsync(cut.Instance.Dispose);pending.SetResult(new("a","A",null,"cluster",[1]));await edit;
cut.FindComponent<Stub<AreaModal>>().Instance.Parameters.Get(x=>x.Visible).ShouldBeFalse();
}
[Fact]
public async Task CurrentDelete_IsSingleFlightAndFailureStaysOnItsNamedDialog()
{
var pending=new TaskCompletionSource<UnsMutationResult>(TaskCreationOptions.RunContinuationsAsynchronously);Service.ClusterDelete=_=>pending.Task;
var cut=Render<UnsPage>();await Call(cut,"HandleDelete",Cluster("a"));var button=cut.Find("button.btn-danger");var deleting=button.ClickAsync(new());
cut.WaitForAssertion(()=>Service.Deletes.ShouldBe(new[]{"a"}));await button.ClickAsync(new());Service.Deletes.ShouldBe(new[]{"a"});
pending.SetResult(new(false,"Current blocker <script>ignored()</script>"));await deleting;
cut.Find("[role=dialog]").GetAttribute("aria-labelledby").ShouldNotBeNullOrWhiteSpace();cut.Find("[role=alert]").TextContent.ShouldContain("Current blocker <script>ignored()</script>");cut.FindAll("script").ShouldBeEmpty();
}
[Fact]
public async Task RetiredSavedEntry_DoesNotStartANewReadForReplacement()
{
var cut=Render<UnsPage>();await Call(cut,"HandleAddChild",Cluster("a"));var action=cut.FindComponent<Stub<AreaModal>>().Instance.Parameters.Get(x=>x.OnSaved);
await Call(cut,"OpenImportModal");await cut.InvokeAsync(()=>action.InvokeAsync());Service.RootReads.ShouldBe(1);cut.FindComponent<Stub<ImportEquipmentModal>>().Instance.Parameters.Get(x=>x.Visible).ShouldBeTrue();
}
[Fact]
public async Task DeferredLineEdit_AlsoCannotOpenAfterReplacement()
{
var pending=new TaskCompletionSource<LineEditDto?>(TaskCreationOptions.RunContinuationsAsynchronously);Service.LineRead=_=>pending.Task;
var cut=Render<UnsPage>();var node=new UnsNode{Kind=UnsNodeKind.Line,Key="line:a",EntityId="line-a",ClusterId="cluster",DisplayName="Line A"};
var edit=Call(cut,"HandleEdit",node);cut.WaitForAssertion(()=>Service.LineReads.Count.ShouldBe(1));await Call(cut,"OpenImportModal");pending.SetResult(new("line-a","area-a","Line A",null,[2]));await edit;
cut.FindComponent<Stub<LineModal>>().Instance.Parameters.Get(x=>x.Visible).ShouldBeFalse();cut.FindComponent<Stub<ImportEquipmentModal>>().Instance.Parameters.Get(x=>x.Visible).ShouldBeTrue();
}
public class Calls:DispatchProxy
{
public int RootReads;public List<string> AreaReads=[],LineReads=[],Deletes=[],Writes=[];public Func<Task<IReadOnlyList<UnsNode>>>? RootRead;public Func<string,Task<AreaEditDto?>>? AreaRead;public Func<string,Task<LineEditDto?>>? LineRead;public Func<string,Task<UnsMutationResult>>? ClusterDelete;
protected override object? Invoke(MethodInfo? m,object?[]? a)
{
switch(m?.Name)
{
case "LoadStructureAsync":RootReads++;return RootRead?.Invoke()??Task.FromResult<IReadOnlyList<UnsNode>>([]);
case "LoadAreaAsync":var area=(string)a![0]!;AreaReads.Add(area);return AreaRead?.Invoke(area)??Task.FromResult<AreaEditDto?>(new(area,area,null,"cluster",[1]));
case "UpdateAreaAsync":Writes.Add((string)a![0]!);return Task.FromResult(new UnsMutationResult(true,null));
case "LoadLineAsync":var line=(string)a![0]!;LineReads.Add(line);return LineRead?.Invoke(line)??Task.FromResult<LineEditDto?>(new(line,"area",line,null,[2]));
case "DeleteAreaAsync":Deletes.Add((string)a![0]!);return Task.FromResult(new UnsMutationResult(true,null));
case "DeleteClusterAsync":var cluster=(string)a![0]!;Deletes.Add(cluster);return ClusterDelete?.Invoke(cluster)??Task.FromResult(new UnsMutationResult(true,null));
default:throw new InvalidOperationException("Unexpected UNS caller operation: "+m?.Name);
}
}
}
}
/// <summary>A confirmed write is never presented as a failed write because a later view read failed.</summary>
[Trait("Category","Unit")]
public sealed class UnsPostCommitRecoveryTests:BunitContext
{
private readonly IUnsTreeService _service;
private UnsCallerPresentationTests.Calls Service=>(UnsCallerPresentationTests.Calls)(object)_service;
public UnsPostCommitRecoveryTests()
{
JSInterop.Mode=JSRuntimeMode.Loose;JSInterop.Setup<bool>("otDialog.activate",_=>true).SetResult(true);
ComponentFactories.AddStub<ImportEquipmentModal>();AddAuthorization().SetAuthorized("fixture");
_service=DispatchProxy.Create<IUnsTreeService,UnsCallerPresentationTests.Calls>();Services.AddSingleton(_service);
Service.RootRead=()=>Service.RootReads==1?Task.FromResult(Roots()):Task.FromException<IReadOnlyList<UnsNode>>(new IOException("Synthetic refresh failure after confirmed write"));
}
private static IReadOnlyList<UnsNode> Roots()
{
var a=new UnsNode{Kind=UnsNodeKind.Area,Key="a",EntityId="a",ClusterId="cluster",DisplayName="a"};
var c=new UnsNode{Kind=UnsNodeKind.Cluster,Key="cluster",EntityId="cluster",ClusterId="cluster",DisplayName="cluster",Expanded=true};c.Children.Add(a);
var e=new UnsNode{Kind=UnsNodeKind.Enterprise,Key="enterprise",DisplayName="Last loaded enterprise",Expanded=true};e.Children.Add(c);return[e];
}
[Fact]
public void SuccessfulAreaWrite_FailedRefreshClosesOnlyOriginAndRetriesOnlyTheRead()
{
var cut=Render<UnsPage>();cut.Find("button[aria-label='Edit a']").Click();cut.Find("form").Submit();
cut.WaitForAssertion(()=>Service.Writes.ShouldBe(new[]{"a"}));cut.FindAll("[role=dialog]").ShouldBeEmpty();
cut.Find("[data-testid=uns-refresh-outcome]").TextContent.ShouldContain("Saved");cut.Find("[data-testid=uns-refresh-outcome]").TextContent.ShouldContain("refresh failed");cut.Markup.ShouldContain("Last loaded enterprise");
Service.RootRead=()=>Task.FromResult(Roots());cut.Find("button[data-testid=tree-retry]").Click();
cut.WaitForAssertion(()=>cut.Find("[data-testid=uns-refresh-outcome]").TextContent.ShouldContain("Structure refreshed"));Service.Writes.ShouldBe(new[]{"a"});Service.RootReads.ShouldBe(3);
}
[Fact]
public void SuccessfulDelete_FailedRefreshDoesNotReplayDeletionOrLoseLastLoadedStructure()
{
var cut=Render<UnsPage>();cut.Find("button[aria-label='Delete cluster']").Click();cut.Find("button.btn-danger").Click();
cut.WaitForAssertion(()=>Service.Deletes.ShouldBe(new[]{"cluster"}));cut.FindAll("[role=dialog]").ShouldBeEmpty();
cut.Find("[data-testid=uns-refresh-outcome]").TextContent.ShouldContain("Deleted");cut.Markup.ShouldContain("Last loaded enterprise");
Service.RootRead=()=>Task.FromResult<IReadOnlyList<UnsNode>>([]);cut.Find("button[data-testid=tree-retry]").Click();
cut.WaitForAssertion(()=>cut.Markup.ShouldContain("No clusters yet."));Service.Deletes.ShouldBe(new[]{"cluster"});Service.RootReads.ShouldBe(3);
}
}
[Trait("Category","Unit")]
public sealed class UnsRecoveryReadOwnershipTests:BunitContext
{
[Theory]
[InlineData(false)]
[InlineData(true)]
public async Task PostCommitReadRecovery_IsNotBlockedOrClearedByRetiredInitialRead(bool initialEndsDuringRetry)
{
JSInterop.Mode=JSRuntimeMode.Loose;ComponentFactories.AddStub<AreaModal>();ComponentFactories.AddStub<LineModal>();ComponentFactories.AddStub<ImportEquipmentModal>();AddAuthorization().SetAuthorized("fixture");
var proxy=DispatchProxy.Create<IUnsTreeService,UnsCallerPresentationTests.Calls>();var service=(UnsCallerPresentationTests.Calls)(object)proxy;Services.AddSingleton(proxy);
var initial=new TaskCompletionSource<IReadOnlyList<UnsNode>>(TaskCreationOptions.RunContinuationsAsynchronously);var retryRead=new TaskCompletionSource<IReadOnlyList<UnsNode>>(TaskCreationOptions.RunContinuationsAsynchronously);
service.RootRead=()=>service.RootReads switch {1=>initial.Task,2=>Task.FromException<IReadOnlyList<UnsNode>>(new IOException("Post-import refresh failed")),_=>retryRead.Task};
var cut=Render<UnsPage>();
try
{
cut.WaitForAssertion(()=>service.RootReads.ShouldBe(1));await cut.InvokeAsync(()=>typeof(UnsPage).GetMethod("OpenImportModal",BindingFlags.Instance|BindingFlags.NonPublic)!.Invoke(cut.Instance,null));cut.Render();
await cut.InvokeAsync(()=>cut.FindComponent<Stub<ImportEquipmentModal>>().Instance.Parameters.Get(x=>x.OnImported).InvokeAsync());service.RootReads.ShouldBe(2);
var retry=cut.Find("button[data-testid=tree-retry]").ClickAsync(new());cut.WaitForAssertion(()=>service.RootReads.ShouldBe(3));
if(initialEndsDuringRetry)
{
cut.WaitForAssertion(()=>cut.FindAll("[role=status]").Any(x=>x.TextContent.Contains("Loading UNS tree")).ShouldBeTrue());var render=cut.RenderCount;
initial.SetResult([]);cut.WaitForAssertion(()=>cut.RenderCount.ShouldBeGreaterThan(render));
cut.Markup.ShouldNotContain("No clusters yet.");cut.FindAll("[role=status]").Any(x=>x.TextContent.Contains("Loading UNS tree")).ShouldBeTrue();
}
retryRead.SetResult([new(){Kind=UnsNodeKind.Enterprise,Key="fresh",DisplayName="Fresh recovered structure"}]);await retry;
if(!initialEndsDuringRetry){initial.SetResult([]);await cut.InvokeAsync(()=>Task.CompletedTask);}
cut.Markup.ShouldContain("Fresh recovered structure");cut.Markup.ShouldNotContain("No clusters yet.");service.RootReads.ShouldBe(3);
}
finally
{
initial.TrySetResult([]);retryRead.TrySetResult([]);await cut.InvokeAsync(()=>Task.CompletedTask);
}
}
}