Skip to content

Latest commit

 

History

History
106 lines (68 loc) · 4.89 KB

README.md

File metadata and controls

106 lines (68 loc) · 4.89 KB
Raw

Webpack5 MFEs — Formidable, We build the modern web

=============

A short experiment to see webpack5 MFE support in action.

Overview

We have four "independent" applications with shared components and libraries across them that we simulate within yarn workspaces. Really, these could be viewed as each independent repositories and applications.

For simplicity all the applications essentially contain the same content and navbar, but differ in that they get code locally from their own app and consume shared code everywhere else via module federation.

For a simple tour, navigate to http://127.0.0.1:3001/ -- this is the homepage application. Looking at the navigation bar, you can see a HOME (3001) heading indicating you are in the homepage application server on port 3001. Further down the menu you see a PAGES heading with options for:

  • Homepage: Favorite item links
  • Items: A random selection of items
  • Item (Cat): A specific cat

All of the above are served within the 3001 homepage application server (although relevant other application supply code under the hood). Clicking on anything just does history push state and does not cause a real HTTP navigation to a new page.

Continuing down the menu bar to the APPS heading with links to all the applications. These links will cause a completely new HTTP navigation to a different application server page (on a different port).

Architecture

We run build watchers and localhost serving independently as follows (with relevant exposes federated components / code):

  • packages/homepage (localhost:3001)
    • pages/homepage: Some favorite items on a lander page
  • packages/item (localhost:3002)
    • components/item: A single item (with internal data fetching)
    • pages/items: Items landing page (random items)
    • pages/item: Single item page
  • packages/cart (localhost:3003)
    • components/add-to-cart: Add to cart button for items.
    • pages/cart: Cart page
  • packages/checkout (localhost:3004)
    • components/checkout-button: Checkout button for cart
    • pages/checkout: Checkout page
    • pages/thank-you: Thank you page for after a purchase
  • packages/shared: Shared dependencies for the other applications. Simulates a common base repository. Includes things like html wrapper, eagerImport, fetch*, and Page + Layout components.

Each of the applications share the following vendor code:

  • htm
  • react
  • react-dom
  • react-router-dom

For convenience, these apps all share via the root package (would be independent in real scenario, or part of webpack-mfe-shared).

  • public/index.html: Common HTML template
  • webpack.config.js: Webpack config wrapper
  • serve.json: A static localdev server configuration

Development

You can run build and watches for all four at the same time with root project helper commands:

$ yarn start

Navigate to: http://localhost:3001/ for the entry in to the home page, or independently to any of the other application entry URLs.

Production

To build everything for deployment to surge:

$ yarn clean && PROD=true yarn build

We have things automated in surge with special environment variables. This deploys to PR environments as: emojistore-staging-${PR_NUMBER}-${APP}.surge.sh. Production deploys the federated applications as follows:

Resources

Demos:

Articles:

Notes

MFE / Infrastructure:

  • To use anything shared or overrideable it appears the entire entry point needs to be wrapped in a dynamic import().
  • To import a component from another MFE, use something like const CheckoutButton = React.lazy(() => import("app_checkout/components/checkout-button")).

This Demo:

  • To keep this demo focused on the infrastructure, we've made shortcuts of having a minimal build (no babel, instead using htm), vanilla-ish React (react + react-router-dom), Pure CSS for styling, and no SSR, etc.
  • Although a lot of the components need React.Suspense, there is no fallback UI provided.

Maintenance Status

Stable: Formidable is not planning to develop any new features for this project. We are still responding to bug reports and security concerns. We are still welcoming PRs for this project, but PRs that include new features should be small and easy to integrate and should not include breaking changes.