nonnative 3.38.0 → 3.40.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d53bdf381bf4cb897538cc4520e499b0116e8fc31566930ae1612859dda4d6a
-  data.tar.gz: 809f8545b4fe5e6d49289840572247148c38f2a0cd3647919b5b77f473b88b5e
+  metadata.gz: f3513aa619cd9dab8134d9c4e8d22d333dcd2300f92e271cb8dee10ed7c0de2c
+  data.tar.gz: 4aeae3fd49ad6bd1da6b929bfa666c17c3c346a73a56b430ca7214a82ee19698
 SHA512:
-  metadata.gz: 34adbd873e0eedd1b994aff7afe5ebc33834ab3f820dcbd2b551d619c851b083ae897828c88ad6c5b185b3d174390364aca1fdd9be85440fc2a5175e574eb686
-  data.tar.gz: 06ea5ded95fd98a9ba589cf5b5a8a8d567e07e295fbe72445332997ccb21b1649aa8edb0fe21054a17b91c527e023aa4e44c0724ce66ca0e43c4f39c3f7c4a69
+  metadata.gz: d5c02d41c403e663ba1ffe2e8f36e67fe4a2a36910b60a921d0e02c3ac84b1c68be01158ff223c40ee3e6990e429d79faf79eada9e538195a26652523d89813a
+  data.tar.gz: 6be1f9067df0fd1c121d0604813d3f91b4e9bbe9cbecfcd10aacd8a96a06a76f27a0a42bb3a08398cb7f0c3e68678a42c0f55b62390f304461814332a1e7e1bf

data/README.md

@@ -182,8 +182,9 @@ expect(response.code).to eq(200)
 ```
 
 HTTP error statuses are returned as response objects so callers can inspect `.code` and `.body`.
-Request timeouts and broken connections raise their RestClient exceptions; observability requests are
-not retried automatically.
+Broken connections raise their RestClient exceptions, and a request timeout raises either a RestClient
+timeout exception or `Timeout::Error` (the latter when `read_timeout` bounds a Net::HTTP retry of an
+idempotent verb); observability requests are not retried automatically.
 
 `Nonnative.grpc_health` is a helper for the standard gRPC health checking protocol:
 
@@ -608,8 +609,10 @@ end
 The system allows you to define an in-process HTTP forward proxy server for external systems, e.g. `api.github.com`. This is a server implementation, not a fault-injection service proxy.
 
 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
+`Nonnative::HTTPProxyServer.new` to target an `http://` upstream or a non-default port. The whole
+upstream call defaults to a one-second bound, including Net::HTTP's built-in retry of an
+unresponsive idempotent request; pass `upstream_timeout:` to tune it for a slow dependency. The
+proxy forwards the request path and query for `GET`, `HEAD`, `POST`, `PUT`, `PATCH`, `DELETE`, and
 `OPTIONS`, while removing proxy credentials, `Host`, `Accept-Encoding`, hop-by-hop headers, and
 headers nominated by `Connection` before the upstream request.
 

data/lib/nonnative/configuration.rb

@@ -93,6 +93,8 @@ module Nonnative
       process = Nonnative::ConfigurationProcess.new
       yield process
 
+      raise ArgumentError, "Process '#{process.name}' requires 'command' or 'go'" if process.command.nil?
+
       processes << process
     end
 
@@ -157,7 +159,7 @@ module Nonnative
         tools = go.tools || []
 
         -> { Nonnative.go_argv(tools, go.output, go.executable, go.command, *params) }
-      else
+      elsif process.command
         -> { process.command }
       end
     end

data/lib/nonnative/http_client.rb

@@ -18,7 +18,8 @@ module Nonnative
       @host = host
       @exceptions = [
         RestClient::Exceptions::Timeout,
-        RestClient::ServerBrokeConnection
+        RestClient::ServerBrokeConnection,
+        ::Timeout::Error
       ]
     end
 
@@ -40,7 +41,7 @@ module Nonnative
     # @param opts [Hash] RestClient request options (e.g. `headers`, `read_timeout`, `open_timeout`)
     # @return [RestClient::Response, String] response for non-2xx errors, otherwise the RestClient result
     def get(pathname, opts = {})
-      with_exception do
+      with_exception(opts) do
         resource(pathname, opts).get
       end
     end
@@ -52,7 +53,7 @@ module Nonnative
     # @param opts [Hash] RestClient request options
     # @return [RestClient::Response, String] response for non-2xx errors, otherwise the RestClient result
     def post(pathname, payload, opts = {})
-      with_exception do
+      with_exception(opts) do
         resource(pathname, opts).post(payload)
       end
     end
@@ -63,7 +64,7 @@ module Nonnative
     # @param opts [Hash] RestClient request options
     # @return [RestClient::Response, String] response for non-2xx errors, otherwise the RestClient result
     def delete(pathname, opts = {})
-      with_exception do
+      with_exception(opts) do
         resource(pathname, opts).delete
       end
     end
@@ -75,7 +76,7 @@ module Nonnative
     # @param opts [Hash] RestClient request options
     # @return [RestClient::Response, String] response for non-2xx errors, otherwise the RestClient result
     def put(pathname, payload, opts = {})
-      with_exception do
+      with_exception(opts) do
         resource(pathname, opts).put(payload)
       end
     end
@@ -87,7 +88,7 @@ module Nonnative
     # @param opts [Hash] RestClient request options
     # @return [RestClient::Response, String] response for non-2xx errors, otherwise the RestClient result
     def patch(pathname, payload, opts = {})
-      with_exception do
+      with_exception(opts) do
         resource(pathname, opts).patch(payload)
       end
     end
@@ -98,7 +99,7 @@ module Nonnative
     # @param opts [Hash] RestClient request options (e.g. `headers`, `read_timeout`, `open_timeout`)
     # @return [RestClient::Response, String] response for non-2xx errors, otherwise the RestClient result
     def head(pathname, opts = {})
-      with_exception do
+      with_exception(opts) do
         resource(pathname, opts).head
       end
     end
@@ -109,7 +110,7 @@ module Nonnative
     # @param opts [Hash] RestClient request options (e.g. `headers`, `read_timeout`, `open_timeout`)
     # @return [RestClient::Response, String] response for non-2xx errors, otherwise the RestClient result
     def options(pathname, opts = {})
-      with_exception do
+      with_exception(opts) do
         RestClient::Request.execute(opts.merge(method: :options, url: request_url(pathname)))
       end
     end
@@ -131,8 +132,12 @@ module Nonnative
       URI.join(host, pathname).to_s
     end
 
-    def with_exception
-      yield
+    # Net::HTTP silently retries idempotent verbs once on a read timeout, so bound the whole call
+    # (including any retry) by the wall clock rather than trusting `:read_timeout` alone.
+    def with_exception(opts = {}, &)
+      timeout = opts[:read_timeout]
+
+      timeout ? ::Timeout.timeout(timeout, &) : yield
     rescue *exceptions => e
       raise e
     rescue RestClient::Exception => e

data/lib/nonnative/http_proxy_server.rb

@@ -59,7 +59,8 @@ module Nonnative
     ].freeze
 
     GATEWAY_TIMEOUT_ERRORS = [
-      RestClient::Exceptions::Timeout
+      RestClient::Exceptions::Timeout,
+      ::Timeout::Error
     ].freeze
 
     GATEWAY_CONNECTION_ERRORS = [
@@ -112,10 +113,12 @@ module Nonnative
     # @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 = { method:, url:, headers:, open_timeout: settings.upstream_timeout, read_timeout: settings.upstream_timeout }
       options[:payload] = payload unless payload.nil?
 
-      RestClient::Request.execute(options)
+      # Net::HTTP retries idempotent verbs once on a read timeout, so bound the whole
+      # call (including any retry) by the wall clock rather than trusting read_timeout alone.
+      ::Timeout.timeout(settings.upstream_timeout) { RestClient::Request.execute(options) }
     rescue *GATEWAY_TIMEOUT_ERRORS
       halt 504
     rescue *GATEWAY_CONNECTION_ERRORS
@@ -246,11 +249,13 @@ module Nonnative
     # @param service [Nonnative::ConfigurationServer] server configuration
     # @param scheme [String] upstream scheme, `"http"` or `"https"`
     # @param port [Integer, nil] upstream port; `nil` uses the scheme's default port
-    def initialize(host, service, scheme: 'https', port: nil)
+    # @param upstream_timeout [Numeric] maximum seconds for each upstream operation (defaults to `1.0`)
+    def initialize(host, service, scheme: 'https', port: nil, upstream_timeout: ConfigurationRunner::DEFAULT_TIMEOUT)
       http_service = Class.new(Nonnative::HTTPProxy) do
         set :host, host
         set :scheme, scheme
         set :port, port
+        set :upstream_timeout, upstream_timeout
       end
 
       super(http_service.new, service)

data/lib/nonnative/observability.rb

@@ -14,8 +14,9 @@ module Nonnative
   #
   # Requests are performed using {Nonnative::HTTPClient}, so callers may pass RestClient options
   # such as `headers`, `open_timeout`, and `read_timeout`. HTTP error statuses are returned as response
-  # objects; timeouts and broken connections raise their RestClient exceptions. Requests are not
-  # retried automatically.
+  # objects; broken connections raise their RestClient exceptions, and a timeout raises either a
+  # RestClient timeout exception or `Timeout::Error` (the latter when `read_timeout` bounds a Net::HTTP
+  # retry of an idempotent verb). Requests are not retried automatically.
   #
   # @example
   #   Nonnative.configure do |config|

data/lib/nonnative/version.rb

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

metadata

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