jeirmeister/Cockatrice
1
0
Fork 0
mirror of https://github.com/Cockatrice/Cockatrice.git synced 2026-11-13 05:20:00 -08:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

[Game] Single chat message when a card transforms (#4764)

Browse source 
Transform currently logs "X destroys Y." followed by "X creates token: Z."
because the server implements it as DestroyCard + CreateToken events.

- Add Context_TransformCard (protocol extension 1010) to the transform
  event batch and a unit test asserting the server attaches it
- Suppress the destroy/create pair and the migration un-attach lines in
  the game log, printing one "X transforms Y into Z (P/T)." message
This commit is contained in:
Lukas Brübach 2026-09-24 06:55:51 +02:00
parent 44d5138181
commit 5b11af585f
8 changed files with 229 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

34
cockatrice/src/game_graphics/log/message_log_widget.cpp
View file

@ -26,6 +26,7 @@
#include <libcockatrice/game/zones/card_zone_logic.h>
#include <libcockatrice/protocol/pb/context_move_card.pb.h>
#include <libcockatrice/protocol/pb/context_mulligan.pb.h>
#include <libcockatrice/protocol/pb/context_transform_card.pb.h>
#include <libcockatrice/settings/chat_settings.h>
#include <libcockatrice/utility/zone_names.h>
#include <optional>
@ -120,6 +121,7 @@ MessageLogWidget::getFromStr(CardZoneLogic *zone, QString cardName, int position
void MessageLogWidget::containerProcessingDone()
{
currentContext = MessageContext_None;
transformOldCardName.clear();
messageSuffix = messagePrefix = QString();
}
@ -129,6 +131,8 @@ void MessageLogWidget::containerProcessingStarted(const GameEventContext &contex
currentContext = MessageContext_MoveCard;
} else if (context.HasExtension(Context_Mulligan::ext)) {
currentContext = MessageContext_Mulligan;
} else if (context.HasExtension(Context_TransformCard::ext)) {
currentContext = MessageContext_TransformCard;
}
}
@ -252,6 +256,27 @@ void MessageLogWidget::logCreateArrow(PlayerLogic *player,
void MessageLogWidget::logCreateToken(PlayerLogic *player, QString cardName, QString pt, bool faceDown)
{
if (currentContext == MessageContext_TransformCard) {
if (transformOldCardName.isEmpty()) {
appendHtmlServerMessage(tr("%1 creates token: %2%3.")
.arg(sanitizeHtml(player->getPlayerInfo()->getName()))
.arg(cardLink(std::move(cardName)))
.arg(pt.isEmpty() ? QString() : QString(" (%1)").arg(sanitizeHtml(pt))));
} else if (faceDown) {
appendHtmlServerMessage(tr("%1 transforms %2 into a face down card.")
.arg(sanitizeHtml(player->getPlayerInfo()->getName()))
.arg(cardLink(std::move(transformOldCardName))));
} else {
appendHtmlServerMessage(tr("%1 transforms %2 into %3%4.")
.arg(sanitizeHtml(player->getPlayerInfo()->getName()))
.arg(cardLink(std::move(transformOldCardName)))
.arg(cardLink(std::move(cardName)))
.arg(pt.isEmpty() ? QString() : QString(" (%1)").arg(sanitizeHtml(pt))));
}
transformOldCardName.clear();
return;
}
if (faceDown) {
appendHtmlServerMessage(
tr("%1 creates a face down token.").arg(sanitizeHtml(player->getPlayerInfo()->getName())));
@ -278,6 +303,11 @@ void MessageLogWidget::logDeckSelect(PlayerLogic *player, QString deckHash, int
void MessageLogWidget::logDestroyCard(PlayerLogic *player, QString cardName)
{
if (currentContext == MessageContext_TransformCard) {
transformOldCardName = cardName;
return;
}
appendHtmlServerMessage(
tr("%1 destroys %2.").arg(sanitizeHtml(player->getPlayerInfo()->getName())).arg(cardLink(std::move(cardName))));
}
@ -817,6 +847,10 @@ void MessageLogWidget::logSpectatorSay(const ServerInfo_User &spectator, QString
void MessageLogWidget::logUnattachCard(PlayerLogic *player, QString cardName)
{
if (currentContext == MessageContext_TransformCard) {
return;
}
appendHtmlServerMessage(tr("%1 unattaches %2.")
.arg(sanitizeHtml(player->getPlayerInfo()->getName()))
.arg(cardLink(std::move(cardName))));

4
cockatrice/src/game_graphics/log/message_log_widget.h
View file

@ -34,10 +34,12 @@ private:
{
MessageContext_None,
MessageContext_MoveCard,
MessageContext_Mulligan
MessageContext_Mulligan,
MessageContext_TransformCard
};
MessageContext currentContext;
QString transformOldCardName;
QString messagePrefix, messageSuffix;
static QPair<QString, QString> getFromStr(CardZoneLogic *zone, QString cardName, int position, bool ownerChange);

2
libcockatrice_network/libcockatrice/network/server/remote/game/server_abstract_player.cpp
View file

@ -47,6 +47,7 @@
#include <libcockatrice/protocol/pb/context_concede.pb.h>
#include <libcockatrice/protocol/pb/context_move_card.pb.h>
#include <libcockatrice/protocol/pb/context_ready_start.pb.h>
#include <libcockatrice/protocol/pb/context_transform_card.pb.h>
#include <libcockatrice/protocol/pb/context_undo_draw.pb.h>
#include <libcockatrice/protocol/pb/event_attach_card.pb.h>
#include <libcockatrice/protocol/pb/event_change_zone_properties.pb.h>
@ -1012,6 +1013,7 @@ Server_AbstractPlayer::cmdCreateToken(const Command_CreateToken &cmd, ResponseCo
if (targetZone) {
targetCard = targetZone->getCard(cmd.target_card_id());
if (targetCard && cmd.target_mode() == Command_CreateToken::TRANSFORM_INTO) {
ges.setGameEventContext(Context_TransformCard());
if (targetCard->getParentCard()) {
ges.enqueueGameEvent(makeAttachCardEvent(targetCard), playerId);
}

1
libcockatrice_protocol/libcockatrice/protocol/pb/CMakeLists.txt
View file

@ -80,6 +80,7 @@ set(PROTO_FILES
context_ping_changed.proto
context_ready_start.proto
context_set_sideboard_lock.proto
context_transform_card.proto
context_undo_draw.proto
developer_commands.proto
event_add_to_list.proto

8
libcockatrice_protocol/libcockatrice/protocol/pb/context_transform_card.proto Normal file
View file

@ -0,0 +1,8 @@
syntax = "proto2";
import "game_event_context.proto";
message Context_TransformCard {
extend GameEventContext {
optional Context_TransformCard ext = 1010;
}
}

1
libcockatrice_protocol/libcockatrice/protocol/pb/game_event_context.proto
View file

@ -11,6 +11,7 @@ message GameEventContext {
CONNECTION_STATE_CHANGED = 1007;
SET_SIDEBOARD_LOCK = 1008;
UNCONCEDE = 1009;
TRANSFORM_CARD = 1010;
}
extensions 100 to max;
}

11
tests/CMakeLists.txt
View file

@ -328,6 +328,17 @@ cockatrice_add_test(
LABELS
server
)
cockatrice_add_test(
NAME
server_transform_context_test
SOURCES
server_transform_context_test.cpp
LIBS
libcockatrice_network_server_remote
libcockatrice_rng
LABELS
server
)
cockatrice_add_test(
NAME
server_forced_password_change_test

169
tests/server_transform_context_test.cpp Normal file
View file

@ -0,0 +1,169 @@
/** @file server_transform_context_test.cpp
* @brief Tests that the card transform path attaches a Context_TransformCard
* to the event storage, so the client can render a single
* "Player X transforms card Y into card Z" chat message.
* @ingroup Tests
*/
#include "game/game_config.h"
#include "game/server_abstract_player.h"
#include "game/server_card.h"
#include "game/server_cardzone.h"
#include "game/server_game.h"
#include "server_response_containers.h"
#include "server_room.h"
#include "movecard_tests/server_test_helpers.h"
#include <QCoreApplication>
#include <gtest/gtest.h>
#include <libcockatrice/protocol/pb/command_create_token.pb.h>
#include <libcockatrice/protocol/pb/context_transform_card.pb.h>
#include <libcockatrice/protocol/pb/event_create_token.pb.h>
#include <libcockatrice/protocol/pb/event_destroy_card.pb.h>
#include <libcockatrice/protocol/pb/serverinfo_user.pb.h>
#include <libcockatrice/rng/rng_abstract.h>
#include <libcockatrice/utility/zone_names.h>
RNG_Abstract *rng = nullptr; // referenced by the server_remote library
namespace
{
class TransformContextTest : public ::testing::Test
{
protected:
ServerInfo_User user;
FakeServer server;
std::unique_ptr<Server_Room> room;
std::unique_ptr<Server_Game> game;
std::unique_ptr<Server_AbstractPlayer> player;
Server_Card *targetCard = nullptr;
void SetUp() override
{
user.set_name("test-user");
room = std::make_unique<Server_Room>(0, 0, "", "", "", "", false, "", QList<QString>(), &server);
GameConfig config{.creatorInfo = user,
.gameId = 1,
.description = QString(),
.password = QString(),
.maxPlayers = 2,
.gameTypes = QList<int>(),
.onlyBuddies = false,
.onlyRegistered = false,
.spectatorsAllowed = false,
.spectatorsNeedPassword = false,
.spectatorsCanTalk = false,
.spectatorsSeeEverything = false,
.startingLifeTotal = 20,
.shareDecklistsOnLoad = false};
game = std::make_unique<Server_Game>(config, room.get());
// Start the game with no participants so cmdCreateToken can run; the
// start is emitted via a queued connection, so process posted events.
game->startGameIfReady(true);
QCoreApplication::processEvents();
ASSERT_TRUE(game->getGameStarted());
player = std::make_unique<Server_AbstractPlayer>(game.get(), 1, user, false, nullptr);
auto *tableZone = new Server_CardZone(player.get(), ZoneNames::TABLE, true, ServerInfo_Zone::PublicZone);
player->addZone(tableZone);
targetCard = new Server_Card({"Old Card", "old-card"}, player->newCardId(), 0, 0);
tableZone->insertCard(targetCard, 0, 0);
}
};
Server_CardZone *tableZoneOf(Server_AbstractPlayer &player)
{
return player.getZones().value(ZoneNames::TABLE);
}
Command_CreateToken makeTransformCommand(uint32_t targetCardId)
{
Command_CreateToken cmd;
cmd.set_zone(ZoneNames::TABLE);
cmd.set_target_zone(ZoneNames::TABLE);
cmd.set_target_card_id(targetCardId);
cmd.set_target_mode(Command_CreateToken::TRANSFORM_INTO);
cmd.set_card_name("New Card");
cmd.set_card_provider_id("new-card");
cmd.set_color("m");
cmd.set_pt("2/2");
cmd.set_destroy_on_zone_change(true);
cmd.set_x(-1);
cmd.set_y(-1);
return cmd;
}
TEST_F(TransformContextTest, TransformCommandSetsTransformContext)
{
GameEventStorage ges;
ResponseContainer rc(0);
const auto response = player->cmdCreateToken(makeTransformCommand(targetCard->getId()), rc, ges);
EXPECT_EQ(response, Response::RespOk);
ASSERT_NE(ges.getGameEventContext(), nullptr);
EXPECT_TRUE(static_cast<GameEventContext *>(ges.getGameEventContext())->HasExtension(Context_TransformCard::ext));
}
TEST_F(TransformContextTest, TransformEventSequenceDestroyThenCreate)
{
GameEventStorage ges;
ResponseContainer rc(0);
ASSERT_EQ(player->cmdCreateToken(makeTransformCommand(targetCard->getId()), rc, ges), Response::RespOk);
QList<uint32_t> destroyedIds;
QList<Event_CreateToken> createdTokens;
for (const auto *item : ges.getGameEventList()) {
const GameEvent &event = item->getGameEvent();
if (event.HasExtension(Event_DestroyCard::ext)) {
destroyedIds.append(event.GetExtension(Event_DestroyCard::ext).card_id());
}
if (event.HasExtension(Event_CreateToken::ext)) {
createdTokens.append(event.GetExtension(Event_CreateToken::ext));
}
}
// The old card is destroyed and exactly one token is created in its place.
EXPECT_EQ(destroyedIds, QList<uint32_t>({static_cast<uint32_t>(targetCard->getId())}));
ASSERT_EQ(createdTokens.size(), 1);
EXPECT_EQ(createdTokens.first().card_name(), "New Card");
EXPECT_EQ(createdTokens.first().pt(), "2/2");
EXPECT_EQ(createdTokens.first().destroy_on_zone_change(), true);
// The old card is removed from the table and the new card replaces it.
EXPECT_EQ(tableZoneOf(*player)->getCard(targetCard->getId()), nullptr);
EXPECT_NE(tableZoneOf(*player)->getCard(createdTokens.first().card_id()), nullptr);
}
TEST_F(TransformContextTest, PlainTokenCreateHasNoTransformContext)
{
Command_CreateToken cmd;
cmd.set_zone(ZoneNames::TABLE);
cmd.set_card_name("Plain Token");
cmd.set_card_provider_id("plain-token");
cmd.set_color("");
cmd.set_pt("1/1");
cmd.set_destroy_on_zone_change(true);
cmd.set_x(-1);
cmd.set_y(-1);
GameEventStorage ges;
ResponseContainer rc(0);
EXPECT_EQ(player->cmdCreateToken(cmd, rc, ges), Response::RespOk);
EXPECT_EQ(ges.getGameEventContext(), nullptr);
}
} // namespace
int main(int argc, char **argv)
{
QCoreApplication app(argc, argv);
::testing::InitGoogleTest(&argc, argv);
return RUN_ALL_TESTS();
}