Android integration issues

[vaslabs]

I'm adding this issue to track minor bugs/missing features while I'm experimenting with various apps.

Issues found so far:

• Android manifest merge cache does not seem to be invalidated when the manifest file changes. PR Android: ManifestMerger bugfixes #5656
• Android manifest merge fails if xmlns:android="http://schemas.android.com/apk/res/android" property already exists. PR Android: ManifestMerger bugfixes #5656

example

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android">

</manifest>

• generatedSourcesWithKSP fails if android APIs (from android.jar) are mentioned -> android.jar is also missing from the classpath in the case of submodules (AndroidModule). PR Android: fix androidCompiledModuleResources #5662
  e.g. these are workarounds

  override def kspClasspath: T[Seq[PathRef]] = super.kspClasspath() ++ androidSdkModule().androidLibsClasspaths()

  override def compileClasspath: T[Seq[PathRef]] = 
    super.compileClasspath() ++ androidSdkModule().androidLibsClasspaths()

• androidCompiledModuleResources fail with multiple submodules. PR Android: fix androidCompiledModuleResources #5662
• Resources can be passed as a Jar to avoid submodule conflicts PR Android: fix androidCompiledModuleResources #5662
• Hilt and KSP classpath resolution is not working with android resolution parameters PR Android: Add kspDependencyResolver #5674
• Proguard rules for Hilt need to be autogenerated along with initialisers in the android manifest provider section to avoid R8 shrinking "nullifying" the constructors. PR Android: Proguard issues fixes #5677
• Proguard file changes do not invalidate androidDex/androidApk caches. PR Android: Fix Proguard Cache Invalidation (Changes Existing Examples) #5688

Workaround Reference

[vaslabs]

I'm specifically testing this project https://github.com/NicosNicolaou16/Pokedex_Compose_Multi_Module which uses hilt, latest compose stack and multiple submodules

my build.mill so far is (only database is properly setup):

//| mill-version: 1.0.2
package build

import mill.*
import androidlib.*
import kotlinlib.*
import hilt.AndroidHiltSupport
import mill.api.ModuleRef
import mill.javalib.JavaModule

object androidSdkModule0 extends AndroidSdkModule {
  def buildToolsVersion = "36.0.0"
}

object database extends AndroidHiltCompose {
  override def androidNamespace: String = "com.nicos.database"

  override def mvnDeps: T[Seq[Dep]] = super.mvnDeps() ++ Seq(
    mvn"androidx.core:core-ktx:1.16.0",
    mvn"androidx.appcompat:appcompat:1.7.1",
    mvn"com.google.android.material:material:1.12.0",
    mvn"androidx.room:room-runtime:2.7.2",
    mvn"androidx.room:room-ktx:2.7.2",
    mvn"com.google.code.gson:gson:2.13.1",
    mvn"org.jetbrains.kotlinx:kotlinx-coroutines-core:1.10.2",
    mvn"org.jetbrains.kotlinx:kotlinx-coroutines-android:1.10.2",
  )

  override def kotlinSymbolProcessors: T[Seq[Dep]] = super.kotlinSymbolProcessors() ++ Seq(
    mvn"androidx.room:room-compiler:2.7.2"
  )
}

object network extends AndroidKotlinLib {
  override def androidNamespace: String = "com.nicos.network"
}

object compose_ui extends AndroidHiltCompose {
  override def moduleDeps: Seq[JavaModule] = super.moduleDeps ++ Seq(database, network)

  override def androidNamespace: String = "com.nicos.compose_ui"

  override def mvnDeps: T[Seq[Dep]] = super.mvnDeps() ++ Seq(

  )
}

object navigation extends AndroidCompose {
  override def moduleDeps: Seq[JavaModule] = super.moduleDeps ++ Seq(compose_ui)
  override def androidNamespace: String = "com.nicos.navigation"

  override def mvnDeps: T[Seq[Dep]] = super.mvnDeps() ++ Seq(

  )
}

object app extends AndroidAppKotlinModule, AndroidR8AppModule, AndroidBuildConfig,
  AndroidHiltSupport {

  override def moduleDeps: Seq[JavaModule] = super.moduleDeps ++ Seq(navigation)

  def kotlinVersion = Versions.kotlinVersion
  def kotlinLanguageVersion = Versions.kotlinLanguageVersion
  def kspVersion = Versions.kspVersion

  override def androidDebugSettings: T[AndroidBuildTypeSettings] = Task {
    AndroidBuildTypeSettings(
      isMinifyEnabled = true,
      isShrinkEnabled = true
    ).withDefaultProguardFile("proguard-android-optimize.txt")
      .withProguardLocalFiles(
        Seq(
          moduleDir / "proguard-rules.pro"
        )
      )
  }

  // TODO consider using a debug module
  def debugSources = Task.Sources("src/debug/java")

  override def sources = super.sources() ++ debugSources()

  def androidApplicationNamespace = "com.example.android.architecture.blueprints.todoapp"
  // TODO change this to com.example.android.architecture.blueprints.main when mill supports build variants
  def androidApplicationId = "com.example.android.architecture.blueprints.main"

  def androidSdkModule = mill.api.ModuleRef(androidSdkModule0)

  def androidCompileSdk = Versions.androidCompileSdk

  def androidMinSdk = Versions.androidMinSdk

  def androidEnableCompose = true

  def androidIsDebug = true

  def bomMvnDeps = Seq(
    mvn"androidx.compose:compose-bom:2024.12.01"
  )

  def mvnDeps: T[Seq[Dep]] = super.mvnDeps() ++ Seq(
    mvn"androidx.core:core-ktx:1.15.0",
    mvn"androidx.appcompat:appcompat:1.7.0",
    mvn"androidx.annotation:annotation:1.9.1",
    mvn"org.jetbrains.kotlinx:kotlinx-coroutines-android:1.9.0",
    mvn"com.jakewharton.timber:timber:5.0.1",
    mvn"androidx.test.espresso:espresso-idling-resource:3.6.1",
    mvn"androidx.room:room-runtime:2.6.1",
    mvn"androidx.room:room-ktx:2.6.1",
    mvn"androidx.activity:activity-compose:1.10.0",
    mvn"androidx.navigation:navigation-compose:2.8.5",
    mvn"androidx.emoji2:emoji2:1.3.0",
    mvn"androidx.lifecycle:lifecycle-common:2.8.7",
    mvn"androidx.lifecycle:lifecycle-process:2.8.7",
    mvn"androidx.lifecycle:lifecycle-runtime-compose:2.8.7",
    mvn"androidx.lifecycle:lifecycle-viewmodel-compose:2.8.7",
    mvn"androidx.lifecycle:lifecycle-viewmodel-ktx:2.8.7",
    mvn"com.google.accompanist:accompanist-appcompat-theme:0.36.0",
    mvn"com.google.dagger:hilt-android:2.56",
    mvn"androidx.hilt:hilt-navigation-compose:1.2.0",
    mvn"com.google.accompanist:accompanist-swiperefresh:0.36.0",
    mvn"androidx.customview:customview-poolingcontainer:1.0.0",
    mvn"androidx.tracing:tracing:1.2.0",

    // versions are resolved with compose-bom
    mvn"androidx.compose.foundation:foundation",
    mvn"androidx.compose.foundation:foundation-layout",
    mvn"androidx.compose.animation:animation",
    mvn"androidx.compose.material3:material3",
    mvn"androidx.compose.material:material",
    mvn"androidx.compose.material:material-icons-extended",
    mvn"androidx.compose.ui:ui-tooling-preview",
    mvn"androidx.compose.ui:ui",
    mvn"androidx.compose.ui:ui-unit",
    mvn"androidx.compose.ui:ui-text",
    mvn"androidx.compose.ui:ui-graphics",
    // debug
    mvn"androidx.compose.ui:ui-tooling",
    mvn"androidx.compose.ui:ui-test-manifest"
  )

  def kotlinSymbolProcessors: T[Seq[Dep]] = Seq(
    mvn"androidx.room:room-compiler:2.7.2",
    mvn"com.google.dagger:hilt-android-compiler:2.57"
  )

}

trait AndroidKotlinLib extends AndroidKotlinModule {
  override def androidMinSdk: T[Int] = Task { Versions.androidMinSdk }

  override def androidCompileSdk: T[Int] = Task { Versions.androidCompileSdk }
  override def androidSdkModule: ModuleRef[AndroidSdkModule] = ModuleRef(androidSdkModule0)

  override def kotlinVersion: T[String] = Versions.kotlinVersion

  override def kotlinUseEmbeddableCompiler: Task[Boolean] = Task {
    true
  }
}

trait AndroidCompose extends AndroidKotlinLib {

  override def androidEnableCompose: T[Boolean] = Task {
    true
  }

}

trait AndroidHiltLib extends AndroidKotlinLib with AndroidHiltSupport {
  def kotlinSymbolProcessors: T[Seq[Dep]] = super.kotlinSymbolProcessors() ++ Seq(
    mvn"com.google.dagger:hilt-android-compiler:2.57",
    mvn"com.google.dagger:hilt-compiler:2.57",
    mvn"androidx.hilt:hilt-compiler:1.2.0"
  )

  override def mvnDeps: T[Seq[Dep]] = super.mvnDeps() ++ Seq(
    mvn"com.google.dagger:hilt-android:2.57"
  )

  override def kspClasspath: T[Seq[PathRef]] = super.kspClasspath() ++ androidSdkModule().androidLibsClasspaths()

  override def compileClasspath: T[Seq[PathRef]] = 
    super.compileClasspath() ++ androidSdkModule().androidLibsClasspaths()
}

trait AndroidHiltCompose extends AndroidHiltLib {
  override def kspVersion: T[String] = Versions.kspVersion
}

object Versions {
  val kotlinVersion = "2.2.0"
  val kotlinLanguageVersion = "1.9"

  val kspVersion = "2.0.2"
  val androidCompileSdk = 36
  val androidMinSdk = 29
}

and run:

./mill database.compile

To fix the android manifest parsing issue remove xmlns:android="http://schemas.android.com/apk/res/android" from the database/src/main/AndroidManifest.xml

[vaslabs]

cc: @souvlakias

[vaslabs]

my integration branch to get the latest changes

https://github.com/vaslabs/Pokedex_Compose_Multi_Module/tree/testing-mill

[vaslabs]

• Having more than one submodules that depend on each other breaks androidCompiledModuleResources

Explanation:

[
  "ref:v0:cd93430f:/home/vnicolaou/Pokedex_Compose_Multi_Module/database/src/main/res"
]
[1/1] ============================== show network.androidTransitiveResources ============================== 1s

[1/1] show
[
  "ref:v0:4fa3fee8:/home/vnicolaou/Pokedex_Compose_Multi_Module/network/src/main/res"
]
[1/1] ============================== show network.androidResources ==============================

show 1 tasks failed
network.androidCompiledModuleResources java.nio.file.FileAlreadyExistsException: /home/vnicolaou/Pokedex_Compose_Multi_Module/out/network/androidCompiledModuleResources.dest/main
    java.base/sun.nio.fs.UnixException.translateToIOException(UnixException.java:94)
    java.base/sun.nio.fs.UnixException.rethrowAsIOException(UnixException.java:106)

Ideally the moduled files should just be passed by reference instead of compiling the resources multiple times or we should just fix:

val libraryName = segmentsSeq.dropRight(1).last

Workaround (not recommended implementation)

[vaslabs]

compose_ui module on example project is not generating the sources properly

[1-292] Caused by: java.lang.IllegalStateException: couldn't find inline method Landroidx/compose/foundation/layout/BoxKt;.Box$default(Landroidx/compose/ui/Modifier;Landroidx/compose/ui/Alignment;ZLkotlin/jvm/functions/Function1;ILjava/lang/Object;)V
[1-292]         at org.jetbrains.kotlin.codegen.inline.SourceCompilerForInlineKt.getMethodNode(SourceCompilerForInline.kt:129)
[1-292]         at org.jetbrains.kotlin.codegen.inline.SourceCompilerForInlineKt.loadCompiledInlineFunction$lambda$2(SourceCompilerForInline.kt:98)
[1-292]         at org.jetbrains.kotlin.codegen.inline.InlineCache.computeMethodBytes(InlineCache.kt:90)
[1-292]         at org.jetbrains.kotlin.codegen.inline.SourceCompilerForInlineKt.loadCompiledInlineFunction(SourceCompilerForInline.kt:93)
[1-292]         at org.jetbrains.kotlin.backend.jvm.codegen.IrSourceCompilerForInline.compileInlineFunction(IrSourceCompilerForInline.kt:96)
[1-292]         at org.jetbrains.kotlin.backend.jvm.codegen.IrInlineCodegen.genInlineCall(IrInlineCodegen.kt:65)
[1-292]         ... 121 more
[1-292] 

this requires in-depth investigation unless I forgot some dependency somewhere

Edit: Setting the language version to 1.9 results in a different error that looks more familiar to me:

[1-292] Caused by: java.lang.ClassNotFoundException: com.google.common.collect.Streams
[1-292]         at java.base/java.net.URLClassLoader.findClass(URLClassLoader.java:440)
[1-292]         at java.base/java.lang.ClassLoader.loadClass(ClassLoader.java:587)
[1-292]         at java.base/java.lang.ClassLoader.loadClass(ClassLoader.java:520)
[1-292]         ... 111 more
[1-292] 

While this fails, it generates some code ^ , so maybe it still needs kotlin language version 1.9 , I haven't run the gradle yet to see what's passing to it

[vaslabs]

I've managed to compile compose ui as well, turns out the android default resolution doesn't play well with whatever we resolve for the compiler classpaths so we shouldn't use default resolvers in the places where we compute the classpath for the compiler (e.g. the compiler plugins and symbol processors).

The workarounds are here

Will follow up with some fixing PRs

[vaslabs]

@lihaoyi @lefou what would be the recommended way to de-couple the default resolver for android? I.e. need different resolution parameters for kotlin/java compiler plugins and different one for the android app compile classpath

EDIT: Further explanation

Take for example KSPModule . In order to not pollute the kotlin symbol processors classpath I've done

trait AndroidHiltLib extends AndroidKotlinLib with AndroidHiltSupport {
       def localResolver = Task.Anon {
    new CoursierModule.Resolver(
      repositories = repositoriesTask(),
      bind = bindDependency(),
      mapDependencies = Some(mapDependencies()),
      customizer = resolutionCustomizer(),
      coursierCacheCustomizer = coursierCacheCustomizer(),
      resolutionParams = resolutionParams(),
      offline = Task.offline,
      checkGradleModules = false
    )
  }

   override def kotlinSymbolProcessorsResolved: T[Seq[PathRef]] = Task {
    localResolver().classpath(
      kotlinSymbolProcessors()
    )
  }

}

so one way would be to add that into mill , in AndroidHiltSupport

Another way we've done so far is with an ExternalModule like we did for AndroidMerger

[lefou]

I think configuring one and assign it a good name (e.g. not "localResolver") sounds reasonable. Since a resolver typically should use the repos configured in the current module, sharing it in the trait seems to be preferable over an external module.

[vaslabs]

A Hilt issue appears when multiple modules are using hilt , a conflict appears for generatedSourcesWithKSP which seems to generate some classes twice/multiple times

error: [ksp] /home/vnicolaou/Pokedex_Compose_Multi_Module/out/app/generatedSourcesWithKSP.dest/generated/ksp/main/java/byRounds/4/com/nicos/pokedex_compose_multi_module/PokemonApplication_HiltComponents.java:127: [Dagger/MissingBinding] com.nicos.database.data.room_database.init_database.MyRoomDatabase cannot be provided without an @Provides-annotated method.
[1-470] 
[1-470]     com.nicos.database.data.room_database.init_database.MyRoomDatabase is injected at
[1-470]         [com.nicos.pokedex_compose_multi_module.PokemonApplication_HiltComponents.ViewModelC] com.nicos.network.data.repository_impl.PokemonDetailsRepositoryImpl(myRoomDatabase, …)
[1-470]     com.nicos.network.data.repository_impl.PokemonDetailsRepositoryImpl is injected at
[1-470]         [com.nicos.pokedex_compose_multi_module.PokemonApplication_HiltComponents.ViewModelC] com.nicos.compose_ui.pokemon_details_screen.PokemonDetailsViewModel(pokemonDetailsRepositoryImpl)
[1-470]     com.nicos.compose_ui.pokemon_details_screen.PokemonDetailsViewModel is injected at
[1-470]         [com.nicos.pokedex_compose_multi_module.PokemonApplication_HiltComponents.ViewModelC] com.nicos.compose_ui.pokemon_details_screen.PokemonDetailsViewModel_HiltModules.BindsModule.binds(p0)
[1-470]     @dagger.hilt.android.internal.lifecycle.HiltViewModelMap java.util.Map<java.lang.Class<?>,javax.inject.Provider<androidx.lifecycle.ViewModel>> is requested at
[1-470]         [com.nicos.pokedex_compose_multi_module.PokemonApplication_HiltComponents.ViewModelC] dagger.hilt.android.internal.lifecycle.HiltViewModelFactory.ViewModelFactoriesEntryPoint.getHiltViewModelMap() [com.nicos.pokedex_compose_multi_module.PokemonApplication_HiltComponents.SingletonC → com.nicos.pokedex_compose_multi_module.PokemonApplication_HiltComponents.ActivityRetainedC → com.nicos.pokedex_compose_multi_module.PokemonApplication_HiltComponents.ViewModelC]
[1-470] It is also requested at:
[1-470]     com.nicos.network.data.repository_impl.PokemonListRepositoryImpl(myRoomDatabase, …)
[1-470] error: [ksp] /home/vnicolaou/Pokedex_Compose_Multi_Module/out/app/generatedSourcesWithKSP.dest/generated/ksp/main/java/byRounds/4/com/nicos/pokedex_compose_multi_module/PokemonApplication_HiltComponents.java:127: [Dagger/MissingBinding] com.nicos.network.domain.remote.PokemonService cannot be provided without an @Provides-annotated method.

[vaslabs]

This seems to fix the issue:
s"apoption=dagger.hilt.internal.useAggregatingRootProcessor=false"

which apparently is the setting to use when generating hilt sources in isolation

it was the language version, I always forget about that

[vaslabs]

Managed to get it to work, issues weren't that serious, small things here and there, very useful app!

[vaslabs]

@souvlakias , let's start adding PRs to fix these small issues, test by removing the workarounds and when everything is fine, we can go for the app's unit and instrumented tests

[vaslabs]

proguard is also not working (minification, shrinking or any combination), but it needs a deeper investigation, will probably look at it separately from these small fixes