Revert DataStore library version #12891

ThomazFB · 2024-11-07T18:51:17Z

Summary

Fix issue #12867 by reverting the DataStore library version back to 1.0.0.

During the project migration to the Version Catalog, we ended up migrating the DataStore from 1.0.0 to 1.1.0. Unfortunately, this upgrade introduced a current known bug from the library to our app.

To fix it, this PR reverts the app back to the version prior to the Version Catalog migration one month ago.

How to Test

Currently, 90% of the app's reliance on DataStore is related to Analytics and Stats. To properly test this downgrade, I recommend verifying if the Analytics Hub, My Store Stats, and Top Performers are all working as expected.

Update release notes:

I have considered if this change warrants user-facing release notes and have added them to RELEASE-NOTES.txt if necessary.

Reviewer (or Author, in the case of optional code reviews):

Please make sure these conditions are met before approving the PR, or request changes if the PR needs improvement:

The PR is small and has a clear, single focus, or a valid explanation is provided in the description. If needed, please request to split it into smaller PRs.
Ensure Adequate Unit Test Coverage: The changes are reasonably covered by unit tests or an explanation is provided in the PR description.
Manual Testing: The author listed all the tests they ran, including smoke tests when needed (e.g., for refactorings). The reviewer confirmed that the PR works as expected on big (tablet) and small (phone) in case of UI changes, and no regressions are added.

dangermattic · 2024-11-07T18:53:21Z

	1 Warning
⚠️	This PR is assigned to the milestone 21.1. This milestone is due in less than 2 days. Please make sure to get it merged by then or assign it to a milestone with a later deadline.

Generated by 🚫 Danger

wpmobilebot · 2024-11-07T18:56:22Z

Project dependencies changes

The following changes in project dependencies were detected (configuration vanillaReleaseRuntimeClasspath):

list

Removed Dependencies
androidx.datastore:datastore-android:1.1.0
androidx.datastore:datastore-core-android:1.1.0
androidx.datastore:datastore-core-okio:1.1.0
androidx.datastore:datastore-core-okio-jvm:1.1.0
androidx.datastore:datastore-preferences-android:1.1.0
androidx.datastore:datastore-preferences-core-jvm:1.1.0

Upgraded Dependencies
androidx.datastore:datastore:1.0.0, (changed from 1.1.0)
androidx.datastore:datastore-core:1.0.0, (changed from 1.1.0)
androidx.datastore:datastore-preferences:1.0.0, (changed from 1.1.0)
androidx.datastore:datastore-preferences-core:1.0.0, (changed from 1.1.0)

tree

-+--- androidx.datastore:datastore-preferences:1.1.0
-|    \--- androidx.datastore:datastore-preferences-android:1.1.0
-|         +--- androidx.datastore:datastore:1.1.0
-|         |    \--- androidx.datastore:datastore-android:1.1.0
-|         |         +--- androidx.annotation:annotation:1.2.0 -> 1.8.0 (*)
-|         |         +--- androidx.datastore:datastore-core:1.1.0
-|         |         |    \--- androidx.datastore:datastore-core-android:1.1.0
-|         |         |         +--- androidx.annotation:annotation:1.7.0 -> 1.8.0 (*)
-|         |         |         +--- org.jetbrains.kotlin:kotlin-parcelize-runtime:1.9.22 -> 1.9.25
-|         |         |         |    +--- org.jetbrains.kotlin:kotlin-stdlib:1.9.25 (*)
-|         |         |         |    \--- org.jetbrains.kotlin:kotlin-android-extensions-runtime:1.9.25
-|         |         |         |         \--- org.jetbrains.kotlin:kotlin-stdlib:1.9.25 (*)
-|         |         |         +--- org.jetbrains.kotlin:kotlin-stdlib:1.8.22 -> 1.9.25 (*)
-|         |         |         +--- org.jetbrains.kotlinx:kotlinx-coroutines-core:1.7.3 -> 1.8.1 (*)
-|         |         |         +--- androidx.datastore:datastore:1.1.0 (c)
-|         |         |         +--- androidx.datastore:datastore-core-okio:1.1.0 (c)
-|         |         |         +--- androidx.datastore:datastore-preferences:1.1.0 (c)
-|         |         |         \--- androidx.datastore:datastore-preferences-core:1.1.0 (c)
-|         |         +--- androidx.datastore:datastore-core-okio:1.1.0
-|         |         |    \--- androidx.datastore:datastore-core-okio-jvm:1.1.0
-|         |         |         +--- androidx.datastore:datastore-core:1.1.0 (*)
-|         |         |         +--- com.squareup.okio:okio:3.4.0 -> 3.7.0
-|         |         |         |    \--- com.squareup.okio:okio-jvm:3.7.0
-|         |         |         |         \--- org.jetbrains.kotlin:kotlin-stdlib:1.9.21 -> 1.9.25 (*)
-|         |         |         +--- org.jetbrains.kotlin:kotlin-stdlib:1.8.22 -> 1.9.25 (*)
-|         |         |         +--- org.jetbrains.kotlinx:kotlinx-coroutines-core:1.7.3 -> 1.8.1 (*)
-|         |         |         +--- androidx.datastore:datastore:1.1.0 (c)
-|         |         |         +--- androidx.datastore:datastore-core:1.1.0 (c)
-|         |         |         +--- androidx.datastore:datastore-preferences:1.1.0 (c)
-|         |         |         \--- androidx.datastore:datastore-preferences-core:1.1.0 (c)
-|         |         +--- com.squareup.okio:okio:3.4.0 -> 3.7.0 (*)
-|         |         +--- org.jetbrains.kotlin:kotlin-stdlib:1.8.22 -> 1.9.25 (*)
-|         |         +--- org.jetbrains.kotlinx:kotlinx-coroutines-core:1.7.3 -> 1.8.1 (*)
-|         |         +--- androidx.datastore:datastore-core:1.1.0 (c)
-|         |         +--- androidx.datastore:datastore-core-okio:1.1.0 (c)
-|         |         +--- androidx.datastore:datastore-preferences:1.1.0 (c)
-|         |         \--- androidx.datastore:datastore-preferences-core:1.1.0 (c)
-|         +--- androidx.datastore:datastore-preferences-core:1.1.0
-|         |    \--- androidx.datastore:datastore-preferences-core-jvm:1.1.0
-|         |         +--- androidx.datastore:datastore-core:1.1.0 (*)
-|         |         +--- androidx.datastore:datastore-core-okio:1.1.0 (*)
-|         |         +--- com.squareup.okio:okio:3.4.0 -> 3.7.0 (*)
-|         |         +--- org.jetbrains.kotlin:kotlin-stdlib:1.8.22 -> 1.9.25 (*)
-|         |         +--- androidx.datastore:datastore:1.1.0 (c)
-|         |         +--- androidx.datastore:datastore-core:1.1.0 (c)
-|         |         +--- androidx.datastore:datastore-core-okio:1.1.0 (c)
-|         |         \--- androidx.datastore:datastore-preferences:1.1.0 (c)
-|         +--- org.jetbrains.kotlin:kotlin-stdlib:1.8.22 -> 1.9.25 (*)
-|         +--- org.jetbrains.kotlinx:kotlinx-coroutines-core:1.7.3 -> 1.8.1 (*)
-|         +--- androidx.datastore:datastore:1.1.0 (c)
-|         +--- androidx.datastore:datastore-preferences-core:1.1.0 (c)
-|         +--- androidx.datastore:datastore-core:1.1.0 (c)
-|         \--- androidx.datastore:datastore-core-okio:1.1.0 (c)
++--- androidx.datastore:datastore-preferences:1.0.0
+|    +--- org.jetbrains.kotlin:kotlin-stdlib:1.5.10 -> 1.9.25 (*)
+|    +--- androidx.datastore:datastore:1.0.0
+|    |    +--- org.jetbrains.kotlin:kotlin-stdlib:1.5.10 -> 1.9.25 (*)
+|    |    +--- org.jetbrains.kotlinx:kotlinx-coroutines-core:1.5.0 -> 1.8.1 (*)
+|    |    +--- androidx.annotation:annotation:1.2.0 -> 1.8.0 (*)
+|    |    \--- androidx.datastore:datastore-core:1.0.0
+|    |         +--- org.jetbrains.kotlin:kotlin-stdlib:1.5.10 -> 1.9.25 (*)
+|    |         +--- org.jetbrains.kotlinx:kotlinx-coroutines-core:1.5.0 -> 1.8.1 (*)
+|    |         \--- androidx.annotation:annotation:1.1.0 -> 1.8.0 (*)
+|    \--- androidx.datastore:datastore-preferences-core:1.0.0
+|         +--- org.jetbrains.kotlin:kotlin-stdlib:1.5.10 -> 1.9.25 (*)
+|         \--- androidx.datastore:datastore-core:1.0.0 (*)
-+--- androidx.datastore:datastore:1.1.0 (*)
++--- androidx.datastore:datastore:1.0.0 (*)
 +--- com.automattic:Automattic-Tracks-Android:5.0.0
 |    \--- com.squareup.okhttp3:okhttp:4.9.0 -> 4.12.0
-|         \--- com.squareup.okio:okio:3.6.0 -> 3.7.0 (*)
+|         \--- com.squareup.okio:okio:3.6.0 -> 3.7.0
+|              \--- com.squareup.okio:okio-jvm:3.7.0
+|                   \--- org.jetbrains.kotlin:kotlin-stdlib:1.9.21 -> 1.9.25 (*)
 +--- org.wordpress:fluxc:2.99.1
-|    \--- org.jetbrains.kotlin:kotlin-parcelize-runtime:1.9.25 (*)
+|    \--- org.jetbrains.kotlin:kotlin-parcelize-runtime:1.9.25
+|         +--- org.jetbrains.kotlin:kotlin-stdlib:1.9.25 (*)
+|         \--- org.jetbrains.kotlin:kotlin-android-extensions-runtime:1.9.25
+|              \--- org.jetbrains.kotlin:kotlin-stdlib:1.9.25 (*)
 \--- org.wordpress:mediapicker:0.3.1
-     \--- androidx.datastore:datastore-preferences:1.0.0 -> 1.1.0 (*)
+     \--- androidx.datastore:datastore-preferences:1.0.0 (*)

wpmobilebot · 2024-11-07T18:59:23Z

📲 You can test the changes from this Pull Request in WooCommerce-Wear Android by scanning the QR code below to install the corresponding build.

	App Name	WooCommerce-Wear Android
	Platform	⌚️ Wear OS
	Flavor	Jalapeno
	Build Type	Debug
	Commit	`c68f285`
	Direct Download	`woocommerce-wear-prototype-build-pr12891-c68f285.apk`

wpmobilebot · 2024-11-07T19:09:45Z

📲 You can test the changes from this Pull Request in WooCommerce Android by scanning the QR code below to install the corresponding build.

	App Name	WooCommerce Android
	Platform	📱 Mobile
	Flavor	Jalapeno
	Build Type	Debug
	Commit	`c68f285`
	Direct Download	`woocommerce-prototype-build-pr12891-c68f285.apk`

gradle/libs.versions.toml

@@ -15,7 +15,7 @@
 androidx-constraintlayout-main = '2.1.4'
 androidx-core-main = '1.13.1'
 androidx-core-splashscreen = '1.0.1'
-androidx-datastore = '1.1.0'
+androidx-datastore = '1.0.0' # Higher versions of the DataStore library are presenting crashes, refer to peaMlT-XN before upgrading it.


gradle/libs.versions.toml

@@ -15,7 +15,7 @@
 androidx-constraintlayout-main = '2.1.4'
 androidx-core-main = '1.13.1'
 androidx-core-splashscreen = '1.0.1'
-androidx-datastore = '1.1.0'
+androidx-datastore = '1.0.0' # Higher versions of the DataStore library are presenting crashes, refer to peaMlT-XN before upgrading it.


gradle/libs.versions.toml

@@ -15,7 +15,7 @@
 androidx-constraintlayout-main = '2.1.4'
 androidx-core-main = '1.13.1'
 androidx-core-splashscreen = '1.0.1'
-androidx-datastore = '1.1.0'
+androidx-datastore = '1.0.0' # Higher versions of the DataStore library are presenting crashes, refer to peaMlT-XN before upgrading it.


gradle/libs.versions.toml

@@ -15,7 +15,7 @@
 androidx-constraintlayout-main = '2.1.4'
 androidx-core-main = '1.13.1'
 androidx-core-splashscreen = '1.0.1'
-androidx-datastore = '1.1.0'
+androidx-datastore = '1.0.0' # Higher versions of the DataStore library are presenting crashes, refer to peaMlT-XN before upgrading it.


gradle/libs.versions.toml

atorresveiga

LGTM!

ParaskP7 · 2024-11-08T11:29:34Z

👋 @ThomazFB , thanks for the fix and apologies for the inconvenience! 🙏 🙇

FYI: As part of the Version Catalogs migration I did warn (⚠️) about such changes (see description), and also wrote a descriptive commit on it too, mentioning that WooCommerce and WooCommerce-Wear were using a different version of datastore, point to 1.0.0 and 1.1.0 correspondingly. I hope that with Version Catalogs we will avoid such inconsistencies going forward, along with all the potential problems this could create. 😞

ThomazFB · 2024-11-08T12:36:01Z

Hey @ParaskP7, don't worry about that, and there is no need for apologies; this is not on you in any way; we can't predict that a small version bump of a library could introduce a shady crash like that one; this is a quality fault from the library itself. The Version Catalog was an amazing introduction to our app and thanks for all your work on that!

ThomazFB added 2 commits November 7, 2024 15:36

Downgrade DataStore library version to 1.0.0

0e49bcc

Add comment to DataStore current version reference.

5d935c2

ThomazFB added type: crash The worst kind of bug. category: tooling Anything that involves building & maintaining the project, including scripts, `Fastfile`, etc. labels Nov 7, 2024

ThomazFB linked an issue Nov 7, 2024 that may be closed by this pull request

CorruptionException: Unable to parse preferences proto. #12867

Closed

ThomazFB requested a review from atorresveiga November 7, 2024 18:51

ThomazFB added this to the 21.1 milestone Nov 7, 2024

github-advanced-security bot found potential problems Nov 7, 2024

View reviewed changes

atorresveiga approved these changes Nov 7, 2024

View reviewed changes

Merge branch 'trunk' into issue/revert-data-store-version

c68f285

atorresveiga enabled auto-merge November 7, 2024 22:07

atorresveiga merged commit eb38658 into trunk Nov 7, 2024
15 checks passed

atorresveiga deleted the issue/revert-data-store-version branch November 7, 2024 22:37

This was referenced Dec 2, 2024

[Dashboard] Add corruption handlers to Data Stores using Protocol Buffer schemas. #13045

Closed

[Dashboard] Add corruption handlers to Data Stores using Protocol Buffer schemas. #13058

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Revert DataStore library version #12891

Revert DataStore library version #12891

ThomazFB commented Nov 7, 2024 •

edited

Loading

dangermattic commented Nov 7, 2024 •

edited

Loading

wpmobilebot commented Nov 7, 2024

wpmobilebot commented Nov 7, 2024 •

edited

Loading

wpmobilebot commented Nov 7, 2024 •

edited

Loading

atorresveiga left a comment

ParaskP7 commented Nov 8, 2024

ThomazFB commented Nov 8, 2024

Revert DataStore library version #12891

Revert DataStore library version #12891

Conversation

ThomazFB commented Nov 7, 2024 • edited Loading

Summary

How to Test

Reviewer (or Author, in the case of optional code reviews):

dangermattic commented Nov 7, 2024 • edited Loading

wpmobilebot commented Nov 7, 2024

Project dependencies changes

wpmobilebot commented Nov 7, 2024 • edited Loading

wpmobilebot commented Nov 7, 2024 • edited Loading

atorresveiga left a comment

Choose a reason for hiding this comment

ParaskP7 commented Nov 8, 2024

ThomazFB commented Nov 8, 2024

ThomazFB commented Nov 7, 2024 •

edited

Loading

dangermattic commented Nov 7, 2024 •

edited

Loading

wpmobilebot commented Nov 7, 2024 •

edited

Loading

wpmobilebot commented Nov 7, 2024 •

edited

Loading