Fix migration to form-factor-specific favorites

Sources/Bookmarks/BookmarkUtils.swift

@@ -82,38 +82,6 @@ public struct BookmarkUtils {
         }
     }
 
-    public static func migrateToFormFactorSpecificFavorites(byCopyingExistingTo folderID: FavoritesFolderID, in context: NSManagedObjectContext) {
-        assert(folderID != .unified, "You must specify either desktop or mobile folder")
-
-        guard let favoritesFolder = BookmarkUtils.fetchFavoritesFolder(withUUID: FavoritesFolderID.unified.rawValue, in: context) else {
-            return
-        }
-
-        if BookmarkUtils.fetchFavoritesFolder(withUUID: FavoritesFolderID.desktop.rawValue, in: context) == nil {
-            let desktopFavoritesFolder = insertRootFolder(uuid: FavoritesFolderID.desktop.rawValue, into: context)
-
-            if folderID == .desktop {
-                favoritesFolder.favoritesArray.forEach { bookmark in
-                    bookmark.addToFavorites(favoritesRoot: desktopFavoritesFolder)
-                }
-            } else {
-                desktopFavoritesFolder.shouldManageModifiedAt = false
-            }
-        }
-
-        if BookmarkUtils.fetchFavoritesFolder(withUUID: FavoritesFolderID.mobile.rawValue, in: context) == nil {
-            let mobileFavoritesFolder = insertRootFolder(uuid: FavoritesFolderID.mobile.rawValue, into: context)
-
-            if folderID == .mobile {
-                favoritesFolder.favoritesArray.forEach { bookmark in
-                    bookmark.addToFavorites(favoritesRoot: mobileFavoritesFolder)
-                }
-            } else {
-                mobileFavoritesFolder.shouldManageModifiedAt = false
-            }
-        }
-    }
-
     public static func copyFavorites(
         from sourceFolderID: FavoritesFolderID,
         to targetFolderID: FavoritesFolderID,

Sources/Bookmarks/Migrations/BookmarkFormFactorFavoritesMigration.swift

@@ -0,0 +1,104 @@
+//
+//  Copyright © 2023 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
+import CoreData
+import Persistence
+import Common
+
+public class BookmarkFormFactorFavoritesMigration {
+
+    public enum MigrationErrors {
+        case couldNotLoadDatabase
+    }
+
+    public static func getFavoritesOrderFromPreV4Model(dbContainerLocation: URL,
+                                                       dbFileURL: URL,
+                                                       errorEvents: EventMapping<MigrationErrors>? = nil) -> [String]? {
+        var oldFavoritesOrder: [String]?
+
+        let metadata = try? NSPersistentStoreCoordinator.metadataForPersistentStore(ofType: NSSQLiteStoreType,
+                                                                                    at: dbFileURL)
+        if let metadata, let version = metadata["NSStoreModelVersionHashesVersion"] as? Int, version < 4 {
+            // Before migrating to latest scheme version, read order of favorites from DB
+
+            let v3BookmarksModel = NSManagedObjectModel.mergedModel(from: [Bookmarks.bundle], forStoreMetadata: metadata)!
+
+            let oldDB = CoreDataDatabase(name: "Bookmarks",
+                                         containerLocation: dbContainerLocation,
+                                         model: v3BookmarksModel)
+            oldDB.loadStore { context, error in
+                guard let context = context else {
+                    errorEvents?.fire(.couldNotLoadDatabase, error: error)
+                    return
+                }
+
+                let favs = BookmarkUtils.fetchLegacyFavoritesFolder(context)
+                oldFavoritesOrder = favs?.favoritesArray.compactMap { $0.uuid }
+            }
+        }
+        return oldFavoritesOrder
+    }
+
+    public static func migrateToFormFactorSpecificFavorites(byCopyingExistingTo folderID: FavoritesFolderID,
+                                                            preservingOrderOf orderedUUIDs: [String]?,
+                                                            in context: NSManagedObjectContext) {
+        assert(folderID != .unified, "You must specify either desktop or mobile folder")
+
+        guard let favoritesFolder = BookmarkUtils.fetchFavoritesFolder(withUUID: FavoritesFolderID.unified.rawValue, in: context) else {
+            return
+        }
+
+        if let orderedUUIDs {
+            // Fix order of favorites
+            let favorites = favoritesFolder.favoritesArray
+
+            for fav in favorites {
+                fav.removeFromFavorites(favoritesRoot: favoritesFolder)
+            }
+
+            for uuid in orderedUUIDs {
+                if let fav = favorites.first(where: { $0.uuid == uuid}) {
+                    fav.addToFavorites(favoritesRoot: favoritesFolder)
+                }
+            }
+        }
+
+        if BookmarkUtils.fetchFavoritesFolder(withUUID: FavoritesFolderID.desktop.rawValue, in: context) == nil {
+            let desktopFavoritesFolder = BookmarkUtils.insertRootFolder(uuid: FavoritesFolderID.desktop.rawValue, into: context)
+
+            if folderID == .desktop {
+                favoritesFolder.favoritesArray.forEach { bookmark in
+                    bookmark.addToFavorites(favoritesRoot: desktopFavoritesFolder)
+                }
+            } else {
+                desktopFavoritesFolder.shouldManageModifiedAt = false
+            }
+        }
+
+        if BookmarkUtils.fetchFavoritesFolder(withUUID: FavoritesFolderID.mobile.rawValue, in: context) == nil {
+            let mobileFavoritesFolder = BookmarkUtils.insertRootFolder(uuid: FavoritesFolderID.mobile.rawValue, into: context)
+
+            if folderID == .mobile {
+                favoritesFolder.favoritesArray.forEach { bookmark in
+                    bookmark.addToFavorites(favoritesRoot: mobileFavoritesFolder)
+                }
+            } else {
+                mobileFavoritesFolder.shouldManageModifiedAt = false
+            }
+        }
+    }
+}

Tests/BookmarksTests/BookmarkUtilsTests.swift

@@ -61,6 +61,9 @@ final class BookmarkUtilsTests: XCTestCase {
         let bookmarkTree = BookmarkTree {
             Bookmark(id: "1")
             Bookmark(id: "2", favoritedOn: [.unified])
+            Folder(id: "10") {
+                Bookmark(id: "12", favoritedOn: [.unified])
+            }
             Bookmark(id: "3", favoritedOn: [.unified])
             Bookmark(id: "4", favoritedOn: [.unified])
         }
@@ -69,15 +72,22 @@ final class BookmarkUtilsTests: XCTestCase {
             bookmarkTree.createEntities(in: context)
 
             try! context.save()
+            let favoritesArray = BookmarkUtils.fetchFavoritesFolder(withUUID: FavoritesFolderID.unified.rawValue, in: context)?.favoritesArray.compactMap(\.uuid)
 
             BookmarkUtils.migrateToFormFactorSpecificFavorites(byCopyingExistingTo: .mobile, in: context)
 
             try! context.save()
 
+            let mobileFavoritesArray = BookmarkUtils.fetchFavoritesFolder(withUUID: FavoritesFolderID.mobile.rawValue, in: context)?.favoritesArray.compactMap(\.uuid)
+            XCTAssertEqual(favoritesArray, mobileFavoritesArray)
+
             let rootFolder = BookmarkUtils.fetchRootFolder(context)!
             assertEquivalent(withTimestamps: false, rootFolder, BookmarkTree {
                 Bookmark(id: "1")
                 Bookmark(id: "2", favoritedOn: [.mobile, .unified])
+                Folder(id: "10") {
+                    Bookmark(id: "12", favoritedOn: [.mobile, .unified])
+                }
                 Bookmark(id: "3", favoritedOn: [.mobile, .unified])
                 Bookmark(id: "4", favoritedOn: [.mobile, .unified])
             })