Attach params to PPro pixels

Core/DefaultVariantManager.swift

@@ -50,7 +50,7 @@ public struct VariantIOS: Variant {
     }
 
     /// This variant is used for returning users to separate them from really new users.
-    static let returningUser = VariantIOS(name: "ru", weight: doNotAllocate, isIncluded: When.always, features: [])
+    public static let returningUser = VariantIOS(name: "ru", weight: doNotAllocate, isIncluded: When.always, features: [])
 
     static let doNotAllocate = 0
 

DuckDuckGo.xcodeproj/project.pbxproj

@@ -724,6 +724,8 @@
 		BD862E0B2B30F9300073E2EE /* VPNFeedbackFormView.swift in Sources */ = {isa = PBXBuildFile; fileRef = BD862E0A2B30F9300073E2EE /* VPNFeedbackFormView.swift */; };
 		BDC234F72B27F51100D3C798 /* UniquePixel.swift in Sources */ = {isa = PBXBuildFile; fileRef = BDC234F62B27F51100D3C798 /* UniquePixel.swift */; };
 		BDD3B3552B8EF8DB005857A8 /* NetworkProtectionUNNotificationPresenter.swift in Sources */ = {isa = PBXBuildFile; fileRef = EE3766DD2AC5945500AAB575 /* NetworkProtectionUNNotificationPresenter.swift */; };
+		BDE219E62C406D19005D5884 /* PrivacyProDataReporting.swift in Sources */ = {isa = PBXBuildFile; fileRef = BDE219E52C406D19005D5884 /* PrivacyProDataReporting.swift */; };
+		BDE219EA2C457B46005D5884 /* PrivacyProDataReporterTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = BDE219E92C457B46005D5884 /* PrivacyProDataReporterTests.swift */; };
 		BDF8D0022C1B87F4003E3B27 /* NetworkProtectionDNSSettingsViewModel.swift in Sources */ = {isa = PBXBuildFile; fileRef = BDF8D0012C1B87F4003E3B27 /* NetworkProtectionDNSSettingsViewModel.swift */; };
 		BDFF031D2BA3D2BD00F324C9 /* DefaultNetworkProtectionVisibility.swift in Sources */ = {isa = PBXBuildFile; fileRef = BDFF031C2BA3D2BD00F324C9 /* DefaultNetworkProtectionVisibility.swift */; };
 		BDFF03212BA3D3CF00F324C9 /* NetworkProtectionVisibilityForTunnelProvider.swift in Sources */ = {isa = PBXBuildFile; fileRef = BDFF03202BA3D3CF00F324C9 /* NetworkProtectionVisibilityForTunnelProvider.swift */; };
@@ -2401,6 +2403,8 @@
 		BD862E082B30F63E0073E2EE /* VPNMetadataCollector.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = VPNMetadataCollector.swift; sourceTree = "<group>"; };
 		BD862E0A2B30F9300073E2EE /* VPNFeedbackFormView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = VPNFeedbackFormView.swift; sourceTree = "<group>"; };
 		BDC234F62B27F51100D3C798 /* UniquePixel.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = UniquePixel.swift; sourceTree = "<group>"; };
+		BDE219E52C406D19005D5884 /* PrivacyProDataReporting.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PrivacyProDataReporting.swift; sourceTree = "<group>"; };
+		BDE219E92C457B46005D5884 /* PrivacyProDataReporterTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = PrivacyProDataReporterTests.swift; sourceTree = "<group>"; };
 		BDF8D0012C1B87F4003E3B27 /* NetworkProtectionDNSSettingsViewModel.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = NetworkProtectionDNSSettingsViewModel.swift; sourceTree = "<group>"; };
 		BDFF03192BA39C5A00F324C9 /* NetworkProtectionFeatureVisibility.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = NetworkProtectionFeatureVisibility.swift; sourceTree = "<group>"; };
 		BDFF031C2BA3D2BD00F324C9 /* DefaultNetworkProtectionVisibility.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DefaultNetworkProtectionVisibility.swift; sourceTree = "<group>"; };
@@ -4753,6 +4757,7 @@
 				D664C7B02B289AA000CBFA76 /* UserScripts */,
 				D664C7962B289AA000CBFA76 /* Extensions */,
 				D65CEA6F2B6AC6C9008A759B /* Subscription.xcassets */,
+				BDE219E52C406D19005D5884 /* PrivacyProDataReporting.swift */,
 			);
 			path = Subscription;
 			sourceTree = "<group>";
@@ -5501,6 +5506,7 @@
 		F1BDDBFC2C340D9C00459306 /* Subscription */ = {
 			isa = PBXGroup;
 			children = (
+				BDE219E92C457B46005D5884 /* PrivacyProDataReporterTests.swift */,
 				F1BDDBF92C340D9C00459306 /* SubscriptionContainerViewModelTests.swift */,
 				F1BDDBFA2C340D9C00459306 /* SubscriptionFlowViewModelTests.swift */,
 				F1BDDBFB2C340D9C00459306 /* SubscriptionPagesUseSubscriptionFeatureTests.swift */,
@@ -7057,6 +7063,7 @@
 				F1D796F01E7B07610019D451 /* BookmarksViewControllerCells.swift in Sources */,
 				9F9EE4D42C37BB1300D4118E /* OnboardingView+Landing.swift in Sources */,
 				85058369219F424500ED4EDB /* UIColorExtension.swift in Sources */,
+				BDE219E62C406D19005D5884 /* PrivacyProDataReporting.swift in Sources */,
 				D6E83C312B1EA309006C8AFB /* SettingsCell.swift in Sources */,
 				85058368219C49E000ED4EDB /* HomeViewSectionRenderers.swift in Sources */,
 				1DEAADEE2BA45DFE00E25A97 /* SettingsDataClearingView.swift in Sources */,
@@ -7221,6 +7228,7 @@
 				F1134EBC1F40D45700B73467 /* MockStatisticsStore.swift in Sources */,
 				983C52E72C2C0ACB007B5747 /* BookmarkStateRepairTests.swift in Sources */,
 				31C138AC27A403CB00FFD4B2 /* DownloadManagerTests.swift in Sources */,
+				BDE219EA2C457B46005D5884 /* PrivacyProDataReporterTests.swift in Sources */,
 				EEFE9C732A603CE9005B0A26 /* NetworkProtectionStatusViewModelTests.swift in Sources */,
 				F13B4BF91F18CA0600814661 /* TabsModelTests.swift in Sources */,
 				F1BDDBFD2C340D9C00459306 /* SubscriptionContainerViewModelTests.swift in Sources */,

DuckDuckGo/AppDelegate.swift

@@ -92,6 +92,8 @@ import WebKit
 
     private var autofillPixelReporter: AutofillPixelReporter?
 
+    var privacyProDataReporter: PrivacyProDataReporting!
+
     // MARK: lifecycle
 
     @UserDefaultsWrapper(key: .privacyConfigCustomURL, defaultValue: nil)
@@ -272,6 +274,8 @@ import WebKit
         syncService.initializeIfNeeded()
         self.syncService = syncService
 
+        privacyProDataReporter = PrivacyProDataReporter()
+
         isSyncInProgressCancellable = syncService.isSyncInProgressPublisher
             .filter { $0 }
             .sink { [weak syncService] _ in
@@ -297,12 +301,15 @@ import WebKit
         remoteMessagingClient.registerBackgroundRefreshTaskHandler()
 
         homePageConfiguration = HomePageConfiguration(variantManager: AppDependencyProvider.shared.variantManager,
-                                                      remoteMessagingClient: remoteMessagingClient)
+                                                      remoteMessagingClient: remoteMessagingClient,
+                                                      privacyProDataReporter: privacyProDataReporter)
 
         let previewsSource = TabPreviewsSource()
         let historyManager = makeHistoryManager()
         let tabsModel = prepareTabsModel(previewsSource: previewsSource)
 
+        privacyProDataReporter.injectTabsModel(tabsModel)
+
         let main = MainViewController(bookmarksDatabase: bookmarksDatabase,
                                       bookmarksDatabaseCleaner: syncDataProviders.bookmarksAdapter.databaseCleaner,
                                       historyManager: historyManager,
@@ -312,7 +319,8 @@ import WebKit
                                       appSettings: AppDependencyProvider.shared.appSettings,
                                       previewsSource: previewsSource,
                                       tabsModel: tabsModel,
-                                      syncPausedStateManager: syncErrorHandler)
+                                      syncPausedStateManager: syncErrorHandler,
+                                      privacyProDataReporter: privacyProDataReporter)
 
         main.loadViewIfNeeded()
         syncErrorHandler.alertPresenter = main
@@ -510,6 +518,9 @@ import WebKit
         }
 
         syncService.scheduler.notifyAppLifecycleEvent()
+
+        privacyProDataReporter.injectSyncService(syncService)
+
         fireFailedCompilationsPixelIfNeeded()
 
 #if NETWORK_PROTECTION
@@ -536,6 +547,10 @@ import WebKit
 
         let importPasswordsStatusHandler = ImportPasswordsStatusHandler(syncService: syncService)
         importPasswordsStatusHandler.checkSyncSuccessStatus()
+
+        Task {
+            await privacyProDataReporter.saveWidgetAdded()
+        }
     }
 
     private func stopAndRemoveVPNIfNotAuthenticated() async {
@@ -646,6 +661,7 @@ import WebKit
         AppDependencyProvider.shared.autofillLoginSession.endSession()
         suspendSync()
         syncDataProviders.bookmarksAdapter.cancelFaviconsFetching(application)
+        privacyProDataReporter.saveApplicationLastSessionEnded()
     }
 
     private func suspendSync() {

DuckDuckGo/HomeCollectionView.swift

@@ -87,7 +87,8 @@ class HomeCollectionView: UICollectionView {
                 renderers.install(renderer: renderer)
 
             case .homeMessage:
-                renderers.install(renderer: HomeMessageViewSectionRenderer(homePageConfiguration: homePageConfiguration))
+                renderers.install(renderer: HomeMessageViewSectionRenderer(homePageConfiguration: homePageConfiguration,
+                                                                           privacyProDataReporter: controller.privacyProDataReporter))
             }
 
         }

DuckDuckGo/HomeMessageCollectionViewCell.swift

@@ -26,7 +26,7 @@ final class HomeMessageCollectionViewCell: SwiftUICollectionViewCell<HomeMessage
     static let maximumWidthPad: CGFloat = 455
 
     static var reuseIdentifier = "HomeMessageCell"
-    
+
     func configure(with viewModel: HomeMessageViewModel, parent: UIViewController) {
         embed(in: parent, withView: HomeMessageView(viewModel: viewModel))
         host?.view.frame = contentView.bounds

DuckDuckGo/HomeMessageView.swift

@@ -175,12 +175,12 @@ struct HomeMessageView: View {
             .padding([.bottom], Const.Padding.buttonVerticalInset)
             .sheet(item: $activityItem) { activityItem in
                 ActivityViewController(activityItems: [activityItem.item]) { _, result, _, _ in
-
-                    Pixel.fire(pixel: .remoteMessageSheet, withAdditionalParameters: [
+                    var additionalParameters = [
                         PixelParameters.message: "\(viewModel.messageId)",
                         PixelParameters.sheetResult: "\(result)"
-                    ])
-
+                    ]
+                    additionalParameters = viewModel.onAttachAdditionalParameters?(.messageID(viewModel.messageId), additionalParameters) ?? additionalParameters
+                    Pixel.fire(pixel: .remoteMessageSheet, withAdditionalParameters: additionalParameters)
                 }
                 .modifier(ActivityViewPresentationModifier())
             }
@@ -329,27 +329,27 @@ struct HomeMessageView_Previews: PreviewProvider {
             HomeMessageView(viewModel: HomeMessageViewModel(messageId: "Small",
                                                             sendPixels: false,
                                                             modelType: small,
-                                                            onDidClose: { _ in }, onDidAppear: {}))
+                                                            onDidClose: { _ in }, onDidAppear: {}, onAttachAdditionalParameters: { _, params in params }))
 
             HomeMessageView(viewModel: HomeMessageViewModel(messageId: "Critical",
                                                             sendPixels: false,
                                                             modelType: critical,
-                                                            onDidClose: { _ in }, onDidAppear: {}))
+                                                            onDidClose: { _ in }, onDidAppear: {}, onAttachAdditionalParameters: { _, params in params }))
 
             HomeMessageView(viewModel: HomeMessageViewModel(messageId: "Big Single",
                                                             sendPixels: false,
                                                             modelType: bigSingle,
-                                                            onDidClose: { _ in }, onDidAppear: {}))
+                                                            onDidClose: { _ in }, onDidAppear: {}, onAttachAdditionalParameters: { _, params in params }))
 
             HomeMessageView(viewModel: HomeMessageViewModel(messageId: "Big Two",
                                                             sendPixels: false,
                                                             modelType: bigTwo,
-                                                            onDidClose: { _ in }, onDidAppear: {}))
+                                                            onDidClose: { _ in }, onDidAppear: {}, onAttachAdditionalParameters: { _, params in params }))
 
             HomeMessageView(viewModel: HomeMessageViewModel(messageId: "Promo",
                                                             sendPixels: false,
                                                             modelType: promo,
-                                                            onDidClose: { _ in }, onDidAppear: {}))
+                                                            onDidClose: { _ in }, onDidAppear: {}, onAttachAdditionalParameters: { _, params in params }))
         }
         .frame(height: 200)
         .padding(.horizontal)

DuckDuckGo/HomeMessageViewModel.swift

@@ -125,6 +125,7 @@ struct HomeMessageViewModel {
 
     let onDidClose: (ButtonAction?) -> Void
     let onDidAppear: () -> Void
+    let onAttachAdditionalParameters: ((_ useCase: PrivacyProDataReportingUseCase, _ params: [String: String]) -> [String: String])?
 
     func mapActionToViewModel(remoteAction: RemoteAction,
                               buttonAction: HomeMessageViewModel.ButtonAction,

DuckDuckGo/HomeMessageViewModelBuilder.swift

@@ -33,6 +33,7 @@ struct HomeMessageViewModelBuilder {
     }
 
     static func build(for remoteMessage: RemoteMessageModel,
+                      with privacyProDataReporter: PrivacyProDataReporting?,
                       onDidClose: @escaping (HomeMessageViewModel.ButtonAction?) -> Void,
                       onDidAppear: @escaping () -> Void) -> HomeMessageViewModel? {
             guard let content = remoteMessage.content else { return nil }
@@ -42,7 +43,10 @@ struct HomeMessageViewModelBuilder {
             sendPixels: remoteMessage.isMetricsEnabled,
             modelType: content,
             onDidClose: onDidClose,
-            onDidAppear: onDidAppear
+            onDidAppear: onDidAppear,
+            onAttachAdditionalParameters: { useCase, params in
+                privacyProDataReporter?.mergeRandomizedParameters(for: useCase, with: params) ?? params
+            }
         )
     }
 

DuckDuckGo/HomeMessageViewSectionRenderer.swift

@@ -42,12 +42,14 @@ class HomeMessageViewSectionRenderer: NSObject, HomeViewSectionRenderer {
     private weak var controller: HomeViewController?
 
     private let homePageConfiguration: HomePageConfiguration
-
-    init(homePageConfiguration: HomePageConfiguration) {
+    private let privacyProDataReporter: PrivacyProDataReporting?
+
+    init(homePageConfiguration: HomePageConfiguration, privacyProDataReporter: PrivacyProDataReporting?) {
         self.homePageConfiguration = homePageConfiguration
+        self.privacyProDataReporter = privacyProDataReporter
         super.init()
     }
-    
+
     func install(into controller: HomeViewController) {
         self.controller = controller
         hideLogoIfThereAreMessagesToDisplay()
@@ -113,12 +115,13 @@ class HomeMessageViewSectionRenderer: NSObject, HomeViewSectionRenderer {
                 self?.dismissHomeMessage(message, at: indexPath, in: collectionView)
             } onDidAppear: {
                 // no-op
+            } onAttachAdditionalParameters: { _, params in
+                params
             }
         case .remoteMessage(let remoteMessage):
-            return HomeMessageViewModelBuilder.build(for: remoteMessage) { [weak self] action in
-
+            return HomeMessageViewModelBuilder.build(for: remoteMessage, with: privacyProDataReporter) { [weak self] action in
                 guard let action,
-                        let self else { return }
+                      let self else { return }
 
                 switch action {
 
@@ -128,7 +131,7 @@ class HomeMessageViewSectionRenderer: NSObject, HomeViewSectionRenderer {
                     }
                     if remoteMessage.isMetricsEnabled {
                         Pixel.fire(pixel: .remoteMessageActionClicked,
-                                   withAdditionalParameters: [PixelParameters.message: "\(remoteMessage.id)"])
+                                   withAdditionalParameters: self.additionalParameters(for: remoteMessage.id))
                     }
 
                 case .primaryAction(let isSharing):
@@ -137,7 +140,7 @@ class HomeMessageViewSectionRenderer: NSObject, HomeViewSectionRenderer {
                     }
                     if remoteMessage.isMetricsEnabled {
                         Pixel.fire(pixel: .remoteMessagePrimaryActionClicked,
-                                   withAdditionalParameters: [PixelParameters.message: "\(remoteMessage.id)"])
+                                   withAdditionalParameters: self.additionalParameters(for: remoteMessage.id))
                     }
 
                 case .secondaryAction(let isSharing):
@@ -146,14 +149,14 @@ class HomeMessageViewSectionRenderer: NSObject, HomeViewSectionRenderer {
                     }
                     if remoteMessage.isMetricsEnabled {
                         Pixel.fire(pixel: .remoteMessageSecondaryActionClicked,
-                                   withAdditionalParameters: [PixelParameters.message: "\(remoteMessage.id)"])
+                                   withAdditionalParameters: self.additionalParameters(for: remoteMessage.id))
                     }
 
                 case .close:
                     self.dismissHomeMessage(message, at: indexPath, in: collectionView)
                     if remoteMessage.isMetricsEnabled {
                         Pixel.fire(pixel: .remoteMessageDismissed,
-                                   withAdditionalParameters: [PixelParameters.message: "\(remoteMessage.id)"])
+                                   withAdditionalParameters: self.additionalParameters(for: remoteMessage.id))
                     }
 
                 }
@@ -162,7 +165,13 @@ class HomeMessageViewSectionRenderer: NSObject, HomeViewSectionRenderer {
             }
         }
     }
-
+
+    private func additionalParameters(for messageID: String) -> [String: String] {
+        let defaultParameters = [PixelParameters.message: "\(messageID)"]
+        return privacyProDataReporter?.mergeRandomizedParameters(for: .messageID(messageID),
+                                                                 with: defaultParameters) ?? defaultParameters
+    }
+
     private func dismissHomeMessage(_ message: HomeMessage,
                                     at indexPath: IndexPath,
                                     in collectionView: UICollectionView) {