rewriteOriginHeader() — vite Function Reference

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

Function typescript ViteCore ConfigEngine called by 1

Entity Profile

ViteCore→ ConfigEngine→ rewriteOriginHeader() — vite Function Reference

Dependency Diagram

graph TD
  71bee4b5_1093_f98d_06c8_78977e4eb508["rewriteOriginHeader()"]
  d873c697_620e_ffca_0134_e9fecd784782["proxy.ts"]
  71bee4b5_1093_f98d_06c8_78977e4eb508 -->|defined in| d873c697_620e_ffca_0134_e9fecd784782
  65695310_3d20_5d70_c2ad_710df99d8481["proxyMiddleware()"]
  65695310_3d20_5d70_c2ad_710df99d8481 -->|calls| 71bee4b5_1093_f98d_06c8_78977e4eb508
  style 71bee4b5_1093_f98d_06c8_78977e4eb508 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/vite/src/node/server/middlewares/proxy.ts lines 43–73

const rewriteOriginHeader = (
  proxyReq: http.ClientRequest,
  options: ProxyOptions,
  config: ResolvedConfig,
) => {
  // Browsers may send Origin headers even with same-origin
  // requests. It is common for WebSocket servers to check the Origin
  // header, so if rewriteWsOrigin is true we change the Origin to match
  // the target URL.
  if (options.rewriteWsOrigin) {
    const { target } = options

    if (proxyReq.headersSent) {
      config.logger.warn(
        colors.yellow(
          `Unable to rewrite Origin header as headers are already sent.`,
        ),
      )
      return
    }

    if (proxyReq.getHeader('origin') && target) {
      const changedOrigin =
        typeof target === 'object'
          ? `${target.protocol ?? 'http:'}//${target.host}`
          : target

      proxyReq.setHeader('origin', changedOrigin)
    }
  }
}