ATB -> PixelDataStore

DuckDuckGo/Common/Database/Database.swift

@@ -25,30 +25,34 @@ final class Database {
         static let databaseName = "Database"
     }
 
-    static let shared = Database()
+    static let shared: Database = {
+#if DEBUG
+        if AppDelegate.isRunningTests {
+            let keyStoreMockClass = (NSClassFromString("EncryptionKeyStoreMock") as? NSObject.Type)!
+            let keyStoreMock = (keyStoreMockClass.init() as? EncryptionKeyStoring)!
+            return Database(keyStore: keyStoreMock)
+        }
+#endif
+        return Database()
+    }()
 
     private let container: NSPersistentContainer
     private let storeLoadedCondition = RunLoop.ResumeCondition()
 
     var model: NSManagedObjectModel {
         return container.managedObjectModel
     }
-
-    convenience init() {
-        let mainBundle = Bundle.main
 
-        guard let managedObjectModel = NSManagedObjectModel.mergedModel(from: [mainBundle]) else { fatalError("No DB scheme found") }
-
-        self.init(name: Constants.databaseName, model: managedObjectModel)
-    }
-
-    init(name: String, model: NSManagedObjectModel) {
+    init(name: String = Constants.databaseName,
+         model: NSManagedObjectModel = NSManagedObjectModel.mergedModel(from: [.main])!,
+         keyStore: EncryptionKeyStoring = EncryptionKeyStore(generator: EncryptionKeyGenerator())) {
         do {
-            try EncryptedValueTransformer<NSImage>.registerTransformer()
-            try EncryptedValueTransformer<NSString>.registerTransformer()
-            try EncryptedValueTransformer<NSURL>.registerTransformer()
-            try EncryptedValueTransformer<NSNumber>.registerTransformer()
-            try EncryptedValueTransformer<NSError>.registerTransformer()
+            try EncryptedValueTransformer<NSImage>.registerTransformer(keyStore: keyStore)
+            try EncryptedValueTransformer<NSString>.registerTransformer(keyStore: keyStore)
+            try EncryptedValueTransformer<NSURL>.registerTransformer(keyStore: keyStore)
+            try EncryptedValueTransformer<NSNumber>.registerTransformer(keyStore: keyStore)
+            try EncryptedValueTransformer<NSError>.registerTransformer(keyStore: keyStore)
+            try EncryptedValueTransformer<NSData>.registerTransformer(keyStore: keyStore)
         } catch {
             fatalError("Failed to register encryption value transformers")
         }
@@ -59,7 +63,7 @@ final class Database {
     func loadStore(migrationHandler: @escaping (NSManagedObjectContext) -> Void = { _ in }) {
         container.loadPersistentStores { _, error in
             if let error = error {
-                Pixel.fire(.debug(event: .dbInitializationError, error: error, countedBy: .counter))
+                Pixel.fire(.debug(event: .dbInitializationError, error: error))
                 // Give Pixel a chance to be sent, but not too long
                 Thread.sleep(forTimeInterval: 1)
                 fatalError("Could not load DB: \(error.localizedDescription)")

DuckDuckGo/Common/FileSystem/EncryptedValueTransformer.swift

@@ -41,11 +41,16 @@ final class EncryptedValueTransformer<T: NSSecureCoding & NSObject>: ValueTransf
             return nil
         }
         let archivedData: Data
-        do {
-            archivedData = try NSKeyedArchiver.archivedData(withRootObject: castValue, requiringSecureCoding: true)
-        } catch {
-            assertionFailure("Could not archive value \(castValue): \(error)")
-            return nil
+        // if T is Data
+        if let data = castValue as? Data {
+            archivedData = data
+        } else {
+            do {
+                archivedData = try NSKeyedArchiver.archivedData(withRootObject: castValue, requiringSecureCoding: true)
+            } catch {
+                assertionFailure("Could not archive value \(castValue): \(error)")
+                return nil
+            }
         }
 
         return try? DataEncryption.encrypt(data: archivedData, key: encryptionKey)
@@ -55,6 +60,11 @@ final class EncryptedValueTransformer<T: NSSecureCoding & NSObject>: ValueTransf
         guard let data = value as? Data,
               let decryptedData = try? DataEncryption.decrypt(data: data, key: encryptionKey) else { return nil }
 
+        // if T is Data
+        if let data = decryptedData as? T {
+            return data
+        }
+
         return try? NSKeyedUnarchiver.unarchivedObject(ofClass: T.self, from: decryptedData as Data)
     }
 
@@ -65,19 +75,11 @@ final class EncryptedValueTransformer<T: NSSecureCoding & NSObject>: ValueTransf
         return NSValueTransformerName("\(className)Transformer")
     }
 
-    static func registerTransformer() throws {
-        #if CI
-            // Don't register transformers when running on the CI, they'll fail to read the Keychain due to the build machines not being provisioned.
-            return
-        #else
-            let generator = EncryptionKeyGenerator()
-            let keyStore = EncryptionKeyStore(generator: generator)
-            let key = try keyStore.readKey()
-            let transformer = EncryptedValueTransformer<T>(encryptionKey: key)
-
-            ValueTransformer.setValueTransformer(transformer, forName: transformerName)
-        #endif
+    static func registerTransformer(keyStore: EncryptionKeyStoring) throws {
+        let key = try keyStore.readKey()
+        let transformer = EncryptedValueTransformer<T>(encryptionKey: key)
 
+        ValueTransformer.setValueTransformer(transformer, forName: transformerName)
     }
 
 }

DuckDuckGo/Common/Utilities/UserDefaultsWrapper.swift

@@ -55,7 +55,6 @@ public struct UserDefaultsWrapper<T> {
         case atb = "statistics.atb.key"
         case searchRetentionAtb = "statistics.retentionatb.key"
         case appRetentionAtb = "statistics.appretentionatb.key"
-        case variant = "statistics.variant.key"
         case lastAppRetentionRequestDate = "statistics.appretentionatb.last.request.key"
 
     }

DuckDuckGo/Configuration/ConfigurationManager.swift

@@ -111,7 +111,7 @@ final class ConfigurationManager {
 
                 if case .failure(let error) = completion {
                     os_log("Failed to complete configuration update %s", log: .config, type: .error, error.localizedDescription)
-                    Pixel.fire(.debug(event: .configurationFetchError, error: error, countedBy: .counter))
+                    Pixel.fire(.debug(event: .configurationFetchError, error: error))
 
                     tryAgainSoon()
                 } else {

DuckDuckGo/Smarter Encryption/Store/HTTPSUpgradeStore.swift

@@ -134,7 +134,7 @@ final class HTTPSUpgradePersistence: HTTPSUpgradeStore {
             do {
                 try context.save()
             } catch {
-                Pixel.fire(.debug(event: .dbSaveBloomFilterError, error: error, countedBy: .counter))
+                Pixel.fire(.debug(event: .dbSaveBloomFilterError, error: error))
             }
         }
     }
@@ -170,7 +170,7 @@ final class HTTPSUpgradePersistence: HTTPSUpgradeStore {
             do {
                 try context.save()
             } catch {
-                Pixel.fire(.debug(event: .dbSaveExcludedHTTPSDomainsError, error: error, countedBy: .counter))
+                Pixel.fire(.debug(event: .dbSaveExcludedHTTPSDomainsError, error: error))
                 result = false
             }
         }

DuckDuckGo/Statistics/ATB/AtbAndVariantCleanup.swift

@@ -21,7 +21,7 @@ import Foundation
 
 public class AtbAndVariantCleanup {
 
-    static func cleanup(statisticsStorage: StatisticsStore = StatisticsUserDefaults(),
+    static func cleanup(statisticsStorage: StatisticsStore = LocalStatisticsStore(),
                         variantManager: VariantManager = DefaultVariantManager()) {
 
         guard let variant = statisticsStorage.variant else { return }

DuckDuckGo/Statistics/ATB/LocalStatisticsStore.swift

@@ -0,0 +1,161 @@
+//
+//  LocalStatisticsStore.swift
+//  DuckDuckGo
+//
+//  Copyright © 2017 DuckDuckGo. All rights reserved.
+//
+//  Licensed under the Apache License, Version 2.0 (the "License");
+//  you may not use this file except in compliance with the License.
+//  You may obtain a copy of the License at
+//
+//  http://www.apache.org/licenses/LICENSE-2.0
+//
+//  Unless required by applicable law or agreed to in writing, software
+//  distributed under the License is distributed on an "AS IS" BASIS,
+//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//  See the License for the specific language governing permissions and
+//  limitations under the License.
+//
+
+import Foundation
+
+final class LocalStatisticsStore: StatisticsStore {
+
+    private struct LegacyStatisticsStore {
+        @UserDefaultsWrapper(key: .atb, defaultValue: nil)
+        var atb: String?
+
+        @UserDefaultsWrapper(key: .installDate, defaultValue: nil)
+        var installDate: Date?
+
+        @UserDefaultsWrapper(key: .searchRetentionAtb, defaultValue: nil)
+        var searchRetentionAtb: String?
+
+        @UserDefaultsWrapper(key: .appRetentionAtb, defaultValue: nil)
+        var appRetentionAtb: String?
+
+        @UserDefaultsWrapper(key: .lastAppRetentionRequestDate, defaultValue: nil)
+        var lastAppRetentionRequestDate: Date?
+
+        mutating func clear() {
+            atb = nil
+            installDate = nil
+            searchRetentionAtb = nil
+            appRetentionAtb = nil
+            lastAppRetentionRequestDate = nil
+        }
+    }
+
+    private struct Keys {
+        static let installDate = "statistics.installdate.key"
+        static let atb = "statistics.atb.key"
+        static let searchRetentionAtb = "statistics.retentionatb.key"
+        static let appRetentionAtb = "statistics.appretentionatb.key"
+        static let variant = "statistics.variant.key"
+        static let lastAppRetentionRequestDate = "statistics.appretentionatb.last.request.key"
+    }
+
+    private let pixelDataStore: PixelDataStore
+
+    init(pixelDataStore: PixelDataStore = LocalPixelDataStore.shared) {
+        self.pixelDataStore = pixelDataStore
+
+        var legacyStatisticsStore = LegacyStatisticsStore()
+        if let atb = legacyStatisticsStore.atb {
+            self.atb = atb
+            self.installDate = legacyStatisticsStore.installDate
+            self.searchRetentionAtb = legacyStatisticsStore.searchRetentionAtb
+            self.appRetentionAtb = legacyStatisticsStore.appRetentionAtb
+            self.lastAppRetentionRequestDate = legacyStatisticsStore.lastAppRetentionRequestDate
+
+            legacyStatisticsStore.clear()
+        }
+    }
+
+    var hasInstallStatistics: Bool {
+        return atb != nil
+    }
+
+    var atb: String? {
+        get {
+            pixelDataStore.value(forKey: Keys.atb)
+        }
+        set {
+            if let value = newValue {
+                pixelDataStore.set(value, forKey: Keys.atb)
+            } else {
+                assertionFailure("Unexpected ATB removal")
+                pixelDataStore.removeValue(forKey: Keys.atb)
+            }
+        }
+    }
+
+    var installDate: Date? {
+        get {
+            guard let timeInterval: Double = pixelDataStore.value(forKey: Keys.installDate) else { return nil }
+            return Date(timeIntervalSinceReferenceDate: timeInterval)
+        }
+        set {
+            if let value = newValue {
+                pixelDataStore.set(value.timeIntervalSinceReferenceDate, forKey: Keys.installDate)
+            } else {
+                assertionFailure("Unexpected ATB installDate removal")
+                pixelDataStore.removeValue(forKey: Keys.installDate)
+            }
+        }
+    }
+
+    var searchRetentionAtb: String? {
+        get {
+            pixelDataStore.value(forKey: Keys.searchRetentionAtb)
+        }
+        set {
+            if let value = newValue {
+                pixelDataStore.set(value, forKey: Keys.searchRetentionAtb)
+            } else {
+                pixelDataStore.removeValue(forKey: Keys.searchRetentionAtb)
+            }
+        }
+    }
+
+    var appRetentionAtb: String? {
+        get {
+            pixelDataStore.value(forKey: Keys.appRetentionAtb)
+        }
+        set {
+            if let value = newValue {
+                pixelDataStore.set(value, forKey: Keys.appRetentionAtb)
+            } else {
+                pixelDataStore.removeValue(forKey: Keys.appRetentionAtb)
+            }
+        }
+    }
+
+    var variant: String? {
+        get {
+            pixelDataStore.value(forKey: Keys.variant)
+        }
+        set {
+            if let value = newValue {
+                pixelDataStore.set(value, forKey: Keys.variant)
+            } else {
+                pixelDataStore.removeValue(forKey: Keys.variant)
+            }
+        }
+    }
+
+    var lastAppRetentionRequestDate: Date? {
+        get {
+            guard let timeInterval: Double = pixelDataStore.value(forKey: Keys.lastAppRetentionRequestDate) else { return nil }
+            return Date(timeIntervalSinceReferenceDate: timeInterval)
+        }
+        set {
+            if let value = newValue {
+                pixelDataStore.set(value.timeIntervalSinceReferenceDate, forKey: Keys.lastAppRetentionRequestDate)
+            } else {
+                pixelDataStore.removeValue(forKey: Keys.lastAppRetentionRequestDate)
+            }
+        }
+    }
+
+}

DuckDuckGo/Statistics/ATB/StatisticsLoader.swift

@@ -30,7 +30,7 @@ final class StatisticsLoader {
     private let parser = AtbParser()
     private var isAppRetentionRequestInProgress = false
 
-    init(statisticsStore: StatisticsStore = StatisticsUserDefaults()) {
+    init(statisticsStore: StatisticsStore = LocalStatisticsStore()) {
         self.statisticsStore = statisticsStore
     }
 

DuckDuckGo/Statistics/ATB/VariantManager.swift

@@ -78,7 +78,7 @@ final class DefaultVariantManager: VariantManager {
     private let rng: VariantRNG
 
     init(variants: [Variant] = Variant.defaultVariants,
-         storage: StatisticsStore = StatisticsUserDefaults(),
+         storage: StatisticsStore = LocalStatisticsStore(),
          rng: VariantRNG = Arc4RandomUniformVariantRNG()) {
         self.variants = variants
         self.storage = storage