Merge pull request #3851 from woocommerce/issue/add-variations-banner

Add variations announcement banner

Author: ealeksandrov

Storage/Storage/Model/FeedbackType.swift

@@ -5,9 +5,9 @@ public enum FeedbackType: String, Codable {
     ///
     case general
 
-    /// Identifier for the Products M5: Linked Products, Downloadable Files, Trashing.
+    /// Identifier for the Products Variations.
     ///
-    case productsM5
+    case productsVariations
 
     /// identifier for the shipping labels m1 feedback survey
     ///

WooCommerce/Classes/Analytics/WooAnalyticsEvent.swift

@@ -58,9 +58,8 @@ extension WooAnalyticsEvent {
     public enum FeedbackContext: String {
         /// Shown in Stats but is for asking general feedback.
         case general
-        /// Shown in products banner for Milestone 4 features. New product banners should have
-        /// their own `FeedbackContext` option.
-        case productsM4 = "products_m4"
+        /// Shown in products banner for Variations release.
+        case productsVariations = "products_variations"
         /// Shown in shipping labels banner for Milestone 1 features.
         case shippingLabelsRelease1 = "shipping_labels_m1"
     }

WooCommerce/Classes/System/WooConstants.swift

@@ -79,9 +79,9 @@ extension WooConstants {
         case inAppFeedback = "https://automattic.survey.fm/woo-app-general-feedback-user-survey"
 #endif
 
-        /// URL for the products M4 feedback survey
+        /// URL for the products feedback survey
         ///
-        case productsM4Feedback = "https://automattic.survey.fm/woo-app-feature-feedback-products"
+        case productsFeedback = "https://automattic.survey.fm/woo-app-feature-feedback-products"
 
         /// URL for the shipping labels M1 feedback survey
         ///

WooCommerce/Classes/ViewRelated/Products/ProductsTopBannerFactory.swift

@@ -2,29 +2,54 @@ import UIKit
 import Yosemite
 
 struct ProductsTopBannerFactory {
+
+    enum BannerType {
+        case variations
+
+        var title: String {
+            Localization.title
+        }
+
+        var info: String {
+            switch self {
+            case .variations:
+                return Localization.infoVariations
+            }
+        }
+
+        var feedbackContext: WooAnalyticsEvent.FeedbackContext {
+            switch self {
+            case .variations:
+                return .productsVariations
+            }
+        }
+    }
+
     /// Creates a products tab top banner asynchronously based on the app settings.
     /// - Parameters:
     ///   - isExpanded: whether the top banner is expanded by default.
+    ///   - type: sets banner content and related analytics events.
     ///   - expandedStateChangeHandler: called when the top banner expanded state changes.
     ///   - onGiveFeedbackButtonPressed: called the give feedback button is pressed.
     ///   - onDismissButtonPressed: called the dismiss button is pressed
     ///   - onCompletion: called when the view controller is created and ready for display.
     static func topBanner(isExpanded: Bool,
                           stores: StoresManager = ServiceLocator.stores,
                           analytics: Analytics = ServiceLocator.analytics,
+                          type: BannerType,
                           expandedStateChangeHandler: @escaping () -> Void,
                           onGiveFeedbackButtonPressed: @escaping () -> Void,
                           onDismissButtonPressed: @escaping () -> Void,
                           onCompletion: @escaping (TopBannerView) -> Void) {
-        let title = Localization.title
+        let title = type.title
+        let infoText = type.info
         let icon: UIImage = .megaphoneIcon
-        let infoText = Localization.info
         let giveFeedbackAction = TopBannerViewModel.ActionButton(title: Localization.giveFeedback) {
-            analytics.track(event: .featureFeedbackBanner(context: .productsM4, action: .gaveFeedback))
+            analytics.track(event: .featureFeedbackBanner(context: type.feedbackContext, action: .gaveFeedback))
             onGiveFeedbackButtonPressed()
         }
         let dismissAction = TopBannerViewModel.ActionButton(title: Localization.dismiss) {
-            analytics.track(event: .featureFeedbackBanner(context: .productsM4, action: .dismissed))
+            analytics.track(event: .featureFeedbackBanner(context: type.feedbackContext, action: .dismissed))
             onDismissButtonPressed()
         }
         let actions = [giveFeedbackAction, dismissAction]
@@ -42,13 +67,12 @@ struct ProductsTopBannerFactory {
 
 private extension ProductsTopBannerFactory {
     enum Localization {
-        static let title =
-            NSLocalizedString("New features available!",
-                              comment: "The title of the top banner on the Products tab.")
-        static let info =
-            NSLocalizedString(
-                "You can now add downloadable files to a product and link upsell & cross-sell products. No longer want a product? Trash it!",
-                comment: "The info of the top banner on the Products tab.")
+        static let title = NSLocalizedString("New features available!",
+                                             comment: "The title of the top banner on the Products tab.")
+
+        static let infoVariations = NSLocalizedString("You can now create and manage product variations!",
+                                                      comment: "The info of the top banner on the Products tab.")
+
         static let giveFeedback =
             NSLocalizedString("Give feedback",
                               comment: "The title of the button to give feedback about products beta features on the banner on the products tab")

WooCommerce/Classes/ViewRelated/Products/ProductsViewController.swift

@@ -162,7 +162,7 @@ final class ProductsViewController: UIViewController {
         configureSyncingCoordinator()
         registerTableViewCells()
 
-        updateTopBannerView()
+        showTopBannerViewIfNeeded()
 
         /// We sync the local product settings for configuring local sorting and filtering.
         /// If there are some info stored when this screen is loaded, the data will be updated using the stored sort/filters.
@@ -397,12 +397,12 @@ private extension ProductsViewController {
 private extension ProductsViewController {
     /// Fetches products feedback visibility from AppSettingsStore and update products top banner accordingly
     ///
-    func updateTopBannerView() {
-        let action = AppSettingsAction.loadFeedbackVisibility(type: .productsM5) { [weak self] result in
+    func showTopBannerViewIfNeeded() {
+        let action = AppSettingsAction.loadFeedbackVisibility(type: .productsVariations) { [weak self] result in
             switch result {
             case .success(let visible):
                 if visible {
-                    self?.requestAndShowNewTopBannerView()
+                    self?.requestAndShowNewTopBannerView(for: .variations)
                 } else {
                     self?.hideTopBannerView()
                 }
@@ -416,9 +416,10 @@ private extension ProductsViewController {
 
     /// Request a new product banner from `ProductsTopBannerFactory` and wire actionButtons actions
     ///
-    func requestAndShowNewTopBannerView() {
+    func requestAndShowNewTopBannerView(for bannerType: ProductsTopBannerFactory.BannerType) {
         let isExpanded = topBannerView?.isExpanded ?? false
         ProductsTopBannerFactory.topBanner(isExpanded: isExpanded,
+                                           type: bannerType,
                                            expandedStateChangeHandler: { [weak self] in
             self?.updateTableHeaderViewHeight()
         }, onGiveFeedbackButtonPressed: { [weak self] in
@@ -593,14 +594,15 @@ private extension ProductsViewController {
     ///
     func presentProductsFeedback() {
         // Present survey
-        let navigationController = SurveyCoordinatingController(survey: .productsM5Feedback)
+        let navigationController = SurveyCoordinatingController(survey: .productsVariationsFeedback)
         present(navigationController, animated: true, completion: nil)
     }
 
     /// Mark feedback request as dismissed and update banner visibility
     ///
     func dismissProductsBanner() {
-        let action = AppSettingsAction.updateFeedbackStatus(type: .productsM5, status: .dismissed) { [weak self] result in
+        let action = AppSettingsAction.updateFeedbackStatus(type: .productsVariations,
+                                                            status: .dismissed) { [weak self] result in
             if let error = result.failure {
                 CrashLogging.logError(error)
             }

WooCommerce/Classes/ViewRelated/Survey/SurveyViewController.swift

@@ -63,7 +63,7 @@ final class SurveyViewController: UIViewController, SurveyViewControllerOutputs
 extension SurveyViewController {
     enum Source {
         case inAppFeedback
-        case productsM5Feedback
+        case productsVariationsFeedback
         case shippingLabelsRelease1Feedback
 
         fileprivate var url: URL {
@@ -74,11 +74,10 @@ extension SurveyViewController {
                     .tagPlatform("ios")
                     .tagAppVersion(Bundle.main.bundleVersion())
 
-            case .productsM5Feedback:
-                return WooConstants.URLs.productsM4Feedback
+            case .productsVariationsFeedback:
+                return WooConstants.URLs.productsFeedback
                     .asURL()
                     .tagPlatform("ios")
-                    .tagProductMilestone("5")
                     .tagAppVersion(Bundle.main.bundleVersion())
             case .shippingLabelsRelease1Feedback:
                 return WooConstants.URLs.shippingLabelsRelease1Feedback
@@ -93,7 +92,7 @@ extension SurveyViewController {
             switch self {
             case .inAppFeedback:
                 return Localization.title
-            case .productsM5Feedback, .shippingLabelsRelease1Feedback:
+            case .productsVariationsFeedback, .shippingLabelsRelease1Feedback:
                 return Localization.giveFeedback
             }
         }
@@ -103,8 +102,8 @@ extension SurveyViewController {
             switch self {
             case .inAppFeedback:
                 return .general
-            case .productsM5Feedback:
-                return .productsM4
+            case .productsVariationsFeedback:
+                return .productsVariations
             case .shippingLabelsRelease1Feedback:
                 return .shippingLabelsRelease1
             }
@@ -152,10 +151,6 @@ extension URL {
         appendingQueryItem(URLQueryItem(name: Tags.surveyRequestAppVersionTag, value: version))
     }
 
-    func tagProductMilestone(_ milestone: String) -> URL {
-        appendingQueryItem(URLQueryItem(name: Tags.surveyRequestProductMilestoneTag, value: milestone))
-    }
-
     func tagShippingLabelsMilestone(_ milestone: String) -> URL {
         appendingQueryItem(URLQueryItem(name: Tags.surveyRequestShippingLabelsMilestoneTag, value: milestone))
     }

WooCommerce/WooCommerceTests/ViewRelated/Products/ProductsTopBannerFactoryTests.swift

@@ -28,7 +28,7 @@ final class ProductsTopBannerFactoryTests: XCTestCase {
 
     func test_it_tracks_featureFeedbackBanner_gaveFeedback_event_when_giveFeedback_button_is_pressed() throws {
         // Given
-        let bannerMirror = try makeBannerViewMirror()
+        let bannerMirror = try makeBannerViewMirror(for: .variations)
         let giveFeedbackButton = try XCTUnwrap(bannerMirror.actionButtons.first)
 
         assertEmpty(analyticsProvider.receivedEvents)
@@ -41,13 +41,13 @@ final class ProductsTopBannerFactoryTests: XCTestCase {
         XCTAssertEqual(analyticsProvider.receivedEvents.first, "feature_feedback_banner")
 
         let properties = try XCTUnwrap(analyticsProvider.receivedProperties.first)
-        XCTAssertEqual(properties["context"] as? String, "products_m4")
+        XCTAssertEqual(properties["context"] as? String, "products_variations")
         XCTAssertEqual(properties["action"] as? String, "gave_feedback")
     }
 
     func test_it_tracks_featureFeedbackBanner_dismissed_event_when_dismiss_button_is_pressed() throws {
         // Given
-        let bannerMirror = try makeBannerViewMirror()
+        let bannerMirror = try makeBannerViewMirror(for: .variations)
         let dismissButton = try XCTUnwrap(bannerMirror.actionButtons.last)
 
         assertEmpty(analyticsProvider.receivedEvents)
@@ -60,13 +60,13 @@ final class ProductsTopBannerFactoryTests: XCTestCase {
         XCTAssertEqual(analyticsProvider.receivedEvents.first, "feature_feedback_banner")
 
         let properties = try XCTUnwrap(analyticsProvider.receivedProperties.first)
-        XCTAssertEqual(properties["context"] as? String, "products_m4")
+        XCTAssertEqual(properties["context"] as? String, "products_variations")
         XCTAssertEqual(properties["action"] as? String, "dismissed")
     }
 }
 
 private extension ProductsTopBannerFactoryTests {
-    func makeBannerViewMirror() throws -> TopBannerViewMirror {
+    func makeBannerViewMirror(for bannerType: ProductsTopBannerFactory.BannerType) throws -> TopBannerViewMirror {
         storesManager.whenReceivingAction(ofType: AppSettingsAction.self) { action in
             if case let .loadProductsFeatureSwitch(onCompletion) = action {
                 onCompletion(true)
@@ -78,6 +78,7 @@ private extension ProductsTopBannerFactoryTests {
             ProductsTopBannerFactory.topBanner(isExpanded: false,
                                                stores: storesManager,
                                                analytics: analytics,
+                                               type: bannerType,
                                                expandedStateChangeHandler: {
 
             }, onGiveFeedbackButtonPressed: {

WooCommerce/WooCommerceTests/ViewRelated/Survey/SurveyViewControllerTests.swift

@@ -24,17 +24,16 @@ final class SurveyViewControllerTests: XCTestCase {
 
     func test_it_loads_the_correct_product_feedback_survey() throws {
         // Given
-        let viewController = SurveyViewController(survey: .productsM5Feedback, onCompletion: {})
+        let viewController = SurveyViewController(survey: .productsVariationsFeedback, onCompletion: {})
 
         // When
         _ = try XCTUnwrap(viewController.view)
         let mirror = try self.mirror(of: viewController)
 
         // Then
         XCTAssertTrue(mirror.webView.isLoading)
-        XCTAssertEqual(mirror.webView.url, WooConstants.URLs.productsM4Feedback
+        XCTAssertEqual(mirror.webView.url, WooConstants.URLs.productsFeedback
                         .asURL().tagPlatform("ios")
-                        .tagProductMilestone("5")
                         .tagAppVersion(Bundle.main.bundleVersion()))
     }
 

WooCommerce/WooCommerceTests/ViewRelated/Survey/URL+SurveyViewControllerTests.swift

@@ -23,14 +23,6 @@ final class URL_SurveyViewControllerTests: XCTestCase {
         XCTAssertEqual(expectedURL, actualURL)
     }
 
-    func test_tagging_product_milestone_appends_the_correct_tag_data() throws {
-        let expectedURL = "https://testurl.com?product-milestone=test"
-
-        let actualURL = URL(string: "https://testurl.com")?.tagProductMilestone("test").absoluteString
-
-        XCTAssertEqual(expectedURL, actualURL)
-    }
-
     func test_tagging_shipping_labels_milestone_appends_the_correct_tag_data() throws {
         let expectedURL = "https://testurl.com?shipping_label_milestone=test"
 
@@ -39,26 +31,14 @@ final class URL_SurveyViewControllerTests: XCTestCase {
         XCTAssertEqual(expectedURL, actualURL)
     }
 
-    func test_tagging_platform_and_tagging_product_milestone_does_stack() throws {
-            let actualURL =
-                URL(string: "https://testurl.com")?
-                .tagPlatform("ios")
-                .tagProductMilestone("123")
-                .absoluteString
-
-            let expectedURL = "https://testurl.com?woo-mobile-platform=ios&product-milestone=123"
-
-            XCTAssertEqual(expectedURL, actualURL)
-    }
-
-    func test_tagging_platform_and_tagging_product_milestone_does_stack_in_order() throws {
+    func test_tagging_platform_and_tagging_shipping_labels_milestone_does_stack_in_order() throws {
         let actualURL =
             URL(string: "https://testurl.com")?
-            .tagProductMilestone("123")
+            .tagShippingLabelsMilestone("123")
             .tagPlatform("ios")
             .absoluteString
 
-        let expectedURL = "https://testurl.com?product-milestone=123&woo-mobile-platform=ios"
+        let expectedURL = "https://testurl.com?shipping_label_milestone=123&woo-mobile-platform=ios"
 
         XCTAssertEqual(expectedURL, actualURL)
     }

Yosemite/Yosemite/Stores/AppSettings/InAppFeedbackCardVisibilityUseCase.swift

@@ -37,7 +37,7 @@ struct InAppFeedbackCardVisibilityUseCase {
         switch feedbackType {
         case .general:
             return try shouldGeneralFeedbackBeVisible(currentDate: currentDate)
-        case .productsM5:
+        case .productsVariations:
             return shouldProductsFeedbackBeVisible()
         case .shippingLabelsRelease1:
             return shouldShippingLabelsRelease1FeedbackBeVisible()
@@ -66,7 +66,7 @@ struct InAppFeedbackCardVisibilityUseCase {
         return true
     }
 
-    /// Returns whether the productsM4 feedback request should be displayed
+    /// Returns whether the products feedback request should be displayed
     ///
     private func shouldProductsFeedbackBeVisible() -> Bool {
         return settings.feedbackStatus(of: feedbackType) == .pending