Centralize counter API with server-side bounds and no-op filtering (#6879)

* Refactor server counter API to own overflow protection and filter no-op events

  Counter modifications now clamp to int bounds server-side and return change
  status, allowing command handlers to skip network broadcasts when values
  don't actually change.

* Centralize MAX_COUNTERS_ON_CARD and enforce [0, 999] bounds on server

  - Move MAX_COUNTERS_ON_CARD to trice_limits.h
  - Server clamps values in setCounter() and incrementCounter()
  - Client uses clamped comparison to allow recovery from invalid states
  - Add tests for clamping behavior

* move incrementCount() implementation from header to cpp
This commit is contained in:
DawnFire42 2026-05-21 23:39:35 -04:00 committed by GitHub
parent 74102aa1ec
commit 8dca14933c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
12 changed files with 432 additions and 32 deletions

View file

@ -0,0 +1,183 @@
/** @file server_card_counter_test.cpp
* @brief Tests for Server_Card counter operations.
* @ingroup Tests
*/
#include <gtest/gtest.h>
#include <libcockatrice/network/server/remote/game/server_card.h>
#include <libcockatrice/protocol/pb/event_set_card_counter.pb.h>
#include <libcockatrice/utility/card_ref.h>
#include <libcockatrice/utility/trice_limits.h>
#include <limits>
TEST(ServerCardCounter, IncrementNewCounter)
{
Server_Card card(CardRef{"TestCard", ""}, 1, 0, 0);
EXPECT_TRUE(card.incrementCounter(1, 10));
EXPECT_EQ(card.getCounter(1), 10);
}
TEST(ServerCardCounter, IncrementExistingCounter)
{
Server_Card card(CardRef{"TestCard", ""}, 1, 0, 0);
ASSERT_TRUE(card.setCounter(1, 50));
EXPECT_TRUE(card.incrementCounter(1, 10));
EXPECT_EQ(card.getCounter(1), 60);
}
TEST(ServerCardCounter, IncrementOverflowProtection)
{
Server_Card card(CardRef{"TestCard", ""}, 1, 0, 0);
ASSERT_TRUE(card.setCounter(1, MAX_COUNTERS_ON_CARD));
EXPECT_FALSE(card.incrementCounter(1, 1));
EXPECT_EQ(card.getCounter(1), MAX_COUNTERS_ON_CARD);
}
TEST(ServerCardCounter, DecrementUnderflowProtection)
{
Server_Card card(CardRef{"TestCard", ""}, 1, 0, 0);
ASSERT_TRUE(card.setCounter(1, 5));
EXPECT_TRUE(card.incrementCounter(1, -10));
EXPECT_EQ(card.getCounter(1), 0);
EXPECT_FALSE(card.getCounters().contains(1));
}
TEST(ServerCardCounter, ReturnsFalseWhenUnchanged)
{
Server_Card card(CardRef{"TestCard", ""}, 1, 0, 0);
ASSERT_TRUE(card.setCounter(1, 50));
EXPECT_FALSE(card.incrementCounter(1, 0));
EXPECT_EQ(card.getCounter(1), 50);
}
TEST(ServerCardCounter, DecrementToZeroRemovesCounter)
{
Server_Card card(CardRef{"TestCard", ""}, 1, 0, 0);
ASSERT_TRUE(card.setCounter(1, 10));
EXPECT_TRUE(card.incrementCounter(1, -10));
EXPECT_EQ(card.getCounter(1), 0);
EXPECT_FALSE(card.getCounters().contains(1));
}
TEST(ServerCardCounter, SetToZeroRemovesCounter)
{
Server_Card card(CardRef{"TestCard", ""}, 1, 0, 0);
ASSERT_TRUE(card.setCounter(1, 10));
EXPECT_TRUE(card.setCounter(1, 0));
EXPECT_EQ(card.getCounter(1), 0);
EXPECT_FALSE(card.getCounters().contains(1));
}
TEST(ServerCardCounter, SetCounterReturnsFalseWhenUnchanged)
{
Server_Card card(CardRef{"TestCard", ""}, 1, 0, 0);
ASSERT_TRUE(card.setCounter(1, 50));
EXPECT_FALSE(card.setCounter(1, 50));
EXPECT_EQ(card.getCounter(1), 50);
}
TEST(ServerCardCounter, SetCounterReturnsTrueWhenChanged)
{
Server_Card card(CardRef{"TestCard", ""}, 1, 0, 0);
ASSERT_TRUE(card.setCounter(1, 50));
EXPECT_TRUE(card.setCounter(1, 100));
EXPECT_EQ(card.getCounter(1), 100);
}
TEST(ServerCardCounter, SetCounterEventNotPopulatedWhenUnchanged)
{
Server_Card card(CardRef{"TestCard", ""}, 1, 0, 0);
ASSERT_TRUE(card.setCounter(1, 50));
Event_SetCardCounter event;
event.set_counter_id(999);
event.set_counter_value(999);
EXPECT_FALSE(card.setCounter(1, 50, &event));
EXPECT_EQ(event.counter_id(), 999);
EXPECT_EQ(event.counter_value(), 999);
}
TEST(ServerCardCounter, IncrementCounterPopulatesEvent)
{
Server_Card card(CardRef{"TestCard", ""}, 1, 0, 0);
ASSERT_TRUE(card.setCounter(1, 50));
Event_SetCardCounter event;
EXPECT_TRUE(card.incrementCounter(1, 10, &event));
EXPECT_EQ(event.counter_id(), 1);
EXPECT_EQ(event.counter_value(), 60);
}
TEST(ServerCardCounter, IncrementCounterEventReflectsClampedValue)
{
Server_Card card(CardRef{"TestCard", ""}, 1, 0, 0);
ASSERT_TRUE(card.setCounter(1, MAX_COUNTERS_ON_CARD - 5));
Event_SetCardCounter event;
EXPECT_TRUE(card.incrementCounter(1, 10, &event));
EXPECT_EQ(event.counter_id(), 1);
EXPECT_EQ(event.counter_value(), MAX_COUNTERS_ON_CARD);
}
TEST(ServerCardCounter, IncrementCounterNoEventWhenNullptr)
{
Server_Card card(CardRef{"TestCard", ""}, 1, 0, 0);
ASSERT_TRUE(card.setCounter(1, 50));
EXPECT_TRUE(card.incrementCounter(1, 10, nullptr));
EXPECT_EQ(card.getCounter(1), 60);
}
TEST(ServerCardCounter, IncrementCounterEventNotPopulatedWhenUnchanged)
{
Server_Card card(CardRef{"TestCard", ""}, 1, 0, 0);
ASSERT_TRUE(card.setCounter(1, MAX_COUNTERS_ON_CARD));
Event_SetCardCounter event;
event.set_counter_id(999);
event.set_counter_value(999);
EXPECT_FALSE(card.incrementCounter(1, 1, &event));
EXPECT_EQ(event.counter_id(), 999);
EXPECT_EQ(event.counter_value(), 999);
}
TEST(ServerCardCounter, SetCounterClampsNegativeToZero)
{
Server_Card card(CardRef{"TestCard", ""}, 1, 0, 0);
EXPECT_FALSE(card.setCounter(1, -5));
EXPECT_EQ(card.getCounter(1), 0);
EXPECT_FALSE(card.getCounters().contains(1));
}
TEST(ServerCardCounter, SetCounterClampsAboveMaxToMax)
{
Server_Card card(CardRef{"TestCard", ""}, 1, 0, 0);
EXPECT_TRUE(card.setCounter(1, 1500));
EXPECT_EQ(card.getCounter(1), MAX_COUNTERS_ON_CARD);
}
TEST(ServerCardCounter, IncrementDoesNotGoBelowZero)
{
Server_Card card(CardRef{"TestCard", ""}, 1, 0, 0);
ASSERT_TRUE(card.setCounter(1, 5));
EXPECT_TRUE(card.incrementCounter(1, -10));
EXPECT_EQ(card.getCounter(1), 0);
EXPECT_FALSE(card.getCounters().contains(1));
}
TEST(ServerCardCounter, IncrementDoesNotExceedMax)
{
Server_Card card(CardRef{"TestCard", ""}, 1, 0, 0);
ASSERT_TRUE(card.setCounter(1, MAX_COUNTERS_ON_CARD - 5));
EXPECT_TRUE(card.incrementCounter(1, 10));
EXPECT_EQ(card.getCounter(1), MAX_COUNTERS_ON_CARD);
}
int main(int argc, char **argv)
{
::testing::InitGoogleTest(&argc, argv);
return RUN_ALL_TESTS();
}