refactor(server): provide createDevServer method instead of getServerAPIs

e2e/cases/server/custom-server/scripts/pure-server.mjs

@@ -1,5 +1,4 @@
 import { join } from 'node:path';
-import { pluginReact } from '@rsbuild/plugin-react';
 import { createRsbuild } from '@rsbuild/core';
 import polka from 'polka';
 
@@ -8,11 +7,11 @@ export async function startDevServerPure(fixtures) {
   const rsbuild = await createRsbuild({
     cwd: fixtures,
     rsbuildConfig: {
-      plugins: [pluginReact()],
       server: {
         htmlFallback: false,
       },
       dev: {
+        printUrls: false,
         setupMiddlewares: [
           (middlewares, server) => {
             middlewares.unshift((req, res, next) => {
@@ -21,8 +20,9 @@ export async function startDevServerPure(fixtures) {
                   Location: '/bbb',
                 });
                 res.end();
+              } else {
+                next();
               }
-              next();
             });
           },
         ],
@@ -32,43 +32,29 @@ export async function startDevServerPure(fixtures) {
 
   const app = polka();
 
-  const serverAPIs = await rsbuild.getServerAPIs();
-
-  const {
-    config: { host, port },
-  } = serverAPIs;
-
-  const { middlewares, close, onUpgrade } = await serverAPIs.getMiddlewares();
+  const rsbuildServer = await rsbuild.createDevServer({ runCompile: false });
 
   app.get('/aaa', (_req, res) => {
     res.end('Hello World!');
   });
 
-  for (const item of middlewares) {
-    if (Array.isArray(item)) {
-      app.use(...item);
-    } else {
-      app.use(item);
-    }
-  }
+  app.use(rsbuildServer.middlewares);
 
   app.get('/bbb', (_req, res) => {
     res.end('Hello Express!');
   });
 
-  await serverAPIs.beforeStart();
-
-  const { server } = app.listen({ host, port }, async () => {
-    await serverAPIs.afterStart();
+  const { server } = app.listen({ port: rsbuildServer.port }, async () => {
+    await rsbuildServer.afterListen();
   });
 
   // subscribe the server's http upgrade event to handle WebSocket upgrade
-  server.on('upgrade', onUpgrade);
+  server.on('upgrade', rsbuildServer.onHTTPUpgrade);
 
   return {
-    config: serverAPIs.config,
+    config: { port: rsbuildServer.port },
     close: async () => {
-      await close();
+      await rsbuildServer.close();
       server.close();
     },
   };

e2e/cases/server/custom-server/scripts/server.mjs

@@ -1,60 +1,51 @@
 import { join } from 'node:path';
-import { pluginReact } from '@rsbuild/plugin-react';
 import { createRsbuild } from '@rsbuild/core';
 import polka from 'polka';
 
 export async function startDevServer(fixtures) {
   const rsbuild = await createRsbuild({
     cwd: fixtures,
     rsbuildConfig: {
-      plugins: [pluginReact()],
       server: {
         htmlFallback: false,
       },
+      dev: {
+        printUrls: false,
+      }
     },
   });
 
   const app = polka();
 
-  const serverAPIs = await rsbuild.getServerAPIs();
+  const rsbuildServer = await rsbuild.createDevServer();
 
   const {
-    config: { host, port },
-  } = serverAPIs;
-
-  const compileMiddlewareAPI = await serverAPIs.startCompile();
-
-  const { middlewares, close, onUpgrade } = await serverAPIs.getMiddlewares({
-    compileMiddlewareAPI,
-  });
+    middlewares,
+    close,
+    onHTTPUpgrade,
+    afterListen,
+    port,
+  } = rsbuildServer;
 
   app.get('/aaa', (_req, res) => {
     res.end('Hello World!');
   });
 
-  for (const item of middlewares) {
-    if (Array.isArray(item)) {
-      app.use(...item);
-    } else {
-      app.use(item);
-    }
-  }
+  app.use(middlewares);
 
   app.get('/bbb', (_req, res) => {
     res.end('Hello Express!');
   });
 
-  await serverAPIs.beforeStart();
-
-  const { server } = app.listen({ host, port }, async () => {
-    await serverAPIs.afterStart();
+  const { server } = app.listen({ port }, async () => {
+    await rsbuildServer.afterListen();
   });
 
   // subscribe the server's http upgrade event to handle WebSocket upgrade
-  server.on('upgrade', onUpgrade);
+  server.on('upgrade', onHTTPUpgrade);
 
   return {
-    config: serverAPIs.config,
+    config: { port },
     close: async () => {
       await close();
       server.close();

packages/compat/webpack/src/provider.ts

@@ -56,25 +56,25 @@ export const webpackProvider: RsbuildProvider<'webpack'> = async ({
       return webpackConfigs;
     },
 
-    async getServerAPIs(options) {
-      const { getServerAPIs } = await import('@rsbuild/core/server');
+    async createDevServer(options) {
+      const { createDevServer } = await import('@rsbuild/core/server');
       const { createDevMiddleware } = await import('./core/createCompiler');
       await initRsbuildConfig({ context, pluginManager });
-      return getServerAPIs(
+      return createDevServer(
         { context, pluginManager, rsbuildOptions },
         createDevMiddleware,
         options,
       );
     },
 
     async startDevServer(options) {
-      const { startDevServer } = await import('@rsbuild/core/server');
+      const { createDevServer } = await import('@rsbuild/core/server');
       const { createDevMiddleware } = await import('./core/createCompiler');
       await initRsbuildConfig({
         context,
         pluginManager,
       });
-      return startDevServer(
+      const server = await createDevServer(
         {
           context,
           pluginManager,
@@ -83,6 +83,8 @@ export const webpackProvider: RsbuildProvider<'webpack'> = async ({
         createDevMiddleware,
         options,
       );
+
+      return server.listen();
     },
 
     async preview(options?: PreviewServerOptions) {

packages/core/src/createRsbuild.ts

@@ -36,7 +36,7 @@ export async function createRsbuild(
     initConfigs,
     inspectConfig,
     createCompiler,
-    getServerAPIs,
+    createDevServer,
     startDevServer,
     applyDefaultPlugins,
   } = await provider({
@@ -72,7 +72,7 @@ export async function createRsbuild(
     createCompiler,
     initConfigs,
     inspectConfig,
-    getServerAPIs,
+    createDevServer,
     startDevServer,
     context: publicContext,
   };

packages/core/src/provider/provider.ts

@@ -48,26 +48,25 @@ export const rspackProvider: RsbuildProvider = async ({
       pluginManager.addPlugins(await applyDefaultPlugins(plugins));
     },
 
-    async getServerAPIs(options) {
-      const { getServerAPIs } = await import('../server/devServer');
+    async createDevServer(options) {
+      const { createDevServer } = await import('../server/devServer');
       const { createDevMiddleware } = await import('./createCompiler');
       await initRsbuildConfig({ context, pluginManager });
-      return getServerAPIs(
+      return createDevServer(
         { context, pluginManager, rsbuildOptions },
         createDevMiddleware,
         options,
       );
     },
 
     async startDevServer(options) {
-      const { startDevServer } = await import('../server/devServer');
+      const { createDevServer } = await import('../server/devServer');
       const { createDevMiddleware } = await import('./createCompiler');
       await initRsbuildConfig({ context, pluginManager });
-      return startDevServer(
-        { context, pluginManager, rsbuildOptions },
-        createDevMiddleware,
-        options,
-      );
+
+      const server = await createDevServer({ context, pluginManager, rsbuildOptions }, createDevMiddleware, options);
+
+      return server.listen();
     },
 
     async preview(options?: PreviewServerOptions) {