pkg/cdi: stop embedding Cache mutex - #335
Open
thaJeztah wants to merge 1 commit into
Open
Conversation
The cache mutex has been embedded since the initial cache implementation in b730453, unintentionally promoting `Lock` and `Unlock` as part of the public `Cache` API. Move the mutex to an unexported `mu` field and add deprecated forwarding methods for compatibility. This keeps existing callers working while making cache locking an implementation detail and allows the synchronization primitive to change independently in the future. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
thaJeztah
commented
Aug 8, 2026
Comment on lines
+51
to
+63
| // Lock locks the cache. | ||
| // | ||
| // Deprecated: Cache locking is an implementation detail and should not be managed by callers. | ||
| func (c *Cache) Lock() { | ||
| c.mu.Lock() | ||
| } | ||
|
|
||
| // Unlock unlocks the cache. | ||
| // | ||
| // Deprecated: Cache locking is an implementation detail and should not be managed by callers. | ||
| func (c *Cache) Unlock() { | ||
| c.mu.Unlock() | ||
| } |
Contributor
Author
There was a problem hiding this comment.
Not sure how likely it is someone is messing with the mutex; added the deprecated wrappers to keep SemVer compatibility, but perhaps it's something we can still wiggle out of.
(was dusting off a branch I had with various changes in this package, and splitting it up into sizeable commits).
This file contains hidden or 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
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.
The cache mutex has been embedded since the initial cache implementation in b730453, unintentionally promoting
LockandUnlockas part of the publicCacheAPI.Move the mutex to an unexported
mufield and add deprecated forwarding methods for compatibility. This keeps existing callers working while making cache locking an implementation detail and allows the synchronization primitive to change independently in the future.