Speed up webpack build and rebuild times #12160

kidroca · 2022-10-26T21:31:00Z

Details

Update webpack configuration to speed up bundling
Removing eslint-loader halves the build time: #11724 (comment)
Adding FS cache boost npm run web and npm run desktop next usage

Fixed Issues

$ #11724
PROPOSAL: N/A

Tests

Verify you can use npm run web
Verify you can use npm run desktop
Verify web can still be built for prod: npm run build & npm run build-staging
Verify desktop can still be built for prod: npm run desktop-build & npm run desktop-build-staging
Verify build speed increased (even more for dev, we only use cache there)
- Run npm run web on the main branch and check the output for webpack 5.74.0 compiled successfully in .... ms
- Run npm run web from this PR and check the same - now you see the effects of removing eslint-loader
- stop and run npm run web again - now you see the effects of cache

QA Steps

Verify the build process is not broken and a staging app is still deployed

PR Review Checklist

PR Author Checklist

PR Reviewer Checklist

The reviewer will copy/paste it into a new comment and complete it after the author checklist is completed

Screenshots

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

Julesssss · 2022-10-28T10:30:33Z

Without Changes

First run: webpack 5.74.0 compiled with 33 warnings in 84399 ms
Second run with cache: webpack 5.74.0 compiled with 33 warnings in 79510 ms

With changes

First run: webpack 5.74.0 compiled successfully in 41374 ms
Second run with cache: webpack 5.74.0 compiled successfully in 8169 ms

I'm on an Intel laptop still, can't wait to upgrade! Very nice improvement 👍

Screenshots

Julesssss · 2022-10-28T10:31:36Z

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:
- iOS / native
- Android / native
- iOS / Safari
- Android / Chrome
- MacOS / Chrome
- 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 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 was added in all src/languages/* files
- I verified any copy / text that was added to the app is correct English and 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 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(themeColors.componentBG)
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.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Julesssss

Great improvement

melvin-bot · 2022-10-28T10:33:12Z

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

Julesssss · 2022-10-28T10:35:28Z

No it wasn't. Stupid bot

OSBotify · 2022-10-28T10:39:33Z

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

roryabraham · 2022-10-28T10:48:06Z

config/webpack/webpack.common.js

+            // @react-navigation for web uses the legacy modules (related to react-native-reanimated)
+            // This results in 33 warnings with stack traces that appear during build and each time we make a change
+            // We can't do anything about the warnings, and they only get in the way, so we suppress them
+            './node_modules/@react-navigation/drawer/lib/module/views/legacy/Drawer.js',


Not sure we should suppress these. Yes they're annoying but if we suppress them we won't remember to upgrade and fix them. We also won't notice when they're gone and thus will never think to remove this code (which will be zombie code by then)

@react-navigation for web uses the legacy modules

Is this likely to change? The logs add a bunch of unactionable junk to the output which makes it more difficult to parse the output. But I get the point about hiding this permanently, so I'm happy to add them back.

I'm not sure how such problem are managed here
On other projects we'll capture an outstanding "to-do" ticket linking to commit/lines of code as a reminder

I see your point, I can revert the change in my next PR on webpack config.

Maybe there's a way to log this crap just once, instead for every change made, so many warnings just make a habit of ignoring output altogether...

melvin-bot · 2022-10-28T11:17:09Z

Hey, I noticed you changed some webpack configuration files. This can break production builds. Did you remember to run a production build locally to verify they still work?

OSBotify · 2022-10-31T18:07:42Z

🚀 Deployed to staging by @Julesssss in version: 1.2.22-0 🚀

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

OSBotify · 2022-11-02T16:18:37Z

🚀 Deployed to production by @Julesssss in version: 1.2.22-3 🚀

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

kidroca added 8 commits October 27, 2022 00:21

Add speed-measure-webpack-plugin

fc22fe7

webpack - remove eslint-loader

de2e3ef

webpack - enable filesystem cache for dev

555be80

package - add lint-watch script

9dc0e95

webpack - suppress react-navigation & reanimated warnings in dev

d44a505

webpack - move devServer client.overlay to webpack.dev

fe7400b

webpack - move warning filter to common to de-clutter build log

ed81d6e

webpack - use separate cache for desktop

4be013f

kidroca marked this pull request as ready for review October 27, 2022 20:05

kidroca requested a review from a team as a code owner October 27, 2022 20:05

melvin-bot bot requested review from Julesssss and thesahindia and removed request for a team October 27, 2022 20:05

Julesssss assigned kidroca Oct 28, 2022

Julesssss approved these changes Oct 28, 2022

View reviewed changes

Julesssss merged commit 7b72886 into Expensify:main Oct 28, 2022

melvin-bot bot added the Emergency label Oct 28, 2022

roryabraham reviewed Oct 28, 2022

View reviewed changes

roryabraham removed the Emergency label Oct 28, 2022

Julesssss removed the request for review from thesahindia October 28, 2022 11:16

kidroca deleted the kidroca/chore/optimize-webpack branch October 28, 2022 12:32

OSBotify mentioned this pull request Oct 31, 2022

Deploy Checklist: New Expensify 2022-10-31 #12305

Closed

22 tasks

parasharrajat mentioned this pull request Nov 7, 2022

[$1000] Dev - Getting an error while running the local web app - reported by @parasharrajat #11275

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Speed up webpack build and rebuild times #12160

Speed up webpack build and rebuild times #12160

kidroca commented Oct 26, 2022 •

edited by Julesssss

Loading

Julesssss commented Oct 28, 2022

Julesssss commented Oct 28, 2022

Julesssss left a comment

melvin-bot bot commented Oct 28, 2022

Julesssss commented Oct 28, 2022

OSBotify commented Oct 28, 2022

roryabraham Oct 28, 2022

Julesssss Oct 28, 2022

kidroca Oct 28, 2022

melvin-bot bot commented Oct 28, 2022

OSBotify commented Oct 31, 2022

OSBotify commented Nov 2, 2022

Speed up webpack build and rebuild times #12160

Speed up webpack build and rebuild times #12160

Conversation

kidroca commented Oct 26, 2022 • edited by Julesssss Loading

Details

Fixed Issues

Tests

QA Steps

PR Review Checklist

PR Author Checklist

PR Reviewer Checklist

Screenshots

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

Julesssss commented Oct 28, 2022

Julesssss commented Oct 28, 2022

Julesssss left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Oct 28, 2022

Julesssss commented Oct 28, 2022

OSBotify commented Oct 28, 2022

roryabraham Oct 28, 2022

Choose a reason for hiding this comment

Julesssss Oct 28, 2022

Choose a reason for hiding this comment

kidroca Oct 28, 2022

Choose a reason for hiding this comment

melvin-bot bot commented Oct 28, 2022

OSBotify commented Oct 31, 2022

OSBotify commented Nov 2, 2022

kidroca commented Oct 26, 2022 •

edited by Julesssss

Loading