mirror of
https://github.com/DarkflameUniverse/DarkflameServer.git
synced 2026-10-02 10:53:44 +00:00
refactor: activity game messages as structs
Converts ActivityEnter, ActivityExit, ActivityStart, ActivityStop,
ActivityPause, StartActivityTime, RequestActivityEnter,
RequestActivityExit and ShowActivityCountdown to NetGameMsgs in
ActivityMessages.{h,cpp}, switches their callers (racing, shooting
gallery, survival, waves, AG course, NT combat challenge) and deletes
the old GameMessages::Send* / HandleRequestActivityExit functions.
REQUEST_ACTIVITY_EXIT is registered in GameMessageHandler's map.
No wire change. Verified by comparing every struct byte for byte with a
frozen verbatim copy of the old functions (tests/.../Legacy) over a
grid of inputs, both to one client and as a broadcast (a temporary test
proved the copy matched production before it was deleted), plus hand
computed golden bytes, round trips and a deliberate field mutation that
made the tests fail. Layouts confirmed against the 1.10.64 client in
Ghidra. Only difference: a broadcast no longer makes
the extra Send(UNASSIGNED, false) that RakNet already rejected.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
Aaron Kimbrell
222
tests/dGameTests/dGameMessagesTests/ActivityMessagesTests.cpp
Normal file
222
tests/dGameTests/dGameMessagesTests/ActivityMessagesTests.cpp
Normal file
@@ -0,0 +1,222 @@
|
||||
#include "ActivityMessages.h"
|
||||
#include "GameDependencies.h"
|
||||
#include "PacketTestUtils.h"
|
||||
#include "Legacy/ActivityMessagesLegacy.h"
|
||||
|
||||
#include <array>
|
||||
#include <cmath>
|
||||
#include <functional>
|
||||
#include <limits>
|
||||
|
||||
#include <gtest/gtest.h>
|
||||
|
||||
using namespace PacketTestUtils;
|
||||
|
||||
namespace {
|
||||
SystemAddress ClientAddress() {
|
||||
SystemAddress address;
|
||||
address.binaryAddress = 0x0100007f;
|
||||
address.port = 2003;
|
||||
return address;
|
||||
}
|
||||
|
||||
const std::array<LWOOBJID, 3> g_Targets = { LWOOBJID_EMPTY, 0x1000000000000001LL, 0x0102030405060708LL };
|
||||
const std::array<SystemAddress, 2> g_Addresses = { ClientAddress(), UNASSIGNED_SYSTEM_ADDRESS };
|
||||
|
||||
PacketBytes StructPacket(const GameMessages::NetGameMsg& msg) {
|
||||
RakNet::BitStream bitStream;
|
||||
msg.WritePacket(bitStream);
|
||||
return FromBitStream(bitStream);
|
||||
}
|
||||
|
||||
// Sends the same message through the frozen legacy function and through the struct, to one client and as a
|
||||
// broadcast, and requires identical bytes and the same effective destination.
|
||||
void ExpectSameAsLegacy(const std::function<void(const SystemAddress&)>& legacySend, const GameMessages::NetGameMsg& msg) {
|
||||
for (const auto& address : g_Addresses) {
|
||||
SCOPED_TRACE(address == UNASSIGNED_SYSTEM_ADDRESS ? "broadcast" : "single client");
|
||||
const auto legacyPackets = Capture([&] { legacySend(address); });
|
||||
const auto newPackets = Capture([&] { msg.Send(address); });
|
||||
|
||||
ASSERT_FALSE(legacyPackets.empty());
|
||||
ASSERT_EQ(newPackets.size(), 1);
|
||||
// The legacy broadcast path also did a second Send(UNASSIGNED_SYSTEM_ADDRESS, broadcast = false),
|
||||
// which RakPeer::Send rejects without sending anything. Every copy must still match byte for byte.
|
||||
for (const auto& legacyPacket : legacyPackets) {
|
||||
EXPECT_PACKET_EQ(FromCapture(legacyPacket), FromCapture(newPackets[0]));
|
||||
}
|
||||
EXPECT_EQ(legacyPackets[0].broadcast, newPackets[0].broadcast);
|
||||
EXPECT_EQ(legacyPackets[0].sysAddr, newPackets[0].sysAddr);
|
||||
EXPECT_PACKET_EQ(FromCapture(newPackets[0]), StructPacket(msg));
|
||||
}
|
||||
}
|
||||
|
||||
// Serializes msg, reads it back into a fresh T and checks the fresh copy serializes to the same bytes.
|
||||
template<typename T>
|
||||
T RoundTrip(const T& msg) {
|
||||
RakNet::BitStream bitStream;
|
||||
msg.Serialize(bitStream);
|
||||
T copy;
|
||||
EXPECT_TRUE(copy.Deserialize(bitStream));
|
||||
EXPECT_EQ(bitStream.GetNumberOfUnreadBits(), 0);
|
||||
RakNet::BitStream again;
|
||||
copy.Serialize(again);
|
||||
EXPECT_PACKET_EQ(FromBitStream(bitStream), FromBitStream(again));
|
||||
return copy;
|
||||
}
|
||||
}
|
||||
|
||||
class ActivityMessagesTests : public GameDependenciesTest {
|
||||
protected:
|
||||
void SetUp() override { SetUpDependencies(); }
|
||||
void TearDown() override { TearDownDependencies(); }
|
||||
};
|
||||
|
||||
TEST_F(ActivityMessagesTests, NoPayloadMessagesMatchLegacy) {
|
||||
for (const auto target : g_Targets) {
|
||||
GameMessages::ActivityEnter enter;
|
||||
enter.target = target;
|
||||
ExpectSameAsLegacy([&](const SystemAddress& a) { LegacyGameMessages::SendActivityEnter(target, a); }, enter);
|
||||
|
||||
GameMessages::ActivityStart start;
|
||||
start.target = target;
|
||||
ExpectSameAsLegacy([&](const SystemAddress& a) { LegacyGameMessages::SendActivityStart(target, a); }, start);
|
||||
|
||||
GameMessages::ActivityExit exit;
|
||||
exit.target = target;
|
||||
ExpectSameAsLegacy([&](const SystemAddress& a) { LegacyGameMessages::SendActivityExit(target, a); }, exit);
|
||||
}
|
||||
}
|
||||
|
||||
TEST_F(ActivityMessagesTests, ActivityStopMatchesLegacy) {
|
||||
for (const auto target : g_Targets) {
|
||||
for (const bool bExit : { false, true }) {
|
||||
for (const bool bUserCancel : { false, true }) {
|
||||
GameMessages::ActivityStop msg;
|
||||
msg.target = target;
|
||||
msg.bExit = bExit;
|
||||
msg.bUserCancel = bUserCancel;
|
||||
ExpectSameAsLegacy([&](const SystemAddress& a) { LegacyGameMessages::SendActivityStop(target, bExit, bUserCancel, a); }, msg);
|
||||
|
||||
const auto copy = RoundTrip(msg);
|
||||
EXPECT_EQ(copy.bExit, bExit);
|
||||
EXPECT_EQ(copy.bUserCancel, bUserCancel);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
TEST_F(ActivityMessagesTests, ActivityPauseMatchesLegacy) {
|
||||
for (const auto target : g_Targets) {
|
||||
for (const bool bPause : { false, true }) {
|
||||
GameMessages::ActivityPause msg;
|
||||
msg.target = target;
|
||||
msg.bPause = bPause;
|
||||
ExpectSameAsLegacy([&](const SystemAddress& a) { LegacyGameMessages::SendActivityPause(target, bPause, a); }, msg);
|
||||
EXPECT_EQ(RoundTrip(msg).bPause, bPause);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
TEST_F(ActivityMessagesTests, StartActivityTimeMatchesLegacy) {
|
||||
for (const auto target : g_Targets) {
|
||||
for (const float startTime : { 0.0f, 30.0f, -1.5f, 1e-30f, std::numeric_limits<float>::max() }) {
|
||||
GameMessages::StartActivityTime msg;
|
||||
msg.target = target;
|
||||
msg.startTime = startTime;
|
||||
ExpectSameAsLegacy([&](const SystemAddress& a) { LegacyGameMessages::SendStartActivityTime(target, startTime, a); }, msg);
|
||||
EXPECT_EQ(RoundTrip(msg).startTime, startTime);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
TEST_F(ActivityMessagesTests, RequestActivityEnterMatchesLegacy) {
|
||||
for (const auto target : g_Targets) {
|
||||
for (const bool bStart : { false, true }) {
|
||||
for (const LWOOBJID userID : g_Targets) {
|
||||
GameMessages::RequestActivityEnter msg;
|
||||
msg.target = target;
|
||||
msg.bStart = bStart;
|
||||
msg.userID = userID;
|
||||
ExpectSameAsLegacy([&](const SystemAddress& a) { LegacyGameMessages::SendRequestActivityEnter(target, a, bStart, userID); }, msg);
|
||||
|
||||
const auto copy = RoundTrip(msg);
|
||||
EXPECT_EQ(copy.bStart, bStart);
|
||||
EXPECT_EQ(copy.userID, userID);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
TEST_F(ActivityMessagesTests, ShowActivityCountdownMatchesLegacy) {
|
||||
const std::u16string longName(300, u'é');
|
||||
for (const auto target : g_Targets) {
|
||||
for (const bool bPlayAdditionalSound : { false, true }) {
|
||||
for (const bool bPlayCountdownSound : { false, true }) {
|
||||
for (const std::u16string& sndName : { std::u16string(), std::u16string(u"sfx/minigame/countdown"), longName }) {
|
||||
for (const int32_t state : { 0, 3, -1 }) {
|
||||
GameMessages::ShowActivityCountdown msg;
|
||||
msg.target = target;
|
||||
msg.bPlayAdditionalSound = bPlayAdditionalSound;
|
||||
msg.bPlayCountdownSound = bPlayCountdownSound;
|
||||
msg.sndName = sndName;
|
||||
msg.stateToPlaySoundOn = state;
|
||||
ExpectSameAsLegacy([&](const SystemAddress& a) {
|
||||
LegacyGameMessages::SendShowActivityCountdown(target, bPlayAdditionalSound, bPlayCountdownSound, sndName, state, a);
|
||||
}, msg);
|
||||
|
||||
const auto copy = RoundTrip(msg);
|
||||
EXPECT_EQ(copy.bPlayAdditionalSound, bPlayAdditionalSound);
|
||||
EXPECT_EQ(copy.bPlayCountdownSound, bPlayCountdownSound);
|
||||
EXPECT_EQ(copy.sndName, sndName);
|
||||
EXPECT_EQ(copy.stateToPlaySoundOn, state);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Independent of the legacy code: pins the layout against hand computed bytes.
|
||||
TEST_F(ActivityMessagesTests, GoldenBytes) {
|
||||
// 53 | 05 00 (CLIENT) | 0c 00 00 00 (GAME_MSG) | 00 | target (LE i64) | msgId (LE u16) | payload
|
||||
GameMessages::ActivityStop stop;
|
||||
stop.target = 0x0102030405060708LL;
|
||||
stop.bExit = true;
|
||||
stop.bUserCancel = false;
|
||||
EXPECT_PACKET_EQ(FromHex("53 05 00 0c 00 00 00 00 08 07 06 05 04 03 02 01 98 01 80", 146), StructPacket(stop));
|
||||
|
||||
GameMessages::StartActivityTime time;
|
||||
time.target = 0x0102030405060708LL;
|
||||
time.startTime = 1.5f;
|
||||
EXPECT_PACKET_EQ(FromHex("53 05 00 0c 00 00 00 00 08 07 06 05 04 03 02 01 40 02 00 00 c0 3f"), StructPacket(time));
|
||||
}
|
||||
|
||||
TEST_F(ActivityMessagesTests, RequestActivityExitReadsLikeLegacy) {
|
||||
for (const bool bUserCancel : { false, true }) {
|
||||
for (const LWOOBJID userID : g_Targets) {
|
||||
RakNet::BitStream wire;
|
||||
wire.Write(bUserCancel);
|
||||
wire.Write(userID);
|
||||
|
||||
RakNet::BitStream legacyStream(wire.GetData(), wire.GetNumberOfBytesUsed(), false);
|
||||
const auto legacy = LegacyGameMessages::ReadRequestActivityExit(legacyStream);
|
||||
|
||||
RakNet::BitStream newStream(wire.GetData(), wire.GetNumberOfBytesUsed(), false);
|
||||
GameMessages::RequestActivityExit msg;
|
||||
ASSERT_TRUE(msg.Deserialize(newStream));
|
||||
|
||||
EXPECT_EQ(msg.bUserCancel, legacy.canceled);
|
||||
// The legacy handler only read userID (and only acted) when the exit was a user cancel.
|
||||
if (legacy.canceled) EXPECT_EQ(msg.userID, legacy.player_id);
|
||||
|
||||
RakNet::BitStream reserialized;
|
||||
msg.Serialize(reserialized);
|
||||
EXPECT_PACKET_EQ(FromBitStream(wire), FromBitStream(reserialized));
|
||||
}
|
||||
}
|
||||
|
||||
RakNet::BitStream truncated;
|
||||
truncated.Write(true);
|
||||
GameMessages::RequestActivityExit msg;
|
||||
EXPECT_FALSE(msg.Deserialize(truncated));
|
||||
}
|
||||
@@ -1,4 +1,5 @@
|
||||
SET(DGAMEMESSAGES_TESTS
|
||||
"ActivityMessagesTests.cpp"
|
||||
"GameMessageTests.cpp"
|
||||
"GameMsgSplitTests.cpp"
|
||||
"UnSmashTests.cpp"
|
||||
|
||||
@@ -0,0 +1,143 @@
|
||||
#ifndef ACTIVITYMESSAGESLEGACY_H
|
||||
#define ACTIVITYMESSAGESLEGACY_H
|
||||
|
||||
// FROZEN ORACLE - DO NOT EDIT.
|
||||
// Verbatim copies of the hand written GameMessages::Send* functions that ActivityMessages.h replaced
|
||||
// (dGame/dGameMessages/GameMessages.cpp at origin/main 129199e4). Only the namespace changed.
|
||||
// The byte-equality tests send the same inputs through these and through the new structs and require
|
||||
// identical bytes, so the wire format is pinned even after the production code is deleted.
|
||||
|
||||
#include "BitStreamUtils.h"
|
||||
#include "dCommonVars.h"
|
||||
#include "dServer.h"
|
||||
#include "Game.h"
|
||||
#include "MessageType/Client.h"
|
||||
#include "MessageType/Game.h"
|
||||
#include "ServiceType.h"
|
||||
|
||||
#include <cmath>
|
||||
#include <string>
|
||||
|
||||
namespace LegacyGameMessages {
|
||||
inline void SendActivityPause(LWOOBJID objectId, bool pause = false, const SystemAddress& sysAddr = UNASSIGNED_SYSTEM_ADDRESS) {
|
||||
CBITSTREAM;
|
||||
CMSGHEADER;
|
||||
|
||||
bitStream.Write(objectId);
|
||||
bitStream.Write(MessageType::Game::ACTIVITY_PAUSE);
|
||||
bitStream.Write(pause);
|
||||
|
||||
if (sysAddr == UNASSIGNED_SYSTEM_ADDRESS) SEND_PACKET_BROADCAST;
|
||||
SEND_PACKET;
|
||||
}
|
||||
|
||||
inline void SendStartActivityTime(LWOOBJID objectId, float_t startTime, const SystemAddress& sysAddr = UNASSIGNED_SYSTEM_ADDRESS) {
|
||||
CBITSTREAM;
|
||||
CMSGHEADER;
|
||||
|
||||
bitStream.Write(objectId);
|
||||
bitStream.Write(MessageType::Game::START_ACTIVITY_TIME);
|
||||
bitStream.Write<float_t>(startTime);
|
||||
|
||||
if (sysAddr == UNASSIGNED_SYSTEM_ADDRESS) SEND_PACKET_BROADCAST;
|
||||
SEND_PACKET;
|
||||
}
|
||||
|
||||
inline void SendRequestActivityEnter(LWOOBJID objectId, const SystemAddress& sysAddr, bool bStart, LWOOBJID userID) {
|
||||
CBITSTREAM;
|
||||
CMSGHEADER;
|
||||
|
||||
bitStream.Write(objectId);
|
||||
bitStream.Write(MessageType::Game::REQUEST_ACTIVITY_ENTER);
|
||||
bitStream.Write<bool>(bStart);
|
||||
bitStream.Write<LWOOBJID>(userID);
|
||||
|
||||
if (sysAddr == UNASSIGNED_SYSTEM_ADDRESS) SEND_PACKET_BROADCAST;
|
||||
SEND_PACKET;
|
||||
}
|
||||
|
||||
inline void SendActivityEnter(LWOOBJID objectId, const SystemAddress& sysAddr) {
|
||||
CBITSTREAM;
|
||||
CMSGHEADER;
|
||||
|
||||
bitStream.Write(objectId);
|
||||
bitStream.Write(MessageType::Game::ACTIVITY_ENTER);
|
||||
|
||||
if (sysAddr == UNASSIGNED_SYSTEM_ADDRESS) SEND_PACKET_BROADCAST;
|
||||
SEND_PACKET;
|
||||
}
|
||||
|
||||
inline void SendActivityStart(LWOOBJID objectId, const SystemAddress& sysAddr) {
|
||||
CBITSTREAM;
|
||||
CMSGHEADER;
|
||||
|
||||
bitStream.Write(objectId);
|
||||
bitStream.Write(MessageType::Game::ACTIVITY_START);
|
||||
|
||||
if (sysAddr == UNASSIGNED_SYSTEM_ADDRESS) SEND_PACKET_BROADCAST;
|
||||
SEND_PACKET;
|
||||
}
|
||||
|
||||
inline void SendActivityExit(LWOOBJID objectId, const SystemAddress& sysAddr) {
|
||||
CBITSTREAM;
|
||||
CMSGHEADER;
|
||||
|
||||
bitStream.Write(objectId);
|
||||
bitStream.Write(MessageType::Game::ACTIVITY_EXIT);
|
||||
|
||||
if (sysAddr == UNASSIGNED_SYSTEM_ADDRESS) SEND_PACKET_BROADCAST;
|
||||
SEND_PACKET;
|
||||
}
|
||||
|
||||
inline void SendActivityStop(LWOOBJID objectId, bool bExit, bool bUserCancel, const SystemAddress& sysAddr) {
|
||||
CBITSTREAM;
|
||||
CMSGHEADER;
|
||||
|
||||
bitStream.Write(objectId);
|
||||
bitStream.Write(MessageType::Game::ACTIVITY_STOP);
|
||||
|
||||
bitStream.Write(bExit);
|
||||
bitStream.Write(bUserCancel);
|
||||
|
||||
if (sysAddr == UNASSIGNED_SYSTEM_ADDRESS) SEND_PACKET_BROADCAST;
|
||||
SEND_PACKET;
|
||||
}
|
||||
|
||||
inline void SendShowActivityCountdown(LWOOBJID objectId, bool bPlayAdditionalSound, bool bPlayCountdownSound, std::u16string sndName, int32_t stateToPlaySoundOn, const SystemAddress& sysAddr) {
|
||||
CBITSTREAM;
|
||||
CMSGHEADER;
|
||||
|
||||
bitStream.Write(objectId);
|
||||
bitStream.Write(MessageType::Game::SHOW_ACTIVITY_COUNTDOWN);
|
||||
|
||||
bitStream.Write(bPlayAdditionalSound);
|
||||
|
||||
bitStream.Write(bPlayCountdownSound);
|
||||
|
||||
bitStream.Write<uint32_t>(sndName.size());
|
||||
for (auto character : sndName) {
|
||||
bitStream.Write(character);
|
||||
}
|
||||
|
||||
bitStream.Write(stateToPlaySoundOn);
|
||||
|
||||
if (sysAddr == UNASSIGNED_SYSTEM_ADDRESS) SEND_PACKET_BROADCAST;
|
||||
SEND_PACKET;
|
||||
}
|
||||
|
||||
// Inbound: the read sequence of the old GameMessages::HandleRequestActivityExit, returning what it read.
|
||||
struct LegacyRequestActivityExitRead {
|
||||
bool canceled = false;
|
||||
LWOOBJID player_id = LWOOBJID_EMPTY;
|
||||
};
|
||||
inline LegacyRequestActivityExitRead ReadRequestActivityExit(RakNet::BitStream& inStream) {
|
||||
LegacyRequestActivityExitRead result;
|
||||
inStream.Read(result.canceled);
|
||||
if (!result.canceled) return result;
|
||||
|
||||
inStream.Read(result.player_id);
|
||||
return result;
|
||||
}
|
||||
}
|
||||
|
||||
#endif // ACTIVITYMESSAGESLEGACY_H
|
||||
Reference in New Issue
Block a user