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
|
// Copyright 2018 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "components/omnibox/browser/favicon_cache.h"
#include "components/favicon/core/test/mock_favicon_service.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "third_party/skia/include/core/SkBitmap.h"
#include "ui/gfx/favicon_size.h"
using testing::_;
using testing::DoAll;
using testing::Return;
using testing::SaveArg;
namespace {
favicon_base::FaviconImageResult GetDummyFaviconResult() {
favicon_base::FaviconImageResult result;
result.icon_url = GURL("http://example.com/favicon.ico");
SkBitmap bitmap;
bitmap.allocN32Pixels(gfx::kFaviconSize, gfx::kFaviconSize);
bitmap.eraseColor(SK_ColorBLUE);
result.image = gfx::Image::CreateFrom1xBitmap(bitmap);
return result;
}
void VerifyFetchedFaviconAndCount(int* count, const gfx::Image& favicon) {
DCHECK(count);
EXPECT_FALSE(favicon.IsEmpty());
++(*count);
}
void VerifyFetchedFavicon(const gfx::Image& favicon) {
EXPECT_FALSE(favicon.IsEmpty());
}
void Fail(const gfx::Image& favicon) {
FAIL() << "This asynchronous callback should never have been called.";
}
} // namespace
class FaviconCacheTest : public testing::Test {
protected:
const GURL kUrlA = GURL("http://www.a.com/");
const GURL kUrlB = GURL("http://www.b.com/");
const GURL kIconUrl = GURL("http://a.com/favicon.ico");
FaviconCacheTest()
: cache_(&favicon_service_, nullptr /* history_service */) {}
testing::NiceMock<favicon::MockFaviconService> favicon_service_;
void ExpectFaviconServiceForPageUrlCalls(int a_site_calls, int b_site_calls) {
if (a_site_calls > 0) {
EXPECT_CALL(
favicon_service_,
GetFaviconImageForPageURL(kUrlA, _ /* callback */, _ /* tracker */))
.Times(a_site_calls)
.WillRepeatedly(
DoAll(SaveArg<1>(&favicon_service_a_site_response_),
Return(base::CancelableTaskTracker::kBadTaskId)));
}
if (b_site_calls > 0) {
EXPECT_CALL(
favicon_service_,
GetFaviconImageForPageURL(kUrlB, _ /* callback */, _ /* tracker */))
.Times(b_site_calls)
.WillRepeatedly(
DoAll(SaveArg<1>(&favicon_service_b_site_response_),
Return(base::CancelableTaskTracker::kBadTaskId)));
}
}
void ExpectFaviconServiceForIconUrlCalls(int calls) {
EXPECT_CALL(favicon_service_,
GetFaviconImage(kIconUrl, _ /* callback */, _ /* tracker */))
.Times(calls);
}
favicon_base::FaviconImageCallback favicon_service_a_site_response_;
favicon_base::FaviconImageCallback favicon_service_b_site_response_;
FaviconCache cache_;
};
TEST_F(FaviconCacheTest, Basic) {
ExpectFaviconServiceForPageUrlCalls(1, 0);
ExpectFaviconServiceForIconUrlCalls(0);
int response_count = 0;
gfx::Image result = cache_.GetFaviconForPageUrl(
kUrlA, base::BindOnce(&VerifyFetchedFaviconAndCount, &response_count));
// Expect the synchronous result to be empty.
EXPECT_TRUE(result.IsEmpty());
favicon_service_a_site_response_.Run(GetDummyFaviconResult());
// Re-request the same favicon and expect a non-empty result now that the
// cache is populated. The above EXPECT_CALL will also verify that the
// backing FaviconService is not hit again.
result = cache_.GetFaviconForPageUrl(kUrlA, base::BindOnce(&Fail));
EXPECT_FALSE(result.IsEmpty());
EXPECT_EQ(1, response_count);
}
TEST_F(FaviconCacheTest, GetFaviconForIconUrl) {
// Verify that the service receives a request by the icon URL.
ExpectFaviconServiceForPageUrlCalls(0, 0);
ExpectFaviconServiceForIconUrlCalls(1);
// Since the other tests are comprehensive, we don't simulate or verify the
// actual result.
gfx::Image result =
cache_.GetFaviconForIconUrl(kIconUrl, base::BindOnce(&Fail));
EXPECT_TRUE(result.IsEmpty());
}
TEST_F(FaviconCacheTest, MultipleRequestsAreCoalesced) {
ExpectFaviconServiceForPageUrlCalls(1, 0);
int response_count = 0;
for (int i = 0; i < 10; ++i) {
cache_.GetFaviconForPageUrl(
kUrlA, base::BindOnce(&VerifyFetchedFaviconAndCount, &response_count));
}
favicon_service_a_site_response_.Run(GetDummyFaviconResult());
EXPECT_EQ(10, response_count);
}
TEST_F(FaviconCacheTest, SeparateOriginsAreCachedSeparately) {
ExpectFaviconServiceForPageUrlCalls(1, 1);
int a_site_response_count = 0;
int b_site_response_count = 0;
gfx::Image a_site_return = cache_.GetFaviconForPageUrl(
kUrlA,
base::BindOnce(&VerifyFetchedFaviconAndCount, &a_site_response_count));
gfx::Image b_site_return = cache_.GetFaviconForPageUrl(
kUrlB,
base::BindOnce(&VerifyFetchedFaviconAndCount, &b_site_response_count));
EXPECT_TRUE(a_site_return.IsEmpty());
EXPECT_TRUE(b_site_return.IsEmpty());
EXPECT_EQ(0, a_site_response_count);
EXPECT_EQ(0, b_site_response_count);
favicon_service_b_site_response_.Run(GetDummyFaviconResult());
EXPECT_EQ(0, a_site_response_count);
EXPECT_EQ(1, b_site_response_count);
a_site_return = cache_.GetFaviconForPageUrl(
kUrlA,
base::BindOnce(&VerifyFetchedFaviconAndCount, &a_site_response_count));
b_site_return = cache_.GetFaviconForPageUrl(kUrlB, base::BindOnce(&Fail));
EXPECT_TRUE(a_site_return.IsEmpty());
EXPECT_FALSE(b_site_return.IsEmpty());
EXPECT_EQ(0, a_site_response_count);
EXPECT_EQ(1, b_site_response_count);
favicon_service_a_site_response_.Run(GetDummyFaviconResult());
EXPECT_EQ(2, a_site_response_count);
EXPECT_EQ(1, b_site_response_count);
a_site_return = cache_.GetFaviconForPageUrl(kUrlA, base::BindOnce(&Fail));
b_site_return = cache_.GetFaviconForPageUrl(kUrlB, base::BindOnce(&Fail));
EXPECT_FALSE(a_site_return.IsEmpty());
EXPECT_FALSE(b_site_return.IsEmpty());
}
TEST_F(FaviconCacheTest, ClearIconsWithHistoryDeletions) {
ExpectFaviconServiceForPageUrlCalls(3, 2);
EXPECT_TRUE(
cache_.GetFaviconForPageUrl(kUrlA, base::BindOnce(&VerifyFetchedFavicon))
.IsEmpty());
EXPECT_TRUE(
cache_.GetFaviconForPageUrl(kUrlB, base::BindOnce(&VerifyFetchedFavicon))
.IsEmpty());
favicon_service_a_site_response_.Run(GetDummyFaviconResult());
favicon_service_b_site_response_.Run(GetDummyFaviconResult());
EXPECT_FALSE(
cache_.GetFaviconForPageUrl(kUrlA, base::BindOnce(&Fail)).IsEmpty());
EXPECT_FALSE(
cache_.GetFaviconForPageUrl(kUrlB, base::BindOnce(&Fail)).IsEmpty());
// Delete just the entry for kUrlA.
history::URLRows a_rows = {history::URLRow(kUrlA)};
cache_.OnURLsDeleted(
nullptr /* history_service */,
history::DeletionInfo::ForUrls(a_rows, {} /* favicon_urls */));
EXPECT_TRUE(
cache_.GetFaviconForPageUrl(kUrlA, base::BindOnce(&VerifyFetchedFavicon))
.IsEmpty());
EXPECT_FALSE(
cache_.GetFaviconForPageUrl(kUrlB, base::BindOnce(&Fail)).IsEmpty());
// Restore the cache entry for kUrlA.
favicon_service_a_site_response_.Run(GetDummyFaviconResult());
// Delete all history.
cache_.OnURLsDeleted(nullptr /* history_service */,
history::DeletionInfo::ForAllHistory());
EXPECT_TRUE(
cache_.GetFaviconForPageUrl(kUrlA, base::BindOnce(&VerifyFetchedFavicon))
.IsEmpty());
EXPECT_TRUE(
cache_.GetFaviconForPageUrl(kUrlB, base::BindOnce(&VerifyFetchedFavicon))
.IsEmpty());
}
TEST_F(FaviconCacheTest, CacheNullFavicons) {
ExpectFaviconServiceForPageUrlCalls(1, 0);
EXPECT_TRUE(
cache_.GetFaviconForPageUrl(kUrlA, base::BindOnce(&Fail)).IsEmpty());
favicon_service_a_site_response_.Run(favicon_base::FaviconImageResult());
// The mock FaviconService's EXPECT_CALL verifies that we do not make another
// call to FaviconService.
EXPECT_TRUE(
cache_.GetFaviconForPageUrl(kUrlA, base::BindOnce(&Fail)).IsEmpty());
}
TEST_F(FaviconCacheTest, ExpireNullFaviconsByHistory) {
ExpectFaviconServiceForPageUrlCalls(2, 0);
EXPECT_TRUE(
cache_.GetFaviconForPageUrl(kUrlA, base::BindOnce(&Fail)).IsEmpty());
favicon_service_a_site_response_.Run(favicon_base::FaviconImageResult());
cache_.OnURLVisited(nullptr /* history_service */, ui::PAGE_TRANSITION_LINK,
history::URLRow(kUrlA), history::RedirectList(),
base::Time::Now());
// Now the empty favicon should have been expired and we expect our second
// call to the mock underlying FaviconService.
EXPECT_TRUE(
cache_.GetFaviconForPageUrl(kUrlA, base::BindOnce(&VerifyFetchedFavicon))
.IsEmpty());
favicon_service_a_site_response_.Run(GetDummyFaviconResult());
EXPECT_FALSE(
cache_.GetFaviconForPageUrl(kUrlA, base::BindOnce(&Fail)).IsEmpty());
}
TEST_F(FaviconCacheTest, ObserveFaviconsChanged) {
ExpectFaviconServiceForPageUrlCalls(2, 1);
EXPECT_TRUE(
cache_.GetFaviconForPageUrl(kUrlA, base::BindOnce(&Fail)).IsEmpty());
EXPECT_TRUE(
cache_.GetFaviconForPageUrl(kUrlB, base::BindOnce(&Fail)).IsEmpty());
// Simulate responses to both requests.
favicon_service_a_site_response_.Run(favicon_base::FaviconImageResult());
favicon_service_b_site_response_.Run(favicon_base::FaviconImageResult());
cache_.OnFaviconsChanged({kUrlA}, GURL());
// Request the two favicons again.
EXPECT_TRUE(
cache_.GetFaviconForPageUrl(kUrlA, base::BindOnce(&Fail)).IsEmpty());
EXPECT_TRUE(
cache_.GetFaviconForPageUrl(kUrlB, base::BindOnce(&Fail)).IsEmpty());
// Our call to |ExpectFaviconServiceForPageUrlCalls(expected A calls, expected
// B calls)| above should verify that we re-request the icon for kUrlA only
// (because the null result has been invalidated by OnFaviconsChanged).
}
|
