Arquitectura MFE con Nextjs
Entendiendo como funciona la arquitectura MFE con nextJS
Producción
Para deploy de la arquitectura de MFE debemos tener en cuenta los siguientes conceptos:
Build Time:
El
build time en Next.js es el tiempo que tarda en construirse la aplicación antes de ser desplegada. Durante este proceso, Next.js compila todos los archivos de la aplicación y los optimiza para su uso en producción. Esto incluye la generación de páginas estáticas, la eliminación de código no utilizado y la minimización de archivos para mejorar el rendimiento de la aplicación.Para su implementación en module federation el build realiza una precarga de los remoteEntries de todos los MFE incluyendo su owner, teniendo en cuenta que la conexión entre MFE’s es bilateral por lo que todos y cada uno de los
sources deben tener la referencia exacta del archivo de entrada (remoteEntry.js). Este proceso divide cada conexión en un bundle optimizado en javascript(partial bundle) el cual sera el que se descargue al momento de consultar modulos federados..png?table=block&id=e38bbdd8-ae88-483b-9ae5-8d098539d2c1&cache=v2)
EXECUTION (JIT):
.png?table=block&id=8a2031e0-b92f-4eaa-b14e-3b3aa0249c1b&cache=v2)
Untitled Diagram.drawio (2).png
Build time:
- Container: Servidor de nextJs optimizado para producción
- Create partial bundle: Separación de remoteEntry.js en código optimizado para cada uno de los MFE’s
Loading:
- Load partial bundle: Antes de iniciar la carga por defecto de next y realiza una carga de los bundles que va utilizar (SOLO APLICA PARA SSR)
- Check versions & revalidate MFE: Valida chunks cacheados para verificar versiones de los
sourcesque consumirá y en caso de existir diferencia realiza un hotreload en el servidor que rehace los partial bundles
- consume remotes ssr: Ejecuta ssr de los MFE’s puedes ser en singular o mixed, es decir puede utilizar solo el ssr del MFE secundario o añadir funcionalidad adicional en del host .
Active on browser:
- Hydrate page: Proceso de next en el cual se ejecuta todo el código de javascript en el navegador. (En este momento sucede el primer render y empieza a vivir la pagina en el navegador)
- consume external components: descarga de código federado y render de componentes externos
Conexión entre MFE’s
La federación de módulos utiliza una conexión bilateral usando ventanas de exposición como puntos de referencia. Aunque un MFE puede consumir mas de un
source cada conexión es aislada y sucede con una conexión punto a punto..png?table=block&id=a0b3f376-8f6a-4058-af6b-ce84ac0377db&cache=v2)
Untitled Diagram.drawio (3).png
FlunkChunks y revalidate
.png?table=block&id=ab0d6eac-f122-4fe5-be47-10e7717d56f5&cache=v2)
Untitled Diagram.drawio (4).png
Revalidate:
Habilita el hotreload del servidor de nodos (no del cliente) en producción. Se recomienda esto, sin él, los servidores no podrán obtener actualizaciones remotas sin un reinicio completo.
FlunkChunks:
Estos son chunks cacheados en el host mapeados en forma de hash que ayudan a validar cambios en un MFE a consumir y así disparar el revalidate
import Document, { Html, Head, Main, NextScript } from "next/document";
import React from "react";
import { revalidate, FlushedChunks, flushChunks } from "@module-federation/nextjs-mf/utils";
class MyDocument extends Document {
static async getInitialProps(ctx) {
if(process.env.NODE_ENV === "development" && !ctx.req.url.includes("_next")) {
await revalidate().then((shouldReload) =>{
if (shouldReload) {
ctx.res.writeHead(302, { Location: ctx.req.url });
ctx.res.end();
}
});
} else {
ctx?.res?.on("finish", () => {
revalidate()
});
}
const chunks = await flushChunks()
const initialProps = await Document.getInitialProps(ctx);
return {
...initialProps,
chunks
};
}
render() {
return (
<Html>
<Head>
<meta name="robots" content="noindex" />
<FlushedChunks chunks={this.props.chunks} />
</Head>
<body className="bg-background-grey">
<Main />
<NextScript />
</body>
</Html>
);
}
}
export default MyDocument;Ambas se recomiendan integrarse en _document.tsx o en componentes a altos niveles
troubleshooting
- Un error común es la falla de referencia a los
sources, hacer doble check a las ventanas de exposición a los MFE’s, Se puede identificar debido a que el error en el cliente se muestra con código 500 y el mensajefailed chunks to load
- Al tener basePath configurado se debe partir desde allí para referenciar el archivo
remoteEntry.js
- Al añadir un MFE nuevo, es necesario hacer deploy antes del MFE y asegurarse que esta en linea para posteriormente hacer el deploy del orquestador
Development or local server
El servidor de development consume e interactúa de forma diferente al momento de usar module federation por lo que es necesario verificar todo desarrollo de este tipo corriendo el proyecto con yarn build && yarn start antes de realizar un deploy
.png?table=block&id=1f9135d7-4edc-4b79-a6c1-959d43057ea0&cache=v2)