Introduces NetworkRequestAccessor trait (#716)

* Introduces `HasNetworkRequestId` trait

* Repurpose HasNetworkRequestId to contain more HTTP request data

* Address missing use statements for the new NetworkRequestDescriptor

* Rename `NetworkRequestDescriptor` as `NetworkRequestAccessor`

---------

Co-authored-by: Tony Li <[email protected]>

Author: oguzkocer

wp_api/src/request.rs

@@ -173,11 +173,6 @@ pub struct WpNetworkRequest {
 
 #[uniffi::export]
 impl WpNetworkRequest {
-    /// Unique identifier for this request – used for external record-keeping
-    pub fn request_id(&self) -> String {
-        self.uuid.clone()
-    }
-
     /// Clones the request and increments the retry count
     pub fn clone_with_incremented_retry_count(&self) -> Self {
         Self {
@@ -195,18 +190,6 @@ impl WpNetworkRequest {
         self.retry_count
     }
 
-    pub fn method(&self) -> RequestMethod {
-        self.method.clone()
-    }
-
-    pub fn url(&self) -> WpEndpointUrl {
-        self.url.clone()
-    }
-
-    pub fn header_map(&self) -> Arc<WpNetworkHeaderMap> {
-        self.header_map.clone()
-    }
-
     pub fn body(&self) -> Option<Arc<WpNetworkRequestBody>> {
         self.body.clone()
     }
@@ -279,6 +262,34 @@ impl Debug for WpNetworkRequest {
     }
 }
 
+/// Unique identifier for this request – used for external record-keeping
+#[uniffi::export(with_foreign)]
+pub trait NetworkRequestAccessor: Send + Sync {
+    fn request_id(&self) -> String;
+    fn method(&self) -> RequestMethod;
+    fn url(&self) -> WpEndpointUrl;
+    fn header_map(&self) -> Arc<WpNetworkHeaderMap>;
+}
+
+#[uniffi::export]
+impl NetworkRequestAccessor for WpNetworkRequest {
+    fn request_id(&self) -> String {
+        self.uuid.clone()
+    }
+
+    fn method(&self) -> RequestMethod {
+        self.method.clone()
+    }
+
+    fn url(&self) -> WpEndpointUrl {
+        self.url.clone()
+    }
+
+    fn header_map(&self) -> Arc<WpNetworkHeaderMap> {
+        self.header_map.clone()
+    }
+}
+
 // Has custom `Debug` trait implementation
 #[derive(uniffi::Record)]
 pub struct WpNetworkResponse {

wp_api/src/request/endpoint/media_endpoint.rs

@@ -9,11 +9,12 @@ use crate::{
         SparseMediaFieldWithViewContext,
     },
     request::{
-        CONTENT_TYPE_MULTIPART, ParsedResponse, RequestMethod, WpNetworkHeaderMap,
-        WpNetworkResponse,
+        CONTENT_TYPE_MULTIPART, NetworkRequestAccessor, ParsedResponse, RequestMethod,
+        WpNetworkHeaderMap, WpNetworkResponse,
     },
 };
 use http::HeaderValue;
+use uuid::Uuid;
 use wp_derive_request_builder::WpDerivedRequest;
 
 #[derive(WpDerivedRequest)]
@@ -119,6 +120,7 @@ fn parse_as_media_request_create_response(
 
 #[derive(uniffi::Object)]
 pub struct MediaUploadRequest {
+    pub(crate) uuid: String,
     pub(crate) method: RequestMethod,
     pub(crate) url: WpEndpointUrl,
     pub(crate) header_map: Arc<WpNetworkHeaderMap>,
@@ -129,18 +131,6 @@ pub struct MediaUploadRequest {
 
 #[uniffi::export]
 impl MediaUploadRequest {
-    pub fn method(&self) -> RequestMethod {
-        self.method.clone()
-    }
-
-    pub fn url(&self) -> WpEndpointUrl {
-        self.url.clone()
-    }
-
-    pub fn header_map(&self) -> Arc<WpNetworkHeaderMap> {
-        self.header_map.clone()
-    }
-
     pub fn file_path(&self) -> String {
         self.file_path.clone()
     }
@@ -179,6 +169,25 @@ impl std::fmt::Debug for MediaUploadRequest {
     }
 }
 
+#[uniffi::export]
+impl NetworkRequestAccessor for MediaUploadRequest {
+    fn request_id(&self) -> String {
+        self.uuid.clone()
+    }
+
+    fn method(&self) -> RequestMethod {
+        self.method.clone()
+    }
+
+    fn url(&self) -> WpEndpointUrl {
+        self.url.clone()
+    }
+
+    fn header_map(&self) -> Arc<WpNetworkHeaderMap> {
+        self.header_map.clone()
+    }
+}
+
 #[uniffi::export]
 impl MediaRequestBuilder {
     pub fn create(
@@ -193,6 +202,7 @@ impl MediaRequestBuilder {
             HeaderValue::from_static(CONTENT_TYPE_MULTIPART),
         );
         MediaUploadRequest {
+            uuid: Uuid::new_v4().into(),
             method: RequestMethod::POST,
             url: self.endpoint.create().into(),
             header_map: header_map.into(),

wp_api/src/reqwest_request_executor.rs

@@ -2,8 +2,9 @@ use crate::{
     MediaUploadRequestExecutionError, RequestExecutionError, RequestExecutionErrorReason,
     api_error::InvalidSslErrorReason,
     request::{
-        RequestExecutor, RequestMethod, WpNetworkHeaderMap, WpNetworkRequest, WpNetworkResponse,
-        endpoint::media_endpoint::MediaUploadRequest, user_agent,
+        NetworkRequestAccessor, RequestExecutor, RequestMethod, WpNetworkHeaderMap,
+        WpNetworkRequest, WpNetworkResponse, endpoint::media_endpoint::MediaUploadRequest,
+        user_agent,
     },
 };
 use async_trait::async_trait;

wp_api_integration_tests/tests/test_app_notifier_immut.rs

@@ -10,7 +10,7 @@ use wp_api::{
     auth::WpAuthenticationProvider,
     middleware::WpApiMiddlewarePipeline,
     request::{
-        RequestExecutor, WpNetworkRequest, WpNetworkResponse,
+        NetworkRequestAccessor, RequestExecutor, WpNetworkRequest, WpNetworkResponse,
         endpoint::media_endpoint::MediaUploadRequest,
     },
     reqwest_request_executor::ReqwestRequestExecutor,

wp_api_integration_tests/tests/test_login_remote.rs

@@ -14,7 +14,7 @@ use wp_api::{
         ApiDiscoveryAuthenticationMiddleware, RetryAfterMiddleware, WpApiMiddleware,
         WpApiMiddlewarePipeline,
     },
-    request::RequestExecutor,
+    request::{NetworkRequestAccessor, RequestExecutor},
     reqwest_request_executor::ReqwestRequestExecutor,
 };
 use wp_api_integration_tests::mock::{MockExecutor, response_helpers};

wp_api_integration_tests/tests/test_media_err.rs

@@ -10,8 +10,8 @@ use wp_api::{
     middleware::WpApiMiddlewarePipeline,
     posts::WpApiParamPostsOrderBy,
     request::{
-        RequestExecutor, WpNetworkHeaderMap, WpNetworkRequest, WpNetworkResponse,
-        endpoint::media_endpoint::MediaUploadRequest,
+        NetworkRequestAccessor, RequestExecutor, WpNetworkHeaderMap, WpNetworkRequest,
+        WpNetworkResponse, endpoint::media_endpoint::MediaUploadRequest,
     },
     reqwest_request_executor::ReqwestRequestExecutor,
     users::UserId,