itsi 0.2.16 → 0.2.18

data/gems/server/lib/itsi/server/config/options/pipeline_flush.rb

@@ -0,0 +1,19 @@
+module Itsi
+  class Server
+    module Config
+      class PipelineFlush < Option
+
+        insert_text <<~SNIPPET
+        pipeline_flush ${1|true,false|}
+        SNIPPET
+
+        detail "Aggregates flushes to better support pipelined responses. (HTTP1 only)."
+
+        schema do
+          (Bool() & Required()).default(false)
+        end
+
+      end
+    end
+  end
+end

data/gems/server/lib/itsi/server/config/options/reuse_port.rb

@@ -2,17 +2,15 @@ module Itsi
   class Server
     module Config
       class ReusePort < Option
-
         insert_text <<~SNIPPET
-        reuse_port ${1|true,false|}
+          reuse_port ${1|true,false|}
         SNIPPET
 
         detail "Configures whether the server should set the reuse_port option on the underlying socket."
 
         schema do
-          (Bool() & Required()).default(false)
+          (Bool() & Required()).default(true)
         end
-
       end
     end
   end

data/gems/server/lib/itsi/server/config/options/writev.md

@@ -0,0 +1,25 @@
+---
+title: Write Vectored
+url: /options/writev
+---
+
+Set whether HTTP/1 connections should try to use vectored writes,
+or always flatten into a single buffer.
+
+Note that setting this to false may mean more copies of body data,
+but may also improve performance when an IO transport doesn't
+support vectored writes well, such as most TLS implementations.
+
+Setting this to true will force hyper to use queued strategy
+which may eliminate unnecessary cloning on some TLS backends
+
+Default is `nil` in which case hyper will try to guess which mode to use
+
+## Configuration
+```ruby {filename=Itsi.rb}
+writev true
+```
+
+```ruby {filename=Itsi.rb}
+writev false
+```

data/gems/server/lib/itsi/server/config/options/writev.rb

@@ -0,0 +1,19 @@
+module Itsi
+  class Server
+    module Config
+      class Writev < Option
+
+        insert_text <<~SNIPPET
+        writev ${1|true,false|}
+        SNIPPET
+
+        detail "Set whether HTTP/1 connections should try to use vectored writes"
+
+        schema do
+          (Bool() & Required()).default(false)
+        end
+
+      end
+    end
+  end
+end

data/gems/server/lib/itsi/server/config.rb

@@ -44,9 +44,9 @@ module Itsi
               rate_limit key: "address", store_config: "in_memory", requests: 5, seconds: 10
               etag type: "strong", algorithm: "md5", min_body_size: 1024 * 1024
               compress min_size: 1024 * 1024, level: "fastest", algorithms: %w[zstd gzip br deflate],
-                        mime_types: %w[all], compress_streams: true
+                       mime_types: %w[all], compress_streams: true
               log_requests before: { level: "DEBUG", format: "[{request_id}] {method} {path_and_query} - {addr} " },
-                            after: { level: "DEBUG",
+                           after: { level: "DEBUG",
                                     format: "[{request_id}] └─ {status} in {response_time}" }
               nodelay false
               static_assets \
@@ -65,14 +65,19 @@ module Itsi
                 }
             end
           elsif File.exist?(config_file_path.to_s)
-            DSL.evaluate(config_file_path)
+            DSL.evaluate do
+              include config_file_path.gsub(".rb", "")
+              rackup_file args[:rackup_file], script_name: "/" if args.key?(:rackup_file)
+            end
           elsif File.exist?("./config.ru")
             DSL.evaluate do
               preload true
-              rackup_file args.fetch(:rackup_file, "./config.ru")
+              rackup_file args.fetch(:rackup_file, "./config.ru"), script_name: "/"
             end
           else
-            DSL.evaluate {}
+            DSL.evaluate do
+              rackup_file args[:rackup_file], script_name: "/" if args.key?(:rackup_file)
+            end
           end
 
         itsifile_config.transform_keys!(&:to_sym)
@@ -92,7 +97,7 @@ module Itsi
             errors << [e, e.backtrace[0]]
           end
         # If we're just preloading a specific gem group, we'll do that here too
-        when Symbol
+        when Symbol, String
           Itsi.log_debug("Preloading gem group #{preload}")
           Bundler.require(preload)
         end
@@ -106,7 +111,7 @@ module Itsi
         end
 
         srv_config = {
-          workers: args.fetch(:workers) { itsifile_config.fetch(:workers, 1) },
+          workers: args.fetch(:workers) { itsifile_config.fetch(:workers, nil) },
           worker_memory_limit: args.fetch(:worker_memory_limit) { itsifile_config.fetch(:worker_memory_limit, nil) },
           silence: args.fetch(:silence) { itsifile_config.fetch(:silence, false) },
           shutdown_timeout: args.fetch(:shutdown_timeout) { itsifile_config.fetch(:shutdown_timeout, 5) },
@@ -127,7 +132,7 @@ module Itsi
           multithreaded_reactor: args.fetch(:multithreaded_reactor) do
             itsifile_config.fetch(:multithreaded_reactor, nil)
           end,
-          pin_worker_cores: args.fetch(:pin_worker_cores) { itsifile_config.fetch(:pin_worker_cores, true) },
+          pin_worker_cores: args.fetch(:pin_worker_cores) { itsifile_config.fetch(:pin_worker_cores, false) },
           scheduler_class: args.fetch(:scheduler_class) { itsifile_config.fetch(:scheduler_class, nil) },
           oob_gc_responses_threshold: args.fetch(:oob_gc_responses_threshold) do
             itsifile_config.fetch(:oob_gc_responses_threshold, nil)
@@ -139,9 +144,15 @@ module Itsi
           log_format: args.fetch(:log_format) { itsifile_config.fetch(:log_format, nil) },
           log_target: args.fetch(:log_target) { itsifile_config.fetch(:log_target, nil) },
           log_target_filters: args.fetch(:log_target_filters) { itsifile_config.fetch(:log_target_filters, nil) },
+          pipeline_flush: itsifile_config.fetch(:pipeline_flush, true),
+          writev: itsifile_config.fetch(:writev, false),
+          max_concurrent_streams: itsifile_config.fetch(:max_concurrent_streams, nil),
+          max_local_error_reset_streams: itsifile_config.fetch(:max_local_error_reset_streams, nil),
+          max_header_list_size: itsifile_config.fetch(:max_header_list_size, 2 * 1024 * 1024),
+          max_send_buf_size: itsifile_config.fetch(:max_send_buf_size, 64 * 1024),
           binds: args.fetch(:binds) { itsifile_config.fetch(:binds, ["http://0.0.0.0:3000"]) },
           middleware_loader: middleware_loader,
-          listeners: args.fetch(:listeners) { nil },
+          listeners: args.fetch(:listeners, nil),
           reuse_address: itsifile_config.fetch(:reuse_address, true),
           reuse_port: itsifile_config.fetch(:reuse_port, true),
           listen_backlog: itsifile_config.fetch(:listen_backlog, 1024),
@@ -222,6 +233,8 @@ module Itsi
 
       # Find config file path, if it exists.
       def self.config_file_path(config_file_path = nil)
+        raise "Config file #{config_file_path} does not exist" if config_file_path && !File.exist?(config_file_path)
+
         config_file_path ||= \
           if File.exist?(ITSI_DEFAULT_CONFIG_FILE)
             ITSI_DEFAULT_CONFIG_FILE

data/gems/server/lib/itsi/server/default_config/Itsi.rb

@@ -10,10 +10,7 @@ env = ENV.fetch("APP_ENV") { ENV.fetch("RACK_ENV", "development") }
 
 # Number of worker processes to spawn
 # If more than 1, Itsi will be booted in Cluster mode
-workers ENV.fetch("ITSI_WORKERS") {
-  require "etc"
-  env == "development" ? 1 : nil
-}
+workers ENV["ITSI_WORKERS"]&.to_i || (env == "development" ? 1 : nil)
 
 # Number of threads to spawn per worker process
 # For pure CPU bound applicationss, you'll get the best results keeping this number low
@@ -30,11 +27,13 @@ threads ENV.fetch("ITSI_THREADS", 3)
 fiber_scheduler nil
 
 # If you bind to https, without specifying a certificate, Itsi will use a self-signed certificate.
-# The self-signed certificate will use a CA generated for your host and stored inside `ITSI_LOCAL_CA_DIR` (Defaults to ~/.itsi)
+# The self-signed certificate will use a CA generated for your
+# host and stored inside `ITSI_LOCAL_CA_DIR` (Defaults to ~/.itsi)
 # bind "https://0.0.0.0:3000"
 # bind "https://0.0.0.0:3000?domains=dev.itsi.fyi"
 #
-# If you want to use let's encrypt to generate you a real certificate you and pass cert=acme and an acme_email address to generate one.
+# If you want to use let's encrypt to generate you a real certificate you
+# and pass cert=acme and an acme_email address to generate one.
 # bind "https://itsi.fyi?cert=acme&acme_email=admin@itsi.fyi"
 # You can generate certificates for multiple domains at once, by passing a comma-separated list of domains
 # bind "https://0.0.0.0?domains=foo.itsi.fyi,bar.itsi.fyi&cert=acme&acme_email=admin@itsi.fyi"
@@ -71,7 +70,8 @@ preload true
 # all of them at once, if they reach the threshold simultaneously.
 worker_memory_limit 1024 * 1024 * 1024
 
-# You can provide an optional block of code to run, when a worker hits its memory threshold (Use this to send yourself an alert,
+# You can provide an optional block of code to run, when a worker hits its memory threshold
+# (Use this to send yourself an alert,
 # write metrics to disk etc. etc.)
 after_memory_limit_reached do |pid|
   puts "Worker #{pid} has reached its memory threshold and will restart"
@@ -88,7 +88,8 @@ after_fork {}
 shutdown_timeout 5
 
 # Set this to false for application environments that require rack.input to be a rewindable body
-# (like Rails). For rack applications that can stream inputs, you can set this to true for a more memory-efficient approach.
+# (like Rails). For rack applications that can stream inputs, you can set this to true for a more
+# memory-efficient approach.
 stream_body false
 
 # OOB GC responses threshold

data/gems/server/lib/itsi/server/grpc/grpc_call.rb

@@ -190,6 +190,8 @@ module Itsi
       end
     end
 
+    alias_method :each, :each_remote_read
+
     def bidi_streamer?
       input_stream? && output_stream?
     end

data/gems/server/lib/itsi/server/grpc/grpc_interface.rb

@@ -79,7 +79,7 @@ module Itsi
       end
 
       def handle_client_streaming(active_call)
-        response = service.send(active_call.method_name, active_call.each_remote_read, active_call)
+        response = service.send(active_call.method_name, active_call)
         active_call.remote_send(response)
       end
 
@@ -94,7 +94,7 @@ module Itsi
       end
 
       def handle_bidi_streaming(active_call)
-        result = service.send(active_call.method_name, active_call.each_remote_read, active_call) do |response|
+        result = service.send(active_call.method_name, active_call.each, active_call) do |response|
           active_call.remote_send(response)
         end
         return unless result.is_a?(Enumerator)

data/gems/server/lib/itsi/server/rack/handler/itsi.rb

@@ -8,7 +8,9 @@ module Rack
         port = options.fetch(:Port, 3001)
         ::Itsi::Server.start(
           {
-            binds: ["http://#{host}:#{port}"]
+            binds: ["http://#{host}:#{port}"],
+            threads: 5,
+            workers: 1
           }
         ) do
           run app

data/gems/server/lib/itsi/server/rack_interface.rb

@@ -12,7 +12,7 @@ module Itsi
           end
         end
         lambda do |request|
-          Server.respond(request, app.call(request.to_rack_env))
+          Server.respond(request, app.call(env = request.to_rack_env), env)
         end
       end
 
@@ -20,14 +20,14 @@ module Itsi
       # Here we build the env, and invoke the Rack app's call method.
       # We then turn the Rack response into something Itsi server understands.
       def call(app, request)
-        respond request, app.call(request.to_rack_env)
+        respond request, app.call(env = request.to_rack_env), env
       end
 
       # Itsi responses are asynchronous and can be streamed.
       # Response chunks are sent using response.send_frame
       # and the response is finished using response.close_write.
       # If only a single chunk is written, you can use the #send_and_close method.
-      def respond(request, (status, headers, body))
+      def respond(request, (status, headers, body), env)
         response = request.response
 
         # Don't try and respond if we've been hijacked.
@@ -39,13 +39,16 @@ module Itsi
 
         # 2. Set Headers
         body_streamer = streaming_body?(body) ? body : headers.delete("rack.hijack")
-        headers.each do |key, value|
-          if value.is_a?(Array)
+
+        response.reserve_headers(headers.size)
+
+        for key, value in headers
+          case value
+          when String then response[key] = value
+          when Array
             value.each do |v|
               response[key] = v
             end
-          elsif value.is_a?(String)
-            response[key] = value
           end
         end
 
@@ -53,15 +56,15 @@ module Itsi
         # As soon as we start setting the response
         # the server will begin to stream it to the client.
 
-        # If we're partially hijacked or returned a streaming body,
-        # stream this response.
 
         if body_streamer
+          # If we're partially hijacked or returned a streaming body,
+          # stream this response.
           body_streamer.call(response)
 
-        # If we're enumerable with more than one chunk
-        # also stream, otherwise write in a single chunk
         elsif body.respond_to?(:each) || body.respond_to?(:to_ary)
+          # If we're enumerable with more than one chunk
+          # also stream, otherwise write in a single chunk
           unless body.respond_to?(:each)
             body = body.to_ary
             raise "Body #to_ary didn't return an array" unless body.is_a?(Array)
@@ -78,8 +81,10 @@ module Itsi
         else
           response.send_and_close(body.to_s)
         end
+      rescue EOFError
+        response.close
       ensure
-        response.close_write
+        RackEnvPool.checkin(env)
         body.close if body.respond_to?(:close)
       end
 

data/gems/server/lib/itsi/server/scheduler_interface.rb

@@ -14,6 +14,8 @@ module Itsi
       def schedule(app, request)
         Fiber.schedule do
           app.call(request)
+        rescue StandardError => e
+          request.server_error(e.message)
         end
       end
     end

data/gems/server/lib/itsi/server/version.rb

@@ -2,6 +2,6 @@
 
 module Itsi
   class Server
-    VERSION = "0.2.16"
+    VERSION = "0.2.18"
   end
 end

data/gems/server/lib/itsi/server.rb

@@ -12,6 +12,7 @@ require_relative "server/rack/handler/itsi"
 require_relative "server/config"
 require_relative "server/typed_handlers"
 require_relative "standard_headers"
+require_relative "rack_env_pool"
 require_relative "http_request"
 require_relative "http_response"
 require_relative "passfile"

data/gems/server/lib/ruby_lsp/itsi/addon.rb

@@ -5,8 +5,8 @@ require "itsi/server"
 
 module RubyLsp
   module Itsi
-    class Addon < ::RubyLsp::Addon
-      def activate(global_state, message_queue)
+    class Addon < ::RubyLsp::Addon # rubocop:disable Style/Documentation
+      def activate(_global_state, message_queue)
         @message_queue = message_queue
       end
 
@@ -20,33 +20,34 @@ module RubyLsp
         "0.1.0"
       end
 
-
       def create_completion_listener(response_builder, node_context, dispatcher, uri)
-        return unless uri.to_s.end_with?("Itsi.rb")
+        return unless uri.to_s =~ /itsi.rb$/i
+
         @in_itsi_file = true
         CompletionListener.new(response_builder, node_context, dispatcher, uri)
       end
 
       def create_hover_listener(response_builder, node_context, dispatcher)
         hl = dispatcher.listeners[:on_call_node_enter].find { |c| c.is_a?(RubyLsp::Listeners::Hover) }
-        return unless hl.instance_variable_get("@path").to_s.end_with?("Itsi.rb")
+        return unless hl.instance_variable_get("@path").to_s =~ /itsi.rb$/i
+
         HoverListener.new(response_builder, node_context, dispatcher)
       end
     end
 
-    class HoverListener
+    class HoverListener # rubocop:disable Style/Documentation
       def initialize(response_builder, node_context, dispatcher)
         @response_builder = response_builder
         @node_context = node_context
         @dispatcher = dispatcher
 
-        @options_by_name = ::Itsi::Server::Config::Option.subclasses.group_by(&:option_name).map{|k,v| [k,v.first]}.to_h
-        @middlewares_by_name = ::Itsi::Server::Config::Middleware.subclasses.group_by(&:middleware_name).map{|k,v| [k,v.first]}.to_h
+        @options_by_name = ::Itsi::Server::Config::Option.subclasses.group_by(&:option_name).transform_values(&:first)
+        @middlewares_by_name = ::Itsi::Server::Config::Middleware.subclasses.group_by(&:middleware_name).transform_values(&:first)
         # Register for call nodes for hover events
         dispatcher.register(self, :on_call_node_enter)
       end
 
-      def on_call_node_enter(node)
+      def on_call_node_enter(node) # rubocop:disable Metrics/MethodLength
         if (matched_class = @options_by_name[node.message.to_sym])
           @response_builder.push(
             matched_class.documentation,
@@ -61,7 +62,7 @@ module RubyLsp
       end
     end
 
-    class CompletionListener
+    class CompletionListener # rubocop:disable Style/Documentation
       def initialize(response_builder, node_context, dispatcher, uri)
         @response_builder = response_builder
         @node_context = node_context
@@ -74,7 +75,7 @@ module RubyLsp
         dispatcher.register(self, :completion_item_resolve)
       end
 
-      def on_call_node_enter(node)
+      def on_call_node_enter(node) # rubocop:disable Metrics/AbcSize
         # Only handle method calls that are being typed (i.e. no arguments yet)
         return unless node.arguments.nil?
 
@@ -122,8 +123,6 @@ module RubyLsp
           end
         end
       end
-
-
     end
   end
 end

data/gems/server/test/helpers/test_helper.rb

@@ -25,17 +25,10 @@ def free_bind(protocol = "http", unix_socket: false)
   end
 end
 
-def server(app: nil, app_with_lint: nil, protocol: "http", bind: free_bind(protocol), itsi_rb: nil, cleanup: true,
-           timeout: 5, &blk)
+def server(
+  app: nil, app_with_lint: nil, protocol: "http", bind: free_bind(protocol), itsi_rb: nil, cleanup: true,
+           &blk)
   app ||= Rack::Lint.new(app_with_lint) if app_with_lint
-  itsi_rb ||= lambda do
-    # Inline Itsi.rb
-    bind bind
-    workers 1
-    threads 1
-    log_level :warn
-    run app if app
-  end
 
   cli_params = {}
   cli_params[:binds] = [bind] if bind
@@ -46,13 +39,18 @@ def server(app: nil, app_with_lint: nil, protocol: "http", bind: free_bind(proto
     sync.push(true)
   end
 
-  Itsi::Server.start_in_background_thread(cli_params, &itsi_rb)
+  Itsi::Server.start_in_background_thread(cli_params) do
+    bind bind
+    workers 1
+    threads 1
+    log_level :warn
+    run app if app
+    instance_exec(&itsi_rb) if itsi_rb
+  end
 
   sync.pop
   uri = URI(bind)
-  # Timeout.timeout(timeout) do
   RequestContext.new(uri, self).instance_exec(uri, &blk)
-  # end
 rescue StandardError => e
   puts e
   # puts e.message
@@ -119,6 +117,7 @@ class RequestContext
   def patch(path, data = "", headers = {})
     request = Net::HTTP::Patch.new(uri_for(path))
     request.body = data
+    headers.each { |k, v| request[k] = v }
     client.request(request)
   end
 

data/gems/server/test/middleware/grpc/grpc.rb

@@ -5,14 +5,13 @@ class TestGrpc < Minitest::Test
   Stub = Test::TestService::Stub
 
   def new_stub(uri)
-    address = uri.to_s[/\/\/(.*)/,1]    # e.g. "127.0.0.1:12345"
+    address = uri.to_s[%r{//(.*)}, 1] # e.g. "127.0.0.1:12345"
     channel = GRPC::Core::Channel.new(address,
-                                      {},              # channel_args hash
-                                      :this_channel_is_insecure,
-    )
+                                      {}, # channel_args hash
+                                      :this_channel_is_insecure)
     stub = Stub.new(nil,
-                                 nil,
-                                 channel_override: channel)
+                    nil,
+                    channel_override: channel)
   end
 
   def test_unary_echo
@@ -46,7 +45,7 @@ class TestGrpc < Minitest::Test
       req = Test::EchoRequest.new(message: "xy")
       # expect two StreamResponse frames, one per character
       chars = stub.server_stream(req).map(&:messages).flatten
-      assert_equal ["x", "y"], chars
+      assert_equal %w[x y], chars
     end
   end
 
@@ -58,7 +57,7 @@ class TestGrpc < Minitest::Test
       inputs = %w[test1 test2].map { |m| Test::EchoRequest.new(message: m) }
       # each response uppercases its incoming message
       results = stub.bidi_stream(inputs.each).map(&:message)
-      assert_equal ["TEST1", "TEST2"], results
+      assert_equal %w[TEST1 TEST2], results
     end
   end
 
@@ -82,7 +81,6 @@ class TestGrpc < Minitest::Test
     end
   end
 
-
   def test_unary_echo_json
     server(itsi_rb: lambda do
       grpc TestServiceImpl.new
@@ -99,7 +97,7 @@ class TestGrpc < Minitest::Test
     server(itsi_rb: lambda do
       grpc TestServiceImpl.new
     end) do
-      input = [{"message" => "a"}, {"message" => "b"}, {"message" => "c"}]
+      input = [{ "message" => "a" }, { "message" => "b" }, { "message" => "c" }]
       res = post("test.TestService/ClientStream", input.to_json, { "Content-Type" => "application/json" })
       json = JSON.parse(res.body)
       assert_equal 200, res.code.to_i
@@ -117,7 +115,7 @@ class TestGrpc < Minitest::Test
       # service streams back one JSON object per character
       messages = arr.flat_map { |frame| frame["messages"] }
       assert_equal 200, res.code.to_i
-      assert_equal ["x","y"], messages
+      assert_equal %w[x y], messages
     end
   end
 
@@ -125,13 +123,13 @@ class TestGrpc < Minitest::Test
     server(itsi_rb: lambda do
       grpc TestServiceImpl.new
     end) do
-      inputs = [{"message":"foo"}, {"message":"Bar"}]
+      inputs = [{ "message": "foo" }, { "message": "Bar" }]
       res = post("test.TestService/BidiStream", inputs.to_json, { "Content-Type" => "application/json" })
       arr = JSON.parse(res.body)
       # bidi uppercases each incoming message
       results = arr.map { |frame| frame["message"] }
       assert_equal 200, res.code.to_i
-      assert_equal ["FOO","BAR"], results
+      assert_equal %w[FOO BAR], results
     end
   end
 
@@ -145,7 +143,8 @@ class TestGrpc < Minitest::Test
       assert_nil json1["messages"]
 
       # empty server-stream
-      res2 = post("test.TestService/ServerStream", { "message" => "" }.to_json, { "Content-Type" => "application/json" })
+      res2 = post("test.TestService/ServerStream", { "message" => "" }.to_json,
+                  { "Content-Type" => "application/json" })
       arr2 = JSON.parse(res2.body)
       assert arr2.empty?
 

data/gems/server/test/middleware/grpc/test_service_impl.rb

@@ -1,12 +1,12 @@
-require_relative 'test_service_services_pb'  # generated by grpc_tools_ruby_protoc
+require_relative "test_service_services_pb" # generated by grpc_tools_ruby_protoc
 
 class TestServiceImpl < Test::TestService::Service
   def unary_echo(req, _unused_call)
     Test::EchoResponse.new(message: req.message)
   end
 
-  def client_stream(stream, _call)
-    msgs = stream.map(&:message)
+  def client_stream(call)
+    msgs = call.each_remote_read.map(&:message)
     Test::StreamResponse.new(messages: msgs)
   end