dice icon indicating copy to clipboard operation
dice copied to clipboard

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

Open AshwinKul28 opened this issue 1 year ago • 8 comments

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 current implementation is specific to the RESP protocol
  • Evaluation functions of each command must be refactored to ensure protocol-agnostic behavior.
  • Evaluation functions should return raw responses instead of protocol specific responses.

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

Requirements

  • Refactor the evaluation function of [Command Name] to be generic.
  • Ensure the evaluation function does not include protocol-specific logic.

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

  • [ ] Migrated the evalXXX function with the latest definition
  • [ ] Update or add unit tests for the new implementation.
  • [ ] All unit tests pass successfully.
  • [ ] Ensure all integration tests pass successfully.

Additional Notes

  • Describe any edge cases that need to be handled in the generic function.
  • Mention any protocol-specific optimizations required in wrappers.

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

Related Issues/PRs

  • Sample implementation for the Get, Set, GetSet and SetEx can be found in this Pull Request.

AshwinKul28 avatar Oct 08 '24 19:10 AshwinKul28

Hi @AshwinKul28 Would like to take this up.

karandixit10 avatar Oct 08 '24 21:10 karandixit10

Thanks @karandixit10 go for it! 🚀

AshwinKul28 avatar Oct 09 '24 02:10 AshwinKul28

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?

karandixit10 avatar Oct 09 '24 11:10 karandixit10

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)

AshwinKul28 avatar Oct 12 '24 20:10 AshwinKul28

Working on it

karandixit10 avatar Oct 14 '24 14:10 karandixit10

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.

AshwinKul28 avatar Oct 17 '24 12:10 AshwinKul28

Hey @karandixit10 whts the update

mohit-nagaraj avatar Oct 20 '24 04:10 mohit-nagaraj

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

karandixit10 avatar Oct 20 '24 09:10 karandixit10

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 avatar Oct 24 '24 11:10 AshwinKul28

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.

AshwinKul28 avatar Nov 12 '24 19:11 AshwinKul28