Keep driver address builders inline within their owning dialog

This commit is contained in:
Joseph Doherty
2026-11-14 02:14:13 -05:00
parent cb26ed9179
commit c8edd65f3e
77 changed files with 29759 additions and 49 deletions
@@ -0,0 +1,117 @@
using System.Reflection;
using Bunit;
using Microsoft.AspNetCore.Components;
using Microsoft.AspNetCore.Components.Rendering;
using Microsoft.AspNetCore.Components.RenderTree;
using Microsoft.AspNetCore.Components.Web;
using Shouldly;
using Xunit;
using ZB.MOM.WW.OtOpcUa.AdminUI.Components.Shared.Drivers;
namespace ZB.MOM.WW.OtOpcUa.AdminUI.Tests.Pages;
[Trait("Category","Unit")]
public sealed class DriverTagPickerLifecycleTests:BunitContext
{
public DriverTagPickerLifecycleTests()=>JSInterop.Mode=JSRuntimeMode.Loose;
[Fact]
public void PickerIsNamedInlineGroupAndNeverASecondModal()
{
var cut=Render<DriverTagPicker>(p=>p.Add(x=>x.Visible,true).Add(x=>x.Title,"Modbus address builder").Add(x=>x.ChildContent,"<label for='choice'>Selection</label><input id='choice'/>") );
cut.FindAll("[role=dialog],.modal-backdrop,.modal").ShouldBeEmpty();
var group=cut.Find("[role=group][aria-labelledby]");cut.Find("#"+group.GetAttribute("aria-labelledby")).TextContent.ShouldBe("Modbus address builder");
cut.FindAll("button").ShouldAllBe(b=>b.GetAttribute("type")=="button");
}
[Fact]
public async Task RetainedCloseCannotDismissReplacement()
{
int a=0,b=0;var cut=Render<DriverTagPicker>(p=>p.Add(x=>x.Visible,true).Add(x=>x.Title,"A").Add(x=>x.VisibleChanged,_=>a++));
var old=Capture(cut,"Close");cut.Render(p=>p.Add(x=>x.Title,"B").Add(x=>x.VisibleChanged,_=>b++));
await cut.InvokeAsync(old);a.ShouldBe(0);b.ShouldBe(0);
cut.FindAll("button").Single(x=>x.TextContent.Trim()=="Close").Click();b.ShouldBe(1);
}
[Fact]
public async Task PendingPickKeepsSnapshotAndCannotCloseReplacement()
{
List<string> picked=[];int bClose=0;var entered=new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);var release=new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);
var cut=Render<DriverTagPicker>(p=>p.Add(x=>x.Visible,true).Add(x=>x.Title,"A").Add(x=>x.CurrentAddress,"4x00123-1").Add(x=>x.OnPickAddress,async value=>{picked.Add(value);entered.TrySetResult();await release.Task;}));
var pending=cut.FindAll("button").Single(x=>x.TextContent.Trim()=="Use this address").ClickAsync(new());await entered.Task;
cut.Render(p=>p.Add(x=>x.Title,"B").Add(x=>x.CurrentAddress,"4x00999-1").Add(x=>x.OnPickAddress,value=>picked.Add("B:"+value)).Add(x=>x.VisibleChanged,_=>bClose++));
release.TrySetResult();await pending;
picked.ShouldBe(["4x00123-1"]);bClose.ShouldBe(0);
cut.FindAll("button").Single(x=>x.TextContent.Trim()=="Use this address").Click();picked.ShouldBe(["4x00123-1","B:4x00999-1"]);bClose.ShouldBe(1);
}
[Fact]
public async Task QueuedUseAndCloseCannotReplayPendingSelection()
{
int count=0,closed=0;var entered=new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);var release=new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);
var cut=Render<DriverTagPicker>(p=>p.Add(x=>x.Visible,true).Add(x=>x.CurrentAddress,"DB1.DBW4").Add(x=>x.OnPickAddress,async _=>{count++;entered.TrySetResult();await release.Task;}).Add(x=>x.VisibleChanged,_=>closed++));
var use=Capture(cut,"Use this address");var close=Capture(cut,"Close");var first=cut.InvokeAsync(use);await entered.Task;
var second=cut.InvokeAsync(use);await Task.Yield();await cut.InvokeAsync(close);var pendingCount=count;var pendingClosed=closed;
release.TrySetResult();await Task.WhenAll(first,second);pendingCount.ShouldBe(1);pendingClosed.ShouldBe(0);closed.ShouldBe(1);
}
[Fact]
public async Task RetainedUseAfterDisposalCannotEmitSelection()
{
int count=0;var cut=Render<DriverTagPicker>(p=>p.Add(x=>x.Visible,true).Add(x=>x.CurrentAddress,"N7:0").Add(x=>x.OnPickAddress,_=>count++));
var use=Capture(cut,"Use this address");await DisposeComponentsAsync();await Renderer.Dispatcher.InvokeAsync(use);count.ShouldBe(0);
}
[Fact]
public void EmptySelectionDisabledAndCloseDoesNotPick()
{
int count=0,closed=0;var cut=Render<DriverTagPicker>(p=>p.Add(x=>x.Visible,true).Add(x=>x.OnPickAddress,_=>count++).Add(x=>x.VisibleChanged,_=>closed++));
cut.FindAll("button").Single(x=>x.TextContent.Trim()=="Use this address").HasAttribute("disabled").ShouldBeTrue();
cut.FindAll("button").Single(x=>x.TextContent.Trim()=="Close").Click();count.ShouldBe(0);closed.ShouldBe(1);
}
[Fact]
public async Task ExplicitTargetAndCallbackReplacementRetireQueuedUseWithoutChangingSelection()
{
List<string> values=[];var cut=Render<DriverTagPicker>(p=>p.Add(x=>x.Visible,true).Add(x=>x.CurrentAddress,"4x00001-1").Add(x=>x.Target,"A").Add(x=>x.OnPickAddress,value=>values.Add(value)));
var old=Capture(cut,"Use this address");cut.Render(p=>p.Add(x=>x.Target,"B").Add(x=>x.CurrentAddress,"4x00002-1"));await cut.InvokeAsync(old);values.ShouldBeEmpty();
var b=Capture(cut,"Use this address");cut.Render(p=>p.Add(x=>x.OnPickAddress,value=>values.Add("C:"+value)));await cut.InvokeAsync(b);values.ShouldBeEmpty();
cut.FindAll("button").Single(x=>x.TextContent.Trim()=="Use this address").Click();values.ShouldBe(["C:4x00002-1"]);
}
[Fact]
public async Task FailedRetiredPickDoesNotSurfaceOrCloseCurrentPicker()
{
var entered=new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);var release=new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);int closed=0;
var cut=Render<DriverTagPicker>(p=>p.Add(x=>x.Visible,true).Add(x=>x.Title,"A").Add(x=>x.CurrentAddress,"old").Add(x=>x.OnPickAddress,async _=>{entered.SetResult();await release.Task;throw new InvalidOperationException("Retired pick failure");}));
var pending=cut.FindAll("button").Single(x=>x.TextContent.Trim()=="Use this address").ClickAsync(new());await entered.Task;
cut.Render(p=>p.Add(x=>x.Title,"B").Add(x=>x.VisibleChanged,_=>closed++));release.SetResult();await pending;closed.ShouldBe(0);cut.Find("[role=group][aria-labelledby]").TextContent.ShouldContain("B");
}
[Fact]
public async Task RetargetDuringAwaitedReturnFocusCannotCloseReplacement()
{
var cut=Render<ReturnFocusHost>();var target=cut.Instance.TriggerA;
var focus=JSInterop.SetupVoid("Blazor._internal.domWrapper.focus",call=>call.Arguments[0] is ElementReference element&&element.Id==target.Id);
var close=cut.FindAll("button").Single(x=>x.TextContent.Trim()=="Close").ClickAsync(new());cut.WaitForAssertion(()=>focus.Invocations.Count.ShouldBe(1));
await cut.InvokeAsync(cut.Instance.Replace);focus.SetVoidResult();await close;
cut.Instance.Closed.ShouldBe(0);cut.FindComponent<DriverTagPicker>().Instance.Target.ShouldBe("B");
cut.FindAll("button").Single(x=>x.TextContent.Trim()=="Close").Click();cut.Instance.Closed.ShouldBe(1);
}
public sealed class ReturnFocusHost:ComponentBase
{
private ElementReference _a,_b;private string _target="A";public ElementReference TriggerA=>_a;public int Closed;
public void Replace(){_target="B";StateHasChanged();}
protected override void OnAfterRender(bool firstRender){if(firstRender)StateHasChanged();}
protected override void BuildRenderTree(RenderTreeBuilder b)
{
b.OpenElement(0,"button");b.AddElementReferenceCapture(1,e=>_a=e);b.AddContent(2,"Build A");b.CloseElement();
b.OpenElement(3,"button");b.AddElementReferenceCapture(4,e=>_b=e);b.AddContent(5,"Build B");b.CloseElement();
b.OpenComponent<DriverTagPicker>(6);b.AddAttribute(7,"Visible",true);b.AddAttribute(8,"Target",_target);b.AddAttribute(9,"ReturnFocus",_target=="A"?_a:_b);b.AddAttribute(10,"VisibleChanged",EventCallback.Factory.Create<bool>(this,_=>Closed++));b.CloseComponent();
}
}
#pragma warning disable BL0006 // Retain actual compiled render callback to exercise queued UI events, not a parallel action.
private static Func<Task> Capture(IRenderedComponent<DriverTagPicker> cut,string label)
{
var instance=cut.Instance;using var builder=new RenderTreeBuilder();typeof(DriverTagPicker).GetMethod("BuildRenderTree",BindingFlags.Instance|BindingFlags.NonPublic)!.Invoke(cut.Instance,[builder]);var range=builder.GetFrames();
for(int i=0;i<range.Count;i++)
{
var frame=range.Array[i];if(frame.FrameType!=RenderTreeFrameType.Element||frame.ElementName!="button")continue;
var body=range.Array.Skip(i+1).Take(frame.ElementSubtreeLength-1).ToArray();if(!body.Any(x=>(x.FrameType==RenderTreeFrameType.Text&&x.TextContent.Trim()==label)||(x.FrameType==RenderTreeFrameType.Markup&&x.MarkupContent.Trim()==label)))continue;
var action=body.Single(x=>x.FrameType==RenderTreeFrameType.Attribute&&x.AttributeName=="onclick").AttributeValue;
return ()=>action switch {EventCallback e=>e.InvokeAsync(),EventCallback<MouseEventArgs> e=>e.InvokeAsync(new()),Func<Task> e=>EventCallback.Factory.Create(instance,e).InvokeAsync(),Action e=>EventCallback.Factory.Create(instance,e).InvokeAsync(),_=>throw new InvalidOperationException("Unknown callback")};
}
throw new InvalidOperationException("Actual button callback not found: "+label);
}
#pragma warning restore BL0006
}