Skip to content

README.md

Latest commit

 

History

History
37 lines (26 loc) · 4.26 KB

README.md

File metadata and controls

37 lines (26 loc) · 4.26 KB

react-native-echo

A library to embed a HTTP server in a React Native app with thread safety to handle high-volume and high-pressure requests.

⚠️ The library is still in development and research. I'm still playing around with this library. Read in research

See this example of how to use this library.

Features

  • Built-in support for JSON thanks to the nature of JavaScript
  • Memory optimized for multipart/form-data request handling support with its cached file instead of holding an array buffer
  • Simple library APIs and reimplementation to the Web APIs as similar as possible
  • Route handling in event loop per thread for better handling to a lot of request

Pending

  • Static file and/or directory serving
  • WebSocket support for real time bidirectional communication
  • HTTP server for iOS & macOS support. Possibly with Swift NIO Transport Services

in Research

I'm still in research to make this library performs better in high-volume and high-pressure requests. Eventually, it can't perform any better than a regular computer server due to the hardware and the platform software code naturally.

This library is using Ktor server with Netty in Android. react-native-echo is currently doing good relatively with the Ktor + Netty server library with really minimal error, and the multipart/form-data request handling is still performing good with cached files, but the performance in a Android device is becoming a question from myself, is this good or not.

I did a simple Postman runner performance test, with 20 Virtual Users run an API in parallel and repeatedly for 1 minute. I did the test with a Realme GT Master (Snapdragon 778G, 8GB RAM. It doesn't mean the library use all the power of the device, because we are limited in an Android app)

Route Description Total Requests Requests/second Avg. response time (ms) Min response time (ms) Max response time (ms) P90 (ms) P95 (ms) P99 (ms) Error
GET /api/hello/world A simple route to get a simple JSON response 1077 15.88 73 13 523 152 207 452 0
POST /api/formdata I sent one string entry, and two entries of file. The server (RN side) is returning one file information in JSON response (see the example app) 783 11.55 681 82 7441 1343 1606 3266 0
POST /api/json Sent a JSON in the body, and give the JSON back to the response (with JSON.parse from RN side) 1053 15.75 208 10 6914 192 290 6715 1 (ECONRESET)

The /api/json avg and max time is high because of the one error. It's actually doing good as the /api/hello/world.

I also plan to use uWebSockets server in Android to make the JavaScript side communicate back and forth with C++ through JSI with a little overhead, and probably with NitroModules, if they can perform better than the current implementation with Ktor+Netty server with React Native Turbo Module.

Currently in working. See the "jsi" branch of this repository.