itsi 0.2.11 → 0.2.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 987c240269c5eeecf8ef25dece0a60076e364199fc04d9616b5b429da7745298
-  data.tar.gz: 24993f6fda6930e19550a74c7f2e26b08783e4d633cce3e10fd21a61250e4581
+  metadata.gz: 9069ae3d194e76dc4c4451d6506594a2a3e3789541b546a31dd3703a172f4e32
+  data.tar.gz: 6aacbd0351095bbde2e6db7c943bcd2444715519b079af2880c93cd5f623572f
 SHA512:
-  metadata.gz: 0be64ac78c963c680f65da8ea2fb309e726408f5983773576fc60f837c9d4721d89a1525dcf64b1f522a2a1ce842f4356ca586caee30efd886bd966d488a0a00
-  data.tar.gz: d770724704cb4f2ab988542572fbf5755c22282a8af7d81d92fe0517d7738dafb66cd7856d83e48b402a7e6412550d58360bdf12180ad14edef0c08c8062b257
+  metadata.gz: 36dcaf525c6852659d11c98f2d7813e4f01f86d934508a2ed45f071004f50fe6faee7a921ff9395bbc02198b10e8dc68887415781de3ae53aa3e90019a62f60e
+  data.tar.gz: ac990a66a605e5da8bec5f8bf26f51859ab50a1e4d8f50d95c9c4bf7c2ce6aefa0a882db1e7ef06593ab97ea4210e0faebe98f2a5d5001d9431fda8b1cf06c51

data/Cargo.lock

@@ -1644,7 +1644,7 @@ checksum = "4a5f13b858c8d314ee3e8f639011f7ccefe71f97f96e50151fb991f267928e2c"
 
 [[package]]
 name = "itsi-scheduler"
-version = "0.2.11"
+version = "0.2.12"
 dependencies = [
  "bytes",
  "derive_more",
@@ -1662,7 +1662,7 @@ dependencies = [
 
 [[package]]
 name = "itsi-server"
-version = "0.2.11"
+version = "0.2.12"
 dependencies = [
  "argon2",
  "async-channel",

data/README.md

@@ -104,3 +104,11 @@ You can also run gem-specific variants of the above. E.g.
 * `rake server:test` or `rake scheduler:test`
 * `rake server:compile` or `rake scheduler:compile`
 * `rake server:build` or `rake scheduler:build`
+
+
+### Contributing
+Developer Certificate of Origin
+
+By submitting a pull-request you certify that:
+1. The contribution is your original work or you have the right to submit it;
+2. You have read and understood the [Developer Certificate of Origin](https://developercertificate.org/) and you accept it.

data/crates/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/crates/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/crates/itsi_scheduler/Cargo.toml

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

data/crates/itsi_server/Cargo.toml

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

data/crates/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/crates/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/crates/itsi_server/src/ruby_types/itsi_http_response.rs

@@ -347,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(())
     }
@@ -364,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/crates/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/crates/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/crates/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/docs/content/itsi_scheduler/_index.md

@@ -101,6 +101,36 @@ end.value
 
 puts results.map(&:inspect)
 ```
-
 to run many blocking operations simultaneously all while occupying only a single Ruby thread!
+
+### 3 (Optional) - Enable Scheduler Refinements
+You can opt-in to a tiny set of Ruby refinements provided by the `Itsi::Scheduler` to make usage even more ergonomic.
+By opting in to this refinement (using `using Itsi::Scheduler`) you gain access to the top-level #schedule(&block) method, as well
+as enumerable methods #schedule_each, and #schedule_map.
+
+```ruby
+
+using Itsi::Scheduler
+
+# Fire-and-forget: 100 HTTP calls in parallel
+100.times.schedule_each do |i|
+  Net::HTTP.get(URI("https://example.com/#{i}"))
+end
+
+# Concurrent transform that keeps the original order
+squares = (1..20).schedule_map { |n| n * n }
+puts squares.inspect
+# => [1, 4, 9, 16, … 400]
+
+# Manual orchestration — still one thread
+schedule do
+  a, b = Queue.new, Queue.new
+
+  schedule { a << Net::HTTP.get(URI("https://httpbin.org/get")) }
+  schedule { b << Net::HTTP.get(URI("https://httpbin.org/uuid")) }
+
+  puts a.pop
+  puts b.pop
+end
+```
 {{% /steps %}}

data/examples/hybrid_scheduler_mode/Itsi.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# Before running this test, go to the ./slow_service directory, and start the slow running service
+# on port 3005, by running `itsi`.
+
+# Single thread for blocking test.
+threads 1
+
+# Single thread for non-blocking test.
+scheduler_threads 1
+
+shutdown_timeout 1.0 # Shutdown Timeout in Seconds
+
+# Small backlogs for test purposes
+ruby_thread_request_backlog_size 100
+
+# Enable Itsi's fiber scheduler.
+fiber_scheduler true
+
+# Send requests to http://localhost:3000/nonblocking.
+# The app at config.ru runs a slow endpoint (takes 3+ seconds).
+# When using this endpoint you can have a very large number of simultaneous inflight requests.
+#
+#
+# Example benchmark:
+# Non-blocking mode. 100 requests at a time, service takes 2s to respond. Throughput of ~50rps expected.
+#  ❯ wrk  http://0.0.0.0:3000/nonblocking -c 100 -d 10
+# Running 10s test @ http://0.0.0.0:3000/nonblocking
+#   2 threads and 100 connections
+#   Thread Stats   Avg      Stdev     Max   +/- Stdev
+#     Latency     0.00us    0.00us   0.00us     nan%
+#     Req/Sec    65.00    109.41   316.00     84.62%
+#   500 requests in 10.10s, 69.34KB read
+#   Socket errors: connect 0, read 0, write 0, timeout 500
+# Requests/sec:     49.50
+# Transfer/sec:      6.86KB
+
+location 'nonblocking' do
+  rackup_file 'config.ru', nonblocking: true, script_name: ''
+end
+
+
+# Send requests to http://localhost:3000/blocking.
+# The app at config.ru runs a slow endpoint (takes 3+ seconds).
+# When using this endpoint, concurrency is limited by the number of blocking threads available.
+#
+# Blocking mode. Requests are executed sequentially , service takes 2s to respond. Throughput of ~0.5rps expected.
+#  ❯ wrk  http://0.0.0.0:3000/nonblocking -c 100 -d 10
+# Running 10s test @ http://0.0.0.0:3000/blocking
+#   2 threads and 100 connections
+#   Thread Stats   Avg      Stdev     Max   +/- Stdev
+#     Latency     0.00us    0.00us   0.00us     nan%
+#     Req/Sec     0.00      0.00     0.00    100.00%
+#   5 requests in 10.10s, 710.00B read
+#   Socket errors: connect 0, read 0, write 0, timeout 5
+# Requests/sec:      0.49
+
+location 'blocking' do
+  rackup_file 'config.ru', script_name: ''
+end

data/examples/hybrid_scheduler_mode/config.ru

@@ -0,0 +1,9 @@
+require 'net/http'
+
+# This could be any Rack app, a Rails app, a Sinatra app, etc.
+# We're going to use a simple inline rack handler for now.
+
+run ->(_) do
+  result = Net::HTTP.new('127.0.0.1', 3005).get('/?sleep=2')
+  [result.code.to_i, {'content-type' => 'text/html'}, [result.body]]
+end

data/examples/hybrid_scheduler_mode/slow_service/Itsi.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+threads 1
+fiber_scheduler true
+
+bind "http://0.0.0.0:3005"
+
+endpoint do |req|
+  sleep_length = req.query_params.fetch("sleep", 3).to_i
+  sleep sleep_length
+  req.ok "It's been #{sleep_length} seconds!"
+end

data/gems/scheduler/Cargo.lock

@@ -213,7 +213,7 @@ checksum = "4a5f13b858c8d314ee3e8f639011f7ccefe71f97f96e50151fb991f267928e2c"
 
 [[package]]
 name = "itsi-scheduler"
-version = "0.2.11"
+version = "0.2.12"
 dependencies = [
  "bytes",
  "derive_more",

data/gems/scheduler/lib/itsi/schedule_refinement.rb

@@ -0,0 +1,96 @@
+module Itsi
+  module ScheduleRefinement
+    # Useful helper functions for using cooperative multi-tasking in Ruby.
+    # Opt-in to usage by executing `using Itsi::ScheduleRefinement` in any places
+    # you intend to use it.
+    #
+    # After this you can do things like the following
+    #
+    # 1. Launch batch concurrent fire-and-forget jobs.
+    # * 100.times.schedule_each{ sleep 0.1 }
+    #
+    # 2. Launch batch concurrent transofmrs
+    # See how `schedule_map` retains ordering, despite sleeping for randomized amount of time.
+    #
+    # * 100.times.schedule_map{|i| sleep Random.rand(0.0..0.05); i }
+    #
+    # 3. Manually organize fibers to run concurrently.
+    #
+    # require "net/http"
+    # schedule do
+    #   req1, req2 = Queue.new, Queue.new
+    #   schedule do
+    #     puts "Making request 1"
+    #     req1 << Net::HTTP.get(URI("http://httpbin.org/get"))
+    #     puts "Finished request 1"
+    #   end
+    #
+    #   schedule do
+    #     puts "Making request 2"
+    #     req2 << Net::HTTP.get(URI("http://httpbin.org/get"))
+    #     puts "Finished request 2"
+    #   end
+    #
+    #   res1, res2 = [req1, req2].map(&:pop)
+    # end
+    refine Kernel do
+      private def schedule(&blk) # rubocop:disable Metrics/MethodLength
+        return unless blk
+
+        if Fiber.scheduler.nil?
+          result = nil
+          Thread.new do
+            Fiber.set_scheduler Itsi::Scheduler.new
+            Fiber.schedule { result = blk.call }
+          end.join
+          result
+        else
+          Fiber.schedule(&blk)
+        end
+      end
+    end
+
+    module EnumerableExtensions
+      using ScheduleRefinement
+      def schedule_each(&block)
+        enum = Enumerator.new do |y|
+          schedule do
+            each { |item| schedule{ y.yield(item) } }
+          end
+        end
+
+        block_given? ? enum.each(&block) : enum.each
+      end
+
+      def schedule_map(&block)
+        return Enumerator.new do |y|
+          schedule do
+            with_index.each_with_object([]) do |(item, index), agg|
+              schedule do
+                agg[index] = (y << item)
+              end
+            end
+          end
+        end.map unless block_given?
+        schedule do
+          with_index.each_with_object([]) do |(item, index), agg|
+            schedule do
+              agg[index] = block[item]
+            end
+          end
+        end
+      end
+    end
+
+
+    refine Enumerator do
+      define_method(:schedule_each, EnumerableExtensions.instance_method(:schedule_each))
+      define_method(:schedule_map, EnumerableExtensions.instance_method(:schedule_map))
+    end
+
+    refine Enumerable do
+      define_method(:schedule_each, EnumerableExtensions.instance_method(:schedule_each))
+      define_method(:schedule_map, EnumerableExtensions.instance_method(:schedule_map))
+    end
+  end
+end

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

@@ -2,6 +2,6 @@
 
 module Itsi
   class Scheduler
-    VERSION = "0.2.11"
+    VERSION = "0.2.12"
   end
 end

data/gems/scheduler/lib/itsi/scheduler.rb

@@ -2,37 +2,10 @@
 
 require_relative "scheduler/version"
 require_relative "scheduler/itsi_scheduler"
+require_relative "schedule_refinement"
 
 module Itsi
-  module ScheduleUtils
-    def schedule(&block)
-      return to_enum(:schedule) unless block_given?
-
-      Object.schedule do
-        each { |item| Object.schedule { block.call(item) } }
-      end
-    end
-  end
-
   class Scheduler
-    def self.enable_schedule_keyword!
-      Object.define_method(:schedule) do |&blk|
-        result = nil
-        return result unless blk
-
-        if Fiber.scheduler.nil?
-          Thread.new do
-            Fiber.set_scheduler Itsi::Scheduler.new
-            Fiber.schedule { result = blk[] }
-          end.join
-        else
-          Fiber.schedule { result = blk[] }
-        end
-        result
-      end
-      Enumerable.include(ScheduleUtils)
-    end
-
     class Error < StandardError; end
 
     def self.resume_token

data/gems/server/Cargo.lock

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

data/gems/server/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/gems/server/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/gems/server/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/gems/server/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/gems/server/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/gems/server/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/gems/server/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/gems/server/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/gems/server/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/gems/server/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/gems/server/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/gems/server/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/gems/server/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/gems/server/lib/itsi/server/config/options/scheduler_threads.md

@@ -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/gems/server/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/gems/server/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/gems/server/lib/itsi/server/version.rb

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

data/gems/server/test/options/ruby_thread_request_backlog_size.rb

@@ -0,0 +1,37 @@
+require_relative "../helpers/test_helper"
+
+class TestRubyThreadRequestBacklogSize < Minitest::Test
+
+  def test_ruby_thread_request_backlog_size
+    server(
+      itsi_rb: lambda do
+        threads 1
+        workers 1
+        ruby_thread_request_backlog_size 1
+        get("/foo"){|r| sleep 0.1; r.ok "ok" }
+      end) do
+      responses = 3.times.map{ Thread.new{ get_resp("/foo") } }.map(&:value)
+
+      assert_equal "ok", responses.first.body
+      assert_equal "200", responses.first.code
+      assert_equal "503", responses.last.code
+    end
+  end
+
+  def test_ruby_thread_request_backlog_size_default
+    server(
+      itsi_rb: lambda do
+        threads 1
+        workers 1
+        # ruby_thread_request_backlog_size 1 - Disabled. Should revert to more generous default
+        get("/foo"){|r| sleep 0.01; r.ok "ok" }
+      end) do
+      responses = 29.times.map{ Thread.new{ get_resp("/foo") } }.map(&:value)
+
+      assert_equal "ok", responses.first.body
+      assert_equal "200", responses.first.code
+      assert_equal "ok", responses.last.body
+      assert_equal "200", responses.last.code
+    end
+  end
+end

data/gems/server/test/rack/test_rack_server.rb

@@ -306,4 +306,63 @@ class TestRackServer < Minitest::Test
     assert_equal Net::HTTP.get(URI("http://#{host}:#{port}")), "Hello, Rackup!"
     Process.kill(:SIGINT, Process.pid)
   end
+
+  def test_script_name_inferred_from_mount
+    server(itsi_rb: lambda do
+      location "foo*" do
+        run ->(env) { [200, { "content-type" => "text/plain" }, [env["SCRIPT_NAME"]]] }
+      end
+      run ->(env) { [200, { "content-type" => "text/plain" }, [env["SCRIPT_NAME"]]] }
+    end) do
+      assert_equal get("/foo/bar"), "/foo"
+      assert_equal get("/baz"), ""
+    end
+  end
+
+  def test_path_info_inferred_from_mount
+    server(itsi_rb: lambda do
+      location "foo*" do
+        run ->(env) { [200, { "content-type" => "text/plain" }, [env["PATH_INFO"]]] }
+      end
+      run ->(env) { [200, { "content-type" => "text/plain" }, [env["PATH_INFO"]]] }
+    end) do
+      assert_equal get("/foo/bar"), "/bar"
+      assert_equal get("/baz"), "/baz"
+    end
+  end
+
+  def test_script_name_explicitly_set
+    server(itsi_rb: lambda do
+      location "foo*" do
+        run ->(env) { [200, { "content-type" => "text/plain" }, [env["SCRIPT_NAME"]]] }, script_name: "/overridden"
+      end
+      run ->(env) { [200, { "content-type" => "text/plain" }, [env["SCRIPT_NAME"]]] }, script_name: ""
+    end) do
+      assert_equal get("/foo/bar"), "/overridden"
+      assert_equal get("/baz"), ""
+    end
+  end
+
+  def test_path_info_when_script_name_explicitly_set
+    server(itsi_rb: lambda do
+      location "foo*" do
+        run ->(env) { [200, { "content-type" => "text/plain" }, [env["PATH_INFO"]]] }, script_name: ""
+      end
+      run ->(env) { [200, { "content-type" => "text/plain" }, [env["PATH_INFO"]]] }, script_name: ""
+    end) do
+      assert_equal get("/foo/bar"), "/foo/bar"
+      assert_equal get("/baz"), "/baz"
+    end
+  end
+
+  def test_multi_field_headers
+    server(app_with_lint: lambda do |env|
+      [200, { "content-type" => "text/plain", "x-example" => ["one, two, three", "four, five"] }, ["Multiple Field Headers"]]
+    end) do
+      response = get_resp("/")
+      assert_equal "200", response.code
+      assert_equal "one, two, three, four, five", response["x-example"]
+      assert_equal "Multiple Field Headers", response.body
+    end
+  end
 end

data/lib/itsi/version.rb

@@ -1,3 +1,3 @@
 module Itsi
-  VERSION = '0.2.11'
+  VERSION = '0.2.12'
 end

data/tasks.txt

@@ -1,3 +1,7 @@
+- Add tests for script name and request backlog size, Add tests for scheduler.
+- Respond on Reddit
+- Min rust version
+
 Tasks:
 - Add way to opt non Itsi.rb files into LSP
 - Better parallelization a lá Iodine

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: itsi
 version: !ruby/object:Gem::Version
-  version: 0.2.11
+  version: 0.2.12
 platform: ruby
 authors:
 - Wouter Coppieters
@@ -253,6 +253,9 @@ files:
 - examples/file_server/itsi-server-100.png
 - examples/file_server/subdirectory/movies.csv
 - examples/helpers/datastore.rb
+- examples/hybrid_scheduler_mode/Itsi.rb
+- examples/hybrid_scheduler_mode/config.ru
+- examples/hybrid_scheduler_mode/slow_service/Itsi.rb
 - examples/media_server/Itsi.rb
 - examples/media_server/README.md
 - examples/media_server/images/itsi-server-100.png
@@ -677,9 +680,9 @@ files:
 - gems/scheduler/bin/setup
 - gems/scheduler/itsi-scheduler-100.png
 - gems/scheduler/itsi-scheduler.gemspec
+- gems/scheduler/lib/itsi/schedule_refinement.rb
 - gems/scheduler/lib/itsi/scheduler.rb
 - gems/scheduler/lib/itsi/scheduler/version.rb
-- gems/scheduler/sig/itsi_scheduler.rbs
 - gems/scheduler/test/helpers/test_helper.rb
 - gems/scheduler/test/test_active_record.rb
 - gems/scheduler/test/test_address_resolve.rb
@@ -941,6 +944,8 @@ files:
 - gems/server/lib/itsi/server/config/options/reuse_address.rb
 - gems/server/lib/itsi/server/config/options/reuse_port.md
 - gems/server/lib/itsi/server/config/options/reuse_port.rb
+- gems/server/lib/itsi/server/config/options/ruby_thread_request_backlog_size.md
+- gems/server/lib/itsi/server/config/options/ruby_thread_request_backlog_size.rb
 - gems/server/lib/itsi/server/config/options/scheduler_threads.md
 - gems/server/lib/itsi/server/config/options/scheduler_threads.rb
 - gems/server/lib/itsi/server/config/options/shutdown_timeout.md
@@ -976,7 +981,6 @@ files:
 - gems/server/lib/itsi/standard_headers.rb
 - gems/server/lib/ruby_lsp/itsi/addon.rb
 - gems/server/lib/shell_completions/completions.rb
-- gems/server/sig/itsi_server.rbs
 - gems/server/test/helpers/test_helper.rb
 - gems/server/test/middleware/allow_list.rb
 - gems/server/test/middleware/auth_api_key.rb
@@ -1010,6 +1014,7 @@ files:
 - gems/server/test/middleware/test_log_requests.rb
 - gems/server/test/options/bind.rb
 - gems/server/test/options/header_read_timeout.rb
+- gems/server/test/options/ruby_thread_request_backlog_size.rb
 - gems/server/test/options/test_request_timeout.rb
 - gems/server/test/options/test_threads.rb
 - gems/server/test/options/test_workers.rb

data/gems/scheduler/sig/itsi_scheduler.rbs

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

data/gems/server/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