Skip to content

[BSK] Fix flaky HistoryCoordinator test #2705

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
samsymons merged 4 commits into from
Dec 2, 2025
Merged

[BSK] Fix flaky HistoryCoordinator test #2705

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e1654ed
Fix flaky history navigation test.
samsymons Nov 30, 2025
a788ed5
Merge branch 'main' into sam/fix-flaky-history-navigation-test
samsymons Dec 1, 2025
7a8c3a8
Merge branch 'main' into sam/fix-flaky-history-navigation-test
samsymons Dec 1, 2025
1aff587
Merge branch 'main' into sam/fix-flaky-history-navigation-test
samsymons Dec 1, 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
19 changes: 12 additions & 7 deletions SharedPackages/BrowserServicesKit/Tests/HistoryTests/HistoryCoordinatorTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -416,27 +416,32 @@ class HistoryCoordinatorTests: XCTestCase {
func testWhenCookiePopupBlockedIsCalled_ThenFlagIsSetAndAutoCommitted() async {
let (historyStoringMock, historyCoordinator) = await HistoryCoordinator.aHistoryCoordinator()

// Add an initial visit, and wait for it to complete:
let url = URL(string: "https://example.com")!
historyCoordinator.addVisit(of: url)

let expectation1 = XCTestExpectation(description: "Changes auto-committed")
historyStoringMock.saveCompletion = { expectation1.fulfill() }
await fulfillment(of: [expectation1], timeout: 5.0)
Copy link
Collaborator Author

@samsymons samsymons Nov 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now we wait for the first visit to properly complete before resetting the mock and performing the subsequent visit. Without this step, both visits were being recorded on the mock and the reset step below didn't have an effect.


// Reset save state after initial visit
historyStoringMock.saveCalled = false
historyStoringMock.savedHistoryEntries.removeAll()

let expectation = XCTestExpectation(description: "Changes auto-committed")
historyStoringMock.saveCompletion = {
expectation.fulfill()
}

// Perform the cookie-popup block visit:
let expectation2 = XCTestExpectation(description: "Changes auto-committed")
historyStoringMock.saveCompletion = { expectation2.fulfill() }
historyCoordinator.cookiePopupBlocked(on: url)

await fulfillment(of: [expectation], timeout: 1.0)
await fulfillment(of: [expectation2], timeout: 5.0)

// Verify flag is set in memory
XCTAssertTrue(historyCoordinator.history!.first?.cookiePopupBlocked ?? false)

// Verify save was called
XCTAssertTrue(historyStoringMock.saveCalled)
XCTAssertTrue(historyStoringMock.savedHistoryEntries.last?.cookiePopupBlocked ?? false)
XCTAssertEqual(historyStoringMock.savedHistoryEntries.count, 1)
XCTAssertEqual(historyStoringMock.savedHistoryEntries.last?.cookiePopupBlocked, true)
}

@MainActor
Expand Down
Loading