uws-react-native 0.0.1-alpha.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,84 @@
+# 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.
+
+- **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++
+
+> ⚠️ uws-react-native is still in heavy development and research. All the uWebSockets instances are not fully implemented yet.
+
+## Installation
+
+npm
+```
+npm install uws-react-native
+```
+
+yarn
+```
+yarn add uws-react-native
+```
+
+pnpm
+```
+pnpm install 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.
+
+This repository does also contain the [example](https://github.com/RakaDoank/uws-react-native/blob/main/example/src/app/index.tsx) app. You can also refer to it, but it is currently for library development playground rather than proper example.
+
+## Compatibility
+
+`uws-react-native` is compatible only compatible for new architecture of React Native.
+
+### Platform
+
+uws-react-native is supported in Android, iOS, and macOS. Windows is currently not supported, and Web is impossible.
+
+### Unsupported APIs
+
+- **SSL options**. We need to research how to provide .pem file in React Native app and its platform architecture regarding the SSL topic
+- **WebSocket server**. Not implemented yet. It will be supported later.
+
+### New APIs
+
+There are some new APIs in uws-react-native. The most reason is because of the differentiation of React Native's architecture compared to the casual server program
+
+- The route method handler like `any`, `get`, `post` and others expects third argument as the handler options optionally. See [`HttpRouterOptions`](https://github.com/RakaDoank/uws-react-native/blob/main/package/src/types/HttpRouterOptions.ts)
+- In [`HttpResponse`](https://github.com/RakaDoank/uws-react-native/blob/main/package/src/types/HttpResponse.ts) object,
+  - `onFullData`. This is an equivalent of `res.collectBody` from uWebSockets.js, but to set the max size, provide it through route method handler options
+  - `onFullDataText`. Same as the `onFullData`, but provides the body data in raw text instead of ArrayBuffer. This is useful if you are using React Native 0.84 version or older because TextDecoder is natively supported only in React Native 0.85 version
+
+## Development & Research
+
+uws-react-native is still in heavy development and research. All the uWebSockets instances are not fully implemented yet.
+
+There are development and research things that you can read for your informations, especially if you are already familiar with uWebSockets. The most things are because of the React Native's architecture differentiation compared to the casual uWebSockets server program.
+
+### Performance & Stability
+
+This library is indeed focusing on performance, but we will focus more of it later until we reach the stability of uws-react-native due to [threading](#threading) issue. It does not mean uws-react-native will performs badly in terms of performance speed, but it is not stable enough in under a stress situation.
+
+I have tested a stress test in an Android device. A lot of incoming request roughly 100 requests per second in roughly 10 seconds for files uploading (multipart/form-data) may crash the app. We do not have the proper benchmark yet, but it is as I expected from a platform restriction of memory usage for an app. An Android device with 12GB RAM does not mean an app can use all of it. I am keeping my eyes on this issue to keep improving this stress test.
+
+### Threading
+
+We are embracing the main chaos of supporting uWebSockets in React Native architecture, which is to prevent UI/Main thread from blocking.
+
+Intentionally, we make the uWebSockets runs in another thread, therefore we have to make sure the communication safety between uWebSockets runner thread to the JS thread and vice versa. In theory, we can make uWebSockets runs in the main thread, but the app will be unusable, and then force closing the app is the only way to stop the server.
+
+We have another issue because of the uWebSockets runs in another thread. From the JSI C++ side, we have to assume any JS function as a callback especially the route method handler is asynchronous. We cannot make a sync call to the JS function from an arbitrary thread to the JS thread, and it makes JS call to the uWebSockets runner is also late.
+
+For this case especially, we have to predefined two instances in the C++ uWebSockets route method handler because of the late call, and the late call would not be tolerated by the uWebSockets internally for some instances
+
+- `res.onAborted`
+
+We have to predefined the `onAborted` callback in C++ side and prevent `res.end` call from JavaScript internally in C++ side. Normally, you would check if it is already aborted or not before calling the end method, but our predefined `onAborted` callback may also late to tell to the JavaScript side. If we are not predefining this method, uWebSockets assumes that you have not assign `onAborted` callback at the time due to the `res.onAborted` assignment from JavaScript is also late.
+
+- `res.onDataV2`
+
+For the `onData` and `onDataV2`, we have predefined it with a single `onDataV2` callback in C++ side. If this method is not predefined, uWebSockets will not collect any incoming body data. If a route method handler is sure that it doesn't expect any body data at all, a route method handler can disable the body reading through the third argument in `any`, `get`, `post`, and other route methods.

package/UwsReactNative.podspec

@@ -0,0 +1,71 @@
+require "json"
+
+package = JSON.parse(File.read(File.join(__dir__, "package.json")))
+
+Pod::Spec.new do |s|
+  s.name         = "UwsReactNative"
+  s.version      = package["version"]
+  s.summary      = package["description"]
+  s.homepage     = package["homepage"]
+  s.license      = package["license"]
+  s.authors      = package["author"]
+
+  s.platforms    = { :ios => min_ios_version_supported, :osx => "10.14" }
+  s.source       = { :git => package["repository"]["url"], :tag => "#{s.version}" }
+
+  s.source_files          = "apple/**/*.{h,m,mm,cpp}", "cpp/*.{cpp,h}"
+  s.ios.exclude_files     = "**/*.macos.{h,m,mm}"
+  s.tvos.exclude_files    = "**/*.macos.{h,m,mm}"
+  s.osx.exclude_files     = "**/*.ios.{h,m,mm}"
+  s.private_header_files  = "apple/**/*.h"
+
+  # zlib
+  s.libraries    = "z"
+
+  s.pod_target_xcconfig = {
+    # Fix IPV6_RECVPKTINFO undeclared for uSockets
+    "GCC_PREPROCESSOR_DEFINITIONS" => "$(inherited) __APPLE_USE_RFC_3542"
+  }
+
+  s.subspec "app" do |ss|
+    ss.source_files         = "cpp/app/**/*.h"
+    ss.project_header_files = "cpp/app/**/*.h"
+    ss.header_mappings_dir  = "cpp"
+  end
+
+  s.subspec "bridging" do |ss|
+    ss.source_files         = "cpp/bridging/**/*.h"
+    ss.project_header_files = "cpp/bridging/**/*.h"
+    ss.header_mappings_dir  = "cpp"
+  end
+
+  s.subspec "jsi" do |ss|
+    ss.source_files         = "cpp/jsi/**/*.h"
+    ss.project_header_files = "cpp/jsi/**/*.h"
+    ss.header_mappings_dir  = "cpp"
+  end
+
+  s.subspec "uSockets" do |ss|
+    ss.source_files         = "cpp/uSockets/**/*.{c,cpp,h}"
+  
+    # Same like the cpp/CMakeLists.txt
+    # whoever want to use uSockets including the uWebSockets
+    # They just need to write like ` #include "libusockets.h" `.
+    ss.header_mappings_dir  = "cpp/uSockets"
+  
+    ss.pod_target_xcconfig = {
+      "GCC_PREPROCESSOR_DEFINITIONS" => "$(inherited) LIBUS_NO_SSL"
+    }
+  end
+
+  s.subspec "uWebSockets" do |ss|
+    ss.source_files         = "cpp/uWebSockets/uWebSockets/*.h"
+    ss.project_header_files = "cpp/uWebSockets/uWebSockets/*.h"
+    ss.header_mappings_dir  = "cpp/uWebSockets"
+  end
+
+  s.dependency "React-jsi"
+  s.dependency "React-callinvoker"
+
+  install_modules_dependencies(s)
+end

package/android/build.gradle.kts

@@ -0,0 +1,138 @@
+buildscript {
+  val module by extra(
+    mapOf(
+      "kotlinVersion" to "2.0.21",
+      "minSdkVersion" to 28,
+      "compileSdkVersion" to 36,
+      "targetSdkVersion" to 36,
+    )
+  )
+
+  val getExtOrDefault by extra {
+    { name: String ->
+      if(rootProject.extra.has(name)) {
+        rootProject.extra[name]!!
+      } else {
+        module[name]!!
+      }
+    }
+  }
+
+  repositories {
+    google()
+    mavenCentral()
+  }
+
+  dependencies {
+    classpath("com.android.tools.build:gradle:8.7.2")
+
+    // noinspection DifferentKotlinGradleVersion
+    classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:${getExtOrDefault("kotlinVersion")}")
+  }
+}
+
+plugins {
+  id("com.android.library")
+  id("org.jetbrains.kotlin.android")
+
+  id("com.facebook.react")
+}
+
+android {
+  @Suppress("UNCHECKED_CAST")
+  val getExtOrDefault = extra["getExtOrDefault"] as (String) -> Any
+
+  namespace = "id.sufeni.oss.uwsreactnative"
+
+  compileSdk = getExtOrDefault("compileSdkVersion") as Int
+
+  defaultConfig {
+    minSdk = getExtOrDefault("minSdkVersion") as Int
+
+    // https://issuetracker.google.com/issues/230625468?pli=1
+    // It is not useful for libraries to declare a targetSdkVersion and soon the manifest merger will ignore it.
+    // targetSdk = getExtOrDefault("targetSdkVersion") as Int
+
+//    externalNativeBuild {
+//      cmake {
+//        cppFlags += listOf(
+//          "-frtti",
+//          "-fexceptions",
+//          "-Wall",
+//          "-fstack-protector-all",
+//        )
+//        arguments += listOf(
+//          "-DANDROID_STL=c++_shared",
+//          "-DANDROID_SUPPORT_FLEXIBLE_PAGE_SIZES=ON",
+//        )
+//
+//        buildTypes {
+//          debug {
+//            cppFlags += "-01 -g"
+//          }
+//          release {
+//            cppFlags += "-02"
+//          }
+//        }
+//      }
+//    }
+  }
+
+  // We don't need this, because the current CMakeLists.txt is
+  // already picked and linked by React Native (app level) to build C++ Turbo Module
+  // with a help by our `dependency.platform.android.cxxModuleCMakeListsPath` option in `react-native.config.js`.
+  // We may only need this for custom JNI
+//  externalNativeBuild {
+//    cmake {
+//      path("CMakeLists.txt")
+//    }
+//  }
+
+//  packaging {
+//    resources {
+//      excludes += listOf(
+//        "META-INF",
+//        "META-INF/**",
+//        "**/libjsi.so",
+//        "**/libc++_shared.so",
+//        "**/libreact_render*.so",
+//        "**/libreactnativejni.so",
+//        "**/libreact_performance_timeline.so",
+//        // In 0.76 multiple react-native's libraries were merged and these are the main new artifacts we're using.
+//        // Some above lib* names could be removed after we remove support for 0.76.
+//        // https://github.com/facebook/react-native/pull/43909
+//        // https://github.com/facebook/react-native/pull/46059
+//        "**/libfbjni.so",
+//        "**/libreactnative.so"
+//      )
+//    }
+//  }
+
+  buildFeatures {
+    buildConfig = true
+    prefab = true
+  }
+
+  buildTypes {
+    debug {
+      isJniDebuggable = true
+    }
+    release {
+      isMinifyEnabled = false
+    }
+  }
+
+  lint {
+    disable += "GradleCompatible"
+    targetSdk = getExtOrDefault("targetSdkVersion") as Int
+  }
+
+  compileOptions {
+    sourceCompatibility = JavaVersion.VERSION_17
+    targetCompatibility = JavaVersion.VERSION_17
+  }
+}
+
+dependencies {
+  implementation("com.facebook.react:react-android")
+}

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,2 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+</manifest>

package/android/src/main/java/id/sufeni/oss/uwsreactnative/UwsReactNativePackage.kt

@@ -0,0 +1,18 @@
+package id.sufeni.oss.uwsreactnative
+
+import com.facebook.react.BaseReactPackage
+import com.facebook.react.bridge.NativeModule
+import com.facebook.react.bridge.ReactApplicationContext
+import com.facebook.react.module.model.ReactModuleInfo
+import com.facebook.react.module.model.ReactModuleInfoProvider
+
+class UwsReactNativePackage : BaseReactPackage() {
+  override fun getModule(name: String, reactContext: ReactApplicationContext): NativeModule? {
+    return null
+  }
+
+  override fun getReactModuleInfoProvider() = ReactModuleInfoProvider {
+    mapOf()
+  }
+
+}

package/apple/OnLoad.mm

@@ -0,0 +1,17 @@
+#import <Foundation/Foundation.h>
+#import <ReactCommon/CxxTurboModuleUtils.h>
+#import "UwsReactNativeModule.h"
+
+@interface UwsReactNativeOnLoad : NSObject
+@end
+
+@implementation UwsReactNativeOnLoad
+
++ (void)load {
+  facebook::react::registerCxxModuleToGlobalModuleMap(std::string(facebook::react::UwsReactNativeModule::kModuleName),
+                                                      [](std::shared_ptr<facebook::react::CallInvoker> jsInvoker) {
+    return std::make_shared<facebook::react::UwsReactNativeModule>(jsInvoker);
+  });
+}
+
+@end