Release 0.5.0

Author: drcaramelsyrup

.bleep

@@ -1 +1 @@
-75b626c78ed3fc9c7f7e9aa6f4d1bb7cbedc2c67
+f2baaca58bb42d4202c112f1eb8e70ffc2ed0aaa

.github/workflows/build.yml

@@ -37,7 +37,7 @@ jobs:
 
       - name: Pin crates to versions for MSRV
         run: |
-          [[ ${{ matrix.toolchain }} != 1.72.0 ]] || (cargo update -p boring --precise 4.13.0 && cargo update -p litemap --precise 0.7.4 && cargo update -p zerofrom --precise 0.1.5 && cargo update -p half --precise 2.4.1)
+          [[ ${{ matrix.toolchain }} != 1.72.0 ]] || (cargo update -p boring --precise 4.13.0 && cargo update -p litemap --precise 0.7.4 && cargo update -p zerofrom --precise 0.1.5 && cargo update -p half --precise 2.4.1 && cargo update -p backtrace --precise 0.3.74)
 
       - name: Run cargo fmt
         run: cargo fmt --all -- --check

CHANGELOG.md

@@ -2,6 +2,54 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.5.0](https://github.com/cloudflare/pingora/compare/0.4.0...0.5.0) - 2025-05-09
+ 
+### 🚀 Features
+
+- [Add tweak_new_upstream_tcp_connection hook to invoke logic on new upstream TCP sockets prior to connection](https://github.com/cloudflare/pingora/commit/be4a023d18c2b061f64ad5efd0868f9498199c91)
+- [Add ability to configure max retries for upstream proxy failures](https://github.com/cloudflare/pingora/commit/6c5d6021a6e67c971e835bef269655d0db94c2d1)
+- [Allow tcp user timeout to be configurable](https://github.com/cloudflare/pingora/commit/e77ca63da58892281f36dcb97c51a8b1e882e2f6)
+- [Add peer address to downstream handshake error logs](https://github.com/cloudflare/pingora/commit/3f9e0a2fae8feaea12a1a9687e6b4bf4616f66c5)
+- [Allow proxy to set stream level downstream read timeout](https://github.com/cloudflare/pingora/commit/87ae8ce2e7883c0a924a776b193c8a4f858b9349)
+- [Improve support for sending custom response headers and bodies for error messages](https://github.com/cloudflare/pingora/commit/a8a6e77eef2c0f4d2a45f00c5b0e316dd373f2f2)
+- [Allow configuring multiple listener tasks per endpoint](https://github.com/cloudflare/pingora/commit/69254671148938f6bc467f6decc2fc89ee7f531e)
+- [Add get_stale and get_stale_while_update for memory-cache](https://github.com/cloudflare/pingora/commit/bb28044cbe9ac9251940b8a313d970c7d15aaff6)
+
+### 🐛 Bug Fixes
+ 
+- [Fix deadloop if proxy_handle_upstream exits earlier than proxy_handle_downstream](https://github.com/cloudflare/pingora/commit/bb111aaa92b3753e650957df3a68f56b0cffc65d)
+- [Check on h2 stream end if error occurred for forwarding HTTP tasks](https://github.com/cloudflare/pingora/commit/e18f41bb6ddb1d6354e824df3b91d77f3255bea2)
+- [Check for content-length underflow on end of stream h2 header](https://github.com/cloudflare/pingora/commit/575d1aafd7c679a50a443701a4c55dcfdbc443b2)
+- [Correctly send empty h2 data frames prior to capacity polling](https://github.com/cloudflare/pingora/commit/c54190432a2efea30c5a0187bb7d078d33570a43)
+- [Signal that the response is done when body write finishes to avoid h1 downstream/h2 upstream errors](https://github.com/cloudflare/pingora/commit/5750e4279e75b1e764dcfc5530aa7a7cebe3abef)
+- [Ignore h2 pipe error when finishing an H2 upstream](https://github.com/cloudflare/pingora/commit/8ad15031291eb5779e0e93e714eb969c4132f632)
+- [Add finish_request_body() for HTTP healthchecks so that H2 healthchecks succeed](https://github.com/cloudflare/pingora/commit/67bc7cc170e754d335cc1d6d526f203c4345eceb)
+- [Fix Windows compile errors by updating `impl<T> UniqueID` to use correct return type](https://github.com/cloudflare/pingora/commit/1756948df77d257bddf7ab798cc3fddf348a91c8)
+- [Fixed compilation errors on Windows](https://github.com/cloudflare/pingora/commit/906cb90864bf6e441727083c9cbd4f6fb289d6f5)
+- [Poll for H2 capacity before sending H2 body to propagate backpressure](https://github.com/cloudflare/pingora/commit/b6f24ff3725d9d8b6a740d87cad959d94befbe54)
+- [Fix for write_error_response for http2 downstreams to set EOS](https://github.com/cloudflare/pingora/commit/c0fa5065812d87e6e404c5624b26cd99c5194079)
+- [Always drain v1 request body before session reuse](https://github.com/cloudflare/pingora/commit/fda3317ec822678564d641e7cf1c9b77ee3759ff)
+- [Fixes HTTP1 client reads to properly timeout on initial read](https://github.com/cloudflare/pingora/commit/3c7db34acb0d930ae7043290a88bc56c1cd77e45)
+- [Fixes issue where if TLS client never sends any bytes, hangs forever](https://github.com/cloudflare/pingora/commit/d1bf0bcac98f943fd716278d674e7d10dce2223e)
+ 
+### Everything Else
+ 
+- [Add builder api for pingora listeners](https://github.com/cloudflare/pingora/commit/3f564af3ae56e898478e13e71d67d095d7f5dbbd)
+- [Better handling for h1 requests that contain both transfer-encoding and content-length](https://github.com/cloudflare/pingora/commit/9287b82645be4a52b0b63530ba38aa0c7ddc4b77)
+- [Allow setting raw path in request to support non-UTF8 use cases](https://github.com/cloudflare/pingora/commit/e6b823c5d89860bb97713fdf14f197f799aed6af)
+- [Allow reusing session on errors prior to proxy upstream](https://github.com/cloudflare/pingora/commit/f8d01278a586c60392b1e3b92e5ed97a415d8fe7)
+- [Avoid allocating large buffer in the accept() loop](https://github.com/cloudflare/pingora/commit/ef234f5baa45650be064c7dd34c2f17986361480)
+- [Ensure HTTP/1.1 when forcing chunked encoding](https://github.com/cloudflare/pingora/commit/9281cab8eab1b545f15f0e387d2ba4cd2ca27364)
+- [Reject if the HTTP header contains duplicated Content-Length values](https://github.com/cloudflare/pingora/commit/eef35768d11305d1293468a6c3ce91a3858dc0fc)
+- [proxy_upstream_filter tries to reuse downstream by default](https://github.com/cloudflare/pingora/commit/86293e65b5c7d8a96f3a333a1f191766dc95bee5)
+- [Allow building server that avoids std::process::exit during shutdown](https://github.com/cloudflare/pingora/commit/2d977d4eb808d8bcbc0ce87cabac4cf4854dfb80)
+- [Update Sentry crate to 0.36](https://github.com/cloudflare/pingora/commit/01a1f9a65c51a4351c29d6961ea3164a6a811958)
+- [Update the bounds on `MemoryCache` methods to accept broader key types](https://github.com/cloudflare/pingora/commit/d66923a9a41d00b326cef5dfb57d8c020d6a4abb)
+- [Flush already received data if upstream write errors](https://github.com/cloudflare/pingora/commit/aa7c2f1a89a652137a987e5f5dbdab228c2f4d06)
+- [Allow modules to receive HttpTask::Done, flush response compression on receiving Done task](https://github.com/cloudflare/pingora/commit/c82fb6ba57b95c256b58095881a33a9bc08f170a)
+- API signature changes as part of experimental proxy cache support
+- Note MSRV was effectively bumped to 1.82 from 1.72 due to a dependency update, though older compilers may still be able to build by pinning dependencies, e.g. `cargo update -p backtrace --precise 0.3.74`.
+
 ## [0.4.0](https://github.com/cloudflare/pingora/compare/0.3.0...0.4.0) - 2024-11-01
 
 ### 🚀 Features

README.md

@@ -43,6 +43,8 @@ API docs are also available for all the crates.
 * Pingora-timeout: A more efficient async timer system
 * TinyUfo: The caching algorithm behind pingora-memory-cache
 
+Note that Pingora proxy integration with caching should be considered experimental, and as such APIs related to caching are currently highly volatile.
+
 # System requirements
 
 ## Systems
@@ -58,7 +60,9 @@ Both x86_64 and aarch64 architectures will be supported.
 
 Pingora keeps a rolling MSRV (minimum supported Rust version) policy of 6 months. This means we will accept PRs that upgrade the MSRV as long as the new Rust version used is at least 6 months old.
 
-Our current MSRV is 1.72.
+Our current MSRV is effectively 1.82.
+
+Previously Pingora advertised an MSRV of 1.72. Older Rust versions may still be able to compile via `cargo update` pinning dependencies such as `[email protected]`. The advertised MSRV in config files will be officially bumped to 1.82 in an upcoming release.
 
 Building with the optional feature `boringssl` with Boring >= 4.14 requires Rust 1.80.
 

pingora-boringssl/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "pingora-boringssl"
-version = "0.4.0"
+version = "0.5.0"
 authors = ["Yuchen Wu <[email protected]>"]
 license = "Apache-2.0"
 edition = "2021"

pingora-cache/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "pingora-cache"
-version = "0.4.0"
+version = "0.5.0"
 authors = ["Yuchen Wu <[email protected]>"]
 license = "Apache-2.0"
 edition = "2021"
@@ -17,12 +17,12 @@ name = "pingora_cache"
 path = "src/lib.rs"
 
 [dependencies]
-pingora-core = { version = "0.4.0", path = "../pingora-core", default-features = false }
-pingora-error = { version = "0.4.0", path = "../pingora-error" }
-pingora-header-serde = { version = "0.4.0", path = "../pingora-header-serde" }
-pingora-http = { version = "0.4.0", path = "../pingora-http" }
-pingora-lru = { version = "0.4.0", path = "../pingora-lru" }
-pingora-timeout = { version = "0.4.0", path = "../pingora-timeout" }
+pingora-core = { version = "0.5.0", path = "../pingora-core", default-features = false }
+pingora-error = { version = "0.5.0", path = "../pingora-error" }
+pingora-header-serde = { version = "0.5.0", path = "../pingora-header-serde" }
+pingora-http = { version = "0.5.0", path = "../pingora-http" }
+pingora-lru = { version = "0.5.0", path = "../pingora-lru" }
+pingora-timeout = { version = "0.5.0", path = "../pingora-timeout" }
 http = { workspace = true }
 indexmap = "1"
 once_cell = { workspace = true }

pingora-core/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "pingora-core"
-version = "0.4.0"
+version = "0.5.0"
 authors = ["Yuchen Wu <[email protected]>"]
 license = "Apache-2.0"
 edition = "2021"
@@ -19,14 +19,14 @@ name = "pingora_core"
 path = "src/lib.rs"
 
 [dependencies]
-pingora-runtime = { version = "0.4.0", path = "../pingora-runtime" }
-pingora-openssl = { version = "0.4.0", path = "../pingora-openssl", optional = true }
-pingora-boringssl = { version = "0.4.0", path = "../pingora-boringssl", optional = true }
-pingora-pool = { version = "0.4.0", path = "../pingora-pool" }
-pingora-error = { version = "0.4.0", path = "../pingora-error" }
-pingora-timeout = { version = "0.4.0", path = "../pingora-timeout" }
-pingora-http = { version = "0.4.0", path = "../pingora-http" }
-pingora-rustls = { version = "0.4.0", path = "../pingora-rustls", optional = true }
+pingora-runtime = { version = "0.5.0", path = "../pingora-runtime" }
+pingora-openssl = { version = "0.5.0", path = "../pingora-openssl", optional = true }
+pingora-boringssl = { version = "0.5.0", path = "../pingora-boringssl", optional = true }
+pingora-pool = { version = "0.5.0", path = "../pingora-pool" }
+pingora-error = { version = "0.5.0", path = "../pingora-error" }
+pingora-timeout = { version = "0.5.0", path = "../pingora-timeout" }
+pingora-http = { version = "0.5.0", path = "../pingora-http" }
+pingora-rustls = { version = "0.5.0", path = "../pingora-rustls", optional = true }
 tokio = { workspace = true, features = ["net", "rt-multi-thread", "signal"] }
 futures = "0.3"
 async-trait = { workspace = true }

pingora-error/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "pingora-error"
-version = "0.4.0"
+version = "0.5.0"
 authors = ["Yuchen Wu <[email protected]>"]
 license = "Apache-2.0"
 edition = "2021"

pingora-header-serde/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "pingora-header-serde"
-version = "0.4.0"
+version = "0.5.0"
 authors = ["Yuchen Wu <[email protected]>"]
 license = "Apache-2.0"
 edition = "2021"
@@ -27,6 +27,6 @@ zstd-safe = { version = "7.1.0", features = ["std"] }
 http = { workspace = true }
 bytes = { workspace = true }
 httparse = { workspace = true }
-pingora-error = { version = "0.4.0", path = "../pingora-error" }
-pingora-http = { version = "0.4.0", path = "../pingora-http" }
+pingora-error = { version = "0.5.0", path = "../pingora-error" }
+pingora-http = { version = "0.5.0", path = "../pingora-http" }
 thread_local = "1.0"

pingora-http/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "pingora-http"
-version = "0.4.0"
+version = "0.5.0"
 authors = ["Yuchen Wu <[email protected]>"]
 license = "Apache-2.0"
 edition = "2021"
@@ -19,7 +19,7 @@ path = "src/lib.rs"
 [dependencies]
 http = { workspace = true }
 bytes = { workspace = true }
-pingora-error = { version = "0.4.0", path = "../pingora-error" }
+pingora-error = { version = "0.5.0", path = "../pingora-error" }
 
 [features]
 default = []