Merge pull request #423 from Tencent/release/v1.5.0

Release/v1.5.0

.github/workflows/tquic-features.yml

@@ -25,6 +25,14 @@ jobs:
       run: cargo build --all --no-default-features -F ffi && cargo test --no-default-features -F ffi
     - name: Build with feature(s) qlog
       run: cargo build --all --no-default-features -F qlog && cargo test --no-default-features -F qlog
+    - name: Build with feature(s) h3
+      run: cargo build --all --no-default-features -F h3 && cargo test --no-default-features -F h3
     - name: Build with feature(s) ffi,qlog
       run: cargo build --all --no-default-features -F ffi,qlog && cargo test --no-default-features -F ffi,qlog
+    - name: Build with feature(s) ffi,h3
+      run: cargo build --all --no-default-features -F ffi,h3 && cargo test --no-default-features -F ffi,h3
+    - name: Build with feature(s) qlog,h3
+      run: cargo build --all --no-default-features -F qlog,h3 && cargo test --no-default-features -F qlog,h3
+    - name: Build with feature(s) ffi,qlog,h3
+      run: cargo build --all --no-default-features -F ffi,qlog,h3 && cargo test --no-default-features -F ffi,qlog,h3
 

CHANGELOG.md

@@ -11,6 +11,16 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 
+## [v1.5.0] - 2024-10-28
+
+### Added
+- Add h3 feature flag to reduce the size of complied library
+- Add tquic_time_cwnd.py for analyzing TQUIC debug logs and produce a time-cwnd figure
+
+### Fixed
+- Fix the typos detected by the latest typo-cli
+
+
 ## [v1.4.0] - 2024-10-28
 
 ### Added
@@ -165,7 +175,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Fix the issue where bbr3 cannot exit slow start due to high packet loss rate
 
 ### Security
-- Limit memory consuption for tracking closed stream ids
+- Limit memory consumption for tracking closed stream ids
 
 
 ## [v0.9.0] - 2024-04-10
@@ -339,6 +349,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Provide example clients and servers.
 
 
+[v1.5.0]: https://github.com/tencent/tquic/compare/v1.4.0...v1.5.0
 [v1.4.0]: https://github.com/tencent/tquic/compare/v1.3.1...v1.4.0
 [v1.3.1]: https://github.com/tencent/tquic/compare/v1.3.0...v1.3.1
 [v1.3.0]: https://github.com/tencent/tquic/compare/v1.2.0...v1.3.0

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "tquic"
-version = "1.4.0"
+version = "1.5.0"
 edition = "2021"
 rust-version = "1.70.0"
 license = "Apache-2.0"
@@ -27,17 +27,20 @@ include = [
 
 [package.metadata.docs.rs]
 no-default-features = true
-features = ["qlog"]
+features = ["qlog", "h3"]
 
 [features]
-default = ["qlog"]
+default = ["qlog", "h3"]
 
 # build the FFI API
 ffi = []
 
 # enable support for the qlog
 qlog = ["dep:serde", "dep:serde_json", "dep:serde_derive", "dep:serde_with"]
 
+# enable support for h3
+h3 = ["dep:sfv"]
+
 [dependencies]
 bytes = "1"
 rustc-hash = "1.1"
@@ -58,7 +61,7 @@ serde_derive = { version = "1.0", optional=true }
 serde_with = { version="3.0.0", optional=true }
 hex = "0.4"
 priority-queue = "1.3.2"
-sfv = { version = "0.9" }
+sfv = { version = "0.9", optional=true }
 
 [target."cfg(windows)".dependencies]
 winapi = { version = "0.3", features = ["wincrypt", "ws2def", "ws2ipdef", "ws2tcpip"] }

include/tquic.h

@@ -1223,7 +1223,7 @@ ssize_t quic_stream_write(struct quic_conn_t *conn,
  * Create a new quic stream with the given id and priority.
  * This is a low-level API for stream creation. It is recommended to use
  * `quic_stream_bidi_new` for bidirectional streams or `quic_stream_uni_new`
- * for unidrectional streams.
+ * for undirectional streams.
  */
 int quic_stream_new(struct quic_conn_t *conn,
                     uint64_t stream_id,

src/connection/connection.rs

@@ -2032,7 +2032,7 @@ impl Connection {
         Ok(())
     }
 
-    /// Write PATH_RESPONSE/PATH_CHALLENGE frams if needed.
+    /// Write PATH_RESPONSE/PATH_CHALLENGE frames if needed.
     fn try_write_path_validation_frames(
         &mut self,
         out: &mut [u8],
@@ -3885,7 +3885,7 @@ impl Connection {
     /// Create a new stream with given stream id and priority.
     /// This is a low-level API for stream creation. It is recommended to use
     /// `stream_bidi_new` for bidirectional streams or `stream_uni_new` for
-    /// unidrectional streams.
+    /// undirectional streams.
     pub fn stream_new(&mut self, stream_id: u64, urgency: u8, incremental: bool) -> Result<()> {
         self.stream_set_priority(stream_id, urgency, incremental)
     }
@@ -3897,7 +3897,7 @@ impl Connection {
         self.streams.stream_bidi_new(urgency, incremental)
     }
 
-    /// Create a new unidrectional stream with given stream priority.
+    /// Create a new undirectional stream with given stream priority.
     /// Return id of the created stream upon success.
     pub fn stream_uni_new(&mut self, urgency: u8, incremental: bool) -> Result<u64> {
         self.mark_tickable(true);

src/connection/stream.rs

@@ -214,7 +214,7 @@ impl StreamMap {
         }
     }
 
-    /// Create a new unidrectional stream with given stream priority.
+    /// Create a new undirectional stream with given stream priority.
     /// Return id of the created stream upon success.
     pub fn stream_uni_new(&mut self, urgency: u8, incremental: bool) -> Result<u64> {
         let stream_id = self.next_stream_id_uni;

src/endpoint.rs

@@ -97,7 +97,7 @@ pub struct Endpoint {
     /// The endpoint is shutdown.
     closed: bool,
 
-    /// The unique trace id for the enpdoint
+    /// The unique trace id for the endpoint
     trace_id: String,
 }