fix: bff test case (#7653)

Author: caohuilin

packages/cli/builder/src/index.ts

@@ -6,6 +6,7 @@ export type { CreateBuilderOptions, BuilderInstance };
 export type {
   BuilderConfig,
   BundlerType,
+  ToolsDevServerConfig,
   MetaOptions,
   Stats,
   MultiStats,

packages/cli/plugin-bff/package.json

@@ -85,6 +85,7 @@
     "@modern-js/create-request": "workspace:*",
     "@modern-js/server-core": "workspace:*",
     "@modern-js/server-utils": "workspace:*",
+    "@modern-js/builder": "workspace:*",
     "@modern-js/utils": "workspace:*",
     "@swc/helpers": "^0.5.17",
     "type-is": "^1.6.18"

packages/cli/plugin-bff/src/cli.ts

@@ -2,6 +2,7 @@ import type { IncomingMessage } from 'http';
 import path from 'path';
 import type { AppTools, CliPlugin } from '@modern-js/app-tools';
 import { ApiRouter } from '@modern-js/bff-core';
+import type { ToolsDevServerConfig } from '@modern-js/builder';
 import { compile } from '@modern-js/server-utils';
 import type { ServerRoute } from '@modern-js/types';
 import {
@@ -144,6 +145,33 @@ export const bffPlugin = (): CliPlugin<AppTools> => ({
       return bffRuntimeFramework === 'hono';
     };
 
+    const createCompressConfig = (
+      devServer: ToolsDevServerConfig | undefined,
+      prefix: string,
+    ) => {
+      if (
+        !devServer ||
+        typeof devServer !== 'object' ||
+        Array.isArray(devServer)
+      ) {
+        return undefined;
+      }
+
+      const { compress } = devServer;
+
+      if (compress === undefined || compress === true) {
+        return {
+          filter: (req: IncomingMessage) => !req.url?.includes(prefix),
+        };
+      }
+
+      if (compress === false) {
+        return false;
+      }
+
+      return compress;
+    };
+
     api.config(async () => {
       const honoRuntimePath = isHono()
         ? { [RUNTIME_HONO]: RUNTIME_HONO }
@@ -152,23 +180,13 @@ export const bffPlugin = (): CliPlugin<AppTools> => ({
       const devServer = api.getConfig()?.tools?.devServer;
       const prefix = api.getConfig()?.bff?.prefix || DEFAULT_API_PREFIX;
 
-      if (
-        typeof devServer === 'object' &&
-        devServer !== null &&
-        !Array.isArray(devServer)
-      ) {
-        const compress = devServer.compress;
-        if (typeof compress === 'undefined' || compress === true) {
-          devServer.compress = {
-            filter: (req: IncomingMessage) => {
-              return !req.url?.includes(prefix);
-            },
-          };
-        }
-      }
+      const compress = createCompressConfig(devServer, prefix);
 
       return {
         tools: {
+          devServer: {
+            compress,
+          },
           bundlerChain: (chain, { CHAIN_ID, isServer }) => {
             const { port, appDirectory, apiDirectory, lambdaDirectory } =
               api.getAppContext();

packages/cli/plugin-bff/src/utils/crossProjectApiPlugin.ts

@@ -13,7 +13,7 @@ export const crossProjectApiPlugin = (): CliPlugin<AppTools> => ({
   name: '@modern-js/plugin-independent-bff',
   post: ['@modern-js/plugin-bff'],
   setup: api => {
-    api.config(async () => {
+    api.modifyResolvedConfig(resolvedConfig => {
       const { appDirectory: originAppDirectory } = api.getAppContext();
 
       const sdkPath = path.join(originAppDirectory, NODE_MODULES, PACKAGE_NAME);
@@ -22,19 +22,20 @@ export const crossProjectApiPlugin = (): CliPlugin<AppTools> => ({
       const apiDirectory = path.join(sdkDistPath, API_DIR);
       const lambdaDirectory = path.resolve(sdkDistPath, LAMBDA_DIR);
 
-      const appContext = api.getAppContext();
-
       api.updateAppContext({
-        ...appContext,
         apiDirectory,
         lambdaDirectory,
       });
-      return {
-        bff: {
-          prefix: PREFIX,
-          isCrossProjectServer: true,
-        },
-      };
+      const config = api.getConfig();
+      if (config?.bff?.prefix) {
+        console.warn(
+          `[WARNING] Detected bff.prefix configuration: "${config.bff.prefix}".
+When using cross-project BFF, you should not configure bff.prefix as it may cause API path conflicts or access issues. Please remove the bff.prefix configuration.`,
+        );
+      }
+      resolvedConfig.bff.prefix = PREFIX;
+      (resolvedConfig.bff as any).isCrossProjectServer = true;
+      return resolvedConfig;
     });
   },
 });

pnpm-lock.yaml

@@ -7,7 +7,7 @@ export default applyBaseConfig({
     prefix: '/api-app',
     crossProject: true,
   },
-  plugins: [expressPlugin(), bffPlugin()],
+  plugins: [expressPlugin() as any, bffPlugin()],
   server: {
     port: 3399,
   },

tests/integration/bff-corss-project/bff-api-app/modern.config.ts

@@ -4,12 +4,9 @@ import { crossProjectApiPlugin } from 'bff-api-app/plugin';
 import { applyBaseConfig } from '../../../utils/applyBaseConfig';
 
 export default applyBaseConfig({
-  bff: {
-    prefix: '/web-app',
-  },
   server: {
     ssr: false,
     port: 3401,
   },
-  plugins: [bffPlugin(), expressPlugin(), crossProjectApiPlugin()],
+  plugins: [bffPlugin(), expressPlugin() as any, crossProjectApiPlugin()],
 });

tests/integration/bff-corss-project/bff-client-app/modern.config.ts

@@ -3,11 +3,8 @@ import { expressPlugin } from '@modern-js/plugin-express';
 import { applyBaseConfig } from '../../../utils/applyBaseConfig';
 
 export default applyBaseConfig({
-  bff: {
-    prefix: '/indep-web-app',
-  },
   server: {
     ssr: false,
   },
-  plugins: [bffPlugin(), expressPlugin()],
+  plugins: [bffPlugin(), expressPlugin() as any],
 });