acdream/tests/AcDream.App.Tests/UI/Layout/RetailDialogFactoryTests.cs
Erik 5d247d5518 fix(chat): CH4 re-review fixes — dialog-queue reentrancy, settings option-bit chokepoint
Should-fix 1: RetailDialogFactory.CloseDialog's queued branch removed the
active DialogInfo, ran DialogDone (whose callback can synchronously open a
new dialog under the SAME queue key — the two-stage house-abandon
confirmation does exactly this), then called OpenNextDialog, which did an
unconditional Dictionary.Add on a key the reentrant dialog had already
re-occupied. Retail's HashTable::add tolerates the duplicate; Dictionary
throws. OpenNextDialog now returns early when the queue key is already
active — the reentrant dialog's own eventual close drains the queue.

Should-fix 2: @join/@leave wrote the local RuntimeCharacterOptionsState bit
before sending, but the Settings Chat toggles reached a second binding
(SendSingleCharacterOption) that only sent the wire message, leaving the
Turbine membership gate stale until the next PlayerDescription.
LiveSessionRuntimeFactory.CreateCommandBindings now has one shared local
function for both entrances.

Should-fix 3: corrected TS-68/#360 wording again — retail's DoAllegiance
dispatcher table EXECUTES boot/ban/officer/title/motd/name/lock/house/
chat/broadcast locally through their own handlers; acdream shows the
unrecognized-subcommand refusal for all nine pending the #360 port. What
matches retail is the ownership rule (the verb never reaches
DoChannelCommand/the server), not the subcommand behavior itself. Removed
the inaccurate "matching retail, not merely harmless" / "now matches
this" claims from both the register row and the issue.

Nits: corrected the HouseAbandonDialogCallback_First citation (0x00580E1A
is DoHouse's load site for the callback pointer, not the function entry —
the entry is 0x00580240, with the stage-2 confirmation string built at
0x005802D8) in both ClientCommandController.cs and the mirrored test
comment; added an InlineData case pinning "@clist allegiance" to
RequestChannelList(0x02000000); converted RetailClientCommandCatalog.
KnownVerbs from a plain array to a FrozenSet<string> with
StringComparer.OrdinalIgnoreCase, matching the file's other lookup tables.

Suite: 12,221 passed / 4 skipped / 0 failed (Release), up from CH4's
12,216/4/0 — net +5 tests, no removals.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-08-09 22:24:43 +02:00

326 lines
12 KiB
C#

using AcDream.App.UI;
using AcDream.App.UI.Layout;
namespace AcDream.App.Tests.UI.Layout;
public sealed class RetailDialogFactoryTests
{
[Theory]
[InlineData(RetailDialogType.Confirmation, 0x15u)]
[InlineData(RetailDialogType.Wait, 0x31u)]
[InlineData(RetailDialogType.Message, 0x24u)]
[InlineData(RetailDialogType.TextInput, 0x28u)]
[InlineData(RetailDialogType.ConfirmationTextInput, 0x2Cu)]
[InlineData(RetailDialogType.Menu, 0x1Bu)]
[InlineData(RetailDialogType.ConfirmationMenu, 0x1Fu)]
public void DialogTypesMapToRetailCatalogRoots(
RetailDialogType type,
uint expectedRoot)
=> Assert.Equal(expectedRoot, RetailDialogFactory.RootElementId(type));
[Fact]
public void FixtureBuildsProductionConfirmationWidgets()
{
var layout = FixtureLoader.LoadConfirmationDialog();
Assert.IsType<UiDialogRoot>(layout.Root);
Assert.IsType<UiText>(layout.FindElement(RetailConfirmationDialogView.MessageElementId));
Assert.IsType<UiButton>(layout.FindElement(RetailConfirmationDialogView.AcceptButtonId));
Assert.IsType<UiButton>(layout.FindElement(RetailConfirmationDialogView.RejectButtonId));
}
[Fact]
public void ConfirmationCreatesFreshCenteredRootAndReturnsPropertyResult()
{
var root = new UiRoot { Width = 1024f, Height = 768f };
var layouts = new List<ImportedLayout>();
var factory = CreateFactory(root, layouts);
bool? result = null;
factory.MakeConfirmation(
"Do you really want to kill your character?",
data => result = data.GetBoolean(RetailDialogProperty.ConfirmationResult));
ImportedLayout layout = Assert.Single(layouts);
Assert.Same(layout.Root, root.Modal);
var popup = Assert.IsAssignableFrom<UiElement>(
layout.FindElement(RetailConfirmationDialogView.PopupElementId));
Assert.Equal(MathF.Round((1024f - popup.Width) * 0.5f), popup.Left);
Assert.Equal(MathF.Round((768f - popup.Height) * 0.5f), popup.Top);
Accept(layout);
Assert.True(result);
Assert.Null(root.Modal);
Assert.False(factory.IsOpen);
}
[Fact]
public void SameQueuePresentsFifoUsingFreshLiveRoots()
{
var root = new UiRoot { Width = 800f, Height = 600f };
var layouts = new List<ImportedLayout>();
var factory = CreateFactory(root, layouts);
var results = new List<string>();
factory.MakeConfirmation("first", data =>
results.Add($"first:{data.GetBoolean(RetailDialogProperty.ConfirmationResult)}"));
factory.MakeConfirmation("second", data =>
results.Add($"second:{data.GetBoolean(RetailDialogProperty.ConfirmationResult)}"));
Assert.Equal(1, factory.PendingCount);
Reject(layouts[0]);
Assert.Equal(["first:False"], results);
Assert.Equal(2, layouts.Count);
Assert.NotSame(layouts[0].Root, layouts[1].Root);
Assert.Same(layouts[1].Root, root.Modal);
Assert.Equal("second", Message(layouts[1]));
Accept(layouts[1]);
Assert.Equal(["first:False", "second:True"], results);
Assert.False(factory.IsOpen);
}
[Fact]
public void QueueGroupsAndNonQueuedDialogsCanBeActiveTogether()
{
var root = new UiRoot { Width = 800f, Height = 600f };
var layouts = new List<ImportedLayout>();
var factory = CreateFactory(root, layouts);
uint first = factory.MakeConfirmation("queue two", queueKey: 2u);
uint second = factory.MakeConfirmation("queue three", queueKey: 3u);
uint third = factory.MakeConfirmation("nonqueued", queueKey: 1u);
Assert.Equal(3, factory.ActiveCount);
Assert.Equal(0, factory.PendingCount);
Assert.Same(layouts[2].Root, root.Modal);
Assert.True(factory.CloseDialog(third));
Assert.Same(layouts[1].Root, root.Modal);
Assert.True(factory.CloseDialog(second));
Assert.Same(layouts[0].Root, root.Modal);
Assert.True(factory.CloseDialog(first));
Assert.Null(root.Modal);
}
[Fact]
public void PriorityDialogSuspendsCurrentAndRestoresItBeforeOlderPendingWork()
{
var root = new UiRoot { Width = 800f, Height = 600f };
var layouts = new List<ImportedLayout>();
var factory = CreateFactory(root, layouts);
factory.MakeConfirmation("current");
factory.MakeConfirmation("ordinary pending");
factory.MakeConfirmation("priority", priority: true);
Assert.Equal(2, factory.PendingCount);
Assert.Equal("priority", Message(layouts[1]));
Assert.DoesNotContain(layouts[0].Root, root.Children);
Reject(layouts[1]);
Assert.Equal(3, layouts.Count);
Assert.Equal("current", Message(layouts[2]));
Assert.Equal(1, factory.PendingCount);
Assert.NotSame(layouts[0].Root, layouts[2].Root);
}
[Fact]
public void CallbackPrecedesCloseNoticeAndCustomLabelsAreApplied()
{
var root = new UiRoot { Width = 800f, Height = 600f };
var layouts = new List<ImportedLayout>();
var factory = CreateFactory(root, layouts);
var order = new List<string>();
factory.DialogClosed += (_, _) => order.Add("notice");
RetailDialogData data = RetailDialogData.Confirmation("Proceed?")
.Set(RetailDialogProperty.AcceptLabel, "Yes")
.Set(RetailDialogProperty.RejectLabel, "No");
factory.MakeDialog(data, _ => order.Add("callback"));
Assert.Equal("Yes", Button(layouts[0], RetailConfirmationDialogView.AcceptButtonId).Label);
Assert.Equal("No", Button(layouts[0], RetailConfirmationDialogView.RejectButtonId).Label);
Accept(layouts[0]);
Assert.Equal(["callback", "notice"], order);
}
[Fact]
public void PendingContextCanBeClosedWithoutDisturbingActiveDialog()
{
var root = new UiRoot { Width = 800f, Height = 600f };
var layouts = new List<ImportedLayout>();
var factory = CreateFactory(root, layouts);
var completed = new List<uint>();
uint active = factory.MakeConfirmation("active");
uint pending = 0u;
pending = factory.MakeConfirmation("pending", _ => completed.Add(pending));
Assert.True(factory.CloseDialog(pending));
Assert.Equal([pending], completed);
Assert.Equal(0, factory.PendingCount);
Assert.Same(layouts[0].Root, root.Modal);
Assert.True(factory.CloseDialog(active));
}
[Fact]
public void ResetCompletesActiveAndPendingContexts()
{
var root = new UiRoot { Width = 800f, Height = 600f };
var layouts = new List<ImportedLayout>();
var factory = CreateFactory(root, layouts);
var completed = new List<string>();
var notices = new List<uint>();
factory.DialogClosed += (context, _) => notices.Add(context);
uint active = factory.MakeConfirmation("active", _ => completed.Add("active"));
uint pending = factory.MakeConfirmation("pending", _ => completed.Add("pending"));
factory.Reset();
Assert.Equal(["active", "pending"], completed);
Assert.Equal([active, pending], notices);
Assert.False(factory.IsOpen);
Assert.Equal(0, factory.PendingCount);
Assert.Null(root.Modal);
}
[Fact]
public void Reset_CompletesEveryDialogAndKeepsContextSequenceMonotonic()
{
var root = new UiRoot { Width = 800f, Height = 600f };
var layouts = new List<ImportedLayout>();
var factory = CreateFactory(root, layouts);
int callbacks = 0;
int notices = 0;
factory.DialogClosed += (_, _) => notices++;
uint first = factory.MakeConfirmation("active", _ => callbacks++);
factory.MakeConfirmation("pending", _ => callbacks++);
factory.Reset();
Assert.Equal(1u, first);
Assert.Equal(2, callbacks);
Assert.Equal(2, notices);
Assert.False(factory.IsOpen);
Assert.Equal(0, factory.PendingCount);
Assert.Null(root.Modal);
Assert.Empty(root.Children);
Assert.Equal(3u, factory.MakeConfirmation("new session"));
}
[Fact]
public void Reset_AttemptsEveryDialogWhenOneCallbackThrows()
{
var root = new UiRoot { Width = 800f, Height = 600f };
var layouts = new List<ImportedLayout>();
var factory = CreateFactory(root, layouts);
int completed = 0;
factory.MakeConfirmation("active", _ => throw new InvalidOperationException("boom"));
factory.MakeConfirmation("pending", _ => completed++);
AggregateException error = Assert.Throws<AggregateException>(factory.Reset);
Assert.Contains("boom", error.ToString());
Assert.Equal(1, completed);
Assert.False(factory.IsOpen);
Assert.Equal(0, factory.PendingCount);
Assert.Null(root.Modal);
Assert.Empty(root.Children);
factory.Reset();
}
[Fact]
public void Reset_DrainsDialogCreatedReentrantlyByCompletionCallback()
{
var root = new UiRoot { Width = 800f, Height = 600f };
var layouts = new List<ImportedLayout>();
var factory = CreateFactory(root, layouts);
int completed = 0;
factory.MakeConfirmation("first", _ =>
{
completed++;
factory.MakeConfirmation("reentrant", _ => completed++);
});
factory.Reset();
Assert.Equal(2, completed);
Assert.False(factory.IsOpen);
Assert.Equal(0, factory.PendingCount);
Assert.Null(root.Modal);
Assert.Empty(root.Children);
}
[Fact]
public void AcceptingChainedReentrantDialogDoesNotThrowAndDrainsQueueAfterChainCompletes()
{
// CH4 re-review should-fix 1: a callback that synchronously reopens a new
// dialog under the SAME queue key (retail's two-stage house-abandon
// confirmation) used to crash OpenNextDialog with a duplicate-key
// ArgumentException whenever a third confirmation was already queued
// behind the chain. See RetailDialogFactory.OpenNextDialog.
var root = new UiRoot { Width = 800f, Height = 600f };
var layouts = new List<ImportedLayout>();
var factory = CreateFactory(root, layouts);
var completed = new List<string>();
factory.MakeConfirmation("stage1", _ =>
{
completed.Add("stage1");
factory.MakeConfirmation("stage2", _ => completed.Add("stage2"));
});
factory.MakeConfirmation("queued behind chain", _ => completed.Add("queued"));
Assert.Equal(1, factory.PendingCount);
Exception? thrown = Record.Exception(() => Accept(layouts[0]));
Assert.Null(thrown);
Assert.Equal(["stage1"], completed);
Assert.Equal(2, layouts.Count);
Assert.Equal("stage2", Message(layouts[1]));
Assert.Same(layouts[1].Root, root.Modal);
Assert.Equal(1, factory.PendingCount);
Accept(layouts[1]);
Assert.Equal(["stage1", "stage2"], completed);
Assert.Equal(3, layouts.Count);
Assert.Equal("queued behind chain", Message(layouts[2]));
Assert.Same(layouts[2].Root, root.Modal);
Assert.Equal(0, factory.PendingCount);
Accept(layouts[2]);
Assert.Equal(["stage1", "stage2", "queued"], completed);
Assert.False(factory.IsOpen);
}
private static RetailDialogFactory CreateFactory(
UiRoot root,
List<ImportedLayout> layouts)
=> new(root, type =>
{
Assert.Equal(RetailDialogType.Confirmation, type);
ImportedLayout layout = FixtureLoader.LoadConfirmationDialog();
layouts.Add(layout);
return layout;
});
private static UiButton Button(ImportedLayout layout, uint id)
=> Assert.IsType<UiButton>(layout.FindElement(id));
private static void Accept(ImportedLayout layout)
=> Button(layout, RetailConfirmationDialogView.AcceptButtonId).OnClick!();
private static void Reject(ImportedLayout layout)
=> Button(layout, RetailConfirmationDialogView.RejectButtonId).OnClick!();
private static string Message(ImportedLayout layout)
=> string.Join(" ", Assert.IsType<UiText>(layout.FindElement(
RetailConfirmationDialogView.MessageElementId)).LinesProvider().Select(static line => line.Text));
}