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
|
// 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.
#ifndef CHROME_BROWSER_PRELOADING_SEARCH_PRELOAD_SEARCH_PRELOAD_SERVICE_H_
#define CHROME_BROWSER_PRELOADING_SEARCH_PRELOAD_SEARCH_PRELOAD_SERVICE_H_
#include "base/memory/raw_ptr.h"
#include "base/memory/weak_ptr.h"
#include "base/scoped_observation.h"
#include "chrome/browser/preloading/search_preload/search_preload_pipeline_manager.h"
#include "components/keyed_service/core/keyed_service.h"
#include "components/search_engines/template_url_service_observer.h"
class AutocompleteResult;
class Profile;
class TemplateURLService;
struct AutocompleteMatch;
namespace content {
class WebContents;
}
namespace omnibox::mojom {
enum class NavigationPredictor;
}
// Roles:
//
// - Observes changes of `TemplateURLService` and notifies it to
// `SearchPreloadPipelineManager`s.
// - Routes Omnibox events to `SearchPreloadPipelineManager`s.
//
// Note that
//
// - Prerender is managed per `WebContents` and we must trigger prerender for
// appropriate `WebContents`; and
// - Prefetch is managed per `BrowserContext` and it's (theoretically) available
// even we trigger prefetches over different `WebContents`s.
// - Note that current behavior of `PrefetchHandle` is
// `PrefetchHandle::dtor()` immediately destroys `PrefetchContainer` and
// it's actually not available.
//
// So, we manage pipelines in `SearchPreloadPipelineManager` per `WebContents`.
// It's for the necessity of prerender and the simplicity of prefetch.
class SearchPreloadService : public KeyedService,
public TemplateURLServiceObserver {
public:
static SearchPreloadService* GetForProfile(Profile* profile);
explicit SearchPreloadService(Profile* profile);
~SearchPreloadService() override;
// Not movable nor copyable.
SearchPreloadService(const SearchPreloadService&&) = delete;
SearchPreloadService& operator=(const SearchPreloadService&&) = delete;
SearchPreloadService(const SearchPreloadService&) = delete;
SearchPreloadService& operator=(const SearchPreloadService&) = delete;
base::WeakPtr<SearchPreloadService> GetWeakPtr() {
return weak_factory_.GetWeakPtr();
}
// KeyedService:
void Shutdown() override;
// TemplateURLServiceObserver:
//
// Monitors changes to DSE. If a change occurs, clears preloads.
void OnTemplateURLServiceChanged() override;
// Clears all preloads from the service.
void ClearPreloads();
void OnPrefetchHeadReceived(const network::mojom::URLResponseHead& head);
void OnOnSuggestPrefetchCompletedOrFailed(
const network::URLLoaderCompletionStatus& completion_status,
const std::optional<int>& response_code);
// Called when autocomplete is updated.
void OnAutocompleteResultChanged(content::WebContents* web_contents,
const AutocompleteResult& result);
// Called when a user is likely navigate to the match.
bool OnNavigationLikely(
size_t index,
const AutocompleteMatch& match,
omnibox::mojom::NavigationPredictor navigation_predictor,
content::WebContents* web_contents);
const std::optional<net::HttpNoVarySearchData>&
GetNoVarySearchDataCacheForTesting() const;
void SetNoVarySearchDataCacheForTesting(
std::optional<net::HttpNoVarySearchData> no_vary_search_data);
// Invalidates a pipeline with `canonical_url`.
//
// Returns true iff invalidated successfully.
bool InvalidatePipelineForTesting(content::WebContents& web_contents,
GURL canonical_url);
private:
// Reference is valid only as rvalue.
SearchPreloadPipelineManager& GetOrCreatePipelineManagerWithLimit(
content::WebContents& web_contents);
base::ScopedObservation<TemplateURLService, TemplateURLServiceObserver>
observer_{this};
const raw_ptr<Profile> profile_;
std::optional<base::WeakPtr<SearchPreloadPipelineManager>> pipeline_manager_;
// Cache of No-Vary-Search header for the No-Vary-Search hint of the next
// prefetch.
std::optional<net::HttpNoVarySearchData> no_vary_search_data_cache_;
// If prefetch on-suggest failed, pause triggering preloads until this time.
base::TimeTicks pause_triggering_until_;
base::WeakPtrFactory<SearchPreloadService> weak_factory_{this};
};
// These values are persisted to logs. Entries should not be renumbered and
// numeric values should never be reused.
//
// LINT.IfChange(SearchPreloadServiceNoVarySearchDataCacheUpdate)
enum class SearchPreloadServiceNoVarySearchDataCacheUpdate : uint8_t {
kUnchanged = 0,
kNullToSome = 1,
kSomeToNull = 2,
kSomeToSome = 3,
kMaxValue = kSomeToSome,
};
// LINT.ThenChange(/tools/metrics/histograms/metadata/omnibox/enums.xml:SearchPreloadServiceNoVarySearchDataCacheUpdate)
#endif // CHROME_BROWSER_PRELOADING_SEARCH_PRELOAD_SEARCH_PRELOAD_SERVICE_H_
|
