Refactor FXIOS-11147 [Tab Optomization Phase 1] Additional Tab Manager cleanup

BrowserKit/Sources/Shared/NotificationConstants.swift

@@ -67,8 +67,6 @@ extension Notification.Name {
 
     public static let WallpaperDidChange = Notification.Name("WallpaperDidChange")
 
-    public static let UpdateLabelOnTabClosed = Notification.Name("UpdateLabelOnTabClosed")
-
     public static let TopTabsTabClosed = Notification.Name("TopTabsTabClosed")
 
     public static let ShowHomepage = Notification.Name("ShowHomepage")

firefox-ios/Client/Frontend/Browser/BrowserViewController/Extensions/BrowserViewController+KeyCommands.swift

@@ -195,13 +195,15 @@ extension BrowserViewController {
 
     @objc
     func closeTabKeyCommand() {
-        TelemetryWrapper.recordEvent(category: .action,
-                                     method: .press,
-                                     object: .keyCommand,
-                                     extras: ["action": "close-tab"])
-        guard let currentTab = tabManager.selectedTab else { return }
-        tabManager.removeTab(currentTab)
-        keyboardPressesHandler().reset()
+        Task {
+            TelemetryWrapper.recordEvent(category: .action,
+                                         method: .press,
+                                         object: .keyCommand,
+                                         extras: ["action": "close-tab"])
+            guard let currentTab = tabManager.selectedTab else { return }
+            await tabManager.removeTab(currentTab.tabUUID)
+            keyboardPressesHandler().reset()
+        }
     }
 
     @objc

firefox-ios/Client/Frontend/Browser/BrowserViewController/Extensions/BrowserViewController+TabToolbarDelegate.swift

@@ -319,9 +319,10 @@ extension BrowserViewController: TabToolbarDelegate, PhotonActionSheetProtocol {
                                      iconString: StandardImageIdentifiers.Large.cross,
                                      iconType: .Image) { _ in
             if let tab = self.tabManager.selectedTab {
-                self.tabManager.removeTab(tab)
-                self.updateTabCountUsingTabManager(self.tabManager)
-                self.showToast(message: .TabsTray.CloseTabsToast.SingleTabTitle, toastAction: .closeTab)
+                self.tabManager.removeTabWithCompletion(tab.tabUUID) {
+                    self.updateTabCountUsingTabManager(self.tabManager)
+                    self.showToast(message: .TabsTray.CloseTabsToast.SingleTabTitle, toastAction: .closeTab)
+                }
             }
         }.items
     }

firefox-ios/Client/Frontend/Browser/BrowserViewController/Extensions/BrowserViewController+WebViewDelegates.swift

@@ -188,10 +188,11 @@ extension BrowserViewController: WKUIDelegate {
     }
 
     func webViewDidClose(_ webView: WKWebView) {
-        if let tab = tabManager[webView] {
-            // Need to wait here in case we're waiting for a pending `window.open()`.
-            DispatchQueue.main.asyncAfter(deadline: .now() + .milliseconds(100)) {
-                self.tabManager.removeTab(tab)
+        Task {
+            if let tab = tabManager[webView] {
+                // Need to wait here in case we're waiting for a pending `window.open()`.
+                try await Task.sleep(nanoseconds: NSEC_PER_MSEC * 100)
+                await tabManager.removeTab(tab.tabUUID)
             }
         }
     }
@@ -552,7 +553,7 @@ extension BrowserViewController: WKNavigationDelegate {
                     if let currentTab = self?.tabManager.selectedTab,
                        currentTab.historyList.count == 1,
                        self?.isStoreURL(currentTab.historyList[0]) ?? false {
-                        self?.tabManager.removeTab(tab)
+                        self?.tabManager.removeTabWithCompletion(tab.tabUUID, completion: nil)
                     }
                 }
             }

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

@@ -328,12 +328,13 @@ class TopTabDisplayManager: NSObject {
             // If it is the last tab of regular mode we automatically create an new tab
             if !self.isPrivate,
                tabsToDisplay.count == 1 {
-                self.tabManager.removeTabs([tab])
-                self.tabManager.selectTab(self.tabManager.addTab())
+                self.tabManager.removeTabWithCompletion(tab.tabUUID) {
+                    self.tabManager.selectTab(self.tabManager.addTab())
+                }
                 return
             }
 
-            self.tabManager.removeTab(tab)
+            self.tabManager.removeTabWithCompletion(tab.tabUUID, completion: nil)
         }
     }
 

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

@@ -147,7 +147,7 @@ class TopTabsViewController: UIViewController, Themeable, Notifiable, FeatureFla
     }
 
     deinit {
-        tabManager.removeDelegate(self.topTabDisplayManager)
+        tabManager.removeDelegate(self.topTabDisplayManager, completion: nil)
     }
 
     override func viewDidLoad() {

firefox-ios/Client/TabManagement/TabManager.swift

@@ -18,60 +18,62 @@ protocol TabManager: AnyObject {
     var isRestoringTabs: Bool { get }
     var delaySelectingNewPopupTab: TimeInterval { get }
     var recentlyAccessedNormalTabs: [Tab] { get }
-    var tabs: [Tab] { get }
     var count: Int { get }
+
     var selectedTab: Tab? { get }
     var backupCloseTab: BackupCloseTab? { get set }
+
+    var tabs: [Tab] { get }
     var normalTabs: [Tab] { get } // Includes active and inactive tabs
     var normalActiveTabs: [Tab] { get }
     var inactiveTabs: [Tab] { get }
     var privateTabs: [Tab] { get }
+
     subscript(index: Int) -> Tab? { get }
     subscript(webView: WKWebView) -> Tab? { get }
 
+    // MARK: - Add/Remove Delegate
     func addDelegate(_ delegate: TabManagerDelegate)
     func addNavigationDelegate(_ delegate: WKNavigationDelegate)
     func removeDelegate(_ delegate: TabManagerDelegate, completion: (() -> Void)?)
+
+    // MARK: - Select Tab
     func selectTab(_ tab: Tab?, previous: Tab?)
-    func addTab(_ request: URLRequest?, afterTab: Tab?, isPrivate: Bool) -> Tab
-    func addTabsForURLs(_ urls: [URL], zombie: Bool, shouldSelectTab: Bool, isPrivate: Bool)
-    func removeTab(_ tab: Tab, completion: (() -> Void)?)
-    func removeTabs(_ tabs: [Tab])
-    func undoCloseTab()
-    func getMostRecentHomepageTab() -> Tab?
-    func clearAllTabsHistory()
-    func cleanupClosedTabs(_ closedTabs: [Tab], previous: Tab?, isPrivate: Bool)
-    func reorderTabs(isPrivate privateMode: Bool, fromIndex visibleFromIndex: Int, toIndex visibleToIndex: Int)
-    func preserveTabs()
-    func restoreTabs(_ forced: Bool)
-    func startAtHomeCheck() -> Bool
-    func getTabForUUID(uuid: TabUUID) -> Tab?
-    func getTabForURL(_ url: URL) -> Tab?
-    func expireLoginAlerts()
-    @discardableResult
-    func switchPrivacyMode() -> SwitchPrivacyModeResult
-    func addPopupForParentTab(profile: Profile, parentTab: Tab, configuration: WKWebViewConfiguration) -> Tab
 
+    // MARK: - Add Tab
+    func addTabsForURLs(_ urls: [URL], zombie: Bool, shouldSelectTab: Bool, isPrivate: Bool)
     @discardableResult
     func addTab(_ request: URLRequest?,
                 afterTab: Tab?,
                 zombie: Bool,
                 isPrivate: Bool) -> Tab
-    // MARK: TabTray refactor interfaces
 
-    /// Async Remove tab option using tabUUID. Replaces direct usage of removeTab where the whole Tab is needed
+    // MARK: - Remove Tab
+    // TODO: FXIOS-11272 Remove this function in favor of the async remove tab.
+    /// GCD remove tab option using tabUUID with completion
+    /// - Parameters:
+    ///   - tabUUID: UUID from the tab
+    ///   - completion: closure called after remove tab completes on main thread
+    func removeTabWithCompletion(_ tabUUID: TabUUID, completion: (() -> Void)?)
+
+    /// Async Remove tab option using tabUUID.
     /// - Parameter tabUUID: UUID from the tab
     func removeTab(_ tabUUID: TabUUID) async
 
     /// Async Remove all tabs indicating if is on private mode or not
     /// - Parameter isPrivateMode: Is private mode enabled or not
     func removeAllTabs(isPrivateMode: Bool) async
 
+    /// Removes all tabs matching the urls, used when other clients request to close tabs on this device.
+    func removeTabs(by urls: [URL]) async
+    func removeTabs(_ tabs: [Tab])
+
+    // MARK: - Undo Close
+    func undoCloseTab()
     /// Undo close all tabs, it will restore the tabs that were backed up when the close action was called.
     func undoCloseAllTabs()
 
-    /// Removes all tabs matching the urls, used when other clients request to close tabs on this device.
-    func removeTabs(by urls: [URL]) async
+    // MARK: Inactive Tabs
 
     /// Get inactive tabs from the list of tabs based on the time condition to be considered inactive.
     /// Replaces LegacyInactiveTabModel and related classes
@@ -84,38 +86,33 @@ protocol TabManager: AnyObject {
 
     /// Undo all inactive tabs closure. All inactive tabs are added back to the list of tabs
     func undoCloseInactiveTabs() async
+
+    // MARK: Get Tab
+    func getTabForUUID(uuid: TabUUID) -> Tab?
+    func getTabForURL(_ url: URL) -> Tab?
+    func getMostRecentHomepageTab() -> Tab?
+
+    // MARK: Other Tab Actions
+    func clearAllTabsHistory()
+    func reorderTabs(isPrivate privateMode: Bool, fromIndex visibleFromIndex: Int, toIndex visibleToIndex: Int)
+    func preserveTabs()
+    func restoreTabs(_ forced: Bool)
+    func startAtHomeCheck() -> Bool
+    func expireLoginAlerts()
+    @discardableResult
+    func switchPrivacyMode() -> SwitchPrivacyModeResult
+    func addPopupForParentTab(profile: Profile, parentTab: Tab, configuration: WKWebViewConfiguration) -> Tab
 }
 
 extension TabManager {
-    func removeDelegate(_ delegate: TabManagerDelegate) {
-        removeDelegate(delegate, completion: nil)
-    }
-
     func selectTab(_ tab: Tab?) {
         selectTab(tab, previous: nil)
     }
 
-    func removeTab(_ tab: Tab) {
-        let uuid = windowUUID
-        removeTab(tab) {
-            NotificationCenter.default.post(name: .UpdateLabelOnTabClosed,
-                                            object: nil,
-                                            userInfo: uuid.userInfo)
-        }
-    }
-
     func restoreTabs(_ forced: Bool = false) {
         restoreTabs(forced)
     }
 
-    func cleanupClosedTabs(_ closedTabs: [Tab],
-                           previous: Tab?,
-                           isPrivate: Bool = false) {
-        cleanupClosedTabs(closedTabs,
-                          previous: previous,
-                          isPrivate: isPrivate)
-    }
-
     @discardableResult
     func addTab(_ request: URLRequest? = nil,
                 afterTab: Tab? = nil,

firefox-ios/Client/TabManagement/TabManagerImplementation.swift

@@ -238,8 +238,10 @@ class TabManagerImplementation: NSObject, TabManager, FeatureFlaggable, TabEvent
         )
     }
 
-    func removeTab(_ tab: Tab, completion: (() -> Void)? = nil) {
-        guard let index = tabs.firstIndex(where: { $0 === tab }) else { return }
+    func removeTabWithCompletion(_ tabUUID: TabUUID, completion: (() -> Void)?) {
+        guard let index = tabs.firstIndex(where: { $0.tabUUID == tabUUID }) else { return }
+        let tab = tabs[index]
+
         DispatchQueue.main.async { [weak self] in
             self?.removeTab(tab, flushToDisk: true)
             self?.updateSelectedTabAfterRemovalOf(tab, deletedIndex: index)
@@ -269,9 +271,7 @@ class TabManagerImplementation: NSObject, TabManager, FeatureFlaggable, TabEvent
             return urls.contains(url)
         }
         for tab in tabsToRemove {
-            await withCheckedContinuation { continuation in
-                removeTab(tab) { continuation.resume() }
-            }
+            await removeTab(tab.tabUUID)
         }
     }
 
@@ -1017,19 +1017,12 @@ class TabManagerImplementation: NSObject, TabManager, FeatureFlaggable, TabEvent
             tabToSelect = addTab(request, afterTab: selectedTab, isPrivate: selectedTab.isPrivate)
         }
         selectTab(tabToSelect)
-        removeTab(selectedTab)
+        removeTabWithCompletion(selectedTab.tabUUID, completion: nil)
         Task {
             await tabSessionStore.deleteUnusedTabSessionData(keeping: [])
         }
     }
 
-    func closeTab(by url: URL) {
-        // Find the tab with the specified URL
-        if let tabToClose = tabs.first(where: { $0.url == url }) {
-            self.removeTab(tabToClose)
-        }
-    }
-
     func reorderTabs(isPrivate privateMode: Bool, fromIndex visibleFromIndex: Int, toIndex visibleToIndex: Int) {
         let currentTabs = privateMode ? privateTabs : normalActiveTabs
 

firefox-ios/firefox-ios-tests/Tests/ClientTests/Mocks/MockTabManager.swift

@@ -61,13 +61,6 @@ class MockTabManager: TabManager {
         }
     }
 
-    func addTab(_ request: URLRequest?, afterTab: Tab?, isPrivate: Bool) -> Tab {
-        let profile = MockProfile()
-        let tab = Tab(profile: profile, isPrivate: isPrivate, windowUUID: windowUUID)
-        tabs.append(tab)
-        return tab
-    }
-
     func getMostRecentHomepageTab() -> Tab? {
         return addTab(nil, afterTab: nil, isPrivate: false)
     }
@@ -85,11 +78,11 @@ class MockTabManager: TabManager {
 
     func reAddTabs(tabsToAdd: [Tab], previousTabUUID: String) {}
 
-    func removeTab(_ tab: Tab, completion: (() -> Void)?) {}
+    func removeTabWithCompletion(_ tabUUID: TabUUID, completion: (() -> Void)?) {}
 
     func removeTabs(_ tabs: [Tab]) {}
 
-    func removeTab(_ tabUUID: String) async {}
+    func removeTab(_ tabUUID: TabUUID) async {}
 
     func removeAllTabs(isPrivateMode: Bool) async {}
 
@@ -105,8 +98,6 @@ class MockTabManager: TabManager {
 
     func willSwitchTabMode(leavingPBM: Bool) {}
 
-    func cleanupClosedTabs(_ closedTabs: [Tab], previous: Tab?, isPrivate: Bool) {}
-
     func reorderTabs(isPrivate privateMode: Bool, fromIndex visibleFromIndex: Int, toIndex visibleToIndex: Int) {}
 
     func preserveTabs() {}