Merge pull request #7102 from woocommerce/issue/6079-wpadmin-url-unwanted-redirects

iamgabrielma · web-flow · commit 3938d56bbc84 · 2022-06-22T17:38:46.000+07:00
Avoid HubMenu unwanted redirects
diff --git a/WooCommerce/Classes/Extensions/Site+URL.swift b/WooCommerce/Classes/Extensions/Site+URL.swift
@@ -12,18 +12,26 @@ private extension CardPresentPaymentsPlugin {
     }
 }
 
-/// Encapsulates the logic related to the provision of the Site URLs that point to plugins related content
+/// Encapsulates the logic related to the provision of the Site URLs
 ///
 extension Site {
     /// Site's plugins section in wp-admin.
     ///
     var pluginsURL: String {
         adminURL + "plugins.php"
     }
-
     /// Payment plugin settings in wp-admin. This can be helpful when the plugin needs to be setup completely.
     /// 
     func pluginSettingsSectionURL(from plugin: CardPresentPaymentsPlugin) -> String {
         adminURL + "admin.php?page=wc-settings&tab=checkout&section=" + plugin.setupURLSectionPath
     }
+    /// Returns the WooCommerce admin URL, or attempts to construct it from the site URL.
+    ///
+    func adminURLWithFallback() -> URL? {
+        guard let adminURL = URL(string: adminURL) else {
+            let adminURLFromSiteURLString = url + "/wp-admin"
+            return URL(string: adminURLFromSiteURLString)
+        }
+        return adminURL
+    }
 }
diff --git a/WooCommerce/Classes/ViewRelated/Hub Menu/HubMenuViewModel.swift b/WooCommerce/Classes/ViewRelated/Hub Menu/HubMenuViewModel.swift
@@ -32,10 +32,10 @@ final class HubMenuViewModel: ObservableObject {
         }
         return url
     }
-
     var woocommerceAdminURL: URL {
         guard let urlString = stores.sessionManager.defaultSite?.adminURL, let url = URL(string: urlString) else {
-            return WooConstants.URLs.blog.asURL()
+            return stores.sessionManager.defaultSite?.adminURLWithFallback() ??
+            WooConstants.URLs.blog.asURL()
         }
         return url
     }
diff --git a/WooCommerce/WooCommerce.xcodeproj/project.pbxproj b/WooCommerce/WooCommerce.xcodeproj/project.pbxproj
@@ -1230,7 +1230,7 @@
 		B92FF9B027FC7821005C34E3 /* ProductsViewController.xib in Resources */ = {isa = PBXBuildFile; fileRef = B92FF9AF27FC7821005C34E3 /* ProductsViewController.xib */; };
 		B96B536B2816ECFC00F753E6 /* CardPresentPluginsDataProviderTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = B96B536A2816ECFC00F753E6 /* CardPresentPluginsDataProviderTests.swift */; };
 		B979A9BA282D62A500EBB383 /* InPersonPaymentsDeactivateStripeView.swift in Sources */ = {isa = PBXBuildFile; fileRef = B979A9B9282D62A500EBB383 /* InPersonPaymentsDeactivateStripeView.swift */; };
-		B9B6DEEF283F8B9F00901FB7 /* Site+PluginsURL.swift in Sources */ = {isa = PBXBuildFile; fileRef = B9B6DEEE283F8B9F00901FB7 /* Site+PluginsURL.swift */; };
+		B9B6DEEF283F8B9F00901FB7 /* Site+URL.swift in Sources */ = {isa = PBXBuildFile; fileRef = B9B6DEEE283F8B9F00901FB7 /* Site+URL.swift */; };
 		B9B6DEF1283F8EB100901FB7 /* SitePluginsURLTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = B9B6DEF0283F8EB100901FB7 /* SitePluginsURLTests.swift */; };
 		B9C4AB2527FDE4B6007008B8 /* CardPresentPluginsDataProvider.swift in Sources */ = {isa = PBXBuildFile; fileRef = B9C4AB2427FDE4B6007008B8 /* CardPresentPluginsDataProvider.swift */; };
 		B9C4AB2728002AF3007008B8 /* PaymentReceiptEmailParameterDeterminer.swift in Sources */ = {isa = PBXBuildFile; fileRef = B9C4AB2628002AF3007008B8 /* PaymentReceiptEmailParameterDeterminer.swift */; };
@@ -3000,7 +3000,7 @@
 		B92FF9AF27FC7821005C34E3 /* ProductsViewController.xib */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = file.xib; path = ProductsViewController.xib; sourceTree = "<group>"; };
 		B96B536A2816ECFC00F753E6 /* CardPresentPluginsDataProviderTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CardPresentPluginsDataProviderTests.swift; sourceTree = "<group>"; };
 		B979A9B9282D62A500EBB383 /* InPersonPaymentsDeactivateStripeView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = InPersonPaymentsDeactivateStripeView.swift; sourceTree = "<group>"; };
-		B9B6DEEE283F8B9F00901FB7 /* Site+PluginsURL.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "Site+PluginsURL.swift"; sourceTree = "<group>"; };
+		B9B6DEEE283F8B9F00901FB7 /* Site+URL.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "Site+URL.swift"; sourceTree = "<group>"; };
 		B9B6DEF0283F8EB100901FB7 /* SitePluginsURLTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SitePluginsURLTests.swift; sourceTree = "<group>"; };
 		B9C4AB2427FDE4B6007008B8 /* CardPresentPluginsDataProvider.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CardPresentPluginsDataProvider.swift; sourceTree = "<group>"; };
 		B9C4AB2628002AF3007008B8 /* PaymentReceiptEmailParameterDeterminer.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PaymentReceiptEmailParameterDeterminer.swift; sourceTree = "<group>"; };
@@ -7110,7 +7110,7 @@
 				DEC51B05276B3F3C009F3DF4 /* Int64+Helpers.swift */,
 				02DE5CA8279F857D007CBEF3 /* Double+Rounding.swift */,
 				02645D8727BA2E820065DC68 /* NSAttributedString+Attributes.swift */,
-				B9B6DEEE283F8B9F00901FB7 /* Site+PluginsURL.swift */,
+				B9B6DEEE283F8B9F00901FB7 /* Site+URL.swift */,
 			);
 			path = Extensions;
 			sourceTree = "<group>";
@@ -9407,7 +9407,7 @@
 				E15FC74526BC213500CF83E6 /* InPersonPaymentsLearnMore.swift in Sources */,
 				D83C12A022250BF0004CA04C /* OrderTrackingTableViewCell.swift in Sources */,
 				E1ABAEF728479E0300F40BB2 /* InPersonPaymentsSelectPluginView.swift in Sources */,
-				B9B6DEEF283F8B9F00901FB7 /* Site+PluginsURL.swift in Sources */,
+				B9B6DEEF283F8B9F00901FB7 /* Site+URL.swift in Sources */,
 				D83F5930225B269C00626E75 /* DatePickerTableViewCell.swift in Sources */,
 				26FF455F24BE49EE00B3B2F4 /* DeprecatedStatsDashboardViewController.swift in Sources */,
 				0272C00322EE9C3200D7CA2C /* AsyncDictionary.swift in Sources */,
diff --git a/WooCommerce/WooCommerceTests/ViewRelated/HubMenu/HubMenuViewModelTests.swift b/WooCommerce/WooCommerceTests/ViewRelated/HubMenu/HubMenuViewModelTests.swift
@@ -160,6 +160,85 @@ final class HubMenuViewModelTests: XCTestCase {
         // Then
         XCTAssertEqual(viewModel.menuElements, [.woocommerceAdmin, .viewStore, .reviews])
     }
+    func test_storeURL_when_site_has_storeURL_then_returns_storeURL() {
+        // Given
+        let sampleStoreURL = "https://testshop.com/"
+        let sessionManager = SessionManager.testingInstance
+        let site = Site.fake().copy(url: sampleStoreURL)
+        sessionManager.defaultSite = site
+        let stores = MockStoresManager(sessionManager: sessionManager)
+
+        // When
+        let viewModel = HubMenuViewModel(siteID: site.siteID,
+                                         stores: stores)
+
+        // Then
+        XCTAssertEqual(viewModel.storeURL, try sampleStoreURL.asURL())
+    }
+    func test_woocommerceAdminURL_when_site_has_adminURL_then_returns_adminURL() {
+        // Given
+        let sampleAdminURL = "https://testshop.com/wp-admin/"
+        let sessionManager = SessionManager.testingInstance
+        let site = Site.fake().copy(adminURL: sampleAdminURL)
+        sessionManager.defaultSite = site
+        let stores = MockStoresManager(sessionManager: sessionManager)
+
+        // When
+        let viewModel = HubMenuViewModel(siteID: site.siteID,
+                                         stores: stores)
+
+        // Then
+        XCTAssertEqual(viewModel.woocommerceAdminURL, try sampleAdminURL.asURL())
+    }
+    func test_storeURL_when_storeURL_is_nil_then_returns_woocommerce_fallback_url() {
+        // Given
+        let sampleStoreURL: String? = nil
+        let sessionManager = SessionManager.testingInstance
+        let site = Site.fake().copy(url: sampleStoreURL)
+        sessionManager.defaultSite = site
+        let stores = MockStoresManager(sessionManager: sessionManager)
+
+        // When
+        let viewModel = HubMenuViewModel(siteID: site.siteID,
+                                         stores: stores)
+        // Then
+        XCTAssertNotNil(viewModel.storeURL)
+        XCTAssertEqual(viewModel.storeURL, WooConstants.URLs.blog.asURL())
+    }
+    func test_woocommerceAdminURL_when_adminURL_is_nil_then_returns_adminURL() {
+        // Given
+        let sampleStoreURL = "https://testshop.com"
+        let sampleAdminURL: String? = nil
+        let expectedAdminURL = "https://testshop.com/wp-admin"
+        let sessionManager = SessionManager.testingInstance
+        let site = Site.fake().copy(url: sampleStoreURL, adminURL: sampleAdminURL)
+        sessionManager.defaultSite = site
+        let stores = MockStoresManager(sessionManager: sessionManager)
+
+        // When
+        let viewModel = HubMenuViewModel(siteID: site.siteID,
+                                         stores: stores)
+        // Then
+        XCTAssertNotNil(viewModel.woocommerceAdminURL)
+        XCTAssertEqual(viewModel.woocommerceAdminURL, try URL(string: expectedAdminURL)?.asURL())
+    }
+    func test_woocommerceAdminURL_when_adminURL_is_empty_then_returns_adminURL() {
+        // Given
+        let sampleStoreURL = "https://testshop.com"
+        let sampleAdminURL = ""
+        let expectedAdminURL = "https://testshop.com/wp-admin"
+        let sessionManager = SessionManager.testingInstance
+        let site = Site.fake().copy(url: sampleStoreURL, adminURL: sampleAdminURL)
+        sessionManager.defaultSite = site
+        let stores = MockStoresManager(sessionManager: sessionManager)
+
+        // When
+        let viewModel = HubMenuViewModel(siteID: site.siteID,
+                                         stores: stores)
+        // Then
+        XCTAssertNotNil(viewModel.woocommerceAdminURL)
+        XCTAssertEqual(viewModel.woocommerceAdminURL, try URL(string: expectedAdminURL)?.asURL())
+    }
 }
 
 private extension HubMenuViewModelTests {

Original file line number	Diff line number	Diff line change
`@@ -12,18 +12,26 @@ private extension CardPresentPaymentsPlugin {`
`12`	`12`	`}`
`13`	`13`	`}`
`14`	`14`
`15`		`-/// Encapsulates the logic related to the provision of the Site URLs that point to plugins related content`
	`15`	`+/// Encapsulates the logic related to the provision of the Site URLs`
`16`	`16`	`///`
`17`	`17`	`extension Site {`
`18`	`18`	`/// Site's plugins section in wp-admin.`
`19`	`19`	`///`
`20`	`20`	`var pluginsURL: String {`
`21`	`21`	`adminURL + "plugins.php"`
`22`	`22`	`}`
`23`		`-`
`24`	`23`	`/// Payment plugin settings in wp-admin. This can be helpful when the plugin needs to be setup completely.`
`25`	`24`	`///`
`26`	`25`	`func pluginSettingsSectionURL(from plugin: CardPresentPaymentsPlugin) -> String {`
`27`	`26`	`adminURL + "admin.php?page=wc-settings&tab=checkout&section=" + plugin.setupURLSectionPath`
`28`	`27`	`}`
	`28`	`+ /// Returns the WooCommerce admin URL, or attempts to construct it from the site URL.`
	`29`	`+ ///`
	`30`	`+ func adminURLWithFallback() -> URL? {`
	`31`	`+ guard let adminURL = URL(string: adminURL) else {`
	`32`	`+ let adminURLFromSiteURLString = url + "/wp-admin"`
	`33`	`+ return URL(string: adminURLFromSiteURLString)`
	`34`	`+ }`
	`35`	`+ return adminURL`
	`36`	`+ }`
`29`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -32,10 +32,10 @@ final class HubMenuViewModel: ObservableObject {`
`32`	`32`	`}`
`33`	`33`	`return url`
`34`	`34`	`}`
`35`		`-`
`36`	`35`	`var woocommerceAdminURL: URL {`
`37`	`36`	`guard let urlString = stores.sessionManager.defaultSite?.adminURL, let url = URL(string: urlString) else {`
`38`		`- return WooConstants.URLs.blog.asURL()`
	`37`	`+ return stores.sessionManager.defaultSite?.adminURLWithFallback() ??`
	`38`	`+ WooConstants.URLs.blog.asURL()`
`39`	`39`	`}`
`40`	`40`	`return url`
`41`	`41`	`}`