DiceDB / dice

DiceDB is a redis-compliant, reactive, scalable, highly-available, unified cache optimized for modern hardware.
https://dicedb.io/
Other
6.83k stars 1.08k forks source link

Command Migration: ('JSON.SET', 'JSON.GET', 'JSON.DEL', 'JSON.TYPE') #1025

Open AshwinKul28 opened 1 month ago

AshwinKul28 commented 1 month ago

This issue tracks the migration of the mentioned commands - ('JSON.SET', 'JSON.GET', 'JSON.DEL', 'JSON.TYPE') to make them compatible across the three protocols supported by the Dice database: RESP, HTTP, and WebSocket. DiceDB now supports more than one protocols (Resp/http/websocket). We don't want eval operation of each command to be strictly bound with any of the protocols. Currently eval function return statements of each command is bounded to the RESP protocol.

The migration is required because:

The goal is to make the command logic protocol-independent, allowing all three protocols to call the same core functionality seamlessly.

Requirements

Migration Steps

  1. Analyze Current Implementation

    • Review the current codebase to understand how the command logic is implemented.
  2. Refactor Return Logic

    • Create a new function with the function definition as evalXXX(args []string, store *dstore.Store) *EvalResponse under the file /internal/eval/store_eval.go
    • Analyse return statements of the eval and modify them to send raw types without encoding
    • Use errors in the return statements from /errors/migrated_errors.go file
    • Use perdefined responses from /internal/clientio/resp.go file as RespType variables
  3. Command/Worker specific Changes

    • Make IsMigrated flag to true in the commands information under /internal/eval/commands.go file.
    • Use the newly written eval function against the NewEval parameter in the same command structure.
    • Delete the old eval function from the /internal/eval/eval.go file.
    • Add the migrated command to the /internal/worker/CommandsMeta map and make it's type as SingleShard
  4. Update Unit Tests

    • Refactor existing unit tests to accommodate the new implementation.
    • Add new unit tests if necessary to cover all possible cases.
  5. Integration Tests

    • Run all integration tests to ensure successful migration.
    • Ensure that each protocol (RESP, HTTP, WebSocket) works correctly after migration.

Checklist

Additional Notes

If there are any questions or concerns about this migration, please mention them here.

Related Issues/PRs

karandixit10 commented 1 month ago

Hi @AshwinKul28 Would like to take this up.

AshwinKul28 commented 1 month ago

Thanks @karandixit10 go for it! 🚀

karandixit10 commented 1 month ago

Hi @AshwinKul28 For JSON.SET and other commands it's already implemented in eval.go Shall I move it to store_eval.go or make changes there only?

AshwinKul28 commented 1 month ago

HI @karandixit10 you need to move it to the store_eval.go and make changes as explained in the above issue. (Make responses independent of any protocols)

karandixit10 commented 1 month ago

Working on it

AshwinKul28 commented 1 month ago

Hey @karandixit10 hope you are doing well, can you please update the current progress on this task? If you have any blockers feel free to discuss here or on the discord.

mohit-nagaraj commented 1 month ago

Hey @karandixit10 whts the update

karandixit10 commented 1 month ago

Hi @AshwinKul28 @mohit-nagaraj I am done migrating JSON.SET and JSON.GET with unit test and integration tests, I'll create a PR today for all the commands. I was having some blocker but it's fixed now

AshwinKul28 commented 4 weeks ago

HI @karandixit10, I hope you are doing well, are you still stuck on any blocker? or if you have already raised a PR please link it with this issue. Lets even go ahead with the draft PR, we can start our reviews on that. Thanks

AshwinKul28 commented 1 week ago

HI @karandixit10 hope you are doing well. Apologies but we have to make the migration as per the deadline. You can pickup any other open issue once you're back active. Thanks. These commands are getting migrated as a part of https://github.com/DiceDB/dice/pull/1276.