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
|
// Copyright 2019 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef COMPONENTS_OPTIMIZATION_GUIDE_CORE_OPTIMIZATION_GUIDE_NAVIGATION_DATA_H_
#define COMPONENTS_OPTIMIZATION_GUIDE_CORE_OPTIMIZATION_GUIDE_NAVIGATION_DATA_H_
#include <stdint.h>
#include <memory>
#include <optional>
#include <utility>
#include "base/containers/flat_map.h"
#include "base/containers/flat_set.h"
#include "base/memory/weak_ptr.h"
#include "base/time/time.h"
#include "components/optimization_guide/core/optimization_guide_enums.h"
#include "components/optimization_guide/proto/hints.pb.h"
#include "components/optimization_guide/proto/models.pb.h"
#include "url/gurl.h"
// A representation of optimization guide information related to a navigation.
// Metrics will be recorded upon this object's destruction.
class OptimizationGuideNavigationData {
public:
OptimizationGuideNavigationData(int64_t navigation_id,
base::TimeTicks navigation_start);
~OptimizationGuideNavigationData();
OptimizationGuideNavigationData(
const OptimizationGuideNavigationData& other) = delete;
OptimizationGuideNavigationData& operator=(
const OptimizationGuideNavigationData&) = delete;
base::WeakPtr<OptimizationGuideNavigationData> GetWeakPtr() {
return weak_ptr_factory_.GetWeakPtr();
}
// The navigation ID of the navigation handle that this data is
// associated with.
int64_t navigation_id() const { return navigation_id_; }
// The time of navigation start.
base::TimeTicks navigation_start() const { return navigation_start_; }
// The navigation URL of the navigation handle that this data is
// associated with.
GURL navigation_url() const { return navigation_url_; }
void set_navigation_url(const GURL& navigation_url) {
navigation_url_ = navigation_url;
}
// The optimization types that were registered at the start of the navigation.
base::flat_set<optimization_guide::proto::OptimizationType>
registered_optimization_types() const {
return registered_optimization_types_;
}
void set_registered_optimization_types(
base::flat_set<optimization_guide::proto::OptimizationType>
registered_optimization_types) {
registered_optimization_types_ = registered_optimization_types;
}
// The optimization targets that were registered at the start of the
// navigation.
base::flat_set<optimization_guide::proto::OptimizationTarget>
registered_optimization_targets() const {
return registered_optimization_targets_;
}
void set_registered_optimization_targets(
base::flat_set<optimization_guide::proto::OptimizationTarget>
registered_optimization_targets) {
registered_optimization_targets_ = registered_optimization_targets;
}
// The duration between the fetch for a hint for the navigation going out to
// when it was received by the client if a fetch was initiated for the
// navigation.
std::optional<base::TimeDelta> hints_fetch_latency() const;
void set_hints_fetch_start(base::TimeTicks hints_fetch_start) {
hints_fetch_start_ = hints_fetch_start;
}
void set_hints_fetch_end(base::TimeTicks hints_fetch_end) {
hints_fetch_end_ = hints_fetch_end;
}
// The status for whether a hint for the page load was attempted to be fetched
// from the remote Optimization Guide Service.
std::optional<optimization_guide::RaceNavigationFetchAttemptStatus>
hints_fetch_attempt_status() const {
return hints_fetch_attempt_status_;
}
void set_hints_fetch_attempt_status(
optimization_guide::RaceNavigationFetchAttemptStatus
hints_fetch_attempt_status) {
hints_fetch_attempt_status_ = hints_fetch_attempt_status;
}
private:
// Records metrics based on data currently held in |this|.
void RecordMetrics() const;
// Records the OptimizationGuide UKM event based on data currently held in
// |this|.
void RecordOptimizationGuideUKM() const;
// The navigation ID of the navigation handle that this data is associated
// with.
const int64_t navigation_id_;
// The time of navigation start.
const base::TimeTicks navigation_start_;
// The navigation URL of the navigation handle this data is associated with.
// Updated on navigation start and navigation redirects.
GURL navigation_url_;
// The optimization types that were registered at the start of the navigation.
base::flat_set<optimization_guide::proto::OptimizationType>
registered_optimization_types_;
// The optimization targets that were registered at the start of the
// navigation.
base::flat_set<optimization_guide::proto::OptimizationTarget>
registered_optimization_targets_;
// The map from optimization type to the last decision made for that type.
base::flat_map<optimization_guide::proto::OptimizationType,
optimization_guide::OptimizationTypeDecision>
optimization_type_decisions_;
// The page hint for the navigation.
std::optional<std::unique_ptr<optimization_guide::proto::PageHint>>
page_hint_;
// The time that the hints fetch for this navigation started. Is only present
// if a fetch was initiated for this navigation.
std::optional<base::TimeTicks> hints_fetch_start_;
// The time that the hints fetch for the navigation ended. Is only present if
// a fetch was initiated and successfully completed for this navigation.
std::optional<base::TimeTicks> hints_fetch_end_;
// The status for whether a hint for the page load was attempted to be fetched
// from the remote Optimization Guide Service.
std::optional<optimization_guide::RaceNavigationFetchAttemptStatus>
hints_fetch_attempt_status_;
// Used to get |weak_ptr_| to self on the UI thread.
base::WeakPtrFactory<OptimizationGuideNavigationData> weak_ptr_factory_{this};
};
#endif // COMPONENTS_OPTIMIZATION_GUIDE_CORE_OPTIMIZATION_GUIDE_NAVIGATION_DATA_H_
|
