Adding support for android app bundle - Issue #17829 #24440

pranayairan · 2018-11-16T18:00:07Z

Implementation Details
This PR adds support for Android App Bundle . Android App bundle is a new packaging format that helps in reducing app size and enabled new features like dynamic delivery for android apps.

I added a new build command appbundle to the flutter tool and introduced bulding app bundle as another option of building APK.

To test : follow all steps to modify your build.gradle file as listed here https://flutter.io/docs/deployment/android. To generate a android app bundle run following command flutter build appbundle

In my current testing this with my app, I have not found any improvements in app size, since flutter apk build only adding arm file. But as we add support to more architectures for flutter app and add more resources, android app bundle can help in optimizing the app size significantly.

Affected Areas
Flutter tool build section.

Issue Link
#17829

googlebot · 2018-11-16T18:00:11Z

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here (e.g. I signed it!) and we'll verify it.

What to do if you already signed the CLA

Individual signers

It's possible we don't have your GitHub username or you're using a different email address on your commit. Check your existing CLA data and verify that your email is set on your git commits.

Corporate signers

Your company has a Point of Contact who decides which employees are authorized to participate. Ask your POC to be added to the group of authorized contributors. If you don't know who your Point of Contact is, direct the Google project maintainer to go/cla#troubleshoot (Public version).
The email used to register you as an authorized contributor must be the email used for the Git commit. Check your existing CLA data and verify that your email is set on your git commits.
The email used to register you as an authorized contributor must also be attached to your GitHub account.

pranayairan · 2018-11-16T18:29:40Z

I signed it!

googlebot · 2018-11-16T18:29:42Z

CLAs look good, thanks!

Hixie · 2018-11-16T20:50:50Z

bin/flutter

-# FLUTTER_TOOL_ARGS="--checked $FLUTTER_TOOL_ARGS"
-# FLUTTER_TOOL_ARGS="$FLUTTER_TOOL_ARGS --observe=65432"
+#FLUTTER_TOOL_ARGS="--checked $FLUTTER_TOOL_ARGS"
+#FLUTTER_TOOL_ARGS="$FLUTTER_TOOL_ARGS --observe=65432"


nit: probably best to leave it as before to avoid churn

Hixie · 2018-11-16T20:51:18Z

packages/flutter_tools/lib/src/android/app_bundle.dart

+        'The build process for Android has changed, and the current project configuration\n'
+            'is no longer valid. Please consult\n\n'
+            '  https://github.com/flutter/flutter/wiki/Upgrading-Flutter-projects-to-build-with-gradle\n\n'
+            'for details on how to upgrade the project.'


nit: indentation is off (each string should be the same indentation)

Hixie · 2018-11-16T20:51:54Z

packages/flutter_tools/lib/src/android/app_bundle.dart

+      printError(message, wrap: false);
+    }
+    throwToolExit('Try re-installing or updating your Android SDK.');
+  }


can we factor out these checks so that all the commands that care can just call the one method that does all of this?

do you think androidSdk is the place where I should add this check? it already has a method validateSdkWellFormed that is doing the major heavy lifting of checking. All this code is doing is printing it on the console and throwing an error.

Hixie · 2018-11-16T20:52:31Z

packages/flutter_tools/lib/src/android/gradle.dart

+
+  if(isBuildingBundle){
+    assembleTask = project.bundleTaskFor(buildInfo);
+  }else{


nit: please use the same format as other places in the file (e.g. argument goes on the next line, spaces after if and before { and around else, etc)

Hixie · 2018-11-16T20:52:49Z

packages/flutter_tools/lib/src/android/gradle.dart

  }
  final Status status = logger.startProgress(
-    "Gradle task '$assembleTask'...",
+    "Gradle task'$assembleTask'...",


missing space

Hixie · 2018-11-16T20:55:41Z

cc @jason-simmons for detailed review

Thanks so much for this contribution!

jason-simmons · 2018-11-16T21:04:05Z

cc @matthew-carroll @sbaranov

googlebot · 2018-11-16T21:16:04Z

We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for all the commit author(s) or Co-authors. If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google.
In order to pass this check, please resolve this problem and have the pull request author add another comment and the bot will run again. If the bot doesn't comment, it means it doesn't think anything has changed.

This reverts commit 2041d45.

pranayairan · 2018-11-16T21:27:02Z

I signed it!

googlebot · 2018-11-16T21:27:06Z

So there's good news and bad news.

👍 The good news is that everyone that needs to sign a CLA (the pull request submitter and all commit authors) have done so. Everything is all good there.

😕 The bad news is that it appears that one or more commits were authored or co-authored by someone other than the pull request submitter. We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that here in the pull request.

Note to project maintainer: This is a terminal state, meaning the cla/google commit status will not change from this state. It's up to you to confirm consent of all the commit author(s), set the cla label to yes (if enabled on your project), and then merge this pull request when appropriate.

googlebot · 2018-11-16T21:37:59Z

A Googler has manually verified that the CLAs look good.

(Googler, please make sure the reason for overriding the CLA status is clearly documented in these comments.)

jason-simmons

Overall approach LGTM

jason-simmons · 2018-11-19T18:47:38Z

packages/flutter_tools/lib/src/android/gradle.dart

+  if (bundleFile.existsSync())
+    return bundleFile;
+  if (buildInfo.flavor != null) {
+    // Android Studio Gradle plugin v3 adds flavor to path. for bundle the folder name is flavorModename


nit: would write this as Android Studio Gradle plugin v3 adds the flavor to the path. For the bundle the folder name is the flavor plus the mode name.

jason-simmons · 2018-11-19T18:48:21Z

packages/flutter_tools/lib/src/android/gradle.dart

+    return bundleFile;
+  if (buildInfo.flavor != null) {
+    // Android Studio Gradle plugin v3 adds flavor to path. for bundle the folder name is flavorModename
+    bundleFile = fs.file(fs.path.join(project.bundleDirectory.path, buildInfo.flavor+modeName, bundleFileName));


nit: use spaces around operators: flavor + modeName

jason-simmons · 2018-11-19T18:48:45Z

packages/flutter_tools/lib/src/android/gradle.dart


 class GradleProject {
-  GradleProject(this.buildTypes, this.productFlavors, this.apkDirectory);
+  GradleProject(this.buildTypes, this.productFlavors, this.apkDirectory,this.bundleDirectory);


nit: add a space after the comma: , this.bundleDirectory

jason-simmons · 2018-11-19T18:56:07Z

packages/flutter_tools/lib/src/commands/build_appbundle.dart

+
+  @override
+  final String description = 'Build an Android App Bundle file from your app.\n\n'
+    'This command can build debug and release versions app bundle for your application. \'debug\' builds support '


nit: versions of an app bundle

jason-simmons · 2018-11-19T18:57:24Z

packages/flutter_tools/lib/src/android/gradle.dart

+      appSize = ' (${getSizeAsMB(apkFile.lengthSync())})';
+    }
+    printStatus('Built ${fs.path.relative(apkFile.path)}$appSize.');
+  }else{


nit: add spaces before and after else

googlebot · 2018-11-19T21:28:06Z

So there's good news and bad news.

👍 The good news is that everyone that needs to sign a CLA (the pull request submitter and all commit authors) have done so. Everything is all good there.

😕 The bad news is that it appears that one or more commits were authored or co-authored by someone other than the pull request submitter. We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that here in the pull request.

Note to project maintainer: This is a terminal state, meaning the cla/google commit status will not change from this state. It's up to you to confirm consent of all the commit author(s), set the cla label to yes (if enabled on your project), and then merge this pull request when appropriate.

Hixie · 2018-11-20T19:26:31Z

This patch is fantastic, thanks so much for this.

Unfortunately as of today we're in a freeze because of the Flutter Live event, but we'll make sure to land it afterwards. Thanks again for your contribution!

pranayairan · 2018-11-20T20:03:47Z

Awesome :) happy to help. Will circle back after Flutter live.

ghost · 2018-12-01T17:25:31Z

@pranayairan Quick Question: Does this work with iOS as well or is it more towards the Android system?

Taormina · 2018-12-02T21:42:54Z

@yeshwanthvshenoy This should be an Android only thing for submission to the Google Play Store. You can read more about app bundles here: https://developer.android.com/guide/app-bundle/

pranayairan · 2018-12-05T15:23:18Z

@Hixie is the restriction for merging lifted? If yes can we merge the changes?

vandie · 2018-12-05T16:01:30Z

Just out of interest, is this likely to be merged in any time soon?

pranayairan · 2018-12-06T02:29:46Z

@vandie hoping to get this merged in a day or 2, we were waiting for flutter live to be done.

updating the comment to re-run the test

googlebot · 2018-12-19T23:44:56Z

So there's good news and bad news.

👍 The good news is that everyone that needs to sign a CLA (the pull request submitter and all commit authors) have done so. Everything is all good there.

😕 The bad news is that it appears that one or more commits were authored or co-authored by someone other than the pull request submitter. We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that here in the pull request.

Note to project maintainer: This is a terminal state, meaning the cla/google commit status will not change from this state. It's up to you to confirm consent of all the commit author(s), set the cla label to yes (if enabled on your project), and then merge this pull request when appropriate.

updating comments to re-trigger build

…nto app_bundle

* flt_master: (143 commits) Roll engine 215ca15..d8c5ec0 (12 commits) (flutter#25728) Provide some more locations for the FAB. (flutter#24736) Undeprecated BigInteger support, but document what it actually does. (flutter#24511) ClipPath.shape and related fixes (flutter#24816) Handle errors in `compute()` by propagating them to the Future. (flutter#24848) Fix merge conflict. (flutter#25718) Some minor tweaks to InputDecoration (mainly docs). (flutter#24643) Expose font fallback API in TextStyle, Roll engine 54a3577..215ca15 (8 commits) (flutter#25585) Updated Shrine demo (flutter#25674) Pin the goldens repo to a specific commit in the android_views test. (flutter#25678) Friendlier flags for Dart compilation training. (flutter#25645) Revert dependency upgrade to see if it helps with build times and APK size (flutter#25642) Depend on the goldens repo through git. (flutter#25479) no period after an alone link in see also section (flutter#25604) Update links for China help (flutter#25238) Roll engine 6a90418..54a3577 (23 commits) (flutter#25649) Roll engine e859296..6a90418 (4 commits) (flutter#25643) Adding support for android app bundle - Issue flutter#17829 (flutter#24440) Revert "[O] Remove many timeouts. (flutter#23531)" (flutter#25646) [O] Remove many timeouts. (flutter#23531) ...

massivefermion · 2019-01-09T03:48:55Z

So... What happened? Is this merged now? If yes, is there any documentation on how to use it?

Hixie · 2019-01-15T20:16:40Z

flutter build bundle --help should describe how to use this command. Please file a bug if it's not clear. Thanks!

alexandranb · 2019-02-05T14:17:51Z

Hi,

Could you explain on how we could create the bundle and include both versions for 32-bit and 64-bit? For now, my bundle only has armeabi-v7a and I can't seem to figure it out how to include armeabi-v81.

Thanks

pranayairan · 2019-02-05T16:42:17Z

Unfortunately, as of now, it will only include armeabi-v7a. I am not sure if there is armeabi-v81 altogether for flutter. There is an internal code that gets only the armeabi-v7a files for both bundle and APK. I will check if we can generate both.

creativecreatorormaybenot · 2019-02-21T23:05:09Z

@Hixie Should be flutter build appbundle --help.

rockwotj · 2019-03-04T03:11:23Z

@pranayairan if you could add an option to generate both 32 bit and 64 bit you would fix #23055

xiabui · 2019-03-22T05:02:44Z

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here (e.g. I signed it!) and we'll verify it.

What to do if you already signed the CLA

Individual signers

It's possible we don't have your GitHub username or you're using a different email address on your commit. Check your existing CLA data and verify that your email is set on your git commits.

Corporate signers

Your company has a Point of Contact who decides which employees are authorized to participate. Ask your POC to be added to the group of authorized contributors. If you don't know who your Point of Contact is, direct the Google project maintainer to go/cla#troubleshoot (Public version).

The email used to register you as an authorized contributor must be the email used for the Git commit. Check your existing CLA data and verify that your email is set on your git commits.

The email used to register you as an authorized contributor must also be attached to your GitHub account.

I signed it!

adding support for android app bundle.

7cc6607

googlebot added the cla: no label Nov 16, 2018

pranayairan mentioned this pull request Nov 16, 2018

Support for Android App Bundles #17829

Closed

googlebot added cla: yes and removed cla: no labels Nov 16, 2018

removing the debug statement.

95bb156

Hixie reviewed Nov 16, 2018

View reviewed changes

fixing formatting and code review changes.

2041d45

googlebot added cla: no and removed cla: yes labels Nov 16, 2018

pairan and others added 2 commits November 16, 2018 13:18

Revert "fixing formatting and code review changes."

c07c566

This reverts commit 2041d45.

Fixing code formatting issues.

2588101

Hixie added cla: yes and removed cla: no labels Nov 16, 2018

jason-simmons requested changes Nov 19, 2018

View reviewed changes

updating review comments fixing comments and spacing.

b7c664d

zoechi added platform-android Android applications specifically tool Affects the "flutter" command-line tool. See also t: labels. t: gradle "flutter build" and "flutter run" on Android labels Nov 28, 2018

updating the comment to re-run the test

027b8ac

updating the comment to re-run the test

googlebot added cla: no and removed cla: yes labels Dec 19, 2018

pranayairan added 5 commits December 19, 2018 19:15

Merge branch 'master' into app_bundle and resolving conflicts.

da256a9

fixing the formatting.

4d60049

updating comments to re-trigger build

589f9e0

updating comments to re-trigger build

Merge branch 'master' of github.com:flutter/flutter into app_bundle

afbc713

Merge branch 'app_bundle' of https://github.com/pranayairan/flutter i…

9ddd0d4

…nto app_bundle

pranayairan merged commit 368cd7d into flutter:master Dec 21, 2018

pranayairan deleted the app_bundle branch December 21, 2018 06:18

github-actions bot locked as resolved and limited conversation to collaborators Aug 7, 2021

Adding support for android app bundle - Issue #17829 #24440

Adding support for android app bundle - Issue #17829 #24440

Uh oh!

Conversation

pranayairan commented Nov 16, 2018

Uh oh!

googlebot commented Nov 16, 2018

What to do if you already signed the CLA

Individual signers

Corporate signers

Uh oh!

pranayairan commented Nov 16, 2018

Uh oh!

googlebot commented Nov 16, 2018

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Hixie commented Nov 16, 2018

Uh oh!

jason-simmons commented Nov 16, 2018

Uh oh!

googlebot commented Nov 16, 2018

Uh oh!

pranayairan commented Nov 16, 2018

Uh oh!

googlebot commented Nov 16, 2018

Uh oh!

googlebot commented Nov 16, 2018

Uh oh!

jason-simmons 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

googlebot commented Nov 19, 2018

Uh oh!

Hixie commented Nov 20, 2018

Uh oh!

pranayairan commented Nov 20, 2018

Uh oh!

ghost commented Dec 1, 2018

Uh oh!

Taormina commented Dec 2, 2018

Uh oh!

pranayairan commented Dec 5, 2018

Uh oh!

vandie commented Dec 5, 2018

Uh oh!

pranayairan commented Dec 6, 2018

Uh oh!

googlebot commented Dec 19, 2018

Uh oh!

massivefermion commented Jan 9, 2019

Uh oh!

Hixie commented Jan 15, 2019

Uh oh!

alexandranb commented Feb 5, 2019

Uh oh!

pranayairan commented Feb 5, 2019

Uh oh!

creativecreatorormaybenot commented Feb 21, 2019

Uh oh!