refactor(runtime): reduce loop iteration complexity of checkStoreUpgrade

[winniehere]

Description

The implementation of IsDeleted and IsAdded use a range iterator, this increases the complexity of checkStoreUpgrade.

Summary by CodeRabbit

• Bug Fixes
  • Improved logic for checking duplicates in store upgrades, enhancing clarity and correctness.
  • Reduced risk of errors in duplicate detection by separating checks for added and deleted keys.

[coderabbitai]

Walkthrough

Walkthrough

The changes in this pull request involve modifications to the checkStoreUpgrade function in both runtime/store.go and runtime/v2/store.go. The primary focus is on improving the logic for checking duplicates in the storeUpgrades structure by utilizing separate maps for added and deleted entries. This update enhances the clarity and correctness of the duplicate checking process, ensuring that each category is validated independently.

Changes

File	Change Summary
runtime/store.go,	Enhanced logic in checkStoreUpgrade to use separate maps (addedFilter, deletedFilter) for
runtime/v2/store.go	checking duplicates in storeUpgrades. Improved clarity and reduced potential logical errors in checks.

Possibly related PRs

• feat(runtime(v2)): add sanity checks on store upgrades #21748: The changes in this PR introduce a new checkStoreUpgrade function that performs sanity checks on the storeUpgrades, which is directly related to the enhancements made in the checkStoreUpgrade function in the main PR, focusing on duplicate checks and validation of the upgrade process.

Suggested labels

C:server/v2, C:x/upgrade

Suggested reviewers

• kocubinski
• cool-develope
• hieuvubk
• julienrbrt
• tac0turtle

---

Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 81ec7ea and d59ef7d.

Files selected for processing (2)

• runtime/store.go (1 hunks)
• runtime/v2/store.go (1 hunks)

Additional context used

Path-based instructions (2)

runtime/v2/store.go (1)

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

runtime/store.go (1)

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

Additional comments not posted (5)

runtime/v2/store.go (4)

105-106: LGTM!

Using separate maps for Added and Deleted keys improves clarity and correctness in the duplicate checking process. The variable names clearly convey the purpose of each map.

---

109-112: LGTM!

The logic correctly checks for duplicates within the Added keys using the addedFilter map and returns an error if a duplicate is found.

---

115-119: LGTM!

The logic correctly checks for duplicates within the Deleted keys using the deletedFilter map and returns an error if a duplicate is found.

---

121-130: LGTM!

The logic correctly checks if any keys in Deleted are also present in Added, and vice versa. Returning an error if a key is found in both lists is the appropriate action. The checks are performed in both directions to ensure completeness.

runtime/store.go (1)

218-243: Excellent refactoring to enhance duplicate checking logic! LGTM.

The changes made to the checkStoreUpgrade function significantly improve the clarity and correctness of the duplicate checking process for store upgrades. Key highlights:

• Using separate maps (addedFilter and deletedFilter) for tracking added and deleted entries enhances the robustness of duplicate detection by ensuring each category is checked independently.
• The streamlined control flow reduces complexity and improves code readability.
• The revised implementation aligns with the PR objectives of reducing complexity and potentially improving performance.

Overall, these changes enhance the maintainability and correctness of the store upgrade checks. Great work!

---

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>, 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 generate interesting stats about this repository and render them as a table.
  -- @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 resolve resolve all the CodeRabbit review comments.
• @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.

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.

[julienrbrt]

Makes sense, thanks! Could you duplicate this in runtime/v2/store as well?

[winniehere]

Makes sense, thanks! Could you duplicate this in runtime/v2/store as well?

Updated