Allow to configure sourceInformation from ComposeOptions [318384658]

Fixed

Feature Request

Status Update

No update yet.

Description

[Deleted User]

created issue #1

Jan 2, 2024 10:21PM

Compose Compiler has the option to disable sourceInformation generation as described in issue where ignoring of this option has been fixed.

kotlinOptions {
    freeCompilerArgs += listOf(
        "-P",
        "plugin:androidx.compose.compiler.plugins.kotlin:sourceInformation=false"
    )
}

But when i try to disable it using this option, project build fails, because there is a limit on the number of declared options. So sourceInformation cannot be declared multiply times as kotlin compiler option .

This option is already declared in kgpUtils.kt, and it is always enabled for debug builds. Therefore, i cannot disable it as liveLiterals, for example.

STEPS TO REPRODUCE:

Disable sourceInformation using freeCompilerArgs
Try to build a project
There will be a crash

> Task :app:compileDebugKotlin FAILED
e: Multiple values are not allowed for plugin option androidx.compose.compiler.plugins.kotlin:sourceInformation

Studio Build: #AI-231.9392.1.2311.10980684

Version of Gradle Plugin: 8.2.0-rc02

Version of Gradle: 8.2

Comments

cm...@google.com <cm...@google.com> Jan 3, 2024 12:14PM

Assigned to an...@google.com.

[Deleted User] <[Deleted User]> #2Jan 3, 2024 02:20PM

Fixed here

je...@google.com <je...@google.com> Jan 3, 2024 09:16PM

Reassigned to hu...@google.com.

hu...@google.com <hu...@google.com> #3Jan 16, 2024 10:09AM

Thank you for this report and the proposed fix in comment #2. I'm trying an alternative fix, it's going through code review:

// kgpUtils.kt
private fun KotlinCompile.addPluginOption(pluginId: String, key: String, value: String) {
    val pluginOption = "plugin:$pluginId:$key"

    // Only add the plugin option if it was not previously added by the user (see b/318384658)
    if (kotlinOptions.freeCompilerArgs.none { it.startsWith("$pluginOption=") }) {
        kotlinOptions.freeCompilerArgs += listOf("-P", "$pluginOption=$value")
    }
}

[Deleted User] <[Deleted User]> #4Jan 16, 2024 11:54AM

comment #3 Hi. A good one, but i guess, alternative fix can fail sometimes when clients add options after project evaluation or snippet with fix executes before adding option by client

hu...@google.com <hu...@google.com> #5Jan 17, 2024 03:09AM

Marked as fixed.

We've fixed this issue in AGP 8.4.0-alpha05: https://android.googlesource.com/platform/tools/base/+/0f36999a1a5b0063b10e5aa0389303e39b23289b

Note that this fix works for KGP 1.8+ only (it seems that in earlier KGPs, the plugin options set in the DSL do not propagate to KotlinCompile.pluginOptions correctly).

======

Re comment #4: You're right, it doesn't work for corner cases, but I wonder whether they are cases that AGP should support. The fix above is probably good enough to unblock you for now, and we can revisit this issue if it comes up again in other cases.

[Deleted User] <[Deleted User]> #6Jan 17, 2024 07:39AM

comment #5 Thank you

an...@google.com <an...@google.com> #7Jan 22, 2024 06:08PM

Thank you for your patience while our engineering team worked to resolve this issue. A fix for this issue is now available in:

Android Studio Jellyfish | 2023.3.1 Canary 5
Android Gradle Plugin 8.4.0-alpha05

We encourage you to try the latest update.

If you notice further issues or have questions, please file a new bug report.

Thank you for taking the time to submit feedback — we really appreciate it!

hu...@google.com <hu...@google.com> #8Feb 3, 2025 03:21PM

Small note: The handling code for androidx.compose.compiler.plugins.kotlin:sourceInformation has changed slightly, see https://youtrack.jetbrains.com/issue/KT-74415/ for the latest updates.