fix(enhanced): support get public path (#2638)

Co-authored-by: ScriptedAlchemy <[email protected]>

Author: ScriptedAlchemy

.changeset/cold-rocks-listen.md

@@ -0,0 +1,8 @@
+---
+'@module-federation/dts-plugin': patch
+'@module-federation/enhanced': patch
+'@module-federation/manifest': patch
+'@module-federation/sdk': patch
+---
+
+Support getPublicPath in compiler plugins

.github/workflows/build-and-test.yml

@@ -37,14 +37,17 @@ jobs:
       - name: Check Code Format
         run: npx nx format:check
 
-      - name: Run Affected Build
-        run: npx nx run-many --targets=build --projects=tag:type:pkg  --skip-nx-cache
+      - name: Update NX Build Cache
+        run: npx nx run-many --targets=build --exclude='*,!tag:type:pkg'
+
+      - name: Run Build for All
+        run: npx nx run-many --targets=build --exclude='*,!tag:type:pkg' --skip-nx-cache
 
       - name: Run Affected Lint
         run: npx nx affected -t lint --parallel=7 --exclude='*,!tag:type:pkg'
 
       - name: Run Affected Test
-        run: npx nx run-many -t test --parallel=3 --exclude='*,!tag:type:pkg' --skip-nx-cache
+        run: npx nx affected -t test --parallel=2 --exclude='*,!tag:type:pkg' --skip-nx-cache
 
       # - name: E2E Test for Next.js Dev
       #   run: |

.gitignore

@@ -58,3 +58,5 @@ packages/enhanced/test/js
 **/.mf
 **/.mf/**
 
+/apps/manifest-demo/**/@mf-types/
+/apps/manifest-demo/3008-webpack-host/@mf-types/

apps/runtime-demo/3005-runtime-host/@mf-types/index.d.ts

@@ -1,21 +1,25 @@
-import type { PackageType as PackageType_0,RemoteKeys as RemoteKeys_0 } from './remote1/apis.d.ts';
+import type { PackageType as PackageType_0,RemoteKeys as RemoteKeys_0 } from './dynamic-remote/apis.d.ts';
+import type { PackageType as PackageType_1,RemoteKeys as RemoteKeys_1 } from './remote1/apis.d.ts';
     declare module "@module-federation/runtime" {
-      type RemoteKeys = RemoteKeys_0;
+      type RemoteKeys = RemoteKeys_0 | RemoteKeys_1;
       type PackageType<T, Y=any> = T extends RemoteKeys_0 ? PackageType_0<T> :
+T extends RemoteKeys_1 ? PackageType_1<T> :
 Y ;
       export function loadRemote<T extends RemoteKeys,Y>(packageName: T): Promise<PackageType<T, Y>>;
       export function loadRemote<T extends string,Y>(packageName: T): Promise<PackageType<T, Y>>;
     }
 declare module "@module-federation/enhanced/runtime" {
-      type RemoteKeys = RemoteKeys_0;
+      type RemoteKeys = RemoteKeys_0 | RemoteKeys_1;
       type PackageType<T, Y=any> = T extends RemoteKeys_0 ? PackageType_0<T> :
+T extends RemoteKeys_1 ? PackageType_1<T> :
 Y ;
       export function loadRemote<T extends RemoteKeys,Y>(packageName: T): Promise<PackageType<T, Y>>;
       export function loadRemote<T extends string,Y>(packageName: T): Promise<PackageType<T, Y>>;
     }
 declare module "@module-federation/runtime-tools" {
-      type RemoteKeys = RemoteKeys_0;
+      type RemoteKeys = RemoteKeys_0 | RemoteKeys_1;
       type PackageType<T, Y=any> = T extends RemoteKeys_0 ? PackageType_0<T> :
+T extends RemoteKeys_1 ? PackageType_1<T> :
 Y ;
       export function loadRemote<T extends RemoteKeys,Y>(packageName: T): Promise<PackageType<T, Y>>;
       export function loadRemote<T extends string,Y>(packageName: T): Promise<PackageType<T, Y>>;

apps/runtime-demo/3005-runtime-host/package.json

@@ -7,6 +7,7 @@
     "@module-federation/runtime": "workspace:*",
     "@module-federation/typescript": "workspace:*",
     "@module-federation/enhanced": "workspace:*",
+    "@module-federation/dts-plugin": "workspace:*",
     "@pmmmwh/react-refresh-webpack-plugin": "0.5.11",
     "react-refresh": "0.14.0"
   },

apps/runtime-demo/3005-runtime-host/project.json

@@ -99,6 +99,12 @@
         "baseUrl": "http://127.0.0.1:3005",
         "browser": "chrome"
       },
+      "dependsOn": [
+        {
+          "target": "build",
+          "dependencies": true
+        }
+      ],
       "configurations": {
         "development": {
           "runnerUi": true,

apps/website-new/docs/en/configure/getpublicpath.mdx

@@ -22,7 +22,7 @@ module.exports = {
         './Button': './src/components/Button.tsx',
       },
       // ...
-      getPublicPath: `function(currentPath) {return "https:" + window.navigator.cdn_host + "/resource/app/"}`,
+      getPublicPath: `function() {return "https:" + window.navigator.cdn_host + "/resource/app/"}`,
     }),
   ],
 };

package.json

@@ -25,7 +25,7 @@
     "lint": "nx run-many --target=lint",
     "test": "nx run-many --target=test",
     "build": "nx run-many --target=build --parallel=3  --projects=tag:type:pkg",
-    "build:pkg": "nx run-many --targets=build --projects=tag:type:pkg",
+    "build:pkg": "nx run-many --targets=build --projects=tag:type:pkg --skip-nx-cache",
     "lint-fix": "nx format:write --uncommitted",
     "trigger-release": "node -e 'import(\"open\").then(open => open.default(\"https://github.com/module-federation/core/actions/workflows/trigger-release.yml\"))'",
     "serve:next": "nx run-many --target=serve --all --parallel=3 -exclude='*,!tag:nextjs'",

packages/dts-plugin/src/core/lib/DTSManager.ts

@@ -201,10 +201,20 @@ class DTSManager {
         return u;
       };
 
-      let publicPath =
-        'publicPath' in manifestJson.metaData
-          ? manifestJson.metaData.publicPath
-          : new Function(manifestJson.metaData.getPublicPath)();
+      let publicPath;
+
+      if ('publicPath' in manifestJson.metaData) {
+        publicPath = manifestJson.metaData.publicPath;
+      } else {
+        const getPublicPath = new Function(manifestJson.metaData.getPublicPath);
+
+        if (manifestJson.metaData.getPublicPath.startsWith('function')) {
+          publicPath = getPublicPath()();
+        } else {
+          publicPath = getPublicPath();
+        }
+      }
+
       if (publicPath === 'auto') {
         publicPath = inferAutoPublicPath(remoteInfo.url);
       }

packages/dts-plugin/src/core/lib/DtsWorker.spec.ts

@@ -194,6 +194,9 @@ describe('generateTypesInChildProcess', () => {
         },
       ],
     });
+    await new Promise((res) => {
+      setTimeout(res, 1000);
+    });
     // the child process should be killed after generateTypes
     expect(checkProcess()).toEqual(false);
   });