Merge pull request #5253 from element-hq/metro-v2

Migrate Anvil KSP to Metro

Author: bmarty

anvilannotations/src/main/kotlin/io/element/android/anvilannotations/ContributesNode.kt

@@ -13,7 +13,7 @@ import kotlin.reflect.KClass
  * Adds Node to the specified component graph.
  * Equivalent to the following declaration:
  *
- * @Module
+ * @BindingContainer
  * @ContributesTo(Scope::class)
  * abstract class YourNodeModule {
 

anvilcodegen/build.gradle.kts

@@ -11,10 +11,9 @@ plugins {
 
 dependencies {
     implementation(projects.anvilannotations)
-    api(libs.anvil.compiler.api)
-    implementation(libs.anvil.compiler.utils)
+    implementation(libs.metro.runtime)
+    implementation(libs.kotlin.compiler)
     implementation(libs.kotlinpoet)
-    implementation(libs.dagger)
     implementation(libs.ksp.plugin)
     implementation(libs.kotlinpoet.ksp)
 }

anvilcodegen/src/main/kotlin/io/element/android/anvilcodegen/ContributesNodeProcessor.kt

@@ -19,7 +19,6 @@ import com.google.devtools.ksp.symbol.KSAnnotated
 import com.google.devtools.ksp.symbol.KSClassDeclaration
 import com.google.devtools.ksp.symbol.KSType
 import com.google.devtools.ksp.validate
-import com.squareup.anvil.annotations.ContributesTo
 import com.squareup.kotlinpoet.AnnotationSpec
 import com.squareup.kotlinpoet.ClassName
 import com.squareup.kotlinpoet.FileSpec
@@ -30,12 +29,12 @@ import com.squareup.kotlinpoet.STAR
 import com.squareup.kotlinpoet.TypeSpec
 import com.squareup.kotlinpoet.ksp.toTypeName
 import com.squareup.kotlinpoet.ksp.writeTo
-import dagger.Binds
-import dagger.Module
-import dagger.assisted.Assisted
-import dagger.assisted.AssistedFactory
-import dagger.assisted.AssistedInject
-import dagger.multibindings.IntoMap
+import dev.zacsweers.metro.Assisted
+import dev.zacsweers.metro.AssistedFactory
+import dev.zacsweers.metro.BindingContainer
+import dev.zacsweers.metro.Binds
+import dev.zacsweers.metro.ContributesTo
+import dev.zacsweers.metro.IntoMap
 import io.element.android.anvilannotations.ContributesNode
 import org.jetbrains.kotlin.name.FqName
 
@@ -77,9 +76,8 @@ class ContributesNodeProcessor(
             fileName = moduleClassName,
         )
             .addType(
-                TypeSpec.classBuilder(moduleClassName)
-                    .addModifiers(KModifier.ABSTRACT)
-                    .addAnnotation(Module::class)
+                TypeSpec.interfaceBuilder(moduleClassName)
+                    .addAnnotation(BindingContainer::class)
                     .addAnnotation(AnnotationSpec.builder(ContributesTo::class).addMember("%T::class", scope.toTypeName()).build())
                     .addFunction(
                         FunSpec.builder("bind${ksClass.simpleName.asString()}Factory")
@@ -103,7 +101,7 @@ class ContributesNodeProcessor(
         content.writeTo(
             codeGenerator = codeGenerator,
             dependencies = Dependencies(
-                aggregating = true,
+                aggregating = false,
                 ksClass.containingFile!!
             ),
         )
@@ -113,23 +111,23 @@ class ContributesNodeProcessor(
     private fun generateFactory(ksClass: KSClassDeclaration) {
         val generatedPackage = ksClass.packageName.asString()
         val assistedFactoryClassName = "${ksClass.simpleName.asString()}_AssistedFactory"
-        val constructor = ksClass.getConstructors().singleOrNull { it.isAnnotationPresent(AssistedInject::class) }
-        val assistedParameters = constructor?.parameters?.filter { it.isAnnotationPresent(Assisted::class) }.orEmpty()
-        if (constructor == null || assistedParameters.size != 2) {
+        val constructor = ksClass.getConstructors().first { it.parameters.isNotEmpty() }
+        val assistedParameters = constructor.parameters.filter { it.isAnnotationPresent(Assisted::class) }
+        if (assistedParameters.size != 2) {
             error(
-                "${ksClass.qualifiedName} must have an @AssistedInject constructor with 2 @Assisted parameters",
+                "${ksClass.qualifiedName?.asString()} must have an @Inject constructor with 2 @Assisted parameters. Found: ${assistedParameters.size}",
             )
         }
         val contextAssistedParam = assistedParameters[0]
         if (contextAssistedParam.name?.asString() != "buildContext") {
             error(
-                "${ksClass.qualifiedName} @Assisted parameter must be named buildContext",
+                "${ksClass.qualifiedName?.asString()} @Assisted parameter must be named buildContext",
             )
         }
         val pluginsAssistedParam = assistedParameters[1]
         if (pluginsAssistedParam.name?.asString() != "plugins") {
             error(
-                "${ksClass.qualifiedName} @Assisted parameter must be named plugins",
+                "${ksClass.qualifiedName?.asString()} @Assisted parameter must be named plugins",
             )
         }
 
@@ -156,7 +154,7 @@ class ContributesNodeProcessor(
         content.writeTo(
             codeGenerator = codeGenerator,
             dependencies = Dependencies(
-                aggregating = true,
+                aggregating = false,
                 ksClass.containingFile!!
             ),
         )

app/build.gradle.kts

@@ -13,7 +13,6 @@ import com.android.build.gradle.tasks.GenerateBuildConfig
 import com.google.firebase.appdistribution.gradle.firebaseAppDistribution
 import config.BuildTimeConfig
 import extension.AssetCopyTask
-import extension.ComponentMergingStrategy
 import extension.GitBranchNameValueSource
 import extension.GitRevisionValueSource
 import extension.allEnterpriseImpl
@@ -23,7 +22,7 @@ import extension.allServicesImpl
 import extension.buildConfigFieldStr
 import extension.koverDependencies
 import extension.locales
-import extension.setupAnvil
+import extension.setupDependencyInjection
 import extension.setupKover
 import java.util.Locale
 
@@ -37,7 +36,7 @@ plugins {
     alias(libs.plugins.licensee)
     alias(libs.plugins.kotlin.serialization)
     // To be able to update the firebase.xml files, uncomment and build the project
-    // id("com.google.gms.google-services")
+    // alias(libs.plugins.gms.google.services)
 }
 
 setupKover()
@@ -248,11 +247,7 @@ knit {
     }
 }
 
-setupAnvil(
-    generateDaggerCode = true,
-    generateDaggerFactoriesUsingAnvil = false,
-    componentMergingStrategy = ComponentMergingStrategy.KSP,
-)
+setupDependencyInjection()
 
 dependencies {
     allLibrariesImpl()

app/src/main/kotlin/io/element/android/x/ElementXApplication.kt

@@ -9,16 +9,16 @@ package io.element.android.x
 
 import android.app.Application
 import androidx.startup.AppInitializer
+import dev.zacsweers.metro.createGraphFactory
 import io.element.android.features.cachecleaner.api.CacheCleanerInitializer
-import io.element.android.libraries.di.DaggerComponentOwner
-import io.element.android.x.di.AppComponent
-import io.element.android.x.di.DaggerAppComponent
+import io.element.android.libraries.di.DependencyInjectionGraphOwner
+import io.element.android.x.di.AppGraph
 import io.element.android.x.info.logApplicationInfo
 import io.element.android.x.initializer.CrashInitializer
 import io.element.android.x.initializer.PlatformInitializer
 
-class ElementXApplication : Application(), DaggerComponentOwner {
-    override val daggerComponent: AppComponent = DaggerAppComponent.factory().create(this)
+class ElementXApplication : Application(), DependencyInjectionGraphOwner {
+    override val graph: AppGraph = createGraphFactory<AppGraph.Factory>().create(this)
 
     override fun onCreate() {
         super.onCreate()

app/src/main/kotlin/io/element/android/x/MainNode.kt

@@ -21,8 +21,8 @@ import com.bumble.appyx.core.node.ParentNode
 import com.bumble.appyx.core.plugin.Plugin
 import io.element.android.appnav.RootFlowNode
 import io.element.android.libraries.architecture.createNode
-import io.element.android.libraries.di.ApplicationContext
-import io.element.android.libraries.di.DaggerComponentOwner
+import io.element.android.libraries.di.DependencyInjectionGraphOwner
+import io.element.android.libraries.di.annotations.ApplicationContext
 import kotlinx.coroutines.launch
 import kotlinx.parcelize.Parcelize
 
@@ -38,8 +38,8 @@ class MainNode(
     buildContext = buildContext,
     plugins = plugins,
 ),
-    DaggerComponentOwner {
-    override val daggerComponent = (context as DaggerComponentOwner).daggerComponent
+    DependencyInjectionGraphOwner {
+    override val graph = (context as DependencyInjectionGraphOwner).graph
 
     override fun resolve(navTarget: RootNavTarget, buildContext: BuildContext): Node {
         return createNode<RootFlowNode>(buildContext = buildContext)

app/src/main/kotlin/io/element/android/x/di/AppBindings.kt

@@ -7,15 +7,15 @@
 
 package io.element.android.x.di
 
-import com.squareup.anvil.annotations.ContributesTo
+import dev.zacsweers.metro.AppScope
+import dev.zacsweers.metro.ContributesTo
 import io.element.android.features.api.MigrationEntryPoint
 import io.element.android.features.enterprise.api.EnterpriseService
 import io.element.android.features.lockscreen.api.LockScreenEntryPoint
 import io.element.android.features.lockscreen.api.LockScreenService
 import io.element.android.features.rageshake.api.reporter.BugReporter
 import io.element.android.libraries.core.meta.BuildMeta
 import io.element.android.libraries.designsystem.utils.snackbar.SnackbarDispatcher
-import io.element.android.libraries.di.AppScope
 import io.element.android.libraries.featureflag.api.FeatureFlagService
 import io.element.android.libraries.matrix.api.platform.InitPlatformService
 import io.element.android.libraries.matrix.api.tracing.TracingService

app/src/main/kotlin/io/element/android/x/di/AppComponent.kt

@@ -0,0 +1,28 @@
+/*
+ * Copyright 2025 New Vector Ltd.
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
+ * Please see LICENSE files in the repository root for full details.
+ */
+
+package io.element.android.x.di
+
+import android.content.Context
+import dev.zacsweers.metro.AppScope
+import dev.zacsweers.metro.DependencyGraph
+import dev.zacsweers.metro.Provides
+import io.element.android.libraries.architecture.NodeFactoriesBindings
+import io.element.android.libraries.di.annotations.ApplicationContext
+
+@DependencyGraph(AppScope::class)
+interface AppGraph : NodeFactoriesBindings {
+    val sessionGraphFactory: SessionGraph.Factory
+
+    @DependencyGraph.Factory
+    interface Factory {
+        fun create(
+            @ApplicationContext @Provides
+            context: Context
+        ): AppGraph
+    }
+}

app/src/main/kotlin/io/element/android/x/di/AppGraph.kt

@@ -11,9 +11,11 @@ import android.content.Context
 import android.content.SharedPreferences
 import android.content.res.Resources
 import androidx.preference.PreferenceManager
-import com.squareup.anvil.annotations.ContributesTo
-import dagger.Module
-import dagger.Provides
+import dev.zacsweers.metro.AppScope
+import dev.zacsweers.metro.BindingContainer
+import dev.zacsweers.metro.ContributesTo
+import dev.zacsweers.metro.Provides
+import dev.zacsweers.metro.SingleIn
 import io.element.android.appconfig.ApplicationConfig
 import io.element.android.features.enterprise.api.EnterpriseService
 import io.element.android.features.messages.impl.timeline.components.customreaction.DefaultEmojibaseProvider
@@ -23,11 +25,10 @@ import io.element.android.libraries.core.coroutine.CoroutineDispatchers
 import io.element.android.libraries.core.meta.BuildMeta
 import io.element.android.libraries.core.meta.BuildType
 import io.element.android.libraries.designsystem.utils.snackbar.SnackbarDispatcher
-import io.element.android.libraries.di.AppScope
-import io.element.android.libraries.di.ApplicationContext
+import io.element.android.libraries.di.BaseDirectory
 import io.element.android.libraries.di.CacheDirectory
-import io.element.android.libraries.di.SingleIn
 import io.element.android.libraries.di.annotations.AppCoroutineScope
+import io.element.android.libraries.di.annotations.ApplicationContext
 import io.element.android.x.BuildConfig
 import io.element.android.x.R
 import kotlinx.coroutines.CoroutineName
@@ -37,10 +38,11 @@ import kotlinx.coroutines.MainScope
 import kotlinx.coroutines.plus
 import java.io.File
 
-@Module
+@BindingContainer
 @ContributesTo(AppScope::class)
 object AppModule {
     @Provides
+    @BaseDirectory
     fun providesBaseDirectory(@ApplicationContext context: Context): File {
         return File(context.filesDir, "sessions")
     }