ruvoy 0.2.0-aarch64-linux → 0.2.1-aarch64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 570d5fa414a87e4f204964ad1dac4b45527948bb3fed5473559cc8698cb80689
-  data.tar.gz: 2d49878f9c9add538a8560d93988cc9c1fcbc838839f79f12e4a2f064823c739
+  metadata.gz: a585700c8fa8895e0202a89938ba64268f56cd01936857684f276b3904ec408a
+  data.tar.gz: aac2b3e316c6ed0ef47c0c205ce232cc6164e0102cbfd4a8ca0761e885faa72a
 SHA512:
-  metadata.gz: 61fd6ebec19502a5160627811938fdcca59c4fdeceed34eaea0f9cc1869d85aa9a6280ea98ae1a984bd6b2733a083c643976fd10c210c93c4aee304ba5d8bd6c
-  data.tar.gz: 0ca15aefdd13ae67dd6c90ab67e4fd98f6d6fd3a0c72bc0da7f2983b32cd16a4c2a585daf5d0bddd7b8465695e0cdb5fcc67627da729aefc13e58a76719f5837
+  metadata.gz: 1cd84c20274deae0cb6105f37d5872c590de9a888ade90715e84be42a72f3a4c4e270dd5a3a412621845fa195c7cd15fedf6237a7fd0c7153c3bbd1e10b85b42
+  data.tar.gz: a3feba17ee4f6253718e95d1902d5edad010899228b4783e97c3e344ee736360edb9ecddef811bfeecfb534a32d7b1e74b4cfb8050ad8d50209d67ba6362484d

data/README.md

@@ -141,10 +141,9 @@ kept, in memory up to 128 KiB and in a temporary file beyond that, so
 Rack versions expect. Raw socket hijacking
 (`rack.hijack`) is not supported; the connection always belongs to Envoy.
 
-A response body that fails after its headers are already on the wire can only
-stop: a dynamic module cannot reset a stream it has started answering, so the
-client receives a short body rather than an error. Applications that can fail
-partway through should send their own length or checksum.
+A response body that fails after its headers are already on the wire resets
+the stream, so the client sees an error rather than a short body that looks
+complete.
 
 ## Blocking calls
 
@@ -274,8 +273,31 @@ one request overlap. A repeated response header arrives as an Array.
 - A response body over `max_response_bytes`, or over Envoy's own buffer limit,
   raises `Ruvoy::UpstreamResponseTooLarge`, a subclass of `Ruvoy::UpstreamError`,
   so a caller can tell asking for less apart from trying again later.
-- Responses are buffered whole, so `max_response_bytes` bounds what one call
-  can hold in memory.
+- `call` buffers the response whole, so `max_response_bytes` bounds what one
+  call can hold in memory.
+
+`stream` takes the same arguments and returns once the response head is in.
+The body yields the response as it arrives and can be returned as the Rack
+response, so a proxy is one line:
+
+```ruby
+run ->(env) { env["ruvoy.upstream"].stream("api", env["REQUEST_METHOD"], env["PATH_INFO"], body: env["rack.input"]) }
+```
+
+- The request body may be a String or anything that responds to `read`, such
+  as `rack.input`. One that ends within its first 64 KiB goes with its length,
+  an empty one as none, and a longer one chunked while the response comes down.
+- `idle_timeout:` bounds the wait for the head and between chunks, `timeout_ms`
+  by default, and raises `Ruvoy::UpstreamTimeout`. `timeout:` bounds the whole
+  exchange and is unset by default: Envoy answers 504 before the head, and
+  resets the stream after it.
+- Envoy applies no flow control to a stream a module starts, so at most
+  `upstream.stream_buffer_bytes` (default 1 MiB) of the response waits for a
+  slow reader. Past that the stream is reset and the reader gets
+  `Ruvoy::UpstreamOverflow`. The request body is held to the same budget until
+  Envoy takes it; what Envoy buffers after that is not bounded by Ruvoy.
+- Closing the body before its end, or finishing the request, resets the
+  stream. `body.trailers` holds the upstream's trailers once the body has ended.
 
 [`examples/extensions`](examples/extensions) runs both against a stand-in
 service, including two calls from one request overlapping.

data/lib/ruvoy/version.rb

@@ -3,5 +3,5 @@
 module Ruvoy
   # Kept in step with the Cargo workspace version by test/e2e/cli_test.rb: the
   # gem and the module it carries are the same release.
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruvoy
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: aarch64-linux
 authors:
 - Zixin Zhou