[Git] Fix vs Refactor

 

커밋 메시지를 작성할 때 항상 고민되는 부분이 있습니다. 바로 코드를 변경했을 때 fix를 써야 할지, refactor를 써야 할지 결정하는 것이죠. 이 두 용어의 차이점을 명확히 이해하고 적절히 사용하고자 이번에 제대로 알아보기로 했습니다.

 

Fix: 버그 수정

fix는 기존 코드의 버그나 오류를 수정할 때 사용합니다. 이는 코드가 의도한 대로 작동하지 않는 문제를 해결하기 위해 코드의 동작을 변경해야 하는 경우에 사용됩니다.

• 사용자가 특정 버튼을 클릭했을 때 의도한 동작이 수행되지 않는 문제 해결
• API 호출 결과가 잘못된 데이터를 반환하는 경우 수정

로그인 함수를 예시로 들어보겠습니다:

// 버그가 있는 기존 코드
function login(username, password) {
  if (username === '' || password === '') {
    return 'Error: Empty fields';
  }

  // 잘못된 조건으로 인해 항상 로그인 실패
  if (username !== 'admin' && password !== '1234') {
    return 'Login failed';
  }

  return 'Login successful';
}

위 코드는 username과 password 모두 맞아야 로그인에 성공해야 하지만, 조건이 잘못되어 항상 로그인 실패 메시지를 반환하고 있습니다.

// 수정된 코드
function login(username, password) {
  if (username === '' || password === '') {
    return 'Error: Empty fields';
  }

  // 논리 오류 수정
  if (username !== 'admin' || password !== '1234') {
    return 'Login failed';
  }

  return 'Login successful';
}

이런 경우 다음과 같이 커밋 메세지를 작성할 수 있습니다:

fix: 로그인 조건 논리 오류 수정

 

Refactor: 코드 구조 개선

refactor는 기능의 변경 없이 코드의 구조나 가독성을 개선할 때 사용합니다. 리팩토링은 외부 동작을 변경하지 않고 내부 구조를 개선하는 과정입니다. 즉, 코드의 동작에는 영향을 주지 않고, 코드의 품질을 높이기 위한 변경에 사용됩니다.

• 중복된 코드를 함수로 분리하여 재사용성을 높이는 경우
• 코드의 가독성을 위해 변수명을 더 명확하게 변경하는 경우

위와 동일하게 로그인 함수를 예시로 들어보겠습니다:

// 기존 코드
function login(username, password) {
  if (username === '' || password === '') {
    return 'Error: Empty fields';
  }

  if (username !== 'admin' || password !== '1234') {
    return 'Login failed';
  }

  return 'Login successful';
}

중복된 조건 검사가 포함되어 있으므로 이를 함수로 분리하여 가독성을 높일 수 있습니다.

// 리팩토링된 코드
function isEmptyField(value) {
  return value === '';
}

function isValidCredentials(username, password) {
  return username === 'admin' && password === '1234';
}

function login(username, password) {
  if (isEmptyField(username) || isEmptyField(password)) {
    return 'Error: Empty fields';
  }

  if (!isValidCredentials(username, password)) {
    return 'Login failed';
  }

  return 'Login successful';
}

이런 경우 다음과 같이 커밋 메세지를 작성할 수 있습니다:

refactor: 중복된 필드 검사와 인증 로직 함수로 분리

 

Fix vs Refactor: 경계가 모호한 경우

그렇다면 다음과 같은 경우에는 어떻게 해야 할까요? 다음과 같이 배열에서 특정 항목의 존재 여부를 확인하는 함수가 있다고 가정해 봅시다:

// 기존 코드
function hasItem(arr, item) {
  for (let i = 0; i < arr.length; i++) {
    if (arr[i] === item) {
      return true;
    }
  }
  return false;
}

이 코드는 작은 배열에서는 성능 문제가 없겠지만, 배열 크기가 커지면 성능이 저하될 수 있습니다.

 

이를 개선하기 위해 Set을 사용하여 다음과 같이 수정할 수 있습니다:

// 수정된 코드
function hasItem(arr, item) {
  const set = new Set(arr);
  return set.has(item);
}

이러한 변경을 커밋할 때, fix와 refactor 중 어떤 것을 선택해야 할까요? 이는 상황에 따라 다를 수 있습니다:

• Fix 관점: 성능 문제가 사용자 경험에 직접적인 영향을 미치는 경우, 이를 "버그"로 간주할 수 있습니다. 느린 성능도 일종의 버그이기 때문입니다. 이 관점에서는 'fix'가 적절할 수 있습니다.
• Refactor 관점: 코드의 외부 동작(함수의 입력과 출력)은 변하지 않았습니다. 단지 내부 구현만 개선되었죠. 이는 전형적인 리팩토링의 특징입니다. 따라서 'refactor'로 볼 수도 있습니다.

이처럼 경계가 모호한 상황에서는 정답이 없을 수 있습니다. 이런 경우 팀의 컨벤션과 해당 변경의 주요 목적을 고려해 판단하는 것이 좋습니다.

 

결국 커밋 메시지의 핵심은 변경사항을 명확하게 전달하는 데 있습니다. fix나 refactor 같은 단어 선택보다는 변경 이유와 그 영향을 잘 설명하는 데 초점을 맞추는 게 더 중요할 것 같습니다.