RxJava 2

intermediate

Arrow aims to enhance the user experience when using RxJava. While providing other datatypes that are capable of handling effects, like IO, the style of programming encouraged by the library allows users to generify behavior for any existing abstractions.

One of such abstractions is RxJava, a library focused on providing composable streams that enable reactive programming. Observable streams are created by chaining operators into what are called observable chains.

Observable.from(7, 4, 11, 3)
  .map { it + 1 }
  .filter { it % 2 == 0 }
  .scan { acc, value -> acc + value }
  .toList()
  .subscribeOn(Schedulers.computation())
  .blockingFirst()
//[8, 20, 24]

Integration with your existing Observable chains

The largest quality of life improvement when using Observables in Arrow is the introduction of the Monad Comprehension. This library construct allows expressing asynchronous Observable sequences as synchronous code using binding/bind.

Arrow Wrapper

To wrap any existing Observable in its Arrow Wrapper counterpart you can use the extension function k().

import arrow.effects.*
import io.reactivex.*
import io.reactivex.subjects.*

val obs = Observable.fromArray(1, 2, 3, 4, 5).k()
obs
// ObservableK(observable=io.reactivex.internal.operators.observable.ObservableFromArray@3c3f8123)
val flow = Flowable.fromArray(1, 2, 3, 4, 5).k()
flow
// FlowableK(flowable=io.reactivex.internal.operators.flowable.FlowableFromArray@2749ed67)
val single = Single.fromCallable { 1 }.k()
single
// SingleK(single=io.reactivex.internal.operators.single.SingleFromCallable@4b238298)
val maybe = Maybe.fromCallable { 1 }.k()
maybe
// MaybeK(maybe=io.reactivex.internal.operators.maybe.MaybeFromCallable@146899d6)
val subject = PublishSubject.create<Int>().k()
subject
// ObservableK(observable=io.reactivex.subjects.PublishSubject@45072fbf)

You can return to their regular forms using the function value().

obs.value()
// io.reactivex.internal.operators.observable.ObservableFromArray@3c3f8123
flow.value()
// io.reactivex.internal.operators.flowable.FlowableFromArray@2749ed67
single.value()
// io.reactivex.internal.operators.single.SingleFromCallable@4b238298
maybe.value()
// io.reactivex.internal.operators.maybe.MaybeFromCallable@146899d6
subject.value()
// io.reactivex.subjects.PublishSubject@45072fbf

Observable comprehensions

The library provides instances of MonadError and MonadDefer.

Async allows you to generify over datatypes that can run asynchronous code. You can use it with ObservableK, FlowableK or SingleK.

fun <F> getSongUrlAsync(MS: MonadDefer<F>) =
  MS { getSongUrl() }

val songObservable: ObservableKOf<Url> = getSongUrlAsync(ObservableK.monadDefer())
val songFlowable: FlowableKOf<Url> = getSongUrlAsync(FlowableK.monadDefer())
val songSingle: SingleKOf<Url> = getSongUrlAsync(SingleK.monadDefer())
val songMaybe: MaybeKOf<Url> = getSongUrlAsync(MaybeK.monadDefer())

MonadError can be used to start a Monad Comprehension using the method bindingCatch, with all its benefits.

Let’s take an example and convert it to a comprehension. We’ll create an observable that loads a song from a remote location, and then reports the current play % every 100 milliseconds until the percentage reaches 100%:

getSongUrlAsync()
  .map { songUrl -> MediaPlayer.load(songUrl) }
  .flatMap {
    val totalTime = musicPlayer.getTotaltime()
    Observable.interval(100, Milliseconds)
      .flatMap {
        Observable.create { musicPlayer.getCurrentTime() }
          .subscribeOn(AndroidSchedulers.mainThread())
          .map { tick -> (tick / totalTime * 100).toInt() }
      }
      .takeUntil { percent -> percent >= 100 }
      .observeOn(Schedulers.immediate())
  }

When rewritten using bindingCatch it becomes:

import arrow.effects.*
import arrow.typeclasses.*

ForObservableK extensions { 
 bindingCatch {
  val songUrl = getSongUrlAsync().bind()
  val musicPlayer = MediaPlayer.load(songUrl)
  val totalTime = musicPlayer.getTotaltime()

  val end = PublishSubject.create<Unit>()
  Observable.interval(100, Milliseconds).takeUntil(end).bind()

  val tick = bindIn(UI) { musicPlayer.getCurrentTime() }
  val percent = (tick / totalTime * 100).toInt()
  if (percent >= 100) {
    end.onNext(Unit)
  }

  percent
 }.fix()
}

Note that any unexpected exception, like AritmeticException when totalTime is 0, is automatically caught and wrapped inside the observable.

Subscription and cancellation

Observables created with comprehensions like bindingCatch behave the same way regular observables do, including cancellation by disposing the subscription.

val disposable =
  songObservable.value()
    .subscribe({ Log.d("Song $it") } , { println("Error $it") })

disposable.dispose()

Note that MonadDefer provides an alternative to bindingCatch called bindingCancellable returning a arrow.Disposable. Invoking this Disposable causes an BindingCancellationException in the chain which needs to be handled by the subscriber, similarly to what Deferred does.

import arrow.effects.instances.observable.monad.*

val (observable, disposable) =
  bindingCancellable {
    val userProfile = Observable.create { getUserProfile("123") }
    val friendProfiles = userProfile.friends().map { friend ->
        bindDefer { getProfile(friend.id) }
    }
    listOf(userProfile) + friendProfiles
  }

observable.value()
  .subscribe({ Log.d("User $it") } , { println("Boom! caused by $it") })

disposable()
// Boom! caused by BindingCancellationException

Stack safety

While MonadDefer usually guarantees stack safety, this does not apply for the rx2 wrapper types. This is a limitation on rx2’s side. See the corresponding github issue.

To overcome this limitation and run code in a stack safe way, one can make use of bindingStackSafe which is provided for every instance of Monad when you have arrow-free included.

import arrow.Kind
import arrow.effects.FlowableK
import arrow.effects.ForFlowableK
import arrow.effects.fix
import arrow.effects.flowablek.monad.monad
import arrow.effects.flowablek.applicativeError.attempt
import arrow.free.bindingStackSafe
import arrow.free.run

fun main() {
  //sampleStart
  // This will not result in a stack overflow
  val result = FlowableK.monad().bindingStackSafe {
    (1..50000).fold(just(0)) { acc: Kind<ForFlowableK, Int>, x: Int ->
      just(acc.bind() + 1)
    }.bind()
  }.run(FlowableK.monad())
  //sampleEnd
  println(result.fix().flowable.blockingFirst()!!)
}
import arrow.core.Try
// This will result in a stack overflow

Try {
  FlowableK.monad().binding {
    (1..50000).fold(just(0)) { acc: Kind<ForFlowableK, Int>, x: Int ->
      just(acc.bind() + 1)
    }.bind()
  }.fix().flowable.blockingFirst()
}
// Failure(exception=java.lang.StackOverflowError)

Supported Type Classes

Module Type classes
arrow.effects.typeclasses Async, Bracket, ConcurrentEffect, Effect, MonadDefer
arrow.typeclasses ApplicativeError, Applicative, Foldable, Functor, MonadError, Monad, MonadThrow, Traverse