Reactive feature flags

Author: hadilq

README.md

@@ -1,6 +1,6 @@
 # Clean Architecture
 
-This is a sample app to show best practices up to authors's knowledge by trying to
+This is a sample app to show best practices up to author's knowledge by trying to
 stay close to standard technologies for a highly scalable, maintainable, and testable
 Android app.
 

app/build.gradle.kts

@@ -53,20 +53,22 @@ android {
   }
 
   packagingOptions {
-    exclude("META-INF/public_release.kotlin_module")
-    exclude("META-INF/impl_release.kotlin_module")
+    exclude("META-INF/*.kotlin_module")
   }
 }
 
 dependencies {
   implementation(project(Modules.corePublic))
   implementation(project(Modules.coreImpl))
+  implementation(project(Modules.diPublic))
   implementation(project(Modules.singleActivityPublic))
   implementation(project(Modules.singleActivityImpl))
   implementation(project(Modules.guidomiaPublic))
   implementation(project(Modules.guidomiaImpl))
   implementation(project(Modules.databasePublic))
   implementation(project(Modules.databaseImpl))
+  implementation(project(Modules.featureFlagsPublic))
+  implementation(project(Modules.featureFlagsImpl))
 
   kapt(Depends.daggerCompiler)
 

app/src/main/java/com/hadilq/guidomia/CustomApplication.kt

@@ -16,12 +16,15 @@
 package com.hadilq.guidomia
 
 import android.app.Application
-import com.hadilq.guidomia.core.api.di.AppScope
-import com.hadilq.guidomia.core.api.di.SingleIn
 import com.hadilq.guidomia.di.AppComponent
 import com.hadilq.guidomia.di.DaggerAppComponent
+import com.hadilq.guidomia.di.api.AppScope
+import com.hadilq.guidomia.di.api.SingleIn
+import com.hadilq.guidomia.featureflags.api.CommandHook
+import com.hadilq.guidomia.featureflags.api.CommandRegister
 import com.hadilq.guidomia.singleactivity.impl.di.SingleActivityComponent
 import com.hadilq.guidomia.singleactivity.impl.di.SingleActivityComponentProvider
+import javax.inject.Inject
 
 @SingleIn(AppScope::class)
 class CustomApplication : Application(), SingleActivityComponentProvider {
@@ -34,4 +37,20 @@ class CustomApplication : Application(), SingleActivityComponentProvider {
 
   override val singleActivityComponentProvider: SingleActivityComponent.Builder
     get() = component.singleActivityComponentBuilder()
+
+  @Inject
+  protected lateinit var commandHookSet: Set<@JvmSuppressWildcards CommandHook>
+
+  @Inject
+  protected lateinit var commandRegister: CommandRegister
+
+  override fun onCreate() {
+    super.onCreate()
+    component.inject(this)
+    hookUpFeatureFlags()
+  }
+
+  private fun hookUpFeatureFlags() {
+    commandHookSet.forEach { it.hookUp(commandRegister) }
+  }
 }

app/src/main/java/com/hadilq/guidomia/di/AppComponent.kt

@@ -16,8 +16,8 @@
 package com.hadilq.guidomia.di
 
 import com.hadilq.guidomia.CustomApplication
-import com.hadilq.guidomia.core.api.di.AppScope
-import com.hadilq.guidomia.core.api.di.SingleIn
+import com.hadilq.guidomia.di.api.AppScope
+import com.hadilq.guidomia.di.api.SingleIn
 import com.hadilq.guidomia.singleactivity.impl.di.SingleActivityComponent
 import com.squareup.anvil.annotations.MergeComponent
 import dagger.BindsInstance
@@ -39,6 +39,8 @@ interface AppComponent {
     fun build(): AppComponent
   }
 
+  fun inject(app: CustomApplication)
+
   fun singleActivityComponentBuilder(): SingleActivityComponent.Builder
   fun fragmentComponentBuilder(): FragmentComponent.Builder
   fun retainComponentBuilder(): RetainComponent.Builder

app/src/main/java/com/hadilq/guidomia/di/AppModule.kt

@@ -17,8 +17,13 @@ package com.hadilq.guidomia.di
 
 import android.content.Context
 import com.hadilq.guidomia.CustomApplication
+import com.hadilq.guidomia.di.api.AppScope
+import com.hadilq.guidomia.featureflags.api.CommandHook
+import com.hadilq.guidomia.featureflags.api.CommandRegister
+import com.squareup.anvil.annotations.ContributesMultibinding
 import dagger.Binds
 import dagger.Module
+import javax.inject.Inject
 
 @Module
 interface AppModule {

app/src/main/java/com/hadilq/guidomia/di/FragmentComponent.kt

@@ -15,8 +15,8 @@
  */
 package com.hadilq.guidomia.di
 
-import com.hadilq.guidomia.core.api.di.FragmentScope
-import com.hadilq.guidomia.core.api.di.SingleIn
+import com.hadilq.guidomia.di.api.FragmentScope
+import com.hadilq.guidomia.di.api.SingleIn
 import com.hadilq.guidomia.guidomia.impl.presentation.GuidomiaFragment
 import com.squareup.anvil.annotations.MergeSubcomponent
 import dagger.Subcomponent

app/src/main/java/com/hadilq/guidomia/di/RetainComponent.kt

@@ -15,8 +15,8 @@
  */
 package com.hadilq.guidomia.di
 
-import com.hadilq.guidomia.core.api.di.RetainScope
-import com.hadilq.guidomia.core.api.di.SingleIn
+import com.hadilq.guidomia.di.api.RetainScope
+import com.hadilq.guidomia.di.api.SingleIn
 import com.hadilq.guidomia.guidomia.impl.presentation.GuidomiaViewModel
 import com.squareup.anvil.annotations.MergeSubcomponent
 import dagger.Subcomponent

app/src/main/java/com/hadilq/guidomia/di/fragment/FragmentFactoryImpl.kt

@@ -18,7 +18,7 @@ package com.hadilq.guidomia.di.fragment
 import androidx.fragment.app.Fragment
 import com.hadilq.guidomia.core.api.FragmentFactory
 import com.hadilq.guidomia.core.api.SimpleFragmentFactory
-import com.hadilq.guidomia.core.api.di.AppScope
+import com.hadilq.guidomia.di.api.AppScope
 import com.squareup.anvil.annotations.ContributesBinding
 import javax.inject.Inject
 import kotlin.reflect.KClass

app/src/main/java/com/hadilq/guidomia/di/fragment/GuidomiaFragmentFactory.kt

@@ -18,7 +18,7 @@ package com.hadilq.guidomia.di.fragment
 import androidx.fragment.app.Fragment
 import com.hadilq.guidomia.core.api.FragmentKey
 import com.hadilq.guidomia.core.api.SimpleFragmentFactory
-import com.hadilq.guidomia.core.api.di.AppScope
+import com.hadilq.guidomia.di.api.AppScope
 import com.hadilq.guidomia.guidomia.impl.presentation.GuidomiaFragment
 import com.hadilq.guidomia.di.FragmentComponent
 import com.squareup.anvil.annotations.ContributesMultibinding

app/src/main/java/com/hadilq/guidomia/di/viewmodel/GuidomiaViewModelFactory.kt

@@ -18,7 +18,7 @@ package com.hadilq.guidomia.di.viewmodel
 import androidx.lifecycle.ViewModel
 import com.hadilq.guidomia.core.api.SimpleViewModelFactory
 import com.hadilq.guidomia.core.api.ViewModelKey
-import com.hadilq.guidomia.core.api.di.AppScope
+import com.hadilq.guidomia.di.api.AppScope
 import com.hadilq.guidomia.guidomia.impl.presentation.GuidomiaViewModel
 import com.hadilq.guidomia.di.RetainComponent
 import com.squareup.anvil.annotations.ContributesMultibinding

app/src/main/java/com/hadilq/guidomia/di/viewmodel/ViewModelFactoryImpl.kt

@@ -18,7 +18,7 @@ package com.hadilq.guidomia.di.viewmodel
 import androidx.lifecycle.ViewModel
 import com.hadilq.guidomia.core.api.SimpleViewModelFactory
 import com.hadilq.guidomia.core.api.ViewModelFactory
-import com.hadilq.guidomia.core.api.di.AppScope
+import com.hadilq.guidomia.di.api.AppScope
 import com.squareup.anvil.annotations.ContributesBinding
 import javax.inject.Inject
 

buildSrc/src/main/kotlin/Depends.kt

@@ -15,6 +15,7 @@
  */
 object Depends {
   const val kotlinStdLib = "org.jetbrains.kotlin:kotlin-stdlib:${Versions.kotlin}"
+  const val kotlinTest = "org.jetbrains.kotlin:kotlin-test:${Versions.kotlin}"
   const val coreKtx = "androidx.core:core-ktx:${Versions.coreKtx}"
   const val appCompat = "androidx.appcompat:appcompat:${Versions.appCompat}"
   const val material = "com.google.android.material:material:${Versions.material}"

buildSrc/src/main/kotlin/Modules.kt

@@ -16,10 +16,13 @@
 object Modules {
   const val corePublic = ":core:public"
   const val coreImpl = ":core:impl"
+  const val diPublic = ":di:public"
   const val singleActivityPublic = ":single-activity:public"
   const val singleActivityImpl = ":single-activity:impl"
   const val guidomiaPublic = ":guidomia:public"
   const val guidomiaImpl = ":guidomia:impl"
   const val databaseImpl = ":database:impl"
   const val databasePublic = ":database:public"
+  const val featureFlagsImpl = ":feature-flags:impl"
+  const val featureFlagsPublic = ":feature-flags:public"
 }

buildSrc/src/main/kotlin/Versions.kt

@@ -28,7 +28,7 @@ object Versions {
   const val recyclerView = "1.1.0"
   const val fragment = "1.3.2"
   const val dagger = "2.34.1"
-  const val anvil = "2.2.1"
+  const val anvil = "2.3.0"
   const val coroutines = "1.4.3"
   const val serialization = "1.4.30"
   const val jsonSerialization = "1.1.0"

core/impl/build.gradle.kts

@@ -30,6 +30,7 @@ android {
 
 dependencies {
   implementation(project(Modules.corePublic))
+  implementation(project(Modules.diPublic))
   implementation(project(Modules.guidomiaPublic))
 
   kapt(Depends.daggerCompiler)

core/impl/src/main/java/com/hadilq/guidomia/core/impl/DispatcherProviderImpl.kt

@@ -16,7 +16,7 @@
 package com.hadilq.guidomia.core.impl
 
 import com.hadilq.guidomia.core.api.DispatcherProvider
-import com.hadilq.guidomia.core.api.di.AppScope
+import com.hadilq.guidomia.di.api.AppScope
 import com.squareup.anvil.annotations.ContributesBinding
 import kotlinx.coroutines.CoroutineDispatcher
 import kotlinx.coroutines.Dispatchers

database/impl/build.gradle.kts

@@ -38,7 +38,9 @@ android {
 
 dependencies {
   implementation(project(Modules.corePublic))
+  implementation(project(Modules.diPublic))
   implementation(project(Modules.databasePublic))
+  implementation(project(Modules.featureFlagsPublic))
 
   kapt(Depends.daggerCompiler)
   kapt(Depends.roomCompiler)

database/impl/src/main/java/com/hadilq/guidomia/database/impl/CarDataEntityCommandImpl.kt

@@ -15,23 +15,27 @@
  */
 package com.hadilq.guidomia.database.impl
 
-import com.hadilq.guidomia.core.api.di.AppScope
-import com.hadilq.guidomia.database.api.CarDataEntityCommand
-import com.hadilq.guidomia.database.api.CarDatabaseEntity
-import com.squareup.anvil.annotations.ContributesBinding
+import com.hadilq.guidomia.database.api.*
+import com.hadilq.guidomia.di.api.AppScope
+import com.hadilq.guidomia.featureflags.api.CommandCallbackImpl
+import com.hadilq.guidomia.featureflags.api.CommandHook
+import com.hadilq.guidomia.featureflags.api.CommandRegister
+import com.hadilq.guidomia.featureflags.api.CommandShooter
+import com.squareup.anvil.annotations.ContributesMultibinding
 import javax.inject.Inject
 
-@ContributesBinding(AppScope::class)
+@ContributesMultibinding(AppScope::class)
 class CarDataEntityCommandImpl @Inject constructor(
   private val carDao: CarDao,
   private val carEntityMapper: CarEntityMapper,
-) : CarDataEntityCommand {
+  private val commandShooter: CommandShooter,
+) : CommandHook {
 
-  override suspend fun getAll(): List<CarDatabaseEntity> =
+  private suspend fun getAll(): List<CarDatabaseEntity> =
     carDao.getAll().map { carEntityMapper.map(it) }
 
 
-  override suspend fun insertAll(cars: List<CarDatabaseEntity>) {
+  private suspend fun insertAll(cars: List<CarDatabaseEntity>) {
     val carEntities = carDao.insertCarEntity(
       *cars.map { carEntityMapper.mapToCarEntity(it) }.toTypedArray()
     ).mapIndexed { index, id ->
@@ -47,5 +51,24 @@ class CarDataEntityCommandImpl @Inject constructor(
     }.toTypedArray())
   }
 
-  override suspend fun isEmpty(): Boolean = carDao.getAll().isEmpty()
+  private suspend fun isEmpty(): Boolean = carDao.getAll().isEmpty()
+
+  override fun hookUp(commandRegister: CommandRegister) {
+
+    commandRegister.register(CarDataEntityCommandGetAll::class,
+      CommandCallbackImpl(commandShooter, CarDataEntityCommandGetAllResult::class) {
+        CarDataEntityCommandGetAllResult(getAll())
+      })
+
+    commandRegister.register(CarDataEntityCommandInsertAll::class,
+      CommandCallbackImpl(commandShooter, CarDataEntityCommandInsertAllResult::class) {
+        insertAll(it.cars)
+        CarDataEntityCommandInsertAllResult()
+      })
+
+    commandRegister.register(CarDataEntityCommandIsEmpty::class,
+      CommandCallbackImpl(commandShooter, CarDataEntityCommandIsEmptyResult::class) {
+        CarDataEntityCommandIsEmptyResult(isEmpty())
+      })
+  }
 }

database/impl/src/main/java/com/hadilq/guidomia/database/impl/di/DatabaseModule.kt

@@ -17,8 +17,8 @@ package com.hadilq.guidomia.database.impl.di
 
 import android.content.Context
 import androidx.room.Room
-import com.hadilq.guidomia.core.api.di.AppScope
-import com.hadilq.guidomia.core.api.di.SingleIn
+import com.hadilq.guidomia.di.api.AppScope
+import com.hadilq.guidomia.di.api.SingleIn
 import com.hadilq.guidomia.database.impl.AppDatabase
 import com.squareup.anvil.annotations.ContributesTo
 import dagger.Module

database/public/build.gradle.kts

@@ -19,4 +19,5 @@ plugins {
 
 dependencies {
   implementation(Depends.kotlinStdLib)
+  implementation(project(Modules.featureFlagsPublic))
 }

database/public/src/main/java/com/hadilq/guidomia/database/api/CarDataEntityCommandGetAll.kt

@@ -0,0 +1,9 @@
+package com.hadilq.guidomia.database.api
+
+import com.hadilq.guidomia.featureflags.api.Command
+
+class CarDataEntityCommandGetAll : Command
+
+class CarDataEntityCommandGetAllResult(
+  val result: List<CarDatabaseEntity>
+) : Command

database/public/src/main/java/com/hadilq/guidomia/database/api/CarDataEntityCommandInsertAll.kt

@@ -0,0 +1,9 @@
+package com.hadilq.guidomia.database.api
+
+import com.hadilq.guidomia.featureflags.api.Command
+
+class CarDataEntityCommandInsertAll(
+  val cars: List<CarDatabaseEntity>
+) : Command
+
+class CarDataEntityCommandInsertAllResult : Command

database/public/src/main/java/com/hadilq/guidomia/database/api/CarDataEntityCommandIsEmpty.kt

@@ -0,0 +1,9 @@
+package com.hadilq.guidomia.database.api
+
+import com.hadilq.guidomia.featureflags.api.Command
+
+class CarDataEntityCommandIsEmpty : Command
+
+class CarDataEntityCommandIsEmptyResult(
+  val result: Boolean
+) : Command

di/public/.gitignore

@@ -0,0 +1 @@
+/build

database/public/src/main/java/com/hadilq/guidomia/database/api/CarDataEntityCommand.kt di/public/build.gradle.kts

@@ -13,13 +13,11 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.hadilq.guidomia.database.api
-
-interface CarDataEntityCommand {
-
-  suspend fun getAll(): List<CarDatabaseEntity>
-
-  suspend fun insertAll(cars: List<CarDatabaseEntity>)
+plugins {
+  kotlin("jvm")
+}
 
-  suspend fun isEmpty(): Boolean
+dependencies {
+  implementation(Depends.kotlinStdLib)
+  implementation(Depends.dagger)
 }

core/public/src/main/java/com/hadilq/guidomia/core/api/di/AppScope.kt di/public/src/main/java/com/hadilq/guidomia/di/api/AppScope.kt

@@ -13,6 +13,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.hadilq.guidomia.core.api.di
+package com.hadilq.guidomia.di.api
 
 abstract class AppScope private constructor()

core/public/src/main/java/com/hadilq/guidomia/core/api/di/FragmentScope.kt di/public/src/main/java/com/hadilq/guidomia/di/api/FragmentScope.kt

@@ -13,6 +13,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.hadilq.guidomia.core.api.di
+package com.hadilq.guidomia.di.api
 
 abstract class FragmentScope private constructor()

core/public/src/main/java/com/hadilq/guidomia/core/api/di/RetainScope.kt di/public/src/main/java/com/hadilq/guidomia/di/api/RetainScope.kt

@@ -13,6 +13,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.hadilq.guidomia.core.api.di
+package com.hadilq.guidomia.di.api
 
 abstract class RetainScope private constructor()

core/public/src/main/java/com/hadilq/guidomia/core/api/di/SingleActivityScope.kt di/public/src/main/java/com/hadilq/guidomia/di/api/SingleActivityScope.kt

@@ -13,6 +13,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.hadilq.guidomia.core.api.di
+package com.hadilq.guidomia.di.api
 
 abstract class SingleActivityScope private constructor()

core/public/src/main/java/com/hadilq/guidomia/core/api/di/SingleIn.kt di/public/src/main/java/com/hadilq/guidomia/di/api/SingleIn.kt

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.hadilq.guidomia.core.api.di
+package com.hadilq.guidomia.di.api
 
 import javax.inject.Scope
 import kotlin.reflect.KClass

feature-flags/impl/.gitignore

@@ -0,0 +1 @@
+/build