more debug options (#23)

Added an option to enable detailed verbose logging of OpenAPI request and response

Author: tanmaykm

Project.toml

@@ -4,7 +4,7 @@ keywords = ["Swagger", "OpenAPI", "REST"]
 license = "MIT"
 desc = "OpenAPI server and client helper for Julia"
 authors = ["Tanmay Mohapatra <[email protected]>", "JuliaHub"]
-version = "0.1.7"
+version = "0.1.8"
 
 [deps]
 Base64 = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"

README.md

@@ -153,6 +153,7 @@ Client(root::String;
     timeout::Int=DEFAULT_TIMEOUT_SECS,
     long_polling_timeout::Int=DEFAULT_LONGPOLL_TIMEOUT_SECS,
     pre_request_hook::Function,
+    verbose::Union{Bool,Function}=false,
 )
 ```
 
@@ -164,11 +165,18 @@ Where:
 - `timeout`: optional timeout to apply for server methods (default `OpenAPI.Clients.DEFAULT_TIMEOUT_SECS`)
 - `long_polling_timeout`: optional timeout to apply for long polling methods (default `OpenAPI.Clients.DEFAULT_LONGPOLL_TIMEOUT_SECS`)
 - `pre_request_hook`: user provided hook to modify the request before it is sent
+- `verbose`: whether to enable verbose logging
 
 The `pre_request_hook` must provide the following two implementations:
 - `pre_request_hook(ctx::OpenAPI.Clients.Ctx) -> ctx`
 - `pre_request_hook(resource_path::AbstractString, body::Any, headers::Dict{String,String}) -> (resource_path, body, headers)`
 
+The `verbose` option can be one of:
+- `false`: the default, no verbose logging
+- `true`: enables curl verbose logging to stderr
+- a function that accepts two arguments - type and message (available on Julia version >= 1.7)
+    - a default implementation of this that uses `@info` to log the arguments is provided as `OpenAPI.Clients.default_debug_hook`
+
 In case of any errors an instance of `ApiException` is thrown. It has the following fields:
 
 - `status::Int`: HTTP status code

src/client.jl

@@ -86,6 +86,11 @@ function get_api_return_type(return_types::Dict{Regex,Type}, response_code::Inte
     # - otherwise we make it throw an ApiException
     return (200 <= response_code <=206) ? Nothing : nothing # first(return_types)[2]
 end
+
+function default_debug_hook(type, message)
+    @info("OpenAPI HTTP transport", type, message)
+end
+
 struct Client
     root::String
     headers::Dict{String,String}
@@ -102,9 +107,14 @@ struct Client
             long_polling_timeout::Int=DEFAULT_LONGPOLL_TIMEOUT_SECS,
             timeout::Int=DEFAULT_TIMEOUT_SECS,
             pre_request_hook::Function=noop_pre_request_hook,
-            verbose::Bool=false,
+            verbose::Union{Bool,Function}=false,
         )
-        clntoptions = Dict{Symbol,Any}(:throw=>false, :verbose=>verbose)
+        clntoptions = Dict{Symbol,Any}(:throw=>false)
+        if isa(verbose, Bool)
+            clntoptions[:verbose] = verbose
+        elseif isa(verbose, Function)
+            clntoptions[:debug] = verbose
+        end
         downloader = Downloads.Downloader()
         downloader.easy_hook = (easy, opts) -> begin
             Downloads.Curl.setopt(easy, LibCURL.CURLOPT_LOW_SPEED_TIME, long_polling_timeout)

test/client/allany/petstore_test_petapi.jl

@@ -3,6 +3,7 @@ module AllAnyTests
 include(joinpath(@__DIR__, "AllAnyClient", "src", "AllAnyClient.jl"))
 using .AllAnyClient
 using Test
+using JSON
 using OpenAPI
 using OpenAPI.Clients
 import OpenAPI.Clients: Client
@@ -50,4 +51,75 @@ function runtests()
         @test pet_equals(api_return, pet)
     end
 end
+
+function test_debug()
+    @testset "stderr verbose mode" begin
+        @info("stderr verbose mode")
+        client = Client(server; verbose=true)
+        api = M.DefaultApi(client)
+    
+        pipe = Pipe()
+        redirect_stderr(pipe) do
+            pet = M.AnyOfMappedPets(mapped_cat)
+            api_return, http_resp = echo_anyof_mapped_pets_post(api, pet)
+            @test pet_equals(api_return, pet)
+        end
+        out_str = String(readavailable(pipe))
+        @test occursin("HTTP/1.1 200 OK", out_str)
+    end
+    @testset "debug log verbose mode" begin
+        @info("debug log verbose mode")
+        client = Client(server; verbose=OpenAPI.Clients.default_debug_hook)
+        api = M.DefaultApi(client)
+    
+        pipe = Pipe()
+        redirect_stderr(pipe) do
+            pet = M.AnyOfMappedPets(mapped_cat)
+            api_return, http_resp = echo_anyof_mapped_pets_post(api, pet)
+            @test pet_equals(api_return, pet)
+        end
+        out_str = String(readavailable(pipe))
+        @test occursin("HTTP/1.1 200 OK", out_str)
+    end
+    @testset "custom verbose function" begin
+        @info("custom verbose function")
+        messages = Any[]
+        client = Client(server; verbose=(type,message)->push!(messages, (type,message)))
+        api = M.DefaultApi(client)
+    
+        pet = M.AnyOfMappedPets(mapped_cat)
+        api_return, http_resp = echo_anyof_mapped_pets_post(api, pet)
+        @test pet_equals(api_return, pet)
+
+        data_out = filter(messages) do elem
+            elem[1] == "DATA OUT"
+        end
+        @test !isempty(data_out)
+        iob = IOBuffer()
+        for (type, message) in data_out
+            write(iob, message)
+        end
+        data_out_str = String(take!(iob))
+        data_out_json = JSON.parse(data_out_str)
+        @test data_out_json["pet_type"] == "cat"
+        @test data_out_json["hunts"] == true
+        @test data_out_json["age"] == 5
+
+        data_in = filter(messages) do elem
+            elem[1] == "DATA IN"
+        end
+        @test !isempty(data_in)
+        iob = IOBuffer()
+        for (type, message) in data_in
+            write(iob, message)
+        end
+        data_in_str = String(take!(iob))
+        data_in_str = strip(split(data_in_str, "\n")[2])
+        data_in_json = JSON.parse(data_in_str)
+        @test data_in_json["pet_type"] == "cat"
+        @test data_in_json["hunts"] == true
+        @test data_in_json["age"] == 5
+    end
+end
+
 end # module AllAnyTests

test/client/allany/runtests.jl

@@ -59,4 +59,23 @@ include("client/allany/runtests.jl")
             run_tests_with_servers && stop_server(8081, ret, out)
         end
     end
+    run_tests_with_servers && sleep(20) # avoid port conflicts
+    @testset "Debug and Verbose" begin
+        ret = out = nothing
+        servers_running = true
+
+        try
+            if run_tests_with_servers
+                ret, out = run_server(joinpath(@__DIR__, "server", "allany", "allany_server.jl"))
+                servers_running &= wait_server(8081)
+                if VERSION >= v"1.7"
+                    AllAnyTests.test_debug()
+                end
+            else
+                servers_running = false
+            end
+        finally
+            run_tests_with_servers && stop_server(8081, ret, out)
+        end
+    end
 end