refactor(kubernetes): Reduce API surface of KubernetesKindProperties #4029
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
Only the statically-defined kinds are allowed to set isDynamic to false, or hasClusterRelationship to true. In order to make this statically true, make the full constructor private and expose a factory method that doesn't allow those properties to be set for use outside the class. (Some of the usages of the constructor in tests *did* set isDynamic and hasClusterRelationship, but these were just testing the API that was available; now that these are not exposed outside the class the tests can just use the factory method.)
The only time we ever use the getRegisteredKinds method in KubernetesKindRegistry, what we actually want is a list of the global kinds (so we can set up the core caching agent). We do this by getting all the kinds and filtering on the isDynamic property; it would be simpler to just return the global kinds in the first place. A kind is global if and only if it is not dynamic.
The prior commit removed the last usage of isDynamic in the KubernetesKindProperties class. Remove the member variable from the class.
In preparation for a fix to reduce live CRD lookups, move the defaulting of unknown kinds from the GlobalKubernetesKindRegistry to the account KubernetesKindRegistry. This doesn't change the result of calling getRegisteredKind on the account registry, but moves where the defaulting happens.
plumpy
approved these changes
Sep 16, 2019
ezimanyi
changed the title
maggieneterval
approved these changes
Sep 16, 2019
|
@maggieneterval : Good question, here are the definitions of the relevant terms: I've found these terms pretty confusing and so am slowly trying to get rid of them; this PR finally gets rid of the concept of a dynamic kind. |
|
@ezimanyi thank you! 🙏 |
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.
refactor(kubernetes): Reduce API surface of KubernetesKindProperties
Only the statically-defined kinds are allowed to set isDynamic to false, or hasClusterRelationship to true. In order to make this statically true, make the full constructor private and expose a factory method that doesn't allow those properties to be set for use outside the class.
(Some of the usages of the constructor in tests did set isDynamic and hasClusterRelationship, but these were just testing the API that was available; now that these are not exposed outside the class the tests can just use the factory method.)
refactor(kubernetes): Simplify getRegisteredKinds
The only time we ever use the getRegisteredKinds method in KubernetesKindRegistry, what we actually want is a list of the global kinds (so we can set up the core caching agent).
We do this by getting all the kinds and filtering on the isDynamic property; it would be simpler to just return the global kinds in the first place. A kind is global if and only if it is not dynamic.
refactor(kubernetes): Remove isDynamic property from kind properties
The prior commit removed the last usage of isDynamic in the KubernetesKindProperties class. Remove the member variable from the class.
refactor(kubernetes): Move defaulting logic to account registry
In preparation for a fix to reduce live CRD lookups, move the defaulting of unknown kinds from the GlobalKubernetesKindRegistry to the account KubernetesKindRegistry.
This doesn't change the result of calling getRegisteredKind on the account registry, but moves where the defaulting happens.