This repository has been archived by the owner on Jul 11, 2023. It is now read-only.
configurator: simplify MeshConfig API #4475
Merged
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
Simplifies the signature of `GetMeshConfig()` in the interface to return an object instead of pointer. MeshConfig is guaranteed to exist upon controller start and there is already a fallback to return a default MeshConfig object if not found in the cache. Returning a pointer results in unnecessary nil pointer handling on the caller side, which makes the usage of this function indeterministic when the implementation is deterministic. This change guarantees to the caller of this function that they will always receive a valid MeshConfig to operate on. Signed-off-by: Shashank Ram <[email protected]>
shashankram
requested review from
draychev,
jaellio,
nojnhuh and
snehachhabria
as code owners
snehachhabria
approved these changes
Jan 25, 2022
nojnhuh
approved these changes
Jan 25, 2022
Codecov Report
@@ Coverage Diff @@
## main #4475 +/- ##
==========================================
+ Coverage 69.14% 69.15% +0.01%
==========================================
Files 212 212
Lines 14595 14591 -4
==========================================
- Hits 10091 10090 -1
+ Misses 4452 4449 -3
Partials 52 52
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
jaellio
approved these changes
Jan 25, 2022
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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:
Simplifies the signature of
GetMeshConfig()inthe interface to return an object instead of a pointer.
MeshConfig is guaranteed to exist during controller
startup and there is already a fallback to return
a default MeshConfig object if not found in the
cache. Returning a pointer results in unnecessary
nil pointer handling on the caller side, which
makes the usage of this function indeterministic
when the implementation is deterministic.
This change guarantees to the caller of this function
that they will always receive a valid MeshConfig to
operate on.
Affected area:
Please answer the following questions with yes/no.
Does this change contain code from or inspired by another project?
noIs this a breaking change?
no