Start migrating Anvil KSP to Metro

Author: jmartinesp

.gitmodules

@@ -1,3 +0,0 @@
-[submodule "enterprise"]
-	path = enterprise
-	url = [email protected]:element-hq/element-android-enterprise.git

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.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
 
@@ -57,9 +56,9 @@ class ContributesNodeProcessor(
         if (validSymbols.isEmpty()) return invalidSymbols
 
         for (ksClass in validSymbols) {
-            if (config.enableLogging) {
+//            if (config.enableLogging) {
                 logger.warn("Processing ${ksClass.qualifiedName?.asString()}")
-            }
+//            }
             generateModule(ksClass)
             generateFactory(ksClass)
         }
@@ -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/src/main/kotlin/io/element/android/x/ElementXApplication.kt

@@ -9,16 +9,18 @@ package io.element.android.x
 
 import android.app.Application
 import androidx.startup.AppInitializer
+import dev.zacsweers.metro.asContribution
+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.x.di.globalGraph
 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)
+    override val daggerComponent: AppComponent = globalGraph.asContribution<AppComponent.Factory>().create(this)
 
     override fun onCreate() {
         super.onCreate()

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

@@ -21,7 +21,7 @@ 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.annotations.ApplicationContext
 import io.element.android.libraries.di.DaggerComponentOwner
 import kotlinx.coroutines.launch
 import kotlinx.parcelize.Parcelize

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.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 dev.zacsweers.metro.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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2023, 2024 New Vector Ltd.
+ * 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.
@@ -8,20 +8,22 @@
 package io.element.android.x.di
 
 import android.content.Context
-import com.squareup.anvil.annotations.MergeComponent
-import dagger.BindsInstance
+import dev.zacsweers.metro.ContributesTo
+import dev.zacsweers.metro.GraphExtension
+import dev.zacsweers.metro.Provides
 import io.element.android.libraries.architecture.NodeFactoriesBindings
-import io.element.android.libraries.di.AppScope
-import io.element.android.libraries.di.ApplicationContext
-import io.element.android.libraries.di.SingleIn
+import dev.zacsweers.metro.AppScope
+import io.element.android.libraries.di.annotations.ApplicationContext
 
-@SingleIn(AppScope::class)
-@MergeComponent(AppScope::class)
+@GraphExtension(AppScope::class)
 interface AppComponent : NodeFactoriesBindings {
-    @MergeComponent.Factory
+    val sessionComponentFactory: SessionComponent.Factory
+
+    @ContributesTo(GlobalScope::class)
+    @GraphExtension.Factory
     interface Factory {
         fun create(
-            @ApplicationContext @BindsInstance
+            @ApplicationContext @Provides
             context: Context
         ): AppComponent
     }

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

@@ -11,9 +11,10 @@ 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.BindingContainer
+import dev.zacsweers.metro.ContributesTo
+import dev.zacsweers.metro.Named
+import dev.zacsweers.metro.Provides
 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,10 +24,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 dev.zacsweers.metro.AppScope
+import io.element.android.libraries.di.annotations.ApplicationContext
 import io.element.android.libraries.di.CacheDirectory
-import io.element.android.libraries.di.SingleIn
+import dev.zacsweers.metro.SingleIn
 import io.element.android.libraries.di.annotations.AppCoroutineScope
 import io.element.android.x.BuildConfig
 import io.element.android.x.R
@@ -37,16 +38,17 @@ import kotlinx.coroutines.MainScope
 import kotlinx.coroutines.plus
 import java.io.File
 
-@Module
+@BindingContainer
 @ContributesTo(AppScope::class)
 object AppModule {
     @Provides
+    @Named("baseDirectory")
     fun providesBaseDirectory(@ApplicationContext context: Context): File {
         return File(context.filesDir, "sessions")
     }
 
     @Provides
-    @CacheDirectory
+    @Named("cacheDirectory")
     fun providesCacheDirectory(@ApplicationContext context: Context): File {
         return context.cacheDir
     }

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

@@ -7,20 +7,19 @@
 
 package io.element.android.x.di
 
-import com.squareup.anvil.annotations.ContributesBinding
+import dev.zacsweers.metro.ContributesBinding
 import io.element.android.appnav.di.RoomComponentFactory
 import io.element.android.libraries.di.SessionScope
 import io.element.android.libraries.matrix.api.room.JoinedRoom
-import javax.inject.Inject
+import dev.zacsweers.metro.Inject
 
 @ContributesBinding(SessionScope::class)
-class DefaultRoomComponentFactory @Inject constructor(
-    private val roomComponentBuilder: RoomComponent.Builder
+@Inject
+class DefaultRoomComponentFactory(
+    private val sessionComponent: SessionComponent,
 ) : RoomComponentFactory {
     override fun create(room: JoinedRoom): Any {
-        return roomComponentBuilder
-            .joinedRoom(room)
-            .baseRoom(room)
-            .build()
+        return sessionComponent.roomComponentFactory
+            .create(room, room)
     }
 }