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
|
// 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 CONTENT_BROWSER_PRELOADING_PRELOAD_SERVING_METRICS_H_
#define CONTENT_BROWSER_PRELOADING_PRELOAD_SERVING_METRICS_H_
#include <memory>
#include <optional>
#include <vector>
#include "base/time/time.h"
#include "content/browser/preloading/prefetch/prefetch_streaming_url_loader_common_types.h"
#include "content/common/content_export.h"
#include "content/public/browser/preload_serving_metrics_capsule.h"
namespace content {
enum class PrefetchPotentialCandidateServingResult;
class NavigationHandle;
// All the structs in this file are "Logs" as defined in
// https://chromium.googlesource.com/chromium/src/+/main/content/browser/preloading/preload_serving_metrics.md#Logs
// Log of `PrefetchContainer`.
//
// `PreloadContainerMetrics` is a "Log" object as defined in
// https://chromium.googlesource.com/chromium/src/+/main/content/browser/preloading/preload_serving_metrics.md#Logs
//
// `PrefetchContainerMetrics` is owned by a `PrefetchContainer`, filled by the
// `PrefetchContainer`, and used for the per-`PrefetchContainer` metrics (e.g.
// `PrefetchContainer::RecordPrefetchDurationHistogram()`).
//
// `PrefetchContainerMetrics` is also used for `PreloadServingMetrics`. In this
// case, the `PrefetchContainerMetrics` at the time of serving is copied
// (indirectly) into `PreloadServingMetrics`.
struct CONTENT_EXPORT PrefetchContainerMetrics final {
PrefetchContainerMetrics();
~PrefetchContainerMetrics();
// Not movable but copyable.
PrefetchContainerMetrics(PrefetchContainerMetrics&& other) = delete;
PrefetchContainerMetrics& operator=(PrefetchContainerMetrics&& other) =
delete;
PrefetchContainerMetrics(const PrefetchContainerMetrics&) = default;
PrefetchContainerMetrics& operator=(const PrefetchContainerMetrics&) =
default;
// Timing information for metrics
//
// Constraint: That earlier one is null implies that later one is null.
// E.g. `time_prefetch_start` is null implies
// `time_header_determined_successfully` is null.
std::optional<base::TimeTicks> time_added_to_prefetch_service;
std::optional<base::TimeTicks> time_initial_eligibility_got;
std::optional<base::TimeTicks> time_prefetch_started;
std::optional<base::TimeTicks> time_url_request_started;
std::optional<base::TimeTicks> time_header_determined_successfully;
std::optional<base::TimeTicks> time_prefetch_completed_successfully;
};
// Log of prefetch matching.
//
// `PreloadMatchMetrics` is a "Log" object as defined in
// https://chromium.googlesource.com/chromium/src/+/main/content/browser/preloading/preload_serving_metrics.md#Logs
//
// The members are filled by `PrefetchMatchResolver`.
struct CONTENT_EXPORT PrefetchMatchMetrics final {
PrefetchMatchMetrics();
~PrefetchMatchMetrics();
// Not movable nor copyable.
PrefetchMatchMetrics(PrefetchMatchMetrics&& other) = delete;
PrefetchMatchMetrics& operator=(PrefetchMatchMetrics&& other) = delete;
PrefetchMatchMetrics(const PrefetchMatchMetrics&) = delete;
PrefetchMatchMetrics& operator=(const PrefetchMatchMetrics&) = delete;
bool IsPotentialMatch() const;
bool IsActualMatch() const;
PrefetchServiceWorkerState expected_service_worker_state;
base::TimeTicks time_match_start;
base::TimeTicks time_match_end;
// Number of initial candidates of prefetch matching, including already failed
// ones.
int n_initial_candidates = -1;
// Number of initial candidates of prefetch matching, blocking ones.
int n_initial_candidates_block_until_head = -1;
// The `PrefetchContainerMetrics` of the `PrefetchContainer` candidate that
// was successfully matched with the `PrefetchMatchResolver`, if any.
// Otherwise null.
std::unique_ptr<PrefetchContainerMetrics> prefetch_container_metrics =
nullptr;
// The information of the prefetch-ahead-prerender `PrefetchContainer`
// candidate, if any. Otherwise null. More precisely, this is non-null iff:
//
// - `PrefetchMatchResolver::navigation_request_for_metrics_` is for a
// prerender initial navigation; and
// - The `PrefetchContainer` of the prefetch-ahead-of-prerender of the
// prerendering
// (if any) is potentially matching with the `PrefetchMatchResolver`.
std::optional<PrefetchPotentialCandidateServingResult>
prefetch_potential_candidate_serving_result_ahead_of_prerender =
std::nullopt;
// The condition is the same to the above.
std::unique_ptr<PrefetchContainerMetrics>
prefetch_container_metrics_ahead_of_prerender = nullptr;
};
// Log of preloads related to a navigation
//
// `PreloadServingMetrics` is a "Log" object as defined in
// https://chromium.googlesource.com/chromium/src/+/main/content/browser/preloading/preload_serving_metrics.md#Logs
//
// The members are filled by `PreloadServingMetrics`.
struct CONTENT_EXPORT PreloadServingMetrics final {
PreloadServingMetrics();
~PreloadServingMetrics();
// Not movable nor copyable.
PreloadServingMetrics(PreloadServingMetrics&& other) = delete;
PreloadServingMetrics& operator=(PreloadServingMetrics&& other) = delete;
PreloadServingMetrics(const PreloadServingMetrics&) = delete;
PreloadServingMetrics& operator=(const PreloadServingMetrics&) = delete;
// Gets "meaningful" `PrefetchMatchMetrics`
//
// For initial fetch of navigation (i.e. before redirect),
// `PrefetchURLLoaderInterceptor` tries to intercept twice, with
// `PrefetchServiceWorkerState::kControlled` and
// `PrefetchServiceWorkerState::kDisallowed`. This method returns meaningful
// one.
//
// Returns nullptr if there is no `PrefetchMatchMetrics`.
const PrefetchMatchMetrics* GetMeaningfulPrefetchMatchMetrics() const;
void RecordMetricsForNonPrerenderNavigationCommitted() const;
void RecordMetricsForPrerenderInitialNavigationFailed() const;
void RecordFirstContentfulPaint(
base::TimeDelta corrected_first_contentful_paint) const;
// Added per prefetch matching.
std::vector<std::unique_ptr<PrefetchMatchMetrics>>
prefetch_match_metrics_list;
// If `this` is for a prerender activation navigation, it's
// `PreloadServingMetrics` of the corresponding prerender initial navigation.
// Otherwise null.
//
// If there are multiple navigations in the frame tree for prerender, this is
// the first navigation and the `PreloadServingMetrics`s for the other
// navigations are discarded.
std::unique_ptr<PreloadServingMetrics>
prerender_initial_preload_serving_metrics = nullptr;
};
// Allows `PageLoadMetricsObserver` to get/hold/record `PreloadServingMetrics`.
class CONTENT_EXPORT PreloadServingMetricsCapsuleImpl final
: public PreloadServingMetricsCapsule {
public:
// Take `PreloadServingMetrics` from `PreloadServingMetricsHolder` of
// `NavigationHandle`.
//
// See
// https://chromium.googlesource.com/chromium/src/+/main/content/browser/preloading/preload_serving_metrics.md#life-of-PreloadServingMetrics
static std::unique_ptr<PreloadServingMetricsCapsule> TakeFromNavigationHandle(
NavigationHandle& navigation_handle);
void RecordMetricsForNonPrerenderNavigationCommitted() const override;
void RecordFirstContentfulPaint(
base::TimeDelta corrected_first_contentful_paint) const override;
private:
explicit PreloadServingMetricsCapsuleImpl(
std::unique_ptr<PreloadServingMetrics> preload_serving_metrics);
~PreloadServingMetricsCapsuleImpl() override;
friend struct std::default_delete<PreloadServingMetricsCapsuleImpl>;
std::unique_ptr<PreloadServingMetrics> preload_serving_metrics_ = nullptr;
};
} // namespace content
#endif // CONTENT_BROWSER_PRELOADING_PRELOAD_SERVING_METRICS_H_
|
