@module-federation/retry-plugin 0.18.4 → 0.19.0

package/dist/index.d.ts

@@ -1,28 +1,110 @@
 import { ModuleFederationRuntimePlugin } from '@module-federation/runtime/types';
 
-interface FetchWithRetryOptions {
-  manifestUrl?: string;
-  options?: RequestInit;
+type CommonRetryOptions = {
+  /**
+   * retry request options
+   */
+  fetchOptions?: RequestInit;
+  /**
+   * retry times
+   */
   retryTimes?: number;
+  /**
+   * retry success times
+   */
+  successTimes?: number;
+  /**
+   * retry delay
+   */
   retryDelay?: number;
-  fallback?:
-    | (() => string)
-    | ((url: string | URL | globalThis.Request) => string);
+  /**
+   * retry path
+   */
   getRetryPath?: (url: string) => string;
-}
-interface ScriptWithRetryOptions {
-  retryTimes?: number;
-  retryDelay?: number;
-  moduleName?: Array<string>;
-  cb?: (resolve: (value: unknown) => void, error: any) => void;
-  getRetryPath?: (url: string) => string;
-}
+  /**
+   * add query parameter
+   */
+  addQuery?:
+    | boolean
+    | ((context: { times: number; originalQuery: string }) => string);
+  /**
+   * retry domains
+   */
+  domains?: string[];
+  /**
+   * retry manifest domains
+   */
+  manifestDomains?: string[];
+  /**
+   * retry callback
+   */
+  onRetry?: ({
+    times,
+    domains,
+    url,
+  }: {
+    times?: number;
+    domains?: string[];
+    url?: string;
+    tagName?: string;
+  }) => void;
+  /**
+   * retry success callback
+   */
+  onSuccess?: ({
+    domains,
+    url,
+    tagName,
+  }: {
+    domains?: string[];
+    url?: string;
+    tagName?: string;
+  }) => void;
+  /**
+   * retry failure callback
+   */
+  onError?: ({
+    domains,
+    url,
+    tagName,
+  }: {
+    domains?: string[];
+    url?: string;
+    tagName?: string;
+  }) => void;
+};
+
+type FetchRetryOptions = {
+  url?: string;
+  fetchOptions?: RequestInit;
+} & CommonRetryOptions;
 
-type RetryPluginParams = {
-  fetch?: FetchWithRetryOptions;
-  script?: ScriptWithRetryOptions;
+type ScriptRetryOptions = {
+  retryOptions: CommonRetryOptions;
+  retryFn: (...args: any[]) => Promise<any> | (() => Promise<any>);
+  beforeExecuteRetry?: (...args: any[]) => void;
 };
 
-declare const RetryPlugin: (params: RetryPluginParams) => ModuleFederationRuntimePlugin;
+declare function rewriteWithNextDomain(currentUrl: string, domains?: string[]): string | null;
+declare function appendRetryCountQuery(url: string, retryIndex: number, key?: string): string;
+declare function getRetryUrl(baseUrl: string, opts?: {
+    domains?: string[];
+    addQuery?: boolean | ((context: {
+        times: number;
+        originalQuery: string;
+    }) => string);
+    retryIndex?: number;
+    queryKey?: string;
+}): string;
+/**
+ * Extract domain/host info from a URL and combine it with path/query from another URL
+ * This is useful for domain rotation while preserving original path and query parameters
+ * @param domainUrl - URL containing the target domain/host
+ * @param pathQueryUrl - URL containing the target path and query parameters
+ * @returns Combined URL with domain from domainUrl and path/query from pathQueryUrl
+ */
+declare function combineUrlDomainWithPathQuery(domainUrl: string, pathQueryUrl: string): string;
+
+declare const RetryPlugin: (params?: CommonRetryOptions) => ModuleFederationRuntimePlugin;
 
-export { type FetchWithRetryOptions, RetryPlugin, type RetryPluginParams, type ScriptWithRetryOptions };
+export { type CommonRetryOptions, type FetchRetryOptions, RetryPlugin, type ScriptRetryOptions, appendRetryCountQuery, combineUrlDomainWithPathQuery, getRetryUrl, rewriteWithNextDomain };

package/dist/index.js

@@ -21,7 +21,11 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // packages/retry-plugin/src/index.ts
 var src_exports = {};
 __export(src_exports, {
-  RetryPlugin: () => RetryPlugin
+  RetryPlugin: () => RetryPlugin,
+  appendRetryCountQuery: () => appendRetryCountQuery,
+  combineUrlDomainWithPathQuery: () => combineUrlDomainWithPathQuery,
+  getRetryUrl: () => getRetryUrl,
+  rewriteWithNextDomain: () => rewriteWithNextDomain
 });
 module.exports = __toCommonJS(src_exports);
 
@@ -29,88 +33,280 @@ module.exports = __toCommonJS(src_exports);
 var defaultRetries = 3;
 var defaultRetryDelay = 1e3;
 var PLUGIN_IDENTIFIER = "[ Module Federation RetryPlugin ]";
+var ERROR_ABANDONED = "The request failed and has now been abandoned";
 
 // 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/utils.ts
+function rewriteWithNextDomain(currentUrl, domains) {
+  if (!domains || domains.length === 0)
+    return null;
+  try {
+    const u = new URL(currentUrl);
+    const currentHostname = u.hostname;
+    const currentPort = u.port;
+    const currentHost = `${currentHostname}${currentPort ? `:${currentPort}` : ""}`;
+    const normalized = domains.map((d) => {
+      try {
+        const du = new URL(d.startsWith("http") ? d : `https://${d}`);
+        return {
+          hostname: du.hostname,
+          port: du.port,
+          protocol: du.protocol
+        };
+      } catch {
+        return {
+          hostname: d,
+          port: "",
+          protocol: u.protocol
+        };
+      }
+    }).filter((d) => !!d.hostname);
+    if (normalized.length === 0)
+      return null;
+    let idx = -1;
+    for (let i = normalized.length - 1; i >= 0; i--) {
+      const candHost = `${normalized[i].hostname}${normalized[i].port ? `:${normalized[i].port}` : ""}`;
+      if (candHost === currentHost) {
+        idx = i;
+        break;
+      }
+    }
+    const total = normalized.length;
+    for (let step = 1; step <= total; step++) {
+      const nextIdx = ((idx >= 0 ? idx : -1) + step) % total;
+      const candidate = normalized[nextIdx];
+      const candidateHost = `${candidate.hostname}${candidate.port ? `:${candidate.port}` : ""}`;
+      if (candidateHost !== currentHost) {
+        u.hostname = candidate.hostname;
+        if (candidate.port !== void 0 && candidate.port !== null && candidate.port !== "") {
+          u.port = candidate.port;
+        } else {
+          u.port = "";
+        }
+        u.protocol = candidate.protocol || u.protocol;
+        return u.toString();
+      }
+    }
+    return null;
+  } catch {
+    return null;
+  }
+}
+__name(rewriteWithNextDomain, "rewriteWithNextDomain");
+function appendRetryCountQuery(url, retryIndex, key = "retryCount") {
+  try {
+    const u = new URL(url);
+    u.searchParams.delete(key);
+    u.searchParams.set(key, String(retryIndex));
+    return u.toString();
+  } catch {
+    return url;
+  }
+}
+__name(appendRetryCountQuery, "appendRetryCountQuery");
+function getRetryUrl(baseUrl, opts = {}) {
+  const { domains, addQuery, retryIndex = 0, queryKey = "retryCount" } = opts;
+  let cleanBaseUrl = baseUrl;
+  try {
+    const urlObj = new URL(baseUrl);
+    urlObj.searchParams.delete(queryKey);
+    cleanBaseUrl = urlObj.toString();
+  } catch {
+  }
+  let nextUrl = rewriteWithNextDomain(cleanBaseUrl, domains) ?? cleanBaseUrl;
+  if (retryIndex > 0 && addQuery) {
+    try {
+      const u = new URL(nextUrl);
+      const originalUrl = new URL(baseUrl);
+      originalUrl.searchParams.delete(queryKey);
+      const originalQuery = originalUrl.search.startsWith("?") ? originalUrl.search.slice(1) : originalUrl.search;
+      if (typeof addQuery === "function") {
+        const newQuery = addQuery({
+          times: retryIndex,
+          originalQuery
+        });
+        u.search = newQuery ? `?${newQuery.replace(/^\?/, "")}` : "";
+        nextUrl = u.toString();
+      } else if (addQuery === true) {
+        u.searchParams.delete(queryKey);
+        u.searchParams.set(queryKey, String(retryIndex));
+        nextUrl = u.toString();
+      }
+    } catch {
+      if (addQuery === true) {
+        nextUrl = appendRetryCountQuery(nextUrl, retryIndex, queryKey);
+      }
+    }
+  }
+  return nextUrl;
+}
+__name(getRetryUrl, "getRetryUrl");
+function combineUrlDomainWithPathQuery(domainUrl, pathQueryUrl) {
+  try {
+    const domainUrlObj = new URL(domainUrl);
+    const pathQueryUrlObj = new URL(pathQueryUrl);
+    domainUrlObj.pathname = pathQueryUrlObj.pathname;
+    domainUrlObj.search = pathQueryUrlObj.search;
+    return domainUrlObj.toString();
+  } catch {
+    return pathQueryUrl;
+  }
+}
+__name(combineUrlDomainWithPathQuery, "combineUrlDomainWithPathQuery");
+
 // packages/retry-plugin/src/fetch-retry.ts
-async function fetchWithRetry(params, userOriginalRetryTimes) {
-  const { manifestUrl, options = {}, retryTimes = defaultRetries, retryDelay = defaultRetryDelay, fallback, getRetryPath } = params;
-  const url = manifestUrl || params.url;
+async function fetchRetry(params, lastRequestUrl, originalTotal) {
+  const {
+    url,
+    fetchOptions = {},
+    retryTimes = defaultRetries,
+    retryDelay = defaultRetryDelay,
+    // List of retry domains when resource loading fails. In the domains array, the first item is the default domain for static resources, and the subsequent items are backup domains. When a request to a domain fails, the system will find that domain in the array and replace it with the next domain in the array.
+    domains,
+    // Whether to add query parameters during resource retry to avoid being affected by browser and CDN cache. When set to true, retry=${times} will be added to the query, requesting in the order of retry=1, retry=2, retry=3.
+    addQuery,
+    onRetry,
+    onSuccess,
+    onError
+  } = params;
   if (!url) {
-    throw new Error("[retry-plugin] manifestUrl or url is required");
+    throw new Error(`${PLUGIN_IDENTIFIER}: url is required in fetchWithRetry`);
+  }
+  const total = originalTotal ?? params.retryTimes ?? defaultRetries;
+  const isFirstAttempt = !lastRequestUrl;
+  let baseUrl = url;
+  if (!isFirstAttempt && lastRequestUrl) {
+    baseUrl = combineUrlDomainWithPathQuery(lastRequestUrl, url);
+  }
+  let requestUrl = baseUrl;
+  if (!isFirstAttempt) {
+    requestUrl = getRetryUrl(baseUrl, {
+      domains,
+      addQuery,
+      retryIndex: total - retryTimes,
+      queryKey: "retryCount"
+    });
   }
-  const originalRetryTimes = userOriginalRetryTimes ?? params.retryTimes ?? defaultRetries;
-  const isRetry = retryTimes !== originalRetryTimes;
-  const retryUrl = isRetry && getRetryPath ? getRetryPath(url) : null;
-  const requestUrl = retryUrl || url;
   try {
-    const response = await fetch(requestUrl, options);
+    if (!isFirstAttempt && retryDelay > 0) {
+      await new Promise((resolve) => setTimeout(resolve, retryDelay));
+    }
+    const response = await fetch(requestUrl, fetchOptions);
     const responseClone = response.clone();
     if (!response.ok) {
-      throw new Error(`Server error\uFF1A${response.status}`);
+      throw new Error(`${PLUGIN_IDENTIFIER}: Request failed: ${response.status} ${response.statusText || ""} | url: ${requestUrl}`);
     }
     await responseClone.json().catch((error) => {
-      throw new Error(`Json parse error: ${error}, url is: ${requestUrl}`);
+      throw new Error(`${PLUGIN_IDENTIFIER}: JSON parse failed: ${error?.message || String(error)} | url: ${requestUrl}`);
     });
+    if (!isFirstAttempt) {
+      onSuccess && requestUrl && onSuccess({
+        domains,
+        url: requestUrl,
+        tagName: "fetch"
+      });
+    }
     return response;
   } catch (error) {
     if (retryTimes <= 0) {
-      logger_default.log(`${PLUGIN_IDENTIFIER}: retry failed after ${defaultRetries} times for url: ${requestUrl}, now will try fallbackUrl url`);
-      if (requestUrl && fallback && typeof fallback === "function") {
-        return fetchWithRetry({
-          manifestUrl: fallback(requestUrl),
-          options,
-          retryTimes: 0,
-          retryDelay: 0
+      const attemptedRetries = total - retryTimes;
+      if (!isFirstAttempt && attemptedRetries > 0) {
+        onError && onError({
+          domains,
+          url: requestUrl,
+          tagName: "fetch"
         });
+        logger_default.log(`${PLUGIN_IDENTIFIER}: retry failed, no retries left for url: ${requestUrl}`);
       }
-      if (error instanceof Error && error.message.includes("Json parse error")) {
-        throw error;
-      }
-      throw new Error(`${PLUGIN_IDENTIFIER}: The request failed three times and has now been abandoned`);
+      throw new Error(`${PLUGIN_IDENTIFIER}: ${ERROR_ABANDONED}`);
     } else {
-      retryDelay > 0 && await new Promise((resolve) => setTimeout(resolve, retryDelay));
-      logger_default.log(`Trying again. Number of retries available\uFF1A${retryTimes - 1}`);
-      return await fetchWithRetry({
+      const nextIndex = total - retryTimes + 1;
+      const predictedBaseUrl = combineUrlDomainWithPathQuery(requestUrl, url);
+      const predictedNextUrl = getRetryUrl(predictedBaseUrl, {
+        domains,
+        addQuery,
+        retryIndex: nextIndex,
+        queryKey: "retryCount"
+      });
+      onRetry && onRetry({
+        times: nextIndex,
+        domains,
+        url: predictedNextUrl,
+        tagName: "fetch"
+      });
+      logger_default.log(`${PLUGIN_IDENTIFIER}: Trying again. Number of retries left: ${retryTimes - 1}`);
+      return await fetchRetry({
         ...params,
         retryTimes: retryTimes - 1
-      }, originalRetryTimes);
+      }, requestUrl, total);
     }
   }
 }
-__name(fetchWithRetry, "fetchWithRetry");
+__name(fetchRetry, "fetchRetry");
 
 // packages/retry-plugin/src/script-retry.ts
-function scriptRetry({ scriptOption, moduleInfo, retryFn, beforeExecuteRetry = /* @__PURE__ */ __name(() => {
+function scriptRetry({ retryOptions, retryFn, beforeExecuteRetry = /* @__PURE__ */ __name(() => {
 }, "beforeExecuteRetry") }) {
   return async function(params) {
     let retryWrapper;
-    const { retryTimes = defaultRetries, retryDelay = defaultRetryDelay } = scriptOption || {};
-    const shouldRetryThisModule = shouldRetryModule(scriptOption, moduleInfo);
-    if (shouldRetryThisModule) {
-      let attempts = 0;
-      while (attempts < retryTimes) {
-        try {
-          beforeExecuteRetry();
+    let lastError;
+    let lastRequestUrl;
+    let originalUrl;
+    const { retryTimes = defaultRetries, retryDelay = defaultRetryDelay, domains, addQuery, onRetry, onSuccess, onError } = retryOptions || {};
+    let attempts = 0;
+    while (attempts < retryTimes) {
+      try {
+        beforeExecuteRetry();
+        if (retryDelay > 0) {
           await new Promise((resolve) => setTimeout(resolve, retryDelay));
-          retryWrapper = await retryFn({
-            ...params,
-            // add getRetryPath to load entry url passed by user
-            getEntryUrl: scriptOption?.getRetryPath
-          });
-          break;
-        } catch (error) {
-          attempts++;
-          if (attempts < retryTimes) {
-            logger_default.log(`${PLUGIN_IDENTIFIER}: script resource retrying ${attempts} times`);
-            await new Promise((resolve) => setTimeout(resolve, retryDelay));
-          } else {
-            scriptOption?.cb && await new Promise((resolve) => scriptOption?.cb && scriptOption?.cb(resolve, error));
-            throw error;
+        }
+        const retryIndex = attempts + 1;
+        retryWrapper = await retryFn({
+          ...params,
+          getEntryUrl: (url) => {
+            if (!originalUrl) {
+              originalUrl = url;
+            }
+            let baseUrl = originalUrl;
+            if (lastRequestUrl) {
+              baseUrl = combineUrlDomainWithPathQuery(lastRequestUrl, originalUrl);
+            }
+            const next = getRetryUrl(baseUrl, {
+              domains,
+              addQuery,
+              retryIndex,
+              queryKey: "retryCount"
+            });
+            onRetry && onRetry({
+              times: retryIndex,
+              domains,
+              url: next,
+              tagName: "script"
+            });
+            lastRequestUrl = next;
+            return next;
           }
+        });
+        onSuccess && lastRequestUrl && onSuccess({
+          domains,
+          url: lastRequestUrl,
+          tagName: "script"
+        });
+        break;
+      } catch (error) {
+        lastError = error;
+        attempts++;
+        if (attempts >= retryTimes) {
+          onError && lastRequestUrl && onError({
+            domains,
+            url: lastRequestUrl,
+            tagName: "script"
+          });
+          throw new Error(`${PLUGIN_IDENTIFIER}: ${ERROR_ABANDONED}`);
         }
       }
     }
@@ -118,67 +314,63 @@ function scriptRetry({ scriptOption, moduleInfo, retryFn, beforeExecuteRetry = /
   };
 }
 __name(scriptRetry, "scriptRetry");
-function shouldRetryModule(scriptOption, moduleInfo) {
-  if (!scriptOption?.moduleName) {
-    return true;
-  }
-  const moduleNames = scriptOption.moduleName;
-  const currentModuleName = moduleInfo.name;
-  const currentModuleAlias = moduleInfo?.alias;
-  return moduleNames.some((targetName) => targetName === currentModuleName || targetName === currentModuleAlias);
-}
-__name(shouldRetryModule, "shouldRetryModule");
 
 // packages/retry-plugin/src/index.ts
-var loadEntryErrorCache = /* @__PURE__ */ new Set();
-var RetryPlugin = /* @__PURE__ */ __name(({ fetch: fetchOption, script: scriptOption }) => ({
-  name: "retry-plugin",
-  async fetch(manifestUrl, options) {
-    const { retryTimes, fallback, getRetryPath } = fetchOption || {};
-    if (fetchOption) {
-      return fetchWithRetry({
-        manifestUrl,
-        options: {
+var RetryPlugin = /* @__PURE__ */ __name((params) => {
+  if (params?.fetch || params?.script) {
+    logger_default.warn(`${PLUGIN_IDENTIFIER}: fetch or script config is deprecated, please use the new config style. See docs: https://module-federation.io/plugin/plugins/retry-plugin.html`);
+  }
+  const { fetchOptions = {}, retryTimes = defaultRetries, successTimes = 0, retryDelay = defaultRetryDelay, domains = [], manifestDomains = [], addQuery, onRetry, onSuccess, onError } = params || {};
+  return {
+    name: "retry-plugin",
+    async fetch(manifestUrl, options) {
+      return fetchRetry({
+        url: manifestUrl,
+        fetchOptions: {
           ...options,
-          ...fetchOption?.options
+          ...fetchOptions
         },
+        domains: manifestDomains || domains,
+        addQuery,
+        onRetry,
+        onSuccess,
+        onError,
         retryTimes,
-        fallback,
-        getRetryPath
+        successTimes,
+        retryDelay
+      });
+    },
+    async loadEntryError({ getRemoteEntry, origin, remoteInfo, remoteEntryExports, globalLoading, uniqueKey }) {
+      const beforeExecuteRetry = /* @__PURE__ */ __name(() => {
+        delete globalLoading[uniqueKey];
+      }, "beforeExecuteRetry");
+      const getRemoteEntryRetry = scriptRetry({
+        retryOptions: {
+          retryTimes,
+          retryDelay,
+          domains,
+          addQuery,
+          onRetry,
+          onSuccess,
+          onError
+        },
+        retryFn: getRemoteEntry,
+        beforeExecuteRetry
       });
-    }
-    return fetch(manifestUrl, options);
-  },
-  async loadEntryError({ getRemoteEntry, origin, remoteInfo, remoteEntryExports, globalLoading, uniqueKey }) {
-    if (!scriptOption || loadEntryErrorCache.has(uniqueKey)) {
-      logger_default.log(`${PLUGIN_IDENTIFIER}: loadEntryError already processed for uniqueKey: ${uniqueKey}, skipping retry`);
-      return;
-    }
-    loadEntryErrorCache.add(uniqueKey);
-    const beforeExecuteRetry = /* @__PURE__ */ __name(() => {
-      delete globalLoading[uniqueKey];
-    }, "beforeExecuteRetry");
-    const getRemoteEntryRetry = scriptRetry({
-      scriptOption,
-      moduleInfo: remoteInfo,
-      retryFn: getRemoteEntry,
-      beforeExecuteRetry
-    });
-    try {
       const result = await getRemoteEntryRetry({
         origin,
         remoteInfo,
         remoteEntryExports
       });
-      loadEntryErrorCache.delete(uniqueKey);
       return result;
-    } catch (error) {
-      loadEntryErrorCache.delete(uniqueKey);
-      throw error;
     }
-  }
-}), "RetryPlugin");
+  };
+}, "RetryPlugin");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  RetryPlugin
+  RetryPlugin,
+  appendRetryCountQuery,
+  combineUrlDomainWithPathQuery,
+  getRetryUrl,
+  rewriteWithNextDomain
 });

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@module-federation/retry-plugin",
-  "version": "0.18.4",
+  "version": "0.19.0",
   "author": "danpeen <dapeen.feng@gmail.com>",
   "main": "./dist/index.js",
   "module": "./dist/esm/index.js",
@@ -8,7 +8,7 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/module-federation/core/",
+    "url": "git+https://github.com/module-federation/core.git",
     "directory": "packages/retry-plugin"
   },
   "publishConfig": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@module-federation/retry-plugin",
-  "version": "0.18.4",
+  "version": "0.19.0",
   "author": "danpeen <dapeen.feng@gmail.com>",
   "main": "./dist/index.js",
   "module": "./dist/esm/index.js",
@@ -8,7 +8,7 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/module-federation/core/",
+    "url": "git+https://github.com/module-federation/core.git",
     "directory": "packages/retry-plugin"
   },
   "publishConfig": {
@@ -33,9 +33,9 @@
     }
   },
   "devDependencies": {
-    "@module-federation/runtime": "0.18.4"
+    "@module-federation/runtime": "0.19.0"
   },
   "dependencies": {
-    "@module-federation/sdk": "0.18.4"
+    "@module-federation/sdk": "0.19.0"
   }
 }