sttp.client4.testing.WebSocketStreamBackendStub.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of core_2.13 Show documentation
core
The newest version!
package sttp.client4.testing

import sttp.client4._
import sttp.monad.{FutureMonad, IdentityMonad, MonadError}

import scala.concurrent.Future
import scala.concurrent.ExecutionContext
import sttp.capabilities.WebSockets
import sttp.shared.Identity

/** A stub backend to use in tests.
  *
  * The stub can be configured to respond with a given response if the request matches a predicate (see the
  * [[whenRequestMatches()]] method).
  *
  * Note however, that this is not type-safe with respect to the type of the response body - the stub doesn't have a way
  * to check if the type of the body in the configured response is the same as the one specified by the request. Some
  * conversions will be attempted (e.g. from a `String` to a custom mapped type, as specified in the request, see the
  * documentation for more details).
  *
  * For web socket requests, the stub can be configured to returned both custom [[sttp.ws.WebSocket]] implementations,
  * as well as [[sttp.ws.testing.WebSocketStub]] instances.
  *
  * For requests which return the response as a stream, if the stub should return a raw stream value (which should then
  * be passed to the stream-consuming function, or mapped to another value), it should be wrapped with [[RawStream]].
  *
  * Predicates can match requests basing on the URI or headers. A [[ClassCastException]] might occur if for a given
  * request, a response is specified with the incorrect or inconvertible body type.
  */
class WebSocketStreamBackendStub[F[_], S](
    monad: MonadError[F],
    matchers: PartialFunction[GenericRequest[_, _], F[Response[_]]],
    fallback: Option[WebSocketStreamBackend[F, S]]
) extends AbstractBackendStub[F, S with WebSockets](monad, matchers, fallback)
    with WebSocketStreamBackend[F, S] {
  type Self = WebSocketStreamBackendStub[F, S]
  override protected def withMatchers(
      matchers: PartialFunction[GenericRequest[_, _], F[Response[_]]]
  ): WebSocketStreamBackendStub[F, S] =
    new WebSocketStreamBackendStub(monad, matchers, fallback)
}

object WebSocketStreamBackendStub {

  /** Create a stub of a synchronous backend (which doesn't use an effect type). */
  def synchronous[S]: WebSocketStreamBackendStub[Identity, S] =
    new WebSocketStreamBackendStub(IdentityMonad, PartialFunction.empty, None)

  /** Create a stub of an asynchronous backend (which uses the Scala's built-in [[Future]] as the effect type). */
  def asynchronousFuture[S](implicit ec: ExecutionContext): WebSocketStreamBackendStub[Future, S] =
    new WebSocketStreamBackendStub(new FutureMonad(), PartialFunction.empty, None)

  /** Create a stub backend using the given response monad (which determines the effect type for responses). */
  def apply[F[_], S](monad: MonadError[F]): WebSocketStreamBackendStub[F, S] =
    new WebSocketStreamBackendStub(monad, PartialFunction.empty, None)

  /** Create a stub backend which delegates send requests to the given fallback backend, if the request doesn't match
    * any of the specified predicates.
    */
  def withFallback[F[_], S](fallback: WebSocketStreamBackend[F, S]): WebSocketStreamBackendStub[F, S] =
    new WebSocketStreamBackendStub(fallback.monad, PartialFunction.empty, Some(fallback))
}