Remote Messaging (#1263)

Implementation of Remote Messaging functionality

Author: amddg44

Core/APIHeaders.swift

@@ -18,6 +18,7 @@
 //
 
 import Foundation
+import BrowserServicesKit
 
 public typealias HTTPHeaders = [String: String]
 

Core/AppUrls.swift

@@ -53,6 +53,8 @@ public struct AppUrls {
 
         static var emailProtectionLink = "https://duckduckgo.com/email"
         static var emailProtectionQuickLink = "ddgQuickLink://https://duckduckgo.com/email"
+
+        static let appStore = "https://apps.apple.com/app/duckduckgo-privacy-browser/id663592361"
     }
 
     private enum DDGStaticURL: String {
@@ -299,6 +301,10 @@ public struct AppUrls {
         return URL(string: "https://duckduckgo.com/mac")!
     }
 
+    public var appStoreURL: URL {
+        return URL(string: Url.appStore)!
+    }
+
     public func pixelUrl(forPixelNamed pixelName: String, formFactor: String? = nil, includeATB: Bool = true) -> URL {
         var urlString = Url.pixel.format(arguments: pixelName)
         if let formFactor = formFactor {

Core/AppVersion.swift

@@ -19,6 +19,7 @@
 
 import Foundation
 import Core
+import BrowserServicesKit
 
 public class AtbAndVariantCleanup {
 

Core/AtbAndVariantCleanup.swift

@@ -76,6 +76,18 @@ public class BookmarksCachingSearch {
         return cachedBookmarksAndFavorites ?? []
     }
 
+	public var bookmarksCount: Int {
+		let bookmarksAndFavorites = bookmarksAndFavorites
+		let bookmarksOnly = bookmarksAndFavorites.filter { !$0.isFavorite }
+		return bookmarksOnly.count
+	}
+
+	public var favoritesCount: Int {
+		let bookmarksAndFavorites = bookmarksAndFavorites
+		let favoritesOnly = bookmarksAndFavorites.filter { $0.isFavorite }
+		return favoritesOnly.count
+	}
+
     public func containsDomain(_ domain: String) -> Bool {
         return bookmarksAndFavorites.contains { $0.url?.host == domain }
     }

Core/BookmarksCachingSearch.swift

@@ -1,5 +1,5 @@
 //
-//  VariantManager.swift
+//  DefaultVariantManager.swift
 //  DuckDuckGo
 //
 //  Copyright © 2017 DuckDuckGo. All rights reserved.
@@ -20,14 +20,10 @@
 import Foundation
 import os.log
 import Speech
+import BrowserServicesKit
 
-public enum FeatureName: String {
 
-    // Used for unit tests
-    case dummy
-}
-
-public struct Variant {
+public struct VariantIOS: Variant {
 
     struct When {
         static let always = { return true }
@@ -53,16 +49,16 @@ public struct Variant {
     public static let defaultVariants: [Variant] = [
 
         // SERP testing
-        Variant(name: "sc", weight: doNotAllocate, isIncluded: When.always, features: []),
-        Variant(name: "sd", weight: doNotAllocate, isIncluded: When.always, features: []),
-        Variant(name: "se", weight: doNotAllocate, isIncluded: When.always, features: [])
+        VariantIOS(name: "sc", weight: doNotAllocate, isIncluded: When.always, features: []),
+        VariantIOS(name: "sd", weight: doNotAllocate, isIncluded: When.always, features: []),
+        VariantIOS(name: "se", weight: doNotAllocate, isIncluded: When.always, features: [])
 
     ]
 
-    public let name: String
-    public let weight: Int
-    public let isIncluded: () -> Bool
-    public let features: [FeatureName]
+    public var name: String
+    public var weight: Int
+    public var isIncluded: () -> Bool
+    public var features: [FeatureName]
 
 }
 
@@ -72,14 +68,6 @@ public protocol VariantRNG {
 
 }
 
-public protocol VariantManager {
-    
-    var currentVariant: Variant? { get }
-    func assignVariantIfNeeded(_ newInstallCompletion: (VariantManager) -> Void)
-    func isSupported(feature: FeatureName) -> Bool
-    
-}
-
 public class DefaultVariantManager: VariantManager {
 
     public var currentVariant: Variant? {
@@ -91,7 +79,7 @@ public class DefaultVariantManager: VariantManager {
     private let storage: StatisticsStore
     private let rng: VariantRNG
 
-    public init(variants: [Variant] = Variant.defaultVariants,
+    public init(variants: [Variant] = VariantIOS.defaultVariants,
                 storage: StatisticsStore = StatisticsUserDefaults(),
                 rng: VariantRNG = Arc4RandomUniformVariantRNG()) {
         self.variants = variants

Core/VariantManager.swift Core/DefaultVariantManager.swiftCore/VariantManager.swift renamed to Core/DefaultVariantManager.swift

@@ -19,6 +19,7 @@
 
 import Foundation
 import os.log
+import BrowserServicesKit
 
 public let generalLog: OSLog = OSLog(subsystem: Bundle.main.bundleIdentifier ?? AppVersion.shared.identifier, category: "DDG General")
 public let contentBlockingLog: OSLog = OSLog(subsystem: Bundle.main.bundleIdentifier ?? AppVersion.shared.identifier,

Core/Logging.swift

@@ -19,6 +19,7 @@
 
 import Foundation
 import os.log
+import BrowserServicesKit
 
 // swiftlint:enable type_body_length
 // swiftlint:enable identifier_name
@@ -94,8 +95,10 @@ public struct PixelParameters {
     public static let emailKeychainAccessType = "access_type"
     public static let emailKeychainError = "error"
     public static let emailKeychainKeychainStatus = "keychain_status"
-    
+
     public static let bookmarkErrorOrphanedFolderCount = "bookmark_error_orphaned_count"
+
+    public static let ctaShown = "cta"
 }
 
 public struct PixelValues {

Core/Pixel.swift

@@ -253,6 +253,14 @@ extension Pixel {
 
         case macBrowserWaitlistNotificationShown
         case macBrowserWaitlistNotificationLaunched
+
+        // MARK: remote messaging pixels
+
+        case remoteMessageShown
+        case remoteMessageShownUnique
+        case remoteMessageDismissed
+        case remoteMessageShownPrimaryActionClicked
+        case remoteMessageShownSecondaryActionClicked
 
         // MARK: debug pixels
 
@@ -263,7 +271,13 @@ extension Pixel {
         case dbInitializationError
         case dbSaveExcludedHTTPSDomainsError
         case dbSaveBloomFilterError
-        
+        case dbRemoteMessagingSaveConfigError
+        case dbRemoteMessagingInvalidateConfigError
+        case dbRemoteMessagingSaveMessageError
+        case dbRemoteMessagingUpdateMessageShownError
+        case dbRemoteMessagingUpdateMessageStatusError
+        case dbRemoteMessagingDeleteScheduledMessageError
+
         case configurationFetchInfo
 
         case trackerDataParseFailed
@@ -569,7 +583,15 @@ extension Pixel.Event {
 
         case .macBrowserWaitlistNotificationShown: return "m_notification_shown_mac_waitlist"
         case .macBrowserWaitlistNotificationLaunched: return "m_notification_launch_mac_waitlist"
-            
+
+        // MARK: remote messaging pixels
+
+        case .remoteMessageShown: return "m_remote_message_shown"
+        case .remoteMessageShownUnique: return "m_remote_message_shown_unique"
+        case .remoteMessageDismissed: return "m_remote_message_dismissed"
+        case .remoteMessageShownPrimaryActionClicked: return "m_remote_message_primary_action_clicked"
+        case .remoteMessageShownSecondaryActionClicked: return "m_remote_message_secondary_action_clicked"
+
         // MARK: debug pixels
 
         case .dbMigrationError: return "m_d_dbme"
@@ -579,7 +601,13 @@ extension Pixel.Event {
         case .dbInitializationError: return "m_d_dbie"
         case .dbSaveExcludedHTTPSDomainsError: return "m_d_dbsw"
         case .dbSaveBloomFilterError: return "m_d_dbsb"
-            
+        case .dbRemoteMessagingSaveConfigError: return "m_d_db_rm_save_config"
+        case .dbRemoteMessagingInvalidateConfigError: return "m_d_db_rm_invalidate_config"
+        case .dbRemoteMessagingSaveMessageError: return "m_d_db_rm_save_message"
+        case .dbRemoteMessagingUpdateMessageShownError: return "m_d_db_rm_update_message_shown"
+        case .dbRemoteMessagingUpdateMessageStatusError: return "m_d_db_rm_update_message_status"
+        case .dbRemoteMessagingDeleteScheduledMessageError: return "m_d_db_rm_delete_scheduled_message"
+
         case .configurationFetchInfo: return "m_d_cfgfetch"
 
         case .trackerDataParseFailed: return "m_d_tds_p"

Core/PixelEvent.swift

@@ -19,6 +19,7 @@
 
 import Foundation
 import os.log
+import BrowserServicesKit
 
 public class StatisticsLoader {