Merge branch 'main' into T376073-donate-slide

# Conflicts: # WMFComponents/Sources/WMFComponents/Components/Year in Review/WMFYearInReviewView.swift # WMFComponents/Sources/WMFComponents/Components/Year in Review/WMFYearInReviewViewModel.swift
wikimedia · Oct 29, 2024 · ac5af98 · ac5af98
2 parents 583cf62 + d4cab24
commit ac5af98
Show file tree

Hide file tree

Showing 16 changed files with 214 additions and 36 deletions.
diff --git a/WMF Framework/LocationManager.swift b/WMF Framework/LocationManager.swift
@@ -186,7 +186,7 @@ extension LocationManager: CLLocationManagerDelegate {
 
         self.heading = heading
         delegate?.locationManager?(self, didUpdate: heading)
-        DDLogDebug("LocationManager - did update heading: \(heading).")
+        DDLogDebug("LocationManager - did update heading.")
     }
 
     public func locationManager(_ manager: CLLocationManager, didFailWithError error: Error) {

diff --git a/WMFComponents/Sources/WMFComponents/Components/Profile/WMFProfileViewModel.swift b/WMFComponents/Sources/WMFComponents/Components/Profile/WMFProfileViewModel.swift
@@ -178,6 +178,7 @@ enum ProfileState {
                 isLoadingDonateConfigs: false,
                 action: {
                     coordinatorDelegate?.handleProfileAction(.showYearInReview)
+                    coordinatorDelegate?.handleProfileAction(.logYearInReviewTap)
                 }
             )
 
@@ -261,6 +262,7 @@ enum ProfileState {
                 isLoadingDonateConfigs: false,
                 action: {
                     coordinatorDelegate?.handleProfileAction(.showYearInReview)
+                    coordinatorDelegate?.handleProfileAction(.logYearInReviewTap)
                 }
             )
 

diff --git a/...ces/WMFComponents/Components/Shared/Feature Announcement/WMFFeatureAnnouncementView.swift b/...ces/WMFComponents/Components/Shared/Feature Announcement/WMFFeatureAnnouncementView.swift
@@ -33,7 +33,9 @@ struct WMFFeatureAnnouncementView: View {
                             HStack {
                                 Spacer()
                                 Button(
-                                    action: { viewModel.closeButtonAction?() },
+                                    action: {
+                                        viewModel.closeButtonAction?()
+                                    },
                                     label: {
                                         closeImage
                                     })

diff --git a/WMFComponents/Sources/WMFComponents/Components/Year in Review/WMFSlideShow.swift b/WMFComponents/Sources/WMFComponents/Components/Year in Review/WMFSlideShow.swift
@@ -2,8 +2,8 @@ import SwiftUI
 
 public struct WMFSlideShow: View {
     @ObservedObject var appEnvironment = WMFAppEnvironment.current
-    @Binding private var currentSlide: Int
-    
+    @Binding public var currentSlide: Int
+
     var theme: WMFTheme {
         return appEnvironment.theme
     }

diff --git a/...ponents/Sources/WMFComponents/Components/Year in Review/WMFYearInReviewDonateButton.swift b/...ponents/Sources/WMFComponents/Components/Year in Review/WMFYearInReviewDonateButton.swift
@@ -12,7 +12,7 @@ struct WMFYearInReviewDonateButton: View {
 
     var body: some View {
         Button(action: {
-            viewModel.coordinatorDelegate?.handleYearInReviewAction(.donate(sourceRect: buttonRect))
+            viewModel.coordinatorDelegate?.handleYearInReviewAction(.donate(sourceRect: buttonRect, slideLoggingID: viewModel.slideLoggingID))
         }) {
 
             ZStack {

diff --git a/...ents/Year in Review/WMFYearInReview.swift → .../Year in Review/WMFYearInReviewView.swift b/...ents/Year in Review/WMFYearInReview.swift → .../Year in Review/WMFYearInReviewView.swift
@@ -1,6 +1,6 @@
 import SwiftUI
 
-public struct WMFYearInReview: View {
+public struct WMFYearInReviewView: View {
     @ObservedObject var appEnvironment = WMFAppEnvironment.current
     @ObservedObject var viewModel: WMFYearInReviewViewModel
 
@@ -26,6 +26,7 @@ public struct WMFYearInReview: View {
                     }
                     Spacer()
                     Button(action: {
+                        viewModel.logYearInReviewDidTapDone()
                         donePressed?()
                     }) {
                         Text(viewModel.localizedStrings.doneButtonTitle)
@@ -37,6 +38,9 @@ public struct WMFYearInReview: View {
                 if viewModel.isEdgeSlide && viewModel.currentSlide == 0 {
                     WMFYearInReviewScrollView(scrollViewContents: scrollViewContent, contents: { AnyView(buttonsFirstSlide) })
                         .frame(maxWidth: .infinity, maxHeight: .infinity)
+                        .onAppear {
+                            viewModel.logYearInReviewSlideDidAppear()
+                        }
                 } else if viewModel.isEdgeSlide {
                     if viewModel.hasDonated {
                         WMFYearInReviewScrollView(scrollViewContents: scrollViewContent)
@@ -64,9 +68,16 @@ public struct WMFYearInReview: View {
                     }
                     .ignoresSafeArea(edges: .bottom)
                     .frame(maxWidth: .infinity, maxHeight: .infinity)
+                    .onAppear {
+                        viewModel.logYearInReviewSlideDidAppear()
+                    }
                 }
             }
             .background(Color(uiColor: theme.midBackground))
+            .onChange(of: viewModel.currentSlide) { newSlide in
+                // Logs slide impressions and next taps
+                viewModel.logYearInReviewSlideDidAppear()
+            }
             .toolbar {
                 if viewModel.shouldShowToolbar() { 
                     ToolbarItem(placement: .bottomBar) {
@@ -97,7 +108,8 @@ public struct WMFYearInReview: View {
                             Spacer()
                             Button(action: {
                                 withAnimation {
-                                    viewModel.currentSlide = (viewModel.currentSlide + 1) % viewModel.slides.count
+                                    viewModel.logYearInReviewSlideDidTapNext()
+                                    viewModel.nextSlide()
                                 }
                             }) {
                                 Text(viewModel.shouldShowFinish() ? viewModel.localizedStrings.finishButtonTitle : viewModel.localizedStrings.nextButtonTitle)
@@ -165,10 +177,12 @@ public struct WMFYearInReview: View {
         VStack {
             WMFLargeButton(configuration: .primary, title: viewModel.localizedStrings.firstSlideCTA) {
                 withAnimation(.easeInOut(duration: 0.75)) {
+                    viewModel.loggingDelegate?.logYearInReviewIntroDidTapContinue()
                     viewModel.getStarted()
                 }
             }
             WMFSmallButton(configuration: configuration, title: viewModel.localizedStrings.firstSlideHide) {
+                viewModel.loggingDelegate?.logYearInReviewIntroDidTapDisable()
                 // TODO: Implement hide this feature
             }
         }

diff --git a/WMFComponents/Sources/WMFComponents/Components/Year in Review/WMFYearInReviewViewModel.swift b/WMFComponents/Sources/WMFComponents/Components/Year in Review/WMFYearInReviewViewModel.swift
@@ -1,36 +1,51 @@
 import Foundation
 import SwiftUI
 
+public protocol WMFYearInReviewLoggingDelegate: AnyObject {
+    func logYearInReviewIntroDidTapContinue()
+    func logYearInReviewIntroDidTapDisable()
+    func logYearInReviewSlideDidAppear(slideLoggingID: String)
+    func logYearInReviewDidTapDone(slideLoggingID: String)
+    func logYearInReviewDidTapNext(slideLoggingID: String)
+}
+
 public class WMFYearInReviewViewModel: ObservableObject {
+    @Published var isFirstSlide = true
+    @Published var currentSlide = 0
     // Edge slide refers to one at either the beginning or the end
     @Published var isEdgeSlide = true
     @Published var hasDonated = false
-    @Published var currentSlide = 0
 
     public let localizedStrings: LocalizedStrings
     var slides: [YearInReviewSlideContent]
     let username: String?
     public let shareLink: String
     public let hashtag: String
     weak var coordinatorDelegate: YearInReviewCoordinatorDelegate?
+    private(set) weak var loggingDelegate: WMFYearInReviewLoggingDelegate?
+
     @Published public var isLoading: Bool = false
-    private var isFirstSlide = true
 
-    public init(isEdgeSlide: Bool = true, localizedStrings: LocalizedStrings, slides: [YearInReviewSlideContent], username: String?, shareLink: String, hashtag: String, coordinatorDelegate: YearInReviewCoordinatorDelegate?, hasDonated: Bool = false) {
-        self.isEdgeSlide = isEdgeSlide
+    public init(isFirstSlide: Bool = true, localizedStrings: LocalizedStrings, slides: [YearInReviewSlideContent], username: String?, shareLink: String, hashtag: String, coordinatorDelegate: YearInReviewCoordinatorDelegate?, loggingDelegate: WMFYearInReviewLoggingDelegate, hasDonated: Bool = false) {
+        self.isFirstSlide = isFirstSlide
         self.localizedStrings = localizedStrings
         self.slides = slides
         self.username = username
         self.shareLink = shareLink
         self.hashtag = hashtag
         self.coordinatorDelegate = coordinatorDelegate
-        self.hasDonated = false
+		self.hasDonated = hasDonated
+        self.loggingDelegate = loggingDelegate
     }
 
     public func getStarted() {
         isEdgeSlide = false
         isFirstSlide = false
     }
+
+    public func nextSlide() {
+        currentSlide = (currentSlide + 1) % slides.count
+    }
 
     public struct LocalizedStrings {
         let donateButtonTitle: String
@@ -100,18 +115,36 @@ public class WMFYearInReviewViewModel: ObservableObject {
         let shareView = view.snapshot()
         coordinatorDelegate?.handleYearInReviewAction(.share(image: shareView))
     }
+
+    func logYearInReviewSlideDidAppear() {
+        loggingDelegate?.logYearInReviewSlideDidAppear(slideLoggingID: slideLoggingID)
+    }
+
+    public func logYearInReviewDidTapDone() {
+        loggingDelegate?.logYearInReviewDidTapDone(slideLoggingID: slideLoggingID)
+    }
+
+    func logYearInReviewSlideDidTapNext() {
+        loggingDelegate?.logYearInReviewDidTapNext(slideLoggingID: slideLoggingID)
+    }
+
+    var slideLoggingID: String {
+        return isFirstSlide ? "start" : slides[currentSlide].loggingID
+    }
 }
 
 public struct YearInReviewSlideContent: SlideShowProtocol {
     public let imageName: String
     public let title: String
     let informationBubbleText: String?
     public let subtitle: String
-
-    public init(imageName: String, title: String, informationBubbleText: String?, subtitle: String) {
+    public let loggingID: String
+
+    public init(imageName: String, title: String, informationBubbleText: String?, subtitle: String, loggingID: String) {
         self.imageName = imageName
         self.title = title
         self.informationBubbleText = informationBubbleText
         self.subtitle = subtitle
+        self.loggingID = loggingID
     }
 }
diff --git a/WMFComponents/Sources/WMFComponents/Coordinator/ProfileCoordinatorDelegate.swift b/WMFComponents/Sources/WMFComponents/Coordinator/ProfileCoordinatorDelegate.swift
@@ -17,4 +17,5 @@ public enum ProfileAction {
     case logout
     case logDonateTap
     case showYearInReview
+    case logYearInReviewTap
 }
diff --git a/WMFComponents/Sources/WMFComponents/Coordinator/YearInReviewCoordinatorDelegate.swift b/WMFComponents/Sources/WMFComponents/Coordinator/YearInReviewCoordinatorDelegate.swift
@@ -5,6 +5,6 @@ public protocol YearInReviewCoordinatorDelegate: AnyObject {
 }
 
 public enum YearInReviewCoordinatorAction {
-    case donate(sourceRect: CGRect)
+    case donate(sourceRect: CGRect, slideLoggingID: String)
     case share(image: UIImage)
 }
diff --git a/Wikipedia/Code/ArticleViewController+Announcements.swift b/Wikipedia/Code/ArticleViewController+Announcements.swift
@@ -156,13 +156,17 @@ extension ArticleViewController {
             else { return }
             yirCoordinator = YearInReviewCoordinator(navigationController: navController, theme: theme, dataStore: dataStore, dataController: yirDataController)
             yirCoordinator?.start()
+            DonateFunnel.shared.logYearInReviewFeatureAnnouncementDidTapContinue()
+        }, closeButtonAction: {
+            DonateFunnel.shared.logYearInReviewFeatureAnnouncementDidTapClose()
         })
 
         if navigationBar.superview != nil {
             let xOrigin = navigationBar.frame.width - 100
             let yOrigin = view.safeAreaInsets.top + navigationBar.barTopSpacing + 15
             let sourceRect = CGRect(x:  xOrigin, y: yOrigin, width: 30, height: 30)
             announceFeature(viewModel: viewModel, sourceView: self.view, sourceRect: sourceRect)
+            DonateFunnel.shared.logYearInReviewFeatureAnnouncementDidAppear()
         }
 
         yirDataController.hasPresentedYiRFeatureAnnouncementModel = true

diff --git a/Wikipedia/Code/DonateCoordinator.swift b/Wikipedia/Code/DonateCoordinator.swift
@@ -100,13 +100,19 @@ class DonateCoordinator: Coordinator {
         switch donateSource {
         case .articleCampaignModal(_, let metricsID, _):
             return metricsID
-        case .articleProfile, .exploreProfile, .settingsProfile, .yearInReview:
+        case .articleProfile, .exploreProfile, .settingsProfile:
             guard let languageCode,
                   let countryCode = Locale.current.region?.identifier else {
                 return nil
             }
 
             return "\(languageCode)\(countryCode)_appmenu_iOS"
+        case .yearInReview:
+            guard let languageCode,
+                  let countryCode = Locale.current.region?.identifier else {
+                return nil
+            }
+            return "\(languageCode)\(countryCode)_appmenu_yir_iOS"
         }
     }
 
@@ -179,7 +185,7 @@ class DonateCoordinator: Coordinator {
 
                 DonateFunnel.shared.logArticleDidTapCancel(project: project, metricsID: metricsID)
             case .yearInReview:
-                print("Year in review")
+                DonateFunnel.shared.logYearInReviewDidTapDonateCancel(metricsID: metricsID)
             }
         }))
 
@@ -203,7 +209,7 @@ class DonateCoordinator: Coordinator {
                }
                 DonateFunnel.shared.logArticleDidTapDonateWithApplePay(project: project, metricsID: metricsID)
             case .yearInReview:
-                print("Year in review")
+                DonateFunnel.shared.logYearInReviewDidTapDonateApplePay(metricsID: metricsID)
             }
             self.navigationController.dismiss(animated: true, completion: {
                 self.pushToNativeDonateForm(donateViewModel: donateViewModel)
@@ -231,7 +237,7 @@ class DonateCoordinator: Coordinator {
                 }
                 DonateFunnel.shared.logArticleDidTapOtherPaymentMethod(project: project, metricsID: metricsID)
             case .yearInReview:
-                print("Year in review")
+                DonateFunnel.shared.logYearInReviewDidTapDonateOtherPaymentMethod(metricsID: metricsID)
             }
             self.navigationController.dismiss(animated: true, completion: {
                 self.pushToOtherPaymentMethod()
@@ -589,7 +595,7 @@ extension DonateCoordinator: WMFDonateLoggingDelegate {
                 DonateFunnel.shared.logArticleCampaignDidSeeApplePayDonateSuccessToast(project: wikimediaProject, metricsID: metricsID)
             }
         case .yearInReview:
-            print("year in review")
+            DonateFunnel.shared.logYearInReviewDidSeeApplePayDonateSuccessToast(metricsID: metricsID)
         }
     }
 
@@ -661,10 +667,8 @@ extension DonateCoordinator: WMFDonateLoggingDelegate {
             }
 
             DonateFunnel.shared.logDonateFormInAppWebViewDidTapArticleReturnButton(project: wikimediaProject, metricsID: metricsID)
-        case .exploreProfile, .settingsProfile:
+        case .exploreProfile, .settingsProfile, .yearInReview:
             DonateFunnel.shared.logDonateFormInAppWebViewDidTapReturnButton(metricsID: metricsID)
-        case .yearInReview:
-            print("Year in review")
         }
     }
 
@@ -698,7 +702,7 @@ extension DonateCoordinator: WMFDonateLoggingDelegate {
             case .settingsProfile:
                 DonateFunnel.shared.logExploreOptOutProfileDidSeeApplePayDonateSuccessToast(metricsID: metricsID)
             case .yearInReview:
-                print("year in review")
+                DonateFunnel.shared.logYearInReviewDidSeeApplePayDonateSuccessToast(metricsID: metricsID)
             }
         }
     }