acdream/tests/AcDream.UI.Abstractions.Tests/Panels/SpewBox/SpewBoxVMTests.cs
Erik e0e7888308 fix(chat): CH2 rework — SpewBox tick-driven visibility + binary-derived error table
Reworks Campaign CH slice CH2 per the REJECT-review findings doc
(docs/research/2026-08-09-ch2-review-findings.md).

BLOCKER 1 — SpewBoxController never rendered a line and leaked its
pending queue. LinesProvider only ran through UiText.OnDraw, which
gates on Visible — and the box started invisible, so the provider (the
sole caller of SpewBoxState.Tick) never ran. Gave the controller an
explicit per-frame Tick(now) driven by UiRoot's global-message-3
broadcast (a zero-size GlobalTimeSink child, the same pattern
VendorUiController.DragOverGlobalTimeSink already uses), matching
retail's gmSpewBoxUI::Update. LinesProvider now only returns the
cache. Tests rewritten to drive root.Tick(...) instead of calling the
provider directly, plus new coverage for visibility-without-a-draw,
queue-drain-without-a-draw, and bounded-queue-across-many-ticks.

BLOCKER 2 — re-derived the HandleFailureEvent routing table from the
PDB-paired binary instead of the pseudo-C's ~33-char string previews.
tools/pdb-extract/sweep_weenie_strings.py sweeps every push imm32 in
VA 0x571990-0x575480, dereferences into .rdata/.data, and decodes the
full UTF-16LE literal. Added the 5 ids dispatched via else-if (missed
by case-label enumeration), resolved 0x4F8 (previously excluded),
fixed 18 wrong strings (16 the review flagged + 2 more — 0x4E9 and
0x518 — an automated diff between every swept literal and the landed
table found). Every changed row cross-checked against ACE's
WeenieError/WeenieErrorWithString enum doc comments; both oracles
agreed on every row, including a case where the review's own proposed
text for the new 0x4E8 row was itself wrong (it was 0x4E9's text) —
corrected via the else-if block's own instruction address plus the ACE
cross-check. Pinned table count: 344 (338 + 5 + 0x4F8).

SHOULD-FIX 1 — RuntimeCommunicationState.ResetSpewBox was dead code;
folded into the ChatIdentity generation-reset stage (same lifetime
boundary), with a reset assertion added to the existing populated-reset
test.

SHOULD-FIX 2 — AddText trimmed only the trailing end and invented an
empty-string early return; retail's AddTextToScroll trims both ends
(trim(&str, 1, 1, ws)) and has no empty guard. Both retired.

SHOULD-FIX 3 — ShowWeenieError bypassed the AddText chokepoint via
ChatLog.OnWeenieError (hardcoded LogTextType 0x00); routed through
Communication.AddText(Resolve(code, param)) instead, and
ChatLog.OnWeenieError is deleted — GameEventWiring's legacy no-router
fallback now resolves + calls OnSystemMessage directly.

SHOULD-FIX 4 — retail's HandleFailureEvent switch has no default case;
an unmapped id now resolves to a null Text (silence toward the
player) instead of the invented "WeenieError 0xNNNN" hex fallback,
with a diagnostics-only console log line for the id.

NITs — AP-TBD placeholders corrected to their real register rows
(AP-178, not the unrelated AP-177 lifetime row); filed AP-180 for the
windowId dual-destination gap and corrected three stale "lands with
CH2" comments; extended SpewBoxLayoutDumpDiagnostic from dats.Portal
to dats.Local and found the SpewBox element for real — LayoutDesc
0x21000011, element 0x10000048, size 450x72, MaxConcurrentItems
(ListBox property 0x10000028) = 4, not retail's code default of 1.
AP-178 narrowed accordingly; SpewBoxState.MaxConcurrentItems and
SpewBoxController's extent/anchor/OneLine are now authored rather than
placeholder (absolute screen position and colour remain open); fixed
the "19 ids... lists 18" miscount by retiring the stale paragraph in
the class doc rewrite; aligned the UseDone handler's silent-status
check with the other two WeenieError handlers.

Full Release suite: 11,914 passed / 4 skipped / 0 failed (build 0
errors).

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-08-09 18:14:26 +02:00

81 lines
2.6 KiB
C#

using AcDream.Core.Chat;
using AcDream.UI.Abstractions.Panels.SpewBox;
namespace AcDream.UI.Abstractions.Tests.Panels.SpewBox;
public sealed class SpewBoxVMTests
{
[Fact]
public void Lines_NoContent_ReturnsEmpty()
{
var vm = new SpewBoxVM(new SpewBoxState());
Assert.Empty(vm.Lines(0d));
Assert.False(vm.HasVisibleLines);
}
[Fact]
public void Lines_DrainsPendingAndReturnsRemainingLifetime()
{
var state = new SpewBoxState();
var vm = new SpewBoxVM(state);
state.Enqueue("You can't jump while in the air");
IReadOnlyList<SpewBoxLine> lines = vm.Lines(nowSeconds: 10d);
SpewBoxLine line = Assert.Single(lines);
Assert.Equal("You can't jump while in the air", line.Text);
Assert.Equal(SpewBoxState.DefaultLifetime.TotalSeconds, line.RemainingLifetimeSeconds, precision: 3);
Assert.True(vm.HasVisibleLines);
}
[Fact]
public void Lines_RemainingLifetime_CountsDownAndFloorsAtZero()
{
var state = new SpewBoxState();
var vm = new SpewBoxVM(state);
state.Enqueue("fading");
vm.Lines(nowSeconds: 0d);
double halfway = SpewBoxState.DefaultLifetime.TotalSeconds / 2;
SpewBoxLine midLine = Assert.Single(vm.Lines(nowSeconds: halfway));
Assert.Equal(halfway, midLine.RemainingLifetimeSeconds, precision: 3);
// Past expiry: the line is pruned by the same Lines() call that ticks it.
Assert.Empty(vm.Lines(nowSeconds: SpewBoxState.DefaultLifetime.TotalSeconds + 1d));
}
[Fact]
public void Lines_NewestFirst_MatchesRetailInsertAtZero()
{
// CH2 REJECT-review rework NIT 3: MaxConcurrentItems is the
// AUTHORED LayoutDesc value (4, see SpewBoxState.MaxConcurrentItems's
// own doc comment), not retail's code default (1) — both entries
// now survive, so assert the ordering directly.
var state = new SpewBoxState();
var vm = new SpewBoxVM(state);
state.Enqueue("older");
vm.Lines(0d);
state.Enqueue("newer");
IReadOnlyList<SpewBoxLine> lines = vm.Lines(0d);
Assert.Equal(2, lines.Count);
Assert.Equal("newer", lines[0].Text);
Assert.Equal("older", lines[1].Text);
}
[Fact]
public void Revision_TracksUnderlyingState()
{
var state = new SpewBoxState();
var vm = new SpewBoxVM(state);
long initial = vm.Revision;
state.Enqueue("a line");
vm.Lines(0d);
Assert.True(vm.Revision > initial);
Assert.Equal(state.Revision, vm.Revision);
}
}