housekeeping: fix catalog apps generation and validation. #2360
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
| if catalogApps == "" { | ||
| return true, gitopsCatalogapps, nil | ||
| // No catalog apps to install | ||
| return nil, nil |
There was a problem hiding this comment.
Previously we were returning an empty slice, but now we are returning nil. Will downstream consumers of this be able to handle that?
There was a problem hiding this comment.
That's a good question!
In Go, a nil slice doesn't panic when sized (with len()) or iterated with range. The only time it would panic is if without range you attempt to access one of its non existent members.
If that's the case though, we want to see that failure because it means you didn't handle the error correctly 😆
Returning a non-nil slice here would just "cover the sun with a finger" but wouldn't stop you from getting a panic if you're trying to access the first element of a zero-length slice.
nathan-nicholson
changed the title
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.
Description
Doing the AWS STS work I found this function that seems to be buggy. Not only loading information into each catalog app wasn't working because it was operating on a copy of the original value, but the error message wasn't being handled at all.
The function returned 2 important values, a boolean that would say if the catalog was incorrect and an error that would say if the catalog was incorrect, thus making it
if err != nilto always have a non-trueboolreturn.If the callers were handling this in a way that would require the "bug" to be there then this would break the current flow.
Related Issue(s)
Fixes #
How to test