opal-up 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92cb787ff140257bb7f11eecfb460e9c9d458be90e723187e6c4ac9006ce1f22
-  data.tar.gz: 5d5046c915394b4c649bee550df9b25a604707655e6746e8487a0c198c26dd0a
+  metadata.gz: cd09c3697caf76eb487770a2818af0a06ee4711761a15f2d80d7d0d291747234
+  data.tar.gz: cc53773debbd42d66a2aa99e1b3d9ec3e3fcd05db99f5e58bfab94e5ecf1811a
 SHA512:
-  metadata.gz: be462aea9b579379ee5234dba708bc37ce92705bb3783d2bdcfbce367fc12a0fc606448ee868f7ef1322d65d252e036368a722ddcf9e5a12996511d49f5059d2
-  data.tar.gz: 1baf0f1da6697e95aaea33049b81bc45a0e136a1a79810284df99e7dfa5de58fdf3980fa25ccb74f29a184300f7bafd8c4ef193e1de6173741630c5c2b4ef68a
+  metadata.gz: 38c374376cfe497c4abd8039272ae616d44e5152d3ba15fc47578d789bd16d88cf8af21d2471fd71eafa0e3852f60704a0aabf03dd560bac2de5c87591724d1a
+  data.tar.gz: 0467d90a76aedd75515f38c678ce7cdcac7e36760a687c9ae6283dfdd9723ea2d0e005d67e357fbcf60491c594511c45be105002a008f650c2eb488f5f315c53

data/README.md

@@ -3,68 +3,58 @@
 
 # UP!
 
-A high performance Rack server for [Opal Ruby](https://github.com/opal/opal), Tech Demo
+A high performance Rack server for [Opal Ruby](https://opalrb.com/) and [Matz Ruby](https://www.ruby-lang.org/), Tech Demo
 
 ## Let Numbers speak first
 
 ```
-Response type:          env.to_s       "hello_world"
-Requests/Second:
-Puma:              9478.41 req/s      50822.38 req/s
-Unicorn:          12267.86 req/s      16329.68 req/s
-Falcon:           13569.35 req/s      24041.63 req/s
-Racer:            14640.34 req/s      15354.14 req/s
-Agoo:             51455.38 req/s      89022.91 req/s
-Iodine:           57257.21 req/s <<< 132723.02 req/s
-Up! node:          2096.64 req/s*     25041.14 req/s
-Up! ruby:         10616.74 req/s      69388.90 req/s
-Up! uWS:           2511.65 req/s*     83853.44 req/s
-Up! node cluster:  6627.05 req/s*     61320.38 req/s
-Up! ruby cluster: 29807.97 req/s     137782.65 req/s
-Up! uWS cluster:   8328.87 req/s*    152865.96 req/s <<< fastest
-
-Latency:
-Puma:                14.05 ms             2.62 ms
-Unicorn:             10.26 ms             7.68 ms
-Falcon:               9.32 ms             5.26 ms
-Racer:                8.90 ms             8.44 ms
-Agoo:                 2.43 ms             1.51 ms
-Iodine:               2.18 ms <<<         0.94 ms
-Up! node:            59.97 ms*            4.99 ms
-Up! uWS:             49.83 ms*            1.49 ms
-Up! ruby:            11.76 ms             1.80 ms
-Up! node cluster:    18.83 ms*            2.04 ms
-Up! ruby cluster:     4.19 ms             0.91 ms
-Up! uWS cluster:     14.99 ms*            0.82 ms <<< fastest
+Response type:               env.to_s                    "hello_world"
+                 Requests/Second   Latency       Requests/Second   Latency
+Puma:              8884.53 req/s  15.18 ms        50822.38 req/s   2.62 ms
+Unicorn:          12302.35 req/s  10.22 ms        16329.68 req/s   7.68 ms
+Falcon:           13168.82 req/s   9.49 ms        24041.63 req/s   5.26 ms
+Racer:            14536.88 req/s   8.94 ms        15354.14 req/s   8.44 ms
+Agoo:             49078.57 req/s   2.54 ms        89022.91 req/s   1.51 ms
+Iodine:           59116.53 req/s   2.11 ms <<<   134267.79 req/s   0.93 ms
+Up! bun:           3900.44 req/s  32.00 ms        47334.16 req/s   2.64 ms
+Up! ruby:         22144.33 req/s   5.64 ms        58704.09 req/s   2.14 ms
+Up! uWS:           6540.62 req/s  19.09 ms        78384.93 req/s   1.59 ms
+Up! ruby cluster: 53641.29 req/s   2.35 ms       128237.52 req/s   0.97 ms
+Up! uWS cluster:  20143.62 req/s   6.20 ms       152353.97 req/s   0.82 ms <<<
+
+<<< denotes the fastest for the response type
 
 running on/with:
 Linux, Kernel 6.5.0-x
 ruby 3.3.0, YJit enabled
-Opal 2.0-dev with node v20.11.0
+Opal 2.0-dev as of 9. Feb 2024, with node v20.11.0
 Puma 6.4.2, 4 workers, 4 threads
 Falcon 0.43.0, 4 workers, 4 threads
 Racer 0.1.3, defaults
 Unicorn 6.1.0, 4 workers
 Agoo 2.15.8, 4 workers, 4 threads
 Iodine 0.7.57, 4 workers, 1 thread
-Up! uWS 0.0.2, 1 worker
-Up! Node 0.0.2, 1 worker
-Up! Ruby 0.0.3, 1 worker
-Up! uWS cluster 0.0.2, 4 workers
-Up! Node cluster 0.0.2, 4 workers
-Up! Ruby cluster 0.0.3, 4 workers
+Up! uWS 0.0.4, 1 worker
+Up! Node 0.0.4, 1 worker
+Up! Ruby 0.0.4, 1 worker
+Up! uWS cluster 0.0.4, 4 workers
+Up! Node cluster 0.0.4, 4 workers
+Up! Ruby cluster 0.0.4, 4 workers
 
 running the example_rack_app from this repo, benchmarked with:
 bombardier http://localhost:3000/
+and taking the Avg
 
-on my old Intel(R) Core(TM) i5-6500 CPU @ 3.20GHz
-
-* please see section "About the benchmarks ..." below
+on a Intel(R) Core(TM) i5-6500 CPU @ 3.20GHz
 ```
 
 ## Introduction
 
-This is currently mainly a technical demonstration, demonstrating the speed of the [Opal Ruby](https://github.com/opal/opal) implementation employing [Node](https://nodejs.org/en) and [uWebSocketJs](https://github.com/uNetworking/uWebSockets.js) as runtime. Its not yet a generic, all purpose Rack server, but good for further experimentation, research and open for improvement.
+This is currently mainly a technical demonstration, demonstrating the speed of the [Opal Ruby](https://github.com/opal/opal) implementation employing [Node](https://nodejs.org/en) and [uWebSocketJs](https://github.com/uNetworking/uWebSockets.js) as runtime.
+
+Its not yet a generic, all purpose Rack server, but good for further experimentation, research and open for improvement. The included ruby version allows for verification of code correctness and performance. If it works with `bundle exec up_ruby` it should work equally well with the various Opal versions, at least thats the future goal.
+
+Its a intention of this project, to serve as a tool for enhancing Opal Ruby and porting Rack apps from Matz to Opal Ruby.
 
 ## Getting started
 
@@ -82,15 +72,13 @@ For a Gemfile available from rubygems:
 
 ## Available Commands
 
-Available with `bundle exec` within the example apps or if this gem  is included in your Gemfile:
+Available with `bundle exec` within the example apps or if this gem is included in your Gemfile:
 
-- `up` - starts a single worker server using Opal with uWebSockets, fastest server
-- `up_cluster` - starts a cluster of workers using Opal with uWebSockets, still fast, depending on workload may be even faster than the single worker or not
-- `up_node` - starts a single worker server using Opal with the standard Node HTTP(S) classes
-- `up_node_cluster` - starts a cluster of workers using Opal with the standard Node HTTP(S) classes, probably faster than `up_node`
+- `up` - starts a single worker server using Opal with uWebSockets
+- `up_cluster` - starts a cluster of workers using Opal with uWebSockets, fastest server
 - `up_bun` - starts single worker server using Bun, requires Opal bun support from [PR#2622](https://github.com/opal/opal/pull/2622)
-- `up_ruby` - starts a single worker using Ruby with uWebSockets in a native extension
-- `up_ruby_cluster` - starts a cluster of workers using Ruby with uWebSockets in a native extension
+- `up_ruby` - starts a single worker using Ruby with uWebSockets in a native extension, does not support the --secure option/TLS
+- `up_ruby_cluster` - starts a cluster of workers using Ruby with uWebSockets in a native extension, does not support the --secure options/TLS
 
 ```
 Usage: up [options]
@@ -106,13 +94,25 @@ When using secure sockets, the -a, -c and -k options must be provided
     -v, --version                    Show version
 
 ```
+## Supported Features
+
+Up! implements the [Rack Spec as of Rack 3.0](https://github.com/rack/rack/blob/main/SPEC.rdoc) with the following differences:
+- `rack.hijack` is not implemented, but `rack.upgrade` instead is, see "Websockets" below
+- `rack.input` is currently still missing
+- Tempfile support is currently incomplete, affecting a few keys in the Rack Env ('tempfile' missing in Opal).
+- Some Rack modules/classes still have issues when run in Opal and may not work as expected
+
+Websockets are supported following the [Iodine SPEC-WebSocket-Draft](https://github.com/boazsegev/iodine/blob/master/SPEC-WebSocket-Draft.md).
+PubSub is supported following the [Iodine SPEC-PubSub-Draft](https://github.com/boazsegev/iodine/blob/master/SPEC-PubSub-Draft.md), except for engines.
+
+A example RackApp using WebSockets and PubSub is provided in the 'example_rack_ws_app' directory
 
 ## Roda
 
 A example app for Roda is provided and _appears_ working with the following patches applied:
 
 - [Changes required to make Roda _appear_ to work](https://github.com/jeremyevans/roda/compare/master...janbiedermann:roda:master)
-- [Changes required to make Rack _appear_ to work](https://github.com/janbiedermann/rack/commit/1dadea0f9813c2df94715052d2277af13f7d0c0c)
+- [Changes required to make Rack with Roda _appear_ to work](https://github.com/janbiedermann/rack/commit/1dadea0f9813c2df94715052d2277af13f7d0c0c)
 
 Please note the phrase "_appear_ to work" in above sentences.
 To try:
@@ -129,8 +129,23 @@ To try:
 - [Mustermann patches](https://github.com/sinatra/mustermann/compare/main...janbiedermann:mustermann:main)
 - [Rack-Session patches](https://github.com/rack/rack-session/compare/main...janbiedermann:rack-session:main)
 
-## About the benchmarks and Opal/Up! performance
+## About the Benchmarks
+
+The benchmarks mainly test the overhead introduced by the rack server. 
+
+In the 'env.to_s' benchmark, the Rack environment access and response header handling overhead are measured. Simply calling env.to_s accesses all keys and serializes them briefly. If the Rack app accesses the keys of the Rack environment and sets response headers, the overhead/latency as measured can be expected, or that amount of requests per second can be expected at most.
+
+The "hello_world" benchmark measures the overhead for the simplest possible version of a meaningful Rack response and should provide maximum performance. If the Rack app just replies with a string, that overhead/latency can be expected, or that amount of requests per second can be expected at most.
+
+## Links
+
+- bombardier, the tool used for benchmarking: [https://github.com/codesenberg/bombardier](https://github.com/codesenberg/bombardier)
 
-The "hello world" benchmark results above demonstrates the great potential of using Opal/Node with uWebSocketsJs on the server for executing ruby, however, the `envt.to_s` benchmark column next to it (results marked with *) also shows, that its still possible to trigger sweet spots in Opal, that can make things a bit slow. Work continues to improve things.
+### Rack Servers
 
-Link to bombardier, the tool used for benchmarking: [https://github.com/codesenberg/bombardier](https://github.com/codesenberg/bombardier)
+- [Agoo](https://github.com/ohler55/agoo)
+- [Falcon](https://github.com/socketry/falcon)
+- [Iodine](https://github.com/boazsegev/iodine)
+- [Puma](https://github.com/puma/puma)
+- [Racer](https://rubygems.org/gems/racer) (a bit old, but included here, because it uses libuv, just like Node)
+- [Unicorn](https://yhbt.net/unicorn/)