Skip to content

Fix flaky TripPlannerViewModel async tests #145

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
aaronbrethorst merged 1 commit into from
Jan 29, 2026
Merged

Fix flaky TripPlannerViewModel async tests #145

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
44 changes: 28 additions & 16 deletions OTPKit/Tests/TripPlannerViewModelTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,18 @@ struct TripPlannerViewModelTests {

// MARK: - Test Helpers

/// Waits for the ViewModel's isLoading to become false, with a timeout.
/// This replaces fixed `Task.sleep` calls that are flaky on slow CI machines.
func waitForLoadingComplete(
_ viewModel: TripPlannerViewModel,
timeout: TimeInterval = 5.0
) async throws {
let start = Date()
while viewModel.isLoading && Date().timeIntervalSince(start) < timeout {
try await Task.sleep(nanoseconds: 50_000_000) // Poll every 0.05 seconds
}
}

func createViewModel(
enabledModes: [TransportMode] = [.transit, .walk, .bike],
mockAPIService: TestFixtures.MockAPIService? = nil
Expand Down Expand Up @@ -193,8 +205,8 @@ struct TripPlannerViewModelTests {

viewModel.planTrip()

// Allow async operations to complete
try await Task.sleep(nanoseconds: 200_000_000) // 0.2 seconds
// Wait for async operation to complete (polling instead of fixed sleep)
try await waitForLoadingComplete(viewModel)

#expect(viewModel.isLoading == false)
#expect(viewModel.tripPlanResponse != nil)
Expand All @@ -216,8 +228,8 @@ struct TripPlannerViewModelTests {
// Check that loading state was set
// Note: isLoading may already be false by the time we check due to async completion

// Allow async operations to complete
try await Task.sleep(nanoseconds: 200_000_000) // 0.2 seconds
// Wait for async operation to complete (polling instead of fixed sleep)
try await waitForLoadingComplete(viewModel)

#expect(viewModel.isLoading == false)
}
Expand All @@ -234,8 +246,8 @@ struct TripPlannerViewModelTests {

viewModel.planTrip()

// Allow async operations to complete
try await Task.sleep(nanoseconds: 200_000_000) // 0.2 seconds
// Wait for async operation to complete (polling instead of fixed sleep)
try await waitForLoadingComplete(viewModel)

#expect(viewModel.showingError == true)
#expect(viewModel.errorMessage != nil)
Expand All @@ -257,8 +269,8 @@ struct TripPlannerViewModelTests {

viewModel.planTrip()

// Allow async operations to complete
try await Task.sleep(nanoseconds: 200_000_000) // 0.2 seconds
// Wait for async operation to complete (polling instead of fixed sleep)
try await waitForLoadingComplete(viewModel)

#expect(viewModel.showingError == false)
#expect(viewModel.errorMessage == nil)
Expand All @@ -276,8 +288,8 @@ struct TripPlannerViewModelTests {

viewModel.planTrip()

// Allow async operations to complete
try await Task.sleep(nanoseconds: 200_000_000) // 0.2 seconds
// Wait for async operation to complete (polling instead of fixed sleep)
try await waitForLoadingComplete(viewModel)

#expect(mockAPIService.lastRequest?.wheelchairAccessible == true)
}
Expand All @@ -294,8 +306,8 @@ struct TripPlannerViewModelTests {

viewModel.planTrip()

// Allow async operations to complete
try await Task.sleep(nanoseconds: 200_000_000) // 0.2 seconds
// Wait for async operation to complete (polling instead of fixed sleep)
try await waitForLoadingComplete(viewModel)

#expect(mockAPIService.lastRequest?.maxWalkDistance == WalkingDistance.halfMile.meters)
}
Expand All @@ -312,8 +324,8 @@ struct TripPlannerViewModelTests {

viewModel.planTrip()

// Allow async operations to complete
try await Task.sleep(nanoseconds: 200_000_000) // 0.2 seconds
// Wait for async operation to complete (polling instead of fixed sleep)
try await waitForLoadingComplete(viewModel)

#expect(mockAPIService.lastRequest?.arriveBy == true)
}
Expand All @@ -330,8 +342,8 @@ struct TripPlannerViewModelTests {

viewModel.planTrip()

// Allow async operations to complete
try await Task.sleep(nanoseconds: 200_000_000) // 0.2 seconds
// Wait for async operation to complete (polling instead of fixed sleep)
try await waitForLoadingComplete(viewModel)

#expect(mockAPIService.lastRequest?.arriveBy == false)
}
Expand Down
Loading