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
|
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "components/omnibox/browser/fake_autocomplete_controller.h"
#include <memory>
#include <string>
#include <vector>
#include "base/memory/raw_ptr.h"
#include "base/strings/string_number_conversions.h"
#include "base/strings/utf_string_conversions.h"
#include "base/test/task_environment.h"
#include "components/omnibox/browser/autocomplete_controller.h"
#include "components/omnibox/browser/autocomplete_match.h"
#include "components/omnibox/browser/autocomplete_match_type.h"
#include "components/omnibox/browser/fake_autocomplete_controller.h"
#include "components/omnibox/browser/fake_autocomplete_provider.h"
#include "components/omnibox/browser/fake_autocomplete_provider_client.h"
#include "components/omnibox/browser/omnibox_prefs.h"
#include "components/omnibox/browser/test_scheme_classifier.h"
#include "components/prefs/pref_registry_simple.h"
#include "testing/gtest/include/gtest/gtest.h"
void FakeAutocompleteControllerObserver::OnResultChanged(
AutocompleteController* controller,
bool default_match_changed) {
on_result_changed_call_count_++;
last_default_match_changed = default_match_changed;
}
void FakeAutocompleteControllerObserver::OnAutocompleteStopTimerTriggered(
const AutocompleteInput& input) {
on_autocomplete_stop_timer_stopped_call_count++;
}
FakeAutocompleteController::FakeAutocompleteController(
raw_ptr<base::test::SingleThreadTaskEnvironment> task_environment)
: AutocompleteController(std::make_unique<FakeAutocompleteProviderClient>(),
0),
task_environment_(task_environment) {
omnibox::RegisterProfilePrefs(static_cast<PrefRegistrySimple*>(
static_cast<FakeAutocompleteProviderClient*>(
autocomplete_provider_client())
->GetPrefs()
->DeprecatedGetPrefRegistry()));
providers_.push_back(base::MakeRefCounted<FakeAutocompleteProvider>(
AutocompleteProvider::Type::TYPE_BOOKMARK));
providers_.push_back(base::MakeRefCounted<FakeAutocompleteProvider>(
AutocompleteProvider::Type::TYPE_BUILTIN));
providers_.push_back(base::MakeRefCounted<FakeAutocompleteProvider>(
AutocompleteProvider::Type::TYPE_HISTORY_QUICK));
providers_.push_back(base::MakeRefCounted<FakeAutocompleteProvider>(
AutocompleteProvider::Type::TYPE_KEYWORD));
providers_.push_back(base::MakeRefCounted<FakeAutocompleteProvider>(
AutocompleteProvider::Type::TYPE_SEARCH));
providers_.push_back(base::MakeRefCounted<FakeAutocompleteProvider>(
AutocompleteProvider::Type::TYPE_HISTORY_URL));
providers_.push_back(base::MakeRefCounted<FakeAutocompleteProvider>(
AutocompleteProvider::Type::TYPE_DOCUMENT));
providers_.push_back(base::MakeRefCounted<FakeAutocompleteProvider>(
AutocompleteProvider::Type::TYPE_HISTORY_CLUSTER_PROVIDER));
observer_ = std::make_unique<FakeAutocompleteControllerObserver>();
AddObserver(observer_.get());
}
FakeAutocompleteController::~FakeAutocompleteController() = default;
// static
AutocompleteInput FakeAutocompleteController::CreateInput(
std::u16string text,
bool omit_async,
bool prevent_inline_autocomplete) {
AutocompleteInput input(text, 0, metrics::OmniboxEventProto::OTHER,
TestSchemeClassifier());
input.set_omit_asynchronous_matches(omit_async);
input.set_prevent_inline_autocomplete(prevent_inline_autocomplete);
return input;
}
std::vector<std::string> FakeAutocompleteController::SimulateAutocompletePass(
bool sync,
bool done,
std::vector<AutocompleteMatch> matches,
AutocompleteInput input) {
GetFakeProvider().matches_ = matches;
GetFakeProvider().done_ = done;
AutocompleteController::UpdateType expected_last_update_type =
AutocompleteController::UpdateType::kNone;
EXPECT_EQ(observer_->on_result_changed_call_count_, 0);
if (sync) {
Start(input);
expected_last_update_type =
done ? AutocompleteController::UpdateType::kSyncPassOnly
: AutocompleteController::UpdateType::kSyncPass;
} else {
OnProviderUpdate(true, &GetFakeProvider());
expected_last_update_type =
done ? AutocompleteController::UpdateType::kLastAsyncPass
: AutocompleteController::UpdateType::kAsyncPass;
}
ExpectOnResultChanged(sync || done ? 0 : 200, expected_last_update_type);
return GetResultContents(true);
}
std::vector<std::string>
FakeAutocompleteController::SimulateCleanAutocompletePass(
std::vector<AutocompleteMatch> matches) {
internal_result_.ClearMatches();
return SimulateAutocompletePass(true, true, matches);
}
std::vector<std::string> FakeAutocompleteController::SimulateExpirePass() {
EXPECT_EQ(observer_->on_result_changed_call_count_, 0);
UpdateResult(AutocompleteController::UpdateType::kExpirePass);
ExpectOnResultChanged(200, AutocompleteController::UpdateType::kExpirePass);
return GetResultContents(true);
}
std::vector<std::string> FakeAutocompleteController::GetResultContents(
bool published) {
std::vector<std::string> names;
auto& result = published ? published_result_ : internal_result_;
for (const auto& match : result)
names.push_back(base::UTF16ToUTF8(match.contents));
return names;
}
void FakeAutocompleteController::ExpectOnResultChanged(
int delay_ms,
AutocompleteController::UpdateType last_update_type) {
std::string debug =
"delay_ms: " + base::NumberToString(delay_ms) + ", last_update_type: " +
AutocompleteController::UpdateTypeToDebugString(last_update_type);
if (delay_ms) {
task_environment_->FastForwardBy(base::Milliseconds(delay_ms - 1));
EXPECT_EQ(observer_->on_result_changed_call_count_, 0) << debug;
task_environment_->FastForwardBy(base::Milliseconds(1));
EXPECT_EQ(observer_->on_result_changed_call_count_, 1) << debug;
} else {
EXPECT_EQ(observer_->on_result_changed_call_count_, 1) << debug;
}
EXPECT_EQ(last_update_type_, last_update_type) << debug;
observer_->on_result_changed_call_count_ = 0;
}
void FakeAutocompleteController::ExpectStopAfter(int delay_ms,
bool explicit_stop) {
if (delay_ms) {
task_environment_->FastForwardBy(base::Milliseconds(delay_ms - 1));
EXPECT_NE(last_update_type_, AutocompleteController::UpdateType::kStop)
<< delay_ms;
EXPECT_EQ(observer_->on_autocomplete_stop_timer_stopped_call_count, 0)
<< delay_ms;
task_environment_->FastForwardBy(base::Milliseconds(1));
}
EXPECT_EQ(last_update_type_, AutocompleteController::UpdateType::kStop)
<< delay_ms;
EXPECT_EQ(observer_->on_autocomplete_stop_timer_stopped_call_count,
explicit_stop ? 0 : 1)
<< delay_ms;
// Any expected notifications should be verified with
// `ExpectOnResultChanged()` and not slip through polluting subsequent
// tests.
EXPECT_EQ(observer_->on_result_changed_call_count_, 0) << delay_ms;
observer_->on_autocomplete_stop_timer_stopped_call_count = 0;
}
void FakeAutocompleteController::ExpectNoNotificationOrStop() {
// Cache the `last_update_type_` and override, so that we can verify no new
// stop updates happen even if the last update was a stop.
auto last_update_type = last_update_type_;
last_update_type_ = AutocompleteController::UpdateType::kNone;
task_environment_->FastForwardBy(base::Milliseconds(10000));
EXPECT_EQ(observer_->on_result_changed_call_count_, 0);
EXPECT_NE(last_update_type_, AutocompleteController::UpdateType::kStop);
last_update_type_ = last_update_type;
}
|