Merge pull request #18519 from wordpress-mobile/task/18389-all-tours-complete-notice

Quick Start for Existing Users: All tour complete notice

Author: momo-ozawa

WordPress/Classes/ViewRelated/Blog/Blog Dashboard/BlogDashboardViewController.swift

@@ -256,15 +256,16 @@ extension BlogDashboardViewController {
 
     private func showNoticeAsNeeded() {
         let quickStartGuide = QuickStartTourGuide.shared
+
         guard let tourToSuggest = quickStartGuide.tourToSuggest(for: blog) else {
+            quickStartGuide.showCongratsNoticeIfNeeded(for: blog)
             return
         }
 
         if quickStartGuide.tourInProgress {
             // If tour is in progress, show notice regardless of quickstart is shown in dashboard or my site
             quickStartGuide.suggest(tourToSuggest, for: blog)
-        }
-        else {
+        } else {
             guard shouldShowQuickStartChecklist() else {
                 return
             }

WordPress/Classes/ViewRelated/Blog/Blog Details/BlogDetailsViewController+FancyAlerts.swift

@@ -64,15 +64,16 @@ extension BlogDetailsViewController {
 
     private func showNoticeAsNeeded() {
         let quickStartGuide = QuickStartTourGuide.shared
+
         guard let tourToSuggest = quickStartGuide.tourToSuggest(for: blog) else {
+            quickStartGuide.showCongratsNoticeIfNeeded(for: blog)
             return
         }
 
         if quickStartGuide.tourInProgress {
             // If tour is in progress, show notice regardless of quickstart is shown in dashboard or my site
             quickStartGuide.suggest(tourToSuggest, for: blog)
-        }
-        else {
+        } else {
             guard shouldShowQuickStartChecklist() else {
                 return
             }

WordPress/Classes/ViewRelated/Blog/QuickStartTourGuide.swift

@@ -23,6 +23,9 @@ open class QuickStartTourGuide: NSObject {
     /// A flag indicating if the user is currently going through a tour or not.
     private(set) var tourInProgress = false
 
+    /// A flag indidcating whether we should show the congrats notice or not.
+    private var shouldShowCongratsNotice = false
+
     /// Represents the current entry point.
     @objc var currentEntryPoint: QuickStartTourEntryPoint = .unknown
 
@@ -229,6 +232,24 @@ open class QuickStartTourGuide: NSObject {
         completed(tour: tour, for: blog, postNotification: postNotification)
     }
 
+    func showCongratsNoticeIfNeeded(for blog: Blog) {
+        guard allToursCompleted(for: blog), shouldShowCongratsNotice else {
+            return
+        }
+
+        shouldShowCongratsNotice = false
+
+        let noticeStyle = QuickStartNoticeStyle(attributedMessage: nil, isDismissable: true)
+        let notice = Notice(title: Strings.congratulationsTitle,
+                            message: Strings.congratulationsMessage,
+                            style: noticeStyle,
+                            tag: noticeTag)
+
+        ActionDispatcher.dispatch(NoticeAction.post(notice))
+
+        WPAnalytics.track(.quickStartCongratulationsViewed)
+    }
+
     // we have this because poor stupid ObjC doesn't know what the heck an optional is
     @objc func currentElementInt() -> Int {
         return currentWaypoint()?.element.rawValue ?? NSNotFound
@@ -289,7 +310,10 @@ open class QuickStartTourGuide: NSObject {
 
         let noticeStyle = QuickStartNoticeStyle(attributedMessage: taskCompleteDescription, isDismissable: true)
         let notice = Notice(title: "", style: noticeStyle, tag: noticeTag)
-        ActionDispatcher.dispatch(NoticeAction.post(notice))
+
+        DispatchQueue.main.asyncAfter(deadline: .now() + Constants.quickStartDelay) {
+            ActionDispatcher.dispatch(NoticeAction.post(notice))
+        }
     }
 
     private func showNextStep(_ nextStep: TourState) {
@@ -344,15 +368,11 @@ private extension QuickStartTourGuide {
             recentlyTouredBlog = nil
         }
 
-        guard !(tour is QuickStartCongratulationsTour) else {
-            WPAnalytics.track(.quickStartCongratulationsViewed)
-            return
-        }
-
         if allToursCompleted(for: blog) {
             WPAnalytics.track(.quickStartAllToursCompleted)
             grantCongratulationsAward(for: blog)
             tourInProgress = false
+            shouldShowCongratsNotice = true
         } else {
             if let nextTour = tourToSuggest(for: blog) {
                 PushNotificationsManager.shared.postNotification(for: nextTour)
@@ -448,6 +468,11 @@ private extension QuickStartTourGuide {
         static let quickStartDelay: DispatchTimeInterval = .milliseconds(500)
         static let nextStepDelay: DispatchTimeInterval = .milliseconds(1000)
     }
+
+    private enum Strings {
+        static let congratulationsTitle = NSLocalizedString("Congrats! You know your way around", comment: "Title shown when all tours have been completed.")
+        static let congratulationsMessage = NSLocalizedString("Doesn't it feel good to cross things off a list?", comment: "Message shown when all tours have been completed")
+    }
 }
 
 internal extension NSNotification.Name {

WordPress/Classes/ViewRelated/Blog/QuickStartTours.swift

@@ -371,24 +371,6 @@ struct QuickStartNotificationsTour: QuickStartTour {
     let accessibilityHintText = NSLocalizedString("Guides you through the process of checking your notifications.", comment: "This value is used to set the accessibility hint text for viewing the user's notifications.")
 }
 
-private let congratsTitle = NSLocalizedString("Congrats on finishing Quick Start  🎉", comment: "Title of a Quick Start Tour")
-private let congratsDescription = NSLocalizedString("doesn’t it feel good to cross things off a list?", comment: "subhead shown to users when they complete all Quick Start items")
-struct QuickStartCongratulationsTour: QuickStartTour {
-    let key = "quick-start-congratulations-tour"
-    let analyticsKey = "congratulations"
-    let title = congratsTitle
-    let titleMarkedCompleted = ""  // Not applicable for this tour type
-    let description = congratsDescription
-    let icon = UIImage.gridicon(.plus)
-    let suggestionNoText = Strings.notNow
-    let suggestionYesText = Strings.yesShowMe
-    let possibleEntryPoints: Set<QuickStartTourEntryPoint> = [.blogDetails, .blogDashboard]
-
-    var waypoints: [QuickStartTour.WayPoint] = [(element: .congratulations, description: NSAttributedString(string: congratsTitle))]
-
-    let accessibilityHintText = ""  // Not applicable for this tour type
-}
-
 private extension String {
     func highlighting(phrase: String, icon: UIImage?) -> NSAttributedString {
         let normalParts = components(separatedBy: "%@")