Skip to content
On this page

Beyond Fast

ViteConf 2023

Watch the replay!

사전 번들링 된 디펜던시

처음 vite를 실행할 때, Vite는 로컬에 사이트를 불러오기 전에 프로젝트의 디펜던시를 사전 번들링합니다. 이는 기본적으로 자동으로 투명하게 진행됩니다.

왜 이런 메시지가 나타나나요?

이러한 메시지가 나타나는 이유는 Vite의 "사전 번들링(Pre-bundling)" 기능으로 인한 것인데, 이를 사용하는 목적은 다음과 같습니다.

  1. CommonJS 그리고 UMD 모듈을 ESM으로 가져오기: 개발 시, Vite의 개발 서버는 모든 코드를 네이티브 ESM으로 가져오게 됩니다. 따라서, vite는 반드시 모든 CommonJS 및 UMD 파일을 ESM으로 불러올 수 있도록 변환 작업을 진행해줘야 합니다.

    vite는 조금 영리하게 ESM 파일로 변환을 진행하는데, 가령 CommonJS 디펜던시를 변환해주는 경우 아래와 같이 이름을 지정해 CommonJS 형태의 모듈을 가져올 수도 있습니다.

    js
    // 아래 코드는 정상적으로 동작합니다.
    import React, { useState } from 'react'
  2. 퍼포먼스: vite는 여러 디펜던시가 존재하는 ESM 모듈을 하나의 모듈로 변환하여 페이지 로드에 대한 퍼포먼스를 향상시킵니다.

    600개의 모듈을 갖고 있는 lodash-es와 같이 매우 많은 모듈을 필요로 하는 경우, 그 수만큼 HTTP 요청을 전송하게 됩니다(import { debounce } from 'lodash-es'를 한다고 해도 말이죠). 서버가 이 요청들을 모두 정상적으로 처리한다고 해도, 브라우저 자체에서 이러한 네트워크 요청에 대한 오버헤드가 존재하기에 페이지 로드 퍼포먼스는 떨어질 수 밖에 없습니다. 즉, lodash-es 모듈을 가져오게 된다면... 600개의 HTTP 요청을 전송하게 되는 것이죠.

    만약 lodash-es 모듈을 하나의 모듈로 번들링하게 된다면 어떻게 될까요? 브라우저는 단지 하나의 HTTP 요청만을 전송하게 됩니다.

참고

디펜던시 사전 번들링 기능은 개발 모드에서만 적용되며, esbuild를 이용해 디펜던시를 ESM으로 변환합니다. 프로덕션 빌드의 경우, 이 대신 @rollup/plugin-commonjs가 대신 사용됩니다.

자동으로 디펜던시 탐색하기

만약 디펜던시가 캐시되지 않았다면 어떻게 될까요? vite는 프로젝트 내 모든 소스 코드를 탐색하여 디펜던시를 찾아낸 뒤, 사전 번들링을 이용해 Import 합니다(node_modules에서 디펜던시를 가져오듯이 말이죠). 물론, 이 사전 번들링 과정은 esbuild를 이용하기에 보통 매우 빠른 속도로 진행됩니다.

서버가 이미 시작된 이후에 캐시되지 않은 새로운 디펜던시가 추가되는 경우라면, vite는 디펜던시 번들링 과정을 재시작하고 이후 필요하다면 해당 페이지를 다시 불러오게 됩니다.

모노리포 디펜던시

모노리포 프로젝트의 경우 디펜던시는 동일한 하나의 리포지토리에 연결된 패키지일 수 있습니다. Vite는 사용하는 디펜던시가 node_modules에 존재하지 않더라도 스스로 탐색하여 이를 소스 코드로 가져올 수 있지만, 이를 번들로 묶지는 않습니다. 그저 연결된 디펜던시 목록을 분석할 뿐이죠.

이를 위해서는 연결된 디펜던시가 ESM 형태로 내보내져야 합니다. 만약 그렇지 않다면, 해당되는 디펜던시들을 optimizeDeps.includebuild.commonjsOptions.include 설정에 추가해주세요.

js
export default defineConfig({
   optimizeDeps: {
      include: ['linked-dep']
   },
   build: {
      commonjsOptions: {
         include: [/linked-dep/, /node_modules/]
      }
   }
})

설정 값 변경 이후 --force 플래그를 이용해 개발 서버를 다시 시작하게 되면 해당 내용이 적용됩니다.

디펜던시 탐색 과정 커스터마이즈하기

Vite의 디펜던시 탐색 휴리스틱이 항상 바람직한 것은 아닙니다. 만약 특정 디펜던시를 명시적으로 포함시키거나 포함시키지 않도록 설정하고자 한다면 optimizeDeps 옵션을 이용해주세요.

optimizeDeps.include 또는 optimizeDeps.exclude의 일반적인 사용 사례는 소스 코드에서 직접 탐색할 수 없는 Import가 있는 경우입니다. 플러그인 변환의 결과물에 Import가 사용된 경우를 예로 들 수 있습니다. 이는 Vite가 초기 스캔 시 해당 Import를 발견할 수 없음을 의미합니다. 브라우저에서 파일을 요청하고 변환된 이후에만 해당 Import를 발견할 수 있습니다. 이는 서버가 시작된 이후에 서버를 다시 번들링하게 만듭니다.

이를 해결하기 위해 includeexclude 옵션 둘 다 사용될 수 있습니다. 만약 디펜던시가 크거나(내부 모듈이 많은 경우) CommonJS 포맷이라면 include 옵션에 명시해야 합니다. 만약 디펜던시가 작고 이미 ESM 스타일로 작성되어 있다면 exclude 옵션에 명시해 브라우저에서 바로 불러올 수 있도록 설정할 수 있습니다.

또한 optimizeDeps.esbuildOptions 옵션을 통해 esbuild를 더욱 세밀하게 커스터마이즈할 수 있습니다. 예를 들어, 특정 파일을 디펜던시에서 처리하기 위한 esbuild 플러그인을 추가하거나, 빌드 target을 변경할 수 있습니다.

캐싱

파일 시스템 캐시

Vite는 사전 번들링 된 디펜던시를 node_modules/.vite 디렉터리 내에 캐시하고 있습니다. 다만 이를 다시 번들링하는 경우가 있는데, 다음과 같습니다.

  • 패키지 매니저의 락파일 내용, 예를 들어 package-lock.json, yarn.lock, pnpm-lock.yaml 또는 bun.lockb
  • 폴더의 수정 시간을 패치
  • vite.config.js와 관련되어 있는 필드가 변경되었을 때
  • NODE_ENV

위의 변경 사항이 발생된 경우 사전 번들링 과정을 다시 시작하게 됩니다.

만약 강제로 디펜던시를 다시 번들링해야 하는 경우, 개발 서버를 --force 옵션과 함께 시작해주세요. 또는 그냥 node_modules/.vite 디렉터리를 삭제해줘도 됩니다.

브라우저 캐시

HTTP 헤더를 max-age=31536000,immutable(사전 번들링 된 디펜던시의 경우 이 헤더가 추가됩니다. - 옮긴이)과 같이 디펜던시가 반드시 캐시되도록 설정한 경우, 개발 시 페이지를 다시 불러올 때의 퍼포먼스를 향상시킬 수 있습니다. 한 번 캐시된 디펜던시는 다시 서버에 요청하지 않기 때문이죠. 물론 캐시된 디펜던시와 다른 버전이 설치된 경우, 기존 버전은 자동으로 무효화됩니다. 물론 아래의 과정을 통해 버전 변경 없이 직접 디펜던시를 수정(디버그)할 수도 있습니다.

  1. 브라우저의 개발자 도구를 이용해 캐시를 사용하지 않도록 설정합니다.
  2. 디펜던시를 다시 번들링하는 --force 옵션과 함께 Vite의 개발 서버를 재시작합니다.
  3. 페이지를 다시 로드합니다.

Released under the MIT License.