karmada-io
Reduce unnecessary watch events in the work-status-controller
What type of PR is this?
/kind cleanup
What this PR does / why we need it:
The work-status-controller only needs to watch the creation events of work objects and the updates of the WorkApplied status of work objects. It does not need to watch updates events for other fields of the work objects or deletion events.
Additionally, for the karmada-agent, it only needs to be concerned with the work of the current cluster.
Which issue(s) this PR fixes:
Part of #6780
Special notes for your reviewer:
Does this PR introduce a user-facing change?:
NONE
[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 ask for approval from xishanyongye-chang. For more information see the Kubernetes Code Review Process.
The full list of commands accepted by this bot can be found here.
Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment
Summary of Changes
Hello @XiShanYongYe-Chang, I'm Gemini Code Assist[^1]! 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 optimizes the work-status-controller by introducing specialized predicate functions to filter unnecessary watch events. New predicates, NewWorkStatusPredicate for the controller-manager and NewWorkStatusPredicateOnAgent for the agent, ensure that Work objects are only processed if they match specific criteria (e.g., push-mode clusters, current agent's cluster) and, for updates, only when their status transitions from 'not applied' to 'applied'. This reduces controller load and improves efficiency. The changes include updates to controller initialization, predicate definitions, and new unit tests.
Highlights
- Intent: This PR aims to reduce unnecessary watch events processed by the
work-status-controllerin both thekarmada-controller-managerandkarmada-agentcomponents. This is a cleanup effort to optimize controller performance by filtering out irrelevant events. - Key Changes: The primary change involves introducing new, more specific predicate functions for the
work-status-controller:
NewWorkStatusPredicate: Used by thekarmada-controller-manager, this predicate filtersWorkobjects to only process those belonging to clusters withPushsynchronization mode. Crucially, for update events, it only triggers reconciliation when aWorkobject transitions from a 'not applied' state to an 'applied' state.NewWorkStatusPredicateOnAgent: Used by thekarmada-agent, this predicate filtersWorkobjects to only process those relevant to the current agent's cluster. Similar to the controller-manager's predicate, it only triggers update events when aWorkobject transitions from 'not applied' to 'applied'.
Both new predicates explicitly ignore Delete and Generic events for Work objects.
Supporting changes include:
- Updating
cmd/agent/app/agent.goandcmd/controller-manager/app/controllermanager.goto integrate these new predicates into theWorkStatusControllersetup. - Refactoring
pkg/controllers/status/work_status_controller.goto simplify the predicate integration logic. - Updating comments in
pkg/util/helper/predicate.goto clarify the usage ofWorkWithinPushClusterPredicate. - Adding comprehensive unit tests for the new predicate functions in
pkg/util/helper/predicate_test.go. - Impact: These changes are expected to significantly reduce the number of
Workwatch events that thework-status-controllerneeds to process, leading to improved performance and reduced resource consumption for both thekarmada-controller-managerandkarmada-agent.
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 :thumbsup: and :thumbsdown: 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.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
[^1]: 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.
![gemini-code-assist[bot] avatar](https://avatars.githubusercontent.com/in/956858?v=4 "Published by a pub.dev verified publisher"){kind=small}
:warning: Please install the to ensure uploads and comments are reliably processed by Codecov.
Codecov Report
:x: Patch coverage is 86.53846% with 7 lines in your changes missing coverage. Please review.
:white_check_mark: Project coverage is 45.87%. Comparing base (070927d) to head (cc75a1b).
:warning: Report is 136 commits behind head on master.
| Files with missing lines | Patch % | Lines |
|---|---|---|
| pkg/controllers/status/work_status_controller.go | 0.00% | 5 Missing :warning: |
| cmd/agent/app/agent.go | 0.00% | 1 Missing :warning: |
| cmd/controller-manager/app/controllermanager.go | 0.00% | 1 Missing :warning: |
| :exclamation: Your organization needs to install the Codecov GitHub app to enable full functionality. |
Additional details and impacted files
@@ Coverage Diff @@
## master #6813 +/- ##
==========================================
+ Coverage 45.84% 45.87% +0.02%
==========================================
Files 690 690
Lines 57300 57342 +42
==========================================
+ Hits 26271 26303 +32
- Misses 29399 29406 +7
- Partials 1630 1633 +3
| Flag | Coverage Δ | |
|---|---|---|
| unittests | 45.87% <86.53%> (+0.02%) |
:arrow_up: |
Flags with carried forward coverage won't be shown. Click here to find out more.
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
:rocket: New features to boost your workflow:
- :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
