Move integration tests to OSS (#43094)

robhogan · facebook-github-bot · commit 8cbf46a5f49f · 2024-02-22T04:21:35.000-08:00
Summary: Pull Request resolved: #43094 Merge the internal `cxxcdp-tester` project into `jsinspector-modern/tests`. Note: These tests still use RN default feature flags and therefore test against the legacy CDP registry - that's addressed in the next diff. Changelog: [Internal] Reviewed By: motiz88 Differential Revision: D53766994 fbshipit-source-id: eec144124b20a4500e28398e98763febaed52748
diff --git a/packages/react-native/ReactCommon/jsinspector-modern/tests/ReactInstanceIntegrationTest.cpp b/packages/react-native/ReactCommon/jsinspector-modern/tests/ReactInstanceIntegrationTest.cpp
@@ -0,0 +1,156 @@
+/*
+ * 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 "ReactInstanceIntegrationTest.h"
+#include "FollyDynamicMatchers.h"
+#include "UniquePtrFactory.h"
+#include "prelude.js.h"
+
+#include <folly/json.h>
+#include <glog/logging.h>
+#include <react/runtime/hermes/HermesInstance.h>
+
+namespace facebook::react::jsinspector_modern {
+
+using namespace ::testing;
+
+ReactInstanceIntegrationTest::ReactInstanceIntegrationTest()
+    : runtime(nullptr),
+      instance(nullptr),
+      messageQueueThread(std::make_shared<MockMessageQueueThread>()),
+      errorHandler(std::make_shared<ErrorUtils>()) {}
+
+void ReactInstanceIntegrationTest::SetUp() {
+  auto mockRegistry = std::make_unique<MockTimerRegistry>();
+  auto timerManager =
+      std::make_shared<react::TimerManager>(std::move(mockRegistry));
+
+  auto jsErrorHandlingFunc = [](react::MapBuffer error) noexcept {
+    LOG(INFO) << "Error: \nFile: " << error.getString(react::kFrameFileName)
+              << "\nLine: " << error.getInt(react::kFrameLineNumber)
+              << "\nColumn: " << error.getInt(react::kFrameColumnNumber)
+              << "\nMethod: " << error.getString(react::kFrameMethodName);
+  };
+
+  auto jsRuntimeFactory = std::make_unique<react::HermesInstance>();
+  std::unique_ptr<react::JSRuntime> runtime_ =
+      jsRuntimeFactory->createJSRuntime(nullptr, nullptr, messageQueueThread);
+  jsi::Runtime* jsiRuntime = &runtime_->getRuntime();
+
+  // Error handler:
+  jsiRuntime->global().setProperty(
+      *jsiRuntime,
+      "ErrorUtils",
+      jsi::Object::createFromHostObject(*jsiRuntime, errorHandler));
+
+  instance = std::make_unique<react::ReactInstance>(
+      std::move(runtime_),
+      messageQueueThread,
+      timerManager,
+      std::move(jsErrorHandlingFunc));
+  timerManager->setRuntimeExecutor(instance->getBufferedRuntimeExecutor());
+
+  // JS Environment:
+  initializeRuntime(preludeJsCode);
+
+  // Inspector:
+  auto& inspector = getInspectorInstance();
+  auto pages = inspector.getPages();
+
+  // We should now have at least a single page once the above runtime has been
+  // initialized.
+  assert(pages.size() > 0);
+  size_t pageId = pages.back().id;
+
+  clientToVM_ = inspector.connect(pageId, mockRemoteConnections_.make_unique());
+}
+
+void ReactInstanceIntegrationTest::TearDown() {
+  clientToVM_->disconnect();
+}
+
+void ReactInstanceIntegrationTest::initializeRuntime(std::string_view script) {
+  react::ReactInstance::JSRuntimeFlags flags{
+      .isProfiling = false,
+  };
+  instance->initializeRuntime(flags, [](jsi::Runtime&) {});
+
+  messageQueueThread->tick();
+
+  std::string init(script);
+  // JS calls no longer buffered after calling loadScript
+  instance->loadScript(std::make_unique<react::JSBigStdString>(init), "");
+
+  messageQueueThread->flush();
+}
+
+void ReactInstanceIntegrationTest::send(
+    const std::string& method,
+    const folly::dynamic& params) {
+  folly::dynamic request = folly::dynamic::object();
+
+  request["method"] = method;
+  request["id"] = id_++;
+  request["params"] = params;
+
+  sendJSONString(folly::toJson(request));
+}
+
+void ReactInstanceIntegrationTest::sendJSONString(const std::string& message) {
+  // The runtime must be initialized and connected to before messaging
+  clientToVM_->sendMessage(message);
+}
+
+jsi::Value ReactInstanceIntegrationTest::run(const std::string& script) {
+  auto runtimeExecutor = instance->getUnbufferedRuntimeExecutor();
+  auto ret = jsi::Value::undefined();
+
+  runtimeExecutor([script, &ret](jsi::Runtime& rt) {
+    ret = rt.evaluateJavaScript(
+        std::make_unique<jsi::StringBuffer>(script), "<test>");
+  });
+
+  messageQueueThread->flush();
+
+  while (verbose_ && errorHandler->size() > 0) {
+    LOG(INFO) << "Error: " << errorHandler->getLastError().getMessage();
+  }
+
+  return ret;
+}
+
+bool ReactInstanceIntegrationTest::verbose(bool isVerbose) {
+  const bool previous = verbose_;
+  verbose_ = isVerbose;
+  return previous;
+}
+
+TEST_F(ReactInstanceIntegrationTest, RuntimeEvalTest) {
+  auto val = run("1 + 2");
+  EXPECT_EQ(val.asNumber(), 3);
+}
+
+TEST_F(ReactInstanceIntegrationTest, ConsoleLogTest) {
+  InSequence s;
+
+  EXPECT_CALL(getRemoteConnection(), onMessage(_))
+      .Times(2)
+      .RetiresOnSaturation();
+
+  EXPECT_CALL(
+      getRemoteConnection(),
+      onMessage(JsonParsed(AllOf(
+          AtJsonPtr("/params/args/0/value", Eq("Hello, World!")),
+          AtJsonPtr("/method", Eq("Runtime.consoleAPICalled"))))));
+
+  EXPECT_CALL(getRemoteConnection(), onDisconnect());
+
+  send("Runtime.enable");
+  run("console.log('Hello, World!');");
+}
+
+} // namespace facebook::react::jsinspector_modern
diff --git a/packages/react-native/ReactCommon/jsinspector-modern/tests/ReactInstanceIntegrationTest.h b/packages/react-native/ReactCommon/jsinspector-modern/tests/ReactInstanceIntegrationTest.h
@@ -0,0 +1,53 @@
+/*
+ * 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/json.h>
+#include <gtest/gtest.h>
+#include <jsinspector-modern/InspectorInterfaces.h>
+#include <memory>
+
+#include "InspectorMocks.h"
+#include "ReactNativeMocks.h"
+#include "UniquePtrFactory.h"
+
+namespace facebook::react::jsinspector_modern {
+
+class ReactInstanceIntegrationTest : public ::testing::Test {
+ protected:
+  ReactInstanceIntegrationTest();
+  void SetUp() override;
+  void TearDown() override;
+
+  jsi::Value run(const std::string& script);
+  bool verbose(bool isVerbose);
+
+  void send(
+      const std::string& method,
+      const folly::dynamic& params = folly::dynamic::object());
+  void sendJSONString(const std::string& message);
+
+  jsi::Runtime* runtime;
+  std::unique_ptr<react::ReactInstance> instance;
+  std::shared_ptr<MockMessageQueueThread> messageQueueThread;
+  std::shared_ptr<ErrorUtils> errorHandler;
+
+  MockRemoteConnection& getRemoteConnection() {
+    return *mockRemoteConnections_[0];
+  }
+
+ private:
+  void initializeRuntime(std::string_view script);
+
+  size_t id_ = 1;
+  bool verbose_ = false;
+  UniquePtrFactory<MockRemoteConnection> mockRemoteConnections_;
+  std::unique_ptr<ILocalConnection> clientToVM_;
+};
+
+} // namespace facebook::react::jsinspector_modern
diff --git a/packages/react-native/ReactCommon/jsinspector-modern/tests/ReactNativeMocks.cpp b/packages/react-native/ReactCommon/jsinspector-modern/tests/ReactNativeMocks.cpp
@@ -0,0 +1,93 @@
+/*
+ * 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 "ReactNativeMocks.h"
+
+namespace facebook::react::jsinspector_modern {
+
+//
+// MockMessageQueueThread
+//
+
+void MockMessageQueueThread::runOnQueue(std::function<void()>&& func) {
+  callbackQueue_.push(func);
+}
+
+void MockMessageQueueThread::tick() {
+  if (!callbackQueue_.empty()) {
+    auto callback = callbackQueue_.front();
+    callback();
+    callbackQueue_.pop();
+  }
+}
+
+void MockMessageQueueThread::guardedTick() {
+  try {
+    tick();
+  } catch (const std::exception& e) {
+    // For easier debugging
+    FAIL() << e.what();
+  }
+}
+
+void MockMessageQueueThread::flush() {
+  while (!callbackQueue_.empty()) {
+    tick();
+  }
+}
+
+size_t MockMessageQueueThread::size() {
+  return callbackQueue_.size();
+}
+
+void MockMessageQueueThread::quitSynchronous() {
+  assert(false && "Not implemented");
+}
+void MockMessageQueueThread::runOnQueueSync(std::function<void()>&& callback) {
+  callback();
+}
+
+//
+// ErrorUtils
+//
+jsi::Value ErrorUtils::get(jsi::Runtime& rt, const jsi::PropNameID& name) {
+  auto methodName = name.utf8(rt);
+
+  if (methodName == "reportFatalError") {
+    return jsi::Function::createFromHostFunction(
+        rt,
+        name,
+        1,
+        [this](
+            jsi::Runtime& runtime,
+            /* thisValue */ const jsi::Value&,
+            const jsi::Value* arguments,
+            size_t count) {
+          if (count >= 1) {
+            auto value = jsi::Value(runtime, arguments[0]);
+            auto error = jsi::JSError(runtime, std::move(value));
+            LOG(INFO) << "JSI Fatal: " << error.getMessage();
+            reportFatalError(std::move(error));
+          }
+          return jsi::Value::undefined();
+        });
+  } else {
+    throw std::runtime_error("Unknown method: " + methodName);
+  }
+}
+
+size_t ErrorUtils::size() {
+  return errors_.size();
+}
+
+jsi::JSError ErrorUtils::getLastError() {
+  auto error = errors_.back();
+  errors_.pop_back();
+  return error;
+}
+
+} // namespace facebook::react::jsinspector_modern
diff --git a/packages/react-native/ReactCommon/jsinspector-modern/tests/ReactNativeMocks.h b/packages/react-native/ReactCommon/jsinspector-modern/tests/ReactNativeMocks.h
@@ -0,0 +1,65 @@
+/*
+ * 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 <gmock/gmock.h>
+#include <gtest/gtest.h>
+#include <queue>
+
+#include <ReactCommon/RuntimeExecutor.h>
+#include <jsi/jsi.h>
+#include <react/runtime/ReactInstance.h>
+
+namespace facebook::react::jsinspector_modern {
+
+class MockTimerRegistry : public react::PlatformTimerRegistry {
+ public:
+  MOCK_METHOD2(createTimer, void(uint32_t, double));
+  MOCK_METHOD2(createRecurringTimer, void(uint32_t, double));
+  MOCK_METHOD1(deleteTimer, void(uint32_t));
+};
+
+class MockMessageQueueThread : public react::MessageQueueThread {
+ public:
+  void runOnQueue(std::function<void()>&& func) override;
+
+  // Unused
+  void runOnQueueSync(std::function<void()>&&) override;
+
+  // Unused
+  void quitSynchronous() override;
+
+  void tick();
+
+  void flush();
+
+  void guardedTick();
+
+  size_t size();
+
+ private:
+  std::queue<std::function<void()>> callbackQueue_;
+};
+
+class ErrorUtils : public jsi::HostObject {
+ public:
+  jsi::Value get(jsi::Runtime& rt, const jsi::PropNameID& name) override;
+
+  void reportFatalError(jsi::JSError&& error) {
+    errors_.push_back(std::move(error));
+  }
+
+  size_t size();
+
+  jsi::JSError getLastError();
+
+ private:
+  std::vector<jsi::JSError> errors_;
+};
+
+} // namespace facebook::react::jsinspector_modern
diff --git a/packages/react-native/ReactCommon/jsinspector-modern/tests/prelude.js.h b/packages/react-native/ReactCommon/jsinspector-modern/tests/prelude.js.h
