nonnative 3.34.0 → 3.36.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '028726d6f2465ec50e55504560c08adf2a1d4cb1cc487687f4308e03e50ebcaa'
-  data.tar.gz: 3309d497da450d41ac5044d446375ed8a937588045dc4a0305240880b59ac03d
+  metadata.gz: 6969c5c21e416e67752d3421af108506fe44730230537c9b426529e28dad7934
+  data.tar.gz: 148ab5d39ef4f367501cca5786de14bc50be175616048a19a792671eee27fc1a
 SHA512:
-  metadata.gz: 6213f4f042a0dab8767bb29021f80cd4d483b66a805165b746ba28c658532747778c51cf7c6720471d56ab5c2c8412f9694116331171d02b98e722d96eeef815
-  data.tar.gz: 1f36fe9bac571d834dfe837fb19173b1d9c062a7389e044df8620a940d38aa3bca40864a7e429dacfb20f15c57a36706d2ed352a1de53f5e86d9b2c8736e1407
+  metadata.gz: 85218dfe59a108dad82130912aaaa1bb0a79e60017595fd089383aafc005e4b9c9e72c74341cd38efc97ac2f31dbf460967cb2dc4eb2fcb34c565ad663b12e41
+  data.tar.gz: 8125a4ef344c00e450f8b03df400cbe2df991f8e2905420673fa2fbd09032c1623f52b540c92cf7ab08c60967b7dfb1d9239c68fcf737341e97c21e1feffa10a

data/README.md

@@ -79,6 +79,7 @@ Process/server fields:
 - `ports`: client-facing ports. These are also used for readiness/shutdown port checks.
 - `timeout`: max time (seconds) for each readiness/shutdown check. For processes, the same value also
   bounds optional HTTP/gRPC probes and graceful child exit after the stop signal. Defaults to `1.0`.
+  A value of `0` fails immediately; setting it to `nil` programmatically does the same.
 - `wait`: small sleep (seconds) between lifecycle steps.
 - `log`: per-runner log file used by process output redirection or server implementations.
 
@@ -89,7 +90,8 @@ Process-only fields:
 
 Service fields:
 - `port`: client-facing service port.
-- `timeout`: max time (seconds) for opt-in service readiness checks. Defaults to `1.0`.
+- `timeout`: max time (seconds) for opt-in service readiness checks. Defaults to `1.0`. A value of
+  `0` fails immediately; setting it to `nil` programmatically does the same.
 - `readiness`: optional list of startup readiness checks. Supported kind is `tcp`, which requires
   explicit `host` and `port`.
 
@@ -114,8 +116,8 @@ Nonnative.stop
 
 `Nonnative.start` runs ordered tiers: service lifecycle calls and optional readiness checks complete,
 then server lifecycle and readiness checks complete, then process lifecycle and readiness checks run.
-A failed service readiness check prevents later tiers; other collected startup errors trigger rollback
-after the attempted tiers finish. `Nonnative.stop` reverses the tiers: processes, servers, then
+A failed service lifecycle call or readiness check prevents later tiers; other collected startup errors
+trigger rollback after the attempted tiers finish. `Nonnative.stop` reverses the tiers: processes, servers, then
 services. Model dependencies in that direction; a managed server can satisfy a process dependency,
 but a server cannot wait on a managed process. Startup failures raise `Nonnative::StartError`, and
 shutdown failures raise `Nonnative::StopError`.
@@ -600,11 +602,13 @@ The system allows you to define an in-process HTTP forward proxy server for exte
 The upstream scheme defaults to HTTPS on the scheme's default port; pass `scheme:`/`port:` to
 `Nonnative::HTTPProxyServer.new` to target an `http://` upstream or a non-default port. The proxy
 forwards the request path and query for `GET`, `HEAD`, `POST`, `PUT`, `PATCH`, `DELETE`, and
-`OPTIONS`, while removing proxy credentials plus `Host` and `Accept-Encoding` before the upstream
-request.
+`OPTIONS`, while removing proxy credentials, `Host`, `Accept-Encoding`, hop-by-hop headers, and
+headers nominated by `Connection` before the upstream request.
 
 The proxy preserves the upstream status, body, and safe end-to-end response headers such as `Content-Type`, `ETag`, and application-specific metadata. It removes hop-by-hop, connection-nominated, proxy-authentication, and framing headers; `Set-Cookie`, `Location`, and `Content-Encoding` are not forwarded.
 
+When the upstream is unavailable, disconnects unexpectedly, or times out, the proxy returns a clean gateway response (`502` or `504`) instead of exposing an internal exception page.
+
 Define your server:
 
 ```ruby

data/lib/nonnative/fault_injection_proxy.rb

@@ -52,6 +52,8 @@ module Nonnative
   # @see Nonnative::Proxy
   # @see Nonnative::SocketPairFactory
   class FaultInjectionProxy < Nonnative::Proxy
+    STOP_DRAIN_TIMEOUT = 1
+
     class Connection
       attr_accessor :pair, :thread
       attr_reader :socket
@@ -73,6 +75,7 @@ module Nonnative
       @logger = Logger.new(service.proxy.log)
       @mutex = Mutex.new
       @state = :none
+      @stopping = false
 
       super
     end
@@ -84,6 +87,7 @@ module Nonnative
     #
     # @return [void]
     def start
+      mutex.synchronize { @stopping = false }
       @tcp_server = ::TCPServer.new(service.host, service.port)
       @thread = Thread.new { perform_start }
 
@@ -95,6 +99,9 @@ module Nonnative
     # @return [void]
     def stop
       server = tcp_server
+      mark_stopping
+      close_connections
+      close_queued_connections(server)
       server&.close
 
       listener_thread = thread
@@ -107,8 +114,6 @@ module Nonnative
       @tcp_server = nil
       @thread = nil
 
-      close_connections
-
       Nonnative.logger.info "stopped with host '#{service.host}' and port '#{service.port}' for proxy 'fault_injection'"
     end
 
@@ -225,13 +230,16 @@ module Nonnative
 
     private
 
-    attr_reader :tcp_server, :thread, :connections, :mutex, :state, :logger
+    attr_reader :tcp_server, :thread, :connections, :mutex, :state, :logger, :stopping
 
     def perform_start
       loop do
         local_socket = tcp_server.accept
         id = local_socket.object_id
-        register_connection(id, local_socket)
+        unless register_connection(id, local_socket)
+          local_socket.close
+          next
+        end
         connection_thread = Thread.start(local_socket) do |accepted_socket|
           accept_connection id, accepted_socket
         end
@@ -275,6 +283,19 @@ module Nonnative
       end
     end
 
+    def close_queued_connections(server)
+      return unless server
+
+      # This connection is queued after every client that connected before shutdown began.
+      # When the listener accepts and closes it, those earlier clients have been closed as well.
+      barrier = TCPSocket.new(service.host, service.port)
+      barrier.wait_readable(STOP_DRAIN_TIMEOUT)
+    rescue IOError, SystemCallError
+      nil
+    ensure
+      barrier&.close
+    end
+
     def apply_state(state)
       Nonnative.logger.info "applying state '#{state}' for proxy 'fault_injection'"
 
@@ -293,7 +314,16 @@ module Nonnative
     end
 
     def register_connection(id, socket)
-      mutex.synchronize { connections[id] = Connection.new(socket) }
+      mutex.synchronize do
+        return false if stopping
+
+        connections[id] = Connection.new(socket)
+        true
+      end
+    end
+
+    def mark_stopping
+      mutex.synchronize { @stopping = true }
     end
 
     def attach_connection_thread(id, thread)

data/lib/nonnative/http_proxy_server.rb

@@ -44,13 +44,35 @@ module Nonnative
     ].freeze
 
     NON_FORWARDABLE_REQUEST_HEADERS = %w[
-      Host
-      Accept-Encoding
-      Version
-      Proxy-Authenticate
-      Proxy-Authorization
+      host
+      accept-encoding
+      version
+      proxy-authenticate
+      proxy-authorization
+      proxy-connection
+      connection
+      keep-alive
+      te
+      trailer
+      transfer-encoding
+      upgrade
+    ].freeze
+
+    GATEWAY_TIMEOUT_ERRORS = [
+      RestClient::Exceptions::Timeout
     ].freeze
 
+    GATEWAY_CONNECTION_ERRORS = [
+      RestClient::ServerBrokeConnection,
+      Errno::ECONNREFUSED,
+      Errno::EHOSTUNREACH,
+      SocketError
+    ].freeze
+
+    # Match malformed percent escapes and bytes outside RFC 3986's path-safe set. Valid `%HH`
+    # escapes remain intact; each match is percent-encoded before building the upstream URI.
+    PATH_ESCAPE_PATTERN = %r{%(?![\da-fA-F]{2})|[^A-Za-z0-9\-._~!$&'()*+,;=:@/%]}
+
     # Extracts request headers from the Rack environment and normalizes them to standard HTTP names.
     #
     # Certain hop-by-hop or proxy-specific headers are removed.
@@ -64,7 +86,8 @@ module Nonnative
         result[normalized_request_header_name(header)] = value
       end
 
-      headers.except(*NON_FORWARDABLE_REQUEST_HEADERS)
+      connection_headers = request_connection_headers(headers)
+      headers.reject { |header, _| non_forwardable_request_header?(header, connection_headers) }
     end
 
     # Builds the upstream URL for the given request.
@@ -75,8 +98,9 @@ module Nonnative
     def build_url(request, settings)
       uri_class = settings.scheme == 'http' ? URI::HTTP : URI::HTTPS
       query = request.query_string
+      path = escape_path(request.path_info)
 
-      uri_class.build(host: settings.host, port: settings.port, path: request.path_info, query: query.empty? ? nil : query).to_s
+      uri_class.build(host: settings.host, port: settings.port, path:, query: query.empty? ? nil : query).to_s
     end
 
     # Executes the upstream request and returns the response.
@@ -86,13 +110,20 @@ module Nonnative
     # @param headers [Hash] request headers
     # @param payload [String, nil] request payload
     # @return [RestClient::Response] response for error statuses, otherwise RestClient return value
+    # @raise [Sinatra::Halt] with a gateway status when the upstream is unavailable or times out
     def api_response(method:, url:, headers:, payload: nil)
       options = { method:, url:, headers: }
       options[:payload] = payload unless payload.nil?
 
       RestClient::Request.execute(options)
+    rescue *GATEWAY_TIMEOUT_ERRORS
+      halt 504
+    rescue *GATEWAY_CONNECTION_ERRORS
+      halt 502
     rescue RestClient::Exception => e
-      e.response
+      return e.response if e.response
+
+      halt 502
     end
 
     # Extracts the request payload for verbs that can carry a body.
@@ -149,6 +180,20 @@ module Nonnative
       header.delete_prefix('HTTP_').split('_').map(&:capitalize).join('-')
     end
 
+    def escape_path(path)
+      URI::DEFAULT_PARSER.escape(path, PATH_ESCAPE_PATTERN)
+    end
+
+    def request_connection_headers(headers)
+      headers.fetch('Connection', '').split(',').map { |header| header.strip.downcase }
+    end
+
+    def non_forwardable_request_header?(header, connection_headers)
+      normalized_header = header.downcase
+
+      NON_FORWARDABLE_REQUEST_HEADERS.include?(normalized_header) || connection_headers.include?(normalized_header)
+    end
+
     # Registered before `get` so it takes precedence over Sinatra's GET-generated HEAD route,
     # which would otherwise forward HEAD requests upstream as GET.
     head(/.*/) do

data/lib/nonnative/pool.rb

@@ -37,7 +37,7 @@ module Nonnative
       errors.concat(service_lifecycle(services, :start, :start))
       service_readiness_errors = check_service_readiness(services)
       errors.concat(service_readiness_errors)
-      return errors if service_readiness_errors.any?
+      return errors if errors.any?
 
       [servers, processes].each { |runners| errors.concat(run_lifecycle_checks(runners, :start, :open?, :start)) }
 

data/lib/nonnative/timeout.rb

@@ -15,7 +15,7 @@ module Nonnative
   #   # ok is either the block result or false if the timeout elapsed
   #
   class Timeout
-    # @param time [Numeric] timeout duration in seconds
+    # @param time [Numeric, nil] timeout duration in seconds; zero and `nil` values time out immediately
     def initialize(time)
       @time = time
     end
@@ -23,10 +23,13 @@ module Nonnative
     # Executes the given block with the configured timeout.
     #
     # If the timeout elapses, returns `false` instead of raising `Timeout::Error`.
+    # Zero and `nil` durations also return `false` without running the block.
     #
     # @yield the work to execute under a timeout
     # @return [Object, false] the block's return value, or `false` if the timeout elapsed
     def perform(&)
+      return false if time.nil? || time.zero?
+
       ::Timeout.timeout(time, &)
     rescue ::Timeout::Error
       false

data/lib/nonnative/version.rb

@@ -4,5 +4,5 @@ module Nonnative
   # The current gem version.
   #
   # @return [String]
-  VERSION = '3.34.0'
+  VERSION = '3.36.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nonnative
 version: !ruby/object:Gem::Version
-  version: 3.34.0
+  version: 3.36.0
 platform: ruby
 authors:
 - Alejandro Falkowski