karmadactl: set default 5s timeout for resource completion by manmathbh · Pull Request #7315 · karmada-io/karmada

manmathbh · 2026-03-22T18:00:42Z

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

karmada-bot · 2026-03-22T18:00:50Z

Welcome @manmathbh! It looks like this is your first PR to karmada-io/karmada 🎉

karmada-bot · 2026-03-22T18:00:51Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign lonelycz for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

pkg/karmadactl/OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

gemini-code-assist · 2026-03-22T18:00:52Z

Summary of Changes

Hello, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the reliability and user experience of karmadactl commands by implementing a default 5-second timeout for resource completion. This change ensures that operations do not wait indefinitely, providing clearer feedback and preventing potential command stalls.

Highlights

Default Timeout for Resource Completion: A default 5-second timeout has been introduced for resource completion operations within karmadactl to prevent commands from hanging indefinitely.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

Copilot

Pull request overview

This PR aims to prevent karmadactl shell completion (resource discovery via apiresources) from hanging by applying a default 5s timeout when listing resources.

Changes:

Adds logic in compGetResourceList to default the REST client timeout to 5s when none is set.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-22T18:02:51Z

pkg/karmadactl/util/completion/completion.go

+	if configFlags, ok := restClientGetter.(*genericclioptions.ConfigFlags); ok {
+		if configFlags.Timeout == nil || len(*configFlags.Timeout) == 0 {
+			configFlags.Timeout = ptr.To("5s")
+		}
+	}


restClientGetter is typically a util.Factory/cmdutil.Factory here (see callers passing f), so the type assertion to *genericclioptions.ConfigFlags will fail and the default timeout will never be applied. Consider wrapping the provided genericclioptions.RESTClientGetter with a small delegating implementation that overrides ToRESTConfig() to set rest.Config.Timeout to 5s when it is zero (or otherwise ensure you can access/mutate the underlying ConfigFlags used by the factory).

Agree, how about:

config, err := restClientGetter.ToRawKubeConfigLoader().ClientConfig() if err != nil { return nil } config.Timeout = 5 * time.Second

gemini-code-assist

Code Review

This pull request introduces a default 5-second timeout for resource completion lookups to prevent them from hanging. The implementation modifies the ConfigFlags to set the timeout. My review includes a suggestion to avoid side effects by restoring the original timeout value after the operation, improving the code's robustness.

gemini-code-assist · 2026-03-22T18:05:01Z

pkg/karmadactl/util/completion/completion.go

-	// TODO: Should set --request-timeout=5s
+	if configFlags, ok := restClientGetter.(*genericclioptions.ConfigFlags); ok {
+		if configFlags.Timeout == nil || len(*configFlags.Timeout) == 0 {
+			configFlags.Timeout = ptr.To("5s")


While this change correctly sets a default timeout, it modifies the configFlags object in place. This creates a side effect that could potentially affect other parts of the code using the same restClientGetter instance within the same process execution. To avoid this, it's better to restore the original timeout value before the function returns. You can achieve this by using a defer statement.

originalTimeout := configFlags.Timeout configFlags.Timeout = ptr.To("5s") defer func() { configFlags.Timeout = originalTimeout }()

Signed-off-by: manmathbh <manmathcode@gmail.com>

codecov-commenter · 2026-03-22T18:51:20Z

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

❌ Patch coverage is 0% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 42.03%. Comparing base (3424bc7) to head (379e04e).
⚠️ Report is 2 commits behind head on master.

Files with missing lines	Patch %	Lines
pkg/karmadactl/util/completion/completion.go	0.00%	3 Missing ⚠️
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #7315      +/-   ##
==========================================
- Coverage   42.03%   42.03%   -0.01%     
==========================================
  Files         874      874              
  Lines       53551    53554       +3     
==========================================
  Hits        22511    22511              
- Misses      29349    29353       +4     
+ Partials     1691     1690       -1

Flag	Coverage Δ
unittests	`42.03% <0.00%> (-0.01%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

XiShanYongYe-Chang · 2026-03-23T07:17:25Z

/cc @zhzhuang-zju

zhzhuang-zju · 2026-03-30T08:23:40Z

Thanks
/assign

zhzhuang-zju

Others LGTM

zhzhuang-zju · 2026-03-30T08:27:02Z

pkg/karmadactl/util/completion/completion.go

+	if configFlags, ok := restClientGetter.(*genericclioptions.ConfigFlags); ok {
+		if configFlags.Timeout == nil || len(*configFlags.Timeout) == 0 {
+			configFlags.Timeout = ptr.To("5s")
+		}
+	}


Agree, how about:

config, err := restClientGetter.ToRawKubeConfigLoader().ClientConfig() if err != nil { return nil } config.Timeout = 5 * time.Second

Copilot AI review requested due to automatic review settings March 22, 2026 18:00

karmada-bot requested review from chaunceyjiang and zhzhuang-zju March 22, 2026 18:00

karmada-bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Mar 22, 2026

Copilot started reviewing on behalf of manmathbh March 22, 2026 18:01 View session

Copilot AI reviewed Mar 22, 2026

View reviewed changes

gemini-code-assist bot reviewed Mar 22, 2026

View reviewed changes

karmadactl: set default 5s timeout for resource completion

379e04e

Signed-off-by: manmathbh <manmathcode@gmail.com>

manmathbh force-pushed the fix/completion-request-timeout branch from 9444460 to 379e04e Compare March 22, 2026 18:06

karmada-bot assigned zhzhuang-zju Mar 30, 2026

zhzhuang-zju reviewed Mar 30, 2026

View reviewed changes

Conversation

manmathbh commented Mar 22, 2026

Uh oh!

karmada-bot commented Mar 22, 2026

Uh oh!

karmada-bot commented Mar 22, 2026

Uh oh!

gemini-code-assist bot commented Mar 22, 2026

Summary of Changes

Highlights

Footnotes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Mar 22, 2026

Choose a reason for hiding this comment

Uh oh!

zhzhuang-zju Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist bot Mar 22, 2026

Choose a reason for hiding this comment

Uh oh!

codecov-commenter commented Mar 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

XiShanYongYe-Chang commented Mar 23, 2026

Uh oh!

zhzhuang-zju commented Mar 30, 2026

Uh oh!

zhzhuang-zju left a comment

Choose a reason for hiding this comment

Uh oh!

zhzhuang-zju Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

codecov-commenter commented Mar 22, 2026 •

edited

Loading