uws-react-native 0.0.10 → 0.1.0-beta.1

package/README.md

@@ -1,6 +1,6 @@
 # uws-react-native
 
-The port of [**uWebSockets**](https://github.com/uNetworking/uWebSockets) library for React Native. Inspired by the [**uWebSockets.js**](https://github.com/uNetworking/uWebSockets.js) for Node.js and tailored for React Native app.
+The port of [**uWebSockets**](https://github.com/uNetworking/uWebSockets) server library for React Native. Inspired by the [**uWebSockets.js**](https://github.com/uNetworking/uWebSockets.js) for Node.js and tailored for React Native app.
 
 - **uWebSockets** is simple, secure & standards compliant web server for the most demanding of applications. See [**uWebSockets**](https://github.com/uNetworking/uWebSockets) for more information
 - **uws-react-native** is library that allows you to easily use **uWebSockets** in your React Native through new architecture with JSI to the native C++
@@ -9,6 +9,7 @@ The port of [**uWebSockets**](https://github.com/uNetworking/uWebSockets) librar
 
 - [Installation](#installation)
   - [From NPM Registry](#from-npm-registry)
+  - [From GitHub Release](#from-github-release)
   - [From GitHub Packages](#from-github-packages)
 - [Usage](#usage)
 - [Compatibility](#compatibility)
@@ -20,7 +21,7 @@ The port of [**uWebSockets**](https://github.com/uNetworking/uWebSockets) librar
 
 ## Installation
 
-We provide two registry homes where this library lives which can be used for your project. You can use either it is from NPM registry or GitHub Packages. It has absolutely **no external JavaScript dependencies**
+We provide three registry homes where this library is available for use in your project. You can use either it is from NPM registry, or GitHub Release, or GitHub Packages. It has absolutely **no external JavaScript dependencies**
 
 ### From NPM Registry
 
@@ -39,6 +40,31 @@ pnpm
 pnpm install uws-react-native
 ```
 
+### From GitHub Release
+
+To install this library from GitHub release
+
+1. Go to this project's [GitHub Release](https://github.com/RakaDoank/uws-react-native/releases)
+2. Find the `uws-react-native-X.X.X.tgz` asset from one of the release versions
+3. Copy the asset URL or link (Right click at the asset file name in your browser)
+
+Finally, do the regular installation with the CLI, but with the asset URL
+
+npm
+```
+npm install https://github.com/.../uws-react-native-X.X.X.tgz
+```
+yarn
+```
+yarn add https://github.com/.../uws-react-native-X.X.X.tgz
+```
+pnpm
+```
+pnpm install https://github.com/.../uws-react-native-X.X.X.tgz
+```
+
+> You can also do an offline installation by downloading the tarball file first, and do the regular installation with the CLI, but with the local file path.
+
 ### From GitHub Packages
 
 First, create your GitHub personal token (classic) with `read:packages` access
@@ -77,10 +103,89 @@ pnpm install @rakadoank/uws-react-native
 ## Usage
 
 Since uws-react-native is a port of uWebSockets library for JavaScript, this library is really similar of how to use the [uWebSockets](https://github.com/uNetworking/uWebSockets) in C++, or the [uWebSockets.js](https://github.com/uNetworking/uWebSockets.js) for Node.js.
-You can refer to the [uWebSockets.js](https://github.com/uNetworking/uWebSockets.js) example.
+You can refer to the [uWebSockets.js](https://github.com/uNetworking/uWebSockets.js) example, but **we recommend to create a server in `useEffect`**.
 
 This repository does also contain the [server example](https://github.com/RakaDoank/uws-react-native/blob/main/examples/app/src/screens/home/_use-server.ts). You can also refer to it, but it is currently for library development playground rather than proper example.
 
+A simple server example
+
+```tsx
+import { useEffect } from "react"
+import * as uWS from "uws-react-native"
+
+export function Component() {
+
+  // useEffect is perfect tool for production and even in development mode.
+  // In the development mode, any changes below will restart the server automatically because of the useEffect cycle
+  useEffect(() => {
+    const app = uWS.App()
+
+    app.get("/data/:foo/:bar", (res, req) => {
+      const fooSlug = req.getParameter("foo")
+      const barSlug = req.getParameter("bar")
+
+      res.writeHeader("content-type", "application/json")
+      res.end(
+        JSON.stringify({
+          foo: fooSlug,
+          bar: barSlug,
+        });
+      )
+    })
+
+    app.get("/about", res => {
+      res.write("<html><body>")
+      res.write("<h2>Hello World</h2>")
+      res.end("</body></html>")
+    })
+
+    app.post("/data", (res, req) => {
+      let isAborted = false
+      res.onAborted(() => {
+        isAborted = true
+      })
+
+      res.onFullData(data => {
+        const textDecoder = new TextDecoder("utf-8")
+        const text = textDecoder.decode(data)
+
+        try {
+          const json = JSON.parse(text)
+
+          if(!isAborted) {
+            // send the json back
+            res.writeHeader("content-type", "application/json")
+            res.end(
+              JSON.stringify(json)
+            )
+          }
+        } catch {
+          // not a valid json
+          res.end(
+            JSON.stringify({
+              message: "Something went wrong",
+            })
+          )
+        }
+      })
+    })
+
+    app.listen("127.0.0.1", 5000, token => {
+      if(token) {
+        console.log("Listening at port 5000")
+      } else {
+        console.log("Failed to listen")
+      }
+    })
+
+    return () => {
+      app.close()
+    }
+  }, [])
+
+}
+```
+
 ## Compatibility
 
 `uws-react-native` is only compatible for new architecture of React Native.

package/cpp/UwsReactNativeModule.cpp

@@ -87,6 +87,10 @@ facebook::jsi::Object UwsReactNativeModule::getParts(facebook::jsi::Runtime &rt,
 
     auto parts = std::vector<facebook::jsi::Object>();
 
+    /// Using jsi Array with zero element and "push" it later
+    /// is only supported in React Native >= 0.86
+//    auto parts = facebook::jsi::Array(rt, 0);
+
     while(true) {
       std::optional<std::string_view> optionalPart = mp.getNextPart(headers);
       if(!optionalPart.has_value()) {

package/cpp/app/HttpResponseObject.h

@@ -3,11 +3,38 @@
 #include <ReactCommon/CallInvoker.h>
 #include <jsi/Buffer.h>
 #include <jsi/jsi.h>
+#include <react/bridging/Function.h>
 #include <utility>
-#include "RecognizedString.h"
 #include "HttpResponseObjectProvider.h"
+#include "RecognizedString.h"
+#include "WebSocketUserData.h"
 #include "uWebSockets/App.h"
 
+#ifdef REACT_NATIVE_DEBUG
+namespace {
+
+thread_local int insideCorkCallback = 0;
+
+void assumeCorked(facebook::jsi::Runtime &rt) {
+ if(!insideCorkCallback) {
+   auto console = rt.global().getProperty(rt, "console");
+   if(!console.isObject()) {
+     return;
+   }
+
+   auto warning = console.asObject(rt).getProperty(rt, "warning");
+   if(!warning.isObject()) {
+     return;
+   }
+
+   auto fn = warning.asObject(rt).asFunction(rt);
+   fn.call(rt, "Warning: uWS.HttpResponse writes must be made from within a corked callback. See documentation for uWS.HttpResponse.cork and consult the user manual.");
+ }
+}
+
+} // namespace
+#endif
+
 namespace uws_react_native {
 
 /// Only use this in the JavaScript thread
@@ -41,7 +68,15 @@ public:
                                                                                              const facebook::jsi::Value *arguments,
                                                                                              size_t count) -> facebook::jsi::Value {
       provider->res->cork([&rt_1, callback = arguments[0].asObject(rt_1).asFunction(rt_1)]() {
+#ifdef REACT_NATIVE_DEBUG
+        insideCorkCallback++;
+#endif
+
         callback.call(rt_1);
+
+#ifdef REACT_NATIVE_DEBUG
+        insideCorkCallback--;
+#endif
       });
 
       return {rt_1, thisValue};
@@ -65,7 +100,12 @@ public:
       }
 
       auto body = RecognizedString(rt_1, arguments[0]).getStringView();
+
+#ifdef REACT_NATIVE_DEBUG
+      assumeCorked(rt_1);
+#endif
       provider->res->end(body);
+
       return {rt_1, thisValue};
     }));
 
@@ -103,6 +143,9 @@ public:
         closeConnection = arguments[1].asBool();
       }
 
+#ifdef REACT_NATIVE_DEBUG
+      assumeCorked(rt_1);
+#endif
       provider->res->endWithoutBody(reportedContentLength, closeConnection);
 
       return {rt_1, thisValue};
@@ -354,50 +397,71 @@ public:
       auto fullBodyOrChunk = RecognizedString(rt_1, arguments[0]).getStringView();
       auto totalSize = arguments[1].asNumber();
 
+#ifdef REACT_NATIVE_DEBUG
+      assumeCorked(rt_1);
+#endif
       auto tryEndResult = provider->res->tryEnd(fullBodyOrChunk, static_cast<uintmax_t>(totalSize));
 
       return facebook::jsi::Array::createWithElements(rt_1, {tryEndResult.first, tryEndResult.second});
     }));
 
-    /// TODO
-    /// Implement this method later
-    /// It looks like we need to persist/save the us_socket_context_t from the ws.
-//    this->setProperty(rt, "upgrade", facebook::jsi::Function::createFromHostFunction(rt,
-//                                                                                         facebook::jsi::PropNameID::forUtf8(rt, "upgrade"),
-//                                                                                         5,
-//                                                                                         [res](facebook::jsi::Runtime &rt_1,
-//                                                                                               const facebook::jsi::Value &thisValue,
-//                                                                                               const facebook::jsi::Value *arguments,
-//                                                                                               size_t count) -> facebook::jsi::Value {
-//      if(!arguments ||
-//         count != 5 ||
-//         !arguments[0].isString() ||
-//         !arguments[1].isString() ||
-//         !arguments[2].isString() ||
-//         !arguments[3].isString() ||
-//         !arguments[4].isNumber()) {
-//        return facebook::jsi::Value::undefined();
-//      }
-//
-//      auto userData = arguments[0].asString(rt_1).utf8(rt_1);
-//      auto secWebSocketKey = arguments[1].asString(rt_1).utf8(rt_1);
-//      auto secWebSocketProtocol = arguments[2].asString(rt_1).utf8(rt_1);
-//      auto secWebSocketExtensions = arguments[3].asString(rt_1).utf8(rt_1);
-//      auto context = arguments[4].asNumber();
-//
-//      // TODO give user a warning if this method has been called outside of cork handler
-//      // assumeCorked()
-//
-//      auto *usSocketContext = reinterpret_cast<us_socket_context_t *>(static_cast<u_long>(context));
-//
-//      res->upgrade(std::string_view(userData),
-//                   std::string_view(secWebSocketKey),
-//                   std::string_view(secWebSocketProtocol),
-//                   std::string_view(secWebSocketExtensions),
-//                   usSocketContext);
-//
-//      return facebook::jsi::Value::undefined();
-//    }));
+    this->setProperty(rt, "upgrade", facebook::jsi::Function::createFromHostFunction(rt,
+                                                                                     facebook::jsi::PropNameID::forUtf8(rt, "upgrade"),
+                                                                                     5,
+                                                                                     [provider](facebook::jsi::Runtime &rt_1,
+                                                                                                const facebook::jsi::Value &thisValue,
+                                                                                                const facebook::jsi::Value *arguments,
+                                                                                                size_t count) -> facebook::jsi::Value {
+      if(!arguments || count != 5 ||
+         !arguments[1].isString() ||
+         !arguments[2].isString() ||
+         !arguments[3].isString() ||
+         !arguments[4].isBigInt()) {
+        return facebook::jsi::Value::undefined();
+      }
+
+      if(!arguments[0].isObject()) {
+        return facebook::jsi::Value::undefined();
+      }
+
+      auto userDataFnObj = arguments[0].asObject(rt_1);
+      if(!userDataFnObj.isFunction(rt_1)) {
+        return facebook::jsi::Value::undefined();
+      }
+
+      /// We are not supposed to store the user data object inside of singleton member,
+      /// such as map, vector, or any else.
+      ///
+      /// See this manual
+      /// https://github.com/uNetworking/uWebSockets/blob/master/misc/READMORE.md#the-appws-route
+      ///
+      /// Not like uWebSockets.js, there is no equivalent of v8::UniquePersistent in JSI.
+      /// So, instead of holding an JS object,
+      /// we store user data as facebook::jsi::HostObject.
+      /// See WebSocketUserData.h
+      auto userDataFn = userDataFnObj.asFunction(rt_1);
+      auto userData = std::make_shared<WebSocketUserData>();
+      userDataFn.call(rt_1,
+                      facebook::jsi::Object::createFromHostObject(rt_1, userData));
+
+      auto secWebSocketKey = arguments[1].asString(rt_1).utf8(rt_1);
+      auto secWebSocketProtocol = arguments[2].asString(rt_1).utf8(rt_1);
+      auto secWebSocketExtensions = arguments[3].asString(rt_1).utf8(rt_1);
+      auto context = arguments[4].asBigInt(rt_1).asUint64(rt_1);
+
+      auto *usSocketContext = reinterpret_cast<us_socket_context_t *>(context);
+
+#ifdef REACT_NATIVE_DEBUG
+      assumeCorked(rt_1);
+#endif
+      provider->res->upgrade(std::move(userData),
+                             std::string_view(secWebSocketKey),
+                             std::string_view(secWebSocketProtocol),
+                             std::string_view(secWebSocketExtensions),
+                             usSocketContext);
+
+      return facebook::jsi::Value::undefined();
+    }));
 
     this->setProperty(rt,
                       "write",
@@ -409,6 +473,10 @@ public:
                                                                                  const facebook::jsi::Value *arguments,
                                                                                  size_t count) -> facebook::jsi::Value {
       auto chunk = RecognizedString(rt_1, arguments[0]).getStringView();
+
+#ifdef REACT_NATIVE_DEBUG
+      assumeCorked(rt_1);
+#endif
       return provider->res->write(chunk);
     }));
 
@@ -423,6 +491,10 @@ public:
                                                                                  size_t count) -> facebook::jsi::Value {
       auto headerKey = RecognizedString(rt_1, arguments[0]).getStringView();
       auto headerVal = RecognizedString(rt_1, arguments[1]).getStringView();
+
+#ifdef REACT_NATIVE_DEBUG
+      assumeCorked(rt_1);
+#endif
       provider->res->writeHeader(headerKey, headerVal);
 
       return {rt_1, thisValue};
@@ -438,6 +510,10 @@ public:
                                                                                  const facebook::jsi::Value *arguments,
                                                                                  size_t count) -> facebook::jsi::Value {
       auto status = RecognizedString(rt_1, arguments[0]).getStringView();
+
+#ifdef REACT_NATIVE_DEBUG
+      assumeCorked(rt_1);
+#endif
       provider->res->writeStatus(status);
 
       return {rt_1, thisValue};

package/cpp/app/RecognizedString.h

@@ -19,10 +19,17 @@ private:
 
   bool valid = false;
 
+#ifdef REACT_NATIVE_DEBUG
+  void check(facebook::jsi::Runtime &rt) const {
+    if(!this->valid) {
+      throw facebook::jsi::JSError(rt, "The value is not known by RecognizedString which only recognizes string and ArrayBuffer");
+    }
+  }
+#endif
+
 public:
   RecognizedString(facebook::jsi::Runtime &rt,
-                   const facebook::jsi::Value &value,
-                   std::optional<bool> withCheck = true) {
+                   const facebook::jsi::Value &value) {
     if(value.isString()) {
       std::function<void (bool ascii, const void *pData, size_t num)> handler = [this](bool ascii, const void *pData, size_t num) {
         if(ascii) {
@@ -42,19 +49,13 @@ public:
       }
     }
 
-    if(withCheck.has_value() && withCheck.value()) {
-      this->check(rt);
-    }
-  }
-
-public:
-  void check(facebook::jsi::Runtime &rt) const {
-    if(!this->valid) {
-      throw facebook::jsi::JSError(rt, "Text and data can only be passed by string or ArrayBuffer");
-    }
+#ifdef REACT_NATIVE_DEBUG
+    this->check(rt);
+#endif
   }
 
-  bool isValid() const {
+  // Check if the Value is recognized as string
+  [[nodiscard]] bool isValid() const {
     return this->valid;
   }
 
@@ -66,6 +67,11 @@ public:
     return {this->data, this->length};
   }
 
+  static bool isValid(facebook::jsi::Runtime &rt,
+                      const facebook::jsi::Value &value) {
+    return value.isString() || (value.isObject() && value.asObject(rt).isArrayBuffer(rt));
+  }
+
 };
 
-}
+}

package/cpp/app/TemplatedAppObject.h

@@ -3,6 +3,7 @@
 #include <ReactCommon/CallInvoker.h>
 #include <ReactCommon/SchedulerPriority.h>
 #include <jsi/jsi.h>
+#include <react/bridging/Function.h>
 #include "AppRunner.h"
 #include "HttpRequestObject.h"
 #include "HttpResponseObject.h"
@@ -88,6 +89,7 @@ private:
       }
     }
 
+    // AppRunner thread
     std::function<void (uWS::HttpResponse<false> *res, uWS::HttpRequest *req)> uwsRouteHandler = [&jsInvoker, disableBodyRead, maxBodySize, asyncCallback = facebook::react::AsyncCallback(rt, std::move(callback), jsInvoker)](uWS::HttpResponse<false> *res, uWS::HttpRequest *req) {
 //      auto httpResponseObject = std::make_shared<HttpResponseObject>(rt,
 //                                                                     res,
@@ -99,6 +101,7 @@ private:
       auto sharedRequest = std::make_shared<uWS::HttpRequest>(*req);
 
       asyncCallback.callWithPriority(facebook::react::SchedulerPriority::ImmediatePriority, [httpResponseObjectProvider, sharedRequest, &jsInvoker](facebook::jsi::Runtime &rt_1, facebook::jsi::Function &cb) {
+        // React Native JS runtime
         if(httpResponseObjectProvider && sharedRequest) {
           cb.call(rt_1,
                   HttpResponseObject(rt_1, httpResponseObjectProvider, jsInvoker),
@@ -248,7 +251,16 @@ public:
                                                                                    const facebook::jsi::Value &thisValue,
                                                                                    const facebook::jsi::Value *arguments,
                                                                                    size_t count) -> facebook::jsi::Value {
-      auto callback = arguments[0].asObject(rt_1).asFunction(rt_1);
+      if(!arguments || !arguments[0].isObject()) {
+        return {rt_1, thisValue};
+      }
+
+      auto obj = arguments[0].asObject(rt_1);
+      if(!obj.isFunction(rt_1)) {
+        return {rt_1, thisValue};
+      }
+
+      auto callback = obj.asFunction(rt_1);
 
       appRunner.app.filter([&jsInvoker, asyncCallback = facebook::react::AsyncCallback(rt_1, std::move(callback), jsInvoker)](auto *res, int count) {
         auto httpResponseObjectProvider = std::make_shared<HttpResponseObjectProvider>(res);
@@ -299,7 +311,7 @@ public:
       std::optional<int> options      = std::nullopt;
 
       if(arguments[0].isString()) {
-        host = RecognizedString(rt_1, arguments[0]).getString();
+        host = arguments[0].asString(rt_1).utf8(rt_1);
         if(arguments[1].isNumber()) {
           port = arguments[1].asNumber();
         }
@@ -338,8 +350,12 @@ public:
                                                                                    const facebook::jsi::Value &thisValue,
                                                                                    const facebook::jsi::Value *arguments,
                                                                                    size_t count) -> facebook::jsi::Value {
-      auto topic = RecognizedString(rt_1, arguments[0]).getStringView();
-      return static_cast<int>(appRunner.app.numSubscribers(topic));
+      auto topic = RecognizedString(rt_1, arguments[0]);
+      if(!topic.isValid()) {
+        return {rt_1, int(0)};
+      }
+
+      return static_cast<int>(appRunner.app.numSubscribers(topic.getStringView()));
     }));
 
     this->setProperty(rt,
@@ -351,8 +367,15 @@ public:
                                                                                    const facebook::jsi::Value &thisValue,
                                                                                    const facebook::jsi::Value *arguments,
                                                                                    size_t count) -> facebook::jsi::Value {
-      auto topic = RecognizedString(rt_1, arguments[0]).getStringView();
-      auto message = RecognizedString(rt_1, arguments[1]).getStringView();
+      auto topic = RecognizedString(rt_1, arguments[0]);
+      if(!topic.isValid()) {
+        return {rt_1, false};
+      }
+
+      auto message = RecognizedString(rt_1, arguments[1]);
+      if(!message.isValid()) {
+        return {rt_1, false};
+      }
 
       bool isBinary = false;
       if(arguments[2].isBool()) {
@@ -364,38 +387,40 @@ public:
         compress = arguments[3].asBool();
       }
 
-      return appRunner.app.publish(topic,
-                             message,
-                             isBinary ? uWS::OpCode::BINARY : uWS::TEXT,
-                             compress);
+      return appRunner.app.publish(topic.getStringView(),
+                                   message.getStringView(),
+                                   isBinary ? uWS::OpCode::BINARY : uWS::TEXT,
+                                   compress);
     }));
 
-    // TODO `WebSocketObject` and `WebSocketBehaviorImpl` are not properly implemented yet
-//    this->setProperty(rt,
-//                      "ws",
-//                      facebook::jsi::Function::createFromHostFunction(rt,
-//                                                                      facebook::jsi::PropNameID::forUtf8(rt, "ws"),
-//                                                                      2,
-//                                                                      [&appRunner, &jsInvoker](facebook::jsi::Runtime &rt_1,
-//                                                                                               const facebook::jsi::Value &thisValue,
-//                                                                                               const facebook::jsi::Value *arguments,
-//                                                                                               size_t count) -> facebook::jsi::Value {
-//#ifdef REACT_NATIVE_DEBUG
-//      if(!arguments) {
-//        throw facebook::jsi::JSError(rt_1, "Expected pattern and WebSocketBehaviour argument");
-//      }
-//      if(!arguments[1].isObject()) {
-//        throw facebook::jsi::JSError(rt_1, "Expected a WebSocketBehaviour object in the second argument");
-//      }
-//#endif
-//
-//      auto pattern = RecognizedString(rt_1, arguments[0]).getString();
-//      auto behavior = WebSocketBehaviorImpl(rt_1, jsInvoker, arguments[1].asObject(rt_1));
-//
-//      appRunner.app.ws(pattern, std::move(behavior));
-//
-//      return {rt_1, thisValue};
-//    }));
+    this->setProperty(rt,
+                      "ws",
+                      facebook::jsi::Function::createFromHostFunction(rt,
+                                                                      facebook::jsi::PropNameID::forUtf8(rt, "ws"),
+                                                                      2,
+                                                                      [&appRunner, &jsInvoker](facebook::jsi::Runtime &rt_1,
+                                                                                               const facebook::jsi::Value &thisValue,
+                                                                                               const facebook::jsi::Value *arguments,
+                                                                                               size_t count) -> facebook::jsi::Value {
+      if(!arguments) {
+        return {rt_1, thisValue};
+      }
+
+      auto pattern = RecognizedString(rt_1, arguments[0]);
+      if(!pattern.isValid()) {
+        return {rt_1, thisValue};
+      }
+
+      if(!arguments[1].isObject()) {
+        return {rt_1, thisValue};
+      }
+
+      auto behavior = WebSocketBehaviorImpl(rt_1, jsInvoker, arguments[1].asObject(rt_1));
+
+      appRunner.app.ws(pattern.getString(), std::move(behavior));
+
+      return {rt_1, thisValue};
+    }));
 
     // +++++ ROUTER +++++