@module-federation/runtime 1.0.0-canary.1 → 1.0.0-canary.3

package/share.cjs.js

@@ -97,19 +97,19 @@ function isPlainObject(val) {
 }
 function isStaticResourcesEqual(url1, url2) {
     const REG_EXP = /^(https?:)?\/\//i;
-    // Convert both url1 and url2 to relative paths
+    // Transform url1 and url2 into relative paths
     const relativeUrl1 = url1.replace(REG_EXP, '').replace(/\/$/, '');
     const relativeUrl2 = url2.replace(REG_EXP, '').replace(/\/$/, '');
-    // Determines whether relative paths are equal
+    // Check if the relative paths are identical
     return relativeUrl1 === relativeUrl2;
 }
 
 var _nativeGlobal___FEDERATION__, _nativeGlobal___FEDERATION__1, _nativeGlobal___FEDERATION__2, _nativeGlobal___FEDERATION__3, _nativeGlobal___FEDERATION__4, _nativeGlobal___FEDERATION__5, _nativeGlobal___FEDERATION__6;
 // export const nativeGlobal: typeof global = new Function('return this')();
 const nativeGlobal = new Function('return this')();
-// Avoid being windowed by some microfront end frameworks, but sandbox escapes due to reuse policies
-// The sandbox in the microfront does not copy the value of configurable
-// If no loading content exists on the global object, the loading object is defined
+// This section is to prevent encapsulation by certain microfrontend frameworks. Due to reuse policies, sandbox escapes.
+// The sandbox in the microfrontend does not replicate the value of 'configurable'.
+// If there is no loading content on the global object, this section defines the loading object.
 if (!Object.hasOwnProperty.call(globalThis, '__GLOBAL_LOADING_REMOTE_ENTRY__')) {
     Object.defineProperty(globalThis, '__GLOBAL_LOADING_REMOTE_ENTRY__', {
         value: {},
@@ -184,23 +184,15 @@ function getGlobalFederationConstructor() {
 function setGlobalFederationConstructor(FederationConstructor) {
     if (isDebugMode()) {
         Global.__FEDERATION__.__DEBUG_CONSTRUCTOR__ = FederationConstructor;
-        Global.__FEDERATION__.__DEBUG_CONSTRUCTOR_VERSION__ = '0.0.1';
+        Global.__FEDERATION__.__DEBUG_CONSTRUCTOR_VERSION__ = '1.0.0-canary.2';
     }
 }
 // eslint-disable-next-line @typescript-eslint/ban-types
 function getInfoWithoutType(target, key, getModuleInfoHook) {
-    let res;
-    if (target[key]) {
-        res = {
-            value: target[key],
-            key: key
-        };
-    } else {
-        res = {
-            value: undefined,
-            key: key
-        };
-    }
+    let res = {
+        value: target[key],
+        key: key
+    };
     if (getModuleInfoHook) {
         const hookRes = getModuleInfoHook(target, key);
         res = hookRes || res;
@@ -209,18 +201,17 @@ function getInfoWithoutType(target, key, getModuleInfoHook) {
 }
 const getGlobalSnapshot = ()=>Global.__FEDERATION__.moduleInfo;
 const getTargetSnapshotInfoByModuleInfo = (moduleInfo, snapshot, getModuleInfoHook)=>{
-    // remote include in hostSnapshot
+    // Check if the remote is included in the hostSnapshot
     const moduleKey = getFMId(moduleInfo);
     const getModuleInfo = getInfoWithoutType(snapshot, moduleKey, getModuleInfoHook).value;
-    // remoteSnapshot may don't include version
+    // The remoteSnapshot might not include a version
     if (getModuleInfo && !getModuleInfo.version && 'version' in moduleInfo && moduleInfo['version']) {
         getModuleInfo.version = moduleInfo['version'];
     }
     if (getModuleInfo) {
         return getModuleInfo;
     }
-    // remote don't include in hostSnapshot
-    // deploy micro app snapshot
+    // If the remote is not included in the hostSnapshot, deploy a micro app snapshot
     if ('version' in moduleInfo && moduleInfo['version']) {
         const { version } = moduleInfo, resModuleInfo = _object_without_properties_loose(moduleInfo, [
             "version"
@@ -242,9 +233,10 @@ const setGlobalSnapshotInfoByModuleInfo = (remoteInfo, moduleDetailInfo)=>{
 const addGlobalSnapshot = (moduleInfos)=>{
     Global.__FEDERATION__.moduleInfo = _extends({}, Global.__FEDERATION__.moduleInfo, moduleInfos);
     return ()=>{
-        Object.keys(moduleInfos).forEach((key)=>{
+        const keys = Object.keys(moduleInfos);
+        for (const key of keys){
             delete Global.__FEDERATION__.moduleInfo[key];
-        });
+        }
     };
 };
 const getRemoteEntryExports = (name, globalName)=>{
@@ -255,7 +247,10 @@ const getRemoteEntryExports = (name, globalName)=>{
         entryExports
     };
 };
-// global hooks
+// This function is used to register global plugins.
+// It iterates over the provided plugins and checks if they are already registered.
+// If a plugin is not registered, it is added to the global plugins.
+// If a plugin is already registered, a warning message is logged.
 const registerGlobalPlugins = (plugins)=>{
     const { __GLOBAL_PLUGIN__ } = Global.__FEDERATION__;
     plugins.forEach((plugin)=>{
@@ -696,8 +691,8 @@ function findSingletonVersionOrderByLoaded(scope, pkgName) {
     };
     return findVersion(scope, pkgName, callback);
 }
-// Information about sharing
-// TODO: Add strictVersion for consistency with mf.
+// Details about shared resources
+// TODO: Implement strictVersion for alignment with module federation.
 function getGlobalShare(pkgName, shareInfo) {
     const globalShares = Global.__FEDERATION__.__SHARE__;
     const { shareConfig, scope = DEFAULT_SCOPE, strategy } = shareInfo;
@@ -712,7 +707,7 @@ function getGlobalShare(pkgName, shareInfo) {
                 const singletonVersion = strategy === 'loaded-first' ? findSingletonVersionOrderByLoaded(sc, pkgName) : findSingletonVersionOrderByVersion(sc, pkgName);
                 // eslint-disable-next-line max-depth
                 if (typeof requiredVersion === 'string' && !satisfy(singletonVersion, requiredVersion)) {
-                    warn(`Unsatisfied version ${singletonVersion} from ${singletonVersion && globalShares[sc][pkgName][singletonVersion].from} of shared singleton module ${pkgName} (${shareInfo.from} required ${requiredVersion})`);
+                    warn(`Version ${singletonVersion} from ${singletonVersion && globalShares[sc][pkgName][singletonVersion].from} of shared singleton module ${pkgName} does not satisfy the requirement of ${shareInfo.from} which needs ${requiredVersion})`);
                 }
                 return globalShares[sc][pkgName][singletonVersion];
             } else {

package/share.esm.js

@@ -95,19 +95,19 @@ function isPlainObject(val) {
 }
 function isStaticResourcesEqual(url1, url2) {
     const REG_EXP = /^(https?:)?\/\//i;
-    // Convert both url1 and url2 to relative paths
+    // Transform url1 and url2 into relative paths
     const relativeUrl1 = url1.replace(REG_EXP, '').replace(/\/$/, '');
     const relativeUrl2 = url2.replace(REG_EXP, '').replace(/\/$/, '');
-    // Determines whether relative paths are equal
+    // Check if the relative paths are identical
     return relativeUrl1 === relativeUrl2;
 }
 
 var _nativeGlobal___FEDERATION__, _nativeGlobal___FEDERATION__1, _nativeGlobal___FEDERATION__2, _nativeGlobal___FEDERATION__3, _nativeGlobal___FEDERATION__4, _nativeGlobal___FEDERATION__5, _nativeGlobal___FEDERATION__6;
 // export const nativeGlobal: typeof global = new Function('return this')();
 const nativeGlobal = new Function('return this')();
-// Avoid being windowed by some microfront end frameworks, but sandbox escapes due to reuse policies
-// The sandbox in the microfront does not copy the value of configurable
-// If no loading content exists on the global object, the loading object is defined
+// This section is to prevent encapsulation by certain microfrontend frameworks. Due to reuse policies, sandbox escapes.
+// The sandbox in the microfrontend does not replicate the value of 'configurable'.
+// If there is no loading content on the global object, this section defines the loading object.
 if (!Object.hasOwnProperty.call(globalThis, '__GLOBAL_LOADING_REMOTE_ENTRY__')) {
     Object.defineProperty(globalThis, '__GLOBAL_LOADING_REMOTE_ENTRY__', {
         value: {},
@@ -182,23 +182,15 @@ function getGlobalFederationConstructor() {
 function setGlobalFederationConstructor(FederationConstructor) {
     if (isDebugMode()) {
         Global.__FEDERATION__.__DEBUG_CONSTRUCTOR__ = FederationConstructor;
-        Global.__FEDERATION__.__DEBUG_CONSTRUCTOR_VERSION__ = '0.0.1';
+        Global.__FEDERATION__.__DEBUG_CONSTRUCTOR_VERSION__ = '1.0.0-canary.2';
     }
 }
 // eslint-disable-next-line @typescript-eslint/ban-types
 function getInfoWithoutType(target, key, getModuleInfoHook) {
-    let res;
-    if (target[key]) {
-        res = {
-            value: target[key],
-            key: key
-        };
-    } else {
-        res = {
-            value: undefined,
-            key: key
-        };
-    }
+    let res = {
+        value: target[key],
+        key: key
+    };
     if (getModuleInfoHook) {
         const hookRes = getModuleInfoHook(target, key);
         res = hookRes || res;
@@ -207,18 +199,17 @@ function getInfoWithoutType(target, key, getModuleInfoHook) {
 }
 const getGlobalSnapshot = ()=>Global.__FEDERATION__.moduleInfo;
 const getTargetSnapshotInfoByModuleInfo = (moduleInfo, snapshot, getModuleInfoHook)=>{
-    // remote include in hostSnapshot
+    // Check if the remote is included in the hostSnapshot
     const moduleKey = getFMId(moduleInfo);
     const getModuleInfo = getInfoWithoutType(snapshot, moduleKey, getModuleInfoHook).value;
-    // remoteSnapshot may don't include version
+    // The remoteSnapshot might not include a version
     if (getModuleInfo && !getModuleInfo.version && 'version' in moduleInfo && moduleInfo['version']) {
         getModuleInfo.version = moduleInfo['version'];
     }
     if (getModuleInfo) {
         return getModuleInfo;
     }
-    // remote don't include in hostSnapshot
-    // deploy micro app snapshot
+    // If the remote is not included in the hostSnapshot, deploy a micro app snapshot
     if ('version' in moduleInfo && moduleInfo['version']) {
         const { version } = moduleInfo, resModuleInfo = _object_without_properties_loose(moduleInfo, [
             "version"
@@ -240,9 +231,10 @@ const setGlobalSnapshotInfoByModuleInfo = (remoteInfo, moduleDetailInfo)=>{
 const addGlobalSnapshot = (moduleInfos)=>{
     Global.__FEDERATION__.moduleInfo = _extends({}, Global.__FEDERATION__.moduleInfo, moduleInfos);
     return ()=>{
-        Object.keys(moduleInfos).forEach((key)=>{
+        const keys = Object.keys(moduleInfos);
+        for (const key of keys){
             delete Global.__FEDERATION__.moduleInfo[key];
-        });
+        }
     };
 };
 const getRemoteEntryExports = (name, globalName)=>{
@@ -253,7 +245,10 @@ const getRemoteEntryExports = (name, globalName)=>{
         entryExports
     };
 };
-// global hooks
+// This function is used to register global plugins.
+// It iterates over the provided plugins and checks if they are already registered.
+// If a plugin is not registered, it is added to the global plugins.
+// If a plugin is already registered, a warning message is logged.
 const registerGlobalPlugins = (plugins)=>{
     const { __GLOBAL_PLUGIN__ } = Global.__FEDERATION__;
     plugins.forEach((plugin)=>{
@@ -694,8 +689,8 @@ function findSingletonVersionOrderByLoaded(scope, pkgName) {
     };
     return findVersion(scope, pkgName, callback);
 }
-// Information about sharing
-// TODO: Add strictVersion for consistency with mf.
+// Details about shared resources
+// TODO: Implement strictVersion for alignment with module federation.
 function getGlobalShare(pkgName, shareInfo) {
     const globalShares = Global.__FEDERATION__.__SHARE__;
     const { shareConfig, scope = DEFAULT_SCOPE, strategy } = shareInfo;
@@ -710,7 +705,7 @@ function getGlobalShare(pkgName, shareInfo) {
                 const singletonVersion = strategy === 'loaded-first' ? findSingletonVersionOrderByLoaded(sc, pkgName) : findSingletonVersionOrderByVersion(sc, pkgName);
                 // eslint-disable-next-line max-depth
                 if (typeof requiredVersion === 'string' && !satisfy(singletonVersion, requiredVersion)) {
-                    warn(`Unsatisfied version ${singletonVersion} from ${singletonVersion && globalShares[sc][pkgName][singletonVersion].from} of shared singleton module ${pkgName} (${shareInfo.from} required ${requiredVersion})`);
+                    warn(`Version ${singletonVersion} from ${singletonVersion && globalShares[sc][pkgName][singletonVersion].from} of shared singleton module ${pkgName} does not satisfy the requirement of ${shareInfo.from} which needs ${requiredVersion})`);
                 }
                 return globalShares[sc][pkgName][singletonVersion];
             } else {

package/src/core.d.ts

@@ -101,9 +101,9 @@ export declare class FederationHost {
     }): Promise<T | null>;
     preloadRemote(preloadOptions: Array<PreloadRemoteArgs>): Promise<void>;
     /**
-     * The sharing init sequence function (only runs once per share scope).
-     * Has one argument, the name of the share scope.
-     * Creates a share scope if not existing
+     * This function initializes the sharing sequence (executed only once per share scope).
+     * It accepts one argument, the name of the share scope.
+     * If the share scope does not exist, it creates one.
      */
     initializeSharing(shareScopeName?: string): boolean | Promise<boolean>;
     private formatOptions;

package/src/utils/hooks/syncWaterfallHook.d.ts

@@ -1,5 +1,5 @@
 import { SyncHook } from './syncHook';
-export declare function checkReturnData(originData: any, returnData: any): boolean;
+export declare function checkReturnData(originalData: any, returnedData: any): boolean;
 export declare class SyncWaterfallHook<T extends Record<string, any>> extends SyncHook<[
     T
 ], T> {