Files
react-native/Libraries/WebPerformance/NativePerformanceObserver.h
T
Ruslan Shestopalyuk bc56f66b8d Implement Performance.getEntries* W3C extension for Performance Timeline API (#36314)
Summary:
Pull Request resolved: https://github.com/facebook/react-native/pull/36314

## Changelog:

[Internal] - Added support for W3C Performance API extension (Performance,getEntries*)

See [here for the details](https://www.w3.org/TR/performance-timeline/#extensions-to-the-performance-interface).

This only supports `mark` and `measure` performance entry types (not `events`, as those are not supported by browsers either, they recommend using the `PerformanceObserver` API instead).

From the implementation perspective, we already maintained persistent buffer for `mark` entry types, which was required in order to look up measures.

The buffer is circular, limited to 1K entries by default.

I basically mimic the same behavior for `measure` entry types as well, since it's the simplest way of doing it at this point,

If we happen to want adding some other entry types that would be available via `Performance.getEntries*` API in the future, we may want to iterate on the internal data structures representation inside `PerformanceEntryReporter`, but for now I believe this approach should work just fine, and whatever changes we may want to do will be purely internal implementation detail.

Reviewed By: rubennorte

Differential Revision: D43625488

fbshipit-source-id: dd315b3f8488e910749a8e2a4158246e94d76f99
2023-03-01 04:14:51 -08:00

96 lines
2.5 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 <FBReactNativeSpec/FBReactNativeSpecJSI.h>
#include <functional>
#include <optional>
#include <string>
#include <vector>
namespace facebook::react {
class PerformanceEntryReporter;
#pragma mark - Structs
using RawPerformanceEntry = NativePerformanceObserverCxxBaseRawPerformanceEntry<
std::string,
int32_t,
double,
double,
// For "event" entries only:
std::optional<double>,
std::optional<double>,
std::optional<uint32_t>>;
template <>
struct Bridging<RawPerformanceEntry>
: NativePerformanceObserverCxxBaseRawPerformanceEntryBridging<
std::string,
int32_t,
double,
double,
std::optional<double>,
std::optional<double>,
std::optional<uint32_t>> {};
using GetPendingEntriesResult =
NativePerformanceObserverCxxBaseGetPendingEntriesResult<
std::vector<RawPerformanceEntry>,
uint32_t>;
template <>
struct Bridging<GetPendingEntriesResult>
: NativePerformanceObserverCxxBaseGetPendingEntriesResultBridging<
std::vector<RawPerformanceEntry>,
uint32_t> {};
#pragma mark - implementation
class NativePerformanceObserver
: public NativePerformanceObserverCxxSpec<NativePerformanceObserver>,
std::enable_shared_from_this<NativePerformanceObserver> {
public:
NativePerformanceObserver(std::shared_ptr<CallInvoker> jsInvoker);
~NativePerformanceObserver();
void startReporting(jsi::Runtime &rt, int32_t entryType);
void stopReporting(jsi::Runtime &rt, int32_t entryType);
GetPendingEntriesResult popPendingEntries(jsi::Runtime &rt);
void setOnPerformanceEntryCallback(
jsi::Runtime &rt,
std::optional<AsyncCallback<>> callback);
void logRawEntry(jsi::Runtime &rt, RawPerformanceEntry entry);
std::vector<std::pair<std::string, uint32_t>> getEventCounts(
jsi::Runtime &rt);
void setDurationThreshold(
jsi::Runtime &rt,
int32_t entryType,
double durationThreshold);
void clearEntries(
jsi::Runtime &rt,
int32_t entryType,
std::optional<std::string> entryName);
std::vector<RawPerformanceEntry> getEntries(
jsi::Runtime &rt,
std::optional<int32_t> entryType,
std::optional<std::string> entryName);
private:
};
} // namespace facebook::react