feat: add remote-entry script resource retry for retry-plugin (#3321)

module-federation · Dec 10, 2024 · fa7a0bd · fa7a0bd
1 parent 85ef6c4
commit fa7a0bd
Show file tree

Hide file tree

Showing 9 changed files with 153 additions and 60 deletions.
diff --git a/.changeset/small-eyes-change.md b/.changeset/small-eyes-change.md
@@ -0,0 +1,6 @@
+---
+'@module-federation/retry-plugin': patch
+'@module-federation/runtime': patch
+---
+
+feat: add remote-entry script resource retry for retry-plugin
diff --git a/apps/router-demo/router-host-2000/rsbuild.config.ts b/apps/router-demo/router-host-2000/rsbuild.config.ts
@@ -31,7 +31,7 @@ export default defineConfig({
       shared: ['react', 'react-dom', 'antd'],
       runtimePlugins: [
         path.join(__dirname, './src/runtime-plugin/shared-strategy.ts'),
-        // path.join(__dirname, './src/runtime-plugin/retry.ts'),
+        path.join(__dirname, './src/runtime-plugin/retry.ts'),
       ],
       // bridge: {
       //   disableAlias: true,

diff --git a/apps/router-demo/router-host-2000/src/App.tsx b/apps/router-demo/router-host-2000/src/App.tsx
@@ -14,22 +14,22 @@ init({
   remotes: [],
   plugins: [
     BridgeReactPlugin(),
-    RetryPlugin({
-      fetch: {
-        url: 'http://localhost:2008/not-exist-mf-manifest.json',
-        fallback: () => 'http://localhost:2001/mf-manifest.json',
-      },
-      script: {
-        retryTimes: 3,
-        retryDelay: 1000,
-        moduleName: ['remote1'],
-        cb: (resolve, error) => {
-          return setTimeout(() => {
-            resolve(error);
-          }, 1000);
-        },
-      },
-    }),
+    // RetryPlugin({
+    //   fetch: {
+    //     url: 'http://localhost:2008/not-exist-mf-manifest.json',
+    //     fallback: () => 'http://localhost:2001/mf-manifest.json',
+    //   },
+    //   script: {
+    //     retryTimes: 3,
+    //     retryDelay: 1000,
+    //     moduleName: ['remote1'],
+    //     cb: (resolve, error) => {
+    //       return setTimeout(() => {
+    //         resolve(error);
+    //       }, 1000);
+    //     },
+    //   },
+    // }),
   ],
 });
 

diff --git a/packages/retry-plugin/src/fetch-retry.ts b/packages/retry-plugin/src/fetch-retry.ts
@@ -33,8 +33,9 @@ async function fetchWithRetry({
   } catch (error) {
     if (retryTimes <= 0) {
       logger.log(
-        `>>>>>>>>> retry failed after ${retryTimes} times for url: ${url}, now will try fallbackUrl url <<<<<<<<<`,
+        `[ Module Federation RetryPlugin ]: retry failed after ${retryTimes} times for url: ${url}, now will try fallbackUrl url`,
       );
+
       if (fallback && typeof fallback === 'function') {
         return fetchWithRetry({
           url: fallback(url),

diff --git a/packages/retry-plugin/src/index.ts b/packages/retry-plugin/src/index.ts
@@ -1,7 +1,7 @@
 import { FederationRuntimePlugin } from '@module-federation/runtime/types';
 import { fetchWithRetry } from './fetch-retry';
-import { defaultRetries, defaultRetryDelay } from './constant';
 import type { RetryPluginParams } from './types';
+import { scriptCommonRetry } from './util';
 
 const RetryPlugin: (params: RetryPluginParams) => FederationRuntimePlugin = ({
   fetch: fetchOption,
@@ -36,39 +36,39 @@ const RetryPlugin: (params: RetryPluginParams) => FederationRuntimePlugin = ({
     }
     return fetch(url, options);
   },
-  async getModuleFactory({ remoteEntryExports, expose, moduleInfo }) {
-    let moduleFactory;
-    const { retryTimes = defaultRetries, retryDelay = defaultRetryDelay } =
-      scriptOption || {};
-
-    if (
-      (scriptOption?.moduleName &&
-        scriptOption?.moduleName.some(
-          (m) => moduleInfo.name === m || (moduleInfo as any)?.alias === m,
-        )) ||
-      scriptOption?.moduleName === undefined
-    ) {
-      let attempts = 0;
 
-      while (attempts - 1 < retryTimes) {
-        try {
-          moduleFactory = await remoteEntryExports.get(expose);
-          break;
-        } catch (error) {
-          attempts++;
-          if (attempts - 1 >= retryTimes) {
-            scriptOption?.cb &&
-              (await new Promise(
-                (resolve) =>
-                  scriptOption?.cb && scriptOption?.cb(resolve, error),
-              ));
-            throw error;
-          }
-          await new Promise((resolve) => setTimeout(resolve, retryDelay));
-        }
-      }
-    }
-    return moduleFactory;
+  async loadEntryError({
+    getRemoteEntry,
+    origin,
+    remoteInfo,
+    remoteEntryExports,
+    globalLoading,
+    uniqueKey,
+  }) {
+    if (!scriptOption) return;
+    const retryFn = getRemoteEntry;
+    const beforeExecuteRetry = () => delete globalLoading[uniqueKey];
+    const getRemoteEntryRetry = scriptCommonRetry({
+      scriptOption,
+      moduleInfo: remoteInfo,
+      retryFn,
+      beforeExecuteRetry,
+    });
+    return getRemoteEntryRetry({
+      origin,
+      remoteInfo,
+      remoteEntryExports,
+    });
+  },
+  async getModuleFactory({ remoteEntryExports, expose, moduleInfo }) {
+    if (!scriptOption) return;
+    const retryFn = remoteEntryExports.get;
+    const getRemoteEntryRetry = scriptCommonRetry({
+      scriptOption,
+      moduleInfo,
+      retryFn,
+    });
+    return getRemoteEntryRetry(expose);
   },
 });
 

diff --git a/packages/retry-plugin/src/types.d.ts b/packages/retry-plugin/src/types.d.ts
@@ -1,3 +1,4 @@
+import { RemoteInfo } from '@module-federation/runtime/types';
 export interface FetchWithRetryOptions {
   url?: string;
   options?: RequestInit;
@@ -24,3 +25,10 @@ export type RequiredFetchWithRetryOptions = Required<
   Pick<FetchWithRetryOptions, 'url'>
 > &
   Omit<FetchWithRetryOptions, 'url'>;
+
+export type ScriptCommonRetryOption = {
+  scriptOption: ScriptWithRetryOptions;
+  moduleInfo: RemoteInfo & { alias?: string };
+  retryFn: (...args: any[]) => Promise<any> | (() => Promise<any>);
+  beforeExecuteRetry?: (...args: any[]) => void;
+};
diff --git a/packages/retry-plugin/src/util.ts b/packages/retry-plugin/src/util.ts
@@ -0,0 +1,47 @@
+import { defaultRetries, defaultRetryDelay } from './constant';
+import type { ScriptCommonRetryOption } from './types';
+import logger from './logger';
+
+export function scriptCommonRetry<T extends (...args: any[]) => void>({
+  scriptOption,
+  moduleInfo,
+  retryFn,
+  beforeExecuteRetry = () => {},
+}: ScriptCommonRetryOption) {
+  return async function (...args: Parameters<T>) {
+    let retryResponse;
+    const { retryTimes = defaultRetries, retryDelay = defaultRetryDelay } =
+      scriptOption || {};
+    if (
+      (scriptOption?.moduleName &&
+        scriptOption?.moduleName.some(
+          (m) => moduleInfo.name === m || moduleInfo?.alias === m,
+        )) ||
+      scriptOption?.moduleName === undefined
+    ) {
+      let attempts = 0;
+      while (attempts - 1 < retryTimes) {
+        try {
+          beforeExecuteRetry && beforeExecuteRetry();
+          retryResponse = await retryFn(...args);
+          break;
+        } catch (error) {
+          attempts++;
+          if (attempts - 1 >= retryTimes) {
+            scriptOption?.cb &&
+              (await new Promise(
+                (resolve) =>
+                  scriptOption?.cb && scriptOption?.cb(resolve, error),
+              ));
+            throw error;
+          }
+          logger.log(
+            `[ Module Federation RetryPlugin ]: script resource retrying ${attempts} times`,
+          );
+          await new Promise((resolve) => setTimeout(resolve, retryDelay));
+        }
+      }
+    }
+    return retryResponse;
+  };
+}
diff --git a/packages/runtime/src/core.ts b/packages/runtime/src/core.ts
@@ -18,7 +18,7 @@ import {
   InitTokens,
   CallFrom,
 } from './type';
-import { getBuilderId, registerPlugins } from './utils';
+import { getBuilderId, registerPlugins, getRemoteEntry } from './utils';
 import { Module } from './module';
 import {
   AsyncHook,
@@ -114,6 +114,22 @@ export class FederationHost {
       [string, RequestInit],
       Promise<Response> | void | false
     >(),
+    loadEntryError: new AsyncHook<
+      [
+        {
+          getRemoteEntry: typeof getRemoteEntry;
+          origin: FederationHost;
+          remoteInfo: RemoteInfo;
+          remoteEntryExports?: RemoteEntryExports | undefined;
+          globalLoading: Record<
+            string,
+            Promise<void | RemoteEntryExports> | undefined
+          >;
+          uniqueKey: string;
+        },
+      ],
+      Promise<(() => Promise<RemoteEntryExports | undefined>) | undefined>
+    >(),
     getModuleFactory: new AsyncHook<
       [
         {

diff --git a/packages/runtime/src/module/index.ts b/packages/runtime/src/module/index.ts
@@ -5,9 +5,10 @@ import {
   RUNTIME_002,
   runtimeDescMap,
 } from '@module-federation/error-codes';
-import { getRemoteEntry } from '../utils/load';
+import { getRemoteEntry, getRemoteEntryUniqueKey } from '../utils/load';
 import { FederationHost } from '../core';
 import { RemoteEntryExports, RemoteInfo, InitScope } from '../type';
+import { globalLoading } from '../global';
 
 export type ModuleOptions = ConstructorParameters<typeof Module>[0];
 
@@ -34,18 +35,32 @@ class Module {
       return this.remoteEntryExports;
     }
 
-    // Get remoteEntry.js
-    const remoteEntryExports = await getRemoteEntry({
-      origin: this.host,
-      remoteInfo: this.remoteInfo,
-      remoteEntryExports: this.remoteEntryExports,
-    });
+    let remoteEntryExports;
+    try {
+      remoteEntryExports = await getRemoteEntry({
+        origin: this.host,
+        remoteInfo: this.remoteInfo,
+        remoteEntryExports: this.remoteEntryExports,
+      });
+    } catch (err) {
+      const uniqueKey = getRemoteEntryUniqueKey(this.remoteInfo);
+      remoteEntryExports =
+        await this.host.loaderHook.lifecycle.loadEntryError.emit({
+          getRemoteEntry,
+          origin: this.host,
+          remoteInfo: this.remoteInfo,
+          remoteEntryExports: this.remoteEntryExports,
+          globalLoading,
+          uniqueKey,
+        });
+    }
+
     assert(
       remoteEntryExports,
       `remoteEntryExports is undefined \n ${safeToString(this.remoteInfo)}`,
     );
 
-    this.remoteEntryExports = remoteEntryExports;
+    this.remoteEntryExports = remoteEntryExports as RemoteEntryExports;
     return this.remoteEntryExports;
   }