packages/react-native/ReactCommon/react/performance/timeline/PerformanceObserver.h - main - githubmr/facebook-react-native

packages/react-native/ReactCommon/react/performance/timeline/PerformanceObserver.h
142 строки4 KB
Ruslan Lesiutin
Replace DOMHighResTimeStamp alias in ReactCommon with new abstractions (#51512)
22 май 2025, 20:16
22 май 2025, 20:16f03268b
/*
 * 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 "PerformanceEntryBuffer.h"
#include "PerformanceObserverRegistry.h"

#include <react/timing/primitives.h>

#include <functional>
#include <memory>
#include <unordered_set>
#include <vector>

namespace facebook::react {

using PerformanceObserverEntryTypeFilter =
    std::unordered_set<PerformanceEntryType>;
using PerformanceObserverCallback = std::function<void()>;

/**
 * Represents subset of spec's `PerformanceObserverInit` that is allowed for
 * multiple types.
 *
 * https://w3c.github.io/performance-timeline/#performanceobserverinit-dictionary
 */
struct PerformanceObserverObserveMultipleOptions {
  HighResDuration durationThreshold = DEFAULT_DURATION_THRESHOLD;
};

/**
 * Represents subset of spec's `PerformanceObserverInit` that is allowed for
 * single type.
 *
 * https://w3c.github.io/performance-timeline/#performanceobserverinit-dictionary
 */
struct PerformanceObserverObserveSingleOptions {
  bool buffered = false;
  HighResDuration durationThreshold = DEFAULT_DURATION_THRESHOLD;
};

/**
 * Represents native counterpart of performance timeline PerformanceObserver
 * class. Each instance has its own entry buffer and can listen for different
 * performance entry types.
 *
 * Entries are pushed to the observer by the `PerformanceEntryReporter` class,
 * through the `PerformanceObserverRegistry` class which acts as a central hub.
 */
class PerformanceObserver
    : public std::enable_shared_from_this<PerformanceObserver> {
 private:
  struct PrivateUseCreateMethod {
    explicit PrivateUseCreateMethod() = default;
  };

 public:
  explicit PerformanceObserver(
      PrivateUseCreateMethod /*unused*/,
      PerformanceObserverRegistry& registry,
      PerformanceObserverCallback&& callback)
      : registry_(registry), callback_(std::move(callback)) {}

  static std::shared_ptr<PerformanceObserver> create(
      PerformanceObserverRegistry& registry,
      PerformanceObserverCallback&& callback) {
    return std::make_shared<PerformanceObserver>(
        PrivateUseCreateMethod(), registry, std::move(callback));
  }

  ~PerformanceObserver() = default;

  /**
   * Append entry to the buffer if this observer should handle this entry.
   */
  void handleEntry(const PerformanceEntry& entry);

  /**
   * Returns current observer buffer and clears it.
   *
   * Spec:
   *  https://w3c.github.io/performance-timeline/#takerecords-method
   */
  [[nodiscard]] std::vector<PerformanceEntry> takeRecords();

  /**
   * Configures the observer to watch for specified entry type.
   *
   * This operation resets and overrides previous configurations. So consecutive
   * calls to this methods remove any previous watch configuration (as per
   * spec).
   */
  void observe(
      PerformanceEntryType type,
      PerformanceObserverObserveSingleOptions options = {});

  /**
   * Configures the observer to watch for specified entry type.
   *
   * This operation resets and overrides previous configurations. So consecutive
   * calls to this methods remove any previous watch configuration (as per
   * spec).
   */
  void observe(std::unordered_set<PerformanceEntryType> types);

  /**
   * Disconnects observer from the registry
   */
  void disconnect() noexcept;

  /**
   * Internal function called by JS bridge to get number of dropped entries
   * count counted at call time.
   */
  uint32_t getDroppedEntriesCount() noexcept;

 private:
  void scheduleFlushBuffer();

  PerformanceObserverRegistry& registry_;
  PerformanceObserverCallback callback_;
  PerformanceObserverEntryTypeFilter observedTypes_;

  /// https://www.w3.org/TR/event-timing/#sec-modifications-perf-timeline
  HighResDuration durationThreshold_ = DEFAULT_DURATION_THRESHOLD;
  std::vector<PerformanceEntry> buffer_;
  bool didScheduleFlushBuffer_ = false;
  bool requiresDroppedEntries_ = false;
};

inline bool operator==(
    const PerformanceObserver& lhs,
    const PerformanceObserver& rhs) {
  return &lhs == &rhs;
}

} // namespace facebook::react