HackIllinois / api

The Official API supporting HackIllinois
https://api.hackillinois.org
Other
23 stars 51 forks source link

Live leaderboard #528

Open Nydauron opened 1 year ago

Nydauron commented 1 year ago

This is mainly for the Siebel dashboard, but this is a new public endpoint: WS /profile/live/leaderboard/

Once the connection has been established, the API will send back an initial leaderboard. From then on, the API will send back updated leaderboards whenever it detects updates to player point totals (primarily from POST /profile/points/award/). The amount of leaderboards the API can send back due to point value updates is 1 response/second.

The API will also send back an updated leaderboard every 5 minutes of inactivity.

Some other tests to consider t add in the future:

Timothy-Gonzalez commented 1 year ago

Haven't looked over the code yet - but do we really need to be within 1 second live? We could probably get away with once every 10 seconds or every 5 minutes, whichever is more often. It wouldn't really matter other than just not using resources we don't need too.