File: search_preload_pipeline_manager.cc

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (368 lines) | stat: -rw-r--r-- 14,482 bytes parent folder | download | duplicates (3)
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
// Copyright 2025 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "chrome/browser/preloading/search_preload/search_preload_pipeline_manager.h"

#include "base/metrics/histogram_functions.h"
#include "chrome/browser/preloading/chrome_preloading.h"
#include "chrome/browser/preloading/prefetch/search_prefetch/search_prefetch_service.h"
#include "chrome/browser/preloading/search_preload/search_preload_features.h"
#include "chrome/browser/preloading/search_preload/search_preload_pipeline.h"
#include "chrome/browser/preloading/search_preload/search_preload_service_factory.h"
#include "chrome/browser/preloading/search_preload/search_preload_signal_result.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/browser/search_engines/template_url_service_factory.h"
#include "components/omnibox/browser/autocomplete_match.h"
#include "components/omnibox/browser/autocomplete_result.h"
#include "components/omnibox/browser/base_search_provider.h"
#include "components/omnibox/browser/omnibox.mojom-shared.h"
#include "components/search_engines/template_url_service.h"
#include "content/public/browser/navigation_handle.h"
#include "content/public/browser/preloading_data.h"
#include "content/public/browser/web_contents.h"

namespace {

// Ergonomic wrapper of `HasCanonicalPreloadingOmniboxSearchURL()`
std::optional<GURL> GetCanonicalUrlForSearchPreload(
    content::BrowserContext& browser_context,
    const GURL& preload_url) {
  GURL canonical_url;
  if (HasCanonicalPreloadingOmniboxSearchURL(preload_url, &browser_context,
                                             &canonical_url)) {
    return canonical_url;
  }

  return std::nullopt;
}

// Ergonomic wrapper of `ExtractSearchTermsFromURL()`
std::optional<std::u16string> ExtractSearchTermsFromUrl(
    TemplateURLService& template_url_service,
    const AutocompleteMatch& match) {
  std::u16string search_terms;
  if (template_url_service.GetDefaultSearchProvider()
          ->ExtractSearchTermsFromURL(match.destination_url,
                                      template_url_service.search_terms_data(),
                                      &search_terms)) {
    return search_terms;
  }
  return std::nullopt;
}

}  // namespace

WEB_CONTENTS_USER_DATA_KEY_IMPL(SearchPreloadPipelineManager);

SearchPreloadPipelineManager::SearchPreloadPipelineManager(
    content::WebContents* web_contents)
    : content::WebContentsUserData<SearchPreloadPipelineManager>(*web_contents),
      content::WebContentsObserver(web_contents) {
  auto* preloading_data =
      content::PreloadingData::GetOrCreateForWebContents(web_contents);
  SetIsNavigationInDomainCallback(preloading_data);
}

SearchPreloadPipelineManager::~SearchPreloadPipelineManager() = default;

void SearchPreloadPipelineManager::DidFinishNavigation(
    content::NavigationHandle* navigation_handle) {
  const bool is_primary_main_frame_navigation =
      navigation_handle->HasCommitted() &&
      navigation_handle->IsInPrimaryMainFrame() &&
      !navigation_handle->IsSameDocument();
  if (!is_primary_main_frame_navigation) {
    return;
  }

  content::BrowserContext* browser_context =
      GetWebContents().GetBrowserContext();
  if (!browser_context) {
    return;
  }

  // Invalidate a pipeline if it is likely used.
  std::optional<GURL> maybe_canonical_url = GetCanonicalUrlForSearchPreload(
      *browser_context, navigation_handle->GetURL());
  if (!maybe_canonical_url.has_value()) {
    return;
  }
  const GURL& canonical_url = maybe_canonical_url.value();

  pipelines_.erase(canonical_url);
}

void SearchPreloadPipelineManager::ClearPreloads() {
  pipelines_.clear();
}

void SearchPreloadPipelineManager::EraseNotAlivePipelines() {
  base::EraseIf(
      pipelines_,
      [](const std::pair<GURL, std::unique_ptr<SearchPreloadPipeline>>& pair) {
        auto& pipeline = pair.second;
        const bool is_alive =
            pipeline->IsPrefetchAlive() || pipeline->IsPrerenderValid();
        return !is_alive;
      });
}

void SearchPreloadPipelineManager::OnAutocompleteResultChanged(
    Profile& profile,
    base::WeakPtr<SearchPreloadService> search_preload_service,
    const AutocompleteResult& result,
    const std::optional<net::HttpNoVarySearchData>& no_vary_search_hint) {
  auto* template_url_service =
      TemplateURLServiceFactory::GetForProfile(&profile);
  CHECK(template_url_service);
  if (!template_url_service->GetDefaultSearchProvider()) {
    return;
  }

  auto record_histograms =
      [](std::tuple<std::optional<SearchPreloadSignalResult>,
                    std::optional<SearchPreloadSignalResult>> signal_results) {
        auto [signal_result_prefetch, signal_result_prerender] = signal_results;
        if (signal_result_prefetch.has_value()) {
          base::UmaHistogramEnumeration(
              "Omnibox.DsePreload.SignalResult.OnSuggest.Prefetch",
              signal_result_prefetch.value());
        }
        if (signal_result_prerender.has_value()) {
          base::UmaHistogramEnumeration(
              "Omnibox.DsePreload.SignalResult.OnSuggest.Prerender",
              signal_result_prerender.value());
        }
      };

  if (base::FeatureList::IsEnabled(
          features::kDsePreload2OnSuggestNonDefalutMatch)) {
    for (const auto& match : result) {
      auto signal_results = OnAutocompleteResultChangedProcessOne(
          profile, search_preload_service, *template_url_service, match,
          no_vary_search_hint);
      record_histograms(std::move(signal_results));
    }
  } else {
    if (!result.default_match()) {
      return;
    }
    const auto& match = *result.default_match();

    auto signal_results = OnAutocompleteResultChangedProcessOne(
        profile, search_preload_service, *template_url_service, match,
        no_vary_search_hint);
    record_histograms(std::move(signal_results));
  }
}

std::tuple<std::optional<SearchPreloadSignalResult>,
           std::optional<SearchPreloadSignalResult>>
SearchPreloadPipelineManager::OnAutocompleteResultChangedProcessOne(
    Profile& profile,
    base::WeakPtr<SearchPreloadService> search_preload_service,
    TemplateURLService& template_url_service,
    const AutocompleteMatch& match,
    const std::optional<net::HttpNoVarySearchData>& no_vary_search_hint) {
  const bool should_prefetch = BaseSearchProvider::ShouldPrefetch(match) ||
                               BaseSearchProvider::ShouldPrerender(match);
  const bool should_prerender = BaseSearchProvider::ShouldPrerender(match);

  // In the case of Default Search Engine Prediction, the confidence depends
  // on the type of preload. For prerender requests, the confidence is
  // comparatively higher than the prefetch to avoid the impact of wrong
  // predictions. We set confidence as 80 for prerender matches and 60 for
  // prefetch as an approximate number to differentiate both these cases.
  //
  // The value is used only for precog. So, these values have no concreate
  // meanings.
  int confidence;
  if (should_prerender) {
    confidence = 80;
  } else if (should_prefetch) {
    confidence = 60;
  } else {
    return {std::nullopt, std::nullopt};
  }

  // Erase to count prefetches.
  EraseNotAlivePipelines();
  // Limit the number of prefetches.
  if (pipelines_.size() >= features::kDsePreload2MaxPrefetch.Get()) {
    return {SearchPreloadSignalResult::kNotTriggeredLimitExceeded,
            std::nullopt};
  }

  std::optional<GURL> maybe_canonical_url =
      GetCanonicalUrlForSearchPreload(profile, match.destination_url);
  if (!maybe_canonical_url.has_value()) {
    return {SearchPreloadSignalResult::kNotTriggeredMisc,
            should_prerender ? std::make_optional(
                                   SearchPreloadSignalResult::kNotTriggeredMisc)
                             : std::nullopt};
  }
  const GURL& canonical_url = maybe_canonical_url.value();

  if (!pipelines_.contains(canonical_url)) {
    pipelines_.insert_or_assign(
        canonical_url, std::make_unique<SearchPreloadPipeline>(canonical_url));
  }
  pipelines_[canonical_url]->UpdateConfidence(GetWebContents(), confidence);

  CHECK(should_prefetch);

  const GURL prefetch_url =
      GetPrefetchUrlFromMatch(*match.search_terms_args, template_url_service,
                              /*is_navigation_likely=*/false);
  const SearchPreloadSignalResult signal_result_prefetch =
      pipelines_[canonical_url]->StartPrefetch(
          GetWebContents(), search_preload_service, prefetch_url,
          chrome_preloading_predictor::kDefaultSearchEngine,
          no_vary_search_hint,
          /*is_navigation_likely=*/false);

  // Trigger prerender without waiting prefetch.
  //
  // They are coordinated by `PrefetchMatchResolver`. For more details, see
  // https://docs.google.com/document/d/1IAIVrDBE-FnO14Qnghr8hsrxUeoFfeob5QIsV_UNRck/edit?tab=t.0#heading=h.vpxgrp4zne09
  std::optional<SearchPreloadSignalResult> signal_result_prerender =
      std::nullopt;
  if (should_prerender) {
    // Unlike prefetch, we cancel the existing prerender and start new one if
    // we have a signal for prerender. This behavior comes from DSE preload 1
    // (`SearchPrefetchService`).
    //
    // TODO(https://crrev.com/421387697): Consider to use different policy.
    for (const auto& [key, value] : pipelines_) {
      if (key != canonical_url) {
        value->CancelPrerender();
      }
    }

    const GURL prerender_url = GetPrerenderUrlFromMatch(
        *match.search_terms_args, template_url_service);
    signal_result_prerender = pipelines_[canonical_url]->StartPrerender(
        GetWebContents(), prerender_url,
        chrome_preloading_predictor::kDefaultSearchEngine);
  }

  return {signal_result_prefetch, signal_result_prerender};
}

bool SearchPreloadPipelineManager::OnNavigationLikely(
    Profile& profile,
    base::WeakPtr<SearchPreloadService> search_preload_service,
    const AutocompleteMatch& match,
    omnibox::mojom::NavigationPredictor navigation_predictor,
    const std::optional<net::HttpNoVarySearchData>& no_vary_search_hint) {
  const auto signal_result_prefetch =
      [&]() -> std::optional<SearchPreloadSignalResult> {
    if (!features::IsDsePreload2OnPressEnabled()) {
      return std::nullopt;
    }

    if (!features::DsePreload2OnPressIsPredictorEnabled(navigation_predictor)) {
      return std::nullopt;
    }

    if (profile.IsOffTheRecord() &&
        !features::IsDsePreload2OnPressIncognitoEnabled()) {
      return SearchPreloadSignalResult::kNotTriggeredIncognito;
    }

    if (!AutocompleteMatch::IsSearchType(match.type)) {
      return SearchPreloadSignalResult::kNotTriggeredOnPressNotSearchType;
    }

    auto* template_url_service =
        TemplateURLServiceFactory::GetForProfile(&profile);
    CHECK(template_url_service);
    bool does_search_provider_opt_in =
        template_url_service->GetDefaultSearchProvider() &&
        template_url_service->GetDefaultSearchProvider()
            ->data()
            .prefetch_likely_navigations;
    if (!does_search_provider_opt_in) {
      return SearchPreloadSignalResult::
          kNotTriggeredOnPressNoSearchProviderOptIn;
    }

    // Erase to count prefetches.
    EraseNotAlivePipelines();
    // Limit the number of prefetches.
    if (pipelines_.size() >= features::kDsePreload2MaxPrefetch.Get()) {
      return SearchPreloadSignalResult::kNotTriggeredLimitExceeded;
    }

    const std::optional<GURL> maybe_canonical_url =
        GetCanonicalUrlForSearchPreload(profile, match.destination_url);
    if (!maybe_canonical_url.has_value()) {
      return SearchPreloadSignalResult::kNotTriggeredMisc;
    }
    const GURL& canonical_url = maybe_canonical_url.value();

    const std::optional<std::u16string> maybe_search_terms =
        ExtractSearchTermsFromUrl(*template_url_service, match);
    if (!maybe_search_terms.has_value()) {
      return SearchPreloadSignalResult::kNotTriggeredMisc;
    }
    const std::u16string& search_terms = maybe_search_terms.value();

    GURL prefetch_url;
    if (match.search_terms_args) {
      auto& search_terms_args = *match.search_terms_args.get();
      prefetch_url =
          GetPrefetchUrlFromMatch(search_terms_args, *template_url_service,
                                  /*is_navigation_likely=*/true);
    } else {
      // Search history suggestions (those that are not also server suggestions)
      // don't have search term args. Generate search term args instead.

      auto search_terms_args_for_history_suggestion =
          std::make_unique<TemplateURLRef::SearchTermsArgs>(search_terms);
      auto& search_terms_args = *search_terms_args_for_history_suggestion.get();
      prefetch_url =
          GetPrefetchUrlFromMatch(search_terms_args, *template_url_service,
                                  /*is_navigation_likely=*/true);
    }

    auto predictor =
        [](omnibox::mojom::NavigationPredictor navigation_predictor) {
          switch (navigation_predictor) {
            case omnibox::mojom::NavigationPredictor::kMouseDown:
              return chrome_preloading_predictor::kOmniboxMousePredictor;
            case omnibox::mojom::NavigationPredictor::kUpOrDownArrowButton:
              return chrome_preloading_predictor::kOmniboxSearchPredictor;
            case omnibox::mojom::NavigationPredictor::kTouchDown:
              return chrome_preloading_predictor::kOmniboxTouchDownPredictor;
          }
        }(navigation_predictor);

    // TODO(crbug.com/403198750): Limit the number of active pipelines.
    if (!pipelines_.contains(canonical_url)) {
      pipelines_.insert_or_assign(
          canonical_url,
          std::make_unique<SearchPreloadPipeline>(canonical_url));
    }
    pipelines_[canonical_url]->UpdateConfidence(GetWebContents(), 100);
    return pipelines_[canonical_url]->StartPrefetch(
        GetWebContents(), search_preload_service, prefetch_url, predictor,
        no_vary_search_hint,
        /*is_navigation_likely=*/true);
  }();

  if (signal_result_prefetch.has_value()) {
    base::UmaHistogramEnumeration(
        "Omnibox.DsePreload.SignalResult.OnPress.Prefetch",
        signal_result_prefetch.value());
  }

  return signal_result_prefetch ==
         SearchPreloadSignalResult::kPrefetchTriggered;
}

bool SearchPreloadPipelineManager::InvalidatePipelineForTesting(
    GURL canonical_url) {
  return static_cast<bool>(pipelines_.erase(canonical_url));
}