Vtop: Refactor Conditions to List for Kubectl Wait #136
Conversation
This file contains 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
…ess. Signed-off-by: Peter Farr <Peter@PrismaPhonic.com>
Signed-off-by: Peter Farr <Peter@PrismaPhonic.com>
enisoc
reviewed
Sep 16, 2020
|
|
||
| // GetCondition provides map style access to retrieve a condition from the conditions list by it's type | ||
| // If the condition doesn't exist, we return nil, false. | ||
| func (s *VitessKeyspaceStatus) GetCondition(ty VitessKeyspaceConditionType) (value *VitessKeyspaceCondition, exists bool) { |
There was a problem hiding this comment.
I think it may be bug-prone to have an exported method that returns a pointer into the underlying array. Callers may think it's ok to retain the pointer, but that's not safe in general. Either the caller's value might get unintentionally mutated underneath them, or the caller might intend to mutate the value in the array and fail.
Consider this scenario:
ptr := GetCondition(condType)
SetConditionStatus(otherCondType, ...)
// This may or may not update the value in the array,
// depending on whether SetConditionStatus() above
// allocated a new array while appending to the slice.
ptr.Status = corev1.ConditionTrueI think it'll be useful to have an exported GetCondition() method, but it should return a deep copy to be safe. We could convert this version to an unexported method getCondition() that's used by both SetConditionStatus() and GetCondition().
There was a problem hiding this comment.
Ahh, I see what you're saying. Ok, will adjust.
Signed-off-by: Peter Farr <Peter@PrismaPhonic.com>
…tion. Signed-off-by: Peter Farr <Peter@PrismaPhonic.com>
Signed-off-by: Peter Farr <Peter@PrismaPhonic.com>
…feedback. Signed-off-by: Peter Farr <Peter@PrismaPhonic.com>
PrismaPhonic
added a commit
that referenced
this pull request
Sep 17, 2020
* Refactored conditions to be a list, and have methods for map like access. Signed-off-by: Peter Farr <Peter@PrismaPhonic.com> * Oops. Signed-off-by: Peter Farr <Peter@PrismaPhonic.com> * Update shard conditions per new list design for Wait support. Signed-off-by: Peter Farr <Peter@PrismaPhonic.com> * List size needs to be 0 to use append. Signed-off-by: Peter Farr <Peter@PrismaPhonic.com> * Refactored so public GetCondition returns deep copy per review suggestion. Signed-off-by: Peter Farr <Peter@PrismaPhonic.com> * Remove left over fragment I missed. Signed-off-by: Peter Farr <Peter@PrismaPhonic.com> * Reverted changes to VitessShardStatus and related methods per review feedback. Signed-off-by: Peter Farr <Peter@PrismaPhonic.com>
enisoc
pushed a commit
that referenced
this pull request
Sep 17, 2020
* Refactored conditions to be a list, and have methods for map like access. Signed-off-by: Peter Farr <Peter@PrismaPhonic.com> * Oops. Signed-off-by: Peter Farr <Peter@PrismaPhonic.com> * Update shard conditions per new list design for Wait support. Signed-off-by: Peter Farr <Peter@PrismaPhonic.com> * List size needs to be 0 to use append. Signed-off-by: Peter Farr <Peter@PrismaPhonic.com> * Refactored so public GetCondition returns deep copy per review suggestion. Signed-off-by: Peter Farr <Peter@PrismaPhonic.com> * Remove left over fragment I missed. Signed-off-by: Peter Farr <Peter@PrismaPhonic.com> * Reverted changes to VitessShardStatus and related methods per review feedback. Signed-off-by: Peter Farr <Peter@PrismaPhonic.com>
enisoc
pushed a commit
that referenced
this pull request
Sep 17, 2020
* Refactored conditions to be a list, and have methods for map like access. Signed-off-by: Peter Farr <Peter@PrismaPhonic.com> * Oops. Signed-off-by: Peter Farr <Peter@PrismaPhonic.com> * Update shard conditions per new list design for Wait support. Signed-off-by: Peter Farr <Peter@PrismaPhonic.com> * List size needs to be 0 to use append. Signed-off-by: Peter Farr <Peter@PrismaPhonic.com> * Refactored so public GetCondition returns deep copy per review suggestion. Signed-off-by: Peter Farr <Peter@PrismaPhonic.com> * Remove left over fragment I missed. Signed-off-by: Peter Farr <Peter@PrismaPhonic.com> * Reverted changes to VitessShardStatus and related methods per review feedback. Signed-off-by: Peter Farr <Peter@PrismaPhonic.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR refactors conditions to be a list rather than map so they can be used with kubectl wait command.