Files
Bret Curtis 4addabaf95 Let the resource cache be told what it stores, and free its values from OSG
GenericObjectCache stored osg::ref_ptr<osg::Object>, so everything cached had to
derive from osg::Object whether that meant anything or not: NifFileHolder and
BgsmFileHolder existed for no other reason, Resource::BulletShape and
ESMTerrain::LandObject carried META_Object and a CopyOp constructor nothing ever
called, and every getter paid a static_cast on the way out. The cache and
MultiObjectCache now take their value type as a template parameter, ask "is
anything else holding this?" through a useCount overload rather than a base class
method, and constrain accept and releaseGLObjects so a value type with neither is
not an error. Both holders are deleted; BulletShape, BulletShapeInstance and
LandObject become plain classes held by std::shared_ptr across physics,
pathfinding, navmeshtool and terrain storage; MWPhysics::HeightField's
type-erased osg::Object keep-alive becomes the LandObject it was always holding;
every remaining manager names the type it actually caches through the
NodeResourceManager alias, which removes eight static_casts and stops
clang-format wrapping the declarations. The preloader needs two keep-alive sets
for now, because the render-owned entries are still osg::Object; they merge once
those move behind the render backend.
2026-09-18 16:10:18 +02:00

418 lines
15 KiB
C++

#include <components/resource/objectcache.hpp>
#include <gmock/gmock.h>
#include <gtest/gtest.h>
#include <memory>
#include <osg/Object>
namespace Resource
{
namespace
{
using namespace ::testing;
using ObjectCache = GenericObjectCache<int, osg::ref_ptr<osg::Object>>;
using StringObjectCache = GenericObjectCache<std::string, osg::ref_ptr<osg::Object>>;
// The point of the value type parameter: a type that derives from nothing at all
// is cacheable, and expiry still knows whether anything outside holds it.
using SharedCache = GenericObjectCache<int, std::shared_ptr<const std::string>>;
TEST(ResourceGenericObjectCacheTest, getRefFromObjectCacheShouldReturnNullptrByDefault)
{
ObjectCache cache;
EXPECT_EQ(cache.getRefFromObjectCache(42), nullptr);
}
TEST(ResourceGenericObjectCacheTest, getRefFromObjectCacheOrNoneShouldReturnNulloptByDefault)
{
ObjectCache cache;
EXPECT_EQ(cache.getRefFromObjectCacheOrNone(42), std::nullopt);
}
struct Object : osg::Object
{
Object() = default;
Object(const Object& other, const osg::CopyOp& copyOp = osg::CopyOp())
: osg::Object(other, copyOp)
{
}
META_Object(ResourceTest, Object)
};
TEST(ResourceGenericObjectCacheTest, shouldStoreValuesThatAreNotOsgObjects)
{
SharedCache cache;
const auto value = std::make_shared<const std::string>("value");
cache.addEntryToObjectCache(42, value);
EXPECT_EQ(cache.getRefFromObjectCache(42), value);
}
TEST(ResourceGenericObjectCacheTest, updateShouldNotDereferenceNullValues)
{
ObjectCache cache;
cache.addEntryToObjectCache(42, nullptr);
cache.update(1000, 1);
EXPECT_THAT(cache.getRefFromObjectCacheOrNone(42), Optional(nullptr));
}
TEST(ResourceGenericObjectCacheTest, updateShouldKeepSharedPtrValuesHeldElsewhere)
{
SharedCache cache;
const auto held = std::make_shared<const std::string>("held");
cache.addEntryToObjectCache(1, held);
cache.addEntryToObjectCache(2, std::make_shared<const std::string>("dropped"));
const double referenceTime = 1000;
cache.update(referenceTime, 1);
cache.update(referenceTime + 10, 1);
EXPECT_THAT(cache.getRefFromObjectCacheOrNone(1), Optional(held));
EXPECT_EQ(cache.getRefFromObjectCacheOrNone(2), std::nullopt);
}
TEST(ResourceGenericObjectCacheTest, shouldStoreValues)
{
ObjectCache cache;
const int key = 42;
osg::ref_ptr<Object> value(new Object);
cache.addEntryToObjectCache(key, value);
EXPECT_EQ(cache.getRefFromObjectCache(key), value);
}
TEST(ResourceGenericObjectCacheTest, shouldStoreNullptrValues)
{
ObjectCache cache;
const int key = 42;
cache.addEntryToObjectCache(key, nullptr);
EXPECT_THAT(cache.getRefFromObjectCacheOrNone(key), Optional(nullptr));
}
TEST(ResourceGenericObjectCacheTest, updateShouldExtendLifetimeForItemsWithZeroTimestamp)
{
ObjectCache cache;
const int key = 42;
osg::ref_ptr<Object> value(new Object);
cache.addEntryToObjectCache(key, value, 0);
value = nullptr;
const double referenceTime = 1000;
const double expiryDelay = 1;
cache.update(referenceTime, expiryDelay);
EXPECT_THAT(cache.getRefFromObjectCacheOrNone(key), Optional(_));
}
TEST(ResourceGenericObjectCacheTest, addEntryToObjectCacheShouldReplaceExistingItemByKey)
{
ObjectCache cache;
const int key = 42;
osg::ref_ptr<Object> value1(new Object);
osg::ref_ptr<Object> value2(new Object);
cache.addEntryToObjectCache(key, value1);
ASSERT_EQ(cache.getRefFromObjectCache(key), value1);
cache.addEntryToObjectCache(key, value2);
EXPECT_EQ(cache.getRefFromObjectCache(key), value2);
}
TEST(ResourceGenericObjectCacheTest, addEntryToObjectCacheShouldMarkLifetime)
{
ObjectCache cache;
const double referenceTime = 1;
const double expiryDelay = 2;
const int key = 42;
cache.addEntryToObjectCache(key, nullptr, referenceTime + expiryDelay);
cache.update(referenceTime, expiryDelay);
ASSERT_THAT(cache.getRefFromObjectCacheOrNone(key), Optional(_));
cache.update(referenceTime + expiryDelay, expiryDelay);
ASSERT_THAT(cache.getRefFromObjectCacheOrNone(key), Optional(_));
cache.update(referenceTime + 2 * expiryDelay, expiryDelay);
EXPECT_EQ(cache.getRefFromObjectCacheOrNone(key), std::nullopt);
}
TEST(ResourceGenericObjectCacheTest, updateShouldRemoveExpiredItems)
{
ObjectCache cache;
const double referenceTime = 1;
const double expiryDelay = 1;
const int key = 42;
osg::ref_ptr<Object> value(new Object);
cache.addEntryToObjectCache(key, value);
value = nullptr;
cache.update(referenceTime, expiryDelay);
ASSERT_THAT(cache.getRefFromObjectCacheOrNone(key), Optional(_));
ASSERT_EQ(cache.getStats().mExpired, 0);
cache.update(referenceTime + expiryDelay, expiryDelay);
EXPECT_EQ(cache.getRefFromObjectCacheOrNone(key), std::nullopt);
ASSERT_EQ(cache.getStats().mExpired, 1);
}
TEST(ResourceGenericObjectCacheTest, updateShouldKeepExternallyReferencedItems)
{
ObjectCache cache;
const double referenceTime = 1;
const double expiryDelay = 1;
const int key = 42;
osg::ref_ptr<Object> value(new Object);
cache.addEntryToObjectCache(key, value);
cache.update(referenceTime, expiryDelay);
ASSERT_THAT(cache.getRefFromObjectCacheOrNone(key), Optional(_));
cache.update(referenceTime + expiryDelay, expiryDelay);
EXPECT_THAT(cache.getRefFromObjectCacheOrNone(key), Optional(value));
}
TEST(ResourceGenericObjectCacheTest, updateShouldKeepNotExpiredItems)
{
ObjectCache cache;
const double referenceTime = 1;
const double expiryDelay = 2;
const int key = 42;
osg::ref_ptr<Object> value(new Object);
cache.addEntryToObjectCache(key, value);
value = nullptr;
cache.update(referenceTime + expiryDelay, expiryDelay);
ASSERT_THAT(cache.getRefFromObjectCacheOrNone(key), Optional(_));
cache.update(referenceTime + expiryDelay / 2, expiryDelay);
EXPECT_THAT(cache.getRefFromObjectCacheOrNone(key), Optional(_));
}
TEST(ResourceGenericObjectCacheTest, updateShouldKeepNotExpiredNullptrItems)
{
ObjectCache cache;
const double referenceTime = 1;
const double expiryDelay = 2;
const int key = 42;
cache.addEntryToObjectCache(key, nullptr);
cache.update(referenceTime + expiryDelay, expiryDelay);
ASSERT_THAT(cache.getRefFromObjectCacheOrNone(key), Optional(_));
cache.update(referenceTime + expiryDelay / 2, expiryDelay);
EXPECT_THAT(cache.getRefFromObjectCacheOrNone(key), Optional(_));
}
TEST(ResourceGenericObjectCacheTest, getRefFromObjectCacheOrNoneShouldNotExtendItemLifetime)
{
ObjectCache cache;
const double referenceTime = 1;
const double expiryDelay = 2;
const int key = 42;
cache.addEntryToObjectCache(key, nullptr);
cache.update(referenceTime, expiryDelay);
ASSERT_THAT(cache.getRefFromObjectCacheOrNone(key), Optional(_));
cache.update(referenceTime + expiryDelay / 2, expiryDelay);
ASSERT_THAT(cache.getRefFromObjectCacheOrNone(key), Optional(_));
cache.update(referenceTime + expiryDelay, expiryDelay);
EXPECT_EQ(cache.getRefFromObjectCacheOrNone(key), std::nullopt);
}
TEST(ResourceGenericObjectCacheTest, lowerBoundShouldSupportHeterogeneousLookup)
{
StringObjectCache cache;
cache.addEntryToObjectCache("a", nullptr);
cache.addEntryToObjectCache("c", nullptr);
EXPECT_THAT(cache.lowerBound(std::string_view("b")), Optional(Pair("c", _)));
}
TEST(ResourceGenericObjectCacheTest, shouldSupportRemovingItems)
{
ObjectCache cache;
const int key = 42;
osg::ref_ptr<Object> value(new Object);
cache.addEntryToObjectCache(key, value);
ASSERT_EQ(cache.getRefFromObjectCache(key), value);
cache.removeFromObjectCache(key);
EXPECT_EQ(cache.getRefFromObjectCacheOrNone(key), std::nullopt);
}
TEST(ResourceGenericObjectCacheTest, clearShouldRemoveAllItems)
{
ObjectCache cache;
const int key1 = 42;
const int key2 = 13;
osg::ref_ptr<Object> value1(new Object);
osg::ref_ptr<Object> value2(new Object);
cache.addEntryToObjectCache(key1, value1);
cache.addEntryToObjectCache(key2, value2);
ASSERT_EQ(cache.getRefFromObjectCache(key1), value1);
ASSERT_EQ(cache.getRefFromObjectCache(key2), value2);
cache.clear();
EXPECT_EQ(cache.getRefFromObjectCacheOrNone(key1), std::nullopt);
EXPECT_EQ(cache.getRefFromObjectCacheOrNone(key2), std::nullopt);
}
TEST(ResourceGenericObjectCacheTest, callShouldIterateOverAllItems)
{
ObjectCache cache;
osg::ref_ptr<Object> value1(new Object);
osg::ref_ptr<Object> value2(new Object);
osg::ref_ptr<Object> value3(new Object);
cache.addEntryToObjectCache(1, value1);
cache.addEntryToObjectCache(2, value2);
cache.addEntryToObjectCache(3, value3);
std::vector<std::pair<int, osg::Object*>> actual;
cache.call([&](int key, osg::Object* value) { actual.emplace_back(key, value); });
EXPECT_THAT(actual, ElementsAre(Pair(1, value1.get()), Pair(2, value2.get()), Pair(3, value3.get())));
}
TEST(ResourceGenericObjectCacheTest, getStatsShouldReturnNumberOrAddedItems)
{
ObjectCache cache;
osg::ref_ptr<Object> value1(new Object);
osg::ref_ptr<Object> value2(new Object);
cache.addEntryToObjectCache(13, value1);
cache.addEntryToObjectCache(42, value2);
const CacheStats stats = cache.getStats();
EXPECT_EQ(stats.mSize, 2);
}
TEST(ResourceGenericObjectCacheTest, getStatsShouldReturnNumberOrGetsAndHits)
{
ObjectCache cache;
{
const CacheStats stats = cache.getStats();
EXPECT_EQ(stats.mGet, 0);
EXPECT_EQ(stats.mHit, 0);
}
osg::ref_ptr<Object> value(new Object);
cache.addEntryToObjectCache(13, value);
cache.getRefFromObjectCache(13);
cache.getRefFromObjectCache(42);
{
const CacheStats stats = cache.getStats();
EXPECT_EQ(stats.mGet, 2);
EXPECT_EQ(stats.mHit, 1);
}
}
TEST(ResourceGenericObjectCacheTest, lowerBoundShouldReturnFirstNotLessThatGivenKey)
{
ObjectCache cache;
osg::ref_ptr<Object> value1(new Object);
osg::ref_ptr<Object> value2(new Object);
osg::ref_ptr<Object> value3(new Object);
cache.addEntryToObjectCache(1, value1);
cache.addEntryToObjectCache(2, value2);
cache.addEntryToObjectCache(4, value3);
EXPECT_THAT(cache.lowerBound(3), Optional(Pair(4, value3)));
}
TEST(ResourceGenericObjectCacheTest, lowerBoundShouldReturnNulloptWhenKeyIsGreaterThanAnyOther)
{
ObjectCache cache;
osg::ref_ptr<Object> value1(new Object);
osg::ref_ptr<Object> value2(new Object);
osg::ref_ptr<Object> value3(new Object);
cache.addEntryToObjectCache(1, value1);
cache.addEntryToObjectCache(2, value2);
cache.addEntryToObjectCache(3, value3);
EXPECT_EQ(cache.lowerBound(4), std::nullopt);
}
TEST(ResourceGenericObjectCacheTest, addEntryToObjectCacheShouldSupportHeterogeneousLookup)
{
StringObjectCache cache;
const std::string key = "key";
osg::ref_ptr<Object> value(new Object);
cache.addEntryToObjectCache(std::string_view("key"), value);
EXPECT_EQ(cache.getRefFromObjectCache(key), value);
}
TEST(ResourceGenericObjectCacheTest, addEntryToObjectCacheShouldKeyMoving)
{
StringObjectCache cache;
std::string key(128, 'a');
osg::ref_ptr<Object> value(new Object);
cache.addEntryToObjectCache(std::move(key), value);
EXPECT_EQ(key, "");
EXPECT_EQ(cache.getRefFromObjectCache(std::string(128, 'a')), value);
}
TEST(ResourceGenericObjectCacheTest, removeFromObjectCacheShouldSupportHeterogeneousLookup)
{
StringObjectCache cache;
const std::string key = "key";
osg::ref_ptr<Object> value(new Object);
cache.addEntryToObjectCache(key, value);
ASSERT_EQ(cache.getRefFromObjectCache(key), value);
cache.removeFromObjectCache(std::string_view("key"));
EXPECT_EQ(cache.getRefFromObjectCacheOrNone(key), std::nullopt);
}
TEST(ResourceGenericObjectCacheTest, getRefFromObjectCacheShouldSupportHeterogeneousLookup)
{
StringObjectCache cache;
const std::string key = "key";
osg::ref_ptr<Object> value(new Object);
cache.addEntryToObjectCache(key, value);
EXPECT_EQ(cache.getRefFromObjectCache(std::string_view("key")), value);
}
TEST(ResourceGenericObjectCacheTest, getRefFromObjectCacheOrNoneShouldSupportHeterogeneousLookup)
{
StringObjectCache cache;
const std::string key = "key";
osg::ref_ptr<Object> value(new Object);
cache.addEntryToObjectCache(key, value);
EXPECT_THAT(cache.getRefFromObjectCacheOrNone(std::string_view("key")), Optional(value));
}
TEST(ResourceGenericObjectCacheTest, checkInObjectCacheShouldSupportHeterogeneousLookup)
{
StringObjectCache cache;
const std::string key = "key";
osg::ref_ptr<Object> value(new Object);
cache.addEntryToObjectCache(key, value);
EXPECT_TRUE(cache.checkInObjectCache(std::string_view("key"), 0));
}
}
}