@module-federation/data-prefetch 0.6.6 → 0.6.8

package/dist/prefetch.esm.js

@@ -0,0 +1,140 @@
+import { getRemoteInfo, getRemoteEntry } from '@module-federation/runtime';
+import { loadScript } from '@module-federation/sdk';
+import { b as getPrefetchId, c as compatGetPrefetchId } from './runtime-utils.esm.js';
+
+var // @ts-ignore init global variable for test
+_globalThis, _globalThis___FEDERATION__;
+var ___FEDERATION__;
+(___FEDERATION__ = (_globalThis = globalThis).__FEDERATION__) != null ? ___FEDERATION__ : _globalThis.__FEDERATION__ = {};
+var ___PREFETCH__;
+(___PREFETCH__ = (_globalThis___FEDERATION__ = globalThis.__FEDERATION__).__PREFETCH__) != null ? ___PREFETCH__ : _globalThis___FEDERATION__.__PREFETCH__ = {
+    entryLoading: {},
+    instance: new Map(),
+    __PREFETCH_EXPORTS__: {}
+};
+class MFDataPrefetch {
+    get global() {
+        return globalThis.__FEDERATION__.__PREFETCH__;
+    }
+    static getInstance(id) {
+        return globalThis.__FEDERATION__.__PREFETCH__.instance.get(id);
+    }
+    async loadEntry(entry) {
+        const { name, remoteSnapshot, remote, origin } = this._options;
+        if (entry) {
+            const { buildVersion, globalName } = remoteSnapshot;
+            const uniqueKey = globalName || `${name}:${buildVersion}`;
+            if (!this.global.entryLoading[uniqueKey]) {
+                this.global.entryLoading[uniqueKey] = loadScript(entry, {});
+            }
+            return this.global.entryLoading[uniqueKey];
+        } else {
+            const remoteInfo = getRemoteInfo(remote);
+            const module = origin.moduleCache.get(remoteInfo.name);
+            return getRemoteEntry({
+                origin: origin,
+                remoteInfo,
+                remoteEntryExports: module ? module.remoteEntryExports : undefined
+            });
+        }
+    }
+    getProjectExports() {
+        var _globalThis___FEDERATION_____PREFETCH_____PREFETCH_EXPORTS__;
+        if (Object.keys(this._exports).length > 0) {
+            return this._exports;
+        }
+        const { name } = this._options;
+        const exportsPromiseFn = (_globalThis___FEDERATION_____PREFETCH_____PREFETCH_EXPORTS__ = globalThis.__FEDERATION__.__PREFETCH__.__PREFETCH_EXPORTS__) == null ? void 0 : _globalThis___FEDERATION_____PREFETCH_____PREFETCH_EXPORTS__[name];
+        const exportsPromise = typeof exportsPromiseFn === 'function' ? exportsPromiseFn() : Promise.resolve({});
+        const resolve = exportsPromise.then((exports = {})=>{
+            // Match prefetch based on the function name suffix so that other capabilities can be expanded later.
+            // Not all functions should be directly identified as prefetch functions
+            const memory = {};
+            Object.keys(exports).forEach((key)=>{
+                memory[key] = {};
+                const exportVal = exports[key];
+                Object.keys(exportVal).reduce((memo, current)=>{
+                    if (current.toLocaleLowerCase().endsWith('prefetch') || current.toLocaleLowerCase() === 'default') {
+                        memo[current] = exportVal[current];
+                    }
+                    return memo;
+                }, memory[key]);
+            });
+            this.memorizeExports(memory);
+        });
+        return resolve;
+    }
+    memorizeExports(exports) {
+        this._exports = exports;
+    }
+    getExposeExports(id) {
+        const prefetchId = getPrefetchId(id);
+        const compatId = compatGetPrefetchId(id);
+        const prefetchExports = this._exports[prefetchId] || this._exports[compatId];
+        return prefetchExports || {};
+    }
+    prefetch(prefetchOptions) {
+        const { id, functionId = 'default', refetchParams } = prefetchOptions;
+        let prefetchResult;
+        const prefetchId = getPrefetchId(id);
+        const compatId = compatGetPrefetchId(id);
+        const memorizeId = id + functionId;
+        const memory = this.prefetchMemory.get(memorizeId);
+        if (!this.checkOutdate(prefetchOptions) && memory) {
+            return memory;
+        }
+        const prefetchExports = this._exports[prefetchId] || this._exports[compatId];
+        if (!prefetchExports) {
+            return;
+        }
+        const executePrefetch = prefetchExports[functionId];
+        if (typeof executePrefetch === 'function') {
+            if (refetchParams) {
+                prefetchResult = executePrefetch(refetchParams);
+            } else {
+                prefetchResult = executePrefetch();
+            }
+        } else {
+            throw new Error(`[Module Federation Data Prefetch]: No prefetch function called ${functionId} export in prefetch file`);
+        }
+        this.memorize(memorizeId, prefetchResult);
+        return prefetchResult;
+    }
+    memorize(id, value) {
+        this.prefetchMemory.set(id, value);
+    }
+    markOutdate(markOptions, isOutdate) {
+        const { id, functionId = 'default' } = markOptions;
+        if (!this.recordOutdate[id]) {
+            this.recordOutdate[id] = {};
+        }
+        this.recordOutdate[id][functionId] = isOutdate;
+    }
+    checkOutdate(outdateOptions) {
+        const { id, functionId = 'default', cacheStrategy } = outdateOptions;
+        if (typeof cacheStrategy === 'function') {
+            return cacheStrategy();
+        }
+        if (!this.recordOutdate[id]) {
+            this.recordOutdate[id] = {};
+        }
+        if (this.recordOutdate[id][functionId]) {
+            this.markOutdate({
+                id,
+                functionId
+            }, false);
+            return true;
+        } else {
+            return false;
+        }
+    }
+    constructor(options){
+        this.prefetchMemory = new Map();
+        this.recordOutdate = {};
+        this._exports = {};
+        this._options = options;
+        this.global.instance.set(options.name, this);
+    }
+}
+
+export { MFDataPrefetch as M };

package/dist/react.cjs.d.ts

@@ -0,0 +1 @@
+export * from "./src/react/index";

package/dist/react.cjs.js

@@ -0,0 +1,77 @@
+'use strict';
+
+var polyfills = require('./polyfills.cjs.js');
+var react = require('react');
+var index = require('./index.cjs2.js');
+var prefetch = require('./prefetch.cjs.js');
+var universal = require('./universal.cjs.js');
+var runtimeUtils = require('./runtime-utils.cjs.js');
+require('@module-federation/sdk');
+require('@module-federation/runtime');
+
+const useFirstMounted = ()=>{
+    const ref = react.useRef(true);
+    react.useEffect(()=>{
+        ref.current = false;
+    }, []);
+    return ref.current;
+};
+
+const usePrefetch = (options)=>{
+    const isFirstMounted = useFirstMounted();
+    if (isFirstMounted) {
+        const startTiming = performance.now();
+        index.logger.info(`2. Start Get Prefetch Data: ${options.id} - ${options.functionId || 'default'} - ${startTiming}`);
+    }
+    const { id, functionId, deferId } = options;
+    const prefetchInfo = {
+        id,
+        functionId
+    };
+    const mfScope = runtimeUtils.getScope();
+    let state;
+    const prefetchResult = universal.prefetch(options);
+    if (deferId) {
+        if (prefetchResult instanceof Promise) {
+            state = prefetchResult.then((deferredData)=>deferredData.data[deferId]);
+        } else {
+            state = prefetchResult.data[deferId];
+        }
+    } else {
+        state = prefetchResult;
+    }
+    const [prefetchState, setPrefetchState] = react.useState(state);
+    const prefetchInstance = prefetch.MFDataPrefetch.getInstance(mfScope);
+    react.useEffect(()=>{
+        const useEffectTiming = performance.now();
+        index.logger.info(`3. Start Execute UseEffect: ${options.id} - ${options.functionId || 'default'} - ${useEffectTiming}`);
+        return ()=>{
+            prefetchInstance == null ? void 0 : prefetchInstance.markOutdate(prefetchInfo, true);
+        };
+    }, []);
+    const refreshExecutor = (refetchParams)=>{
+        const refetchOptions = polyfills._extends({}, options);
+        if (refetchParams) {
+            refetchOptions.refetchParams = refetchParams;
+        }
+        prefetchInstance == null ? void 0 : prefetchInstance.markOutdate(prefetchInfo, true);
+        const newVal = universal.prefetch(refetchOptions);
+        let newState;
+        if (deferId) {
+            if (newVal instanceof Promise) {
+                newState = newVal.then((deferredData)=>deferredData.data[deferId]);
+            } else {
+                newState = newVal.data[deferId];
+            }
+        } else {
+            newState = newVal;
+        }
+        setPrefetchState(newState);
+    };
+    return [
+        prefetchState,
+        refreshExecutor
+    ];
+};
+
+exports.usePrefetch = usePrefetch;

package/dist/react.esm.d.ts

@@ -0,0 +1 @@
+export * from "./src/react/index";

package/dist/react.esm.js

@@ -0,0 +1,75 @@
+import { _ as _extends } from './polyfills.esm.js';
+import { useRef, useEffect, useState } from 'react';
+import { l as logger } from './index.esm2.js';
+import { M as MFDataPrefetch } from './prefetch.esm.js';
+import { prefetch } from './universal.esm.js';
+import { g as getScope } from './runtime-utils.esm.js';
+import '@module-federation/sdk';
+import '@module-federation/runtime';
+
+const useFirstMounted = ()=>{
+    const ref = useRef(true);
+    useEffect(()=>{
+        ref.current = false;
+    }, []);
+    return ref.current;
+};
+
+const usePrefetch = (options)=>{
+    const isFirstMounted = useFirstMounted();
+    if (isFirstMounted) {
+        const startTiming = performance.now();
+        logger.info(`2. Start Get Prefetch Data: ${options.id} - ${options.functionId || 'default'} - ${startTiming}`);
+    }
+    const { id, functionId, deferId } = options;
+    const prefetchInfo = {
+        id,
+        functionId
+    };
+    const mfScope = getScope();
+    let state;
+    const prefetchResult = prefetch(options);
+    if (deferId) {
+        if (prefetchResult instanceof Promise) {
+            state = prefetchResult.then((deferredData)=>deferredData.data[deferId]);
+        } else {
+            state = prefetchResult.data[deferId];
+        }
+    } else {
+        state = prefetchResult;
+    }
+    const [prefetchState, setPrefetchState] = useState(state);
+    const prefetchInstance = MFDataPrefetch.getInstance(mfScope);
+    useEffect(()=>{
+        const useEffectTiming = performance.now();
+        logger.info(`3. Start Execute UseEffect: ${options.id} - ${options.functionId || 'default'} - ${useEffectTiming}`);
+        return ()=>{
+            prefetchInstance == null ? void 0 : prefetchInstance.markOutdate(prefetchInfo, true);
+        };
+    }, []);
+    const refreshExecutor = (refetchParams)=>{
+        const refetchOptions = _extends({}, options);
+        if (refetchParams) {
+            refetchOptions.refetchParams = refetchParams;
+        }
+        prefetchInstance == null ? void 0 : prefetchInstance.markOutdate(prefetchInfo, true);
+        const newVal = prefetch(refetchOptions);
+        let newState;
+        if (deferId) {
+            if (newVal instanceof Promise) {
+                newState = newVal.then((deferredData)=>deferredData.data[deferId]);
+            } else {
+                newState = newVal.data[deferId];
+            }
+        } else {
+            newState = newVal;
+        }
+        setPrefetchState(newState);
+    };
+    return [
+        prefetchState,
+        refreshExecutor
+    ];
+};
+
+export { usePrefetch };

package/dist/runtime-utils.cjs.js

@@ -0,0 +1,27 @@
+'use strict';
+
+var runtime = require('@module-federation/runtime');
+var sdk = require('@module-federation/sdk');
+
+const getScope = ()=>{
+    return runtime.getInstance().options.name;
+};
+const getPrefetchId = (id)=>sdk.encodeName(`${id}/${sdk.MFPrefetchCommon.identifier}`);
+const compatGetPrefetchId = (id)=>sdk.encodeName(`${id}/VmokPrefetch`);
+const getSignalFromManifest = (remoteSnapshot)=>{
+    if (!remoteSnapshot) {
+        return false;
+    }
+    if (!('prefetchEntry' in remoteSnapshot) && !('prefetchInterface' in remoteSnapshot)) {
+        return false;
+    }
+    if (!remoteSnapshot.prefetchEntry && !remoteSnapshot.prefetchInterface) {
+        return false;
+    }
+    return true;
+};
+
+exports.compatGetPrefetchId = compatGetPrefetchId;
+exports.getPrefetchId = getPrefetchId;
+exports.getScope = getScope;
+exports.getSignalFromManifest = getSignalFromManifest;

package/dist/runtime-utils.esm.js

@@ -0,0 +1,22 @@
+import { getInstance } from '@module-federation/runtime';
+import { encodeName, MFPrefetchCommon } from '@module-federation/sdk';
+
+const getScope = ()=>{
+    return getInstance().options.name;
+};
+const getPrefetchId = (id)=>encodeName(`${id}/${MFPrefetchCommon.identifier}`);
+const compatGetPrefetchId = (id)=>encodeName(`${id}/VmokPrefetch`);
+const getSignalFromManifest = (remoteSnapshot)=>{
+    if (!remoteSnapshot) {
+        return false;
+    }
+    if (!('prefetchEntry' in remoteSnapshot) && !('prefetchInterface' in remoteSnapshot)) {
+        return false;
+    }
+    if (!remoteSnapshot.prefetchEntry && !remoteSnapshot.prefetchInterface) {
+        return false;
+    }
+    return true;
+};
+
+export { getSignalFromManifest as a, getPrefetchId as b, compatGetPrefetchId as c, getScope as g };

package/dist/shared.cjs.d.ts

@@ -0,0 +1,2 @@
+export * from "./src/shared/index";
+export { default } from "./src/shared/index";

package/dist/shared.cjs.js

@@ -0,0 +1,24 @@
+'use strict';
+
+const sharedStrategy = ()=>({
+        name: 'shared-strategy',
+        beforeInit (args) {
+            const { userOptions } = args;
+            const shared = userOptions.shared;
+            if (shared) {
+                Object.keys(shared).forEach((sharedKey)=>{
+                    const sharedConfigs = shared[sharedKey];
+                    const arraySharedConfigs = Array.isArray(sharedConfigs) ? sharedConfigs : [
+                        sharedConfigs
+                    ];
+                    arraySharedConfigs.forEach((s)=>{
+                        s.strategy = 'loaded-first';
+                    });
+                });
+                console.warn(`[Module Federation Data Prefetch]: Your shared strategy is set to 'loaded-first', this is a necessary condition for data prefetch`);
+            }
+            return args;
+        }
+    });
+
+module.exports = sharedStrategy;

package/dist/shared.esm.d.ts

@@ -0,0 +1,2 @@
+export * from "./src/shared/index";
+export { default } from "./src/shared/index";

package/dist/shared.esm.js

@@ -0,0 +1,22 @@
+const sharedStrategy = ()=>({
+        name: 'shared-strategy',
+        beforeInit (args) {
+            const { userOptions } = args;
+            const shared = userOptions.shared;
+            if (shared) {
+                Object.keys(shared).forEach((sharedKey)=>{
+                    const sharedConfigs = shared[sharedKey];
+                    const arraySharedConfigs = Array.isArray(sharedConfigs) ? sharedConfigs : [
+                        sharedConfigs
+                    ];
+                    arraySharedConfigs.forEach((s)=>{
+                        s.strategy = 'loaded-first';
+                    });
+                });
+                console.warn(`[Module Federation Data Prefetch]: Your shared strategy is set to 'loaded-first', this is a necessary condition for data prefetch`);
+            }
+            return args;
+        }
+    });
+
+export { sharedStrategy as default };

package/dist/{cli → src/cli}/babel.d.ts

@@ -1,5 +1,4 @@
-import { moduleFederationPlugin } from '@module-federation/sdk';
-
+import type { moduleFederationPlugin } from '@module-federation/sdk';
 interface BabelPluginOptions {
     hook_id: string;
     import_pkg: string;
@@ -35,5 +34,4 @@ declare const _default: (babel: {
         }): void;
     };
 };
-
-export { _default as default };
+export default _default;

package/dist/{cli → src/cli}/index.d.ts

@@ -1,10 +1,8 @@
-import * as webpack from 'webpack';
-import { WebpackPluginInstance, Compiler } from 'webpack';
 import { moduleFederationPlugin } from '@module-federation/sdk';
-
-declare const RuntimeGlobals: typeof webpack.RuntimeGlobals;
-declare function getFederationGlobalScope(runtimeGlobals: typeof RuntimeGlobals): string;
-declare class PrefetchPlugin implements WebpackPluginInstance {
+import type { Compiler, WebpackPluginInstance } from 'webpack';
+declare const RuntimeGlobals: typeof import("webpack").RuntimeGlobals;
+export declare function getFederationGlobalScope(runtimeGlobals: typeof RuntimeGlobals): string;
+export declare class PrefetchPlugin implements WebpackPluginInstance {
     options: moduleFederationPlugin.ModuleFederationPluginOptions;
     private _reWriteExports;
     constructor(options: moduleFederationPlugin.ModuleFederationPluginOptions);
@@ -15,5 +13,4 @@ declare class PrefetchPlugin implements WebpackPluginInstance {
     static setRemoteIdentifier(): string;
     static removeRemoteIdentifier(): string;
 }
-
-export { PrefetchPlugin, getFederationGlobalScope };
+export {};

package/dist/src/common/constant.d.ts

@@ -0,0 +1 @@
+export declare const TEMP_DIR = ".mf";

package/dist/src/common/index.d.ts

@@ -0,0 +1 @@
+export * from './constant';

package/dist/src/common/node-utils.d.ts

@@ -0,0 +1,2 @@
+export declare const fileExistsWithCaseSync: (filepath: string) => boolean;
+export declare const fixPrefetchPath: (exposePath: string) => Array<string>;

package/dist/src/common/runtime-utils.d.ts

@@ -0,0 +1,5 @@
+import { ModuleInfo } from '@module-federation/sdk';
+export declare const getScope: () => string;
+export declare const getPrefetchId: (id: string) => string;
+export declare const compatGetPrefetchId: (id: string) => string;
+export declare const getSignalFromManifest: (remoteSnapshot: ModuleInfo) => boolean;

package/dist/src/index.d.ts

@@ -0,0 +1,2 @@
+export * from './prefetch';
+export * from './plugin';

package/dist/src/logger/index.d.ts

@@ -0,0 +1,3 @@
+import { Logger } from '@module-federation/sdk';
+declare const _default: Logger;
+export default _default;

package/dist/src/plugin.d.ts

@@ -0,0 +1,3 @@
+import type { FederationRuntimePlugin } from '@module-federation/runtime/types';
+export declare const prefetchPlugin: () => FederationRuntimePlugin;
+export default prefetchPlugin;

package/dist/{prefetch-4e9646e4.d.ts → src/prefetch.d.ts}

@@ -1,30 +1,29 @@
 import { FederationHost } from '@module-federation/runtime';
 import { ModuleInfo } from '@module-federation/sdk';
 import { Remote } from '@module-federation/runtime/types';
-
 declare module '@module-federation/runtime' {
     interface Federation {
         __PREFETCH__: {
             entryLoading: Record<string, undefined | Promise<void>>;
             instance: Map<string, MFDataPrefetch>;
-            __PREFETCH_EXPORTS__: Record<string, Promise<Record<string, any>>>;
+            __PREFETCH_EXPORTS__: Record<string, () => Promise<Record<string, any>>>;
         };
     }
 }
 type PrefetchExports = Record<string, any>;
-interface DataPrefetchOptions {
+export interface DataPrefetchOptions {
     name: string;
     remote?: Remote;
     origin?: FederationHost;
     remoteSnapshot?: ModuleInfo;
 }
-interface prefetchOptions {
+export interface prefetchOptions {
     id: string;
     functionId?: string;
     cacheStrategy?: () => boolean;
     refetchParams?: any;
 }
-declare class MFDataPrefetch {
+export declare class MFDataPrefetch {
     prefetchMemory: Map<string, Promise<any>>;
     recordOutdate: Record<string, Record<string, boolean>>;
     private _exports;
@@ -41,5 +40,4 @@ declare class MFDataPrefetch {
     markOutdate(markOptions: Omit<prefetchOptions, 'cacheStrategy'>, isOutdate: boolean): void;
     checkOutdate(outdateOptions: prefetchOptions): boolean;
 }
-
-export { DataPrefetchOptions as D, MFDataPrefetch as M, prefetchOptions as p };
+export {};

package/dist/src/react/hooks.d.ts

@@ -0,0 +1,11 @@
+import { type prefetchOptions } from '../prefetch';
+type refetchParams = any;
+type prefetchReturnType<T> = [
+    Promise<T>,
+    (refetchParams?: refetchParams) => void
+];
+type UsePrefetchOptions = prefetchOptions & {
+    deferId?: string;
+};
+export declare const usePrefetch: <T>(options: UsePrefetchOptions) => prefetchReturnType<T>;
+export {};

package/dist/src/react/index.d.ts

@@ -0,0 +1 @@
+export * from './hooks';

package/dist/src/react/utils.d.ts

@@ -0,0 +1 @@
+export declare const useFirstMounted: () => boolean;

package/dist/src/shared/index.d.ts

@@ -0,0 +1,3 @@
+import type { FederationRuntimePlugin } from '@module-federation/runtime';
+declare const sharedStrategy: () => FederationRuntimePlugin;
+export default sharedStrategy;

package/dist/src/universal/index.d.ts

@@ -0,0 +1,2 @@
+import { type prefetchOptions } from '../prefetch';
+export declare function prefetch(options: prefetchOptions): Promise<any>;

package/dist/universal.cjs.d.ts

@@ -0,0 +1 @@
+export * from "./src/universal/index";

package/dist/universal.cjs.js

@@ -0,0 +1,29 @@
+'use strict';
+
+var prefetch$1 = require('./prefetch.cjs.js');
+var runtimeUtils = require('./runtime-utils.cjs.js');
+require('@module-federation/runtime');
+require('@module-federation/sdk');
+
+function prefetch(options) {
+    const { id, functionId = 'default' } = options;
+    const mfScope = runtimeUtils.getScope();
+    const prefetchInstance = prefetch$1.MFDataPrefetch.getInstance(mfScope) || new prefetch$1.MFDataPrefetch({
+        name: mfScope
+    });
+    const res = prefetchInstance.getProjectExports();
+    if (res instanceof Promise) {
+        const promise = res.then(()=>{
+            const result = prefetchInstance.prefetch(options);
+            prefetchInstance.memorize(id + functionId, result);
+            return result;
+        });
+        return promise;
+    } else {
+        const result = prefetchInstance.prefetch(options);
+        prefetchInstance.memorize(id + functionId, result);
+        return result;
+    }
+}
+
+exports.prefetch = prefetch;

package/dist/universal.esm.d.ts

@@ -0,0 +1 @@
+export * from "./src/universal/index";

package/dist/universal.esm.js

@@ -0,0 +1,27 @@
+import { M as MFDataPrefetch } from './prefetch.esm.js';
+import { g as getScope } from './runtime-utils.esm.js';
+import '@module-federation/runtime';
+import '@module-federation/sdk';
+
+function prefetch(options) {
+    const { id, functionId = 'default' } = options;
+    const mfScope = getScope();
+    const prefetchInstance = MFDataPrefetch.getInstance(mfScope) || new MFDataPrefetch({
+        name: mfScope
+    });
+    const res = prefetchInstance.getProjectExports();
+    if (res instanceof Promise) {
+        const promise = res.then(()=>{
+            const result = prefetchInstance.prefetch(options);
+            prefetchInstance.memorize(id + functionId, result);
+            return result;
+        });
+        return promise;
+    } else {
+        const result = prefetchInstance.prefetch(options);
+        prefetchInstance.memorize(id + functionId, result);
+        return result;
+    }
+}
+
+export { prefetch };

package/jest.config.js

@@ -24,6 +24,6 @@ module.exports = {
     '^.+\\.(t|j)sx?$': ['@swc/jest', { swcrc: false }],
   },
   rootDir: __dirname,
-  testMatch: ['<rootDir>__tests__/**/**.spec.[jt]s?(x)'],
-  testPathIgnorePatterns: ['/node_modules/', '/dev/'],
+  testMatch: ['<rootDir>/__tests__/**/*.spec.[jt]s?(x)'],
+  testPathIgnorePatterns: ['/node_modules/'],
 };