Use plugin slug type instead of string (#501)

Automattic · Jan 23, 2025 · 693b03e · 693b03e
1 parent 6f2b564
commit 693b03e
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 6 deletions.
diff --git a/native/swift/Sources/wordpress-api/Exports.swift b/native/swift/Sources/wordpress-api/Exports.swift
@@ -125,4 +125,8 @@ public typealias WpSiteHealthTestsRequestExecutor = WordPressAPIInternal.WpSiteH
 extension WpSiteHealthTestsRequestExecutor: @unchecked Sendable {}
 // swiftlint:enable line_length
 
+// MARK: - WordPress.org
+public typealias WordPressOrgApiClient = WordPressAPIInternal.WordPressOrgApiClient
+extension WordPressOrgApiClient: @unchecked Sendable {}
+
 #endif
diff --git a/wp_api/src/plugins.rs b/wp_api/src/plugins.rs
@@ -118,6 +118,12 @@ impl From<&str> for PluginWpOrgDirectorySlug {
     }
 }
 
+impl PluginWpOrgDirectorySlug {
+    pub fn as_str(&self) -> &str {
+        self.slug.as_str()
+    }
+}
+
 #[derive(
     Debug,
     Clone,

diff --git a/wp_api/src/wordpress_org/client.rs b/wp_api/src/wordpress_org/client.rs
@@ -1,6 +1,6 @@
 use crate::{
     request::{endpoint::WpEndpointUrl, RequestExecutor, WpNetworkRequest, WpNetworkResponse},
-    RequestExecutionError,
+    PluginWpOrgDirectorySlug, RequestExecutionError,
 };
 use serde::de::DeserializeOwned;
 use std::{result::Result, sync::Arc};
@@ -22,7 +22,7 @@ impl WordPressOrgApiClient {
 
     pub async fn plugin_information(
         &self,
-        slug: &str,
+        slug: &PluginWpOrgDirectorySlug,
     ) -> Result<PluginInformation, WordPressOrgApiClientError> {
         self.execute(Self::plugin_information_request(slug)).await
     }
@@ -73,12 +73,12 @@ impl WordPressOrgApiClient {
         })
     }
 
-    fn plugin_information_request(slug: &str) -> WpNetworkRequest {
+    fn plugin_information_request(slug: &PluginWpOrgDirectorySlug) -> WpNetworkRequest {
         let mut url = Self::plugin_info_api_url();
         url.query_pairs_mut()
             .append_pair("action", "plugin_information")
             .append_pair("fields", "icons")
-            .append_pair("slug", slug);
+            .append_pair("slug", slug.as_str());
         WpNetworkRequest::get(WpEndpointUrl(url.to_string()))
     }
 
@@ -186,7 +186,7 @@ mod tests {
 
     #[test]
     fn test_plugin_info_requests_include_icons() {
-        let request = WordPressOrgApiClient::plugin_information_request("akismet");
+        let request = WordPressOrgApiClient::plugin_information_request(&("akismet".into()));
         assert!(request.url.0.contains("fields=icons"));
     }
 

diff --git a/wp_api_integration_tests/tests/test_plugin_directory.rs b/wp_api_integration_tests/tests/test_plugin_directory.rs
@@ -56,7 +56,7 @@ async fn test_parsing_full_plugin_directory() {
 
     let mut plugin_information_failures = Vec::new();
     for slug in all_slugs {
-        let info = client.plugin_information(&slug).await;
+        let info = client.plugin_information(&slug.as_str().into()).await;
         if let Err(e) = info {
             print!("F({})", slug);
             plugin_information_failures.push((slug.to_string(), e));