Api: 🐛 Sms type 변환 시, 휴먼 에러 제거 및 예방

[psychology50]

작업 이유

public enum VerificationType {
    GENERAL("general"),
    OAUTH("oauth"),
    USERNAME("username"),
    PASSWORD("password"),
    PHONE("phone");

    private final String type;

    VerificationType(String type) {
        this.type = type;
    }

    public PhoneCodeKeyType toPhoneVerificationType(Provider provider) {
        return switch (this) {
            case OAUTH -> PhoneCodeKeyType.getOauthSignUpTypeByProvider(provider);
            case USERNAME -> PhoneCodeKeyType.FIND_USERNAME;
            case PASSWORD -> PhoneCodeKeyType.FIND_PASSWORD;
            default -> PhoneCodeKeyType.SIGN_UP;
        };
    }
}

• 사용자의 QueryParam을 VerificationType으로 받고 PhoneCodeKeyType으로 치환하는 과정에서 phone 변환 분기 처리를 빠트림.
• case 하나 더 추가하고, default인 경우 예외를 던져 해결할 수도 있지만 보다 근본적인 휴먼 에러 발생 원인을 찾아서 제거

작업 사항

개인적으로 switch문을 좋아하지 않습니다.
상수가 추가될 때마다 개발자가 case 문을 추가하는 방식은 번거로움과 휴먼 에러 가능성의 여지를 제공합니다.

따라서, 각 상수마다 PhoneCodeKeyType을 매핑하는 방법으로 수정했습니다.

public enum VerificationType {
    GENERAL("general", PhoneCodeKeyType.SIGN_UP),
    OAUTH("oauth", null),
    USERNAME("username", PhoneCodeKeyType.FIND_USERNAME),
    PASSWORD("password", PhoneCodeKeyType.FIND_PASSWORD),
    PHONE("phone", PhoneCodeKeyType.PHONE);

    private final String type;
    private final PhoneCodeKeyType phoneCodeKeyType;

    VerificationType(String type, PhoneCodeKeyType phoneCodeKeyType) {
        this.type = type;
        this.phoneCodeKeyType = phoneCodeKeyType;
    }

    public PhoneCodeKeyType toPhoneVerificationType(@Nonnull Provider provider) {
        if (this.equals(OAUTH)) {
            return PhoneCodeKeyType.getOauthSignUpTypeByProvider(provider);
        }

        return phoneCodeKeyType;
    }
}

• OAuth 상수의 경우 일대다 매핑이 되기 때문에, 컴파일 시점에는 비결정적일 수 밖에 없어 null처리를 했습니다.
• 그 외에는 일대일로 매핑된 PhoneCodeKeyType을 명시적으로 할당하도록 만들었으며, 장기적으로 개발자의 휴먼 에러를 방지할 수 있습니다.
• 또한 공개 메서드를 단 하나만 외부에 노출시킴으로써, 해당 열거 타입을 사용하는 개발자가 실수를 할 경우 또한 없다고 판단합니다.

리뷰어가 중점적으로 확인해야 하는 부분

• null 처리를 하는 것이 맞을지, 더 좋은 방법이 있을까요?

발견한 이슈

• 내 지능 이슈..