typelevel / typelevel/cats-effect
`WorkerThread#blockOn` implementation note is incorrect
Open
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 2.2k
- Forks
- 576
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 18
Description
blockOn may be invoked by directly using the WSTP as an ExecutionContext with scala.concurrent.blocking, no IO involved. So that's not sufficient justification for not using try/catch. Not sure if we can rejustify it, or just have to add it in.
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
Read core/jvm/src/main/scala/cats/effect/unsafe/WorkerThread.scala around lines 923-933, then inspect how blockOn is used as an ExecutionContext with scala.concurrent.blocking. Determine whether the implementation note should be reworded or the try/catch behavior changed; done means the note accurately reflects all stated blockOn entry paths.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- backend
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100