STAC Client pagination support

[pomadchin]

Overview

This PR refactors StacClient. All methods that returned Lists return fs2.Streams now. These changes allowed SttpStacClient to support pagination 🎉 🎉 🎉

All changes are done to keep the interface as simple as it is possible, see how it can be combined via Apply2K here

Checklist

• New tests have been added or existing tests have been modified
• Changelog updated (please use chan)

Other info

// that's how we can use tofu.Mid to add tracing both on F and G
// it is really sad that we have A in our interfaces which was done to avoid copy pasting in JVM and JS clients :/
implicit class MidOps3[U[_[_], _[_], _], F[_], G[_], A](val u: U[F, G, A]) extends AnyVal {
  def attach2(mf: U[Mid[F, *], G, A])(mg: U[F, Mid[G, *], A])(implicit af: ApplyK[U[F, *[_], A]], ag: ApplyK[U[*[_], G, A]]): U[F, G, A] =
    Mid.attach[U[*[_], G, A], F](mf)(Mid.attach[U[F, *[_], A], G](mg)(u))
}

// usage
client.attach2(midF)(midG) 

or a more traditional attach semantics:

implicit class MidOps3Tuple[U[_[_], _[_], _], F[_], G[_], A](val mfg: (U[Mid[F, *], G, A], U[F, Mid[G, *], A])) extends AnyVal {
  def attach(u: U[F, G, A])(implicit af: ApplyK[U[F, *[_], A]], ag: ApplyK[U[*[_], G, A]]): U[F, G, A] =
    Mid.attach[U[*[_], G, A], F](mfg._1)(Mid.attach[U[F, *[_], A], G](mfg._2)(u))
}

// usage 
(midF, midG) attach client

Closes #198
Closes #324
Closes #326
Closes #316
Closes #314

[pomadchin]

This still should be type aliases, traits would not work since they add children into the traits hierarchy.

[pomadchin]

G here is a separate parameter to make it independent from F.

[pomadchin]

We use the default synchronous Either backend to use the same tests set for the Scala JS backend. (c)

[pomadchin]

I guess this can be better handled via #199 eventually

[jisantuc]

This mostly looks good -- can you let me know some testing instructions so I can try it out?

[jisantuc]

ha nice first search result

[pomadchin]

@jisantuc you mean testing insturctions that are different from tests? There is also its usage example in GT Server. Sure:

// to run it you'd need the following dep
// "com.softwaremill.sttp.client3" %% "async-http-client-backend-cats-ce2" % "3.3.4"

import com.azavea.stac4s.api.client.SttpStacClient
import cats.effect.IO
import sttp.client3.asynchttpclient.cats.AsyncHttpClientCatsBackend
import sttp.client3.UriContext

import scala.concurrent.ExecutionContext

object Test {
  implicit val executionContext = ExecutionContext.global
  implicit val contextShift     = IO.contextShift(executionContext)
  implicit val timer            = IO.timer(executionContext)

  def main(args: Array[String]): Unit = {
    AsyncHttpClientCatsBackend
      .resource[IO]()
      .use { backend =>
        val client = SttpStacClient(backend, uri"https://franklin.nasa-hsi.azavea.com/")
        // any number here, or don't use take at all
        // try to pass params, fetch collections, items, etc
        client.search.take(95).compile.toList
      }
      .map(list => println(s"items count: ${list.map(_.id).distinct.length}"))
      .unsafeRunSync()
  }
}

[jisantuc]

Yeah pretty much exactly that -- it's helpful to me to have a sense of the real use that the test is a tiny version of. Maybe that's not a great attitude about tests. Anyway I threw your example into this ammonite script and it worked great:

import $ivy.`com.azavea.stac4s::core:0.4.0-13-ge85ee2f-SNAPSHOT`
import $ivy.`com.azavea.stac4s::client:0.4.0-13-ge85ee2f-SNAPSHOT`
import $ivy.`com.softwaremill.sttp.client3::async-http-client-backend-cats-ce2:3.3.4`

import com.azavea.stac4s.api.client.SttpStacClient
import cats.effect.IO
import sttp.client3.asynchttpclient.cats.AsyncHttpClientCatsBackend
import sttp.client3.UriContext

import scala.concurrent.ExecutionContext

object Test {
  implicit val executionContext = ExecutionContext.global
  implicit val contextShift     = IO.contextShift(executionContext)
  implicit val timer            = IO.timer(executionContext)

  def main(args: Array[String]): Unit = {
    AsyncHttpClientCatsBackend
      .resource[IO]()
      .use { backend =>
        val client = SttpStacClient(backend, uri"https://franklin.nasa-hsi.azavea.com/")
        // any number here, or don't use take at all
        // try to pass params, fetch collections, items, etc
        client.search.take(95).compile.toList
      }
      .map(list => println(s"items count: ${list.map(_.id).distinct.length}"))
      .unsafeRunSync()
  }
}

Test.main(Array.empty[String])