Test Coverage: Deadlines (#62)

- Add comments about closing response channel on exception in Curl.jl
- Remove unreachable exception case in Streaming.jl for response streaming
- Add test coverage for deadlines

Author: csvance

src/Curl.jl

@@ -42,6 +42,7 @@ function write_callback(
                 GRPC_INTERNAL,
                 "Recieved $(n) bytes from curl but only handled $(handled_n_bytes_total)",
             )
+            # If we are response streaming unblock the task waiting on response_c
             !isnothing(req.response_c) && close(req.response_c)
             return typemax(Csize_t)
         end
@@ -129,7 +130,25 @@ function header_callback(
     end
 end
 
-
+function grpc_timeout_header_val(timeout::Real)
+    if round(Int, timeout) == timeout
+        timeout_secs = round(Int64, timeout)
+        return "$(timeout_secs)S"
+    end
+    timeout *= 1000
+    if round(Int, timeout) == timeout
+        timeout_millisecs = round(Int64, timeout)
+        return "$(timeout_millisecs)m"
+    end
+    timeout *= 1000
+    if round(Int, timeout) == timeout
+        timeout_microsecs = round(Int64, timeout)
+        return "$(timeout_microsecs)u"
+    end
+    timeout *= 1000
+    timeout_nanosecs = round(Int64, timeout)
+    return "$(timeout_nanosecs)n"
+end
 
 mutable struct gRPCRequest
     # CURL multi lock for exclusive access to the easy handle after its added to the multi
@@ -221,26 +240,6 @@ mutable struct gRPCRequest
             curl_easy_setopt(easy_handle, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_2TLS)
         end
 
-        function grpc_timeout_header_val(timeout::Real)
-            if round(Int, timeout) == timeout
-                timeout_secs = round(Int64, timeout)
-                return "$(timeout_secs)S"
-            end
-            timeout *= 1000
-            if round(Int, timeout) == timeout
-                timeout_millisecs = round(Int64, timeout)
-                return "$(timeout_millisecs)m"
-            end
-            timeout *= 1000
-            if round(Int, timeout) == timeout
-                timeout_microsecs = round(Int64, timeout)
-                return "$(timeout_microsecs)u"
-            end
-            timeout *= 1000
-            timeout_nanosecs = round(Int64, timeout)
-            return "$(timeout_nanosecs)n"
-        end
-
         headers = C_NULL
         headers = curl_slist_append(headers, "User-Agent: $(USER_AGENT)")
         headers = curl_slist_append(headers, "Content-Type: application/grpc+proto")
@@ -352,6 +351,7 @@ function handle_write(req::gRPCRequest, buf::Vector{UInt8})::Tuple{Int64, Union{
                     GRPC_UNIMPLEMENTED,
                     "Response was compressed but compression is not currently supported.",
                 )
+                # If we are response streaming unblock the task waiting on response_c
                 !isnothing(req.response_c) && close(req.response_c)
                 notify(req.ready)
                 return n, nothing
@@ -360,6 +360,7 @@ function handle_write(req::gRPCRequest, buf::Vector{UInt8})::Tuple{Int64, Union{
                     GRPC_RESOURCE_EXHAUSTED,
                     "length-prefix longer than max_recieve_message_length: $(req.response_length) > $(req.max_recieve_message_length)",
                 )
+                # If we are response streaming unblock the task waiting on response_c
                 !isnothing(req.response_c) && close(req.response_c)
                 notify(req.ready)
                 return n, nothing

src/Streaming.jl

@@ -100,11 +100,6 @@ function grpc_async_stream_response(
     catch ex
         if isa(ex, InvalidStateException)
 
-        elseif isa(ex, gRPCServiceCallException)
-            if isnothing(req.ex)
-                req.ex = ex
-                notify(req.ready)
-            end
         else
             if isnothing(req.ex)
                 req.ex = ex

test/runtests.jl

@@ -1,8 +1,11 @@
-using Test 
-using ProtoBuf 
+using Test
+using ProtoBuf
 using gRPCClient
 using Base.Threads
 
+# Import the timeout header formatting function for testing
+import gRPCClient: grpc_timeout_header_val, GRPC_DEADLINE_EXCEEDED
+
 
 function _get_test_host()
     if "GRPC_TEST_SERVER_HOST" in keys(ENV)
@@ -345,5 +348,36 @@ include("gen/test/test_pb.jl")
     # end
     end
 
+    # @testset "Timeout Header Value Formatting" begin
+        # Test integer seconds
+        @test grpc_timeout_header_val(1) == "1S"
+
+        # Test milliseconds
+        @test grpc_timeout_header_val(0.001) == "1m"
+
+        # Test microseconds
+        @test grpc_timeout_header_val(0.000001) == "1u"
+
+        # Test nanoseconds
+        @test grpc_timeout_header_val(0.0000001) == "100n"
+
+    # end
+
+    # @testset "Deadline - Very short timeout" begin
+        # Test with an extremely short deadline that might timeout
+        # Note: This test is timing-sensitive and might be flaky
+        client = TestService_TestRPC_Client(_TEST_HOST, _TEST_PORT; deadline=0.000000001)
+
+        # Try to make a request - it might timeout depending on server response time
+        try
+            response = grpc_sync_request(client, TestRequest(1, zeros(UInt64, 1)))
+            @test false
+        catch ex
+            # If it times out, verify it's an exception (CURL timeout or gRPC error)
+            @test isa(ex, gRPCServiceCallException)
+            @test ex.grpc_status == GRPC_DEADLINE_EXCEEDED
+        end
+    # end
+
     grpc_shutdown()
 end