uws-react-native 0.0.1-alpha.1

package/cpp/CMakeLists.txt

@@ -0,0 +1,154 @@
+# Currently, this CMake is only used by Android for React Native C++ static autolinking
+# We need to adjust this build if this is getting used by other platforms
+# or to build Shared Object file.
+
+project("uws_react_native")
+cmake_minimum_required(VERSION 3.14.0)
+
+# include(FetchContent)
+
+set(CMAKE_VERBOSE_MAKEFILE ON)
+set(CMAKE_CXX_STANDARD 20)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+# set(CMAKE_ANDROID_STL_TYPE "c++_static")
+set(ANDROID_SUPPORT_FLEXIBLE_PAGE_SIZES ON)
+
+set(LIB_ANDROID_DIR "${CMAKE_CURRENT_SOURCE_DIR}/../android")
+set(LIB_ANDROID_GENERATED_JNI_DIR ${LIB_ANDROID_DIR}/build/generated/source/codegen/jni)
+set(LIB_CODEGEN_SPEC_NAME "UwsReactNativeSpecs")
+
+if(CMAKE_ANDROID_ARCH_ABI STREQUAL "arm64-v8a" OR CMAKE_ANDROID_ARCH_ABI STREQUAL "x86_64")
+	set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} -Wl,-z,max-page-size=16384")
+endif()
+
+find_package(ReactAndroid REQUIRED CONFIG)
+find_package(fbjni REQUIRED CONFIG)
+find_package(ZLIB REQUIRED)
+
+file(
+	GLOB_RECURSE
+	LIB_SHARED_SRCS
+	RELATIVE
+	${CMAKE_CURRENT_SOURCE_DIR}
+	"./*.cpp"
+)
+
+# It's useful later to call cpp to Java/Kotlin
+# file(GLOB_RECURSE LIB_ANDROID_SRCS RELATIVE ${CMAKE_SOURCE_DIR} "src/main/cpp/*.cpp")
+file(
+	GLOB
+	LIB_ANDROID_SRCS
+	RELATIVE
+	${LIB_ANDROID_DIR}
+	"src/main/cpp/*.cpp"
+)
+
+# Codegen source files
+file(
+	GLOB_RECURSE
+	LIB_CODEGEN_SRCS
+	CONFIGURE_DEPENDS
+	${LIB_ANDROID_GENERATED_JNI_DIR}/*.cpp
+	${LIB_ANDROID_GENERATED_JNI_DIR}/**/*.cpp
+)
+
+add_library(
+	${PROJECT_NAME}
+	STATIC
+	${LIB_SHARED_SRCS}
+	${LIB_ANDROID_SRCS}
+	${LIB_CODEGEN_SRCS}
+)
+
+# Add headers search paths
+target_include_directories(
+	${PROJECT_NAME}
+	PUBLIC
+	"."
+	${LIB_ANDROID_SRCS}
+	${LIB_ANDROID_GENERATED_JNI_DIR}
+	"${LIB_ANDROID_GENERATED_JNI_DIR}/react/renderer/components/${LIB_CODEGEN_SPEC_NAME}"
+)
+
+# uSockets & uWebSockets setup
+# Thanks to https://github.com/tony-go/cmake-uwebsockets/blob/main/CMakeLists.txt
+
+# The "uSockets" and "uWebSockets" files
+# are generated by /uws-react-native/package-builder/scripts/_uws-mod.mjs.
+# If you are library user and see this note from your /node_modules,
+# the "uws-mod.mjs" is not part of the library file.
+# Visit our repository https://github.com/RakaDoank/uws-react-native
+
+# +++++ uSockets +++++
+file(
+	GLOB_RECURSE
+	USOCKETS_SRCS
+	CONFIGURE_DEPENDS
+	"./uSockets/*.c"
+)
+
+add_library(
+	uSockets
+	${USOCKETS_SRCS}
+)
+
+# We make the uSockets headers flatten path without its directory name
+# because uWebSockets include the uSockets header internally without its directory name.
+# So whoever want to use uSockets including the uWebSockets
+# They just need to write like ` #include "libusockets.h" `.
+target_include_directories(
+	uSockets
+	PUBLIC
+	"./uSockets"
+)
+
+target_compile_definitions(
+	uSockets
+	PRIVATE
+	LIBUS_NO_SSL
+)
+# ----- uSockets -----
+
+# +++++ uWebSockets +++++
+add_library(
+	uWebSockets
+	INTERFACE
+)
+
+# Notice that `uWebSockets` directory has another directory inside with the same name `uWebSockets`.
+# So, to include uWebSockets headers, the directory name has to be included.
+# ` #include "uWebSockets/App.h" `
+target_include_directories(
+	uWebSockets
+	INTERFACE
+	"./uWebSockets"
+)
+
+target_link_libraries(
+	uWebSockets
+	INTERFACE
+	uSockets
+	${ZLIB_LIBRARIES}
+)
+
+target_compile_options(uWebSockets INTERFACE -Wno-deprecated-declarations)
+# ----- uWebSockets -----
+
+add_subdirectory(app)
+add_subdirectory(bridging)
+add_subdirectory(jsi)
+
+# Link Libraries
+target_link_libraries(
+	${PROJECT_NAME}
+	ReactAndroid::reactnative
+	ReactAndroid::jsi
+	fbjni::fbjni
+	react_codegen_UwsReactNativeSpecs
+	uWebSockets
+	android
+	log
+	uws_react_native::app
+	uws_react_native::bridging
+	uws_react_native::jsi
+)

package/cpp/UwsReactNativeModule.cpp

@@ -0,0 +1,191 @@
+#include "UwsReactNativeModule.h"
+#include <memory>
+#include <vector>
+#include <jsi/jsi.h>
+#include "app/AppHost.h"
+#include "app/TemplatedAppObject.h"
+#include "jsi/Buffer.h"
+#include "uWebSockets/HttpContextData.h"
+#include "uWebSockets/HttpResponse.h"
+#include "uWebSockets/Multipart.h"
+
+namespace facebook::react {
+
+namespace {
+
+std::vector<std::shared_ptr<uws_react_native::AppHost>> appHosts;
+
+} // namespace
+
+UwsReactNativeModule::UwsReactNativeModule(std::shared_ptr<CallInvoker> jsInvoker)
+  : NativeUwsReactNativeCxxSpec(std::move(jsInvoker)) {}
+
+uws_react_native::TemplatedAppObject UwsReactNativeModule::App(facebook::jsi::Runtime &rt,
+                                                               std::optional<facebook::jsi::Object> appOptions) {
+  auto assignedIndex = appHosts.size();
+
+  auto appHost = std::make_shared<uws_react_native::AppHost>([assignedIndex]() {
+    if(assignedIndex < appHosts.size()) {
+      appHosts.erase(appHosts.begin() + assignedIndex);
+    }
+  });
+  appHosts.emplace_back(appHost);
+
+  /// Be aware!
+  /// We pass increased number of the assignedIndex to the appHost->getTemplatedAppObject().
+  /// When users use the listen method (app.listen)
+  /// they got 1..n number, not zero at first.
+  /// It will passes 0 (zero) if the listen method is failed
+  /// that has been done internally in `app/TemplatedAppObject.h`.
+
+  /// This is intentional to get similar behaviour from uWebSockets.js.
+  /// And this is also for future usage kind of thing.
+  /// When we actually start to pass the `us_socket_t` or `us_listen_socket_t` to the listen method in JS,
+  /// we don't break users code space and they don't need to do anything at all.
+
+  /// User often uses the app.listen like this below
+
+  /// app.listen(5000, token => {
+  ///   if(token) {
+  ///     console.log("Listening to port 5000");
+  ///   } else {
+  ///     console.log("Failed to listen to port 5000");
+  ///   }
+  /// });
+  return appHost->getTemplatedAppObject(rt, this->jsInvoker_, assignedIndex + 1);
+}
+
+/// Ported of uWebSockets.js `getParts`
+/// See https://github.com/uNetworking/uWebSockets.js/blob/master/src/addon.cpp#L45
+facebook::jsi::Object UwsReactNativeModule::getParts(facebook::jsi::Runtime &rt,
+                                                     facebook::jsi::Object body,
+                                                     facebook::jsi::String contentType) {
+  /// Sucks
+  /// Codegen maps `unknown` type to JSI Object.
+  /// We can't return Array | Undefined
+  /// If an empty object, it indicates undefined.
+  /// Empty object needs to be remapped to undefined.
+  /// See /uws-react-native/package/src/modules/getParts.ts
+
+  if(!body.isArrayBuffer(rt)) {
+    /// undefined
+    return facebook::jsi::Object(rt);
+  }
+
+  auto arrayBuffer = body.getArrayBuffer(rt);
+
+  auto mp = uWS::MultipartParser(contentType.utf8(rt));
+  if(mp.isValid()) {
+    mp.setBody(std::string_view(reinterpret_cast<char *>(arrayBuffer.data(rt)),
+                                arrayBuffer.size(rt)));
+
+    std::pair<std::string_view, std::string_view> headers[10];
+
+    auto parts = std::vector<facebook::jsi::Object>();
+
+    while(true) {
+      std::optional<std::string_view> optionalPart = mp.getNextPart(headers);
+      if(!optionalPart.has_value()) {
+        break;
+      }
+
+      std::string_view part = optionalPart.value();
+      auto partObj = facebook::jsi::Object(rt);
+
+      partObj.setProperty(rt,
+                          "data",
+                          facebook::jsi::ArrayBuffer(rt, std::make_shared<uws_react_native::StringViewMutableBuffer>(part)));
+
+      for(int i = 0; headers[i].first.length(); i++) {
+        if(headers[i].first == "content-type") {
+          partObj.setProperty(rt,
+                              "type",
+                              std::string(headers[i].second));
+        } else if(headers[i].first == "content-disposition") {
+          /* Parse the parameters */
+          uWS::ParameterParser pp(headers[i].second);
+          while(true) {
+            auto [key, value] = pp.getKeyValue();
+            if(!key.length()) {
+              break;
+            }
+
+            if(key == "name" || key == "filename") {
+              partObj.setProperty(rt,
+                                  facebook::jsi::PropNameID::forUtf8(rt, std::string(key)),
+                                  std::string(value));
+            }
+          }
+        }
+      }
+
+      parts.emplace_back(std::move(partObj));
+    }
+
+    auto multipartField = facebook::jsi::Array(rt, parts.size());
+
+    std::for_each(parts.begin(), parts.end(), [&rt, &multipartField, i = 0](auto &part) mutable {
+      multipartField.setValueAtIndex(rt, i, part);
+      i++;
+    });
+
+    return multipartField;
+  }
+
+  /// undefined
+  return facebook::jsi::Object(rt);
+}
+
+/// It's better to have different name than this.
+/// It doesn't use us_listen_socket_close from uSockets directly in this function
+void UwsReactNativeModule::_us_listen_socket_close(facebook::jsi::Runtime &rt,
+                                                  double id
+                                                  /*facebook::jsi::Object listenSocket*/) {
+  if(id < 1) {
+    return;
+  }
+
+  /// Decreased one number. See notes above at UwsReactNativeModule::App
+  auto assignedIndex = id - 1;
+
+  auto appHost = appHosts.at(assignedIndex);
+
+  if(!appHost) {
+    return;
+  }
+
+  appHost->appRunner.close([assignedIndex]() {
+    if(assignedIndex < appHosts.size()) {
+      appHosts.erase(appHosts.begin() + assignedIndex);
+    }
+  });
+}
+
+/// It's better to have different name than this.
+/// JS side doesn't pass the actual us_socket_t or us_listen_socket_t to this function.
+double UwsReactNativeModule::_us_socket_local_port(facebook::jsi::Runtime &rt,
+                                                double id
+                                                /*facebook::jsi::Object socket*/) {
+  if(id < 1) {
+    return -1;
+  }
+
+  /// Decreased one number. See notes above at UwsReactNativeModule::App
+  auto assignedIndex = id - 1;
+
+  auto appHost = appHosts.at(assignedIndex);
+
+  if(!appHost) {
+    return -1;
+  }
+
+  auto *listenSocket = appHost->appRunner.listenSocket;
+
+  if(!listenSocket) {
+    return -1;
+  }
+
+  return us_socket_local_port(0, (struct us_socket_t *)listenSocket);
+}
+
+} // namespace facebook::react

package/cpp/UwsReactNativeModule.h

@@ -0,0 +1,30 @@
+#pragma once
+
+#include <UwsReactNativeSpecsJSI.h>
+#include "app/TemplatedAppObject.h"
+
+namespace facebook::react {
+
+class UwsReactNativeModule : public NativeUwsReactNativeCxxSpec<UwsReactNativeModule> {
+
+public:
+  UwsReactNativeModule(std::shared_ptr<CallInvoker> jsInvoker);
+
+  uws_react_native::TemplatedAppObject App(facebook::jsi::Runtime &rt,
+                                           std::optional<facebook::jsi::Object> appOptions);
+
+  facebook::jsi::Object getParts(facebook::jsi::Runtime &rt,
+                                 facebook::jsi::Object body,
+                                 facebook::jsi::String contentType);
+
+  void _us_listen_socket_close(facebook::jsi::Runtime &rt,
+                              double id
+                              /*facebook::jsi::Object listenSocket*/);
+
+  double _us_socket_local_port(facebook::jsi::Runtime &rt,
+                            double id
+                            /*facebook::jsi::Object socket*/);
+
+};
+
+}

package/cpp/app/AppHost.h

@@ -0,0 +1,37 @@
+#pragma once
+
+#include <jsi/jsi.h>
+#include <memory>
+#include "AppRunner.h"
+#include "TemplatedAppObject.h"
+
+namespace uws_react_native {
+
+class AppHost {
+
+private:
+  std::function<void ()> closeHandler;
+
+public:
+  AppRunner appRunner = {};
+
+  AppHost(std::function<void ()> &&closeHandler) {
+    // TODO Implement the uWS::App ssl options
+//    this->appRunner = std::make_shared<AppRunner>();
+
+    this->closeHandler = closeHandler;
+  }
+
+  TemplatedAppObject getTemplatedAppObject(facebook::jsi::Runtime &rt,
+                                           std::shared_ptr<facebook::react::CallInvoker> &jsInvoker,
+                                           unsigned short id) {
+    return {this->appRunner, rt, jsInvoker, id, [this]() {
+      this->appRunner.close([this]() {
+        this->closeHandler();
+      });
+    }};
+  }
+
+};
+
+}

package/cpp/app/AppRunner.h

@@ -0,0 +1,88 @@
+#pragma once
+
+#include <optional>
+#include <mutex>
+#include <thread>
+#include "uWebSockets/App.h"
+
+namespace uws_react_native {
+
+/**
+ * This simple wrapper helps consumer to run the uWebSockets server in an another thread.
+ * UI Thread and JavaScript thread must not be blocked by the app run.
+ */
+class AppRunner {
+
+private:
+  std::thread serverThread;
+
+  /**
+   * The main loop of the uWebSockets.
+   * Useful to wake the uWS Loop immediately to execute queued tasks.
+   */
+  uWS::Loop *serverLoop = nullptr;
+
+  // +++++ for socket closing +++++
+  std::mutex listenSocketMutex;
+  // ----- for socket closing -----
+
+public:
+  /**
+   * Be careful. Once the `listen` method from this class instance has been invoked,
+   * this member has moved into another rvalue.
+   *
+   * Do not run the uWebSockets server manually from this instance.
+   * If you do, you don't need this class.
+   */
+  uWS::App app;
+
+  us_listen_socket_t *listenSocket = nullptr;
+
+  void listen(const std::optional<std::string> &host,
+              const int port,
+              const std::optional<int> options,
+              std::function<void (us_listen_socket_t *listenedSocket)> &&handler) {
+    // To prevent the UI thread is getting blocked,
+    // run the server from another thread
+    // https://github.com/uNetworking/uWebSockets/issues/1858#issuecomment-2907728248
+    this->serverThread = std::thread([this, host, options, port, handler]{
+      uWS::App internalApp = uWS::App(std::move(this->app));
+      this->serverLoop = internalApp.getLoop();
+
+      std::function<void (us_listen_socket_t *listenedSocket)> listenHandler = [this, handler](auto *listenedSocket) {
+        this->listenSocket = listenedSocket;
+        handler(this->listenSocket);
+      };
+
+      if(host.has_value()) {
+        if(options.has_value()) {
+          internalApp.listen(host.value(), port, options.value(), std::move(listenHandler));
+        } else {
+          internalApp.listen(host.value(), port, std::move(listenHandler));
+        }
+      } else {
+        internalApp.listen(port, std::move(listenHandler));
+      }
+
+      this->serverLoop->run();
+    });
+
+    this->serverThread.detach();
+  };
+
+  void close(std::function<void ()> &&onClose) {
+    if(this->serverLoop) {
+      this->serverLoop->defer([this, onClose]() {
+        std::lock_guard<std::mutex> lock(this->listenSocketMutex);
+        if(this->listenSocket) {
+          us_listen_socket_close(0, this->listenSocket);
+          this->listenSocket = nullptr;
+          onClose();
+        }
+      });
+    }
+  };
+
+};
+
+} // namespace

package/cpp/app/CMakeLists.txt

@@ -0,0 +1,39 @@
+project("uws_react_native__app")
+
+file(
+	GLOB_RECURSE
+	LIB_HEADER_SRCS
+	RELATIVE
+	${CMAKE_CURRENT_SOURCE_DIR}
+	"./*.h"
+)
+
+add_library(
+	${PROJECT_NAME}
+	INTERFACE
+	${LIB_HEADER_SRCS}
+)
+
+add_library(
+	"uws_react_native::app"
+	ALIAS
+	${PROJECT_NAME}
+)
+
+target_include_directories(
+	${PROJECT_NAME}
+	INTERFACE
+	"."
+)
+
+target_link_libraries(
+	${PROJECT_NAME}
+	INTERFACE
+	reactnative
+	jsi
+	uWebSockets
+	android
+	log
+	uws_react_native::bridging
+	uws_react_native::jsi
+)