Update POSSystemStatusService to also fetch inactive plugins and upsert all plugins to storage so that later use cases have the latest value.

Author: jaclync

Modules/Sources/Storage/Protocols/StorageManagerType.swift

@@ -57,4 +57,17 @@ public extension StorageManagerType {
     func reset() {
         reset(onCompletion: nil)
     }
+    
+    /// Async/await version of `performAndSave`.
+    ///
+    /// - Parameters:
+    ///   - operation: A closure which uses the given `StorageType` to make data changes in background.
+    ///   - queue: A queue on which to execute the completion closure.
+    func performAndSaveAsync(_ operation: @escaping (StorageType) -> Void, on queue: DispatchQueue = .main) async {
+        await withCheckedContinuation { continuation in
+            performAndSave(operation, completion: {
+                continuation.resume()
+            }, on: queue)
+        }
+    }
 }

Modules/Sources/Yosemite/PointOfSale/Eligibility/POSSystemStatusService.swift

@@ -1,5 +1,6 @@
 import Foundation
 import Networking
+import Storage
 
 public protocol POSSystemStatusServiceProtocol {
     /// Loads WooCommerce plugin and POS feature switch value remotely for eligibility checks.
@@ -23,27 +24,36 @@ public struct POSPluginAndFeatureInfo {
 /// Service for fetching POS-related system status information.
 public final class POSSystemStatusService: POSSystemStatusServiceProtocol {
     private let remote: SystemStatusRemote
+    private let storageManager: StorageManagerType
 
-    public init(credentials: Credentials?) {
+    public init(credentials: Credentials?, storageManager: StorageManagerType) {
         let network = AlamofireNetwork(credentials: credentials)
-        remote = SystemStatusRemote(network: network)
+        self.remote = SystemStatusRemote(network: network)
+        self.storageManager = storageManager
     }
 
     /// Test-friendly initializer that accepts a network implementation.
-    init(network: Network) {
-        remote = SystemStatusRemote(network: network)
+    init(network: Network, storageManager: StorageManagerType) {
+        self.remote = SystemStatusRemote(network: network)
+        self.storageManager = storageManager
     }
 
+    @MainActor
     public func loadWooCommercePluginAndPOSFeatureSwitch(siteID: Int64) async throws -> POSPluginAndFeatureInfo {
         let mapper = SingleItemMapper<POSPluginEligibilitySystemStatus>(siteID: siteID)
         let systemStatus: POSPluginEligibilitySystemStatus = try await remote.loadSystemStatus(
             for: siteID,
-            fields: [.activePlugins, .settings],
+            fields: [.activePlugins, .inactivePlugins, .settings],
             mapper: mapper
         )
 
-        // Finds WooCommerce plugin from active plugins response.
-        guard let wcPlugin = systemStatus.activePlugins.first(where: { $0.plugin == Constants.wcPluginPath }) else {
+        // Upserts all plugins in storage.
+        await storageManager.performAndSaveAsync({ [weak self] storage in
+            self?.upsertSystemPlugins(siteID: siteID, systemStatus: systemStatus, in: storage)
+        })
+
+        // Loads WooCommerce plugin from storage.
+        guard let wcPlugin = storageManager.viewStorage.loadSystemPlugin(siteID: siteID, path: Constants.wcPluginPath)?.toReadOnly() else {
             return POSPluginAndFeatureInfo(wcPlugin: nil, featureValue: nil)
         }
 
@@ -57,16 +67,52 @@ private extension POSSystemStatusService {
     enum Constants {
         static let wcPluginPath = "woocommerce/woocommerce.php"
     }
+
+    /// Updates or inserts system plugins in storage.
+    func upsertSystemPlugins(siteID: Int64, systemStatus: POSPluginEligibilitySystemStatus, in storage: StorageType) {
+        // Active and inactive plugins share identical structure, but are stored in separate parts of the remote response
+        // (and without an active attribute in the response). So we apply the correct value for active (or not)
+        let readonlySystemPlugins: [SystemPlugin] = {
+            let activePlugins = systemStatus.activePlugins.map {
+                $0.copy(active: true)
+            }
+
+            let inactivePlugins = systemStatus.inactivePlugins.map {
+                $0.copy(active: false)
+            }
+
+            return activePlugins + inactivePlugins
+        }()
+
+        let storedPlugins = storage.loadSystemPlugins(siteID: siteID, matching: readonlySystemPlugins.map { $0.name })
+        readonlySystemPlugins.forEach { readonlySystemPlugin in
+            // Loads or creates new StorageSystemPlugin matching the readonly one.
+            let storageSystemPlugin: StorageSystemPlugin = {
+                if let systemPlugin = storedPlugins.first(where: { $0.name == readonlySystemPlugin.name }) {
+                    return systemPlugin
+                }
+                return storage.insertNewObject(ofType: StorageSystemPlugin.self)
+            }()
+
+            storageSystemPlugin.update(with: readonlySystemPlugin)
+        }
+
+        // Removes stale system plugins.
+        let currentSystemPlugins = readonlySystemPlugins.map(\.name)
+        storage.deleteStaleSystemPlugins(siteID: siteID, currentSystemPlugins: currentSystemPlugins)
+    }
 }
 
 // MARK: - Network Response Structs
 
 private struct POSPluginEligibilitySystemStatus: Decodable {
     let activePlugins: [SystemPlugin]
+    let inactivePlugins: [SystemPlugin]
     let settings: POSEligibilitySystemStatusSettings
 
     enum CodingKeys: String, CodingKey {
         case activePlugins = "active_plugins"
+        case inactivePlugins = "inactive_plugins"
         case settings
     }
 }

Modules/Tests/NetworkingTests/Responses/system-status-wc-plugin-and-pos-feature-disabled.json

@@ -1,5 +1,6 @@
 {
   "data": {
+    "inactive_plugins": [],
     "active_plugins":[
       {
         "plugin": "woocommerce/woocommerce.php",

Modules/Tests/NetworkingTests/Responses/system-status-wc-plugin-and-pos-feature-enabled.json

@@ -1,5 +1,6 @@
 {
   "data": {
+    "inactive_plugins": [],
     "active_plugins":[
       {
         "plugin": "woocommerce/woocommerce.php",

Modules/Tests/NetworkingTests/Responses/system-status-wc-plugin-missing.json

@@ -1,5 +1,6 @@
 {
   "data": {
+    "inactive_plugins": [],
     "active_plugins":[
     ],
     "settings": {

Modules/Tests/YosemiteTests/PointOfSale/POSSystemStatusServiceTests.swift

@@ -2,22 +2,24 @@ import Foundation
 import Testing
 import TestKit
 @testable import Networking
+@testable import Storage
 @testable import Yosemite
 
 @MainActor
 struct POSSystemStatusServiceTests {
     private let network = MockNetwork()
+    private let storageManager = MockStorageManager()
     private let sampleSiteID: Int64 = 134
     private let sut: POSSystemStatusService
 
     init() async throws {
         network.removeAllSimulatedResponses()
-        sut = POSSystemStatusService(network: network)
+        sut = POSSystemStatusService(network: network, storageManager: storageManager)
     }
 
     // MARK: - loadWooCommercePluginAndPOSFeatureSwitch Tests
 
-    @Test func loadWooCommercePluginAndPOSFeatureSwitch_returns_plugin_and_nil_feature_when_settings_response_does_not_include_enabled_featuers() async throws {
+    @Test func loadWooCommercePluginAndPOSFeatureSwitch_returns_plugin_and_nil_feature_when_settings_response_does_not_include_enabled_features() async throws {
         // Given
         network.simulateResponse(requestUrlSuffix: "system_status", filename: "systemStatus")
 
@@ -37,6 +39,10 @@ struct POSSystemStatusServiceTests {
         // Given
         network.simulateResponse(requestUrlSuffix: "system_status", filename: "system-status-wc-plugin-and-pos-feature-enabled")
 
+        // Inserts WooCommerce plugin into storage with an older version and inactive.
+        let storageWCPlugin = createWCPlugin(version: "9.5.2", active: false)
+        storageManager.insertSampleSystemPlugin(readOnlySystemPlugin: storageWCPlugin)
+
         // When
         let result = try await sut.loadWooCommercePluginAndPOSFeatureSwitch(siteID: sampleSiteID)
 
@@ -53,6 +59,10 @@ struct POSSystemStatusServiceTests {
         // Given
         network.simulateResponse(requestUrlSuffix: "system_status", filename: "system-status-wc-plugin-and-pos-feature-disabled")
 
+        // Inserts WooCommerce plugin into storage with an older version and inactive.
+        let storageWCPlugin = createWCPlugin(version: "9.5.2", active: false)
+        storageManager.insertSampleSystemPlugin(readOnlySystemPlugin: storageWCPlugin)
+
         // When
         let result = try await sut.loadWooCommercePluginAndPOSFeatureSwitch(siteID: sampleSiteID)
 
@@ -69,6 +79,10 @@ struct POSSystemStatusServiceTests {
         // Given
         network.simulateResponse(requestUrlSuffix: "system_status", filename: "system-status-wc-plugin-missing")
 
+        // Inserts WooCommerce plugin eligible for POS into storage.
+        let storageWCPlugin = createWCPlugin(version: "9.9.0", active: true)
+        storageManager.insertSampleSystemPlugin(readOnlySystemPlugin: storageWCPlugin)
+
         // When
         let result = try await sut.loadWooCommercePluginAndPOSFeatureSwitch(siteID: sampleSiteID)
 
@@ -87,3 +101,15 @@ struct POSSystemStatusServiceTests {
         }
     }
 }
+
+private extension POSSystemStatusServiceTests {
+    func createWCPlugin(version: String = "5.8.0", active: Bool = true) -> Yosemite.SystemPlugin {
+        .fake().copy(
+            siteID: sampleSiteID,
+            plugin: "woocommerce/woocommerce.php",
+            version: version,
+            versionLatest: version,
+            active: active
+        )
+    }
+}

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

@@ -62,7 +62,8 @@ final class POSTabEligibilityChecker: POSEntryPointEligibilityCheckerProtocol {
          eligibilityService: POSEligibilityServiceProtocol = POSEligibilityService(),
          stores: StoresManager = ServiceLocator.stores,
          featureFlagService: FeatureFlagService = ServiceLocator.featureFlagService,
-         systemStatusService: POSSystemStatusServiceProtocol = POSSystemStatusService(credentials: ServiceLocator.stores.sessionManager.defaultCredentials)) {
+         systemStatusService: POSSystemStatusServiceProtocol = POSSystemStatusService(credentials: ServiceLocator.stores.sessionManager.defaultCredentials,
+                                                                                      storageManager: ServiceLocator.storageManager)) {
         self.siteID = siteID
         self.userInterfaceIdiom = userInterfaceIdiom
         self.siteSettings = siteSettings
@@ -208,7 +209,7 @@ private extension POSTabEligibilityChecker {
     }
 
     func checkWooCommercePluginEligibility(wcPlugin: SystemPlugin?) -> PluginEligibilityState {
-        guard let wcPlugin else {
+        guard let wcPlugin, wcPlugin.active else {
             return .ineligible(reason: .wooCommercePluginNotFound)
         }