@module-federation/retry-plugin 0.6.13 → 0.6.15

package/dist/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @module-federation/retry-plugin
 
+## 0.6.15
+
+### Patch Changes
+
+- ec31539: fix(retry-plugin): fix script retry logic to make error-boundary should render until script retry finished.
+- 283574b: feat(retry-plugin): allow fallback function to receive failed URL
+  - @module-federation/sdk@0.6.15
+
+## 0.6.14
+
+### Patch Changes
+
+- ad605d2: chore: unified logger
+- Updated dependencies [ad605d2]
+  - @module-federation/sdk@0.6.14
+
 ## 0.6.13
 
 ## 0.6.12

package/dist/esm/index.js

@@ -4,10 +4,12 @@ var __name = (target, value) => __defProp(target, "name", { value, configurable:
 // packages/retry-plugin/src/constant.ts
 var defaultRetries = 3;
 var defaultRetryDelay = 1e3;
-var loadStatus = {
-  success: "success",
-  error: "error"
-};
+var PLUGIN_IDENTIFIER = "[ Module Federation RetryPlugin ]";
+
+// packages/retry-plugin/src/logger.ts
+import { createLogger } from "@module-federation/sdk";
+var logger = createLogger(PLUGIN_IDENTIFIER);
+var logger_default = logger;
 
 // packages/retry-plugin/src/fetch-retry.ts
 async function fetchWithRetry({ url, options = {}, retryTimes = defaultRetries, retryDelay = defaultRetryDelay, fallback }) {
@@ -23,10 +25,10 @@ async function fetchWithRetry({ url, options = {}, retryTimes = defaultRetries,
     return response;
   } catch (error) {
     if (retryTimes <= 0) {
-      console.log(`>>>>>>>>> \u3010Module Federation RetryPlugin\u3011: retry failed after ${retryTimes} times for url: ${url}, now will try fallbackUrl url <<<<<<<<<`);
+      logger_default.log(`>>>>>>>>> retry failed after ${retryTimes} times for url: ${url}, now will try fallbackUrl url <<<<<<<<<`);
       if (fallback && typeof fallback === "function") {
         return fetchWithRetry({
-          url: fallback(),
+          url: fallback(url),
           options,
           retryTimes: 0,
           retryDelay: 0
@@ -35,10 +37,10 @@ async function fetchWithRetry({ url, options = {}, retryTimes = defaultRetries,
       if (error instanceof Error && error.message.includes("Json parse error")) {
         throw error;
       }
-      throw new Error("\u3010Module Federation RetryPlugin\u3011: The request failed three times and has now been abandoned");
+      throw new Error(`${PLUGIN_IDENTIFIER}: The request failed three times and has now been abandoned`);
     } else {
       retryDelay > 0 && await new Promise((resolve) => setTimeout(resolve, retryDelay));
-      console.log(`\u3010Module Federation RetryPlugin\u3011: Trying again. Number of retries available\uFF1A${retryTimes - 1}`);
+      logger_default.log(`Trying again. Number of retries available\uFF1A${retryTimes - 1}`);
       return await fetchWithRetry({
         url,
         options,
@@ -51,81 +53,6 @@ async function fetchWithRetry({ url, options = {}, retryTimes = defaultRetries,
 }
 __name(fetchWithRetry, "fetchWithRetry");
 
-// packages/retry-plugin/src/script-retry.ts
-var defaultCreateScript = /* @__PURE__ */ __name((url, attrs) => {
-  let script = document.createElement("script");
-  script.src = url;
-  Object.keys(attrs).forEach((key) => {
-    if (key === "async" || key === "defer") {
-      script[key] = attrs[key];
-    } else if (!script.getAttribute(key)) {
-      script.setAttribute(key, attrs[key]);
-    }
-  });
-  return script;
-}, "defaultCreateScript");
-var getScript = /* @__PURE__ */ __name((url, attrs, customCreateScript) => {
-  let script = null;
-  if (customCreateScript && typeof customCreateScript === "function") {
-    script = customCreateScript(url, attrs);
-  }
-  if (!script) {
-    script = defaultCreateScript(url, attrs);
-  }
-  return script;
-}, "getScript");
-async function loadScript(url, attrs, maxRetries = defaultRetries, retryDelay = defaultRetryDelay, customCreateScript) {
-  let retries = 0;
-  function attemptLoad() {
-    return new Promise((resolve, reject) => {
-      const script = getScript(url, attrs, customCreateScript);
-      script.onload = (event) => {
-        resolve({
-          status: loadStatus.success,
-          event
-        });
-      };
-      script.onerror = (event) => {
-        if (retries < maxRetries) {
-          retries++;
-          console.warn(`\u3010Module Federation RetryPlugin\u3011: Failed to load script. Retrying... (${retries}/${maxRetries})`);
-          retryDelay > 0 && setTimeout(() => {
-            resolve(attemptLoad());
-          }, retryDelay);
-        } else {
-          console.error("\u3010Module Federation RetryPlugin\u3011: Failed to load script after maximum retries. the url is:", url);
-          resolve({
-            status: loadStatus.error,
-            event
-          });
-        }
-      };
-      document.head.appendChild(script);
-    });
-  }
-  __name(attemptLoad, "attemptLoad");
-  return attemptLoad();
-}
-__name(loadScript, "loadScript");
-function scriptWithRetry({ url, attrs = {}, retryTimes = defaultRetries, retryDelay = defaultRetryDelay, customCreateScript }) {
-  const script = getScript(url, attrs, customCreateScript);
-  const originOnerror = script.onerror;
-  const originOnLoad = script.onload;
-  script.onerror = async (event) => {
-    console.warn(`\u3010Module Federation RetryPlugin\u3011: Script load failed, retrying (${retryTimes + 1}/${defaultRetries}): ${url}`);
-    const scriptLoader = await loadScript(url, attrs, retryTimes, retryDelay, customCreateScript);
-    if (scriptLoader.status === loadStatus.success) {
-      originOnLoad?.call(script, scriptLoader?.event);
-      return;
-    } else {
-      originOnerror?.call(script, scriptLoader?.event);
-    }
-    return;
-  };
-  return script;
-}
-__name(scriptWithRetry, "scriptWithRetry");
-
 // packages/retry-plugin/src/index.ts
 var RetryPlugin = /* @__PURE__ */ __name(({ fetch: fetchOption, script: scriptOption }) => ({
   name: "retry-plugin",
@@ -155,31 +82,26 @@ var RetryPlugin = /* @__PURE__ */ __name(({ fetch: fetchOption, script: scriptOp
     }
     return fetch(url, options);
   },
-  createScript({ url, attrs }) {
-    const scriptAttrs = scriptOption?.attrs ? {
-      ...attrs,
-      ...scriptOption.attrs
-    } : attrs;
-    if (scriptOption) {
-      if (scriptOption?.url) {
-        if (url === scriptOption?.url) {
-          return scriptWithRetry({
-            url: scriptOption?.url,
-            attrs: scriptAttrs,
-            retryTimes: scriptOption?.retryTimes,
-            customCreateScript: scriptOption?.customCreateScript ? scriptOption.customCreateScript : void 0
-          });
+  async getModuleFactory({ remoteEntryExports, expose, moduleInfo }) {
+    let moduleFactory;
+    const { retryTimes = defaultRetries, retryDelay = defaultRetryDelay } = scriptOption || {};
+    if (scriptOption?.moduleName && scriptOption?.moduleName.some((m) => moduleInfo.name === m || moduleInfo?.alias === m) || scriptOption?.moduleName === void 0) {
+      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));
         }
-      } else {
-        return scriptWithRetry({
-          url,
-          attrs: scriptAttrs,
-          retryTimes: scriptOption?.retryTimes,
-          customCreateScript: scriptOption?.customCreateScript ? scriptOption.customCreateScript : void 0
-        });
       }
     }
-    return {};
+    return moduleFactory;
   }
 }), "RetryPlugin");
 export {

package/dist/index.d.mts

@@ -1,31 +1,27 @@
 import { FederationRuntimePlugin } from '@module-federation/runtime/types';
 
 interface FetchWithRetryOptions {
-  url?: string;
+  url: string;
   options?: RequestInit;
   retryTimes?: number;
   retryDelay?: number;
-  fallback?: () => string;
+  fallback?:
+    | (() => string)
+    | ((url: string | URL | globalThis.Request) => string);
 }
 
 interface ScriptWithRetryOptions {
-  url?: string;
-  attrs?: Record<string, string>;
   retryTimes?: number;
   retryDelay?: number;
-  customCreateScript?: CreateScriptFunc;
+  moduleName?: Array<string>;
+  cb?: (resolve: (value: unknown) => void, error: any) => void;
 }
 
 type RetryPluginParams = {
-  fetch?: FetchWithRetryOptions; // fetch retry options
-  script?: ScriptWithRetryOptions; // script retry options
+  fetch?: FetchWithRetryOptions;
+  script?: ScriptWithRetryOptions;
 };
 
-type CreateScriptFunc = (
-  url: string,
-  attrs: Record<string, any>,
-) => HTMLScriptElement;
-
 declare const RetryPlugin: (params: RetryPluginParams) => FederationRuntimePlugin;
 
 export { FetchWithRetryOptions, RetryPlugin, RetryPluginParams, ScriptWithRetryOptions };

package/dist/index.d.ts

@@ -1,31 +1,27 @@
 import { FederationRuntimePlugin } from '@module-federation/runtime/types';
 
 interface FetchWithRetryOptions {
-  url?: string;
+  url: string;
   options?: RequestInit;
   retryTimes?: number;
   retryDelay?: number;
-  fallback?: () => string;
+  fallback?:
+    | (() => string)
+    | ((url: string | URL | globalThis.Request) => string);
 }
 
 interface ScriptWithRetryOptions {
-  url?: string;
-  attrs?: Record<string, string>;
   retryTimes?: number;
   retryDelay?: number;
-  customCreateScript?: CreateScriptFunc;
+  moduleName?: Array<string>;
+  cb?: (resolve: (value: unknown) => void, error: any) => void;
 }
 
 type RetryPluginParams = {
-  fetch?: FetchWithRetryOptions; // fetch retry options
-  script?: ScriptWithRetryOptions; // script retry options
+  fetch?: FetchWithRetryOptions;
+  script?: ScriptWithRetryOptions;
 };
 
-type CreateScriptFunc = (
-  url: string,
-  attrs: Record<string, any>,
-) => HTMLScriptElement;
-
 declare const RetryPlugin: (params: RetryPluginParams) => FederationRuntimePlugin;
 
 export { FetchWithRetryOptions, RetryPlugin, RetryPluginParams, ScriptWithRetryOptions };

package/dist/index.js

@@ -28,10 +28,12 @@ module.exports = __toCommonJS(src_exports);
 // packages/retry-plugin/src/constant.ts
 var defaultRetries = 3;
 var defaultRetryDelay = 1e3;
-var loadStatus = {
-  success: "success",
-  error: "error"
-};
+var PLUGIN_IDENTIFIER = "[ Module Federation RetryPlugin ]";
+
+// packages/retry-plugin/src/logger.ts
+var import_sdk = require("@module-federation/sdk");
+var logger = (0, import_sdk.createLogger)(PLUGIN_IDENTIFIER);
+var logger_default = logger;
 
 // packages/retry-plugin/src/fetch-retry.ts
 async function fetchWithRetry({ url, options = {}, retryTimes = defaultRetries, retryDelay = defaultRetryDelay, fallback }) {
@@ -47,10 +49,10 @@ async function fetchWithRetry({ url, options = {}, retryTimes = defaultRetries,
     return response;
   } catch (error) {
     if (retryTimes <= 0) {
-      console.log(`>>>>>>>>> \u3010Module Federation RetryPlugin\u3011: retry failed after ${retryTimes} times for url: ${url}, now will try fallbackUrl url <<<<<<<<<`);
+      logger_default.log(`>>>>>>>>> retry failed after ${retryTimes} times for url: ${url}, now will try fallbackUrl url <<<<<<<<<`);
       if (fallback && typeof fallback === "function") {
         return fetchWithRetry({
-          url: fallback(),
+          url: fallback(url),
           options,
           retryTimes: 0,
           retryDelay: 0
@@ -59,10 +61,10 @@ async function fetchWithRetry({ url, options = {}, retryTimes = defaultRetries,
       if (error instanceof Error && error.message.includes("Json parse error")) {
         throw error;
       }
-      throw new Error("\u3010Module Federation RetryPlugin\u3011: The request failed three times and has now been abandoned");
+      throw new Error(`${PLUGIN_IDENTIFIER}: The request failed three times and has now been abandoned`);
     } else {
       retryDelay > 0 && await new Promise((resolve) => setTimeout(resolve, retryDelay));
-      console.log(`\u3010Module Federation RetryPlugin\u3011: Trying again. Number of retries available\uFF1A${retryTimes - 1}`);
+      logger_default.log(`Trying again. Number of retries available\uFF1A${retryTimes - 1}`);
       return await fetchWithRetry({
         url,
         options,
@@ -75,81 +77,6 @@ async function fetchWithRetry({ url, options = {}, retryTimes = defaultRetries,
 }
 __name(fetchWithRetry, "fetchWithRetry");
 
-// packages/retry-plugin/src/script-retry.ts
-var defaultCreateScript = /* @__PURE__ */ __name((url, attrs) => {
-  let script = document.createElement("script");
-  script.src = url;
-  Object.keys(attrs).forEach((key) => {
-    if (key === "async" || key === "defer") {
-      script[key] = attrs[key];
-    } else if (!script.getAttribute(key)) {
-      script.setAttribute(key, attrs[key]);
-    }
-  });
-  return script;
-}, "defaultCreateScript");
-var getScript = /* @__PURE__ */ __name((url, attrs, customCreateScript) => {
-  let script = null;
-  if (customCreateScript && typeof customCreateScript === "function") {
-    script = customCreateScript(url, attrs);
-  }
-  if (!script) {
-    script = defaultCreateScript(url, attrs);
-  }
-  return script;
-}, "getScript");
-async function loadScript(url, attrs, maxRetries = defaultRetries, retryDelay = defaultRetryDelay, customCreateScript) {
-  let retries = 0;
-  function attemptLoad() {
-    return new Promise((resolve, reject) => {
-      const script = getScript(url, attrs, customCreateScript);
-      script.onload = (event) => {
-        resolve({
-          status: loadStatus.success,
-          event
-        });
-      };
-      script.onerror = (event) => {
-        if (retries < maxRetries) {
-          retries++;
-          console.warn(`\u3010Module Federation RetryPlugin\u3011: Failed to load script. Retrying... (${retries}/${maxRetries})`);
-          retryDelay > 0 && setTimeout(() => {
-            resolve(attemptLoad());
-          }, retryDelay);
-        } else {
-          console.error("\u3010Module Federation RetryPlugin\u3011: Failed to load script after maximum retries. the url is:", url);
-          resolve({
-            status: loadStatus.error,
-            event
-          });
-        }
-      };
-      document.head.appendChild(script);
-    });
-  }
-  __name(attemptLoad, "attemptLoad");
-  return attemptLoad();
-}
-__name(loadScript, "loadScript");
-function scriptWithRetry({ url, attrs = {}, retryTimes = defaultRetries, retryDelay = defaultRetryDelay, customCreateScript }) {
-  const script = getScript(url, attrs, customCreateScript);
-  const originOnerror = script.onerror;
-  const originOnLoad = script.onload;
-  script.onerror = async (event) => {
-    console.warn(`\u3010Module Federation RetryPlugin\u3011: Script load failed, retrying (${retryTimes + 1}/${defaultRetries}): ${url}`);
-    const scriptLoader = await loadScript(url, attrs, retryTimes, retryDelay, customCreateScript);
-    if (scriptLoader.status === loadStatus.success) {
-      originOnLoad?.call(script, scriptLoader?.event);
-      return;
-    } else {
-      originOnerror?.call(script, scriptLoader?.event);
-    }
-    return;
-  };
-  return script;
-}
-__name(scriptWithRetry, "scriptWithRetry");
-
 // packages/retry-plugin/src/index.ts
 var RetryPlugin = /* @__PURE__ */ __name(({ fetch: fetchOption, script: scriptOption }) => ({
   name: "retry-plugin",
@@ -179,31 +106,26 @@ var RetryPlugin = /* @__PURE__ */ __name(({ fetch: fetchOption, script: scriptOp
     }
     return fetch(url, options);
   },
-  createScript({ url, attrs }) {
-    const scriptAttrs = scriptOption?.attrs ? {
-      ...attrs,
-      ...scriptOption.attrs
-    } : attrs;
-    if (scriptOption) {
-      if (scriptOption?.url) {
-        if (url === scriptOption?.url) {
-          return scriptWithRetry({
-            url: scriptOption?.url,
-            attrs: scriptAttrs,
-            retryTimes: scriptOption?.retryTimes,
-            customCreateScript: scriptOption?.customCreateScript ? scriptOption.customCreateScript : void 0
-          });
+  async getModuleFactory({ remoteEntryExports, expose, moduleInfo }) {
+    let moduleFactory;
+    const { retryTimes = defaultRetries, retryDelay = defaultRetryDelay } = scriptOption || {};
+    if (scriptOption?.moduleName && scriptOption?.moduleName.some((m) => moduleInfo.name === m || moduleInfo?.alias === m) || scriptOption?.moduleName === void 0) {
+      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));
         }
-      } else {
-        return scriptWithRetry({
-          url,
-          attrs: scriptAttrs,
-          retryTimes: scriptOption?.retryTimes,
-          customCreateScript: scriptOption?.customCreateScript ? scriptOption.customCreateScript : void 0
-        });
       }
     }
-    return {};
+    return moduleFactory;
   }
 }), "RetryPlugin");
 // Annotate the CommonJS export names for ESM import in node:

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@module-federation/retry-plugin",
-  "version": "0.6.13",
+  "version": "0.6.15",
   "author": "danpeen <dapeen.feng@gmail.com>",
   "main": "./dist/index.js",
   "module": "./dist/esm/index.js",
@@ -29,5 +29,8 @@
   },
   "devDependencies": {
     "@module-federation/runtime": "workspace:*"
+  },
+  "dependencies": {
+    "@module-federation/sdk": "workspace:*"
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@module-federation/retry-plugin",
-  "version": "0.6.13",
+  "version": "0.6.15",
   "author": "danpeen <dapeen.feng@gmail.com>",
   "main": "./dist/index.js",
   "module": "./dist/esm/index.js",
@@ -28,6 +28,9 @@
     }
   },
   "devDependencies": {
-    "@module-federation/runtime": "0.6.13"
+    "@module-federation/runtime": "0.6.15"
+  },
+  "dependencies": {
+    "@module-federation/sdk": "0.6.15"
   }
 }