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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
content / browser / interest_group / interest_group_permissions_cache_unittest.cc [blame]
// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "content/browser/interest_group/interest_group_permissions_cache.h"
#include <string>
#include <vector>
#include "base/run_loop.h"
#include "base/strings/stringprintf.h"
#include "base/test/task_environment.h"
#include "base/time/time.h"
#include "net/base/network_isolation_key.h"
#include "net/base/schemeful_site.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "url/gurl.h"
#include "url/origin.h"
namespace content {
namespace {
// Very short time used by some tests that want to wait until just after a
// timer triggers.
constexpr base::TimeDelta kTinyTime = base::Microseconds(1);
using Permissions = InterestGroupPermissionsCache::Permissions;
class InterestGroupPermissionsCacheTest : public testing::Test {
protected:
// Default values used in most tests.
const url::Origin kFrameOrigin =
url::Origin::Create(GURL("https://frame.test"));
const url::Origin kGroupOrigin =
url::Origin::Create(GURL("https://group.test"));
const net::SchemefulSite kFrameSite = net::SchemefulSite(kFrameOrigin);
const net::NetworkIsolationKey kNetworkIsolationKey =
net::NetworkIsolationKey(kFrameSite, kFrameSite);
const Permissions kPermissions =
Permissions{/*can_join=*/true, /*can_leave=*/false};
// Alternative values when two different values are needed for any field.
const url::Origin kOtherFrameOrigin =
url::Origin::Create(GURL("https://other_frame.test"));
const url::Origin kOtherGroupOrigin =
url::Origin::Create(GURL("https://other_group.test"));
const net::SchemefulSite kOtherFrameSite =
net::SchemefulSite(kOtherFrameOrigin);
const net::NetworkIsolationKey kOtherNetworkIsolationKey =
net::NetworkIsolationKey(kOtherFrameSite, kOtherFrameSite);
const Permissions kOtherPermissions =
Permissions{/*can_join=*/false, /*can_leave=*/true};
base::test::TaskEnvironment task_environment_ = base::test::TaskEnvironment(
base::test::TaskEnvironment::TimeSource::MOCK_TIME);
InterestGroupPermissionsCache interest_group_permissions_cache_;
};
TEST_F(InterestGroupPermissionsCacheTest, PermissionsEquality) {
EXPECT_EQ(kPermissions, kPermissions);
EXPECT_EQ(kOtherPermissions, kOtherPermissions);
EXPECT_NE(kOtherPermissions, kPermissions);
EXPECT_NE(kPermissions, kOtherPermissions);
// Check that two different Permissions objects that have the same values are
// considered equal.
//
// Same as kPermissions.
Permissions permissions1{/*can_join=*/true, /*can_leave=*/false};
EXPECT_EQ(kPermissions, permissions1);
EXPECT_EQ(permissions1, kPermissions);
// Matches neither `kPermissions` nor `kOtherPermissions`. Used to make sure
// both values matter.
Permissions permissions2{/*can_join=*/false, /*can_leave=*/false};
EXPECT_NE(kPermissions, permissions2);
EXPECT_NE(permissions2, kPermissions);
EXPECT_NE(kOtherPermissions, permissions2);
EXPECT_NE(permissions2, kOtherPermissions);
}
TEST_F(InterestGroupPermissionsCacheTest, Basic) {
EXPECT_FALSE(interest_group_permissions_cache_.GetPermissions(
kFrameOrigin, kGroupOrigin, kNetworkIsolationKey));
interest_group_permissions_cache_.CachePermissions(
kPermissions, kFrameOrigin, kGroupOrigin, kNetworkIsolationKey);
Permissions* permissions = interest_group_permissions_cache_.GetPermissions(
kFrameOrigin, kGroupOrigin, kNetworkIsolationKey);
ASSERT_TRUE(permissions);
EXPECT_EQ(*permissions, kPermissions);
}
TEST_F(InterestGroupPermissionsCacheTest, Overwrite) {
interest_group_permissions_cache_.CachePermissions(
kPermissions, kFrameOrigin, kGroupOrigin, kNetworkIsolationKey);
Permissions* permissions = interest_group_permissions_cache_.GetPermissions(
kFrameOrigin, kGroupOrigin, kNetworkIsolationKey);
ASSERT_TRUE(permissions);
EXPECT_EQ(*permissions, kPermissions);
interest_group_permissions_cache_.CachePermissions(
kOtherPermissions, kFrameOrigin, kGroupOrigin, kNetworkIsolationKey);
permissions = interest_group_permissions_cache_.GetPermissions(
kFrameOrigin, kGroupOrigin, kNetworkIsolationKey);
ASSERT_TRUE(permissions);
EXPECT_EQ(*permissions, kOtherPermissions);
}
TEST_F(InterestGroupPermissionsCacheTest, MultipleEntries) {
// Permissions that are each assigned to a different pair of origins +
// NetworkIsolationKey. This coincidentally covers all distinct permissions
// values, but that is not necessary for this test. They all just need to be
// distinct.
const Permissions kPermissionsValues[4] = {
{/*can_join=*/true, /*can_leave=*/true},
{/*can_join=*/true, /*can_leave=*/false},
{/*can_join=*/false, /*can_leave=*/true},
{/*can_join=*/false, /*can_leave=*/false},
};
// Each set of permissions varies in only one value from the first set. Some
// of these combinations can't actually occur (in particular, the frame origin
// normally corresponds to the NetworkIsolationKey's frame site), but the
// cache layer doesn't care.
interest_group_permissions_cache_.CachePermissions(
kPermissionsValues[0], kFrameOrigin, kGroupOrigin, kNetworkIsolationKey);
interest_group_permissions_cache_.CachePermissions(
kPermissionsValues[1], kOtherFrameOrigin, kGroupOrigin,
kNetworkIsolationKey);
interest_group_permissions_cache_.CachePermissions(
kPermissionsValues[2], kFrameOrigin, kOtherGroupOrigin,
kNetworkIsolationKey);
interest_group_permissions_cache_.CachePermissions(kPermissionsValues[3],
kFrameOrigin, kGroupOrigin,
kOtherNetworkIsolationKey);
Permissions* permissions = interest_group_permissions_cache_.GetPermissions(
kFrameOrigin, kGroupOrigin, kNetworkIsolationKey);
ASSERT_TRUE(permissions);
EXPECT_EQ(*permissions, kPermissionsValues[0]);
permissions = interest_group_permissions_cache_.GetPermissions(
kOtherFrameOrigin, kGroupOrigin, kNetworkIsolationKey);
ASSERT_TRUE(permissions);
EXPECT_EQ(*permissions, kPermissionsValues[1]);
permissions = interest_group_permissions_cache_.GetPermissions(
kFrameOrigin, kOtherGroupOrigin, kNetworkIsolationKey);
ASSERT_TRUE(permissions);
EXPECT_EQ(*permissions, kPermissionsValues[2]);
permissions = interest_group_permissions_cache_.GetPermissions(
kFrameOrigin, kGroupOrigin, kOtherNetworkIsolationKey);
ASSERT_TRUE(permissions);
EXPECT_EQ(*permissions, kPermissionsValues[3]);
}
TEST_F(InterestGroupPermissionsCacheTest, Clear) {
interest_group_permissions_cache_.CachePermissions(
kPermissions, kFrameOrigin, kGroupOrigin, kNetworkIsolationKey);
Permissions* permissions = interest_group_permissions_cache_.GetPermissions(
kFrameOrigin, kGroupOrigin, kNetworkIsolationKey);
ASSERT_TRUE(permissions);
EXPECT_EQ(*permissions, kPermissions);
interest_group_permissions_cache_.CachePermissions(
kOtherPermissions, kOtherFrameOrigin, kOtherGroupOrigin,
kOtherNetworkIsolationKey);
permissions = interest_group_permissions_cache_.GetPermissions(
kOtherFrameOrigin, kOtherGroupOrigin, kOtherNetworkIsolationKey);
ASSERT_TRUE(permissions);
EXPECT_EQ(*permissions, kOtherPermissions);
EXPECT_EQ(2u, interest_group_permissions_cache_.cache_shards_for_testing());
interest_group_permissions_cache_.Clear();
EXPECT_EQ(0u, interest_group_permissions_cache_.cache_shards_for_testing());
EXPECT_FALSE(interest_group_permissions_cache_.GetPermissions(
kFrameOrigin, kGroupOrigin, kNetworkIsolationKey));
EXPECT_FALSE(interest_group_permissions_cache_.GetPermissions(
kOtherFrameOrigin, kOtherGroupOrigin, kOtherNetworkIsolationKey));
}
TEST_F(InterestGroupPermissionsCacheTest, Expiry) {
interest_group_permissions_cache_.CachePermissions(
kPermissions, kFrameOrigin, kGroupOrigin, kNetworkIsolationKey);
Permissions* permissions = interest_group_permissions_cache_.GetPermissions(
kFrameOrigin, kGroupOrigin, kNetworkIsolationKey);
ASSERT_TRUE(permissions);
EXPECT_EQ(*permissions, kPermissions);
EXPECT_EQ(1u, interest_group_permissions_cache_.cache_shards_for_testing());
task_environment_.FastForwardBy(
InterestGroupPermissionsCache::kCacheDuration);
permissions = interest_group_permissions_cache_.GetPermissions(
kFrameOrigin, kGroupOrigin, kNetworkIsolationKey);
ASSERT_TRUE(permissions);
EXPECT_EQ(*permissions, kPermissions);
EXPECT_EQ(1u, interest_group_permissions_cache_.cache_shards_for_testing());
task_environment_.FastForwardBy(kTinyTime);
// Cache shards are only deleted on a timer or on access, neither of which has
// happened yet, though the shard should now be expired.
EXPECT_EQ(1u, interest_group_permissions_cache_.cache_shards_for_testing());
EXPECT_FALSE(interest_group_permissions_cache_.GetPermissions(
kFrameOrigin, kGroupOrigin, kNetworkIsolationKey));
// The expired cache shard should have been deleted on access.
EXPECT_EQ(0u, interest_group_permissions_cache_.cache_shards_for_testing());
}
// Test the case where a CacheEntry expires without the cache shard also
// expiring.
TEST_F(InterestGroupPermissionsCacheTest, CacheEntryExpiry) {
// Create a cache entry.
interest_group_permissions_cache_.CachePermissions(
kPermissions, kFrameOrigin, kGroupOrigin, kNetworkIsolationKey);
EXPECT_EQ(1u, interest_group_permissions_cache_.cache_shards_for_testing());
// Wait until just before the entry expires.
task_environment_.FastForwardBy(
InterestGroupPermissionsCache::kCacheDuration);
// Add another entry to the same cache shard.
interest_group_permissions_cache_.CachePermissions(
kOtherPermissions, kFrameOrigin, kOtherGroupOrigin, kNetworkIsolationKey);
Permissions* permissions = interest_group_permissions_cache_.GetPermissions(
kFrameOrigin, kOtherGroupOrigin, kNetworkIsolationKey);
ASSERT_TRUE(permissions);
EXPECT_EQ(*permissions, kOtherPermissions);
// There should still be only one cache shard.
EXPECT_EQ(1u, interest_group_permissions_cache_.cache_shards_for_testing());
// Check that the original entry is still there.
permissions = interest_group_permissions_cache_.GetPermissions(
kFrameOrigin, kGroupOrigin, kNetworkIsolationKey);
ASSERT_TRUE(permissions);
EXPECT_EQ(*permissions, kPermissions);
EXPECT_EQ(1u, interest_group_permissions_cache_.cache_shards_for_testing());
// Wait for the origin entry to expire.
task_environment_.FastForwardBy(kTinyTime);
// Original entry should have expired.
EXPECT_FALSE(interest_group_permissions_cache_.GetPermissions(
kFrameOrigin, kGroupOrigin, kNetworkIsolationKey));
// Other entry should still be present.
permissions = interest_group_permissions_cache_.GetPermissions(
kFrameOrigin, kOtherGroupOrigin, kNetworkIsolationKey);
ASSERT_TRUE(permissions);
EXPECT_EQ(*permissions, kOtherPermissions);
// There should still be only one cache shard.
EXPECT_EQ(1u, interest_group_permissions_cache_.cache_shards_for_testing());
}
TEST_F(InterestGroupPermissionsCacheTest, DeleteExpired) {
interest_group_permissions_cache_.CachePermissions(
kPermissions, kFrameOrigin, kGroupOrigin, kNetworkIsolationKey);
// Run until just before the delete expired timer runs. Don't call
// GetPermissions(), as it would delete the entry. At this point, the entry is
// expired, but has not been deleted.
task_environment_.FastForwardBy(
InterestGroupPermissionsCache::kDeleteExpiredTimerDuration - kTinyTime);
EXPECT_EQ(1u, interest_group_permissions_cache_.cache_shards_for_testing());
// Run until the delete expired timer runs, which should delete the entry.
task_environment_.FastForwardBy(kTinyTime);
EXPECT_EQ(0u, interest_group_permissions_cache_.cache_shards_for_testing());
EXPECT_FALSE(interest_group_permissions_cache_.GetPermissions(
kFrameOrigin, kGroupOrigin, kNetworkIsolationKey));
}
TEST_F(InterestGroupPermissionsCacheTest, DeleteExpiredPreservesUnexpired) {
interest_group_permissions_cache_.CachePermissions(
kPermissions, kFrameOrigin, kGroupOrigin, kNetworkIsolationKey);
EXPECT_EQ(1u, interest_group_permissions_cache_.cache_shards_for_testing());
// Run until just before the delete expired timer runs. Don't call
// GetPermissions(), as it would delete the entry. At this point, the entry is
// expired, but has not been deleted.
task_environment_.FastForwardBy(
InterestGroupPermissionsCache::kDeleteExpiredTimerDuration - kTinyTime);
EXPECT_EQ(1u, interest_group_permissions_cache_.cache_shards_for_testing());
// Add permission for a different group.
interest_group_permissions_cache_.CachePermissions(
kOtherPermissions, kFrameOrigin, kOtherGroupOrigin, kNetworkIsolationKey);
EXPECT_EQ(1u, interest_group_permissions_cache_.cache_shards_for_testing());
// Run until the delete expired timer runs, which should delete nothing.
task_environment_.FastForwardBy(kTinyTime);
EXPECT_EQ(1u, interest_group_permissions_cache_.cache_shards_for_testing());
// The original permissions should have expired.
EXPECT_FALSE(interest_group_permissions_cache_.GetPermissions(
kFrameOrigin, kGroupOrigin, kNetworkIsolationKey));
// But the new permissions should still be around.
Permissions* permissions = interest_group_permissions_cache_.GetPermissions(
kFrameOrigin, kOtherGroupOrigin, kNetworkIsolationKey);
ASSERT_TRUE(permissions);
EXPECT_EQ(*permissions, kOtherPermissions);
EXPECT_EQ(1u, interest_group_permissions_cache_.cache_shards_for_testing());
// Run until the delete expired timer triggers again, which should now delete
// the entry.
task_environment_.FastForwardBy(
InterestGroupPermissionsCache::kDeleteExpiredTimerDuration);
EXPECT_EQ(0u, interest_group_permissions_cache_.cache_shards_for_testing());
EXPECT_FALSE(interest_group_permissions_cache_.GetPermissions(
kFrameOrigin, kGroupOrigin, kNetworkIsolationKey));
}
TEST_F(InterestGroupPermissionsCacheTest, LRU) {
// Fill LRU cache.
std::vector<url::Origin> group_origins;
for (int i = 0; i < InterestGroupPermissionsCache::kMaxCacheEntriesPerShard;
++i) {
url::Origin group_origin =
url::Origin::Create(GURL(base::StringPrintf("https://%i.test", i)));
interest_group_permissions_cache_.CachePermissions(
kPermissions, kFrameOrigin, group_origin, kNetworkIsolationKey);
group_origins.emplace_back(std::move(group_origin));
}
// Check all entries are present, accessing in order to end with the same LRU
// order as before.
for (int i = 0; i < InterestGroupPermissionsCache::kMaxCacheEntriesPerShard;
++i) {
Permissions* permissions = interest_group_permissions_cache_.GetPermissions(
kFrameOrigin, group_origins[i], kNetworkIsolationKey);
ASSERT_TRUE(permissions);
EXPECT_EQ(*permissions, kPermissions);
}
// Access first entry.
ASSERT_TRUE(interest_group_permissions_cache_.GetPermissions(
kFrameOrigin, group_origins[0], kNetworkIsolationKey));
// Overwrite second entry.
interest_group_permissions_cache_.CachePermissions(
kOtherPermissions, kFrameOrigin, group_origins[1], kNetworkIsolationKey);
// Add another entry. The third entry is the last-used entry, and should be
// evicted.
interest_group_permissions_cache_.CachePermissions(
kOtherPermissions, kFrameOrigin, kGroupOrigin, kNetworkIsolationKey);
// Check third entry was removed.
EXPECT_FALSE(interest_group_permissions_cache_.GetPermissions(
kFrameOrigin, group_origins[2], kNetworkIsolationKey));
// Check other entries are all still present.
for (int i = 3; i < InterestGroupPermissionsCache::kMaxCacheEntriesPerShard;
++i) {
Permissions* permissions = interest_group_permissions_cache_.GetPermissions(
kFrameOrigin, group_origins[i], kNetworkIsolationKey);
ASSERT_TRUE(permissions);
EXPECT_EQ(*permissions, kPermissions);
}
Permissions* permissions = interest_group_permissions_cache_.GetPermissions(
kFrameOrigin, group_origins[0], kNetworkIsolationKey);
ASSERT_TRUE(permissions);
EXPECT_EQ(*permissions, kPermissions);
permissions = interest_group_permissions_cache_.GetPermissions(
kFrameOrigin, group_origins[1], kNetworkIsolationKey);
ASSERT_TRUE(permissions);
EXPECT_EQ(*permissions, kOtherPermissions);
permissions = interest_group_permissions_cache_.GetPermissions(
kFrameOrigin, kGroupOrigin, kNetworkIsolationKey);
ASSERT_TRUE(permissions);
EXPECT_EQ(*permissions, kOtherPermissions);
}
} // namespace
} // namespace content