목차
Turborepo에 배포 작업의 순서를 맡긴 UVP 모노레포 (2022-04)
원문 정보
- 원문: Turborepo로 모노레포 개발 경험 향상하기
- 매체 · 게시일: LINE Engineering 블로그 · 2022-04-15
- 저자: 이상철 (1ilsang, LINE+ UIT 조직 프런트엔드 개발자)
- 원문 내용을 바탕으로 재구성한 요약입니다.
배포 직전의 테스트가 실패하면 어디서부터 다시 시작해야 할까요? LINE+의 사내 동영상 컴포넌트 라이브러리 UVP(Universal Video Player)에서는 lint -> build -> test를 다시 거쳐야 했습니다. 이미 끝낸 빌드도 예외가 아니었습니다. 개발 중에도 스토리북과 데모 웹이 같은 라이브러리를 각각 빌드하는 일이 반복됐습니다.
UVP 개발팀이 Turborepo에 맡기려던 일은 이 반복을 줄이는 것이었습니다. 길게 이어 붙인 명령에서 작업 간 의존성을 분리하고, 한 번 수행한 작업의 결과를 다음 실행에서도 쓰려 했습니다.
여러 패키지를 거치는 스토리북 배포
UVP의 모노레포에는 동영상 기본 기능을 담은 uvp-core와 이를 감싼 UI 컴포넌트 uvp가 있습니다. 라이브러리를 사용하는 개발자용 데모 웹과 스토리북은 apps 폴더 아래에 각각 패키지로 자리 잡았습니다. Babel, ESLint 같은 공통 스크립트와 타입스크립트 설정도 패키지로 묶어 관리할 곳을 모았습니다.
하나의 리포지터리에 여러 서브 프로젝트를 두면 코드와 자산의 관계를 함께 살피기 좋습니다. 커밋 이력을 한곳에서 추적하고 테스트 코드 같은 자산을 재사용할 수도 있습니다. UVP에서는 이렇게 모아 둔 패키지를 빌드하고 배포하는 명령이 길어졌습니다. 스토리북 배포 하나에도 린트와 테스트, uvp-core와 uvp, 스토리북의 빌드가 필요했습니다.
deploy:storybook에 들어 있던 명령은 yarn lint && yarn uvp-core build && yarn uvp build && yarn storybook build && yarn test && yarn storybook deploy였습니다. 각 스크립트 안에 또 다른 의존성이 있으면 작성과 유지 보수는 더 어려워집니다. 이 순서를 계속 스크립트로 관리하는 대신, Turborepo가 의존성을 판단하고 가능한 작업을 병렬로 실행하도록 바꾸기로 했습니다.
실행 순서를 넘겨받은 Turborepo
Turborepo는 Vercel이 인수한 JavaScript·TypeScript 모노레포용 고성능 빌드 시스템입니다. 복잡한 빌드 설정과 스크립트 관리를 대신해 개발자가 개발에 집중하도록 돕는 것이 목표입니다. UVP에 적용할 때도 별도 코드 작업은 없었습니다. package.json과 turbo.json을 변경해 설정을 마쳤습니다.
먼저 각 패키지의 스크립트에서 앞뒤로 연결한 작업을 분리했습니다. 스크립트에는 해당 작업만 남겼습니다. 예를 들어 기존 build:storybook은 yarn lint && yarn uvp-core build && yarn uvp build && build-storybook을 실행했지만, 변경 뒤에는 build-storybook만 실행합니다. 스토리북을 빌드하기 전에 끝내야 할 작업은 turbo.json에서 지정합니다.
모노레포 루트의 turbo.json에는 태스크 파이프라인을 작성합니다. 여기서 태스크는 병렬 처리와 의존성을 판단하는 단위입니다. dependsOn: ["^build"]는 의존하는 패키지의 빌드를 먼저 실행하라는 뜻이며, 특정 패키지의 작업을 지정할 때는 패키지명#스크립트 형식을 씁니다. UVP의 스냅샷 테스트는 @linecorp/uvp#build를 기다리도록 설정했습니다.
모든 작업이 앞선 빌드를 기다리는 것은 아닙니다. 예제의 lint에는 의존성을 지정하지 않았으므로 실행할 여건이 되면 바로 시작합니다. 배포 태스크에는 build, cypress:ci, snapshots, lint를 선행 작업으로 지정했습니다. Turborepo는 이 관계에 맞춰 실행 순서를 위상 정렬하고, 최대한 병렬로 처리합니다.
캐시 설정도 같은 파일에 둡니다. outputs에는 캐시할 산출물 폴더를 지정하고, 핫 로딩이 필요한 dev에는 "cache": false를 써서 캐시를 끕니다. 태스크마다 실행 조건과 캐시 사용 여부를 따로 정하는 방식입니다.
설치는 루트에서 yarn add turbo -DW로 진행합니다. 이후 turbo run build를 실행하면 파이프라인의 키와 각 패키지의 package.json 스크립트가 연결됩니다. 해당 스크립트가 없는 패키지는 건너뜁니다. A 패키지에만 lint 스크립트가 있다면 린트는 A에서만 실행되는 식입니다.
루트의 package.json에서는 필요한 태스크와 범위를 조합합니다. --scope는 실행할 패키지 범위를 정하고, --no-deps --include-dependencies를 함께 쓰면 필요한 의존성도 실행합니다. 긴 배포 명령이 있던 deploy:storybook은 turbo run deploy --scope='storybook'으로 바뀌었습니다. 캐시된 작업까지 다시 실행하려면 --force를 붙입니다.
복잡한 빌드 도구 설정이나 서드파티 작업 없이 적용을 마쳤다는 점은 개발팀이 꼽은 이점입니다. 지원하지 않는 기능도 있었습니다. 2022년 4월 당시 Turborepo는 Yarn2의 PnP(Plug n Play)를 지원하지 않아, 이 기능은 써 보지 못했습니다.
이전 산출물로 끝낸 0.64초의 재실행
실행 순서를 정한 다음에는 같은 빌드를 반복하지 않도록 해야 했습니다. 스토리북과 데모 웹은 모두 uvp 빌드에 의존합니다. 어느 한쪽에서 이미 빌드했다면 다른 쪽의 스크립트를 실행할 때 그 결과를 다시 쓰는 것이 개발팀의 바람이었습니다.
Turborepo의 기본 원칙도 한 번 수행한 계산을 다시 하지 않는 것입니다. 앞서 계산한 작업은 다음 실행에서 건너뛰고, 캐시해 둔 로그를 다시 보여줍니다. 변경 여부는 타임스탬프 대신 파일 내용으로 판단해 변경된 파일만 빌드합니다.
UVP에서 효과를 확인한 조건은 분명합니다. 6개 패키지의 13가지 태스크에 종속된 배포 작업을 다시 실행했을 때, 이전 산출물을 100% 캐시로 활용했습니다. 이 재실행에서 7분 걸리던 작업이 0.64초 만에 끝났습니다.
배포 전 테스트가 실패하는 상황에서도 차이가 생겼습니다. 특정 태스크에서 오류가 나더라도 그 앞에서 수행한 작업은 캐시로 처리하므로, 처음부터 모든 빌드를 반복하던 때보다 빠르게 다시 진행할 수 있었습니다.
새로 합류할 동료를 위한 실행 그래프
UVP에는 라이브러리와 이를 사용하는 사이트가 별도 패키지로 존재했습니다. 여기에 플러그인 형태로 UVP를 확장할 계획도 있었습니다. 앞으로 패키지가 더 생기면 새로 합류한 사람이 긴 배포 스크립트를 읽고 의존성과 배포 순서를 익혀야 할 부담도 커집니다. 개발팀은 이 관계를 눈으로 확인할 방법을 원했습니다.
turbo run TASK --graph를 실행하면 파이프라인에 지정한 태스크 관계가 그래프 이미지로 나옵니다. 이 옵션을 쓰려면 graphviz를 설치해야 합니다. UVP의 빌드 그래프에서는 uvp가 uvp-core에 의존하고, 이후 각 패키지가 uvp 빌드를 사용하는 흐름을 확인했습니다. 각 패키지를 배포하기 전에 어떤 테스트 스크립트를 거치는지도 보입니다.
실제로 어디서 시간이 걸렸는지는 프로파일에서 확인합니다. turbo run TASK --profile은 빌드 진행 과정과 병렬 처리 구간, 소요 시간을 담은 JSON 파일을 만듭니다. 이를 Chrome 개발자 도구의 Performance 탭에서 불러오면 실행 과정을 시각화해 볼 수 있습니다. 태스크 관계를 파악하는 데서 더 나아가, 빌드 중 병목이 생기는 지점까지 찾는 데 도움이 됐습니다.
원문의 주요 수치와 옵션
| 항목 | 값 |
|---|---|
| 재실행한 배포 작업 범위 | 6개 패키지, 13가지 태스크 |
| 캐시 활용률 | 100% |
| 소요 시간 | 7분에서 0.64초 |
| 설치 | yarn add turbo -DW |
--scope | 실행할 패키지 범위 지정 |
--no-deps --include-dependencies | 필요한 의존성과 함께 실행 |
--force | 캐시된 작업 재실행 |
--graph / --profile | 태스크 관계 그래프 / 프로파일 JSON |