[Audit][Implementation] - Use only supported locales to reduce the APK size #39688

hurali97 · 2024-04-05T09:29:40Z

Details

This PR is part of Audit by callstack and is concerned with reducing the APK size. Since it's regarding APK size, it only affects android.

Applications often have dependencies which supports multiple locales. These translations strings are then made part of the APK that is installed by the user. So the user is installing an APK which has translations which he will not even use because it's not supported by the application. For eg, Expensify only supports en and es, so there's no point compiling all other locales in the APK.

Take a look at below screen shot, which has whole lot of other locales like Arabic which we don't even need. They come as part of google-play-services-core, material etc.

We can remove all the non-supported locales by explicitly telling android build tools that we support only en and es. See below how unused strings are then removed from resources.arsc

We managed to reduce the resources.arsc from 3.4MB to 1MB in raw file size. Let's see the impact of this on the APK size. We will benchmark this on the results gained from this PR, they are not related but to only show the final benchmarks from these two PRs:

Before ( linked PR ):

	APK Size MB	Download Size MB
All architectures	103.1	99.3

After:

	APK Size MB	Download Size MB
All architectures	100.8	98.7

We get 2.3 MB of reduction in APK size and 0.6 MB of reduction in Download size 🚀

Fixed Issues

$ #39700
PROPOSAL: #39700

Tests

Testing Steps:

Switching between English and Spanish locales should work fine

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

Screenshots/Videos

Android: Native

Screen.Recording.2024-04-05.at.3.25.53.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

…y-App into audit/app-startup/use-only-required-locales

melvin-bot · 2024-04-05T12:13:33Z

@allroundexperts 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]

…y-App into audit/app-startup/use-only-required-locales

allroundexperts · 2024-04-08T11:51:09Z

@hurali97 Conflicts.

…y-App into audit/app-startup/use-only-required-locales

hurali97 · 2024-04-08T12:41:20Z

@allroundexperts resolved ✅

allroundexperts · 2024-04-08T14:01:23Z

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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design 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

Screen.Recording.2024-04-08.at.7.25.54.PM.mov

Android: mWeb Chrome

Screen.Recording.2024-04-08.at.7.24.41.PM.mov

iOS: Native

Screen.Recording.2024-04-08.at.7.23.52.PM.mov

iOS: mWeb Safari

Screen.Recording.2024-04-08.at.7.21.43.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-04-08.at.7.17.45.PM.mov

MacOS: Desktop

Screen.Recording.2024-04-08.at.7.20.15.PM.mov

allroundexperts

Works good. Thanks!

Julesssss

@hurali97 sorry to not mention this sooner, but I think Android provides a method of automatically removing unused languages here.

Can we use that instead please, because someone trying to add a new language that is unfamiliar with the gradle config is going to waste a lot of time trying to find out why the Android app keeps stripping out the language resources 😄

hurali97 · 2024-04-09T09:22:14Z

Hey @Julesssss

I went through automatic per-app language support and it looks like it's designed for android only projects. Which means the projects which keep their language resources in this format res/values-fr/strings.xml. We can set the default locale in resources.properties but for the alternative language we will have to follow the format and keep our strings there and since Expensify is a RN project this doesn't fit.

This is to only enable the language switcher for the app from settings and it doesn't remove any other unused locales from the dependencies, so it's not worth adding.

If we are concerned about adding new language in the future, can we update ReadMe or language docs to include this information that you have to add let's say fr to resConfigs in app/build.gradle?

Julesssss · 2024-04-09T09:43:14Z

@hurali97 ah okay no worries and thanks for explaining. That's a shame.

I'm still worried that this is going to confuse people who add languages in the future, but maybe a comment above the Gradle config would make this a bit easier to locate. Something like this maybe: // Language variants must be declared here to avoid the resources from being removed during compilation

hurali97 · 2024-04-09T09:49:35Z

@hurali97 ah okay no worries and thanks for explaining. That's a shame.

I'm still worried that this is going to confuse people who add languages in the future, but maybe a comment above the Gradle config would make this a bit easier to locate. Something like this maybe: // Language variants must be declared here to avoid the resources from being removed during compilation

Yes makes sense, I will add it 👍

kacper-mikolajczak · 2024-04-10T07:26:14Z

Conflicts resolved on behalf of @hurali97 as he is out of office. Feel free to hit me up anytime needed with the PR 👍

OSBotify · 2024-04-10T08:50:58Z

✋ 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-04-10T17:47:24Z

🚀 Deployed to staging by https://github.com/Julesssss in version: 1.4.62-0 🚀

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

OSBotify · 2024-04-10T17:56:17Z

🚀 Deployed to staging by https://github.com/Julesssss in version: 1.4.62-0 🚀

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

OSBotify · 2024-04-10T19:35:30Z

🚀 Deployed to staging by https://github.com/Julesssss in version: 1.4.62-0 🚀

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

OSBotify · 2024-04-18T04:33:15Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.4.62-17 🚀

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

hurali97 added 2 commits April 5, 2024 14:28

perf: use only supported locales to reduce the APK size

f64253f

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

080d3b7

…y-App into audit/app-startup/use-only-required-locales

mountiny mentioned this pull request Apr 5, 2024

[HOLD for payment 2024-04-25] [Performance] Use shrinkMode strict to decrease APK size and remove unused locales #39700

Closed

hurali97 marked this pull request as ready for review April 5, 2024 12:13

hurali97 requested a review from a team as a code owner April 5, 2024 12:13

melvin-bot bot requested review from allroundexperts and removed request for a team April 5, 2024 12:13

hurali97 added 2 commits April 5, 2024 17:36

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

3304c9b

…y-App into audit/app-startup/use-only-required-locales

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

9a6f88f

…y-App into audit/app-startup/use-only-required-locales

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

3f6b18c

…y-App into audit/app-startup/use-only-required-locales

allroundexperts approved these changes Apr 8, 2024

View reviewed changes

melvin-bot bot requested a review from Julesssss April 8, 2024 14:30

Julesssss requested changes Apr 8, 2024

View reviewed changes

hurali97 and others added 2 commits April 9, 2024 17:33

feat: add comments to resConfigs block

af5d964

merge main

c813a66

Julesssss approved these changes Apr 10, 2024

View reviewed changes

Julesssss merged commit 70a4818 into Expensify:main Apr 10, 2024
8 checks passed

github-actions bot mentioned this pull request Apr 10, 2024

Deploy Checklist: New Expensify 2024-04-10 #40026

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Audit][Implementation] - Use only supported locales to reduce the APK size #39688

[Audit][Implementation] - Use only supported locales to reduce the APK size #39688

hurali97 commented Apr 5, 2024 •

edited

Loading

melvin-bot bot commented Apr 5, 2024

allroundexperts commented Apr 8, 2024

hurali97 commented Apr 8, 2024

allroundexperts commented Apr 8, 2024 •

edited

Loading

allroundexperts left a comment

Julesssss left a comment

hurali97 commented Apr 9, 2024

Julesssss commented Apr 9, 2024

hurali97 commented Apr 9, 2024

kacper-mikolajczak commented Apr 10, 2024

OSBotify commented Apr 10, 2024

OSBotify commented Apr 10, 2024

OSBotify commented Apr 10, 2024

OSBotify commented Apr 10, 2024

OSBotify commented Apr 18, 2024

[Audit][Implementation] - Use only supported locales to reduce the APK size #39688

[Audit][Implementation] - Use only supported locales to reduce the APK size #39688

Conversation

hurali97 commented Apr 5, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Apr 5, 2024

allroundexperts commented Apr 8, 2024

hurali97 commented Apr 8, 2024

allroundexperts commented Apr 8, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

allroundexperts left a comment

Choose a reason for hiding this comment

Julesssss left a comment

Choose a reason for hiding this comment

hurali97 commented Apr 9, 2024

Julesssss commented Apr 9, 2024

hurali97 commented Apr 9, 2024

kacper-mikolajczak commented Apr 10, 2024

OSBotify commented Apr 10, 2024

OSBotify commented Apr 10, 2024

OSBotify commented Apr 10, 2024

OSBotify commented Apr 10, 2024

OSBotify commented Apr 18, 2024

hurali97 commented Apr 5, 2024 •

edited

Loading

allroundexperts commented Apr 8, 2024 •

edited

Loading