Enforce Component names to be unique #7195
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
Currently in standalone mode, it is possible to load multiple components with the same name but of different types. This is problematic as it can produce undefined behaviour in Daprd where global state indexed on Component name (like state encryption) can "leak" to another Component. It also makes it impossible to implement the hot reloader reconciler as that controller is level based, and without a single unique name to index on, the reconciler cannot determine which Components have been deleted/editted. It is also confusing to different requirements to Kubernetes whether a Component name _must_ be unique within a namespace. PR implements a check to ensure that Component names are unique. The component store implements a pending & lock mechanism to ensure that another Component of the same name cannot be added whilst another is initialising. Adds an integration test to ensure daprd errors when multiple Components with the same name are added. Signed-off-by: joshvanl <me@joshvanl.dev>
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## master #7195 +/- ##
==========================================
+ Coverage 64.89% 64.92% +0.03%
==========================================
Files 221 221
Lines 21003 21004 +1
==========================================
+ Hits 13629 13637 +8
+ Misses 6216 6212 -4
+ Partials 1158 1155 -3 ☔ View full report in Codecov by Sentry. |
daixiang0
reviewed
Nov 20, 2023
| return c.components[i], true | ||
| } | ||
| } | ||
| return compsv1alpha1.Component{}, false | ||
| } | ||
|
|
||
| func (c *ComponentStore) AddComponent(component compsv1alpha1.Component) { | ||
| func (c *ComponentStore) AddPendingComponentForCommit(component compsv1alpha1.Component) error { |
There was a problem hiding this comment.
Why need a pending queue as we add component one by one?
There was a problem hiding this comment.
I don't think it is necessarily true when we introduce hot reloading. Adding the name as pending means we can reserve name before committing when Init is successful.
There was a problem hiding this comment.
With hot reloading components can be updated in the sidecar in parallel, as opposed to being initialized sequentially when loaded at startup.
Signed-off-by: joshvanl <me@joshvanl.dev>
JoshVanL
added
the
autoupdate
yaron2
approved these changes
Nov 21, 2023
berndverst
approved these changes
Nov 21, 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.
Currently in standalone mode, it is possible to load multiple components with the same name but of different types. This is problematic as it can produce undefined behaviour in Daprd where global state indexed on Component name (like state encryption) can "leak" to another Component. It also makes it impossible to implement the hot reloader reconciler as that controller is level based, and without a single unique name to index on, the reconciler cannot determine which Components have been deleted/editted. It is also confusing to different requirements to Kubernetes whether a Component name must be unique within a namespace.
PR implements a check to ensure that Component names are unique. The component store implements a pending & lock mechanism to ensure that another Component of the same name cannot be added whilst another is initialising.
Adds an integration test to ensure daprd errors when multiple Components with the same name are added.