itsi-server 0.1.1 → 0.1.11

data/Cargo.toml

@@ -0,0 +1,7 @@
+# This Cargo.toml is here to let externals tools (IDEs, etc.) know that this is
+# a Rust project. Your extensions dependencies should be added to the Cargo.toml
+# in the ext/ directory.
+
+[workspace]
+members = ["./ext/itsi_server"]
+resolver = "2"

data/Rakefile

@@ -3,7 +3,14 @@
 require "bundler/gem_tasks"
 require "minitest/test_task"
 
-Minitest::TestTask.create
+
+Minitest::TestTask.create(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.warning = false
+  t.test_globs = ['test/**/*.rb']
+  t.test_prelude = 'require "helpers/test_helper.rb"'
+end
 
 require "rubocop/rake_task"
 

data/exe/itsi

@@ -2,26 +2,38 @@
 # frozen_string_literal: true
 
 require "optparse"
-require "rack"
-require "etc"
 
 # Default options used when starting Osprey from the CLI using `osprey`
 DEFAULT_OPTIONS = {
   # Number of workers
-  workers: Etc.nprocessors,
+  workers: 1,
   # Number of threads per worker
   threads: 1,
   # Graceful shutdown timeout
-  shutdown_timeout: 0.3,
+  shutdown_timeout: 5,
   # Binds
-  binds: ['http://0.0.0.0:3000']
+  binds: ["http://0.0.0.0:3000"],
+  # Preload
+  preload: true,
+  # Rackup file
+  rackup_file: "config.ru",
+  # Scheduler class
+  scheduler_class: nil,
+  # Whether to stream the body or not
+  stream_body: false,
+  # Config file
+  config_file: nil
 }
 
 options = DEFAULT_OPTIONS.to_a.select(&:last).to_h
 
 # Define the option parser
 OptionParser.new do |opts|
-  opts.banner = "Usage: script.rb [options]"
+  opts.banner = "Usage: itsi [options]"
+
+  opts.on("-C", "--config CONFIG_FILE", String, "Itsi Configuration file to use (default: Itsi.rb)") do |config_file|
+    options[:config_file] = config_file
+  end
 
   opts.on("-w", "--workers WORKERS", Integer, "Number of workers (default: #{options[:workers]})") do |w|
     options[:workers] = w
@@ -31,29 +43,68 @@ OptionParser.new do |opts|
     options[:threads] = t
   end
 
-  opts.on("-h", "--host HOST", String, "Host to bind to (default: #{options[:host]})") do |h|
-    options[:host] = h
+  opts.on("-r", "--rackup_file FILE", String, "Rackup file to use (default: #{options[:rackup_file]})") do |rf|
+    options[:rackup_file] = rf
   end
 
-  opts.on("-p", "--port PORT", Integer, "Port for the application (default: #{options[:port]})") do |p|
-    options[:port] = p
+  opts.on("--worker-memory-limit MEMORY_LIMIT", Integer,
+          "Memory limit for each worker (default: #{options[:worker_memory_limit] || "None"}). If this limit is breached the worker is gracefully restarted") do |ml|
+    options[:worker_memory_limit] = ml
   end
 
-  opts.on("-f", "--use_fiber_scheduler PORT", TrueClass,
-          "Port for the application (default: #{options[:use_scheduler]})") do |p|
-    options[:use_scheduler] = p
+  opts.on("-f", "--fiber_scheduler [CLASS_NAME]", [String],
+          "Scheduler class to use (default: nil). Provide blank or true to use Itsi::Scheduler, or a classname to use an alternative scheduler") do |scheduler_class|
+    if scheduler_class.nil? || scheduler_class == "true"
+      options[:scheduler_class] = "Itsi::Scheduler"
+    elsif scheduler_class == "false"
+      options.delete(:scheduler_class)
+    else
+      options[:scheduler_class] = scheduler_class
+    end
   end
 
-  opts.on("--http_port HTTP_PORT", Integer, "HTTP port for the application (default: #{options[:http_port]})") do |hp|
-    options[:http_port] = hp
+  opts.on("--preload [true, false, :bundle_group_name]", String, " Toggle preloading the application") do |preload|
+    if preload == "true"
+      options[:preload] = true
+    elsif preload == "false"
+      options[:preload] = false
+    else
+      # Not supported yet
+    end
   end
 
-  opts.on("-c", "--cert_path CERT_PATH", String, "Path to the SSL certificate file") do |cp|
-    options[:cert_path] = cp
+  opts.on("-b", "--bind BIND", String,
+          "Bind address (default: #{options[:binds].join(", ")}). You can specify this flag multiple times to bind to multiple addresses.") do |bind|
+    options[:binds].pop if options[:binds].first.frozen?
+    options[:binds] << bind
   end
 
-  opts.on("-k", "--key_path KEY_PATH", String, "Path to the SSL key file") do |kp|
-    options[:key_path] = kp
+  opts.on("-c", "--cert_path CERT_PATH", String,
+          "Path to the SSL certificate file (must follow a --bind option). You can specify this flag multiple times.") do |cp|
+    raise OptionParser::InvalidOption, "--cert_path must follow a --bind" if options[:binds].empty?
+
+    require "uri"
+
+    # Modify the last bind entry to add/update the cert query parameter
+    uri = URI.parse("http://#{options[:binds].last}") # Ensure valid URI parsing
+    params = URI.decode_www_form(uri.query.to_s).to_h
+    params["cert"] = cp
+    query_string = params.map { |k, v| "#{k}=#{v}" }.join("&")
+    options[:binds][-1] = "#{uri.host}?#{query_string}"
+  end
+
+  opts.on("-k", "--key_path KEY_PATH", String,
+          "Path to the SSL key file (must follow a --bind option). You can specify this flag multiple times.") do |kp|
+    raise OptionParser::InvalidOption, "--key_path must follow a --bind" if options[:binds].empty?
+
+    require "uri"
+
+    # Modify the last bind entry to add/update the key query parameter
+    uri = URI.parse("http://#{options[:binds].last}") # Ensure valid URI parsing
+    params = URI.decode_www_form(uri.query.to_s).to_h
+    params["key"] = kp
+    query_string = params.map { |k, v| "#{k}=#{v}" }.join("&")
+    options[:binds][-1] = "#{uri.host}?#{query_string}"
   end
 
   opts.on("--shutdown_timeout SHUTDOWN_TIMEOUT", String,
@@ -65,20 +116,59 @@ OptionParser.new do |opts|
     options[:script_name] = script_name
   end
 
-  opts.on("--help", "Show this help message") do
+  opts.on("--stream-body", TrueClass, "Stream body frames (default: false for best compatibility)") do |stream_body|
+    options[:stream_body] = stream_body
+  end
+
+  opts.on("-h", "--help", "Show this help message") do
     puts opts
     exit
   end
 end.parse!
 
-# Parse the Rack application
-app, _ = Rack::Builder.parse_file("config.ru")
+require "itsi/server/config"
+if ARGV.pop == "init"
+  Itsi::Server::Config.write_default
+  exit(0)
+  # Add initialization code here
+end
+
+options = Itsi::Server::Config.load(options)
+loader = nil
+
+if options[:app] || File.exist?(options[:rackup_file])
+  loader ||= lambda do
+    require "rack"
+    require_relative "../lib/itsi/server/scheduler_mode" if options[:scheduler_class]
+    require "itsi/scheduler" if [true, "Itsi::Scheduler"].include?(options[:scheduler_class])
+    require "itsi/server"
+    return options[:app] if options[:app]
+    Array(Rack::Builder.parse_file(options[:rackup_file])).first
+  end
 
-puts "App is #{app}"
-# Make sure osprey is loaded, if not already loaded by the rack_app above.
-# Start the Osprey server
+  if options[:preload] == true
+    # If preload is true, we'll invoke our loader now, and just return a no-op proc
+    # which returns the app as loader. We still need to optionally load the scheduler class and rack
+    # in case the app has been provided directly in Itsi.rb instead of in config.ru
+    require "rack"
+    require_relative "../lib/itsi/server/scheduler_mode" if options[:scheduler_class]
+    require "itsi/scheduler" if [true, "Itsi::Scheduler"].include?(options[:scheduler_class])
+    loader = (options[:app] || loader[]).method(:itself).to_proc
+  elsif options[:preload]
+    # If a group name is given, we'll stick to just loading the gem group by the same name from the Gemfile.
+    # But we'll fall through to the default delayed loader for the full app.
+    require "bundler"
+    Bundler.setup
+    Bundler.require(options[:preload])
+    nil
+  end
+end
+
+# Make sure Itsi is loaded, if not already loaded by the rack_app above.
+# Start the Itsi server
 require "itsi/server"
-Itsi::Server.new(
-  app: app,
-  **options
-).start
+
+Itsi::Server.start(
+  loader: loader,
+  **options.except(:preload, :rackup_file)
+)

data/ext/itsi_error/Cargo.toml

@@ -7,3 +7,5 @@ edition = "2024"
 thiserror = "2.0.11"
 magnus = { version = "0.7.1" }
 rcgen = "0.13.2"
+nix = "0.29.0"
+httparse = "1.10.1"

data/ext/itsi_error/src/from.rs

@@ -0,0 +1,68 @@
+use magnus::{
+    Error,
+    error::ErrorType,
+    exception::{self, arg_error, exception},
+};
+use nix::errno::Errno;
+
+use crate::ItsiError;
+use std::{ffi::NulError, io};
+
+pub static CLIENT_CONNECTION_CLOSED: &str = "Client disconnected";
+
+impl From<httparse::Error> for ItsiError {
+    fn from(err: httparse::Error) -> Self {
+        ItsiError::ArgumentError(err.to_string())
+    }
+}
+
+impl From<Errno> for ItsiError {
+    fn from(err: Errno) -> Self {
+        ItsiError::ArgumentError(err.to_string())
+    }
+}
+
+impl From<io::Error> for ItsiError {
+    fn from(err: io::Error) -> Self {
+        ItsiError::ArgumentError(err.to_string())
+    }
+}
+
+impl From<rcgen::Error> for ItsiError {
+    fn from(err: rcgen::Error) -> Self {
+        ItsiError::ArgumentError(err.to_string())
+    }
+}
+
+impl From<NulError> for ItsiError {
+    fn from(err: NulError) -> Self {
+        ItsiError::ArgumentError(err.to_string())
+    }
+}
+
+impl From<Error> for ItsiError {
+    fn from(err: Error) -> Self {
+        match err.error_type() {
+            ErrorType::Jump(tag) => ItsiError::Jump(tag.to_string()),
+            ErrorType::Error(_exception_class, cow) => ItsiError::ArgumentError(cow.to_string()),
+            ErrorType::Exception(exception) => ItsiError::ArgumentError(exception.to_string()),
+        }
+    }
+}
+
+impl From<ItsiError> for Error {
+    fn from(err: ItsiError) -> Self {
+        match err {
+            ItsiError::InvalidInput(msg) => Error::new(arg_error(), msg),
+            ItsiError::InternalServerError(msg) => Error::new(exception(), msg),
+            ItsiError::UnsupportedProtocol(msg) => Error::new(arg_error(), msg),
+            ItsiError::ArgumentError(msg) => Error::new(arg_error(), msg),
+            ItsiError::Jump(msg) => Error::new(exception::local_jump_error(), msg),
+            ItsiError::Break() => Error::new(exception::interrupt(), "Break"),
+            ItsiError::ClientConnectionClosed => {
+                Error::new(exception::eof_error(), CLIENT_CONNECTION_CLOSED)
+            }
+            ItsiError::Pass() => Error::new(exception::interrupt(), "Pass"),
+        }
+    }
+}

data/ext/itsi_error/src/lib.rs

@@ -1,49 +1,24 @@
+pub mod from;
 use thiserror::Error;
 
 pub type Result<T> = std::result::Result<T, ItsiError>;
 
-#[derive(Error, Debug)]
+#[derive(Error, Debug, Clone)]
 pub enum ItsiError {
-    #[error("Invalid input")]
+    #[error("Invalid input {0}")]
     InvalidInput(String),
-    #[error("Internal server error")]
-    InternalServerError,
-    #[error("Unsupported protocol")]
+    #[error("Internal server error {0}")]
+    InternalServerError(String),
+    #[error("Unsupported protocol {0}")]
     UnsupportedProtocol(String),
-    #[error("Argument error")]
+    #[error("Argument error: {0}")]
     ArgumentError(String),
+    #[error("Client Connection Closed")]
+    ClientConnectionClosed,
     #[error("Jump")]
     Jump(String),
-}
-
-impl From<ItsiError> for magnus::Error {
-    fn from(err: ItsiError) -> Self {
-        magnus::Error::new(magnus::exception::runtime_error(), err.to_string())
-    }
-}
-
-impl From<std::io::Error> for ItsiError {
-    fn from(err: std::io::Error) -> Self {
-        ItsiError::ArgumentError(err.to_string())
-    }
-}
-
-impl From<rcgen::Error> for ItsiError {
-    fn from(err: rcgen::Error) -> Self {
-        ItsiError::ArgumentError(err.to_string())
-    }
-}
-
-impl From<magnus::Error> for ItsiError {
-    fn from(err: magnus::Error) -> Self {
-        match err.error_type() {
-            magnus::error::ErrorType::Jump(tag) => ItsiError::Jump(tag.to_string()),
-            magnus::error::ErrorType::Error(_exception_class, cow) => {
-                ItsiError::ArgumentError(cow.to_string())
-            }
-            magnus::error::ErrorType::Exception(exception) => {
-                ItsiError::ArgumentError(exception.to_string())
-            }
-        }
-    }
+    #[error("Break")]
+    Break(),
+    #[error("Pass")]
+    Pass(),
 }

data/ext/itsi_instrument_entry/Cargo.toml

@@ -0,0 +1,15 @@
+[package]
+name = "itsi_instrument_entry"
+version = "0.1.0"
+edition = "2021"
+authors = ["Wouter Coppieters <wc@pico.net.nz>"]
+license = "MIT"
+publish = false
+
+
+[lib]
+proc-macro = true
+[dependencies]
+proc-macro2 = "1.0"
+quote = "1.0"
+syn = { version = "1.0", features = ["full"] }

data/ext/itsi_instrument_entry/src/lib.rs

@@ -0,0 +1,31 @@
+use proc_macro::TokenStream;
+use proc_macro2::TokenStream as TokenStream2;
+use quote::quote;
+use syn::{parse_macro_input, ItemFn};
+
+#[proc_macro_attribute]
+pub fn instrument_with_entry(attr: TokenStream, item: TokenStream) -> TokenStream {
+    let attr_tokens = TokenStream2::from(attr);
+    let input_fn = parse_macro_input!(item as ItemFn);
+    let attrs = input_fn.attrs;
+    let vis = input_fn.vis;
+    let sig = input_fn.sig;
+    let block = input_fn.block;
+    let output = quote! {
+        #[cfg(debug_assertions)]
+        #[tracing::instrument(#attr_tokens)]
+        #(#attrs)*
+        #vis #sig {
+            tracing::trace!("");
+            #block
+        }
+
+        #[cfg(not(debug_assertions))]
+        #(#attrs)*
+        #vis #sig {
+            #block
+        }
+    };
+
+    output.into()
+}

data/ext/itsi_rb_helpers/Cargo.toml

@@ -4,5 +4,7 @@ version = "0.1.0"
 edition = "2024"
 
 [dependencies]
+cfg-if = "1.0.0"
 magnus = { version = "0.7.1", features = ["rb-sys", "bytes"] }
+nix = "0.29.0"
 rb-sys = "0.9.105"

data/ext/itsi_rb_helpers/src/heap_value.rs

@@ -0,0 +1,121 @@
+use magnus::IntoValue;
+use magnus::rb_sys::AsRawValue;
+use magnus::value::BoxValue;
+use magnus::{Ruby, Value, value::ReprValue};
+use std::fmt::{self, Debug, Formatter};
+use std::ops::Deref;
+
+/// HeapVal is a wrapper for heap-allocated magnus ReprVa;ies
+/// that is marked as thread-safe(Send and Sync)
+/// It's up to the user to actually ensure this though,
+/// typically by only interacting with the value from a thread which
+/// holds the GVL.
+pub struct HeapValue<T>(pub BoxValue<T>)
+where
+    T: ReprValue;
+
+impl<T> PartialEq for HeapValue<T>
+where
+    T: ReprValue,
+{
+    fn eq(&self, other: &Self) -> bool {
+        self.0.as_raw() == other.0.as_raw()
+    }
+}
+
+impl<T> Deref for HeapValue<T>
+where
+    T: ReprValue,
+{
+    type Target = T;
+
+    fn deref(&self) -> &Self::Target {
+        &self.0
+    }
+}
+
+impl<T> HeapValue<T>
+where
+    T: ReprValue,
+{
+    pub fn inner(self) -> T {
+        *self.0
+    }
+}
+
+impl<T> IntoValue for HeapValue<T>
+where
+    T: ReprValue,
+{
+    fn into_value_with(self, _: &Ruby) -> Value {
+        self.0.into_value()
+    }
+}
+
+impl<T> From<T> for HeapValue<T>
+where
+    T: ReprValue,
+{
+    fn from(value: T) -> Self {
+        HeapValue(BoxValue::new(value))
+    }
+}
+
+impl<T> Clone for HeapValue<T>
+where
+    T: ReprValue + Clone,
+{
+    fn clone(&self) -> Self {
+        HeapValue(BoxValue::new(*self.0.deref()))
+    }
+}
+
+impl<T> Debug for HeapValue<T>
+where
+    T: ReprValue + Debug,
+{
+    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
+        write!(f, "{:?}", self.0)
+    }
+}
+
+unsafe impl<T> Send for HeapValue<T> where T: ReprValue {}
+unsafe impl<T> Sync for HeapValue<T> where T: ReprValue {}
+
+/// HeapVal is a wrapper for heap-allocated magnus Values
+/// that is marked as thread-safe(Send and Sync)
+/// It's up to the user to actually ensure this though,
+/// typically by only interacting with the value from a thread which
+/// holds the GVL.
+pub struct HeapVal(HeapValue<Value>);
+impl Deref for HeapVal {
+    type Target = Value;
+
+    fn deref(&self) -> &Self::Target {
+        &self.0
+    }
+}
+
+impl IntoValue for HeapVal {
+    fn into_value_with(self, _: &Ruby) -> Value {
+        self.0.into_value()
+    }
+}
+
+impl From<Value> for HeapVal {
+    fn from(value: Value) -> Self {
+        HeapVal(HeapValue(BoxValue::new(value)))
+    }
+}
+
+impl Clone for HeapVal {
+    fn clone(&self) -> Self {
+        HeapVal(HeapValue(BoxValue::new(*self.0.deref())))
+    }
+}
+
+impl Debug for HeapVal {
+    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
+        write!(f, "{:?}", self.0)
+    }
+}