soil-query-test/soil.query.test/TestSwrClientPlus

TestSwrClientPlus

interface TestSwrClientPlus : TestSwrClient, SwrClientPlus

This extended interface of the SwrClientPlus provides the capability to mock specific queries, mutations, and subscriptions for the purpose of testing. By registering certain keys as mocks, you can control the behavior of these specific keys while the rest of the keys function normally. This allows for more targeted and precise testing of your application.

val cache = SwrCachePlus(..)
val testClient = cache.test {
     on(MySubscriptionId) { MutableStateFlow("returned fake data") }
}

testClient.doSomething()

Properties

errorRelay

abstract val errorRelay: Flow<ErrorRecord>

mutationReceiver

abstract val mutationReceiver: MutationReceiver

queryReceiver

abstract val queryReceiver: QueryReceiver

subscriptionReceiver

abstract val subscriptionReceiver: SubscriptionReceiver

Functions

awaitIdle

suspend fun TestSwrClient.awaitIdle(context: CoroutineContext = EmptyCoroutineContext, timeout: Duration = 1.seconds)

Suspends until the TestSwrClient is idle.

effect

abstract fun effect(block: Effect): Job

abstract fun gc(level: MemoryPressureLevel)

getInfiniteQuery

abstract fun <T, S> getInfiniteQuery(key: InfiniteQueryKey<T, S>, marker: Marker): InfiniteQueryRef<T, S>

getMutation

abstract fun <T, S> getMutation(key: MutationKey<T, S>, marker: Marker): MutationRef<T, S>

getQuery

abstract fun <T> getQuery(key: QueryKey<T>, marker: Marker): QueryRef<T>

getSubscription

abstract fun <T> getSubscription(key: SubscriptionKey<T>, marker: Marker): SubscriptionRef<T>

isIdleNow

abstract fun isIdleNow(): Boolean

Returns true if client is currently idle.

abstract fun <T, S> on(id: InfiniteQueryId<T, S>, fetch: FakeInfiniteQueryFetch<T, S>)

Mocks the query process corresponding to InfiniteQueryId.

abstract fun <T, S> on(testTag: InfiniteQueryTestTag<T, S>, fetch: FakeInfiniteQueryFetch<T, S>)

Mocks the query process corresponding to InfiniteQueryTestTag.

abstract fun <T, S> on(id: MutationId<T, S>, mutate: FakeMutationMutate<T, S>)

Mocks the mutation process corresponding to MutationId.

abstract fun <T, S> on(testTag: MutationTestTag<T, S>, mutate: FakeMutationMutate<T, S>)

Mocks the mutation process corresponding to MutationTestTag.

abstract fun <T> on(id: QueryId<T>, fetch: FakeQueryFetch<T>)

Mocks the query process corresponding to QueryId.

abstract fun <T> on(testTag: QueryTestTag<T>, fetch: FakeQueryFetch<T>)

Mocks the query process corresponding to QueryTestTag.

abstract fun <T> on(id: SubscriptionId<T>, subscribe: FakeSubscriptionSubscribe<T>)

Mocks the subscription process corresponding to SubscriptionId.

abstract fun <T> on(testTag: SubscriptionTestTag<T>, subscribe: FakeSubscriptionSubscribe<T>)

Mocks the subscription process corresponding to the given test tag.

onMount

abstract fun onMount(id: String)

onUnmount

abstract fun onUnmount(id: String)

prefetchInfiniteQuery

abstract fun <T, S> prefetchInfiniteQuery(key: InfiniteQueryKey<T, S>, marker: Marker): Job

prefetchQuery

abstract fun <T> prefetchQuery(key: QueryKey<T>, marker: Marker): Job

purgeAll

abstract fun purgeAll()