Implement Endpoints for Retrieving Busiest Bixi Stations During a Given Time Periods in Bixi-Api

[k-allagbe]

Feature Request

Description:

We need to implement API endpoints in the Bixi-Api backend that allow users to retrieve information on the busiest Bixi stations during specified time periods.

Use Case:

This feature is to address the requirements of UC004, which identifies a potential user interest in determining the busiest times at Bixi stations. This would benefit users by offering insights into station usage patterns, enabling better planning for bike rentals and returns.

Proposed Solution:

In discussion.

Alternative Solutions:

In discussion.

Additional Information:

• Use case: https://github.com/Monitoring-Mtl/Frontend/issues/112

Checklist

• [x] I have searched for existing feature requests that are similar.
• [x] I have provided a clear and concise description of the feature.
• [x] I have explained the use case for the feature.
• [ ] I have considered possible implementation approaches.

[k-allagbe]

Few approaches we can consider:

1. Real-time Data Processing

• Approach: Implement a system that analyzes bike check-ins and check-outs in real-time to determine the busyness of stations.
• Benefits: Ensures the information provided to users is always current.
• Challenges: May require significant infrastructure and can be complex to implement and maintain.

2. Batch Processing with Scheduled Updates

• Approach: Data is analyzed in batches at predetermined intervals, such as hourly or daily, to update busyness metrics.
• Benefits: Simpler to implement than real-time processing and still offers updated information at regular intervals.
• Challenges: There's a delay in data refresh, meaning information isn't updated instantaneously.

3. Cached Results with Periodic Refresh

• Approach: Store the results of data analyses in a cache, which is refreshed regularly or upon certain triggers.
• Benefits: Improves response times for user queries by reducing direct queries to the database.
• Challenges: Managing cache freshness and determining when to invalidate and refresh cache entries can be complex.

4. Precomputed Rankings with Dynamic Filtering

• Approach: Calculate busyness metrics at various times and days in advance and store these results. Apply dynamic filtering based on user requests to provide relevant information.
• Benefits: Offers quick response times as the data is already computed and merely needs to be filtered upon request.
• Challenges: Increases the storage requirements and may not capture real-time changes in station usage.