@module-federation/data-prefetch 0.0.0-next-20241231075249 → 0.0.0-next-20250106035038

package/jest.config.js

@@ -1,29 +0,0 @@
-// For a detailed explanation regarding each configuration property, visit:
-// https://jestjs.io/docs/en/configuration.html
-
-module.exports = {
-  clearMocks: true,
-  cacheDirectory: './jest/cache',
-  coverageDirectory: './jest/coverage',
-  testEnvironment: 'jsdom',
-  coveragePathIgnorePatterns: ['__tests__', '/node_modules/'],
-  coverageProvider: 'v8',
-  coverageReporters: ['cobertura', 'clover', 'json', 'lcov', 'text'],
-  globals: {
-    __DEV__: true,
-    __TEST__: true,
-    __BROWSER__: false,
-    __VERSION__: '"unknow"',
-  },
-  preset: 'ts-jest',
-  transformIgnorePatterns: [
-    // Change MODULE_NAME_HERE to your module that isn't being compiled
-    '/node_modules/(?!((@byted/garfish-)|(byted-tea-sdk))).+\\.js$',
-  ],
-  transform: {
-    '^.+\\.(t|j)sx?$': ['@swc/jest', { swcrc: false }],
-  },
-  rootDir: __dirname,
-  testMatch: ['<rootDir>/__tests__/**/*.spec.[jt]s?(x)'],
-  testPathIgnorePatterns: ['/node_modules/'],
-};

package/project.json

@@ -1,64 +0,0 @@
-{
-  "name": "data-prefetch",
-  "$schema": "../../node_modules/nx/schemas/project-schema.json",
-  "sourceRoot": "packages/data-prefetch/src",
-  "projectType": "library",
-  "tags": ["type:pkg"],
-  "targets": {
-    "build": {
-      "executor": "@nx/rollup:rollup",
-      "outputs": ["{options.outputPath}"],
-      "options": {
-        "outputPath": "packages/data-prefetch/dist",
-        "main": "packages/data-prefetch/src/index.ts",
-        "tsConfig": "packages/data-prefetch/tsconfig.lib.json",
-        "assets": [],
-        "project": "packages/data-prefetch/package.json",
-        "rollupConfig": "packages/data-prefetch/rollup.config.js",
-        "compiler": "swc",
-        "format": ["cjs", "esm"],
-        "generatePackageJson": false
-      }
-    },
-    "test": {
-      "executor": "@nx/jest:jest",
-      "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
-      "options": {
-        "jestConfig": "packages/data-prefetch/jest.config.js",
-        "passWithNoTests": true
-      },
-      "configurations": {
-        "ci": {
-          "ci": true,
-          "codeCoverage": true
-        }
-      }
-    },
-    "lint": {
-      "executor": "@nx/eslint:lint",
-      "outputs": ["{options.outputFile}"],
-      "options": {
-        "lintFilePatterns": [
-          "packages/data-prefetch/**/*.ts",
-          "packages/data-prefetch/package.json"
-        ]
-      }
-    },
-    "pre-release": {
-      "executor": "nx:run-commands",
-      "options": {
-        "parallel": false,
-        "commands": [
-          {
-            "command": "nx run data-prefetch:test",
-            "forwardAllArgs": false
-          },
-          {
-            "command": "nx run data-prefetch:build",
-            "forwardAllArgs": false
-          }
-        ]
-      }
-    }
-  }
-}

package/rollup.config.js

@@ -1,63 +0,0 @@
-const copy = require('rollup-plugin-copy');
-
-module.exports = (rollupConfig, _projectOptions) => {
-  rollupConfig.plugins.push(
-    copy({
-      targets: [
-        {
-          src: 'packages/data-prefetch/LICENSE',
-          dest: 'packages/data-prefetch/dist',
-        },
-      ],
-    }),
-  );
-  rollupConfig.input = {
-    index: 'packages/data-prefetch/src/index.ts',
-    react: 'packages/data-prefetch/src/react/index.ts',
-    cli: 'packages/data-prefetch/src/cli/index.ts',
-    babel: 'packages/data-prefetch/src/cli/babel.ts',
-    universal: 'packages/data-prefetch/src/universal/index.ts',
-    plugin: 'packages/data-prefetch/src/plugin.ts',
-  };
-
-  if (Array.isArray(rollupConfig.output)) {
-    rollupConfig.output = rollupConfig.output.map((c) => ({
-      ...c,
-      manualChunks: (id) => {
-        if (id.includes('@swc/helpers')) {
-          return 'polyfills';
-        }
-      },
-      hoistTransitiveImports: false,
-      entryFileNames:
-        c.format === 'esm'
-          ? c.entryFileNames.replace('.js', '.mjs')
-          : c.entryFileNames,
-      chunkFileNames:
-        c.format === 'esm'
-          ? c.chunkFileNames.replace('.js', '.mjs')
-          : c.chunkFileNames,
-    }));
-  } else {
-    rollupConfig.output = {
-      ...rollupConfig.output,
-      manualChunks: (id) => {
-        if (id.includes('@swc/helpers')) {
-          return 'polyfills';
-        }
-      },
-      hoistTransitiveImports: false,
-      entryFileNames:
-        rollupConfig.output.format === 'esm'
-          ? rollupConfig.output.entryFileNames.replace('.js', '.mjs')
-          : rollupConfig.output.entryFileNames,
-      chunkFileNames:
-        rollupConfig.output.format === 'esm'
-          ? rollupConfig.output.chunkFileNames.replace('.js', '.mjs')
-          : rollupConfig.output.chunkFileNames,
-    };
-  }
-
-  // rollupConfig.external = [/@module-federation/];
-  return rollupConfig;
-};

package/src/cli/babel.ts

@@ -1,94 +0,0 @@
-// no used now
-import path from 'path';
-import type { moduleFederationPlugin } from '@module-federation/sdk';
-
-const attribute = 'id';
-const hookId = 'usePrefetch';
-const importPackage = '@module-federation/data-prefetch/react';
-
-interface BabelPluginOptions {
-  hook_id: string;
-  import_pkg: string;
-  attribute: string;
-  name: string;
-  exposes: moduleFederationPlugin.ModuleFederationPluginOptions['exposes'];
-}
-
-// biome-ignore lint/suspicious/noExplicitAny: <explanation>
-export default (babel: { types: any }, options: BabelPluginOptions) => {
-  const t = babel.types;
-  let shouldHandle = false;
-  let scope = '';
-  const { name, exposes } = options;
-  if (!exposes) {
-    return {};
-  }
-  const exposesKey = Object.keys(exposes);
-  const processedExposes = exposesKey.map((expose) => ({
-    key: expose.replace('.', ''),
-    value: path.resolve(
-      // @ts-ignore
-      typeof exposes[expose] === 'string'
-        ? // @ts-ignore
-          exposes[expose]
-        : // @ts-ignore
-          exposes[expose].import,
-    ),
-  }));
-
-  return {
-    visitor: {
-      ImportDeclaration(
-        nodePath: {
-          // biome-ignore lint/suspicious/noExplicitAny: <explanation>
-          node: { source: { value: any }; specifiers: any };
-        },
-        // biome-ignore lint/suspicious/noExplicitAny: <explanation>
-        state: { file: { opts: { filename: any } } },
-      ) {
-        const source = nodePath.node.source.value;
-        const { specifiers } = nodePath.node;
-        const { filename } = state.file.opts;
-
-        if (source === importPackage) {
-          shouldHandle = specifiers.some(
-            (specifier: { imported: { name: string } }) =>
-              specifier.imported &&
-              specifier.imported.name === hookId &&
-              processedExposes.find(
-                // biome-ignore lint/suspicious/noAssignInExpressions: <explanation>
-                (expose) => expose.value === filename && (scope = expose.key),
-              ),
-          );
-        }
-      },
-
-      CallExpression(nodePath: {
-        // biome-ignore lint/suspicious/noExplicitAny: <explanation>
-        node: { callee: any; arguments: string | any[] };
-      }) {
-        if (
-          shouldHandle &&
-          t.isIdentifier(nodePath.node.callee, { name: hookId }) &&
-          nodePath.node.arguments.length > 0
-        ) {
-          const objectExpression = nodePath.node.arguments[0];
-          if (
-            objectExpression &&
-            t.isObjectExpression(objectExpression) &&
-            !objectExpression.properties.find(
-              (p: { key: { name: string } }) => p.key.name === attribute,
-            )
-          ) {
-            objectExpression.properties.push(
-              t.objectProperty(
-                t.identifier(attribute),
-                t.stringLiteral(name + scope),
-              ),
-            );
-          }
-        }
-      },
-    },
-  };
-};

package/src/cli/index.ts

@@ -1,176 +0,0 @@
-import path from 'path';
-import fs from 'fs-extra';
-
-import {
-  encodeName,
-  moduleFederationPlugin,
-  MFPrefetchCommon,
-} from '@module-federation/sdk';
-import { normalizeWebpackPath } from '@module-federation/sdk/normalize-webpack-path';
-import type { Compiler, WebpackPluginInstance } from 'webpack';
-
-import { TEMP_DIR } from '../common/constant';
-import { fileExistsWithCaseSync, fixPrefetchPath } from '../common/node-utils';
-import { getPrefetchId } from '../common/runtime-utils';
-import { SHARED_STRATEGY } from '../constant';
-
-const { RuntimeGlobals, Template } = require(
-  normalizeWebpackPath('webpack'),
-) as typeof import('webpack');
-
-export function getFederationGlobalScope(
-  runtimeGlobals: typeof RuntimeGlobals,
-): string {
-  return `${runtimeGlobals.require || '__webpack_require__'}.federation`;
-}
-
-export class PrefetchPlugin implements WebpackPluginInstance {
-  public options: moduleFederationPlugin.ModuleFederationPluginOptions;
-  private _reWriteExports: string;
-
-  constructor(options: moduleFederationPlugin.ModuleFederationPluginOptions) {
-    this.options = options;
-    this._reWriteExports = '';
-  }
-
-  // eslint-disable-next-line max-lines-per-function
-  apply(compiler: Compiler) {
-    const { name, exposes } = this.options;
-    if (!exposes) {
-      return;
-    }
-    if (!compiler.options.context) {
-      throw new Error('compiler.options.context is not defined');
-    }
-
-    const { runtimePlugins } = this.options;
-    if (!Array.isArray(runtimePlugins)) {
-      this.options.runtimePlugins = [];
-    }
-
-    const runtimePath = path.resolve(__dirname, './plugin.esm.mjs');
-    if (!this.options.runtimePlugins?.includes(runtimePath)) {
-      this.options.runtimePlugins!.push(runtimePath);
-    }
-    if (this.options.shareStrategy !== SHARED_STRATEGY) {
-      this.options.shareStrategy = SHARED_STRATEGY;
-      console.warn(
-        `[Module Federation Data Prefetch]: Your shared strategy is set to '${SHARED_STRATEGY}', this is a necessary condition for data prefetch`,
-      );
-    }
-
-    const encodedName = encodeName(name as string);
-    const asyncEntryPath = path.resolve(
-      compiler.options.context,
-      `node_modules/${TEMP_DIR}/${encodedName}/bootstrap.js`,
-    );
-    if (fs.existsSync(asyncEntryPath)) {
-      fs.unlinkSync(asyncEntryPath);
-    }
-    if (!this.options.dataPrefetch) {
-      return;
-    }
-
-    const prefetchs: Array<string> = [];
-    const exposeAlias = Object.keys(exposes);
-    exposeAlias.forEach((alias) => {
-      let exposePath;
-      // @ts-ignore
-      const exposeValue = exposes[alias];
-      if (typeof exposeValue === 'string') {
-        exposePath = exposeValue;
-      } else {
-        exposePath = exposeValue.import[0];
-      }
-      const targetPaths = fixPrefetchPath(exposePath);
-      for (const pathItem of targetPaths) {
-        const absolutePath = path.resolve(compiler.options.context!, pathItem);
-        if (fileExistsWithCaseSync(absolutePath)) {
-          prefetchs.push(pathItem);
-          const absoluteAlias = alias.replace('.', '');
-          this._reWriteExports += `export * as ${getPrefetchId(
-            `${name}${absoluteAlias}`,
-          )} from '${absolutePath}';\n`;
-          break;
-        }
-      }
-    });
-
-    if (!this._reWriteExports) {
-      return;
-    }
-    const tempDirRealPath = path.resolve(
-      compiler.options.context,
-      'node_modules',
-      TEMP_DIR,
-    );
-    if (!fs.existsSync(tempDirRealPath)) {
-      fs.mkdirSync(tempDirRealPath);
-    }
-    if (!fs.existsSync(`${tempDirRealPath}/${encodedName}`)) {
-      fs.mkdirSync(`${tempDirRealPath}/${encodedName}`);
-    }
-    fs.writeFileSync(asyncEntryPath, this._reWriteExports);
-    new compiler.webpack.DefinePlugin({
-      FederationDataPrefetch: JSON.stringify(asyncEntryPath),
-    }).apply(compiler);
-  }
-
-  static addRuntime(
-    compiler: Compiler,
-    options: {
-      name: string;
-    },
-  ) {
-    const encodedName = encodeName(options.name as string);
-    if (!compiler.options.context) {
-      throw new Error('compiler.options.context is not defined');
-    }
-    const prefetchEntry = path.resolve(
-      compiler.options.context,
-      `node_modules/.mf/${encodedName}/bootstrap.js`,
-    );
-    const federationGlobal = getFederationGlobalScope(
-      RuntimeGlobals || ({} as typeof RuntimeGlobals),
-    );
-
-    return Template.asString([
-      fs.existsSync(prefetchEntry)
-        ? Template.indent([
-            'function injectPrefetch() {',
-            Template.indent([
-              `globalThis.__FEDERATION__ = globalThis.__FEDERATION__ || {};`,
-              `globalThis.__FEDERATION__['${MFPrefetchCommon.globalKey}'] = globalThis.__FEDERATION__['${MFPrefetchCommon.globalKey}'] || {`,
-              `entryLoading: {},`,
-              `instance: new Map(),`,
-              `__PREFETCH_EXPORTS__: {},`,
-              `};`,
-              `globalThis.__FEDERATION__['${MFPrefetchCommon.globalKey}']['${MFPrefetchCommon.exportsKey}'] = globalThis.__FEDERATION__['${MFPrefetchCommon.globalKey}']['${MFPrefetchCommon.exportsKey}'] || {};`,
-              `globalThis.__FEDERATION__['${MFPrefetchCommon.globalKey}']['${MFPrefetchCommon.exportsKey}']['${options.name}'] = function(){ return import('${prefetchEntry}');}`,
-            ]),
-            '}',
-            `${federationGlobal}.prefetch = injectPrefetch`,
-          ])
-        : '',
-      Template.indent([
-        `if(!${federationGlobal}.isMFRemote && ${federationGlobal}.prefetch){`,
-        `${federationGlobal}.prefetch()`,
-        '}',
-      ]),
-    ]);
-  }
-
-  static setRemoteIdentifier() {
-    const federationGlobal = getFederationGlobalScope(
-      RuntimeGlobals || ({} as typeof RuntimeGlobals),
-    );
-    return Template.indent([`${federationGlobal}.isMFRemote = true;`]);
-  }
-
-  static removeRemoteIdentifier() {
-    const federationGlobal = getFederationGlobalScope(
-      RuntimeGlobals || ({} as typeof RuntimeGlobals),
-    );
-    return Template.indent([`${federationGlobal}.isMFRemote = false;`]);
-  }
-}

package/src/common/constant.ts

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

package/src/common/index.ts

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

package/src/common/node-utils.ts

@@ -1,24 +0,0 @@
-import path from 'path';
-import fs from 'fs-extra';
-
-export const fileExistsWithCaseSync = (filepath: string): boolean => {
-  const dir = path.dirname(filepath);
-  if (filepath === '/' || filepath === '.') {
-    return true;
-  }
-  const filenames = fs.readdirSync(dir);
-  if (filenames.indexOf(path.basename(filepath)) === -1) {
-    return false;
-  }
-  return fileExistsWithCaseSync(dir);
-};
-
-export const fixPrefetchPath = (exposePath: string): Array<string> => {
-  const pathExt = ['.js', '.ts'];
-  const extReg = /\.(ts|js|tsx|jsx)$/;
-  if (extReg.test(exposePath)) {
-    return pathExt.map((ext) => exposePath.replace(extReg, `.prefetch${ext}`));
-  } else {
-    return pathExt.map((ext) => exposePath + `.prefetch${ext}`);
-  }
-};

package/src/common/runtime-utils.ts

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

package/src/constant.ts

@@ -1 +0,0 @@
-export const SHARED_STRATEGY = 'loaded-first';

package/src/index.ts

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

package/src/logger/index.ts

@@ -1,5 +0,0 @@
-import { createLogger } from '@module-federation/sdk';
-
-const logger = createLogger('[ Module Federation Data Prefetch ]');
-
-export default logger;

package/src/plugin.ts

@@ -1,191 +0,0 @@
-import type { FederationRuntimePlugin } from '@module-federation/runtime/types';
-import { ModuleInfo, getResourceUrl } from '@module-federation/sdk';
-
-import { getSignalFromManifest } from './common/runtime-utils';
-import { MFDataPrefetch } from './prefetch';
-import logger from './logger';
-import { SHARED_STRATEGY } from './constant';
-
-interface Loading {
-  id: string;
-  promise: Promise<
-    Array<{
-      value: any;
-      functionId: string;
-    }>
-  >;
-}
-const loadingArray: Array<Loading> = [];
-let sharedFlag = SHARED_STRATEGY;
-// eslint-disable-next-line max-lines-per-function
-export const prefetchPlugin = (): FederationRuntimePlugin => ({
-  name: 'data-prefetch-runtime-plugin',
-  initContainer(options) {
-    const { remoteSnapshot, remoteInfo, id, origin } = options;
-    const snapshot = remoteSnapshot as ModuleInfo;
-    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 as string);
-    }
-
-    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 as ModuleInfo;
-    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 as string);
-    }
-
-    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) {
-    const { remote, id } = options;
-    const { name } = remote;
-    const promise = loadingArray.find((loading) => loading.id === id)?.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: { value: any; functionId: string }) => {
-        const { value, functionId } = result;
-        instance!.memorize(id + functionId, value);
-      });
-    }
-    return options;
-  },
-
-  beforeLoadShare(options) {
-    const shareInfo = options.shareInfo;
-    sharedFlag = shareInfo?.strategy || sharedFlag;
-    return options;
-  },
-});
-
-export default prefetchPlugin;