Inconsistent test failure due to partial analysis [188814760]

Fixed

Bug

Status Update

No update yet.

Description

al...@google.com

created issue #1

May 20, 2021 07:40PM

Jetpack uses a lint check to prevent cross-group usage of the @RequiresOptIn annotation. The implementation is similar to @RestrictToDetector's enforcement of LIBRARY_GROUP, but our check fails provisional checks on alternating runs even though they seem to be reporting as expected.

We've logged some data to figure out what's going on when using ./gradlew :lint-checks:test --rerun-tasks.

For a failing run, we see:

androidx.build.lint.BanInappropriateExperimentalUsageTest > Test cross-module Experimental usage via Gradle model STANDARD_OUT
    GLOBAL: used sample.annotation.provider.ExperimentalSampleAnnotationJava in consumer
    GLOBAL: report usage of sample.annotation.provider in androidx.sample.consumer
    GLOBAL: declared sample.annotation.provider.ExperimentalSampleAnnotationJava in provider
    GLOBAL: declared sample.annotation.provider.ExperimentalSampleAnnotation in provider
    GLOBAL: used sample.annotation.provider.ExperimentalSampleAnnotationJava in consumer
    GLOBAL: report usage of sample.annotation.provider in androidx.sample.consumer
    GLOBAL: declared sample.annotation.provider.ExperimentalSampleAnnotationJava in provider
    GLOBAL: declared sample.annotation.provider.ExperimentalSampleAnnotation in provider
    ANALYSIS_ONLY: declared sample.annotation.provider.ExperimentalSampleAnnotationJava in provider
    ANALYSIS_ONLY: declared sample.annotation.provider.ExperimentalSampleAnnotation in provider
    ANALYSIS_ONLY: used sample.annotation.provider.ExperimentalSampleAnnotationJava in consumer
    ANALYSIS_ONLY: report usage of sample.annotation.provider in androidx.sample.consumer

androidx.build.lint.BanInappropriateExperimentalUsageTest > Test cross-module Experimental usage via Gradle model FAILED
    org.junit.ComparisonFailure: Lint results computed provisionally do
    not match those computed without provisional support enabled.
    ...
    You can then check each output by passing in a `testType` parameter
    to `expect`(...). expected:<[UInjectionHost Enabled:

    ../consumer/src/main/kotlin/androidx/sample/consumer/OutsideGroupExperimentalAnnotatedClass.kt:25: Error: Experimental and RequiresOptIn APIs may only be used within the  same-version group where they were defined. [IllegalExperimentalApiUsage]
        @ExperimentalSampleAnnotationJava
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    1 errors, 0 warnings
    ]> but was:<[Automatic Partial Analysis and Merging:

    No warnings.]>

The next run, however, passes:

androidx.build.lint.BanInappropriateExperimentalUsageTest > Test cross-module Experimental usage via Gradle model STANDARD_OUT
    GLOBAL: used sample.annotation.provider.ExperimentalSampleAnnotationJava in consumer
    GLOBAL: report usage of sample.annotation.provider in androidx.sample.consumer
    GLOBAL: declared sample.annotation.provider.ExperimentalSampleAnnotationJava in provider
    GLOBAL: declared sample.annotation.provider.ExperimentalSampleAnnotation in provider
    GLOBAL: used sample.annotation.provider.ExperimentalSampleAnnotationJava in consumer
    GLOBAL: report usage of sample.annotation.provider in androidx.sample.consumer
    GLOBAL: declared sample.annotation.provider.ExperimentalSampleAnnotationJava in provider
    GLOBAL: declared sample.annotation.provider.ExperimentalSampleAnnotation in provider
    ANALYSIS_ONLY: declared sample.annotation.provider.ExperimentalSampleAnnotationJava in provider
    ANALYSIS_ONLY: declared sample.annotation.provider.ExperimentalSampleAnnotation in provider
    ANALYSIS_ONLY: used sample.annotation.provider.ExperimentalSampleAnnotationJava in consumer
    ANALYSIS_ONLY: report usage of sample.annotation.provider in androidx.sample.consumer

androidx.build.lint.BanInappropriateExperimentalUsageTest > Test cross-module Experimental usage via Gradle model PASSED

The next run fails, and so on.

Comments

al...@google.com <al...@google.com> #2May 20, 2021 07:42PM

Assigned to tn...@google.com.

Thanks for reporting, would you be able to provide a reproducible case for when this incremental error occurs? The task for merging java resources has multiple incremental inputs depending on where the java resource originates - providing a sample project where this issue can be triggered will help the team narrow what task input is impacted. A longer stacktrace of the issue from #1 might also be useful.

Message last modified on May 21, 2021 01:44AM

al...@google.com <al...@google.com> #3May 21, 2021 01:50AM

Reassigned to al...@google.com.

Comment has been deleted.

Message last modified on May 21, 2021 02:16AM

al...@google.com <al...@google.com> #4May 21, 2021 02:12AM

Reassigned to tn...@google.com.

Comment has been deleted.

Message last modified on May 21, 2021 02:16AM

tn...@google.com <tn...@google.com> #5Jan 28, 2022 12:44AM

Yes, our setup looks like this:

:features
  :feature1
    :public
    :impl
  :feature2
    :public
    :impl
...

The modules mentioned in the error would always be one of these impl or public modules.

Unfortunately I cannot share our project and even if I could, I don't know how to replicate the issue.

I will say though that since upgrading to the latest AGP 8.2 alpha I have not seen the issue so it's possible that it's already been fixed as a part of another change.

al...@google.com <al...@google.com> #6Jan 28, 2022 12:45AM

Oops, spoke too soon. It just happened.

Once it happens ever run will trigger it so if you need me to log or try something let me know. Removing the app level build directory fixes the issue.

tn...@google.com <tn...@google.com> #7Jan 28, 2022 01:30AM

BTW, what is the target release for this fix?

al...@google.com <al...@google.com> #8Jan 28, 2022 07:26PM

Status: Won't Fix (Obsolete)

For now, we've worked around this by adding this to our Kotlin convention plugin:

tasks.withType<KotlinCompile>().configureEach {
    compilerOptions {
        moduleName.set(path.removePrefix(":").replace(":", "_"))
    }
}

au...@google.com <au...@google.com> #9Feb 1, 2022 06:30PM

Status: Assigned (reopened)

Thanks for sharing the workaround. I needed to slightly adapt it to work for us, otherwise kapt and ksp would fail because they'd expect different names for internal symbols.

tasks.withType(org.jetbrains.kotlin.gradle.tasks.KotlinCompilationTask.class).configureEach {
    if (!name.containsIgnoreCase("ksp") && !name.containsIgnoreCase("kapt")) {
       compilerOptions {
       moduleName.set(path.substring(1).replace(":", "_"))
    }
}

al...@google.com <al...@google.com> #10Feb 1, 2022 06:35PM

Actually, I found a better way to solve this. The default module name is based on the base plugin's archivesName property. So you can do this instead:

base {
    archivesName.set(path.removePrefix(":").replace(":", "_"))
}

pa...@google.com <pa...@google.com> #11Oct 5, 2023 01:55PM

It seems AGP is not correctly excluding kotlin_module files during java resource merging, so we'd expect a collision - although this error message isn't clear.

Until we release we have a fix for the issue, a workaround may be to add packagingOptions { exclude 'META-INF/*.kotlin_module' } to the build.gradle conflicting libraries, so AGP doesn't attempt to merge them.

pa...@google.com <pa...@google.com> Oct 9, 2023 06:59PM

Reassigned to pa...@google.com.

pa...@google.com <pa...@google.com> #12Oct 10, 2023 05:03PM

Alternatively you can give them unique names e.g.

kotlin {
    compilerOptions {
        moduleName.set(project.path)
    }
}

applied to all projects

pa...@google.com <pa...@google.com> #13Oct 11, 2023 12:49PM

We set the module to the dashified project gradle path. Kinda feel like this should be the default for the module merging issue in general

pa...@google.com <pa...@google.com> Oct 16, 2023 07:01PM

Marked as fixed.

an...@google.com <an...@google.com> #14Oct 20, 2023 12:44AM

In my case, I had similar errors with MergeJavaResourcesTask
But in my case, errors were against for META-INF metadata from Google AutoService instead of kotlin-module

And I did set same workaround with Comment #8, then errors were gone.