Skip to content

Commit 7726597

Browse files
itsmeichigoitsmeichigo
authored
Update eligibility check for shipping label creation to use plugin path instead of name (#15655)
2 parents 9862c61 + eec329f commit 7726597

File tree

5 files changed

+61
-22
lines changed

5 files changed

+61
-22
lines changed

‎WooCommerce/Classes/Extensions/SitePlugin+Woo.swift‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ import Yosemite
44
///
55
extension SitePlugin {
66
enum SupportedPlugin {
7-
public static let LegacyWCShip = "WooCommerce Shipping & Tax"
8-
public static let WooShipping = ["Woo Shipping", "WooCommerce Shipping"]
97
public static let WCTracking = "WooCommerce Shipment Tracking"
108
public static let WCSubscriptions = ["WooCommerce Subscriptions", "Woo Subscriptions"]
119
public static let WCProductBundles = ["WooCommerce Product Bundles", "Woo Product Bundles"]
@@ -14,4 +12,9 @@ extension SitePlugin {
1412
public static let WCGiftCards = ["WooCommerce Gift Cards", "Woo Gift Cards"]
1513
public static let GoogleForWooCommerce = ["Google Listings and Ads", "Google for WooCommerce"]
1614
}
15+
16+
enum SupportedPluginPath {
17+
public static let LegacyWCShip = "woocommerce-services/woocommerce-services.php"
18+
public static let WooShipping = "woocommerce-shipping/woocommerce-shipping.php"
19+
}
1720
}

‎WooCommerce/Classes/ViewModels/Order Details/OrderDetailsDataSource.swift‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ final class OrderDetailsDataSource: NSObject {
8989
///
9090
var shouldAllowWCShipInstallation: Bool {
9191
let isFeatureFlagEnabled = featureFlags.isFeatureFlagEnabled(.shippingLabelsOnboardingM1)
92-
let plugin = resultsControllers.sitePlugins.first { $0.name == SitePlugin.SupportedPlugin.LegacyWCShip }
92+
let plugin = resultsControllers.sitePlugins.first { $0.plugin == SitePlugin.SupportedPluginPath.LegacyWCShip }
9393
let isPluginInstalled = plugin != nil && resultsControllers.sitePlugins.count > 0
9494
let isPluginActive = plugin?.status.isActive ?? false
9595
let isCountryCodeUS = SiteAddress(siteSettings: siteSettings).countryCode == CountryCode.US

‎WooCommerce/Classes/ViewModels/Order Details/OrderDetailsViewModel.swift‎

Lines changed: 29 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -796,19 +796,19 @@ extension OrderDetailsViewModel {
796796
return false
797797
}
798798

799-
guard await !isPluginActive(SitePlugin.SupportedPlugin.LegacyWCShip) else {
799+
guard await !isPluginActive(pluginPath: SitePlugin.SupportedPluginPath.LegacyWCShip) else {
800800
return true
801801
}
802802

803-
return await isPluginActive(SitePlugin.SupportedPlugin.WooShipping)
803+
return await isPluginActive(pluginPath: SitePlugin.SupportedPluginPath.WooShipping)
804804
}
805805

806806
/// Checks if the Woo Shipping extension is active, with the minimum version required for its shipping label flow.
807807
///
808808
@MainActor
809809
func isWooShippingSupported() async -> Bool {
810810
guard featureFlagService.isFeatureFlagEnabled(.revampedShippingLabelCreation),
811-
let plugin = await fetchPlugin(SitePlugin.SupportedPlugin.WooShipping) else {
811+
let plugin = await fetchPluginByPath(SitePlugin.SupportedPluginPath.WooShipping) else {
812812
return false
813813
}
814814

@@ -885,7 +885,7 @@ extension OrderDetailsViewModel {
885885
///
886886
private func isPluginActive(_ pluginNames: [String], completion: @escaping (Bool) -> (Void)) {
887887
Task { @MainActor in
888-
let plugin = await fetchPlugin(pluginNames)
888+
let plugin = await fetchPluginByNames(pluginNames)
889889
completion(plugin?.active == true)
890890
}
891891
}
@@ -894,7 +894,7 @@ extension OrderDetailsViewModel {
894894
/// Additionally it logs to tracks if the plugin store is accessed without it being in sync so we can handle that edge-case if it happens recurrently.
895895
///
896896
@MainActor
897-
private func fetchPlugin(_ pluginNames: [String]) async -> SystemPlugin? {
897+
private func fetchPluginByNames(_ pluginNames: [String]) async -> SystemPlugin? {
898898
guard arePluginsSynced() else {
899899
DDLogError("⚠️ SystemPlugins accessed without being in sync.")
900900
ServiceLocator.analytics.track(event: WooAnalyticsEvent.Orders.pluginsNotSyncedYet())
@@ -908,6 +908,24 @@ extension OrderDetailsViewModel {
908908
}
909909
}
910910

911+
/// Fetches a plugin from storage, based on the provided plugin path.
912+
/// Additionally it logs to tracks if the plugin store is accessed without it being in sync so we can handle that edge-case if it happens recurrently.
913+
///
914+
@MainActor
915+
private func fetchPluginByPath(_ path: String) async -> SystemPlugin? {
916+
guard arePluginsSynced() else {
917+
DDLogError("⚠️ SystemPlugins accessed without being in sync.")
918+
ServiceLocator.analytics.track(event: WooAnalyticsEvent.Orders.pluginsNotSyncedYet())
919+
return nil
920+
}
921+
922+
return await withCheckedContinuation { continuation in
923+
stores.dispatch(SystemStatusAction.fetchSystemPluginWithPath(siteID: order.siteID, pluginPath: path, onCompletion: { plugin in
924+
continuation.resume(returning: plugin)
925+
}))
926+
}
927+
}
928+
911929
/// Function that checks for any existing system plugin in the order's store.
912930
/// If there is none, we assume plugins are not synced because at least the`WooCommerce` plugin should be present.
913931
///
@@ -945,6 +963,12 @@ private extension OrderDetailsViewModel {
945963
}
946964
}
947965
}
966+
967+
@MainActor
968+
func isPluginActive(pluginPath: String) async -> Bool {
969+
let plugin = await fetchPluginByPath(pluginPath)
970+
return plugin?.active == true
971+
}
948972
}
949973

950974
extension OrderDetailsViewModel {

‎WooCommerce/WooCommerceTests/ViewRelated/OrderDetailsViewModelTests.swift‎

Lines changed: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ final class OrderDetailsViewModelTests: XCTestCase {
9696
storesManager.reset()
9797
XCTAssertEqual(storesManager.receivedActions.count, 0)
9898

99-
let plugin = insertSystemPlugin(name: SitePlugin.SupportedPlugin.LegacyWCShip, siteID: order.siteID, isActive: true)
99+
let plugin = insertSystemPlugin(path: SitePlugin.SupportedPluginPath.LegacyWCShip, siteID: order.siteID, isActive: true)
100100
whenFetchingSystemPlugin(thenReturn: plugin)
101101
whenSyncingShippingLabels(thenReturn: .success([]))
102102

@@ -108,13 +108,13 @@ final class OrderDetailsViewModelTests: XCTestCase {
108108

109109
// SystemStatusAction.fetchSystemPlugin
110110
let firstAction = try XCTUnwrap(storesManager.receivedActions.first as? SystemStatusAction)
111-
guard case let SystemStatusAction.fetchSystemPluginListWithNameList(siteID, systemPluginNameList, _) = firstAction else {
111+
guard case let SystemStatusAction.fetchSystemPluginWithPath(siteID, path, _) = firstAction else {
112112
XCTFail("Expected \(firstAction) to be \(SystemStatusAction.self)")
113113
return
114114
}
115115

116116
XCTAssertEqual(siteID, order.siteID)
117-
XCTAssertEqual(systemPluginNameList, [SitePlugin.SupportedPlugin.LegacyWCShip])
117+
XCTAssertEqual(path, SitePlugin.SupportedPluginPath.LegacyWCShip)
118118

119119
// ShippingLabelAction.synchronizeShippingLabels
120120
let secondAction = try XCTUnwrap(storesManager.receivedActions.last as? ShippingLabelAction)
@@ -143,7 +143,7 @@ final class OrderDetailsViewModelTests: XCTestCase {
143143
func test_checkShippingLabelCreationEligibility_with_a_non_virtual_product_returns_value_from_action() async throws {
144144
// Given
145145
configureOrderWithProductsInStorage(products: [.fake().copy(productID: 6, virtual: false)])
146-
let plugin = insertSystemPlugin(name: SitePlugin.SupportedPlugin.LegacyWCShip, siteID: order.siteID, isActive: true)
146+
let plugin = insertSystemPlugin(path: SitePlugin.SupportedPluginPath.LegacyWCShip, siteID: order.siteID, isActive: true)
147147
whenFetchingSystemPlugin(thenReturn: plugin)
148148
whenCheckingShippingLabelCreationEligibility(thenReturn: true)
149149

@@ -174,7 +174,8 @@ final class OrderDetailsViewModelTests: XCTestCase {
174174
XCTAssertEqual(storesManager.receivedActions.count, 0)
175175

176176
// Make sure the are plugins synced
177-
let plugin = insertSystemPlugin(name: SitePlugin.SupportedPlugin.LegacyWCShip, siteID: order.siteID, isActive: true)
177+
let path = SitePlugin.SupportedPluginPath.LegacyWCShip
178+
let plugin = insertSystemPlugin(path: path, siteID: order.siteID, isActive: true)
178179
whenFetchingSystemPlugin(thenReturn: plugin)
179180
whenCheckingShippingLabelCreationEligibility(thenReturn: true)
180181

@@ -186,13 +187,13 @@ final class OrderDetailsViewModelTests: XCTestCase {
186187

187188
// SystemStatusAction.fetchSystemPlugin
188189
let firstAction = try XCTUnwrap(storesManager.receivedActions.first as? SystemStatusAction)
189-
guard case let SystemStatusAction.fetchSystemPluginListWithNameList(siteID, systemPluginNameList, _) = firstAction else {
190+
guard case let SystemStatusAction.fetchSystemPluginWithPath(siteID: siteID, pluginPath: path, onCompletion: _) = firstAction else {
190191
XCTFail("Expected \(firstAction) to be \(SystemStatusAction.self)")
191192
return
192193
}
193194

194195
XCTAssertEqual(siteID, order.siteID)
195-
XCTAssertEqual(systemPluginNameList, [SitePlugin.SupportedPlugin.LegacyWCShip])
196+
XCTAssertEqual(path, SitePlugin.SupportedPluginPath.LegacyWCShip)
196197

197198
// ShippingLabelAction.synchronizeShippingLabels
198199
let secondAction = try XCTUnwrap(storesManager.receivedActions.last as? ShippingLabelAction)
@@ -430,7 +431,7 @@ final class OrderDetailsViewModelTests: XCTestCase {
430431
// Given
431432
let featureFlagService = MockFeatureFlagService(revampedShippingLabelCreation: true)
432433
let viewModel = OrderDetailsViewModel(order: order, stores: storesManager, storageManager: storageManager, featureFlagService: featureFlagService)
433-
let plugin = insertSystemPlugin(name: SitePlugin.SupportedPlugin.WooShipping[0], siteID: order.siteID, isActive: true, version: "1.0.5")
434+
let plugin = insertSystemPlugin(path: SitePlugin.SupportedPluginPath.WooShipping, siteID: order.siteID, isActive: true, version: "1.0.5")
434435
whenFetchingSystemPlugin(thenReturn: plugin)
435436

436437
// When
@@ -444,7 +445,7 @@ final class OrderDetailsViewModelTests: XCTestCase {
444445
// Given
445446
let featureFlagService = MockFeatureFlagService(revampedShippingLabelCreation: false)
446447
let viewModel = OrderDetailsViewModel(order: order, stores: storesManager, storageManager: storageManager, featureFlagService: featureFlagService)
447-
let plugin = insertSystemPlugin(name: SitePlugin.SupportedPlugin.WooShipping[0], siteID: order.siteID, isActive: true, version: "1.0.5")
448+
let plugin = insertSystemPlugin(path: SitePlugin.SupportedPluginPath.WooShipping, siteID: order.siteID, isActive: true, version: "1.0.5")
448449
whenFetchingSystemPlugin(thenReturn: plugin)
449450

450451
// When
@@ -458,7 +459,7 @@ final class OrderDetailsViewModelTests: XCTestCase {
458459
// Given
459460
let featureFlagService = MockFeatureFlagService(revampedShippingLabelCreation: true)
460461
let viewModel = OrderDetailsViewModel(order: order, stores: storesManager, storageManager: storageManager, featureFlagService: featureFlagService)
461-
let plugin = insertSystemPlugin(name: SitePlugin.SupportedPlugin.WooShipping[0], siteID: order.siteID, isActive: false, version: "1.0.5")
462+
let plugin = insertSystemPlugin(path: SitePlugin.SupportedPluginPath.WooShipping, siteID: order.siteID, isActive: false, version: "1.0.5")
462463
whenFetchingSystemPlugin(thenReturn: plugin)
463464

464465
// When
@@ -472,7 +473,7 @@ final class OrderDetailsViewModelTests: XCTestCase {
472473
// Given
473474
let featureFlagService = MockFeatureFlagService(revampedShippingLabelCreation: true)
474475
let viewModel = OrderDetailsViewModel(order: order, stores: storesManager, storageManager: storageManager, featureFlagService: featureFlagService)
475-
let plugin = insertSystemPlugin(name: SitePlugin.SupportedPlugin.WooShipping[0], siteID: order.siteID, isActive: false, version: "1.0.4")
476+
let plugin = insertSystemPlugin(path: SitePlugin.SupportedPluginPath.WooShipping, siteID: order.siteID, isActive: false, version: "1.0.4")
476477
whenFetchingSystemPlugin(thenReturn: plugin)
477478

478479
// When
@@ -491,6 +492,13 @@ private extension OrderDetailsViewModelTests {
491492
return plugin
492493
}
493494

495+
@discardableResult
496+
func insertSystemPlugin(path: String, siteID: Int64, isActive: Bool, version: String? = nil) -> SystemPlugin {
497+
let plugin = SystemPlugin.fake().copy(siteID: siteID, plugin: path, version: version, active: isActive)
498+
storageManager.insertSampleSystemPlugin(readOnlySystemPlugin: plugin)
499+
return plugin
500+
}
501+
494502
func configureOrderWithProductsInStorage(products: [Product]) {
495503
order = MockOrders().sampleOrder().copy(items: products.map { OrderItem.fake().copy(productID: $0.productID) })
496504
viewModel = OrderDetailsViewModel(order: order, stores: storesManager, storageManager: storageManager)
@@ -508,8 +516,10 @@ private extension OrderDetailsViewModelTests {
508516
onCompletion(plugin)
509517
case let .fetchSystemPluginListWithNameList(_, _, onCompletion):
510518
onCompletion(plugin)
511-
default:
512-
break
519+
case let .fetchSystemPluginWithPath(_, _, onCompletion):
520+
onCompletion(plugin)
521+
default:
522+
break
513523
}
514524
}
515525
}

‎WooCommerce/WooCommerceTests/ViewRelated/Orders/Order Details/OrderDetailsDataSourceTests.swift‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -381,7 +381,9 @@ final class OrderDetailsDataSourceTests: XCTestCase {
381381
// Given
382382
let sampleSiteID: Int64 = 1234
383383
let order = makeOrder()
384-
let activePlugin = SitePlugin.fake().copy(siteID: sampleSiteID, status: .active, name: SitePlugin.SupportedPlugin.LegacyWCShip)
384+
let activePlugin = SitePlugin.fake().copy(siteID: sampleSiteID,
385+
plugin: SitePlugin.SupportedPluginPath.LegacyWCShip,
386+
status: .active)
385387
insert(activePlugin)
386388

387389
let currencySettings = CurrencySettings(currencyCode: .USD,

0 commit comments

Comments
 (0)