refactor: use a pointer for field: skipAnalysis in Canary object #2
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
reedflinch
reviewed
Jun 13, 2024
Comment on lines
617
to
+626
| func (c *Canary) SkipAnalysis() bool { | ||
| if c.Spec.SkipAnalysis == nil { | ||
| return false | ||
| } | ||
|
|
||
| if c.Spec.Analysis == nil && c.Spec.CanaryAnalysis == nil { | ||
| return true | ||
| } | ||
| return c.Spec.SkipAnalysis | ||
|
|
||
| return *c.Spec.SkipAnalysis |
There was a problem hiding this comment.
we don't have to adjust the return type to *bool here?
There was a problem hiding this comment.
This method looks like an internal API ready for consumption: when the caller calls, it is an implementation detail how the nil pointer should be handled. Then the caller just needs to know if it is a "true" or "false", sort of a tell-dont-ask principle
This refactor tries to fulfil a special use case fluxcd#1660: when a custom controller uses the Flagger API to render the Canary object to json/yaml, it makes sure the skipAnalysis field is rendered when the value is "false", so that the field is always communicated to the k8s API server. Comparison is as follows: before, when skipAnalysis is "false" the canary object is rendered as such: ``` apiVersion: flagger.app/v1beta1 kind: Canary ... spec: analysis: ... ``` After, it is as such: ``` apiVersion: flagger.app/v1beta1 kind: Canary ... spec: skipAnalysis: false # this is the field we expected analysis: ... ```
Wenliang-CHEN
force-pushed
the
feat/use-pointer-for-skipAnalysis-field
branch
from
f1ef8eb
to
24b40e3
Compare
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 refactor tries to fulfill a special use case {ticket number}: when a custom controller uses the Flagger API to create/update a Canary object using k8s client-go:
This makes sure that the skipAnalysis field is always rendered after marshalling to json format.