react-native-tvos 0.73.7-1 → 0.74.0-0

package/ReactCommon/jsinspector-modern/ScopedExecutor.h

@@ -0,0 +1,97 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#pragma once
+
+#include <cassert>
+#include <functional>
+#include <memory>
+
+namespace facebook::react::jsinspector_modern {
+
+/**
+ * Takes a function and calls it when it is safe to access the Self&
+ * parameter without locking. The function is not called if
+ * the underlying Self object is destroyed while the function is pending.
+ */
+template <typename Self>
+using ScopedExecutor =
+    std::function<void(std::function<void(Self& self)>&& callback)>;
+
+using VoidExecutor = std::function<void(std::function<void()>&& callback)>;
+
+/**
+ * Creates a ScopedExecutor<Self> from a shared (weak) pointer to Self plus some
+ * base executor for a "parent" object of Self. The resulting executor will call
+ * the callback with a valid reference to Self iff Self is still alive.
+ */
+template <typename Self, typename Parent>
+ScopedExecutor<Self> makeScopedExecutor(
+    std::shared_ptr<Self> self,
+    ScopedExecutor<Parent> executor) {
+  return makeScopedExecutor(self, makeVoidExecutor(executor));
+}
+
+/**
+ * Creates a ScopedExecutor<Self> from a shared (weak) pointer to Self plus some
+ * base executor. The resulting executor will call the callback with a valid
+ * reference to Self iff Self is still alive.
+ */
+template <typename Self>
+ScopedExecutor<Self> makeScopedExecutor(
+    std::shared_ptr<Self> self,
+    VoidExecutor executor) {
+  return [self = std::weak_ptr(self), executor](auto&& callback) {
+    executor([self, callback = std::move(callback)]() {
+      auto lockedSelf = self.lock();
+      if (!lockedSelf) {
+        return;
+      }
+      callback(*lockedSelf);
+    });
+  };
+}
+
+/**
+ * Creates a VoidExecutor from a ScopedExecutor<Self> by ignoring the Self&
+ * parameter.
+ */
+template <typename Self>
+VoidExecutor makeVoidExecutor(ScopedExecutor<Self> executor) {
+  return [executor](auto&& callback) {
+    executor([callback = std::move(callback)](Self&) { callback(); });
+  };
+}
+
+template <typename Self>
+class EnableExecutorFromThis : public std::enable_shared_from_this<Self> {
+ public:
+  /**
+   * Returns an executor that can be used to safely invoke methods on Self.
+   * Must not be called during the constructor of Self.
+   */
+  ScopedExecutor<Self> executorFromThis() {
+    assert(baseExecutor_);
+    return makeScopedExecutor(this->shared_from_this(), baseExecutor_);
+  }
+
+  template <typename Other>
+  void setExecutor(ScopedExecutor<Other> executor) {
+    setExecutor(makeVoidExecutor(executor));
+  }
+
+  void setExecutor(VoidExecutor executor) {
+    assert(executor);
+    assert(!baseExecutor_);
+    baseExecutor_ = std::move(executor);
+  }
+
+ private:
+  VoidExecutor baseExecutor_;
+};
+
+}; // namespace facebook::react::jsinspector_modern

package/ReactCommon/jsinspector-modern/SessionState.h

@@ -0,0 +1,51 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#pragma once
+
+#include "ExecutionContext.h"
+#include "RuntimeAgent.h"
+
+#include <string>
+#include <string_view>
+#include <unordered_map>
+#include <unordered_set>
+
+namespace facebook::react::jsinspector_modern {
+
+struct SessionState {
+ public:
+  // TODO: Generalise this to arbitrary domains
+  bool isLogDomainEnabled{false};
+  bool isRuntimeDomainEnabled{false};
+
+  /**
+   * A map from binding names (registered during this session using @cdp
+   * Runtime.addBinding) to execution context selectors.
+   *
+   * Even though bindings get added to the global scope as
+   * functions that can outlive a session, they are treated as session state,
+   * matching Chrome's behaviour (a binding not added by the current session
+   * will not emit events on it).
+   */
+  std::unordered_map<std::string, ExecutionContextSelectorSet>
+      subscribedBindings;
+
+  /**
+   * Stores the state object exported from the last main RuntimeAgent, if any,
+   * before it was destroyed.
+   */
+  RuntimeAgent::ExportedState lastRuntimeAgentExportedState;
+
+  // Here, we will eventually allow RuntimeAgents to store their own arbitrary
+  // state (e.g. some sort of K/V storage of folly::dynamic?)
+
+  // TODO: Figure out a good model for restricting write access / preventing
+  // agents from unintentionally clobbering each other's state.
+};
+
+} // namespace facebook::react::jsinspector_modern

package/ReactCommon/jsinspector-modern/UniqueMonostate.h

@@ -0,0 +1,54 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#pragma once
+
+#include <functional>
+
+namespace facebook::react::jsinspector_modern {
+
+/**
+ * A template for easily creating empty types that are distinct from one
+ * another. Useful if you need to generate marker types for use in an
+ * std::variant, and a single std::monostate won't do.
+ */
+template <size_t key>
+struct UniqueMonostate {
+  constexpr bool operator==(const UniqueMonostate<key>&) const noexcept {
+    return true;
+  }
+  constexpr bool operator!=(const UniqueMonostate<key>&) const noexcept {
+    return false;
+  }
+  constexpr bool operator<(const UniqueMonostate<key>&) const noexcept {
+    return false;
+  }
+  constexpr bool operator>(const UniqueMonostate<key>&) const noexcept {
+    return false;
+  }
+  constexpr bool operator<=(const UniqueMonostate<key>&) const noexcept {
+    return true;
+  }
+  constexpr bool operator>=(const UniqueMonostate<key>&) const noexcept {
+    return true;
+  }
+};
+
+} // namespace facebook::react::jsinspector_modern
+
+namespace std {
+
+template <size_t key>
+struct hash<::facebook::react::jsinspector_modern::UniqueMonostate<key>> {
+  size_t operator()(
+      const ::facebook::react::jsinspector_modern::UniqueMonostate<key>&)
+      const noexcept {
+    return key;
+  }
+};
+
+} // namespace std

package/ReactCommon/jsinspector-modern/WeakList.h

@@ -0,0 +1,79 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#pragma once
+
+#include <list>
+#include <memory>
+
+namespace facebook::react::jsinspector_modern {
+
+/**
+ * A list that holds weak pointers to objects of type `T`. Null pointers are not
+ * considered to be in the list.
+ *
+ * The list is not thread-safe! The caller is responsible for synchronization.
+ */
+template <typename T>
+class WeakList {
+ public:
+  /**
+   * Call the given function for every element in the list, ensuring the element
+   * is not destroyed for the duration of the call. Elements are visited in the
+   * order they were inserted.
+   *
+   * As a side effect, any null pointers in the underlying list (corresponding
+   * to destroyed elements) will be removed during iteration.
+   */
+  template <typename Fn>
+  void forEach(Fn&& fn) const {
+    for (auto it = ptrs_.begin(); it != ptrs_.end();) {
+      if (auto ptr = it->lock()) {
+        fn(*ptr);
+        ++it;
+      } else {
+        it = ptrs_.erase(it);
+      }
+    }
+  }
+
+  /**
+   * Returns the number of (non-null) elements in the list. The count will only
+   * remain accurate as long as the list is not modified and elements are
+   * not destroyed.
+   *
+   * As a side effect, any null pointers in the underlying list (corresponding
+   * to destroyed elements) will be removed during this method.
+   */
+  size_t size() const {
+    size_t count{0};
+    forEach([&count](const auto&) { ++count; });
+    return count;
+  }
+
+  /**
+   * Returns true if there are no elements in the list.
+   *
+   * As a side effect, any null pointers in the underlying list (corresponding
+   * to destroyed elements) will be removed during this method.
+   */
+  bool empty() const {
+    return !size();
+  }
+
+  /**
+   * Inserts an element into the list.
+   */
+  void insert(std::weak_ptr<T> ptr) {
+    ptrs_.push_back(ptr);
+  }
+
+ private:
+  mutable std::list<std::weak_ptr<T>> ptrs_;
+};
+
+} // namespace facebook::react::jsinspector_modern

package/ReactCommon/jsinspector-modern/WebSocketInterfaces.h

@@ -0,0 +1,62 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#pragma once
+
+#include <optional>
+#include <string>
+#include <string_view>
+
+namespace facebook::react::jsinspector_modern {
+
+/**
+ * Simplified interface to a WebSocket connection.
+ * The socket MUST be initially open when constructed.
+ */
+class IWebSocket {
+ public:
+  /**
+   * If still connected when destroyed, the socket MUST automatically send an
+   * "end of session" message and disconnect.
+   */
+  virtual ~IWebSocket() = default;
+
+  /**
+   * Sends a message over the socket. This function may be called on any thread
+   * without synchronization.
+   * \param message Message to send, in UTF-8 encoding.
+   */
+  virtual void send(std::string_view message) = 0;
+};
+
+class IWebSocketDelegate {
+ public:
+  virtual ~IWebSocketDelegate() = default;
+
+  /**
+   * Called when the socket has encountered an error.
+   * \param posixCode POSIX errno value if available, otherwise nullopt.
+   * \param error Error description.
+   */
+  virtual void didFailWithError(
+      std::optional<int> posixCode,
+      std::string error) = 0;
+
+  /**
+   * Called when a message has been received from the socket.
+   * \param message Message received, in UTF-8 encoding.
+   */
+  virtual void didReceiveMessage(std::string_view message) = 0;
+
+  /**
+   * Called when the socket has been closed. The call is not required if
+   * didFailWithError was called instead.
+   */
+  virtual void didClose() = 0;
+};
+
+} // namespace facebook::react::jsinspector_modern

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

@@ -0,0 +1,50 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#include <folly/dynamic.h>
+#include <folly/json.h>
+#include <folly/json_pointer.h>
+#include <gmock/gmock.h>
+
+#include "FollyDynamicMatchers.h"
+
+namespace facebook::folly_dynamic_matchers_utils {
+
+std::string as_string(std::string value) {
+  return value;
+}
+std::string as_string(folly::dynamic value) {
+  return value.asString();
+}
+
+std::string explain_error(
+    folly::dynamic::json_pointer_resolution_error<folly::dynamic const> error) {
+  using err_code = folly::dynamic::json_pointer_resolution_error_code;
+
+  switch (error.error_code) {
+    case err_code::key_not_found:
+      return "key not found";
+    case err_code::index_out_of_bounds:
+      return "index out of bounds";
+    case err_code::append_requested:
+      return "append requested";
+    case err_code::index_not_numeric:
+      return "array index is not numeric";
+    case err_code::index_has_leading_zero:
+      return "leading zero not allowed when indexing arrays";
+    case err_code::element_not_object_or_array:
+      return "element is neither an object nor an array";
+    case err_code::json_pointer_out_of_bounds:
+      return "JSON pointer out of bounds";
+    case err_code::other:
+      return "unknown error";
+    default:
+      assert(false && "unhandled error code");
+      return "<unhandled error code>";
+  }
+}
+} // namespace facebook::folly_dynamic_matchers_utils

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

@@ -0,0 +1,80 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#pragma once
+
+#include <folly/dynamic.h>
+#include <folly/json.h>
+#include <folly/json_pointer.h>
+#include <gmock/gmock.h>
+
+namespace facebook {
+
+namespace folly_dynamic_matchers_utils {
+
+std::string as_string(std::string value);
+std::string as_string(folly::dynamic value);
+std::string explain_error(
+    folly::dynamic::json_pointer_resolution_error<folly::dynamic const> error);
+
+} // namespace folly_dynamic_matchers_utils
+
+// GTest / GMock compatible matchers for `folly::dynamic` values.
+
+/**
+ * Parses a JSON string into a folly::dynamic, then matches it against the
+ * given matcher.
+ */
+MATCHER_P(
+    JsonParsed,
+    innerMatcher,
+    std::string{"parsed as JSON "} +
+        testing::DescribeMatcher<folly::dynamic>(innerMatcher, negation)) {
+  using namespace ::testing;
+  using namespace folly_dynamic_matchers_utils;
+  const auto& json = arg;
+  folly::dynamic parsed = folly::parseJson(as_string(json));
+  return ExplainMatchResult(innerMatcher, parsed, result_listener);
+}
+
+/**
+ * Given a folly::dynamic argument, asserts that it is deeply equal to the
+ * result of parsing the given JSON string.
+ */
+MATCHER_P(
+    JsonEq,
+    expected,
+    std::string{"deeply equals "} +
+        folly::toPrettyJson(folly::parseJson(expected))) {
+  using namespace ::testing;
+  return ExplainMatchResult(
+      JsonParsed(Eq(folly::parseJson(expected))), arg, result_listener);
+}
+
+/**
+ * A higher-order matcher that applies an inner matcher to the value at a
+ * particular JSON Pointer location within a folly::dynamic.
+ */
+MATCHER_P2(
+    AtJsonPtr,
+    jsonPointer,
+    innerMatcher,
+    std::string{"value at "} + jsonPointer + " " +
+        testing::DescribeMatcher<folly::dynamic>(innerMatcher, negation)) {
+  using namespace ::testing;
+  using namespace folly_dynamic_matchers_utils;
+  auto resolved_ptr = arg.try_get_ptr(folly::json_pointer::parse(jsonPointer));
+  if (resolved_ptr.hasValue()) {
+    return ExplainMatchResult(
+        innerMatcher, *resolved_ptr.value().value, result_listener);
+  }
+  *result_listener << "has no value at " << jsonPointer << " because of error: "
+                   << explain_error(resolved_ptr.error());
+  return false;
+}
+
+} // namespace facebook

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

@@ -0,0 +1,163 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#pragma once
+
+#include <folly/executors/ScheduledExecutor.h>
+#include <gmock/gmock.h>
+
+#include <jsinspector-modern/InspectorInterfaces.h>
+#include <jsinspector-modern/InspectorPackagerConnection.h>
+#include <jsinspector-modern/ReactCdp.h>
+
+#include <chrono>
+#include <functional>
+#include <memory>
+#include <string>
+
+// Configurable mocks of various interfaces required by the inspector API.
+
+namespace facebook::react::jsinspector_modern {
+
+class MockWebSocket : public IWebSocket {
+ public:
+  MockWebSocket(
+      const std::string& url,
+      std::weak_ptr<IWebSocketDelegate> delegate)
+      : url{url}, delegate{delegate} {
+    EXPECT_TRUE(this->delegate.lock())
+        << "Delegate should exist when provided to createWebSocket";
+  }
+
+  const std::string url;
+  std::weak_ptr<IWebSocketDelegate> delegate;
+
+  /**
+   * Convenience method to access the delegate from tests.
+   * \pre The delegate has not been destroyed.
+   */
+  IWebSocketDelegate& getDelegate() {
+    auto delegateStrong = this->delegate.lock();
+    EXPECT_TRUE(delegateStrong);
+    return *delegateStrong;
+  }
+
+  // IWebSocket methods
+  MOCK_METHOD(void, send, (std::string_view message), (override));
+};
+
+class MockRemoteConnection : public IRemoteConnection {
+ public:
+  MockRemoteConnection() = default;
+
+  // IRemoteConnection methods
+  MOCK_METHOD(void, onMessage, (std::string message), (override));
+  MOCK_METHOD(void, onDisconnect, (), (override));
+};
+
+class MockLocalConnection : public ILocalConnection {
+ public:
+  explicit MockLocalConnection(
+      std::unique_ptr<IRemoteConnection> remoteConnection)
+      : remoteConnection_{std::move(remoteConnection)} {}
+
+  IRemoteConnection& getRemoteConnection() {
+    return *remoteConnection_;
+  }
+
+  std::unique_ptr<IRemoteConnection> dangerouslyReleaseRemoteConnection() {
+    return std::move(remoteConnection_);
+  }
+
+  // ILocalConnection methods
+  MOCK_METHOD(void, sendMessage, (std::string message), (override));
+  MOCK_METHOD(void, disconnect, (), (override));
+
+ private:
+  std::unique_ptr<IRemoteConnection> remoteConnection_;
+};
+
+class MockInspectorPackagerConnectionDelegate
+    : public InspectorPackagerConnectionDelegate {
+ public:
+  explicit MockInspectorPackagerConnectionDelegate(folly::Executor& executor)
+      : executor_(executor) {
+    using namespace testing;
+    ON_CALL(*this, scheduleCallback(_, _))
+        .WillByDefault(Invoke<>([this](auto callback, auto delay) {
+          if (auto scheduledExecutor =
+                  dynamic_cast<folly::ScheduledExecutor*>(&executor_)) {
+            scheduledExecutor->scheduleAt(
+                callback, scheduledExecutor->now() + delay);
+          } else {
+            executor_.add(callback);
+          }
+        }));
+  }
+
+  // InspectorPackagerConnectionDelegate methods
+  MOCK_METHOD(
+      std::unique_ptr<IWebSocket>,
+      connectWebSocket,
+      (const std::string& url, std::weak_ptr<IWebSocketDelegate> delegate),
+      (override));
+  MOCK_METHOD(
+      void,
+      scheduleCallback,
+      (std::function<void(void)> callback, std::chrono::milliseconds delayMs),
+      (override));
+
+ private:
+  folly::Executor& executor_;
+};
+
+class MockPageTargetDelegate : public PageTargetDelegate {
+ public:
+  // PageTargetDelegate methods
+  MOCK_METHOD(void, onReload, (const PageReloadRequest& request), (override));
+};
+
+class MockInstanceTargetDelegate : public InstanceTargetDelegate {};
+
+class MockRuntimeTargetDelegate : public RuntimeTargetDelegate {
+ public:
+  // RuntimeTargetDelegate methods
+  MOCK_METHOD(
+      std::unique_ptr<RuntimeAgentDelegate>,
+      createAgentDelegate,
+      (FrontendChannel channel,
+       SessionState& sessionState,
+       std::unique_ptr<RuntimeAgentDelegate::ExportedState>
+           previouslyExportedState,
+       const ExecutionContextDescription&),
+      (override));
+};
+
+class MockRuntimeAgentDelegate : public RuntimeAgentDelegate {
+ public:
+  inline MockRuntimeAgentDelegate(
+      FrontendChannel frontendChannel,
+      SessionState& sessionState,
+      std::unique_ptr<RuntimeAgentDelegate::ExportedState>,
+      const ExecutionContextDescription& executionContextDescription)
+      : frontendChannel(std::move(frontendChannel)),
+        sessionState(sessionState),
+        executionContextDescription(executionContextDescription) {}
+
+  // RuntimeAgentDelegate methods
+  MOCK_METHOD(
+      bool,
+      handleRequest,
+      (const cdp::PreparsedRequest& req),
+      (override));
+
+  const FrontendChannel frontendChannel;
+  SessionState& sessionState;
+  const ExecutionContextDescription executionContextDescription;
+};
+
+} // namespace facebook::react::jsinspector_modern