dice icon indicating copy to clipboard operation
dice copied to clipboard
verified publisher icon DiceDB

IronHawk Port: ZRANK

Open arpitbbhayani opened this issue 9 months ago • 3 comments

We reimplemented the core of the DiceDB engine and re-wrote - the wire protocol, execution engine, and config management. This rewrite helped us gain 32% throughput over our existing benchmark. One of the core principles we focussed on was to make code easy to extend and debug. As an effort, we need to migrate the command from the old engine to IronHawk.

Here are the exact things to be taken care of to migrate command ZRANK

  1. setup DiceDB server locally from the source - instructions
  2. setup DiceDB CLI locally from the source - instructions

Steps to execute

Start the DiceDB server with IronHawk engine

$ go run main.go --engine ironhawk --log-level debug

Start the DiceDB CLI with the IronHawk engine

$ go run main.go --engine ironhawk

Porting the command

  1. Find the current implementation of the command, the name of the function will be evalZRANK. ex: evalSET, evalGET, etc. Most of them are present in the store_eval.go file.
  2. Create a new file internal/cmd/cmd_zrank.go and follow the structure as cmd_get.go, cmd_set.go, and cmd_ping.go files.
  3. Reimplement the old evalZRANK function into a new file, Make a note of the return values of the new function.
  4. If you think the implementation is complex, feel free to simplify
  5. Document the code you have written and make sure it adheres to existing standard
  6. Add TODO in the comment, if you feel there are things that need to be implemented later
  7. Cover all possible cases for the command implementation
  8. Do not delete the old implementation of the eval function

No need to write test cases for this new implementation. We will take care of this in one shot later. If the test fails, it is okay.

If you find any other bug while you are implementing it, you can either

  1. fix it yourself and submit it in a new PR
  2. raise a GitHub issue

Follow the contribution guidelines

These are general guidelines to follow before you submit a patch. Please mark them as done once you complete them

arpitbbhayani avatar Mar 20 '25 15:03 arpitbbhayani

Hi @arpitbbhayani, this sounds interesting, would like to work on this, can you assign it to me?

Dhanushkumar-S-G avatar Mar 20 '25 16:03 Dhanushkumar-S-G

@arpitbbhayani I am open to suggestions for this pr

goyal-aman avatar Mar 21 '25 20:03 goyal-aman

@arpitbbhayani gentle reminder

goyal-aman avatar Mar 25 '25 07:03 goyal-aman