Propagate tracing categories to recording state (#54380)

Summary:

# Changelog: [Internal]

We can now propagate down enabled categories to the state of trace recording.

Reviewed By: huntie

Differential Revision: D85996394

Author: hoxyq

packages/react-native/ReactAndroid/src/main/jni/react/runtime/jni/JReactHostInspectorTarget.cpp

@@ -146,7 +146,14 @@ HostTarget* JReactHostInspectorTarget::getInspectorTarget() {
 
 bool JReactHostInspectorTarget::startBackgroundTrace() {
   if (inspectorTarget_) {
-    return inspectorTarget_->startTracing(tracing::Mode::Background);
+    return inspectorTarget_->startTracing(
+        tracing::Mode::Background,
+        {
+            tracing::Category::HiddenTimeline,
+            tracing::Category::RuntimeExecution,
+            tracing::Category::Timeline,
+            tracing::Category::UserTiming,
+        });
   } else {
     jni::throwNewJavaException(
         "java/lang/IllegalStateException",

packages/react-native/ReactCommon/jsinspector-modern/HostTarget.h

@@ -17,8 +17,10 @@
 #include "WeakList.h"
 
 #include <optional>
+#include <set>
 #include <string>
 
+#include <jsinspector-modern/tracing/TracingCategory.h>
 #include <jsinspector-modern/tracing/TracingMode.h>
 #include <jsinspector-modern/tracing/TracingState.h>
 
@@ -203,9 +205,11 @@ class HostTargetController final {
    * Starts trace recording for this HostTarget.
    *
    * \param mode In which mode to start the trace recording.
+   * \param enabledCategories The set of categories to enable.
+   *
    * \return false if already tracing, true otherwise.
    */
-  bool startTracing(tracing::Mode mode);
+  bool startTracing(tracing::Mode mode, std::set<tracing::Category> enabledCategories);
 
   /**
    * Stops previously started trace recording.
@@ -292,9 +296,11 @@ class JSINSPECTOR_EXPORT HostTarget : public EnableExecutorFromThis<HostTarget>
    * Starts trace recording for this HostTarget.
    *
    * \param mode In which mode to start the trace recording.
+   * \param enabledCategories The set of categories to enable.
+   *
    * \return false if already tracing, true otherwise.
    */
-  bool startTracing(tracing::Mode mode);
+  bool startTracing(tracing::Mode mode, std::set<tracing::Category> enabledCategories);
 
   /**
    * Stops previously started trace recording.

packages/react-native/ReactCommon/jsinspector-modern/HostTargetTraceRecording.cpp

@@ -11,9 +11,12 @@
 namespace facebook::react::jsinspector_modern {
 
 HostTargetTraceRecording::HostTargetTraceRecording(
+    HostTarget& hostTarget,
     tracing::Mode tracingMode,
-    HostTarget& hostTarget)
-    : tracingMode_(tracingMode), hostTarget_(hostTarget) {}
+    std::set<tracing::Category> enabledCategories)
+    : hostTarget_(hostTarget),
+      tracingMode_(tracingMode),
+      enabledCategories_(std::move(enabledCategories)) {}
 
 void HostTargetTraceRecording::setTracedInstance(
     InstanceTarget* instanceTarget) {
@@ -32,6 +35,7 @@ void HostTargetTraceRecording::start() {
   state_ = tracing::TraceRecordingState{
       .mode = tracingMode_,
       .startTime = HighResTimeStamp::now(),
+      .enabledCategories = enabledCategories_,
   };
   hostTracingAgent_ = hostTarget_.createTracingAgent(*state_);
 }

packages/react-native/ReactCommon/jsinspector-modern/HostTargetTraceRecording.h

@@ -12,8 +12,10 @@
 #include "InstanceTarget.h"
 
 #include <jsinspector-modern/tracing/TraceRecordingState.h>
+#include <jsinspector-modern/tracing/TracingCategory.h>
 
 #include <optional>
+#include <set>
 
 namespace facebook::react::jsinspector_modern {
 
@@ -28,7 +30,10 @@ namespace facebook::react::jsinspector_modern {
  */
 class HostTargetTraceRecording {
  public:
-  explicit HostTargetTraceRecording(tracing::Mode tracingMode, HostTarget &hostTarget);
+  explicit HostTargetTraceRecording(
+      HostTarget &hostTarget,
+      tracing::Mode tracingMode,
+      std::set<tracing::Category> enabledCategories);
 
   inline bool isBackgroundInitiated() const
   {
@@ -61,14 +66,14 @@ class HostTargetTraceRecording {
 
  private:
   /**
-   * The mode in which this trace recording was initialized.
+   * The Host for which this Trace Recording is going to happen.
    */
-  tracing::Mode tracingMode_;
+  HostTarget &hostTarget_;
 
   /**
-   * The Host for which this Trace Recording is going to happen.
+   * The mode in which this trace recording was initialized.
    */
-  HostTarget &hostTarget_;
+  tracing::Mode tracingMode_;
 
   /**
    * The state of the current Trace Recording.
@@ -81,6 +86,11 @@ class HostTargetTraceRecording {
    * Only allocated if the recording is enabled.
    */
   std::shared_ptr<HostTracingAgent> hostTracingAgent_;
+
+  /**
+   * The list of categories that are enabled for this recording.
+   */
+  std::set<tracing::Category> enabledCategories_;
 };
 
 } // namespace facebook::react::jsinspector_modern

packages/react-native/ReactCommon/jsinspector-modern/HostTargetTracing.cpp

@@ -12,8 +12,10 @@
 
 namespace facebook::react::jsinspector_modern {
 
-bool HostTargetController::startTracing(tracing::Mode tracingMode) {
-  return target_.startTracing(tracingMode);
+bool HostTargetController::startTracing(
+    tracing::Mode tracingMode,
+    std::set<tracing::Category> enabledCategories) {
+  return target_.startTracing(tracingMode, std::move(enabledCategories));
 }
 
 tracing::TraceRecordingState HostTargetController::stopTracing() {
@@ -27,7 +29,9 @@ std::shared_ptr<HostTracingAgent> HostTarget::createTracingAgent(
   return agent;
 }
 
-bool HostTarget::startTracing(tracing::Mode tracingMode) {
+bool HostTarget::startTracing(
+    tracing::Mode tracingMode,
+    std::set<tracing::Category> enabledCategories) {
   if (traceRecording_ != nullptr) {
     if (traceRecording_->isBackgroundInitiated() &&
         tracingMode == tracing::Mode::CDP) {
@@ -37,8 +41,8 @@ bool HostTarget::startTracing(tracing::Mode tracingMode) {
     }
   }
 
-  traceRecording_ =
-      std::make_unique<HostTargetTraceRecording>(tracingMode, *this);
+  traceRecording_ = std::make_unique<HostTargetTraceRecording>(
+      *this, tracingMode, std::move(enabledCategories));
   traceRecording_->setTracedInstance(currentInstance_.get());
   traceRecording_->start();
 

packages/react-native/ReactCommon/jsinspector-modern/TracingAgent.cpp

@@ -59,8 +59,25 @@ bool TracingAgent::handleRequest(const cdp::PreparsedRequest& req) {
       return true;
     }
 
-    bool didNotHaveAlreadyRunningRecording =
-        hostTargetController_.startTracing(tracing::Mode::CDP);
+    /**
+     * This logic has to be updated with the next upgrade of Chrome
+     * DevTools Frotnend fork.
+     *
+     * At the moment of writing this, our fork uses categories field, which is
+     * marked as depreacted in CDP spec.
+     *
+     * Latest versions of Chrome DevTools in stable channel of Chromium are
+     * already using traceConfig field.
+     */
+    std::set<tracing::Category> enabledCategories;
+    if (req.params.isObject() && req.params.count("categories") != 0 &&
+        req.params["categories"].isString()) {
+      enabledCategories = tracing::parseSerializedTracingCategories(
+          req.params["categories"].getString());
+    }
+
+    bool didNotHaveAlreadyRunningRecording = hostTargetController_.startTracing(
+        tracing::Mode::CDP, std::move(enabledCategories));
     if (!didNotHaveAlreadyRunningRecording) {
       frontendChannel_(
           cdp::jsonError(

packages/react-native/ReactCommon/jsinspector-modern/tests/TracingTest.h

@@ -7,14 +7,16 @@
 
 #pragma once
 
+#include "FollyDynamicMatchers.h"
 #include "JsiIntegrationTest.h"
 
+#include <fmt/format.h>
 #include <folly/dynamic.h>
 #include <folly/json.h>
 #include <gmock/gmock.h>
-#include <vector>
 
-#include "FollyDynamicMatchers.h"
+#include <set>
+#include <vector>
 
 namespace facebook::react::jsinspector_modern {
 
@@ -29,17 +31,28 @@ class TracingTestBase : public JsiIntegrationPortableTestBase<EngineAdapter, Exe
   /**
    * Helper method to start tracing via Tracing.start CDP command.
    */
-  void startTracing()
+  void startTracing(
+      const std::set<tracing::Category> &enabledCategories = {
+          tracing::Category::HiddenTimeline,
+          tracing::Category::JavaScriptSampling,
+          tracing::Category::RuntimeExecution,
+          tracing::Category::Timeline,
+          tracing::Category::UserTiming,
+      })
   {
     this->expectMessageFromPage(JsonEq(R"({
                                           "id": 1,
                                           "result": {}
                                         })"));
 
-    this->toPage_->sendMessage(R"({
-                                  "id": 1,
-                                  "method": "Tracing.start"
-                                })");
+    this->toPage_->sendMessage(
+        fmt::format(
+            R"({{
+              "id": 1,
+              "method": "Tracing.start",
+              "params": {{ "categories": "{0}" }}
+            }})",
+            tracing::serializeTracingCategories(enabledCategories)));
   }
 
   /**

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

@@ -34,6 +34,9 @@ struct TraceRecordingState {
 
   // 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;
 };
 
 } // namespace facebook::react::jsinspector_modern::tracing