How to configure benchmark build type created by BPGP [324837887]

Fixed

Feature Request

Status Update

No update yet.

Description

ml...@google.com

created issue #1

Feb 12, 2024 10:04AM

Baseline Profile Gradle Plugin (BPGP) creates custom build types that are properly set up to generate optimal baseline profiles.

There's no way though to tweak the configuration to app's specific needs and prevent creating duplicate confusing build types.

Consider the example from Now in Android where each build type added applicationIdSuffix.

Either the application has duplicate build types benchmarkBenchmark, or there's no way to define applicationIdSuffix in benchmark build type generated by BPGP.

I think we should allow developers telling BPGP to either: a) define their own benchmark build type b) allowing customization of the benchmark build type created by BPGP.

Comments

ma...@google.com <ma...@google.com> #2Apr 8, 2024 09:33PM

Reassigned to ml...@google.com.

Any suggestions on where such an interface might live? I don't think it makes sense for the interface to be in the drawerlayout artifact if you're specifically going to use the interface to *not* use DrawerLayout.

Message last modified on Apr 8, 2024 09:36PM

ma...@google.com <ma...@google.com> #3Apr 8, 2024 11:39PM

Reassigned to ma...@google.com.

androidx.customview would be a good candidate. This is used by all of the widget libraries.

Message last modified on Apr 8, 2024 11:39PM

ml...@google.com <ml...@google.com> #4Apr 9, 2024 07:43AM

Reassigned to be...@google.com.

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

commit 3ed3fb003fa6c1244f923202859a616225b5b2fa
Author: Ian Lake <ilake@google.com>
Date: Fri Feb 14 11:17:46 2020

Create an interface for layouts that can be opened

Create a common interface that represents layouts
that have two states: open and closed. This allows
higher level libraries to rely on the interface,
rather than concrete implementations such as
DrawerLayout, making them more resilient to
changes in the current recommended implementation.

Fixes: 129979320
Test: ./gradlew checkApi
Change-Id: I0f2a1414977825aa053c6555261f2b7d4417bd19

M customview/customview/api/1.1.0-alpha02.txt
M customview/customview/api/current.txt
M customview/customview/api/public_plus_experimental_1.1.0-alpha02.txt
M customview/customview/api/public_plus_experimental_current.txt
M customview/customview/api/restricted_1.1.0-alpha02.txt
M customview/customview/api/restricted_current.txt
A customview/customview/src/main/java/androidx/customview/widget/Openable.java
M drawerlayout/drawerlayout/api/1.1.0-alpha03.txt
M drawerlayout/drawerlayout/api/current.txt
M drawerlayout/drawerlayout/api/public_plus_experimental_1.1.0-alpha03.txt
M drawerlayout/drawerlayout/api/public_plus_experimental_current.txt
M drawerlayout/drawerlayout/api/restricted_1.1.0-alpha03.txt
M drawerlayout/drawerlayout/api/restricted_current.txt
M drawerlayout/drawerlayout/build.gradle
M drawerlayout/drawerlayout/src/main/java/androidx/drawerlayout/widget/DrawerLayout.java
M jetifier/jetifier/migration.config
M slidingpanelayout/slidingpanelayout/api/1.1.0-alpha01.txt
M slidingpanelayout/slidingpanelayout/api/current.txt
M slidingpanelayout/slidingpanelayout/api/public_plus_experimental_1.1.0-alpha01.txt
M slidingpanelayout/slidingpanelayout/api/public_plus_experimental_current.txt
M slidingpanelayout/slidingpanelayout/api/restricted_1.1.0-alpha01.txt
M slidingpanelayout/slidingpanelayout/api/restricted_current.txt
M slidingpanelayout/slidingpanelayout/src/main/java/androidx/slidingpanelayout/widget/SlidingPaneLayout.java

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

ap...@google.com <ap...@google.com> #5Apr 10, 2024 05:20PM

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

commit 9c2a871ca8804f5dcf680a7f772f7050198408df
Author: Marcello Albano <maralb@google.com>
Date: Mon Apr 08 16:35:50 2024

Override build type props when build types already exist

It's currently possible to customize release build types creating
benchmark and nonMinified build types. For example to customize
`release` it's possible to create `benchmarkRelease` and
`nonMinifiedRelease`. This PR makes sure that even when they're
customized, properties that would break baseline profile generation are
overridden. This PR also makes sure that the signing config is copied
from the release build type to the extended ones.

Relnote: "when customizing a nonMinified or benchmark build type,
ensure that properties that are needed to make baseline profile
generation and benchmark working are overridden."
Test: ./gradlew :benchmark:benchmark-baseline-profile-gradle-plugin:test
Bug: 324837887
Change-Id: Ib8f0555001ff719f4b82c35cf50c13b4a3fa308d

M benchmark/baseline-profile-gradle-plugin/src/main/kotlin/androidx/baselineprofile/gradle/apptarget/BaselineProfileAppTargetPlugin.kt
M benchmark/baseline-profile-gradle-plugin/src/main/kotlin/androidx/baselineprofile/gradle/producer/BaselineProfileProducerPlugin.kt
M benchmark/baseline-profile-gradle-plugin/src/main/kotlin/androidx/baselineprofile/gradle/utils/BuildTypes.kt
M benchmark/baseline-profile-gradle-plugin/src/test/kotlin/androidx/baselineprofile/gradle/apptarget/BaselineProfileAppTargetPluginTest.kt

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

ma...@google.com <ma...@google.com> #6Apr 23, 2024 04:47PM

This is a summary of how build type configuration works:

buildTypes {
    release {
        ...
    }
    benchmarkRelease {
        // Properties for benchmark release can be overridden here.
        // It's also possible to specify a different signing config.
    }
    nonMinifiedRelease {
        // Properties for nonMinifiedRelease can be specified here.
        //
        // From 1.2.5 and 1.3.0-alpha04, the following properties are always overridden to avoid breaking baseline profile generation:
        //
        // isJniDebuggable = false
        // isDebuggable = false
        // isMinifyEnabled = false
        // isShrinkResources = false
        // isProfileable = true
        // enableAndroidTestCoverage = false
        // enableUnitTestCoverage = false
        //
        // It's still possible to specify a different signing config.
    }
}

ma...@google.com <ma...@google.com> Apr 24, 2024 07:24PM

Reassigned to ma...@google.com.

ma...@google.com <ma...@google.com> Apr 25, 2024 05:38PM

Accepted by ma...@google.com.

ma...@google.com <ma...@google.com> #7Apr 26, 2024 05:20PM

Marked as fixed.

Documentation updated