refactor: streamline port handling in output and middleware logic (#5039)

Author: chenjiahan

packages/core/src/plugins/output.ts

@@ -25,7 +25,6 @@ function getPublicPath({
   const { dev, output, server } = config;
 
   let publicPath = DEFAULT_ASSET_PREFIX;
-  const port = context.devServer?.port || server.port || DEFAULT_PORT;
 
   if (isProd) {
     if (typeof output.assetPrefix === 'string') {
@@ -53,6 +52,8 @@ function getPublicPath({
     }
   }
 
+  const defaultPort = server.port ?? DEFAULT_PORT;
+  const port = isProd ? defaultPort : (context.devServer?.port ?? defaultPort);
   return formatPublicPath(replacePortPlaceholder(publicPath, port));
 }
 

packages/core/src/server/devMiddlewares.ts

@@ -1,7 +1,6 @@
 import { isAbsolute, join } from 'node:path';
 import rspack from '@rspack/core';
 import { normalizePublicDirs } from '../config';
-import { DEFAULT_PORT } from '../constants';
 import { isMultiCompiler } from '../helpers';
 import { logger } from '../logger';
 import type {
@@ -124,13 +123,12 @@ const applyDefaultMiddlewares = async ({
 
     if (
       typeof dev.lazyCompilation === 'object' &&
-      typeof dev.lazyCompilation.serverUrl === 'string'
+      typeof dev.lazyCompilation.serverUrl === 'string' &&
+      context.devServer
     ) {
-      const port = context.devServer?.port || server.port || DEFAULT_PORT;
-
       dev.lazyCompilation.serverUrl = replacePortPlaceholder(
         dev.lazyCompilation.serverUrl,
-        port,
+        context.devServer.port,
       );
     }
 

packages/core/src/server/helper.ts

@@ -4,7 +4,7 @@ import net from 'node:net';
 import type { Socket } from 'node:net';
 import os from 'node:os';
 import { posix, relative, sep } from 'node:path';
-import { DEFAULT_DEV_HOST, DEFAULT_PORT } from '../constants';
+import { DEFAULT_DEV_HOST } from '../constants';
 import {
   addTrailingSlash,
   color,
@@ -310,14 +310,13 @@ export const getServerConfig = async ({
   https: boolean;
   portTip: string | undefined;
 }> => {
-  const host = config.server.host || DEFAULT_DEV_HOST;
-  const originalPort = config.server.port || DEFAULT_PORT;
+  const { host, port: originalPort, strictPort } = config.server;
   const port = await getPort({
     host,
     port: originalPort,
-    strictPort: config.server.strictPort || false,
+    strictPort,
   });
-  const https = Boolean(config.server.https) || false;
+  const https = Boolean(config.server.https);
   const portTip =
     port !== originalPort
       ? `port ${originalPort} is in use, ${color.yellow(`using port ${port}.`)}`

packages/core/tests/output.test.ts

@@ -1,4 +1,5 @@
 import { createStubRsbuild } from '@scripts/test-helper';
+import { createRsbuild } from '../src';
 import { pluginOutput } from '../src/plugins/output';
 
 describe('plugin-output', () => {
@@ -179,8 +180,8 @@ describe('plugin-output', () => {
   });
 
   it('should replace `<port>` placeholder with server.port', async () => {
-    const rsbuild = await createStubRsbuild({
-      plugins: [pluginOutput()],
+    vi.stubEnv('NODE_ENV', 'development');
+    const rsbuild = await createRsbuild({
       rsbuildConfig: {
         server: { port: 4000 },
         dev: {
@@ -190,12 +191,12 @@ describe('plugin-output', () => {
     });
     const [config] = await rsbuild.initConfigs();
     expect(config?.output?.publicPath).toEqual('http://example-4000.com:4000/');
+    vi.unstubAllEnvs();
   });
 
   it('should replace `<port>` placeholder of `output.assetPrefix` with default port', async () => {
     vi.stubEnv('NODE_ENV', 'production');
-    const rsbuild = await createStubRsbuild({
-      plugins: [pluginOutput()],
+    const rsbuild = await createRsbuild({
       rsbuildConfig: {
         output: {
           assetPrefix: 'http://example.com:<port>/',
@@ -205,5 +206,6 @@ describe('plugin-output', () => {
 
     const [config] = await rsbuild.initConfigs();
     expect(config?.output?.publicPath).toEqual('http://example.com:3000/');
+    vi.unstubAllEnvs();
   });
 });

scripts/dictionary.txt

@@ -134,6 +134,7 @@ unocss
 unpatch
 unplugin
 unshift
+unstub
 upath
 vitest
 vnode