react-native-tvos 0.83.2-0 → 0.84.0-0

package/ReactCommon/jsinspector-modern/HostTargetTracing.cpp

@@ -5,18 +5,27 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-#include <jsinspector-modern/tracing/TracingState.h>
-
 #include "HostTarget.h"
 #include "HostTargetTraceRecording.h"
 
 namespace facebook::react::jsinspector_modern {
 
-bool HostTargetController::startTracing(tracing::Mode tracingMode) {
-  return target_.startTracing(tracingMode);
+namespace {
+
+// The size of the timeline for the trace recording that happened in the
+// background.
+constexpr HighResDuration kBackgroundTraceWindowSize =
+    HighResDuration::fromMilliseconds(20000);
+
+} // namespace
+
+bool HostTargetController::startTracing(
+    tracing::Mode tracingMode,
+    std::set<tracing::Category> enabledCategories) {
+  return target_.startTracing(tracingMode, std::move(enabledCategories));
 }
 
-tracing::TraceRecordingState HostTargetController::stopTracing() {
+tracing::HostTracingProfile HostTargetController::stopTracing() {
   return target_.stopTracing();
 }
 
@@ -27,45 +36,69 @@ 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) {
+  std::lock_guard lock(tracingMutex_);
+
   if (traceRecording_ != nullptr) {
     if (traceRecording_->isBackgroundInitiated() &&
         tracingMode == tracing::Mode::CDP) {
+      if (auto tracingDelegate = delegate_.getTracingDelegate()) {
+        tracingDelegate->onTracingStopped();
+      }
+
+      traceRecording_->stop();
       traceRecording_.reset();
     } else {
       return false;
     }
   }
 
-  traceRecording_ =
-      std::make_unique<HostTargetTraceRecording>(tracingMode, *this);
+  auto timeWindow = tracingMode == tracing::Mode::Background
+      ? std::make_optional(kBackgroundTraceWindowSize)
+      : std::nullopt;
+  auto screenshotsCategoryEnabled =
+      enabledCategories.contains(tracing::Category::Screenshot);
+
+  traceRecording_ = std::make_unique<HostTargetTraceRecording>(
+      *this, tracingMode, std::move(enabledCategories), timeWindow);
   traceRecording_->setTracedInstance(currentInstance_.get());
   traceRecording_->start();
 
+  if (auto tracingDelegate = delegate_.getTracingDelegate()) {
+    tracingDelegate->onTracingStarted(tracingMode, screenshotsCategoryEnabled);
+  }
+
   return true;
 }
 
-tracing::TraceRecordingState HostTarget::stopTracing() {
+tracing::HostTracingProfile HostTarget::stopTracing() {
+  std::lock_guard lock(tracingMutex_);
+
   assert(traceRecording_ != nullptr && "No tracing in progress");
 
-  auto state = traceRecording_->stop();
+  if (auto tracingDelegate = delegate_.getTracingDelegate()) {
+    tracingDelegate->onTracingStopped();
+  }
+
+  auto profile = traceRecording_->stop();
   traceRecording_.reset();
 
-  return state;
+  return profile;
 }
 
-tracing::TracingState HostTarget::tracingState() const {
-  if (traceRecording_ == nullptr) {
-    return tracing::TracingState::Disabled;
-  }
+void HostTarget::recordFrameTimings(
+    tracing::FrameTimingSequence frameTimingSequence) {
+  std::lock_guard lock(tracingMutex_);
 
-  if (traceRecording_->isBackgroundInitiated()) {
-    return tracing::TracingState::EnabledInBackgroundMode;
+  if (traceRecording_) {
+    traceRecording_->recordFrameTimings(frameTimingSequence);
+  } else {
+    assert(
+        false &&
+        "The HostTarget is not being profiled. Did you call recordFrameTimings() from the native Host side when there is no tracing in progress?");
   }
-
-  // This means we have a traceRecording_, but not running in the background.
-  // CDP initiated this trace so we should report as disabled.
-  return tracing::TracingState::EnabledInCDPMode;
 }
 
 } // namespace facebook::react::jsinspector_modern

package/ReactCommon/jsinspector-modern/InstanceAgent.cpp

@@ -15,15 +15,6 @@
 
 namespace facebook::react::jsinspector_modern {
 
-namespace {
-
-// The size of the timeline for the trace recording that happened in the
-// background.
-constexpr HighResDuration kBackgroundTracePerformanceTracerWindowSize =
-    HighResDuration::fromMilliseconds(20000);
-
-} // namespace
-
 InstanceAgent::InstanceAgent(
     FrontendChannel frontendChannel,
     InstanceTarget& target,
@@ -171,8 +162,8 @@ void InstanceAgent::maybeSendPendingConsoleMessages() {
 InstanceTracingAgent::InstanceTracingAgent(tracing::TraceRecordingState& state)
     : tracing::TargetTracingAgent(state) {
   auto& performanceTracer = tracing::PerformanceTracer::getInstance();
-  if (state.mode == tracing::Mode::Background) {
-    performanceTracer.startTracing(kBackgroundTracePerformanceTracerWindowSize);
+  if (state.windowSize) {
+    performanceTracer.startTracing(*state.windowSize);
   } else {
     performanceTracer.startTracing();
   }

package/ReactCommon/jsinspector-modern/InstanceTarget.h

@@ -34,9 +34,9 @@ class InstanceTargetDelegate {
  public:
   InstanceTargetDelegate() = default;
   InstanceTargetDelegate(const InstanceTargetDelegate &) = delete;
-  InstanceTargetDelegate(InstanceTargetDelegate &&) = default;
+  InstanceTargetDelegate(InstanceTargetDelegate &&) = delete;
   InstanceTargetDelegate &operator=(const InstanceTargetDelegate &) = delete;
-  InstanceTargetDelegate &operator=(InstanceTargetDelegate &&) = default;
+  InstanceTargetDelegate &operator=(InstanceTargetDelegate &&) = delete;
 
   virtual ~InstanceTargetDelegate();
 };

package/ReactCommon/jsinspector-modern/PerfMonitorV2.cpp

@@ -21,7 +21,15 @@ void PerfMonitorUpdateHandler::handlePerfIssueAdded(
     delegate_.unstable_onPerfIssueAdded(
         PerfIssuePayload{
             .name = payload["name"].asString(),
-            .severity = payload["severity"].asString(),
+            .severity = payload["severity"].isNull()
+                ? std::nullopt
+                : std::make_optional(payload["severity"].asString()),
+            .description = payload["description"].isNull()
+                ? std::nullopt
+                : std::make_optional(payload["description"].asString()),
+            .learnMoreUrl = payload["learnMoreUrl"].isNull()
+                ? std::nullopt
+                : std::make_optional(payload["learnMoreUrl"].asString()),
         });
   }
 }

package/ReactCommon/jsinspector-modern/PerfMonitorV2.h

@@ -7,6 +7,7 @@
 
 #pragma once
 
+#include <optional>
 #include <string>
 
 namespace facebook::react::jsinspector_modern {
@@ -15,7 +16,9 @@ class HostTargetDelegate;
 
 struct PerfIssuePayload {
   std::string name;
-  std::string severity;
+  std::optional<std::string> severity;
+  std::optional<std::string> description;
+  std::optional<std::string> learnMoreUrl;
 };
 
 /**

package/ReactCommon/jsinspector-modern/RuntimeAgent.cpp

@@ -152,13 +152,14 @@ RuntimeTracingAgent::RuntimeTracingAgent(
     tracing::TraceRecordingState& state,
     RuntimeTargetController& targetController)
     : tracing::TargetTracingAgent(state), targetController_(targetController) {
-  if (state.mode == tracing::Mode::CDP) {
+  if (state.enabledCategories.contains(tracing::Category::JavaScriptSampling)) {
     targetController_.enableSamplingProfiler();
   }
 }
 
 RuntimeTracingAgent::~RuntimeTracingAgent() {
-  if (state_.mode == tracing::Mode::CDP) {
+  if (state_.enabledCategories.contains(
+          tracing::Category::JavaScriptSampling)) {
     targetController_.disableSamplingProfiler();
     auto profile = targetController_.collectSamplingProfile();
 

package/ReactCommon/jsinspector-modern/RuntimeAgent.h

@@ -99,7 +99,7 @@ class RuntimeAgent final {
  * Lifetime of this agent is bound to the lifetime of the Tracing session -
  * HostTargetTraceRecording and to the lifetime of the RuntimeTarget.
  */
-class RuntimeTracingAgent : tracing::TargetTracingAgent {
+class RuntimeTracingAgent : public tracing::TargetTracingAgent {
  public:
   explicit RuntimeTracingAgent(tracing::TraceRecordingState &state, RuntimeTargetController &targetController);
 

package/ReactCommon/jsinspector-modern/RuntimeTarget.cpp

@@ -248,6 +248,18 @@ bool RuntimeTarget::isDomainEnabled(Domain domain) const {
   return threadSafeDomainStatus_[domain];
 }
 
+bool RuntimeTarget::isConsoleCreateTaskEnabled() const {
+  if (isDomainEnabled(Domain::Runtime)) {
+    return true;
+  }
+
+  if (auto tracingAgent = tracingAgent_.lock()) {
+    return tracingAgent->isRunningInBackgroundMode();
+  }
+
+  return false;
+}
+
 RuntimeTargetController::RuntimeTargetController(RuntimeTarget& target)
     : target_(target) {}
 

package/ReactCommon/jsinspector-modern/RuntimeTarget.h

@@ -207,19 +207,6 @@ class JSINSPECTOR_EXPORT RuntimeTarget : public EnableExecutorFromThis<RuntimeTa
    */
   std::shared_ptr<RuntimeTracingAgent> createTracingAgent(tracing::TraceRecordingState &state);
 
-  /**
-   * Start sampling profiler for a particular JavaScript runtime.
-   */
-  void enableSamplingProfiler();
-  /**
-   * Stop sampling profiler for a particular JavaScript runtime.
-   */
-  void disableSamplingProfiler();
-  /**
-   * Return recorded sampling profile for the previous sampling session.
-   */
-  tracing::RuntimeSamplingProfile collectSamplingProfile();
-
  private:
   using Domain = RuntimeTargetController::Domain;
 
@@ -275,6 +262,18 @@ class JSINSPECTOR_EXPORT RuntimeTarget : public EnableExecutorFromThis<RuntimeTa
    * session - HostTargetTraceRecording.
    */
   std::weak_ptr<RuntimeTracingAgent> tracingAgent_;
+  /**
+   * Start sampling profiler for a particular JavaScript runtime.
+   */
+  void enableSamplingProfiler();
+  /**
+   * Stop sampling profiler for a particular JavaScript runtime.
+   */
+  void disableSamplingProfiler();
+  /**
+   * Return recorded sampling profile for the previous sampling session.
+   */
+  tracing::RuntimeSamplingProfile collectSamplingProfile();
 
   /**
    * Adds a function with the given name on the runtime's global object, that
@@ -293,6 +292,10 @@ class JSINSPECTOR_EXPORT RuntimeTarget : public EnableExecutorFromThis<RuntimeTa
    * Install the console API handler.
    */
   void installConsoleHandler();
+  /**
+   * Returns whether console.createTask should actually capture stack traces.
+   */
+  bool isConsoleCreateTaskEnabled() const;
 
   /**
    * Installs __DEBUGGER_SESSION_OBSERVER__ object on the JavaScript's global

package/ReactCommon/jsinspector-modern/RuntimeTargetConsole.cpp

@@ -5,6 +5,10 @@
  * LICENSE file in the root directory of this source tree.
  */
 
+#include "ConsoleTask.h"
+#include "ConsoleTaskContext.h"
+#include "ConsoleTaskOrchestrator.h"
+
 #include <jsinspector-modern/RuntimeTarget.h>
 #include <jsinspector-modern/tracing/PerformanceTracer.h>
 
@@ -477,8 +481,17 @@ void consoleTimeStamp(
   }
 
   if (performanceTracer.isTracing()) {
+    auto taskContext = ConsoleTaskOrchestrator::getInstance().top();
+
     performanceTracer.reportTimeStamp(
-        label, start, end, trackName, trackGroup, color, std::move(detail));
+        label,
+        start,
+        end,
+        trackName,
+        trackGroup,
+        color,
+        std::move(detail),
+        taskContext ? taskContext->getSerializedStackTrace() : nullptr);
   }
 
   if (ReactPerfettoLogger::isTracing()) {
@@ -521,6 +534,71 @@ void installConsoleTimeStamp(
               })));
 }
 
+/**
+ * run method of the task object returned from console.createTask().
+ */
+jsi::Value consoleTaskRun(
+    jsi::Runtime& runtime,
+    const jsi::Value* args,
+    size_t count,
+    std::shared_ptr<ConsoleTaskContext> taskContext) {
+  if (count < 1 || !args[0].isObject()) {
+    throw JSError(runtime, "First argument must be a function");
+  }
+  auto fnObj = args[0].getObject(runtime);
+  if (!fnObj.isFunction(runtime)) {
+    throw JSError(runtime, "First argument must be a function");
+  }
+
+  ConsoleTask consoleTask{taskContext};
+
+  auto fn = fnObj.getFunction(runtime);
+  return fn.call(runtime);
+}
+
+/**
+ * console.createTask. Non-standardized.
+ * https://developer.chrome.com/docs/devtools/console/api#createtask
+ */
+jsi::Value consoleCreateTask(
+    jsi::Runtime& runtime,
+    const jsi::Value* args,
+    size_t count,
+    RuntimeTargetDelegate& runtimeTargetDelegate,
+    bool enabled) {
+  if (count < 1 || !args[0].isString()) {
+    throw JSError(runtime, "First argument must be a non-empty string");
+  }
+  auto name = args[0].asString(runtime).utf8(runtime);
+  if (name.empty()) {
+    throw JSError(runtime, "First argument must be a non-empty string");
+  }
+
+  jsi::Object task{runtime};
+  std::shared_ptr<ConsoleTaskContext> taskContext = nullptr;
+  if (enabled) {
+    taskContext = std::make_shared<ConsoleTaskContext>(
+        runtime, runtimeTargetDelegate, name);
+    taskContext->schedule();
+  }
+
+  task.setProperty(
+      runtime,
+      "run",
+      jsi::Function::createFromHostFunction(
+          runtime,
+          jsi::PropNameID::forAscii(runtime, "run"),
+          0,
+          [taskContext](
+              jsi::Runtime& runtime,
+              const jsi::Value& /*thisVal*/,
+              const jsi::Value* args,
+              size_t count) {
+            return consoleTaskRun(runtime, args, count, taskContext);
+          }));
+  return task;
+}
+
 } // namespace
 
 void RuntimeTarget::installConsoleHandler() {
@@ -624,6 +702,33 @@ void RuntimeTarget::installConsoleHandler() {
      */
     installConsoleTimeStamp(runtime, originalConsole, console);
 
+    /**
+     * console.createTask
+     */
+    console.setProperty(
+        runtime,
+        "createTask",
+        jsi::Function::createFromHostFunction(
+            runtime,
+            jsi::PropNameID::forAscii(runtime, "createTask"),
+            0,
+            [state, selfWeak](
+                jsi::Runtime& runtime,
+                const jsi::Value& /*thisVal*/,
+                const jsi::Value* args,
+                size_t count) {
+              jsi::Value task;
+              tryExecuteSync(selfWeak, [&](auto& self) {
+                task = consoleCreateTask(
+                    runtime,
+                    args,
+                    count,
+                    self.delegate_,
+                    self.isConsoleCreateTaskEnabled());
+              });
+              return task;
+            }));
+
     // Install forwarding console methods.
 #define FORWARDING_CONSOLE_METHOD(name, type) \
   installConsoleMethod(#name, console_##name);

package/ReactCommon/jsinspector-modern/TracingAgent.cpp

@@ -7,10 +7,10 @@
 
 #include "TracingAgent.h"
 
+#include <jsinspector-modern/tracing/HostTracingProfileSerializer.h>
 #include <jsinspector-modern/tracing/PerformanceTracer.h>
 #include <jsinspector-modern/tracing/RuntimeSamplingProfileTraceEventSerializer.h>
 #include <jsinspector-modern/tracing/TraceEventSerializer.h>
-#include <jsinspector-modern/tracing/TraceRecordingStateSerializer.h>
 #include <jsinspector-modern/tracing/TracingMode.h>
 
 namespace facebook::react::jsinspector_modern {
@@ -26,12 +26,8 @@ const uint16_t TRACE_EVENT_CHUNK_SIZE = 1000;
 /**
  * The maximum number of ProfileChunk trace events
  * that will be sent in a single CDP Tracing.dataCollected message.
- * TODO(T219394401): Increase the size once we manage the queue on OkHTTP
- side
- * properly and avoid WebSocket disconnections when sending a message larger
- * than 16MB.
  */
-const uint16_t PROFILE_TRACE_EVENT_CHUNK_SIZE = 1;
+const uint16_t PROFILE_TRACE_EVENT_CHUNK_SIZE = 10;
 
 } // namespace
 
@@ -74,8 +70,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(
@@ -91,37 +104,36 @@ bool TracingAgent::handleRequest(const cdp::PreparsedRequest& req) {
 
     return true;
   } else if (req.method == "Tracing.end") {
-    // @cdp Tracing.end support is experimental.
-    auto state = hostTargetController_.stopTracing();
+    auto tracingProfile = hostTargetController_.stopTracing();
 
     sessionState_.hasPendingTraceRecording = false;
     // Send response to Tracing.end request.
     frontendChannel_(cdp::jsonResult(req.id));
 
-    emitTraceRecording(std::move(state));
+    emitHostTracingProfile(std::move(tracingProfile));
     return true;
   }
 
   return false;
 }
 
-void TracingAgent::emitExternalTraceRecording(
-    tracing::TraceRecordingState traceRecording) const {
+void TracingAgent::emitExternalHostTracingProfile(
+    tracing::HostTracingProfile tracingProfile) const {
   frontendChannel_(
       cdp::jsonNotification("ReactNativeApplication.traceRequested"));
-  emitTraceRecording(std::move(traceRecording));
+  emitHostTracingProfile(std::move(tracingProfile));
 }
 
-void TracingAgent::emitTraceRecording(
-    tracing::TraceRecordingState traceRecording) const {
+void TracingAgent::emitHostTracingProfile(
+    tracing::HostTracingProfile tracingProfile) const {
   auto dataCollectedCallback = [this](folly::dynamic&& eventsChunk) {
     frontendChannel_(
         cdp::jsonNotification(
             "Tracing.dataCollected",
             folly::dynamic::object("value", std::move(eventsChunk))));
   };
-  tracing::TraceRecordingStateSerializer::emitAsDataCollectedChunks(
-      std::move(traceRecording),
+  tracing::HostTracingProfileSerializer::emitAsDataCollectedChunks(
+      std::move(tracingProfile),
       dataCollectedCallback,
       TRACE_EVENT_CHUNK_SIZE,
       PROFILE_TRACE_EVENT_CHUNK_SIZE);

package/ReactCommon/jsinspector-modern/TracingAgent.h

@@ -11,6 +11,7 @@
 #include "InspectorInterfaces.h"
 
 #include <jsinspector-modern/cdp/CdpJson.h>
+#include <jsinspector-modern/tracing/HostTracingProfile.h>
 #include <jsinspector-modern/tracing/Timing.h>
 #include <react/timing/primitives.h>
 
@@ -41,9 +42,9 @@ class TracingAgent {
   bool handleRequest(const cdp::PreparsedRequest &req);
 
   /**
-   * Emits the Trace Recording that was stashed externally by the HostTarget.
+   * Emits the HostTracingProfile that was stashed externally by the HostTarget.
    */
-  void emitExternalTraceRecording(tracing::TraceRecordingState traceRecording) const;
+  void emitExternalHostTracingProfile(tracing::HostTracingProfile tracingProfile) const;
 
  private:
   /**
@@ -56,10 +57,10 @@ class TracingAgent {
   HostTargetController &hostTargetController_;
 
   /**
-   * Emits the captured Trace Recording state in a series of
+   * Emits captured HostTracingProfile in a series of
    * Tracing.dataCollected events, followed by a Tracing.tracingComplete event.
    */
-  void emitTraceRecording(tracing::TraceRecordingState traceRecording) const;
+  void emitHostTracingProfile(tracing::HostTracingProfile tracingProfile) const;
 };
 
 } // namespace facebook::react::jsinspector_modern