@module-federation/modern-js 0.14.3 → 0.15.0

package/dist/esm-node/cli/server/data-fetch-server-plugin.js

@@ -0,0 +1,159 @@
+import { DATA_FETCH_QUERY, MF_DATA_FETCH_STATUS } from "../../constant";
+import logger from "../../logger";
+import { getDataFetchMap } from "../../utils";
+import { fetchData, initDataFetchMap, loadDataFetchModule } from "../../utils/dataFetch";
+import { SEPARATOR, MANIFEST_EXT } from "@module-federation/sdk";
+function wrapSetTimeout(targetPromise, delay = 2e4, id) {
+  if (targetPromise && typeof targetPromise.then === "function") {
+    return new Promise((resolve, reject) => {
+      const timeoutId = setTimeout(() => {
+        logger.warn(`Data fetch for ID ${id} timed out after 20 seconds.`);
+        reject(new Error(`Data fetch for ID ${id} timed out after 20 seconds`));
+      }, delay);
+      targetPromise.then((value) => {
+        clearTimeout(timeoutId);
+        resolve(value);
+      }).catch((err) => {
+        clearTimeout(timeoutId);
+        reject(err);
+      });
+    });
+  }
+}
+function addProtocol(url) {
+  if (url.startsWith("//")) {
+    return "https:" + url;
+  }
+  return url;
+}
+const getDecodeQuery = (url, name) => {
+  const res = url.searchParams.get(name);
+  if (!res) {
+    return null;
+  }
+  return decodeURIComponent(res);
+};
+const middleware = async (ctx, next) => {
+  var _globalThis___FEDERATION__;
+  let url;
+  let dataFetchId;
+  let params;
+  let remoteInfo;
+  try {
+    url = new URL(ctx.req.url);
+    dataFetchId = getDecodeQuery(url, DATA_FETCH_QUERY);
+    params = JSON.parse(getDecodeQuery(url, "params") || "{}");
+    const remoteInfoQuery = getDecodeQuery(url, "remoteInfo");
+    remoteInfo = remoteInfoQuery ? JSON.parse(remoteInfoQuery) : null;
+  } catch (e) {
+    logger.error("fetch data from server, error: ", e);
+    return next();
+  }
+  if (!dataFetchId) {
+    return next();
+  }
+  logger.log("fetch data from server, dataFetchId: ", dataFetchId);
+  logger.debug("fetch data from server, moduleInfo: ", (_globalThis___FEDERATION__ = globalThis.__FEDERATION__) === null || _globalThis___FEDERATION__ === void 0 ? void 0 : _globalThis___FEDERATION__.moduleInfo);
+  try {
+    var _dataFetchMap_dataFetchId, _dataFetchMap_dataFetchId1;
+    const dataFetchMap = getDataFetchMap();
+    if (!dataFetchMap) {
+      initDataFetchMap();
+    }
+    const fetchDataPromise = (_dataFetchMap_dataFetchId = dataFetchMap[dataFetchId]) === null || _dataFetchMap_dataFetchId === void 0 ? void 0 : _dataFetchMap_dataFetchId[1];
+    logger.debug("fetch data from server, fetchDataPromise: ", fetchDataPromise);
+    if (fetchDataPromise && ((_dataFetchMap_dataFetchId1 = dataFetchMap[dataFetchId]) === null || _dataFetchMap_dataFetchId1 === void 0 ? void 0 : _dataFetchMap_dataFetchId1[2]) !== MF_DATA_FETCH_STATUS.ERROR) {
+      const targetPromise = fetchDataPromise[0];
+      const wrappedPromise = wrapSetTimeout(targetPromise, 2e4, dataFetchId);
+      if (wrappedPromise) {
+        const res = await wrappedPromise;
+        logger.log("fetch data from server, fetchDataPromise res: ", res);
+        return ctx.json(res);
+      }
+      logger.error(`Expected a Promise from fetchDataPromise[0] for dataFetchId ${dataFetchId}, but received:`, targetPromise, "Will try call new dataFetch again...");
+    }
+    if (remoteInfo) {
+      try {
+        const hostInstance2 = globalThis.__FEDERATION__.__INSTANCES__[0];
+        const remoteEntry = `${addProtocol(remoteInfo.ssrPublicPath) + remoteInfo.ssrRemoteEntry}`;
+        if (!hostInstance2) {
+          throw new Error("host instance not found!");
+        }
+        const remote = hostInstance2.options.remotes.find((remote2) => remote2.name === remoteInfo.name);
+        logger.debug("find remote: ", JSON.stringify(remote));
+        if (!remote) {
+          hostInstance2.registerRemotes([
+            {
+              name: remoteInfo.name,
+              entry: remoteEntry,
+              entryGlobalName: remoteInfo.globalName
+            }
+          ]);
+        } else if (!("entry" in remote) || !remote.entry.includes(MANIFEST_EXT)) {
+          const { hostGlobalSnapshot, remoteSnapshot } = hostInstance2.snapshotHandler.getGlobalRemoteInfo(remoteInfo);
+          logger.debug("find hostGlobalSnapshot: ", JSON.stringify(hostGlobalSnapshot));
+          logger.debug("find remoteSnapshot: ", JSON.stringify(remoteSnapshot));
+          if (!hostGlobalSnapshot || !remoteSnapshot) {
+            if ("version" in remote) {
+              delete remote.version;
+            }
+            remote.entry = remoteEntry;
+            remote.entryGlobalName = remoteInfo.globalName;
+          }
+        }
+      } catch (e) {
+        ctx.status(500);
+        return ctx.text(`failed to fetch ${remoteInfo.name} data, error:
+ ${e}`);
+      }
+    }
+    const dataFetchItem = dataFetchMap[dataFetchId];
+    logger.debug("fetch data from server, dataFetchItem: ", dataFetchItem);
+    if (dataFetchItem) {
+      const callFetchDataPromise = fetchData(dataFetchId, {
+        ...params,
+        isDowngrade: !remoteInfo
+      });
+      const wrappedPromise = wrapSetTimeout(callFetchDataPromise, 2e4, dataFetchId);
+      if (wrappedPromise) {
+        const res = await wrappedPromise;
+        logger.log("fetch data from server, dataFetchItem res: ", res);
+        return ctx.json(res);
+      }
+    }
+    const remoteId = dataFetchId.split(SEPARATOR)[0];
+    const hostInstance = globalThis.__FEDERATION__.__INSTANCES__[0];
+    if (!hostInstance) {
+      throw new Error("host instance not found!");
+    }
+    const dataFetchFn = await loadDataFetchModule(hostInstance, remoteId);
+    const data = await dataFetchFn({
+      ...params,
+      isDowngrade: !remoteInfo
+    });
+    logger.log("fetch data from server, loadDataFetchModule res: ", data);
+    return ctx.json(data);
+  } catch (e) {
+    logger.error("server plugin data fetch error: ", e);
+    ctx.status(500);
+    return ctx.text(`failed to fetch ${remoteInfo.name} data, error:
+ ${e}`);
+  }
+};
+const dataFetchServePlugin = () => ({
+  name: "mf-data-fetch-server-plugin",
+  setup: (api) => {
+    api.onPrepare(() => {
+      const { middlewares } = api.getServerContext();
+      middlewares.push({
+        name: "module-federation-serve-manifest",
+        // @ts-ignore type error
+        handler: middleware
+      });
+    });
+  }
+});
+var data_fetch_server_plugin_default = dataFetchServePlugin;
+export {
+  data_fetch_server_plugin_default as default
+};

package/dist/esm-node/cli/ssrPlugin.js

@@ -3,9 +3,9 @@ import fs from "fs-extra";
 import { ModuleFederationPlugin } from "@module-federation/enhanced/webpack";
 import { ModuleFederationPlugin as RspackModuleFederationPlugin } from "@module-federation/enhanced/rspack";
 import UniverseEntryChunkTrackerPlugin from "@module-federation/node/universe-entry-chunk-tracker-plugin";
-import { updateStatsAndManifest } from "./manifest";
-import { isDev } from "./constant";
-import logger from "./logger";
+import logger from "../logger";
+import { isDev } from "./utils";
+import { updateStatsAndManifest } from "@module-federation/rsbuild-plugin/manifest";
 import { isWebTarget, skipByTarget } from "./utils";
 function setEnv() {
   process.env["MF_DISABLE_EMIT_STATS"] = "true";
@@ -76,15 +76,23 @@ const moduleFederationSSRPlugin = (pluginOptions) => ({
     }
     setEnv();
     api._internalRuntimePlugins(({ entrypoint, plugins }) => {
-      if (!isDev) {
+      const { fetchServerQuery } = pluginOptions;
+      plugins.push({
+        name: "injectDataFetchFunction",
+        path: "@module-federation/modern-js/ssr-inject-data-fetch-function-plugin",
+        config: {
+          fetchServerQuery
+        }
+      });
+      if (!isDev()) {
         return {
           entrypoint,
           plugins
         };
       }
       plugins.push({
-        name: "mfSSR",
-        path: "@module-federation/modern-js/ssr-runtime",
+        name: "mfSSRDev",
+        path: "@module-federation/modern-js/ssr-dev-plugin",
         config: {}
       });
       return {
@@ -92,6 +100,17 @@ const moduleFederationSSRPlugin = (pluginOptions) => ({
         plugins
       };
     });
+    if (pluginOptions.ssrConfig.remotes) {
+      api._internalServerPlugins(({ plugins }) => {
+        plugins.push({
+          name: "@module-federation/modern-js/data-fetch-server-plugin",
+          options: {}
+        });
+        return {
+          plugins
+        };
+      });
+    }
     api.modifyBundlerChain((chain) => {
       const target = chain.get("target");
       if (skipByTarget(target)) {
@@ -112,7 +131,7 @@ const moduleFederationSSRPlugin = (pluginOptions) => ({
       }
       if (!isWeb) {
         chain.target("async-node");
-        if (isDev) {
+        if (isDev()) {
           chain.plugin("UniverseEntryChunkTrackerPlugin").use(UniverseEntryChunkTrackerPlugin);
         }
         const userSSRConfig = pluginOptions.userConfig.ssr ? typeof pluginOptions.userConfig.ssr === "object" ? pluginOptions.userConfig.ssr : {} : {};
@@ -121,7 +140,7 @@ const moduleFederationSSRPlugin = (pluginOptions) => ({
           chain.output.publicPath(`${publicPath}${userSSRConfig.distOutputDir}/`);
         }
       }
-      if (isDev && isWeb) {
+      if (isDev() && isWeb) {
         chain.externals({
           "@module-federation/node/utils": "NOT_USED_IN_BROWSER"
         });

package/dist/esm-node/cli/utils.js

@@ -42,8 +42,12 @@ const skipByTarget = (target) => {
   }
   return false;
 };
+function isDev() {
+  return process.env.NODE_ENV === "development";
+}
 export {
   getIPV4,
+  isDev,
   isWebTarget,
   skipByTarget
 };

package/dist/esm-node/constant.js

@@ -1,6 +1,42 @@
 const LOCALHOST = "localhost";
 const PLUGIN_IDENTIFIER = "[ Modern.js Module Federation ]";
+const DATA_FETCH_QUERY = "x-mf-data-fetch";
+const DATA_FETCH_ERROR_PREFIX = "caught the following error during dataFetch: ";
+const LOAD_REMOTE_ERROR_PREFIX = "caught the following error during loadRemote: ";
+const DOWNGRADE_KEY = "_mfSSRDowngrade";
+const DATA_FETCH_MAP_KEY = "__MF_DATA_FETCH_MAP__";
+const DATA_FETCH_FUNCTION = "_mfDataFetch";
+const FS_HREF = "_mfFSHref";
+const ERROR_TYPE = {
+  DATA_FETCH: 1,
+  LOAD_REMOTE: 2,
+  UNKNOWN: 3
+};
+const WRAP_DATA_FETCH_ID_IDENTIFIER = "wrap_dfip_identifier";
+var MF_DATA_FETCH_TYPE;
+(function(MF_DATA_FETCH_TYPE2) {
+  MF_DATA_FETCH_TYPE2[MF_DATA_FETCH_TYPE2["FETCH_SERVER"] = 1] = "FETCH_SERVER";
+  MF_DATA_FETCH_TYPE2[MF_DATA_FETCH_TYPE2["FETCH_CLIENT"] = 2] = "FETCH_CLIENT";
+})(MF_DATA_FETCH_TYPE || (MF_DATA_FETCH_TYPE = {}));
+var MF_DATA_FETCH_STATUS;
+(function(MF_DATA_FETCH_STATUS2) {
+  MF_DATA_FETCH_STATUS2[MF_DATA_FETCH_STATUS2["LOADED"] = 1] = "LOADED";
+  MF_DATA_FETCH_STATUS2[MF_DATA_FETCH_STATUS2["LOADING"] = 2] = "LOADING";
+  MF_DATA_FETCH_STATUS2[MF_DATA_FETCH_STATUS2["AWAIT"] = 0] = "AWAIT";
+  MF_DATA_FETCH_STATUS2[MF_DATA_FETCH_STATUS2["ERROR"] = 3] = "ERROR";
+})(MF_DATA_FETCH_STATUS || (MF_DATA_FETCH_STATUS = {}));
 export {
+  DATA_FETCH_ERROR_PREFIX,
+  DATA_FETCH_FUNCTION,
+  DATA_FETCH_MAP_KEY,
+  DATA_FETCH_QUERY,
+  DOWNGRADE_KEY,
+  ERROR_TYPE,
+  FS_HREF,
+  LOAD_REMOTE_ERROR_PREFIX,
   LOCALHOST,
-  PLUGIN_IDENTIFIER
+  MF_DATA_FETCH_STATUS,
+  MF_DATA_FETCH_TYPE,
+  PLUGIN_IDENTIFIER,
+  WRAP_DATA_FETCH_ID_IDENTIFIER
 };

package/dist/esm-node/{cli/logger.js → logger.js}

@@ -1,5 +1,5 @@
 import { createLogger } from "@module-federation/sdk";
-import { PLUGIN_IDENTIFIER } from "../constant";
+import { PLUGIN_IDENTIFIER } from "./constant";
 const logger = createLogger(PLUGIN_IDENTIFIER);
 var logger_default = logger;
 export {

package/dist/esm-node/runtime/AwaitDataFetch.js

@@ -0,0 +1,109 @@
+import { jsx as _jsx, jsxs as _jsxs, Fragment as _Fragment } from "react/jsx-runtime";
+import { Suspense, useRef } from "react";
+import logger from "../logger";
+import { DATA_FETCH_ERROR_PREFIX, LOAD_REMOTE_ERROR_PREFIX, ERROR_TYPE, DATA_FETCH_FUNCTION } from "../constant";
+import { getDataFetchIdWithErrorMsgs, wrapDataFetchId } from "../utils";
+function isPromise(obj) {
+  return !!obj && (typeof obj === "object" || typeof obj === "function") && typeof obj.then === "function";
+}
+const AWAIT_ERROR_PREFIX = "<Await /> caught the following error during render: ";
+const transformError = (err) => {
+  const errMsg = err instanceof Error ? err.message : err;
+  const originalMsg = errMsg.replace(AWAIT_ERROR_PREFIX, "");
+  const dataFetchMapKey = getDataFetchIdWithErrorMsgs(originalMsg);
+  if (originalMsg.indexOf(DATA_FETCH_ERROR_PREFIX) === 0) {
+    return {
+      error: new Error(originalMsg.replace(DATA_FETCH_ERROR_PREFIX, "").replace(wrapDataFetchId(dataFetchMapKey), "")),
+      errorType: ERROR_TYPE.DATA_FETCH,
+      dataFetchMapKey
+    };
+  }
+  if (originalMsg.indexOf(LOAD_REMOTE_ERROR_PREFIX) === 0) {
+    return {
+      error: new Error(originalMsg.replace(LOAD_REMOTE_ERROR_PREFIX, "").replace(wrapDataFetchId(dataFetchMapKey), "")),
+      errorType: ERROR_TYPE.LOAD_REMOTE,
+      dataFetchMapKey
+    };
+  }
+  return {
+    error: new Error(originalMsg.replace(wrapDataFetchId(dataFetchMapKey), "")),
+    errorType: ERROR_TYPE.UNKNOWN,
+    dataFetchMapKey
+  };
+};
+const DefaultLoading = /* @__PURE__ */ _jsx(_Fragment, {});
+const DefaultErrorElement = (_data) => /* @__PURE__ */ _jsx("div", {
+  children: "Error"
+});
+function AwaitDataFetch({ resolve, loading = DefaultLoading, errorElement = DefaultErrorElement, children, params }) {
+  const dataRef = useRef();
+  const data = dataRef.current || resolve;
+  const getData = isPromise(data) ? fetchData(data, dataRef) : () => data;
+  return /* @__PURE__ */ _jsx(AwaitSuspense, {
+    params,
+    loading,
+    errorElement,
+    // @ts-ignore
+    resolve: getData,
+    children
+  });
+}
+function AwaitSuspense({ resolve, children, loading = DefaultLoading, errorElement = DefaultErrorElement }) {
+  return /* @__PURE__ */ _jsx(Suspense, {
+    fallback: loading,
+    children: /* @__PURE__ */ _jsx(ResolveAwait, {
+      resolve,
+      errorElement,
+      children
+    })
+  });
+}
+function ResolveAwait({ children, resolve, errorElement, params }) {
+  const data = resolve();
+  logger.debug("resolve data: ", data);
+  if (typeof data === "string" && data.indexOf(AWAIT_ERROR_PREFIX) === 0) {
+    const transformedError = transformError(data);
+    return /* @__PURE__ */ _jsx(_Fragment, {
+      children: typeof errorElement === "function" ? /* @__PURE__ */ _jsxs(_Fragment, {
+        children: [
+          globalThis.FEDERATION_SSR && /* @__PURE__ */ _jsx("script", {
+            suppressHydrationWarning: true,
+            dangerouslySetInnerHTML: {
+              __html: String.raw`
+                  globalThis['${DATA_FETCH_FUNCTION}'] = globalThis['${DATA_FETCH_FUNCTION}']  || []
+                  globalThis['${DATA_FETCH_FUNCTION}'].push([${transformedError.dataFetchMapKey ? `'${transformedError.dataFetchMapKey}'` : ""},${params ? JSON.stringify(params) : null},true]);`
+            }
+          }),
+          errorElement(transformedError)
+        ]
+      }) : errorElement
+    });
+  }
+  const toRender = typeof children === "function" ? children(data) : children;
+  return /* @__PURE__ */ _jsx(_Fragment, {
+    children: toRender
+  });
+}
+const fetchData = (promise, ref) => {
+  let data;
+  let status = "pending";
+  const suspender = promise.then((res) => {
+    status = "success";
+    data = res;
+    ref.current = res;
+  }).catch((e) => {
+    status = "success";
+    console.warn(e);
+    data = AWAIT_ERROR_PREFIX + e;
+  });
+  return () => {
+    if (status === "pending") {
+      throw suspender;
+    }
+    return data;
+  };
+};
+export {
+  AwaitDataFetch,
+  transformError
+};