Use backgroundScope

Author: bmarty

features/ftue/impl/src/test/kotlin/io/element/android/features/ftue/impl/DefaultFtueServiceTest.kt

@@ -15,18 +15,19 @@ import io.element.android.features.ftue.impl.state.DefaultFtueService
 import io.element.android.features.ftue.impl.state.FtueStep
 import io.element.android.features.lockscreen.api.LockScreenService
 import io.element.android.features.lockscreen.test.FakeLockScreenService
+import io.element.android.libraries.matrix.api.verification.SessionVerificationService
 import io.element.android.libraries.matrix.api.verification.SessionVerifiedStatus
 import io.element.android.libraries.matrix.test.verification.FakeSessionVerificationService
+import io.element.android.libraries.permissions.api.PermissionStateProvider
 import io.element.android.libraries.permissions.impl.FakePermissionStateProvider
+import io.element.android.libraries.preferences.api.store.SessionPreferencesStore
 import io.element.android.libraries.preferences.test.InMemorySessionPreferencesStore
 import io.element.android.services.analytics.api.AnalyticsService
 import io.element.android.services.analytics.test.FakeAnalyticsService
 import io.element.android.services.toolbox.test.sdk.FakeBuildVersionSdkIntProvider
 import io.element.android.tests.testutils.lambda.lambdaRecorder
 import io.element.android.tests.testutils.lambda.value
-import kotlinx.coroutines.CoroutineScope
-import kotlinx.coroutines.SupervisorJob
-import kotlinx.coroutines.cancel
+import kotlinx.coroutines.test.TestScope
 import kotlinx.coroutines.test.runTest
 import org.junit.Test
 
@@ -36,8 +37,9 @@ class DefaultFtueServiceTest {
         val sessionVerificationService = FakeSessionVerificationService().apply {
             givenVerifiedStatus(SessionVerifiedStatus.Unknown)
         }
-        val coroutineScope = CoroutineScope(coroutineContext + SupervisorJob())
-        val service = createDefaultFtueService(coroutineScope, sessionVerificationService)
+        val service = createDefaultFtueService(
+            sessionVerificationService = sessionVerificationService,
+        )
 
         service.state.test {
             // Verification state is unknown, we don't display the flow yet
@@ -47,9 +49,6 @@ class DefaultFtueServiceTest {
             sessionVerificationService.givenVerifiedStatus(SessionVerifiedStatus.NotVerified)
             assertThat(awaitItem()).isEqualTo(FtueState.Incomplete)
         }
-
-        // Cleanup
-        coroutineScope.cancel()
     }
 
     @Test
@@ -58,10 +57,7 @@ class DefaultFtueServiceTest {
         val sessionVerificationService = FakeSessionVerificationService()
         val permissionStateProvider = FakePermissionStateProvider(permissionGranted = true)
         val lockScreenService = FakeLockScreenService()
-        val coroutineScope = CoroutineScope(coroutineContext + SupervisorJob())
-
         val service = createDefaultFtueService(
-            coroutineScope = coroutineScope,
             sessionVerificationService = sessionVerificationService,
             analyticsService = analyticsService,
             permissionStateProvider = permissionStateProvider,
@@ -75,9 +71,6 @@ class DefaultFtueServiceTest {
         service.updateState()
 
         assertThat(service.state.value).isEqualTo(FtueState.Complete)
-
-        // Cleanup
-        coroutineScope.cancel()
     }
 
     @Test
@@ -88,10 +81,7 @@ class DefaultFtueServiceTest {
         val analyticsService = FakeAnalyticsService()
         val permissionStateProvider = FakePermissionStateProvider(permissionGranted = false)
         val lockScreenService = FakeLockScreenService()
-        val coroutineScope = CoroutineScope(coroutineContext + SupervisorJob())
-
         val service = createDefaultFtueService(
-            coroutineScope = coroutineScope,
             sessionVerificationService = sessionVerificationService,
             analyticsService = analyticsService,
             permissionStateProvider = permissionStateProvider,
@@ -126,20 +116,15 @@ class DefaultFtueServiceTest {
             // Final state
             null,
         )
-
-        // Cleanup
-        coroutineScope.cancel()
     }
 
     @Test
     fun `if a check for a step is true, start from the next one`() = runTest {
-        val coroutineScope = CoroutineScope(coroutineContext + SupervisorJob())
         val sessionVerificationService = FakeSessionVerificationService()
         val analyticsService = FakeAnalyticsService()
         val permissionStateProvider = FakePermissionStateProvider(permissionGranted = false)
         val lockScreenService = FakeLockScreenService()
         val service = createDefaultFtueService(
-            coroutineScope = coroutineScope,
             sessionVerificationService = sessionVerificationService,
             analyticsService = analyticsService,
             permissionStateProvider = permissionStateProvider,
@@ -155,22 +140,17 @@ class DefaultFtueServiceTest {
 
         analyticsService.setDidAskUserConsent()
         assertThat(service.getNextStep(null)).isNull()
-
-        // Cleanup
-        coroutineScope.cancel()
     }
 
     @Test
     fun `if version is older than 13 we don't display the notification opt in screen`() = runTest {
-        val coroutineScope = CoroutineScope(coroutineContext + SupervisorJob())
         val sessionVerificationService = FakeSessionVerificationService()
         val analyticsService = FakeAnalyticsService()
         val lockScreenService = FakeLockScreenService()
 
         val service = createDefaultFtueService(
             sdkIntVersion = Build.VERSION_CODES.M,
             sessionVerificationService = sessionVerificationService,
-            coroutineScope = coroutineScope,
             analyticsService = analyticsService,
             lockScreenService = lockScreenService,
         )
@@ -182,14 +162,10 @@ class DefaultFtueServiceTest {
 
         analyticsService.setDidAskUserConsent()
         assertThat(service.getNextStep(null)).isNull()
-
-        // Cleanup
-        coroutineScope.cancel()
     }
 
     @Test
     fun `reset do the expected actions S`() = runTest {
-        val coroutineScope = CoroutineScope(coroutineContext + SupervisorJob())
         val resetAnalyticsLambda = lambdaRecorder<Unit> { }
         val analyticsService = FakeAnalyticsService(
             resetLambda = resetAnalyticsLambda
@@ -199,7 +175,6 @@ class DefaultFtueServiceTest {
             resetPermissionLambda = resetPermissionLambda
         )
         val service = createDefaultFtueService(
-            coroutineScope = coroutineScope,
             sdkIntVersion = Build.VERSION_CODES.S,
             permissionStateProvider = permissionStateProvider,
             analyticsService = analyticsService,
@@ -211,7 +186,6 @@ class DefaultFtueServiceTest {
 
     @Test
     fun `reset do the expected actions TIRAMISU`() = runTest {
-        val coroutineScope = CoroutineScope(coroutineContext + SupervisorJob())
         val resetLambda = lambdaRecorder<Unit> { }
         val analyticsService = FakeAnalyticsService(
             resetLambda = resetLambda
@@ -221,7 +195,6 @@ class DefaultFtueServiceTest {
             resetPermissionLambda = resetPermissionLambda
         )
         val service = createDefaultFtueService(
-            coroutineScope = coroutineScope,
             sdkIntVersion = Build.VERSION_CODES.TIRAMISU,
             permissionStateProvider = permissionStateProvider,
             analyticsService = analyticsService,
@@ -232,17 +205,16 @@ class DefaultFtueServiceTest {
             .with(value("android.permission.POST_NOTIFICATIONS"))
     }
 
-    private fun createDefaultFtueService(
-        coroutineScope: CoroutineScope,
-        sessionVerificationService: FakeSessionVerificationService = FakeSessionVerificationService(),
+    private fun TestScope.createDefaultFtueService(
+        sessionVerificationService: SessionVerificationService = FakeSessionVerificationService(),
         analyticsService: AnalyticsService = FakeAnalyticsService(),
-        permissionStateProvider: FakePermissionStateProvider = FakePermissionStateProvider(permissionGranted = false),
+        permissionStateProvider: PermissionStateProvider = FakePermissionStateProvider(permissionGranted = false),
         lockScreenService: LockScreenService = FakeLockScreenService(),
-        sessionPreferencesStore: InMemorySessionPreferencesStore = InMemorySessionPreferencesStore(),
+        sessionPreferencesStore: SessionPreferencesStore = InMemorySessionPreferencesStore(),
         // First version where notification permission is required
         sdkIntVersion: Int = Build.VERSION_CODES.TIRAMISU,
     ) = DefaultFtueService(
-        sessionCoroutineScope = coroutineScope,
+        sessionCoroutineScope = backgroundScope,
         sessionVerificationService = sessionVerificationService,
         sdkVersionProvider = FakeBuildVersionSdkIntProvider(sdkIntVersion),
         analyticsService = analyticsService,