Extract serializers for ProfileChunk (#52870)

Summary:
Pull Request resolved: #52870

# Changelog: [Internal]

Defines a set of static serializers for parts of the "Profile" and "ProfileChunk" Trace Events.

Mainly for 2 reasons:
1. To follow the same pattern of static serializers for Tracing.
2. To save on string copying, since ProfileChunk could contain hundreds of unique frames, all of them could have unique function names. The previous approach would copy the strings and populate a new `folly::dynamic` object.

Reviewed By: huntie

Differential Revision: D78919218

fbshipit-source-id: 303a4fc259d6b1720ce982e144037ee56cd47e9b

Author: hoxyq

packages/react-native/ReactCommon/jsinspector-modern/tracing/PerformanceTracer.cpp

@@ -401,7 +401,7 @@ folly::dynamic PerformanceTracer::getSerializedRuntimeProfileChunkTraceEvent(
     uint16_t profileId,
     uint64_t threadId,
     HighResTimeStamp chunkTimestamp,
-    const tracing::TraceEventProfileChunk& traceEventProfileChunk) {
+    tracing::TraceEventProfileChunk&& traceEventProfileChunk) {
   return TraceEventSerializer::serialize(TraceEvent{
       .id = profileId,
       .name = "ProfileChunk",
@@ -410,8 +410,10 @@ folly::dynamic PerformanceTracer::getSerializedRuntimeProfileChunkTraceEvent(
       .ts = chunkTimestamp,
       .pid = processId_,
       .tid = threadId,
-      .args =
-          folly::dynamic::object("data", traceEventProfileChunk.toDynamic()),
+      .args = folly::dynamic::object(
+          "data",
+          TraceEventSerializer::serializeProfileChunk(
+              std::move(traceEventProfileChunk))),
   });
 }
 

packages/react-native/ReactCommon/jsinspector-modern/tracing/PerformanceTracer.h

@@ -148,7 +148,7 @@ class PerformanceTracer {
       uint16_t profileId,
       uint64_t threadId,
       HighResTimeStamp chunkTimestamp,
-      const TraceEventProfileChunk& traceEventProfileChunk);
+      TraceEventProfileChunk&& traceEventProfileChunk);
 
  private:
   PerformanceTracer();

packages/react-native/ReactCommon/jsinspector-modern/tracing/RuntimeSamplingProfileTraceEventSerializer.cpp

@@ -137,10 +137,7 @@ void RuntimeSamplingProfileTraceEventSerializer::bufferProfileChunkTraceEvent(
                   TraceEventProfileChunk::CPUProfile{
                       .nodes = std::move(traceEventNodes),
                       .samples = std::move(chunk.samples)},
-              .timeDeltas =
-                  TraceEventProfileChunk::TimeDeltas{
-                      .deltas = std::move(chunk.timeDeltas),
-                  },
+              .timeDeltas = std::move(chunk.timeDeltas),
           }));
 }
 

packages/react-native/ReactCommon/jsinspector-modern/tracing/TraceEventProfile.h

@@ -7,10 +7,11 @@
 
 #pragma once
 
-#include <jsinspector-modern/tracing/Timing.h>
 #include <react/timing/primitives.h>
 
-#include <folly/dynamic.h>
+#include <optional>
+#include <string>
+#include <vector>
 
 namespace facebook::react::jsinspector_modern::tracing {
 
@@ -19,18 +20,7 @@ namespace facebook::react::jsinspector_modern::tracing {
 struct TraceEventProfileChunk {
   /// Deltas between timestamps of chronolocigally sorted samples.
   /// Will be sent as part of the "ProfileChunk" trace event.
-  struct TimeDeltas {
-    folly::dynamic toDynamic() const {
-      auto value = folly::dynamic::array();
-      value.reserve(deltas.size());
-      for (const auto& delta : deltas) {
-        value.push_back(highResDurationToTracingClockDuration(delta));
-      }
-      return value;
-    }
-
-    std::vector<HighResDuration> deltas;
-  };
+  using TimeDeltas = std::vector<HighResDuration>;
 
   /// Contains Profile information that will be emitted in this chunk: nodes and
   /// sample root node ids.
@@ -41,24 +31,6 @@ struct TraceEventProfileChunk {
     struct Node {
       /// Unique call frame in the call stack.
       struct CallFrame {
-        folly::dynamic toDynamic() const {
-          folly::dynamic dynamicCallFrame = folly::dynamic::object();
-          dynamicCallFrame["codeType"] = codeType;
-          dynamicCallFrame["scriptId"] = scriptId;
-          dynamicCallFrame["functionName"] = functionName;
-          if (url.has_value()) {
-            dynamicCallFrame["url"] = url.value();
-          }
-          if (lineNumber.has_value()) {
-            dynamicCallFrame["lineNumber"] = lineNumber.value();
-          }
-          if (columnNumber.has_value()) {
-            dynamicCallFrame["columnNumber"] = columnNumber.value();
-          }
-
-          return dynamicCallFrame;
-        }
-
         std::string codeType;
         uint32_t scriptId;
         std::string functionName;
@@ -67,45 +39,15 @@ struct TraceEventProfileChunk {
         std::optional<uint32_t> columnNumber;
       };
 
-      folly::dynamic toDynamic() const {
-        folly::dynamic dynamicNode = folly::dynamic::object();
-
-        dynamicNode["callFrame"] = callFrame.toDynamic();
-        dynamicNode["id"] = id;
-        if (parentId.has_value()) {
-          dynamicNode["parent"] = parentId.value();
-        }
-
-        return dynamicNode;
-      }
-
       uint32_t id;
       CallFrame callFrame;
       std::optional<uint32_t> parentId;
     };
 
-    folly::dynamic toDynamic() const {
-      folly::dynamic dynamicNodes = folly::dynamic::array();
-      dynamicNodes.reserve(nodes.size());
-      for (const auto& node : nodes) {
-        dynamicNodes.push_back(node.toDynamic());
-      }
-      folly::dynamic dynamicSamples =
-          folly::dynamic::array(samples.begin(), samples.end());
-
-      return folly::dynamic::object("nodes", dynamicNodes)(
-          "samples", dynamicSamples);
-    }
-
     std::vector<Node> nodes;
     std::vector<uint32_t> samples;
   };
 
-  folly::dynamic toDynamic() const {
-    return folly::dynamic::object("cpuProfile", cpuProfile.toDynamic())(
-        "timeDeltas", timeDeltas.toDynamic());
-  }
-
   CPUProfile cpuProfile;
   TimeDeltas timeDeltas;
 };

packages/react-native/ReactCommon/jsinspector-modern/tracing/TraceEventSerializer.cpp

@@ -8,6 +8,8 @@
 #include "TraceEventSerializer.h"
 #include "Timing.h"
 
+#include <react/timing/primitives.h>
+
 namespace facebook::react::jsinspector_modern::tracing {
 
 /* static */ folly::dynamic TraceEventSerializer::serialize(
@@ -33,4 +35,77 @@ namespace facebook::react::jsinspector_modern::tracing {
   return result;
 }
 
+/* static */ folly::dynamic TraceEventSerializer::serializeProfileChunk(
+    TraceEventProfileChunk&& profileChunk) {
+  return folly::dynamic::object(
+      "cpuProfile",
+      serializeProfileChunkCPUProfile(std::move(profileChunk.cpuProfile)))(
+      "timeDeltas",
+      serializeProfileChunkTimeDeltas(std::move(profileChunk.timeDeltas)));
+}
+
+/* static */ folly::dynamic
+TraceEventSerializer::serializeProfileChunkTimeDeltas(
+    TraceEventProfileChunk::TimeDeltas&& deltas) {
+  auto value = folly::dynamic::array();
+  value.reserve(deltas.size());
+
+  for (auto& delta : deltas) {
+    value.push_back(highResDurationToTracingClockDuration(delta));
+  }
+  return value;
+}
+
+/* static */ folly::dynamic
+TraceEventSerializer::serializeProfileChunkCPUProfile(
+    TraceEventProfileChunk::CPUProfile&& cpuProfile) {
+  folly::dynamic dynamicNodes = folly::dynamic::array();
+  dynamicNodes.reserve(cpuProfile.nodes.size());
+  for (auto& node : cpuProfile.nodes) {
+    dynamicNodes.push_back(
+        serializeProfileChunkCPUProfileNode(std::move(node)));
+  }
+  folly::dynamic dynamicSamples = folly::dynamic::array(
+      std::make_move_iterator(cpuProfile.samples.begin()),
+      std::make_move_iterator(cpuProfile.samples.end()));
+
+  return folly::dynamic::object("nodes", std::move(dynamicNodes))(
+      "samples", std::move(dynamicSamples));
+}
+
+/* static */ folly::dynamic
+TraceEventSerializer::serializeProfileChunkCPUProfileNode(
+    TraceEventProfileChunk::CPUProfile::Node&& node) {
+  folly::dynamic dynamicNode = folly::dynamic::object();
+
+  dynamicNode["callFrame"] =
+      serializeProfileChunkCPUProfileNodeCallFrame(std::move(node.callFrame));
+  dynamicNode["id"] = node.id;
+  if (node.parentId.has_value()) {
+    dynamicNode["parent"] = node.parentId.value();
+  }
+
+  return dynamicNode;
+}
+
+/* static */ folly::dynamic
+TraceEventSerializer::serializeProfileChunkCPUProfileNodeCallFrame(
+    TraceEventProfileChunk::CPUProfile::Node::CallFrame&& callFrame) {
+  folly::dynamic dynamicCallFrame = folly::dynamic::object();
+  dynamicCallFrame["codeType"] = std::move(callFrame.codeType);
+  dynamicCallFrame["scriptId"] = callFrame.scriptId;
+  dynamicCallFrame["functionName"] = std::move(callFrame.functionName);
+  if (callFrame.url.has_value()) {
+    dynamicCallFrame["url"] = std::move(callFrame.url.value());
+  }
+  if (callFrame.lineNumber.has_value()) {
+    dynamicCallFrame["lineNumber"] = callFrame.lineNumber.value();
+  }
+  if (callFrame.columnNumber.has_value()) {
+    dynamicCallFrame["columnNumber"] = callFrame.columnNumber.value();
+  }
+
+  return dynamicCallFrame;
+}
+
 } // namespace facebook::react::jsinspector_modern::tracing

packages/react-native/ReactCommon/jsinspector-modern/tracing/TraceEventSerializer.h

@@ -8,6 +8,7 @@
 #pragma once
 
 #include "TraceEvent.h"
+#include "TraceEventProfile.h"
 
 #include <folly/dynamic.h>
 
@@ -28,6 +29,65 @@ class TraceEventSerializer {
    * Trace Event for CDP.
    */
   static folly::dynamic serialize(TraceEvent&& event);
+
+  /**
+   * Serialize a TraceEventProfileChunk to a folly::dynamic object.
+   *
+   * \param profileChunk rvalue reference to the TraceEventProfileChunk object.
+   * \return A folly::dynamic object that represents a serialized into JSON
+   * "ProfileChunk" Trace Event for CDP.
+   */
+  static folly::dynamic serializeProfileChunk(
+      TraceEventProfileChunk&& profileChunk);
+
+  /**
+   * Serialize a TraceEventProfileChunk::TimeDeltas to a folly::dynamic
+   * object.
+   *
+   * \param deltas rvalue reference to the TraceEventProfileChunk::TimeDeltas
+   * object.
+   * \return A folly::dynamic object that represents a serialized "timeDeltas"
+   * property of "ProfileChunk" Trace Event for CDP.
+   */
+  static folly::dynamic serializeProfileChunkTimeDeltas(
+      TraceEventProfileChunk::TimeDeltas&& deltas);
+
+  /**
+   * Serialize a TraceEventProfileChunk::CPUProfile into a folly::dynamic
+   * object.
+   *
+   * \param cpuProfile rvalue reference to the
+   * TraceEventProfileChunk::CPUProfile object.
+   * \return A folly::dynamic object that represents a serialized "cpuProfile"
+   * property of "ProfileChunk" Trace Event for CDP.
+   */
+  static folly::dynamic serializeProfileChunkCPUProfile(
+      TraceEventProfileChunk::CPUProfile&& cpuProfile);
+
+  /**
+   * Serialize a TraceEventProfileChunk::CPUProfile::Node into a folly::dynamic
+   * object.
+   *
+   * \param node rvalue reference to the
+   * TraceEventProfileChunk::CPUProfile::Node object.
+   * \return A folly::dynamic object that represents a serialized
+   * "cpuProfile.nodes[i]" property of "ProfileChunk" Trace Event for CDP.
+   */
+  static folly::dynamic serializeProfileChunkCPUProfileNode(
+      TraceEventProfileChunk::CPUProfile::Node&& node);
+
+  /**
+   * Serialize a TraceEventProfileChunk::CPUProfile::Node::CallFrame into a
+   * folly::dynamic object.
+   *
+   * \param callFrame rvalue reference to the
+   * TraceEventProfileChunk::CPUProfile::Node::CallFrame object.
+   * \return A folly::dynamic object that represents a serialized
+   * "cpuProfile.nodes[i].callFrame" property of "ProfileChunk" Trace Event for
+   * CDP.
+   */
+  static folly::dynamic serializeProfileChunkCPUProfileNodeCallFrame(
+      TraceEventProfileChunk::CPUProfile::Node::CallFrame&& callFrame);
 };
 
 } // namespace facebook::react::jsinspector_modern::tracing