Feature/improve logs and add verbose (#11)

os-esh · web-flow · commit 5567d2e61e89 · 2023-08-29T20:38:16.000+03:00
* update transport logging:
add verbose params
don't log error for exists methods
move ignore to opts var

* update version

* fix review comments
diff --git a/Project.toml b/Project.toml
@@ -1,25 +1,26 @@
 name = "ElasticsearchClient"
 uuid = "e586a49d-aa29-4ce5-8f91-fa4f824367bd"
 authors = ["Egor Shmorgun <egor.shmorgun@opensesame.com>"]
-version = "0.2.8"
+version = "0.2.9"
 
 [deps]
 CodecZlib = "944b1d66-785c-5afd-91f1-9de20f533193"
 Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
 HTTP = "cd3eb016-35fb-5094-929b-558a96fad6f3"
 JSON = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
+Logging = "56ddb016-857b-54e1-b83d-db4d58db5568"
 Mocking = "78c3b35d-d492-501b-9361-3d52fe80e533"
 Retry = "20febd7b-183b-5ae2-ac4a-720e7ce64774"
 URIs = "5c2747f8-b7ea-4ff2-ba2e-563bfd36b1d4"
 
 [compat]
-julia = "1"
 CodecZlib = "0.7"
 HTTP = "1"
 JSON = "0.21"
 Mocking = "0.7"
 Retry = "0.4"
 URIs = "1"
+julia = "1"
 
 [extras]
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
diff --git a/src/api/actions/bulk.jl b/src/api/actions/bulk.jl
@@ -27,6 +27,7 @@ function bulk(client::Client; body, index=nothing, headers=Dict(), auth_params=n
   else
     "/_bulk"
   end
+  options = extract_options(arguments)
   params = process_params(arguments)
 
   payload = if body isa Vector
@@ -36,6 +37,6 @@ function bulk(client::Client; body, index=nothing, headers=Dict(), auth_params=n
   end
 
   Response(
-    @mock perform_request(client, method, path; params=params, auth_params=auth_params, headers=headers, body=payload)
+    @mock perform_request(client, method, path; params=params, auth_params=auth_params, headers=headers, body=payload, opts=options)
   )
-end
+end
diff --git a/src/api/actions/cat/Cat.jl b/src/api/actions/cat/Cat.jl
@@ -1,7 +1,7 @@
 module Cat
 
 using ..API: HTTP_GET
-using ..API: _listify, process_params
+using ..API: _listify, process_params, extract_options
 using ..API: Response
 using ..ElasticTransport
 
diff --git a/src/api/actions/cat/indices.jl b/src/api/actions/cat/indices.jl
@@ -31,9 +31,10 @@ function indices(client::Client; index=nothing, headers=Dict(), auth_params=noth
     "/_cat/indices"
   end
 
+  options = extract_options(arguments)
   params = process_params(arguments)
 
   Response(
-    @mock perform_request(client, method, path; params=params, auth_params=auth_params, headers=headers, body=nothing)
+    @mock perform_request(client, method, path; params=params, auth_params=auth_params, headers=headers, body=nothing, opts=options)
   )
 end
diff --git a/src/api/actions/delete.jl b/src/api/actions/delete.jl
@@ -23,9 +23,11 @@ function delete(client::Client; index, id, headers=Dict(), auth_params=nothing,
   method = HTTP_DELETE
 
   path = "/$(_listify(index))/_doc/$(_listify(id))"
+
+  options = extract_options(arguments)
   params = process_params(arguments)
 
   Response(
-    @mock perform_request(client, method, path; params=params, auth_params=auth_params, headers=headers, body=nothing)
+    @mock perform_request(client, method, path; params=params, auth_params=auth_params, headers=headers, body=nothing, opts=options)
   )
 end
diff --git a/src/api/actions/delete_by_query.jl b/src/api/actions/delete_by_query.jl
@@ -44,9 +44,10 @@ function delete_by_query(client::Client; body, index, headers=Dict(), auth_param
   method = HTTP_POST
 
   path = "/$(_listify(index))/_delete_by_query"
+  options = extract_options(arguments)
   params = process_params(arguments)
 
   Response(
-    @mock perform_request(client, method, path; params=params, auth_params=auth_params, headers=headers, body=body)
+    @mock perform_request(client, method, path; params=params, auth_params=auth_params, headers=headers, body=body, opts=options)
   )
-end
+end
diff --git a/src/api/actions/index.jl b/src/api/actions/index.jl
@@ -31,9 +31,11 @@ function index(client::Client; body, index, id=nothing, headers=Dict(), auth_par
   else
     "/$(_listify(index))/_doc"
   end
+
+  options = extract_options(arguments)
   params = process_params(arguments)
 
   Response(
-    @mock perform_request(client, method, path; params=params, auth_params=auth_params, headers=headers, body=body)
+    @mock perform_request(client, method, path; params=params, auth_params=auth_params, headers=headers, body=body, opts=options)
   )
 end
diff --git a/src/api/actions/indices/Indices.jl b/src/api/actions/indices/Indices.jl
@@ -1,7 +1,7 @@
 module Indices
 
 using ..API: HTTP_GET, HTTP_DELETE, HTTP_PUT, HTTP_HEAD, HTTP_POST
-using ..API: _listify, process_params
+using ..API: _listify, process_params, extract_options, set_ignore_on_not_found!
 using ..API: Response
 using ..ElasticTransport
 
diff --git a/src/api/actions/indices/create.jl b/src/api/actions/indices/create.jl
@@ -17,9 +17,10 @@ function create(client::Client; body=nothing, index, headers=Dict(), auth_params
 
   method = HTTP_PUT
   path = "/$(_listify(index))"
+  options = extract_options(arguments)
   params = process_params(arguments)
 
   Response(
-    @mock perform_request(client, method, path; params=params, auth_params=auth_params, headers=headers, body=body)
+    @mock perform_request(client, method, path; params=params, auth_params=auth_params, headers=headers, body=body, opts=options)
   )
-end
+end
diff --git a/src/api/actions/indices/delete.jl b/src/api/actions/indices/delete.jl
@@ -18,9 +18,10 @@ function delete(client::Client; index, headers=Dict(), auth_params=nothing, kwar
 
   method = HTTP_DELETE
   path = "/$(_listify(index))"
+  options = extract_options(arguments)
   params = process_params(arguments)
 
   Response(
-    @mock perform_request(client, method, path; params=params, auth_params=auth_params, headers=headers, body=nothing)
+    @mock perform_request(client, method, path; params=params, auth_params=auth_params, headers=headers, body=nothing, opts=options)
   )
 end
diff --git a/src/api/actions/indices/exists.jl b/src/api/actions/indices/exists.jl
@@ -22,18 +22,14 @@ function exists(client::Client; index=nothing, headers=Dict(), auth_params=nothi
 
   method = HTTP_HEAD
   path = "/$(_listify(index))"
+
+  options = extract_options(arguments)
+  set_ignore_on_not_found!(options)
   params = process_params(arguments)
 
-  try
-    response = Response(
-      @mock perform_request(client, method, path; params=params, auth_params=auth_params, headers=headers, body=nothing)
-    )
-    response.status == 200 ? true : false
-  catch exc
-    if exc isa ElasticTransport.ServerException && exc.status == 404
-      return false
-    else
-      throw(exc)
-    end
-  end
-end
+  response = Response(
+    @mock perform_request(client, method, path; params=params, auth_params=auth_params, headers=headers, body=nothing, opts=options)
+  )
+
+  response.status == 200
+end
diff --git a/src/api/actions/indices/exists_alias.jl b/src/api/actions/indices/exists_alias.jl
@@ -25,18 +25,13 @@ function exists_alias(client::Client; index=nothing, name, headers=Dict(), auth_
   else
     "/_alias/$(_listify(name))"
   end
+  options = extract_options(arguments)
+  set_ignore_on_not_found!(options)
   params = process_params(arguments)
 
-  try
-    response = Response(
-      @mock perform_request(client, method, path; params=params, auth_params=auth_params, headers=headers, body=nothing)
-    )
-    response.status == 200 ? true : false
-  catch exc
-    if exc isa ElasticTransport.ServerException && exc.status == 404
-      return false
-    else
-      throw(exc)
-    end
-  end
-end
+  response = Response(
+    @mock perform_request(client, method, path; params=params, auth_params=auth_params, headers=headers, body=nothing, opts=options)
+  )
+  
+  response.status == 200
+end
diff --git a/src/api/actions/indices/get.jl b/src/api/actions/indices/get.jl
@@ -21,9 +21,10 @@ function get(client::Client; index=nothing, headers=Dict(), auth_params=nothing,
 
   method = HTTP_GET
   path = "/$(_listify(index))"
+  options = extract_options(arguments)
   params = process_params(arguments)
 
   Response(
-    @mock perform_request(client, method, path; params=params, auth_params=auth_params, headers=headers, body=nothing)
+    @mock perform_request(client, method, path; params=params, auth_params=auth_params, headers=headers, body=nothing, opts=options)
   )
-end
+end
diff --git a/src/api/actions/indices/put_alias.jl b/src/api/actions/indices/put_alias.jl
@@ -17,9 +17,10 @@ function put_alias(client::Client; body=nothing, index, name, headers=Dict(), au
 
   method = HTTP_PUT
   path = "/$(_listify(index))/_aliases/$(_listify(name))"
+  options = extract_options(arguments)
   params = process_params(arguments)
 
   Response(
-    @mock perform_request(client, method, path; params=params, auth_params=auth_params, headers=headers, body=body)
+    @mock perform_request(client, method, path; params=params, auth_params=auth_params, headers=headers, body=body, opts=options)
   )
-end
+end
diff --git a/src/api/actions/indices/refresh.jl b/src/api/actions/indices/refresh.jl
@@ -20,9 +20,10 @@ function refresh(client::Client; index=nothing, headers=Dict(), auth_params=noth
   else
     "/_refresh"
   end
+  options = extract_options(arguments)
   params = process_params(arguments)
 
   Response(
-    @mock perform_request(client, method, path; params=params, auth_params=auth_params, headers=headers, body=nothing)
+    @mock perform_request(client, method, path; params=params, auth_params=auth_params, headers=headers, body=nothing, opts=options)
   )
-end
+end
diff --git a/src/api/actions/indices/update_aliases.jl b/src/api/actions/indices/update_aliases.jl
@@ -15,9 +15,10 @@ function update_aliases(client::Client; body, headers=Dict(), auth_params=nothin
 
   method = HTTP_POST
   path = "/_aliases"
+  options = extract_options(arguments)
   params = process_params(arguments)
 
   Response(
-    @mock perform_request(client, method, path; params=params, auth_params=auth_params, headers=headers, body=body)
+    @mock perform_request(client, method, path; params=params, auth_params=auth_params, headers=headers, body=body, opts=options)
   )
-end
+end
diff --git a/src/api/actions/put_script.jl b/src/api/actions/put_script.jl
@@ -22,9 +22,11 @@ function put_script(client::Client; body, id, context=nothing, headers=Dict(), a
   else
     "/_scripts/$(_listify(id))"
   end
+
+  options = extract_options(arguments)
   params = process_params(arguments)
 
   Response(
-    @mock perform_request(client, method, path; params=params, auth_params=auth_params, headers=headers, body=body)
+    @mock perform_request(client, method, path; params=params, auth_params=auth_params, headers=headers, body=body, opts=options)
   )
 end
diff --git a/src/api/actions/search.jl b/src/api/actions/search.jl
@@ -69,9 +69,10 @@ function search(client::Client; body=nothing, index=nothing, headers=Dict(), aut
     "/$(UNDERSCORE_SEARCH)"
   end
 
+  options = extract_options(arguments)
   params = process_params(arguments)
 
   Response(
-    @mock perform_request(client, method, path; params=params, auth_params=auth_params, headers=headers, body=body)
+    @mock perform_request(client, method, path; params=params, auth_params=auth_params, headers=headers, body=body, opts=options)
   )
 end
diff --git a/src/api/actions/search_template.jl b/src/api/actions/search_template.jl
@@ -33,9 +33,10 @@ function search_template(client::Client; body, index=nothing, headers=Dict(), au
     "/$(UNDERSCORE_SEARCH)/template"
   end
 
+  options = extract_options(arguments)
   params = process_params(arguments)
 
   Response(
-    @mock perform_request(client, method, path; params=params, auth_params=auth_params, headers=headers, body=body)
+    @mock perform_request(client, method, path; params=params, auth_params=auth_params, headers=headers, body=body, opts=options)
   )
 end
diff --git a/src/api/utils.jl b/src/api/utils.jl
@@ -56,3 +56,28 @@ function _bulkify(payload::Vector{String})
 
   join(payload, "\n")
 end
+
+function extract_options(arguments::AbstractDict)::AbstractDict
+  options = Dict{Symbol, Any}()
+
+  extract_option_if_exist!(options, arguments, :reload_on_failure)
+  extract_option_if_exist!(options, arguments, :delay_on_retry)
+  extract_option_if_exist!(options, arguments, :verbose)
+  extract_option_if_exist!(options, arguments, :ignore)
+
+  options
+end
+
+function extract_option_if_exist!(options::AbstractDict, arguments::AbstractDict, option_name::Symbol)
+  option_value = pop!(arguments, option_name, nothing)
+
+  if !isnothing(option_value)
+    options[option_name] = option_value
+  end
+end
+
+function set_ignore_on_not_found!(options::AbstractDict)
+  ignore = get!(() -> Integer[], options, :ignore)
+
+  push!(ignore, 404)
+end
diff --git a/src/elastic_transport/client.jl b/src/elastic_transport/client.jl
@@ -46,8 +46,8 @@ mutable struct Client
 end
 
 function Client(;http_client::Module=HTTP, kwargs...)
-  options = deepcopy(Dict{Symbol, Any}(kwargs))
-  arguments = options
+  arguments = Dict{Symbol, Any}(kwargs)
+  options = deepcopy(arguments)
 
   get!(options, :reload_connections, false)
   get!(options, :retry_on_failure, false)
@@ -56,6 +56,7 @@ function Client(;http_client::Module=HTTP, kwargs...)
   get!(options, :randomize_hosts, false)
   get!(() -> Dict(), options, :transport_options)
   get!(() -> Dict(), options, :http)
+  get!(options, :verbose, 0)
 
   host_keys = [:hosts, :host, :url, :urls]
   host_key_index = findfirst(key -> haskey(arguments, key), host_keys)
@@ -67,10 +68,10 @@ function Client(;http_client::Module=HTTP, kwargs...)
   hosts = extract_hosts(hosts_config, options)
 
   if haskey(arguments, :request_timeout)
-    arguments[:transport_options][:request] = Dict(:timeout => arguments[:request_timeout])
+    options[:transport_options][:request] = Dict(:timeout => arguments[:request_timeout])
   end
 
-  transport = Transport(; hosts=hosts, options=arguments, http_client=http_client)
+  transport = Transport(; hosts=hosts, options=options, http_client=http_client)
 
   Client(
     arguments,
@@ -134,7 +135,8 @@ function perform_request(
   params=Dict(),
   auth_params=nothing,
   body::Union{Nothing,Dict,NamedTuple,String}=nothing,
-  headers::Union{Nothing,Dict}=nothing
+  headers::Union{Nothing,Dict}=nothing,
+  opts::AbstractDict=Dict()
 )
   if method == "GET" && !isnothing(body)
     method = client.send_get_body_as
@@ -151,7 +153,8 @@ function perform_request(
     params=params,
     auth_params=auth_params,
     body=body,
-    headers=headers
+    headers=headers,
+    opts=opts
   )
 end
 
diff --git a/src/elastic_transport/transport/transport.jl b/src/elastic_transport/transport/transport.jl
diff --git a/test/api_test/indices/exists_alias_test.jl b/test/api_test/indices/exists_alias_test.jl
diff --git a/test/api_test/indices/exists_test.jl b/test/api_test/indices/exists_test.jl
diff --git a/test/elastic_transport_test/transport_test.jl b/test/elastic_transport_test/transport_test.jl
