itsi-server 0.2.10 → 0.2.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1299ba07e4b4de522049dbf9df9c8948810c0b10f0a82da2f79585d66f803a51
-  data.tar.gz: 1f6d3ed4821cb0d8652a7659ea9ab6d60643901b307f7e925e818b69fbc5db2c
+  metadata.gz: 4a7ed672076127c57c4691c730e0a1545edaa1659573652b91e4a5db2bab3f02
+  data.tar.gz: 438a6d6e9693ae19080604e642709aa0381cd3486e4f562b175300549cf417f9
 SHA512:
-  metadata.gz: ff5e1d66975a9406fb832e6a742679cc018507223078fac096776fd51324def81a022db3b1324456fa86f2b36f92ce7b79f4cce05c93567e48b25fc02a1ff25d
-  data.tar.gz: bd898dedfdfa333c5eb7e69d55883585218bcc7ed34c6318b33fd1cf9cf9d66fdb44b4fdeab7f5c87c8ebba3937574545fbc1ba1955e78227f2334fb8acbea77
+  metadata.gz: 7c203ef2a97ed945256f138561359f7c4a32f79417b3caaded682f12a56ff2737b2becfd5e9994e133c547a2e455974e2b1255749ff61ada8e5c8f20aaa95721
+  data.tar.gz: 87908e166b10ef36fd3404d5f80cfca03baa5ac12e974947d3e8d9e65b93d73919c0159c0d6d77d62ff33e1eb100dc37ab3bf96fa455e7eec370bc582986c9e7

data/Cargo.lock

@@ -1644,7 +1644,7 @@ checksum = "4a5f13b858c8d314ee3e8f639011f7ccefe71f97f96e50151fb991f267928e2c"
 
 [[package]]
 name = "itsi-server"
-version = "0.2.10"
+version = "0.2.12"
 dependencies = [
  "argon2",
  "async-channel",

data/ext/itsi_error/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "itsi_error"
 version = "0.1.0"
-edition = "2024"
+edition = "2021"
 
 [dependencies]
 thiserror = "2.0.11"

data/ext/itsi_rb_helpers/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "itsi_rb_helpers"
 version = "0.1.0"
-edition = "2024"
+edition = "2021"
 
 [dependencies]
 cfg-if = "1.0.0"

data/ext/itsi_scheduler/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "itsi-scheduler"
-version = "0.2.10"
+version = "0.2.12"
 edition = "2021"
 authors = ["Wouter Coppieters <wc@pico.net.nz>"]
 license = "MIT"

data/ext/itsi_server/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "itsi-server"
-version = "0.2.10"
+version = "0.2.12"
 edition = "2021"
 authors = ["Wouter Coppieters <wc@pico.net.nz>"]
 license = "MIT"

data/ext/itsi_server/src/default_responses/mod.rs

@@ -9,3 +9,6 @@ pub static NOT_FOUND_RESPONSE: LazyLock<ErrorResponse> = LazyLock::new(ErrorResp
 
 pub static INTERNAL_SERVER_ERROR_RESPONSE: LazyLock<ErrorResponse> =
     LazyLock::new(ErrorResponse::internal_server_error);
+
+pub static SERVICE_UNAVAILABLE_RESPONSE: LazyLock<ErrorResponse> =
+    LazyLock::new(ErrorResponse::service_unavailable);

data/ext/itsi_server/src/lib.rs

@@ -86,6 +86,8 @@ fn init(ruby: &Ruby) -> Result<()> {
     response.define_method("<<", method!(ItsiHttpResponse::send_frame, 1))?;
     response.define_method("write", method!(ItsiHttpResponse::send_frame, 1))?;
     response.define_method("read", method!(ItsiHttpResponse::recv_frame, 0))?;
+    response.define_method("flush", method!(ItsiHttpResponse::flush, 0))?;
+    response.define_method("closed?", method!(ItsiHttpResponse::is_closed, 0))?;
     response.define_method(
         "send_and_close",
         method!(ItsiHttpResponse::send_and_close, 1),

data/ext/itsi_server/src/ruby_types/itsi_http_request.rs

@@ -22,6 +22,7 @@ use super::{
     itsi_http_response::ItsiHttpResponse,
 };
 use crate::{
+    default_responses::{INTERNAL_SERVER_ERROR_RESPONSE, SERVICE_UNAVAILABLE_RESPONSE},
     server::{
         byte_frame::ByteFrame,
         http_message_types::{HttpRequest, HttpResponse},
@@ -186,16 +187,20 @@ impl ItsiHttpRequest {
                 } else {
                     &context.sender
                 };
-                match sender
-                    .send(RequestJob::ProcessHttpRequest(request, app))
-                    .await
-                {
-                    Err(err) => {
-                        error!("Error occurred: {}", err);
-                        let mut response = Response::new(BoxBody::new(Empty::new()));
-                        *response.status_mut() = StatusCode::BAD_REQUEST;
-                        Ok(response)
-                    }
+                match sender.try_send(RequestJob::ProcessHttpRequest(request, app)) {
+                    Err(err) => match err {
+                        async_channel::TrySendError::Full(_) => {
+                            Ok(SERVICE_UNAVAILABLE_RESPONSE
+                                .to_http_response(context.accept.clone())
+                                .await)
+                        }
+                        async_channel::TrySendError::Closed(err) => {
+                            error!("Error occurred: {:?}", err);
+                            Ok(INTERNAL_SERVER_ERROR_RESPONSE
+                                .to_http_response(context.accept.clone())
+                                .await)
+                        }
+                    },
                     _ => match receiver.recv().await {
                         Some(first_frame) => Ok(response
                             .build(first_frame, receiver, shutdown_channel)

data/ext/itsi_server/src/ruby_types/itsi_http_response.rs

@@ -272,6 +272,14 @@ impl ItsiHttpResponse {
         // not implemented
     }
 
+    pub fn flush(&self) {
+        // no-op
+    }
+
+    pub fn is_closed(&self) -> bool {
+        self.data.response_writer.write().is_none()
+    }
+
     pub fn send_and_close(&self, frame: Bytes) -> MagnusResult<()> {
         let result = self.send_frame_into(ByteFrame::End(frame), &self.data.response_writer);
         self.data.response_writer.write().take();
@@ -339,7 +347,7 @@ impl ItsiHttpResponse {
         })?;
         let header_value = unsafe { HeaderValue::from_maybe_shared_unchecked(value) };
         if let Some(ref mut resp) = *self.data.response.write() {
-            resp.headers_mut().insert(header_name, header_value);
+            resp.headers_mut().append(header_name, header_value);
         }
         Ok(())
     }
@@ -356,7 +364,7 @@ impl ItsiHttpResponse {
                 })?;
                 for value in values {
                     let header_value = unsafe { HeaderValue::from_maybe_shared_unchecked(value) };
-                    headers_mut.insert(&header_name, header_value);
+                    headers_mut.append(&header_name, header_value);
                 }
             }
         }

data/ext/itsi_server/src/ruby_types/itsi_server/itsi_server_config.rs

@@ -69,6 +69,7 @@ pub struct ServerParams {
     pub pin_worker_cores: bool,
     pub scheduler_class: Option<String>,
     pub oob_gc_responses_threshold: Option<u64>,
+    pub ruby_thread_request_backlog_size: Option<usize>,
     pub middleware_loader: HeapValue<Proc>,
     pub middleware: OnceLock<MiddlewareSet>,
     pub binds: Vec<Bind>,
@@ -222,6 +223,10 @@ impl ServerParams {
         let scheduler_class: Option<String> = rb_param_hash.fetch("scheduler_class")?;
         let oob_gc_responses_threshold: Option<u64> =
             rb_param_hash.fetch("oob_gc_responses_threshold")?;
+
+        let ruby_thread_request_backlog_size: Option<usize> =
+            rb_param_hash.fetch("ruby_thread_request_backlog_size")?;
+
         let middleware_loader: Proc = rb_param_hash.fetch("middleware_loader")?;
         let log_level: Option<String> = rb_param_hash.fetch("log_level")?;
         let log_target: Option<String> = rb_param_hash.fetch("log_target")?;
@@ -310,6 +315,7 @@ impl ServerParams {
             scheduler_threads,
             streamable_body,
             scheduler_class,
+            ruby_thread_request_backlog_size,
             oob_gc_responses_threshold,
             binds,
             itsi_server_token_preference,

data/ext/itsi_server/src/server/middleware_stack/middlewares/ruby_app.rs

@@ -18,6 +18,7 @@ use std::sync::Arc;
 pub struct RubyApp {
     app: Arc<HeapValue<Proc>>,
     request_type: RequestType,
+    script_name: Option<String>,
     sendfile: bool,
     nonblocking: bool,
     base_path: Regex,
@@ -53,6 +54,9 @@ impl RubyApp {
         let base_path_src = params
             .funcall::<_, _, String>(Symbol::new("[]"), ("base_path",))
             .unwrap_or("".to_owned());
+        let script_name = params
+            .funcall::<_, _, Option<String>>(Symbol::new("[]"), ("script_name",))
+            .unwrap_or(None);
         let base_path = Regex::new(&base_path_src).unwrap();
 
         let request_type: RequestType = params
@@ -65,6 +69,7 @@ impl RubyApp {
             app: Arc::new(app.into()),
             sendfile,
             nonblocking,
+            script_name,
             request_type,
             base_path,
         }))
@@ -82,13 +87,14 @@ impl MiddlewareLayer for RubyApp {
         match self.request_type {
             RequestType::Http => {
                 let uri = req.uri().path();
-                let script_name = self
-                    .base_path
-                    .captures(uri)
-                    .and_then(|caps| caps.name("base_path"))
-                    .map(|m| m.as_str())
-                    .unwrap_or("/")
-                    .to_owned();
+                let script_name = self.script_name.clone().unwrap_or_else(|| {
+                    self.base_path
+                        .captures(uri)
+                        .and_then(|caps| caps.name("base_path"))
+                        .map(|m| m.as_str())
+                        .unwrap_or("/")
+                        .to_owned()
+                });
                 ItsiHttpRequest::process_request(
                     self.app.clone(),
                     req,

data/ext/itsi_server/src/server/thread_worker.rs

@@ -65,9 +65,12 @@ type ThreadWorkerBuildResult = Result<(
 pub fn build_thread_workers(params: Arc<ServerParams>, pid: Pid) -> ThreadWorkerBuildResult {
     let blocking_thread_count = params.threads;
     let nonblocking_thread_count = params.scheduler_threads;
+    let ruby_thread_request_backlog_size: usize = params
+        .ruby_thread_request_backlog_size
+        .unwrap_or_else(|| (blocking_thread_count as u16 * 30) as usize);
 
     let (blocking_sender, blocking_receiver) =
-        async_channel::bounded((blocking_thread_count as u16 * 30) as usize);
+        async_channel::bounded(ruby_thread_request_backlog_size);
     let blocking_receiver_ref = Arc::new(blocking_receiver);
     let blocking_sender_ref = blocking_sender;
     let scheduler_class = load_scheduler_class(params.scheduler_class.clone())?;

data/lib/itsi/http_request.rb

@@ -11,7 +11,8 @@ module Itsi
     include ResponseStatusShortcodes
     attr_accessor :hijacked
 
-    EMPTY_IO = StringIO.new("")
+    EMPTY_IO = StringIO.new("").tap { |io| io.set_encoding(Encoding::ASCII_8BIT) }
+
     RACK_HEADER_MAP = StandardHeaders::ALL.map do |header|
       rack_form = if header == "content-type"
                     "CONTENT_TYPE"
@@ -49,9 +50,7 @@ module Itsi
       "rack.version" => nil,
       "rack.url_scheme" => "",
       "rack.input" => "",
-      "rack.hijack" => "",
-      "CONTENT_TYPE" => nil,
-      "CONTENT_LENGTH" => nil
+      "rack.hijack" => ""
     }.freeze
 
     def to_rack_env
@@ -75,20 +74,20 @@ module Itsi
       env["rack.hijack"] = method(:hijack)
       headers.each do |(k, v)|
         env[case k
-          when "content-type" then "CONTENT_TYPE"
-          when "content-length" then "CONTENT_LENGTH"
-          when "accept" then "HTTP_ACCEPT"
-          when "accept-encoding" then "HTTP_ACCEPT_ENCODING"
-          when "accept-language" then "HTTP_ACCEPT_LANGUAGE"
-          when "user-agent" then "HTTP_USER_AGENT"
-          when "referer" then "HTTP_REFERER"
-          when "origin" then "HTTP_ORIGIN"
-          when "cookie" then "HTTP_COOKIE"
-          when "authorization" then "HTTP_AUTHORIZATION"
-          when "x-forwarded-for" then "HTTP_X_FORWARDED_FOR"
-          when "x-forwarded-proto" then "HTTP_X_FORWARDED_PROTO"
-          else RACK_HEADER_MAP[k]
-          end
+            when "content-type" then "CONTENT_TYPE"
+            when "content-length" then "CONTENT_LENGTH"
+            when "accept" then "HTTP_ACCEPT"
+            when "accept-encoding" then "HTTP_ACCEPT_ENCODING"
+            when "accept-language" then "HTTP_ACCEPT_LANGUAGE"
+            when "user-agent" then "HTTP_USER_AGENT"
+            when "referer" then "HTTP_REFERER"
+            when "origin" then "HTTP_ORIGIN"
+            when "cookie" then "HTTP_COOKIE"
+            when "authorization" then "HTTP_AUTHORIZATION"
+            when "x-forwarded-for" then "HTTP_X_FORWARDED_FOR"
+            when "x-forwarded-proto" then "HTTP_X_FORWARDED_PROTO"
+            else RACK_HEADER_MAP[k]
+            end
         ] = v
       end
       env
@@ -154,8 +153,8 @@ module Itsi
     def build_input_io
       case body_parts
       when nil then EMPTY_IO
-      when String then StringIO.new(body_parts)
-      when Array then File.open(body_parts.first, "rb")
+      when String then StringIO.new(body_parts).tap { |io| io.set_encoding(Encoding::ASCII_8BIT) }
+      when Array then File.open(body_parts.first, "rb").tap { |io| io.set_encoding(Encoding::ASCII_8BIT) }
       else body_parts
       end
     end

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

@@ -11,14 +11,17 @@ module Itsi
           ].flatten
 
           listing.each do |file|
-            current = klass.subclasses
+            current = klass.subclasses.dup
             require file
             following = klass.subclasses
             new_class = (following - current).first
 
             documentation_file = "#{file[/(.*)\.rb/, 1]}.md"
             documentation_file = "#{file[%r{(.*)/[^/]+\.rb}, 1]}/_index.md" unless File.exist?(documentation_file)
-            next unless File.exist?(documentation_file) && new_class
+            unless File.exist?(documentation_file) && new_class
+              new_class&.documentation "Documentation not found"
+              next
+            end
 
             new_class.documentation IO.read(documentation_file)
                                       .gsub(/^---.*?\n.*?-+/m, "") # Strip frontmatter

data/lib/itsi/server/config/middleware/endpoint/_index.md

@@ -5,9 +5,10 @@ prev: deny_list/
 next: controller/
 ---
 
+> If you're after running a rack app using a fully-featured framework, e.g. a Ruby on Rails or Sinatra, take a look at the [Rackup File](/middleware/rackup_file) middleware instead.
+
 The **endpoint** middleware allows you to define an ultra light-weight, inline, Ruby endpoint.
 
-> If you're after running a rack app using a fully-featured framework, e.g. a Ruby on Rails or Sinatra, take a look at the [Rackup File](/middleware/rackup_file) middleware instead.
 This feature can be useful for quickly prototyping, building small pieces of isolated functionality, or minimal endpoints where high throughput is essential.
 
 `endpoint` has several variants, that further restrict the endpoint to respond to specific HTTP methods:

data/lib/itsi/server/config/middleware/endpoint/delete.rb

@@ -26,12 +26,13 @@ module Itsi
             paths: Array(Or(Type(String), Type(Regexp))),
             handler: Type(Proc) & Required(),
             http_methods: Array(Type(String)),
+            script_name: Type(String).default(nil),
             nonblocking: Bool()
           }
         end
 
-        def initialize(location, path="", handler=nil, http_methods: [], nonblocking: false, &handler_proc)
-          location.endpoint(path, handler, http_methods: ["DELETE"], nonblocking: nonblocking, &handler_proc)
+        def initialize(location, path="", handler=nil, http_methods: [], nonblocking: false, script_name: nil, &handler_proc) # rubocop:disable Metrics/ParameterLists,Lint/MissingSuper
+          location.endpoint(path, handler, http_methods: ["DELETE"], nonblocking: nonblocking, script_name: script_name, &handler_proc)
         end
 
         def build!

data/lib/itsi/server/config/middleware/endpoint/endpoint.rb

@@ -28,17 +28,24 @@ module Itsi
             paths: Array(Or(Type(String), Type(Regexp))),
             handler: Type(Proc) & Required(),
             http_methods: Array(Type(String)),
+            script_name: Type(String).default(nil),
             nonblocking: Bool()
           }
         end
 
-        def initialize(location, path="", handler=nil, http_methods: [], nonblocking: false, &handler_proc)
+        def initialize(location, path="", handler=nil, http_methods: [], nonblocking: false, script_name: nil, &handler_proc)
           raise "Can not combine a controller method and inline handler" if handler && handler_proc
           handler_proc = location.controller.method(handler).to_proc if handler.is_a?(Symbol) || handler.is_a?(String)
 
           super(
             location,
-            { paths: Array(path), handler: handler_proc, http_methods: http_methods, nonblocking: nonblocking }
+            {
+              paths: Array(path),
+              handler: handler_proc,
+              http_methods: http_methods,
+              nonblocking: nonblocking,
+              script_name: script_name
+            }
           )
 
           num_required, keywords = Itsi::Server::TypedHandlers::SourceParser.extract_expr_from_source_location(handler_proc)
@@ -75,7 +82,11 @@ module Itsi
 
         def build!
           params = @params
-          app = { preloader: -> { params[:handler] }, nonblocking: @params[:nonblocking] }
+          app = {
+            preloader: -> { params[:handler] },
+            nonblocking: @params[:nonblocking],
+            script_name: @params[:script_name]
+          }
 
           if @params[:paths] == [""] && @params[:http_methods].empty?
             location.middleware[:app] = app

data/lib/itsi/server/config/middleware/endpoint/get.rb

@@ -26,12 +26,13 @@ module Itsi
             paths: Array(Or(Type(String), Type(Regexp))),
             handler: Type(Proc) & Required(),
             http_methods: Array(Type(String)),
+            script_name: Type(String).default(nil),
             nonblocking: Bool()
           }
         end
 
-        def initialize(location, path="", handler=nil, http_methods: [], nonblocking: false, &handler_proc)
-          location.endpoint(path, handler, http_methods: ["GET", "HEAD"], nonblocking: nonblocking, &handler_proc)
+        def initialize(location, path="", handler=nil, http_methods: [], nonblocking: false, script_name: nil, &handler_proc) # rubocop:disable Lint/MissingSuper,Metrics/ParameterLists
+          location.endpoint(path, handler, http_methods: ["GET", "HEAD"], nonblocking: nonblocking, script_name: script_name, &handler_proc)
         end
 
         def build!

data/lib/itsi/server/config/middleware/endpoint/patch.rb

@@ -26,12 +26,13 @@ module Itsi
             paths: Array(Or(Type(String), Type(Regexp))),
             handler: Type(Proc) & Required(),
             http_methods: Array(Type(String)),
+            script_name: Type(String).default(nil),
             nonblocking: Bool()
           }
         end
 
-        def initialize(location, path="", handler=nil, http_methods: [], nonblocking: false, &handler_proc)
-          location.endpoint(path, handler, http_methods: ["PATCH"], nonblocking: nonblocking, &handler_proc)
+        def initialize(location, path="", handler=nil, http_methods: [], nonblocking: false, script_name: nil, &handler_proc) # rubocop:disable Lint/MissingSuper
+          location.endpoint(path, handler, http_methods: ["PATCH"], nonblocking: nonblocking, script_name: script_name, &handler_proc)
         end
 
         def build!

data/lib/itsi/server/config/middleware/endpoint/post.rb

@@ -26,12 +26,13 @@ module Itsi
             paths: Array(Or(Type(String), Type(Regexp))),
             handler: Type(Proc) & Required(),
             http_methods: Array(Type(String)),
+            script_name: Type(String).default(nil),
             nonblocking: Bool()
           }
         end
 
-        def initialize(location, path="", handler=nil, http_methods: [], nonblocking: false, &handler_proc)
-          location.endpoint(path, handler, http_methods: ["POST"], nonblocking: nonblocking, &handler_proc)
+        def initialize(location, path="", handler=nil, http_methods: [], nonblocking: false, script_name: nil, &handler_proc) # rubocop:disable Lint/MissingSuper
+          location.endpoint(path, handler, http_methods: ["POST"], nonblocking: nonblocking, script_name: script_name, &handler_proc)
         end
 
         def build!

data/lib/itsi/server/config/middleware/endpoint/put.rb

@@ -26,12 +26,13 @@ module Itsi
             paths: Array(Or(Type(String), Type(Regexp))),
             handler: Type(Proc) & Required(),
             http_methods: Array(Type(String)),
+            script_name: Type(String).default(nil),
             nonblocking: Bool()
           }
         end
 
-        def initialize(location, path="", handler=nil, http_methods: [], nonblocking: false, &handler_proc)
-          location.endpoint(path, handler, http_methods: ["PUT"], nonblocking: nonblocking, &handler_proc)
+        def initialize(location, path="", handler=nil, http_methods: [], nonblocking: false, script_name: nil, &handler_proc) # rubocop:disable Lint/MissingSuper,Metrics/ParameterLists
+          location.endpoint(path, handler, http_methods: ["PUT"], nonblocking: nonblocking, script_name: script_name, &handler_proc)
         end
 
         def build!

data/lib/itsi/server/config/middleware/rackup_file.md

@@ -44,6 +44,24 @@ $ curl http://0.0.0.0:3000/root/child_path
 :/root/child_path
 ```
 
+### `SCRIPT_NAME` and `PATH_INFO` Rack ENV variables.
+Rack applications mounted at a subpath will, by default, receive a `SCRIPT_NAME` value that includes the subpath at which the app is mounted, and a `PATH_INFO` value that is relative to the subpath at which the rack app is mounted.
+If you wish to use location blocks only to control the middleware that applies to a rack app, but still have it behave as if it were mounted elsewhere (e.g. at the root), you can explicitly set the `script_name` option.
+E.g.
+
+```ruby
+location "/subpath/*" do
+  rackup_file "config.ru", script_name: '/'
+end
+```
+
+```bash
+# Our script-name override kicks in here, even though the app is mounted under `/subpath`
+$ curl http://0.0.0.0:3000/subpath/child_path
+/:/subpath/child_path
+```
+
+
 ### Options
 * `nonblocking` (default false). Determines whether requests sent to this Rack application should be run on non-blocking threads. Only applies if running in hybrid (non-blocking and blocking thread pool) mode. Otherwise this is a no-op and will run in whatever mode is set globally.
 * `sendfile` (default true). Determines whether Itsi should respect the `X-Sendfile` header set by the Rack application and use the `sendfile` function to efficiently send files. (Despite the name, this does not use the OS-level `sendfile` system call). Note. Itsi enforces the restriction that the referenced file must be within a child directory of the application root.

data/lib/itsi/server/config/middleware/rackup_file.rb

@@ -15,6 +15,7 @@ module Itsi
         schema do
           {
             nonblocking: Bool().default(false),
+            script_name: Type(String).default(nil),
             sendfile: Bool().default(true)
           }
         end
@@ -31,6 +32,7 @@ module Itsi
             preloader: -> { @app },
             sendfile: @params[:sendfile],
             nonblocking: @params[:nonblocking],
+            script_name: @params[:script_name],
             base_path: "^(?<base_path>#{location.paths_from_parent.gsub(/\.\*\)$/, ")")}).*$"
           }
           location.middleware[:app] = app_args

data/lib/itsi/server/config/middleware/run.md

@@ -39,7 +39,6 @@ run(Rack::Builder.app do
   use Rack::CommonLogger
   run ->(env) { [200, { 'content-type' => 'text/plain' }, [[env['SCRIPT_NAME'], env['PATH_INFO']].join(":") ]  ] }
 end)
-
 ```
 
 ```bash
@@ -50,6 +49,26 @@ $ curl http://0.0.0.0:3000/root/child_path
 :/root/child_path
 ```
 
+### `SCRIPT_NAME` and `PATH_INFO` Rack ENV variables.
+Rack applications mounted at a subpath will, by default, receive a `SCRIPT_NAME` value that includes the subpath at which the app is mounted, and a `PATH_INFO` value that is relative to the subpath at which the rack app is mounted.
+If you wish to use location blocks only to control the middleware that applies to a rack app, but still have it behave as if it were mounted elsewhere (e.g. at the root), you can explicitly set the `script_name` option.
+E.g.
+
+```ruby
+location "/subpath/*" do
+  run(Rack::Builder.app do
+    use Rack::CommonLogger
+    run ->(env) { [200, { 'content-type' => 'text/plain' }, [[env['SCRIPT_NAME'], env['PATH_INFO']].join(":") ]  ] }
+  end, script_name: '/')
+end
+```
+
+```bash
+# Our script-name override kicks in here, even though the app is mounted under `/subpath`
+$ curl http://0.0.0.0:3000/subpath/child_path
+/:/subpath/child_path
+```
+
 ### Options
 * `nonblocking` (default false). Determines whether requests sent to this Rack application should be run on non-blocking threads. Only applies if running in hybrid (non-blocking and blocking thread pool) mode. Otherwise this is a no-op and will run in whatever mode is set globally.
 * `sendfile` (default true). Determines whether Itsi should respect the `X-Sendfile` header set by the Rack application and use the `sendfile` function to efficiently send files. (Despite the name, this does not use the OS-level `sendfile` system call). Note. Itsi enforces the restriction that the referenced file must be within a child directory of the application root.

data/lib/itsi/server/config/middleware/run.rb

@@ -15,6 +15,7 @@ module Itsi
         schema do
           {
             nonblocking: Bool().default(false),
+            script_name: Type(String).default(nil),
             sendfile: Bool().default(true)
           }
         end
@@ -30,6 +31,7 @@ module Itsi
             preloader: -> { Itsi::Server::RackInterface.for(@app) },
             sendfile: @params[:sendfile],
             nonblocking: @params[:nonblocking],
+            script_name: @params[:script_name],
             base_path: "^(?<base_path>#{location.paths_from_parent.gsub(/\.\*\)$/, ')')}).*$"
           }
           location.middleware[:app] = app_args

data/lib/itsi/server/config/options/certificates.md

@@ -9,11 +9,11 @@ Itsi can automatically generate TLS certificates for you, both in development an
 To automatically generate a TLS certificate in development, just bind using the `https` scheme.
 E.g.
 ```ruby {filename=Itsi.rb}
-bind "https://localhost"
+bind "https://0.0.0.0"
 
 or
 
-bind "https://localhost:8443"
+bind "https://0.0.0.0:8443"
 ```
 Itsi will generate a local development CA for you if it does not yet exist, then use this to
 sign a just-in-time certificate for your server.

data/lib/itsi/server/config/options/ruby_thread_request_backlog_size.md

@@ -0,0 +1,18 @@
+---
+title: Ruby Thread Request Backlog Size
+url: /options/ruby_thread_request_backlog_size
+---
+
+Configures the size of the backlog queue for incoming requests in the Ruby thread pool.
+Up to this many requests can be queued at once before the server rejects further requests to Ruby workers (note this does not block other requests to proxied hosts or for static assets).
+
+The default value is `30 x number of threads`.
+
+## Configuration
+```ruby {filename=Itsi.rb}
+ruby_thread_request_backlog_size 20
+```
+
+```ruby {filename=Itsi.rb}
+ruby_thread_request_backlog_size 100
+```

data/lib/itsi/server/config/options/ruby_thread_request_backlog_size.rb

@@ -0,0 +1,19 @@
+module Itsi
+  class Server
+    module Config
+      class RubyThreadRequestBacklogSize < Option
+
+        insert_text <<~SNIPPET
+        ruby_thread_request_backlog_size ${1|10,25,50,100|}
+        SNIPPET
+
+        detail "The maximum number of requests that can be queued for processing by the Ruby thread."
+
+        schema do
+          (Type(Integer)).default(nil)
+        end
+
+      end
+    end
+  end
+end

data/lib/itsi/server/config/options/scheduler_threads.md

@@ -3,7 +3,7 @@ title: Scheduler Threads
 url: /options/scheduler_threads
 ---
 
-You can explicitly spawn a pool of non-blocking scheduler threads and divide work across traditional blocking and non-blocking threads, using [location](/middleware/location) blocks.
+You can explicitly spawn a pool of non-blocking scheduler threads and divide work across traditional/blocking and non-blocking threads, using [location](/middleware/location) blocks.
 
 This allows you to safely dip your toes into using non-blocking threads for specific I/O heavy operations without having to port an entire application to non-blocking I/O.
 
@@ -25,10 +25,17 @@ fiber_scheduler true
 # We mount the same app *twice*.
 # For a specific route prefix, all requests will be sent to non blocking threads.
 # All others fall through to the default mount
+
 location "/heavy_io/*" do
+  # You can optionally use the `script_name: ""` option here to set the base path for the mounted app (useful if a nested app
+  # should still serve requests as if it was mounted at the root).
+  # Otherwise it will infer the script-name based on the parent location block.
   rackup_file "./config.ru", nonblocking: true
 end
 
 rackup_file "./config.ru"
 
 ```
+## Examples.
+
+See [https://github.com/wouterken/itsi/tree/main/examples/hybrid_scheduler_mode](hybrid_scheduler_mode) example in the Git repository.

data/lib/itsi/server/config.rb

@@ -134,6 +134,9 @@ module Itsi
           oob_gc_responses_threshold: args.fetch(:oob_gc_responses_threshold) do
             itsifile_config.fetch(:oob_gc_responses_threshold, nil)
           end,
+          ruby_thread_request_backlog_size: args.fetch(:ruby_thread_request_backlog_size) do
+            itsifile_config.fetch(:ruby_thread_request_backlog_size, nil)
+          end,
           log_level: args.fetch(:log_level) { itsifile_config.fetch(:log_level, nil) },
           log_format: args.fetch(:log_format) { itsifile_config.fetch(:log_format, nil) },
           log_target: args.fetch(:log_target) { itsifile_config.fetch(:log_target, nil) },

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

@@ -31,8 +31,8 @@ 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)
-# bind "https://localhost:3000"
-# bind "https://localhost:3000?domains=dev.itsi.fyi"
+# 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.
 # bind "https://itsi.fyi?cert=acme&acme_email=admin@itsi.fyi"

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

@@ -8,10 +8,11 @@ module Rack
         port = options.fetch(:Port, 3001)
         ::Itsi::Server.start(
           {
-            app: app,
             binds: ["http://#{host}:#{port}"]
           }
-        )
+        ) do
+          run app
+        end
       end
     end
   end

data/lib/itsi/server/rack_interface.rb

@@ -40,13 +40,12 @@ module Itsi
         # 2. Set Headers
         body_streamer = streaming_body?(body) ? body : headers.delete("rack.hijack")
         headers.each do |key, value|
-          unless value.is_a?(Array)
+          if value.is_a?(Array)
+            value.each do |v|
+              response[key] = v
+            end
+          elsif value.is_a?(String)
             response[key] = value
-            next
-          end
-
-          value.each do |v|
-            response[key] = v
           end
         end
 

data/lib/itsi/server/version.rb

@@ -2,6 +2,6 @@
 
 module Itsi
   class Server
-    VERSION = "0.2.10"
+    VERSION = "0.2.12"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: itsi-server
 version: !ruby/object:Gem::Version
-  version: 0.2.10
+  version: 0.2.12
 platform: ruby
 authors:
 - Wouter Coppieters
@@ -91,7 +91,6 @@ files:
 - ".rubocop.yml"
 - Cargo.lock
 - Cargo.toml
-- README.md
 - Rakefile
 - exe/itsi
 - ext/itsi_acme/Cargo.toml
@@ -498,6 +497,8 @@ files:
 - lib/itsi/server/config/options/reuse_address.rb
 - lib/itsi/server/config/options/reuse_port.md
 - lib/itsi/server/config/options/reuse_port.rb
+- lib/itsi/server/config/options/ruby_thread_request_backlog_size.md
+- lib/itsi/server/config/options/ruby_thread_request_backlog_size.rb
 - lib/itsi/server/config/options/scheduler_threads.md
 - lib/itsi/server/config/options/scheduler_threads.rb
 - lib/itsi/server/config/options/shutdown_timeout.md
@@ -533,7 +534,6 @@ files:
 - lib/itsi/standard_headers.rb
 - lib/ruby_lsp/itsi/addon.rb
 - lib/shell_completions/completions.rb
-- sig/itsi_server.rbs
 homepage: https://itsi.fyi
 licenses:
 - MIT

data/README.md

@@ -1,49 +0,0 @@
----
-type: docs
-sidebar:
-  exclude: true
----
-
-# ItsiServer
-
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/itsi_server`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-## Installation
-
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
-Install the gem and add to the application's Gemfile by executing:
-
-```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
-```
-
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
-```
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/itsi_server. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/itsi_server/blob/master/CODE_OF_CONDUCT.md).
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the ItsiServer project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/itsi_server/blob/master/CODE_OF_CONDUCT.md).

data/sig/itsi_server.rbs

@@ -1,4 +0,0 @@
-module ItsiServer
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end