Add API rate limiting for trip planner requests

[ksharma-xyz]

TL;DR

Added rate limiting functionality to the Trip Planner API calls to prevent excessive requests. For first time the api will be called without delay and subsequent ones will be rate limited by 1 second.

NOTE: Also making the APIRateLimiter as NON Singleton as we want to lose the state private val isFirstTime = MutableStateFlow(false). Otherwise , if we go to another screen and come back to TimeTableScreen this class will still be alive and rate limit first time API calls also.

What changed?

• Introduced a new RateLimiter interface and APIRateLimiter implementation
• Added rate limiting with a 1-second debounce interval between API calls
• Updated TimeTableViewModel to use rate limiting for trip fetching
• Implemented unit tests for rate limiting behavior
• Removed unused demo UI test file

How to test?

1. Navigate to the Trip Planner screen
2. Rapidly toggle between different trips or reverse trips
3. Verify that API calls are limited to once per second
4. Run the new unit tests in APIRateLimiterTest to verify rate limiting behavior

Why make this change?

To prevent potential API rate limit issues and optimize network usage by controlling the frequency of API calls, especially during rapid user interactions or screen state changes. This implementation ensures smoother user experience while maintaining server-friendly request patterns.

Screenshots

Screen.Recording.2024-11-03.at.9.37.09.pm.mov

[ksharma-xyz]

• Add API rate limiting for trip planner requests #294 👈
• UI: Add reverse trip functionality to TimeTableScreen #293
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @ksharma-xyz and the rest of your teammates on Graphite