react-native 0.83.3 → 0.83.5

package/ReactCommon/jsinspector-modern/InspectorFlags.cpp

@@ -21,6 +21,14 @@ bool InspectorFlags::getAssertSingleHostState() const {
   return loadFlagsAndAssertUnchanged().assertSingleHostState;
 }
 
+bool InspectorFlags::getScreenshotCaptureEnabled() const {
+  return loadFlagsAndAssertUnchanged().screenshotCaptureEnabled;
+}
+
+bool InspectorFlags::getFrameRecordingEnabled() const {
+  return loadFlagsAndAssertUnchanged().frameRecordingEnabled;
+}
+
 bool InspectorFlags::getFuseboxEnabled() const {
   if (fuseboxDisabledForTest_) {
     return false;
@@ -54,6 +62,10 @@ const InspectorFlags::Values& InspectorFlags::loadFlagsAndAssertUnchanged()
   InspectorFlags::Values newValues = {
       .assertSingleHostState =
           ReactNativeFeatureFlags::fuseboxAssertSingleHostState(),
+      .screenshotCaptureEnabled =
+          ReactNativeFeatureFlags::fuseboxScreenshotCaptureEnabled(),
+      .frameRecordingEnabled =
+          ReactNativeFeatureFlags::fuseboxFrameRecordingEnabled(),
       .fuseboxEnabled =
 #if defined(REACT_NATIVE_DEBUGGER_ENABLED)
           true,

package/ReactCommon/jsinspector-modern/InspectorFlags.h

@@ -36,6 +36,16 @@ class InspectorFlags {
    */
   bool getIsProfilingBuild() const;
 
+  /**
+   * Flag determining if Page.captureScreenshot CDP method is enabled.
+   */
+  bool getScreenshotCaptureEnabled() const;
+
+  /**
+   * Flag determining if frame recording (timings + screenshots) is enabled.
+   */
+  bool getFrameRecordingEnabled() const;
+
   /**
    * Flag determining if network inspection is enabled.
    */
@@ -61,6 +71,8 @@ class InspectorFlags {
  private:
   struct Values {
     bool assertSingleHostState;
+    bool screenshotCaptureEnabled;
+    bool frameRecordingEnabled;
     bool fuseboxEnabled;
     bool isProfilingBuild;
     bool networkInspectionEnabled;

package/ReactCommon/jsinspector-modern/InspectorInterfaces.cpp

@@ -143,13 +143,9 @@ int InspectorImpl::addPage(
       pageId,
       Page{pageId, description, vm, std::move(connectFunc), capabilities});
 
-  // Strong assumption: If prefersFuseboxFrontend is set, the page added is a
-  // HostTarget and not a legacy Hermes runtime target.
-  if (capabilities.prefersFuseboxFrontend) {
-    for (const auto& listenerWeak : listeners_) {
-      if (auto listener = listenerWeak.lock()) {
-        listener->unstable_onHostTargetAdded();
-      }
+  for (const auto& listenerWeak : listeners_) {
+    if (auto listener = listenerWeak.lock()) {
+      listener->unstable_onHostTargetAdded();
     }
   }
 

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/NetworkIOAgent.cpp

@@ -8,10 +8,10 @@
 #include "NetworkIOAgent.h"
 #include "InspectorFlags.h"
 
-#include "Base64.h"
 #include "Utf8.h"
 
 #include <jsinspector-modern/network/NetworkHandler.h>
+#include <react/utils/Base64.h>
 
 #include <sstream>
 #include <tuple>

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 {
@@ -74,8 +74,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 +108,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

package/ReactCommon/jsinspector-modern/tests/HostTargetTest.cpp

@@ -1526,4 +1526,69 @@ TEST_F(HostTargetTest, IOReadSizeValidation) {
       })");
 }
 
+TEST_F(HostTargetTest, TracingDelegateIsNotifiedOnCDPRequest) {
+  connect();
+  InSequence s;
+
+  EXPECT_CALL(
+      hostTargetDelegate_.getTracingDelegateMock(),
+      onTracingStarted(Eq(tracing::Mode::CDP), Eq(false)))
+      .Times(1)
+      .RetiresOnSaturation();
+  EXPECT_CALL(fromPage(), onMessage(JsonEq(R"({
+                                               "id": 1,
+                                               "result": {}
+                                             })")));
+  toPage_->sendMessage(R"({
+                        "id": 1,
+                        "method": "Tracing.start"
+                      })");
+
+  EXPECT_CALL(hostTargetDelegate_.getTracingDelegateMock(), onTracingStopped())
+      .Times(1)
+      .RetiresOnSaturation();
+  EXPECT_CALL(fromPage(), onMessage(JsonEq(R"({
+                                               "id": 1,
+                                               "result": {}
+                                             })")));
+  EXPECT_CALL(
+      fromPage(),
+      onMessage(JsonParsed(
+          testing::AllOf(
+              AtJsonPtr("/method", "Tracing.tracingComplete"),
+              AtJsonPtr("/params/dataLossOccurred", false)))));
+  toPage_->sendMessage(R"({
+                        "id": 1,
+                        "method": "Tracing.end"
+                      })");
+}
+
+TEST_F(HostTargetTest, TracingDelegateIsNotifiedOnDirectTracingCall) {
+  connect();
+
+  EXPECT_CALL(
+      hostTargetDelegate_.getTracingDelegateMock(),
+      onTracingStarted(Eq(tracing::Mode::Background), Eq(false)))
+      .Times(1)
+      .RetiresOnSaturation();
+  page_->startTracing(tracing::Mode::Background, {});
+
+  EXPECT_CALL(hostTargetDelegate_.getTracingDelegateMock(), onTracingStopped())
+      .Times(1)
+      .RetiresOnSaturation();
+  page_->stopTracing();
+}
+
+TEST_F(HostTargetProtocolTest, CaptureScreenshotNotSupportedWhenFlagDisabled) {
+  EXPECT_CALL(
+      fromPage(),
+      onMessage(JsonParsed(AllOf(
+          AtJsonPtr("/error/code", Eq(-32601)), AtJsonPtr("/id", Eq(1))))))
+      .RetiresOnSaturation();
+  toPage_->sendMessage(R"({
+                           "id": 1,
+                           "method": "Page.captureScreenshot"
+                         })");
+}
+
 } // namespace facebook::react::jsinspector_modern

package/ReactCommon/jsinspector-modern/tests/InspectorMocks.h

@@ -87,13 +87,13 @@ class MockInspectorPackagerConnectionDelegate : public InspectorPackagerConnecti
   explicit MockInspectorPackagerConnectionDelegate(folly::Executor &executor) : executor_(executor)
   {
     using namespace testing;
-    ON_CALL(*this, scheduleCallback(_, _)).WillByDefault(Invoke<>([this](auto callback, auto delay) {
+    ON_CALL(*this, scheduleCallback(_, _)).WillByDefault([this](auto callback, auto delay) {
       if (auto scheduledExecutor = dynamic_cast<folly::ScheduledExecutor *>(&executor_)) {
         scheduledExecutor->scheduleAt(callback, scheduledExecutor->now() + delay);
       } else {
         executor_.add(callback);
       }
-    }));
+    });
     EXPECT_CALL(*this, scheduleCallback(_, _)).Times(AnyNumber());
   }
 
@@ -113,6 +113,12 @@ class MockInspectorPackagerConnectionDelegate : public InspectorPackagerConnecti
   folly::Executor &executor_;
 };
 
+class MockHostTargetTracingDelegate : public HostTargetTracingDelegate {
+ public:
+  MOCK_METHOD(void, onTracingStarted, (tracing::Mode tracingMode, bool screenshotsCategoryEnabled), (override));
+  MOCK_METHOD(void, onTracingStopped, (), (override));
+};
+
 class MockHostTargetDelegate : public HostTargetDelegate {
  public:
   // HostTargetDelegate methods
@@ -131,6 +137,21 @@ class MockHostTargetDelegate : public HostTargetDelegate {
       loadNetworkResource,
       (const LoadNetworkResourceRequest &params, ScopedExecutor<NetworkRequestListener> executor),
       (override));
+  MOCK_METHOD(std::optional<std::string>, captureScreenshot, (const PageCaptureScreenshotRequest &request), (override));
+
+  HostTargetTracingDelegate *getTracingDelegate() override
+  {
+    return mockTracingDelegate_.get();
+  }
+
+  MockHostTargetTracingDelegate &getTracingDelegateMock()
+  {
+    return *mockTracingDelegate_;
+  }
+
+ private:
+  std::unique_ptr<MockHostTargetTracingDelegate> mockTracingDelegate_ =
+      std::make_unique<MockHostTargetTracingDelegate>();
 };
 
 class MockInstanceTargetDelegate : public InstanceTargetDelegate {};

package/ReactCommon/jsinspector-modern/tests/JsiIntegrationTest.cpp

@@ -358,6 +358,7 @@ TYPED_TEST(JsiIntegrationPortableTest, ReactNativeApplicationEnable) {
                                           "method": "ReactNativeApplication.metadataUpdated",
                                           "params": {
                                             "integrationName": "JsiIntegrationTest",
+                                            "unstable_frameRecordingEnabled": false,
                                             "unstable_isProfilingBuild": false,
                                             "unstable_networkInspectionEnabled": false
                                           }

package/ReactCommon/jsinspector-modern/tests/NetworkReporterTest.cpp

@@ -42,6 +42,7 @@ class NetworkReporterTestBase : public JsiIntegrationPortableTestBase<
             .enableNetworkEventReporting =
                 WithParamInterface<Params>::GetParam()
                     .enableNetworkEventReporting,
+            .networkInspectionEnabled = true,
         }) {}
 
   void SetUp() override {