@module-federation/data-prefetch 2.0.0 → 2.1.0

package/dist/plugin.js

@@ -0,0 +1,173 @@
+import { getResourceUrl } from "@module-federation/sdk";
+import { getSignalFromManifest } from "./common/runtime-utils.js";
+import { MFDataPrefetch } from "./prefetch.js";
+import logger from "./logger/index.js";
+import { SHARED_STRATEGY } from "./constant.js";
+
+;// CONCATENATED MODULE: external "@module-federation/sdk"
+
+;// CONCATENATED MODULE: external "./common/runtime-utils.js"
+
+;// CONCATENATED MODULE: external "./prefetch.js"
+
+;// CONCATENATED MODULE: external "./logger/index.js"
+
+;// CONCATENATED MODULE: external "./constant.js"
+
+;// CONCATENATED MODULE: ./src/plugin.ts
+
+
+
+
+
+const loadingArray = [];
+let sharedFlag = SHARED_STRATEGY;
+// eslint-disable-next-line max-lines-per-function
+const prefetchPlugin = ()=>({
+        name: 'data-prefetch-runtime-plugin',
+        initContainer (options) {
+            const { remoteSnapshot, remoteInfo, id, origin } = options;
+            if (!id) {
+                return options;
+            }
+            const snapshot = remoteSnapshot;
+            const { name } = remoteInfo;
+            const prefetchOptions = {
+                name,
+                remote: remoteInfo,
+                origin,
+                remoteSnapshot: snapshot
+            };
+            const signal = getSignalFromManifest(snapshot);
+            if (!signal) {
+                return options;
+            }
+            if (sharedFlag !== SHARED_STRATEGY) {
+                throw new Error(`[Module Federation Data Prefetch]: If you want to use data prefetch, the shared strategy must be 'loaded-first'`);
+            }
+            const instance = MFDataPrefetch.getInstance(name) || new MFDataPrefetch(prefetchOptions);
+            let prefetchUrl;
+            // @ts-expect-error
+            if (snapshot.prefetchEntry) {
+                // @ts-expect-error
+                prefetchUrl = getResourceUrl(snapshot, snapshot.prefetchEntry);
+            }
+            const exist = loadingArray.find((loading)=>loading.id === id);
+            if (exist) {
+                return options;
+            }
+            const promise = instance.loadEntry(prefetchUrl).then(async ()=>{
+                const projectExports = instance.getProjectExports();
+                if (projectExports instanceof Promise) {
+                    await projectExports;
+                }
+                return Promise.resolve().then(()=>{
+                    const exports = instance.getExposeExports(id);
+                    logger.info(`1. Start Prefetch initContainer: ${id} - ${performance.now()}`);
+                    const result = Object.keys(exports).map((k)=>{
+                        const value = instance.prefetch({
+                            id,
+                            functionId: k
+                        });
+                        const functionId = k;
+                        return {
+                            value,
+                            functionId
+                        };
+                    });
+                    return result;
+                });
+            });
+            loadingArray.push({
+                id,
+                promise
+            });
+            return options;
+        },
+        afterResolve (options) {
+            const { remoteSnapshot, remoteInfo, id, origin } = options;
+            const snapshot = remoteSnapshot;
+            const { name } = remoteInfo;
+            const prefetchOptions = {
+                name,
+                remote: remoteInfo,
+                origin,
+                remoteSnapshot: snapshot
+            };
+            const signal = getSignalFromManifest(snapshot);
+            if (!signal) {
+                return options;
+            }
+            const inited = loadingArray.some((info)=>info.id === id);
+            if (!inited) {
+                return options;
+            }
+            if (sharedFlag !== SHARED_STRATEGY) {
+                throw new Error(`[Module Federation Data Prefetch]: If you want to use data prefetch, the shared strategy must be 'loaded-first'`);
+            }
+            const instance = MFDataPrefetch.getInstance(name) || new MFDataPrefetch(prefetchOptions);
+            let prefetchUrl;
+            // @ts-expect-error
+            if (snapshot.prefetchEntry) {
+                // @ts-expect-error
+                prefetchUrl = getResourceUrl(snapshot, snapshot.prefetchEntry);
+            }
+            const index = loadingArray.findIndex((loading)=>loading.id === id);
+            // clear cache
+            if (index !== -1) {
+                loadingArray.splice(index, 1);
+            }
+            const promise = instance.loadEntry(prefetchUrl).then(async ()=>{
+                const projectExports = instance.getProjectExports();
+                if (projectExports instanceof Promise) {
+                    await projectExports;
+                }
+                return Promise.resolve().then(()=>{
+                    const exports = instance.getExposeExports(id);
+                    logger.info(`1. Start Prefetch afterResolve: ${id} - ${performance.now()}`);
+                    const result = Object.keys(exports).map((k)=>{
+                        const value = instance.prefetch({
+                            id,
+                            functionId: k
+                        });
+                        const functionId = k;
+                        return {
+                            value,
+                            functionId
+                        };
+                    });
+                    return result;
+                });
+            });
+            loadingArray.push({
+                id,
+                promise
+            });
+            return options;
+        },
+        async onLoad (options) {
+            var _loadingArray_find;
+            const { remote, id } = options;
+            const { name } = remote;
+            const promise = (_loadingArray_find = loadingArray.find((loading)=>loading.id === id)) === null || _loadingArray_find === void 0 ? void 0 : _loadingArray_find.promise;
+            if (promise) {
+                const prefetch = await promise;
+                const prefetchValue = prefetch.map((result)=>result.value);
+                await Promise.all(prefetchValue);
+                const instance = MFDataPrefetch.getInstance(name);
+                prefetch.forEach((result)=>{
+                    const { value, functionId } = result;
+                    instance.memorize(id + functionId, value);
+                });
+            }
+            return options;
+        },
+        beforeLoadShare (options) {
+            const shareInfo = options.shareInfo;
+            sharedFlag = (shareInfo === null || shareInfo === void 0 ? void 0 : shareInfo.strategy) || sharedFlag;
+            return options;
+        }
+    });
+/* ESM default export */ const src_plugin = (prefetchPlugin);
+
+export { src_plugin as default, prefetchPlugin };

package/dist/prefetch.cjs

@@ -0,0 +1,197 @@
+"use strict";
+const __rslib_import_meta_url__ = /*#__PURE__*/ (function () {
+  return typeof document === 'undefined'
+    ? new (require('url'.replace('', '')).URL)('file:' + __filename).href
+    : (document.currentScript && document.currentScript.src) ||
+      new URL('main.js', document.baseURI).href;
+})();
+;
+// The require scope
+var __webpack_require__ = {};
+
+/************************************************************************/
+// webpack/runtime/define_property_getters
+(() => {
+__webpack_require__.d = (exports, definition) => {
+	for(var key in definition) {
+        if(__webpack_require__.o(definition, key) && !__webpack_require__.o(exports, key)) {
+            Object.defineProperty(exports, key, { enumerable: true, get: definition[key] });
+        }
+    }
+};
+})();
+// webpack/runtime/has_own_property
+(() => {
+__webpack_require__.o = (obj, prop) => (Object.prototype.hasOwnProperty.call(obj, prop))
+})();
+// webpack/runtime/make_namespace_object
+(() => {
+// define __esModule on exports
+__webpack_require__.r = (exports) => {
+	if(typeof Symbol !== 'undefined' && Symbol.toStringTag) {
+		Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+	}
+	Object.defineProperty(exports, '__esModule', { value: true });
+};
+})();
+/************************************************************************/
+var __webpack_exports__ = {};
+// ESM COMPAT FLAG
+__webpack_require__.r(__webpack_exports__);
+
+// EXPORTS
+__webpack_require__.d(__webpack_exports__, {
+  MFDataPrefetch: () => (/* binding */ MFDataPrefetch)
+});
+
+;// CONCATENATED MODULE: external "@module-federation/runtime"
+const runtime_namespaceObject = require("@module-federation/runtime");
+;// CONCATENATED MODULE: external "@module-federation/sdk"
+const sdk_namespaceObject = require("@module-federation/sdk");
+;// CONCATENATED MODULE: external "./common/runtime-utils.cjs"
+const runtime_utils_cjs_namespaceObject = require("./common/runtime-utils.cjs");
+;// CONCATENATED MODULE: ./src/prefetch.ts
+
+
+
+// @ts-ignore init global variable for test
+const federationGlobal = globalThis;
+federationGlobal.__FEDERATION__ ??= {};
+federationGlobal.__FEDERATION__.__PREFETCH__ ??= {
+    entryLoading: {},
+    instance: new Map(),
+    __PREFETCH_EXPORTS__: {}
+};
+const getFederation = ()=>globalThis.__FEDERATION__;
+class MFDataPrefetch {
+    get global() {
+        return getFederation().__PREFETCH__;
+    }
+    static getInstance(id) {
+        return getFederation().__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] = (0,sdk_namespaceObject.loadScript)(entry, {});
+            }
+            return this.global.entryLoading[uniqueKey];
+        } else {
+            const remoteInfo = (0,runtime_namespaceObject.getRemoteInfo)(remote);
+            const module = origin.moduleCache.get(remoteInfo.name);
+            return (0,runtime_namespaceObject.getRemoteEntry)({
+                origin: origin,
+                remoteInfo,
+                remoteEntryExports: module ? module.remoteEntryExports : undefined
+            });
+        }
+    }
+    getProjectExports() {
+        var _getFederation___PREFETCH_____PREFETCH_EXPORTS__;
+        if (Object.keys(this._exports).length > 0) {
+            return this._exports;
+        }
+        const { name } = this._options;
+        const exportsPromiseFn = (_getFederation___PREFETCH_____PREFETCH_EXPORTS__ = getFederation().__PREFETCH__.__PREFETCH_EXPORTS__) === null || _getFederation___PREFETCH_____PREFETCH_EXPORTS__ === void 0 ? void 0 : _getFederation___PREFETCH_____PREFETCH_EXPORTS__[name];
+        const exportsPromise = typeof exportsPromiseFn === 'function' ? exportsPromiseFn() : exportsPromiseFn;
+        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 = (0,runtime_utils_cjs_namespaceObject.getPrefetchId)(id);
+        const compatId = (0,runtime_utils_cjs_namespaceObject.compatGetPrefetchId)(id);
+        const prefetchExports = this._exports[prefetchId] || this._exports[compatId];
+        return prefetchExports || {};
+    }
+    prefetch(prefetchOptions) {
+        const { id, functionId = 'default', refetchParams } = prefetchOptions;
+        let prefetchResult;
+        const prefetchId = (0,runtime_utils_cjs_namespaceObject.getPrefetchId)(id);
+        const compatId = (0,runtime_utils_cjs_namespaceObject.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);
+    }
+}
+
+exports.MFDataPrefetch = __webpack_exports__.MFDataPrefetch;
+for(var __webpack_i__ in __webpack_exports__) {
+  if(["MFDataPrefetch"].indexOf(__webpack_i__) === -1) {
+    exports[__webpack_i__] = __webpack_exports__[__webpack_i__];
+  }
+}
+Object.defineProperty(exports, '__esModule', { value: true });

package/dist/prefetch.d.ts

@@ -0,0 +1,42 @@
+import { ModuleFederation } from '@module-federation/runtime';
+import { ModuleInfo } from '@module-federation/sdk';
+import { Remote } from '@module-federation/runtime/types';
+import type { Federation } from '@module-federation/runtime';
+interface FederationWithPrefetch extends Federation {
+    __PREFETCH__: {
+        entryLoading: Record<string, undefined | Promise<void>>;
+        instance: Map<string, MFDataPrefetch>;
+        __PREFETCH_EXPORTS__: Record<string, () => Promise<Record<string, any>>>;
+    };
+}
+type PrefetchExports = Record<string, any>;
+export interface DataPrefetchOptions {
+    name: string;
+    remote?: Remote;
+    origin?: ModuleFederation;
+    remoteSnapshot?: ModuleInfo;
+}
+export interface prefetchOptions {
+    id: string;
+    functionId?: string;
+    cacheStrategy?: () => boolean;
+    refetchParams?: any;
+}
+export declare class MFDataPrefetch {
+    prefetchMemory: Map<string, Promise<any>>;
+    recordOutdate: Record<string, Record<string, boolean>>;
+    private _exports;
+    private _options;
+    constructor(options: DataPrefetchOptions);
+    get global(): FederationWithPrefetch['__PREFETCH__'];
+    static getInstance(id: string): MFDataPrefetch | undefined;
+    loadEntry(entry: string | undefined): Promise<any>;
+    getProjectExports(): Promise<void> | Record<string, any>;
+    memorizeExports(exports: Record<string, any>): void;
+    getExposeExports(id: string): PrefetchExports;
+    prefetch(prefetchOptions: prefetchOptions): any;
+    memorize(id: string, value: any): void;
+    markOutdate(markOptions: Omit<prefetchOptions, 'cacheStrategy'>, isOutdate: boolean): void;
+    checkOutdate(outdateOptions: prefetchOptions): boolean;
+}
+export {};

package/dist/prefetch.js

@@ -0,0 +1,149 @@
+import { getRemoteEntry, getRemoteInfo } from "@module-federation/runtime";
+import { loadScript } from "@module-federation/sdk";
+import { compatGetPrefetchId, getPrefetchId } from "./common/runtime-utils.js";
+
+;// CONCATENATED MODULE: external "@module-federation/runtime"
+
+;// CONCATENATED MODULE: external "@module-federation/sdk"
+
+;// CONCATENATED MODULE: external "./common/runtime-utils.js"
+
+;// CONCATENATED MODULE: ./src/prefetch.ts
+
+
+
+// @ts-ignore init global variable for test
+const federationGlobal = globalThis;
+federationGlobal.__FEDERATION__ ??= {};
+federationGlobal.__FEDERATION__.__PREFETCH__ ??= {
+    entryLoading: {},
+    instance: new Map(),
+    __PREFETCH_EXPORTS__: {}
+};
+const getFederation = ()=>globalThis.__FEDERATION__;
+class MFDataPrefetch {
+    get global() {
+        return getFederation().__PREFETCH__;
+    }
+    static getInstance(id) {
+        return getFederation().__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 _getFederation___PREFETCH_____PREFETCH_EXPORTS__;
+        if (Object.keys(this._exports).length > 0) {
+            return this._exports;
+        }
+        const { name } = this._options;
+        const exportsPromiseFn = (_getFederation___PREFETCH_____PREFETCH_EXPORTS__ = getFederation().__PREFETCH__.__PREFETCH_EXPORTS__) === null || _getFederation___PREFETCH_____PREFETCH_EXPORTS__ === void 0 ? void 0 : _getFederation___PREFETCH_____PREFETCH_EXPORTS__[name];
+        const exportsPromise = typeof exportsPromiseFn === 'function' ? exportsPromiseFn() : exportsPromiseFn;
+        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 };