typelevel / typelevel/fs2

StreamSubscriber hangs in some scenarios

Open
#2,260 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

2.5.x 3.x
Dominant language
Scala
Stars
2.5k
Forks
636
Avg merge
2d 4h
Merged PRs (30d)
7

Description

import cats.effect.{ ContextShift, IO, BracketThrow }

import monix.eval.Task
import monix.execution.{ ExecutionModel, Scheduler }
import monix.execution.Scheduler.DefaultScheduledExecutor
import monix.execution.schedulers.AsyncScheduler
import monix.reactive.Observable

import fs2.{ Chunk, Stream }
import fs2.interop.reactivestreams.PublisherOps

import scala.concurrent.ExecutionContext

implicit val scheduler: Scheduler =
  AsyncScheduler(DefaultScheduledExecutor, ExecutionContext.global, ExecutionModel.Default)

implicit val contextShift: ContextShift[IO] =
  IO.contextShift(ExecutionContext.global)

val program: IO[Vector[Byte]] =
  Observable
    .fromIterator(Task.async[Iterator[Byte]] { cb => cb(Right(Iterator[Byte](1, 2, 3, 4, 5))) })
    .map(Array(_))
    .map(Chunk.bytes(_))
    .toReactivePublisher[Chunk[Byte]](Scheduler.global)
    .toStream[Task]
    .flatMap(Stream.chunk(_))
    .compile
    .toVector
    .to[IO]

implicitly[BracketThrow[IO]].bracket(IO.unit)(_ => program)(_ => IO.unit).unsafeRunSync()

This commit causes the issue https://github.com/typelevel/fs2/commit/a9ff266ea23c67e9feb43ea8a672242a7bf99e5d. Just in case this is the only change needed to recreate the issue:

// Before
def onSubscribe(s: Subscription): Unit = {
  nonNull(s)
  sub.onSubscribe(s).unsafeRunAsync()
}
// After
def onSubscribe(s: Subscription): Unit = {
  nonNull(s)
  sub.onSubscribe(s).unsafeRunSync()
}

IO Bracket and Task.async are needed in order to recreate the issue. I tried to isolate the problem as much as I could. It seems to be hanging in cats.effect.internals.ForwardCancelable#complete which is used by IO.cancelable and that's the function ConcurrentEffect[F].toIO calls.

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 with the StreamSubscriber onSubscribe path and compare the behavior introduced by commit a9ff266ea23c67e9feb43ea8a672242a7bf99e5d. Use the supplied FS2 2.4.4 and 2.4.6 reproductions, then inspect cats.effect.internals.ForwardCancelable#complete, IO.cancelable, and ConcurrentEffect[F].toIO. Done means the bracketed program completes without hanging on the 2.4.6 path.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
stream-processing
Issue type
Bug
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.