feat: add lifecycle hooks for bridge

.changeset/great-feet-rule.md

@@ -0,0 +1,7 @@
+---
+'@module-federation/bridge-react': patch
+'@module-federation/bridge-vue3': patch
+'@module-federation/runtime': patch
+---
+
+feat: support module isolated reported

packages/bridge/bridge-react/package.json

@@ -45,7 +45,8 @@
   "peerDependencies": {
     "react": ">=16.9.0",
     "react-dom": ">=16.9.0",
-    "react-router-dom": ">=4"
+    "react-router-dom": ">=4",
+    "@module-federation/runtime": "workspace:*"
   },
   "devDependencies": {
     "@testing-library/react": "15.0.7",

packages/bridge/bridge-react/src/create.tsx

@@ -1,11 +1,11 @@
 import React, { forwardRef } from 'react';
-import type { ProviderParams } from '@module-federation/bridge-shared';
-import { LoggerInstance } from './utils';
 import {
   ErrorBoundary,
   ErrorBoundaryPropsWithComponent,
 } from 'react-error-boundary';
+import { LoggerInstance } from './utils';
 import RemoteApp from './remote';
+import type { ProviderParams } from '@module-federation/bridge-shared';
 
 export interface RenderFnParams extends ProviderParams {
   dom?: any;

packages/bridge/bridge-react/src/lifecycle.ts

@@ -0,0 +1,29 @@
+import { getInstance } from '@module-federation/runtime';
+import helper from '@module-federation/runtime/helpers';
+
+function registerBridgeLifeCycle() {
+  const { registerPlugins, pluginHelper } = helper.global;
+  const host = getInstance();
+  const pluginSystem = new pluginHelper.PluginSystem({
+    beforeBridgeRender: new pluginHelper.SyncHook<
+      [Record<string, any>],
+      void
+    >(),
+    beforeBridgeDestroy: new pluginHelper.SyncHook<
+      [Record<string, any>],
+      void
+    >(),
+  });
+
+  if (host) {
+    registerPlugins<typeof pluginSystem.lifecycle, typeof pluginSystem>(
+      host?.options?.plugins,
+      [pluginSystem],
+    );
+    return pluginSystem;
+  }
+
+  return null;
+}
+
+export { registerBridgeLifeCycle };

packages/bridge/bridge-react/src/provider.tsx

@@ -2,23 +2,31 @@ import { useLayoutEffect, useRef, useState } from 'react';
 import * as React from 'react';
 import ReactDOM from 'react-dom';
 import ReactDOMClient from 'react-dom/client';
-import { RouterContext } from './context';
 import type {
   ProviderParams,
   RenderFnParams,
 } from '@module-federation/bridge-shared';
-import { LoggerInstance, atLeastReact18 } from './utils';
 import { ErrorBoundary } from 'react-error-boundary';
+import { RouterContext } from './context';
+import { LoggerInstance, atLeastReact18 } from './utils';
 
+type RenderParams = RenderFnParams & any;
+type DestroyParams = {
+  dom: HTMLElement;
+};
 type RootType = HTMLElement | ReactDOMClient.Root;
+
 type ProviderFnParams<T> = {
   rootComponent: React.ComponentType<T>;
   render?: (
     App: React.ReactElement,
     id?: HTMLElement | string,
   ) => RootType | Promise<RootType>;
+  hooks?: {
+    beforeBridgeRender?: (params: RenderFnParams) => void;
+    beforeBridgeDestroy?: (params: DestroyParams) => void;
+  };
 };
-
 export function createBridgeComponent<T>(bridgeInfo: ProviderFnParams<T>) {
   return () => {
     const rootMap = new Map<any, RootType>();
@@ -37,7 +45,7 @@ export function createBridgeComponent<T>(bridgeInfo: ProviderFnParams<T>) {
     };
 
     return {
-      async render(info: RenderFnParams & any) {
+      async render(info: RenderParams) {
         LoggerInstance.log(`createBridgeComponent render Info`, info);
         const {
           moduleName,
@@ -61,6 +69,16 @@ export function createBridgeComponent<T>(bridgeInfo: ProviderFnParams<T>) {
           </ErrorBoundary>
         );
 
+        // call beforeBridgeRender hook
+        if (
+          bridgeInfo?.hooks &&
+          bridgeInfo?.hooks.beforeBridgeRender &&
+          typeof bridgeInfo?.hooks.beforeBridgeRender === 'function'
+        ) {
+          bridgeInfo.hooks.beforeBridgeRender(info);
+        }
+
+        // call render function
         if (atLeastReact18(React)) {
           if (bridgeInfo?.render) {
             // in case bridgeInfo?.render is an async function, resolve this to promise
@@ -78,10 +96,21 @@ export function createBridgeComponent<T>(bridgeInfo: ProviderFnParams<T>) {
           renderFn?.(rootComponentWithErrorBoundary, info.dom);
         }
       },
-      async destroy(info: { dom: HTMLElement }) {
+      async destroy(info: DestroyParams) {
         LoggerInstance.log(`createBridgeComponent destroy Info`, {
           dom: info.dom,
         });
+
+        // call beforeBridgeDestroy hook
+        if (
+          bridgeInfo?.hooks &&
+          bridgeInfo?.hooks.beforeBridgeDestroy &&
+          typeof bridgeInfo?.hooks.beforeBridgeDestroy === 'function'
+        ) {
+          bridgeInfo.hooks.beforeBridgeDestroy(info);
+        }
+
+        // call destroy function
         if (atLeastReact18(React)) {
           const root = rootMap.get(info.dom);
           (root as ReactDOMClient.Root)?.unmount();

packages/bridge/bridge-react/src/remote/index.tsx

@@ -7,9 +7,10 @@ import React, {
 } from 'react';
 import * as ReactRouterDOM from 'react-router-dom';
 import type { ProviderParams } from '@module-federation/bridge-shared';
-import { LoggerInstance, pathJoin } from '../utils';
 import { dispatchPopstateEnv } from '@module-federation/bridge-shared';
 import { ErrorBoundaryPropsWithComponent } from 'react-error-boundary';
+import { registerBridgeLifeCycle } from '../lifecycle';
+import { LoggerInstance, pathJoin } from '../utils';
 
 declare const __APP_VERSION__: string;
 export interface RenderFnParams extends ProviderParams {
@@ -39,6 +40,7 @@ const RemoteAppWrapper = forwardRef(function (
   props: RemoteAppParams & RenderFnParams,
   ref,
 ) {
+  const bridgeHook = registerBridgeLifeCycle();
   const RemoteApp = () => {
     LoggerInstance.log(`RemoteAppWrapper RemoteApp props >>>`, { props });
     const {
@@ -78,6 +80,13 @@ const RemoteAppWrapper = forwardRef(function (
           `createRemoteComponent LazyComponent render >>>`,
           renderProps,
         );
+
+        if (bridgeHook && bridgeHook?.lifecycle?.beforeBridgeRender) {
+          bridgeHook?.lifecycle?.beforeBridgeRender.emit({
+            ...renderProps,
+          });
+        }
+
         providerReturn.render(renderProps);
       });
 
@@ -89,6 +98,16 @@ const RemoteAppWrapper = forwardRef(function (
               `createRemoteComponent LazyComponent destroy >>>`,
               { moduleName, basename, dom: renderDom.current },
             );
+            if (bridgeHook && bridgeHook?.lifecycle?.beforeBridgeDestroy) {
+              bridgeHook?.lifecycle?.beforeBridgeDestroy.emit({
+                moduleName,
+                dom: renderDom.current,
+                basename,
+                memoryRoute,
+                fallback,
+                ...resProps,
+              });
+            }
             providerInfoRef.current?.destroy({
               dom: renderDom.current,
             });

packages/bridge/vue3-bridge/package.json

@@ -28,7 +28,8 @@
   },
   "peerDependencies": {
     "vue": "=3",
-    "vue-router": "=3"
+    "vue-router": "=3",
+    "@module-federation/runtime": "workspace:*"
   },
   "dependencies": {
     "@module-federation/bridge-shared": "workspace:*"

packages/bridge/vue3-bridge/src/create.ts

@@ -1,7 +1,7 @@
 import { defineAsyncComponent, h } from 'vue';
+import { useRoute } from 'vue-router';
 import RemoteApp from './remoteApp.jsx';
 import { LoggerInstance } from './utils.js';
-import { useRoute } from 'vue-router';
 
 declare const __APP_VERSION__: string;
 

packages/bridge/vue3-bridge/src/lifecycle.ts

@@ -0,0 +1,29 @@
+import { getInstance } from '@module-federation/runtime';
+import helper from '@module-federation/runtime/helpers';
+
+function registerBridgeLifeCycle() {
+  const { registerPlugins, pluginHelper } = helper.global;
+  const host = getInstance();
+  const pluginSystem = new pluginHelper.PluginSystem({
+    beforeBridgeRender: new pluginHelper.SyncHook<
+      [Record<string, any>],
+      void
+    >(),
+    beforeBridgeDestroy: new pluginHelper.SyncHook<
+      [Record<string, any>],
+      void
+    >(),
+  });
+
+  if (host) {
+    registerPlugins<typeof pluginSystem.lifecycle, typeof pluginSystem>(
+      host?.options?.plugins,
+      [pluginSystem],
+    );
+    return pluginSystem;
+  }
+
+  return null;
+}
+
+export { registerBridgeLifeCycle };

packages/bridge/vue3-bridge/src/provider.ts

@@ -14,6 +14,7 @@ export function createBridgeComponent(bridgeInfo: any) {
         LoggerInstance.log(`createBridgeComponent render Info`, info);
         const app = Vue.createApp(bridgeInfo.rootComponent);
         rootMap.set(info.dom, app);
+        bridgeInfo?.renderLifecycle?.(info);
         const appOptions = bridgeInfo.appOptions({
           basename: info.basename,
           memoryRoute: info.memoryRoute,
@@ -46,6 +47,7 @@ export function createBridgeComponent(bridgeInfo: any) {
       destroy(info: { dom: HTMLElement }) {
         LoggerInstance.log(`createBridgeComponent destroy Info`, info);
         const root = rootMap.get(info?.dom);
+        bridgeInfo?.destroyLifecycle?.(info);
         root?.unmount();
       },
     };

packages/bridge/vue3-bridge/src/remoteApp.tsx

@@ -1,7 +1,8 @@
 import { ref, onMounted, onBeforeUnmount, watch, defineComponent } from 'vue';
+import { dispatchPopstateEnv } from '@module-federation/bridge-shared';
 import { useRoute } from 'vue-router';
+import { registerBridgeLifeCycle } from './lifecycle';
 import { LoggerInstance } from './utils';
-import { dispatchPopstateEnv } from '@module-federation/bridge-shared';
 
 export default defineComponent({
   name: 'RemoteApp',
@@ -16,6 +17,7 @@ export default defineComponent({
     const providerInfoRef = ref(null);
     const pathname = ref('');
     const route = useRoute();
+    const bridgeHook = registerBridgeLifeCycle();
 
     const renderComponent = () => {
       const providerReturn = props.providerInfo?.();
@@ -30,6 +32,12 @@ export default defineComponent({
         `createRemoteComponent LazyComponent render >>>`,
         renderProps,
       );
+
+      if (bridgeHook && bridgeHook?.lifecycle?.beforeBridgeRender) {
+        bridgeHook?.lifecycle?.beforeBridgeRender.emit({
+          ...renderProps,
+        });
+      }
       providerReturn.render(renderProps);
     };
 
@@ -61,6 +69,15 @@ export default defineComponent({
         ...props,
       });
       watchStopHandle();
+      if (bridgeHook && bridgeHook?.lifecycle?.beforeBridgeRender) {
+        bridgeHook?.lifecycle?.beforeBridgeDestroy.emit({
+          name: props.moduleName,
+          dom: rootRef.value,
+          basename: props.basename,
+          memoryRoute: props.memoryRoute,
+        });
+      }
+
       (providerInfoRef.value as any)?.destroy({ dom: rootRef.value });
     });
 

packages/runtime/src/helpers.ts

@@ -19,6 +19,8 @@ import {
   Global,
 } from './global';
 import { getRegisteredShare, getGlobalShareScope } from './utils/share';
+import * as pluginHelper from './utils/hooks';
+import { registerPlugins } from './utils';
 
 interface IShareUtils {
   getRegisteredShare: typeof getRegisteredShare;
@@ -48,6 +50,8 @@ interface IGlobalUtils {
   getGlobalHostPlugins: typeof getGlobalHostPlugins;
   getPreloaded: typeof getPreloaded;
   setPreloaded: typeof setPreloaded;
+  registerPlugins: typeof registerPlugins;
+  pluginHelper: typeof pluginHelper;
 }
 
 const GlobalUtils: IGlobalUtils = {
@@ -69,6 +73,8 @@ const GlobalUtils: IGlobalUtils = {
   getGlobalHostPlugins,
   getPreloaded,
   setPreloaded,
+  registerPlugins,
+  pluginHelper,
 };
 
 export default {

packages/runtime/src/module/index.ts

@@ -1,4 +1,4 @@
-import { getFMId, assert } from '../utils';
+import { getFMId, assert, processModuleAlias } from '../utils';
 import { safeToString, ModuleInfo } from '@module-federation/sdk';
 import { getRemoteEntry } from '../utils/load';
 import { FederationHost } from '../core';
@@ -121,7 +121,9 @@ class Module {
       `${getFMId(this.remoteInfo)} remote don't export ${expose}.`,
     );
 
-    const wrapModuleFactory = this.wraperFactory(moduleFactory, id);
+    // keep symbol for module name always one format
+    const symbolName = processModuleAlias(this.remoteInfo.name, expose);
+    const wrapModuleFactory = this.wraperFactory(moduleFactory, symbolName);
 
     if (!loadFactory) {
       return wrapModuleFactory;