Rename plugin to pluginPath parameter in PluginsServiceProtocol.waitForPluginInStorage to improve readability.

Author: jaclync

Modules/Sources/Yosemite/Tools/Plugins/PluginsService.swift

@@ -7,10 +7,10 @@ public protocol PluginsServiceProtocol {
     /// Waits for a specific plugin to be available in storage.
     /// - Parameters:
     ///   - siteID: The site ID to search for the plugin.
-    ///   - plugin: The plugin's file path (e.g., "woocommerce/woocommerce.php" for WooCommerce).
+    ///   - pluginPath: The plugin's file path (e.g., "woocommerce/woocommerce.php" for WooCommerce).
     ///   - isActive: Whether the plugin is active or not.
     /// - Returns: The SystemPlugin when found in storage.
-    func waitForPluginInStorage(siteID: Int64, plugin: String, isActive: Bool) async -> SystemPlugin
+    func waitForPluginInStorage(siteID: Int64, pluginPath: String, isActive: Bool) async -> SystemPlugin
 }
 
 public class PluginsService: PluginsServiceProtocol {
@@ -21,8 +21,8 @@ public class PluginsService: PluginsServiceProtocol {
     }
 
     @MainActor
-    public func waitForPluginInStorage(siteID: Int64, plugin: String, isActive: Bool) async -> SystemPlugin {
-        let predicate = \StorageSystemPlugin.siteID == siteID && \StorageSystemPlugin.plugin == plugin && \StorageSystemPlugin.active == isActive
+    public func waitForPluginInStorage(siteID: Int64, pluginPath: String, isActive: Bool) async -> SystemPlugin {
+        let predicate = \StorageSystemPlugin.siteID == siteID && \StorageSystemPlugin.plugin == pluginPath && \StorageSystemPlugin.active == isActive
         let pluginDescriptor = NSSortDescriptor(keyPath: \StorageSystemPlugin.plugin, ascending: true)
         let resultsController = ResultsController<StorageSystemPlugin>(storageManager: storageManager,
                                                                        matching: predicate,
@@ -34,7 +34,7 @@ public class PluginsService: PluginsServiceProtocol {
                 return plugin
             }
         } catch {
-            DDLogError("Error loading plugin \(plugin) for site \(siteID) initially: \(error.localizedDescription)")
+            DDLogError("Error loading plugin \(pluginPath) for site \(siteID) initially: \(error.localizedDescription)")
         }
 
         return await withCheckedContinuation { continuation in

Modules/Tests/YosemiteTests/Tools/Plugins/PluginsServiceTests.swift

@@ -18,7 +18,7 @@ struct PluginsServiceTests {
         storageManager.insertWCPlugin(siteID: siteID, isActive: true, version: "1.0.0")
 
         // When
-        let result = await sut.waitForPluginInStorage(siteID: siteID, plugin: PluginConstants.plugin, isActive: true)
+        let result = await sut.waitForPluginInStorage(siteID: siteID, pluginPath: PluginConstants.plugin, isActive: true)
 
         // Then
         #expect(result.siteID == siteID)
@@ -33,7 +33,7 @@ struct PluginsServiceTests {
         await storageManager.reset()
 
         // When
-        async let plugin = sut.waitForPluginInStorage(siteID: siteID, plugin: PluginConstants.plugin, isActive: true)
+        async let plugin = sut.waitForPluginInStorage(siteID: siteID, pluginPath: PluginConstants.plugin, isActive: true)
         #expect(storageManager.viewStorage.loadSystemPlugins(siteID: siteID).count == 0)
         storageManager.insertWCPlugin(siteID: siteID, isActive: true, version: "2.0.0")
         #expect(storageManager.viewStorage.loadSystemPlugins(siteID: siteID).count == 1)

WooCommerce/Classes/ViewRelated/Dashboard/Settings/POS/LegacyPOSTabEligibilityChecker.swift

@@ -154,7 +154,7 @@ private extension LegacyPOSTabEligibilityChecker {
 
     @MainActor
     func fetchWooCommercePlugin(siteID: Int64) async -> SystemPlugin {
-        await pluginsService.waitForPluginInStorage(siteID: siteID, plugin: Constants.wcPlugin, isActive: true)
+        await pluginsService.waitForPluginInStorage(siteID: siteID, pluginPath: Constants.wcPlugin, isActive: true)
     }
 
     @MainActor

WooCommerce/Classes/ViewRelated/Dashboard/Settings/POS/POSTabEligibilityChecker.swift

@@ -140,7 +140,7 @@ private extension POSTabEligibilityChecker {
 
     @MainActor
     func fetchWooCommercePlugin(siteID: Int64) async -> SystemPlugin {
-        await pluginsService.waitForPluginInStorage(siteID: siteID, plugin: Constants.wcPlugin, isActive: true)
+        await pluginsService.waitForPluginInStorage(siteID: siteID, pluginPath: Constants.wcPlugin, isActive: true)
     }
 
     @MainActor

WooCommerce/WooCommerceTests/ViewRelated/Settings/POS/LegacyPOSTabEligibilityCheckerTests.swift

@@ -426,7 +426,7 @@ private extension LegacyPOSTabEligibilityCheckerTests {
 private final class MockPluginsService: PluginsServiceProtocol {
     var pluginToReturn: SystemPlugin = .fake()
 
-    func waitForPluginInStorage(siteID: Int64, plugin: String, isActive: Bool) async -> SystemPlugin {
+    func waitForPluginInStorage(siteID: Int64, pluginPath: String, isActive: Bool) async -> SystemPlugin {
         pluginToReturn
     }
 }

WooCommerce/WooCommerceTests/ViewRelated/Settings/POS/POSTabEligibilityCheckerTests.swift

@@ -648,7 +648,7 @@ private extension POSTabEligibilityCheckerTests {
 private final class MockPluginsService: PluginsServiceProtocol {
     var pluginToReturn: SystemPlugin = .fake()
 
-    func waitForPluginInStorage(siteID: Int64, plugin: String, isActive: Bool) async -> SystemPlugin {
+    func waitForPluginInStorage(siteID: Int64, pluginPath: String, isActive: Bool) async -> SystemPlugin {
         pluginToReturn
     }
 }