serve() — vite Function Reference

Architecture documentation for the serve() function in serve.ts from the vite codebase.

Function typescript ViteCore ConfigEngine calls 2

Entity Profile

ViteCore→ ConfigEngine→ serve() — vite Function Reference

Dependency Diagram

graph TD
  f797f934_0de5_e01d_8e86_ee712b506fda["serve()"]
  f7b3d158_cef2_c5d6_e1e9_618c0b12e5a8["serve.ts"]
  f797f934_0de5_e01d_8e86_ee712b506fda -->|defined in| f7b3d158_cef2_c5d6_e1e9_618c0b12e5a8
  32dae94d_4e52_4562_6377_73438c721fcb["resolvedOrTimeout()"]
  f797f934_0de5_e01d_8e86_ee712b506fda -->|calls| 32dae94d_4e52_4562_6377_73438c721fcb
  fe3d154a_8fd8_adee_8784_8a0d58dd4c70["startedOnPort()"]
  f797f934_0de5_e01d_8e86_ee712b506fda -->|calls| fe3d154a_8fd8_adee_8784_8a0d58dd4c70
  style f797f934_0de5_e01d_8e86_ee712b506fda fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

playground/cli-module/__tests__/serve.ts lines 18–114

export async function serve() {
  // collect stdout and stderr streams from child processes here to avoid interfering with regular vitest output
  const streams = {
    build: { out: [], err: [] },
    server: { out: [], err: [] },
  }
  // helpers to collect streams
  const collectStreams = (name, process) => {
    process.stdout.on('data', (d) => streams[name].out.push(d.toString()))
    process.stderr.on('data', (d) => streams[name].err.push(d.toString()))
  }
  const collectErrorStreams = (name, e) => {
    e.stdout && streams[name].out.push(e.stdout)
    e.stderr && streams[name].err.push(e.stderr)
  }

  // helper to output stream content on error
  const printStreamsToConsole = async (name) => {
    const std = streams[name]
    if (std.out && std.out.length > 0) {
      console.log(`stdout of ${name}\n${std.out.join('\n')}\n`)
    }
    if (std.err && std.err.length > 0) {
      console.log(`stderr of ${name}\n${std.err.join('\n')}\n`)
    }
  }

  // only run `vite build` when needed
  if (isBuild) {
    const buildCommand = `${viteBinPath} build`
    try {
      const buildProcess = execaCommand(buildCommand, {
        cwd: rootDir,
        stdio: 'pipe',
      })
      collectStreams('build', buildProcess)
      await buildProcess
    } catch (e) {
      console.error(`error while executing cli command "${buildCommand}":`, e)
      collectErrorStreams('build', e)
      await printStreamsToConsole('build')
      throw e
    }
  }

  await kill(port)

  // run `vite --port x` or `vite preview --port x` to start server
  const viteServerArgs = ['--port', `${port}`, '--strict-port']
  if (isBuild) {
    viteServerArgs.unshift('preview')
  }
  const serverCommand = `${viteBinPath} ${viteServerArgs.join(' ')}`
  const serverProcess = execaCommand(serverCommand, {
    cwd: rootDir,
    stdio: 'pipe',
    forceKillAfterDelay: 3000,
  })
  collectStreams('server', serverProcess)

  // close server helper, send SIGTERM followed by SIGKILL if needed, give up after 3sec
  const close = async () => {
    if (serverProcess) {
      const timeoutError = `server process still alive after 3s`
      try {
        await killProcess(serverProcess)
        await resolvedOrTimeout(serverProcess, 10000, timeoutError)
      } catch (e) {
        if (e === timeoutError || (!serverProcess.killed && !isWindows)) {
          collectErrorStreams('server', e)
          console.error(
            `error while killing cli command "${serverCommand}":`,
            e,
          )
          await printStreamsToConsole('server')
        }
      }
    }
  }

  try {