Skip to content

Refactor FXIOS-12469 [TA 2025] Update MockGleanWrapper functionality to test extras from multiple events fired in a single test #27197

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 11, 2025
Merged

Refactor FXIOS-12469 [TA 2025] Update MockGleanWrapper functionality to test extras from multiple events fired in a single test #27197

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
78f0372
Update MockGleanWrapper functionality to test extras from multiple ev…
ih-codes Jun 9, 2025
8999be9
Update GleanWrapper test usage for non-optional events and added extr…
ih-codes Jun 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions ...firefox-ios-tests/Tests/ClientTests/AppIconSelection/AppIconSelectionTelemetryTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,10 @@ final class AppIconSelectionTelemetryTests: XCTestCase {
subject.selectedIcon(expectedNewAppIcon, previousIcon: expectedOldAppIcon)

let savedExtras = try XCTUnwrap(
mockGleanWrapper.savedExtras as? EventExtrasType
mockGleanWrapper.savedExtras.first as? EventExtrasType
)
let savedMetric = try XCTUnwrap(
mockGleanWrapper.savedEvents?.first as? EventMetricType<EventExtrasType>
mockGleanWrapper.savedEvents.first as? EventMetricType<EventExtrasType>
)
let resultMetricType = type(of: savedMetric)
let debugMessage = TelemetryDebugMessage(expectedMetric: expectedMetricType, resultMetric: resultMetricType)
Expand Down
12 changes: 6 additions & 6 deletions ...ios-tests/Tests/ClientTests/Frontend/Home/TopSites/UnifiedAdsCallbackTelemetryTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,19 +68,19 @@ class UnifiedAdsCallbackTelemetryTests: XCTestCase {
return
}
XCTAssertEqual(asAnyHashable(savedPing), asAnyHashable(GleanMetrics.Pings.shared.topsitesImpression))
XCTAssertEqual(gleanWrapper.savedEvents?.count, 2)
XCTAssertEqual(gleanWrapper.savedEvents.count, 2)

// Ensuring we call the right metrics type
let firstSavedMetric = try XCTUnwrap(
gleanWrapper.savedEvents?[0] as? EventMetricType<GleanMetrics.TopSites.ContileImpressionExtra>
gleanWrapper.savedEvents.first as? EventMetricType<GleanMetrics.TopSites.ContileImpressionExtra>
)
let expectedFirstMetricType = type(of: GleanMetrics.TopSites.contileImpression)
let firstResultMetricType = type(of: firstSavedMetric)
let debugMessage = TelemetryDebugMessage(expectedMetric: expectedFirstMetricType,
resultMetric: firstResultMetricType)
XCTAssert(firstResultMetricType == expectedFirstMetricType, debugMessage.text)

let secondSavedMetric = try XCTUnwrap(gleanWrapper.savedEvents?[1] as? StringMetricType)
let secondSavedMetric = try XCTUnwrap(gleanWrapper.savedEvents[safe: 1] as? StringMetricType)
let expectedSecondMetricType = type(of: GleanMetrics.TopSites.contileAdvertiser)
let secondResultMetricType = type(of: secondSavedMetric)
let secondDebugMessage = TelemetryDebugMessage(expectedMetric: expectedSecondMetricType,
Expand All @@ -102,19 +102,19 @@ class UnifiedAdsCallbackTelemetryTests: XCTestCase {
return
}
XCTAssertEqual(asAnyHashable(savedPing), asAnyHashable(GleanMetrics.Pings.shared.topsitesImpression))
XCTAssertEqual(gleanWrapper.savedEvents?.count, 2)
XCTAssertEqual(gleanWrapper.savedEvents.count, 2)

// Ensuring we call the right metrics type
let firstSavedMetric = try XCTUnwrap(
gleanWrapper.savedEvents?[0] as? EventMetricType<GleanMetrics.TopSites.ContileClickExtra>
gleanWrapper.savedEvents.first as? EventMetricType<GleanMetrics.TopSites.ContileClickExtra>
)
let expectedFirstMetricType = type(of: GleanMetrics.TopSites.contileClick)
let firstResultMetricType = type(of: firstSavedMetric)
let debugMessage = TelemetryDebugMessage(expectedMetric: expectedFirstMetricType,
resultMetric: firstResultMetricType)
XCTAssert(firstResultMetricType == expectedFirstMetricType, debugMessage.text)

let secondSavedMetric = try XCTUnwrap(gleanWrapper.savedEvents?[1] as? StringMetricType)
let secondSavedMetric = try XCTUnwrap(gleanWrapper.savedEvents[safe: 1] as? StringMetricType)
let expectedSecondMetricType = type(of: GleanMetrics.TopSites.contileAdvertiser)
let secondResultMetricType = type(of: secondSavedMetric)
let secondDebugMessage = TelemetryDebugMessage(expectedMetric: expectedSecondMetricType,
Expand Down
26 changes: 13 additions & 13 deletions ...ios-tests/Tests/ClientTests/Frontend/Homepage Rebuild/Redux/HomepageMiddlewareTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ final class HomepageMiddlewareTests: XCTestCase, StoreTestUtility {

subject.homepageProvider(AppState(), action)

let savedMetric = try XCTUnwrap(mockGleanWrapper.savedEvents?[0] as? EventMetricType<NoExtras>)
let savedMetric = try XCTUnwrap(mockGleanWrapper.savedEvents.first as? EventMetricType<NoExtras>)
let expectedMetricType = type(of: GleanMetrics.Homepage.viewed)
let resultMetricType = type(of: savedMetric)
let debugMessage = TelemetryDebugMessage(expectedMetric: expectedMetricType, resultMetric: resultMetricType)
Expand All @@ -71,7 +71,7 @@ final class HomepageMiddlewareTests: XCTestCase, StoreTestUtility {

subject.homepageProvider(AppState(), action)

let savedMetric = try XCTUnwrap(mockGleanWrapper.savedEvents?[0] as? EventMetricType<NoExtras>)
let savedMetric = try XCTUnwrap(mockGleanWrapper.savedEvents.first as? EventMetricType<NoExtras>)
let expectedMetricType = type(of: GleanMetrics.Homepage.viewed)
let resultMetricType = type(of: savedMetric)
let debugMessage = TelemetryDebugMessage(expectedMetric: expectedMetricType, resultMetric: resultMetricType)
Expand All @@ -91,10 +91,10 @@ final class HomepageMiddlewareTests: XCTestCase, StoreTestUtility {
subject.homepageProvider(AppState(), action)

let savedMetric = try XCTUnwrap(
mockGleanWrapper.savedEvents?[0] as? EventMetricType<GleanMetrics.Homepage.ItemTappedExtra>
mockGleanWrapper.savedEvents.first as? EventMetricType<GleanMetrics.Homepage.ItemTappedExtra>
)
let savedExtras = try XCTUnwrap(
mockGleanWrapper.savedExtras as? GleanMetrics.Homepage.ItemTappedExtra
mockGleanWrapper.savedExtras.first as? GleanMetrics.Homepage.ItemTappedExtra
)
let expectedMetricType = type(of: GleanMetrics.Homepage.itemTapped)
let resultMetricType = type(of: savedMetric)
Expand All @@ -117,10 +117,10 @@ final class HomepageMiddlewareTests: XCTestCase, StoreTestUtility {
subject.homepageProvider(AppState(), action)

let savedMetric = try XCTUnwrap(
mockGleanWrapper.savedEvents?[0] as? EventMetricType<GleanMetrics.Homepage.ItemTappedExtra>
mockGleanWrapper.savedEvents.first as? EventMetricType<GleanMetrics.Homepage.ItemTappedExtra>
)
let savedExtras = try XCTUnwrap(
mockGleanWrapper.savedExtras as? GleanMetrics.Homepage.ItemTappedExtra
mockGleanWrapper.savedExtras.first as? GleanMetrics.Homepage.ItemTappedExtra
)
let expectedMetricType = type(of: GleanMetrics.Homepage.itemTapped)
let resultMetricType = type(of: savedMetric)
Expand All @@ -143,10 +143,10 @@ final class HomepageMiddlewareTests: XCTestCase, StoreTestUtility {
subject.homepageProvider(AppState(), action)

let savedMetric = try XCTUnwrap(
mockGleanWrapper.savedEvents?[0] as? EventMetricType<GleanMetrics.Homepage.ItemTappedExtra>
mockGleanWrapper.savedEvents.first as? EventMetricType<GleanMetrics.Homepage.ItemTappedExtra>
)
let savedExtras = try XCTUnwrap(
mockGleanWrapper.savedExtras as? GleanMetrics.Homepage.ItemTappedExtra
mockGleanWrapper.savedExtras.first as? GleanMetrics.Homepage.ItemTappedExtra
)
let expectedMetricType = type(of: GleanMetrics.Homepage.itemTapped)
let resultMetricType = type(of: savedMetric)
Expand All @@ -169,10 +169,10 @@ final class HomepageMiddlewareTests: XCTestCase, StoreTestUtility {
subject.homepageProvider(AppState(), action)

let savedMetric = try XCTUnwrap(
mockGleanWrapper.savedEvents?[0] as? EventMetricType<GleanMetrics.Homepage.ItemTappedExtra>
mockGleanWrapper.savedEvents.first as? EventMetricType<GleanMetrics.Homepage.ItemTappedExtra>
)
let savedExtras = try XCTUnwrap(
mockGleanWrapper.savedExtras as? GleanMetrics.Homepage.ItemTappedExtra
mockGleanWrapper.savedExtras.first as? GleanMetrics.Homepage.ItemTappedExtra
)
let expectedMetricType = type(of: GleanMetrics.Homepage.itemTapped)
let resultMetricType = type(of: savedMetric)
Expand All @@ -195,10 +195,10 @@ final class HomepageMiddlewareTests: XCTestCase, StoreTestUtility {
subject.homepageProvider(AppState(), action)

let savedMetric = try XCTUnwrap(
mockGleanWrapper.savedEvents?[0] as? EventMetricType<GleanMetrics.Homepage.ItemTappedExtra>
mockGleanWrapper.savedEvents.first as? EventMetricType<GleanMetrics.Homepage.ItemTappedExtra>
)
let savedExtras = try XCTUnwrap(
mockGleanWrapper.savedExtras as? GleanMetrics.Homepage.ItemTappedExtra
mockGleanWrapper.savedExtras.first as? GleanMetrics.Homepage.ItemTappedExtra
)
let expectedMetricType = type(of: GleanMetrics.Homepage.itemTapped)
let resultMetricType = type(of: savedMetric)
Expand All @@ -220,7 +220,7 @@ final class HomepageMiddlewareTests: XCTestCase, StoreTestUtility {

subject.homepageProvider(AppState(), action)

let savedMetric = try XCTUnwrap(mockGleanWrapper.savedEvents?[0] as? LabeledMetricType<CounterMetricType>)
let savedMetric = try XCTUnwrap(mockGleanWrapper.savedEvents.first as? LabeledMetricType<CounterMetricType>)
let expectedMetricType = type(of: GleanMetrics.Homepage.sectionViewed)
let resultMetricType = type(of: savedMetric)
let debugMessage = TelemetryDebugMessage(expectedMetric: expectedMetricType, resultMetric: resultMetricType)
Expand Down
14 changes: 7 additions & 7 deletions ...x-ios-tests/Tests/ClientTests/Frontend/Homepage Rebuild/Redux/PocketMiddlewareTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ final class PocketMiddlewareTests: XCTestCase, StoreTestUtility {
subject.pocketSectionProvider(AppState(), action)

let firstSavedMetric = try XCTUnwrap(
mockGleanWrapper.savedEvents?[0] as? LabeledMetricType<CounterMetricType>
mockGleanWrapper.savedEvents.first as? LabeledMetricType<CounterMetricType>
)
let expectedFirstMetricType = type(of: GleanMetrics.Pocket.openStoryOrigin)
let firstResultMetricType = type(of: firstSavedMetric)
Expand All @@ -95,15 +95,15 @@ final class PocketMiddlewareTests: XCTestCase, StoreTestUtility {
resultMetric: firstResultMetricType
)

let secondSavedMetric = try XCTUnwrap(mockGleanWrapper.savedEvents?[1] as? LabeledMetricType<CounterMetricType>)
let secondSavedMetric = try XCTUnwrap(mockGleanWrapper.savedEvents.first as? LabeledMetricType<CounterMetricType>)
let expectedSecondMetricType = type(of: GleanMetrics.Pocket.openStoryPosition)
let secondResultMetricType = type(of: secondSavedMetric)
let secondDebugMessage = TelemetryDebugMessage(
expectedMetric: expectedSecondMetricType,
resultMetric: secondResultMetricType
)

XCTAssertEqual(mockGleanWrapper.savedEvents?.count, 2)
XCTAssertEqual(mockGleanWrapper.savedEvents.count, 2)
XCTAssertEqual(mockGleanWrapper.recordLabelCalled, 2)
XCTAssert(firstResultMetricType == expectedFirstMetricType, debugMessage.text)
XCTAssert(secondResultMetricType == expectedSecondMetricType, secondDebugMessage.text)
Expand All @@ -117,7 +117,7 @@ final class PocketMiddlewareTests: XCTestCase, StoreTestUtility {
)
subject.pocketSectionProvider(AppState(), action)

XCTAssertEqual(mockGleanWrapper.savedEvents?.count, 0)
XCTAssertEqual(mockGleanWrapper.savedEvents.count, 0)
XCTAssertEqual(mockGleanWrapper.recordLabelCalled, 0)
}

Expand All @@ -127,7 +127,7 @@ final class PocketMiddlewareTests: XCTestCase, StoreTestUtility {

subject.pocketSectionProvider(AppState(), action)

let savedMetric = try XCTUnwrap(mockGleanWrapper.savedEvents?[0] as? CounterMetricType)
let savedMetric = try XCTUnwrap(mockGleanWrapper.savedEvents.first as? CounterMetricType)
let expectedMetricType = type(of: GleanMetrics.Pocket.sectionImpressions)
let resultMetricType = type(of: savedMetric)
let debugMessage = TelemetryDebugMessage(expectedMetric: expectedMetricType, resultMetric: resultMetricType)
Expand All @@ -145,7 +145,7 @@ final class PocketMiddlewareTests: XCTestCase, StoreTestUtility {
)
subject.pocketSectionProvider(AppState(), action)

let savedMetric = try XCTUnwrap(mockGleanWrapper.savedEvents?[0] as? EventMetricType<NoExtras>)
let savedMetric = try XCTUnwrap(mockGleanWrapper.savedEvents.first as? EventMetricType<NoExtras>)
let expectedMetricType = type(of: GleanMetrics.Pocket.openInPrivateTab)
let resultMetricType = type(of: savedMetric)
let debugMessage = TelemetryDebugMessage(expectedMetric: expectedMetricType, resultMetric: resultMetricType)
Expand All @@ -163,7 +163,7 @@ final class PocketMiddlewareTests: XCTestCase, StoreTestUtility {
)
subject.pocketSectionProvider(AppState(), action)

XCTAssertEqual(mockGleanWrapper.savedEvents?.count, 0)
XCTAssertEqual(mockGleanWrapper.savedEvents.count, 0)
XCTAssertEqual(mockGleanWrapper.recordEventCalled, 0)
}

Expand Down
26 changes: 13 additions & 13 deletions ...ios-tests/Tests/ClientTests/Frontend/Homepage Rebuild/Redux/TopSitesMiddlewareTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ final class TopSitesMiddlewareTests: XCTestCase, StoreTestUtility {

try checkTopSitesPressedMetrics(label: "zero-search", position: "0", tileType: "sponsored")

XCTAssertEqual(mockGleanWrapper.savedEvents?.count, 2)
XCTAssertEqual(mockGleanWrapper.savedEvents.count, 2)
XCTAssertEqual(mockGleanWrapper.recordLabelCalled, 1)
XCTAssertEqual(mockGleanWrapper.recordEventCalled, 1)
XCTAssertEqual(sponsoredTelemetry.sendClickTelemetryCalled, 1)
Expand Down Expand Up @@ -210,7 +210,7 @@ final class TopSitesMiddlewareTests: XCTestCase, StoreTestUtility {

try checkTopSitesPressedMetrics(label: "zero-search", position: "0", tileType: "sponsored")

XCTAssertEqual(mockGleanWrapper.savedEvents?.count, 2)
XCTAssertEqual(mockGleanWrapper.savedEvents.count, 2)
XCTAssertEqual(mockGleanWrapper.recordLabelCalled, 1)
XCTAssertEqual(mockGleanWrapper.recordEventCalled, 1)
XCTAssertEqual(unifiedAdsTelemetry.sendClickTelemetryCalled, 1)
Expand Down Expand Up @@ -242,7 +242,7 @@ final class TopSitesMiddlewareTests: XCTestCase, StoreTestUtility {

try checkTopSitesPressedMetrics(label: "origin-other", position: "1", tileType: "suggested")

XCTAssertEqual(mockGleanWrapper.savedEvents?.count, 2)
XCTAssertEqual(mockGleanWrapper.savedEvents.count, 2)
XCTAssertEqual(mockGleanWrapper.recordLabelCalled, 1)
XCTAssertEqual(mockGleanWrapper.recordEventCalled, 1)
XCTAssertEqual(sponsoredTelemetry.sendClickTelemetryCalled, 0)
Expand All @@ -264,7 +264,7 @@ final class TopSitesMiddlewareTests: XCTestCase, StoreTestUtility {

subject.topSitesProvider(appState, action)

XCTAssertEqual(mockGleanWrapper.savedEvents?.count, 0)
XCTAssertEqual(mockGleanWrapper.savedEvents.count, 0)
XCTAssertEqual(mockGleanWrapper.recordLabelCalled, 0)
XCTAssertEqual(mockGleanWrapper.recordEventCalled, 0)
XCTAssertEqual(unifiedAdsTelemetry.sendImpressionTelemetryCalled, 0)
Expand Down Expand Up @@ -298,7 +298,7 @@ final class TopSitesMiddlewareTests: XCTestCase, StoreTestUtility {

subject.topSitesProvider(appState, action)

XCTAssertEqual(mockGleanWrapper.savedEvents?.count, 0)
XCTAssertEqual(mockGleanWrapper.savedEvents.count, 0)
XCTAssertEqual(mockGleanWrapper.recordEventCalled, 0)
XCTAssertEqual(mockTopSitesManager.pinTopSiteCalledCount, 0)
}
Expand All @@ -325,7 +325,7 @@ final class TopSitesMiddlewareTests: XCTestCase, StoreTestUtility {

subject.topSitesProvider(appState, action)

XCTAssertEqual(mockGleanWrapper.savedEvents?.count, 0)
XCTAssertEqual(mockGleanWrapper.savedEvents.count, 0)
XCTAssertEqual(mockGleanWrapper.recordEventCalled, 0)
XCTAssertEqual(mockTopSitesManager.unpinTopSiteCalledCount, 0)
}
Expand All @@ -352,7 +352,7 @@ final class TopSitesMiddlewareTests: XCTestCase, StoreTestUtility {

subject.topSitesProvider(appState, action)

XCTAssertEqual(mockGleanWrapper.savedEvents?.count, 0)
XCTAssertEqual(mockGleanWrapper.savedEvents.count, 0)
XCTAssertEqual(mockGleanWrapper.recordEventCalled, 0)
XCTAssertEqual(mockTopSitesManager.removeTopSiteCalledCount, 0)
}
Expand All @@ -366,7 +366,7 @@ final class TopSitesMiddlewareTests: XCTestCase, StoreTestUtility {
)
subject.topSitesProvider(AppState(), action)

let savedMetric = try XCTUnwrap(mockGleanWrapper.savedEvents?[0] as? EventMetricType<NoExtras>)
let savedMetric = try XCTUnwrap(mockGleanWrapper.savedEvents.first as? EventMetricType<NoExtras>)
let expectedMetricType = type(of: GleanMetrics.TopSites.openInPrivateTab)
let resultMetricType = type(of: savedMetric)
let debugMessage = TelemetryDebugMessage(expectedMetric: expectedMetricType, resultMetric: resultMetricType)
Expand Down Expand Up @@ -414,10 +414,10 @@ final class TopSitesMiddlewareTests: XCTestCase, StoreTestUtility {

private func checkContextMenuMetricsCalled(withExtra extra: String) throws {
let savedMetric = try XCTUnwrap(
mockGleanWrapper.savedEvents?[0] as? EventMetricType<GleanMetrics.TopSites.ContextualMenuExtra>
mockGleanWrapper.savedEvents.first as? EventMetricType<GleanMetrics.TopSites.ContextualMenuExtra>
)
let savedExtras = try XCTUnwrap(
mockGleanWrapper.savedExtras as? GleanMetrics.TopSites.ContextualMenuExtra
mockGleanWrapper.savedExtras.first as? GleanMetrics.TopSites.ContextualMenuExtra
)
let expectedMetricType = type(of: GleanMetrics.TopSites.contextualMenu)
let resultMetricType = type(of: savedMetric)
Expand All @@ -430,7 +430,7 @@ final class TopSitesMiddlewareTests: XCTestCase, StoreTestUtility {

private func checkTopSitesPressedMetrics(label: String, position: String, tileType: String) throws {
let firstSavedMetric = try XCTUnwrap(
mockGleanWrapper.savedEvents?[0] as? LabeledMetricType<CounterMetricType>
mockGleanWrapper.savedEvents.first as? LabeledMetricType<CounterMetricType>
)

let expectedFirstMetricType = type(of: GleanMetrics.TopSites.pressedTileOrigin)
Expand All @@ -441,10 +441,10 @@ final class TopSitesMiddlewareTests: XCTestCase, StoreTestUtility {
)

let secondSavedMetric = try XCTUnwrap(
mockGleanWrapper.savedEvents?[1] as? EventMetricType<GleanMetrics.TopSites.TilePressedExtra>
mockGleanWrapper.savedEvents[safe: 1] as? EventMetricType<GleanMetrics.TopSites.TilePressedExtra>
)
let secondSavedExtras = try XCTUnwrap(
mockGleanWrapper.savedExtras as? GleanMetrics.TopSites.TilePressedExtra
mockGleanWrapper.savedExtras.first as? GleanMetrics.TopSites.TilePressedExtra
)
let expectedSecondMetricType = type(of: GleanMetrics.TopSites.tilePressed)
let secondResultMetricType = type(of: secondSavedMetric)
Expand Down
Loading