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>
146 lines
5.8 KiB
C#
146 lines
5.8 KiB
C#
using AcDream.App.UI;
|
|
using AcDream.Core.Chat;
|
|
using AcDream.UI.Abstractions.Panels.SpewBox;
|
|
|
|
namespace AcDream.App.Tests.UI;
|
|
|
|
/// <summary>
|
|
/// CH2 REJECT-review rework, BLOCKER 1
|
|
/// (<c>docs/research/2026-08-09-ch2-review-findings.md</c>): these tests
|
|
/// drive the controller's frame hook (<c>UiRoot.Tick</c>, the global-message-3
|
|
/// broadcast) rather than calling <c>UiText.LinesProvider</c> directly. The
|
|
/// original tests invoked the provider straight through, bypassing the
|
|
/// <c>Visible</c> gate that <c>UiText.OnDraw</c> checks before ever polling
|
|
/// it — that is exactly why the original bug (start-invisible → provider
|
|
/// never called by drawing → no line ever visible, pending queue never
|
|
/// drains) was invisible to the original test suite.
|
|
/// </summary>
|
|
public sealed class SpewBoxControllerTests
|
|
{
|
|
[Fact]
|
|
public void Controller_IsClickThroughOverlayAndDisposesFromRetainedRoot()
|
|
{
|
|
var root = new UiRoot
|
|
{
|
|
Width = 1280f,
|
|
Height = 720f,
|
|
};
|
|
var state = new SpewBoxState();
|
|
|
|
using (var controller = new SpewBoxController(root, new SpewBoxVM(state)))
|
|
{
|
|
UiText text = Assert.IsType<UiText>(root.Children.OfType<UiText>().Single());
|
|
Assert.False(text.Visible);
|
|
Assert.True(text.ClickThrough);
|
|
Assert.Equal(int.MaxValue, text.ZOrder);
|
|
|
|
state.Enqueue("You can't jump while in the air");
|
|
|
|
// Drive the frame hook, NOT the provider — this is the tick
|
|
// that drains the pending queue in production, wired through
|
|
// UiRoot.Tick's IUiGlobalTimeListener broadcast.
|
|
root.Tick(dt: 0d, nowMs: 1000L);
|
|
|
|
UiText.Line line = Assert.Single(text.LinesProvider!());
|
|
Assert.Equal("You can't jump while in the air", line.Text);
|
|
Assert.True(text.Visible);
|
|
}
|
|
|
|
Assert.Empty(root.Children);
|
|
}
|
|
|
|
[Fact]
|
|
public void Controller_NoContent_LeavesTextHiddenWithEmptyLines()
|
|
{
|
|
var root = new UiRoot { Width = 1280f, Height = 720f };
|
|
using var controller = new SpewBoxController(root, new SpewBoxVM(new SpewBoxState()));
|
|
|
|
root.Tick(dt: 0d, nowMs: 1000L);
|
|
|
|
UiText text = Assert.IsType<UiText>(root.Children.OfType<UiText>().Single());
|
|
Assert.Empty(text.LinesProvider!());
|
|
Assert.False(text.Visible);
|
|
}
|
|
|
|
[Fact]
|
|
public void Controller_BecomesVisible_WithoutAnyDrawHavingHappenedFirst()
|
|
{
|
|
// BLOCKER 1 acceptance (a): the original bug was start-invisible →
|
|
// LinesProvider only reachable through UiElement.DrawSelfAndChildren
|
|
// (which returns early on !Visible) → provider never called → never
|
|
// visible. This test never calls anything draw-shaped — no OnDraw,
|
|
// no DrawSelfAndChildren, no UiRenderContext — only the tick.
|
|
var root = new UiRoot { Width = 1280f, Height = 720f };
|
|
var state = new SpewBoxState();
|
|
using var controller = new SpewBoxController(root, new SpewBoxVM(state));
|
|
|
|
UiText text = Assert.IsType<UiText>(root.Children.OfType<UiText>().Single());
|
|
Assert.False(text.Visible);
|
|
|
|
state.Enqueue("Out of Range!");
|
|
root.Tick(dt: 0d, nowMs: 500L);
|
|
|
|
Assert.True(text.Visible);
|
|
Assert.Equal("Out of Range!", Assert.Single(text.LinesProvider!()).Text);
|
|
}
|
|
|
|
[Fact]
|
|
public void Controller_PendingQueueDrains_WithoutAnyDrawPass()
|
|
{
|
|
// BLOCKER 1 acceptance (b): SpewBoxState.Tick is the only caller
|
|
// that drains _pending (SpewBoxState.cs's Queue<string>). Before the
|
|
// fix, that call only happened inside LinesProvider, which drawing
|
|
// gated behind Visible — so the pending queue was an unbounded
|
|
// per-session leak. Enqueue, tick the frame hook, and assert the
|
|
// underlying state actually drained (Count reflects the visible
|
|
// set, not the still-pending queue) — never touching drawing.
|
|
var root = new UiRoot { Width = 1280f, Height = 720f };
|
|
var state = new SpewBoxState();
|
|
using var controller = new SpewBoxController(root, new SpewBoxVM(state));
|
|
|
|
state.Enqueue("first");
|
|
Assert.Equal(0, state.Count); // still pending, not yet drained
|
|
|
|
root.Tick(dt: 0d, nowMs: 100L);
|
|
|
|
Assert.Equal(1, state.Count); // drained into the visible list
|
|
Assert.Equal("first", state.Snapshot()[0].Text);
|
|
}
|
|
|
|
[Fact]
|
|
public void Controller_QueueStaysBounded_AcrossManyTicksWithoutADrawPass()
|
|
{
|
|
// BLOCKER 1 acceptance (c): repeated enqueue+tick cycles must never
|
|
// let the visible set grow past SpewBoxState.MaxConcurrentItems
|
|
// (retail's code default, 1) — this is what "unbounded per-session
|
|
// leak" would have looked like if the drain never ran at all.
|
|
var root = new UiRoot { Width = 1280f, Height = 720f };
|
|
var state = new SpewBoxState();
|
|
using var controller = new SpewBoxController(root, new SpewBoxVM(state));
|
|
|
|
for (int i = 0; i < 50; i++)
|
|
{
|
|
state.Enqueue($"line {i}");
|
|
root.Tick(dt: 0d, nowMs: 1000L + i);
|
|
Assert.True(state.Count <= SpewBoxState.MaxConcurrentItems);
|
|
}
|
|
|
|
UiText text = Assert.IsType<UiText>(root.Children.OfType<UiText>().Single());
|
|
Assert.True(text.LinesProvider!().Count <= SpewBoxState.MaxConcurrentItems);
|
|
// Newest-at-top, matching retail's InsertItem(item, 0).
|
|
Assert.Equal("line 49", text.LinesProvider!()[0].Text);
|
|
}
|
|
|
|
[Fact]
|
|
public void Dispose_RemovesBothTheTextAndTheGlobalTimeSinkFromTheRoot()
|
|
{
|
|
var root = new UiRoot { Width = 1280f, Height = 720f };
|
|
var controller = new SpewBoxController(root, new SpewBoxVM(new SpewBoxState()));
|
|
|
|
Assert.Equal(2, root.Children.Count); // UiText + the tick sink
|
|
|
|
controller.Dispose();
|
|
|
|
Assert.Empty(root.Children);
|
|
}
|
|
}
|