Reduce bundle size by lazy loading map #41242

janicduplessis · 2024-04-29T18:54:19Z

Details

This reduces JS loaded by the app initially by loading the mapbox code only when displaying a map.

This makes sure to handle loading, error and offline states. Since the map is already not available when offline, loading the code later doesn't cause issues with offline mode.

Loading state

Offline state

Error state

This could happen if for some reason the network request to load the map code fails.

Loaded state

Bundle size

We now avoid loading and parsing the mapbox bundle which is about 1mb (273kb gzip).

Fixed Issues

$ #48202
PROPOSAL:

Tests

Verify that no errors appear in the JS console
Tested the the map reload when going from offline to online
Tested that the map handles error when loading the map code
Tested that the map code is no longer loaded on initial app load

Offline tests

Use the following steps to verify offline works as expected.
Open the app
Go offline
Submit expense -> Distance
See the offline state for the map
Go back online
See the map loaded

QA Steps

Verify that no errors appear in the JS console
Verify that the map loads properly when going to Submit expense -> Distance

PR Author Checklist

Screenshots/Videos

Android: Native

N/A

Android: mWeb Chrome

Screen.Recording.2024-08-26.at.22.11.21.mov

iOS: Native

N/A

iOS: mWeb Safari

Screen.Recording.2024-08-26.at.22.07.58.mov

MacOS: Chrome / Safari

Screen.Recording.2024-08-26.at.22.03.30.mov

MacOS: Desktop

Screen.Recording.2024-08-26.at.22.20.52.mov

hannojg · 2024-08-14T09:11:48Z

@janicduplessis whats missing to bring this over the finish line? Is there anything someone from our team could help?

janicduplessis · 2024-08-15T16:45:12Z

I think it was mostly done, just needs rebase and a little more testing. I can actually have some time to pick this up in the next few days. The bundle size improvement is actually really good.

janicduplessis · 2024-08-24T18:19:34Z

Starting work again on this!

janicduplessis · 2024-08-27T00:01:41Z

Changing the scope of this PR to only lazy load the map, for PDF I am a bit worried about offline support and will need to do more testing so will re-evaluate that change.

For the map we already do not support loading it offline so changing to load the code lazily works perfectly.

melvin-bot · 2024-08-27T02:22:57Z

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

cristipaval · 2024-08-27T10:08:13Z

Do we have an issue to link the PR description?

janicduplessis · 2024-08-28T18:32:32Z

@cristipaval Oh sorry I forgot about that, I just created an issue to track this and linked it in the description.

janicduplessis · 2024-09-04T15:18:53Z

@cristipaval Would you have time to look at this again?

melvin-bot · 2024-09-04T21:04:23Z

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

sobitneupane

Screenshots/Videos

Android: Native

Screen.Recording.2024-09-05.at.20.41.19.mov

iOS: Native

Screen.Recording.2024-09-05.at.20.28.42.mov

iOS: mWeb Safari

Screen.Recording.2024-09-05.at.18.59.37.mov

MacOS: Chrome / Safari

Screen.Recording.2024-09-05.at.18.21.05.mov

MacOS: Desktop

Untitled.mov

sobitneupane

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.

janicduplessis · 2024-09-13T21:02:56Z

@neil-marcellini Could you trigger an adhoc build so I can compare the network timeline with production?

neil-marcellini · 2024-09-19T17:40:29Z

Ah woops, I added the label but forgot that I had to start the workflow. It should be posted in about an hour.

github-actions · 2024-09-19T18:13:54Z

🧪🧪 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/41242/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/41242/index.html

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

👀 View the workflow run that generated this build 👀

neil-marcellini

Code looks fine and tests well. Thanks! We just need to resolve conflicts.

janicduplessis · 2024-10-03T17:45:23Z

CI is failing because of withOnyx usage, this code is just moved from

App/src/components/MapView/MapView.website.tsx

Line 298 in ba9af8f

export default withOnyx<ComponentProps, MapViewOnyxProps>({

. Looks like there's a different lint config for changed files? Should I update it to use useOnyx or just leave it as is?

neil-marcellini · 2024-10-07T17:11:16Z

CI is failing because of withOnyx usage, this code is just moved from

App/src/components/MapView/MapView.website.tsx

Line 298 in ba9af8f

export default withOnyx<ComponentProps, MapViewOnyxProps>({

. Looks like there's a different lint config for changed files? Should I update it to use useOnyx or just leave it as is?

Yeah we're migrating to useOnyx. I'll create a separate migration issue and assign it to you as a follow up so that we can get this merged.

melvin-bot · 2024-10-07T17:11:29Z

@neil-marcellini looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

neil-marcellini · 2024-10-07T17:11:37Z

Explained above

neil-marcellini · 2024-10-07T17:14:12Z

@janicduplessis here is the issue Migrate MapView to useOnyx. Would you please comment there so I can assign you?

OSBotify · 2024-10-07T17:22:39Z

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

github-actions · 2024-10-07T22:28:21Z

🚀 Deployed to staging by https://github.com/neil-marcellini in version: 9.0.46-0 🚀

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

github-actions · 2024-10-09T20:28:10Z

🚀 Deployed to production by https://github.com/thienlnam in version: 9.0.46-5 🚀

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

janicduplessis changed the title ~~Reduce bundle size by lazy loading map and pdf~~ Reduce bundle size by lazy loading map Aug 26, 2024

Lazy load MapView

690cd30

janicduplessis force-pushed the @janic/bundle-size branch from 905d56f to 690cd30 Compare August 26, 2024 23:59

janicduplessis marked this pull request as ready for review August 27, 2024 02:22

janicduplessis requested a review from a team as a code owner August 27, 2024 02:22

melvin-bot bot requested a review from cristipaval August 27, 2024 02:22

melvin-bot bot removed the request for review from a team August 27, 2024 02:22

cristipaval mentioned this pull request Aug 28, 2024

[HOLD for payment 2024-10-16] [$250] [Performance] Avoid including mapbox in initial web bundle #48202

Closed

6 tasks

neil-marcellini requested review from neil-marcellini and a team and removed request for cristipaval September 4, 2024 21:04

melvin-bot bot requested review from sobitneupane and removed request for a team September 4, 2024 21:04

sobitneupane reviewed Sep 5, 2024

View reviewed changes

sobitneupane approved these changes Sep 5, 2024

View reviewed changes

Merge remote-tracking branch 'upstream/main' into @janic/bundle-size

4a4a467

neil-marcellini added the Ready To Build label Sep 16, 2024

neil-marcellini previously approved these changes Oct 2, 2024

View reviewed changes

Merge remote-tracking branch 'upstream/main' into @janic/bundle-size

9bb31ff

janicduplessis dismissed neil-marcellini’s stale review via 9bb31ff October 3, 2024 17:36

neil-marcellini approved these changes Oct 7, 2024

View reviewed changes

neil-marcellini merged commit f43d1ed into Expensify:main Oct 7, 2024
16 of 17 checks passed

melvin-bot bot added the Emergency label Oct 7, 2024

neil-marcellini removed the Emergency label Oct 7, 2024

neil-marcellini mentioned this pull request Oct 7, 2024

[HOLD for payment 2024-11-14] Migrate MapView to useOnyx #50343

Closed

janicduplessis deleted the @janic/bundle-size branch October 7, 2024 17:29

github-actions bot mentioned this pull request Oct 7, 2024

Deploy Checklist: New Expensify 2024-10-07 #50366

Closed

50 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Reduce bundle size by lazy loading map #41242

Reduce bundle size by lazy loading map #41242

janicduplessis commented Apr 29, 2024 •

edited

Loading

hannojg commented Aug 14, 2024

janicduplessis commented Aug 15, 2024 •

edited

Loading

janicduplessis commented Aug 24, 2024

janicduplessis commented Aug 27, 2024

melvin-bot bot commented Aug 27, 2024

cristipaval commented Aug 27, 2024

janicduplessis commented Aug 28, 2024

janicduplessis commented Sep 4, 2024

melvin-bot bot commented Sep 4, 2024

sobitneupane left a comment •

edited

Loading

sobitneupane left a comment

janicduplessis commented Sep 13, 2024

neil-marcellini commented Sep 19, 2024

github-actions bot commented Sep 19, 2024

neil-marcellini left a comment •

edited

Loading

janicduplessis commented Oct 3, 2024

neil-marcellini commented Oct 7, 2024

melvin-bot bot commented Oct 7, 2024

neil-marcellini commented Oct 7, 2024

neil-marcellini commented Oct 7, 2024

OSBotify commented Oct 7, 2024

github-actions bot commented Oct 7, 2024

github-actions bot commented Oct 9, 2024

Reduce bundle size by lazy loading map #41242

Reduce bundle size by lazy loading map #41242

Conversation

janicduplessis commented Apr 29, 2024 • edited Loading

Details

Loading state

Offline state

Error state

Loaded state

Bundle size

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

hannojg commented Aug 14, 2024

janicduplessis commented Aug 15, 2024 • edited Loading

janicduplessis commented Aug 24, 2024

janicduplessis commented Aug 27, 2024

melvin-bot bot commented Aug 27, 2024

cristipaval commented Aug 27, 2024

janicduplessis commented Aug 28, 2024

janicduplessis commented Sep 4, 2024

melvin-bot bot commented Sep 4, 2024

sobitneupane left a comment • edited Loading

Choose a reason for hiding this comment

Screenshots/Videos

sobitneupane left a comment

Choose a reason for hiding this comment

Reviewer Checklist

janicduplessis commented Sep 13, 2024

neil-marcellini commented Sep 19, 2024

github-actions bot commented Sep 19, 2024

neil-marcellini left a comment • edited Loading

Choose a reason for hiding this comment

janicduplessis commented Oct 3, 2024

neil-marcellini commented Oct 7, 2024

melvin-bot bot commented Oct 7, 2024

neil-marcellini commented Oct 7, 2024

neil-marcellini commented Oct 7, 2024

OSBotify commented Oct 7, 2024

github-actions bot commented Oct 7, 2024

github-actions bot commented Oct 9, 2024

janicduplessis commented Apr 29, 2024 •

edited

Loading

janicduplessis commented Aug 15, 2024 •

edited

Loading

sobitneupane left a comment •

edited

Loading

neil-marcellini left a comment •

edited

Loading