Merge/main/2024.1.0

face/capture/src/main/java/com/simprints/face/capture/screens/livefeedback/LiveFeedbackFragment.kt

@@ -37,7 +37,7 @@ import com.simprints.infra.resources.R as IDR
 
 
 /**
- * This is the class presented as the user is capturing theface, they are presented with this fragment, which displays
+ * As the user is capturing subject's face, they are presented with this fragment, which displays
  * live information about distance and whether the face is ready to be captured or not.
  * It also displays the capture process of the face and then sends this result to
  * [com.simprints.face.capture.screens.confirmation.ConfirmationFragment]
@@ -66,18 +66,14 @@ internal class LiveFeedbackFragment : Fragment(R.layout.fragment_live_feedback)
                 IDR.string.face_capturing_permission_denied,
                 Toast.LENGTH_LONG
             ).show()
+        } else {
+            setUpCamera()
         }
-        // init fragment anyway
-        initFragment()
     }
 
     override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
         super.onViewCreated(view, savedInstanceState)
-        if (requireActivity().hasPermission(Manifest.permission.CAMERA)) {
-            initFragment()
-        } else {
-            launchPermissionRequest.launch(Manifest.permission.CAMERA)
-        }
+        initFragment()
     }
 
     private fun initFragment() {
@@ -96,13 +92,15 @@ internal class LiveFeedbackFragment : Fragment(R.layout.fragment_live_feedback)
                     binding.captureOverlay.rectInCanvas,
                     Size(binding.captureOverlay.width, binding.captureOverlay.height),
                 )
-                setUpCamera()
             }
         }
     }
 
     /** Initialize CameraX, and prepare to bind the camera use cases  */
     private fun setUpCamera() = lifecycleScope.launch {
+        if (::cameraExecutor.isInitialized) {
+            return@launch
+        }
         // Initialize our background executor
         cameraExecutor = Executors.newSingleThreadExecutor()
         // ImageAnalysis
@@ -121,6 +119,18 @@ internal class LiveFeedbackFragment : Fragment(R.layout.fragment_live_feedback)
         preview.setSurfaceProvider(binding.faceCaptureCamera.surfaceProvider)
     }
 
+    override fun onStart() {
+        super.onStart()
+
+        // Check permission in onStart() so that if user left the app to go to Settings
+        // and give the permission, it's reflected when they come back to SID
+        if (requireActivity().hasPermission(Manifest.permission.CAMERA)) {
+            setUpCamera()
+        } else {
+            launchPermissionRequest.launch(Manifest.permission.CAMERA)
+        }
+    }
+
     override fun onStop() {
         // Shut down our background executor
         if(::cameraExecutor.isInitialized) {

feature/dashboard/src/main/java/com/simprints/feature/dashboard/logout/LogoutSyncViewModel.kt

@@ -4,22 +4,17 @@ import androidx.lifecycle.LiveData
 import androidx.lifecycle.ViewModel
 import androidx.lifecycle.liveData
 import androidx.lifecycle.viewModelScope
-import com.simprints.core.ExternalScope
 import com.simprints.core.livedata.LiveDataEventWithContent
 import com.simprints.feature.dashboard.logout.usecase.LogoutUseCase
-import com.simprints.infra.authlogic.AuthManager
 import com.simprints.infra.config.store.ConfigRepository
 import com.simprints.infra.config.store.models.SettingsPasswordConfig
 import dagger.hilt.android.lifecycle.HiltViewModel
-import kotlinx.coroutines.CoroutineScope
-import kotlinx.coroutines.launch
 import javax.inject.Inject
 
 @HiltViewModel
 internal class LogoutSyncViewModel @Inject constructor(
     private val configRepository: ConfigRepository,
     private val logoutUseCase: LogoutUseCase,
-    @ExternalScope private val externalScope: CoroutineScope,
 ) : ViewModel() {
 
     val settingsLocked: LiveData<LiveDataEventWithContent<SettingsPasswordConfig>>
@@ -29,6 +24,7 @@ internal class LogoutSyncViewModel @Inject constructor(
 
 
     fun logout() {
-        externalScope.launch { logoutUseCase() }
+        logoutUseCase()
     }
 }
+

feature/dashboard/src/main/java/com/simprints/feature/dashboard/logout/usecase/LogoutUseCase.kt

@@ -2,17 +2,20 @@ package com.simprints.feature.dashboard.logout.usecase
 
 import com.simprints.infra.authlogic.AuthManager
 import com.simprints.infra.sync.SyncOrchestrator
+import kotlinx.coroutines.runBlocking
 import javax.inject.Inject
 
 internal class LogoutUseCase @Inject constructor(
     private val syncOrchestrator: SyncOrchestrator,
     private val authManager: AuthManager,
 ) {
 
-    suspend operator fun invoke() {
+    operator fun invoke() = runBlocking {
         // Cancel all background sync
         syncOrchestrator.cancelBackgroundWork()
         syncOrchestrator.deleteEventSyncInfo()
+        // sign out the user
         authManager.signOut()
     }
+
 }

feature/dashboard/src/main/java/com/simprints/feature/dashboard/main/sync/SyncViewModel.kt

@@ -6,7 +6,6 @@ import androidx.lifecycle.MediatorLiveData
 import androidx.lifecycle.MutableLiveData
 import androidx.lifecycle.ViewModel
 import androidx.lifecycle.viewModelScope
-import com.simprints.core.ExternalScope
 import com.simprints.core.livedata.LiveDataEvent
 import com.simprints.core.livedata.LiveDataEventWithContent
 import com.simprints.core.livedata.send
@@ -56,9 +55,8 @@ internal class SyncViewModel @Inject constructor(
     private val configRepository: ConfigRepository,
     private val timeHelper: TimeHelper,
     private val authStore: AuthStore,
-    private val logoutUseCase: LogoutUseCase,
+    private val logout: LogoutUseCase,
     private val recentUserActivityManager: RecentUserActivityManager,
-    @ExternalScope private val externalScope: CoroutineScope,
 ) : ViewModel() {
 
     companion object {
@@ -106,8 +104,8 @@ internal class SyncViewModel @Inject constructor(
                     configRepository.getProject(authStore.signedInProjectId).state == ProjectState.PROJECT_ENDING
 
                 if (isSyncComplete && isProjectEnding) {
-                    externalScope.launch {
-                        logoutUseCase()
+                    viewModelScope.launch {
+                        logout()
                         _signOutEventLiveData.postValue(LiveDataEvent())
                     }
                 }

feature/dashboard/src/main/java/com/simprints/feature/dashboard/settings/about/AboutViewModel.kt

@@ -4,7 +4,6 @@ import androidx.lifecycle.LiveData
 import androidx.lifecycle.MutableLiveData
 import androidx.lifecycle.ViewModel
 import androidx.lifecycle.viewModelScope
-import com.simprints.core.ExternalScope
 import com.simprints.core.livedata.LiveDataEventWithContent
 import com.simprints.core.livedata.send
 import com.simprints.feature.dashboard.logout.usecase.LogoutUseCase
@@ -16,18 +15,16 @@ import com.simprints.infra.eventsync.EventSyncManager
 import com.simprints.infra.recent.user.activity.RecentUserActivityManager
 import com.simprints.infra.recent.user.activity.domain.RecentUserActivity
 import dagger.hilt.android.lifecycle.HiltViewModel
-import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.flow.first
 import kotlinx.coroutines.launch
 import javax.inject.Inject
 
 @HiltViewModel
 internal class AboutViewModel @Inject constructor(
     private val configRepository: ConfigRepository,
-    private val logoutUseCase: LogoutUseCase,
+    private val logout: LogoutUseCase,
     private val eventSyncManager: EventSyncManager,
     private val recentUserActivityManager: RecentUserActivityManager,
-    @ExternalScope private val externalScope: CoroutineScope,
 ) : ViewModel() {
 
     val syncAndSearchConfig: LiveData<SyncAndSearchConfig>
@@ -75,9 +72,6 @@ internal class AboutViewModel @Inject constructor(
     private suspend fun canSyncDataToSimprints(): Boolean =
         configRepository.getProjectConfiguration().canSyncDataToSimprints()
 
-    private fun logout() {
-        externalScope.launch { logoutUseCase() }
-    }
 
     private fun load() = viewModelScope.launch {
         val configuration = configRepository.getProjectConfiguration()

feature/dashboard/src/test/java/com/simprints/feature/dashboard/logout/LogoutSyncViewModelTest.kt

@@ -13,7 +13,6 @@ import io.mockk.coVerify
 import io.mockk.every
 import io.mockk.impl.annotations.MockK
 import io.mockk.mockk
-import kotlinx.coroutines.CoroutineScope
 import org.junit.Before
 import org.junit.Rule
 import org.junit.Test
@@ -43,7 +42,6 @@ internal class LogoutSyncViewModelTest {
         val viewModel = LogoutSyncViewModel(
             configRepository = configRepository,
             logoutUseCase = logoutUseCase,
-            externalScope = CoroutineScope(testCoroutineRule.testCoroutineDispatcher)
         )
 
         viewModel.logout()
@@ -62,7 +60,6 @@ internal class LogoutSyncViewModelTest {
         val viewModel = LogoutSyncViewModel(
             configRepository = configRepository,
             logoutUseCase = logoutUseCase,
-            externalScope = CoroutineScope(testCoroutineRule.testCoroutineDispatcher),
         )
         val resultConfig = viewModel.settingsLocked.getOrAwaitValue()
         assertThat(resultConfig.peekContent()).isEqualTo(config)

feature/dashboard/src/test/java/com/simprints/feature/dashboard/logout/usecase/LogoutUseCaseTest.kt

@@ -0,0 +1,51 @@
+package com.simprints.feature.dashboard.logout.usecase
+
+import androidx.arch.core.executor.testing.InstantTaskExecutorRule
+import com.simprints.infra.authlogic.AuthManager
+import com.simprints.infra.sync.SyncOrchestrator
+import com.simprints.testtools.common.coroutines.TestCoroutineRule
+import io.mockk.MockKAnnotations
+import io.mockk.coVerify
+import io.mockk.impl.annotations.MockK
+import kotlinx.coroutines.test.runTest
+import org.junit.Before
+import org.junit.Rule
+import org.junit.Test
+
+class LogoutUseCaseTest {
+
+    @get:Rule
+    val rule = InstantTaskExecutorRule()
+
+    @get:Rule
+    val testCoroutineRule = TestCoroutineRule()
+
+    @MockK
+    private lateinit var syncOrchestrator: SyncOrchestrator
+
+    @MockK
+    private lateinit var authManager: AuthManager
+
+    private lateinit var useCase: LogoutUseCase
+
+    @Before
+    fun setUp() {
+        MockKAnnotations.init(this, relaxed = true)
+
+        useCase = LogoutUseCase(
+            syncOrchestrator = syncOrchestrator,
+            authManager = authManager,
+        )
+    }
+
+    @Test
+    fun `Fully logs out when called`() = runTest {
+        useCase.invoke()
+
+        coVerify {
+            syncOrchestrator.cancelBackgroundWork()
+            syncOrchestrator.deleteEventSyncInfo()
+            authManager.signOut()
+        }
+    }
+}

feature/dashboard/src/test/java/com/simprints/feature/dashboard/main/sync/SyncViewModelTest.kt

@@ -44,7 +44,6 @@ import io.mockk.every
 import io.mockk.impl.annotations.MockK
 import io.mockk.mockk
 import io.mockk.verify
-import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.flow.flowOf
 import org.junit.Before
 import org.junit.Rule
@@ -444,8 +443,7 @@ internal class SyncViewModelTest {
         configRepository = configRepository,
         timeHelper = timeHelper,
         authStore = authStore,
-        logoutUseCase = logoutUseCase,
+        logout = logoutUseCase,
         recentUserActivityManager = recentUserActivityManager,
-        externalScope = CoroutineScope(testCoroutineRule.testCoroutineDispatcher)
     )
 }

feature/dashboard/src/test/java/com/simprints/feature/dashboard/settings/about/AboutViewModelTest.kt

@@ -20,7 +20,6 @@ import io.mockk.coEvery
 import io.mockk.coVerify
 import io.mockk.every
 import io.mockk.mockk
-import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.flow.flowOf
 import kotlinx.coroutines.test.runTest
 import org.junit.Rule
@@ -66,8 +65,7 @@ class AboutViewModelTest {
             configRepository = configRepository,
             eventSyncManager = eventSyncManager,
             recentUserActivityManager = recentUserActivityManager,
-            logoutUseCase = logoutUseCase,
-            externalScope = CoroutineScope(testCoroutineRule.testCoroutineDispatcher),
+            logout = logoutUseCase,
         )
 
         assertThat(viewModel.modalities.value).isEqualTo(MODALITIES)
@@ -186,8 +184,7 @@ class AboutViewModelTest {
             configRepository = configRepository,
             eventSyncManager = eventSyncManager,
             recentUserActivityManager = recentUserActivityManager,
-            externalScope = CoroutineScope(testCoroutineRule.testCoroutineDispatcher),
-            logoutUseCase = logoutUseCase,
+            logout = logoutUseCase,
         )
     }
 }

feature/orchestrator/src/main/java/com/simprints/feature/orchestrator/OrchestratorFragment.kt

@@ -74,12 +74,20 @@ internal class OrchestratorFragment : Fragment(R.layout.fragment_orchestrator) {
     private val clientApiVm by viewModels<ClientApiViewModel>()
     private val orchestratorVm by viewModels<OrchestratorViewModel>()
 
-
-    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
-        super.onViewCreated(view, savedInstanceState)
+    override fun onCreate(savedInstanceState: Bundle?) {
+        super.onCreate(savedInstanceState)
         if (savedInstanceState != null) {
             orchestratorVm.requestProcessed = savedInstanceState.getBoolean(KEY_REQUEST_PROCESSED)
+            savedInstanceState.getString(KEY_ACTION_REQUEST)
+                ?.run(orchestratorVm::setActionRequestFromJson)
+            orchestratorVm.restoreStepsIfNeeded()
+            orchestratorVm.restoreModalitiesIfNeeded()
         }
+    }
+
+    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
+        super.onViewCreated(view, savedInstanceState)
+
         observeLoginCheckVm()
         observeClientApiVm()
         observeOrchestratorVm()
@@ -180,6 +188,10 @@ internal class OrchestratorFragment : Fragment(R.layout.fragment_orchestrator) {
     override fun onSaveInstanceState(outState: Bundle) {
         super.onSaveInstanceState(outState)
         outState.putBoolean(KEY_REQUEST_PROCESSED, orchestratorVm.requestProcessed)
+        // [MS-405] Saving the action request in the bundle, since ViewModels don't survive the
+        // process death. ActionRequest is important in mapping the correct SID response, hence it
+        // is important for it to be able to survive both configuration changes and process death.
+        outState.putString(KEY_ACTION_REQUEST, orchestratorVm.getActionRequestJson())
     }
 
     override fun onResume() {
@@ -201,5 +213,6 @@ internal class OrchestratorFragment : Fragment(R.layout.fragment_orchestrator) {
 
     companion object {
         private const val KEY_REQUEST_PROCESSED = "requestProcessed"
+        private const val KEY_ACTION_REQUEST = "actionRequest"
     }
 }