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
|
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef ASH_QUICK_INSERT_METRICS_QUICK_INSERT_PERFORMANCE_METRICS_H_
#define ASH_QUICK_INSERT_METRICS_QUICK_INSERT_PERFORMANCE_METRICS_H_
#include <optional>
#include "ash/ash_export.h"
#include "base/time/time.h"
namespace ui {
class PresentationTimeRecorder;
}
namespace views {
class Widget;
}
namespace ash {
// Records performance metrics for a session of using Quick Insert, such as
// latency.
class ASH_EXPORT QuickInsertPerformanceMetrics {
public:
enum class SearchResultsUpdate {
// Stale search results were cleared to an empty list of results.
kClear,
// Stale search results were replaced with a new non-empty list of results.
kReplace,
// The "no results found" message was shown.
kNoResultsFound,
// New results were appended to the (possibly empty) list of results.
kAppend,
};
// `trigger_event_timestamp` is the timestamp of the event that triggered the
// session. By default, this uses the time QuickInsertPerformanceMetrics is
// created. Call `StartRecording` to start recording metrics for the session.
QuickInsertPerformanceMetrics(
base::TimeTicks trigger_start_timestamp = base::TimeTicks::Now());
~QuickInsertPerformanceMetrics();
// Starts recording metrics for this session.
// `widget` is the widget that contains the Quick Insert UI. It must outlive
// this class.
void StartRecording(views::Widget& widget);
// Stops recording metrics for this session.
// This should be called, for example, when the widget containing the Quick
// Insert UI is destroyed.
void StopRecording();
// Marks a focus event on the Quick Insert search field.
void MarkInputFocus();
// Marks that the search field contents changed.
void MarkContentsChanged();
// Marks that the search results were updated.
void MarkSearchResultsUpdated(SearchResultsUpdate update);
private:
bool is_recording_ = false;
// The timestamp of earliest the feature was triggered.
base::TimeTicks trigger_start_timestamp_;
// Whether the first input focus has been marked yet.
bool marked_first_focus_ = false;
// The timestamp of when the current search started.
std::optional<base::TimeTicks> search_start_timestamp_;
// Records the presentation delay when search field contents change.
std::unique_ptr<ui::PresentationTimeRecorder>
search_field_presentation_time_recorder_;
// Records the presentation delay of updating the results page.
std::unique_ptr<ui::PresentationTimeRecorder>
results_presentation_time_recorder_;
};
} // namespace ash
#endif // ASH_QUICK_INSERT_METRICS_QUICK_INSERT_PERFORMANCE_METRICS_H_
|
