feat(schema)!: support kv-pair updates array

[aaronc]

Description

Data in server/v2 is already passed in KVPair arrays so this changes allows server/v2 integration to be more performant.

---

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

• included the correct type prefix in the PR title, you can find examples of the prefixes below:
• confirmed ! in the type prefix if API or client breaking change
• targeted the correct branch (see PR Targeting)
• provided a link to the relevant issue or specification
• reviewed "Files changed" and left comments if necessary
• included the necessary unit and integration tests
• added a changelog entry to CHANGELOG.md
• updated the relevant documentation or specification, including comments for documenting Go code
• confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

I have...

• confirmed the correct type prefix in the PR title
• confirmed all author checklist items have been addressed
• reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

• New Features

  • Enhanced support for handling multiple key-value pair updates, improving flexibility and efficiency.

• Bug Fixes

  • Improved error handling and processing logic for updates in middleware functionality.

• Refactor

  • Updated data structures to better accommodate batch processing of key-value pair updates.

[coderabbitai]

Walkthrough

Walkthrough

The recent changes enhance the Go code's handling of key-value pair updates by transitioning from a single update representation to a collection of updates. This modification improves flexibility and efficiency, allowing for batch processing of updates across various components, including data structures and middleware functions. The adjustments facilitate a more comprehensive approach to managing updates, thus optimizing overall functionality.

Changes

File	Change Summary
schema/appdata/data.go	Renamed ModuleKVPairUpdate to ModuleKVPairUpdates and modified KVPairData to use an array of updates for enhanced batch processing capabilities.
schema/decoding/decoding_test.go	Updated Set method to pass a KVPairData object containing multiple updates, reflecting changes to the data structure for improved flexibility.
schema/decoding/middleware.go	Altered the Middleware function to iterate over multiple updates instead of a single update, enhancing efficiency in batch processing.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

[github-actions]

@aaronc your pull request is missing a changelog!

[coderabbitai]

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (1)

schema/decoding/middleware.go (1)

83-100: Ensure proper error handling and logging.

The loop iterates over kvUpdate.Updates, processing each update. Ensure that errors are logged or handled appropriately to aid in debugging. Consider adding logging for successful updates as well.

+ import "log"
...
  if err != nil {
    log.Printf("Error decoding update for module %s: %v", kvUpdate.ModuleName, err)
    return err
  }
...
  if err != nil {
    log.Printf("Error updating object for module %s: %v", kvUpdate.ModuleName, err)
    return err
  }

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 75db9d7 and 26d8c77.

Files selected for processing (3)

• schema/appdata/data.go (1 hunks)
• schema/decoding/decoding_test.go (1 hunks)
• schema/decoding/middleware.go (1 hunks)

Additional context used

Path-based instructions (3)

schema/decoding/middleware.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

schema/appdata/data.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

schema/decoding/decoding_test.go (2)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

---

Pattern **/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"

Additional comments not posted (2)

schema/appdata/data.go (1)

75-84: Review struct renaming and field changes for consistency.

The renaming from ModuleKVPairUpdate to ModuleKVPairUpdates and changing Update to Updates aligns with handling multiple updates. Ensure that all usages of these structs in the codebase are updated accordingly to prevent inconsistencies.

schema/decoding/decoding_test.go (1)

300-307: Verify test coverage for handling multiple updates.

The Set method now handles multiple updates. Ensure that the tests cover scenarios with multiple updates to validate the changes. Consider adding tests for edge cases, such as empty updates or large batches.

[aaronc]

Closing in favor of #21305 which is even closer to what's in server/v2