Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion android/src/main/java/dev/openfeature/sdk/NoOpProvider.kt
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ class NoOpProvider(override val hooks: List<Hook<*>> = listOf()) : FeatureProvid

override fun observe(): Flow<OpenFeatureEvents> = flowOf()

override fun isProviderReady(): Boolean = true
override fun getProviderStatus(): OpenFeatureEvents = OpenFeatureEvents.ProviderReady

data class NoOpProviderMetadata(override val name: String?) : ProviderMetadata
}
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import dev.openfeature.sdk.FeatureProvider
import dev.openfeature.sdk.OpenFeatureAPI
import dev.openfeature.sdk.OpenFeatureClient
import dev.openfeature.sdk.events.OpenFeatureEvents
import dev.openfeature.sdk.events.isProviderReady
import dev.openfeature.sdk.events.observe
import kotlinx.coroutines.CoroutineDispatcher
import kotlinx.coroutines.CoroutineScope
Expand Down
23 changes: 14 additions & 9 deletions android/src/main/java/dev/openfeature/sdk/events/EventHandler.kt
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
package dev.openfeature.sdk.events

import dev.openfeature.sdk.FeatureProvider
import kotlinx.coroutines.CoroutineDispatcher
import kotlinx.coroutines.CoroutineScope
import kotlinx.coroutines.Job
Expand All @@ -15,32 +16,38 @@ interface EventObserver {
}

interface ProviderStatus {
fun isProviderReady(): Boolean
fun getProviderStatus(): OpenFeatureEvents
}

fun FeatureProvider.isProviderReady(): Boolean =
getProviderStatus() == OpenFeatureEvents.ProviderReady

interface EventsPublisher {
fun publish(event: OpenFeatureEvents)
}

inline fun <reified T : OpenFeatureEvents> EventObserver.observe() = observe()
.filterIsInstance<T>()

class EventHandler(dispatcher: CoroutineDispatcher) : EventObserver, EventsPublisher, ProviderStatus {
class EventHandler(dispatcher: CoroutineDispatcher) :
EventObserver,
EventsPublisher,
ProviderStatus {
private val sharedFlow: MutableSharedFlow<OpenFeatureEvents> = MutableSharedFlow()
private val isProviderReady = MutableStateFlow(false)
private val currentStatus: MutableStateFlow<OpenFeatureEvents> =
MutableStateFlow(OpenFeatureEvents.ProviderShutDown)
private val job = Job()
private val coroutineScope = CoroutineScope(job + dispatcher)

init {
coroutineScope.launch {
sharedFlow.collect {
currentStatus.value = it
when (it) {
is OpenFeatureEvents.ProviderReady -> isProviderReady.value = true
is OpenFeatureEvents.ProviderStale -> isProviderReady.value = false
is OpenFeatureEvents.ProviderShutDown -> {
isProviderReady.value = false
job.cancelChildren()
}

else -> {
// do nothing
}
Expand All @@ -57,7 +64,5 @@ class EventHandler(dispatcher: CoroutineDispatcher) : EventObserver, EventsPubli

override fun observe(): Flow<OpenFeatureEvents> = sharedFlow

override fun isProviderReady(): Boolean {
return isProviderReady.value
}
override fun getProviderStatus(): OpenFeatureEvents = currentStatus.value
}
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
package dev.openfeature.sdk.events

sealed class OpenFeatureEvents {
object ProviderReady : OpenFeatureEvents()
data class ProviderError(val error: Throwable) : OpenFeatureEvents()
object ProviderStale : OpenFeatureEvents()
object ProviderShutDown : OpenFeatureEvents()
sealed interface OpenFeatureEvents {
object ProviderReady : OpenFeatureEvents
data class ProviderError(val error: Throwable) : OpenFeatureEvents
object ProviderStale : OpenFeatureEvents
object ProviderShutDown : OpenFeatureEvents
}
34 changes: 32 additions & 2 deletions android/src/test/java/dev/openfeature/sdk/EventsHandlerTest.kt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import dev.openfeature.sdk.async.observeProviderReady
import dev.openfeature.sdk.async.toAsync
import dev.openfeature.sdk.events.EventHandler
import dev.openfeature.sdk.events.OpenFeatureEvents
import dev.openfeature.sdk.events.isProviderReady
import dev.openfeature.sdk.events.observe
import kotlinx.coroutines.CoroutineScope
import kotlinx.coroutines.ExperimentalCoroutinesApi
Expand Down Expand Up @@ -192,7 +193,7 @@ class EventsHandlerTest {

OpenFeatureAPI.setProvider(
mock {
on { isProviderReady() } doReturn provider.isProviderReady()
on { getProviderStatus() } doReturn provider.getProviderStatus()
on { observeProviderReady() } doReturn provider.observeProviderReady()
}
)
Expand Down Expand Up @@ -234,7 +235,7 @@ class EventsHandlerTest {

OpenFeatureAPI.setProvider(
mock {
on { isProviderReady() } doReturn provider.isProviderReady()
on { getProviderStatus() } doReturn provider.getProviderStatus()
on { observeProviderReady() } doReturn provider.observeProviderReady()
}
)
Expand All @@ -253,4 +254,33 @@ class EventsHandlerTest {
job.join()
Assert.assertEquals(listOf("text1"), resultTexts)
}

@Test
fun accessing_status_from_provider_works() = runTest {
val dispatcher = UnconfinedTestDispatcher(testScheduler)
val eventHandler = EventHandler(dispatcher)
val provider = TestFeatureProvider(dispatcher, eventHandler)

Assert.assertEquals(OpenFeatureEvents.ProviderShutDown, provider.getProviderStatus())

provider.emitReady()

Assert.assertEquals(OpenFeatureEvents.ProviderReady, provider.getProviderStatus())

provider.emitStale()

Assert.assertEquals(OpenFeatureEvents.ProviderStale, provider.getProviderStatus())

val illegalStateException = IllegalStateException("test")
provider.emitError(illegalStateException)

Assert.assertEquals(
OpenFeatureEvents.ProviderError(illegalStateException),
provider.getProviderStatus()
)

provider.shutdown()

Assert.assertEquals(OpenFeatureEvents.ProviderShutDown, provider.getProviderStatus())
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ class TestFeatureProvider(
}

override fun shutdown() {
TODO("Not yet implemented")
eventHandler.publish(OpenFeatureEvents.ProviderShutDown)
}

override fun onContextSet(oldContext: EvaluationContext?, newContext: EvaluationContext) {
Expand Down Expand Up @@ -67,7 +67,7 @@ class TestFeatureProvider(

override fun observe() = eventHandler.observe()

override fun isProviderReady(): Boolean = eventHandler.isProviderReady()
override fun getProviderStatus(): OpenFeatureEvents = eventHandler.getProviderStatus()

fun emitReady() {
eventHandler.publish(OpenFeatureEvents.ProviderReady)
Expand All @@ -76,4 +76,8 @@ class TestFeatureProvider(
fun emitStale() {
eventHandler.publish(OpenFeatureEvents.ProviderStale)
}

fun emitError(exception: Exception) {
eventHandler.publish(OpenFeatureEvents.ProviderError(exception))
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,10 @@ import dev.openfeature.sdk.exceptions.OpenFeatureError.FlagNotFoundError
import kotlinx.coroutines.flow.Flow
import kotlinx.coroutines.flow.flow

class AlwaysBrokenProvider(override var hooks: List<Hook<*>> = listOf(), override var metadata: ProviderMetadata = AlwaysBrokenProviderMetadata()) :
class AlwaysBrokenProvider(
override var hooks: List<Hook<*>> = listOf(),
override var metadata: ProviderMetadata = AlwaysBrokenProviderMetadata()
) :
FeatureProvider {
override fun initialize(initialContext: EvaluationContext?) {
// no-op
Expand Down Expand Up @@ -70,7 +73,8 @@ class AlwaysBrokenProvider(override var hooks: List<Hook<*>> = listOf(), overrid

override fun observe(): Flow<OpenFeatureEvents> = flow { }

override fun isProviderReady(): Boolean = true
override fun getProviderStatus(): OpenFeatureEvents =
OpenFeatureEvents.ProviderError(FlagNotFoundError("test"))

class AlwaysBrokenProviderMetadata(override val name: String? = "test") : ProviderMetadata
}
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ class DoSomethingProvider(

override fun observe(): Flow<OpenFeatureEvents> = flowOf()

override fun isProviderReady(): Boolean = true
override fun getProviderStatus(): OpenFeatureEvents = OpenFeatureEvents.ProviderReady

class DoSomethingProviderMetadata(override val name: String? = "something") : ProviderMetadata
}