Bugfix FXIOS-10996, FXIOS-11158 Fix app crashes in HistoryPanel due to duplicate Site identifiers

firefox-ios/Client/Frontend/Browser/BackForwardListViewController.swift

@@ -303,9 +303,9 @@ class BackForwardListViewController: UIViewController,
         let isAboutHomeURL = InternalURL(item.url)?.isAboutHomeURL ?? false
         var site: Site
         if isAboutHomeURL {
-            site = Site(url: item.url.absoluteString, title: .FirefoxHomePage)
+            site = Site.createBasicSite(url: item.url.absoluteString, title: .FirefoxHomePage)
         } else {
-            site = sites[urlString] ?? Site(url: urlString, title: item.title ?? "")
+            site = sites[urlString] ?? Site.createBasicSite(url: urlString, title: item.title ?? "")
         }
 
         let viewModel = BackForwardCellViewModel(site: site,

firefox-ios/Client/Frontend/Browser/BrowserViewController/Views/BrowserViewController.swift

@@ -1703,15 +1703,13 @@ class BrowserViewController: UIViewController,
         QuickActionsImplementation().addDynamicApplicationShortcutItemOfType(.openLastBookmark,
                                                                              withUserData: userData,
                                                                              toApplication: .shared)
-        site?.setBookmarked(true)
         showBookmarkToast(action: .add)
     }
 
     func removeBookmark(url: URL, title: String?, site: Site? = nil) {
         profile.places.deleteBookmarksWithURL(url: url.absoluteString).uponQueue(.main) { result in
             guard result.isSuccess else { return }
             self.showBookmarkToast(bookmarkURL: url, title: title, action: .remove)
-            site?.setBookmarked(false)
         }
     }
 

firefox-ios/Client/Frontend/Browser/MainMenuActionHelper.swift

@@ -785,7 +785,9 @@ class MainMenuActionHelper: PhotonActionSheetProtocol,
                                      iconString: StandardImageIdentifiers.Large.pin) { _ in
             guard let url = self.selectedTab?.url?.displayURL,
                   let title = self.selectedTab?.displayTitle else { return }
-            let site = Site(url: url.absoluteString, title: title)
+
+            let site = Site.createBasicSite(url: url.absoluteString, title: title)
+
             self.profile.pinnedSites.addPinnedTopSite(site).uponQueue(.main) { result in
                 guard result.isSuccess else { return }
                 self.delegate?.showToast(message: .LegacyAppMenu.AddPinToShortcutsConfirmMessage, toastAction: .pinPage)
@@ -800,7 +802,9 @@ class MainMenuActionHelper: PhotonActionSheetProtocol,
                                      iconString: StandardImageIdentifiers.Large.pinSlash) { _ in
             guard let url = self.selectedTab?.url?.displayURL,
                   let title = self.selectedTab?.displayTitle else { return }
-            let site = Site(url: url.absoluteString, title: title)
+
+            let site = Site.createBasicSite(url: url.absoluteString, title: title)
+
             self.profile.pinnedSites.removeFromPinnedTopSites(site).uponQueue(.main) { result in
                 if result.isSuccess {
                     self.delegate?.showToast(

firefox-ios/Client/Frontend/Browser/Search/SearchHighlightItem.swift

@@ -18,6 +18,6 @@ struct SearchHighlightItem {
         return highlightItem.urlString ?? ""
     }
     var siteURL: String {
-        return Site(url: urlString, title: highlightItem.displayTitle).url
+        return urlString
     }
 }

firefox-ios/Client/Frontend/Browser/Search/SearchViewController.swift

@@ -778,7 +778,7 @@ class SearchViewController: SiteTableViewController,
                     twoLineCell,
                     site.title,
                     site.url,
-                    site.bookmarked ?? false
+                    site.isBookmarked ?? false
                 )
                 cell = twoLineCell
             }

firefox-ios/Client/Frontend/Browser/Search/SearchViewModel.swift

@@ -32,12 +32,12 @@ class SearchViewModel: FeatureFlaggable, LoaderListener {
 
     var bookmarkSites: [Site] {
         delegate?.searchData.compactMap { $0 }
-            .filter { $0.bookmarked == true } ?? []
+            .filter { $0.isBookmarked == true } ?? []
     }
 
     var historySites: [Site] {
         delegate?.searchData.compactMap { $0 }
-            .filter { $0.bookmarked == false } ?? []
+            .filter { $0.isBookmarked == false } ?? []
     }
 
     private let maxNumOfFirefoxSuggestions: Int32 = 1

firefox-ios/Client/Frontend/Browser/SearchLoader.swift

@@ -48,7 +48,7 @@ final class SearchLoader: Loader<Cursor<Site>, SearchViewModel>, FeatureFlaggabl
                 return
             }
 
-            let sites = bookmarkItems.map({ Site(url: $0.url, title: $0.title, bookmarked: true, guid: $0.guid) })
+            let sites = bookmarkItems.map({ Site.createBasicSite(url: $0.url, title: $0.title, isBookmarked: true) })
             completionHandler(sites)
         }
     }
@@ -74,7 +74,7 @@ final class SearchLoader: Loader<Cursor<Site>, SearchViewModel>, FeatureFlaggabl
                 // Sort descending by frecency score
                 $0.frecency > $1.frecency
             }.map({
-                return Site(url: $0.url, title: $0.title )
+                return Site.createBasicSite(url: $0.url, title: $0.title )
             }).uniqued()
             completionHandler(sites)
         }

firefox-ios/Client/Frontend/Browser/Tabs/Middleware/TabManagerMiddleware.swift

@@ -956,7 +956,8 @@ class TabManagerMiddleware: BookmarksRefactorFeatureFlagProvider {
               let url = tab.url?.displayURL?.absoluteString
         else { return }
 
-        let site = Site(url: url, title: tab.displayTitle)
+        let site = Site.createBasicSite(url: url, title: tab.displayTitle)
+
         profile.pinnedSites.addPinnedTopSite(site).uponQueue(.main) { result in
             guard result.isSuccess else { return }
 
@@ -977,7 +978,8 @@ class TabManagerMiddleware: BookmarksRefactorFeatureFlagProvider {
               let url = tab.url?.displayURL?.absoluteString
         else { return }
 
-        let site = Site(url: url, title: tab.displayTitle)
+        let site = Site.createBasicSite(url: url, title: tab.displayTitle)
+
         profile.pinnedSites.removeFromPinnedTopSites(site).uponQueue(.main) { result in
             guard result.isSuccess else { return }
             store.dispatch(

firefox-ios/Client/Frontend/Home/Bookmarks/BookmarksViewModel.swift

@@ -130,7 +130,7 @@ extension BookmarksViewModel: HomepageSectionHandler {
         guard let bookmarksCell = cell as? BookmarksCell else { return UICollectionViewCell() }
 
         if let item = bookmarkItems[safe: indexPath.row] {
-            let site = Site(url: item.url, title: item.title, bookmarked: true)
+            let site = Site.createBasicSite(url: item.url, title: item.title, isBookmarked: true)
             let viewModel = BookmarksCellViewModel(site: site)
             bookmarksCell.configure(viewModel: viewModel, theme: theme)
         }
@@ -156,8 +156,8 @@ extension BookmarksViewModel: HomepageSectionHandler {
     func handleLongPress(with collectionView: UICollectionView, indexPath: IndexPath) {
         guard let onLongPressTileAction = onLongPressTileAction else { return }
 
-        let site = Site(url: bookmarkItems[indexPath.row].url,
-                        title: bookmarkItems[indexPath.row].title)
+        let site = Site.createBasicSite(url: bookmarkItems[indexPath.row].url,
+                                        title: bookmarkItems[indexPath.row].title)
         let sourceView = collectionView.cellForItem(at: indexPath)
         onLongPressTileAction(site, sourceView)
     }

firefox-ios/Client/Frontend/Home/Homepage Rebuild/ContextMenu/ContextMenuConfiguration.swift

@@ -3,6 +3,7 @@
 // file, You can obtain one at http://mozilla.org/MPL/2.0/
 
 import Storage
+
 struct ContextMenuConfiguration: Equatable {
     var homepageSection: HomepageSection
     var sourceView: UIView?
@@ -13,11 +14,9 @@ struct ContextMenuConfiguration: Equatable {
         case .topSite(let state, _):
             return state.site
         case .pocket(let state):
-            return Site(url: state.url?.absoluteString ?? "",
-                        title: state.title)
+            return Site.createBasicSite(url: state.url?.absoluteString ?? "", title: state.title)
         case .pocketDiscover(let state):
-            return Site(url: state.url?.absoluteString ?? "",
-                        title: state.title)
+            return Site.createBasicSite(url: state.url?.absoluteString ?? "", title: state.title)
         default:
             return nil
         }

firefox-ios/Client/Frontend/Home/Homepage Rebuild/ContextMenu/ContextMenuState.swift

@@ -62,13 +62,16 @@ struct ContextMenuState {
     // MARK: - Top sites item's context menu actions
     private func getTopSitesActions(site: Site) -> [PhotonRowActions] {
         let topSiteActions: [PhotonRowActions]
-        if site is PinnedSite {
-            topSiteActions = getPinnedTileActions(site: site)
-        } else if site as? SponsoredTile != nil {
+
+        switch site.type {
+        case .sponsoredSite:
             topSiteActions = getSponsoredTileActions(site: site)
-        } else {
+        case .pinnedSite:
+            topSiteActions = getPinnedTileActions(site: site)
+        default:
             topSiteActions = getOtherTopSitesActions(site: site)
         }
+
         return topSiteActions
     }
 

firefox-ios/Client/Frontend/Home/Homepage Rebuild/TopSites/Site+createSponsoredSite.swift

@@ -0,0 +1,19 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/
+
+import Storage
+
+extension Site {
+    /// A helper to instantiate a Site from the Storage target using the Client target `Contile` type.
+    static func createSponsoredSite(fromContile contile: Contile) -> Site {
+        let siteInfo = SponsoredSiteInfo(
+            tileId: contile.id,
+            impressionURL: contile.impressionUrl,
+            clickURL: contile.clickUrl,
+            imageURL: contile.imageUrl
+        )
+
+        return Site.createSponsoredSite(url: contile.url, title: contile.name, siteInfo: siteInfo)
+    }
+}

firefox-ios/Client/Frontend/Home/Homepage Rebuild/TopSites/TopSiteCell.swift

@@ -147,16 +147,21 @@ class TopSiteCell: UICollectionViewCell, ReusableCell {
         let siteURLString = topSite.site.url
         var imageResource: SiteResource?
 
-        if let site = topSite.site as? SponsoredTile,
-           let url = URL(string: site.imageURL, invalidCharacters: false) {
-            imageResource = .remoteURL(url: url)
-        } else if let site = topSite.site as? PinnedSite {
-            imageResource = site.faviconResource
-        } else if let site = topSite.site as? SuggestedSite {
-            imageResource = site.faviconResource
-        } else if let siteURL = URL(string: siteURLString),
-                  let domainNoTLD = siteURL.baseDomain?.split(separator: ".").first,
-                  domainNoTLD == "google" {
+        switch topSite.type {
+        case .sponsoredSite(let siteInfo):
+            if let url = URL(string: siteInfo.imageURL, invalidCharacters: false) {
+                imageResource = .remoteURL(url: url)
+            }
+        case .pinnedSite, .suggestedSite:
+            imageResource = topSite.site.faviconResource
+        default:
+            break
+        }
+
+        if imageResource == nil,
+           let siteURL = URL(string: siteURLString),
+           let domainNoTLD = siteURL.baseDomain?.split(separator: ".").first,
+           domainNoTLD == "google" {
             // Exception for Google top sites, which all return blurry low quality favicons that on the home screen.
             // Return our bundled G icon for all of the Google Suite.
             // Parse example: "https://drive.google.com/drive/home" > "drive.google.com" > "google"
@@ -237,7 +242,7 @@ class TopSiteCell: UICollectionViewCell, ReusableCell {
     }
 
     private func configureSponsoredSite(_ topSite: TopSiteState) {
-        guard topSite.isSponsoredTile else { return }
+        guard topSite.isSponsored else { return }
 
         sponsoredLabel.text = topSite.sponsoredText
     }

firefox-ios/Client/Frontend/Home/Homepage Rebuild/TopSites/TopSiteState.swift

@@ -7,7 +7,7 @@ import Storage
 import Shared
 
 /// Top site UI class, used in the homepage top site section
-final class TopSiteState: Hashable, Equatable {
+struct TopSiteState: Hashable, Equatable {
     var site: Site
     var title: String
 
@@ -16,23 +16,31 @@ final class TopSiteState: Hashable, Equatable {
     }
 
     var accessibilityLabel: String? {
-        return isSponsoredTile ? "\(title), \(sponsoredText)" : title
+        return isSponsored ? "\(title), \(sponsoredText)" : title
     }
 
     var isPinned: Bool {
-        return (site as? PinnedSite) != nil
+        return site.isPinnedSite
     }
 
     var isSuggested: Bool {
-        return (site as? SuggestedSite) != nil
+        return site.isSuggestedSite
     }
 
-    var isSponsoredTile: Bool {
-        return (site as? SponsoredTile) != nil
+    var isSponsored: Bool {
+        return site.isSponsoredSite
     }
 
-    var isGoogleGUID: Bool {
-        return site.guid == GoogleTopSiteManager.Constants.googleGUID
+    var type: SiteType {
+        return site.type
+    }
+
+    var isGooglePinnedTile: Bool {
+        guard case SiteType.pinnedSite(let siteInfo) = site.type else {
+            return false
+        }
+
+        return siteInfo.isGooglePinnedTile
     }
 
     var isGoogleURL: Bool {
@@ -52,42 +60,22 @@ final class TopSiteState: Hashable, Equatable {
 
     func impressionTracking(position: Int) {
         // Only sending sponsored tile impressions for now
-        guard let tile = site as? SponsoredTile else { return }
+        guard site.isSponsoredSite else { return }
 
-        SponsoredTileTelemetry.sendImpressionTelemetry(tile: tile, position: position)
+        SponsoredTileTelemetry.sendImpressionTelemetry(tileSite: site, position: position)
     }
 
     func getTelemetrySiteType() -> String {
-        if isPinned && isGoogleGUID {
+        if isGooglePinnedTile {
             return "google"
         } else if isPinned {
             return "user-added"
         } else if isSuggested {
             return "suggested"
-        } else if isSponsoredTile {
+        } else if isSponsored {
             return "sponsored"
         }
 
         return "history-based"
     }
-
-    // MARK: - Equatable
-    static func == (lhs: TopSiteState, rhs: TopSiteState) -> Bool {
-        lhs.site == rhs.site &&
-        lhs.isPinned == rhs.isPinned &&
-        lhs.isSuggested == rhs.isSuggested &&
-        lhs.isSponsoredTile == rhs.isSponsoredTile &&
-        lhs.isGoogleGUID == rhs.isGoogleGUID &&
-        lhs.isGoogleURL == rhs.isGoogleURL
-    }
-
-    // MARK: - Hashable
-    func hash(into hasher: inout Hasher) {
-        hasher.combine(self.site)
-        hasher.combine(self.isPinned)
-        hasher.combine(self.isSuggested)
-        hasher.combine(self.isSponsoredTile)
-        hasher.combine(self.isGoogleGUID)
-        hasher.combine(self.isGoogleURL)
-    }
 }