Fetch

Join the chat at https://gitter.im/47deg/fetch Build Status codecov.io Maven Central License Latest version Scala.js GitHub Issues

A library for Simple & Efficient data access in Scala and Scala.js

Installation

Add the following dependency to your project's build file.

For Scala 2.11.x and 2.12.x:

"com.47deg" %% "fetch" % "1.0.0-RC1"

Or, if using Scala.js (0.6.x):

"com.47deg" %%% "fetch" % "1.0.0-RC1"

Remote data

Fetch is a library for making access to data both simple & efficient. Fetch is especially useful when querying data that has a latency cost, such as databases or web services.

Define your data sources

To tell Fetch how to get the data you want, you must implement the DataSource typeclass. Data sources have fetch and batch methods that define how to fetch such a piece of data.

Data Sources take two type parameters:

  1. Identity is a type that has enough information to fetch the data
  2. Result is the type of data we want to fetch
import cats.data.NonEmptyList
import cats.effect.ConcurrentEffect
import cats.temp.par.Par

trait DataSource[Identity, Result]{
  def name: String
  def fetch[F[_] : ConcurrentEffect : Par](id: Identity): F[Option[Result]]
  def batch[F[_] : ConcurrentEffect : Par](ids: NonEmptyList[Identity]): F[Map[Identity, Result]]
}

Returning ConcurrentEffect instances from the fetch methods allows us to specify if the fetch must run synchronously or asynchronously and use all the goodies available in cats and cats-effect.

We'll implement a dummy data source that can convert integers to strings. For convenience, we define a fetchString function that lifts identities (Int in our dummy data source) to a Fetch.

import cats.data.NonEmptyList
import cats.effect._
import cats.temp.par._
import cats.instances.list._
import cats.syntax.all._

import fetch._

object ToStringSource extends DataSource[Int, String]{
  override def name = "ToString"

  override def fetch[F[_] : ConcurrentEffect : Par](id: Int): F[Option[String]] = {
    Sync[F].delay(println(s"--> [${Thread.currentThread.getId}] One ToString $id")) >>
    Sync[F].delay(println(s"<-- [${Thread.currentThread.getId}] One ToString $id")) >>
    Sync[F].pure(Option(id.toString))
  }

  override def batch[F[_] : ConcurrentEffect : Par](ids: NonEmptyList[Int]): F[Map[Int, String]] = {
    Sync[F].delay(println(s"--> [${Thread.currentThread.getId}] Batch ToString $ids")) >>
    Sync[F].delay(println(s"<-- [${Thread.currentThread.getId}] Batch ToString $ids")) >>
    Sync[F].pure(ids.toList.map(i => (i, i.toString)).toMap)
  }
}

def fetchString[F[_] : ConcurrentEffect](n: Int): Fetch[F, String] =
  Fetch(n, ToStringSource)

Creating a runtime

Since Fetch relies on ConcurrentEffect from the cats-effect library, we'll need a runtime for executing our effects. We'll be using IO from cats-effect to run fetches, but you can use any type that has a ConcurrentEffect instance.

For executing IO we need a ContextShift[IO] used for running IO instances and a Timer[IO] that is used for scheduling, let's go ahead and create them, we'll use a java.util.concurrent.ScheduledThreadPoolExecutor with a couple of threads to run our fetches.

import java.util.concurrent._
import scala.concurrent.ExecutionContext

val executor = new ScheduledThreadPoolExecutor(4)
val executionContext: ExecutionContext = ExecutionContext.fromExecutor(executor)

implicit val timer: Timer[IO] = IO.timer(executionContext)
implicit val cs: ContextShift[IO] = IO.contextShift(executionContext)

Creating and running a fetch

Now that we can convert Int values to Fetch[F, String], let's try creating a fetch.

def fetchOne[F[_] : ConcurrentEffect]: Fetch[F, String] =
  fetchString(1)

Let's run it and wait for the fetch to complete, we'll use IO#unsafeRunTimed for testing purposes, which will run an IO[A] to Option[A] and return None if it didn't complete in time:

import scala.concurrent.duration._
// import scala.concurrent.duration._

Fetch.run[IO](fetchOne).unsafeRunTimed(5.seconds)
// --> [48] One ToString 1
// <-- [48] One ToString 1
// res0: Option[String] = Some(1)

As you can see in the previous example, the ToStringSource is queried once to get the value of 1.

Batching

Multiple fetches to the same data source are automatically batched. For illustrating it, we are going to compose three independent fetch results as a tuple.

def fetchThree[F[_] : ConcurrentEffect]: Fetch[F, (String, String, String)] =
  (fetchString(1), fetchString(2), fetchString(3)).tupled

When executing the above fetch, note how the three identities get batched and the data source is only queried once.

Fetch.run[IO](fetchThree).unsafeRunTimed(5.seconds)
// --> [49] Batch ToString NonEmptyList(1, 2, 3)
// <-- [49] Batch ToString NonEmptyList(1, 2, 3)
// res1: Option[(String, String, String)] = Some((1,2,3))

Note that the DataSource#batch method is not mandatory, it will be implemented in terms of DataSource#fetch if you don't provide an implementation.

object UnbatchedToStringSource extends DataSource[Int, String]{
  override def name = "UnbatchedToString"

  override def fetch[F[_] : ConcurrentEffect : Par](id: Int): F[Option[String]] = {
    Sync[F].delay(println(s"--> [${Thread.currentThread.getId}] One UnbatchedToString $id")) >>
    Sync[F].delay(println(s"<-- [${Thread.currentThread.getId}] One UnbatchedToString $id")) >>
    Sync[F].pure(Option(id.toString))
  }
}

def unbatchedString[F[_] : ConcurrentEffect](n: Int): Fetch[F, String] =
  Fetch(n, UnbatchedToStringSource)

Let's create a tuple of unbatched string requests.

def fetchUnbatchedThree[F[_] : ConcurrentEffect]: Fetch[F, (String, String, String)] =
  (unbatchedString(1), unbatchedString(2), unbatchedString(3)).tupled

When executing the above fetch, note how the three identities get requested in parallel. You can override batch to execute queries sequentially if you need to.

Fetch.run[IO](fetchUnbatchedThree).unsafeRunTimed(5.seconds)
// --> [49] One UnbatchedToString 2
// --> [48] One UnbatchedToString 3
// --> [51] One UnbatchedToString 1
// <-- [48] One UnbatchedToString 3
// <-- [49] One UnbatchedToString 2
// <-- [51] One UnbatchedToString 1
// res2: Option[(String, String, String)] = Some((1,2,3))

Parallelism

If we combine two independent fetches from different data sources, the fetches can be run in parallel. First, let's add a data source that fetches a string's size.

object LengthSource extends DataSource[String, Int]{
  override def name = "Length"

  override def fetch[F[_] : ConcurrentEffect : Par](id: String): F[Option[Int]] = {
    Sync[F].delay(println(s"--> [${Thread.currentThread.getId}] One Length $id")) >>
    Sync[F].delay(println(s"<-- [${Thread.currentThread.getId}] One Length $id")) >>
    Sync[F].pure(Option(id.size))
  }
  override def batch[F[_] : ConcurrentEffect : Par](ids: NonEmptyList[String]): F[Map[String, Int]] = {
    Sync[F].delay(println(s"--> [${Thread.currentThread.getId}] Batch Length $ids")) >>
    Sync[F].delay(println(s"<-- [${Thread.currentThread.getId}] Batch Length $ids")) >>
    Sync[F].pure(ids.toList.map(i => (i, i.size)).toMap)
  }
}

def fetchLength[F[_] : ConcurrentEffect](s: String): Fetch[F, Int] =
  Fetch(s, LengthSource)

And now we can easily receive data from the two sources in a single fetch.

def fetchMulti[F[_] : ConcurrentEffect]: Fetch[F, (String, Int)] =
  (fetchString(1), fetchLength("one")).tupled

Note how the two independent data fetches run in parallel, minimizing the latency cost of querying the two data sources.

Fetch.run[IO](fetchMulti).unsafeRunTimed(5.seconds)
// --> [48] One ToString 1
// <-- [48] One ToString 1
// --> [50] One Length one
// <-- [50] One Length one
// res3: Option[(String, Int)] = Some((1,3))

Caching

When fetching an identity, subsequent fetches for the same identity are cached. Let's try creating a fetch that asks for the same identity twice.

import cats.syntax.all._

def fetchTwice[F[_] : ConcurrentEffect]: Fetch[F, (String, String)] = for {
  one <- fetchString(1)
  two <- fetchString(1)
} yield (one, two)

While running it, notice that the data source is only queried once. The next time the identity is requested it's served from the cache.

Fetch.run[IO](fetchTwice).unsafeRunTimed(5.seconds)
// --> [51] One ToString 1
// <-- [51] One ToString 1
// res4: Option[(String, String)] = Some((1,1))

For more in-depth information take a look at our documentation.

Fetch in the wild

If you wish to add your library here please consider a PR to include it in the list below.

Copyright

Fetch is designed and developed by 47 Degrees

Copyright (C) 2016-2018 47 Degrees. http://47deg.com