Add support for Jetpack Compose

[changusmc]

Related to #239 but this issue is to specifically call out support for Jetpack Compose.

From previous conversations in BazelBuild Slack

I think we can support Jetpack Compose in the kotlin rules without vast changes. It'll need a better kotlin plugin architecture, but nothing that seems insane.
If you have kt_plugin() then you should be able to setup a jetpack compose plugin target, then use "plugins=" to consume them, similarly to how you'd do dagger, or auto-value, with java_plugin.

[cgruber]

This is great. As mentioned, this should be essentially fixed by #239 but any separate issues can be tracked here.

[Kernald]

I started taking a look at this, and had a first issue: it looks like the plugin is somehow trying to add itself as a dependency?

ERROR: /Users/kernald/dev/monos/java/fr/enoent/experimental/android/compose/BUILD:11:15: in deps attribute of android_binary rule //java/fr/enoent/experimental/android/compose:compose: Dependencies on .jar artifacts are not allowed in Android binaries, please use a java_import to depend on external/maven/v1/https/maven.google.com/androidx/compose/compose-compiler/0.1.0-dev12/compose-compiler-0.1.0-dev12.jar. If this is an implicit dependency then the rule that introduces it will need to be fixed to account for it correctly.. Since this rule was created by the macro 'android_binary', the error might have been caused by the macro implementation
ERROR: Analysis of target '//java/fr/enoent/experimental/android/compose:compose' failed; build aborted: Analysis of target '//java/fr/enoent/experimental/android/compose:compose' failed

This is with the following BUILD:

load("//java/rules:defs.bzl", "kt_android_library")
load("@rules_android//android:rules.bzl", "android_binary", "android_library")

android_library(
    name = "res",
    srcs = [],
    manifest = "AndroidManifest.xml",
    resource_files = glob(["res/**"]),
)

android_binary(
    name = "compose",
    manifest = "AndroidManifest.xml",
    manifest_values = {
        "applicationId": "fr.enoent.android.experimental.compose",
    },
    multidex = "native",
    deps = [
        ":res",
        ":compose_activity",
    ],
)

kt_android_library(
    name = "compose_activity",
    srcs = [
        "ComposeActivity.kt",
    ],
    plugins = [
        "//third_party/androidx/compose:compose_compiler",
    ],
    manifest = "AndroidManifest.xml",
    deps = [
        ":res",
        "@maven//:androidx_appcompat_appcompat",
        "@maven//:androidx_compose_compose_runtime",
    ],
)

And //third_party/androidx/compose/BUILD:

load("@io_bazel_rules_kotlin//kotlin:kotlin.bzl", "kt_compiler_plugin")

kt_compiler_plugin(
    name = "compose_compiler",
    visibility = ["//visibility:public"],
    deps = [
        "@maven//:androidx_compose_compose_compiler",
    ],
)

Building the activity target that actually has the plugin dependency also triggers a different error: a version compatibility issue. I'm using kotlinc 1.3.72 (also tried with 1.3.70 with the same result) and compose 0.1.0-dev12. Here's the stacktrace in case I'm missing something:

ERROR: /Users/kernald/dev/monos/java/fr/enoent/experimental/android/compose/BUILD:23:19: Compiling Kotlin to JVM //java/fr/enoent/experimental/android/compose:compose_activity_kt { kt: 1, java: 0, srcjars
: 0 } failed (Exit 2)
exception: java.lang.IllegalStateException: The provided plugin androidx.compose.plugins.kotlin.ComposeComponentRegistrar is not compatible with this version of compiler
        at org.jetbrains.kotlin.cli.jvm.compiler.KotlinCoreEnvironment$Companion.registerExtensionsFromPlugins$cli(KotlinCoreEnvironment.kt:577)
        at org.jetbrains.kotlin.cli.jvm.compiler.KotlinCoreEnvironment$ProjectEnvironment.registerExtensionsFromPlugins(KotlinCoreEnvironment.kt:135)
        at org.jetbrains.kotlin.cli.jvm.compiler.KotlinCoreEnvironment.<init>(KotlinCoreEnvironment.kt:175)
        at org.jetbrains.kotlin.cli.jvm.compiler.KotlinCoreEnvironment.<init>(KotlinCoreEnvironment.kt:115)
        at org.jetbrains.kotlin.cli.jvm.compiler.KotlinCoreEnvironment$Companion.createForProduction(KotlinCoreEnvironment.kt:427)
        at org.jetbrains.kotlin.cli.jvm.K2JVMCompiler.createCoreEnvironment(K2JVMCompiler.kt:219)
        at org.jetbrains.kotlin.cli.jvm.K2JVMCompiler.doExecute(K2JVMCompiler.kt:150)
        at org.jetbrains.kotlin.cli.jvm.K2JVMCompiler.doExecute(K2JVMCompiler.kt:51)
        at org.jetbrains.kotlin.cli.common.CLICompiler.execImpl(CLICompiler.kt:85)
        at org.jetbrains.kotlin.cli.common.CLICompiler.execImpl(CLICompiler.kt:43)
        at org.jetbrains.kotlin.cli.common.CLITool.exec(CLITool.kt:105)
        at io.bazel.kotlin.compiler.BazelK2JVMCompiler.exec(BazelK2JVMCompiler.kt:30)
        at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
        at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
        at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
        at java.base/java.lang.reflect.Method.invoke(Method.java:566)
        at io.bazel.kotlin.builder.toolchain.KotlinToolchain$KotlinCliToolInvoker.compile(KotlinToolchain.kt:130)
        at io.bazel.kotlin.builder.tasks.jvm.Compilation_taskKt$compileKotlin$1$1.invoke(compilation_task.kt:151)
        at io.bazel.kotlin.builder.tasks.jvm.Compilation_taskKt$compileKotlin$1$1.invoke(compilation_task.kt)
        at io.bazel.kotlin.builder.toolchain.CompilationTaskContext.executeCompilerTask(CompilationTaskContext.kt:122)
        at io.bazel.kotlin.builder.toolchain.CompilationTaskContext.executeCompilerTask$default(CompilationTaskContext.kt:118)
        at io.bazel.kotlin.builder.tasks.jvm.Compilation_taskKt.compileKotlin(compilation_task.kt:151)
        at io.bazel.kotlin.builder.tasks.jvm.KotlinJvmTaskExecutor$execute$1$$special$$inlined$apply$lambda$1.invoke(KotlinJvmTaskExecutor.kt:52)
        at io.bazel.kotlin.builder.tasks.jvm.KotlinJvmTaskExecutor$execute$1$$special$$inlined$apply$lambda$1.invoke(KotlinJvmTaskExecutor.kt:33)
        at io.bazel.kotlin.builder.toolchain.CompilationTaskContext.execute(CompilationTaskContext.kt:146)
        at io.bazel.kotlin.builder.toolchain.CompilationTaskContext.execute(CompilationTaskContext.kt:138)
        at io.bazel.kotlin.builder.tasks.jvm.KotlinJvmTaskExecutor$execute$1.invoke(KotlinJvmTaskExecutor.kt:50)
        at io.bazel.kotlin.builder.tasks.jvm.KotlinJvmTaskExecutor$execute$1.invoke(KotlinJvmTaskExecutor.kt:33)
        at io.bazel.kotlin.builder.toolchain.CompilationTaskContext.execute(CompilationTaskContext.kt:146)
        at io.bazel.kotlin.builder.toolchain.CompilationTaskContext.execute(CompilationTaskContext.kt:138)
        at io.bazel.kotlin.builder.tasks.jvm.KotlinJvmTaskExecutor.execute(KotlinJvmTaskExecutor.kt:44)
        at io.bazel.kotlin.builder.tasks.KotlinBuilder.executeJvmTask(KotlinBuilder.kt:216)
        at io.bazel.kotlin.builder.tasks.KotlinBuilder.apply(KotlinBuilder.kt:119)
        at io.bazel.kotlin.builder.tasks.PersistentWorker.run(BazelWorker.kt:168)
        at io.bazel.kotlin.builder.tasks.BazelWorker.apply(BazelWorker.kt:74)
        at io.bazel.kotlin.builder.KotlinBuilderMain.main(KotlinBuilderMain.java:28)
Caused by: java.lang.AbstractMethodError: Receiver class androidx.compose.plugins.kotlin.ComposeComponentRegistrar does not define or inherit an implementation of the resolved method 'abstract void regist
erProjectComponents(com.intellij.mock.MockProject, org.jetbrains.kotlin.config.CompilerConfiguration)' of interface org.jetbrains.kotlin.compiler.plugin.ComponentRegistrar.
        at org.jetbrains.kotlin.cli.jvm.compiler.KotlinCoreEnvironment$Companion.registerExtensionsFromPlugins$cli(KotlinCoreEnvironment.kt:569)
        ... 35 more

[cgruber]

So there are two issues here - one is that somehow you're relying on a .jar artifact rather than an import (java_import or kt_jvm_import). It's not clear how that's happening, but that can be tracked down.

The second issue is that the version of the compose plugin is not compatible with that version of kotlinc, so I would check the versions carefully and make sure they line up - it's possible this second problem is a misleading side-effect of the .jar artifact leakage.

Can you do a bazel query between the plugin jar and teh app binary (somepath() I mean) and see what that output is? I'm curious if it really is trying to add itself as a dependency, or if that's a misinterpretation of the error output.

[Kernald]

This is what query tells:

➜ bazel query "somepath(//java/fr/enoent/experimental/android/compose:compose, @maven//:androidx_compose_compose_compiler)"
//java/fr/enoent/experimental/android/compose:compose
//java/fr/enoent/experimental/android/compose:compose_activity
//java/fr/enoent/experimental/android/compose:compose_activity_kt
//third_party/androidx/compose:compose_compiler
@maven//:androidx_compose_compose_compiler
Loading: 4 packages loaded

[Kernald]

Reading #319, I tried wrapping the plugin in a kt_jvm_import (I'm fetching it through rules_jvm_external), which gives this path:

➜ bazel query "somepath(//java/fr/enoent/experimental/android/compose:compose, @maven//:androidx_compose_compose_compiler)"
//java/fr/enoent/experimental/android/compose:compose
//java/fr/enoent/experimental/android/compose:compose_activity
//java/fr/enoent/experimental/android/compose:compose_activity_kt
//third_party/androidx/compose:compose_compiler
//third_party/androidx/compose:compiler_import
@maven//:androidx_compose_compose_compiler

But still causes the same error.

[Kernald]

Updating to Compose 0.1.0-dev13 fixed the plugin compatibility issue. I can now build the activity target. I guess what's left here is the same issue as #319.

Edit: my bad, this is not true. Somehow, building :compose_activity works fine, but building :compose_activity_kt fails with the same compiler incompatibility as before.

[alexjlockwood]

@Kernald were you ever able to get compose working with bazel?

[Kernald]

@alexjlockwood I haven't. My understanding is that old versions of Compose required a patched version of the Kotlin compiler, which might be easy enough to get to work, but these Bazel rules do not work yet with the Kotlin 1.4 compiler, which is now required by Compose. I'm waiting on that to give it another try.

[alexjlockwood]

@Kernald Interesting. I was expecting the main issue to be that (as far as I know) it's not currently possible to pass target-level kotlinc compiler flags? And that would seem to be necessary as Compose requires -Xuse-ir to be passed? #23

[Kernald]

@alexjlockwood you might be entirely right - I haven't looked into that in quite a while, to be honest.