## Summary Phase 1 of a multi-phase optimization to eliminate intermediate string allocations between `$"..."` interpolation and the packet text region for ModernUO's player-facing message APIs. - Adds `[InterpolatedStringHandler]` overloads to every `Send*`/`Public/Local/Private/NonlocalOverheadMessage`/`Say`/`Emote`/`Whisper`/`Yell`/`SendLocalizedMessageTo` API in `OutgoingMessagePackets`, `Mobile`, and `Item`. Each overload is a 3-line shim that forwards `handler.Text` to the existing span-based path then calls `handler.Clear()` to return the rented `STArrayPool<char>` buffer (matches the established `SpanWriter.WriteAscii(ref RawInterpolatedStringHandler)` precedent). - Converts `string text/args/affix/name` parameters to `ReadOnlySpan<char>` for consistency with the handler path. `lang` intentionally stays `string` (it's never interpolated and the `??= "ENU"` fallback stays cleaner). - Adds `int charCount` overloads of the three `GetMaxMessage*Length` helpers so stackalloc sizing can avoid the redundant `ROS<char>` round-trip. - Moves `Mobile` (17 methods) and `Item` (4 methods) message methods into new partial-class files (`Mobile.Messages.cs`, `Item.Messages.cs`) for organization. No UOContent call sites change in this PR — existing `string`/`ROS<char>` calls compile unchanged via implicit conversion. Phase 2 (intermediate-string audit) and Phase 3 (cleanup PRs) follow. ## Files - `Projects/Server/Network/Packets/OutgoingMessagePackets.cs` — `string` → `ROS<char>` for text params, `int charCount` length helpers added, class made `partial` - `Projects/Server/Network/Packets/OutgoingMessagePackets.Interpolated.cs` (new) — 3 `ref RawInterpolatedStringHandler` extension overloads - `Projects/Server/Mobiles/Mobile.cs` — message methods extracted (-262 lines) - `Projects/Server/Mobiles/Mobile.Messages.cs` (new, 463 lines) — moved + ROS-converted methods + 25 handler overloads - `Projects/Server/Items/Item.cs` — message methods extracted (-93 lines) - `Projects/Server/Items/Item.Messages.cs` (new, 142 lines) — moved + ROS-converted methods + 4 handler overloads - `Projects/Server.Tests/Tests/Network/Packets/Outgoing/MessagePacketTests.cs` — 3 new regression tests verifying byte-equivalence for the handler overloads
298 lines
7.4 KiB
C#
298 lines
7.4 KiB
C#
using Server.Network;
|
|
using Server.Prompts;
|
|
using Xunit;
|
|
|
|
namespace Server.Tests.Network;
|
|
|
|
[Collection("Sequential Server Tests")]
|
|
public class MessageTests
|
|
{
|
|
[Fact]
|
|
public void TestMessageLocalized()
|
|
{
|
|
var serial = (Serial)0x1024;
|
|
var graphic = 0x100;
|
|
var messageType = MessageType.Label;
|
|
var hue = 1024;
|
|
var font = 3;
|
|
var number = 150000;
|
|
var name = "Stuff";
|
|
var args = "Arguments";
|
|
|
|
var expected = new MessageLocalized(
|
|
serial,
|
|
graphic,
|
|
messageType,
|
|
hue,
|
|
font,
|
|
number,
|
|
name,
|
|
args
|
|
).Compile();
|
|
|
|
using var ns = PacketTestUtilities.CreateTestNetState();
|
|
ns.SendMessageLocalized(
|
|
serial,
|
|
graphic,
|
|
messageType,
|
|
hue,
|
|
font,
|
|
number,
|
|
name,
|
|
args
|
|
);
|
|
|
|
var result = ns.SendBuffer.GetReadSpan();
|
|
AssertThat.Equal(result, expected);
|
|
}
|
|
|
|
[Fact]
|
|
public void TestMessageLocalizedInterpolated()
|
|
{
|
|
var serial = (Serial)0x1024;
|
|
var graphic = 0x100;
|
|
var messageType = MessageType.Label;
|
|
var hue = 1024;
|
|
var font = 3;
|
|
var number = 150000;
|
|
var name = "Stuff";
|
|
var argValue = 42;
|
|
|
|
var expected = new MessageLocalized(
|
|
serial, graphic, messageType, hue, font, number, name, $"value: {argValue}"
|
|
).Compile();
|
|
|
|
using var ns = PacketTestUtilities.CreateTestNetState();
|
|
ns.SendMessageLocalized(serial, graphic, messageType, hue, font, number, name, $"value: {argValue}");
|
|
|
|
var result = ns.SendBuffer.GetReadSpan();
|
|
AssertThat.Equal(result, expected);
|
|
}
|
|
|
|
[Fact]
|
|
public void TestMessageLocalizedAffix()
|
|
{
|
|
var serial = (Serial)0x1024;
|
|
var graphic = 0x100;
|
|
var messageType = MessageType.Label;
|
|
var hue = 1024;
|
|
var font = 3;
|
|
var number = 150000;
|
|
var name = "Stuff";
|
|
var args = "Arguments";
|
|
var affixType = AffixType.System;
|
|
var affix = "Affix";
|
|
|
|
var expected = new MessageLocalizedAffix(
|
|
serial,
|
|
graphic,
|
|
messageType,
|
|
hue,
|
|
font,
|
|
number,
|
|
name,
|
|
affixType,
|
|
affix,
|
|
args
|
|
).Compile();
|
|
|
|
using var ns = PacketTestUtilities.CreateTestNetState();
|
|
ns.SendMessageLocalizedAffix(
|
|
serial,
|
|
graphic,
|
|
messageType,
|
|
hue,
|
|
font,
|
|
number,
|
|
name,
|
|
affixType,
|
|
affix,
|
|
args
|
|
);
|
|
|
|
var result = ns.SendBuffer.GetReadSpan();
|
|
AssertThat.Equal(result, expected);
|
|
}
|
|
|
|
[Fact]
|
|
public void TestMessageLocalizedAffixInterpolated()
|
|
{
|
|
var serial = (Serial)0x1024;
|
|
var graphic = 0x100;
|
|
var messageType = MessageType.Label;
|
|
var hue = 1024;
|
|
var font = 3;
|
|
var number = 150000;
|
|
var name = "Stuff";
|
|
var affixType = AffixType.System;
|
|
var affix = "Affix";
|
|
var argValue = 42;
|
|
|
|
var expected = new MessageLocalizedAffix(
|
|
serial, graphic, messageType, hue, font, number, name, affixType, affix, $"value: {argValue}"
|
|
).Compile();
|
|
|
|
using var ns = PacketTestUtilities.CreateTestNetState();
|
|
ns.SendMessageLocalizedAffix(
|
|
serial, graphic, messageType, hue, font, number, name, affixType, affix,
|
|
$"value: {argValue}"
|
|
);
|
|
|
|
var result = ns.SendBuffer.GetReadSpan();
|
|
AssertThat.Equal(result, expected);
|
|
}
|
|
|
|
[Fact]
|
|
public void TestUnicodeMessageInterpolated()
|
|
{
|
|
var serial = (Serial)0x1024;
|
|
var graphic = 0x100;
|
|
var messageType = MessageType.Label;
|
|
var hue = 1024;
|
|
var font = 3;
|
|
var lang = "ENU";
|
|
var name = "Stuff";
|
|
var who = "Alice";
|
|
|
|
var expected = new UnicodeMessage(
|
|
serial, graphic, messageType, hue, font, lang, name, $"hello, {who}"
|
|
).Compile();
|
|
|
|
using var ns = PacketTestUtilities.CreateTestNetState();
|
|
ns.SendMessage(
|
|
serial, graphic, messageType, hue, font, false, lang, name, $"hello, {who}"
|
|
);
|
|
|
|
var result = ns.SendBuffer.GetReadSpan();
|
|
AssertThat.Equal(result, expected);
|
|
}
|
|
|
|
[Fact]
|
|
public void TestAsciiMessage()
|
|
{
|
|
var serial = (Serial)0x1024;
|
|
var graphic = 0x100;
|
|
var messageType = MessageType.Label;
|
|
var hue = 1024;
|
|
var font = 3;
|
|
var name = "Stuff";
|
|
var text = "Some Text";
|
|
|
|
var expected = new AsciiMessage(
|
|
serial,
|
|
graphic,
|
|
messageType,
|
|
hue,
|
|
font,
|
|
name,
|
|
text
|
|
).Compile();
|
|
|
|
using var ns = PacketTestUtilities.CreateTestNetState();
|
|
ns.SendMessage(
|
|
serial,
|
|
graphic,
|
|
messageType,
|
|
hue,
|
|
font,
|
|
true,
|
|
null,
|
|
name,
|
|
text
|
|
);
|
|
|
|
var result = ns.SendBuffer.GetReadSpan();
|
|
AssertThat.Equal(result, expected);
|
|
}
|
|
|
|
[Fact]
|
|
public void TestUnicodeMessage()
|
|
{
|
|
var serial = (Serial)0x1024;
|
|
var graphic = 0x100;
|
|
var messageType = MessageType.Label;
|
|
var hue = 1024;
|
|
var font = 3;
|
|
var lang = "ENU";
|
|
var name = "Stuff";
|
|
var text = "Some Text";
|
|
|
|
var expected = new UnicodeMessage(
|
|
serial,
|
|
graphic,
|
|
messageType,
|
|
hue,
|
|
font,
|
|
lang,
|
|
name,
|
|
text
|
|
).Compile();
|
|
|
|
using var ns = PacketTestUtilities.CreateTestNetState();
|
|
ns.SendMessage(
|
|
serial,
|
|
graphic,
|
|
messageType,
|
|
hue,
|
|
font,
|
|
false,
|
|
lang,
|
|
name,
|
|
text
|
|
);
|
|
|
|
var result = ns.SendBuffer.GetReadSpan();
|
|
AssertThat.Equal(result, expected);
|
|
}
|
|
|
|
[Fact]
|
|
public void TestFollowMessage()
|
|
{
|
|
var serial = (Serial)0x1024;
|
|
var serial2 = (Serial)0x2;
|
|
|
|
var expected = new FollowMessage(serial, serial2).Compile();
|
|
|
|
using var ns = PacketTestUtilities.CreateTestNetState();
|
|
ns.SendFollowMessage(serial, serial2);
|
|
|
|
var result = ns.SendBuffer.GetReadSpan();
|
|
AssertThat.Equal(result, expected);
|
|
}
|
|
|
|
[Fact]
|
|
public void TestObjectHelpResponse()
|
|
{
|
|
var s = (Serial)0x100;
|
|
var text = "This is some testing text";
|
|
|
|
var expected = new ObjectHelpResponse(s, text).Compile();
|
|
|
|
using var ns = PacketTestUtilities.CreateTestNetState();
|
|
ns.SendHelpResponse(s, text);
|
|
|
|
var result = ns.SendBuffer.GetReadSpan();
|
|
AssertThat.Equal(result, expected);
|
|
}
|
|
|
|
internal class TestPrompt : Prompt
|
|
{
|
|
}
|
|
|
|
[Collection("Sequential Server Tests")]
|
|
public class UnicodePromptTests
|
|
{
|
|
[Fact]
|
|
public void TestUnicodePrompt()
|
|
{
|
|
var prompt = new TestPrompt();
|
|
var expected = new UnicodePrompt(prompt).Compile();
|
|
|
|
using var ns = PacketTestUtilities.CreateTestNetState();
|
|
ns.SendPrompt(prompt);
|
|
|
|
var result = ns.SendBuffer.GetReadSpan();
|
|
AssertThat.Equal(result, expected);
|
|
}
|
|
}
|
|
}
|