baselineprofile gradle plugin is not work properly. [307478189]

Fixed

Bug

Status Update

No update yet.

Description

ga...@linecorp.com

created issue #1

Oct 24, 2023 04:57PM

Continuing report from b/307473787

I tried to follow https://developer.android.com/topic/performance/baselineprofiles/create-baselineprofile#create-new-profile

And applied androidx.baselineprofile gradle plugin on my project.

But when I tried to perform gradle, and gradle failed like this.

$ git clone https://github.com/ganadist/VersionCodeDemo -b baselineprofile2
$ cd VersionCodeDemo
$ ./gradlew :app:tasks -S

...

Caused by: org.gradle.api.UnknownTaskException: Task with name 'mergeBetaBenchmarkReleaseArtProfile' not found in project ':app'.
	at org.gradle.api.internal.tasks.DefaultTaskCollection.createNotFoundException(DefaultTaskCollection.java:102)
	at org.gradle.api.internal.tasks.DefaultTaskCollection.createNotFoundException(DefaultTaskCollection.java:46)
	at org.gradle.api.internal.DefaultNamedDomainObjectCollection.named(DefaultNamedDomainObjectCollection.java:361)
	at org.gradle.api.internal.tasks.DefaultTaskCollection.named(DefaultTaskCollection.java:112)
	at androidx.baselineprofile.gradle.consumer.BaselineProfileConsumerAgpPlugin$onVariants$lastTaskProvider$applySourceSetsFunc$1.invoke(BaselineProfileConsumerPlugin.kt:336)
	at androidx.baselineprofile.gradle.consumer.BaselineProfileConsumerAgpPlugin$onVariants$lastTaskProvider$applySourceSetsFunc$1.invoke(BaselineProfileConsumerPlugin.kt:333)
	at androidx.baselineprofile.gradle.consumer.BaselineProfileConsumerAgpPlugin$onVariants$lastTaskProvider$2.invoke(BaselineProfileConsumerPlugin.kt:356)
	at androidx.baselineprofile.gradle.consumer.BaselineProfileConsumerAgpPlugin$onVariants$lastTaskProvider$2.invoke(BaselineProfileConsumerPlugin.kt:349)
	at androidx.baselineprofile.gradle.utils.AgpPlugin$configureWithAndroidPlugin$5.invoke(AgpPlugin.kt:169)
	at androidx.baselineprofile.gradle.utils.AgpPlugin$configureWithAndroidPlugin$5.invoke(AgpPlugin.kt:164)
	at androidx.baselineprofile.gradle.utils.AgpPlugin.configureWithAndroidPlugin$lambda$6(AgpPlugin.kt:164)
	at org.gradle.configuration.internal.DefaultUserCodeApplicationContext$CurrentApplication$1.execute(DefaultUserCodeApplicationContext.java:123)
	at org.gradle.api.internal.DefaultCollectionCallbackActionDecorator$BuildOperationEmittingAction$1.run(DefaultCollectionCallbackActionDecorator.java:110)
	at org.gradle.internal.operations.DefaultBuildOperationRunner$1.execute(DefaultBuildOperationRunner.java:29)
	at org.gradle.internal.operations.DefaultBuildOperationRunner$1.execute(DefaultBuildOperationRunner.java:26)
	at org.gradle.internal.operations.DefaultBuildOperationRunner$2.execute(DefaultBuildOperationRunner.java:66)
	at org.gradle.internal.operations.DefaultBuildOperationRunner$2.execute(DefaultBuildOperationRunner.java:59)
	at org.gradle.internal.operations.DefaultBuildOperationRunner.execute(DefaultBuildOperationRunner.java:157)
	at org.gradle.internal.operations.DefaultBuildOperationRunner.execute(DefaultBuildOperationRunner.java:59)
	at org.gradle.internal.operations.DefaultBuildOperationRunner.run(DefaultBuildOperationRunner.java:47)
	at org.gradle.internal.operations.DefaultBuildOperationExecutor.run(DefaultBuildOperationExecutor.java:73)
	at org.gradle.api.internal.DefaultCollectionCallbackActionDecorator$BuildOperationEmittingAction.execute(DefaultCollectionCallbackActionDecorator.java:107)
	at org.gradle.internal.ImmutableActionSet$SetWithFewActions.execute(ImmutableActionSet.java:285)
	at org.gradle.api.internal.DefaultDomainObjectCollection.doAdd(DefaultDomainObjectCollection.java:262)
	at org.gradle.api.internal.DefaultDomainObjectCollection.add(DefaultDomainObjectCollection.java:251)
	at com.android.build.gradle.AbstractAppExtension.addVariant(AbstractAppExtension.kt:64)
	at com.android.build.gradle.internal.ApiObjectFactory.create(ApiObjectFactory.java:126)

Component used:

Gradle : 8.4
Android Gradle Plugin: 8.2.0-rc01
Java: OpenJDK 17
Androidx Benchmark / Baseline Profile Plugin : 1.2.0

Devices/Android versions reproduced on: N/A

If this is a bug in the library, we would appreciate if you could attach:

Sample project to trigger the issue.
A screenrecord or screenshots showing the issue (if UI related).

Comments

cc...@google.com <cc...@google.com> Oct 24, 2023 05:00PM

Reassigned to ma...@google.com.

ma...@google.com <ma...@google.com> Oct 24, 2023 09:19PM

Accepted by ma...@google.com.

ma...@google.com <ma...@google.com> #2Oct 25, 2023 09:21PM

Marked as fixed.

Project: platform/frameworks/support
Branch: androidx-master-dev

commit c60f33e229e31ab328ef6b59dab63b264954831c
Author: Alexandre Elias <aelias@google.com>
Date: Fri Jul 10 16:23:09 2020

Semantics no-op cleanups

Partly in response to lmr's broad code review, I did a pass of
superficial API/implementation cleanup. The main changes are:

- I changed each Boolean SemanticsProperty where false is equivalent to
not being present to take "Unit" instead. This is conceptually
clearer: it avoids questions like "can I cancel out a semantics from a
merged child by setting it to false?" Because "property = Unit" looks
weird, I also changed the style of these to "property()".

- I moved the Semantics id generator closer to where it's used, in
SemanticsModifierCore. I made it internal and an AtomicInt.
(Note that integer ids are heavily used in the Android
AccessibilityNodeInfo APIs so I can't simply remove them entirely.)

- I deleted dead code. Some examples include SemanticsHintOverrides,
a public API not connected to anything, and SemanticsPropertyKey
merge() open method which is never called. (In both cases I have
a different plan in mind for accessibility.)

Fixes: 145951226
Fixes: 145955412
Test: existing tests
Relnote: "Single-value semantics properties now use a calling style.
For example, 'semantics { hidden = true }' is now written as:
'semantics { hidden() }'."

Change-Id: Ic1afd12ea22c926babc9662f1804d80b33aa0cfc

M ui/integration-tests/benchmark/src/androidTest/java/androidx/ui/benchmark/test/LayoutNodeModifierBenchmark.kt
M ui/ui-core/api/0.1.0-dev15.txt
M ui/ui-core/api/current.txt
M ui/ui-core/api/public_plus_experimental_0.1.0-dev15.txt
M ui/ui-core/api/public_plus_experimental_current.txt
M ui/ui-core/api/restricted_0.1.0-dev15.txt
M ui/ui-core/api/restricted_current.txt
M ui/ui-core/src/androidAndroidTest/kotlin/androidx/ui/graphics/vector/VectorTest.kt
M ui/ui-core/src/androidAndroidTest/kotlin/androidx/ui/semantics/SemanticsTests.kt
M ui/ui-core/src/androidMain/kotlin/androidx/ui/core/AndroidActuals.kt
M ui/ui-core/src/androidMain/kotlin/androidx/ui/core/AndroidComposeView.kt
M ui/ui-core/src/androidMain/kotlin/androidx/ui/core/AndroidComposeViewAccessibilityDelegateCompat.kt
M ui/ui-core/src/androidMain/kotlin/androidx/ui/core/AndroidPopup.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/Expect.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsConfiguration.kt
D ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsHintOverrides.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsModifier.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsNode.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsOwner.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsWrapper.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/semantics/SemanticsProperties.kt
M ui/ui-foundation/api/0.1.0-dev15.txt
M ui/ui-foundation/api/current.txt
M ui/ui-foundation/api/public_plus_experimental_0.1.0-dev15.txt
M ui/ui-foundation/api/public_plus_experimental_current.txt
M ui/ui-foundation/api/restricted_0.1.0-dev15.txt
M ui/ui-foundation/api/restricted_current.txt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/Clickable.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/Dialog.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/Scroller.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/selection/Selectable.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/selection/Toggleable.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/semantics/FoundationSemanticsProperties.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/ButtonTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/CardTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/CheckboxScreenshotTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/RadioButtonScreenshotTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/ScaffoldTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/SnackbarTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/SurfaceTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/ripple/RippleIndicationTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/textfield/TextFieldScreenshotTest.kt
M ui/ui-material/src/main/java/androidx/ui/material/AppBar.kt
M ui/ui-material/src/main/java/androidx/ui/material/TextFieldImpl.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/AssertsTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/CallSemanticsActionTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/ErrorMessagesTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/FindersTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/PrintToStringTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/ScrollToTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/TextActionsTest.kt
M ui/ui-test/src/main/java/androidx/ui/test/Actions.kt
M ui/ui-test/src/main/java/androidx/ui/test/Filters.kt
M ui/ui-text/api/0.1.0-dev15.txt
M ui/ui-text/api/current.txt
M ui/ui-text/api/public_plus_experimental_0.1.0-dev15.txt
M ui/ui-text/api/public_plus_experimental_current.txt
M ui/ui-text/api/restricted_0.1.0-dev15.txt
M ui/ui-text/api/restricted_current.txt
M ui/ui-text/src/commonMain/kotlin/androidx/ui/text/CoreTextField.kt
M ui/ui-text/src/commonMain/kotlin/androidx/ui/text/TextSemanticsProperties.kt

https://android-review.googlesource.com/1360099

ga...@linecorp.com <ga...@linecorp.com> #3Oct 26, 2023 01:30AM

In my case, I added several changes like this https://github.com/ganadist/VersionCodeDemo/compare/6849979a..861ad9691
And I can perform :app:generateProductionReleaseBaselineProfile successfully.

applying the com.android.test plugin to the baselineprofile module causes an exception for missing testImplementation configuration.

This was already guarded by https://github.com/ganadist/VersionCodeDemo/blob/baselineprofile2/build-logic/convention/src/main/kotlin/AndroidBuilderPlugin.kt#L53-L56 And it does not make error in my case.

That logic is disabling variants for with build types that are not release (and flavor not develop). Removing that logic should fix the issue.

I confirmed that :app:tasks can performed successfully with commenting out this block.
But filtering variants feature is introduced at https://developer.android.com/build/build-variants#filter-variants, and It is expected to be widely used.

ga...@linecorp.com <ga...@linecorp.com> #4Oct 26, 2023 04:02AM

applying the com.android.test plugin to the baselineprofile module causes an exception for missing testImplementation configuration.

This was already guarded by https://github.com/ganadist/VersionCodeDemo/blob/baselineprofile2/build-logic/convention/src/main/kotlin/AndroidBuilderPlugin.kt#L53-L56 And it does not make error in my case.

Hmm, it is strange.
I found this error occured while gradle project sync only, but it is okay when invoke gradle on command line.
I'm guessing that plugin Id is different when gradle is invoked from commandline and project sync from Android Studio.
Anyway, I'll handle about missing testImplementation configuration.

ga...@linecorp.com <ga...@linecorp.com> #5Oct 26, 2023 09:43AM

I added this logic to allow build types which are added by baselineprofile plugin.
https://github.com/ganadist/VersionCodeDemo/commit/efe2fd48a3

As I commented at #3 , variants filtering would be used widely.
So, https://developer.android.com/topic/performance/baselineprofiles/create-baselineprofile page should have information about added build type from plugin, and mention should be added not to ignore these build type.

Or please raise exception which has these information instead of UnknownTaskException

ma...@google.com <ma...@google.com> #6Oct 26, 2023 04:43PM

But filtering variants feature is introduced at https://developer.android.com/build/build-variants#filter-variants, and It is expected to be widely used.

Unfortunately, the plugin cannot prevent the user to disable a variant that is used for baseline profile generation. This is because build types are created in finalizeDsl, while variants can be disabled in beforeVariants that runs after. There are actually some hacky way to do this but supporting them would require api that are currently deprecated and not meant for public use (that means AGP can break them any time).

Improving the error message is already on my to-do list and will pass the task to the team to update the documentation.

Thank you for trying the baseline profile gradle plugin, if you encounter any other issue please don't hesitate to reach out.

ap...@google.com <ap...@google.com> #7Nov 9, 2023 07:17PM

Project: platform/frameworks/support
Branch: androidx-main

commit 0a3e9f8ceef5cb0ceffc8385346f45e86985f0aa
Author: Marcello Albano <maralb@google.com>
Date: Thu Oct 26 10:32:53 2023

Improved error msg when benchmark variants are disabled

Bug: 307478189
Test: ./gradlew :benchmark:benchmark-baseline-profile-gradle-plugin:test
Change-Id: I8536bc3c14bbf2d1ee165b3d3f55a3dec9ff61d7

M benchmark/baseline-profile-gradle-plugin/src/main/kotlin/androidx/baselineprofile/gradle/consumer/BaselineProfileConsumerPlugin.kt
M benchmark/baseline-profile-gradle-plugin/src/test/kotlin/androidx/baselineprofile/gradle/consumer/BaselineProfileConsumerPluginTest.kt

https://android-review.googlesource.com/2806414

pr...@google.com <pr...@google.com> #8Feb 21, 2024 07:32PM

The following release(s) address this bug.It is possible this bug has only been partially addressed:

androidx.benchmark:benchmark-baseline-profile-gradle-plugin:1.3.0-alpha01