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 /* PrivacyProDataReporter.swift in Sources */ = {isa = PBXBuildFile; fileRef = BDE219E52C406D19005D5884 /* PrivacyProDataReporter.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 /* PrivacyProDataReporter.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PrivacyProDataReporter.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 /* PrivacyProDataReporter.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 /* PrivacyProDataReporter.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 */,
@@ -10186,7 +10194,7 @@
 			repositoryURL = "https://github.com/DuckDuckGo/BrowserServicesKit";
 			requirement = {
 				kind = exactVersion;
-				version = 174.0.1;
+				version = 174.1.0;
 			};
 		};
 		9F8FE9472BAE50E50071E372 /* XCRemoteSwiftPackageReference "lottie-spm" */ = {

DuckDuckGo.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved

@@ -32,8 +32,8 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/DuckDuckGo/BrowserServicesKit",
       "state" : {
-        "revision" : "63195a30b02e05d1b7176c76ebc55c2cff66c9c8",
-        "version" : "174.0.1"
+        "revision" : "79f6d4c11d6f832e2c5cc00ac815ffb181aab911",
+        "version" : "174.1.0"
       }
     },
     {

DuckDuckGo/AppDelegate.swift

@@ -309,6 +309,8 @@ import WebKit
         let historyManager = makeHistoryManager()
         let tabsModel = prepareTabsModel(previewsSource: previewsSource)
 
+        PrivacyProDataReporter.shared.injectTabsModel(tabsModel)
+
         let main = MainViewController(bookmarksDatabase: bookmarksDatabase,
                                       bookmarksDatabaseCleaner: syncDataProviders.bookmarksAdapter.databaseCleaner,
                                       historyManager: historyManager,
@@ -516,6 +518,9 @@ import WebKit
         }
 
         syncService.scheduler.notifyAppLifecycleEvent()
+
+        PrivacyProDataReporter.shared.injectSyncService(syncService)
+
         fireFailedCompilationsPixelIfNeeded()
 
 #if NETWORK_PROTECTION
@@ -542,6 +547,10 @@ import WebKit
 
         let importPasswordsStatusHandler = ImportPasswordsStatusHandler(syncService: syncService)
         importPasswordsStatusHandler.checkSyncSuccessStatus()
+
+        Task {
+            await PrivacyProDataReporter.shared.saveWidgetAdded()
+        }
     }
 
     private func stopAndRemoveVPNIfNotAuthenticated() async {
@@ -652,6 +661,7 @@ import WebKit
         AppDependencyProvider.shared.autofillLoginSession.endSession()
         suspendSync()
         syncDataProviders.bookmarksAdapter.cancelFaviconsFetching(application)
+        PrivacyProDataReporter.shared.saveApplicationLastSessionEnded()
     }
 
     private func suspendSync() {

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: [
+                    let additionalParameters = PrivacyProDataReporter.shared.mergeRandomizedParameters(for: .messageID(viewModel.messageId), with: [
                         PixelParameters.message: "\(viewModel.messageId)",
                         PixelParameters.sheetResult: "\(result)"
                     ])
 
+                    Pixel.fire(pixel: .remoteMessageSheet, withAdditionalParameters: additionalParameters)
                 }
                 .modifier(ActivityViewPresentationModifier())
             }

DuckDuckGo/HomeMessageViewSectionRenderer.swift

@@ -116,9 +116,8 @@ class HomeMessageViewSectionRenderer: NSObject, HomeViewSectionRenderer {
             }
         case .remoteMessage(let remoteMessage):
             return HomeMessageViewModelBuilder.build(for: remoteMessage) { [weak self] action in
-
                 guard let action,
-                        let self else { return }
+                      let self else { return }
 
                 switch action {
 
@@ -128,7 +127,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 +136,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 +145,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 +161,12 @@ class HomeMessageViewSectionRenderer: NSObject, HomeViewSectionRenderer {
             }
         }
     }
-
+
+    private func additionalParameters(for messageID: String) -> [String: String] {
+        PrivacyProDataReporter.shared.mergeRandomizedParameters(for: .messageID(messageID),
+                                                                       with: [PixelParameters.message: "\(messageID)"])
+    }
+
     private func dismissHomeMessage(_ message: HomeMessage,
                                     at indexPath: IndexPath,
                                     in collectionView: UICollectionView) {

DuckDuckGo/HomePageConfiguration.swift

@@ -94,20 +94,19 @@ final class HomePageConfiguration: HomePageMessagesConfiguration {
     }
 
     func didAppear(_ homeMessage: HomeMessage) {
-
         switch homeMessage {
         case .remoteMessage(let remoteMessage):
             os_log("Remote message shown: %s", log: .remoteMessaging, type: .info, remoteMessage.id)
             if remoteMessage.isMetricsEnabled {
                 Pixel.fire(pixel: .remoteMessageShown,
-                           withAdditionalParameters: [PixelParameters.message: "\(remoteMessage.id)"])
+                           withAdditionalParameters: additionalParameters(for: remoteMessage.id))
             }
 
             if !remoteMessagingClient.store.hasShownRemoteMessage(withID: remoteMessage.id) {
                 os_log("Remote message shown for first time: %s", log: .remoteMessaging, type: .info, remoteMessage.id)
                 if remoteMessage.isMetricsEnabled {
                     Pixel.fire(pixel: .remoteMessageShownUnique,
-                               withAdditionalParameters: [PixelParameters.message: "\(remoteMessage.id)"])
+                               withAdditionalParameters: additionalParameters(for: remoteMessage.id))
                 }
                 remoteMessagingClient.store.updateRemoteMessage(withID: remoteMessage.id, asShown: true)
             }
@@ -117,4 +116,9 @@ final class HomePageConfiguration: HomePageMessagesConfiguration {
         }
 
     }
+
+    private func additionalParameters(for messageID: String) -> [String: String] {
+        PrivacyProDataReporter.shared.mergeRandomizedParameters(for: .messageID(messageID),
+                                                                       with: [PixelParameters.message: "\(messageID)"])
+    }
 }

DuckDuckGo/MainViewController.swift

@@ -2504,6 +2504,8 @@ extension MainViewController: AutoClearWorker {
             transitionCompletion?()
             self.refreshUIAfterClear()
         } completion: {
+            PrivacyProDataReporter.shared.saveFireCount()
+
             // Ideally this should happen once data clearing has finished AND the animation is finished
             if showNextDaxDialog {
                 self.homeController?.showNextDaxDialog()

DuckDuckGo/NewTabPageMessagesModel.swift

@@ -80,9 +80,8 @@ final class NewTabPageMessagesModel: ObservableObject {
             }
         case .remoteMessage(let remoteMessage):
             return HomeMessageViewModelBuilder.build(for: remoteMessage) { [weak self] action in
-
                 guard let action,
-                        let self else { return }
+                      let self else { return }
 
                 switch action {
 
@@ -92,7 +91,7 @@ final class NewTabPageMessagesModel: ObservableObject {
                     }
                     if remoteMessage.isMetricsEnabled {
                         pixelFiring.fire(.remoteMessageActionClicked,
-                                         withAdditionalParameters: [PixelParameters.message: "\(remoteMessage.id)"])
+                                         withAdditionalParameters: self.additionalParameters(for: remoteMessage.id))
                     }
 
                 case .primaryAction(let isSharing):
@@ -101,7 +100,7 @@ final class NewTabPageMessagesModel: ObservableObject {
                     }
                     if remoteMessage.isMetricsEnabled {
                         pixelFiring.fire(.remoteMessagePrimaryActionClicked,
-                                         withAdditionalParameters: [PixelParameters.message: "\(remoteMessage.id)"])
+                                         withAdditionalParameters: self.additionalParameters(for: remoteMessage.id))
                     }
 
                 case .secondaryAction(let isSharing):
@@ -110,14 +109,14 @@ final class NewTabPageMessagesModel: ObservableObject {
                     }
                     if remoteMessage.isMetricsEnabled {
                         pixelFiring.fire(.remoteMessageSecondaryActionClicked,
-                                         withAdditionalParameters: [PixelParameters.message: "\(remoteMessage.id)"])
+                                         withAdditionalParameters: self.additionalParameters(for: remoteMessage.id))
                     }
 
                 case .close:
                     self.dismissHomeMessage(message)
                     if remoteMessage.isMetricsEnabled {
                         pixelFiring.fire(.remoteMessageDismissed,
-                                         withAdditionalParameters: [PixelParameters.message: "\(remoteMessage.id)"])
+                                         withAdditionalParameters: self.additionalParameters(for: remoteMessage.id))
                     }
 
                 }
@@ -126,4 +125,9 @@ final class NewTabPageMessagesModel: ObservableObject {
             }
         }
     }
+
+    private func additionalParameters(for messageID: String) -> [String: String] {
+        PrivacyProDataReporter.shared.mergeRandomizedParameters(for: .messageID(messageID),
+                                                                       with: [PixelParameters.message: "\(messageID)"])
+    }
 }