feat(sdk): auto public path support for json remote (#2463)

ScriptedAlchemy · 2heal1 · web-flow · commit 2e52e516a8e4 · 2024-05-09T21:43:51.000-07:00
Co-authored-by: ScriptedAlchemy &lt;zackaryjackson@bytedance.com&gt;
Co-authored-by: 2heal1 &lt;TwoHeal@163.com&gt;
diff --git a/.changeset/chatty-lies-rush.md b/.changeset/chatty-lies-rush.md
@@ -0,0 +1,5 @@
+---
+'@module-federation/dts-plugin': patch
+---
+
+Build zip url for json ext as well
diff --git a/.changeset/dull-pumas-bow.md b/.changeset/dull-pumas-bow.md
@@ -0,0 +1,5 @@
+---
+'@module-federation/managers': patch
+---
+
+If library.name is not set, fallback to plugin name
diff --git a/.changeset/young-apricots-rule.md b/.changeset/young-apricots-rule.md
@@ -0,0 +1,6 @@
+---
+'@module-federation/manifest': patch
+'@module-federation/sdk': patch
+---
+
+publicPath: auto support for json manifest remote
diff --git a/.cursorignore b/.cursorignore
@@ -0,0 +1,10 @@
+# Add directories or file patterns to ignore during indexing (e.g. foo/ or *.csv)
+./tmp
+./scripts
+./.git
+./packages/storybook-addon
+./packages/core
+./packages/utilities
+./packages/typescript
+./packages/native-*
+./apps
diff --git a/.gitignore b/.gitignore
@@ -5,7 +5,7 @@
 /tmp
 /out-tsc
 /build
-/@mf-types
+**/@mf-types
 **/@mf-types/**
 /docs
 /.nx
diff --git a/apps/manifest-demo/3009-webpack-provider/project.json b/apps/manifest-demo/3009-webpack-provider/project.json
@@ -51,6 +51,12 @@
         "hmr": true,
         "port": 3009
       },
+      "dependsOn": [
+        {
+          "target": "build",
+          "dependencies": true
+        }
+      ],
       "configurations": {
         "development": {
           "buildTarget": "3009-webpack-provider:build:development"
diff --git a/apps/manifest-demo/3009-webpack-provider/webpack.config.js b/apps/manifest-demo/3009-webpack-provider/webpack.config.js
@@ -16,7 +16,7 @@ module.exports = composePlugins(
       ignored: ['**/node_modules/**', '**/@mf-types/**'],
     };
     // publicPath must be specific url
-    config.output.publicPath = 'http://localhost:3009/';
+    config.output.publicPath = 'auto';
     config.plugins.push(
       new ModuleFederationPlugin({
         name: 'webpack_provider',
diff --git a/apps/manifest-demo/3010-rspack-provider/project.json b/apps/manifest-demo/3010-rspack-provider/project.json
@@ -31,6 +31,12 @@
         "buildTarget": "3010-rspack-provider:build",
         "port": 3010
       },
+      "dependsOn": [
+        {
+          "target": "build",
+          "dependencies": true
+        }
+      ],
       "configurations": {
         "development": {
           "buildTarget": "3010-rspack-provider:build:development",
diff --git a/apps/manifest-demo/3011-rspack-manifest-provider/project.json b/apps/manifest-demo/3011-rspack-manifest-provider/project.json
@@ -31,6 +31,12 @@
         "buildTarget": "3011-rspack-manifest-provider:build",
         "port": 3011
       },
+      "dependsOn": [
+        {
+          "target": "build",
+          "dependencies": true
+        }
+      ],
       "configurations": {
         "development": {
           "buildTarget": "3011-rspack-manifest-provider:build:development",
diff --git a/apps/manifest-demo/3012-rspack-js-entry-provider/project.json b/apps/manifest-demo/3012-rspack-js-entry-provider/project.json
@@ -31,6 +31,12 @@
         "buildTarget": "3012-rspack-js-entry-provider:build",
         "port": 3012
       },
+      "dependsOn": [
+        {
+          "target": "build",
+          "dependencies": true
+        }
+      ],
       "configurations": {
         "development": {
           "buildTarget": "3012-rspack-js-entry-provider:build:development",
diff --git a/apps/node-remote/webpack.config.js b/apps/node-remote/webpack.config.js
@@ -22,7 +22,7 @@ module.exports = composePlugins(withNx(), (config) => {
         require.resolve('@module-federation/node/runtimePlugin'),
       ],
       name: 'node_remote',
-      library: { type: 'commonjs-module' },
+      library: { type: 'commonjs-module', name: 'node_remote' },
       filename: 'remoteEntry.js',
       exposes: {
         './test': './src/expose.js',
diff --git a/apps/website-new/docs/en/guide/basic/webpack.mdx b/apps/website-new/docs/en/guide/basic/webpack.mdx
@@ -27,15 +27,18 @@ import { PackageManagerTabs } from '@theme';
 
 In `Webpack`, you can add the plugin through the `plugins` configuration item in the `webpack.config.js` file:
 
+:::warning Public Path Auto & Manifest
+When using mf-manifest.json remotes `publicPath: 'auto'` support is experimental
+:::
+
 ```ts title='webpack.config.js'
 import { ModuleFederationPlugin } from '@module-federation/enhanced/webpack';
 module.exports = {
   devServer: {
     port: 2000,
   },
   output: {
-    // publicPath must be configured if using manifest
-    publicPath: 'http://localhost:2000/',
+    publicPath: 'http://localhost:2000/', // or auto
   },
   plugins: [
     new ModuleFederationPlugin({
diff --git a/apps/website-new/docs/zh/guide/basic/webpack.mdx b/apps/website-new/docs/zh/guide/basic/webpack.mdx
@@ -27,6 +27,10 @@ import { PackageManagerTabs } from '@theme';
 
 在 `Webpack` 中，你可以通过 `webpack.config.js` 配置文件中的 `plugins` 配置项来添加插件：
 
+:::warning 公共路径自动配置与 Manifest
+当使用 mf-manifest.json 远程模块时，`publicPath: 'auto'` 的支持还处于实验阶段
+:::
+
 ```ts title='webpack.config.js'
 import { ModuleFederationPlugin } from '@module-federation/enhanced/webpack';
 module.exports = {
@@ -35,7 +39,7 @@ module.exports = {
   },
   output: {
     // 使用 manifest 必须要配置 publicPath
-    publicPath: 'http://localhost:2000/',
+    publicPath: 'http://localhost:2000/', //or 'auto'
   },
   plugins: [
     new ModuleFederationPlugin({
diff --git a/packages/dts-plugin/src/core/configurations/hostPlugin.ts b/packages/dts-plugin/src/core/configurations/hostPlugin.ts
@@ -17,9 +17,6 @@ const defaultOptions = {
 const buildZipUrl = (hostOptions: Required<HostOptions>, url: string) => {
   const remoteUrl = new URL(url);
 
-  if (remoteUrl.href.includes(MANIFEST_EXT)) {
-    return undefined;
-  }
   const pathnameWithoutEntry = remoteUrl.pathname
     .split('/')
     .slice(0, -1)
@@ -51,6 +48,7 @@ const retrieveRemoteInfo = (options: {
       : parsedInfo.name === remote
       ? remote
       : '';
+
   const zipUrl = url ? buildZipUrl(hostOptions, url) : '';
 
   return {
diff --git a/packages/dts-plugin/src/core/lib/DTSManager.ts b/packages/dts-plugin/src/core/lib/DTSManager.ts
@@ -2,7 +2,11 @@ import ansiColors from 'ansi-colors';
 import path from 'path';
 import { rm } from 'fs/promises';
 import fs from 'fs';
-import { MANIFEST_EXT, Manifest } from '@module-federation/sdk';
+import {
+  MANIFEST_EXT,
+  Manifest,
+  inferAutoPublicPath,
+} from '@module-federation/sdk';
 import cloneDeepWith from 'lodash.clonedeepwith';
 
 import { retrieveRemoteConfig } from '../configurations/remotePlugin';
@@ -22,7 +26,6 @@ import {
   HOST_API_TYPES_FILE_NAME,
 } from '../constant';
 import axios from 'axios';
-import { replaceLocalhost } from './utils';
 import { fileLog } from '../../server';
 
 export const MODULE_DTS_MANAGER_IDENTIFIER = 'MF DTS Manager';
@@ -171,7 +174,7 @@ class DTSManager {
       if (!remoteInfo.url.includes(MANIFEST_EXT)) {
         return remoteInfo as Required<RemoteInfo>;
       }
-      const url = replaceLocalhost(remoteInfo.url);
+      const url = remoteInfo.url;
       const res = await axios({
         method: 'get',
         url,
@@ -186,10 +189,14 @@ class DTSManager {
         }
         return u;
       };
-      const publicPath =
+
+      let publicPath =
         'publicPath' in manifestJson.metaData
           ? manifestJson.metaData.publicPath
           : new Function(manifestJson.metaData.getPublicPath)();
+      if (publicPath === 'auto') {
+        publicPath = inferAutoPublicPath(remoteInfo.url);
+      }
 
       remoteInfo.zipUrl = new URL(
         path.join(addProtocol(publicPath), manifestJson.metaData.types.zip),
@@ -233,7 +240,7 @@ class DTSManager {
       return;
     }
     try {
-      const url = replaceLocalhost(apiTypeUrl);
+      const url = apiTypeUrl;
       const res = await axios.get(url);
       let apiTypeFile = res.data as string;
       apiTypeFile = apiTypeFile.replaceAll(
diff --git a/packages/dts-plugin/src/core/lib/archiveHandler.ts b/packages/dts-plugin/src/core/lib/archiveHandler.ts
@@ -6,7 +6,6 @@ import typescript from 'typescript';
 import { HostOptions } from '../interfaces/HostOptions';
 import { RemoteOptions } from '../interfaces/RemoteOptions';
 import { retrieveMfTypesPath } from './typeScriptCompiler';
-import { replaceLocalhost } from './utils';
 import { fileLog } from '../../server';
 
 export const retrieveTypesZipPath = (
@@ -59,7 +58,7 @@ export const downloadTypesArchive = (hostOptions: Required<HostOptions>) => {
 
     while (retries++ < hostOptions.maxRetries) {
       try {
-        const url = replaceLocalhost(fileToDownload);
+        const url = fileToDownload;
         const response = await axios
           .get(url, { responseType: 'arraybuffer' })
           .catch(downloadErrorLogger(destinationFolder, url));
diff --git a/packages/dts-plugin/src/core/lib/utils.ts b/packages/dts-plugin/src/core/lib/utils.ts
@@ -65,10 +65,6 @@ export function retrieveTypesAssetsInfo(options: RemoteOptions) {
   }
 }
 
-export function replaceLocalhost(url: string): string {
-  return url.replace('localhost', '127.0.0.1');
-}
-
 export function isDebugMode() {
   return Boolean(process.env['FEDERATION_DEBUG']);
 }
diff --git a/packages/managers/__tests__/ContainerManager.spec.ts b/packages/managers/__tests__/ContainerManager.spec.ts
@@ -50,7 +50,9 @@ describe('ContainerManager', () => {
     const containerManager = new ContainerManager();
     containerManager.init(options);
 
-    expect(containerManager.globalEntryName).toEqual(undefined);
+    expect(containerManager.globalEntryName).toEqual(
+      '@module-federation/container-managers-test',
+    );
   });
 
   it('set expose name by default', () => {
diff --git a/packages/managers/src/ContainerManager.ts b/packages/managers/src/ContainerManager.ts
@@ -41,7 +41,7 @@ class ContainerManager extends BasicPluginOptionsManager<moduleFederationPlugin.
       if (typeof library.name === 'string') {
         return library.name;
       }
-      return undefined;
+      return name;
     }
 
     return name;
diff --git a/packages/manifest/src/ManifestManager.ts b/packages/manifest/src/ManifestManager.ts
@@ -126,7 +126,9 @@ class ManifestManager {
 
     if (isDev()) {
       console.log(
-        chalk`{bold {greenBright [ ${PLUGIN_IDENTIFIER} ]} {greenBright Manifest Link:} {cyan ${publicPath}${manifestFileName}}}`,
+        chalk`{bold {greenBright [ ${PLUGIN_IDENTIFIER} ]} {greenBright Manifest Link:} {cyan ${
+          publicPath === 'auto' ? '{auto}/' : publicPath
+        }${manifestFileName}}}`,
       );
     }
   }
diff --git a/packages/manifest/src/StatsManager.ts b/packages/manifest/src/StatsManager.ts
@@ -440,9 +440,9 @@ class StatsManager {
       return false;
     } else if (publicPath === 'auto') {
       console.warn(
-        chalk`{bold {yellow [ ${PLUGIN_IDENTIFIER} ]: Manifest will not generate, because publicPath can only be absolute path, but got '${publicPath}'}}`,
+        chalk`{bold {blue [ ${PLUGIN_IDENTIFIER} ]: Manifest will use absolute path resolution via its host at runtime, reason: publicPath='${publicPath}'}}`,
       );
-      return false;
+      return true;
     }
 
     return true;
diff --git a/packages/node/src/runtimePlugin.ts b/packages/node/src/runtimePlugin.ts
@@ -249,7 +249,7 @@ export default function () {
           }
 
           __webpack_require__.federation.runtime
-            .loadScriptNode(url, { attrs: {} })
+            .loadScriptNode(url, { attrs: { globalName: remoteName } })
             .then(function (res) {
               var federation = __webpack_require__.federation;
               var enhancedRemote = federation.instance.initRawContainer(
diff --git a/packages/sdk/__tests__/inferAutoPublicPath.spec.ts b/packages/sdk/__tests__/inferAutoPublicPath.spec.ts
@@ -0,0 +1,12 @@
+import { inferAutoPublicPath } from '../src';
+
+describe('inferAutoPublicPath', () => {
+  it('should infer correct public path', () => {
+    expect(inferAutoPublicPath('http://localhost:3009/mf-stats.json')).toEqual(
+      'http://localhost:3009/',
+    );
+    expect(inferAutoPublicPath('http://localhost:3009/remoteEntry.js')).toEqual(
+      'http://localhost:3009/',
+    );
+  });
+});
diff --git a/packages/sdk/src/generateSnapshotFromManifest.ts b/packages/sdk/src/generateSnapshotFromManifest.ts
@@ -48,6 +48,13 @@ export const simpleJoinRemoteEntry = (rPath: string, rName: string): string => {
   return `${transformedPath}/${rName}`;
 };
 
+export function inferAutoPublicPath(url: string): string {
+  return url
+    .replace(/#.*$/, '')
+    .replace(/\?.*$/, '')
+    .replace(/\/[^\/]+$/, '/');
+}
+
 // Priority: overrides > remotes
 // eslint-disable-next-line max-lines-per-function
 export function generateSnapshotFromManifest(
@@ -59,6 +66,10 @@ export function generateSnapshotFromManifest(
 
   const getPublicPath = (): string => {
     if ('publicPath' in manifest.metaData) {
+      if (manifest.metaData.publicPath === 'auto' && version) {
+        // use same implementation as publicPath auto runtime module implements
+        return inferAutoPublicPath(version);
+      }
       return manifest.metaData.publicPath;
     } else {
       return manifest.metaData.getPublicPath;
diff --git a/packages/sdk/src/index.ts b/packages/sdk/src/index.ts
@@ -5,6 +5,7 @@ export {
   generateSnapshotFromManifest,
   isManifestProvider,
   simpleJoinRemoteEntry,
+  inferAutoPublicPath,
 } from './generateSnapshotFromManifest';
 export * from './logger';
 export * from './env';

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'@module-federation/dts-plugin': patch
 +---
++
 +Build zip url for json ext as well