Lock() of Locker interface should probably take a receive-only channel
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 35/100
- Issue type
- Refactor
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- go
- Domain
- distributed-systems
Research direction
Start at store/store.go around the Locker interface and inspect the Lock signature and its implementations or callers. Check how stopChan is used, especially whether callers pass a context's Done channel. Done means the interface and affected uses consistently accept a receive-only channel without changing Lock's behavior.
Written by the indexing model from the issue text.
Description
Lock() of Locker interface should probably take a receive-only channel for stopChan, that is, instead of
Lock(stopChan chan struct{}) (<-chan struct{}, error)
have
Lock(<-stopChan chan struct{}) (<-chan struct{}, error)
Lock would not be writing to stopChan, the user of the Lock will - and this signature will allow using things like Context's Done channel directly (without mediating it with another select).
- Dominant language
- Go
- Stars
- 847
- Forks
- 204
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from docker/libkv
-
Difficulty 5/5 Over a week Newbie friendliness 15/100
-
Difficulty 3/5 1-2 days Newbie friendliness 25/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
-
Difficulty 4/5 3-5 days Newbie friendliness 28/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 84/100
-
enhancement needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
kind/cleanup
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
kubernetes-sigs/kueue#15947 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
sympozium-ai/sympozium#627 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100