react-native 0.83.4 → 0.83.5

package/ReactCommon/jsinspector-modern/tracing/TraceEventGenerator.cpp

@@ -0,0 +1,100 @@
+/*
+ * 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 "TraceEventGenerator.h"
+#include "Timing.h"
+#include "TracingCategory.h"
+
+#include <react/utils/Base64.h>
+
+namespace facebook::react::jsinspector_modern::tracing {
+
+/* static */ TraceEvent TraceEventGenerator::createSetLayerTreeIdEvent(
+    std::string frame,
+    int layerTreeId,
+    ProcessId processId,
+    ThreadId threadId,
+    HighResTimeStamp timestamp) {
+  folly::dynamic data = folly::dynamic::object("frame", std::move(frame))(
+      "layerTreeId", layerTreeId);
+
+  return TraceEvent{
+      .name = "SetLayerTreeId",
+      .cat = {Category::HiddenTimeline},
+      .ph = 'I',
+      .ts = timestamp,
+      .pid = processId,
+      .s = 't',
+      .tid = threadId,
+      .args = folly::dynamic::object("data", std::move(data)),
+  };
+}
+
+/* static */ std::pair<TraceEvent, TraceEvent>
+TraceEventGenerator::createFrameTimingsEvents(
+    uint64_t sequenceId,
+    int layerTreeId,
+    HighResTimeStamp beginTimestamp,
+    HighResTimeStamp endTimestamp,
+    ProcessId processId,
+    ThreadId threadId) {
+  folly::dynamic args = folly::dynamic::object("frameSeqId", sequenceId)(
+      "layerTreeId", layerTreeId);
+
+  auto beginEvent = TraceEvent{
+      .name = "BeginFrame",
+      .cat = {Category::Frame},
+      .ph = 'I',
+      .ts = beginTimestamp,
+      .pid = processId,
+      .s = 't',
+      .tid = threadId,
+      .args = args,
+  };
+  auto drawEvent = TraceEvent{
+      .name = "DrawFrame",
+      .cat = {Category::Frame},
+      .ph = 'I',
+      .ts = endTimestamp,
+      .pid = processId,
+      .s = 't',
+      .tid = threadId,
+      .args = args,
+  };
+
+  return {std::move(beginEvent), std::move(drawEvent)};
+}
+
+/* static */ TraceEvent TraceEventGenerator::createScreenshotEvent(
+    FrameSequenceId frameSequenceId,
+    int sourceId,
+    std::vector<uint8_t>&& snapshot,
+    HighResTimeStamp expectedDisplayTime,
+    ProcessId processId,
+    ThreadId threadId) {
+  // Convert binary data to string for Base64 encoding
+  std::string snapshotBytes(snapshot.begin(), snapshot.end());
+  std::string base64Snapshot = base64Encode(snapshotBytes);
+
+  folly::dynamic args =
+      folly::dynamic::object("snapshot", std::move(base64Snapshot))(
+          "source_id", sourceId)("frame_sequence", frameSequenceId)(
+          "expected_display_time",
+          highResTimeStampToTracingClockTimeStamp(expectedDisplayTime));
+
+  return TraceEvent{
+      .name = "Screenshot",
+      .cat = {Category::Screenshot},
+      .ph = 'O',
+      .ts = expectedDisplayTime,
+      .pid = processId,
+      .tid = threadId,
+      .args = std::move(args),
+  };
+}
+
+}; // namespace facebook::react::jsinspector_modern::tracing

package/ReactCommon/jsinspector-modern/tracing/TraceEventGenerator.h

@@ -0,0 +1,60 @@
+/*
+ * 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 "TraceEvent.h"
+
+#include <jsinspector-modern/tracing/FrameTimingSequence.h>
+#include <react/timing/primitives.h>
+
+#include <cstdint>
+#include <utility>
+#include <vector>
+
+namespace facebook::react::jsinspector_modern::tracing {
+
+/**
+ * This class encapsulates the logic for generating canonical trace events that will be serialized and sent as part of
+ * Tracing.dataCollected CDP message.
+ */
+class TraceEventGenerator {
+ public:
+  /**
+   * Creates canonical "SetLayerTreeId" trace event.
+   */
+  static TraceEvent createSetLayerTreeIdEvent(
+      std::string frame,
+      int layerTreeId,
+      ProcessId processId,
+      ThreadId threadId,
+      HighResTimeStamp timestamp);
+
+  /**
+   * Creates canonical "BeginFrame", "Commit", "DrawFrame" trace events.
+   */
+  static std::pair<TraceEvent, TraceEvent> createFrameTimingsEvents(
+      FrameSequenceId sequenceId,
+      int layerTreeId,
+      HighResTimeStamp beginTimestamp,
+      HighResTimeStamp endTimestamp,
+      ProcessId processId,
+      ThreadId threadId);
+
+  /**
+   * Creates canonical "Screenshot" trace event.
+   */
+  static TraceEvent createScreenshotEvent(
+      FrameSequenceId frameSequenceId,
+      int sourceId,
+      std::vector<uint8_t> &&snapshot,
+      HighResTimeStamp expectedDisplayTime,
+      ProcessId processId,
+      ThreadId threadId);
+};
+
+}; // namespace facebook::react::jsinspector_modern::tracing

package/ReactCommon/jsinspector-modern/tracing/TraceEventSerializer.cpp

@@ -7,6 +7,7 @@
 
 #include "TraceEventSerializer.h"
 #include "Timing.h"
+#include "TracingCategory.h"
 
 #include <react/timing/primitives.h>
 
@@ -22,7 +23,7 @@ namespace facebook::react::jsinspector_modern::tracing {
     result["id"] = buffer.data();
   }
   result["name"] = std::move(event.name);
-  result["cat"] = std::move(event.cat);
+  result["cat"] = serializeTracingCategories(event.cat);
   result["ph"] = std::string(1, event.ph);
   result["ts"] = highResTimeStampToTracingClockTimeStamp(event.ts);
   result["pid"] = event.pid;
@@ -111,4 +112,46 @@ TraceEventSerializer::serializeProfileChunkCPUProfileNodeCallFrame(
   return dynamicCallFrame;
 }
 
+/* static */ size_t TraceEventSerializer::estimateJsonSize(
+    const folly::dynamic& value) {
+  switch (value.type()) {
+    case folly::dynamic::Type::NULLT:
+      return 4; // null
+    case folly::dynamic::Type::BOOL:
+      return 5; // false
+    case folly::dynamic::Type::INT64:
+    case folly::dynamic::Type::DOUBLE:
+      return 20; // conservative max for numeric values
+    case folly::dynamic::Type::STRING:
+      return value.stringPiece().size() + 2; // quotes
+    case folly::dynamic::Type::ARRAY: {
+      size_t size = 2; // []
+      bool first = true;
+      for (const auto& element : value) {
+        if (!first) {
+          size += 1; // comma
+        }
+        first = false;
+        size += estimateJsonSize(element);
+      }
+      return size;
+    }
+    case folly::dynamic::Type::OBJECT: {
+      size_t size = 2; // {}
+      bool first = true;
+      for (const auto& [key, val] : value.items()) {
+        if (!first) {
+          size += 1; // comma
+        }
+        first = false;
+        // key size + quotes + colon
+        size += key.stringPiece().size() + 3;
+        size += estimateJsonSize(val);
+      }
+      return size;
+    }
+  }
+  return 0;
+}
+
 } // namespace facebook::react::jsinspector_modern::tracing

package/ReactCommon/jsinspector-modern/tracing/TraceEventSerializer.h

@@ -84,6 +84,13 @@ class TraceEventSerializer {
    */
   static folly::dynamic serializeProfileChunkCPUProfileNodeCallFrame(
       TraceEventProfileChunk::CPUProfile::Node::CallFrame &&callFrame);
+
+  /**
+   * Estimates the JSON-serialized byte size of a folly::dynamic value.
+   * This is a rough but conservative estimate to avoid the cost of
+   * double-serialization (once to measure, once to emit).
+   */
+  static size_t estimateJsonSize(const folly::dynamic &value);
 };
 
 } // namespace facebook::react::jsinspector_modern::tracing

package/ReactCommon/jsinspector-modern/tracing/TraceRecordingState.h

@@ -18,22 +18,33 @@
 
 namespace facebook::react::jsinspector_modern::tracing {
 
+/**
+ * The global state for the given Trace Recording.
+ * Shared with Tracing Agents, which could use it to stash the corresponding target profiles during reloads.
+ */
 struct TraceRecordingState {
+  TraceRecordingState(
+      tracing::Mode tracingMode,
+      std::set<tracing::Category> enabledCategories,
+      std::optional<HighResDuration> windowSize = std::nullopt)
+      : mode(tracingMode), enabledCategories(std::move(enabledCategories)), windowSize(windowSize)
+  {
+  }
+
   // The mode of this Trace Recording.
   tracing::Mode mode;
 
-  // The ID of the OS-level process that this Trace Recording is associated
-  // with.
-  ProcessId processId = oscompat::getCurrentProcessId();
-
-  // The timestamp at which this Trace Recording started.
-  HighResTimeStamp startTime;
-
   // All captured Runtime Sampling Profiles during this Trace Recording.
   std::vector<RuntimeSamplingProfile> runtimeSamplingProfiles{};
 
   // All captures Instance Tracing Profiles during this Trace Recording.
   std::vector<InstanceTracingProfile> instanceTracingProfiles{};
+
+  // The list of categories that are enabled for this recording.
+  std::set<tracing::Category> enabledCategories;
+
+  // The size of the time window for this recording.
+  std::optional<HighResDuration> windowSize;
 };
 
 } // namespace facebook::react::jsinspector_modern::tracing

package/ReactCommon/jsinspector-modern/tracing/TracingCategory.h

@@ -0,0 +1,136 @@
+/*
+ * 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 <folly/container/small_vector.h>
+
+#include <optional>
+#include <set>
+#include <string>
+
+namespace facebook::react::jsinspector_modern::tracing {
+
+enum class Category {
+  HiddenTimeline, /*     disabled-by-default-devtools.timeline       */
+  JavaScriptSampling, /* disabled-by-default-v8.cpu_profiler         */
+  RuntimeExecution, /*   v8.execute                                  */
+  Timeline, /*           devtools.timeline                           */
+  UserTiming, /*         blink.user_timing                           */
+  Frame, /*              disabled-by-default-devtools.timeline.frame */
+  Screenshot, /*         disabled-by-default-devtools.screenshot     */
+};
+
+inline std::string tracingCategoryToString(const Category &category)
+{
+  switch (category) {
+    case Category::Timeline:
+      return "devtools.timeline";
+    case Category::HiddenTimeline:
+      return "disabled-by-default-devtools.timeline";
+    case Category::UserTiming:
+      return "blink.user_timing";
+    case Category::JavaScriptSampling:
+      return "disabled-by-default-v8.cpu_profiler";
+    case Category::RuntimeExecution:
+      return "v8.execute";
+    case Category::Frame:
+      return "disabled-by-default-devtools.timeline.frame";
+    case Category::Screenshot:
+      return "disabled-by-default-devtools.screenshot";
+  }
+}
+
+inline std::optional<Category> getTracingCategoryFromString(const std::string &str)
+{
+  if (str == "blink.user_timing") {
+    return Category::UserTiming;
+  } else if (str == "devtools.timeline") {
+    return Category::Timeline;
+  } else if (str == "disabled-by-default-devtools.timeline") {
+    return Category::HiddenTimeline;
+  } else if (str == "disabled-by-default-v8.cpu_profiler") {
+    return Category::JavaScriptSampling;
+  } else if (str == "v8.execute") {
+    return Category::RuntimeExecution;
+  } else if (str == "disabled-by-default-devtools.timeline.frame") {
+    return Category::Frame;
+  } else if (str == "disabled-by-default-devtools.screenshot") {
+    return Category::Screenshot;
+  } else {
+    return std::nullopt;
+  }
+}
+
+/**
+ * The Trace Event could have multiple categories, but this is extremely rare case.
+ */
+using Categories = folly::small_vector<Category, 1>;
+
+// { Timeline, UserTiming } => "devtools.timeline,blink.user_timing"
+inline std::string serializeTracingCategories(const Categories &categories)
+{
+  if (categories.size() == 1) {
+    return tracingCategoryToString(categories.front());
+  }
+
+  std::string serializedValue;
+  for (size_t i = 0; i < categories.size(); ++i) {
+    serializedValue += tracingCategoryToString(categories[i]);
+    if (i < categories.size() - 1) {
+      serializedValue += ",";
+    }
+  }
+  return serializedValue;
+}
+
+// { Timeline, UserTiming } => "devtools.timeline,blink.user_timing"
+inline std::string serializeTracingCategories(const std::set<Category> &categories)
+{
+  std::string serializedValue;
+
+  auto current = categories.begin();
+  while (current != categories.end()) {
+    serializedValue += tracingCategoryToString(*current);
+
+    ++current;
+    if (current != categories.end()) {
+      serializedValue += ",";
+    }
+  }
+
+  return serializedValue;
+}
+
+// "devtools.timeline,blink.user_timing" => { Timeline, UserTiming }
+inline std::set<Category> parseSerializedTracingCategories(const std::string &serializedCategories)
+{
+  std::set<Category> categories;
+  if (serializedCategories.empty()) {
+    return categories;
+  }
+
+  size_t start = 0;
+  size_t end = serializedCategories.find(',');
+  while (end != std::string::npos) {
+    std::string token = serializedCategories.substr(start, end - start);
+    if (auto category = getTracingCategoryFromString(token)) {
+      categories.insert(*category);
+    }
+    start = end + 1;
+    end = serializedCategories.find(',', start);
+  }
+
+  std::string lastToken = serializedCategories.substr(start);
+  if (auto category = getTracingCategoryFromString(lastToken)) {
+    categories.insert(*category);
+  }
+
+  return categories;
+}
+
+} // namespace facebook::react::jsinspector_modern::tracing