Rnkr is a general purpose leaderboard microservice to be integrated as a back-end component behind a custom server aggregator (ie your Node.js API)
TL;DR gimme the good stuff, NOW!
If you’re dying to see for yourself what this is about, follow these links
It’s early days. Rankr is not yet suitable for production as-is but can be used as a starting point for a custom deployment if you’re happy to contribute. Please do contact me either via GitHub Issues or start a private messaging thread by any of these means for any inquiries.
Rationale and goals
I believe that the best way of learning something new is to dive in head first. This is an open-source project which I’ve started mainly to learn the Scala language and ecosystem.
I see programming languages as sophisticated tools to solve problems, I have chosen this one because
- It is familiar to me. Since writing server code for console games day in, day out, I’ve learnt that players love being ranked against each other.
- I believe the problem is not fully solved. I am not fully satisfied with any of the solutions I’ve adopted in the past. Project budgets tends to be tight on R&D.
- It is general enough to build a community around it
- …but small enough for a single person to work on it
I started with a data structure which implements an ordered list of N rows of the form
(rank, (score, timestamp), value, [attachment])
rankare unique and sequentially ordered numbers 1 to N
- list is kept sorted by non-unique
scoreaccording to a given
(score, timestamp)are also a unique sorted key
valueis an unique, required key
attachmentis an arbitrary, optional value
- seeking by either
- traversal of the structure with
- insertion, update and deletion are
With the following implementation goals:
- efficient in-memory storage for live objects
- efficient offloading of idle objects to persistent storage
- “reasonable” scalability to support both large leaderboards and a large number of leaderboards
- “reasonable” availability
- loss of nodes with no loss of data
- pluggable backends
- ease of deployment with state-of-the art containerization (eg CoreOS/Docker)
As definition of “large” may vary, I suggest that a leaderboard containing 1-10 million entries can be considered large, and that 100 thousands to a million leaderboards is a large number.
According to my experience, games tend to have a few large leaderboards and a large number of small leaderboards, with a pareto-like distribution.
Given the design goals and constraints, I decided to
- implement the structure as a mutable, counted B+tree in Scala.
- use Akka actors and queues to arbitrate read/write operations to the data structure
- adopt an event log/snapshot system for persistence, treating each leaderboard as a distinct entity so load can easily be distributed across nodes
- design with row oriented partitioned storage in mind, starting with a Cassandra implementation
- design with shared-nothing principles in mind
- explore the concept of hot/cold leaderboards. “Cold” leaderboards are similar to “frozen” audio tracks in a DAW: they allow faster and more time/space efficient sequential reads at the cost of transitioning both ways (hot <-> cold).
You are welcome to submit feature requests, user stories or questions in the form of GitHub Issues and submit pull requests.
At the time of writing, the project is subject to the GPL 2.0 licence. As I am bound by certain contract obligations with my employer, I reserve the rights to change the licensing terms for future releases. Please contact me in private for queries about licensing.
Design and documentation are subject to CC BY-SA 4.0