opal-up 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d20b2473096aef989d7b0d966ae78805db8798bc3d0957e9785252610cb7717
-  data.tar.gz: 26fd5a5a1fd37c574844bfad0abefc4af06a3eae4f2d305f7e3a0fed2bf0bb23
+  metadata.gz: 6b5f1d401dd86a88d34ec1137b212d166a60dc376acb94f2123d6c4b29f0dd61
+  data.tar.gz: f8f37f91e0de3dbd37974411e08babe4c5c07a3f1776f9d63016d7b6da13becc
 SHA512:
-  metadata.gz: dfe04b8cc20af1634eedb70b6d782e85ed6c2b7faf8d318c7efac9c216d11439293427d9e143656559fd26343466bd5aee4a58a51ff846ce9ca034e3c25ef980
-  data.tar.gz: 1feec67ff1e68b488a49bbe2d583ea981ea6dab797c338faeec0fd8b0991b41814f558b435f38054508fd3d26141dde878f3d4c10abbfe06a661c39245d9c39e
+  metadata.gz: 9e4b3f682584aca6cac12aa0cdc97304005d6d791bbd2a7228f353298290dbd05feabe9409eb1863cbce5120c416ef94c111c1498bdbb9984bc7ab2eb2b10b82
+  data.tar.gz: 5834fece6b8c7ee428242bdfaebb65e49c7cdbc4f2df8b125c05485b476ec471ba5e3c7287c4d00d72cb20851bbd6f2dcf13c748d1f483b1ee42a03617239e75

data/LICENSE

@@ -19,3 +19,212 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
+
+
+
+Files from the uWebSocket project in the lib/up_ext directory have been
+originally taken from https://github.com/uNetworking/uWebSockets and
+employ the Apache License as follows and as specified within the files itself:
+
+                                 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.
+

data/README.md

@@ -1,40 +1,60 @@
 <img src="https://raw.githubusercontent.com/janbiedermann/up/master/up_logo.svg" alt="UP Logo">
-<small>Original Image by <a href="https://www.freepik.com/free-vector/colorful-arrows_715199.htm#query=up&position=3&from_view=search&track=sph&uuid=63f9eddf-02a6-4e5c-8178-8cfa507ee33d">Freepik</a>, modified though</small>
+<small>(Original Image by <a href="https://www.freepik.com/free-vector/colorful-arrows_715199.htm#query=up&position=3&from_view=search&track=sph&uuid=63f9eddf-02a6-4e5c-8178-8cfa507ee33d">Freepik</a>, modified though)</small>
 
 # UP!
 
-A high performance Rack server for Opal Ruby, 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
 
 ```
-Requests per second:
-Puma:      6391.01 req/s
-Iodine:   18645.58 req/s
-Up! node:  3801.21 req/s
-Up! uWS:  20258.46 req/s <<< fastest
-
-Time per Request, mean, across all concurrent requests:
-Puma:     0.156ms
-Iodine:   0.054ms
-Up! node: 0.275ms
-Up! uWS:  0.049ms  <<< fastest
-
-running on Linux with:
+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 1.8.2 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
-Iodine 0.7.57, 4 workers, 4 threads
-Up! uWS 0.0.1, 1 worker, no threads
-Up! Node 0.0.2, 4 workers, no 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.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:
-ab -n 100000 -c 10 http://localhost:3000/
+bombardier http://localhost:3000/
+and taking the Avg
+
+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 implementation employing Node and UWebSocketJs 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
 
@@ -52,13 +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 uWebSockets, fastest server
-- `up_cluster` - starts a cluster of workers using uWebSockets, still fast, depending on workload may be even faster than the single worker or not
-- `up_node` - starts a single worker server using the standard Node HTTP(S) classes
-- `up_node_cluster` - starts a cluster of workers using 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, 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]
@@ -74,10 +94,58 @@ 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 with Roda _appear_ to work](https://github.com/janbiedermann/rack/commit/1dadea0f9813c2df94715052d2277af13f7d0c0c)
+
+Please note the phrase "_appear_ to work" in above sentences.
+To try:
+- clone Rack 3.0.9 and Roda 3.76
+- apply the patch sets above
+- set paths in the example_roda_app to point to your cloned rack & roda repos
+- and up! the server
+
+## Sinatra, others ...
+
+... currently do not work! A example app for Sinatra is provided, for convenience of developing and expanding the capabilities of Opal.
+
+- [Sinatra patches](https://github.com/sinatra/sinatra/compare/main...janbiedermann:sinatra:main)
+- [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
+
+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.
 
-## Roda, Sinatra, others ...
+## Links
 
-... currently do not work! Just basic Rack apps with a few dependencies.
+- bombardier, the tool used for benchmarking: [https://github.com/codesenberg/bombardier](https://github.com/codesenberg/bombardier)
 
-Example apps for Roda and Sinatra are provided, for convenience of developing and expanding the capabilities of Opal.
+### Rack Servers
 
+- [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/)

data/bin/up_ruby

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'up/cli'
+require 'up/ruby/server_cli'
+Up::CLI.call

data/bin/up_ruby_cluster

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'up/cli'
+require 'up/ruby/cluster_cli'
+Up::CLI.call