packages/react-native/ReactCommon/react/performance/timeline/tests/PerformanceObserverTest.cpp - main - githubmr/facebook-react-native

packages/react-native/ReactCommon/react/performance/timeline/tests/PerformanceObserverTest.cpp
457 строк13 KB
Rubén Norte
Extend PerformanceEventTiming with taskEndTime (#53199)
11 авг 2025, 15:26
11 авг 2025, 15:266b05a59
/*
 * 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.
 */

#include <gtest/gtest.h>
#include <ostream>

#include "../PerformanceEntryReporter.h"
#include "../PerformanceObserver.h"

namespace facebook::react {

[[maybe_unused]] static bool operator==(
    const PerformanceEntry& lhs,
    const PerformanceEntry& rhs) {
  return std::visit(
      [&](const auto& left, const auto& right) {
        bool baseMatch = left.name == right.name &&
            left.entryType == right.entryType &&
            left.startTime == right.startTime &&
            left.duration == right.duration;

        if (baseMatch && left.entryType == PerformanceEntryType::EVENT) {
          auto leftEventTiming = std::get<PerformanceEventTiming>(lhs);
          auto rightEventTiming = std::get<PerformanceEventTiming>(rhs);

          return leftEventTiming.processingStart ==
              rightEventTiming.processingStart &&
              leftEventTiming.processingEnd == rightEventTiming.processingEnd &&
              leftEventTiming.interactionId == rightEventTiming.interactionId;
        }

        return baseMatch;
      },
      lhs,
      rhs);
}
} // namespace facebook::react

using namespace facebook::react;

TEST(PerformanceObserver, PerformanceObserverTestObserveFlushes) {
  auto reporter = PerformanceEntryReporter::getInstance();
  reporter->clearEntries();

  bool callbackCalled = false;
  auto observer = PerformanceObserver::create(
      reporter->getObserverRegistry(), [&]() { callbackCalled = true; });
  auto timeOrigin = HighResTimeStamp::now();
  observer->observe(PerformanceEntryType::MARK);

  // buffer is empty
  ASSERT_FALSE(callbackCalled);

  reporter->reportMark(
      "test", timeOrigin + HighResDuration::fromMilliseconds(10));
  ASSERT_TRUE(callbackCalled);

  observer->disconnect();
}

TEST(PerformanceObserver, PerformanceObserverTestFilteredSingle) {
  auto reporter = PerformanceEntryReporter::getInstance();
  reporter->clearEntries();

  auto timeOrigin = HighResTimeStamp::now();
  auto observer =
      PerformanceObserver::create(reporter->getObserverRegistry(), [&]() {});
  observer->observe(PerformanceEntryType::MEASURE);
  reporter->reportMark(
      "test", timeOrigin + HighResDuration::fromMilliseconds(10));

  // wrong type
  ASSERT_EQ(observer->takeRecords().size(), 0);

  observer->disconnect();
}

TEST(PerformanceObserver, PerformanceObserverTestFilterMulti) {
  auto reporter = PerformanceEntryReporter::getInstance();
  reporter->clearEntries();

  auto timeOrigin = HighResTimeStamp::now();
  auto callbackCalled = false;
  auto observer = PerformanceObserver::create(
      reporter->getObserverRegistry(), [&]() { callbackCalled = true; });
  observer->observe(
      {PerformanceEntryType::MEASURE, PerformanceEntryType::MARK});

  reporter->reportEvent(
      "test1",
      timeOrigin + HighResDuration::fromMilliseconds(10),
      HighResDuration::fromMilliseconds(10),
      timeOrigin,
      timeOrigin,
      timeOrigin,
      0);
  reporter->reportEvent(
      "test2",
      timeOrigin + HighResDuration::fromMilliseconds(10),
      HighResDuration::fromMilliseconds(10),
      timeOrigin,
      timeOrigin,
      timeOrigin,
      0);
  reporter->reportEvent(
      "test3",
      timeOrigin + HighResDuration::fromMilliseconds(10),
      HighResDuration::fromMilliseconds(10),
      timeOrigin,
      timeOrigin,
      timeOrigin,
      0);

  ASSERT_EQ(observer->takeRecords().size(), 0);
  ASSERT_FALSE(callbackCalled);

  observer->disconnect();
}

TEST(
    PerformanceObserver,
    PerformanceObserverTestFilterSingleCallbackNotCalled) {
  auto reporter = PerformanceEntryReporter::getInstance();
  reporter->clearEntries();

  auto timeOrigin = HighResTimeStamp::now();
  auto callbackCalled = false;
  auto observer = PerformanceObserver::create(
      reporter->getObserverRegistry(), [&]() { callbackCalled = true; });
  observer->observe(PerformanceEntryType::MEASURE);

  reporter->reportMark(
      "test", timeOrigin + HighResDuration::fromMilliseconds(10));

  ASSERT_FALSE(callbackCalled);

  observer->disconnect();
}

TEST(PerformanceObserver, PerformanceObserverTestFilterMultiCallbackNotCalled) {
  auto reporter = PerformanceEntryReporter::getInstance();
  reporter->clearEntries();

  auto timeOrigin = HighResTimeStamp::now();
  auto callbackCalled = false;
  auto observer = PerformanceObserver::create(
      reporter->getObserverRegistry(), [&]() { callbackCalled = true; });
  observer->observe(
      {PerformanceEntryType::MEASURE, PerformanceEntryType::MARK});

  reporter->reportEvent(
      "test1",
      timeOrigin + HighResDuration::fromMilliseconds(10),
      HighResDuration::fromMilliseconds(10),
      timeOrigin,
      timeOrigin,
      timeOrigin,
      0);
  reporter->reportEvent(
      "test2",
      timeOrigin + HighResDuration::fromMilliseconds(10),
      HighResDuration::fromMilliseconds(10),
      timeOrigin,
      timeOrigin,
      timeOrigin,
      0);
  reporter->reportEvent(
      "off3",
      timeOrigin + HighResDuration::fromMilliseconds(10),
      HighResDuration::fromMilliseconds(10),
      timeOrigin,
      timeOrigin,
      timeOrigin,
      0);

  ASSERT_FALSE(callbackCalled);

  observer->disconnect();
}

TEST(PerformanceObserver, PerformanceObserverTestObserveTakeRecords) {
  auto reporter = PerformanceEntryReporter::getInstance();
  reporter->clearEntries();

  auto timeOrigin = HighResTimeStamp::now();
  auto observer =
      PerformanceObserver::create(reporter->getObserverRegistry(), [&]() {});
  observer->observe(PerformanceEntryType::MARK);

  reporter->reportMark(
      "test1", timeOrigin + HighResDuration::fromMilliseconds(10));
  reporter->reportMeasure(
      "off",
      timeOrigin + HighResDuration::fromMilliseconds(10),
      HighResDuration::fromMilliseconds(20));
  reporter->reportMark(
      "test2", timeOrigin + HighResDuration::fromMilliseconds(20));
  reporter->reportMark(
      "test3", timeOrigin + HighResDuration::fromMilliseconds(30));

  const std::vector<PerformanceEntry> expected = {
      PerformanceMark{
          {.name = "test1",
           .startTime = timeOrigin + HighResDuration::fromMilliseconds(10)}},
      PerformanceMark{
          {.name = "test2",
           .startTime = timeOrigin + HighResDuration::fromMilliseconds(20)}},
      PerformanceMark{
          {.name = "test3",
           .startTime = timeOrigin + HighResDuration::fromMilliseconds(30)}},
  };

  ASSERT_EQ(expected, observer->takeRecords());

  observer->disconnect();
}

TEST(PerformanceObserver, PerformanceObserverTestObserveDurationThreshold) {
  auto reporter = PerformanceEntryReporter::getInstance();
  reporter->clearEntries();

  auto timeOrigin = HighResTimeStamp::now();
  auto observer =
      PerformanceObserver::create(reporter->getObserverRegistry(), [&]() {});
  observer->observe(
      PerformanceEntryType::EVENT,
      {.durationThreshold = HighResDuration::fromMilliseconds(50)});

  reporter->reportEvent(
      "test1",
      timeOrigin,
      HighResDuration::fromMilliseconds(50),
      timeOrigin,
      timeOrigin,
      timeOrigin,
      0);
  reporter->reportEvent(
      "test2",
      timeOrigin,
      HighResDuration::fromMilliseconds(100),
      timeOrigin,
      timeOrigin,
      timeOrigin,
      0);
  reporter->reportEvent(
      "off1",
      timeOrigin,
      HighResDuration::fromMilliseconds(40),
      timeOrigin,
      timeOrigin,
      timeOrigin,
      0);
  reporter->reportMark(
      "off2", timeOrigin + HighResDuration::fromMilliseconds(100));
  reporter->reportEvent(
      "test3",
      timeOrigin,
      HighResDuration::fromMilliseconds(60),
      timeOrigin,
      timeOrigin,
      timeOrigin,
      0);

  const std::vector<PerformanceEntry> expected = {
      PerformanceEventTiming{
          {.name = "test1",
           .startTime = timeOrigin,
           .duration = HighResDuration::fromMilliseconds(50)},
          timeOrigin,
          timeOrigin,
          timeOrigin,
          0},
      PerformanceEventTiming{
          {.name = "test2",
           .startTime = timeOrigin,
           .duration = HighResDuration::fromMilliseconds(100)},
          timeOrigin,
          timeOrigin,
          timeOrigin,
          0},
      PerformanceEventTiming{
          {.name = "test3",
           .startTime = timeOrigin,
           .duration = HighResDuration::fromMilliseconds(60)},
          timeOrigin,
          timeOrigin,
          timeOrigin,
          0},
  };

  ASSERT_EQ(expected, observer->takeRecords());

  observer->disconnect();
}

TEST(PerformanceObserver, PerformanceObserverTestObserveBuffered) {
  auto reporter = PerformanceEntryReporter::getInstance();
  reporter->clearEntries();

  auto timeOrigin = HighResTimeStamp::now();
  reporter->reportEvent(
      "test1",
      timeOrigin,
      HighResDuration::fromMilliseconds(50),
      timeOrigin,
      timeOrigin,
      timeOrigin,
      0);
  reporter->reportEvent(
      "test2",
      timeOrigin,
      HighResDuration::fromMilliseconds(100),
      timeOrigin,
      timeOrigin,
      timeOrigin,
      0);
  reporter->reportEvent(
      "test3",
      timeOrigin,
      HighResDuration::fromMilliseconds(40),
      timeOrigin,
      timeOrigin,
      timeOrigin,
      0);
  reporter->reportEvent(
      "test4",
      timeOrigin,
      HighResDuration::fromMilliseconds(100),
      timeOrigin,
      timeOrigin,
      timeOrigin,
      0);

  auto observer =
      PerformanceObserver::create(reporter->getObserverRegistry(), [&]() {});
  observer->observe(
      PerformanceEntryType::EVENT,
      {.buffered = true,
       .durationThreshold = HighResDuration::fromMilliseconds(50)});

  const std::vector<PerformanceEntry> expected = {
      PerformanceEventTiming{
          {.name = "test1",
           .startTime = timeOrigin,
           .duration = HighResDuration::fromMilliseconds(50)},
          timeOrigin,
          timeOrigin,
          timeOrigin,
          0},
      PerformanceEventTiming{
          {.name = "test2",
           .startTime = timeOrigin,
           .duration = HighResDuration::fromMilliseconds(100)},
          timeOrigin,
          timeOrigin,
          timeOrigin,
          0},
      PerformanceEventTiming{
          {.name = "test4",
           .startTime = timeOrigin,
           .duration = HighResDuration::fromMilliseconds(100)},
          timeOrigin,
          timeOrigin,
          timeOrigin,
          0},
  };

  ASSERT_EQ(expected, observer->takeRecords());

  observer->disconnect();
}

TEST(PerformanceObserver, PerformanceObserverTestMultiple) {
  auto reporter = PerformanceEntryReporter::getInstance();
  reporter->clearEntries();

  auto timeOrigin = HighResTimeStamp::now();
  auto observer1 =
      PerformanceObserver::create(reporter->getObserverRegistry(), [&]() {});
  auto observer2 =
      PerformanceObserver::create(reporter->getObserverRegistry(), [&]() {});
  observer1->observe(
      PerformanceEntryType::EVENT,
      {.durationThreshold = HighResDuration::fromMilliseconds(50)});
  observer2->observe(
      PerformanceEntryType::EVENT,
      {.durationThreshold = HighResDuration::fromMilliseconds(80)});

  reporter->reportMeasure(
      "measure", timeOrigin, HighResDuration::fromMilliseconds(50));
  reporter->reportEvent(
      "event1",
      timeOrigin,
      HighResDuration::fromMilliseconds(100),
      timeOrigin,
      timeOrigin,
      timeOrigin,
      0);
  reporter->reportEvent(
      "event2",
      timeOrigin,
      HighResDuration::fromMilliseconds(40),
      timeOrigin,
      timeOrigin,
      timeOrigin,
      0);
  reporter->reportMark(
      "mark1", timeOrigin + HighResDuration::fromMilliseconds(100));
  reporter->reportEvent(
      "event3",
      timeOrigin,
      HighResDuration::fromMilliseconds(60),
      timeOrigin,
      timeOrigin,
      timeOrigin,
      0);

  const std::vector<PerformanceEntry> expected1 = {
      PerformanceEventTiming{
          {.name = "event1",
           .startTime = timeOrigin,
           .duration = HighResDuration::fromMilliseconds(100)},
          timeOrigin,
          timeOrigin,
          timeOrigin,
          0},
      PerformanceEventTiming{
          {.name = "event3",
           .startTime = timeOrigin,
           .duration = HighResDuration::fromMilliseconds(60)},
          timeOrigin,
          timeOrigin,
          timeOrigin,
          0},
  };

  const std::vector<PerformanceEntry> expected2 = {
      PerformanceEventTiming{
          {.name = "event1",
           .startTime = timeOrigin,
           .duration = HighResDuration::fromMilliseconds(100)},
          timeOrigin,
          timeOrigin,
          timeOrigin,
          0},
  };

  ASSERT_EQ(expected1, observer1->takeRecords());
  ASSERT_EQ(expected2, observer2->takeRecords());

  observer1->disconnect();
  observer2->disconnect();
}