fix!: remove output.distPath.server (#2696)

web-infra-dev · Jun 25, 2024 · b13d0aa · b13d0aa
1 parent d918d06
commit b13d0aa
Show file tree

Hide file tree

Showing 21 changed files with 56 additions and 50 deletions.
diff --git a/e2e/cases/babel/preset-node/index.test.ts b/e2e/cases/babel/preset-node/index.test.ts
@@ -9,7 +9,8 @@ rspackOnlyTest(
       runServer: true,
     });
 
-    const { foo } = await import('./dist/server/index.js');
+    // @ts-ignore .js file
+    const { foo } = await import('./dist/index.js');
     expect(foo).toEqual(1);
   },
 );
diff --git a/e2e/cases/node-addons/index.test.ts b/e2e/cases/node-addons/index.test.ts
@@ -13,15 +13,15 @@ test('should compile Node addons correctly', async () => {
     file.endsWith('test.darwin.node'),
   );
 
-  expect(addonFile?.includes('server/test.darwin.node')).toBeTruthy();
+  expect(addonFile?.includes('/test.darwin.node')).toBeTruthy();
 
   expect(
-    fs.existsSync(join(__dirname, 'dist', 'server', 'test.darwin.node')),
+    fs.existsSync(join(__dirname, 'dist', 'test.darwin.node')),
   ).toBeTruthy();
 
   // the `test.darwin.node` is only compatible with darwin
   if (process.platform === 'darwin') {
-    const content = await import('./dist/server/index.js');
+    const content = await import('./dist/index.js');
     expect(typeof (content.default as any).readLength).toEqual('function');
   }
 });
@@ -61,14 +61,12 @@ test('should compile Node addons in the node_modules correctly', async () => {
     file.endsWith('other.node'),
   );
 
-  expect(addonFile?.includes('server/other.node')).toBeTruthy();
+  expect(addonFile?.includes('/other.node')).toBeTruthy();
 
-  expect(
-    fs.existsSync(join(__dirname, 'dist', 'server', 'other.node')),
-  ).toBeTruthy();
+  expect(fs.existsSync(join(__dirname, 'dist', 'other.node'))).toBeTruthy();
 
   if (process.platform === 'darwin') {
-    const content = await import('./dist/server/index.js');
+    const content = await import('./dist/index.js');
     expect(typeof (content.default as any).readLength).toEqual('function');
   }
 });
diff --git a/e2e/cases/output/externals/tests/index.test.ts b/e2e/cases/output/externals/tests/index.test.ts
@@ -1,4 +1,4 @@
-import { join, resolve } from 'node:path';
+import { resolve } from 'node:path';
 import { build, gotoPage } from '@e2e/helper';
 import { expect, test } from '@playwright/test';
 import { pluginReact } from '@rsbuild/plugin-react';

diff --git a/e2e/cases/performance/print-file-size/index.test.ts b/e2e/cases/performance/print-file-size/index.test.ts
@@ -52,6 +52,9 @@ test.describe('should print file size correctly', async () => {
           node: {
             output: {
               target: 'node',
+              distPath: {
+                root: 'dist/server',
+              },
             },
           },
         },

diff --git a/e2e/cases/plugin-api/plugin-transform-by-targets/rsbuild.config.ts b/e2e/cases/plugin-api/plugin-transform-by-targets/rsbuild.config.ts
@@ -11,6 +11,9 @@ export default {
     node: {
       output: {
         target: 'node',
+        distPath: {
+          root: 'dist/server',
+        },
       },
     },
   },

diff --git a/e2e/cases/source/alias-by-target/rsbuild.config.ts b/e2e/cases/source/alias-by-target/rsbuild.config.ts
@@ -23,6 +23,9 @@ export default defineConfig({
       },
       output: {
         target: 'node',
+        distPath: {
+          root: 'dist/server',
+        },
       },
     },
   },

diff --git a/e2e/cases/source/multiple-entry/rsbuild.config.ts b/e2e/cases/source/multiple-entry/rsbuild.config.ts
@@ -27,6 +27,9 @@ export default defineConfig({
     node: {
       output: {
         target: 'node',
+        distPath: {
+          root: 'dist/server',
+        },
       },
     },
   },

diff --git a/packages/compat/webpack/tests/__snapshots__/default.test.ts.snap b/packages/compat/webpack/tests/__snapshots__/default.test.ts.snap
@@ -1038,7 +1038,7 @@ exports[`applyDefaultPlugins > should apply default plugins correctly when targe
     "library": {
       "type": "commonjs2",
     },
-    "path": "<ROOT>/packages/compat/webpack/tests/dist/server",
+    "path": "<ROOT>/packages/compat/webpack/tests/dist",
     "pathinfo": false,
     "publicPath": "/",
     "webassemblyModuleFilename": "static/wasm/[hash].module.wasm",

diff --git a/packages/core/src/config.ts b/packages/core/src/config.ts
@@ -31,7 +31,6 @@ import {
   JS_DIST_DIR,
   MEDIA_DIST_DIR,
   ROOT_DIST_DIR,
-  SERVER_DIST_DIR,
   SVG_DIST_DIR,
   TS_CONFIG_FILE,
   WASM_DIST_DIR,
@@ -135,7 +134,6 @@ const getDefaultOutputConfig = (): NormalizedOutputConfig => ({
     wasm: WASM_DIST_DIR,
     image: IMAGE_DIST_DIR,
     media: MEDIA_DIST_DIR,
-    server: SERVER_DIST_DIR,
   },
   assetPrefix: DEFAULT_ASSET_PREFIX,
   filename: {},

diff --git a/packages/core/src/constants.ts b/packages/core/src/constants.ts
@@ -4,7 +4,6 @@ import { join } from 'node:path';
 // loaders will be emitted to the same folder of the main bundle
 export const ROOT_DIST_DIR = 'dist';
 export const HTML_DIST_DIR = '/';
-export const SERVER_DIST_DIR = 'server';
 export const JS_DIST_DIR = 'static/js';
 export const CSS_DIST_DIR = 'static/css';
 export const SVG_DIST_DIR = 'static/svg';

diff --git a/packages/core/src/plugins/output.ts b/packages/core/src/plugins/output.ts
@@ -103,10 +103,7 @@ export const pluginOutput = (): RsbuildPlugin => ({
           .hashFunction('xxhash64');
 
         if (isServer) {
-          const serverPath = config.output.distPath.server;
-
           chain.output
-            .path(posix.join(distPath, serverPath))
             .filename('[name].js')
             .chunkFilename('[name].js')
             .library({

diff --git a/packages/core/src/plugins/performance.ts b/packages/core/src/plugins/performance.ts
@@ -31,9 +31,7 @@ export const pluginPerformance = (): RsbuildPlugin => ({
         if (rsbuildConfig.performance?.profile) {
           applyBundleAnalyzeConfig(rsbuildConfig);
         } else if (rsbuildConfig.environments) {
-          for (const config of Object.values(
-            rsbuildConfig.environments,
-          )) {
+          for (const config of Object.values(rsbuildConfig.environments)) {
             if (config.performance?.profile) {
               applyBundleAnalyzeConfig(config);
             }

diff --git a/packages/core/tests/__snapshots__/default.test.ts.snap b/packages/core/tests/__snapshots__/default.test.ts.snap
@@ -1234,7 +1234,7 @@ exports[`applyDefaultPlugins > should apply default plugins correctly when targe
     "library": {
       "type": "commonjs2",
     },
-    "path": "<ROOT>/packages/core/tests/dist/server",
+    "path": "<ROOT>/packages/core/tests/dist",
     "pathinfo": false,
     "publicPath": "/",
     "webassemblyModuleFilename": "static/wasm/[hash].module.wasm",

diff --git a/packages/core/tests/__snapshots__/environments.test.ts.snap b/packages/core/tests/__snapshots__/environments.test.ts.snap
@@ -79,7 +79,6 @@ exports[`environment config > should normalize environment config correctly 1`]
       "js": "static/js",
       "media": "static/media",
       "root": "dist",
-      "server": "server",
       "svg": "static/svg",
       "wasm": "static/wasm",
     },
@@ -201,7 +200,6 @@ exports[`environment config > should print environment config when inspect confi
         "js": "static/js",
         "media": "static/media",
         "root": "dist",
-        "server": "server",
         "svg": "static/svg",
         "wasm": "static/wasm",
       },
@@ -319,7 +317,6 @@ exports[`environment config > should print environment config when inspect confi
         "js": "static/js",
         "media": "static/media",
         "root": "dist",
-        "server": "server",
         "svg": "static/svg",
         "wasm": "static/wasm",
       },
@@ -442,7 +439,6 @@ exports[`environment config > should support modify environment config by api.mo
         "js": "static/js",
         "media": "static/media",
         "root": "dist",
-        "server": "server",
         "svg": "static/svg",
         "wasm": "static/wasm",
       },
@@ -560,7 +556,6 @@ exports[`environment config > should support modify environment config by api.mo
         "js": "static/js",
         "media": "static/media",
         "root": "dist",
-        "server": "server",
         "svg": "static/svg",
         "wasm": "static/wasm",
       },
@@ -679,7 +674,6 @@ exports[`environment config > should support modify environment config by api.mo
         "js": "static/js",
         "media": "static/media",
         "root": "dist",
-        "server": "server",
         "svg": "static/svg",
         "wasm": "static/wasm",
       },

diff --git a/packages/core/tests/__snapshots__/output.test.ts.snap b/packages/core/tests/__snapshots__/output.test.ts.snap
@@ -1,6 +1,6 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
-exports[`plugin-output > should allow to custom server directory with distPath.server 1`] = `
+exports[`plugin-output > should allow to custom server directory with distPath.root 1`] = `
 {
   "output": {
     "chunkFilename": "[name].js",

diff --git a/packages/core/tests/output.test.ts b/packages/core/tests/output.test.ts
@@ -11,14 +11,14 @@ describe('plugin-output', () => {
     expect(bundlerConfigs[0]).toMatchSnapshot();
   });
 
-  it('should allow to custom server directory with distPath.server', async () => {
+  it('should allow to custom server directory with distPath.root', async () => {
     const rsbuild = await createStubRsbuild({
       plugins: [pluginOutput()],
       rsbuildConfig: {
         output: {
           target: 'node',
           distPath: {
-            server: 'server',
+            root: 'dist/server',
           },
         },
       },

diff --git a/packages/shared/src/types/config/output.ts b/packages/shared/src/types/config/output.ts
@@ -63,11 +63,6 @@ export type DistPathConfig = {
    * @default 'static/media'
    */
   media?: string;
-  /**
-   * The output directory of server bundles when target is `node`.
-   * @default 'server'
-   */
-  server?: string;
 };
 
 export type FilenameConfig = {

diff --git a/website/docs/en/config/output/dist-path.mdx b/website/docs/en/config/output/dist-path.mdx
@@ -15,7 +15,6 @@ type DistPathConfig = {
   wasm?: string;
   image?: string;
   media?: string;
-  server?: string;
 };
 ```
 
@@ -34,7 +33,6 @@ const defaultDistPath = {
   wasm: 'static/wasm',
   image: 'static/image',
   media: 'static/media',
-  server: 'server',
 };
 ```
 
@@ -53,7 +51,6 @@ Detail:
 - `wasm`: The output directory of WebAssembly files.
 - `image`: The output directory of non-SVG images.
 - `media`: The output directory of media assets, such as videos.
-- `server`: The output directory of server bundles when [target](/config/output/targets) is `node`.
 
 ### Root Directory
 

diff --git a/website/docs/en/guide/basic/output-files.mdx b/website/docs/en/guide/basic/output-files.mdx
@@ -106,15 +106,25 @@ dist
 
 Node.js files usually only contain JS files, no HTML or CSS. Also, JS file names will not contain hash.
 
-You can modify the output path of Node.js files through the [output.distPath.server](/config/output/dist-path) config.
+You can modify the output path of Node.js files via the [environments](/config/environments) config.
 
 For example, output Node.js files to the `server` directory:
 
 ```ts
 export default {
-  output: {
-    distPath: {
-      server: 'server',
+  environments: {
+    web: {
+      output: {
+        target: 'web',
+      },
+    },
+    node: {
+      output: {
+        target: 'node',
+        distPath: {
+          root: 'dist/server',
+        },
+      },
     },
   },
 };

diff --git a/website/docs/zh/config/output/dist-path.mdx b/website/docs/zh/config/output/dist-path.mdx
@@ -15,7 +15,6 @@ type DistPathConfig = {
   wasm?: string;
   image?: string;
   media?: string;
-  server?: string;
 };
 ```
 
@@ -34,7 +33,6 @@ const defaultDistPath = {
   wasm: 'static/wasm',
   image: 'static/image',
   media: 'static/media',
-  server: 'server',
 };
 ```
 
@@ -53,7 +51,6 @@ const defaultDistPath = {
 - `wasm`：表示 WebAssembly 文件的输出目录。
 - `image`：表示非 SVG 图片的输出目录。
 - `media`：表示视频等媒体资源的输出目录。
-- `server`: 表示服务端产物的输出目录，仅在 [target](/config/output/targets) 为 `node` 时有效。
 
 ### 根目录
 

diff --git a/website/docs/zh/guide/basic/output-files.mdx b/website/docs/zh/guide/basic/output-files.mdx
@@ -106,15 +106,25 @@ dist
 
 Node.js 产物通常只包含 JS 文件，不包含 HTML、CSS 等文件。此外，Node 产物的 JS 文件名称也不会自动生成哈希值。
 
-你可以通过 [output.distPath.server](/config/output/dist-path) 配置项来修改 Node 产物的输出路径。
+你可以通过 [environments](/config/environments) 配置项来修改 Node 产物的输出路径。
 
-比如，将 Node.js 产物输出到 `server` 目录：
+比如，将 Node.js 产物输出到 `dist/server` 目录：
 
 ```ts
 export default {
-  output: {
-    distPath: {
-      server: 'server',
+  environments: {
+    web: {
+      output: {
+        target: 'web',
+      },
+    },
+    node: {
+      output: {
+        target: 'node',
+        distPath: {
+          root: 'dist/server',
+        },
+      },
     },
   },
 };