Merge pull request #4312 from vector-im/feature/fga/hilt_app_migration

Migrate App DI framework to Hilt

Author: bmarty

build.gradle

@@ -17,6 +17,7 @@ buildscript {
         // https://developer.android.com/studio/releases/gradle-plugin
         classpath libs.gradle.gradlePlugin
         classpath libs.gradle.kotlinPlugin
+        classpath libs.gradle.hiltPlugin
         classpath 'com.google.gms:google-services:4.3.10'
         classpath 'org.sonarsource.scanner.gradle:sonarqube-gradle-plugin:3.3'
         classpath 'com.google.android.gms:oss-licenses-plugin:0.10.4'

changelog.d/3888.misc

@@ -0,0 +1 @@
+Migrate app DI framework to Hilt

dependencies.gradle

@@ -34,7 +34,9 @@ def androidxTest = "1.4.0"
 ext.libs = [
         gradle      : [
                 'gradlePlugin'            : "com.android.tools.build:gradle:$gradle",
-                'kotlinPlugin'            : "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin"
+                'kotlinPlugin'            : "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin",
+                'hiltPlugin'              : "com.google.dagger:hilt-android-gradle-plugin:$dagger"
+
         ],
         jetbrains   : [
                 'coroutinesCore'          : "org.jetbrains.kotlinx:kotlinx-coroutines-core:$kotlinCoroutines",
@@ -72,7 +74,9 @@ ext.libs = [
         ],
         dagger      : [
                 'dagger'                  : "com.google.dagger:dagger:$dagger",
-                'daggerCompiler'          : "com.google.dagger:dagger-compiler:$dagger"
+                'daggerCompiler'          : "com.google.dagger:dagger-compiler:$dagger",
+                'hilt'                    : "com.google.dagger:hilt-android:$dagger",
+                'hiltCompiler'            : "com.google.dagger:hilt-compiler:$dagger"
         ],
         squareup    : [
                 'moshi'                  : "com.squareup.moshi:moshi-adapters:$moshi",

docs/hilt_migration.md

@@ -0,0 +1,33 @@
+Useful links:
+- https://dagger.dev/hilt/migration-guide
+- https://dagger.dev/hilt/quick-start
+
+Hilt is built on top of Dagger 2 and simplify usage by removing needs to create components manually.
+
+When you create a new feature, you should have the following:
+
+Annotate your Activity with @AndroidEntryPoint
+If you have a BottomSheetFragment => Annotate it with @AndroidEntryPoint
+Otherwise => Add your Fragment to the FragmentModule
+Add your ViewModel.Factory to the MavericksViewModelModule
+Makes sure your ViewModel as the following code:
+
+```
+ @AssistedFactory
+    interface Factory: MavericksAssistedViewModelFactory<MyViewModel, MyViewState> {
+        override fun create(initialState: MyViewState): MyViewModel
+    }
+
+    companion object : MavericksViewModelFactory<MyViewModel, MyViewState> by hiltMavericksViewModelFactory()
+```
+
+## Some remarks
+
+@MavericksViewModelScope dependencies can't be injected inside Fragments/Activities
+You can only inject @Singleton, @MavericksViewModelScope or unscoped dependencies inside Maverick ViewModels
+You can access some specific dependencies from Singleton component by using
+```
+context.singletonEntryPoint()
+```
+Be aware that only the app has been migrated to Hilt and not the SDK.
+

vector/build.gradle

@@ -6,6 +6,7 @@ apply plugin: 'kotlin-android'
 apply plugin: 'kotlin-parcelize'
 apply plugin: 'kotlin-kapt'
 apply plugin: 'placeholder-resolver'
+apply plugin: 'dagger.hilt.android.plugin'
 
 kapt {
     correctErrorTypes = true
@@ -456,8 +457,8 @@ dependencies {
     implementation 'nl.dionsegijn:konfetti:1.3.2'
     implementation 'com.github.jetradarmobile:android-snowfall:1.2.1'
     // DI
-    implementation libs.dagger.dagger
-    kapt libs.dagger.daggerCompiler
+    implementation libs.dagger.hilt
+    kapt libs.dagger.hiltCompiler
 
     // gplay flavor only
     gplayImplementation('com.google.firebase:firebase-messaging:22.0.0') {

vector/src/debug/java/im/vector/app/features/debug/DebugMenuActivity.kt

@@ -24,9 +24,9 @@ import android.os.Build
 import androidx.core.app.NotificationCompat
 import androidx.core.app.Person
 import androidx.core.content.getSystemService
+import dagger.hilt.android.AndroidEntryPoint
 import im.vector.app.R
 import im.vector.app.core.di.ActiveSessionHolder
-import im.vector.app.core.di.ScreenComponent
 import im.vector.app.core.extensions.registerStartForActivityResult
 import im.vector.app.core.platform.VectorBaseActivity
 import im.vector.app.core.utils.PERMISSIONS_FOR_TAKING_PHOTO
@@ -50,17 +50,14 @@ import org.matrix.android.sdk.internal.crypto.verification.qrcode.toQrCodeData
 import timber.log.Timber
 import javax.inject.Inject
 
+@AndroidEntryPoint
 class DebugMenuActivity : VectorBaseActivity<ActivityDebugMenuBinding>() {
 
     override fun getBinding() = ActivityDebugMenuBinding.inflate(layoutInflater)
 
     @Inject
     lateinit var activeSessionHolder: ActiveSessionHolder
 
-    override fun injectWith(injector: ScreenComponent) {
-        injector.inject(this)
-    }
-
     private lateinit var buffer: ByteArray
 
     override fun initUiAndData() {

vector/src/fdroid/java/im/vector/app/fdroid/features/settings/troubleshoot/TestBackgroundRestrictions.kt

@@ -18,15 +18,15 @@ package im.vector.app.fdroid.features.settings.troubleshoot
 import android.content.Intent
 import android.net.ConnectivityManager
 import androidx.activity.result.ActivityResultLauncher
-import androidx.appcompat.app.AppCompatActivity
 import androidx.core.content.getSystemService
 import androidx.core.net.ConnectivityManagerCompat
+import androidx.fragment.app.FragmentActivity
 import im.vector.app.R
 import im.vector.app.core.resources.StringProvider
 import im.vector.app.features.settings.troubleshoot.TroubleshootTest
 import javax.inject.Inject
 
-class TestBackgroundRestrictions @Inject constructor(private val context: AppCompatActivity,
+class TestBackgroundRestrictions @Inject constructor(private val context: FragmentActivity,
                                                      private val stringProvider: StringProvider) :
     TroubleshootTest(R.string.settings_troubleshoot_test_bg_restricted_title) {
 

vector/src/fdroid/java/im/vector/app/fdroid/features/settings/troubleshoot/TestBatteryOptimization.kt

@@ -17,7 +17,7 @@ package im.vector.app.fdroid.features.settings.troubleshoot
 
 import android.content.Intent
 import androidx.activity.result.ActivityResultLauncher
-import androidx.appcompat.app.AppCompatActivity
+import androidx.fragment.app.FragmentActivity
 import im.vector.app.R
 import im.vector.app.core.resources.StringProvider
 import im.vector.app.core.utils.isIgnoringBatteryOptimizations
@@ -26,7 +26,7 @@ import im.vector.app.features.settings.troubleshoot.TroubleshootTest
 import javax.inject.Inject
 
 class TestBatteryOptimization @Inject constructor(
-        private val context: AppCompatActivity,
+        private val context: FragmentActivity,
         private val stringProvider: StringProvider
 ) : TroubleshootTest(R.string.settings_troubleshoot_test_battery_title) {
 

vector/src/fdroid/java/im/vector/app/fdroid/receiver/AlarmSyncBroadcastReceiver.kt

@@ -24,7 +24,7 @@ import android.content.Intent
 import android.os.Build
 import androidx.core.content.ContextCompat
 import androidx.core.content.getSystemService
-import im.vector.app.core.di.HasVectorInjector
+import im.vector.app.core.extensions.singletonEntryPoint
 import im.vector.app.core.services.VectorSyncService
 import org.matrix.android.sdk.internal.session.sync.job.SyncService
 import timber.log.Timber
@@ -33,9 +33,8 @@ class AlarmSyncBroadcastReceiver : BroadcastReceiver() {
 
     override fun onReceive(context: Context, intent: Intent) {
         Timber.d("## Sync: AlarmSyncBroadcastReceiver received intent")
-        val vectorPreferences = (context.applicationContext as? HasVectorInjector)
-                ?.injector()
-                ?.takeIf { it.activeSessionHolder().getSafeActiveSession() != null }
+        val vectorPreferences = context.singletonEntryPoint()
+                .takeIf { it.activeSessionHolder().getSafeActiveSession() != null }
                 ?.vectorPreferences()
                 ?: return Unit.also { Timber.v("No active session, so don't launch sync service.") }
 

vector/src/fdroid/java/im/vector/app/fdroid/receiver/OnApplicationUpgradeOrRebootReceiver.kt

@@ -20,22 +20,19 @@ package im.vector.app.fdroid.receiver
 import android.content.BroadcastReceiver
 import android.content.Context
 import android.content.Intent
-import im.vector.app.core.di.HasVectorInjector
-import im.vector.app.core.extensions.vectorComponent
+import im.vector.app.core.extensions.singletonEntryPoint
 import im.vector.app.fdroid.BackgroundSyncStarter
 import timber.log.Timber
 
 class OnApplicationUpgradeOrRebootReceiver : BroadcastReceiver() {
 
     override fun onReceive(context: Context, intent: Intent) {
         Timber.v("## onReceive() ${intent.action}")
-        val appContext = context.applicationContext
-        if (appContext is HasVectorInjector) {
+        val singletonEntryPoint = context.singletonEntryPoint()
             BackgroundSyncStarter.start(
                     context,
-                    appContext.vectorComponent().vectorPreferences(),
-                    appContext.injector().activeSessionHolder()
+                    singletonEntryPoint.vectorPreferences(),
+                    singletonEntryPoint.activeSessionHolder()
             )
-        }
     }
 }