Add FXIOS-13876 [Toolbar] Record telemetry for middle button customization (#30078)

thatswinnie · web-flow · commit 3aeee99880cb · 2025-10-17T17:59:50.000+02:00
* Add metrics

* Record telemetry

* Add tests

* Rename method

* Add method to record labeled_string metric

* Update toolbar middle button metric and remove boolean metric

* Fix Swiftlint warnings

* Add PR number

* Fix tests
diff --git a/firefox-ios/Client/Frontend/Browser/Toolbars/Redux/ToolbarMiddleware.swift b/firefox-ios/Client/Frontend/Browser/Toolbars/Redux/ToolbarMiddleware.swift
@@ -100,6 +100,8 @@ final class ToolbarMiddleware: FeatureFlaggable {
                 NavigationBarMiddleButtonType.newTab
             }
 
+            toolbarTelemetry.middleButtonType(middleButton)
+
             let action = ToolbarAction(
                 toolbarPosition: toolbarPosition,
                 toolbarLayout: toolbarLayout,
diff --git a/firefox-ios/Client/Frontend/Browser/Toolbars/ToolbarTelemetry.swift b/firefox-ios/Client/Frontend/Browser/Toolbars/ToolbarTelemetry.swift
@@ -12,6 +12,10 @@ struct ToolbarTelemetry {
         self.gleanWrapper = gleanWrapper
     }
 
+    func middleButtonType(_ buttonType: NavigationBarMiddleButtonType) {
+        gleanWrapper.recordString(for: GleanMetrics.UserToolbar.middleButtonType, value: buttonType.rawValue)
+    }
+
     // Tap
     func qrCodeButtonTapped(isPrivate: Bool) {
         let isPrivateExtra = GleanMetrics.Toolbar.QrScanButtonTappedExtra(isPrivate: isPrivate)
diff --git a/firefox-ios/Client/Frontend/Library/Bookmarks/BookmarksTelemetry.swift b/firefox-ios/Client/Frontend/Library/Bookmarks/BookmarksTelemetry.swift
@@ -21,23 +21,23 @@ struct BookmarksTelemetry {
     }
 
     func addBookmark(eventLabel: EventLabel) {
-        gleanWrapper.recordLabel(for: GleanMetrics.Bookmarks.add,
-                                 label: eventLabel.rawValue)
+        gleanWrapper.incrementLabeledCounter(for: GleanMetrics.Bookmarks.add,
+                                             label: eventLabel.rawValue)
     }
 
     func deleteBookmark(eventLabel: EventLabel) {
-        gleanWrapper.recordLabel(for: GleanMetrics.Bookmarks.delete,
-                                 label: eventLabel.rawValue)
+        gleanWrapper.incrementLabeledCounter(for: GleanMetrics.Bookmarks.delete,
+                                             label: eventLabel.rawValue)
     }
 
     func openBookmarksSite(eventLabel: EventLabel) {
-        gleanWrapper.recordLabel(for: GleanMetrics.Bookmarks.open,
-                                 label: eventLabel.rawValue)
+        gleanWrapper.incrementLabeledCounter(for: GleanMetrics.Bookmarks.open,
+                                             label: eventLabel.rawValue)
     }
 
     func editBookmark(eventLabel: EventLabel) {
-        gleanWrapper.recordLabel(for: GleanMetrics.Bookmarks.edit,
-                                 label: eventLabel.rawValue)
+        gleanWrapper.incrementLabeledCounter(for: GleanMetrics.Bookmarks.edit,
+                                             label: eventLabel.rawValue)
     }
 
      func addBookmarkFolder() {
diff --git a/firefox-ios/Client/Glean/probes/toolbar.yaml b/firefox-ios/Client/Glean/probes/toolbar.yaml
@@ -429,3 +429,18 @@ awesomebar:
     notification_emails:
       - fx-ios-data-stewards@mozilla.com
     expires: "2026-01-01"
+    
+user.toolbar:
+  middle_button_type:
+    type: string
+    description: |
+      Records the user's preference for the middle button (newTab or home).
+    send_in_pings:
+      - metrics
+    bugs:
+      - https://github.com/mozilla-mobile/firefox-ios/issues/30060
+    data_reviews:
+      - https://github.com/mozilla-mobile/firefox-ios/pull/30078
+    notification_emails:
+      - fx-ios-data-stewards@mozilla.com
+    expires: "2026-01-01"
diff --git a/firefox-ios/Client/Telemetry/GleanWrapper.swift b/firefox-ios/Client/Telemetry/GleanWrapper.swift
@@ -17,9 +17,10 @@ protocol GleanWrapper {
     func recordEvent<NoExtras>(for metric: EventMetricType<NoExtras>) where NoExtras: EventExtras
     func incrementCounter(for metric: CounterMetricType)
     func recordString(for metric: StringMetricType, value: String)
-    func recordLabel(for metric: LabeledMetricType<CounterMetricType>, label: String)
+    func incrementLabeledCounter(for metric: LabeledMetricType<CounterMetricType>, label: String)
     func setBoolean(for metric: BooleanMetricType, value: Bool)
     func recordQuantity(for metric: QuantityMetricType, value: Int64)
+    func recordLabel(for metric: LabeledMetricType<StringMetricType>, label: String, value: String)
     func recordLabeledQuantity(for metric: LabeledMetricType<QuantityMetricType>, label: String, value: Int64)
     func recordUrl(for metric: UrlMetricType, value: URL)
     func recordDatetime(for metric: DatetimeMetricType, value: Date)
@@ -84,7 +85,7 @@ struct DefaultGleanWrapper: GleanWrapper {
         metric.set(value)
     }
 
-    func recordLabel(for metric: LabeledMetricType<CounterMetricType>, label: String) {
+    func incrementLabeledCounter(for metric: LabeledMetricType<CounterMetricType>, label: String) {
         metric[label].add()
     }
 
@@ -96,6 +97,10 @@ struct DefaultGleanWrapper: GleanWrapper {
         metric.set(value)
     }
 
+    func recordLabel(for metric: LabeledMetricType<StringMetricType>, label: String, value: String) {
+        metric[label].set(value)
+    }
+
     func recordLabeledQuantity(for metric: LabeledMetricType<QuantityMetricType>, label: String, value: Int64) {
         metric[label].set(value)
     }
diff --git a/firefox-ios/Client/Telemetry/HomepageTelemetry.swift b/firefox-ios/Client/Telemetry/HomepageTelemetry.swift
@@ -49,7 +49,7 @@ struct HomepageTelemetry {
     }
 
     func sendSectionLabeledCounter(for itemType: ItemType) {
-        gleanWrapper.recordLabel(for: GleanMetrics.Homepage.sectionViewed, label: itemType.sectionName)
+        gleanWrapper.incrementLabeledCounter(for: GleanMetrics.Homepage.sectionViewed, label: itemType.sectionName)
     }
 
     // MARK: - Top Sites
@@ -70,7 +70,7 @@ struct HomepageTelemetry {
 
     func sendTopSitesPressedEvent(position: Int, tileType: String, isZeroSearch: Bool) {
         let originExtra: TelemetryWrapper.EventValue = isZeroSearch ? .fxHomepageOriginZeroSearch : .fxHomepageOriginOther
-        gleanWrapper.recordLabel(
+        gleanWrapper.incrementLabeledCounter(
             for: GleanMetrics.TopSites.pressedTileOrigin,
             label: originExtra.rawValue
         )
@@ -83,8 +83,8 @@ struct HomepageTelemetry {
     // MARK: - Pocket
     func sendTapOnPocketStoryCounter(position: Int, isZeroSearch: Bool) {
         let originExtra: TelemetryWrapper.EventValue = isZeroSearch ? .fxHomepageOriginZeroSearch : .fxHomepageOriginOther
-        gleanWrapper.recordLabel(for: GleanMetrics.Pocket.openStoryOrigin, label: originExtra.rawValue)
-        gleanWrapper.recordLabel(for: GleanMetrics.Pocket.openStoryPosition, label: "position-\(position)")
+        gleanWrapper.incrementLabeledCounter(for: GleanMetrics.Pocket.openStoryOrigin, label: originExtra.rawValue)
+        gleanWrapper.incrementLabeledCounter(for: GleanMetrics.Pocket.openStoryPosition, label: "position-\(position)")
     }
 
     func sendPocketSectionCounter() {
diff --git a/firefox-ios/firefox-ios-tests/Tests/ClientTests/Frontend/Homepage Rebuild/Redux/HomepageMiddlewareTests.swift b/firefox-ios/firefox-ios-tests/Tests/ClientTests/Frontend/Homepage Rebuild/Redux/HomepageMiddlewareTests.swift
@@ -240,7 +240,7 @@ final class HomepageMiddlewareTests: XCTestCase, StoreTestUtility {
         let resultMetricType = type(of: savedMetric)
         let debugMessage = TelemetryDebugMessage(expectedMetric: expectedMetricType, resultMetric: resultMetricType)
 
-        XCTAssertEqual(mockGleanWrapper.recordLabelCalled, 1)
+        XCTAssertEqual(mockGleanWrapper.incrementLabeledCounterCalled, 1)
         XCTAssert(resultMetricType == expectedMetricType, debugMessage.text)
         XCTAssertEqual(mockGleanWrapper?.savedLabel as? String, "top_sites")
     }
diff --git a/firefox-ios/firefox-ios-tests/Tests/ClientTests/Frontend/Homepage Rebuild/Redux/MerinoMiddlewareTests.swift b/firefox-ios/firefox-ios-tests/Tests/ClientTests/Frontend/Homepage Rebuild/Redux/MerinoMiddlewareTests.swift
@@ -157,7 +157,7 @@ final class MerinoMiddlewareTests: XCTestCase, StoreTestUtility {
         )
 
         XCTAssertEqual(mockGleanWrapper.savedEvents.count, 2)
-        XCTAssertEqual(mockGleanWrapper.recordLabelCalled, 2)
+        XCTAssertEqual(mockGleanWrapper.incrementLabeledCounterCalled, 2)
         XCTAssert(firstResultMetricType == expectedFirstMetricType, debugMessage.text)
         XCTAssert(secondResultMetricType == expectedSecondMetricType, secondDebugMessage.text)
     }
diff --git a/firefox-ios/firefox-ios-tests/Tests/ClientTests/Frontend/Homepage Rebuild/Redux/TopSitesMiddlewareTests.swift b/firefox-ios/firefox-ios-tests/Tests/ClientTests/Frontend/Homepage Rebuild/Redux/TopSitesMiddlewareTests.swift
@@ -193,7 +193,7 @@ final class TopSitesMiddlewareTests: XCTestCase, StoreTestUtility {
         try checkTopSitesPressedMetrics(label: "zero-search", position: "0", tileType: "sponsored")
 
         XCTAssertEqual(mockGleanWrapper.savedEvents.count, 2)
-        XCTAssertEqual(mockGleanWrapper.recordLabelCalled, 1)
+        XCTAssertEqual(mockGleanWrapper.incrementLabeledCounterCalled, 1)
         XCTAssertEqual(mockGleanWrapper.recordEventCalled, 1)
         XCTAssertEqual(sponsoredTelemetry.sendClickTelemetryCalled, 1)
         XCTAssertEqual(unifiedAdsTelemetry.sendClickTelemetryCalled, 0)
@@ -222,7 +222,7 @@ final class TopSitesMiddlewareTests: XCTestCase, StoreTestUtility {
         try checkTopSitesPressedMetrics(label: "zero-search", position: "0", tileType: "sponsored")
 
         XCTAssertEqual(mockGleanWrapper.savedEvents.count, 2)
-        XCTAssertEqual(mockGleanWrapper.recordLabelCalled, 1)
+        XCTAssertEqual(mockGleanWrapper.incrementLabeledCounterCalled, 1)
         XCTAssertEqual(mockGleanWrapper.recordEventCalled, 1)
         XCTAssertEqual(unifiedAdsTelemetry.sendClickTelemetryCalled, 1)
         XCTAssertEqual(sponsoredTelemetry.sendClickTelemetryCalled, 0)
@@ -254,7 +254,7 @@ final class TopSitesMiddlewareTests: XCTestCase, StoreTestUtility {
         try checkTopSitesPressedMetrics(label: "origin-other", position: "1", tileType: "suggested")
 
         XCTAssertEqual(mockGleanWrapper.savedEvents.count, 2)
-        XCTAssertEqual(mockGleanWrapper.recordLabelCalled, 1)
+        XCTAssertEqual(mockGleanWrapper.incrementLabeledCounterCalled, 1)
         XCTAssertEqual(mockGleanWrapper.recordEventCalled, 1)
         XCTAssertEqual(sponsoredTelemetry.sendClickTelemetryCalled, 0)
         XCTAssertEqual(unifiedAdsTelemetry.sendImpressionTelemetryCalled, 0)
diff --git a/firefox-ios/firefox-ios-tests/Tests/ClientTests/Library/Bookmarks/BookmarksTelemetryTests.swift b/firefox-ios/firefox-ios-tests/Tests/ClientTests/Library/Bookmarks/BookmarksTelemetryTests.swift
@@ -31,7 +31,7 @@ final class BookmarksTelemetryTests: XCTestCase {
         let resultMetricType = type(of: savedMetric)
         let debugMessage = TelemetryDebugMessage(expectedMetric: expectedMetricType, resultMetric: resultMetricType)
         XCTAssert(resultMetricType == expectedMetricType, debugMessage.text)
-        XCTAssertEqual(gleanWrapper.recordLabelCalled, 1)
+        XCTAssertEqual(gleanWrapper.incrementLabeledCounterCalled, 1)
     }
 
     func testRecordBookmark_WhenDeletedBookmark_ThenGleanIsCalled() throws {
@@ -42,7 +42,7 @@ final class BookmarksTelemetryTests: XCTestCase {
         let resultMetricType = type(of: savedMetric)
         let debugMessage = TelemetryDebugMessage(expectedMetric: expectedMetricType, resultMetric: resultMetricType)
         XCTAssert(resultMetricType == expectedMetricType, debugMessage.text)
-        XCTAssertEqual(gleanWrapper.recordLabelCalled, 1)
+        XCTAssertEqual(gleanWrapper.incrementLabeledCounterCalled, 1)
     }
 
     func testRecordBookmark_WhenOpenedSite_ThenGleanIsCalled() throws {
@@ -53,7 +53,7 @@ final class BookmarksTelemetryTests: XCTestCase {
         let resultMetricType = type(of: savedMetric)
         let debugMessage = TelemetryDebugMessage(expectedMetric: expectedMetricType, resultMetric: resultMetricType)
         XCTAssert(resultMetricType == expectedMetricType, debugMessage.text)
-        XCTAssertEqual(gleanWrapper.recordLabelCalled, 1)
+        XCTAssertEqual(gleanWrapper.incrementLabeledCounterCalled, 1)
     }
 
     func testRecordBookmark_WhenEditedSite_ThenGleanIsCalled() throws {
@@ -64,7 +64,7 @@ final class BookmarksTelemetryTests: XCTestCase {
         let resultMetricType = type(of: savedMetric)
         let debugMessage = TelemetryDebugMessage(expectedMetric: expectedMetricType, resultMetric: resultMetricType)
         XCTAssert(resultMetricType == expectedMetricType, debugMessage.text)
-        XCTAssertEqual(gleanWrapper.recordLabelCalled, 1)
+        XCTAssertEqual(gleanWrapper.incrementLabeledCounterCalled, 1)
     }
 
     func testRecordBookmark_WhenAddedFolder_ThenGleanIsCalled() throws {
diff --git a/firefox-ios/firefox-ios-tests/Tests/ClientTests/Mocks/MockGleanWrapper.swift b/firefox-ios/firefox-ios-tests/Tests/ClientTests/Mocks/MockGleanWrapper.swift
@@ -14,6 +14,7 @@ class MockGleanWrapper: GleanWrapper {
     var incrementCounterCalled = 0
     var recordStringCalled = 0
     var recordLabelCalled = 0
+    var incrementLabeledCounterCalled = 0
     var setBooleanCalled = 0
     var recordQuantityCalled = 0
     var recordLabeledQuantityCalled = 0
@@ -71,10 +72,10 @@ class MockGleanWrapper: GleanWrapper {
         recordStringCalled += 1
     }
 
-    func recordLabel(for metric: LabeledMetricType<CounterMetricType>, label: String) {
+    func incrementLabeledCounter(for metric: LabeledMetricType<CounterMetricType>, label: String) {
         savedLabel = label
         savedEvents.append(metric)
-        recordLabelCalled += 1
+        incrementLabeledCounterCalled += 1
     }
 
     func setBoolean(for metric: BooleanMetricType, value: Bool) {
@@ -87,7 +88,14 @@ class MockGleanWrapper: GleanWrapper {
         recordQuantityCalled += 1
     }
 
+    func recordLabel(for metric: LabeledMetricType<StringMetricType>, label: String, value: String) {
+        savedEvents.append(metric)
+        recordLabelCalled += 1
+    }
+
     func recordLabeledQuantity(for metric: LabeledMetricType<QuantityMetricType>, label: String, value: Int64) {
+        savedLabel = label
+        savedValues.append(value)
         savedEvents.append(metric)
         recordLabeledQuantityCalled += 1
     }
diff --git a/firefox-ios/firefox-ios-tests/Tests/ClientTests/Toolbar/ToolbarMiddlewareTests.swift b/firefox-ios/firefox-ios-tests/Tests/ClientTests/Toolbar/ToolbarMiddlewareTests.swift
@@ -73,6 +73,11 @@ final class ToolbarMiddlewareTests: XCTestCase, StoreTestUtility {
         XCTAssertEqual(actionCalled.addressBorderPosition, borderPosition)
         XCTAssertEqual(actionCalled.displayNavBorder, displayBorder)
         XCTAssertEqual(actionCalled.middleButton, .newTab)
+
+        let savedValue = try XCTUnwrap(
+            mockGleanWrapper.savedValues.first as? String
+        )
+        XCTAssertEqual(savedValue, "newTab")
     }
 
     func testBrowserDidLoad_withHomeCustomMiddleButton_dispatchesDidLoadToolbars() throws {

Original file line number	Diff line number	Diff line change
`@@ -100,6 +100,8 @@ final class ToolbarMiddleware: FeatureFlaggable {`
`100`	`100`	`NavigationBarMiddleButtonType.newTab`
`101`	`101`	`}`
`102`	`102`
	`103`	`+ toolbarTelemetry.middleButtonType(middleButton)`
	`104`	`+`
`103`	`105`	`let action = ToolbarAction(`
`104`	`106`	`toolbarPosition: toolbarPosition,`
`105`	`107`	`toolbarLayout: toolbarLayout,`
Original file line number	Diff line number	Diff line change
`@@ -21,23 +21,23 @@ struct BookmarksTelemetry {`
`21`	`21`	`}`
`22`	`22`
`23`	`23`	`func addBookmark(eventLabel: EventLabel) {`
`24`		`- gleanWrapper.recordLabel(for: GleanMetrics.Bookmarks.add,`
`25`		`- label: eventLabel.rawValue)`
	`24`	`+ gleanWrapper.incrementLabeledCounter(for: GleanMetrics.Bookmarks.add,`
	`25`	`+ label: eventLabel.rawValue)`
`26`	`26`	`}`
`27`	`27`
`28`	`28`	`func deleteBookmark(eventLabel: EventLabel) {`
`29`		`- gleanWrapper.recordLabel(for: GleanMetrics.Bookmarks.delete,`
`30`		`- label: eventLabel.rawValue)`
	`29`	`+ gleanWrapper.incrementLabeledCounter(for: GleanMetrics.Bookmarks.delete,`
	`30`	`+ label: eventLabel.rawValue)`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`func openBookmarksSite(eventLabel: EventLabel) {`
`34`		`- gleanWrapper.recordLabel(for: GleanMetrics.Bookmarks.open,`
`35`		`- label: eventLabel.rawValue)`
	`34`	`+ gleanWrapper.incrementLabeledCounter(for: GleanMetrics.Bookmarks.open,`
	`35`	`+ label: eventLabel.rawValue)`
`36`	`36`	`}`
`37`	`37`
`38`	`38`	`func editBookmark(eventLabel: EventLabel) {`
`39`		`- gleanWrapper.recordLabel(for: GleanMetrics.Bookmarks.edit,`
`40`		`- label: eventLabel.rawValue)`
	`39`	`+ gleanWrapper.incrementLabeledCounter(for: GleanMetrics.Bookmarks.edit,`
	`40`	`+ label: eventLabel.rawValue)`
`41`	`41`	`}`
`42`	`42`
`43`	`43`	`func addBookmarkFolder() {`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ struct HomepageTelemetry {`
`49`	`49`	`}`
`50`	`50`
`51`	`51`	`func sendSectionLabeledCounter(for itemType: ItemType) {`
`52`		`- gleanWrapper.recordLabel(for: GleanMetrics.Homepage.sectionViewed, label: itemType.sectionName)`
	`52`	`+ gleanWrapper.incrementLabeledCounter(for: GleanMetrics.Homepage.sectionViewed, label: itemType.sectionName)`
`53`	`53`	`}`
`54`	`54`
`55`	`55`	`// MARK: - Top Sites`
`@@ -70,7 +70,7 @@ struct HomepageTelemetry {`
`70`	`70`
`71`	`71`	`func sendTopSitesPressedEvent(position: Int, tileType: String, isZeroSearch: Bool) {`
`72`	`72`	`let originExtra: TelemetryWrapper.EventValue = isZeroSearch ? .fxHomepageOriginZeroSearch : .fxHomepageOriginOther`
`73`		`- gleanWrapper.recordLabel(`
	`73`	`+ gleanWrapper.incrementLabeledCounter(`
`74`	`74`	`for: GleanMetrics.TopSites.pressedTileOrigin,`
`75`	`75`	`label: originExtra.rawValue`
`76`	`76`	`)`
`@@ -83,8 +83,8 @@ struct HomepageTelemetry {`
`83`	`83`	`// MARK: - Pocket`
`84`	`84`	`func sendTapOnPocketStoryCounter(position: Int, isZeroSearch: Bool) {`
`85`	`85`	`let originExtra: TelemetryWrapper.EventValue = isZeroSearch ? .fxHomepageOriginZeroSearch : .fxHomepageOriginOther`
`86`		`- gleanWrapper.recordLabel(for: GleanMetrics.Pocket.openStoryOrigin, label: originExtra.rawValue)`
`87`		`- gleanWrapper.recordLabel(for: GleanMetrics.Pocket.openStoryPosition, label: "position-\(position)")`
	`86`	`+ gleanWrapper.incrementLabeledCounter(for: GleanMetrics.Pocket.openStoryOrigin, label: originExtra.rawValue)`
	`87`	`+ gleanWrapper.incrementLabeledCounter(for: GleanMetrics.Pocket.openStoryPosition, label: "position-\(position)")`
`88`	`88`	`}`
`89`	`89`
`90`	`90`	`func sendPocketSectionCounter() {`
Original file line number	Diff line number	Diff line change
`@@ -240,7 +240,7 @@ final class HomepageMiddlewareTests: XCTestCase, StoreTestUtility {`
`240`	`240`	`let resultMetricType = type(of: savedMetric)`
`241`	`241`	`let debugMessage = TelemetryDebugMessage(expectedMetric: expectedMetricType, resultMetric: resultMetricType)`
`242`	`242`
`243`		`- XCTAssertEqual(mockGleanWrapper.recordLabelCalled, 1)`
	`243`	`+ XCTAssertEqual(mockGleanWrapper.incrementLabeledCounterCalled, 1)`
`244`	`244`	`XCTAssert(resultMetricType == expectedMetricType, debugMessage.text)`
`245`	`245`	`XCTAssertEqual(mockGleanWrapper?.savedLabel as? String, "top_sites")`
`246`	`246`	`}`
Original file line number	Diff line number	Diff line change
`@@ -157,7 +157,7 @@ final class MerinoMiddlewareTests: XCTestCase, StoreTestUtility {`
`157`	`157`	`)`
`158`	`158`
`159`	`159`	`XCTAssertEqual(mockGleanWrapper.savedEvents.count, 2)`
`160`		`- XCTAssertEqual(mockGleanWrapper.recordLabelCalled, 2)`
	`160`	`+ XCTAssertEqual(mockGleanWrapper.incrementLabeledCounterCalled, 2)`
`161`	`161`	`XCTAssert(firstResultMetricType == expectedFirstMetricType, debugMessage.text)`
`162`	`162`	`XCTAssert(secondResultMetricType == expectedSecondMetricType, secondDebugMessage.text)`
`163`	`163`	`}`