[RNMobile] Upgrade Gradle to `8.2.1` and AGP to `8.1.0` by fluiddot · Pull Request #52872 · WordPress/gutenberg

fluiddot · 2023-07-24T09:17:36Z

Related PR:

[RNMobile] Upgrade Gradle to 8.2.1 and AGP to 8.1.0 wordpress-mobile/gutenberg-mobile#5989
[Build] Upgrade Gradle to 8.2.1 and AGP to 8.1.0 wordpress-mobile/WordPress-Android#18775

What?

Apply needed changes to upgrade Gradle to version 8.2.1 and AGP (Android Gradle Plugin) to version ~~8.0.2~~ 8.1.0.

Why?

This is needed to match the versions that will be used in the Android app. Otherwise, we won't be able to do composite builds, which are needed during the development workflow to test native changes without publishing the Android binaries.

Closes wordpress-mobile/gutenberg-mobile#5990.

How?

This PR contains several changes introduced by @ParaskP7 in the forked branch build/upgrade-gradle-to-8.2.1-and-agp-to-8.0.2. The main changes are:

Upgrade Gradle and AGP in react-native-aztec package.
Upgrade Gradle and AGP in react-native-bridge package.
Upgrade Gradle and AGP in react-native-editor package.
Extract versions into groups to make version management easier.
Move package from Android manifest files to build files.
Enable build config build feature.
Include correct react-native-aztec project in bridge.
Update Android CI jobs to use Java 17.
Add newer version of react-native-gradle-plugin via package @react-native/gradle-plugin.
Remove patch for react-native-gradle which is no longer need it.

Testing Instructions

Check that the Gutenberg demo app can be built.
Smoke test the editor.

⚠️ NOTE: AGP 8.1.0 requires Android Studio Giraffe | 2022.3.1 or above.

Testing Instructions for Keyboard

N/A

Screenshots or screencast

N/A

FYI: You will notice an additional 'aztec' related 'junit' version. This is because the node modules are using an older version of JUnit, the '4.12', that is, comparing to the newer '4.13' version that the 'aztec' modules are using. As such, and in order to avoid behavior changes, two such version were extracted to the root 'build.gradle' file with an accompanying TODO for the future.

Release Notes: https://docs.gradle.org/8.1.1/release-notes.html Command: ./gradlew wrapper --gradle-version=8.1.1 --distribution-type=all ------------------------------------------------------------------------ FYI: You will notice that the associated 'gradle-wrapper.jar', 'gradlew' and 'gradlew.bat' files are not updated. This is because of the breaking changes that this upgrade introduces, including the 'AGP' upgrade and its associated breaking changes (namespace, build option, etc). As such, this Gradle upgrade command is only half done. PS: When all the breaking changes are resolved, this Gradle command will be issued again, which should fully complete this upgrade.

Release Notes: https://developer.android.com/build/releases/ gradle-plugin#agp-8-0-2

This is an AGP version '8.0' breaking change that requires 'namespace' in module-level build scripts, see build failure below: ------------------------------------------------------------------------ FAILURE: Build failed with an exception. * What went wrong: A problem occurred configuring root project '@wordpress_react-native-aztec'. > Failed to notify project evaluation listener. > Could not create an instance of type com.android.build.api.variant.impl.LibraryVariantBuilderImpl. > Namespace not specified. Please specify a namespace in the module's build.gradle file like so: android { namespace 'com.example.namespace' } If the package attribute is specified in the source AndroidManifest.xml, it can be migrated automatically to the namespace value in the build.gradle file using the AGP Upgrade Assistant; please refer to https://developer.android.com/ studio/build/agp-upgrade-assistant for more information. > Could not get unknown property 'bundleReleaseAar' for object of type org.gradle.api.publish.maven.internal.publication .DefaultMavenPublication. ------------------------------------------------------------------------ Explanation: "You must set the namespace in the module-level 'build.gradle.kts' file, rather than the manifest file." For more info see: https://developer.android.com/build/releases/ gradle-plugin#

Release Notes: https://docs.gradle.org/8.1.1/release-notes.html Command: ./gradlew wrapper --gradle-version=8.1.1 --distribution-type=all ------------------------------------------------------------------------ As per the previous d85ad7b commit and its description, this change is a follow-up upgrade, which fully completes this Gradle upgrade.

FYI: This was suggested automatically using the AGP upgrade assistant.

Release Notes: https://docs.gradle.org/8.2.1/release-notes.html Command: ./gradlew wrapper --gradle-version=8.2.1 --distribution-type=all

Release Notes: https://docs.gradle.org/8.1.1/release-notes.html Command: ./gradlew wrapper --gradle-version=8.1.1 --distribution-type=all ------------------------------------------------------------------------ FYI: You will notice that the associated 'gradle-wrapper.jar', 'gradlew' and 'gradlew.bat' files are not updated. This is because of the breaking changes that this upgrade introduces, including the 'AGP' upgrade and its associated breaking changes (namespace, build option, etc). As such, this Gradle upgrade command is only half done. PS: When all the breaking changes are resolved, this Gradle command will be issued again, which should fully complete this upgrade.

Release Notes: https://developer.android.com/build/releases/ gradle-plugin#agp-8-0-2

This is an AGP version '8.0' breaking change that requires 'namespace' in module-level build scripts, see build failure below: ------------------------------------------------------------------------ FAILURE: Build failed with an exception. * What went wrong: A problem occurred configuring root project '@wordpress_react-native-bridge'. > Failed to notify project evaluation listener. > Could not create an instance of type com.android.build.api.variant.impl.LibraryVariantBuilderImpl. > Namespace not specified. Please specify a namespace in the module's build.gradle file like so: android { namespace 'com.example.namespace' } If the package attribute is specified in the source AndroidManifest.xml, it can be migrated automatically to the namespace value in the build.gradle file using the AGP Upgrade Assistant; please refer to https://developer.android.com/ studio/build/agp-upgrade-assistant for more information. > Could not get unknown property 'bundleReleaseAar' for object of type org.gradle.api.publish.maven.internal.publication .DefaultMavenPublication. ------------------------------------------------------------------------ Explanation: "You must set the namespace in the module-level 'build.gradle.kts' file, rather than the manifest file." For more info see: https://developer.android.com/build/releases/ gradle-plugin#

This is an AGP version '8.0' breaking change that changes the build option default values, see build failure below: ------------------------------------------------------------------------ FAILURE: Build failed with an exception. * What went wrong: A problem occurred configuring project ':react-native-bridge'. > Failed to notify project evaluation listener. > com.android.builder.errors.EvalIssueException: defaultConfig contains custom BuildConfig fields, but the feature is disabled. > Could not get unknown property 'bundleReleaseAar' for object of type org.gradle.api.publish.maven.internal.publication .DefaultMavenPublication. ------------------------------------------------------------------------ Explanation: "Starting with AGP 8.0, the default values for these flags have changed to improve build performance. AGP 8.0 doesn't generate 'BuildConfig' by default. You need to specify this option using the DSL in the projects where you need it." For more info see: https://developer.android.com/build/releases/ gradle-plugin#default-changes

Release Notes: https://docs.gradle.org/8.1.1/release-notes.html Command: ./gradlew wrapper --gradle-version=8.1.1 --distribution-type=all ------------------------------------------------------------------------ As per the previous 5ff4e6e commit and its description, this change is a follow-up upgrade, which fully completes this Gradle upgrade

FYI: This was suggested automatically using the AGP upgrade assistant.

Release Notes: https://docs.gradle.org/8.2.1/release-notes.html Command: ./gradlew wrapper --gradle-version=8.2.1 --distribution-type=all

fluiddot · 2023-07-25T10:58:34Z

@fluiddot The changes so far looks good to me. I've left one comment about the settings.gradle changes for react-native-bridge.

For the GitHub action failure related to JDK 17, you can add the following step prior to the task execution so that CI has access to JDK 17:
- name: Set Up JDK 17
  uses: actions/setup-java@v3
  with:
    java-version: 17
    distribution: 'corretto'
You can see an example of this in this PR.

Great, thanks @oguzkocer for sharing the update 🙇 !

We are also updating the publish to S3 Gradle Plugin version to 0.8.0 for all our projects as part of this AGP update. Could you update this & this to reflect that? You'll also need to remove the line with androidSourcesJar from the publish block here & here. Here is an example commit that encapsulates this change.

Hope this helps and let me know if you have any questions/concerns!

Sure thing, I'll apply the updates you shared. Thanks!

Revert removing package from AndroidManifest

fluiddot · 2023-07-25T13:56:00Z

packages/react-native-bridge/android/react-native-bridge/src/main/AndroidManifest.xml

-<?xml version="1.0" encoding="utf-8"?>
-<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+
+<manifest xmlns:android="http://schemas.android.com/apk/res/android" package="org.wordpress.mobile.ReactNativeGutenbergBridge">


The React Native CLI fetches the package attribute from AndroidManifest files, so we can't remove it. Otherwise, we encounter the following error when installing the Pods for the demo project:

error Failed to build the app: No package name found. Found errors in gutenberg-mobile/gutenberg/node_modules/@wordpress/react-native-bridge/android/react-native-bridge/src/main/AndroidManifest.xml.

This can be tested by removing the package attribute and running the command npx react-native config (this command is used behind the scenes when installing the Pods).

I think it is okay (safe) to keep this package definition here @fluiddot , that is, as long as we make sure to have the same namespace defined on the inner react-native-bridge/build.gradle level, just we already did. 👍

PS: We just need to not forget to update one without the other, that is, if we ever need to do something like that anyway (but I doubt that this will be happening anytime soon). 🤷

I think it is okay (safe) to keep this package definition here @fluiddot , that is, as long as we make sure to have the same namespace defined on the inner react-native-bridge/build.gradle level, just we already did. 👍

PS: We just need to not forget to update one without the other, that is, if we ever need to do something like that anyway (but I doubt that this will be happening anytime soon). 🤷

Good point. I think having an inline comment in both build.gradle and AndroidManifest.xml files reminding this would be helpful to avoid forgetting that both need to be updated. I'll add this 💨 .

I applied my above suggestion in 67ca6bd.

ParaskP7

👋 @fluiddot !

From where I stand, everything LGTM, thank you so much for taking this to the finish line, you are a rockstar! 🙇 ❤️ 🚀

As such, I am personally going to approve this, but I suggest having @oguzkocer taking a final look, getting his approval here too, that is, before we proceed with the JP/WPAndroid testing part via this JP/WPAndroid#18775 client PR.

fluiddot · 2023-07-25T14:45:02Z

From where I stand, everything LGTM, thank you so much for taking this to the finish line, you are a rockstar! 🙇 ❤️ 🚀

As such, I am personally going to approve this, but I suggest having @oguzkocer taking a final look, getting his approval here too, that is, before we proceed with the JP/WPAndroid testing part via this JP/WPAndroid#18775 client PR.

Thanks, you're more than welcome @ParaskP7 😊. All CI jobs are passing, but I encountered issues related to CI jobs and Java 17 in the Gutenberg Mobile PR. I'm actively working on it, at least to solve the ones related to CircleCI. However, I'm a bit blocked with Buildkite so I'm wondering if you could take a look when you are available (reference). Thanks!

ParaskP7 · 2023-07-25T14:50:45Z

Thanks, you're more than welcome @ParaskP7 😊.

❤️ x ❤️ ^ ❤️

All CI jobs are passing, but I encountered issues related to CI jobs and Java 17 in the wordpress-mobile/gutenberg-mobile#5989. I'm actively working on it, at least to solve the ones related to CircleCI.

Yea, I am aware of that, just took a look... 😞 🤷 😞

However, I'm a bit blocked with Buildkite so I'm wondering if you could take a look when you are available (wordpress-mobile/gutenberg-mobile#5989 (comment)). Thanks!

As per my comment here I think it is best to have @oguzkocer take a quick look when he becomes available later today. In the meanwhile, unfortunately, I'll need to switch context and work on something different for the rest of my day today.

This comment will avoid forgetting about updating the package name in all places needed.

…-agp-to-8.0.2 # Conflicts: # package-lock.json # packages/react-native-aztec/android/gradle/wrapper/gradle-wrapper.jar # packages/react-native-aztec/android/gradle/wrapper/gradle-wrapper.properties # packages/react-native-aztec/android/gradlew.bat # packages/react-native-bridge/android/gradle/wrapper/gradle-wrapper.jar # packages/react-native-bridge/android/gradle/wrapper/gradle-wrapper.properties # packages/react-native-bridge/android/gradlew.bat # packages/react-native-editor/android/gradle/wrapper/gradle-wrapper.jar # packages/react-native-editor/android/gradle/wrapper/gradle-wrapper.properties # packages/react-native-editor/android/gradlew.bat # packages/react-native-editor/android/settings.gradle # packages/react-native-editor/package.json

fluiddot · 2023-07-28T09:04:58Z

Heads up that I've updated AGP to version to a newer version (8.1.0) in order to match WP-Android. Additionally, after updating the branch with trunk, I removed a patch we introduced for the RN upgrade 0.71.11 that is no longer necessary due to using a newer version of the React Native Gradle Plugin (665c586).

fluiddot

I've tested the following items and all succeeded:

Publish react-native-aztec library locally ✅
Publish react-native-bridge library locally ✅
Build and run react-native-editor ✅
Build and run WP-Android using this PR and composite build ✅
NOTE: I had to locally bump AGP and update with trunk when using the WP-Android PR.

The PR is now ready to review and once we have a green light in wordpress-mobile/WordPress-Android#18775, we could proceed to merge it. Thanks!

fluiddot · 2023-07-26T10:18:59Z

packages/react-native-aztec/android/build.gradle

+        androidxRecyclerviewVersion = '1.1.0'
+
+        // test
+        junitAztecVersion = '4.13' // TODO: Align 'junit' versions.


@ParaskP7 should be this version aligned with WordPress-Android or AztecEditor-Android?

Just checking whether this question was answered in another thread, or is it still outstanding? If it's correct that we should use the WordPress-Android version, should we remove the TODO?

Nope, it hasn't been answered yet. I assume aligning the versions is not critical and only a matter of keeping version consistency across libraries. In any case, I'll let @ParaskP7 and @oguzkocer share insights about this. In the meantime, I'll remove the TODO. If we need to follow up on this, we could do it in a GitHub issue.

packages/react-native-bridge/android/settings.gradle

fluiddot · 2023-07-26T11:32:00Z

packages/react-native-editor/package.json

 		"@react-native-community/blur": "4.2.0",
 		"@react-native-community/slider": "https://raw.githubusercontent.com/wordpress-mobile/react-native-slider/v3.0.2-wp-4/react-native-community-slider-3.0.2-wp-4.tgz",
 		"@react-native-masked-view/masked-view": "0.2.6",
+		"@react-native/gradle-plugin": "0.72.11",


Originally, we tried patching the React Native Gradle plugin, as discussed here. But this turned out to be complex and hard to maintain. For this reason, the incompatibility with the Gradle plugin has been solved by adding a specific and newer version. This seems safe even though we use an older React Native version.

NOTE: The React Native Gradle Plugin is a transitive dependency of React Native.

fluiddot · 2023-07-28T09:10:20Z

patches/react-native-gradle-plugin+0.71.19.patch

We no longer this patch as WP-Android will use an Android Gradle Plugin version above the one used by the React Native Gradle Plugin (8.2.1).

fluiddot · 2023-07-28T09:14:26Z

.github/workflows/enforce-pr-labels.yml

Seems this file got automatically reformatted when updating with trunk and committing 🤔. I checked the format of other workflow files (example) and now it's matching it, so looks like a safe change to apply.

cc @priethor as author of #52760

Aha, the linter didn't throw any errors, but it's true the spacing wasn't matching the other yaml files. Thanks for catching this, and feel free to push the changes! 👍

SiobhyB

@fluiddot, thank you for all the work on this! I confirmed that the demo app builds as expected for me and, looking through the changes, I only had one question that is likely not blocking. Based on that, as well as the questions/review from Petros and Oguz, going ahead to approve. 👏 👏 🎉

SiobhyB · 2023-07-28T10:15:43Z

packages/react-native-aztec/android/build.gradle

+        androidxRecyclerviewVersion = '1.1.0'
+
+        // test
+        junitAztecVersion = '4.13' // TODO: Align 'junit' versions.


Just checking whether this question was answered in another thread, or is it still outstanding? If it's correct that we should use the WordPress-Android version, should we remove the TODO?

…-agp-to-8.0.2 # Conflicts: # .github/workflows/enforce-pr-labels.yml

ParaskP7 added 30 commits July 21, 2023 18:42

Build: Move android related gradle properties to its own group for aztec

cc1ca68

Deps: Extract agp version to settings build gradle for aztec

eb29afb

Deps: Extract publish to s3 version to settings build gradle for aztec

22ed356

Deps: Add versions groups to root build gradle for aztec

3c2cd6f

Deps: Extract androidx legacy version to root build gradle for aztec

dd97556

Deps: Extract androidx gridlayout version to root build gradle for aztec

2a66c7a

Deps: Extract androidx cardview version to root build gradle for aztec

0767c4e

Deps: Extract androidx appcompat version to root build gradle for aztec

d9af77e

Deps: Extract androidx recyclerview version to root bld gradle for aztec

7c2c07b

Build: Upgrade agp to 8.0.2 for aztec

f63df55

Release Notes: https://developer.android.com/build/releases/ gradle-plugin#agp-8-0-2

Build: Migrate dsl properties from lint options to lint for aztec

c0d9c1a

FYI: This was suggested automatically using the AGP upgrade assistant.

Build: Upgrade gradle to 8.2.1 for aztec

c106962

Release Notes: https://docs.gradle.org/8.2.1/release-notes.html Command: ./gradlew wrapper --gradle-version=8.2.1 --distribution-type=all

Build: Move android related gradle prop. to its own group for bridge

ab9d379

Deps: Extract agp version to settings build gradle for bridge

60a411f

Deps: Extract publish to s3 version to settings build gradle for bridge

9ceb140

Deps: Extract facebook fresco react native related version for bridge

143c768

Deps: Extract google material version to root build gradle for bridge

e60fa86

Deps: Extract wordpress utils version to root build gradle for bridge

fc5ad2a

Deps: Extract junit version to root build gradle for bridge

ab4ba07

Build: Upgrade agp to 8.0.2 for bridge

565f0b8

Release Notes: https://developer.android.com/build/releases/ gradle-plugin#agp-8-0-2

Build: Migrate dsl properties from lint options to lint for bridge

47210b7

FYI: This was suggested automatically using the AGP upgrade assistant.

Build: Upgrade gradle to 8.2.1 for bridge

fb26a88

Release Notes: https://docs.gradle.org/8.2.1/release-notes.html Command: ./gradlew wrapper --gradle-version=8.2.1 --distribution-type=all

fluiddot added 3 commits July 25, 2023 12:59

Use Java 17 in Android E2E tests

f1738ff

Update publish-to-s3 Gradle plugin to 0.8.0

86c5dc2

Revert removing package from AndroidManifest

ced1fc9

Revert removing package from AndroidManifest

fluiddot commented Jul 25, 2023

View reviewed changes

ParaskP7 approved these changes Jul 25, 2023

View reviewed changes

fluiddot marked this pull request as ready for review July 25, 2023 14:45

fluiddot added 6 commits July 25, 2023 16:58

Add inline comment to remind updating package name

67ca6bd

This comment will avoid forgetting about updating the package name in all places needed.

Add .java-version file to use Java 17

0cf7e42

Bump Android Gradle Plugin to 8.1.0

1ba4251

Remove react-native-gradle patch

665c586

Update react-native-editor changelog

7fead25

fluiddot added the [Type] Build Tooling Issues or PRs related to build tooling label Jul 28, 2023

fluiddot changed the title ~~[RNMobile] Upgrade Gradle to 8.2.1 and AGP to 8.0.2~~ [RNMobile] Upgrade Gradle to 8.2.1 and AGP to 8.1.0 Jul 28, 2023

fluiddot commented Jul 28, 2023

View reviewed changes

SiobhyB self-requested a review July 28, 2023 09:45

SiobhyB approved these changes Jul 28, 2023

View reviewed changes

fluiddot added 2 commits July 28, 2023 19:38

Merge branch 'trunk' into rnmobile/0.69.4-upgrade-gradle-to-8.2.1-and…

6300536

…-agp-to-8.0.2 # Conflicts: # .github/workflows/enforce-pr-labels.yml

Remove TODO inline comment in build.gradle

0f7ee31

fluiddot enabled auto-merge (squash) July 28, 2023 17:41

fluiddot merged commit 6e4bc84 into trunk Jul 28, 2023

fluiddot deleted the rnmobile/0.69.4-upgrade-gradle-to-8.2.1-and-agp-to-8.0.2 branch July 28, 2023 18:13

github-actions bot added this to the Gutenberg 16.4 milestone Jul 28, 2023

twstokes mentioned this pull request Aug 1, 2023

Native Mobile current focus areas #38407

Closed

SiobhyB mentioned this pull request Aug 3, 2023

Release 1.101.0 wordpress-mobile/gutenberg-mobile#6024

Merged

4 tasks

dcalhoun mentioned this pull request Dec 13, 2024

build(deps): Bump the kotlin-ksp group with 11 updates wordpress-mobile/WordPress-Android#21515

Closed

Conversation

fluiddot commented Jul 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What?

Why?

How?

Testing Instructions

Testing Instructions for Keyboard

Screenshots or screencast

Uh oh!

fluiddot commented Jul 25, 2023

Uh oh!

fluiddot Jul 25, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ParaskP7 left a comment

Choose a reason for hiding this comment

Uh oh!

fluiddot commented Jul 25, 2023

Uh oh!

ParaskP7 commented Jul 25, 2023

Uh oh!

fluiddot commented Jul 28, 2023

Uh oh!

fluiddot left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

priethor Jul 28, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SiobhyB left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

fluiddot commented Jul 24, 2023 •

edited

Loading

fluiddot Jul 25, 2023 •

edited

Loading

priethor Jul 28, 2023 •

edited

Loading

SiobhyB left a comment •

edited

Loading