Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor event listener to use async instead of Dispatcher #33

Merged
merged 5 commits into from
Nov 29, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 17 additions & 27 deletions dom/src/main/scala/fs2/dom/EventTargetHelpers.scala
Original file line number Diff line number Diff line change
Expand Up @@ -18,38 +18,28 @@ package fs2
package dom

import cats.effect.kernel.Async
import cats.effect.kernel.Resource
import cats.effect.std.Dispatcher
import cats.syntax.all._
import fs2.concurrent.Channel
import org.scalajs.dom.Event
import org.scalajs.dom.EventListenerOptions
import org.scalajs.dom.EventTarget
import org.scalajs.dom

private[dom] object EventTargetHelpers {

def listen[F[_], E <: Event](target: EventTarget, `type`: String)(implicit
def listen[F[_], E <: dom.Event](target: dom.EventTarget, `type`: String)(implicit
F: Async[F]
): Resource[F, Stream[F, E]] = {
val setup = for {
dispatcher <- Dispatcher.sequential[F]
abort <- AbortController[F]
ch <- Resource.eval {
Channel.unbounded[F, E].flatTap { ch =>
F.delay {
target.addEventListener[E](
`type`,
(ev: E) => dispatcher.unsafeRunAndForget(ch.send(ev)),
new EventListenerOptions {
signal = abort
}
)
}
): Stream[F, E] =
Stream.repeatEval {
F.async[E] { cb =>
F.delay {
val ctrl = new dom.AbortController
target.addEventListener[E](
`type`,
(e: E) => cb(Right(e)),
new dom.EventListenerOptions {
once = true
signal = ctrl.signal
}
)
Some(F.delay(ctrl.abort()))
}
}
} yield ch

setup.map(_.stream)
}
}

}
14 changes: 10 additions & 4 deletions dom/src/main/scala/fs2/dom/History.scala
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ package fs2.dom
import cats.data.OptionT
import cats.effect.kernel.Async
import cats.effect.kernel.Ref
import cats.effect.std.Queue
import cats.syntax.all._
import fs2.Stream
import fs2.concurrent.Signal
Expand Down Expand Up @@ -51,10 +52,15 @@ object History {
new History[F, S] {

def state = new Signal[F, Option[S]] {
def discrete =
Stream.resource(eventsResource[F, PopStateEvent](window, "popstate")).flatMap { events =>
Stream.eval(get) ++ events.evalMap(e => serializer.deserialize(e.state).map(Some(_)))
}
def discrete = Stream.eval(Queue.circularBuffer[F, PopStateEvent](1)).flatMap { queue =>
val head = Stream.eval(get)
val tail =
Stream.repeatEval(queue.take).evalMap(e => serializer.deserialize(e.state).map(Some(_)))

val listener = events[F, PopStateEvent](window, "popstate").foreach(queue.offer(_))

(head ++ tail).concurrently(listener)
}

def get = OptionT(F.delay(Option(window.history.state)))
.semiflatMap(serializer.deserialize(_))
Expand Down
6 changes: 3 additions & 3 deletions dom/src/main/scala/fs2/dom/package.scala
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,12 @@ package object dom {
stream.through(toReadableStream).compile.resource.lastOrError

def events[F[_]: Async, E <: Event](target: EventTarget, `type`: String): Stream[F, E] =
Stream.resource(EventTargetHelpers.listen(target, `type`)).flatten
EventTargetHelpers.listen(target, `type`)

@deprecated("Use events", "0.1.1")
def eventsResource[F[_]: Async, E <: Event](
target: EventTarget,
`type`: String
): Resource[F, Stream[F, E]] =
EventTargetHelpers.listen(target, `type`)
): Resource[F, Stream[F, E]] = Resource.pure(events(target, `type`))

}
1 change: 1 addition & 0 deletions testsBrowser/src/test/scala/fs2/dom/HistorySuite.scala
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ class HistorySuite extends CatsEffectSuite {
_ <- history.state.get.assertEquals(Some(3))
_ <- history.back
_ <- history.state.get.assertEquals(Some(1))
_ <- IO.sleep(1.second) // before the next UI
_ <- history.forward
_ <- history.state.get.assertEquals(Some(3))
_ <- ch.stream.take(2).compile.toList.assertEquals(List(1, 3))
Expand Down