chore: cleanup vcluster scan

[adityachoudhari26]

Summary by CodeRabbit

• Refactor
  • Improved the process for retrieving and handling cluster and vcluster resources, resulting in more reliable error handling and cleaner internal logic.
  • Removed unused debug code for a more streamlined experience.

[coderabbitai]

Walkthrough

This update introduces new helper functions and a struct to modularize the retrieval and processing of cluster and vcluster resources in the Kubernetes vcluster sync command. Error handling is improved by returning errors immediately, and unused debug code is removed for clarity and maintainability.

Changes

File(s)	Change Summary
.../kubernetes/vcluster.go	Added getParentClusterResource helper, ClusterResource struct, and getCreateResourceFromVcluster function. Refactored main command logic to use these helpers, improved error handling, and removed unused debug code.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI
    participant CtrlplaneAPI

    User->>CLI: Run vcluster sync command
    CLI->>CtrlplaneAPI: getParentClusterResource (fetch cluster resource)
    CtrlplaneAPI-->>CLI: Return cluster resource or error
    CLI->>CLI: getCreateResourceFromVcluster (process vcluster & cluster resource)
    CLI->>CtrlplaneAPI: Sync/Create resource as needed
    CLI-->>User: Output result or error

Loading

Possibly related PRs

• vcluster sync #28: Refactored and modularized vcluster sync logic, introducing helpers and struct for cluster resources, which this PR builds upon and reorganizes.

Poem

A helper hops in, code refines its way,
Clusters and vclusters now neatly array.
Errors returned, no more silent despair,
Debug lines vanish—clean code everywhere!
With structs and helpers, the sync hops anew,
A rabbit’s delight in what functions can do!
🐇✨

---

📜 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 a1e476c and 56c5ce7.

📒 Files selected for processing (1)

• cmd/ctrlc/root/sync/kubernetes/vcluster.go (5 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

cmd/ctrlc/root/sync/kubernetes/vcluster.go (1)

internal/api/client.gen.go (3)

• ClientWithResponses (5754-5756)
• MetadataMap (425-425)
• CreateResource (146-154)

🔇 Additional comments (6)

cmd/ctrlc/root/sync/kubernetes/vcluster.go (6)

4-4: LGTM: Context import added for new function.

The context import is appropriately added to support the new getParentClusterResource function.

---

26-44: Well-implemented helper function with proper error handling.

The getParentClusterResource function effectively encapsulates the cluster resource fetching logic with appropriate error handling for both API call failures and non-200 status codes.

---

120-127: Well-defined struct that matches API response structure.

The ClusterResource struct appropriately captures the necessary fields from the API response and uses the correct api.MetadataMap type.

---

129-150: Excellent modularization of resource creation logic.

This function effectively extracts the complex resource creation logic into a reusable helper function with proper error handling and clear separation of concerns.

---

180-183: Improved error handling with immediate return.

The refactored code correctly uses the new helper function and improves error handling by returning errors immediately instead of continuing execution.

---

214-217: Consistent use of new helper function with proper error handling.

The code correctly uses the new getCreateResourceFromVcluster helper function and maintains consistent error handling patterns.

✨ 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:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this 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.

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.