Verify with the API server if an empty map is equal to nil #171
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
JustinKuli
reviewed
Nov 3, 2023
If a policy specified an empty map but the object didn't return a value for the map, it was assumed that API server was just not returning an empty value. This is true in most cases, however, if the underlying Go type of the map is a pointer to a struct, an empty map may have a different meaning than nil. One example is the `emptyDir` key in the "configs.imageregistry.operator.openshift.io" resource. This commit changes the local comparison logic from considering empty maps being the same as a nil value. The controller then performs a dry run update request to see if the API server returns an empty map or omits the value entirely (i.e. seen as nil). The result of the object comparison is now cached to not continuously making dry run update requests on every policy evaluation. Relates: https://issues.redhat.com/browse/ACM-7810 Signed-off-by: mprahl <mprahl@users.noreply.github.com>
This is important for the dry-run to not send a noncompliant error because the dry-run failed due to an object conflict. On the normal update case, it saves the time it takes for the policy to be evaluated again. Signed-off-by: mprahl <mprahl@users.noreply.github.com>
JustinKuli
approved these changes
Nov 3, 2023
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: JustinKuli, mprahl The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
openshift-ci
bot
merged commit d2a4e04
into
open-cluster-management-io:main
4 checks passed
This was referenced Nov 3, 2023
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.
If a policy specified an empty map but the object didn't return a value
for the map, it was assumed that API server was just not returning an
empty value.
This is true in most cases, however, if the underlying Go type of the
map is a pointer to a struct, an empty map may have a different meaning
than nil. One example is the
emptyDirkey in the"configs.imageregistry.operator.openshift.io" resource.
This commit changes the local comparison logic from considering empty
maps being the same as a nil value. The controller then performs a dry
run update request to see if the API server returns an empty map or
omits the value entirely (i.e. seen as nil).
The result of the object comparison is now cached to not continuously
making dry run update requests on every policy evaluation.
Relates:
https://issues.redhat.com/browse/ACM-7810