Splash screen update (#282)

* Updated splash screen logic & animation * Resolved PR comments * Update unit tests --------- Co-authored-by: ShiftHackZ <[email protected]>
ShiftHackZ · Sep 1, 2024 · 8a4b143 · 8a4b143
1 parent f29557e
commit 8a4b143
Show file tree

Hide file tree

Showing 6 changed files with 44 additions and 9 deletions.
diff --git a/...on/src/main/java/com/shifthackz/aisdv1/presentation/activity/AiStableDiffusionActivity.kt b/...on/src/main/java/com/shifthackz/aisdv1/presentation/activity/AiStableDiffusionActivity.kt
@@ -1,17 +1,21 @@
 package com.shifthackz.aisdv1.presentation.activity
 
+import android.animation.ObjectAnimator
 import android.os.Bundle
+import android.view.View
 import androidx.activity.compose.BackHandler
 import androidx.activity.compose.setContent
 import androidx.activity.result.contract.ActivityResultContracts
 import androidx.appcompat.app.AppCompatActivity
 import androidx.compose.material3.DrawerValue
 import androidx.compose.material3.rememberDrawerState
+import androidx.compose.runtime.LaunchedEffect
 import androidx.compose.runtime.getValue
 import androidx.compose.runtime.mutableStateOf
 import androidx.compose.runtime.remember
 import androidx.compose.runtime.rememberCoroutineScope
 import androidx.compose.runtime.setValue
+import androidx.core.animation.doOnEnd
 import androidx.core.splashscreen.SplashScreen.Companion.installSplashScreen
 import androidx.navigation.compose.NavHost
 import androidx.navigation.compose.currentBackStackEntryAsState
@@ -48,11 +52,25 @@ class AiStableDiffusionActivity : AppCompatActivity() {
     }
 
     override fun onCreate(savedInstanceState: Bundle?) {
-        installSplashScreen()
+        val splashScreen = installSplashScreen()
         super.onCreate(savedInstanceState)
         actionBar?.hide()
-        PermissionUtil.checkNotificationPermission(this, notificationPermission::launch)
-        PermissionUtil.checkStoragePermission(this, storagePermission::launch)
+        splashScreen.setKeepOnScreenCondition { viewModel.state.value.isShowSplash }
+        splashScreen.setOnExitAnimationListener { splashScreenViewProvider ->
+            val fadeOutAnimation = ObjectAnimator.ofFloat(
+                splashScreenViewProvider.view,
+                View.ALPHA,
+                1f,
+                0f
+            )
+            fadeOutAnimation.duration = 500L
+            fadeOutAnimation.doOnEnd {
+                PermissionUtil.checkNotificationPermission(this, notificationPermission::launch)
+                PermissionUtil.checkStoragePermission(this, storagePermission::launch)
+                splashScreenViewProvider.remove()
+            }
+            fadeOutAnimation.start()
+        }
         setContent {
             val navController = rememberNavController()
             val backStackEntry by navController.currentBackStackEntryAsState()
@@ -65,6 +83,13 @@ class AiStableDiffusionActivity : AppCompatActivity() {
                 scope.launch { drawerState.close() }
             }
 
+            LaunchedEffect(backStackEntry) {
+                if (!viewModel.state.value.isShowSplash) return@LaunchedEffect
+                if (backStackEntry?.destination?.route != Constants.ROUTE_SPLASH) {
+                    viewModel.processIntent(AppIntent.HideSplash)
+                }
+            }
+
             AiSdAppTheme {
                 MviComponent(
                     viewModel = viewModel,

diff --git a/...n/src/main/java/com/shifthackz/aisdv1/presentation/activity/AiStableDiffusionViewModel.kt b/...n/src/main/java/com/shifthackz/aisdv1/presentation/activity/AiStableDiffusionViewModel.kt
@@ -58,5 +58,9 @@ class AiStableDiffusionViewModel(
         is AppIntent.HomeRoute -> {
             homeRouter.navigateToRoute(intent.route)
         }
+
+        AppIntent.HideSplash -> updateState { state ->
+            state.copy(isShowSplash = false)
+        }
     }
 }
diff --git a/presentation/src/main/java/com/shifthackz/aisdv1/presentation/activity/AppIntent.kt b/presentation/src/main/java/com/shifthackz/aisdv1/presentation/activity/AppIntent.kt
@@ -5,6 +5,7 @@ import com.shifthackz.android.core.mvi.MviIntent
 sealed interface AppIntent : MviIntent {
 
     data object GrantStoragePermission : AppIntent
+    data object HideSplash : AppIntent
 
     data class HomeRoute(val route: String) : AppIntent
 }
diff --git a/presentation/src/main/java/com/shifthackz/aisdv1/presentation/activity/AppState.kt b/presentation/src/main/java/com/shifthackz/aisdv1/presentation/activity/AppState.kt
@@ -8,4 +8,5 @@ import com.shifthackz.android.core.mvi.MviState
 @Immutable
 data class AppState(
     val drawerItems: List<NavItem> = mainDrawerNavItems(),
+    val isShowSplash: Boolean = true,
 ) : MviState
diff --git a/...src/main/java/com/shifthackz/aisdv1/presentation/navigation/router/main/MainRouterImpl.kt b/...src/main/java/com/shifthackz/aisdv1/presentation/navigation/router/main/MainRouterImpl.kt
@@ -47,7 +47,7 @@ internal class MainRouterImpl : MainRouter {
     override fun navigateToServerSetup(source: LaunchSource) {
         effectSubject.onNext(NavigationEffect.Navigate.RouteBuilder("${Constants.ROUTE_SERVER_SETUP}/${source.ordinal}") {
             if (source == LaunchSource.SPLASH) {
-                popUpTo(Constants.ROUTE_ONBOARDING) {
+                popUpTo(Constants.ROUTE_SPLASH) {
                     inclusive = true
                 }
             }

diff --git a/...c/test/java/com/shifthackz/aisdv1/presentation/activity/AiStableDiffusionViewModelTest.kt b/...c/test/java/com/shifthackz/aisdv1/presentation/activity/AiStableDiffusionViewModelTest.kt
@@ -19,12 +19,9 @@ import io.mockk.mockk
 import io.mockk.verify
 import io.reactivex.rxjava3.core.Flowable
 import io.reactivex.rxjava3.subjects.BehaviorSubject
-import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.ExperimentalCoroutinesApi
 import kotlinx.coroutines.flow.firstOrNull
-import kotlinx.coroutines.test.StandardTestDispatcher
 import kotlinx.coroutines.test.runTest
-import kotlinx.coroutines.test.setMain
 import org.junit.Assert
 import org.junit.Before
 import org.junit.Test
@@ -76,7 +73,7 @@ class AiStableDiffusionViewModelTest : CoreViewModelTest<AiStableDiffusionViewMo
     }
 
     @Test
-    fun `given onStoragePermissionsGranted was called, expected VM sets field saveToMediaStore with true in preference manager`() {
+    fun `given received GrantStoragePermission intent, expected VM sets field saveToMediaStore with true in preference manager`() {
         every {
             stubPreferenceManager::saveToMediaStore.set(any())
         } returns Unit
@@ -88,6 +85,14 @@ class AiStableDiffusionViewModelTest : CoreViewModelTest<AiStableDiffusionViewMo
         }
     }
 
+    @Test
+    fun `given received HideSplash intent, expected VM sets isShowSplash to false in UI state`() {
+        with(viewModel) {
+            processIntent(AppIntent.HideSplash)
+            Assert.assertFalse(state.value.isShowSplash)
+        }
+    }
+
     @Test
     fun `given route event from main router, expected domain model delivered to effect collector`() {
         stubNavigationEffect.onNext(NavigationEffect.Navigate.Route("route"))
@@ -132,7 +137,6 @@ class AiStableDiffusionViewModelTest : CoreViewModelTest<AiStableDiffusionViewMo
 
     @Test
     fun `given route then back events from main router, expected two domain models delivered to effect collector in same order`() {
-        Dispatchers.setMain(StandardTestDispatcher())
         runTest {
             viewModel.effect.test {
                 stubNavigationEffect.onNext(NavigationEffect.Navigate.Route("route2"))