Reliability (Get and Report Bus Fullness) #344
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
Implement two routes,
getBusFullnessandreportBusFullness.getBusFullnessreturn the fullness of a requested trip ID and the minutes elapsed since a fullness was last reported.reportBusFullnessadds a new report (tripId, time, and fullness) to the database. All data is currently stored in a JSON file calledbusFullness.jsonat the root of the directory.tripId: route number
time: unix time
fullness: integer value
Changes Made
GetFullnessRouter.js: Implement getBusFullness routeReportFullnessRouter.js: Implement reportBusFullness routeReliabilityUtils.js: Implement helper functions for getBusFullness and reportBusFullnessTest Coverage
Get bus fullness:
Returns NULL when no reports exist for tripId
Report bus fullness
Next Steps
Currently fullness is stored as an integer, but we're still waiting on design for what they want reliability to look like and how fullness is measured. The reports are stored in a JSON for now, but we plan to eventually store them in a MongoDB database.
Related PRs or Issues