chore: replace strings.SplitN(arg, sep, 2) with strings.Cut(arg, sep)

[healthyyyoung]

Description

Closes: #23954

---

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

• Refactor

  • Streamlined input parsing for key-value pairs and file paths, resulting in clearer error handling and consistent behavior.

• Tests

  • Added comprehensive tests to validate the updated parsing logic across various input scenarios.

[aljo242]

@healthyyyoung lint failing

[healthyyyoung]

@technicallyty merge branch, noticed tag:v54 Should we merge this PR into v54?

[coderabbitai]

📝 Walkthrough

Walkthrough

This pull request refactors the string parsing logic for key-value pairs across multiple components. In two flag-related files, the existing methods that used strings.SplitN have been updated to use strings.Cut for clearer and more concise error handling. Similarly, the store’s path parsing logic now employs strings.Cut to separate the store name from the subpath. A new test file has been added to validate the revised parsing behavior and error scenarios.

Changes

File(s)	Summary
client/v2/autocli/flag/map.go, client/v2/autocli/flag/maps/generic.go	Updated the Set methods to replace strings.SplitN with strings.Cut for key-value parsing. Variable names were clarified and error handling was streamlined.
store/rootmulti/store.go	Refactored the parsePath function to use strings.Cut for separating store name and subpath. Now returns a nil subpath when absent and prefixes found subpaths with a "/" before returning.
client/v2/autocli/flag/map_test.go	Introduced a new test file with mock implementations to test the CompositeMapValue’s Set method under various scenarios, including valid input and error cases.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant CompositeMapValue
    participant Parser as strings.Cut

    Caller->>CompositeMapValue: Call Set(arg)
    CompositeMapValue->>Parser: Cut(arg, "=")
    alt Key-value pair not found
        Parser-->>CompositeMapValue: found = false
        CompositeMapValue-->>Caller: Return error ("invalid format")
    else Key-value pair found
        Parser-->>CompositeMapValue: Return key, value, found = true
        CompositeMapValue->>CompositeMapValue: Process key with keyParser(key)
        CompositeMapValue->>CompositeMapValue: Process value with valueParser(value)
        CompositeMapValue-->>Caller: Return success
    end

Loading

sequenceDiagram
    participant Caller
    participant parsePath
    participant Cutter as strings.Cut

    Caller->>parsePath: Call parsePath(path)
    alt Path does not start with "/"
        parsePath-->>Caller: Return error ("invalid path")
    else Valid path
        parsePath->>Cutter: Cut(path, "/")
        alt Subpath is found
            Cutter-->>parsePath: Return storeName, subpath
            parsePath->>parsePath: Prefix subpath with "/"
            parsePath-->>Caller: Return (storeName, "/" + subpath)
        else Subpath is not found
            Cutter-->>parsePath: Return storeName, ""
            parsePath-->>Caller: Return (storeName, nil)
        end
    end

Loading

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 64200a3 and 69b0f36.

📒 Files selected for processing (4)

• client/v2/autocli/flag/map.go (1 hunks)
• client/v2/autocli/flag/map_test.go (1 hunks)
• client/v2/autocli/flag/maps/generic.go (1 hunks)
• store/rootmulti/store.go (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (15)

• GitHub Check: test-system
• GitHub Check: test-system-legacy
• GitHub Check: tests (03)
• GitHub Check: tests (02)
• GitHub Check: tests (01)
• GitHub Check: tests (00)
• GitHub Check: test-sim-nondeterminism
• GitHub Check: test-integration
• GitHub Check: build (arm64)
• GitHub Check: test-e2e
• GitHub Check: build (amd64)
• GitHub Check: Analyze
• GitHub Check: golangci-lint
• GitHub Check: Gosec
• GitHub Check: Summary

🔇 Additional comments (7)

client/v2/autocli/flag/map.go (1)

205-206: Great improvement using strings.Cut for clearer parsing logic

This change from strings.SplitN to strings.Cut is a good improvement. The new approach is more direct and clearer as it explicitly returns whether the separator was found rather than requiring a length check on the resulting slice.

client/v2/autocli/flag/maps/generic.go (2)

32-33: Excellent use of strings.Cut for more elegant parsing

This change simplifies the code by replacing strings.SplitN with strings.Cut, making the parsing logic more direct and readable.

---

36-40: Good variable naming improvement

Using explicit key and val variable names instead of array indices makes the code more readable and maintainable.

store/rootmulti/store.go (1)

807-812:

Details

❓ Verification inconclusive

Better string parsing approach with strings.Cut

The refactoring of parsePath using strings.Cut improves readability and simplifies the logic. The function now directly indicates when the separator is found without needing to check the length of a resulting slice.

Since a reviewer previously asked whether this parsePath function is tested, let's verify:

---

🏁 Script executed:

#!/bin/bash
# Search for tests that might be testing the parsePath function
rg -A 10 -B 10 'func .*Test.*parsePath|parsePath.*testing|parsePath.*assert|parsePath.*require' --type go

Length of output: 107

---

Action Required: Verify Test Coverage for parsePath

The new implementation using strings.Cut is clear and straightforward. However, our initial search for tests directly targeting parsePath returned no results. Please review whether:

• The parsePath function is indirectly validated through higher-level or integration tests.
• Unit tests should be explicitly added (for example, in a store/rootmulti/store_test.go file) to cover both branches—the case where the separator is found and where it isn’t.

Kindly perform a manual verification of the test coverage and add tests if necessary.

client/v2/autocli/flag/map_test.go (3)

53-125: Well-structured test cases for the refactored Set method

This is a great addition of test coverage for the compositeMapValue.Set method that was refactored. The test cases cover multiple scenarios including valid input, invalid format, key resolver failures, and value parsing errors.

The table-driven test approach is well-implemented with clear test case names and thorough assertions.

---

65-65: Good implementation of previous review feedback

Using strconv.Atoi as the resolver addresses the previous review comment. This is a standard approach for parsing integers in Go.

---

13-51: Good mock implementation for testing purposes

The mock implementations of Value and Type interfaces are well-structured and sufficient for testing the Set method functionality.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

• 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.