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
|
// 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/document_provider.h"
#include "base/json/json_reader.h"
#include "base/strings/utf_string_conversions.h"
#include "base/test/scoped_feature_list.h"
#include "base/values.h"
#include "components/omnibox/browser/autocomplete_provider.h"
#include "components/omnibox/browser/autocomplete_provider_listener.h"
#include "components/omnibox/browser/mock_autocomplete_provider_client.h"
#include "components/omnibox/browser/omnibox_field_trial.h"
#include "components/omnibox/browser/omnibox_pref_names.h"
#include "components/omnibox/browser/test_scheme_classifier.h"
#include "components/prefs/pref_registry_simple.h"
#include "components/prefs/testing_pref_service.h"
#include "testing/gtest/include/gtest/gtest.h"
namespace {
using testing::Return;
class FakeAutocompleteProviderClient : public MockAutocompleteProviderClient {
public:
FakeAutocompleteProviderClient()
: template_url_service_(new TemplateURLService(nullptr, 0)) {
pref_service_.registry()->RegisterBooleanPref(
omnibox::kDocumentSuggestEnabled, true);
}
bool SearchSuggestEnabled() const override { return true; }
TemplateURLService* GetTemplateURLService() override {
return template_url_service_.get();
}
TemplateURLService* GetTemplateURLService() const override {
return template_url_service_.get();
}
PrefService* GetPrefs() override { return &pref_service_; }
private:
std::unique_ptr<TemplateURLService> template_url_service_;
TestingPrefServiceSimple pref_service_;
DISALLOW_COPY_AND_ASSIGN(FakeAutocompleteProviderClient);
};
} // namespace
class DocumentProviderTest : public testing::Test,
public AutocompleteProviderListener {
public:
DocumentProviderTest();
void SetUp() override;
protected:
// AutocompleteProviderListener:
void OnProviderUpdate(bool updated_matches) override;
std::unique_ptr<FakeAutocompleteProviderClient> client_;
scoped_refptr<DocumentProvider> provider_;
TemplateURL* default_template_url_;
private:
DISALLOW_COPY_AND_ASSIGN(DocumentProviderTest);
};
DocumentProviderTest::DocumentProviderTest() {}
void DocumentProviderTest::SetUp() {
client_.reset(new FakeAutocompleteProviderClient());
TemplateURLService* turl_model = client_->GetTemplateURLService();
turl_model->Load();
TemplateURLData data;
data.SetShortName(base::ASCIIToUTF16("t"));
data.SetURL("https://www.google.com/?q={searchTerms}");
data.suggestions_url = "https://www.google.com/complete/?q={searchTerms}";
default_template_url_ = turl_model->Add(std::make_unique<TemplateURL>(data));
turl_model->SetUserSelectedDefaultSearchProvider(default_template_url_);
provider_ = DocumentProvider::Create(client_.get(), this);
}
void DocumentProviderTest::OnProviderUpdate(bool updated_matches) {
// No action required.
}
TEST_F(DocumentProviderTest, CheckFeatureBehindFlag) {
base::test::ScopedFeatureList feature_list;
feature_list.InitAndDisableFeature(omnibox::kDocumentProvider);
EXPECT_FALSE(provider_->IsDocumentProviderAllowed(client_.get()));
}
TEST_F(DocumentProviderTest, CheckFeaturePrerequisiteNoIncognito) {
base::test::ScopedFeatureList feature_list;
feature_list.InitAndEnableFeature(omnibox::kDocumentProvider);
EXPECT_CALL(*client_.get(), SearchSuggestEnabled())
.WillRepeatedly(Return(true));
EXPECT_CALL(*client_.get(), IsAuthenticated()).WillRepeatedly(Return(true));
EXPECT_CALL(*client_.get(), IsUnifiedConsentGiven())
.WillRepeatedly(Return(true));
EXPECT_CALL(*client_.get(), IsOffTheRecord()).WillRepeatedly(Return(false));
// Feature starts enabled.
EXPECT_TRUE(provider_->IsDocumentProviderAllowed(client_.get()));
// Feature should be disabled in incognito.
EXPECT_CALL(*client_.get(), IsOffTheRecord()).WillRepeatedly(Return(true));
EXPECT_FALSE(provider_->IsDocumentProviderAllowed(client_.get()));
}
TEST_F(DocumentProviderTest, CheckFeaturePrerequisiteNoConsentBit) {
base::test::ScopedFeatureList feature_list;
feature_list.InitAndEnableFeature(omnibox::kDocumentProvider);
EXPECT_CALL(*client_.get(), SearchSuggestEnabled())
.WillRepeatedly(Return(true));
EXPECT_CALL(*client_.get(), IsAuthenticated()).WillRepeatedly(Return(true));
EXPECT_CALL(*client_.get(), IsUnifiedConsentGiven())
.WillRepeatedly(Return(true));
EXPECT_CALL(*client_.get(), IsOffTheRecord()).WillRepeatedly(Return(false));
// Feature starts enabled.
EXPECT_TRUE(provider_->IsDocumentProviderAllowed(client_.get()));
// Feature should be disabled without a consent bit.
EXPECT_CALL(*client_.get(), IsUnifiedConsentGiven()).WillOnce(Return(false));
EXPECT_FALSE(provider_->IsDocumentProviderAllowed(client_.get()));
}
TEST_F(DocumentProviderTest, CheckFeaturePrerequisiteClientSettingOff) {
base::test::ScopedFeatureList feature_list;
feature_list.InitAndEnableFeature(omnibox::kDocumentProvider);
EXPECT_CALL(*client_.get(), SearchSuggestEnabled())
.WillRepeatedly(Return(true));
EXPECT_CALL(*client_.get(), IsAuthenticated()).WillRepeatedly(Return(true));
EXPECT_CALL(*client_.get(), IsUnifiedConsentGiven())
.WillRepeatedly(Return(true));
EXPECT_CALL(*client_.get(), IsOffTheRecord()).WillRepeatedly(Return(false));
// Feature starts enabled.
EXPECT_TRUE(provider_->IsDocumentProviderAllowed(client_.get()));
// Disabling toggle in chrome://settings should be respected.
PrefService* fake_prefs = client_->GetPrefs();
fake_prefs->SetBoolean(omnibox::kDocumentSuggestEnabled, false);
EXPECT_FALSE(provider_->IsDocumentProviderAllowed(client_.get()));
fake_prefs->SetBoolean(omnibox::kDocumentSuggestEnabled, true);
}
TEST_F(DocumentProviderTest, CheckFeaturePrerequisiteDefaultSearch) {
base::test::ScopedFeatureList feature_list;
feature_list.InitAndEnableFeature(omnibox::kDocumentProvider);
EXPECT_CALL(*client_.get(), SearchSuggestEnabled())
.WillRepeatedly(Return(true));
EXPECT_CALL(*client_.get(), IsAuthenticated()).WillRepeatedly(Return(true));
EXPECT_CALL(*client_.get(), IsUnifiedConsentGiven())
.WillRepeatedly(Return(true));
EXPECT_CALL(*client_.get(), IsOffTheRecord()).WillRepeatedly(Return(false));
// Feature starts enabled.
EXPECT_TRUE(provider_->IsDocumentProviderAllowed(client_.get()));
// Switching default search disables it.
TemplateURLService* template_url_service = client_->GetTemplateURLService();
TemplateURLData data;
data.SetShortName(base::ASCIIToUTF16("t"));
data.SetURL("https://www.notgoogle.com/?q={searchTerms}");
data.suggestions_url = "https://www.notgoogle.com/complete/?q={searchTerms}";
TemplateURL* new_default_provider =
template_url_service->Add(std::make_unique<TemplateURL>(data));
template_url_service->SetUserSelectedDefaultSearchProvider(
new_default_provider);
EXPECT_FALSE(provider_->IsDocumentProviderAllowed(client_.get()));
template_url_service->SetUserSelectedDefaultSearchProvider(
default_template_url_);
template_url_service->Remove(new_default_provider);
}
TEST_F(DocumentProviderTest, CheckFeaturePrerequisiteServerBackoff) {
base::test::ScopedFeatureList feature_list;
feature_list.InitAndEnableFeature(omnibox::kDocumentProvider);
EXPECT_CALL(*client_.get(), SearchSuggestEnabled())
.WillRepeatedly(Return(true));
EXPECT_CALL(*client_.get(), IsAuthenticated()).WillRepeatedly(Return(true));
EXPECT_CALL(*client_.get(), IsUnifiedConsentGiven())
.WillRepeatedly(Return(true));
EXPECT_CALL(*client_.get(), IsOffTheRecord()).WillRepeatedly(Return(false));
// Feature starts enabled.
EXPECT_TRUE(provider_->IsDocumentProviderAllowed(client_.get()));
// Server setting backoff flag disables it.
provider_->backoff_for_session_ = true;
EXPECT_FALSE(provider_->IsDocumentProviderAllowed(client_.get()));
provider_->backoff_for_session_ = false;
}
TEST_F(DocumentProviderTest, IsInputLikelyURL) {
base::test::ScopedFeatureList feature_list;
feature_list.InitAndEnableFeature(omnibox::kDocumentProvider);
auto IsInputLikelyURL_Wrapper = [](const std::string& input_ascii) {
const AutocompleteInput autocomplete_input(
base::ASCIIToUTF16(input_ascii), metrics::OmniboxEventProto::OTHER,
TestSchemeClassifier());
return DocumentProvider::IsInputLikelyURL(autocomplete_input);
};
EXPECT_TRUE(IsInputLikelyURL_Wrapper("htt"));
EXPECT_TRUE(IsInputLikelyURL_Wrapper("http"));
EXPECT_TRUE(IsInputLikelyURL_Wrapper("https"));
EXPECT_TRUE(IsInputLikelyURL_Wrapper("https://"));
EXPECT_TRUE(IsInputLikelyURL_Wrapper("http://web.site"));
EXPECT_TRUE(IsInputLikelyURL_Wrapper("https://web.site"));
EXPECT_TRUE(IsInputLikelyURL_Wrapper("https://web.site"));
EXPECT_TRUE(IsInputLikelyURL_Wrapper("w"));
EXPECT_TRUE(IsInputLikelyURL_Wrapper("www."));
EXPECT_TRUE(IsInputLikelyURL_Wrapper("www.web.site"));
EXPECT_TRUE(IsInputLikelyURL_Wrapper("chrome://extensions"));
EXPECT_FALSE(IsInputLikelyURL_Wrapper("https certificate"));
EXPECT_FALSE(IsInputLikelyURL_Wrapper("www website hosting"));
EXPECT_FALSE(IsInputLikelyURL_Wrapper("text query"));
}
TEST_F(DocumentProviderTest, ParseDocumentSearchResults) {
const char kGoodJSONResponse[] = R"({
"results": [
{
"title": "Document 1",
"url": "https://documentprovider.tld/doc?id=1",
"score": 1234,
"originalUrl": "https://shortened.url"
},
{
"title": "Document 2",
"url": "https://documentprovider.tld/doc?id=2"
}
]
})";
std::unique_ptr<base::DictionaryValue> response =
base::DictionaryValue::From(base::JSONReader::Read(kGoodJSONResponse));
ASSERT_TRUE(response != nullptr);
ACMatches matches;
provider_->ParseDocumentSearchResults(*response, &matches);
EXPECT_EQ(matches.size(), 2u);
EXPECT_EQ(matches[0].contents, base::ASCIIToUTF16("Document 1"));
EXPECT_EQ(matches[0].destination_url,
GURL("https://documentprovider.tld/doc?id=1"));
EXPECT_EQ(matches[0].relevance, 1234); // Server-specified.
EXPECT_EQ(matches[0].stripped_destination_url, GURL("https://shortened.url"));
EXPECT_EQ(matches[1].contents, base::ASCIIToUTF16("Document 2"));
EXPECT_EQ(matches[1].destination_url,
GURL("https://documentprovider.tld/doc?id=2"));
EXPECT_EQ(matches[1].relevance, 700); // From study default.
EXPECT_TRUE(matches[1].stripped_destination_url.is_empty());
ASSERT_FALSE(provider_->backoff_for_session_);
}
TEST_F(DocumentProviderTest, ParseDocumentSearchResultsWithBackoff) {
// Response where the server wishes to trigger backoff.
const char kBackoffJSONResponse[] = R"({
"error": {
"code": 503,
"message": "Not eligible to query, see retry info.",
"status": "UNAVAILABLE",
"details": [
{
"@type": "type.googleapis.com/google.rpc.RetryInfo",
"retryDelay": "100000s"
},
]
}
})";
ASSERT_FALSE(provider_->backoff_for_session_);
std::unique_ptr<base::DictionaryValue> backoff_response =
base::DictionaryValue::From(base::JSONReader::Read(
kBackoffJSONResponse, base::JSON_ALLOW_TRAILING_COMMAS));
ASSERT_TRUE(backoff_response != nullptr);
ACMatches matches;
provider_->ParseDocumentSearchResults(*backoff_response, &matches);
ASSERT_TRUE(provider_->backoff_for_session_);
}
TEST_F(DocumentProviderTest, ParseDocumentSearchResultsWithIneligibleFlag) {
// Response where the server wishes to trigger backoff.
const char kIneligibleJSONResponse[] = R"({
"error": {
"code": 403,
"message": "Not eligible to query due to admin disabled Chrome search settings.",
"status": "PERMISSION_DENIED",
}
})";
// Same as above, but the message doesn't match. We should accept this
// response, but it isn't expected to trigger backoff.
const char kMismatchedMessageJSON[] = R"({
"error": {
"code": 403,
"message": "Some other thing went wrong.",
"status": "PERMISSION_DENIED",
}
})";
ACMatches matches;
ASSERT_FALSE(provider_->backoff_for_session_);
// First, parse an invalid response - shouldn't prohibit future requests
// from working but also shouldn't trigger backoff.
std::unique_ptr<base::DictionaryValue> bad_response =
base::DictionaryValue::From(base::JSONReader::Read(
kMismatchedMessageJSON, base::JSON_ALLOW_TRAILING_COMMAS));
ASSERT_TRUE(bad_response != nullptr);
provider_->ParseDocumentSearchResults(*bad_response, &matches);
ASSERT_FALSE(provider_->backoff_for_session_);
// Now parse a response that does trigger backoff.
std::unique_ptr<base::DictionaryValue> backoff_response =
base::DictionaryValue::From(base::JSONReader::Read(
kIneligibleJSONResponse, base::JSON_ALLOW_TRAILING_COMMAS));
ASSERT_TRUE(backoff_response != nullptr);
provider_->ParseDocumentSearchResults(*backoff_response, &matches);
ASSERT_TRUE(provider_->backoff_for_session_);
}
|
