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
|
// Copyright 2018 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "third_party/blink/renderer/core/timing/event_timing.h"
#include <optional>
#include "base/time/tick_clock.h"
#include "third_party/blink/renderer/core/dom/events/event.h"
#include "third_party/blink/renderer/core/events/keyboard_event.h"
#include "third_party/blink/renderer/core/events/pointer_event.h"
#include "third_party/blink/renderer/core/events/touch_event.h"
#include "third_party/blink/renderer/core/events/wheel_event.h"
#include "third_party/blink/renderer/core/frame/local_dom_window.h"
#include "third_party/blink/renderer/core/loader/interactive_detector.h"
#include "third_party/blink/renderer/core/timing/dom_window_performance.h"
#include "third_party/blink/renderer/core/timing/performance_event_timing.h"
#include "third_party/blink/renderer/platform/runtime_enabled_features.h"
namespace blink {
namespace {
const base::TickClock* g_clock_for_testing = nullptr;
static base::TimeTicks Now() {
return g_clock_for_testing ? g_clock_for_testing->NowTicks()
: base::TimeTicks::Now();
}
bool ShouldLogEvent(const Event& event) {
return event.type() == event_type_names::kPointerdown ||
event.type() == event_type_names::kPointerup ||
event.type() == event_type_names::kClick ||
event.type() == event_type_names::kKeydown ||
event.type() == event_type_names::kMousedown ||
event.type() == event_type_names::kMouseup;
}
bool ShouldReportForEventTiming(WindowPerformance* performance) {
if (!performance->FirstInputDetected())
return true;
return (!performance->IsEventTimingBufferFull() ||
performance->HasObserverFor(PerformanceEntry::kEvent));
}
} // namespace
EventTiming::EventTiming(base::TimeTicks processing_start,
WindowPerformance* performance,
const Event& event,
EventTarget* hit_test_target)
: performance_(performance), event_(&event) {
performance_->EventTimingProcessingStart(event, processing_start,
hit_test_target);
}
// static
void EventTiming::HandleInputDelay(LocalDOMWindow* window,
const Event& event,
base::TimeTicks processing_start) {
auto* pointer_event = DynamicTo<PointerEvent>(&event);
base::TimeTicks event_timestamp =
pointer_event ? pointer_event->OldestPlatformTimeStamp()
: event.PlatformTimeStamp();
if (ShouldLogEvent(event) && event.isTrusted()) {
InteractiveDetector* interactive_detector =
InteractiveDetector::From(*window->document());
if (interactive_detector) {
interactive_detector->HandleForInputDelay(event, event_timestamp,
processing_start);
}
}
}
// static
bool EventTiming::IsEventTypeForEventTiming(const Event& event) {
// Include only trusted events of certain kinds. Explicitly excluding input
// events that are considered continuous: event types for which the user agent
// may have timer-based dispatch under certain conditions. These are excluded
// since EventCounts cannot be used to properly computed percentiles on those.
// See spec: https://wicg.github.io/event-timing/#sec-events-exposed.
// Needs to be kept in sync with WebInputEvent::IsWebInteractionEvent(),
// except non-raw web input event types, for example kCompositionend.
return (event.isTrusted() ||
event.type() == event_type_names::kCompositionend) &&
(IsA<MouseEvent>(event) || IsA<PointerEvent>(event) ||
IsA<TouchEvent>(event) || IsA<KeyboardEvent>(event) ||
IsA<WheelEvent>(event) || event.IsInputEvent() ||
event.IsCompositionEvent() || event.IsDragEvent()) &&
event.type() != event_type_names::kMousemove &&
event.type() != event_type_names::kPointermove &&
event.type() != event_type_names::kPointerrawupdate &&
event.type() != event_type_names::kTouchmove &&
event.type() != event_type_names::kWheel &&
event.type() != event_type_names::kDrag;
}
// static
std::optional<EventTiming> EventTiming::TryCreate(
LocalDOMWindow* window,
const Event& event,
EventTarget* hit_test_target) {
auto* performance = DOMWindowPerformance::performance(*window);
if (!performance || !IsEventTypeForEventTiming(event)) {
return std::nullopt;
}
// Most events track their performance in EventDispatcher::Dispatch but
// some event types which can be filtered are tracked at the point
// where they may be filtered. This condition check ensures we don't create
// two EventTiming objects for the same Event.
if (performance->GetCurrentEventTimingEvent() == &event)
return std::nullopt;
if (!RuntimeEnabledFeatures::
ContinueEventTimingRecordingWhenBufferIsFullEnabled()) {
bool should_report_for_event_timing =
ShouldReportForEventTiming(performance);
bool should_log_event = ShouldLogEvent(event);
if (!should_report_for_event_timing && !should_log_event) {
return std::nullopt;
}
base::TimeTicks processing_start = Now();
HandleInputDelay(window, event, processing_start);
if (!should_report_for_event_timing && !should_log_event) {
return std::nullopt;
}
return EventTiming(processing_start, performance, event, hit_test_target);
}
base::TimeTicks processing_start = Now();
// TODO(mmocny): Move this out of ::TryCreate and into the Constructor,
// or even further in window_performance / responsiveness_metrics
HandleInputDelay(window, event, processing_start);
return EventTiming(processing_start, performance, event, hit_test_target);
}
// static
void EventTiming::SetTickClockForTesting(const base::TickClock* clock) {
g_clock_for_testing = clock;
}
EventTiming::~EventTiming() {
// event_ might potentially be null if this is std::move()-ed.
if (event_) {
performance_->EventTimingProcessingEnd(*event_, Now());
}
}
} // namespace blink
|