[EPIC] Automate asset bundling in MobileFrontend/Minerva
Open, HighPublic

Description

Documentation on wiki

https://m.mediawiki.org/wiki/Reading/Web/Projects/Invest_in_the_MobileFrontend_%26_MinervaNeue_frontend_architecture#Automate_asset_bundling

What

Use a Node.js based bundler (webpack) to compile the JavaScript files into different entry points automatically based only on source code import statements. These bundled files will then be given to ResourceLoader for serving.

This approach is the same one taken in Extension:Popups (Page Previews), which has proven to be an effective strategy.

We will also use UglifyJS for minifying our JavaScript files for production, which should give us approximately 25% savings on file sizes for the mobile website.

Progress

There are ~80 JavaScript files in MobileFrontend, in 58 modules.

We will go module by module, file by file, migrating the file to the src/ folder like in Extension:Popups, adapting the imports/exports, and moving the QUnit test files to node-qunit if possible/easy.

Progress can be measured by looking at the amount of files and lines of code migrated to the src/ folder.

Measuring success

We will be successful if:

  • There is a reduction in the size of the JS assets served to clients due to better minimization
  • There is a big reduction on the amount of manual JSON configuration needed for sorting the JS files (.ResourceModules on extension.json)
  • The performance of MediaWiki locally on development is better due to the decreased load on ResourceLoader

AC

  • We have documented the client bundle sizes served, the amount of manual configuration for scripts in .ResourceModules extension.json, for further analysis after the project ends (see T165036 for an example which includes bundlesize checks, Webpack performance hints, and ADR and blog post docs)
  • There is a build setup with npm scripts start and build that bundles the assets and outputs them to resources/dist
  • CI checks on every commit that the built assets committed in the repo are up to date with the committed sources (like in Extension:Popups-an experiment is underway to _not_ version artifacts)
  • The build process is configured to use UglifyJS when outputting production assets
  • The development build process includes a script to monitor and automatically rebuild debug assets (see Popups)
  • The build assets are properly configured to be served by ResourceLoader from MediaWiki (see Popups)
  • The sources in resources/ have been migrated to src/, using EcmaScript modules syntax, and babel for transpilation to ES5
  • There is a linting step for verifying that the production bundles in resources/dist are ES5 compliant (see Popup's ES5 ESLint config or this eslint-plugin-compat spike)
  • The built assets are split automatically to have common modules of bundles based on the entry points, and configured correctly to be performant for our most common cases
  • We measure our success metrics after the work is finished and compare and report with the initial metrics
Jhernandez updated the task description. (Show Details)May 24 2018, 12:04 PM
Niedzielski updated the task description. (Show Details)Jun 1 2018, 12:41 PM
Niedzielski updated the task description. (Show Details)Jun 1 2018, 12:58 PM
ovasileva renamed this task from Automate asset bundling in MobileFrontend/Minerva to [EPIC] Automate asset bundling in MobileFrontend/Minerva.Jun 4 2018, 10:07 AM
Jdlrobson moved this task from Backlog to New adventures on the MinervaNeue board.Jun 13 2018, 3:55 PM
Vvjjkkii renamed this task from [EPIC] Automate asset bundling in MobileFrontend/Minerva to gdcaaaaaaa.Jul 1 2018, 1:08 AM
Vvjjkkii triaged this task as High priority.
Vvjjkkii updated the task description. (Show Details)
Vvjjkkii removed a subscriber: Aklapper.
CommunityTechBot raised the priority of this task from High to Needs Triage.
CommunityTechBot renamed this task from gdcaaaaaaa to [EPIC] Automate asset bundling in MobileFrontend/Minerva.
CommunityTechBot added a subscriber: Aklapper.
Jdlrobson triaged this task as High priority.Jul 9 2018, 4:30 PM
Jdlrobson moved this task from Inbox to Next up on the User-Jdlrobson board.Jul 31 2018, 1:58 AM
Jdlrobson changed the status of subtask T202746: Use ES6 syntax in MobileFrontend from Open to Stalled.Oct 5 2018, 5:49 PM
Jdlrobson updated the task description. (Show Details)Oct 10 2018, 8:22 PM
Jdlrobson updated the task description. (Show Details)Tue, Oct 23, 7:31 PM