Merge branch 'trunk' of github.com:wordpress-mobile/WordPress-iOS into task/success-card-actions

Author: salimbraksa

WordPress/Classes/Services/JetpackNotificationMigrationService.swift

@@ -25,7 +25,16 @@ final class JetpackNotificationMigrationService: JetpackNotificationMigrationSer
 
     var wordPressNotificationsEnabled: Bool {
         get {
-            return remoteNotificationRegister.isRegisteredForRemoteNotifications
+            /// UIApplication.shared.isRegisteredForRemoteNotifications should be always accessed from main thread
+            if Thread.isMainThread {
+                return remoteNotificationRegister.isRegisteredForRemoteNotifications
+            } else {
+                var isRegisteredForRemoteNotifications = false
+                DispatchQueue.main.sync {
+                    isRegisteredForRemoteNotifications = remoteNotificationRegister.isRegisteredForRemoteNotifications
+                }
+                return isRegisteredForRemoteNotifications
+            }
         }
 
         set {

WordPress/Classes/Stores/UserPersistentStoreFactory.swift

@@ -1,17 +1,18 @@
 import Foundation
 
+/// Factory was used to sync WP & JP UserDefaults. It was decided to do it as one-off instead.
+/// Instead of refactoring the call-sites, we simply return `standard` here. Although it looks
+/// redundant, it gives us more flexibility to go back to syncing or apply similar changes and effect is isolated.
+/// If it is evident that this kind of thing is no longer needed after migration is complete, we can remove this
+/// and update call-sites to call `standard` directly.
 @objc
 final class UserPersistentStoreFactory: NSObject {
     static func instance() -> UserPersistentRepository {
-        FeatureFlag.contentMigration.enabled ? UserPersistentStore.standard : UserDefaults.standard
+        UserDefaults.standard
     }
 
     @objc
     static func userDefaultsInstance() -> UserDefaults {
-        guard FeatureFlag.contentMigration.enabled, let defaults = UserDefaults(suiteName: WPAppGroupName) else {
-            return UserDefaults.standard
-        }
-
-        return defaults
+        return UserDefaults.standard
     }
 }

WordPress/Classes/System/WordPressAppDelegate.swift

@@ -154,20 +154,9 @@ class WordPressAppDelegate: UIResponder, UIApplicationDelegate {
 
         NotificationCenter.default.post(name: .applicationLaunchCompleted, object: nil)
 
-        copyToSharedDefaultsIfNeeded()
         return true
     }
 
-    private func copyToSharedDefaultsIfNeeded() {
-        if !AppConfiguration.isJetpack && FeatureFlag.contentMigration.enabled && !UserPersistentStore.standard.isOneOffMigrationComplete {
-            let dict = UserDefaults.standard.dictionaryRepresentation()
-            for (key, value) in dict {
-                UserPersistentStore.standard.set(value, forKey: key)
-            }
-            UserPersistentStore.standard.isOneOffMigrationComplete = true
-        }
-    }
-
     func applicationWillTerminate(_ application: UIApplication) {
         DDLogInfo("\(self) \(#function)")
     }

WordPress/Classes/Utility/Blogging Prompts/PromptRemindersScheduler.swift

@@ -467,6 +467,12 @@ protocol LocalFileStore {
 
     @discardableResult
     func save(contents: Data, at url: URL) -> Bool
+
+    func containerURL(forAppGroup appGroup: String) -> URL?
+
+    func removeItem(at url: URL) throws
+
+    func copyItem(at srcURL: URL, to dstURL: URL) throws
 }
 
 extension LocalFileStore {
@@ -476,6 +482,10 @@ extension LocalFileStore {
 }
 
 extension FileManager: LocalFileStore {
+    func containerURL(forAppGroup appGroup: String) -> URL? {
+        return containerURL(forSecurityApplicationGroupIdentifier: appGroup)
+    }
+
     func fileExists(at url: URL) -> Bool {
         return fileExists(atPath: url.path)
     }

WordPress/Classes/Utility/BuildInformation/FeatureFlag.swift

@@ -123,7 +123,7 @@ enum FeatureFlag: Int, CaseIterable, OverrideableFlag {
         case .newCoreDataContext:
             return true
         case .jetpackMigrationPreventDuplicateNotifications:
-            return false
+            return true
         case .jetpackFeaturesRemovalPhaseOne:
             return false
         case .jetpackFeaturesRemovalPhaseTwo:

WordPress/Classes/Utility/KeychainUtils.swift

@@ -22,4 +22,16 @@ class KeychainUtils: NSObject {
             try keychainUtils.storeUsername(username, andPassword: password, forServiceName: serviceName, accessGroup: destinationAccessGroup, updateExisting: updateExisting)
         }
     }
+
+    func password(for username: String, serviceName: String, accessGroup: String? = nil) throws -> String? {
+        return try keychainUtils.getPasswordForUsername(username, andServiceName: serviceName, accessGroup: accessGroup)
+    }
+
+    func store(username: String, password: String, serviceName: String, accessGroup: String? = nil, updateExisting: Bool) throws {
+        return try keychainUtils.storeUsername(username,
+                                               andPassword: password,
+                                               forServiceName: serviceName,
+                                               accessGroup: accessGroup,
+                                               updateExisting: updateExisting)
+    }
 }

WordPress/Classes/ViewRelated/Stats/Insights/SiteStatsPinnedItemStore.swift

@@ -5,7 +5,7 @@ protocol SiteStatsPinnable { /* not implemented */ }
 
 final class SiteStatsPinnedItemStore {
     private(set) lazy var items: [SiteStatsPinnable] = {
-        let presentBloggingReminders = Feature.enabled(.bloggingReminders) && JetpackNotificationMigrationService.shared.shouldPresentNotifications()
+        let presentBloggingReminders = Feature.enabled(.bloggingReminders) && jetpackNotificationMigrationService.shouldPresentNotifications()
         return presentBloggingReminders ?
             [GrowAudienceCell.HintType.social,
              GrowAudienceCell.HintType.bloggingReminders,

WordPress/Jetpack/Classes/Utility/DataMigrator.swift

@@ -1,27 +1,36 @@
 final class DataMigrator {
 
+    /// `DefaultsWrapper` is used to single out a dictionary for the migration process.
+    /// This way we can delete just the value for its key and leave the rest of shared defaults untouched.
+    private struct DefaultsWrapper {
+        static let dictKey = "defaults_staging_dictionary"
+        let defaultsDict: [String: Any]
+    }
+
     private let coreDataStack: CoreDataStack
     private let backupLocation: URL?
     private let keychainUtils: KeychainUtils
     private let localDefaults: UserDefaults
     private let sharedDefaults: UserDefaults?
+    private let localFileStore: LocalFileStore
 
     init(coreDataStack: CoreDataStack = ContextManager.sharedInstance(),
          backupLocation: URL? = FileManager.default.containerURL(forSecurityApplicationGroupIdentifier: "group.org.wordpress")?.appendingPathComponent("WordPress.sqlite"),
          keychainUtils: KeychainUtils = KeychainUtils(),
          localDefaults: UserDefaults = UserDefaults.standard,
-         sharedDefaults: UserDefaults? = UserDefaults(suiteName: WPAppGroupName)) {
+         sharedDefaults: UserDefaults? = UserDefaults(suiteName: WPAppGroupName),
+         localFileStore: LocalFileStore = FileManager.default) {
         self.coreDataStack = coreDataStack
         self.backupLocation = backupLocation
         self.keychainUtils = keychainUtils
         self.localDefaults = localDefaults
         self.sharedDefaults = sharedDefaults
+        self.localFileStore = localFileStore
     }
 
     enum DataMigratorError: Error {
         case localDraftsNotSynced
         case databaseCopyError
-        case keychainError
         case sharedUserDefaultsNil
     }
 
@@ -34,7 +43,7 @@ final class DataMigrator {
             completion?(.failure(.databaseCopyError))
             return
         }
-        guard copyUserDefaults(from: localDefaults, to: sharedDefaults) else {
+        guard populateSharedDefaults() else {
             completion?(.failure(.sharedUserDefaultsNil))
             return
         }
@@ -47,14 +56,29 @@ final class DataMigrator {
             completion?(.failure(.databaseCopyError))
             return
         }
-        guard copyUserDefaults(from: sharedDefaults, to: localDefaults) else {
+        guard populateFromSharedDefaults() else {
             completion?(.failure(.sharedUserDefaultsNil))
             return
         }
+
+        copyTodayWidgetDataToJetpack()
         BloggingRemindersScheduler.handleRemindersMigration()
         completion?(.success(()))
     }
 
+    /// Copies WP's Today Widget data (in Keychain and User Defaults) into JP.
+    ///
+    /// Both WP and JP's extensions are already reading and storing data in the same location, but in case of Today Widget,
+    /// the keys used for Keychain and User Defaults are differentiated to prevent one app overwriting the other.
+    ///
+    /// Note: This method is not private for unit testing purposes.
+    /// It requires time to properly mock the dependencies in `importData`.
+    ///
+    func copyTodayWidgetDataToJetpack() {
+        copyTodayWidgetKeychain()
+        copyTodayWidgetUserDefaults()
+        copyTodayWidgetCacheFiles()
+    }
 }
 
 // MARK: - Private Functions
@@ -96,26 +120,152 @@ private extension DataMigrator {
         return true
     }
 
-    func copyKeychain(from sourceAccessGroup: String?, to destinationAccessGroup: String?) -> Bool {
-        do {
-            try keychainUtils.copyKeychain(from: sourceAccessGroup, to: destinationAccessGroup)
-        } catch {
-            DDLogError("Error copying keychain: \(error)")
+    func populateSharedDefaults() -> Bool {
+        guard let sharedDefaults = sharedDefaults else {
             return false
         }
 
+        let data = localDefaults.dictionaryRepresentation()
+        var temporaryDictionary: [String: Any] = [:]
+        for (key, value) in data {
+            temporaryDictionary[key] = value
+        }
+        sharedDefaults.set(temporaryDictionary, forKey: DefaultsWrapper.dictKey)
         return true
     }
 
-    func copyUserDefaults(from source: UserDefaults?, to destination: UserDefaults?) -> Bool {
-        guard let source, let destination else {
+    func populateFromSharedDefaults() -> Bool {
+        guard let sharedDefaults = sharedDefaults,
+              let temporaryDictionary = sharedDefaults.dictionary(forKey: DefaultsWrapper.dictKey) else {
             return false
         }
-        let data = source.dictionaryRepresentation()
-        for (key, value) in data {
-            destination.set(value, forKey: key)
-        }
 
+        for (key, value) in temporaryDictionary {
+            localDefaults.set(value, forKey: key)
+        }
+        sharedDefaults.removeObject(forKey: DefaultsWrapper.dictKey)
         return true
     }
 }
+
+// MARK: - Today Widget Extension Constants
+
+private extension DataMigrator {
+
+    func copyTodayWidgetKeychain() {
+        guard let authToken = try? keychainUtils.password(for: WPWidgetConstants.keychainTokenKey.rawValue,
+                                                          serviceName: WPWidgetConstants.keychainServiceName.rawValue,
+                                                          accessGroup: WPAppKeychainAccessGroup) else {
+            return
+        }
+
+        try? keychainUtils.store(username: WPWidgetConstants.keychainTokenKey.valueForJetpack(),
+                                 password: authToken,
+                                 serviceName: WPWidgetConstants.keychainServiceName.valueForJetpack(),
+                                 updateExisting: true)
+    }
+
+    func copyTodayWidgetUserDefaults() {
+        guard let sharedDefaults else {
+            return
+        }
+
+        let userDefaultKeys: [WPWidgetConstants] = [
+            .userDefaultsSiteIdKey,
+            .userDefaultsLoggedInKey,
+            .statsUserDefaultsSiteIdKey,
+            .statsUserDefaultsSiteUrlKey,
+            .statsUserDefaultsSiteNameKey,
+            .statsUserDefaultsSiteTimeZoneKey
+        ]
+
+        userDefaultKeys.forEach { key in
+            // go to the next key if there's nothing stored under the current key.
+            guard let objectToMigrate = sharedDefaults.object(forKey: key.rawValue) else {
+                return
+            }
+
+            sharedDefaults.set(objectToMigrate, forKey: key.valueForJetpack())
+        }
+    }
+
+    func copyTodayWidgetCacheFiles() {
+        let fileNames: [WPWidgetConstants] = [
+            .todayFilename,
+            .allTimeFilename,
+            .thisWeekFilename,
+            .statsTodayFilename,
+            .statsThisWeekFilename,
+            .statsAllTimeFilename
+        ]
+
+        fileNames.forEach { fileName in
+            guard let sourceURL = localFileStore.containerURL(forAppGroup: WPAppGroupName)?.appendingPathComponent(fileName.rawValue),
+                  let targetURL = localFileStore.containerURL(forAppGroup: WPAppGroupName)?.appendingPathComponent(fileName.valueForJetpack()),
+                  localFileStore.fileExists(at: sourceURL) else {
+                return
+            }
+
+            if localFileStore.fileExists(at: targetURL) {
+                try? localFileStore.removeItem(at: targetURL)
+            }
+
+            try? localFileStore.copyItem(at: sourceURL, to: targetURL)
+        }
+    }
+
+    /// Keys relevant for migration, copied from WidgetConfiguration.
+    ///
+    enum WPWidgetConstants: String {
+        // Constants for Home Widget
+        case keychainTokenKey = "OAuth2Token"
+        case keychainServiceName = "TodayWidget"
+        case userDefaultsSiteIdKey = "WordPressHomeWidgetsSiteId"
+        case userDefaultsLoggedInKey = "WordPressHomeWidgetsLoggedIn"
+        case todayFilename = "HomeWidgetTodayData.plist" // HomeWidgetTodayData
+        case allTimeFilename = "HomeWidgetAllTimeData.plist" // HomeWidgetAllTimeData
+        case thisWeekFilename = "HomeWidgetThisWeekData.plist" // HomeWidgetThisWeekData
+
+        // Constants for Stats Widget
+        case statsUserDefaultsSiteIdKey = "WordPressTodayWidgetSiteId"
+        case statsUserDefaultsSiteNameKey = "WordPressTodayWidgetSiteName"
+        case statsUserDefaultsSiteUrlKey = "WordPressTodayWidgetSiteUrl"
+        case statsUserDefaultsSiteTimeZoneKey = "WordPressTodayWidgetTimeZone"
+        case statsTodayFilename = "TodayData.plist" // TodayWidgetStats
+        case statsThisWeekFilename = "ThisWeekData.plist" // ThisWeekWidgetStats
+        case statsAllTimeFilename = "AllTimeData.plist" // AllTimeWidgetStats
+
+        func valueForJetpack() -> String {
+            switch self {
+            case .keychainTokenKey:
+                return "OAuth2Token"
+            case .keychainServiceName:
+                return "JetpackTodayWidget"
+            case .userDefaultsSiteIdKey:
+                return "JetpackHomeWidgetsSiteId"
+            case .userDefaultsLoggedInKey:
+                return "JetpackHomeWidgetsLoggedIn"
+            case .todayFilename:
+                return "JetpackHomeWidgetTodayData.plist"
+            case .allTimeFilename:
+                return "JetpackHomeWidgetAllTimeData.plist"
+            case .thisWeekFilename:
+                return "JetpackHomeWidgetThisWeekData.plist"
+            case .statsUserDefaultsSiteIdKey:
+                return "JetpackTodayWidgetSiteId"
+            case .statsUserDefaultsSiteNameKey:
+                return "JetpackTodayWidgetSiteName"
+            case .statsUserDefaultsSiteUrlKey:
+                return "JetpackTodayWidgetSiteUrl"
+            case .statsUserDefaultsSiteTimeZoneKey:
+                return "JetpackTodayWidgetTimeZone"
+            case .statsTodayFilename:
+                return "JetpackTodayData.plist"
+            case .statsThisWeekFilename:
+                return "JetpackThisWeekData.plist"
+            case .statsAllTimeFilename:
+                return "JetpackAllTimeData.plist"
+            }
+        }
+    }
+}