Files
react-native/ReactCommon/react/renderer/core/RawEvent.h
T
Ruslan Shestopalyuk 09ad0cc0c6 Implement reporting of events from native side to WebPerformance API (#35768)
Summary:
Pull Request resolved: https://github.com/facebook/react-native/pull/35768

Changelog: [Internal]

This implements native side mechanics for reporting user events timing to JS  (PerformanceObserver API).

See the standard for more details: https://www.w3.org/TR/event-timing/

The events are only logged when there are any active subscriptions (via `PerformanceObserver.observe`), also we only log "discrete events" (i.e. no likes of mouse move), so the overhead is non-existing.

There are two main metrics of interest for an event lifecycle:
* Time the event is spent in the queue, i.e. the time between it's created and dispatched
* Time that is spend in the event handler on the JS side (event dispatch), or processing time

Both of these are measured, and the corresponding fields are populated.

Reviewed By: sammy-SC

Differential Revision: D42294947

fbshipit-source-id: 4fd7938c04b942400befa4057d4929fb2763cee1
2023-01-03 11:11:37 -08:00

77 lines
1.8 KiB
C++

/*
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/
#pragma once
#include <memory>
#include <string>
#include <react/renderer/core/EventLogger.h>
#include <react/renderer/core/EventTarget.h>
#include <react/renderer/core/ValueFactory.h>
namespace facebook {
namespace react {
/*
* Represents ready-to-dispatch event object.
*/
struct RawEvent {
/*
* Defines category of a native platform event. This is used to deduce types
* of events for Concurrent Mode.
* This enum is duplicated for JNI access in `EventCategoryDef.java`, keep in
* sync.
*/
enum class Category {
/*
* Start of a continuous event. To be used with touchStart.
*/
ContinuousStart = 0,
/*
* End of a continuous event. To be used with touchEnd.
*/
ContinuousEnd = 1,
/*
* Priority for this event will be determined from other events in the
* queue. If it is triggered by continuous event, its priority will be
* default. If it is not triggered by continuous event, its priority will be
* discrete.
*/
Unspecified = 2,
/*
* Forces discrete type for the event. Regardless if continuous event is
* ongoing.
*/
Discrete = 3,
/*
* Forces continuous type for the event. Regardless if continuous event
* isn't ongoing.
*/
Continuous = 4
};
RawEvent(
std::string type,
ValueFactory payloadFactory,
SharedEventTarget eventTarget,
Category category = Category::Unspecified);
std::string type;
ValueFactory payloadFactory;
SharedEventTarget eventTarget;
Category category;
EventTag loggingTag{0};
};
} // namespace react
} // namespace facebook