1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
|
/*
* Copyright (C) 2025 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#include "config.h"
#if ENABLE(CONTENT_EXTENSIONS)
#include "Utilities.h"
#include <WebCore/ResourceMonitorThrottlerHolder.h>
#include <wtf/FileSystem.h>
#include <wtf/MainThread.h>
namespace TestWebKitAPI {
using namespace WebCore;
class ResourceMonitorTest : public testing::Test {
public:
void SetUp() override
{
WTF::initializeMainThread();
m_reference = ContinuousApproximateTime::now();
}
protected:
ContinuousApproximateTime m_reference;
RefPtr<ResourceMonitorThrottlerHolder> m_throttler;
String m_temporayDatabasePath;
void prepareThrottler(size_t count, Seconds duration, size_t maxHosts, bool withPersistence = false)
{
if (withPersistence)
m_throttler = ResourceMonitorThrottlerHolder::create(temporaryDatabasePath(), count, duration, maxHosts);
else
m_throttler = ResourceMonitorThrottlerHolder::create(count, duration, maxHosts);
}
void prepareThrottler(bool withPersistence = false)
{
if (withPersistence)
m_throttler = ResourceMonitorThrottlerHolder::create(temporaryDatabasePath());
else
m_throttler = ResourceMonitorThrottlerHolder::create();
}
void disposeThrottler()
{
m_throttler = nullptr;
}
ResourceMonitorThrottlerHolder* throttler()
{
return m_throttler.get();
}
ContinuousApproximateTime now()
{
auto t = m_reference;
m_reference += 1_ms;
return t;
}
ContinuousApproximateTime later(Seconds delta)
{
m_reference += delta;
return m_reference;
}
bool tryAccess(const String& host, ContinuousApproximateTime time)
{
bool result;
bool completed = false;
m_throttler->tryAccess(host, time, [&] (bool wasGranted) {
result = wasGranted;
completed = true;
});
Util::run(&completed);
return result;
}
String& temporaryDatabasePath()
{
if (m_temporayDatabasePath.isEmpty()) {
m_temporayDatabasePath = FileSystem::createTemporaryFile("tempDatabaseForResourceMonitorThrottler"_s);
FileSystem::deleteFile(m_temporayDatabasePath);
}
return m_temporayDatabasePath;
}
};
TEST_F(ResourceMonitorTest, ThrottlerBasic)
{
prepareThrottler(/* size */ 2, /* duration */ 1_s, /* maxHosts */ 1);
auto host = "example.com"_s;
// first access must be okay.
EXPECT_TRUE(tryAccess(host, now()));
// second one is alse okay.
EXPECT_TRUE(tryAccess(host, now()));
// but third one is not okay because size is 2.
EXPECT_FALSE(tryAccess(host, now()));
// after duration, it should be okay.
EXPECT_TRUE(tryAccess(host, later(1_s)));
}
TEST_F(ResourceMonitorTest, ThrottlerMaxHosts)
{
prepareThrottler(/* size */ 2, /* duration */ 1_s, /* maxHosts */ 2);
auto host1 = "h1.example.com"_s;
auto host2 = "h2.example.com"_s;
auto host3 = "h3.example.com"_s;
// make host1 inaccessible.
EXPECT_TRUE(tryAccess(host1, now()));
EXPECT_TRUE(tryAccess(host1, now()));
EXPECT_FALSE(tryAccess(host1, now()));
// host2 is accessible and still host1 is not.
EXPECT_TRUE(tryAccess(host2, now()));
EXPECT_FALSE(tryAccess(host1, now()));
// host3 is accessible and host1 is now also accessible because of the max host.
EXPECT_TRUE(tryAccess(host3, now()));
EXPECT_TRUE(tryAccess(host1, now()));
}
TEST_F(ResourceMonitorTest, ThrottlerLeastRecentAccessedHostWillBeRemoved)
{
prepareThrottler(/* size */ 2, /* duration */ 1_s, /* maxHosts */ 2);
auto host1 = "h1.example.com"_s;
auto host2 = "h2.example.com"_s;
auto host3 = "h3.example.com"_s;
// host1 is the oldest access.
EXPECT_TRUE(tryAccess(host1, now()));
// make host2 inaccessible
EXPECT_TRUE(tryAccess(host2, now()));
EXPECT_TRUE(tryAccess(host2, now()));
EXPECT_FALSE(tryAccess(host2, now()));
// make host1 inaccessible and this is the most recent access.
EXPECT_TRUE(tryAccess(host1, now()));
EXPECT_FALSE(tryAccess(host1, now()));
// host3 is accessible. In this access, lest recent host is removed.
EXPECT_TRUE(tryAccess(host3, now()));
// host1 is the oldest, but recent than host2. Still it is blocked.
EXPECT_FALSE(tryAccess(host1, now()));
// host2 is the least recent access and removed in host3 access. So it is accessible.
EXPECT_TRUE(tryAccess(host2, now()));
}
TEST_F(ResourceMonitorTest, ThrottlerEmptyHostname)
{
prepareThrottler(/* size */ 2, /* duration */ 1_s, /* maxHosts */ 2);
auto emptyHost = ""_s;
// Accessing with an empty hostname should not crash.
EXPECT_FALSE(tryAccess(emptyHost, now()));
}
TEST_F(ResourceMonitorTest, ThrottlerPersistence)
{
auto host = "example.com"_s;
prepareThrottler(/* size */ 2, /* duration */ 1_s, /* maxHosts */ 2, /* withPersistence */ true);
// first access must be okay.
EXPECT_TRUE(tryAccess(host, now()));
// second one is alse okay.
EXPECT_TRUE(tryAccess(host, now()));
// but third one is not okay because size is 2.
EXPECT_FALSE(tryAccess(host, now()));
disposeThrottler();
prepareThrottler(/* size */ 2, /* duration */ 1_s, /* maxHosts */ 2, /* withPersistence */ true);
// recover all history from database so still third one is not okay because size is 2.
EXPECT_FALSE(tryAccess(host, now()));
}
TEST_F(ResourceMonitorTest, ThrottlerCreateAndDelete)
{
// Shouldn't crash with immediate disposal.
prepareThrottler(true);
disposeThrottler();
EXPECT_FALSE(throttler());
}
} // namespace TestWebKitAPI
#endif // ENABLE(CONTENT_EXTENSIONS)
|