SOCAR Tech Blog

목차
시작하며
규모가 커지면서 생기는 문제점들
2.1 계속해서 생겨나는 중복 코드들
2.2 멀티레포 환경에서의 공통 라이브러리 업데이트
일관성을 위한 모노레포 도입과 고민
프로젝트 세팅 비용 단축하기
4.1 기존 멀티레포 환경에서의 프로젝트 세팅
4.2 모노레포 환경 구성 세팅하기
4.3 Code Generator를 활용한 프로젝트 세팅
4.4 결론
마치며
1. 시작하며
해당 글은 다음과 같은 분들에게 도움이 됩니다.
모노레포 환경으로 이관/구성하려는 프론트엔드 개발자
프로젝트 환경 세팅 자동화를 하여 효율성을 높이고 싶은 개발자
안녕하세요 쏘카 웹 프론트엔드로 근무하고 있는 Common Resource 팀 리아코 입니다.
이미 프로젝트를 관리하기 위한 방법으로 모노레포를 도입한 곳이 많을 것 입니다. 쏘카 웹 프론트엔드 규모가 점점 커지면서 (24년 8월 기준) 29명의 프론트엔드 개발자와 수십 개의 프로젝트를 효율적으로 관리하기 위해 모노레포를 도입하게 되었습니다. 기존 멀티레포 환경에서 모노레포 환경으로 이관하게 되면서 사용하던 기술 스택에 대한 기준 설정과 프로젝트 일관성을 보장하기 위한 방법을 고민하고 개선했습니다. 이 글을 통해 모노레포 프로젝트 관리를 유용하게 하는데 도움이 되면 좋겠습니다.
2. 규모가 커지면서 생기는 문제점들
66개 가량의 프론트엔드 Repository
서비스의 확장을 위해 점점 프론트엔드 팀의 규모가 커지고 진행되는 프로젝트가 많아지면서 그만큼 Repository의 개수가 증가했습니다. 이로 인해 유지 보수 문제와 중복 코드 등 여러 문제가 발생했습니다.
1. 여러 단일 Repository에 존재하는 중복 코드들
2. 공통 라이브러리 변경 후 여러 단일 Repository에 적용하는 과정의 높은 작업 공수
3. 서로 다른 개발 환경을 가진 여러 단일 Repository에 증가로 인해 프로젝트 별 러닝 커브가 높아지는 문제
2.1. 계속해서 생겨나는 중복 코드들
코드 파편화에 대한 이슈
여러 단일 Repository가 점점 늘어나면서 비슷한 기능을 구현하는 코드들이 각 프로젝트마다 중복해서 작성되기 시작되면서 코드 파편화를 발생시켰습니다. 이와 같은 코드 파편화는 동일한 로직이 여러 곳에 산재해 있어, 전체적인 코드 베이스의 일관성을 지키기 어려웠습니다.
그 결과, 개발 인원과 프로젝트가 늘어나면서 문제가 점점 확대되기 시작하였고 팀 전체의 생산성 저하와 코드 품질 관리의 어려움으로 이어졌습니다.
이러한 상황을 더 이상 방치할 수 없는 상황이라 판단하여 문제를 해결하기 위한 고민을 시작하게 되었습니다.
2.2. 멀티레포 환경에서의 공통 라이브러리 업데이트
쏘카 웹 프론트엔드 팀은 NPM Registry를 활용하여 SDS(socar-design-system)와 frontend-libraries 같은 공통 라이브러리 패키지를 여러 프로젝트에서 사용하고 있습니다.
이러한 멀티레포 구조에서 공통 라이브러리를 업데이트할 때 다음과 같은 플로우를 타게 됩니다.
이 외에도 내부적으로 복잡한 배포 승인 과정
위와 같은 플로우는 각 단계 별로 이슈 확인, 코드 테스트, 배포, 적용마다 시간이 필요할 뿐만 아니라 모든 프로젝트에 동시에 업데이트를 적용하기에는 어려워 일관성 유지가 힘들어집니다.
이러한 문제점들로 인해 공통 라이브러리의 효율적인 관리와 빠른 개선이 어려워지며, 결과적으로 프로젝트 전체의 개발 속도와 품질에 영향을 미칠 수 있습니다.
이 외에도 일관적이지 않는 개발 환경으로 인해 러닝커브가 점점 커져가며 유지 보수에 대해 문제가 생기기도 합니다.
프론트엔드 팀 인원이 30명 가까이 늘어나면서 문제는 더욱 심화되었고, 이러한 문제들을 해결하기 위해 저희 쏘카 웹 그룹은 모노레포 도입을 결정했습니다.
3. 일관성을 위한 모노레포 도입과 고민
모노레포는 이미 많은 회사에서 프로젝트 관리의 일관성을 위해 도입하고 있는 방식입니다. 모노레포를 통해 다음과 같은 이점을 얻고자 했습니다.
1. 공통 컴포넌트의 중앙화된 관리
2. 코드 재사용성 증가
3. 일관된 개발 환경 및 툴링
4. 의존성 관리 간소화
모노레포를 관리하기 위한 여러 도구들(lerna, nx 등)이 있지만, 빠른 빌드 속도와 병렬 실행, 원격 캐싱과 같은 성능적인 이점과 최소한의 설정으로 모노레포 세팅이 가능한 편의성을 고려해 Turborepo를 기반으로 모노레포 프로젝트를 구성했습니다.
모노레포 도입을 통해 30명이 넘는 프론트엔드 개발자가 수십 개의 프로젝트를 진행하여도 동일한 기술 스택과 개발 환경을 일관성 있게 하나의 프로젝트처럼 같이 관리할 수 있는 장점이 있었습니다.
다만 멀티레포에서 사용하던 방식들에 대한 변경 점과 모노레포 프로젝트 관리를 위한 정책들과 도구들이 추가되어야 했습니다. 저희는 먼저 프로젝트 세팅에 대한 고민을 시작했습니다.
4. 프로젝트 세팅 비용 단축하기
멀티레포 환경에서 모노레포로 이관하면서 고민했던 문제들과 프로젝트 세팅을 위한 Code Generator에 대해 소개합니다.
💡 Code Generator란?
코드 제너레이터는 프로그래밍 코드를 자동 생성하는 도구나 소프트웨어를 의미합니다. 
개발자가 직접 작성하는 대신 특정 규칙 및 템플릿 명세를 기반으로 소스코드를 자동으로 생성하는 프로그램입니다.
4.1 기존 멀티레포 환경에서의 프로젝트 세팅
쏘카 웹 프론트엔드 프로젝트 템플릿은 Github Repository Template 기능으로 프로젝트 환경을 2개로 나누어서 사용 중이었습니다.
멀티레포 방식의 프로젝트 관리를 하면서 해당 템플릿을 받아오는 스캐폴딩 개발 방식을 도입했습니다.
💡   스캐폴딩(Scaffolding) 코드란?
- 새로운 프로젝트나 모듈을 시작할 때 초기 구조와 설정을 자동으로 생성해주는 도구 및 과정
이러한 Github Repository Template 기능을 활용하여 다음과 같은 이 점을 얻을 수 있었습니다.
1. 멀티레포 방식의 효율적인 프로젝트 세팅 방법
2. 프로젝트 간 일관성 유지
그러나 모노레포 환경으로 이전하면서 Repository Template을 더 이상 활용할 수 없게 되었습니다. 이를 대체하기 위해 저희는 Code Generator를 구현했고 이에 대해 다음 섹션에서 자세히 설명하겠습니다.
4.2 모노레포 환경 구성 세팅하기
쏘카 프론트엔드 모노레포는 Turborepo 기반으로 모노레포 환경을 구성했습니다. 멀티레포와 다르게 하나의 Repository로 프로젝트들을 관리하게 되면서 새로운 스캐폴딩 방식 중 하나인 Code Generator를 도입하게 되었습니다.
아래는 쏘카 프론트엔드 모노레포 환경에서 자동 생성이 필요한 주요 패키지들을 정리했습니다.
App
웹 그룹에서 사용하고 있는 next.js 기반의 프로젝트 세팅 및 프로젝트 구조, Terraform 관련 파일을 담고 있습니다. AWS Amplify 환경 구성된 CI/CD Workflow, 테스트 환경, 코어 라이브러리가 세팅된 템플릿을 제공합니다.
socar-design-system
웹 그룹에서 사용하고 있는 디자인 시스템 컴포넌트를 구성할 때 사용합니다. 컴포넌트 코드에 대한 컨벤션과 스타일 파일을 제공합니다.
utils/hooks
웹 그룹에서 사용하고 있는 공통으로 사용하는 유틸 함수 패키지를 구성할 때 사용합니다. 유틸 기능에 대한 주석 컨벤션과 코드 컨벤션을 제공합니다. hooks도 React 환경에서 사용할 수 있는 유용한 공통 로직을 담고 있습니다.
위와 같은 패키지들은 모노레포에서 사용하고 있는 컨벤션이 적용된 템플릿을 쓸 수 있도록 제공하고 있습니다.
4.3 Code Generator를 활용한 프로젝트 세팅
쏘카 모노레포 환경은 위에서 언급한 것과 같이 Turborepo로 이루어져 있습니다. Turborepo에서는 모노레포 패키지를 보다 효율적으로 활용할 수 있는 제너레이팅 라이브러리 turbo/gen을 제공합니다.
제공하는 turbo/gen의 기반은 JavaScript로 정의할 수 있는 프롬프트 라이브러리인 plop을 활용합니다. 이를 통해 새로운 컨트롤러와 구성 요소가 변경되어도 손쉽게 유지 보수할 수 있는 스크립트 코드를 작성할 수 있습니다.
다음은 Code Gen 구성을 위한 Plop Config에 대한 예제입니다. 기본적으로 Plop 문법을 따르고 있으며 Generator 할 수 있는 Plop Action들을 정의해 사용할 수 있습니다.
// turbo/generators/config.ts
import { type PlopTypes } from '@turbo/gen'
import {
  hooksPlopConfig,
  nextAppPlopConfig,
  socarDesignSystemPlopConfig,
  utilsPlopConfig,
} from '../plops'
import { toUpperCase } from './helpers'
export default function generator(plop: PlopTypes.NodePlopAPI) {
  plop.setGenerator('next', nextAppPlopConfig)
  plop.setGenerator('socar-design-system', socarDesignSystemPlopConfig)
  plop.setGenerator('utils', utilsPlopConfig)
  plop.setGenerator('hooks', hooksPlopConfig)
  plop.setHelper('uppercase', toUpperCase)
}
위와 같이 Plop Config를 역할에 맞도록 파일을 생성하여 유지 관리하고 있습니다.
Plop의 장점으로는 제공하는 add, modify와 같은 정의된 예약어가 아닌, 확장된 설정을 할 수 있습니다. 저희는 커스텀 헬퍼 함수와 액션을 추가하여 생성되는 파일에 대한 ESLint의 fix 옵션을 적용한 프로세스를 설정했습니다.
이를 통해 추가 구현한  socar-design-system 생성 스크립트입니다.
import { type PlopTypes } from '@turbo/gen'
import path from 'path'
import { lintAndFixFiles } from '../utils'
const SOCAR_DESIGN_SYSTEM_SRC_PATH = 'packages/socar-design-system/src' as const
export const socarDesignSystemPlopConfig: PlopTypes.PlopGeneratorConfig = {
  description: "'packages/socar-design-system' 공통 UI 컴포넌트를 생성합니다.'",
  prompts: [
    {
      type: 'input',
      name: 'file',
      message:
        '작업할 컴포넌트 이름을 입력해주세요. (ex: button 입력 시 Button 컴포넌트가 생성됩니다.)',
	    ...
    },
  ],
  actions: [
    {
      type: 'add',
      path: `${SOCAR_DESIGN_SYSTEM_SRC_PATH}/components//styles`,
      templateFile: ...,
    },
    {
      type: 'add',
      path: `${SOCAR_DESIGN_SYSTEM_SRC_PATH}/components//index.tsx`,
      templateFile: ...,
    },
    {
      type: 'modify',
      pattern: /(\n\s*)$/,
      path: `${SOCAR_DESIGN_SYSTEM_SRC_PATH}/components/index.ts`,
      template: ...,
    },
	  async () => {
      const filePath = path.resolve(__dirname, "배럴 파일 경로")
      return await lintAndFixFiles(filePath)
    },
  ],
}
위와 같은 액션 정의를 하여 사용자는 아래와 예시와 같이 CLI를 통해 빠르고 정확하게 프로젝트 세팅을 마무리할 수 있습니다.
Generate 결과. 이 외로도 Github Action 등 설정
4.4 결론
저희는 위와 같이 Code Generator를 도입하여 다음과 같은 이점을 얻을 수 있었습니다.
코드 일관성 유지
모든 새로운 컴포넌트나 유틸리티가 동일한 구조와 스타일로 생성되어 코드 베이스 전체의 일관성을 유지할 수 있습니다.
시간 절약
반복적인 보일러 플레이트 코드 작성을 자동화함으로써 개발자의 시간을 절약할 수 있습니다. 
새로운 프로젝트 생성/세팅 시간이 기존 대비 80% 이상 감소했습니다.
오류 감소
수동으로 파일을 생성하고 설정하는 과정에서 발생할 수 있는 인적 오류를 줄일 수 있습니다.
쉬운 온보딩
새로운 팀원들이 프로젝트 구조와 컨벤션을 빠르게 이해하고 적용할 수 있습니다.
위와 같은 개선은 개발자들의 생산성 향상과 코드 품질 개선으로 이어지고 더 나은 제품을 더 빠르게 제공할 수 있게 해주었고 긍정적인 결과를 보여주었습니다.
5. 마치며
모노레포 도입 이전부터 프로젝트 구성에는 기초 지식이 필요했습니다. 이러한 진입 장벽을 낮추고 개발자들의 부담을 줄이고자 우리는 앞서 소개한 도구들을 도입하게 되었습니다. 개발 팀이 성장하고 프로젝트 규모가 커짐에 따라, 이러한 개선 노력들이 큰 효과를 발휘하기 시작했습니다. 결과적으로 우리는 개발자들이 복잡한 환경 설정보다는 실제 서비스 로직에 더 집중할 수 있는 환경을 만들어가고 있습니다.
Common Resource 팀은 끊임없이 개발자 생산성 향상을 위한 방법을 모색하고 있습니다. 단순히 코드 작성의 효율성을 높이는 것을 넘어, 마치 한 사람이 개발한 것처럼 일관된 코드베이스를 유지하기 위해 다양한 거버넌스(Governance)을 수립하고 있습니다. 또한 개발자들의 일상적인 작업을 돕는 여러 도구들을 지속적으로 개발하고 있습니다.
긴 글을 끝까지 읽어주셔서 감사합니다. 이 글이 여러분의 개발 프로세스 개선에 조금이나마 도움이 되었기를 바랍니다. 앞으로도 저희 팀의 경험과 인사이트를 계속해서 공유하겠습니다.
다음 편에서는 쏘카 프론트엔드 모노레포 - Part2. 코어라이브러리 버전 관리 시리즈로 이어가겠습니다.

쏘카 프론트엔드 모노레포 - Part1. Code Generator로 프로젝트 세팅 자동화하기

댓글