perf: reduce APK size with ProGuard enabled #34218

hurali97 · 2024-01-10T09:31:42Z

Details

This PR enables minification and resource shrinking for android using ProGuard. This gives us 10.4 MB reduction in Download Size.

Before:

	APK Size MB	Download Size MB
All architectures	127	123.3

After:

	APK Size MB	Download Size MB
All architectures	116.5	112.9

Fixed Issues

$ #34222
PROPOSAL: #33070 (comment)

Tests

Install the APK
Launch the app and use normally
The app shouldn't crash and shouldn't miss any functionality
Verify that no errors appear in the JS console

Offline tests

QA Steps

Verify that no errors appear in the JS console

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
- I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
  - If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
I verified that if a function's arguments changed that all usages have also been updated correctly
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label so the design team can review the changes.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native

Screen.Recording.2024-01-10.at.4.44.02.PM.mov

Android: mWeb Chrome

N/A

iOS: Native

N/A

iOS: mWeb Safari

N/A

MacOS: Chrome / Safari

N/A

MacOS: Desktop

N/A

hurali97 · 2024-01-10T11:53:38Z

It would be ideal to NOT MERGE this PR until the QA completes their testing and confirms that no crashes or loss of functionality is noticed.

We can move forward with creating the builds for this PR and kick off the QA testing.

cc: @roryabraham @mountiny

melvin-bot · 2024-01-10T11:53:46Z

@s77rt Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

mountiny · 2024-01-10T12:35:21Z

Running a build here https://github.com/Expensify/App/actions/runs/7474984009

Julesssss

Testing well for me, though we'll need to keep a close eye out for regressions once this is merged as it removes and obfuscates code.

Julesssss · 2024-01-10T13:30:39Z

One super minor thing I noticed is that the AdHoc badge doesn't display, but I haven't checked previous AdHoc builds in a while...

mountiny · 2024-01-10T13:31:30Z

@shubham1206agra will do some initial testing and we would probably ask QA to do a full regression on the android build before merging too

mountiny · 2024-01-10T13:31:47Z

@shubham1206agra will do some initial testing and we would probably ask QA to do a full regression on the android build before merging too

shubham1206agra · 2024-01-10T13:39:27Z

Please check notification here

mountiny · 2024-01-10T13:42:32Z

Is it the logo? that might be case for other adhoc builds too, that would be good to check

shubham1206agra · 2024-01-10T14:17:40Z

I think the App is working fine. Except the logo, crossed check with other adhoc build where it works fine.
Note - Please check the permissions area as I got a phantom permission while doing distance request in confirmation page.

cc @mountiny @Julesssss

Edit - One think I noticed is that the message does not scroll to bottom at all.

shubham1206agra · 2024-01-10T14:29:56Z

XRecorder_10012024_184612_compressed.mp4

shubham1206agra · 2024-01-10T15:40:01Z

@hurali97 Please address this #34218 (comment)

mountiny · 2024-01-10T18:03:50Z

@shubham1206agra did you confirm that does not happen on other Android adhoc builds?

shubham1206agra · 2024-01-10T18:07:35Z

Yes

hurali97 · 2024-01-11T12:19:26Z

@hurali97 Please address this #34218 (comment)

@shubham1206agra It's fixed now.

shubham1206agra · 2024-01-11T12:28:59Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label so the design team can review the changes.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

XRecorder_10012024_184612_compressed.mp4

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

shubham1206agra · 2024-01-11T12:29:28Z

@hurali97 Can you confirm the final size of apk now?

hurali97 · 2024-01-11T12:55:12Z

@hurali97 Can you confirm the final size of apk now?

Yeah sure.

After adding keep rules for resources:

	APK Size MB	Download Size MB
All architectures	116.5	113

There's 0.1 MB increase in Download Size and APK Size remains intact. We still save 10.3 MB in Download size.

Julesssss · 2024-01-11T13:00:02Z

android/app/src/main/res/raw/keep.xml

+<resources xmlns:tools="http://schemas.android.com/tools"
+    tools:keep="@mipmap/ic_launcher, @drawable/bootsplash*, @drawable/alert_background,
+        @drawable/ic_launcher*, @drawable/ic_notification*, @drawable/picker_background,
+        @drawable/rn_edit_text_material" />


This is a small selection of resources, did we get this list from anywhere specific?

I inspected the res directory and all the resources that were used in the codebase by search, were added in keep rule. For example, drawable/datepicker_background.xml wasn't being referenced anywhere, so I didn't add it to the keep rule.

So there's no prescription that says what to keep but anything that's referenced and is being used can be kept. I also tested on build variants like production and adhoc and I get the correct assets as our keep xml file is inherited for each build variant.

https://developer.android.com/build/shrink-code#keep-resources

Resources in react-native/assets aren't touched by resource shrinker, so that's why they aren't added in the keep rules.

I also tested on build variants like production and adhoc and I get the correct assets as our keep xml file is inherited for each build variant.

Okay cool, that's what I was worried about as it's not clear that alternative resourses would be kept. For example: drawable-xxxhdpi/bootsplash_logo.png

I'm just generating another test build to confirm that we're not defaulting to the lower res drawables.

shubham1206agra

LGTM!

melvin-bot · 2024-01-11T13:23:21Z

We did not find an internal engineer to review this PR, trying to assign a random engineer to #34222 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

github-actions · 2024-01-11T13:55:40Z

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/34218/index.html	❌ FAILED ❌
	The QR code can't be generated, because the iOS build failed
Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/34218/NewExpensify.dmg	https://34218.pr-testing.expensify.com

👀 View the workflow run that generated this build 👀

…y-App into hur/enable-proguard

mountiny · 2024-01-19T11:03:22Z

Making a new test build

github-actions · 2024-01-19T11:28:41Z

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/34218/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/34218/index.html

Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/34218/NewExpensify.dmg	https://34218.pr-testing.expensify.com

👀 View the workflow run that generated this build 👀

Julesssss

LGTM, was unable to find any broken features

Julesssss · 2024-01-19T14:15:36Z

Oh wait, did we confirm the logo issue doesn't exist on other AdHoc builds?

I think the App is working fine. Except the logo, crossed check with other adhoc build where it works fine.

Julesssss · 2024-01-19T14:16:56Z

One other thing, did this PR introduce the regression where Android build information isn't shown for AdHoc downloads?

shubham1206agra · 2024-01-19T14:18:39Z

Oh wait, did we confirm the logo issue doesn't exist on other AdHoc builds?

I think the App is working fine. Except the logo, crossed check with other adhoc build where it works fine.

I have checked this. Works fine for me.

Julesssss · 2024-01-19T14:46:33Z

I'm still seeing it on a Pixel 6a, perhaps this depends on DP?

mountiny · 2024-01-19T15:29:27Z

@Julesssss I have that on my iPhone adhoc build, other one too, not related

shubham1206agra · 2024-01-19T17:12:08Z

I'm still seeing it on a Pixel 6a, perhaps this depends on DP?

This is a known problem in other builds too

mountiny · 2024-01-19T18:12:43Z

I think this is good to go then!

mountiny

Ah why is this still not merged... going to merge it

OSBotify · 2024-01-25T18:42:53Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2024-01-29T19:24:03Z

🚀 Deployed to staging by https://github.com/mountiny in version: 1.4.33-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	cancelled 🔪
🕸 web 🕸	success ✅

OSBotify · 2024-01-31T02:30:54Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.4.33-5 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅

hurali97 added 2 commits January 10, 2024 14:29

feat: enable ProGuard

882b8c6

feat: add ProGuard rules

0ae9249

hurali97 marked this pull request as ready for review January 10, 2024 11:53

hurali97 requested a review from a team as a code owner January 10, 2024 11:53

melvin-bot bot requested review from s77rt and removed request for a team January 10, 2024 11:53

mountiny changed the title ~~perf: reduce APK size with ProGuard enabled~~ [HOLD] perf: reduce APK size with ProGuard enabled Jan 10, 2024

mountiny assigned hurali97 Jan 10, 2024

mountiny added the Ready To Build label Jan 10, 2024

This comment has been minimized.

Sign in to view

mountiny requested review from shubham1206agra and removed request for s77rt January 10, 2024 13:10

Julesssss previously approved these changes Jan 10, 2024

View reviewed changes

fix: add resource keep rules to not remove assets

35155fd

hurali97 dismissed Julesssss’s stale review via 35155fd January 11, 2024 12:09

Julesssss reviewed Jan 11, 2024

View reviewed changes

shubham1206agra approved these changes Jan 11, 2024

View reviewed changes

hurali97 added 2 commits January 19, 2024 07:36

Merge branch 'main' of https://github.com/callstack-internal/Expensif…

2479f3e

…y-App into hur/enable-proguard

feat: add dontwarn flag to in proguard rules to allow build to succeed

0d6384d

mountiny changed the title ~~[HOLD] perf: reduce APK size with ProGuard enabled~~ perf: reduce APK size with ProGuard enabled Jan 19, 2024

Julesssss approved these changes Jan 19, 2024

View reviewed changes

mountiny approved these changes Jan 25, 2024

View reviewed changes

mountiny merged commit 889051c into Expensify:main Jan 25, 2024
10 checks passed

github-actions bot mentioned this pull request Jan 29, 2024

Deploy Checklist: New Expensify 2024-01-29 #35328

Closed

mkhutornyi mentioned this pull request Jan 30, 2024

[HOLD for payment 2024-02-07] [HOLD for payment 2024-02-07] [$500] Android - Wallet - App crashes on tapping enable wallet. #35344

Closed

6 tasks

francoisl mentioned this pull request Jan 31, 2024

[CP Staging] fix crash on tapping enable wallet in android #35440

Merged

60 tasks

melvin-bot bot mentioned this pull request Jan 31, 2024

[HOLD for payment 2024-02-07] App CallStack Audit: Enable ProGuard to optimize APK Size #34222

Closed

hurali97 mentioned this pull request Apr 4, 2024

[Audit][Implementation] - Use shrinkMode strict to reduce the APK size #39592

Closed

50 tasks

perf: reduce APK size with ProGuard enabled #34218

perf: reduce APK size with ProGuard enabled #34218

Conversation

hurali97 commented Jan 10, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

hurali97 commented Jan 10, 2024

melvin-bot bot commented Jan 10, 2024

mountiny commented Jan 10, 2024

This comment has been minimized.

Julesssss left a comment • edited Loading

Choose a reason for hiding this comment

Julesssss commented Jan 10, 2024

mountiny commented Jan 10, 2024

mountiny commented Jan 10, 2024

shubham1206agra commented Jan 10, 2024

mountiny commented Jan 10, 2024

shubham1206agra commented Jan 10, 2024 • edited Loading

shubham1206agra commented Jan 10, 2024

shubham1206agra commented Jan 10, 2024

mountiny commented Jan 10, 2024

shubham1206agra commented Jan 10, 2024

hurali97 commented Jan 11, 2024

shubham1206agra commented Jan 11, 2024

Reviewer Checklist

Screenshots/Videos

shubham1206agra commented Jan 11, 2024

hurali97 commented Jan 11, 2024

Julesssss Jan 11, 2024

Choose a reason for hiding this comment

hurali97 Jan 11, 2024

Choose a reason for hiding this comment

hurali97 Jan 11, 2024 • edited Loading

Choose a reason for hiding this comment

Julesssss Jan 11, 2024 • edited Loading

Choose a reason for hiding this comment

shubham1206agra left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Jan 11, 2024

github-actions bot commented Jan 11, 2024

mountiny commented Jan 19, 2024

github-actions bot commented Jan 19, 2024

Julesssss left a comment

Choose a reason for hiding this comment

Julesssss commented Jan 19, 2024

Julesssss commented Jan 19, 2024

shubham1206agra commented Jan 19, 2024

Julesssss commented Jan 19, 2024

mountiny commented Jan 19, 2024

shubham1206agra commented Jan 19, 2024

mountiny commented Jan 19, 2024

mountiny left a comment

Choose a reason for hiding this comment

OSBotify commented Jan 25, 2024

OSBotify commented Jan 29, 2024

OSBotify commented Jan 31, 2024

hurali97 commented Jan 10, 2024 •

edited

Loading

Julesssss left a comment •

edited

Loading

shubham1206agra commented Jan 10, 2024 •

edited

Loading

hurali97 Jan 11, 2024 •

edited

Loading

Julesssss Jan 11, 2024 •

edited

Loading