Add [Tabs] Updates to tab logging to make it easier for sentry to group logs (backport #26236) (#26362)

Add [Tabs] Updates to tab logging to make it easier for sentry to group logs (#26236)

* updates to tab logging to make it easier for sentry to group logs

* Clean up task in restoreTabs

* remove parameter from task

(cherry picked from commit 50528bb)

Co-authored-by: Carson Ramsden <[email protected]>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

Author: mergify[bot]

firefox-ios/Client/TabManagement/TabManagerImplementation.swift

@@ -609,15 +609,14 @@ class TabManagerImplementation: NSObject, TabManager, FeatureFlaggable {
 
     private func restoreOnly() {
         tabs = [Tab]()
-        Task { [weak self, windowUUID] in
+        Task {
             // Only attempt a tab data store fetch if we know we should have tabs on disk (ignore new windows)
-            let windowIsNew = self?.windowIsNew ?? false
-            let windowData: WindowData? = windowIsNew ? nil : await self?.tabDataStore.fetchWindowData(uuid: windowUUID)
-            await self?.buildTabRestore(window: windowData)
-            Task { @MainActor in
+            let windowData: WindowData? = windowIsNew ? nil : await tabDataStore.fetchWindowData(uuid: windowUUID)
+            await buildTabRestore(window: windowData)
+            await MainActor.run {
                 // Log on main thread, where computed `tab` properties can be accessed without risk of races
-                self?.logger.log("Tabs restore ended after fetching window data", level: .debug, category: .tabs)
-                self?.logger.log("Normal tabs count; \(self?.normalTabs.count ?? 0), Inactive tabs count; \(self?.inactiveTabs.count ?? 0), Private tabs count; \(self?.privateTabs.count ?? 0)", level: .debug, category: .tabs)
+                logger.log("Tabs restore ended after fetching window data", level: .debug, category: .tabs)
+                logger.log("Normal tabs count; \(normalTabs.count), Inactive tabs count; \(inactiveTabs.count), Private tabs count; \(privateTabs.count)", level: .debug, category: .tabs)
             }
         }
     }
@@ -747,9 +746,14 @@ class TabManagerImplementation: NSObject, TabManager, FeatureFlaggable {
         newTab.metadataManager?.tabGroupData = groupData
 
         if newTab.url == nil {
-            logger.log("Tab restored has empty URL for tab id \(tabData.id.uuidString). It was last used \(tabData.lastUsedTime)",
+            logger.log("Tab restored has empty URL",
                        level: .debug,
-                       category: .tabs)
+                       category: .tabs,
+                       extra: [
+                        "tabID": tabData.id.uuidString,
+                        "lastUsedTime": tabData.lastUsedTime.description
+                       ]
+            )
         }
 
         // Restore screenshot

firefox-ios/Client/Telemetry/TabErrorTelemetryHelper.swift

@@ -44,7 +44,7 @@ final class TabErrorTelemetryHelper {
     private func recordTabCount(_ window: WindowUUID) {
         guard self.tabManagerAvailable(for: window) else { return }
         var tabCounts = defaults.object(forKey: defaultsKey) as? [String: Int] ?? [String: Int]()
-        let tabCount = getTabCount(window: window)
+        let tabCount = getTotalTabCount(window: window)
         tabCounts[window.uuidString] = tabCount
         defaults.set(tabCounts, forKey: defaultsKey)
     }
@@ -53,11 +53,16 @@ final class TabErrorTelemetryHelper {
         guard tabManagerAvailable(for: window) else { return }
         guard let tabCounts = defaults.object(forKey: defaultsKey) as? [String: Int],
               let expectedTabCount = tabCounts[window.uuidString] else { return }
-        let currentTabCount = getTabCount(window: window)
+        let currentTabCount = getTotalTabCount(window: window)
+        let currentActiveTabCount = getNormalActiveTabCount(window: window)
 
         if expectedTabCount > 1 && (expectedTabCount - currentTabCount) > 1 {
             // Potential tab loss bug detected. Log a MetricKit error.
-            sendTelemetryTabLossDetectedEvent(expected: expectedTabCount, actual: currentTabCount)
+            sendTelemetryTabLossDetectedEvent(
+                expected: expectedTabCount,
+                actual: currentTabCount,
+                actualNormalActive: currentActiveTabCount
+            )
         }
 
         // After validating the tab count, we make sure to remove the count
@@ -83,15 +88,30 @@ final class TabErrorTelemetryHelper {
         return true
     }
 
-    private func getTabCount(window: WindowUUID) -> Int {
+    private func getTotalTabCount(window: WindowUUID) -> Int {
         assert(tabManagerAvailable(for: window), "getTabCount() should not be called prior to TabManager config.")
         return windowManager.tabManager(for: window).normalTabs.count
     }
 
-    private func sendTelemetryTabLossDetectedEvent(expected: Int, actual: Int) {
-        logger.log("Tab loss detected. Expected: \(expected). Actual: \(actual). Windows: \(windowManager.windows.count)",
+    private func getNormalActiveTabCount(window: WindowUUID) -> Int {
+        assert(
+            tabManagerAvailable(for: window),
+            "getNormalActiveTabCount() should not be called prior to TabManager config."
+        )
+        return windowManager.tabManager(for: window).normalActiveTabs.count
+    }
+
+    private func sendTelemetryTabLossDetectedEvent(expected: Int, actual: Int, actualNormalActive: Int) {
+        logger.log("Tab loss detected",
                    level: .fatal,
-                   category: .tabs)
+                   category: .tabs,
+                   extra: [
+                    "expected": String(expected),
+                    "actual": String(actual),
+                    "actualNormalActive": String(actualNormalActive),
+                    "windows": String(windowManager.windows.count)
+                   ]
+        )
         telemetryWrapper.recordEvent(category: .information,
                                      method: .error,
                                      object: .app,