-
Notifications
You must be signed in to change notification settings - Fork 130
Use API reader for CR status refresh #1829
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
vivekr-splunk
wants to merge
1
commit into
develop
Choose a base branch
from
fix/standalone-status-live-reader
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+89
−22
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| // Copyright (c) 2018-2022 Splunk Inc. All rights reserved. | ||
|
|
||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package common | ||
|
|
||
| import "sigs.k8s.io/controller-runtime/pkg/client" | ||
|
|
||
| // APIReaderProvider exposes a direct API reader alongside a controller client. | ||
| type APIReaderProvider interface { | ||
| GetAPIReader() client.Reader | ||
| } | ||
|
|
||
| // APIAwareClient keeps the standard controller client behavior while exposing a | ||
| // direct API reader for code paths that need a live read before a write. | ||
| type APIAwareClient struct { | ||
| client.Client | ||
| apiReader client.Reader | ||
| } | ||
|
|
||
| // NewAPIAwareClient returns a client wrapper that exposes the provided API reader. | ||
| func NewAPIAwareClient(baseClient client.Client, apiReader client.Reader) client.Client { | ||
| if baseClient == nil || apiReader == nil { | ||
| return baseClient | ||
| } | ||
|
|
||
| return &APIAwareClient{ | ||
| Client: baseClient, | ||
| apiReader: apiReader, | ||
| } | ||
| } | ||
|
|
||
| // GetAPIReader returns the live API reader associated with the wrapped client. | ||
| func (c *APIAwareClient) GetAPIReader() client.Reader { | ||
| if c.apiReader != nil { | ||
| return c.apiReader | ||
| } | ||
|
|
||
| return c.Client | ||
| } | ||
|
|
||
| // ResolveAPIReader returns a live API reader when one is available, otherwise | ||
| // it falls back to the provided client. | ||
| func ResolveAPIReader(baseClient client.Client) client.Reader { | ||
| if provider, ok := baseClient.(APIReaderProvider); ok { | ||
| if apiReader := provider.GetAPIReader(); apiReader != nil { | ||
| return apiReader | ||
| } | ||
| } | ||
|
|
||
| return baseClient | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
New exported API-reader wrapper helpers are introduced here, but there are no unit tests validating the key behaviors (e.g., ResolveAPIReader returns the provided API reader when the client implements APIReaderProvider, and falls back to the base client when it does not / when nils are provided). Adding a small client_test.go would help prevent regressions since this code changes read consistency around status updates.