opal-up 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd1f3da03559ae97160438ac56cab04162d985d069f73fdbb228e18a83f21757
-  data.tar.gz: 880e5c28a44a8aba0d160c07994d4ca69b5b15051e0fd9948e7aa5b0696a9b82
+  metadata.gz: 2d20b2473096aef989d7b0d966ae78805db8798bc3d0957e9785252610cb7717
+  data.tar.gz: 26fd5a5a1fd37c574844bfad0abefc4af06a3eae4f2d305f7e3a0fed2bf0bb23
 SHA512:
-  metadata.gz: '0491776446d5623ebe8ccacde009d9e448778bff5c5803ebfa4f30ea70b0178454fe5d9b39ba8f9e8d0e54be20a607a81e854f758c64aea5dc9cc4d7ae495821'
-  data.tar.gz: 25659ca070cc81c078599f2281f2f52c4862f10ebadf284257d9c420380319d98708b77233cd6fb684b064d931c58e50bc893aaedf763f2c5c42d35b81392f51
+  metadata.gz: dfe04b8cc20af1634eedb70b6d782e85ed6c2b7faf8d318c7efac9c216d11439293427d9e143656559fd26343466bd5aee4a58a51ff846ce9ca034e3c25ef980
+  data.tar.gz: 1feec67ff1e68b488a49bbe2d583ea981ea6dab797c338faeec0fd8b0991b41814f558b435f38054508fd3d26141dde878f3d4c10abbfe06a661c39245d9c39e

data/README.md

@@ -1,7 +1,7 @@
 <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>
 
-# UP
+# UP!
 
 A high performance Rack server for Opal Ruby, Tech Demo
 
@@ -9,28 +9,32 @@ A high performance Rack server for Opal Ruby, Tech Demo
 
 ```
 Requests per second:
-Puma:    6391.01 req/s
-Iodine: 18645.58 req/s
-Up!:    20258.46 req/s <<< fastest
+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!:     0.049ms  <<< fastest
-```
-running on linux with:
+Puma:     0.156ms
+Iodine:   0.054ms
+Up! node: 0.275ms
+Up! uWS:  0.049ms  <<< fastest
+
+running on Linux with:
 ruby 3.3.0, YJit enabled
-Opal 1.8.2 with node v2011.0
+Opal 1.8.2 with node v20.11.0
 Puma 6.4.2, 4 workers, 4 threads
 Iodine 0.7.57, 4 workers, 4 threads
-Up! 0.0.1, 1 worker, no threads
+Up! uWS 0.0.1, 1 worker, no threads
+Up! Node 0.0.2, 4 workers, no threads
 
 running the example_rack_app from this repo, benchmarked with:
-`ab -n 100000 -c 10 http://localhost:3000/`
+ab -n 100000 -c 10 http://localhost:3000/
+```
 
 ## 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 Reck 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 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.
 
 ## Getting started
 
@@ -41,7 +45,35 @@ To start experimenting:
 - bundle install
 - bundle exec up
 
-You may want to change the `gem 'up'` line in the Gemfile to use up from rubygems, if you want to run your app outside of the cloned repo.
+You may want to change the `gem 'opal-up'` line in the Gemfile to use up from rubygems, if you want to run your app outside of the cloned repo.
+
+For a Gemfile available from rubygems:
+`gem 'opal-up'`
+
+## Available Commands
+
+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_bun` - starts single worker server using Bun, requires Opal bun support from [PR#2622](https://github.com/opal/opal/pull/2622)
+
+```
+Usage: up [options]
+
+    -h, --help                       Show this message
+    -p, --port PORT                  Port number the server will listen to
+    -b, --bind ADDRESS               Address the server will listen to
+    -s, --secure                     Use secure sockets.
+When using secure sockets, the -a, -c and -k options must be provided
+    -a, --ca-file FILE               File with CA certs
+    -c, --cert-file FILE             File with the servers certificate
+    -k, --key-file FILE              File with the servers certificate
+    -v, --version                    Show version
+
+```
 
 ## Roda, Sinatra, others ...
 

data/bin/up

@@ -1,29 +1,12 @@
 #!/usr/bin/env ruby
 
 if RUBY_ENGINE == 'opal'
-  require 'up-node'
+  require 'up/u_web_socket/server_cli'
   Up::CLI.call
 else
-  # check for commands
-  node_cmd = `which node`
-  npm_cmd = `which npm`
-  raise "Please install node first!" if !node_cmd || node_cmd.empty?
-  raise "Please install npm first!" if !npm_cmd || npm_cmd.empty?
-  node_cmd.chop! if node_cmd.end_with?("\n")
-  npm_cmd.chop! if npm_cmd.end_with?("\n")
-  got_uws = `npm list|grep uWebSockets.js@20`
-  `npm i uNetworking/uWebSockets.js#v20.41.0` if got_uws.empty?
+  require 'up/cli'
+  Up::CLI.setup_u_web_socket
   lib_dir = File.expand_path("#{__dir__}/../lib")
-
-  # Opal does not yet support gems, so lets read the Gemfile and simply add each gem
-  # to the Opal load path and require it, works for some gems, fails for others
-  gems = ""
-  if File.exist?("Gemfile")
-    lines = File.readlines('Gemfile')
-    lines.each do |line|
-      m = /gem ['"](\w+)['"]/.match(line)
-      gems << " -g #{m[1]} -r #{m[1]}" if m && m[1] != 'up'
-    end
-  end
-  Kernel.exec("opal -Rnodejs -E -I. -I#{lib_dir} -g rack #{gems} #{__FILE__}")
+  gems = Up::CLI.get_gems_for_cmd
+  Kernel.exec("opal -Rnodejs -E -I. -I#{lib_dir} -g rack #{gems} #{__FILE__} -- #{ARGV.join(' ')}")
 end

data/bin/up_bun

@@ -1,23 +1,12 @@
 #!/usr/bin/env ruby
 
 if RUBY_ENGINE == 'opal'
-  require 'up-bun'
+  require 'up/bun/server_cli'
   Up::CLI.call
 else
-  # check for commands
-  bun_cmd = `which bun`
-  raise "Please install bun first!" if !bun_cmd || bun_cmd.empty?
-  bun_cmd.chop! if bun_cmd.end_with?("\n")
+  require 'up/cli'
+  Up::CLI.setup_bun
   lib_dir = File.expand_path("#{__dir__}/../lib")
-  # Opal does not yet support gems, so lets read the Gemfile and simply add each gem
-  # to the Opal load path and require it, works for some gems, fails for others
-  gems = ""
-  if File.exist?("Gemfile")
-    lines = File.readlines('Gemfile')
-    lines.each do |line|
-      m = /gem ['"](\w+)['"]/.match(line)
-      gems << " -g #{m[1]} -r #{m[1]}" if m && m[1] != 'up'
-    end
-  end
-  Kernel.exec("opal -Rbun -E -I. -I#{lib_dir} -g rack #{gems} #{__FILE__}")
+  gems = Up::CLI.get_gems_for_cmd
+  Kernel.exec("opal -Rbun -E -I. -I#{lib_dir} -g rack #{gems} #{__FILE__} -- #{ARGV.join(' ')}")
 end

data/bin/up_cluster

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+if RUBY_ENGINE == 'opal'
+  require 'up/u_web_socket/cluster_cli'
+  Up::CLI.call
+else
+  require 'up/cli'
+  Up::CLI.setup_u_web_socket
+  lib_dir = File.expand_path("#{__dir__}/../lib")
+  gems = Up::CLI.get_gems_for_cmd
+  Kernel.exec("opal -Rnodejs -E -I. -I#{lib_dir} -g rack #{gems} #{__FILE__} -- #{ARGV.join(' ')}")
+end

data/bin/up_node

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+if RUBY_ENGINE == 'opal'
+  require 'up/node/server_cli'
+  Up::CLI.call
+else
+  require 'up/cli'
+  Up::CLI.setup_node
+  lib_dir = File.expand_path("#{__dir__}/../lib")
+  gems = Up::CLI.get_gems_for_cmd
+  Kernel.exec("opal -Rnodejs -E -I. -I#{lib_dir} -g rack #{gems} #{__FILE__} -- #{ARGV.join(' ')}")
+end

data/bin/up_node_cluster

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+if RUBY_ENGINE == 'opal'
+  require 'up/node/cluster_cli'
+  Up::CLI.call
+else
+  require 'up/cli'
+  Up::CLI.setup_node
+  lib_dir = File.expand_path("#{__dir__}/../lib")
+  gems = Up::CLI.get_gems_for_cmd
+  Kernel.exec("opal -Rnodejs -E -I. -I#{lib_dir} -g rack #{gems} #{__FILE__} -- #{ARGV.join(' ')}")
+end

data/example_roda_app/Gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
-gem 'opal', github: 'opal/opal'
+gem 'rack', path: '../../rack'
 gem 'opal-up', path: '../'
-gem 'roda'
+gem 'roda', path: '../../roda'

data/example_roda_app/roda_app.rb

@@ -1,7 +1,9 @@
 require "roda"
 
 class RodaApp < Roda
+  STDERR.puts "executing route"
   route do |r|
+    STDERR.puts r
     # GET / request
     r.root do
       r.redirect "/hello"

data/example_sinatra_app/Gemfile

@@ -3,4 +3,4 @@ git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
 gem 'opal', github: 'opal/opal'
 gem 'opal-up', path: '../'
-gem 'sinatra', '>= 4.0.0'
+gem 'sinatra'

data/lib/up/bun/rack_env.rb

@@ -0,0 +1,104 @@
+# backtick_javascript: true
+
+require 'logger'
+require 'up/version'
+
+module Up
+  module Bun
+    class RackEnv < ::Hash
+      RACK_VARS = %w[rack.errors rack.hijack rack.hijack? rack.input rack.logger
+                    rack.multipart.buffer_size rack.multipart.tempfile_factory
+                    rack.response_finished
+                    rack.session rack.upgrade rack.upgrade? rack.url_scheme
+                    HTTP_ACCEPT HTTP_ACCEPT_ENCODING HTTP_ACCEPT_LANGUAGE
+                    HTTP_CONNECTION HTTP_HOST HTTP_USER_AGENT PATH_INFO QUERY_STRING REQUEST_METHOD
+                    SCRIPT_NAME SERVER_NAME SERVER_PROTOCOL SERVER_SOFTWARE]
+      def initialize(req, config)
+        @req = req
+        @config = config
+      end
+
+      def [](key)
+        return super(key) if key?(key)
+        self[key] = case key
+                    when 'rack.errors'
+                      STDERR
+                    when 'rack.hijack'
+                      nil
+                    when 'rack.hijack?'
+                      false
+                    when 'rack.input'
+                      ::IO.new
+                    when 'rack.logger'
+                      ::Logger.new(self['rack.errors'])
+                    when 'rack.multipart.buffer_size'
+                      4096
+                    when 'rack.multipart.tempfile_factory'
+                      proc { |_filename, _content_type| File.new }
+                    when 'rack.response_finished'
+                      []
+                    when 'rack.session'
+                      {}
+                    when 'rack.upgrade'
+                      nil
+                    when 'rack.upgrade?'
+                      nil
+                    when 'rack.url_scheme'
+                      @config[:scheme]
+                    when 'PATH_INFO'
+                      `#@req.url`
+                    when 'QUERY_STRING'
+                      ""
+                    when 'RACK_ERRORS'
+                      self['rack.errors']
+                    when 'RACK_LOGGER'
+                      self['rack.logger']
+                    when 'REQUEST_METHOD'
+                      `#@req.method`
+                    when 'SCRIPT_NAME'
+                      ""
+                    when 'SERVER_NAME'
+                      @config[:host]
+                    when 'SERVER_PORT'
+                      @config[:port].to_s
+                    when 'SERVER_PROTOCOL'
+                      ""
+                    when 'SERVER_SOFTWARE'
+                      "#{@config[:handler]}/#{Up::VERSION} #{@config[:engine]}"
+                    else
+                      if key.start_with?('HTTP_')
+                        key = key[5..].gsub(/_/, '-')
+                        `#@req.headers.get(key.toLowerCase())`
+                      else
+                        nil
+                      end
+                    end
+      end
+
+      def req_headers
+        h = {}
+        %x{
+          var hdr, hds = #@req.headers;
+          for (hdr of hds) { h.set(hdr[0], hdr[1]); }
+        }
+        h
+      end
+
+      def each
+        unless @got_them_all
+          RACK_VARS.each { |k| self[k] unless self.key?(k) }
+          @got_them_all = true
+        end
+        super
+      end
+
+      def to_s
+        unless @got_them_all
+          RACK_VARS.each { |k| self[k] unless self.key?(k) }
+          @got_them_all = true
+        end
+        super
+      end
+    end
+  end
+end

data/lib/up/bun/rack_server.rb

@@ -0,0 +1,25 @@
+require 'up/bun/server'
+
+module Up
+  module Bun
+    module RackServer
+      def self.run(app, options = {})
+        raise "already running" if @server
+        @server = Up::Bun::Server.new(app: app, **options).listen
+        true
+      end
+
+      def self.shutdown
+        @server&.stop
+        @server = nil
+      end
+    end
+  end
+end
+
+ENV['RACK_HANDLER'] ||= 'up'
+
+begin
+  ::Rackup::Handler.register('up', Up::Bun::RackServer) if defined?(::Rackup::Handler)
+rescue StandardError
+end

data/lib/up/bun/server.rb

@@ -0,0 +1,89 @@
+# backtick_javascript: true
+require 'up/cli'
+require 'up/bun/rack_env'
+
+module Up
+  module Bun
+    class Server
+      def initialize(app:, host: 'localhost', port: 3000, scheme: 'http', ca_file: nil, cert_file: nil, key_file: nil)
+        @app = app
+        @scheme    = scheme || 'http'
+        raise "unsupported scheme #{@scheme}" unless %w[http https].include?(@scheme)
+        @host      = host || 'localhost'
+        @port      = port&.to_i || 3000
+        @config    = { handler: self.class.name, engine: "bun/#{`process.version`}", port: port, scheme: scheme, host: host }.freeze
+        @ca_file   = ca_file
+        @cert_file = cert_file
+        @key_file  = key_file
+        @server = nil
+      end
+
+      %x{
+        self.handle_headers = function(rack_headers, bun_hdr) {
+          if (rack_headers.$$is_hash) {
+            var header, k, v;
+            for(header of rack_headers) {
+              k = header[0];
+              if (!k.startsWith('rack.')) {
+                v = header[1];
+                if (v.$$is_array) {
+                  v = v.join("\n");
+                }
+                bun_hdr.set(k, v);
+              }
+            }
+          }
+        }
+
+        self.handle_response = function(parts, body) {
+          if (parts["$respond_to?"]('each')) {
+            // this is not technically correct, just to make things work
+            #{`parts`.each { |part| `body = body + part` }}
+          } else if (parts["$respond_to?"]('call')) {
+            body = parts.$call();
+          }
+          #{`parts`.close if `parts`.respond_to?(:close)}
+          return body;
+        }
+      }
+      def listen
+        raise "already running" if @server
+        %x{
+          const oubr = Opal.Up.Bun.RackEnv;
+          const oubs = Opal.Up.Bun.Server;
+
+          var server_options = {
+            port: #@port,
+            hostname: #@host,
+            development: false,
+            fetch(req) {
+              const rack_res = #@app.$call(oubr.$new(req, #@config));
+              const hdr = new Headers();
+              oubs.handle_headers(rack_res[1]);
+              var body = '';
+              body = oubs.handle_response(rack_res[2], body);
+              return new Response(body, {status: rack_res[0], statusText: 'OK', headers: hdr});
+            }
+          };
+          if (#@scheme === 'https') {
+            server_options.tls = {
+              key: Bun.file(#@key_file),
+              cert: Bun.file(#@cert_file),
+              ca: Bun.file(#@ca_file)
+            };
+          }
+      
+          #@server = Bun.serve(server_options);
+          console.log(`Server is running on ${#@scheme}://${#@host}:${#@port}`);
+        }
+      end
+
+      def stop
+        if Up::CLI::stoppable?
+          `#@server.stop()`
+          @server = nil
+        end
+      end
+    end
+  end
+end

data/lib/up/bun/server_cli.rb

@@ -0,0 +1,15 @@
+require 'opal/platform'
+require 'bun/file'
+require 'nodejs/require'
+require 'opal-parser'
+require 'rack/builder'
+require 'up/rack_builder_patch'
+require 'up/bun/rack_server'
+
+module Up
+  module CLI
+    def self.call
+      Up::Bun::RackServer.run(get_app, get_options)
+    end
+  end
+end

data/lib/up/cli.rb

@@ -0,0 +1,151 @@
+require 'optparse'
+require 'up/version'
+
+module Up
+  module CLI
+    class Options < OptionParser
+      attr_reader :options
+      def initialize
+        super
+        @options = {}
+        self.banner = 'Usage: up [options]'
+        separator ''
+        on('-h', '--help', 'Show this message') do
+          puts self
+          exit
+        end
+        on('-p', '--port PORT', String, 'Port number the server will listen to') do |port|
+          options[:port] = port.to_i
+        end
+        on('-b', '--bind ADDRESS', String, 'Address the server will listen to') do |host|
+          options[:host] = host
+        end
+        on('-s', '--secure', "Use secure sockets.\nWhen using secure sockets, the -a, -c and -k options must be provided") do
+          options[:scheme] = 'https'
+        end
+        on('-a', '--ca-file FILE', String, 'File with CA certs') do |ca_file|
+          options[:ca_file] = ca_file
+        end
+        on('-c', '--cert-file FILE', String, 'File with the servers certificate') do |cert_file|
+          options[:cert_file] = cert_file
+        end
+        on('-k', '--key-file FILE', String, 'File with the servers certificate') do |key_file|
+          options[:key_file] = key_file
+        end
+        on('-v', '--version', 'Show version') do
+          puts "Up! v#{Up::VERSION}"
+          exit
+        end
+      end
+
+      def parse!
+        super
+        if options[:scheme] == 'https'
+          if !options[:ca_file] || !options[:cert_file] || !options[:key_file]
+            puts "When using -s or --secure the -a,-c- and -k options must be given too!"
+            exit 2
+          end
+        end
+      end
+    end
+
+    class << self
+      if RUBY_ENGINE != 'opal'
+        def setup_bun
+          bun_cmd = `which bun`
+          if !bun_cmd || bun_cmd.empty?
+            puts "Please install bun first!"
+            exit 2
+          end
+          true
+        end
+          
+        def setup_node
+          node_cmd = `which node`
+          if !node_cmd || node_cmd.empty?
+            puts "Please install node first!"
+            exit 2
+          end
+          true
+        end
+
+        def setup_u_web_socket
+          setup_node
+          npm_cmd = `which npm`
+          if !npm_cmd || npm_cmd.empty?
+            puts "Please install npm first!"
+            exit 2
+          end
+          npm_cmd.chop! if npm_cmd.end_with?("\n")
+          have_uws = `npm list|grep uWebSockets.js@20`
+          `npm i uNetworking/uWebSockets.js#v20.41.0` if have_uws.empty?
+          true
+        end
+      end
+
+      def get_options
+        options = Up::CLI::Options.new
+        options.parse!
+        options.options
+      rescue OptionParser::InvalidOption => e
+        $stderr.puts "#{$0}: #{e.message} (-h will show valid options)"
+        exit 64
+      end
+
+      def get_gems_for_cmd
+        # Opal does not yet support gems, so lets read the Gemfile and simply add each gem
+        # to the Opal load path and require it, works for some gems, fails for others
+        gems = ""
+        if File.exist?("Gemfile")
+          lines = File.readlines('Gemfile')
+          lines.each do |line|
+            m = /gem ['"](\w+)['"]/.match(line)
+            gems << " -g #{m[1]} -r #{m[1]}" if m && m[1] != 'opal-up'
+          end
+        end
+        gems
+      end
+
+      def try_file(filename)
+        return nil unless File.exist? filename
+        ::Rack::Builder.parse_file filename
+      end
+
+      def get_app(filename = 'config.ru')
+        app = nil
+        filename ||= 'config.ru'
+        app = try_file(filename)
+        unless app
+          filename = "#{filename}.ru"
+          app = try_file(filename)
+        end
+        raise "Something wrong with #{filename}\n" unless app
+        app
+      end
+
+      def stoppable?
+        sleep 0.1
+        puts 'deflating request chain links'
+        sleep 0.1
+        puts 'optimizing response distortion'
+        sleep 0.1
+        print 'releasing boost pressure: '
+        3.times do
+          sleep 0.2
+          print '.'
+        end
+        3.times do 
+          puts "\n\033[5;31;47mRED ALERT: boost pressure to high, cannot open release valve!1!!!\033[0m"
+          sleep 0.1
+          print '.'
+          sleep 0.1
+        end
+        puts 'stopping engines failed, for further help see:'
+        puts 'https://www.youtube.com/watch?v=ecBco63zvas'
+        sleep 0.2
+        puts "Just kidding :)"
+        true
+      end
+    end
+  end
+end

data/lib/up/node/cluster.rb

@@ -0,0 +1,39 @@
+# backtick_javascript: true
+require 'up/node/server'
+
+%x{
+  const cluster = require('node:cluster');
+  const num_workers = require('node:os').availableParallelism();
+}
+
+module Up
+  module Node
+    class Cluster < Up::Node::Server
+      def initialize(app:, host: 'localhost', port: 3000, scheme: 'http', ca_file: nil, cert_file: nil, key_file: nil, workers: nil)
+        super(app: app, host: host, port: port, scheme: scheme, ca_file: ca_file, cert_file: cert_file, key_file: key_file)
+        @workers = workers || `num_workers`
+        @members = []
+      end
+
+      def listen
+        raise "already running" unless @members.empty?
+        %x{
+          if (cluster.isPrimary) {
+            for (let i = 0; i < #@workers; i++) {
+              #@members.push(cluster.fork());
+            }
+          } else {
+            #{super}
+          }
+        }
+      end
+
+      def stop
+        if Up::CLI::stoppable?
+          @members.each { |m| `m.kill()` } 
+          @members.clear
+        end
+      end
+    end
+  end
+end

data/lib/up/node/cluster_cli.rb

@@ -0,0 +1,15 @@
+require 'opal/platform'
+require 'nodejs/file'
+require 'nodejs/require'
+require 'opal-parser'
+require 'rack/builder'
+require 'up/rack_builder_patch'
+require 'up/node/rack_cluster'
+
+module Up
+  module CLI
+    def self.call
+      Up::Node::RackCluster.run(get_app, get_options)
+    end
+  end
+end