Merge pull request #285 from Kotlin-Android-Open-Source/tweaks

hoc081098 · web-flow · commit f70107e6c543 · 2025-07-13T17:15:33.000+07:00
This pull request implements a comprehensive refactoring that renames the `getUsers` method and related use cases to `observeUsers` to better reflect the flow-based observable nature of the functionality. The changes also include code style improvements, dependency updates, and minor optimizations.

Key changes:
- Renamed `getUsers` to `observeUsers` across the entire codebase including repositories, use cases, tests, and ViewModels
- Updated various code style elements including constant naming conventions and coroutine dispatcher handling
- Added performance optimizations and removed unused logging statements
diff --git a/.idea/codeStyles/Project.xml b/.idea/codeStyles/Project.xml
diff --git a/.idea/compiler.xml b/.idea/compiler.xml
diff --git a/.idea/kotlinc.xml b/.idea/kotlinc.xml
diff --git a/.idea/misc.xml b/.idea/misc.xml
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019-2024 Kotlin Android Open Source
+Copyright (c) 2019-2025 Kotlin Android Open Source
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/buildSrc/gradle/wrapper/gradle-wrapper.jar b/buildSrc/gradle/wrapper/gradle-wrapper.jar
diff --git a/core-ui/src/main/java/com/hoc/flowmvi/core_ui/CollectIn.kt b/core-ui/src/main/java/com/hoc/flowmvi/core_ui/CollectIn.kt
@@ -9,7 +9,6 @@ import kotlinx.coroutines.Job
 import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.collect
 import kotlinx.coroutines.launch
-import timber.log.Timber
 
 inline fun <T> Flow<T>.collectIn(
   owner: LifecycleOwner,
@@ -18,7 +17,6 @@ inline fun <T> Flow<T>.collectIn(
 ): Job =
   owner.lifecycleScope.launch {
     owner.repeatOnLifecycle(state = minActiveState) {
-      Timber.d("Start collecting $owner $minActiveState...")
       collect { action(it) }
     }
   }
diff --git a/core-ui/src/main/java/com/hoc/flowmvi/core_ui/debugCheckImmediateMainDispatcher.kt b/core-ui/src/main/java/com/hoc/flowmvi/core_ui/debugCheckImmediateMainDispatcher.kt
@@ -1,17 +1,22 @@
 package com.hoc.flowmvi.core_ui
 
-import kotlin.coroutines.ContinuationInterceptor
+import kotlinx.coroutines.CoroutineDispatcher
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.currentCoroutineContext
 import timber.log.Timber
 
-suspend fun debugCheckImmediateMainDispatcher() {
+@OptIn(ExperimentalStdlibApi::class)
+suspend inline fun debugCheckImmediateMainDispatcher() {
   if (BuildConfig.DEBUG) {
-    val interceptor = currentCoroutineContext()[ContinuationInterceptor]
-    Timber.d("debugCheckImmediateMainDispatcher: interceptor=$interceptor")
+    val dispatcher = checkNotNull(currentCoroutineContext()[CoroutineDispatcher]) {
+      "Expected CoroutineDispatcher in current CoroutineContext but was null"
+    }.also { Timber.d("debugCheckImmediateMainDispatcher: dispatcher=$it") }
 
-    check(interceptor === Dispatchers.Main.immediate) {
-      "Expected ContinuationInterceptor to be Dispatchers.Main.immediate but was $interceptor"
+    check(
+      dispatcher === Dispatchers.Main.immediate ||
+        !dispatcher.isDispatchNeeded(Dispatchers.Main.immediate),
+    ) {
+      "Expected dispatcher to be Dispatchers.Main.immediate but was $dispatcher"
     }
   }
 }
diff --git a/core/src/main/java/com/hoc/flowmvi/core/selfReference.kt b/core/src/main/java/com/hoc/flowmvi/core/selfReference.kt
@@ -11,7 +11,8 @@ import kotlin.reflect.KProperty
 value class SelfReference<T>(
   val value: T,
 ) : ReadOnlyProperty<Any?, T> {
-  override fun getValue(
+  @Suppress("OVERRIDE_BY_INLINE", "NOTHING_TO_INLINE")
+  override inline fun getValue(
     thisRef: Any?,
     property: KProperty<*>,
   ): T = value
diff --git a/data/src/main/java/com/hoc/flowmvi/data/UserRepositoryImpl.kt b/data/src/main/java/com/hoc/flowmvi/data/UserRepositoryImpl.kt
@@ -80,7 +80,7 @@ internal class UserRepositoryImpl(
       .first()
 
   @OptIn(FlowExtPreview::class)
-  override fun getUsers() =
+  override fun observeUsers() =
     changesFlow
       .onEach { Timber.d("[USER_REPO] Change=$it") }
       .scanWith(::getUsersFromRemoteWithRetry) { acc, change ->
diff --git a/data/src/test/java/com/hoc/flowmvi/data/UserRepositoryImplRealAPITest.kt b/data/src/test/java/com/hoc/flowmvi/data/UserRepositoryImplRealAPITest.kt
@@ -56,12 +56,12 @@ class UserRepositoryImplRealAPITest : KoinTest {
   private val userRepo by inject<UserRepository>()
 
   @Test
-  fun getUsers() =
+  fun observeUsers() =
     runBlocking {
       kotlin.runCatching {
         val result =
           userRepo
-            .getUsers()
+            .observeUsers()
             .first()
         assertTrue(result.isRight())
         assertTrue(result.rightValueOrThrow.isNotEmpty())
diff --git a/data/src/test/java/com/hoc/flowmvi/data/UserRepositoryImplTest.kt b/data/src/test/java/com/hoc/flowmvi/data/UserRepositoryImplTest.kt
@@ -285,15 +285,15 @@ class UserRepositoryImplTest {
     }
 
   @Test
-  fun test_getUsers_withApiCallSuccess_emitsInitial() =
+  fun test_observeUsers_withApiCallSuccess_emitsInitial() =
     runTest {
       coEvery { userApiService.getUsers() } returns USER_RESPONSES
       every { responseToDomain(any()) } returnsMany VALID_NES_USERS
 
       val events = mutableListOf<Either<UserError, List<User>>>()
       val job =
         launch(start = CoroutineStart.UNDISPATCHED) {
-          repo.getUsers().toList(events)
+          repo.observeUsers().toList(events)
         }
       delay(5_000)
       job.cancel()
@@ -313,15 +313,15 @@ class UserRepositoryImplTest {
     }
 
   @Test
-  fun test_getUsers_withApiCallError_rethrows() =
+  fun test_observeUsers_withApiCallError_rethrows() =
     runTest {
       coEvery { userApiService.getUsers() } throws IOException()
       every { errorMapper(ofType<IOException>()) } returns UserError.NetworkError
 
       val events = mutableListOf<Either<UserError, List<User>>>()
       val job =
         launch(start = CoroutineStart.UNDISPATCHED) {
-          repo.getUsers().toList(events)
+          repo.observeUsers().toList(events)
         }
       delay(20_000)
       job.cancel()
@@ -337,7 +337,7 @@ class UserRepositoryImplTest {
     }
 
   @Test
-  fun test_getUsers_withApiCallSuccess_emitsInitialAndUpdatedUsers() =
+  fun test_observeUsers_withApiCallSuccess_emitsInitialAndUpdatedUsers() =
     runTest {
       val user = USERS.last()
       val userResponse = USER_RESPONSES.last()
@@ -352,7 +352,7 @@ class UserRepositoryImplTest {
       val events = mutableListOf<Either<UserError, List<User>>>()
       val job =
         launch(start = CoroutineStart.UNDISPATCHED) {
-          repo.getUsers().toList(events)
+          repo.observeUsers().toList(events)
         }
       repo.add(user)
       repo.remove(user)
diff --git a/domain/src/main/java/com/hoc/flowmvi/domain/DomainModule.kt b/domain/src/main/java/com/hoc/flowmvi/domain/DomainModule.kt
@@ -1,7 +1,7 @@
 package com.hoc.flowmvi.domain
 
 import com.hoc.flowmvi.domain.usecase.AddUserUseCase
-import com.hoc.flowmvi.domain.usecase.GetUsersUseCase
+import com.hoc.flowmvi.domain.usecase.ObserveUsersUseCase
 import com.hoc.flowmvi.domain.usecase.RefreshGetUsersUseCase
 import com.hoc.flowmvi.domain.usecase.RemoveUserUseCase
 import com.hoc.flowmvi.domain.usecase.SearchUsersUseCase
@@ -11,7 +11,7 @@ import org.koin.dsl.module
 @JvmField
 val domainModule =
   module {
-    factoryOf(::GetUsersUseCase)
+    factoryOf(::ObserveUsersUseCase)
 
     factoryOf(::RefreshGetUsersUseCase)
 
diff --git a/domain/src/main/java/com/hoc/flowmvi/domain/model/UserError.kt b/domain/src/main/java/com/hoc/flowmvi/domain/model/UserError.kt
@@ -2,7 +2,7 @@ package com.hoc.flowmvi.domain.model
 
 import arrow.core.NonEmptySet
 
-sealed class UserError : Throwable() {
+sealed class UserError : RuntimeException() {
   data object NetworkError : UserError() {
     private fun readResolve(): Any = NetworkError
   }
diff --git a/domain/src/main/java/com/hoc/flowmvi/domain/repository/UserRepository.kt b/domain/src/main/java/com/hoc/flowmvi/domain/repository/UserRepository.kt
@@ -6,7 +6,7 @@ import com.hoc.flowmvi.domain.model.UserError
 import kotlinx.coroutines.flow.Flow
 
 interface UserRepository {
-  fun getUsers(): Flow<Either<UserError, List<User>>>
+  fun observeUsers(): Flow<Either<UserError, List<User>>>
 
   suspend fun refresh(): Either<UserError, Unit>
 
diff --git a/domain/src/main/java/com/hoc/flowmvi/domain/usecase/ObserveUsersUseCase.kt b/domain/src/main/java/com/hoc/flowmvi/domain/usecase/ObserveUsersUseCase.kt
@@ -6,8 +6,8 @@ import com.hoc.flowmvi.domain.model.UserError
 import com.hoc.flowmvi.domain.repository.UserRepository
 import kotlinx.coroutines.flow.Flow
 
-class GetUsersUseCase(
+class ObserveUsersUseCase(
   private val userRepository: UserRepository,
 ) {
-  operator fun invoke(): Flow<Either<UserError, List<User>>> = userRepository.getUsers()
+  operator fun invoke(): Flow<Either<UserError, List<User>>> = userRepository.observeUsers()
 }
diff --git a/domain/src/test/java/com/hoc/flowmvi/domain/UseCaseTest.kt b/domain/src/test/java/com/hoc/flowmvi/domain/UseCaseTest.kt
@@ -6,7 +6,7 @@ import com.hoc.flowmvi.domain.model.User
 import com.hoc.flowmvi.domain.model.UserError
 import com.hoc.flowmvi.domain.repository.UserRepository
 import com.hoc.flowmvi.domain.usecase.AddUserUseCase
-import com.hoc.flowmvi.domain.usecase.GetUsersUseCase
+import com.hoc.flowmvi.domain.usecase.ObserveUsersUseCase
 import com.hoc.flowmvi.domain.usecase.RefreshGetUsersUseCase
 import com.hoc.flowmvi.domain.usecase.RemoveUserUseCase
 import com.hoc.flowmvi.domain.usecase.SearchUsersUseCase
@@ -60,7 +60,7 @@ class UseCaseTest {
   val coroutineRule = TestCoroutineDispatcherRule()
 
   private lateinit var userRepository: UserRepository
-  private lateinit var getUsersUseCase: GetUsersUseCase
+  private lateinit var observeUsersUseCase: ObserveUsersUseCase
   private lateinit var refreshUseCase: RefreshGetUsersUseCase
   private lateinit var removeUserUseCase: RemoveUserUseCase
   private lateinit var addUserUseCase: AddUserUseCase
@@ -72,7 +72,7 @@ class UseCaseTest {
   fun setup() {
     userRepository = mockk()
 
-    getUsersUseCase = GetUsersUseCase(userRepository)
+    observeUsersUseCase = ObserveUsersUseCase(userRepository)
     refreshUseCase = RefreshGetUsersUseCase(userRepository)
     removeUserUseCase = RemoveUserUseCase(userRepository)
     addUserUseCase = AddUserUseCase(userRepository)
@@ -86,25 +86,25 @@ class UseCaseTest {
   }
 
   @Test
-  fun test_getUsersUseCase_whenSuccess_emitsUsers() =
+  fun test_observeUsersUseCase_whenSuccess_emitsUsers() =
     runTest {
       val usersRight = USERS.right()
-      every { userRepository.getUsers() } returns flowOf(usersRight)
+      every { userRepository.observeUsers() } returns flowOf(usersRight)
 
-      val result = getUsersUseCase()
+      val result = observeUsersUseCase()
 
-      verify { userRepository.getUsers() }
+      verify { userRepository.observeUsers() }
       assertEquals(usersRight, result.first())
     }
 
   @Test
-  fun test_getUsersUseCase_whenError_throwsError() =
+  fun test_observeUsersUseCase_whenError_throwsError() =
     runTest {
-      every { userRepository.getUsers() } returns flowOf(errorLeft)
+      every { userRepository.observeUsers() } returns flowOf(errorLeft)
 
-      val result = getUsersUseCase()
+      val result = observeUsersUseCase()
 
-      verify { userRepository.getUsers() }
+      verify { userRepository.observeUsers() }
       assertEquals(errorLeft, result.first())
     }
 
diff --git a/feature-main/src/main/java/com/hoc/flowmvi/ui/main/MainVM.kt b/feature-main/src/main/java/com/hoc/flowmvi/ui/main/MainVM.kt
@@ -3,7 +3,7 @@ package com.hoc.flowmvi.ui.main
 import androidx.lifecycle.viewModelScope
 import arrow.core.flatMap
 import com.hoc.flowmvi.core.selfReferenced
-import com.hoc.flowmvi.domain.usecase.GetUsersUseCase
+import com.hoc.flowmvi.domain.usecase.ObserveUsersUseCase
 import com.hoc.flowmvi.domain.usecase.RefreshGetUsersUseCase
 import com.hoc.flowmvi.domain.usecase.RemoveUserUseCase
 import com.hoc.flowmvi.mvi_base.AbstractMviViewModel
@@ -33,7 +33,7 @@ import timber.log.Timber
 @FlowPreview
 @ExperimentalCoroutinesApi
 class MainVM(
-  private val getUsersUseCase: GetUsersUseCase,
+  private val observeUsersUseCase: ObserveUsersUseCase,
   private val refreshGetUsers: RefreshGetUsersUseCase,
   private val removeUser: RemoveUserUseCase,
 ) : AbstractMviViewModel<ViewIntent, ViewState, SingleEvent>() {
@@ -78,7 +78,7 @@ class MainVM(
   //region Processors
   private fun Flow<ViewIntent>.toUserChangeFlow(): Flow<PartialStateChange.Users> {
     val userChanges =
-      defer(getUsersUseCase::invoke)
+      defer { observeUsersUseCase() }
         .onEach { either -> Timber.tag(logTag).d("Emit users.size=${either.map { it.size }}") }
         .map { result ->
           result.fold(
diff --git a/feature-main/src/test/java/com/hoc/flowmvi/ui/main/MainVMTest.kt b/feature-main/src/test/java/com/hoc/flowmvi/ui/main/MainVMTest.kt
@@ -4,7 +4,7 @@ import arrow.core.left
 import arrow.core.right
 import com.hoc.flowmvi.domain.model.User
 import com.hoc.flowmvi.domain.model.UserError
-import com.hoc.flowmvi.domain.usecase.GetUsersUseCase
+import com.hoc.flowmvi.domain.usecase.ObserveUsersUseCase
 import com.hoc.flowmvi.domain.usecase.RefreshGetUsersUseCase
 import com.hoc.flowmvi.domain.usecase.RemoveUserUseCase
 import com.hoc.flowmvi.mvi_testing.BaseMviViewModelTest
@@ -40,7 +40,7 @@ class MainVMTest :
     MainVM,
     >() {
   private lateinit var vm: MainVM
-  private lateinit var getUserUseCase: GetUsersUseCase
+  private lateinit var getUserUseCase: ObserveUsersUseCase
   private lateinit var refreshGetUsersUseCase: RefreshGetUsersUseCase
   private lateinit var removeUser: RemoveUserUseCase
 
@@ -53,7 +53,7 @@ class MainVMTest :
 
     vm =
       MainVM(
-        getUsersUseCase = getUserUseCase,
+        observeUsersUseCase = getUserUseCase,
         refreshGetUsers = refreshGetUsersUseCase,
         removeUser = removeUser,
       )
diff --git a/mvi/mvi-base/src/main/java/com/hoc/flowmvi/mvi_base/AbstractMviViewModel.kt b/mvi/mvi-base/src/main/java/com/hoc/flowmvi/mvi_base/AbstractMviViewModel.kt

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,6 @@ import kotlinx.coroutines.Job`
`9`	`9`	`import kotlinx.coroutines.flow.Flow`
`10`	`10`	`import kotlinx.coroutines.flow.collect`
`11`	`11`	`import kotlinx.coroutines.launch`
`12`		`-import timber.log.Timber`
`13`	`12`
`14`	`13`	`inline fun <T> Flow<T>.collectIn(`
`15`	`14`	`owner: LifecycleOwner,`
`@@ -18,7 +17,6 @@ inline fun <T> Flow<T>.collectIn(`
`18`	`17`	`): Job =`
`19`	`18`	`owner.lifecycleScope.launch {`
`20`	`19`	`owner.repeatOnLifecycle(state = minActiveState) {`
`21`		`- Timber.d("Start collecting $owner $minActiveState...")`
`22`	`20`	`collect { action(it) }`
`23`	`21`	`}`
`24`	`22`	`}`