refactor(server): provide createDevServer method instead of getServerAPIs

[9aoy]

Summary

Simplify the way users use custom servers. The original getServerAPIs is too complicated for users to use custom server (requires calling 6 API methods).

before:

+  const serverAPIs = await rsbuild.getServerAPIs();

  const {
    config: { host, port },
  } = serverAPIs;

+  const compileMiddlewareAPI = await serverAPIs.startCompile();

+  const { middlewares, close, onUpgrade } = await serverAPIs.getMiddlewares({
    compileMiddlewareAPI,
  });

+  middlewares.forEach((item) => {
    if (Array.isArray(item)) {
      app.use(...item);
    } else {
      app.use(item);
    }
  });

+  await serverAPIs.beforeStart();

  const { server } = app.listen({ host, port }, async () => {
+    await serverAPIs.afterStart();
  });

  // subscribe the server's http upgrade event to handle WebSocket upgrade
+  server.on('upgrade', serverAPIs.onUpgrade);

  return {
    close: async () => {
+     await serverAPIs.close();
      server.close();
    },
  };

after:

+  const rsbuildServer = await rsbuild.createDevServer();

+  app.use(rsbuildServer.middlewares);

  const {
    config: { port },
  } = rsbuildServer;

  const { server } = app.listen({ port }, async () => {
+   await rsbuildServer.afterListen();
  });

  // subscribe the server's http upgrade event to handle WebSocket upgrade
+  server.on('upgrade', rsbuildServer.onHTTPUpgrade);

  return {
    close: async () => {
+     await rsbuildServer.close();
      server.close();
    },
  };
}

Related Links

Checklist

• Tests updated.
• Documentation updated.

[9aoy]

!canary

[9aoy]

!canary