acdream/tests/AcDream.Runtime.Tests/Gameplay/TurbineChatMembershipGateTests.cs
Erik e07fba5731 fix(chat): CH3 review fixes — phantom UN-9, allegiance-broadcast echo, /a legacy fallback
Applies the Opus review of Campaign CH slice CH3 (614a1e05):

- B1: UN-9 was a phantom divergence — ACE's CharacterOptions1.cs:47
  OR-sum is 0x50C4A54A (its own comment confirms 1355064650), identical
  to acdream's literal. The wrong 0x50C48D4A existed only in the research
  doc. Row deleted, register §5 reverted to 4 rows, research doc corrected
  with dated notes.
- S1/S4: AllegianceBroadcast (0x02000000) is a server-echoing channel —
  ACE's GameActionChatChannel handler includes the sender in its real-name
  Allegiance.Members broadcast (retail's DoAllegianceBroadcast has no
  AddTextToScroll), so the client must skip its local optimistic echo, not
  keep it. ChatChannelInfo.Legacy.IsSelfEchoChannel() now returns true for
  it; RouteLegacyChannel's comment corrected; Turbine.IsSelfEchoChannel()'s
  backwards comment rewritten truthfully.
- S3: retail's /a stays on the legacy AllegianceBroadcast bitflag until
  StartupTurbineChatSystem successfully starts Turbine chat — "never
  started" (TurbineChatState.Enabled == false) now falls back to legacy in
  both LiveSessionCommandRouter.RouteChat and
  DirectGameRuntimeCommandAdapter.TrySendChannel, while "enabled but no
  allegiance room" still correctly refuses locally.
- S5: added a LiveSessionEventRouter test proving the Options.Replace ->
  OnCharacterOptionsChanged seeding order, and RuntimeSettingsTargets /
  GameWindowLiveSessionOwnershipTests tests proving the concrete
  ICommandBus.Publish wiring and the single LiveSessionCommandSurface
  construction site.
- S6: AP-181 rewritten to name both of retail's omitted pre-send checks
  (IsMessageSafe silent-drop, then IsMessageSpam) and stop misattributing
  either to RouteLegacyChannel, which has no such gates.
- N1-N7: CharacterOptionId moved below SocialActions so its doc comment
  re-attaches; TurbineChatMembershipGate reuses TurbineChatDisplayNames
  instead of a duplicate table; the gate-to-refusal-text mapping is now
  shared via TurbineChatMembershipGate.ResolveRefusalText instead of
  duplicated in both hosts; ChatSettings.Default now matches ACE's real
  CharacterOptions2.Default (Roleplay/Society start off); a doc-comment
  clarifies only the five Hear toggles are server-backed; the register's
  §3 header recounted 129 -> 128.

Suite: 11,964 passed / 4 skipped / 0 failed (baseline 11,957/4/0 + 7 new
tests). Campaign ledger CH3 review column updated to APPROVE-WITH-FIXES.

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

233 lines
9.4 KiB
C#

using AcDream.Core.Chat;
using AcDream.Core.Net.Messages;
using AcDream.Runtime.Gameplay;
namespace AcDream.Runtime.Tests.Gameplay;
/// <summary>
/// Campaign CH slice CH3 (2026-08-09): pins the retail
/// <c>SendTurbineChat @0x0057db10</c> local pre-send gate — the fix for
/// "side channels don't work" (research doc §5.2/§6.2).
/// </summary>
public sealed class TurbineChatMembershipGateTests
{
[Fact]
public void TurbineDisabled_ReturnsUnavailable_EvenWithRoomIdAndOptionOn()
{
var turbine = new TurbineChatState(); // never received SetTurbineChatChannels
var options = new RuntimeCharacterOptionsState();
TurbineChatGateResult result = TurbineChatMembershipGate.Evaluate(
ChatChannelKindLite.General, turbine, options, isOlthoiPlayer: false);
Assert.Equal(TurbineChatGateStatus.Unavailable, result.Status);
Assert.Equal(0u, result.RoomId);
}
[Fact]
public void RoomIdZero_ReturnsUnavailable_NoAllegiance()
{
TurbineChatState turbine = ReceivedRooms(allegianceRoom: 0u);
var options = new RuntimeCharacterOptionsState();
TurbineChatGateResult result = TurbineChatMembershipGate.Evaluate(
ChatChannelKindLite.Allegiance, turbine, options, isOlthoiPlayer: false);
Assert.Equal(TurbineChatGateStatus.Unavailable, result.Status);
}
[Theory]
[InlineData(ChatChannelKindLite.General)]
[InlineData(ChatChannelKindLite.Trade)]
[InlineData(ChatChannelKindLite.Lfg)]
[InlineData(ChatChannelKindLite.Roleplay)]
[InlineData(ChatChannelKindLite.Society)]
public void HearOptionOff_ReturnsNotListening_RoomIdAndTypeStillReported(
ChatChannelKindLite kind)
{
TurbineChatState turbine = ReceivedRooms();
var options = new RuntimeCharacterOptionsState();
options.Replace(options.Options1, 0u); // every Hear*Chat bit off
TurbineChatGateResult result = TurbineChatMembershipGate.Evaluate(
kind, turbine, options, isOlthoiPlayer: false);
Assert.Equal(TurbineChatGateStatus.NotListening, result.Status);
Assert.NotEqual(0u, result.RoomId);
Assert.NotEqual(string.Empty, result.DisplayName);
}
[Fact]
public void AllegianceHearOptionOff_ReturnsNotListening()
{
TurbineChatState turbine = ReceivedRooms();
var options = new RuntimeCharacterOptionsState();
options.Replace(0u, options.Options2); // HearAllegianceChat bit off
TurbineChatGateResult result = TurbineChatMembershipGate.Evaluate(
ChatChannelKindLite.Allegiance, turbine, options, isOlthoiPlayer: false);
Assert.Equal(TurbineChatGateStatus.NotListening, result.Status);
}
[Fact]
public void OlthoiRoom_GatesOnHeritageNotAnOption()
{
TurbineChatState turbine = ReceivedRooms();
var options = new RuntimeCharacterOptionsState(); // no Hear-Olthoi bit exists
TurbineChatGateResult notOlthoi = TurbineChatMembershipGate.Evaluate(
ChatChannelKindLite.Olthoi, turbine, options, isOlthoiPlayer: false);
TurbineChatGateResult olthoi = TurbineChatMembershipGate.Evaluate(
ChatChannelKindLite.Olthoi, turbine, options, isOlthoiPlayer: true);
Assert.Equal(TurbineChatGateStatus.NotListening, notOlthoi.Status);
Assert.Equal(TurbineChatGateStatus.Allowed, olthoi.Status);
}
[Theory]
[InlineData(ChatChannelKindLite.Allegiance, 0x10u, (uint)TurbineChat.ChatType.Allegiance, "Allegiance")]
[InlineData(ChatChannelKindLite.General, 0x11u, (uint)TurbineChat.ChatType.General, "General")]
[InlineData(ChatChannelKindLite.Trade, 0x12u, (uint)TurbineChat.ChatType.Trade, "Trade")]
[InlineData(ChatChannelKindLite.Lfg, 0x13u, (uint)TurbineChat.ChatType.Lfg, "LFG")]
[InlineData(ChatChannelKindLite.Society, 0x16u, (uint)TurbineChat.ChatType.Society, "Society")]
[InlineData(ChatChannelKindLite.Olthoi, 0x17u, (uint)TurbineChat.ChatType.Olthoi, "Olthoi")]
public void AllowedResultCarriesRoomIdChatTypeAndDisplayName(
ChatChannelKindLite kind,
uint expectedRoom,
uint expectedChatType,
string expectedName)
{
TurbineChatState turbine = ReceivedRooms(
allegianceRoom: 0x10u,
generalRoom: 0x11u,
tradeRoom: 0x12u,
lfgRoom: 0x13u,
roleplayRoom: 0x14u,
olthoiRoom: 0x17u,
societyRoom: 0x16u);
var options = new RuntimeCharacterOptionsState();
options.Replace(
options.Options1,
options.Options2
| (uint)PlayerDescriptionParser.CharacterOptions2.HearSocietyChat);
TurbineChatGateResult result = TurbineChatMembershipGate.Evaluate(
kind, turbine, options, isOlthoiPlayer: true);
Assert.Equal(TurbineChatGateStatus.Allowed, result.Status);
Assert.Equal(expectedRoom, result.RoomId);
Assert.Equal(expectedChatType, result.ChatType);
Assert.Equal(expectedName, result.DisplayName);
}
[Fact]
public void FreshDefaultOptions_MatchAceMembership_RoleplayAndSocietyAreOff()
{
// The CH3 headline finding (research doc §5.2): ACE's own
// CharacterOptions2.Default (0x00948700, byte-identical to
// RuntimeCharacterOptionsState.DefaultOptions2) OMITS
// HearRoleplayChat/HearSocietyChat — General/Trade/LFG/Allegiance
// are on by default, Roleplay/Society are NOT, and a fresh
// acdream character must reproduce that exact split.
TurbineChatState turbine = ReceivedRooms();
var options = new RuntimeCharacterOptionsState(); // untouched defaults
Assert.Equal(
TurbineChatGateStatus.Allowed,
TurbineChatMembershipGate.Evaluate(
ChatChannelKindLite.Allegiance, turbine, options, false).Status);
Assert.Equal(
TurbineChatGateStatus.Allowed,
TurbineChatMembershipGate.Evaluate(
ChatChannelKindLite.General, turbine, options, false).Status);
Assert.Equal(
TurbineChatGateStatus.Allowed,
TurbineChatMembershipGate.Evaluate(
ChatChannelKindLite.Trade, turbine, options, false).Status);
Assert.Equal(
TurbineChatGateStatus.Allowed,
TurbineChatMembershipGate.Evaluate(
ChatChannelKindLite.Lfg, turbine, options, false).Status);
Assert.Equal(
TurbineChatGateStatus.NotListening,
TurbineChatMembershipGate.Evaluate(
ChatChannelKindLite.Roleplay, turbine, options, false).Status);
Assert.Equal(
TurbineChatGateStatus.NotListening,
TurbineChatMembershipGate.Evaluate(
ChatChannelKindLite.Society, turbine, options, false).Status);
}
// ── N3 (CH3 Opus review): shared refusal-text mapping ──
[Fact]
public void ResolveRefusalText_AllowedGate_ReturnsNull()
{
TurbineChatState turbine = ReceivedRooms();
var options = new RuntimeCharacterOptionsState();
TurbineChatGateResult gate = TurbineChatMembershipGate.Evaluate(
ChatChannelKindLite.General, turbine, options, isOlthoiPlayer: false);
Assert.Equal(TurbineChatGateStatus.Allowed, gate.Status);
Assert.Null(TurbineChatMembershipGate.ResolveRefusalText(gate));
}
[Fact]
public void ResolveRefusalText_UnavailableGate_ReturnsRetailUnavailableString()
{
var turbine = new TurbineChatState(); // never received SetTurbineChatChannels
var options = new RuntimeCharacterOptionsState();
TurbineChatGateResult gate = TurbineChatMembershipGate.Evaluate(
ChatChannelKindLite.General, turbine, options, isOlthoiPlayer: false);
(string Text, RetailLogTextType Type)? refusal =
TurbineChatMembershipGate.ResolveRefusalText(gate);
Assert.NotNull(refusal);
Assert.Equal(ClientTextRefusals.TurbineChatUnavailable, refusal!.Value.Text);
}
[Fact]
public void ResolveRefusalText_NotListeningGate_ReturnsWeenieErrorString()
{
TurbineChatState turbine = ReceivedRooms();
var options = new RuntimeCharacterOptionsState();
options.Replace(options.Options1, 0u); // every Hear*Chat bit off
TurbineChatGateResult gate = TurbineChatMembershipGate.Evaluate(
ChatChannelKindLite.General, turbine, options, isOlthoiPlayer: false);
(string Text, RetailLogTextType Type)? refusal =
TurbineChatMembershipGate.ResolveRefusalText(gate);
Assert.NotNull(refusal);
(string? expectedText, RetailLogTextType expectedType) =
WeenieErrorMessages.Resolve(0x0551u, gate.DisplayName);
Assert.Equal(expectedText, refusal!.Value.Text);
Assert.Equal(expectedType, refusal.Value.Type);
}
private static TurbineChatState ReceivedRooms(
uint allegianceRoom = 0x10u,
uint generalRoom = 0x11u,
uint tradeRoom = 0x12u,
uint lfgRoom = 0x13u,
uint roleplayRoom = 0x14u,
uint olthoiRoom = 0x15u,
uint societyRoom = 0x16u)
{
var state = new TurbineChatState();
state.OnChannelsReceived(
allegianceRoom,
generalRoom,
tradeRoom,
lfgRoom,
roleplayRoom,
olthoiRoom,
societyRoom,
societyCelestialHandRoom: 0u,
societyEldrytchWebRoom: 0u,
societyRadiantBloodRoom: 0u);
return state;
}
}