InvalidFragmentVersionForActivityResult false positive [182388985]

Fixed

Bug

Status Update

No update yet.

Description

vs...@gmail.com

created issue #1

Mar 10, 2021 10:01PM

Component used: Activity
Version used: 1.3.0-alpha04

InvalidFragmentVersionForActivityResult is reported though I forced androidx.fragment:fragment-ktx:1.3.1.

Here is my build.gradle essentials:

// root's build.gradle
ext {
    kotlinVersion = '1.4.31'
    composeVersion = '1.0.0-beta02'
    kotlinxSerializationVersion = '1.1.0'
    sqlDelightVersion = '1.4.4'
}

...

// app's build.gradle
plugins {
    id 'com.android.application'
    id 'org.jetbrains.kotlin.android'
    id 'org.jetbrains.kotlin.plugin.serialization'
    id 'kotlin-parcelize'
    id 'com.squareup.sqldelight'
    id 'kotlin-kapt'
    id 'com.google.gms.google-services'
    id 'com.google.firebase.crashlytics'
}

android {
    compileSdkVersion 29

    defaultConfig {
        applicationId ...
        minSdkVersion ...
        targetSdkVersion ...
        versionCode ...
        versionName ...

        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
    }

    buildTypes {
        release {
            minifyEnabled true
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'

            manifestPlaceholders = [crashlyticsCollectionEnabled: "true"]
        }

        debug {
            applicationIdSuffix '.debug'

            manifestPlaceholders = [crashlyticsCollectionEnabled: "false"]
        }
    }

    buildFeatures {
        compose true
    }

    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }

    kotlinOptions {
        jvmTarget = '1.8'
        useIR = true

        freeCompilerArgs += '-Xopt-in=kotlin.time.ExperimentalTime'
        freeCompilerArgs += '-Xopt-in=kotlin.contracts.ExperimentalContracts'
        freeCompilerArgs += '-Xopt-in=kotlinx.coroutines.ObsoleteCoroutinesApi'
        freeCompilerArgs += '-Xopt-in=kotlinx.coroutines.ExperimentalCoroutinesApi'
        freeCompilerArgs += '-Xopt-in=kotlinx.coroutines.InternalCoroutinesApi'
        freeCompilerArgs += '-Xopt-in=kotlinx.coroutines.FlowPreview'
        freeCompilerArgs += '-Xopt-in=androidx.compose.foundation.ExperimentalFoundationApi'
        freeCompilerArgs += '-Xopt-in=androidx.compose.animation.core.InternalAnimationApi'
    }

    composeOptions {
        kotlinCompilerExtensionVersion composeVersion
    }
}

dependencies {
    def coroutinesVersion = '1.4.2'
    implementation "org.jetbrains.kotlinx:kotlinx-coroutines-core:$coroutinesVersion"
    implementation "org.jetbrains.kotlinx:kotlinx-coroutines-android:$coroutinesVersion"

    implementation 'androidx.appcompat:appcompat:1.2.0'
    implementation 'androidx.core:core-ktx:1.3.2'
    implementation 'androidx.activity:activity-compose:1.3.0-alpha04'
    implementation 'androidx.fragment:fragment-ktx:1.3.1' // Essential for Activity Result APIs (as per https://developer.android.com/training/basics/intents/result)
    implementation "androidx.constraintlayout:constraintlayout-compose:1.0.0-alpha03"

    implementation platform('com.google.firebase:firebase-bom:26.3.0')
    implementation 'com.google.firebase:firebase-analytics-ktx'
    implementation 'com.google.firebase:firebase-crashlytics-ktx'

    def lifecycleVersion = '2.2.0'
    implementation "androidx.lifecycle:lifecycle-common-java8:$lifecycleVersion"
    implementation "androidx.lifecycle:lifecycle-viewmodel-ktx:$lifecycleVersion"
    implementation "androidx.lifecycle:lifecycle-viewmodel-savedstate:$lifecycleVersion"

    // Compose
    implementation "androidx.compose.ui:ui:$composeVersion"
    implementation "androidx.compose.ui:ui-tooling:$composeVersion"
    implementation "androidx.compose.foundation:foundation:$composeVersion"
    implementation "androidx.compose.material:material:$composeVersion"
    implementation "androidx.compose.material:material-icons-core:$composeVersion"
    implementation "androidx.compose.material:material-icons-extended:$composeVersion"
    androidTestImplementation "androidx.compose.ui:ui-test:$composeVersion"

    implementation "com.squareup.sqldelight:android-driver:$sqlDelightVersion"
    implementation "com.squareup.sqldelight:coroutines-extensions-jvm:$sqlDelightVersion"

    implementation "org.jetbrains.kotlinx:kotlinx-serialization-core:$kotlinxSerializationVersion"
    implementation "org.jetbrains.kotlinx:kotlinx-serialization-json:$kotlinxSerializationVersion"

    def daggerVersion = '2.29.1'
    implementation "com.google.dagger:dagger:$daggerVersion"
    kapt "com.google.dagger:dagger-compiler:$daggerVersion"

    testImplementation 'junit:junit:4.12'
    androidTestImplementation 'androidx.test.ext:junit:1.1.2'
    androidTestImplementation 'androidx.test.espresso:espresso-core:3.3.0'
}

Comments

il...@google.com <il...@google.com> #2Mar 10, 2021 10:04PM

Hi Ed, Thank you so much for these suggestions. I've been reviewing them and merging them in. Hopefully it should be live. I've included a thank you note too in the article.

vs...@gmail.com <vs...@gmail.com> #3Mar 10, 2021 10:08PM

Great! Thanks a lot, I'll look for the live updates soon!

il...@google.com <il...@google.com> Mar 10, 2021 10:37PM

Assigned to jb...@google.com.

jd...@gmail.com <jd...@gmail.com> #4Mar 11, 2021 04:26AM

The version comparison insdie ActivityResultFragmentVersionDetector is clearly inadequate. The simple length and string comparison end up returning true when they shouldn't

From the lint check:

            val currentVersion = library.substringAfter("androidx.fragment:fragment:")
            if (library != currentVersion && FRAGMENT_VERSION.compareVersions(currentVersion)) {
                locations.forEach { location ->
                    context.report(
                        ISSUE, expression, location,
                        "Upgrade Fragment version to at least $FRAGMENT_VERSION."
                    )
                }
            }

But if you plugin the the current version of "1.3.1", you can see how it yields the wrong result.

val FRAGMENT_VERSION = "1.3.0"
fun String.compareVersions(other: String): Boolean {
    return when {
        length < other.length -> true
        length > other.length -> false
        else -> this < other
    }
}
FRAGMENT_VERSION.compareVersions("1.3.1")
res3: kotlin.Boolean = true

zh...@google.com <zh...@google.com> #5Mar 11, 2021 04:47AM

I'm hitting this bug as well when fragment-ktx is upgraded from 1.3.0 to 1.3.1.

Looking at ActivityResultFragmentVersionDetector, I couldn't really understand the compareVersions() function in it:

        const val FRAGMENT_VERSION = "1.3.0"
...
        if (library.isNotEmpty()) {
            val currentVersion = library.substringAfter("androidx.fragment:fragment:")
            if (library != currentVersion && FRAGMENT_VERSION.compareVersions(currentVersion)) {
                locations.forEach { location ->
                    context.report(
                        ISSUE, expression, location,
                        "Upgrade Fragment version to at least $FRAGMENT_VERSION."
                    )
                }
            }
        }
...

    private fun String.compareVersions(other: String): Boolean {
        return when {
            length < other.length -> true
            length > other.length -> false
            else -> this < other
        }
    }

So say library is androidx.fragment:fragment:1.3.1, currentVersion would be 1.3.1 and the Lint detector reports an issue if "1.3.0".compareVersions("1.3.1") returns true. And since "1.3.0" and "1.3.1" has the same length, it reports an issue if "1.3.0" < "1.3.1", which is true (Playground), and we get a Lint failure here.

I'm confused about how the current compareVersions() implementation is supposed to work for semantic versions, because it doesn't seem to work for a number of scenarios I could think of:

Case	`FRAGMENT_VERSION`	`currentVersion`	`length <=> other.length`	`this < other`	`compareVersions()` (reports Lint error)	Works as expected
Older stable release	`"1.3.0"`	`"1.2.0"`	`length == other.length`	`false`	`false`	`false`
Older unstable release	`"1.3.0"`	`"1.3.0-alpha01"`	`length < other.length`	N/A	`true`	`true`
Exact unstable release (aosp/1564487)	`"1.3.0"`	`"1.3.0-alpha06"`	`length < other.length`	N/A	`true`	`false`
Newer unstable release	`"1.3.0"`	`"1.3.0-beta01"`	`length < other.length`	N/A	`true`	`false`
Exact stable release	`"1.3.0"`	`"1.3.0"`	`length == other.length`	`false`	`false`	`true`
Newer stable release	`"1.3.0"`	`"1.3.1"`	`length == other.length`	`true`	`true`	`false`

zh...@google.com <zh...@google.com> #6Mar 11, 2021 04:56AM

Oh, if the intention here is to simply report an issue for all non-stable versions (which will have a different string length) to avoid pulling in a full semver implementation, I think we just need to flip the comparison in else -> this < other here to fix this for stable versions.

jd...@gmail.com <jd...@gmail.com> #7Mar 11, 2021 05:44AM

Flipping it would work for a quick fix, but the length check may still end up returning incorrect data if the patch version of fragment ever reached 2 digits, 1.3.10.

ap...@google.com <ap...@google.com> #8Mar 11, 2021 01:51PM

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

commit 2db691788fe04d6cb2080cd2187989962a2c2b46
Author: Jeremy Woods <jbwoods@google.com>
Date: Wed Mar 10 15:18:15 2021

Fix string comparision for activity lint

Fixing error that caused lint report when using Fragment versions
greater than 1.3.0.

RelNote: "There is no longer a false positive lint error when using
Fragment version 1.3.1 with Activity Result APIs"
Test: ActivityResultFragmentVersionDetectorTest
Bug: 182388985

Change-Id: I54da158c0ca4bfa6246f51226fd4991dc485b0d2

M activity/activity-lint/src/main/java/androidx/activity/lint/ActivityResultFragmentVersionDetector.kt
M activity/activity-lint/src/test/java/androidx/activity/lint/ActivityResultFragmentVersionDetectorTest.kt

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

jb...@google.com <jb...@google.com> #9Mar 11, 2021 06:49PM

Marked as fixed.

This has been fixed internally and will be available in the next Activity release.

vs...@gmail.com <vs...@gmail.com> #10Mar 12, 2021 02:51PM

Awesome, thank you!

ba...@gmail.com <ba...@gmail.com> #11Mar 14, 2021 02:28PM

Cool thanks!

to...@yahoo.com <to...@yahoo.com> #12Mar 15, 2021 06:55PM

cheers !

[Deleted User] <[Deleted User]> #13Mar 22, 2021 07:07AM

when the next version will be available?

ce...@gmail.com <ce...@gmail.com> #14Mar 31, 2021 09:22AM

Release notes of Activity 1.2.2 quoted this issue as fixed but it actually isn't.

We still get it with Activity 1.2.2 and Fragment 1.3.2.

to...@yahoo.com <to...@yahoo.com> #15Mar 31, 2021 09:50AM

implementation 'androidx.activity:activity:1.3.0-alpha05'
implementation 'androidx.fragment:fragment:1.3.2'

finally seems to work...

ce...@gmail.com <ce...@gmail.com> #16Mar 31, 2021 10:54AM

Edit for https://issuetracker.google.com/issues/182388985#comment14

The issue is fixed.

I'm sorry for the previous message, the issue was caused by the dependency configuration of our project (some modules had a transitive dependency on previous activity/fragment versions).

lb...@gmail.com <lb...@gmail.com> #17Mar 31, 2021 05:52PM

@15 Is this the final answer? How do you know this one fixed it?

il...@google.com <il...@google.com> #18Mar 31, 2021 11:10PM

Upgrading to Activity 1.2.2 (or Activity 1.3.0-alpha05, which also includes the fix) is the only requirement.

Fragment 1.3.2 includes a dependency on Activity 1.2.2, so upgrading your version of Fragments will also pull in the fix via the transitive dependency.

lb...@gmail.com <lb...@gmail.com> #19Mar 31, 2021 11:34PM

@18 Meaning this is fine:

implementation "androidx.fragment:fragment-ktx:1.3.2"

?

But how do you guys know this fixed the issue?

il...@google.com <il...@google.com> #20Mar 31, 2021 11:37PM

Re #19 - Because it includes the fix from comment#8.

lb...@gmail.com <lb...@gmail.com> #21Apr 1, 2021 12:02AM

@20 ok thanks.

ca...@gmail.com <ca...@gmail.com> #22Apr 19, 2021 04:40PM

I'm still able to replicate this issue with compose beta04 and activity-compose 1.3.0-alpha06.

```
Update to Fragment 1.3.0 to use ActivityResult APIs
```

il...@google.com <il...@google.com> #23Apr 19, 2021 04:55PM

Re #22 - please file a new bug with a sample project that reproduces your issue.

ar...@gmail.com <ar...@gmail.com> #24May 13, 2021 11:48AM

I don't get this activity dependency, my question is should we change the import of AppCompatActivity or this dependency is just for ActivityResultRegistry ?

ar...@gmail.com <ar...@gmail.com> #25May 13, 2021 12:15PM

So far I still get this lint error I am still getting lint error, this is a bit old project written in Java and I use androidx.activity:activity-ktx:1.3.0-alpha07 working with AS Arctic Fox Canary 15

ar...@gmail.com <ar...@gmail.com> #26May 13, 2021 12:18PM

I am using androidx.fragment:fragment-ktx:1.3.3 as well but the lint error still there

du...@gmail.com <du...@gmail.com> #27May 13, 2021 12:47PM

I still get the lint error in androidx.fragment:fragment-ktx:1.3.3 :(

il...@google.com <il...@google.com> #28May 13, 2021 03:42PM

Re #24-27 - please file a new issue with a project that reproduces your issue.

mu...@gmail.com <mu...@gmail.com> #29May 29, 2021 02:26PM

I still get the lint error in androidx.fragment:fragment-ktx:1.3.3

mu...@gmail.com <mu...@gmail.com> #30May 29, 2021 02:27PM

Also 1.3.4 is the same

ig...@gmail.com <ig...@gmail.com> #31Jun 4, 2021 12:07PM

Same issue with:

implementation "androidx.activity:activity-ktx:
implementation "androidx.fragment:fragment-ktx:1.3.4"

il...@google.com <il...@google.com> #32Jun 4, 2021 05:06PM

Re #29, #31 - like previously mentioned, file a new issue with a project that reproduces your issue.

si...@gmail.com <si...@gmail.com> #33Jan 4, 2024 06:29PM

df...@smart-soft.com <df...@smart-soft.com> #34May 22, 2024 07:15PM

I am getting this error, and I'm not even using fragments. Androidx.fragment:fragment-ktx isn't even in my dependencies.

il...@google.com <il...@google.com> #35May 23, 2024 03:05PM

Re comment#34 - then it is likely this is not a false positive - many other libraries (like AppCompat) depend on a very old version of Fragments. This Lint check works even in those cases to tell you that you need to upgrade your Fragment version manually.