Improve http client error handling (#459)

* Improve http client error handling

Signed-off-by: Patrik Stas <patrik.stas@absa.africa>

* Fix agency error details propagation, refactor response mocking code

Signed-off-by: Patrik Stas <patrik.stas@absa.africa>

* Fix codecov hash in CI

Signed-off-by: Patrik Stas <patrik.stas@absa.africa>

Author: Patrik-Stas

.github/workflows/main.yml

@@ -111,7 +111,7 @@ jobs:
           POOL_DOCKERFILE_HASH=${{ hashFiles('ci/indy-pool.dockerfile')}}
 
           LIBVCX_HASH=${LIBVCX_SOURCE_HASH:0:11}-${ARIESVCX_SOURCE_HASH:0:11}-${LIBVCX_NODE_WRAPPERS_HASH:0:11}-${LIBVCX_NODE_AGENT_HASH:0:11}-${LIBVCX_DOCKERFILE_HASH:0:11}-${AGENCY_CLIENT_HASH:0:11}
-          CODECOV_HASH=${LIBVCX_SOURCE_HASH:0:23}-${ARIESVCX_SOURCE_HASH:0:11}-${CODECOV_DOCKERFILE_HASH:0:23}
+          CODECOV_HASH=${LIBVCX_SOURCE_HASH:0:23}-${ARIESVCX_SOURCE_HASH:0:11}-${AGENCY_CLIENT_HASH:0:11}-${CODECOV_DOCKERFILE_HASH:0:23}
           ANDROID_HASH=${LIBVCX_SOURCE_HASH:0:15}-${ARIESVCX_SOURCE_HASH:0:11}-${JAVA_WRAPPERS_HASH:0:15}
           POOL_HASH=${POOL_DOCKERFILE_HASH:0:15}
 

agency_client/src/httpclient.rs

@@ -1,15 +1,15 @@
 use std::env;
+use std::time::Duration;
 
+use async_std::sync::RwLock;
 use reqwest;
-use reqwest::header::CONTENT_TYPE;
 use reqwest::Client;
-use async_std::sync::RwLock;
-use std::time::Duration;
+use reqwest::header::CONTENT_TYPE;
 
+use crate::{AgencyMockDecrypted, mocking};
 use crate::error::{AgencyClientError, AgencyClientErrorKind, AgencyClientResult};
-use crate::mocking::{AgencyMock, AgencyMockDecrypted, HttpClientMockResponse};
+use crate::mocking::{AgencyMock, HttpClientMockResponse};
 use crate::utils::timeout::TimeoutUtils;
-use crate::mocking;
 
 lazy_static! {
     static ref HTTP_CLIENT: RwLock<Client> = RwLock::new(reqwest::ClientBuilder::new()
@@ -22,18 +22,17 @@ lazy_static! {
 }
 
 pub async fn post_message(body_content: &Vec<u8>, url: &str) -> AgencyClientResult<Vec<u8>> {
-    // todo: this function should be general, not knowing that agency exists -> move agency mocks to agency module
     if mocking::agency_mocks_enabled() {
         if HttpClientMockResponse::has_response() {
-            warn!("HttpClient has mocked response");
+            warn!("post_to_agency >> mocking response for POST {}", url);
             return HttpClientMockResponse::get_response();
         }
         if AgencyMockDecrypted::has_decrypted_mock_responses() {
-            warn!("Agency requests returns empty response, decrypted mock response is available");
+            warn!("post_to_agency >> will use mocked decrypted response for POST {}", url);
             return Ok(vec!());
         }
         let mocked_response = AgencyMock::get_response();
-        debug!("Agency returns mocked response of length {}", mocked_response.len());
+        warn!("post_to_agency >> mocking response of length {} for POST {}", mocked_response.len(), url);
         return Ok(mocked_response);
     }
 
@@ -44,7 +43,7 @@ pub async fn post_message(body_content: &Vec<u8>, url: &str) -> AgencyClientResu
     }
 
     let client = HTTP_CLIENT.read().await;
-    debug!("Posting encrypted bundle to: \"{}\"", url);
+    debug!("post_to_agency >> http client sending request POST {}", url);
 
     let response =
         client.post(url)
@@ -53,21 +52,22 @@ pub async fn post_message(body_content: &Vec<u8>, url: &str) -> AgencyClientResu
             .send()
             .await
             .map_err(|err| {
-                AgencyClientError::from_msg(AgencyClientErrorKind::PostMessageFailed, format!("Could not connect {:?}", err))
+                AgencyClientError::from_msg(AgencyClientErrorKind::PostMessageFailed, format!("HTTP Client could not connect with {}, err: {}", url, err.to_string()))
             })?;
 
-    if !response.status().is_success() {
-        match response.text().await {
-            Ok(content) => {
-                Err(AgencyClientError::from_msg(AgencyClientErrorKind::PostMessageFailed, format!("Agency responded with error. Details: {}", content)))
-            }
-            Err(_) => {
-                Err(AgencyClientError::from_msg(AgencyClientErrorKind::PostMessageFailed, format!("Agency response could not be read.")))
+    let content_length = response.content_length();
+    let response_status = response.status();
+    match response.text().await {
+        Ok(payload) => {
+            if response_status.is_success() {
+                Ok(payload.into_bytes())
+            } else {
+                Err(AgencyClientError::from_msg(AgencyClientErrorKind::PostMessageFailed, format!("POST {} failed due to non-success HTTP status: {}, response body: {}", url, response_status.to_string(), payload)))
             }
         }
-    } else {
-        Ok(response.text().await
-            .or(Err(AgencyClientError::from_msg(AgencyClientErrorKind::PostMessageFailed, "could not read response")))?.into())
+        Err(error) => {
+            Err(AgencyClientError::from_msg(AgencyClientErrorKind::PostMessageFailed, format!("POST {} failed because response could not be decoded as utf-8, HTTP status: {}, content-length header: {:?}, error: {:?}", url, response_status.to_string(), content_length, error)))
+        }
     }
 }
 

agency_client/src/utils/comm.rs

@@ -1,5 +1,4 @@
-use crate::{agency_settings, httpclient};
-use crate::error::AgencyClientResult;
+use crate::{agency_settings, AgencyClientResult, httpclient};
 
 pub async fn post_to_agency(body_content: &Vec<u8>) -> AgencyClientResult<Vec<u8>> {
     let endpoint = agency_settings::get_config_value(agency_settings::CONFIG_AGENCY_ENDPOINT)?;

aries_vcx/src/error.rs

@@ -5,7 +5,6 @@ use failure::{Backtrace, Context, Fail};
 
 use agency_client;
 
-use crate::utils;
 use crate::utils::error;
 
 pub mod prelude {
@@ -300,7 +299,7 @@ impl From<VcxErrorKind> for VcxError {
 impl From<agency_client::error::AgencyClientError> for VcxError {
     fn from(agency_err: agency_client::error::AgencyClientError) -> VcxError {
         let kind_num: u32 = agency_err.kind().into();
-        VcxError::from_msg(kind_num.into(), utils::error::error_message(&agency_err.kind().clone().into()))
+        VcxError::from_msg(kind_num.into(), agency_err.to_string())
     }
 }