Request execution failure reason and redirects (#516)

* Introduces RequestExecutionErrorReason

* Optionally track redirects in RequestExecutionError

Author: oguzkocer

wp_api/src/api_error.rs

@@ -15,13 +15,15 @@ pub enum WpApiError {
     #[error("Status code ({}) is not valid", status_code)]
     InvalidHttpStatusCode { status_code: u16 },
     #[error(
-        "Request execution failed!\nStatus Code: '{:?}'.\nResponse: '{}'",
+        "Request execution failed!\nStatus Code: '{:?}'\nRedirects: '{:#?}'\nReason: '{:#?}'",
         status_code,
+        redirects,
         reason
     )]
     RequestExecutionFailed {
         status_code: Option<u16>,
-        reason: String,
+        redirects: Option<Vec<String>>,
+        reason: RequestExecutionErrorReason,
     },
     #[error("Media file not found at file path: {}", file_path)]
     MediaFileNotFound { file_path: String },
@@ -419,26 +421,42 @@ pub enum WpErrorCode {
 #[derive(Debug, Clone, PartialEq, Eq, thiserror::Error, uniffi::Error)]
 pub enum RequestExecutionError {
     #[error(
-        "Request execution failed!\nStatus Code: '{:?}'.\nResponse: '{}'",
+        "Request execution failed!\nStatus Code: '{:?}'\nRedirects: '{:#?}'\nReason: '{:#?}'",
         status_code,
+        redirects,
         reason
     )]
     RequestExecutionFailed {
         status_code: Option<u16>,
-        reason: String,
+        redirects: Option<Vec<String>>,
+        reason: RequestExecutionErrorReason,
+    },
+}
+
+#[derive(Debug, Clone, PartialEq, Eq, uniffi::Enum)]
+pub enum RequestExecutionErrorReason {
+    SslError {
+        domain: String,
+        trust_chain: Option<Vec<String>>,
+        error_message: String,
+    },
+    GenericError {
+        error_message: String,
     },
 }
 
 #[derive(Debug, Clone, PartialEq, Eq, thiserror::Error, uniffi::Error)]
 pub enum MediaUploadRequestExecutionError {
     #[error(
-        "Request execution failed!\nStatus Code: '{:?}'.\nResponse: '{}'",
+        "Request execution failed!\nStatus Code: '{:?}'\nRedirects: '{:#?}'\nReason: '{:#?}'",
         status_code,
+        redirects,
         reason
     )]
     RequestExecutionFailed {
         status_code: Option<u16>,
-        reason: String,
+        redirects: Option<Vec<String>>,
+        reason: RequestExecutionErrorReason,
     },
     #[error("Media file not found at file path: {}", file_path)]
     MediaFileNotFound { file_path: String },
@@ -449,9 +467,11 @@ impl From<RequestExecutionError> for WpApiError {
         match value {
             RequestExecutionError::RequestExecutionFailed {
                 status_code,
+                redirects,
                 reason,
             } => Self::RequestExecutionFailed {
                 status_code,
+                redirects,
                 reason,
             },
         }
@@ -463,9 +483,11 @@ impl From<MediaUploadRequestExecutionError> for WpApiError {
         match value {
             MediaUploadRequestExecutionError::RequestExecutionFailed {
                 status_code,
+                redirects,
                 reason,
             } => Self::RequestExecutionFailed {
                 status_code,
+                redirects,
                 reason,
             },
             MediaUploadRequestExecutionError::MediaFileNotFound { file_path } => {

wp_api/src/lib.rs

@@ -2,8 +2,8 @@
 
 pub use api_client::{WpApiClient, WpApiRequestBuilder};
 pub use api_error::{
-    MediaUploadRequestExecutionError, ParsedRequestError, RequestExecutionError, WpApiError,
-    WpError, WpErrorCode,
+    MediaUploadRequestExecutionError, ParsedRequestError, RequestExecutionError,
+    RequestExecutionErrorReason, WpApiError, WpError, WpErrorCode,
 };
 pub use parsed_url::{ParseUrlError, ParsedUrl};
 use plugins::*;

wp_api/src/wordpress_org/client.rs

@@ -1,4 +1,5 @@
 use crate::{
+    api_error::RequestExecutionErrorReason,
     request::{endpoint::WpEndpointUrl, RequestExecutor, WpNetworkRequest, WpNetworkResponse},
     wordpress_org::update_check::UpdateCheckRequest,
     ParsedUrl, PluginWithViewContext, PluginWpOrgDirectorySlug, RequestExecutionError,
@@ -167,13 +168,15 @@ pub enum WordPressOrgApiClientError {
     #[error("Failed to encode request. Reason: {}", reason)]
     RequestEncodingError { reason: String },
     #[error(
-        "Request execution failed!\nStatus Code: '{:?}'.\nResponse: '{}'",
+        "Request execution failed!\nStatus Code: '{:?}'\nRedirects: '{:#?}'\nReason: '{:#?}'",
         status_code,
+        redirects,
         reason
     )]
     RequestExecutionFailed {
         status_code: Option<u16>,
-        reason: String,
+        redirects: Option<Vec<String>>,
+        reason: RequestExecutionErrorReason,
     },
     #[error("Error while parsing. \nReason: {}\nResponse: {}", reason, response)]
     ResponseParsingError { reason: String, response: String },
@@ -190,9 +193,11 @@ impl From<RequestExecutionError> for WordPressOrgApiClientError {
         match e {
             RequestExecutionError::RequestExecutionFailed {
                 status_code,
+                redirects,
                 reason,
             } => WordPressOrgApiClientError::RequestExecutionFailed {
                 status_code,
+                redirects,
                 reason,
             },
         }

wp_api_integration_tests/src/lib.rs

@@ -13,8 +13,8 @@ use wp_api::{
     },
     tags::TagId,
     users::UserId,
-    MediaUploadRequestExecutionError, ParsedUrl, RequestExecutionError, WpApiClient, WpApiError,
-    WpAuthentication, WpErrorCode,
+    MediaUploadRequestExecutionError, ParsedUrl, RequestExecutionError,
+    RequestExecutionErrorReason, WpApiClient, WpApiError, WpAuthentication, WpErrorCode,
 };
 
 // A `TestCredentials::instance()` function will be generated by this
@@ -154,7 +154,10 @@ pub struct AsyncWpNetworking {
 impl Default for AsyncWpNetworking {
     fn default() -> Self {
         Self {
-            client: reqwest::Client::new(),
+            client: reqwest::Client::builder()
+                .danger_accept_invalid_certs(true)
+                .build()
+                .expect("We should be able to build the reqwest client with this configuration"),
         }
     }
 }
@@ -242,7 +245,10 @@ impl RequestExecutor for AsyncWpNetworking {
         self.async_request(request).await.map_err(|err| {
             RequestExecutionError::RequestExecutionFailed {
                 status_code: err.status().map(|s| s.as_u16()),
-                reason: err.to_string(),
+                redirects: None,
+                reason: RequestExecutionErrorReason::GenericError {
+                    error_message: err.to_string(),
+                },
             }
         })
     }
@@ -256,7 +262,10 @@ impl RequestExecutor for AsyncWpNetworking {
             .map_err(
                 |err| MediaUploadRequestExecutionError::RequestExecutionFailed {
                     status_code: err.status().map(|s| s.as_u16()),
-                    reason: err.to_string(),
+                    redirects: None,
+                    reason: RequestExecutionErrorReason::GenericError {
+                        error_message: err.to_string(),
+                    },
                 },
             )
     }

wp_api_integration_tests/tests/test_login_err.rs

@@ -25,3 +25,23 @@ async fn test_login_flow_err_parse_api_details(#[case] site_url: &str) {
         original_attempt_error
     );
 }
+
+#[rstest]
+#[case("http://jalib923knblakis9ba92q3nbaslkes.nope")]
+#[tokio::test]
+#[parallel]
+async fn test_login_flow_err_network_error(#[case] site_url: &str) {
+    let client = WpLoginClient::new(Arc::new(AsyncWpNetworking::default()));
+    let mut result = client.api_discovery(site_url.to_string()).await;
+    let original_attempt_error = result
+        .attempts
+        .remove(&AutoDiscoveryAttemptType::UserInput)
+        .unwrap()
+        .result
+        .unwrap_err();
+    assert!(
+        original_attempt_error.is_network_error(),
+        "{:#?}",
+        original_attempt_error
+    );
+}

wp_api_integration_tests/tests/test_login_immut.rs

@@ -50,6 +50,10 @@ const VANILLA_WP_SITE_URL: &str = "https://vanilla.wpmt.co/wp-admin/authorize-ap
     "https://jetpack.wpmt.co",
     "https://jetpack.wpmt.co/wp-admin/authorize-application.php"
 )]
+#[case(
+    "http://wordpress-1315525-4803651.cloudwaysapps.com",
+    "https://vanilla.wpmt.co/wp-admin/authorize-application.php"
+)]
 #[tokio::test]
 #[parallel]
 async fn test_login_flow(#[case] site_url: &str, #[case] expected_auth_url: &str) {

wp_api_integration_tests/tests/test_media_err.rs

@@ -11,8 +11,8 @@ use wp_api::{
         WpNetworkRequest, WpNetworkResponse,
     },
     users::UserId,
-    MediaUploadRequestExecutionError, RequestExecutionError, WpApiClient, WpAuthentication,
-    WpErrorCode,
+    MediaUploadRequestExecutionError, RequestExecutionError, RequestExecutionErrorReason,
+    WpApiClient, WpAuthentication, WpErrorCode,
 };
 use wp_api_integration_tests::{
     api_client, api_client_as_author, api_client_as_subscriber, test_site_url, AssertWpError,
@@ -208,7 +208,10 @@ impl RequestExecutor for MediaErrNetworking {
     ) -> Result<WpNetworkResponse, RequestExecutionError> {
         Err(RequestExecutionError::RequestExecutionFailed {
             status_code: None,
-            reason: "Execute function is not necessary for these tests".to_string(),
+            redirects: None,
+            reason: RequestExecutionErrorReason::GenericError {
+                error_message: "Execute function is not necessary for these tests".to_string(),
+            },
         })
     }
 
@@ -242,7 +245,10 @@ impl RequestExecutor for MediaErrNetworking {
         let mut response = request.send().await.map_err(|err| {
             MediaUploadRequestExecutionError::RequestExecutionFailed {
                 status_code: err.status().map(|s| s.as_u16()),
-                reason: err.to_string(),
+                redirects: None,
+                reason: RequestExecutionErrorReason::GenericError {
+                    error_message: err.to_string(),
+                },
             }
         })?;