[AGP] Add generated source directory to IDE model (Variant API) [232805583]

Fixed

Bug

Status Update

No update yet.

Description

[Deleted User]

created issue #1

May 17, 2022 10:51AM

The new Variant API SourceDirectoriesImpl.addGeneratedSourceDirectory() allows to add a custom task generating source files that need to be compiled within the build process, but does not add the generated source directory to the IDE model in TaskProviderBasedDirectoryEntryImpl.

It is used in replacement of the old API BaseVariantImpl.registerJavaGeneratingTask() that automatically added the generated source directories to the IDE model.

It seems to me that the old behavior should be maintained, i.e., either:

set shouldBeAddedToIdeModel to true by default in the constructor of TaskProviderBasedDirectoryEntryImpl,
pass shouldBeAddedToIdeModel = true when creating TaskProviderBasedDirectoryEntryImpl in addGeneratedSourceDirectory,
add an optional argument to addGeneratedSourceDirectory for letting the user set the desired value of shouldBeAddedToIdeModel.

Note that it should go the same way with SourceDirectoriesImpl.addStaticSourceDirectory().

Also, I would personally not set the path of the output directory here if it has already been set by the user before calling addGeneratedSourceDirectory, since this overwriting is not documented and not obvious to the user. Or similarly to shouldBeAddedToIdeModel, this behavior (setting or not the output directory) could be controlled through an optional argument to addGeneratedSourceDirectory.

Please consider this other issue too that might be relevant as well (I did not try to reproduce it), it apppears not only in TaskProviderBasedDirectoryEntryImpl but also in ProviderBasedDirectoryEntryImpl.

Studio Build: #AI-213.7172.25.2211.8571212 (Android Studio Electric Eel | 2022.1.1 Canary 2)

Version of Gradle Plugin: 7.4.0-alpha02

Version of Gradle: 7.5-rc-1

Version of Java: 1.8

OS: Ubuntu 18.04

Comments

mk...@google.com <mk...@google.com> May 18, 2022 12:05PM

Assigned to an...@google.com.

je...@google.com <je...@google.com> #2May 24, 2022 08:02PM

Reassigned to al...@google.com.

Will be this fix also part of 4.2 please?

al...@google.com <al...@google.com> Jun 3, 2022 03:53PM

Accepted by al...@google.com.

[Deleted User] <[Deleted User]> #3Jul 1, 2022 06:56PM

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.

al...@google.com <al...@google.com> #4Jul 22, 2022 06:50PM

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?

al...@google.com <al...@google.com> #5Sep 16, 2022 11:13PM

Marked as fixed.

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?

mi...@gmail.com <mi...@gmail.com> #6Sep 18, 2022 01:17PM

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

cm...@google.com <cm...@google.com> #7Oct 10, 2022 04:54PM

Accepted by cm...@google.com.

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.

cm...@google.com <cm...@google.com> #8Oct 12, 2022 03:03PM

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.

fr...@gmail.com <fr...@gmail.com> #9Oct 13, 2022 03:50PM

Thanks, Jerome!