typelevel / typelevel/cats-effect

`resume`/`callback` in `cont`, `async`, etc. should return a `Boolean`

Open
#3,553 14 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

  • #3917 by @durban — closed without merging
:book: laws
Dominant language
Scala
Stars
2.2k
Forks
576
Avg merge
2d 11h
Merged PRs (30d)
18

Description

This Boolean should be similar to the Boolean returned when completing a Deferred i.e. it should indicate that this invocation of the resume/callback is the one and only one that actually completed the callback. Everyone else should get false.

This information about whether the callback succeeded would help avoid leaks in various concurrent state machines. Here are two that I encountered recently:

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the cont, async, and related resume/callback entry points, then compare their completion behavior with Deferred. Read the discussion linked in the issue and closed pull request #3917 for prior context. Done means the completing invocation returns true and later invocations return false consistently across the affected APIs.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
backend-api-design
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.