dice icon indicating copy to clipboard operation
dice copied to clipboard

Migrate ZADD

Open vivekkothari opened this issue 1 year ago • 2 comments

Resolved #1604

Migrate ZADD

Also create cmdResInt function which creates an int response. Verified that go-compiler inlines the function, so it should cause no runtime overhead.

CleanShot 2025-03-24 at 08 31 04@2x

Testing evidence

localhost:7379> ZADD foo 1 "one"
OK 1
localhost:7379> ZADD XX foo 1 "one"
ERR wrong number of arguments for 'ZADD' command
localhost:7379> ZADD foo 1 "one" XX
ERR wrong number of arguments for 'ZADD' command
localhost:7379> ZADD bar XX 1 "one"
OK 0
localhost:7379> ZADD key INCR score member
ERR value is not an integer or a float
localhost:7379> ZADD mySortedSet INCR 10 "item1"
OK 10.000000
localhost:7379> ZADD mySortedSet INCR 1 "item1"

CleanShot 2025-03-20 at 23 00 45@2x

vivekkothari avatar Mar 20 '25 17:03 vivekkothari

How do I make sure when I run ZADD it actually is using?

vivekkothari avatar Mar 20 '25 17:03 vivekkothari

Resolves https://github.com/DiceDB/dice/issues/1604

vivekkothari avatar Mar 20 '25 17:03 vivekkothari

Walkthrough

This pull request simplifies response handling in several command implementations by replacing the direct construction of wire.Response objects with a helper function cmdResInt (and cmdResFloat for float responses). It removes the dependency on the wire package in multiple command files and introduces a new ZADD command implementation alongside its tests, adding the necessary flag parsing and sorted set management functions.

Changes

File(s) Change Summary
internal/cmd/cmd_{del,exists,expiretime,hset,incrby,ttl}.go Replaced inline wire.Response construction with cmdResInt; removed wire package imports where applicable.
internal/cmd/cmds.go Added utility functions cmdResInt and cmdResFloat for constructing response objects.
internal/cmd/cmd_zadd.go New implementation of the ZADD command with functions for flag parsing, member processing, and sorted set management.
tests/.../zadd_test.go New test suite for ZADD covering various scenarios and flag combinations.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant ShardManager
    participant ZADDHandler as ZADD
    participant SortedSetStore as SortedSet
    Client->>ShardManager: Send ZADD command with arguments
    ShardManager->>ZADDHandler: Execute ZADD command
    ZADDHandler->>ZADDHandler: Parse flags and validate arguments
    ZADDHandler->>SortedSetStore: getOrCreateSortedSet(key)
    SortedSetStore-->>ZADDHandler: Return SortedSet instance
    ZADDHandler->>ZADDHandler: Process members with flags
    ZADDHandler->>SortedSetStore: storeUpdatedSet(key, SortedSet)
    ZADDHandler-->>ShardManager: Return response via cmdResInt
    ShardManager-->>Client: Send command result

Assessment against linked issues

Objective Addressed Explanation
IronHawk Port: ZADD (#1604)

Suggested reviewers

  • arpitbbhayani

Poem

I’m a rabbit hopping through the code,
Skipping wires and lightening the load.
With ZADD now shining bright,
My burrow’s code feels just right.
Hop on, dear devs, to code in delight!
🐇✨

✨ Finishing Touches
  • [ ] 📝 Generate Docstrings

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot] avatar Mar 27 '25 04:03 coderabbitai[bot]