#76 (revert) Remove event getting methods

Author: PatilShreyas

permission-flow/src/main/java/dev/shreyaspatil/permissionFlow/PermissionFlow.kt

@@ -21,7 +21,6 @@ import dev.shreyaspatil.permissionFlow.PermissionFlow.Companion.init
 import dev.shreyaspatil.permissionFlow.impl.PermissionFlowImpl
 import kotlinx.coroutines.CoroutineDispatcher
 import kotlinx.coroutines.DelicateCoroutinesApi
-import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.StateFlow
 import kotlinx.coroutines.newFixedThreadPoolContext
 
@@ -108,31 +107,6 @@ interface PermissionFlow {
      */
     fun getPermissionState(permission: String): StateFlow<PermissionState>
 
-    /**
-     * Returns [Flow] for a given [permission] events.
-     *
-     * Flow will emit [PermissionState] whenever the state of permission is changed after collecting
-     * this flow. Initial state of permission won't be emitted.
-     *
-     * @param permission Unique permission identity (for e.g.
-     *   [android.Manifest.permission.READ_CONTACTS])
-     *
-     * Example:
-     * ```
-     *  permissionFlow.getPermissionEvent(android.Manifest.permission.READ_CONTACTS)
-     *      .collect { state ->
-     *          if (state.isGranted) {
-     *              // Do something
-     *          } else {
-     *              if (state.isRationaleRequired) {
-     *                  // Do something
-     *              }
-     *          }
-     *      }
-     * ```
-     */
-    fun getPermissionEvent(permission: String): Flow<PermissionState>
-
     /**
      * Returns [StateFlow] of a combining state for [permissions]
      *

permission-flow/src/main/java/dev/shreyaspatil/permissionFlow/impl/PermissionFlowImpl.kt

@@ -24,7 +24,6 @@ import dev.shreyaspatil.permissionFlow.PermissionState
 import dev.shreyaspatil.permissionFlow.internal.ApplicationStateMonitor
 import dev.shreyaspatil.permissionFlow.watchmen.PermissionWatchmen
 import kotlinx.coroutines.CoroutineDispatcher
-import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.StateFlow
 
 /** Default implementation of a [PermissionFlow] */
@@ -38,10 +37,6 @@ constructor(
         return watchmen.watchState(permission)
     }
 
-    override fun getPermissionEvent(permission: String): Flow<PermissionState> {
-        return watchmen.watchStateEvents(permission)
-    }
-
     override fun getMultiplePermissionState(
         vararg permissions: String
     ): StateFlow<MultiplePermissionState> {

permission-flow/src/main/java/dev/shreyaspatil/permissionFlow/watchmen/PermissionWatchmen.kt

@@ -22,16 +22,13 @@ import dev.shreyaspatil.permissionFlow.utils.stateFlow.combineStates
 import kotlinx.coroutines.CoroutineDispatcher
 import kotlinx.coroutines.CoroutineName
 import kotlinx.coroutines.CoroutineScope
-import kotlinx.coroutines.FlowPreview
 import kotlinx.coroutines.Job
 import kotlinx.coroutines.SupervisorJob
 import kotlinx.coroutines.cancelChildren
-import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.MutableSharedFlow
 import kotlinx.coroutines.flow.MutableStateFlow
 import kotlinx.coroutines.flow.StateFlow
 import kotlinx.coroutines.flow.asStateFlow
-import kotlinx.coroutines.flow.filter
 import kotlinx.coroutines.flow.launchIn
 import kotlinx.coroutines.flow.onEach
 import kotlinx.coroutines.launch
@@ -72,12 +69,6 @@ internal class PermissionWatchmen(
         return combineStates(*permissionStates) { MultiplePermissionState(it.toList()) }
     }
 
-    fun watchStateEvents(permission: String): Flow<PermissionState> {
-        // Add permission to state watchlist too
-        watchState(permission)
-        return getPermissionEvent(permission)
-    }
-
     fun notifyPermissionsChanged(permissions: Array<String>) {
         watchmenScope.launch {
             permissions.forEach { permission ->
@@ -111,9 +102,6 @@ internal class PermissionWatchmen(
             .state
     }
 
-    private fun getPermissionEvent(permission: String) =
-        permissionEvents.filter { it.permission == permission }
-
     /** Watches for the permission events and updates appropriate state holders of permission */
     private fun watchPermissionEvents() {
         if (watchEventsJob != null && watchEventsJob?.isActive == true) return

permission-flow/src/test/java/dev/shreyaspatil/permissionFlow/impl/PermissionFlowImplTest.kt

@@ -22,7 +22,6 @@ import io.mockk.every
 import io.mockk.mockk
 import io.mockk.verify
 import kotlinx.coroutines.flow.MutableStateFlow
-import kotlinx.coroutines.flow.flow
 import org.junit.Assert.assertEquals
 import org.junit.Before
 import org.junit.Test
@@ -50,19 +49,6 @@ class PermissionFlowImplTest {
         assertEquals(expectedFlow, actualFlow)
     }
 
-    @Test
-    fun testGetPermissionEvent() {
-        // Given: Permission flow
-        val expectedFlow = flow<PermissionState> {}
-        every { watchmen.watchStateEvents("A") } returns expectedFlow
-
-        // When: Flow for any permission is retrieved
-        val actualFlow = permissionFlow.getPermissionEvent("A")
-
-        // Then: Correct flow should be returned
-        assertEquals(expectedFlow, actualFlow)
-    }
-
     @Test
     fun testGetMultiplePermissionState() {
         // Given: Permission flow

permission-flow/src/test/java/dev/shreyaspatil/permissionFlow/watchmen/PermissionWatchmenTest.kt

@@ -21,10 +21,8 @@ import io.mockk.every
 import io.mockk.mockk
 import io.mockk.verify
 import kotlinx.coroutines.ExperimentalCoroutinesApi
-import kotlinx.coroutines.async
 import kotlinx.coroutines.channels.BufferOverflow
 import kotlinx.coroutines.flow.MutableSharedFlow
-import kotlinx.coroutines.flow.first
 import kotlinx.coroutines.test.StandardTestDispatcher
 import kotlinx.coroutines.test.TestScope
 import kotlinx.coroutines.test.advanceUntilIdle
@@ -73,20 +71,6 @@ class PermissionWatchmenTest {
         assertEquals(1, foregroundEvents.subscriptionCount.value)
     }
 
-    @Test
-    fun shouldWakeUpAndReturnFlow_whenWatchPermissionEventForTheFirstTime() {
-        // Given: Permission
-        val permission = "permission"
-
-        // When: Starts watching permission for the first time.
-        val flow = watchmen.watchStateEvents(permission)
-
-        // Then: Should start watching activity foreground events.
-        dispatcher.scheduler.runCurrent()
-        verify(exactly = 1) { applicationStateMonitor.activityForegroundEvents }
-        assertEquals(1, foregroundEvents.subscriptionCount.value)
-    }
-
     @Test
     fun shouldWakeUpAndReturnFlow_whenWatchMultiplePermissionForTheFirstTime() {
         // Given: Multiple Permission
@@ -152,44 +136,6 @@ class PermissionWatchmenTest {
         assertFalse(state.value.isGranted)
     }
 
-    @Test
-    fun shouldNotEmitCurrentState_whenEventIsWatched() = runTest {
-        // Given: Watching a permission flow as event and permission is not granted
-        val permission = "permission"
-        mockPermissions(permission to false)
-        watchmen.notifyPermissionsChanged(permissions = arrayOf(permission))
-
-        // When: Watching state event
-        val state = async { watchmen.watchStateEvents(permission).first() }
-        advanceUntilIdle()
-
-        // Then: Event should not be emitted with current value
-        assertTrue(state.isActive)
-
-        // When: Change in state is notified for the same permission
-        watchmen.notifyPermissionsChanged(permissions = arrayOf(permission))
-
-        // Then: Current value of flow should be false i.e. Not granted
-        assertEquals(permission, state.await().permission)
-        assertFalse(state.await().isGranted)
-    }
-
-    @Test
-    fun shouldEmitStateEvent_whenPermissionChangesAreNotified() = runTest {
-        // Given: Watching a permission flow as event
-        val permission = "permission"
-        val event = watchmen.watchStateEvents(permission)
-
-        // When: Change in state is notified for the same permission
-        mockPermissions(permission to false)
-        watchmen.notifyPermissionsChanged(permissions = arrayOf(permission))
-
-        // Then: Current value of flow should be false i.e. Not granted
-        val state = event.first()
-        assertEquals(permission, state.permission)
-        assertFalse(state.isGranted)
-    }
-
     @Test
     fun shouldUpdateMultiplePermissionFlowState_whenPermissionChangesAreNotified() {
         // Given: Watching multiple permission state
@@ -225,24 +171,6 @@ class PermissionWatchmenTest {
         assertFalse(flow.value.isGranted)
     }
 
-    @Test
-    fun shouldEmitPermissionFlowStateEvent_whenWatchmenWakesAfterSleeping() = runTest {
-        // Given: Watching a permission
-        val permission = "permission"
-        mockPermissions(permission to true)
-        val state = async { watchmen.watchStateEvents(permission).first() }
-        advanceUntilIdle()
-
-        // When: Watchmen sleeps, permission state changes and watchmen wakes after that
-        watchmen.sleep()
-        mockPermissions(permission to false)
-        watchmen.wakeUp()
-        advanceUntilIdle()
-
-        // Then: Permission state should be get updated
-        assertFalse(state.await().isGranted)
-    }
-
     @Test
     fun shouldUpdateMultiplePermissionFlowState_whenWatchmenWakesAfterSleeping() {
         // Given: Watching multiple permissions
@@ -278,23 +206,6 @@ class PermissionWatchmenTest {
         assertTrue(flow.value.isGranted)
     }
 
-    @Test
-    fun shouldEmitStateEvent_whenPermissionChangesAreNotifiedEvenIfWatchmenIsSleeping() = runTest {
-        // Given: Watching a permission flow events and watchmen is sleeping
-        val permission = "permission"
-        mockPermissions(permission to true)
-        val state = async { watchmen.watchStateEvents(permission).first() }
-        watchmen.sleep()
-
-        // When: Change in state is notified for the same permission
-        mockPermissions(permission to false)
-        watchmen.notifyPermissionsChanged(permissions = arrayOf(permission))
-        advanceUntilIdle()
-
-        // Then: Current value of flow should be changed
-        assertFalse(state.await().isGranted)
-    }
-
     @Test
     fun shouldNotUpdateMultipleFlowState_whenPermissionChangesAreNotifiedAndWatchmenIsSleeping() {
         // Given: Watching a permission flow and watchmen is sleeping