tonic-rails 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6cc5ee93380e004201e88f63289b88dff01dd6cc6566c92a3d972b9c934150d
-  data.tar.gz: 20a5a45adb019fa7275330b2d5b9f256a9f259765e1ffc83f4f1278902b38620
+  metadata.gz: cd7973d8a7b1550f1f483912639ec1cbec562297c3368c8751c45780e8472ec1
+  data.tar.gz: 385c74ea7100d36e7c128df6f1feda64fb7ac7c3b11a3905afa35d5ac275af26
 SHA512:
-  metadata.gz: 452568660e7a6f19c16d77ff8d272691c0f54c7ebf67261e5199dab6ad59f6c1df89b4b8e0efab84748e089bd74f4e4c2bf4de7dd599e628de0fc11f6ce03922
-  data.tar.gz: 52d5199c4d503c0792d84d254442a87cc25fc962b9af87561129c08c95974c48424c1a8914bd0cfcf664331d5c2f892c6cd8f31e507309bacb8c32b3ecc2fb53
+  metadata.gz: d491ec733022fca2b343ca3bb738273945c62614619266a1bccc8e8823f9f377628a2e6b4fb9a4b9c367b623e4c523ace580e18e4094fd66b07f94b7b55a0b97
+  data.tar.gz: 58a0d85837cd8f68f063d934b029761ab4239d30b9e2807bed5638b798ac1b18d2efe3e88c20c255dbb5c18aa3a5fee79ba86a8056d785eced8690ce4a6d0c17

data/CHANGELOG.md

@@ -7,6 +7,16 @@ minor versions may contain breaking changes.
 
 ## [Unreleased]
 
+## [0.8.1] - 2026-10-13
+
+### Fixed
+
+- Client: a call whose deadline passed could raise `CANCELLED` ("Timeout
+  expired") instead of `DEADLINE_EXCEEDED` (#48), mostly on Windows.
+  tonic enforces the deadline too, and when its timer fired first the
+  call ended with its status. Calls now raise `DEADLINE_EXCEEDED`
+  whichever timer fires first.
+
 ## [0.8.0] - 2026-10-12
 
 ### Added
@@ -207,7 +217,8 @@ First public release.
 - Precompiled native gems for Linux (x86_64, aarch64; glibc and musl) and
   macOS (x86_64, arm64), Ruby 3.3 to 4.0.
 
-[Unreleased]: https://github.com/CodingAnarchy/tonic-rails/compare/v0.8.0...HEAD
+[Unreleased]: https://github.com/CodingAnarchy/tonic-rails/compare/v0.8.1...HEAD
+[0.8.1]: https://github.com/CodingAnarchy/tonic-rails/compare/v0.8.0...v0.8.1
 [0.8.0]: https://github.com/CodingAnarchy/tonic-rails/compare/v0.7.0...v0.8.0
 [0.7.0]: https://github.com/CodingAnarchy/tonic-rails/compare/v0.6.0...v0.7.0
 [0.6.0]: https://github.com/CodingAnarchy/tonic-rails/compare/v0.5.0...v0.6.0

data/Cargo.lock

@@ -1060,7 +1060,7 @@ dependencies = [
 
 [[package]]
 name = "tonic_rails_native"
-version = "0.8.0"
+version = "0.8.1"
 dependencies = [
  "axum",
  "base64",

data/ext/tonic_rails_native/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "tonic_rails_native"
-version = "0.8.0"
+version = "0.8.1"
 edition = "2024"
 rust-version = "1.88"
 publish = false

data/ext/tonic_rails_native/src/client.rs

@@ -30,7 +30,7 @@ use tokio::task::JoinHandle;
 use tonic::codec::{Codec, DecodeBuf, Decoder, EncodeBuf, Encoder, Streaming};
 use tonic::metadata::MetadataMap;
 use tonic::transport::{Certificate, Channel, ClientTlsConfig, Endpoint, Identity};
-use tonic::{Code, Request, Status};
+use tonic::{Code, Request, Status, TimeoutExpired};
 
 use crate::gvl::{Cancel, Wait, block_on, recv_blocking, without_gvl};
 use crate::sync::Mutex;
@@ -218,13 +218,22 @@ async fn with_timeout(call: impl Future<Output = Outcome>, timeout: Option<Durat
     let started = tokio::time::Instant::now();
     let outcome = tokio::time::timeout(timeout, call).await;
     match outcome {
-        // tonic's channel enforces the grpc-timeout header too, but ends
-        // the call with its own status.
-        Ok(outcome) if !(outcome.local && started.elapsed() >= timeout) => outcome,
+        Ok(outcome) if !(outcome.local && started.elapsed() >= timeout) && !timeout_expired(&outcome) => {
+            outcome
+        }
         _ => Outcome::error(Code::DeadlineExceeded, "deadline exceeded"),
     }
 }
 
+/// tonic's channel enforces the grpc-timeout header too, and when its timer
+/// fires before ours it ends the call with CANCELLED "Timeout expired", with
+/// no source to mark it local.  (A tonic server enforcing the same deadline
+/// sends that status too.)  Coarse timers, like Windows' 15 ms ticks, let
+/// it fire first even though ours started earlier (#48).
+fn timeout_expired(outcome: &Outcome) -> bool {
+    outcome.code == Code::Cancelled && outcome.message == TimeoutExpired(()).to_string()
+}
+
 /// What every call needs: the method, one request message and its metadata.
 struct CallArgs {
     channel: Channel,
@@ -663,3 +672,42 @@ fn append_causes(mut message: String, mut source: Option<&dyn std::error::Error>
     }
     message
 }
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    fn run(call: impl Future<Output = Outcome>, timeout: Option<Duration>) -> Outcome {
+        let runtime = Builder::new_current_thread().enable_time().build().unwrap();
+        runtime.block_on(with_timeout(call, timeout))
+    }
+
+    async fn status(status: Status) -> Outcome {
+        Outcome::status(status, None)
+    }
+
+    #[test]
+    fn tonics_timeout_is_a_deadline_however_early_it_fires() {
+        let outcome = run(
+            status(Status::cancelled("Timeout expired")),
+            Some(Duration::from_secs(60)),
+        );
+        assert_eq!(outcome.code, Code::DeadlineExceeded);
+    }
+
+    #[test]
+    fn other_cancellations_stay_cancelled() {
+        let outcome = run(
+            status(Status::cancelled("client went away")),
+            Some(Duration::from_secs(60)),
+        );
+        assert_eq!(outcome.code, Code::Cancelled);
+        assert_eq!(outcome.message, "client went away");
+    }
+
+    #[test]
+    fn our_timer_is_a_deadline() {
+        let outcome = run(std::future::pending(), Some(Duration::from_millis(10)));
+        assert_eq!(outcome.code, Code::DeadlineExceeded);
+    }
+}

data/lib/tonic/rails/version.rb

@@ -2,6 +2,6 @@
 
 module Tonic
   module Rails
-    VERSION = "0.8.0"
+    VERSION = "0.8.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tonic-rails
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Matt Tanous