Merge pull request #3217 from CruGlobal/kspMigration

Migrate a few more modules to use KSP
CruGlobal · Nov 7, 2023 · 2a702f4 · 2a702f4
2 parents d7c63f6 + 99a4939
commit 2a702f4
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 15 deletions.
diff --git a/app/build.gradle.kts b/app/build.gradle.kts
@@ -1,12 +1,12 @@
 plugins {
     id("godtools.application-conventions")
-    kotlin("kapt")
     alias(libs.plugins.firebase.appdistribution)
     alias(libs.plugins.firebase.crashlytics)
     alias(libs.plugins.firebase.perf)
     alias(libs.plugins.google.services)
     alias(libs.plugins.grgit)
     alias(libs.plugins.hilt)
+    alias(libs.plugins.ksp)
 }
 
 android {
@@ -129,12 +129,13 @@ android {
     dynamicFeatures += ":feature:bundledcontent"
 }
 
-kapt {
-    javacOptions {
-        option("-Adagger.fastInit=enabled")
-    }
+ksp {
+    arg("dagger.fastInit", "enabled")
 }
 
+// TODO: remove these bug workarounds once they are no longer needed
+exportAgpGeneratedSourcesToKsp()
+
 onesky {
     sourceStringFiles = listOf(
         "strings_account.xml",
@@ -225,10 +226,8 @@ dependencies {
     debugImplementation(libs.gtoSupport.okhttp3)
     debugImplementation(libs.leakcanary)
 
-    // TODO: transition to KSP for dagger once referencing BuildConfig is supported
-    //       see: https://github.com/google/dagger/issues/4051
-    kapt(libs.dagger.compiler)
-    kapt(libs.hilt.compiler)
+    ksp(libs.dagger.compiler)
+    ksp(libs.hilt.compiler)
 
     testImplementation(libs.androidx.arch.core.testing)
     testImplementation(libs.androidx.lifecycle.runtime.testing)
@@ -238,7 +237,6 @@ dependencies {
     testImplementation(libs.kotlin.coroutines.test)
     testImplementation(libs.turbine)
     testImplementation(testFixtures(project(":library:model")))
-    kaptTest(libs.hilt.compiler)
 }
 
 // region Firebase App Distribution

diff --git a/build-logic/src/main/kotlin/AndroidConfiguration.kt b/build-logic/src/main/kotlin/AndroidConfiguration.kt
@@ -2,6 +2,7 @@ import com.android.build.api.dsl.CommonExtension
 import com.android.build.api.variant.AndroidComponentsExtension
 import com.android.build.gradle.BaseExtension
 import com.android.build.gradle.TestedExtension
+import com.android.build.gradle.tasks.GenerateBuildConfig
 import org.gradle.api.JavaVersion
 import org.gradle.api.Project
 import org.gradle.api.artifacts.component.ModuleComponentIdentifier
@@ -11,6 +12,7 @@ import org.gradle.kotlin.dsl.findByType
 import org.gradle.kotlin.dsl.invoke
 import org.jetbrains.kotlin.gradle.dsl.KotlinAndroidProjectExtension
 import org.jetbrains.kotlin.gradle.dsl.KotlinJvmOptions
+import org.jetbrains.kotlin.gradle.tasks.AbstractKotlinCompileTool
 
 internal const val BUILD_TYPE_DEBUG = "debug"
 internal const val BUILD_TYPE_QA = "qa"
@@ -138,3 +140,23 @@ fun CommonExtension<*, *, *, *, *>.configureQaBuildType(project: Project) {
         named("${BUILD_TYPE_QA}Implementation") { extendsFrom(getByName("${BUILD_TYPE_DEBUG}Implementation")) }
     }
 }
+
+// TODO: Work around AGP generated BuildConfig not being exposed to KSP processors.
+//       see: https://github.com/google/dagger/issues/4051
+fun Project.exportAgpGeneratedSourcesToKsp() {
+    androidComponents {
+        onVariants { variant ->
+            val kspTaskName = "ksp" + variant.name.capitalize() + "Kotlin"
+            val buildConfigTaskName = "generate" + variant.name.capitalize() + "BuildConfig"
+
+            afterEvaluate {
+                tasks.named(kspTaskName) {
+                    val buildConfigSource = tasks.named(buildConfigTaskName, GenerateBuildConfig::class.java)
+                        .map { it.sourceOutputDir }
+
+                    (this as AbstractKotlinCompileTool<*>).setSource(buildConfigSource)
+                }
+            }
+        }
+    }
+}
diff --git a/library/api/build.gradle.kts b/library/api/build.gradle.kts
@@ -1,6 +1,6 @@
 plugins {
     id("godtools.library-conventions")
-    kotlin("kapt")
+    alias(libs.plugins.ksp)
 }
 
 android {
@@ -16,6 +16,9 @@ android {
     }
 }
 
+// TODO: remove these bug workarounds once they are no longer needed
+exportAgpGeneratedSourcesToKsp()
+
 dependencies {
     api(project(":library:model"))
 
@@ -37,10 +40,8 @@ dependencies {
     implementation(libs.scarlet.adapters.stream.coroutines)
     implementation(libs.scarlet.websockets.okhttp)
 
-    // TODO: transition to KSP for dagger once referencing BuildConfig is supported
-    //       see: https://github.com/google/dagger/issues/4051
-    kapt(libs.dagger.compiler)
-    kapt(libs.hilt.compiler)
+    ksp(libs.dagger.compiler)
+    ksp(libs.hilt.compiler)
 
     testImplementation(libs.json)
     testImplementation(libs.jsonUnit.assertj)