docs(angular): show how to add additional webpack plugins with MF (#16572)
This commit is contained in:
Colum Ferry
GitHub
parent
4cab83eb99
commit
5761aa9bdd
@ -1,24 +1,33 @@
|
||||
# Faster Builds with Module Federation
|
||||
|
||||
As applications grow, builds can become unacceptably slow, which leads to slow CI/CD pipelines and long dev-server startup times. This slowness
|
||||
As applications grow, builds can become unacceptably slow, which leads to slow CI/CD pipelines and long dev-server
|
||||
startup times. This slowness
|
||||
decrease team productivity due to long waits for local compilation, and clogged up CI/CD pipelines.
|
||||
|
||||
Module Federation provides a solution to the scaling problem by allowing a Single Page Application (SPA) to be sliced into multiple smaller
|
||||
remote applications that are built independently. There are some costs to slicing an application through Module Federation:
|
||||
Module Federation provides a solution to the scaling problem by allowing a Single Page Application (SPA) to be sliced
|
||||
into multiple smaller
|
||||
remote applications that are built independently. There are some costs to slicing an application through Module
|
||||
Federation:
|
||||
|
||||
- Cognitive overhead of developing multiple applications versus a SPA.
|
||||
- Coordinating build and deployment across many applications is a huge headache, especially in a multi-repo setup.
|
||||
- Version-Mismatch-Hell where different applications are deployed with different versions of shared libraries can lead to unexpected errors.
|
||||
- Version-Mismatch-Hell where different applications are deployed with different versions of shared libraries can lead
|
||||
to unexpected errors.
|
||||
|
||||
Nx provides the best experience for teams that want faster builds, but want to also minimize the downsides that come with Module Federation. Starting in Nx 14,
|
||||
Nx provides the best experience for teams that want faster builds, but want to also minimize the downsides that come
|
||||
with Module Federation. Starting in Nx 14,
|
||||
we provide specialized generators, executors, and utilities that make Module Federation easy to set up and work with.
|
||||
|
||||
## When should I use Module Federation?
|
||||
|
||||
Whether Module Federation makes sense for your team depends on the size of your application. Although Nx hides most of the complexity around Module Federation, it still comes with some downsides:
|
||||
Whether Module Federation makes sense for your team depends on the size of your application. Although Nx hides most of
|
||||
the complexity around Module Federation, it still comes with some downsides:
|
||||
|
||||
- Developers need to think about which remotes they are working on, since it is a waste of CPU and memory to run _all_ remotes in development mode. In practice this may not be a problem if the teams are already divided by domain or feature.
|
||||
- Increased orchestration since remotes are independent of each other, shared state may require the host application to coordinate it between remotes. For example, sharing Redux state across remotes is more complicated versus a SPA.
|
||||
- Developers need to think about which remotes they are working on, since it is a waste of CPU and memory to run _all_
|
||||
remotes in development mode. In practice this may not be a problem if the teams are already divided by domain or
|
||||
feature.
|
||||
- Increased orchestration since remotes are independent of each other, shared state may require the host application to
|
||||
coordinate it between remotes. For example, sharing Redux state across remotes is more complicated versus a SPA.
|
||||
|
||||
## Architectural overview
|
||||
|
||||
@ -27,25 +36,33 @@ With Module Federation, a large application is split into:
|
||||
1. A single **Host** application that references external...
|
||||
2. **Remote** applications, which handle a single domain or feature.
|
||||
|
||||
In the next section, we will see an example with a host app (`host`) and three remotes (`shop`, `cart`, `about`). Although all the applications are independently built, thus have no dependency between them, conceptually you can think of them in the following hierarchy.
|
||||
In the next section, we will see an example with a host app (`host`) and three remotes (`shop`, `cart`, `about`).
|
||||
Although all the applications are independently built, thus have no dependency between them, conceptually you can think
|
||||
of them in the following hierarchy.
|
||||
|
||||
|
||||
|
||||
## Creating an example workspace
|
||||
|
||||
The best way to understand the setup is through an example. In this section, we will create a `host` application with three remotes under these routes:
|
||||
The best way to understand the setup is through an example. In this section, we will create a `host` application with
|
||||
three remotes under these routes:
|
||||
|
||||
1. `/shop`
|
||||
1. `/cart`
|
||||
1. `/about`
|
||||
|
||||
But before we begin, we've put together a couple of example repos (React and Angular) for you to inspect if you want to skip ahead.
|
||||
But before we begin, we've put together a couple of example repos (React and Angular) for you to inspect if you want to
|
||||
skip ahead.
|
||||
|
||||
{% github-repository url="https://github.com/nrwl/ng-module-federation" /%}
|
||||
|
||||
{% github-repository url="https://github.com/nrwl/react-module-federation" /%}
|
||||
|
||||
These examples have fully functioning [CI](https://github.com/nrwl/react-module-federation/blob/main/.github/workflows/ci.yml) [workflows](https://github.com/nrwl/ng-module-federation/blob/main/.github/workflows/ci.yml) that are simple to set up. You can see what the CI does by viewing the sample pull requests in each repo. Also notice the [Nx Cloud](https://nx.app) integration, which gives you insight into each pipeline. We'll touch on this [later in this guide](#distributed-computation-caching-with-nx-cloud).
|
||||
These examples have fully
|
||||
functioning [CI](https://github.com/nrwl/react-module-federation/blob/main/.github/workflows/ci.yml) [workflows](https://github.com/nrwl/ng-module-federation/blob/main/.github/workflows/ci.yml)
|
||||
that are simple to set up. You can see what the CI does by viewing the sample pull requests in each repo. Also notice
|
||||
the [Nx Cloud](https://nx.app) integration, which gives you insight into each pipeline. We'll touch on
|
||||
this [later in this guide](#distributed-computation-caching-with-nx-cloud).
|
||||
|
||||
|
||||
|
||||
@ -58,7 +75,8 @@ cd acme
|
||||
```
|
||||
|
||||
{% callout type="check" title="Enabling distributed caching" %}
|
||||
You will be prompted to enable Nx Cloud in the workspace. For the best experience, we highly recommend using Nx Cloud to take advantage of distributed caching and other features it provides.
|
||||
You will be prompted to enable Nx Cloud in the workspace. For the best experience, we highly recommend using Nx Cloud to
|
||||
take advantage of distributed caching and other features it provides.
|
||||
{% /callout %}
|
||||
|
||||
Then, for React users, install the `@nrwl/react` plugin; and for Angular users, install the `@nrwl/angular` plugin.
|
||||
@ -86,7 +104,8 @@ nx g @nrwl/angular:host host --remotes=shop,cart,about
|
||||
```
|
||||
|
||||
{% callout type="note" title="More details" %}
|
||||
You can leave off the `--remotes` option and add them later with `nx g @nrwl/react:remote shop --host=host` or `nx g @nrwl/angular:remote shop --host=host`.
|
||||
You can leave off the `--remotes` option and add them later with `nx g @nrwl/react:remote shop --host=host`
|
||||
or `nx g @nrwl/angular:remote shop --host=host`.
|
||||
{% /callout %}
|
||||
|
||||
Now, serve `host` to view it in your browser.
|
||||
@ -95,7 +114,8 @@ Now, serve `host` to view it in your browser.
|
||||
nx serve host --open
|
||||
```
|
||||
|
||||
The above command serves `host` in development mode, whereas the remotes are built and served statically. That is, changes to `host` will update its bundle, but changes to remotes will not update.
|
||||
The above command serves `host` in development mode, whereas the remotes are built and served statically. That is,
|
||||
changes to `host` will update its bundle, but changes to remotes will not update.
|
||||
|
||||
To run one or more remotes in development mode, use the `--devRemotes` option.
|
||||
|
||||
@ -106,7 +126,9 @@ nx serve host --open --devRemotes=shop,cart
|
||||
The above command starts the `shop` and `cart` remotes in development mode, but `about` will remain static.
|
||||
|
||||
{% callout type="note" title="More details" %}
|
||||
Both commands serve the whole system. By passing `--devRemotes`, you configure what parts of it you will be changing. For instance, in the example above, you can go to the about page and back. This is different from having different versions of the app for every team.
|
||||
Both commands serve the whole system. By passing `--devRemotes`, you configure what parts of it you will be changing.
|
||||
For instance, in the example above, you can go to the about page and back. This is different from having different
|
||||
versions of the app for every team.
|
||||
{% /callout %}
|
||||
|
||||
## What was generated?
|
||||
@ -115,9 +137,15 @@ To understand how Module Federation works with Nx, let's take a look at three fi
|
||||
|
||||
### `apps/host/project.json`
|
||||
|
||||
The `build` target uses `@nrwl/webpack:webpack` for React, and `@nrwl/angular:webpack-browser` for Angular. This is the same as a normal SPA that uses custom webpack configuration (`webpackConfig`), but difference is in the webpack configuration file.
|
||||
The `build` target uses `@nrwl/webpack:webpack` for React, and `@nrwl/angular:webpack-browser` for Angular. This is the
|
||||
same as a normal SPA that uses custom webpack configuration (`webpackConfig`), but difference is in the webpack
|
||||
configuration file.
|
||||
|
||||
If you use Module Federation to speed up your CI and improve your local development, and not to deploy different remotes independently, you need to create implicit dependencies from the host to all the remotes. Semantically, the host and the remotes comprise one application, so you cannot build the host without the remotes. Adding implicit dependencies also makes distributed builds possible ([see below](#production-build-and-deployment)). To create these dependencies, add the `implicitDependencies` configuration.
|
||||
If you use Module Federation to speed up your CI and improve your local development, and not to deploy different remotes
|
||||
independently, you need to create implicit dependencies from the host to all the remotes. Semantically, the host and the
|
||||
remotes comprise one application, so you cannot build the host without the remotes. Adding implicit dependencies also
|
||||
makes distributed builds possible ([see below](#production-build-and-deployment)). To create these dependencies, add
|
||||
the `implicitDependencies` configuration.
|
||||
|
||||
```text
|
||||
// apps/host/project.json
|
||||
@ -143,11 +171,48 @@ module.exports = withModuleFederation({
|
||||
});
|
||||
```
|
||||
|
||||
We'll talk about [what `withModuleFederation` does](#what-does-withmodulefederation-do) in a bit, but for now the important part of the configuration is the use of `module-federation.config.js` which we will examine next.
|
||||
We'll talk about [what `withModuleFederation` does](#what-does-withmodulefederation-do) in a bit, but for now the
|
||||
important part of the configuration is the use of `module-federation.config.js` which we will examine next.
|
||||
|
||||
{% callout type="note" title="Extending the Webpack Config" %}
|
||||
If you find yourself needing to add additional webpack plugins to your config, you can do so by following the pattern
|
||||
below. This example shows how you could use it to add the `LicenseWebpackPlugin` but you can use this method to apply
|
||||
any webpack plugins you need.
|
||||
|
||||
```js
|
||||
const { withModuleFederation } = require('@nrwl/angular/module-federation');
|
||||
const config = require('./module-federation.config');
|
||||
const LicenseWebpackPlugin =
|
||||
require('license-webpack-plugin').LicenseWebpackPlugin;
|
||||
const path = require('path');
|
||||
|
||||
module.exports = async (wco) => {
|
||||
const wmf = await withModuleFederation(config);
|
||||
return wmf({
|
||||
...wco,
|
||||
plugins: [
|
||||
...(wco.plugins ?? []),
|
||||
new LicenseWebpackPlugin({
|
||||
stats: {
|
||||
warnings: false,
|
||||
errors: false,
|
||||
},
|
||||
perChunkOutput: false,
|
||||
outputFilename: '3rdpartylicenses.txt',
|
||||
skipChildCompilers: true,
|
||||
modulesDirectories: [path.resolve(__dirname, '../../node_modules')],
|
||||
}),
|
||||
],
|
||||
});
|
||||
};
|
||||
```
|
||||
|
||||
{% /callout %}
|
||||
|
||||
### `apps/host/module-federation.config.js`
|
||||
|
||||
This file is the main configuration for the `host`, and you'll see `module-federation.config.js` for the generated remotes as well.
|
||||
This file is the main configuration for the `host`, and you'll see `module-federation.config.js` for the generated
|
||||
remotes as well.
|
||||
|
||||
```javascript
|
||||
module.exports = {
|
||||
@ -156,26 +221,33 @@ module.exports = {
|
||||
};
|
||||
```
|
||||
|
||||
The required `name` property is the magic to link the host and remotes together. The `host` application references the three remotes by their names.
|
||||
The required `name` property is the magic to link the host and remotes together. The `host` application references the
|
||||
three remotes by their names.
|
||||
|
||||
{% callout type="note" title="More details" %}
|
||||
It is important that the values in `remotes` property matches the `name` property of the remote applications. Otherwise, webpack will throw an error. Nx handles this automatically for you so there shouldn't be an issue unless it was modified manually.
|
||||
It is important that the values in `remotes` property matches the `name` property of the remote applications. Otherwise,
|
||||
webpack will throw an error. Nx handles this automatically for you so there shouldn't be an issue unless it was modified
|
||||
manually.
|
||||
{% /callout %}
|
||||
|
||||
## What does `withModuleFederation` do?
|
||||
|
||||
In the previous section, we saw `withModuleFederation` used in the webpack config. This function is an abstraction on top of webpack's `ModuleFederationPlugin` with some Nx-specific behavior.
|
||||
In the previous section, we saw `withModuleFederation` used in the webpack config. This function is an abstraction on
|
||||
top of webpack's `ModuleFederationPlugin` with some Nx-specific behavior.
|
||||
|
||||
- All libraries (npm and workspace) are shared singletons by default, so you don't manually configure them.
|
||||
- Remotes are referenced by name only, since Nx knows which ports each remote is running on (in development mode).
|
||||
|
||||
With Nx, the developer experience (DX) when working with Module Federation matches more closely to development on a SPA. You don't have to worry about managing a bunch of configuration, and most things just work out of the box.
|
||||
With Nx, the developer experience (DX) when working with Module Federation matches more closely to development on a SPA.
|
||||
You don't have to worry about managing a bunch of configuration, and most things just work out of the box.
|
||||
|
||||
### Excluding or overriding shared libraries
|
||||
|
||||
There are cases where excluding or changing the shared configuration is required. For example, shared libraries are not tree shaken, so to enable this behavior you must exclude them from being shared.
|
||||
There are cases where excluding or changing the shared configuration is required. For example, shared libraries are not
|
||||
tree shaken, so to enable this behavior you must exclude them from being shared.
|
||||
|
||||
To exclude a library or change its configuration, you can provide the `shared: (libraryName, sharedConfig) => sharedConfig` function in your configuration file.
|
||||
To exclude a library or change its configuration, you can provide
|
||||
the `shared: (libraryName, sharedConfig) => sharedConfig` function in your configuration file.
|
||||
|
||||
```javascript
|
||||
// module-federation.config.js
|
||||
@ -191,25 +263,32 @@ module.exports = {
|
||||
};
|
||||
```
|
||||
|
||||
The `shared` function can return an `undefined` to use Nx's default value, `false` to exclude it from being shared, or a [shared config](https://webpack.js.org/plugins/module-federation-plugin/#sharing-hints) that webpack supports.
|
||||
The `shared` function can return an `undefined` to use Nx's default value, `false` to exclude it from being shared, or
|
||||
a [shared config](https://webpack.js.org/plugins/module-federation-plugin/#sharing-hints) that webpack supports.
|
||||
|
||||
{% callout type="note" title="Analysis" %}
|
||||
The default configuration, without overrides, should work well for most workspaces, and we encourage you to analyze your bundles before optimizing the shared behavior.
|
||||
The default configuration, without overrides, should work well for most workspaces, and we encourage you to analyze your
|
||||
bundles before optimizing the shared behavior.
|
||||
|
||||
To analyze your bundle, run build with `--statsJson` and use a tool like [`webpack-bundle-analyzer`](https://www.npmjs.com/package/webpack-bundle-analyzer) to the size of your bundles.
|
||||
To analyze your bundle, run build with `--statsJson` and use a tool
|
||||
like [`webpack-bundle-analyzer`](https://www.npmjs.com/package/webpack-bundle-analyzer) to the size of your bundles.
|
||||
|
||||
If you have any feedback regarding this feature, we'd love to hear from you--check our [community page](https://nx.dev/community) for links to our Slack and Twitter.
|
||||
If you have any feedback regarding this feature, we'd love to hear from you--check
|
||||
our [community page](https://nx.dev/community) for links to our Slack and Twitter.
|
||||
{% /callout %}
|
||||
|
||||
## Distributed computation caching with Nx Cloud
|
||||
|
||||
To use Module Federation well, we recommend that you enable [Nx Cloud](https://nx.app). If you haven't enabled it yet when using `create-nx-workspace`, you can do the following.
|
||||
To use Module Federation well, we recommend that you enable [Nx Cloud](https://nx.app). If you haven't enabled it yet
|
||||
when using `create-nx-workspace`, you can do the following.
|
||||
|
||||
```shell
|
||||
nx connect-to-nx-cloud
|
||||
```
|
||||
|
||||
With Nx Cloud enabled, a large set of builds can be skipped entirely when running the application locally (and in CI/CD). When you run builds through Nx + Nx Cloud, the artifacts are stored in the distributed cache, so as long as the source of a given remote hasn't changed, it will be served from cache.
|
||||
With Nx Cloud enabled, a large set of builds can be skipped entirely when running the application locally (and in
|
||||
CI/CD). When you run builds through Nx + Nx Cloud, the artifacts are stored in the distributed cache, so as long as the
|
||||
source of a given remote hasn't changed, it will be served from cache.
|
||||
|
||||
You can see this behavior locally if you serve the `host` twice.
|
||||
|
||||
@ -221,7 +300,9 @@ nx serve host
|
||||
nx serve host
|
||||
```
|
||||
|
||||
The second serve starts up much faster, because the three remotes (`shop`, `cart`, `about`) are read from cache. Not only that, any other copy of the workspace will also benefit from the cache if they haven't changed a particular remote. If, say, someone is working on `shop`, they will get the `cart` and `about` builds from the cache.
|
||||
The second serve starts up much faster, because the three remotes (`shop`, `cart`, `about`) are read from cache. Not
|
||||
only that, any other copy of the workspace will also benefit from the cache if they haven't changed a particular remote.
|
||||
If, say, someone is working on `shop`, they will get the `cart` and `about` builds from the cache.
|
||||
|
||||
If you inspect the terminal output, you'll see something like this, even if you are on different machines.
|
||||
|
||||
@ -237,12 +318,17 @@ If you inspect the terminal output, you'll see something like this, even if you
|
||||
```
|
||||
|
||||
{% callout type="note" title="More details" %}
|
||||
This caching behavior is _crucial_. If you don't have a build system supporting distributed computation caching, using Module Federation will be slower. It takes longer to build `shop`, `cart` and `about` separately than building all of them together as part of the same process.
|
||||
This caching behavior is _crucial_. If you don't have a build system supporting distributed computation caching, using
|
||||
Module Federation will be slower. It takes longer to build `shop`, `cart` and `about` separately than building all of
|
||||
them together as part of the same process.
|
||||
|
||||
**When using Nx, you rarely have to build all of them because most of the time you work on one remote, other remotes will be retrieved from cache.**
|
||||
**When using Nx, you rarely have to build all of them because most of the time you work on one remote, other remotes
|
||||
will be retrieved from cache.**
|
||||
{% /callout %}
|
||||
|
||||
This also helps things like end-to-end (E2E) testing because testing against a static server is much more efficient than starting many servers in development mode. When the CI pipeline runs E2E tests, all the remotes should be served statically from cache.
|
||||
This also helps things like end-to-end (E2E) testing because testing against a static server is much more efficient than
|
||||
starting many servers in development mode. When the CI pipeline runs E2E tests, all the remotes should be served
|
||||
statically from cache.
|
||||
|
||||
In addition to computation caching, Nx Cloud also comes with:
|
||||
|
||||
@ -256,7 +342,8 @@ In addition to computation caching, Nx Cloud also comes with:
|
||||
|
||||
In this section, we'll examine how to set up your production build and simulate a deployment to `http://localhost:3000`.
|
||||
|
||||
First, make sure you have implicit dependencies from `host` to each remote. In case you didn't already set this up, add the following line to the `host`'s project configuration.
|
||||
First, make sure you have implicit dependencies from `host` to each remote. In case you didn't already set this up, add
|
||||
the following line to the `host`'s project configuration.
|
||||
|
||||
```jsonc {% fileName="apps/host/project.json" %}
|
||||
{
|
||||
@ -265,7 +352,8 @@ First, make sure you have implicit dependencies from `host` to each remote. In c
|
||||
}
|
||||
```
|
||||
|
||||
Next, open up the production webpack configuration file and update the remote URLs to their own sub-folder under `http://localhost:3000`.
|
||||
Next, open up the production webpack configuration file and update the remote URLs to their own sub-folder
|
||||
under `http://localhost:3000`.
|
||||
|
||||
```javascript {% fileName="apps/host/webpack.config.prod.js" %}
|
||||
const withModuleFederation = require('@nrwl/react/module-federation');
|
||||
@ -284,7 +372,10 @@ module.exports = withModuleFederation({
|
||||
Now you can run `nx build host` to build all the `host` and all the implicit dependencies in production mode.
|
||||
|
||||
{% callout type="note" title="Distributed caching" %}
|
||||
Again, if you don't use [Nx Cloud's Distributed Tasks Execution](/concepts/dte) using Module Federation will be slower than building everything in a single process. It's only if you enable Distributed Tasks Execution, your CI will be able to build each remote on a separate machine, in parallel, (or not build it at all and retrieve it from cache), which will reduce the CI time.
|
||||
Again, if you don't use [Nx Cloud's Distributed Tasks Execution](/concepts/dte) using Module Federation will be slower
|
||||
than building everything in a single process. It's only if you enable Distributed Tasks Execution, your CI will be able
|
||||
to build each remote on a separate machine, in parallel, (or not build it at all and retrieve it from cache), which will
|
||||
reduce the CI time.
|
||||
{% /callout %}
|
||||
|
||||
After running that command you'll see the following artifacts in `dist` folder.
|
||||
@ -306,7 +397,8 @@ deploy \
|
||||
--command="rm -rf production && mkdir production && cp -r dist/apps/host/* production && cp -r dist/apps/{shop,cart,about} production && http-server -p 3000 -a localhost production"
|
||||
```
|
||||
|
||||
You can then run `nx deploy host` to see the application running on `http://localhost:3000`. If you inspect the `production` folder you'll see the following files.
|
||||
You can then run `nx deploy host` to see the application running on `http://localhost:3000`. If you inspect
|
||||
the `production` folder you'll see the following files.
|
||||
|
||||
```text
|
||||
production/
|
||||
@ -325,7 +417,8 @@ production/
|
||||
|
||||
The above command is just an example. You'll need to use what make sense for your team and workspace.
|
||||
|
||||
For examples of how CI/CD pipelines can be configured using Nx Cloud and GitHub, see our [React](https://github.com/nrwl/react-module-federation)
|
||||
For examples of how CI/CD pipelines can be configured using Nx Cloud and GitHub, see
|
||||
our [React](https://github.com/nrwl/react-module-federation)
|
||||
and [Angular](https://github.com/nrwl/ng-module-federation) examples.
|
||||
|
||||
{% github-repository url="https://github.com/nrwl/ng-module-federation" /%}
|
||||
@ -334,21 +427,36 @@ and [Angular](https://github.com/nrwl/ng-module-federation) examples.
|
||||
|
||||
## Using buildable libs
|
||||
|
||||
By using Module Federation you essentially split your application build process vertically. You can also split it horizontally by making some libraries buildable.
|
||||
By using Module Federation you essentially split your application build process vertically. You can also split it
|
||||
horizontally by making some libraries buildable.
|
||||
|
||||
We don't recommend making all libraries in your workspace buildable--it will make some things faster but many other things slower. But in some scenarios making a few large libraries at the bottom of your graph buildable can speed up your CI.
|
||||
We don't recommend making all libraries in your workspace buildable--it will make some things faster but many other
|
||||
things slower. But in some scenarios making a few large libraries at the bottom of your graph buildable can speed up
|
||||
your CI.
|
||||
|
||||
Because Nx Cloud's Distributed Tasks Execution works with any task graph, having buildable libraries is handled automatically. If you have a buildable `components` library that all remotes depend on, Nx Cloud will build the library first before building the remotes.
|
||||
Because Nx Cloud's Distributed Tasks Execution works with any task graph, having buildable libraries is handled
|
||||
automatically. If you have a buildable `components` library that all remotes depend on, Nx Cloud will build the library
|
||||
first before building the remotes.
|
||||
|
||||
## Summary
|
||||
|
||||
You could use Module Federation to implement [micro frontends](/more-concepts/micro-frontend-architecture), but this guide showed how to use it to speed up your builds.
|
||||
You could use Module Federation to implement [micro frontends](/more-concepts/micro-frontend-architecture), but this
|
||||
guide showed how to use it to speed up your builds.
|
||||
|
||||
Module Federation allows you to split a single build process into multiple processes which can run in parallel or even on multiple machines. The result of each build process can be cached independently. For this to work well in practice you need to have a build system supporting distributed computation caching and distributed tasks execution (e.g., Nx + Nx Cloud).
|
||||
Module Federation allows you to split a single build process into multiple processes which can run in parallel or even
|
||||
on multiple machines. The result of each build process can be cached independently. For this to work well in practice
|
||||
you need to have a build system supporting distributed computation caching and distributed tasks execution (e.g., Nx +
|
||||
Nx Cloud).
|
||||
|
||||
When a developer runs say `nx serve host --devRemotes=cart`, they still run the whole application, but `shop` and `about` are served statically, from cache. As a result, the serve time and the time it takes to see the changes on the screen go down, often by an order of magnitude.
|
||||
When a developer runs say `nx serve host --devRemotes=cart`, they still run the whole application, but `shop`
|
||||
and `about` are served statically, from cache. As a result, the serve time and the time it takes to see the changes on
|
||||
the screen go down, often by an order of magnitude.
|
||||
|
||||
When a CI machine runs say `nx build host --configuration=production`, the `shop`, `about` and `cart` remotes will either be build on separate machines or retrieved from cache. Once all of them are built, the build process for `host` will combine the file artifacts from all the remotes. Nx Cloud takes care of distributing the tasks and moving file artifacts across machines. As a result, the worst case scenario build time (when nothing is cached) goes from building all the code to building the largest remote, which is often an order of magnitude faster.
|
||||
When a CI machine runs say `nx build host --configuration=production`, the `shop`, `about` and `cart` remotes will
|
||||
either be build on separate machines or retrieved from cache. Once all of them are built, the build process for `host`
|
||||
will combine the file artifacts from all the remotes. Nx Cloud takes care of distributing the tasks and moving file
|
||||
artifacts across machines. As a result, the worst case scenario build time (when nothing is cached) goes from building
|
||||
all the code to building the largest remote, which is often an order of magnitude faster.
|
||||
|
||||
## Resources
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user