@angular-architects/native-federation 0.9.0 → 0.9.2

package/README.md

@@ -1,259 +1,314 @@
-# Native Federation
-
-Native Federation is a "browser-native" implementation of the successful mental model behind wepback Module Federation for building Micro Frontends.
-
-## Features
-
-- ✅ Mental Model of Module Federation 
-- ✅ Future Proof: Independent of build tools like webpack
-- ✅ Embraces Import Maps - an emerging web standard
-- ✅ Easy to configure: We use the same API and Schematics as for our Module Federation plugin
-- ✅ Blazing Fast: The reference implementation not only uses the fast esbuild; it also caches already built shared dependencies (like Angular itself). 
-
-## Today and Tomorrow
-
-### Bundler
-
-The current version uses **esbuild**. Future versions will allow to easily **switch out the build tool**. 
-
-### Frameworks
-
-**Angular** is a first-class citizen: The package ships with **Schematics** for the Angular CLI and a **builder** (that delegates to the experimental esbuild builder the CLI team is current working on). Future versions will also make it easy to use the implementation **with other frameworks**. 
-
-### Design
-
-This is possible, because by design, most of the implementation runs outside of the bundler und independently of CLI mechanisms. Hence, we will expose 2-3 helper functions everyone can call in their build process regardless of the framework or build tool used.
-
-## Current Limitations
-
-This is a first experimental version. The results look very promising, however it's not intended to be used in production. Feel free to try it out and to provide feedback!
-
-Limitations:
-
-- 🔷 As we use a fork of the experimental esbuild builder the CLI team is current working on, there is currently **only a builder for ng build**. ng serve or ng test are currently not supported. This support will be added with a future version.
-  
-- 🔷 Libraries are currently only shared if two or more remotes (Micro Frontends) request the very same version. This is also what works best with Angular. In a future version, we will add optional "version negotiation" for the sake of feature parity with Module Federation. This allows Native Federation to decide for a "higher compatible version" (e. g. a higher minor version provided by another Micro Frontend) at runtime.
-
-## Credits
-
-Big thanks to:
-
-- [Zack Jackson](https://twitter.com/ScriptedAlchemy) for originally coming up with the great idea of Module Federation and its successful mental model
-- [Tobias Koppers](https://twitter.com/wSokra) for helping to make Module Federation a first class citizen of webpack
-- [The Nx Team](https://twitter.com/NxDevTools), esp. [Colum Ferry](https://twitter.com/FerryColum), who seamlessly integrated webpack Module Federation into Nx and hence helped to spread the word about it (Nx + Module Federation === ❤️)
-- [Michael Egger-Zikes](https://twitter.com/MikeZks) for contributing to our Module Federation efforts and brining in valuable feedback
-- The Angular CLI-Team, esp. [Alan Agius](https://twitter.com/AlanAgius4) and [Charles Lyding](https://twitter.com/charleslyding), for working on the experimental esbuild builder for Angular
-
-## Example
-
-We migrated our webpack Module Federation example to Native Federation:
-
-![Example](https://raw.githubusercontent.com/angular-architects/module-federation-plugin/main/libs/native-federation/example.png)
-
-Please find the example [here (branch: ng-solution)](https://github.com/manfredsteyer/module-federation-plugin-example/tree/nf-solution):
-
-```
-git clone https://github.com/manfredsteyer/module-federation-plugin-example.git --branch nf-solution
-
-cd module-federation-plugin-example
-
-npm i
-npm run build
-npm run start
-```
-
-Then, open http://localhost:3000 in your browser.
-
-Please note, that the current **experimental** version does **not** support ``ng serve``. Hence, you need to build it and serve it from the ``dist`` folder (this is what npm run build && npm run start in the above shown example do).
-
-## Usage
-
-> You can checkout the [nf-starter branch](https://github.com/manfredsteyer/module-federation-plugin-example/tree/nf-solution) to try out Native Federation.
-
-### Adding Native Federation
-
-```
-npm i @angular-architects/native-federation -D
-```
-
-Making an application a host:
-
-```
-ng g @angular-architects/native-federation:init --project shell --type host
-```
-
-A dynamic host is a host reading the configuration data at runtime from a ``.json`` file:
-
-```
-ng g @angular-architects/native-federation:init --project shell --type dynamic-host
-```
-
-Making an application a remote:
-
-```
-ng g @angular-architects/native-federation:init --project mfe1 --type remote
-```
-
-### Configuring the Host
-
-The host configuration looks like what you know from our Module Federation plugin:
-
-```javascript
-// projects/shell/federation.config.js
-
-const { withNativeFederation, shareAll } = require('@angular-architects/native-federation/config');
-
-module.exports = withNativeFederation({
-
-  shared: {
-    ...shareAll({ singleton: true, strictVersion: true, requiredVersion: 'auto' }),
-  },
-
-});
-```
-
-### Configuring the Remote
-
-Also the remote configuration looks familiar:
-
-```javascript
-// projects/mfe1/federation.config.js
-
-const { withNativeFederation, shareAll } = require('@angular-architects/native-federation/config');
-
-module.exports = withNativeFederation({
-
-  name: 'mfe1',
-
-  exposes: {
-    './Module': './projects/mfe1/src/app/flights/flights.module.ts',
-  },
-
-  shared: {
-    ...shareAll({ singleton: true, strictVersion: true, requiredVersion: 'auto' }),
-  },
-
-});
-```
-
-### Initializing the Host
-
-Call ``initFederation`` before bootstrapping your ``main.ts``:
-
-```typescript
-// projects/shell/src/main.ts
-
-import { initFederation } from '@angular-architects/native-federation';
-
-initFederation({
-	mfe1: 'http://localhost:3001/remoteEntry.json'
-})
-  .catch(err => console.error(err))
-  .then(_ => import('./bootstrap'))
-  .catch(err => console.error(err));
-```
-
-> Our ``init`` schematic shown above generates all of this if you pass ``--type host``.
-
-You can directly pass a mapping between remote names and their ``remoteEntry.json``. The ``remoteEntry.json`` contains the necessary metadata. It is generated when compiling the remote.
-
-Please note that in Native Federation, the remote entry is just a ``.json`` file while its a ``.js`` file in Module Federation.
-
-However, you don't need to hardcode this mapping. Feel free to point to the file name of a federation manifest:
-
-```typescript
-// projects/shell/src/main.ts
-
-import { initFederation } from '@angular-architects/native-federation';
-
-initFederation('/assets/federation.manifest.json')
-  .catch(err => console.error(err))
-  .then(_ => import('./bootstrap'))
-  .catch(err => console.error(err));
-```
-
-This manifest can be exchanged when deploying the solution. Hence, you can adopt the solution to the current environment.
-
-> Our ``init`` schematic shown above generates this variation if you pass ``--type dynamic-host``.
-
-Credits: The Nx team originally came up with the idea for the manifest.
-
-This is what the (also generated) federation manifest looks like:
-
-```json
-{
-	"mfe1": "http://localhost:3001/remoteEntry.json"
-}
-```
-
-### Initializing the Remote
-
-Also, the remote needs to be initialized. If a remote doesn't load further remotes, you don't need to pass any mappings to ``initFederation``:
-
-```typescript
-import { initFederation } from '@angular-architects/native-federation';
-
-initFederation()
-  .catch(err => console.error(err))
-  .then(_ => import('./bootstrap'))
-  .catch(err => console.error(err));
-```
-
-### Loading a Remote
-
-Use the helper function ``loadRemoteModule`` to load a configured remote:
-
-```typescript
-import { loadRemoteModule } from '@angular-architects/native-federation';
-[...]
-
-export const APP_ROUTES: Routes = [
-    [...]
-
-    {
-      path: 'flights',
-      loadChildren: () => loadRemoteModule({
-          remoteName: 'mfe1',
-          exposedModule: './Module'
-        }).then(m => m.FlightsModule)
-    },
-
-    [...]
-}
-```
-
-This can be used with and without routing; with ``NgModule``s but also with **standalone** building blocks. Just use it instead of dynamic imports.
-
-For the sake of compatibility with our Module Federation API, you can also use the ``remoteEntry`` to identify the remote in question:
-
-```typescript
-import { loadRemoteModule } from '@angular-architects/native-federation';
-[...]
-
-export const APP_ROUTES: Routes = [
-    [...]
-
-    {
-      path: 'flights',
-      loadChildren: () => loadRemoteModule({
-          // Alternative: You can also use the remoteEntry i/o the remoteName:
-          remoteEntry: 'http://localhost:3001/remoteEntry.json',
-          exposedModule: './Module'
-        }).then(m => m.FlightsModule)
-    },
-
-    [...]
-}
-```
-
-However, we prefer the first option where just the ``remoteName`` is passed.
-
-## More: Blog Articles
-
-Find out more about our work including Micro Frontends and Module Federation but also about alternatives to these approaches in our [blog](https://www.angulararchitects.io/en/aktuelles/the-microfrontend-revolution-part-2-module-federation-with-angular/).
-
-## More: Angular Architecture Workshop (100% online, interactive)
-
-In our [Angular Architecture Workshop](https://www.angulararchitects.io/en/angular-workshops/advanced-angular-enterprise-architecture-incl-ivy/), we cover all these topics and far more. We provide different options and alternatives and show up their consequences.
-
-[Details: Angular Architecture Workshop](https://www.angulararchitects.io/en/angular-workshops/advanced-angular-enterprise-architecture-incl-ivy/)
+# Native Federation
+
+Native Federation is a "browser-native" implementation of the successful mental model behind wepback Module Federation for building Micro Frontends.
+
+## Features
+
+- ✅ Mental Model of Module Federation
+- ✅ Future Proof: Independent of build tools like webpack
+- ✅ Embraces Import Maps - an emerging web standard
+- ✅ Easy to configure: We use the same API and Schematics as for our Module Federation plugin
+- ✅ Blazing Fast: The reference implementation not only uses the fast esbuild; it also caches already built shared dependencies (like Angular itself).
+
+## Today and Tomorrow
+
+### Bundler
+
+The current version uses **esbuild**. Future versions will allow to easily **switch out the build tool**.
+
+### Frameworks
+
+**Angular** is a first-class citizen: The package ships with **Schematics** for the Angular CLI and a **builder** (that delegates to the experimental esbuild builder the CLI team is current working on). Future versions will also make it easy to use the implementation **with other frameworks**.
+
+### Design
+
+This is possible, because by design, most of the implementation runs outside of the bundler und independently of CLI mechanisms. Hence, we will expose 2-3 helper functions everyone can call in their build process regardless of the framework or build tool used.
+
+## Current Limitations
+
+This is a first experimental version. The results look very promising, however it's not intended to be used in production. Feel free to try it out and to provide feedback!
+
+Limitations:
+
+- 🔷 As we use a fork of the experimental esbuild builder the CLI team is current working on, there is currently **only a builder for ng build**. ng serve or ng test are currently not supported. This support will be added with a future version. Also, as the forked esbuile builder is still experimental, you cannot expect to get all the features you are used to. This will also change over time.
+- 🔷 Libraries are currently only shared if two or more remotes (Micro Frontends) request the very same version. This is also what works best with Angular. In a future version, we will add optional "version negotiation" for the sake of feature parity with Module Federation. This allows Native Federation to decide for a "higher compatible version" (e. g. a higher minor version provided by another Micro Frontend) at runtime.
+
+## Credits
+
+Big thanks to:
+
+- [Zack Jackson](https://twitter.com/ScriptedAlchemy) for originally coming up with the great idea of Module Federation and its successful mental model
+- [Tobias Koppers](https://twitter.com/wSokra) for helping to make Module Federation a first class citizen of webpack
+- [Florian Rappl](https://twitter.com/FlorianRappl) for an good discussion about these topics during a speakers dinner in Nuremberg
+- [The Nx Team](https://twitter.com/NxDevTools), esp. [Colum Ferry](https://twitter.com/FerryColum), who seamlessly integrated webpack Module Federation into Nx and hence helped to spread the word about it (Nx + Module Federation === ❤️)
+- [Michael Egger-Zikes](https://twitter.com/MikeZks) for contributing to our Module Federation efforts and brining in valuable feedback
+- The Angular CLI-Team, esp. [Alan Agius](https://twitter.com/AlanAgius4) and [Charles Lyding](https://twitter.com/charleslyding), for working on the experimental esbuild builder for Angular
+
+## Example
+
+We migrated our webpack Module Federation example to Native Federation:
+
+![Example](https://raw.githubusercontent.com/angular-architects/module-federation-plugin/main/libs/native-federation/example.png)
+
+Please find the example [here (branch: ng-solution)](https://github.com/manfredsteyer/module-federation-plugin-example/tree/nf-solution):
+
+```
+git clone https://github.com/manfredsteyer/module-federation-plugin-example.git --branch nf-solution
+
+cd module-federation-plugin-example
+
+npm i
+npm run build
+npm start
+```
+
+Then, open http://localhost:3000 in your browser.
+
+Please note, that the current **experimental** version does **not** support `ng serve`. Hence, you need to build it and serve it from the `dist` folder (this is what npm run build && npm run start in the above shown example do).
+
+## About the Mental Model
+
+The underlying mental model allows for runtime integration: Loading a part of a separately built and deployed application into your's. This is needed for Micro Frontend architectures but also for plugin-based solutions.
+
+For this, the mental model introduces several concepts:
+
+- **Remote:** The remote is a separately built and deployed application. It can **expose EcmaScript** modules that can be loaded into other applications.
+- **Host:** The host loads one or several remotes on demand. For your framework's perspective, this looks like traditional lazy loading. The big difference is that the host doesn't know the remotes at compilation time.
+- **Shared Dependencies:** If a several remotes and the host use the same library, you might not want to download it several times. Instead, you might want to just download it once and share it at runtime. For this use case, the mental model allows for defining such shared dependencies.
+- **Version Mismatch:** If two or more applications use a different version of the same shared library, we need to prevent a version mismatch. To deal with it, the mental model defines several strategies, like falling back to another version that fits the application, using a different compatible one (according to semantic versioning) or throwing an error.
+
+## Usage
+
+> You can checkout the [nf-starter branch](https://github.com/manfredsteyer/module-federation-plugin-example/tree/nf-solution) to try out Native Federation.
+
+### Adding Native Federation
+
+```
+npm i @angular-architects/native-federation -D
+```
+
+Making an application a host:
+
+```
+ng g @angular-architects/native-federation:init --project shell --type host
+```
+
+A dynamic host is a host reading the configuration data at runtime from a `.json` file:
+
+```
+ng g @angular-architects/native-federation:init --project shell --type dynamic-host
+```
+
+Making an application a remote:
+
+```
+ng g @angular-architects/native-federation:init --project mfe1 --type remote
+```
+
+### Configuring the Host
+
+The host configuration looks like what you know from our Module Federation plugin:
+
+```javascript
+// projects/shell/federation.config.js
+
+const {
+  withNativeFederation,
+  shareAll,
+} = require('@angular-architects/native-federation/config');
+
+module.exports = withNativeFederation({
+  shared: {
+    ...shareAll({
+      singleton: true,
+      strictVersion: true,
+      requiredVersion: 'auto',
+    }),
+  },
+});
+```
+
+### Configuring the Remote
+
+Also the remote configuration looks familiar:
+
+```javascript
+// projects/mfe1/federation.config.js
+
+const {
+  withNativeFederation,
+  shareAll,
+} = require('@angular-architects/native-federation/config');
+
+module.exports = withNativeFederation({
+  name: 'mfe1',
+
+  exposes: {
+    './Module': './projects/mfe1/src/app/flights/flights.module.ts',
+  },
+
+  shared: {
+    ...shareAll({
+      singleton: true,
+      strictVersion: true,
+      requiredVersion: 'auto',
+    }),
+  },
+});
+```
+
+### Initializing the Host
+
+Call `initFederation` before bootstrapping your `main.ts`:
+
+```typescript
+// projects/shell/src/main.ts
+
+import { initFederation } from '@angular-architects/native-federation';
+
+initFederation({
+  mfe1: 'http://localhost:3001/remoteEntry.json',
+})
+  .catch((err) => console.error(err))
+  .then((_) => import('./bootstrap'))
+  .catch((err) => console.error(err));
+```
+
+> Our `init` schematic shown above generates all of this if you pass `--type host`.
+
+You can directly pass a mapping between remote names and their `remoteEntry.json`. The `remoteEntry.json` contains the necessary metadata. It is generated when compiling the remote.
+
+Please note that in Native Federation, the remote entry is just a `.json` file while its a `.js` file in Module Federation.
+
+However, you don't need to hardcode this mapping. Feel free to point to the file name of a federation manifest:
+
+```typescript
+// projects/shell/src/main.ts
+
+import { initFederation } from '@angular-architects/native-federation';
+
+initFederation('/assets/federation.manifest.json')
+  .catch((err) => console.error(err))
+  .then((_) => import('./bootstrap'))
+  .catch((err) => console.error(err));
+```
+
+This manifest can be exchanged when deploying the solution. Hence, you can adopt the solution to the current environment.
+
+> Our `init` schematic shown above generates this variation if you pass `--type dynamic-host`.
+
+Credits: The Nx team originally came up with the idea for the manifest.
+
+This is what the (also generated) federation manifest looks like:
+
+```json
+{
+  "mfe1": "http://localhost:3001/remoteEntry.json"
+}
+```
+
+### Initializing the Remote
+
+Also, the remote needs to be initialized. If a remote doesn't load further remotes, you don't need to pass any mappings to `initFederation`:
+
+```typescript
+import { initFederation } from '@angular-architects/native-federation';
+
+initFederation()
+  .catch((err) => console.error(err))
+  .then((_) => import('./bootstrap'))
+  .catch((err) => console.error(err));
+```
+
+### Loading a Remote
+
+Use the helper function `loadRemoteModule` to load a configured remote:
+
+```typescript
+import { loadRemoteModule } from '@angular-architects/native-federation';
+[...]
+
+export const APP_ROUTES: Routes = [
+    [...]
+
+    {
+      path: 'flights',
+      loadChildren: () => loadRemoteModule({
+          remoteName: 'mfe1',
+          exposedModule: './Module'
+        }).then(m => m.FlightsModule)
+    },
+
+    [...]
+}
+```
+
+This can be used with and without routing; with `NgModule`s but also with **standalone** building blocks. Just use it instead of dynamic imports.
+
+For the sake of compatibility with our Module Federation API, you can also use the `remoteEntry` to identify the remote in question:
+
+```typescript
+import { loadRemoteModule } from '@angular-architects/native-federation';
+[...]
+
+export const APP_ROUTES: Routes = [
+    [...]
+
+    {
+      path: 'flights',
+      loadChildren: () => loadRemoteModule({
+          // Alternative: You can also use the remoteEntry i/o the remoteName:
+          remoteEntry: 'http://localhost:3001/remoteEntry.json',
+          exposedModule: './Module'
+        }).then(m => m.FlightsModule)
+    },
+
+    [...]
+}
+```
+
+However, we prefer the first option where just the `remoteName` is passed.
+
+### Polyfill
+
+This library uses Import Maps. As of today, not all browsers support this emerging browser feature, we need a polyfill. We recommend the polyfill `es-module-shims` which has been developed for production use cases. Our schematics install it via npm and add it to your `polyfills.ts`.
+
+Also, the schematics add the following to your `index.html`:
+
+```html
+<script type="esms-options">
+  {
+      "shimMode": true
+  }
+</script>
+
+<script type="module" src="polyfills.js"></script>
+
+<script type="module-shim" src="main.js"></script>
+```
+
+The script with the type `esms-options` configures the polyfill. This library was built for shim mode. In this mode, the polyfill provides some additional features beyond the proposal for Import Maps. These features, for instance, allow for dynamically creating an import map after loading the first EcmaScript module. Native Federation uses this possibility.
+
+To make the polyfill to load your EcmaScript modules (bundles) in shim mode, assign the type `module-shim`. However, please just use module for the polyfill bundle itself to prevent an hen/egg-issue.
+
+## FAQ
+
+### Should we Already use Native Federation in Production?
+
+For production, we would stick with Module Federation for the time being. Native Federation, however, shows that you don't need to fear that you are left alone, once you (or the community) wants to move over to other build tools.
+
+We will evolve Native Federation but also our Module Federation support and keep you posted.
+
+### How does Native Federation Work under the Covers?
+
+We use Import Maps at runtime. As they are currently not supported in every browser, our `init` schematic installs the `es-module-shims` polyfill. In addition to Import Maps, we use some code at build time and at runtime to provide the Mental Model of Module Federation.
+
+## More: Blog Articles
+
+Find out more about our work including Micro Frontends and Module Federation but also about alternatives to these approaches in our [blog](https://www.angulararchitects.io/en/aktuelles/the-microfrontend-revolution-part-2-module-federation-with-angular/).
+
+## More: Angular Architecture Workshop (100% online, interactive)
+
+In our [Angular Architecture Workshop](https://www.angulararchitects.io/en/angular-workshops/advanced-angular-enterprise-architecture-incl-ivy/), we cover all these topics and far more. We provide different options and alternatives and show up their consequences.
+
+[Details: Angular Architecture Workshop](https://www.angulararchitects.io/en/angular-workshops/advanced-angular-enterprise-architecture-incl-ivy/)

package/builders.json

@@ -1,10 +1,10 @@
-{
-  "$schema": "../../node_modules/@angular-devkit/architect/src/builders-schema.json",
-  "builders": {
-    "build": {
-      "implementation": "./src/builders/build/builder",
-      "schema": "./src/builders/build/schema.json",
-      "description": "build builder"
-    }
-  }
-}
+{
+  "$schema": "../../node_modules/@angular-devkit/architect/src/builders-schema.json",
+  "builders": {
+    "build": {
+      "implementation": "./src/builders/build/builder",
+      "schema": "./src/builders/build/schema.json",
+      "description": "build builder"
+    }
+  }
+}

package/collection.json

@@ -1,17 +1,17 @@
-{
-  "$schema": "../../node_modules/@angular-devkit/schematics/collection-schema.json",
-  "name": "module-federation",
-  "version": "0.0.1",
-  "schematics": {
-    "ng-add": {
-      "factory": "./src/schematics/init/schematic",
-      "schema": "./src/schematics/init/schema.json",
-      "description": "Initialize an angular project for webpack module federation"
-    },
-    "init": {
-      "factory": "./src/schematics/init/schematic",
-      "schema": "./src/schematics/init/schema.json",
-      "description": "Initialize an angular project for webpack module federation"
-    }
-  }
-}
+{
+  "$schema": "../../node_modules/@angular-devkit/schematics/collection-schema.json",
+  "name": "module-federation",
+  "version": "0.0.1",
+  "schematics": {
+    "ng-add": {
+      "factory": "./src/schematics/init/schematic",
+      "schema": "./src/schematics/init/schema.json",
+      "description": "Initialize an angular project for webpack module federation"
+    },
+    "init": {
+      "factory": "./src/schematics/init/schematic",
+      "schema": "./src/schematics/init/schema.json",
+      "description": "Initialize an angular project for webpack module federation"
+    }
+  }
+}