mirror of
https://github.com/DarkflameUniverse/DarkflameServer.git
synced 2026-10-15 09:04:10 +00:00
refactor: racing and vehicle game messages as structs
Converts the 12 racing / vehicle / modular assembly messages DLU sends
and the 8 it receives to NetGameMsgs in RacingMessages.{h,cpp}, adds
eRacingClientNotificationType for NotifyRacingClient's event type,
switches the callers (RacingControlComponent, CarBoostBehavior,
PossessorComponent, slash commands), registers the received messages
in GameMessageHandler's map and deletes the old functions. Handlers are
copied verbatim. Also moves the byte-equality test helpers into a
shared GameMessageTestUtils.h.
No wire change. Verified byte for byte against a frozen verbatim copy
of the old functions over an input grid, to one client and broadcast;
received messages compared with the old handlers' read sequences
(including all 16 optional-field combinations of
VehicleNotifyHitImaginationServer) and every truncated payload
rejected; hand computed golden bytes; round trips; a deliberate field
mutation made the tests fail. Layouts confirmed against the 1.10.64
client in Ghidra. Malformed received messages are
dropped (see the foundations commit).
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
Aaron Kimbrell
@@ -1,6 +1,6 @@
|
||||
#include "ActivityMessages.h"
|
||||
#include "GameDependencies.h"
|
||||
#include "PacketTestUtils.h"
|
||||
#include "GameMessageTestUtils.h"
|
||||
#include "Legacy/ActivityMessagesLegacy.h"
|
||||
|
||||
#include <array>
|
||||
@@ -10,60 +10,7 @@
|
||||
|
||||
#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;
|
||||
}
|
||||
}
|
||||
using namespace GameMessageTestUtils;
|
||||
|
||||
class ActivityMessagesTests : public GameDependenciesTest {
|
||||
protected:
|
||||
|
||||
@@ -2,6 +2,7 @@ SET(DGAMEMESSAGES_TESTS
|
||||
"ActivityMessagesTests.cpp"
|
||||
"GameMessageTests.cpp"
|
||||
"GameMsgSplitTests.cpp"
|
||||
"RacingMessagesTests.cpp"
|
||||
"UnSmashTests.cpp"
|
||||
"LegacyGameMessageTests.cpp")
|
||||
|
||||
|
||||
86
tests/dGameTests/dGameMessagesTests/GameMessageTestUtils.h
Normal file
86
tests/dGameTests/dGameMessagesTests/GameMessageTestUtils.h
Normal file
@@ -0,0 +1,86 @@
|
||||
#ifndef GAMEMESSAGETESTUTILS_H
|
||||
#define GAMEMESSAGETESTUTILS_H
|
||||
|
||||
// Shared helpers for the byte-equality tests of converted game messages (see docs/PacketArchitecture.md).
|
||||
|
||||
#include "GameMessages.h"
|
||||
#include "PacketTestUtils.h"
|
||||
|
||||
#include <array>
|
||||
#include <functional>
|
||||
|
||||
#include <gtest/gtest.h>
|
||||
|
||||
namespace GameMessageTestUtils {
|
||||
using namespace PacketTestUtils;
|
||||
|
||||
inline SystemAddress ClientAddress() {
|
||||
SystemAddress address;
|
||||
address.binaryAddress = 0x0100007f;
|
||||
address.port = 2003;
|
||||
return address;
|
||||
}
|
||||
|
||||
// Synthetic object IDs: empty, a player-style ID and one with every byte different.
|
||||
inline const std::array<LWOOBJID, 3> g_Targets = { LWOOBJID_EMPTY, 0x1000000000000001LL, 0x0102030405060708LL };
|
||||
inline const std::array<SystemAddress, 2> g_Addresses = { ClientAddress(), UNASSIGNED_SYSTEM_ADDRESS };
|
||||
|
||||
// The complete packet msg.Send(sysAddr) puts on the wire.
|
||||
inline 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.
|
||||
// legacySend receives the address to send to.
|
||||
inline 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 copy consumed every bit and serializes to the
|
||||
// same bytes. Returns the copy so callers can compare fields.
|
||||
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;
|
||||
}
|
||||
|
||||
// Checks that every strict prefix of msg's serialized payload fails to deserialize.
|
||||
template<typename T>
|
||||
void ExpectTruncatedFails(const T& msg) {
|
||||
RakNet::BitStream full;
|
||||
msg.Serialize(full);
|
||||
for (uint32_t bits = 0; bits < full.GetNumberOfBitsUsed(); bits++) {
|
||||
RakNet::BitStream prefix;
|
||||
prefix.WriteBits(full.GetData(), bits, false);
|
||||
T copy;
|
||||
EXPECT_FALSE(copy.Deserialize(prefix)) << "deserialized from only " << bits << " bits";
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#endif // GAMEMESSAGETESTUTILS_H
|
||||
@@ -0,0 +1,240 @@
|
||||
#ifndef RACINGMESSAGESLEGACY_H
|
||||
#define RACINGMESSAGESLEGACY_H
|
||||
|
||||
// FROZEN ORACLE - DO NOT EDIT.
|
||||
// Verbatim copies of the hand written GameMessages::Send* functions that RacingMessages.h replaced
|
||||
// (dGame/dGameMessages/GameMessages.cpp, branched from origin/main 129199e4). Only the namespace changed.
|
||||
// The Read* functions are the read sequences of the replaced GameMessages::Handle* functions, verbatim up to
|
||||
// the point where the handler starts using what it read.
|
||||
|
||||
#include "BitStreamUtils.h"
|
||||
#include "dCommonVars.h"
|
||||
#include "dServer.h"
|
||||
#include "Entity.h"
|
||||
#include "Game.h"
|
||||
#include "MessageType/Client.h"
|
||||
#include "MessageType/Game.h"
|
||||
#include "NiPoint3.h"
|
||||
#include "ServiceType.h"
|
||||
|
||||
#include <string>
|
||||
|
||||
namespace LegacyGameMessages {
|
||||
inline void SendModuleAssemblyDBDataForClient(LWOOBJID objectId, LWOOBJID assemblyID, const std::u16string& data, const SystemAddress& sysAddr) {
|
||||
CBITSTREAM;
|
||||
CMSGHEADER;
|
||||
|
||||
bitStream.Write(objectId);
|
||||
bitStream.Write(MessageType::Game::MODULE_ASSEMBLY_DB_DATA_FOR_CLIENT);
|
||||
|
||||
bitStream.Write(assemblyID);
|
||||
|
||||
bitStream.Write<uint32_t>(data.size());
|
||||
for (auto character : data) {
|
||||
bitStream.Write(character);
|
||||
}
|
||||
|
||||
if (sysAddr == UNASSIGNED_SYSTEM_ADDRESS) SEND_PACKET_BROADCAST;
|
||||
SEND_PACKET;
|
||||
}
|
||||
|
||||
inline void SendNotifyVehicleOfRacingObject(LWOOBJID objectId, LWOOBJID racingObjectID, const SystemAddress& sysAddr) {
|
||||
CBITSTREAM;
|
||||
CMSGHEADER;
|
||||
|
||||
bitStream.Write(objectId);
|
||||
bitStream.Write(MessageType::Game::NOTIFY_VEHICLE_OF_RACING_OBJECT);
|
||||
|
||||
bitStream.Write(racingObjectID != LWOOBJID_EMPTY);
|
||||
if (racingObjectID != LWOOBJID_EMPTY) bitStream.Write(racingObjectID);
|
||||
|
||||
if (sysAddr == UNASSIGNED_SYSTEM_ADDRESS) SEND_PACKET_BROADCAST;
|
||||
SEND_PACKET;
|
||||
}
|
||||
|
||||
inline void SendRacingPlayerLoaded(LWOOBJID objectId, LWOOBJID playerID, LWOOBJID vehicleID, const SystemAddress& sysAddr) {
|
||||
CBITSTREAM;
|
||||
CMSGHEADER;
|
||||
|
||||
bitStream.Write(objectId);
|
||||
bitStream.Write(MessageType::Game::RACING_PLAYER_LOADED);
|
||||
|
||||
bitStream.Write(playerID);
|
||||
bitStream.Write(vehicleID);
|
||||
|
||||
if (sysAddr == UNASSIGNED_SYSTEM_ADDRESS) SEND_PACKET_BROADCAST;
|
||||
SEND_PACKET;
|
||||
}
|
||||
|
||||
inline void SendVehicleUnlockInput(LWOOBJID objectId, bool bLockWheels, const SystemAddress& sysAddr) {
|
||||
CBITSTREAM;
|
||||
CMSGHEADER;
|
||||
|
||||
bitStream.Write(objectId);
|
||||
bitStream.Write(MessageType::Game::VEHICLE_UNLOCK_INPUT);
|
||||
|
||||
bitStream.Write(bLockWheels);
|
||||
|
||||
if (sysAddr == UNASSIGNED_SYSTEM_ADDRESS) SEND_PACKET_BROADCAST;
|
||||
SEND_PACKET;
|
||||
}
|
||||
|
||||
inline void SendVehicleSetWheelLockState(LWOOBJID objectId, bool bExtraFriction, bool bLocked, const SystemAddress& sysAddr) {
|
||||
CBITSTREAM;
|
||||
CMSGHEADER;
|
||||
|
||||
bitStream.Write(objectId);
|
||||
bitStream.Write(MessageType::Game::VEHICLE_SET_WHEEL_LOCK_STATE);
|
||||
|
||||
bitStream.Write(bExtraFriction);
|
||||
bitStream.Write(bLocked);
|
||||
|
||||
if (sysAddr == UNASSIGNED_SYSTEM_ADDRESS) SEND_PACKET_BROADCAST;
|
||||
SEND_PACKET;
|
||||
}
|
||||
|
||||
inline void SendRacingSetPlayerResetInfo(LWOOBJID objectId, int32_t currentLap, uint32_t furthestResetPlane, LWOOBJID playerID, NiPoint3 respawnPos, uint32_t upcomingPlane, const SystemAddress& sysAddr) {
|
||||
CBITSTREAM;
|
||||
CMSGHEADER;
|
||||
|
||||
bitStream.Write(objectId);
|
||||
bitStream.Write(MessageType::Game::RACING_SET_PLAYER_RESET_INFO);
|
||||
|
||||
bitStream.Write(currentLap);
|
||||
bitStream.Write(furthestResetPlane);
|
||||
bitStream.Write(playerID);
|
||||
bitStream.Write(respawnPos);
|
||||
bitStream.Write(upcomingPlane);
|
||||
|
||||
if (sysAddr == UNASSIGNED_SYSTEM_ADDRESS) SEND_PACKET_BROADCAST;
|
||||
SEND_PACKET;
|
||||
}
|
||||
|
||||
inline void SendRacingResetPlayerToLastReset(LWOOBJID objectId, LWOOBJID playerID, const SystemAddress& sysAddr) {
|
||||
CBITSTREAM;
|
||||
CMSGHEADER;
|
||||
|
||||
bitStream.Write(objectId);
|
||||
bitStream.Write(MessageType::Game::RACING_RESET_PLAYER_TO_LAST_RESET);
|
||||
|
||||
bitStream.Write(playerID);
|
||||
|
||||
if (sysAddr == UNASSIGNED_SYSTEM_ADDRESS) SEND_PACKET_BROADCAST;
|
||||
SEND_PACKET;
|
||||
}
|
||||
|
||||
inline void SendVehicleStopBoost(Entity* targetEntity, const SystemAddress& playerSysAddr, bool affectPassive) {
|
||||
CBITSTREAM;
|
||||
CMSGHEADER;
|
||||
|
||||
bitStream.Write(targetEntity->GetObjectID());
|
||||
bitStream.Write(MessageType::Game::VEHICLE_STOP_BOOST);
|
||||
|
||||
bitStream.Write(affectPassive);
|
||||
|
||||
SEND_PACKET_BROADCAST;
|
||||
}
|
||||
|
||||
inline void SendNotifyRacingClient(LWOOBJID objectId, int32_t eventType, int32_t param1, LWOOBJID paramObj, std::u16string paramStr, LWOOBJID singleClient, const SystemAddress& sysAddr) {
|
||||
CBITSTREAM;
|
||||
CMSGHEADER;
|
||||
|
||||
bitStream.Write(objectId);
|
||||
bitStream.Write(MessageType::Game::NOTIFY_RACING_CLIENT);
|
||||
|
||||
bitStream.Write(eventType != 0);
|
||||
if (eventType != 0) bitStream.Write(eventType);
|
||||
|
||||
bitStream.Write(param1);
|
||||
|
||||
bitStream.Write(paramObj);
|
||||
|
||||
bitStream.Write<uint32_t>(paramStr.size());
|
||||
for (auto character : paramStr) {
|
||||
bitStream.Write(character);
|
||||
}
|
||||
|
||||
bitStream.Write(singleClient);
|
||||
|
||||
if (sysAddr == UNASSIGNED_SYSTEM_ADDRESS) SEND_PACKET_BROADCAST;
|
||||
SEND_PACKET;
|
||||
}
|
||||
|
||||
inline void SendVehicleAddPassiveBoostAction(LWOOBJID objectId, const SystemAddress& sysAddr) {
|
||||
CBITSTREAM;
|
||||
CMSGHEADER;
|
||||
|
||||
bitStream.Write(objectId);
|
||||
bitStream.Write(MessageType::Game::VEHICLE_ADD_PASSIVE_BOOST_ACTION);
|
||||
|
||||
if (sysAddr == UNASSIGNED_SYSTEM_ADDRESS) SEND_PACKET_BROADCAST;
|
||||
SEND_PACKET;
|
||||
}
|
||||
|
||||
inline void SendVehicleRemovePassiveBoostAction(LWOOBJID objectId, const SystemAddress& sysAddr) {
|
||||
CBITSTREAM;
|
||||
CMSGHEADER;
|
||||
|
||||
bitStream.Write(objectId);
|
||||
bitStream.Write(MessageType::Game::VEHICLE_REMOVE_PASSIVE_BOOST_ACTION);
|
||||
|
||||
if (sysAddr == UNASSIGNED_SYSTEM_ADDRESS) SEND_PACKET_BROADCAST;
|
||||
SEND_PACKET;
|
||||
}
|
||||
|
||||
inline void SendVehicleNotifyFinishedRace(LWOOBJID objectId, const SystemAddress& sysAddr) {
|
||||
CBITSTREAM;
|
||||
CMSGHEADER;
|
||||
|
||||
bitStream.Write(objectId);
|
||||
bitStream.Write(MessageType::Game::VEHICLE_NOTIFY_FINISHED_RACE);
|
||||
|
||||
if (sysAddr == UNASSIGNED_SYSTEM_ADDRESS) SEND_PACKET_BROADCAST;
|
||||
SEND_PACKET;
|
||||
}
|
||||
|
||||
// GameMessages::HandleModularAssemblyNIFCompleted
|
||||
inline LWOOBJID ReadModularAssemblyNIFCompleted(RakNet::BitStream& inStream) {
|
||||
LWOOBJID objectID;
|
||||
|
||||
inStream.Read(objectID);
|
||||
return objectID;
|
||||
}
|
||||
|
||||
// GameMessages::HandleVehicleSetWheelLockState
|
||||
inline std::pair<bool, bool> ReadVehicleSetWheelLockState(RakNet::BitStream& inStream) {
|
||||
bool bExtraFriction = inStream.ReadBit();
|
||||
bool bLocked = inStream.ReadBit();
|
||||
return { bExtraFriction, bLocked };
|
||||
}
|
||||
|
||||
// GameMessages::HandleRacingClientReady and GameMessages::HandleRacingPlayerInfoResetFinished
|
||||
inline LWOOBJID ReadRacingPlayerID(RakNet::BitStream& inStream) {
|
||||
LWOOBJID playerID;
|
||||
|
||||
inStream.Read(playerID);
|
||||
return playerID;
|
||||
}
|
||||
|
||||
// GameMessages::HandleVehicleNotifyHitImaginationServer
|
||||
struct LegacyHitImagination {
|
||||
LWOOBJID pickupObjID = LWOOBJID_EMPTY;
|
||||
LWOOBJID pickupSpawnerID = LWOOBJID_EMPTY;
|
||||
int32_t pickupSpawnerIndex = -1;
|
||||
NiPoint3 vehiclePosition = NiPoint3Constant::ZERO;
|
||||
};
|
||||
inline LegacyHitImagination ReadVehicleNotifyHitImaginationServer(RakNet::BitStream& inStream) {
|
||||
LWOOBJID pickupObjID = LWOOBJID_EMPTY;
|
||||
LWOOBJID pickupSpawnerID = LWOOBJID_EMPTY;
|
||||
int32_t pickupSpawnerIndex = -1;
|
||||
NiPoint3 vehiclePosition = NiPoint3Constant::ZERO;
|
||||
|
||||
if (inStream.ReadBit()) inStream.Read(pickupObjID);
|
||||
if (inStream.ReadBit()) inStream.Read(pickupSpawnerID);
|
||||
if (inStream.ReadBit()) inStream.Read(pickupSpawnerIndex);
|
||||
if (inStream.ReadBit()) inStream.Read(vehiclePosition);
|
||||
return { pickupObjID, pickupSpawnerID, pickupSpawnerIndex, vehiclePosition };
|
||||
}
|
||||
}
|
||||
|
||||
#endif // RACINGMESSAGESLEGACY_H
|
||||
320
tests/dGameTests/dGameMessagesTests/RacingMessagesTests.cpp
Normal file
320
tests/dGameTests/dGameMessagesTests/RacingMessagesTests.cpp
Normal file
@@ -0,0 +1,320 @@
|
||||
#include "RacingMessages.h"
|
||||
#include "GameDependencies.h"
|
||||
#include "GameMessageTestUtils.h"
|
||||
#include "Legacy/RacingMessagesLegacy.h"
|
||||
|
||||
#include <cstdio>
|
||||
#include <functional>
|
||||
#include <limits>
|
||||
#include <string>
|
||||
#include <vector>
|
||||
|
||||
#include <gtest/gtest.h>
|
||||
|
||||
using namespace GameMessageTestUtils;
|
||||
|
||||
// eRacingClientNotificationType goes on the wire; pin its values.
|
||||
static_assert(static_cast<int32_t>(eRacingClientNotificationType::INVALID) == 0);
|
||||
static_assert(static_cast<int32_t>(eRacingClientNotificationType::ACTIVITY_START) == 1);
|
||||
static_assert(static_cast<int32_t>(eRacingClientNotificationType::REWARD_PLAYER) == 2);
|
||||
static_assert(static_cast<int32_t>(eRacingClientNotificationType::EXIT) == 3);
|
||||
static_assert(static_cast<int32_t>(eRacingClientNotificationType::REPLAY) == 4);
|
||||
static_assert(static_cast<int32_t>(eRacingClientNotificationType::REMOVE_PLAYER) == 5);
|
||||
static_assert(static_cast<int32_t>(eRacingClientNotificationType::LEADERBOARD_UPDATED) == 6);
|
||||
|
||||
namespace {
|
||||
const std::vector<std::u16string> g_Strings = { u"", u"a", u"1:8092;2:4880;3:7503;", std::u16string(300, u'é') };
|
||||
const std::vector<NiPoint3> g_Points = { NiPoint3Constant::ZERO, NiPoint3(1.0f, -2.5f, 1e6f), NiPoint3(0.0f, 0.0f, -0.0f) };
|
||||
}
|
||||
|
||||
class RacingMessagesTests : public GameDependenciesTest {
|
||||
protected:
|
||||
void SetUp() override { SetUpDependencies(); }
|
||||
void TearDown() override { TearDownDependencies(); }
|
||||
};
|
||||
|
||||
TEST_F(RacingMessagesTests, NoPayloadMessagesMatchLegacy) {
|
||||
for (const auto target : g_Targets) {
|
||||
GameMessages::VehicleAddPassiveBoostAction add;
|
||||
add.target = target;
|
||||
ExpectSameAsLegacy([&](const SystemAddress& a) { LegacyGameMessages::SendVehicleAddPassiveBoostAction(target, a); }, add);
|
||||
|
||||
GameMessages::VehicleRemovePassiveBoostAction remove;
|
||||
remove.target = target;
|
||||
ExpectSameAsLegacy([&](const SystemAddress& a) { LegacyGameMessages::SendVehicleRemovePassiveBoostAction(target, a); }, remove);
|
||||
|
||||
GameMessages::VehicleNotifyFinishedRace finished;
|
||||
finished.target = target;
|
||||
ExpectSameAsLegacy([&](const SystemAddress& a) { LegacyGameMessages::SendVehicleNotifyFinishedRace(target, a); }, finished);
|
||||
}
|
||||
}
|
||||
|
||||
TEST_F(RacingMessagesTests, ModuleAssemblyDBDataForClientMatchesLegacy) {
|
||||
for (const auto target : g_Targets) {
|
||||
for (const auto assemblyID : g_Targets) {
|
||||
for (const auto& blob : g_Strings) {
|
||||
GameMessages::ModuleAssemblyDBDataForClient msg;
|
||||
msg.target = target;
|
||||
msg.assemblyID = assemblyID;
|
||||
msg.blob = blob;
|
||||
ExpectSameAsLegacy([&](const SystemAddress& a) { LegacyGameMessages::SendModuleAssemblyDBDataForClient(target, assemblyID, blob, a); }, msg);
|
||||
const auto copy = RoundTrip(msg);
|
||||
EXPECT_EQ(copy.assemblyID, assemblyID);
|
||||
EXPECT_EQ(copy.blob, blob);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
TEST_F(RacingMessagesTests, NotifyVehicleOfRacingObjectMatchesLegacy) {
|
||||
for (const auto target : g_Targets) {
|
||||
for (const auto racingObjectID : g_Targets) {
|
||||
GameMessages::NotifyVehicleOfRacingObject msg;
|
||||
msg.target = target;
|
||||
msg.racingObjectID = racingObjectID;
|
||||
ExpectSameAsLegacy([&](const SystemAddress& a) { LegacyGameMessages::SendNotifyVehicleOfRacingObject(target, racingObjectID, a); }, msg);
|
||||
EXPECT_EQ(RoundTrip(msg).racingObjectID, racingObjectID);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
TEST_F(RacingMessagesTests, RacingPlayerLoadedMatchesLegacy) {
|
||||
for (const auto target : g_Targets) {
|
||||
for (const auto playerID : g_Targets) {
|
||||
for (const auto vehicleID : g_Targets) {
|
||||
GameMessages::RacingPlayerLoaded msg;
|
||||
msg.target = target;
|
||||
msg.playerID = playerID;
|
||||
msg.vehicleID = vehicleID;
|
||||
ExpectSameAsLegacy([&](const SystemAddress& a) { LegacyGameMessages::SendRacingPlayerLoaded(target, playerID, vehicleID, a); }, msg);
|
||||
const auto copy = RoundTrip(msg);
|
||||
EXPECT_EQ(copy.playerID, playerID);
|
||||
EXPECT_EQ(copy.vehicleID, vehicleID);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
TEST_F(RacingMessagesTests, VehicleUnlockInputMatchesLegacy) {
|
||||
for (const auto target : g_Targets) {
|
||||
for (const bool bLockWheels : { false, true }) {
|
||||
GameMessages::VehicleUnlockInput msg;
|
||||
msg.target = target;
|
||||
msg.bLockWheels = bLockWheels;
|
||||
ExpectSameAsLegacy([&](const SystemAddress& a) { LegacyGameMessages::SendVehicleUnlockInput(target, bLockWheels, a); }, msg);
|
||||
EXPECT_EQ(RoundTrip(msg).bLockWheels, bLockWheels);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
TEST_F(RacingMessagesTests, VehicleSetWheelLockStateMatchesLegacy) {
|
||||
for (const auto target : g_Targets) {
|
||||
for (const bool bExtraFriction : { false, true }) {
|
||||
for (const bool bLocked : { false, true }) {
|
||||
GameMessages::VehicleSetWheelLockState msg;
|
||||
msg.target = target;
|
||||
msg.bExtraFriction = bExtraFriction;
|
||||
msg.bLocked = bLocked;
|
||||
ExpectSameAsLegacy([&](const SystemAddress& a) { LegacyGameMessages::SendVehicleSetWheelLockState(target, bExtraFriction, bLocked, a); }, msg);
|
||||
const auto copy = RoundTrip(msg);
|
||||
EXPECT_EQ(copy.bExtraFriction, bExtraFriction);
|
||||
EXPECT_EQ(copy.bLocked, bLocked);
|
||||
|
||||
// Inbound: same read as the old handler.
|
||||
RakNet::BitStream wire;
|
||||
msg.Serialize(wire);
|
||||
RakNet::BitStream legacyStream(wire.GetData(), wire.GetNumberOfBytesUsed(), false);
|
||||
const auto [legacyFriction, legacyLocked] = LegacyGameMessages::ReadVehicleSetWheelLockState(legacyStream);
|
||||
EXPECT_EQ(legacyFriction, bExtraFriction);
|
||||
EXPECT_EQ(legacyLocked, bLocked);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
TEST_F(RacingMessagesTests, RacingSetPlayerResetInfoMatchesLegacy) {
|
||||
for (const auto target : g_Targets) {
|
||||
for (const int32_t currentLap : { 0, 3, -1, std::numeric_limits<int32_t>::max() }) {
|
||||
for (const uint32_t furthestResetPlane : { 0u, 7u, std::numeric_limits<uint32_t>::max() }) {
|
||||
for (const auto& respawnPos : g_Points) {
|
||||
const LWOOBJID playerID = 0x1000000000000001LL;
|
||||
const uint32_t upcomingPlane = furthestResetPlane + 1;
|
||||
GameMessages::RacingSetPlayerResetInfo msg;
|
||||
msg.target = target;
|
||||
msg.currentLap = currentLap;
|
||||
msg.furthestResetPlane = furthestResetPlane;
|
||||
msg.playerID = playerID;
|
||||
msg.respawnPos = respawnPos;
|
||||
msg.upcomingPlane = upcomingPlane;
|
||||
ExpectSameAsLegacy([&](const SystemAddress& a) {
|
||||
LegacyGameMessages::SendRacingSetPlayerResetInfo(target, currentLap, furthestResetPlane, playerID, respawnPos, upcomingPlane, a);
|
||||
}, msg);
|
||||
const auto copy = RoundTrip(msg);
|
||||
EXPECT_EQ(copy.currentLap, currentLap);
|
||||
EXPECT_EQ(copy.furthestResetPlane, furthestResetPlane);
|
||||
EXPECT_EQ(copy.respawnPos, respawnPos);
|
||||
EXPECT_EQ(copy.upcomingPlane, upcomingPlane);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
TEST_F(RacingMessagesTests, RacingResetPlayerToLastResetMatchesLegacy) {
|
||||
for (const auto target : g_Targets) {
|
||||
for (const auto playerID : g_Targets) {
|
||||
GameMessages::RacingResetPlayerToLastReset msg;
|
||||
msg.target = target;
|
||||
msg.playerID = playerID;
|
||||
ExpectSameAsLegacy([&](const SystemAddress& a) { LegacyGameMessages::SendRacingResetPlayerToLastReset(target, playerID, a); }, msg);
|
||||
EXPECT_EQ(RoundTrip(msg).playerID, playerID);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
TEST_F(RacingMessagesTests, VehicleStopBoostMatchesLegacy) {
|
||||
// The legacy function always broadcast, whatever address it was given; callers now pass UNASSIGNED explicitly.
|
||||
for (const auto target : g_Targets) {
|
||||
for (const bool bAffectPassive : { false, true }) {
|
||||
Entity vehicle(target, info);
|
||||
GameMessages::VehicleStopBoost msg;
|
||||
msg.target = target;
|
||||
msg.bAffectPassive = bAffectPassive;
|
||||
|
||||
const auto legacyPackets = Capture([&] { LegacyGameMessages::SendVehicleStopBoost(&vehicle, ClientAddress(), bAffectPassive); });
|
||||
const auto newPackets = Capture([&] { msg.Send(UNASSIGNED_SYSTEM_ADDRESS); });
|
||||
ASSERT_EQ(legacyPackets.size(), 1);
|
||||
ASSERT_EQ(newPackets.size(), 1);
|
||||
EXPECT_TRUE(legacyPackets[0].broadcast);
|
||||
EXPECT_TRUE(newPackets[0].broadcast);
|
||||
EXPECT_PACKET_EQ(FromCapture(legacyPackets[0]), FromCapture(newPackets[0]));
|
||||
EXPECT_EQ(RoundTrip(msg).bAffectPassive, bAffectPassive);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
TEST_F(RacingMessagesTests, NotifyRacingClientMatchesLegacy) {
|
||||
for (const auto target : g_Targets) {
|
||||
for (const int32_t eventType : { 0, 1, 2, 3, 6, -5 }) {
|
||||
for (const int32_t param1 : { 0, 1, -1 }) {
|
||||
for (const auto paramObj : g_Targets) {
|
||||
for (const auto& paramStr : g_Strings) {
|
||||
const LWOOBJID singleClient = paramObj == LWOOBJID_EMPTY ? 0x1000000000000001LL : LWOOBJID_EMPTY;
|
||||
GameMessages::NotifyRacingClient msg;
|
||||
msg.target = target;
|
||||
msg.eventType = static_cast<eRacingClientNotificationType>(eventType);
|
||||
msg.param1 = param1;
|
||||
msg.paramObj = paramObj;
|
||||
msg.paramStr = paramStr;
|
||||
msg.singleClient = singleClient;
|
||||
ExpectSameAsLegacy([&](const SystemAddress& a) {
|
||||
LegacyGameMessages::SendNotifyRacingClient(target, eventType, param1, paramObj, paramStr, singleClient, a);
|
||||
}, msg);
|
||||
const auto copy = RoundTrip(msg);
|
||||
EXPECT_EQ(copy.eventType, msg.eventType);
|
||||
EXPECT_EQ(copy.param1, param1);
|
||||
EXPECT_EQ(copy.paramObj, paramObj);
|
||||
EXPECT_EQ(copy.paramStr, paramStr);
|
||||
EXPECT_EQ(copy.singleClient, singleClient);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Independent of the legacy code: hand computed payloads (RakNet writes MSB first).
|
||||
TEST_F(RacingMessagesTests, GoldenBytes) {
|
||||
auto payload = [](const GameMessages::NetGameMsg& msg) {
|
||||
RakNet::BitStream bitStream;
|
||||
msg.Serialize(bitStream);
|
||||
return FromBitStream(bitStream);
|
||||
};
|
||||
|
||||
GameMessages::NotifyVehicleOfRacingObject notifyVehicle;
|
||||
notifyVehicle.racingObjectID = 0x0102030405060708LL;
|
||||
EXPECT_PACKET_EQ(FromHex("84 03 83 02 82 01 81 00 80", 65), payload(notifyVehicle));
|
||||
notifyVehicle.racingObjectID = LWOOBJID_EMPTY;
|
||||
EXPECT_PACKET_EQ(FromHex("00", 1), payload(notifyVehicle));
|
||||
|
||||
GameMessages::NotifyRacingClient notify;
|
||||
notify.eventType = eRacingClientNotificationType::EXIT;
|
||||
notify.param1 = 5;
|
||||
notify.paramObj = 0x11;
|
||||
notify.paramStr = u"ab";
|
||||
notify.singleClient = 0x22;
|
||||
EXPECT_PACKET_EQ(FromHex("81 80 00 00 02 80 00 00 08 80 00 00 00 00 00 00 01 00 00 00 30 80 31 00 11 00 00 00 00 00 00 00 00", 257), payload(notify));
|
||||
GameMessages::NotifyRacingClient notifyDefault;
|
||||
EXPECT_PACKET_EQ(FromHex("00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00", 193), payload(notifyDefault));
|
||||
|
||||
GameMessages::RacingSetPlayerResetInfo reset;
|
||||
reset.currentLap = 2;
|
||||
reset.furthestResetPlane = 7;
|
||||
reset.playerID = 0x0102030405060708LL;
|
||||
reset.respawnPos = NiPoint3(1.0f, 2.0f, -3.0f);
|
||||
reset.upcomingPlane = 8;
|
||||
EXPECT_PACKET_EQ(FromHex("02 00 00 00 07 00 00 00 08 07 06 05 04 03 02 01 00 00 80 3f 00 00 00 40 00 00 40 c0 08 00 00 00"), payload(reset));
|
||||
|
||||
// Full packet: 53 | CLIENT | GAME_MSG | 00 | target | msgId | payload
|
||||
GameMessages::RacingPlayerLoaded loaded;
|
||||
loaded.target = 0x0102030405060708LL;
|
||||
loaded.playerID = 0x11;
|
||||
loaded.vehicleID = 0x22;
|
||||
const auto msgId = static_cast<uint16_t>(MessageType::Game::RACING_PLAYER_LOADED);
|
||||
char idHex[8];
|
||||
std::snprintf(idHex, sizeof(idHex), "%02x %02x", msgId & 0xff, msgId >> 8);
|
||||
EXPECT_PACKET_EQ(FromHex(std::string("53 05 00 0c 00 00 00 00 08 07 06 05 04 03 02 01 ") + idHex + " 11 00 00 00 00 00 00 00 22 00 00 00 00 00 00 00"), StructPacket(loaded));
|
||||
}
|
||||
|
||||
TEST_F(RacingMessagesTests, InboundReadsLikeLegacy) {
|
||||
for (const auto id : g_Targets) {
|
||||
{
|
||||
GameMessages::ModularAssemblyNIFCompleted msg;
|
||||
msg.objectID = id;
|
||||
RakNet::BitStream wire;
|
||||
msg.Serialize(wire);
|
||||
RakNet::BitStream legacyStream(wire.GetData(), wire.GetNumberOfBytesUsed(), false);
|
||||
EXPECT_EQ(LegacyGameMessages::ReadModularAssemblyNIFCompleted(legacyStream), id);
|
||||
EXPECT_EQ(RoundTrip(msg).objectID, id);
|
||||
ExpectTruncatedFails(msg);
|
||||
}
|
||||
{
|
||||
GameMessages::RacingClientReady ready;
|
||||
ready.playerID = id;
|
||||
GameMessages::RacingPlayerInfoResetFinished finished;
|
||||
finished.playerID = id;
|
||||
for (const GameMessages::NetGameMsg* msg : std::initializer_list<const GameMessages::NetGameMsg*>{ &ready, &finished }) {
|
||||
RakNet::BitStream wire;
|
||||
msg->Serialize(wire);
|
||||
RakNet::BitStream legacyStream(wire.GetData(), wire.GetNumberOfBytesUsed(), false);
|
||||
EXPECT_EQ(LegacyGameMessages::ReadRacingPlayerID(legacyStream), id);
|
||||
}
|
||||
EXPECT_EQ(RoundTrip(ready).playerID, id);
|
||||
EXPECT_EQ(RoundTrip(finished).playerID, id);
|
||||
ExpectTruncatedFails(ready);
|
||||
ExpectTruncatedFails(finished);
|
||||
}
|
||||
}
|
||||
|
||||
// VehicleNotifyHitImaginationServer: every combination of present/absent optional fields.
|
||||
for (int mask = 0; mask < 16; mask++) {
|
||||
GameMessages::VehicleNotifyHitImaginationServer msg;
|
||||
if (mask & 1) msg.pickupObjID = 0x0102030405060708LL;
|
||||
if (mask & 2) msg.pickupSpawnerID = 0x1000000000000001LL;
|
||||
if (mask & 4) msg.pickupSpawnerIndex = 12;
|
||||
if (mask & 8) msg.vehiclePosition = NiPoint3(1.0f, 2.0f, 3.0f);
|
||||
|
||||
RakNet::BitStream wire;
|
||||
msg.Serialize(wire);
|
||||
RakNet::BitStream legacyStream(wire.GetData(), wire.GetNumberOfBytesUsed(), false);
|
||||
const auto legacy = LegacyGameMessages::ReadVehicleNotifyHitImaginationServer(legacyStream);
|
||||
EXPECT_EQ(legacyStream.GetReadOffset(), wire.GetNumberOfBitsUsed()); // both read exactly the same bits
|
||||
|
||||
const auto copy = RoundTrip(msg);
|
||||
EXPECT_EQ(copy.pickupObjID, legacy.pickupObjID);
|
||||
EXPECT_EQ(copy.pickupSpawnerID, legacy.pickupSpawnerID);
|
||||
EXPECT_EQ(copy.pickupSpawnerIndex, legacy.pickupSpawnerIndex);
|
||||
EXPECT_EQ(copy.vehiclePosition, legacy.vehiclePosition);
|
||||
ExpectTruncatedFails(msg);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user