AndroidPluginVersion.toString() is missing leading 0s [319053159]

Fixed

Bug

Status Update

No update yet.

Description

tr...@block.xyz

created issue #1

Jan 8, 2024 04:46PM

DESCRIBE THE ISSUE IN DETAIL:

I have two requests for this issue:

The string representation of AndroidPluginVersion should not omit leading 0s for the preview property.
AndroidPluginVersion should have an immediately useful string representation that doesn't require stripping off the "Android Gradle Plugin version " prefix. I use this string in many places in https://github.com/autonomousapps/dependency-analysis-gradle-plugin.

STEPS TO REPRODUCE:

See code block below.

val androidComponents = project.extensions.getByType(AndroidComponentsExtension::class.java)
val agpVersion = androidComponents.pluginVersion.toString()
project.logger.quiet(agpVersion)

For example, if I call toString() on an instance of AGP from version 8.4.0-alpha01, it will return Android Gradle Plugin version 8.4.0-alpha1 (note that it ends with alpha1 and not alpha01.

By contrast, if I look at the kdoc for preview, this is what it says:

The preview version.
e.g. 5 for Android Gradle Plugin Version 7.0.0-alpha05

Where the leading 0 is clearly visible.

Version of Gradle Plugin: 8.4.0-alpha01 (and maybe earlier versions)

Comments

ra...@google.com <ra...@google.com> Jan 10, 2024 01:31AM

Assigned to an...@google.com.

je...@google.com <je...@google.com> Jan 16, 2024 05:25AM

Reassigned to cm...@google.com.

cm...@google.com <cm...@google.com> #2Jan 16, 2024 10:20AM

Accepted by cm...@google.com.

The toString was deliberately prefixed like this to make it clear this wasn't meant to be passed back as a maven version, as it wasn't necessarily consistent

Annoyingly 3.0 alphas, betas & rc and 3.0 beta and rc did not do this, although perhaps that doesn't matter so much

Message last modified on Jan 16, 2024 10:21AM

cm...@google.com <cm...@google.com> #3Jan 16, 2024 10:29AM

It's a reasonable request that we do return something that exactly corresponds with the maven version though

tr...@block.xyz <tr...@block.xyz> #4Jan 16, 2024 07:00PM

As a point of reference, the GradleVersion class looks roughly like this:

  public String toString() {
    return "Gradle " + this.version;
  }

  public String getVersion() {
    return this.version;
  }

Also, I have what I think is a valid use-case for having the actual Maven version string. I use this string for building functional test fixtures for my Gradle plugin test suite. The AGP version is a parameter I pass in so I can test against multiple versions and ensure wide compatibility.

cm...@google.com <cm...@google.com> #5Jan 18, 2024 03:27PM

Marked as fixed.

I've added kotlin property 'version' to the class and fixed both to prefix 0 where appropriate in https://cs.android.com/android-studio/platform/tools/base/+/d8282c4f9e06ddad46143ad29532fc63116ddff0

Which should land in AGP 8.4.0-alpha06

an...@google.com <an...@google.com> #6Jan 26, 2024 06:06PM

Thank you for your patience while our engineering team worked to resolve this issue. A fix for this issue is now available in:

Android Studio Jellyfish | 2023.3.1 Canary 7
Android Gradle Plugin 8.4.0-alpha07

We encourage you to try the latest update.

If you notice further issues or have questions, please file a new bug report.

Thank you for taking the time to submit feedback — we really appreciate it!