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 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462
|
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "ash/quick_insert/search/quick_insert_search_request.h"
#include <algorithm>
#include <cstddef>
#include <functional>
#include <map>
#include <optional>
#include <set>
#include <string>
#include <string_view>
#include <utility>
#include <variant>
#include <vector>
#include "ash/public/cpp/app_list/app_list_types.h"
#include "ash/quick_insert/quick_insert_category.h"
#include "ash/quick_insert/quick_insert_client.h"
#include "ash/quick_insert/quick_insert_clipboard_history_provider.h"
#include "ash/quick_insert/quick_insert_search_result.h"
#include "ash/quick_insert/search/quick_insert_action_search.h"
#include "ash/quick_insert/search/quick_insert_date_search.h"
#include "ash/quick_insert/search/quick_insert_editor_search.h"
#include "ash/quick_insert/search/quick_insert_lobster_search.h"
#include "ash/quick_insert/search/quick_insert_math_search.h"
#include "ash/quick_insert/search/quick_insert_search_source.h"
#include "base/check.h"
#include "base/check_deref.h"
#include "base/containers/contains.h"
#include "base/containers/fixed_flat_set.h"
#include "base/containers/flat_set.h"
#include "base/containers/span.h"
#include "base/containers/to_vector.h"
#include "base/functional/bind.h"
#include "base/functional/callback_forward.h"
#include "base/functional/callback_helpers.h"
#include "base/logging.h"
#include "base/metrics/histogram_functions.h"
#include "base/notreached.h"
#include "base/parameter_pack.h"
#include "base/strings/utf_string_conversions.h"
#include "base/time/time.h"
#include "base/types/cxx23_to_underlying.h"
#include "chromeos/ash/components/emoji/gif_tenor_api_fetcher.h"
#include "chromeos/ash/components/emoji/tenor_types.mojom.h"
#include "components/endpoint_fetcher/endpoint_fetcher.h"
#include "services/network/public/cpp/shared_url_loader_factory.h"
#include "url/gurl.h"
namespace ash {
namespace {
// TODO: b/330936766 - Prioritise "earlier" domains in this list.
constexpr auto kGoogleCorpGotoHosts = base::MakeFixedFlatSet<std::string_view>(
{"goto2.corp.google.com", "goto.corp.google.com", "goto.google.com", "go"});
constexpr int kMaxGifsToSearch = 25;
const char* SearchSourceToHistogram(QuickInsertSearchSource source) {
switch (source) {
case QuickInsertSearchSource::kOmnibox:
return "Ash.Picker.Search.OmniboxProvider.QueryTime";
case QuickInsertSearchSource::kDate:
return "Ash.Picker.Search.DateProvider.QueryTime";
case QuickInsertSearchSource::kAction:
return "Ash.Picker.Search.CategoryProvider.QueryTime";
case QuickInsertSearchSource::kLocalFile:
return "Ash.Picker.Search.FileProvider.QueryTime";
case QuickInsertSearchSource::kDrive:
return "Ash.Picker.Search.DriveProvider.QueryTime";
case QuickInsertSearchSource::kMath:
return "Ash.Picker.Search.MathProvider.QueryTime";
case QuickInsertSearchSource::kClipboard:
return "Ash.Picker.Search.ClipboardProvider.QueryTime";
case QuickInsertSearchSource::kEditorWrite:
case QuickInsertSearchSource::kEditorRewrite:
return "Ash.Picker.Search.EditorProvider.QueryTime";
case QuickInsertSearchSource::kLobsterWithNoSelectedText:
case QuickInsertSearchSource::kLobsterWithSelectedText:
return "Ash.Picker.Search.LobsterProvider.QueryTime";
case QuickInsertSearchSource::kGifs:
return "Ash.Picker.Search.Gifs.QueryTime";
}
NOTREACHED() << "Unexpected search source " << base::to_underlying(source);
}
[[nodiscard]] std::vector<QuickInsertSearchResult>
DeduplicateGoogleCorpGotoDomains(
std::vector<QuickInsertSearchResult> omnibox_results) {
std::set<std::string, std::less<>> seen;
std::vector<QuickInsertSearchResult> deduped_results;
std::vector<QuickInsertSearchResult*> results_to_remove;
for (QuickInsertSearchResult& link : omnibox_results) {
auto* link_data = std::get_if<QuickInsertBrowsingHistoryResult>(&link);
if (link_data == nullptr) {
deduped_results.push_back(std::move(link));
continue;
}
const GURL& url = link_data->url;
if (!url.has_host() || !url.has_path() ||
!kGoogleCorpGotoHosts.contains(url.host_piece())) {
deduped_results.push_back(std::move(link));
continue;
}
auto [it, inserted] = seen.emplace(url.path_piece());
if (inserted) {
deduped_results.push_back(std::move(link));
}
}
return deduped_results;
}
std::vector<QuickInsertSearchResult> ConvertGifResponse(
base::expected<tenor::mojom::PaginatedGifResponsesPtr,
GifTenorApiFetcher::Error> response) {
if (!response.has_value()) {
// TODO: b/325368650 - Add better handling of errors.
return {};
}
size_t rank = 0;
return base::ToVector(
(*response)->results,
[&rank](const tenor::mojom::GifResponsePtr& result) {
CHECK(result);
const tenor::mojom::GifUrlsPtr& urls = result->url;
CHECK(urls);
return QuickInsertSearchResult(QuickInsertGifResult(
urls->preview, urls->preview_image, result->preview_size,
urls->full, result->full_size,
base::UTF8ToUTF16(result->content_description), rank++));
});
}
} // namespace
QuickInsertSearchRequest::QuickInsertSearchRequest(
std::u16string_view query,
std::optional<QuickInsertCategory> category,
SearchResultsCallback callback,
DoneCallback done_callback,
QuickInsertClient* client,
base::span<const QuickInsertCategory> available_categories,
bool caps_lock_state_to_search,
bool search_case_transforms)
: is_category_specific_search_(category.has_value()),
client_(CHECK_DEREF(client)),
gif_search_debouncer_(kGifDebouncingDelay),
current_callback_(std::move(callback)),
done_callback_(std::move(done_callback)) {
CHECK(!current_callback_.is_null());
CHECK(!done_callback_.is_null());
std::string utf8_query = base::UTF16ToUTF8(query);
std::vector<QuickInsertSearchSource> cros_search_sources;
cros_search_sources.reserve(3);
if ((!category.has_value() || category == QuickInsertCategory::kLinks) &&
base::Contains(available_categories, QuickInsertCategory::kLinks)) {
cros_search_sources.push_back(QuickInsertSearchSource::kOmnibox);
}
if ((!category.has_value() || category == QuickInsertCategory::kLocalFiles) &&
base::Contains(available_categories, QuickInsertCategory::kLocalFiles)) {
cros_search_sources.push_back(QuickInsertSearchSource::kLocalFile);
}
if ((!category.has_value() || category == QuickInsertCategory::kDriveFiles) &&
base::Contains(available_categories, QuickInsertCategory::kDriveFiles)) {
cros_search_sources.push_back(QuickInsertSearchSource::kDrive);
}
if (!cros_search_sources.empty()) {
// TODO: b/326166751 - Use `available_categories_` to decide what searches
// to do.
for (QuickInsertSearchSource source : cros_search_sources) {
MarkSearchStarted(source);
}
client_->StartCrosSearch(
std::u16string(query), category,
base::BindRepeating(&QuickInsertSearchRequest::HandleCrosSearchResults,
weak_ptr_factory_.GetWeakPtr()));
}
if ((!category.has_value() || category == QuickInsertCategory::kClipboard) &&
base::Contains(available_categories, QuickInsertCategory::kClipboard)) {
clipboard_provider_ =
std::make_unique<QuickInsertClipboardHistoryProvider>();
MarkSearchStarted(QuickInsertSearchSource::kClipboard);
clipboard_provider_->FetchResults(
base::BindOnce(&QuickInsertSearchRequest::HandleClipboardSearchResults,
weak_ptr_factory_.GetWeakPtr()),
query);
}
if ((!category.has_value() || category == QuickInsertCategory::kDatesTimes) &&
base::Contains(available_categories, QuickInsertCategory::kDatesTimes)) {
MarkSearchStarted(QuickInsertSearchSource::kDate);
// Date results is currently synchronous.
HandleDateSearchResults(QuickInsertDateSearch(base::Time::Now(), query));
}
if ((!category.has_value() || category == QuickInsertCategory::kUnitsMaths) &&
base::Contains(available_categories, QuickInsertCategory::kUnitsMaths)) {
MarkSearchStarted(QuickInsertSearchSource::kMath);
// Math results is currently synchronous.
HandleMathSearchResults(QuickInsertMathSearch(query));
}
if (category == QuickInsertCategory::kGifs) {
MarkSearchStarted(QuickInsertSearchSource::kGifs);
gif_search_debouncer_.RequestSearch(base::BindOnce(
&QuickInsertSearchRequest::StartGifSearch,
weak_ptr_factory_.GetWeakPtr(), base::UTF16ToUTF8(query)));
}
// These searches do not have category-specific search.
if (!category.has_value()) {
MarkSearchStarted(QuickInsertSearchSource::kAction);
// Action results are currently synchronous.
HandleActionSearchResults(
QuickInsertActionSearch(available_categories, caps_lock_state_to_search,
search_case_transforms, query));
if (base::Contains(available_categories,
QuickInsertCategory::kEditorWrite)) {
// Editor results are currently synchronous.
MarkSearchStarted(QuickInsertSearchSource::kEditorWrite);
HandleEditorSearchResults(
QuickInsertSearchSource::kEditorWrite,
QuickInsertEditorSearch(QuickInsertEditorResult::Mode::kWrite,
query));
}
if (base::Contains(available_categories,
QuickInsertCategory::kEditorRewrite)) {
// Editor results are currently synchronous.
MarkSearchStarted(QuickInsertSearchSource::kEditorRewrite);
HandleEditorSearchResults(
QuickInsertSearchSource::kEditorRewrite,
QuickInsertEditorSearch(QuickInsertEditorResult::Mode::kRewrite,
query));
}
if (base::Contains(available_categories,
QuickInsertCategory::kLobsterWithNoSelectedText)) {
// Lobster results are currently synchronous.
MarkSearchStarted(QuickInsertSearchSource::kLobsterWithNoSelectedText);
HandleLobsterSearchResults(
QuickInsertSearchSource::kLobsterWithNoSelectedText,
QuickInsertLobsterSearch(QuickInsertLobsterResult::Mode::kNoSelection,
query));
}
if (base::Contains(available_categories,
QuickInsertCategory::kLobsterWithSelectedText)) {
// Lobster results are currently synchronous.
MarkSearchStarted(QuickInsertSearchSource::kLobsterWithSelectedText);
HandleLobsterSearchResults(
QuickInsertSearchSource::kLobsterWithSelectedText,
QuickInsertLobsterSearch(
QuickInsertLobsterResult::Mode::kWithSelection, query));
}
}
can_call_done_closure_ = true;
MaybeCallDoneClosure();
}
QuickInsertSearchRequest::~QuickInsertSearchRequest() {
// Ensure that any bound callbacks to `Handle*SearchResults` - and therefore
// `current_callback_` - will not get called by stopping searches.
weak_ptr_factory_.InvalidateWeakPtrs();
if (!done_callback_.is_null()) {
std::move(done_callback_).Run(/*interrupted=*/true);
current_callback_.Reset();
}
client_->StopCrosQuery();
}
void QuickInsertSearchRequest::StartGifSearch(std::string_view query) {
gif_fetcher_ = GifTenorApiFetcher::FetchGifSearchCancellable(
client_->GetSharedURLLoaderFactory(), query, std::nullopt,
kMaxGifsToSearch,
base::BindOnce(ConvertGifResponse)
.Then(
base::BindOnce(&QuickInsertSearchRequest::HandleGifSearchResponse,
weak_ptr_factory_.GetWeakPtr())));
}
void QuickInsertSearchRequest::HandleSearchSourceResults(
QuickInsertSearchSource source,
std::vector<QuickInsertSearchResult> results,
bool has_more_results) {
MarkSearchEnded(source);
// This method is only called from `Handle*SearchResults` methods (one for
// each search source), and the only time `current_callback_` is null is when
// this request is being destructed, or `done_closure_` was called.
// The destructor invalidates any bound callbacks to `Handle*SearchResults`
// before resetting the callback to null. If `done_closure_` was called, and
// more calls would have occurred, this is a bug and we should noisly crash.
CHECK(!current_callback_.is_null())
<< "Current callback is null in HandleSearchSourceResults";
current_callback_.Run(source, std::move(results), has_more_results);
MaybeCallDoneClosure();
}
void QuickInsertSearchRequest::HandleActionSearchResults(
std::vector<QuickInsertSearchResult> results) {
HandleSearchSourceResults(QuickInsertSearchSource::kAction,
std::move(results),
/*has_more_results*/ false);
}
void QuickInsertSearchRequest::HandleCrosSearchResults(
AppListSearchResultType type,
std::vector<QuickInsertSearchResult> results) {
switch (type) {
case AppListSearchResultType::kOmnibox: {
results = DeduplicateGoogleCorpGotoDomains(std::move(results));
size_t results_to_remove = is_category_specific_search_
? 0
: std::max<size_t>(results.size(), 3) - 3;
results.erase(results.end() - results_to_remove, results.end());
HandleSearchSourceResults(QuickInsertSearchSource::kOmnibox,
std::move(results),
/*has_more_results=*/results_to_remove > 0);
break;
}
case AppListSearchResultType::kDriveSearch: {
size_t files_to_remove = is_category_specific_search_
? 0
: std::max<size_t>(results.size(), 3) - 3;
results.erase(results.end() - files_to_remove, results.end());
HandleSearchSourceResults(QuickInsertSearchSource::kDrive,
std::move(results),
/*has_more_results=*/files_to_remove > 0);
break;
}
case AppListSearchResultType::kFileSearch: {
size_t files_to_remove = is_category_specific_search_
? 0
: std::max<size_t>(results.size(), 3) - 3;
results.erase(results.end() - files_to_remove, results.end());
HandleSearchSourceResults(QuickInsertSearchSource::kLocalFile,
std::move(results),
/*has_more_results=*/files_to_remove > 0);
break;
}
default:
LOG(DFATAL) << "Got unexpected search result type "
<< static_cast<int>(type);
break;
}
}
void QuickInsertSearchRequest::HandleDateSearchResults(
std::vector<QuickInsertSearchResult> results) {
// Date results are never truncated.
HandleSearchSourceResults(QuickInsertSearchSource::kDate, std::move(results),
/*has_more_results=*/false);
}
void QuickInsertSearchRequest::HandleMathSearchResults(
std::optional<QuickInsertSearchResult> result) {
std::vector<QuickInsertSearchResult> results;
if (result.has_value()) {
results.push_back(*std::move(result));
}
// Math results are never truncated.
HandleSearchSourceResults(QuickInsertSearchSource::kMath, std::move(results),
/*has_more_results=*/false);
}
void QuickInsertSearchRequest::HandleClipboardSearchResults(
std::vector<QuickInsertSearchResult> results) {
// Clipboard results are never truncated.
HandleSearchSourceResults(QuickInsertSearchSource::kClipboard,
std::move(results),
/*has_more_results=*/false);
}
void QuickInsertSearchRequest::HandleEditorSearchResults(
QuickInsertSearchSource source,
std::optional<QuickInsertSearchResult> result) {
std::vector<QuickInsertSearchResult> results;
if (result.has_value()) {
results.push_back(std::move(*result));
}
// Editor results are never truncated.
HandleSearchSourceResults(source, std::move(results),
/*has_more_results=*/false);
}
void QuickInsertSearchRequest::HandleLobsterSearchResults(
QuickInsertSearchSource source,
std::optional<QuickInsertSearchResult> result) {
std::vector<QuickInsertSearchResult> results;
if (result.has_value()) {
results.push_back(std::move(*result));
}
// Lobster results are never truncated.
HandleSearchSourceResults(source, std::move(results),
/*has_more_results=*/false);
}
void QuickInsertSearchRequest::MarkSearchStarted(
QuickInsertSearchSource source) {
CHECK(!SwapSearchStart(source, base::TimeTicks::Now()).has_value())
<< "search_starts_ enum " << base::to_underlying(source)
<< " was already set";
}
void QuickInsertSearchRequest::MarkSearchEnded(QuickInsertSearchSource source) {
std::optional<base::TimeTicks> start = SwapSearchStart(source, std::nullopt);
CHECK(start.has_value()) << "search_starts_ enum "
<< base::to_underlying(source) << " was not set";
base::TimeDelta elapsed = base::TimeTicks::Now() - *start;
base::UmaHistogramTimes(SearchSourceToHistogram(source), elapsed);
}
std::optional<base::TimeTicks> QuickInsertSearchRequest::SwapSearchStart(
QuickInsertSearchSource source,
std::optional<base::TimeTicks> new_value) {
return std::exchange(search_starts_[base::to_underlying(source)],
std::move(new_value));
}
void QuickInsertSearchRequest::MaybeCallDoneClosure() {
if (!can_call_done_closure_) {
return;
}
if (std::ranges::any_of(search_starts_,
[](std::optional<base::TimeTicks>& start) {
return start.has_value();
})) {
return;
}
std::move(done_callback_).Run(/*interrupted=*/false);
current_callback_.Reset();
}
void QuickInsertSearchRequest::HandleGifSearchResponse(
std::vector<QuickInsertSearchResult> results) {
// GIF results are never truncated.
HandleSearchSourceResults(QuickInsertSearchSource::kGifs, std::move(results),
/*has_more_results=*/false);
}
} // namespace ash
|