[SWEP-68] 챌린지 수락, 완료, 조회, 에러 핸들링

[codie0226]

Sweepic Server PR List

⚒️develop의 최신 커밋을 pull 받았나요?

• 최신 커밋 업데이트

🔍️ 이 PR을 통해 해결하려는 문제가 무엇인가요?

어떤 기능을 구현한건지, 이슈 대응이라면 어떤 이슈인지 PR이 열리게 된 계기와 목적을 Reviewer 들이 쉽게 이해할 수 있도록 적어 주세요
일감 백로그 링크나 다이어그램, 피그마를 첨부해도 좋아요

• 챌린지의 status를 변경하는 api들입니다.
• 수락하는 경우에는 챌린지가 수락되어있는지, 완료되어있는지 먼저 확인합니다.
• 완료하는 경우에도 마찬가지로 수락되어있는지 확인합니다.
• 한 유저가 가지고 있는 모든 챌린지의 목록을 조회할 수 있는 api입니다.
• 낭니 스타일로 에러 핸들링 완료하였습니다.

✨ 이 PR에서 핵심적으로 변경된 사항은 무엇일까요? (핵심 작업 내용)

문제를 해결하면서 주요하게 변경된 사항들을 적어 주세요

• challenge.repositories.ts

export const acceptChallenge = async (data: bigint): Promise<Challenge | null> => {
    const state: {status: number} | null = await prisma.challenge.findFirst({
        where: {id: data},
        select: {
            status: true
        }
    });

    if(!state){
        throw new ChallengeAcceptError({challengeId: data, reason: '챌린지가 존재하지 않습니다.'});
    }

    if(state.status === 2 || state.status === 3){
        throw new ChallengeAcceptError({challengeId: data, reason: '챌린지가 이미 수락되거나 완료되었습니다.'});
    } 

    const updatedChallenge = await prisma.challenge.update({
        where: {id: data},
        data: {
            status: 2,
            acceptedAt: new Date()
        }  //status: 1 = created, 2 = accepted, 3 = completed
    });

    return updatedChallenge;
};

해당 코드와 같이 status 값을 변경해주고, acceptedAt 컬럼을 new Date를 통해 현재 시간으로 바꿔줍니다. completeChallenge 함수도 같은 원리로 작동됩니다. update 전 챌린지가 변경될 수 있는 상태인지 먼저 확인합니다.

challenge.dtos.ts

export const responseFromGetByUserId = (
    challenges: ResponseFromGetByUserId[]
): ResponseFromGetByUserIdReform[] => {
    return challenges.map((value: ResponseFromGetByUserId) => {
        const {id, title, context, requiredCount, remainingCount, userId,
            createdAt, updatedAt, acceptedAt, completedAt, status, locationChallenge, dateChallenge
        } = value;

        return {
            id: id.toString(),
            title,
            context,
            challengeLocation: locationChallenge?.challengeLocation,
            challengeDate: dateChallenge?.challengeDate,
            requiredCount,
            remainingCount,
            userId: userId.toString(),
            createdAt,
            updatedAt,
            acceptedAt,
            completedAt,
            status
        };
    });
};

객체 배열을 다뤄주기 위한 함수입니다. 어찌된 일인지 typescript는 바로 배열형태로 입력받아 다루는 걸 허용하지 않더라고요. 따라서 map형식으로 배열의 원소 하나하나를 뜯어서 구조 분해 할당 시켜주고 다시 return시켜 배열 형태로 다시 만들어주고 최종적으로 객체 배열을 return하게 됩니다.

challenge.entities.ts

export interface ResponseFromGetByUserId {
    locationChallenge: {
        challengeLocation: string;
    } | null;
    dateChallenge: {
        challengeDate: Date;
    } | null;

    id: bigint;
    userId: bigint;
    title: string;
    context: string;
    requiredCount: number;
    remainingCount: number;
    createdAt: Date;
    updatedAt: Date | null;
    acceptedAt: Date | null;
    completedAt: Date | null;
    status: number;
}

export interface ResponseFromGetByUserIdReform {
    id: string;
    userId: string;
    title: string;
    context: string;
    challengeLocation: string | undefined;
    challengeDate: Date | undefined;
    requiredCount: number;
    remainingCount: number;
    createdAt: Date;
    updatedAt: Date | null;
    acceptedAt: Date | null;
    completedAt: Date | null;
    status: number;
}

챌린지 배열을 다시 클라이언트로 돌아갈 때의 형식을 만들었습니다...만.
json은 string으로만 받으므로 어쩔 수 없이 2개 만들고 서버와 클라이언트 오갈 수 있게 만들었습니다.
사실 id: string | bigint 형식으로 만들 수도 있었겠지만 그렇게 하면 typescript의 의미가 없어지므로 일단 저렇게 했습니다.

🤚 동작 확인

기능을 실행했을 때 정상 동작하는지 여부를 확인하고 스크린 샷을 올려주세요

🔖 핵심 변경 사항 외에 추가적으로 변경된 부분이 있나요?

없으면 "없음" 이라고 기재해 주세요

• 에러 핸들링 완료했습니다. 형식이나 메세지가 좀 어색하거나 통일되어 있지 않은 부분이 있다면 바로 리뷰 남겨주시면 고치겠습니다.
• swagger를 정적 파일로 만들면서 기존의 문제는 해결되었습니다만 왜인지는 모르겠는데 params를 받는 api는 목록에 뜨기는 하나 설명이 나오지 않습니다. 참고로 웬티 코드 복붙하고 안에 내용만 바꿨습니다. 만약 문법이 틀린 것이 있다면 리뷰 남겨주시면 고치겠습니다.

🙏 Reviewer 분들이 이런 부분을 신경써서 봐 주시면 좋겠어요

개발 과정에서 다른 분들의 의견은 어떠한지 궁금했거나 크로스 체크가 필요하다고 느껴진 코드가 있다면 남겨주세요

• swagger 문법
• challenges.entities.ts 파일에서 만든 인터페이스 2개가 사실 굉장이 비효율적이고 아름답지 않다고 느껴집니다. 저거를 이쁘게 해결할 수 있는 방법이 있다면 알려주세요.

🩺 이 PR에서 테스트 혹은 검증이 필요한 부분이 있을까요?

테스트가 필요한 항목이나 테스트 코드가 추가되었다면 함께 적어주세요

📌 PR 진행 시 이러한 점들을 참고해 주세요

• Reviewer 분들은 코드 리뷰 시 좋은 코드의 방향을 제시하되, 코드 수정을 강제하지 말아 주세요.
• Reviewer 분들은 좋은 코드를 발견한 경우, 칭찬과 격려를 아끼지 말아 주세요.
• Review는 특수한 케이스가 아니면 Reviewer로 지정된 시점 기준으로 2일 이내에 진행해 주세요.
• Comment 작성 시 Prefix로 P1, P2, P3 를 적어 주시면 Assignee가 보다 명확하게 Comment에 대해 대응할 수 있어요
  • P1 : 꼭 반영해 주세요 (Request Changes) - 이슈가 발생하거나 취약점이 발견되는 케이스 등
  • P2 : 반영을 적극적으로 고려해 주시면 좋을 것 같아요 (Comment)
  • P3 : 이런 방법도 있을 것 같아요~ 등의 사소한 의견입니다 (Chore)

---

📝 Assignee를 위한 CheckList

• To-Do Item

[jjiinaaa]

catch 문 뒤에 baseError 처리로 해야하는 것으로 압니다. 모든 파일이 공통적으로 그렇게 안되어있는데 한 번 낭니 PR 보세요 ~

[jjiinaaa]

이 파일에서 낭니가 만들어놓은 에러 클래스들 명이나 양식 바꾸시고 적용하신거같은데, 곧 낭니가 재업데이트하면 아마 컨플릭날 수도 있습니다.

[jjiinaaa]

이건 이렇게 하는거 아닙니다. baseError 형식을 catch 문 뒤에 넣어야해요~ 관련 사항은 낭니 지난 PR 에 있는데 다 적용이 안되있고 몇 개만 적용이 될겁니다.

[jonaeunnn]

이거 제가 다시 구체적으로해서 곧 올리겠습니다!!!!

[jjiinaaa]

낭니 PR 보시고 바꿔보세요. 아마 next(error)로 넘겨주는 로직이 될겁니다.

[jjiinaaa]

마찬가지

[jjiinaaa]

마찬가지

[jjiinaaa]

로컬로 해도 되나요? 안되는걸로 아는데

[jjiinaaa]

catch 문에 error처리할 때 next(error)로 처리해야합니다. 관련한 사항은 최근에 머지된 낭니 PR에 있으니 이거에 맞춰 해보시기 바랍니다.

[jjiinaaa]

낭니 PR 보시고 바꿔보세요. 아마 next(error)로 넘겨주는 로직이 될겁니다.