Create constraints between lifecycle artifacts [242871265]

Fixed

Bug

Status Update

No update yet.

Description

il...@google.com

created issue #1

Aug 17, 2022 05:23PM

Component used: Lifecycle

Version used: 2.6.0-alpha01

Until feature requests such as b/146802533 are released, Gradle does not do any enforcement that Lifecycle artifacts are of the same version (i.e., you could mix and match lifecycle-common:2.6.0-alpha01 with lifecycle-runtime:2.5.1).

Gradle supports constraints, which ensure that upgrading a transitive dependency will also upgrade other dependencies.

We should manually add two way constraints, similarly to what was done for Paging in b/235256201, to the various lifecycle artifacts, which will help Gradle enforce the same version policy we intend.

The pairs of artifacts we should add constraints to should match the dependencies we have right now, which should mean the list looks something like:

lifecycle-common and lifecycle-common-java8
lifecycle-common and lifecycle-runtime
lifecycle-runtime and lifecycle-runtime-ktx
lifecycle-runtime and lifecycle-runtime-compose
lifecycle-runtime and lifecycle-runtime-testing
lifecycle-livedata-core and lifecycle-livedata-core-ktx
lifecycle-livedata-core and lifecycle-livedata
lifecycle-livedata and lifecycle-livedata-ktx
lifecycle-reactivestreams and lifecycle-reactivestreams-ktx
lifecycle-viewmodel and lifecycle-viewmodel-ktx
lifecycle-viewmodel and lifecycle-viewmodel-savedstate
lifecycle-viewmodel-savedstate and lifecycle-viewmodel-compose

Comments

ap...@google.com <ap...@google.com> #2Aug 20, 2022 05:23AM

There are a few more changes to DataStoreImpl's logic which makes a reevaluation necessary.

Now with Yigit's changes, datastore's cold flow always tries to do a dirty read by readState which calls readAndInitOrPropagateAndThrowFailure that invokes readDataOrHandleCorruption only in InitDataStore's first run. Any following read is triggered by IPC's listener which calls readDataAndUpdateCache which updates the cache to ReadException returned from attemptRead.

A ReadException is not automatically handled and stays in cache until a updateData call which revisits readAndInitOrPropagateAndThrowFailure, but it doesn't handle the corruption exception because it's already not the first run. In such case, the handleUpdate call proceeds to transformAndWrite which does not catch the exceptions thrown from readDataFromFileOrDefault.

ap...@google.com <ap...@google.com> #3Aug 20, 2022 07:25AM

can we create a test failure for this? I'm not fully sure what is going wrong here, it is a bit hard to track w/o a repro case.

ap...@google.com <ap...@google.com> #4Aug 20, 2022 07:25AM

can we create a test failure for this?

Sure I'm working on the code changes.

In the meantime I think this bug might makes the errors e.g. in b/309382591 harder to recover because it doesn't try to handle the corruption until the app restarts so the DS can readAndInit again (with corruption handler logic).

ap...@google.com <ap...@google.com> #5Aug 20, 2022 07:25AM

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

commit 383a67d0e5a9b35e394b212db35bdee892b167fb
Author: Zhiyuan Wang <zhiyuanwang@google.com>
Date: Wed Feb 21 17:04:40 2024

Add tests to verify that CorruptionException is not properly handled after DataStore's first disk read. If the internal state is [ReadException], it will not recover for the rest of the lifecycle.

Fix in the follow up change.

Bug: 289582516
Test: ./gradlew :datastore:datastore-core:jvmTest
Change-Id: Ie77900b5c2cb8fb8e55d4c40364491dea9250784

M datastore/datastore-core/src/commonTest/kotlin/androidx/datastore/core/SingleProcessDataStoreTest.kt

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

ap...@google.com <ap...@google.com> #6Aug 20, 2022 07:25AM

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

commit 70085fee2af278bb8c3e45e1acfcf3f4cbb05c5a
Author: Zhiyuan Wang <zhiyuanwang@google.com>
Date: Thu Feb 22 15:08:34 2024

DataStore handles CorruptionException for all reads and writes.

Before this change, DataStore didn't handle the CorruptionException for both the reads and writes after initialization.

Fixes: 289582516
Test: ./gradlew :datastore:datastore-core:jvmTest
Change-Id: Icb07b140017b62a905d3626f82aeb993f636c053

M datastore/datastore-core/src/commonMain/kotlin/androidx/datastore/core/DataStoreImpl.kt
M datastore/datastore-core/src/commonTest/kotlin/androidx/datastore/core/SingleProcessDataStoreTest.kt

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

ap...@google.com <ap...@google.com> #7Aug 22, 2022 06:12PM

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

androidx.datastore:datastore-core:1.1.0-beta02
androidx.datastore:datastore-core-android:1.1.0-beta02
androidx.datastore:datastore-core-iosarm64:1.1.0-beta02
androidx.datastore:datastore-core-iossimulatorarm64:1.1.0-beta02
androidx.datastore:datastore-core-iosx64:1.1.0-beta02
androidx.datastore:datastore-core-jvm:1.1.0-beta02
androidx.datastore:datastore-core-linuxx64:1.1.0-beta02
androidx.datastore:datastore-core-macosarm64:1.1.0-beta02
androidx.datastore:datastore-core-macosx64:1.1.0-beta02

ap...@google.com <ap...@google.com> #8Aug 22, 2022 06:12PM

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

commit aad31661faf4f14036a23a5d0b73147dda032094
Author: Sanura N'Jaka <sanura@google.com>
Date: Thu Aug 18 17:45:05 2022

Add project dependency constraint between lifecycle-reactivestreams and lifecycle-reactivestreams-ktx

Added bi-directional project version constraint between
lifecycle-reactivestreams and lifecycle-reactivestreams-ktx.
If both artifacts are in the dependency tree, their versions
should match. This will now be enforced by gradle
automatically bumping up either version to meet constraint.

Test: N/A
Bug: 242871265
Change-Id: I8e39eed1d37def3dcc3aa38ef1f4edd1583f40c1

M lifecycle/lifecycle-reactivestreams/build.gradle
M lifecycle/lifecycle-reactivestreams-ktx/build.gradle

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

ap...@google.com <ap...@google.com> #9Aug 23, 2022 04:43PM

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

commit f83ce34e8fddb3eb499f98c1262c346d11ee0205
Author: Sanura N'Jaka <sanura@google.com>
Date: Thu Aug 18 17:28:49 2022

Add project dependency constraint between lifecycle-livedata and lifecycle-livedata-core

Added bi-directional project version constraint between
lifecycle-lifedata and lifecycle-livedata-core. If both
artifacts are in the dependency tree, their versions
should match. This will now be enforced by gradle
automatically bumping up either version to meet constraint.

Test: N/A
Bug: 242871265
Change-Id: I3e67cbe8fa8bbc3999f0f463f22b484ea66ba988

M lifecycle/lifecycle-livedata-core/build.gradle
M lifecycle/lifecycle-livedata/build.gradle

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

ap...@google.com <ap...@google.com> #10Aug 23, 2022 07:35PM

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

commit fe17ed80e60d5ec3bb42fe0552415424b7b3dde5
Author: Sanura N'Jaka <sanura@google.com>
Date: Thu Aug 18 17:36:11 2022

Add project dependency constraint between lifecycle-livedata and lifecycle-livedata-ktx

Added bi-directional project version constraint between
lifecycle-lifedata and lifecycle-livedata-ktx. If both
artifacts are in the dependency tree, their versions
should match. This will now be enforced by gradle
automatically bumping up either version to meet constraint.

Test: N/A
Bug: 242871265
Change-Id: Iba6d1ffb952fd20be91b813dcac193ecc1776173

M lifecycle/lifecycle-livedata-ktx/build.gradle
M lifecycle/lifecycle-livedata/build.gradle

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

ap...@google.com <ap...@google.com> #11Aug 23, 2022 07:57PM

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

commit 1e948aed8d0c01823ae60258ade0694da728b36d
Author: Sanura N'Jaka <sanura@google.com>
Date: Thu Aug 18 17:40:29 2022

Add project dependency constraint between lifecycle-livedata-core and lifecycle-livedata-core-ktx

Added bi-directional project version constraint between
lifecycle-lifedata-core and lifecycle-livedata-core-ktx.
If both artifacts are in the dependency tree, their
versions should match. This will now be enforced by gradle
automatically bumping up either version to meet constraint.

Test: N/A
Bug: 242871265
Change-Id: I6c6dd9de2e252217095c60de8ef577be6d940f1a

M lifecycle/lifecycle-livedata-core/build.gradle
M lifecycle/lifecycle-livedata-core-ktx/build.gradle

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

ap...@google.com <ap...@google.com> #12Aug 24, 2022 08:02PM

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

commit 325aa99d830327ccf016231f9836cf04db65c3ff
Author: Sanura N'Jaka <sanura@google.com>
Date: Mon Aug 22 22:23:18 2022

Add project dependency constraint between lifecycle-common and lifecycle-livedata-core

Added bi-directional project version constraint between
lifecycle-common and lifecycle-livedata-core. If both
artifacts are in the dependency tree, their versions
should match. This will now be enforced by gradle
automatically bumping up either version to meet constraint.

Test: N/A
Bug: 242871265
Change-Id: I22e0fda00e22bc4fc56ac1bf5b7dcd2369ad533e

M lifecycle/lifecycle-livedata-core/build.gradle
M lifecycle/lifecycle-common/build.gradle

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

ap...@google.com <ap...@google.com> #13Aug 26, 2022 04:47PM

Marked as fixed.

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

commit 27355f7c30e816f6636928caeef29d473b896e28
Author: Sanura N'Jaka <sanura@google.com>
Date: Wed Aug 24 22:41:48 2022

Add project dependency constraint between lifecycle-viewmodel-savedstate and lifecycle-livedata-core

Added bi-directional project version constraint between
lifecycle-viewmodel-savedstate and lifecycle-livedata-core.
If both artifacts are in the dependency tree, their versions
should match. This will now be enforced by gradle automatically
bumping up either version to meet constraint.

Test: N/A
Fixes: 242871265
Change-Id: I94cc3ddd0f86033653c1477cf3f8ad8a1d93adae

M lifecycle/lifecycle-livedata-core/build.gradle
M lifecycle/lifecycle-viewmodel-savedstate/build.gradle

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

ap...@google.com <ap...@google.com> #14Aug 26, 2022 04:47PM

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

commit 0598f5400a797fc9e31858e0d8a1b575ad7158a7
Author: Sanura N'Jaka <sanura@google.com>
Date: Thu Aug 18 18:28:20 2022

Add project dependency constraint between lifecycle-viewmodel-savedstate and lifecycle-viewmodel-compose

Added bi-directional project version constraint between
lifecycle-viewmodel-savedstate and lifecycle-viewmodel-compose.
If both artifacts are in the dependency tree, their versions
should match. This will now be enforced by gradle automatically
bumping up either version to meet constraint.

Test: N/A
Bug: 242871265
Change-Id: I2810d3afbe0cb8e8e387d1bc64eb3c698285d471

M lifecycle/lifecycle-viewmodel-savedstate/build.gradle
M lifecycle/lifecycle-viewmodel-compose/build.gradle

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

na...@google.com <na...@google.com> #15Sep 12, 2022 05:51PM

This bug was linked in a change in the following release(s):

androidx.lifecycle:lifecycle-common:2.6.0-alpha02
androidx.lifecycle:lifecycle-livedata:2.6.0-alpha02
androidx.lifecycle:lifecycle-livedata-core:2.6.0-alpha02
androidx.lifecycle:lifecycle-livedata-core-ktx:2.6.0-alpha02
androidx.lifecycle:lifecycle-livedata-ktx:2.6.0-alpha02
androidx.lifecycle:lifecycle-reactivestreams:2.6.0-alpha02
androidx.lifecycle:lifecycle-reactivestreams-ktx:2.6.0-alpha02
androidx.lifecycle:lifecycle-runtime:2.6.0-alpha02
androidx.lifecycle:lifecycle-runtime-compose:2.6.0-alpha02
androidx.lifecycle:lifecycle-runtime-ktx:2.6.0-alpha02
androidx.lifecycle:lifecycle-runtime-testing:2.6.0-alpha02
androidx.lifecycle:lifecycle-viewmodel:2.6.0-alpha02
androidx.lifecycle:lifecycle-viewmodel-compose:2.6.0-alpha02
androidx.lifecycle:lifecycle-viewmodel-ktx:2.6.0-alpha02
androidx.lifecycle:lifecycle-viewmodel-savedstate:2.6.0-alpha02

da...@google.com <da...@google.com> #16Sep 28, 2022 02:38PM

This release seems to have conflicting artifacts in the classpath. When both:

androidx.lifecycle:lifecycle-viewmodel-ktx:2.6.0-alpha02

androidx-lifecycle:lifecycle-livedata-ktx:2.6.0-alpha02

are added as dependencies, the following error pops up:

FAILURE: Build failed with an exception.

* What went wrong:
Execution failed for task ':sync:sync-test:checkProdDebugAndroidTestDuplicateClasses'.
> A failure occurred while executing com.android.build.gradle.internal.tasks.CheckDuplicatesRunnable
   > Duplicate class androidx.lifecycle.ViewModelLazy found in modules lifecycle-viewmodel-2.6.0-alpha02-runtime (androidx.lifecycle:lifecycle-viewmodel:2.6.0-alpha02) and lifecycle-viewmodel-ktx-2.3.1-runtime (androidx.lifecycle:lifecycle-viewmodel-ktx:2.3.1)
     Duplicate class androidx.lifecycle.ViewTreeViewModelKt found in modules lifecycle-viewmodel-2.6.0-alpha02-runtime (androidx.lifecycle:lifecycle-viewmodel:2.6.0-alpha02) and lifecycle-viewmodel-ktx-2.3.1-runtime (androidx.lifecycle:lifecycle-viewmodel-ktx:2.3.1)
     
     Go to the documentation to learn how to <a href="d.android.com/r/tools/classpath-sync-errors">Fix dependency resolution errors</a>.

Downgrading to 2.6.0-alpha01 fixes this.

sa...@google.com <sa...@google.com> #17Oct 17, 2022 05:23PM

As an update to the above comment from TJ, this issue has been fixed and will be available in Lifecycle 2.6.0-alpha03.

na...@google.com <na...@google.com> #18Oct 24, 2022 01:38PM

The following release(s) address this bug:

androidx.lifecycle:lifecycle-runtime:2.6.0-alpha03
androidx.lifecycle:lifecycle-runtime-compose:2.6.0-alpha03
androidx.lifecycle:lifecycle-viewmodel-compose:2.6.0-alpha03
androidx.lifecycle:lifecycle-viewmodel-savedstate:2.6.0-alpha03