Lint: PartialResults merging works incorrectly [239337003]

Fixed

Bug

Status Update

No update yet.

Description

li...@gmail.com

created issue #1

Jul 18, 2022 04:46PM

DESCRIBE THE ISSUE IN DETAIL:

STEPS TO REPRODUCE:

Download project from the attach;
Run ./gradlew :app:lintDebug and observe 2 issues;
Run ./gradlew :lint-checks:test and observe tests failing.

It looks like PartialResult#map doesn't follow the contract in unit tests. It claims to return LintMap for the project in context, but under the certain condition it seems to be violated.

The conditions require multimodule setup. A library module must put smth into its LintMap. Then, when the app module accesses its own LintMap for the first time it get a map prefilled with the data from the library module, instead of the fresh one.

To demonstrate the issue I created the following setup:

An :app module and a :library module;
:app module contains app_color color resource, while :library module contains :library_color;
I created a simple detector, which works only in partial analysis mode and does a simple thing: detects the color resource declaration within the module, puts into the partial results and then reports all colors found per module in checkPartialResults method;
There's a unit test, which mimics the same setup.

If you run lint checks using the ./gradlew :app:lintDebug command, you'll observe Lint correctly reporting app_color found in :app and library_color found in :library. However, if you run the unit tests, you'll observe that Lint also reports a library_color found in the :app.

It looks like while scanning the :app module, the first access to partial results, causes LintCliClient to create new instance of results and fill it with results of the dependent module (see LintCliClient#getPartialResults method). For some reason this is happening only in tests.

The replacement of the getPartialResult.map() method call with getPartialResult.mapFor(context.project) method call successfully addresses the issue.

There's still a chance, that my test is wrong. In this case, would be great to know in which way.

Studio Build: Chipmunk | 2021.2.1 Version of Gradle Plugin: 7.2.1, 7.4.0-alpha08 Version of Gradle: 7.4.2 OS: Mac OS Monteray 12.4

LintBug2.zip

803 KB

Download

Comments

li...@gmail.com <li...@gmail.com> #2Jul 18, 2022 04:58PM

Will be this fix also part of 4.2 please?

ch...@google.com <ch...@google.com> Jul 20, 2022 01:09PM

Assigned to an...@google.com.

li...@gmail.com <li...@gmail.com> #3Jul 20, 2022 03:45PM

for the "out" bundle issue, this seems indeed an issue. for the second one reported adding "debugUpdateAPKArtifact" to the path, this WAI as there can more more than one transformer and we need to automatically separate them so they do not use the same output folder. for #3, I will look at it but it might be difficult to change it at this time.

je...@google.com <je...@google.com> Jul 26, 2022 01:20AM

Reassigned to sp...@google.com.

sp...@google.com <sp...@google.com> #4Jul 26, 2022 05:00PM

Reassigned to ra...@google.com.

I understand that if there is more transformer is necessary to make every folder different, but there is the main problem, that the final one (last transform) is inside of the intermediate folder. The last transformation should end in the standard location, right? Maybe also with the default name not?

ra...@google.com <ra...@google.com> Aug 15, 2022 06:32PM

Reassigned to pa...@google.com.

pa...@google.com <pa...@google.com> Aug 30, 2022 11:11AM

Reassigned to pa...@google.com.

pa...@google.com <pa...@google.com> #5Aug 30, 2022 07:38PM

Hello, this is a P1 S1 issue for a while now, and it's blocking us from upgrading to AGP 4.2 and further. What's the current status? And do you have plans to backport it to 4.2.x?

li...@gmail.com <li...@gmail.com> #6Sep 9, 2022 12:14PM

no we don't have a plan to backport this. why is this blocking you from upgrading ?

pa...@google.com <pa...@google.com> #7Sep 23, 2022 11:46AM

We sign apk's and bundles via internal service, and i don't know another way to interact with artifacts; Yesterday i ended up with some ugly workaround: https://github.com/avito-tech/avito-android/pull/1085/files#diff-b898cc20fedebe394439bb37ffb91d3366a1f9a6d359dbdebca79af8a079f911 I'd be glad if you'll point me out how can it be done better.

pa...@google.com <pa...@google.com> #8Oct 25, 2022 09:34AM

Marked as fixed.

I commented on the merge request but to summarize :

you can set your signing tasks output folder to wherever you need to be :

artifacts.use(target.tasks.signedApkTaskProvider(this)).configure { signedDirProperty.set(File("/path/to/where/you/want/your/signed/files")) }

if you don't set it, then we will set a directory automatically.

li...@gmail.com <li...@gmail.com> #9Nov 1, 2022 04:59PM

Thanks, Jerome!

sa...@google.com <sa...@google.com> #10Nov 2, 2022 05:32PM

I checked that we do have correct behavior for FILE based artifacts like bundle :

> Task :app:debugUpdateArtifact
originalArtifact: /usr/local/google/home/jedo/src/studio-main/out/apiTests/Kotlin/bugTest/app/build/intermediates/bundle/debug/signDebugBundle/app-debug.aab
updatedArtifact: /usr/local/google/home/jedo/src/studio-main/out/apiTests/Kotlin/bugTest/app/build/outputs/bundle/debug/app-debug.aab

however, we still seem to not be consistent for the DIRECTORY based artifacts like APK:

> Task :app:debugUpdateAPKArtifact
Input folder: /usr/local/google/home/jedo/src/studio-main/out/apiTests/Kotlin/bugTest/app/build/outputs/apk/debug
Output folder: /usr/local/google/home/jedo/src/studio-main/out/apiTests/Kotlin/bugTest/app/build/intermediates/apk/debug
Input file: /usr/local/google/home/jedo/src/studio-main/out/apiTests/Kotlin/bugTest/app/build/outputs/apk/debug/app-debug.apk

Alex, can you have a look ?

sa...@google.com <sa...@google.com> #11Nov 3, 2022 01:42PM

correction, I was not correct about FILE being correct.

Instead of :

updatedArtifact: /usr/local/google/home/jedo/src/studio-main/out/apiTests/Kotlin/bugTest/app/build/outputs/bundle/debug/app-debug.aab

it should be

updatedArtifact: /usr/local/google/home/jedo/src/studio-main/out/apiTests/Kotlin/bugTest/app/build/outputs/app-debug.aab
``

li...@gmail.com <li...@gmail.com> #12Jan 13, 2023 03:51PM

Two requests are created as they are API changes b/241581686 (set artifact name for transformation) and b/241582907 (change string to OutputFile)

Message last modified on Jan 13, 2023 03:56PM

pa...@google.com <pa...@google.com> Jan 13, 2023 03:54PM

Status: Assigned (reopened)

pa...@google.com <pa...@google.com> #13Jan 18, 2023 05:45PM

Marked as fixed.

Fix will be available in Android Studio F/AGP 8.0 Canary 2 Release

li...@gmail.com <li...@gmail.com> #14May 9, 2023 12:04PM

Comment has been deleted.

Message last modified on May 9, 2023 12:06PM

li...@gmail.com <li...@gmail.com> #15May 9, 2023 12:06PM

The big issue is, that the current AGP 7.4.0 is broken. I tried to use this API and it is still broken in 7.4.0, it is probably really in AGP 8 :-(