Refactor FXIOS-12796 [Swift 6 Migration] Isolate SearchEnginesManager to the main actor

firefox-ios/Client/Frontend/Browser/SearchEngines/SearchEnginesManager.swift

@@ -8,9 +8,13 @@ import Shared
 import Storage
 
 protocol SearchEnginesManagerProvider: AnyObject {
+    @MainActor
     var defaultEngine: OpenSearchEngine? { get }
+    @MainActor
     var orderedEngines: [OpenSearchEngine] { get }
+    @MainActor
     var delegate: SearchEngineDelegate? { get set }
+    @MainActor
     func getOrderedEngines(completion: @escaping SearchEngineCompletion)
 }
 
@@ -46,6 +50,7 @@ struct SearchEngineProviderFactory {
 /// enabled quick search engines, and it is possible to disable every non-default quick search engine).
 ///
 /// This class is not thread-safe -- you should only access it on a single thread (usually, the main thread)!
+@MainActor
 class SearchEnginesManager: SearchEnginesManagerProvider {
     private let prefs: Prefs
     private let fileAccessor: FileAccessor
@@ -291,7 +296,7 @@ class SearchEnginesManager: SearchEnginesManagerProvider {
         }
     }
 
-    func deleteCustomEngine(_ engine: OpenSearchEngine, completion: @escaping @Sendable () -> Void) {
+    func deleteCustomEngine(_ engine: OpenSearchEngine, completion: @MainActor @escaping @Sendable () -> Void) {
         // We can't delete a preinstalled engine or an engine that is currently the default.
         guard engine.isCustomEngine && !isEngineDefault(engine) else { return }
 

firefox-ios/Client/Frontend/Browser/Toolbars/Models/AddressToolbarContainerModel.swift

@@ -190,6 +190,7 @@ final class AddressToolbarContainerModel: Equatable {
         )
     }
 
+    @MainActor
     init(
         state: ToolbarState,
         profile: Profile,
@@ -242,6 +243,7 @@ final class AddressToolbarContainerModel: Equatable {
         self.toolbarHelper = toolbarHelper
     }
 
+    @MainActor
     func searchTermFromURL(_ url: URL?) -> String? {
         var searchURL: URL? = url
 

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

@@ -28,6 +28,7 @@ protocol TopSitesManagerInterface {
     /// - Parameters:
     ///   - otherSites: Contains the user's pinned sites, history, and default suggested sites.
     ///   - sponsoredSites: Contains the sponsored sites.
+    @MainActor
     func recalculateTopSites(otherSites: [TopSiteConfiguration], sponsoredSites: [Site]) -> [TopSiteConfiguration]
 
     /// Removes the site out of the top sites.
@@ -78,6 +79,7 @@ final class TopSitesManager: TopSitesManagerInterface, FeatureFlaggable {
         self.maxTopSites = maxTopSites
     }
 
+    @MainActor
     func recalculateTopSites(otherSites: [TopSiteConfiguration], sponsoredSites: [Site]) -> [TopSiteConfiguration] {
         let availableSpaceCount = getAvailableSpaceCount(with: otherSites)
         let googleTopSite = addGoogleTopSite(with: availableSpaceCount)
@@ -142,6 +144,7 @@ final class TopSitesManager: TopSitesManagerInterface, FeatureFlaggable {
         return featureFlags.isFeatureEnabled(.hntSponsoredShortcuts, checking: .userOnly)
     }
 
+    @MainActor
     private func filterSponsoredSites(
         contiles: [Site],
         with availableSpaceCount: Int,
@@ -161,6 +164,7 @@ final class TopSitesManager: TopSitesManagerInterface, FeatureFlaggable {
 
     /// Show the sponsored site only if site is not already present in the pinned sites
     /// and it's not the default search engine
+    @MainActor
     private func shouldShowSponsoredSite(with sponsoredSite: Site, and otherSites: [TopSiteConfiguration]) -> Bool {
         let siteDomain = sponsoredSite.url.asURL?.shortDomain
         let sponsoredSiteIsAlreadyPresent = otherSites.contains { (topSite: TopSiteConfiguration) in

firefox-ios/Client/Frontend/Home/TopSites/DataManagement/TopSiteHistoryManager.swift

@@ -19,6 +19,7 @@ class TopSiteHistoryManager: TopSiteHistoryManagerProvider {
     private let topSiteCacheSize: Int32 = 32
     private let topSitesProvider: TopSitesProvider
 
+    @MainActor
     init(profile: Profile) {
         self.profile = profile
         self.topSitesProvider = TopSitesProviderImplementation(

firefox-ios/Client/Frontend/Home/TopSites/DataManagement/TopSitesDataAdaptor.swift

@@ -20,6 +20,7 @@ protocol TopSitesDataAdaptor {
     var numberOfRows: Int { get }
 
     /// Get top sites data
+    @MainActor
     func getTopSitesData() -> [TopSite]
 }
 
@@ -78,6 +79,7 @@ class TopSitesDataAdaptorImplementation: TopSitesDataAdaptor, FeatureFlaggable {
         loadTopSitesData()
     }
 
+    @MainActor
     func getTopSitesData() -> [TopSite] {
         recalculateTopSiteData()
         return topSites
@@ -88,6 +90,7 @@ class TopSitesDataAdaptorImplementation: TopSitesDataAdaptor, FeatureFlaggable {
     /// Top sites are composed of pinned sites, history, Contiles and Google top site.
     /// Google top site is always first, then comes the contiles, pinned sites and history top sites.
     /// We only add Google top site or Contiles if number of pins doesn't exceeds the available number shown of tiles.
+    @MainActor
     private func recalculateTopSiteData() {
         var sites = historySites
         let availableSpaceCount = getAvailableSpaceCount(maxTopSites: maxTopSites)
@@ -120,9 +123,11 @@ class TopSitesDataAdaptorImplementation: TopSitesDataAdaptor, FeatureFlaggable {
         // FXIOS-13954 - This code will disappear soon since it's part of the legacy homepage only. If it hasn't
         // disappeared then we should is to be revisited once we are on Swift 6.2 with default main actor isolation.
         // Note: `didLoadNewData` calls `ensureMainThread`
-        dispatchGroup.notify(queue: dataQueue) { [weak self] in
-            self?.recalculateTopSiteData()
-            self?.delegate?.didLoadNewData()
+        dispatchGroup.notify(queue: .main) { [weak self] in
+            MainActor.assumeIsolated {
+                self?.recalculateTopSiteData()
+                self?.delegate?.didLoadNewData()
+            }
         }
     }
 
@@ -188,6 +193,7 @@ class TopSitesDataAdaptorImplementation: TopSitesDataAdaptor, FeatureFlaggable {
         return Int(preferredNumberOfRows ?? defaultNumberOfRows)
     }
 
+    @MainActor
     func addSponsoredTiles(sites: inout [Site],
                            shouldAddGoogle: Bool,
                            availableSpaceCount: Int) {

firefox-ios/Client/Frontend/Home/TopSites/TopSitesViewModel.swift

@@ -35,6 +35,7 @@ class TopSitesViewModel {
     private let unifiedAdsTelemetry: UnifiedAdsCallbackTelemetry
     private let sponsoredTileTelemetry: SponsoredTileTelemetry
 
+    @MainActor
     init(profile: Profile,
          isZeroSearch: Bool = false,
          theme: Theme,

firefox-ios/Client/Telemetry/TelemetryWrapper.swift

@@ -39,7 +39,10 @@ enum SearchLocation: String {
 }
 
 // FIXME: FXIOS-13987 Make truly thread safe
-class TelemetryWrapper: TelemetryWrapperProtocol, FeatureFlaggable, @unchecked Sendable {
+class TelemetryWrapper: TelemetryWrapperProtocol,
+                        FeatureFlaggable,
+                        Notifiable,
+                        @unchecked Sendable {
     typealias ExtraKey = TelemetryWrapper.EventExtraKey
 
     static let shared = TelemetryWrapper()
@@ -83,6 +86,7 @@ class TelemetryWrapper: TelemetryWrapperProtocol, FeatureFlaggable, @unchecked S
         } catch {}
     }
 
+    @MainActor
     func setup(profile: Profile) {
         migratePathComponentInDocumentsDirectory("MozTelemetry-Default-core", to: .cachesDirectory)
         migratePathComponentInDocumentsDirectory("MozTelemetry-Default-mobile-event", to: .cachesDirectory)
@@ -94,6 +98,7 @@ class TelemetryWrapper: TelemetryWrapperProtocol, FeatureFlaggable, @unchecked S
         initGlean(profile, sendUsageData: sendUsageData)
     }
 
+    @MainActor
     func initGlean(
         _ profile: Profile,
         searchEnginesManager: SearchEnginesManager = AppContainer.shared.resolve(),
@@ -176,17 +181,13 @@ class TelemetryWrapper: TelemetryWrapperProtocol, FeatureFlaggable, @unchecked S
 
         // Register an observer to record settings and other metrics that are more appropriate to
         // record on going to background rather than during initialization.
-        NotificationCenter.default.addObserver(
-            self,
-            selector: #selector(recordEnteredBackgroundPreferenceMetrics(notification:)),
-            name: UIApplication.didEnterBackgroundNotification,
-            object: nil
-        )
-        NotificationCenter.default.addObserver(
-            self,
-            selector: #selector(recordFinishedLaunchingPreferenceMetrics(notification:)),
-            name: UIApplication.didFinishLaunchingNotification,
-            object: nil
+        startObservingNotifications(
+            withNotificationCenter: NotificationCenter.default,
+            forObserver: self,
+            observing: [
+                UIApplication.didEnterBackgroundNotification,
+                UIApplication.didFinishLaunchingNotification
+            ]
         )
     }
 
@@ -206,9 +207,28 @@ class TelemetryWrapper: TelemetryWrapperProtocol, FeatureFlaggable, @unchecked S
         }
     }
 
-    @objc
-    func recordFinishedLaunchingPreferenceMetrics(notification: NSNotification) {
+    // MARK: Notifiable
+    func handleNotifications(_ notification: Notification) {
+        switch notification.name {
+        case UIApplication.didEnterBackgroundNotification:
+            // For recording metrics that are better recorded when going to background due
+            // to the particular measurement, or availability of the information.
+            ensureMainThread {
+                self.recordEnteredBackgroundPreferenceMetrics()
+            }
+        case UIApplication.didFinishLaunchingNotification:
+            ensureMainThread {
+                self.recordFinishedLaunchingPreferenceMetrics()
+            }
+        default:
+            break
+        }
+    }
+
+    @MainActor
+    func recordFinishedLaunchingPreferenceMetrics() {
         guard let profile = self.profile else { return }
+
         // Pocket stories visible
         if let pocketStoriesVisible = profile.prefs.boolForKey(PrefsKeys.UserFeatureFlagPrefs.ASPocketStories) {
             GleanMetrics.FirefoxHomePage.pocketStoriesVisible.set(pocketStoriesVisible)
@@ -217,10 +237,8 @@ class TelemetryWrapper: TelemetryWrapperProtocol, FeatureFlaggable, @unchecked S
         }
     }
 
-    // Function for recording metrics that are better recorded when going to background due
-    // to the particular measurement, or availability of the information.
-    @objc
-    func recordEnteredBackgroundPreferenceMetrics(notification: NSNotification) {
+    @MainActor
+    func recordEnteredBackgroundPreferenceMetrics() {
         guard let profile = self.profile else {
             assertionFailure("Error unwrapping profile")
             return

firefox-ios/firefox-ios-tests/Tests/ClientTests/DependencyInjection/DependencyHelperMock.swift

@@ -20,13 +20,6 @@ class DependencyHelperMock {
         )
         AppContainer.shared.register(service: profile as Profile)
 
-        let searchEnginesManager = SearchEnginesManager(
-            prefs: profile.prefs,
-            files: profile.files,
-            engineProvider: MockSearchEngineProvider()
-        )
-        AppContainer.shared.register(service: searchEnginesManager)
-
         let diskImageStore: DiskImageStore = DefaultDiskImageStore(
             files: profile.files,
             namespace: TabManagerConstants.tabScreenshotNamespace,
@@ -52,6 +45,13 @@ class DependencyHelperMock {
                     windowManager: windowManager
                 )
                 AppContainer.shared.register(service: MockThemeManager() as ThemeManager)
+
+                let searchEnginesManager = SearchEnginesManager(
+                    prefs: profile.prefs,
+                    files: profile.files,
+                    engineProvider: MockSearchEngineProvider()
+                )
+                AppContainer.shared.register(service: searchEnginesManager)
             }
         } else {
             DispatchQueue.main.sync {
@@ -61,6 +61,13 @@ class DependencyHelperMock {
                     windowManager: windowManager
                 )
                 AppContainer.shared.register(service: MockThemeManager() as ThemeManager)
+
+                let searchEnginesManager = SearchEnginesManager(
+                    prefs: profile.prefs,
+                    files: profile.files,
+                    engineProvider: MockSearchEngineProvider()
+                )
+                AppContainer.shared.register(service: searchEnginesManager)
             }
         }
 

firefox-ios/firefox-ios-tests/Tests/ClientTests/Frontend/Browser/SearchEngines/SearchEnginesManagerTests.swift

@@ -5,8 +5,10 @@
 @testable import Client
 import Foundation
 import XCTest
+import Common
 import Shared
 
+@MainActor
 class SearchEnginesManagerTests: XCTestCase {
     private let defaultSearchEngineName = "ATester"
     private let expectedEngineNames = ["ATester", "BTester", "CTester", "DTester", "ETester", "FTester"]
@@ -73,9 +75,11 @@ class SearchEnginesManagerTests: XCTestCase {
 
         let exp = expectation(description: "Engine was deleted")
         searchEnginesManager.deleteCustomEngine(testEngine) { [self] in
-            XCTAssertFalse(searchEnginesManager.orderedEngines.contains(where: { $0 == testEngine }))
+            ensureMainThread {
+                XCTAssertFalse(self.searchEnginesManager.orderedEngines.contains(where: { $0 == testEngine }))
 
-            exp.fulfill()
+                exp.fulfill()
+            }
         }
 
         waitForExpectations(timeout: 2)

firefox-ios/firefox-ios-tests/Tests/ClientTests/Frontend/Home/TopSites/TopSitesDataAdaptorTests.swift

@@ -9,6 +9,7 @@ import Shared
 import Storage
 import XCTest
 
+@MainActor
 class TopSitesDataAdaptorTests: XCTestCase, FeatureFlaggable {
     private var profile: MockProfile!
     private var searchEnginesManager: SearchEnginesManager!

firefox-ios/firefox-ios-tests/Tests/ClientTests/Frontend/Home/TopSites/TopSitesViewModelTests.swift

@@ -28,6 +28,7 @@ class TopSitesViewModelTests: XCTestCase {
         super.tearDown()
     }
 
+    @MainActor
     func testDeletionOfSingleSuggestedSite() {
         let viewModel = TopSitesViewModel(profile: profile,
                                           isZeroSearch: false,
@@ -47,6 +48,7 @@ class TopSitesViewModelTests: XCTestCase {
         }))
     }
 
+    @MainActor
     func testDeletionOfAllDefaultSites() {
         let viewModel = TopSitesViewModel(profile: self.profile,
                                           isZeroSearch: false,
@@ -68,6 +70,7 @@ class TopSitesViewModelTests: XCTestCase {
 
 // MARK: Helper methods
 extension TopSitesViewModelTests {
+    @MainActor
     func createViewModel(overridenSiteCount: Int = 40, overridenNumberOfRows: Int = 2) -> TopSitesViewModel {
         let viewModel = TopSitesViewModel(profile: self.profile,
                                           isZeroSearch: false,