refactor: emit the trace recoding on ReactNativeApplication domain initialization (#53760)

Summary:
Pull Request resolved: #53760

# Changelog: [Internal]

This is a different approach from the one that I've introduced initially in [1].

This saves us from the scenario, where any local session could snatch the stashed trace recording. For example, if some session was created for a Runtime binding right after we've stashed the trace and before initializing real CDP session with the Frontend.

Reviewed By: huntie

Differential Revision: D82316584

fbshipit-source-id: 806a0f6dbdb4e4e928ce33af228cae86d43772e9

Author: hoxyq

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

@@ -41,18 +41,14 @@ class HostAgent::Impl final {
       HostTargetController& targetController,
       HostTargetMetadata hostMetadata,
       SessionState& sessionState,
-      VoidExecutor executor,
-      std::optional<tracing::TraceRecordingState> traceRecordingToEmit)
+      VoidExecutor executor)
       : frontendChannel_(frontendChannel),
         targetController_(targetController),
         hostMetadata_(std::move(hostMetadata)),
         sessionState_(sessionState),
         networkIOAgent_(NetworkIOAgent(frontendChannel, std::move(executor))),
-        tracingAgent_(TracingAgent(
-            frontendChannel,
-            sessionState,
-            targetController,
-            std::move(traceRecordingToEmit))) {}
+        tracingAgent_(
+            TracingAgent(frontendChannel, sessionState, targetController)) {}
 
   ~Impl() {
     if (isPausedInDebuggerOverlayVisible_) {
@@ -201,6 +197,14 @@ class HostAgent::Impl final {
           "ReactNativeApplication.metadataUpdated",
           createHostMetadataPayload(hostMetadata_)));
 
+      auto stashedTraceRecording =
+          targetController_.getDelegate()
+              .unstable_getTraceRecordingThatWillBeEmittedOnInitialization();
+      if (stashedTraceRecording.has_value()) {
+        tracingAgent_.emitExternalTraceRecording(
+            std::move(stashedTraceRecording.value()));
+      }
+
       return {
           .isFinishedHandlingRequest = true,
           .shouldSendOKResponse = true,
@@ -432,8 +436,7 @@ class HostAgent::Impl final {
       HostTargetController& targetController,
       HostTargetMetadata hostMetadata,
       SessionState& sessionState,
-      VoidExecutor executor,
-      std::optional<tracing::TraceRecordingState> traceRecordingToEmit) {}
+      VoidExecutor executor) {}
 
   void handleRequest(const cdp::PreparsedRequest& req) {}
   void setCurrentInstanceAgent(std::shared_ptr<InstanceAgent> agent) {}
@@ -446,16 +449,14 @@ HostAgent::HostAgent(
     HostTargetController& targetController,
     HostTargetMetadata hostMetadata,
     SessionState& sessionState,
-    VoidExecutor executor,
-    std::optional<tracing::TraceRecordingState> traceRecordingToEmit)
+    VoidExecutor executor)
     : impl_(std::make_unique<Impl>(
           *this,
           frontendChannel,
           targetController,
           std::move(hostMetadata),
           sessionState,
-          std::move(executor),
-          std::move(traceRecordingToEmit))) {}
+          std::move(executor))) {}
 
 HostAgent::~HostAgent() = default;
 

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

@@ -36,16 +36,13 @@ class HostAgent final {
    * \param hostMetadata Metadata about the host that created this agent.
    * \param sessionState The state of the session that created this agent.
    * \param executor A void executor to be used by async-aware handlers.
-   * \param traceRecordingToEmit If set, this is the trace that Host has
-   * requested to display in the Frontend.
    */
   HostAgent(
       const FrontendChannel& frontendChannel,
       HostTargetController& targetController,
       HostTargetMetadata hostMetadata,
       SessionState& sessionState,
-      VoidExecutor executor,
-      std::optional<tracing::TraceRecordingState> traceRecordingToEmit);
+      VoidExecutor executor);
 
   HostAgent(const HostAgent&) = delete;
   HostAgent(HostAgent&&) = delete;

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

@@ -34,8 +34,7 @@ class HostTargetSession {
       std::unique_ptr<IRemoteConnection> remote,
       HostTargetController& targetController,
       HostTargetMetadata hostMetadata,
-      VoidExecutor executor,
-      std::optional<tracing::TraceRecordingState> traceRecordingToEmit)
+      VoidExecutor executor)
       : remote_(std::make_shared<RAIIRemoteConnection>(std::move(remote))),
         frontendChannel_(
             [remoteWeak = std::weak_ptr(remote_)](std::string_view message) {
@@ -48,8 +47,7 @@ class HostTargetSession {
             targetController,
             std::move(hostMetadata),
             state_,
-            std::move(executor),
-            std::move(traceRecordingToEmit)) {}
+            std::move(executor)) {}
 
   /**
    * Called by CallbackLocalConnection to send a message to this Session's
@@ -205,8 +203,7 @@ std::unique_ptr<ILocalConnection> HostTarget::connect(
       std::move(connectionToFrontend),
       controller_,
       delegate_.getMetadata(),
-      makeVoidExecutor(executorFromThis()),
-      delegate_.unstable_getTraceRecordingThatWillBeEmittedOnInitialization());
+      makeVoidExecutor(executorFromThis()));
   session->setCurrentInstance(currentInstance_.get());
   sessions_.insert(std::weak_ptr(session));
   return std::make_unique<CallbackLocalConnection>(

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

@@ -38,17 +38,10 @@ const uint16_t PROFILE_TRACE_EVENT_CHUNK_SIZE = 1;
 TracingAgent::TracingAgent(
     FrontendChannel frontendChannel,
     SessionState& sessionState,
-    HostTargetController& hostTargetController,
-    std::optional<tracing::TraceRecordingState> traceRecordingToEmit)
+    HostTargetController& hostTargetController)
     : frontendChannel_(std::move(frontendChannel)),
       sessionState_(sessionState),
-      hostTargetController_(hostTargetController) {
-  if (traceRecordingToEmit.has_value()) {
-    frontendChannel_(
-        cdp::jsonNotification("ReactNativeApplication.traceRequested"));
-    emitTraceRecording(std::move(traceRecordingToEmit.value()));
-  }
-}
+      hostTargetController_(hostTargetController) {}
 
 TracingAgent::~TracingAgent() {
   // Agents are owned by the session. If the agent is destroyed, it means that
@@ -100,15 +93,22 @@ bool TracingAgent::handleRequest(const cdp::PreparsedRequest& req) {
   return false;
 }
 
+void TracingAgent::emitExternalTraceRecording(
+    tracing::TraceRecordingState traceRecording) const {
+  frontendChannel_(
+      cdp::jsonNotification("ReactNativeApplication.traceRequested"));
+  emitTraceRecording(std::move(traceRecording));
+}
+
 void TracingAgent::emitTraceRecording(
-    tracing::TraceRecordingState state) const {
+    tracing::TraceRecordingState traceRecording) const {
   auto dataCollectedCallback = [this](folly::dynamic&& eventsChunk) {
     frontendChannel_(cdp::jsonNotification(
         "Tracing.dataCollected",
         folly::dynamic::object("value", std::move(eventsChunk))));
   };
   tracing::TraceRecordingStateSerializer::emitAsDataCollectedChunks(
-      std::move(state),
+      std::move(traceRecording),
       dataCollectedCallback,
       TRACE_EVENT_CHUNK_SIZE,
       PROFILE_TRACE_EVENT_CHUNK_SIZE);

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

@@ -28,14 +28,11 @@ class TracingAgent {
    * \param hostTargetController An interface to the HostTarget that this agent
    * is attached to. The caller is responsible for ensuring that the
    * HostTargetDelegate and underlying HostTarget both outlive the agent.
-   * \param traceRecordingToEmit If set, this is the trace that Host has
-   * requested to display in the Frontend.
    */
   TracingAgent(
       FrontendChannel frontendChannel,
       SessionState& sessionState,
-      HostTargetController& hostTargetController,
-      std::optional<tracing::TraceRecordingState> traceRecordingToEmit);
+      HostTargetController& hostTargetController);
 
   ~TracingAgent();
 
@@ -46,6 +43,12 @@ class TracingAgent {
    */
   bool handleRequest(const cdp::PreparsedRequest& req);
 
+  /**
+   * Emits the Trace Recording that was stashed externally by the HostTarget.
+   */
+  void emitExternalTraceRecording(
+      tracing::TraceRecordingState traceRecording) const;
+
  private:
   /**
    * A channel used to send responses and events to the frontend.
@@ -60,7 +63,7 @@ class TracingAgent {
    * Emits the captured Trace Recording state in a series of
    * Tracing.dataCollected events, followed by a Tracing.tracingComplete event.
    */
-  void emitTraceRecording(tracing::TraceRecordingState state) const;
+  void emitTraceRecording(tracing::TraceRecordingState traceRecording) const;
 };
 
 } // namespace facebook::react::jsinspector_modern