kubernetes-sigs / kubernetes-sigs/cli-utils
TechDebt: TaskContext.TaskChannel is never closed
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 178
- Forks
- 85
- PR merge metrics
- No merged PRs in 30d
Description
taskrunner.NewTaskContext creates a new TaskChannel, but never closes it.
The tests don't seem to care, but it means you can't listen on the TaskChannel until it is closed, including for tr := range taskContext.TaskChannel() {, which makes usage of the TaskChannel need some other mechanism to stop listening.
In general, the function or goroutine that sends or manages sending things to the channel should close it as a signal that no more will be sent. This implies that the TaskRunner should close the TaskChannel, since it manages the tasks that send events to the shared channel.
Contributor guide
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.
Research direction
Start at taskrunner.NewTaskContext and follow TaskContext.TaskChannel through TaskRunner, focusing on which component manages sends and task completion. Review the existing tests that exercise task channels and verify that ranging over TaskChannel terminates after all tasks finish.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- cli
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100