Feat/#139/develop material user feedback(swm 392)

[D-w-nJ]

Motivation 🤔

• 강의자료 (강의노트, 퀴즈) 피드백 api를 개발합니다.

Key changes ✅

• fast api에서 받아오는 json 객체 리스트를 각각 매핑시켜 저장하는 방식을 통해 강의자료 중 하나라도 에러가 있을 시 넘어온 자료 모두 저장이 되지 않는 문제를 해결하였습니다.
• [POST] /material/{quizId or summaryId}/feedback?type= API가 개발되었습니다.
  • type에는 "quiz" 또는 "summary" 문자열이 전달되며, 인식하지 못하는 다른 문자가 입력되면 다음과 같은 에러메시지가 전달됩니다.

   {
      "status_code": 404,
      "message": "강의자료 타입을 찾을 수 없습니다. 입력받은 타입 : quiiiz"
    }

• db내에 저장되지 않은 summaryId, quizId일 경우 다음과 같은 에러메시지가 전달됩니다.

   {
      "status_code": 404,
      "message": "해당 퀴즈를 찾을 수 없습니다."
   }

• 제대로 피드백이 저장된다면 다음과 같은 메시지를 전달합니다.
  • 아래 메시지는 피드백 받은 강의자료 타입이 퀴즈이며, 더이상 피드백이 불가능하며, 피드백이 저장되었으며, 긍정적이지 않은(bad) 피드백이었음을 말합니다.

   {
      "type": "quiz",
      "available": false,
      "has_feedback": true,
      "satisfactory": false
    }

• 중복하여 피드백을 하고자 할 경우 에러메시지가 뜨지 않으며, db 에 저장되지 않고 저장되었을 때와 마찬가지의 json 형태로 메시지가 전달됩니다.
• [GET] /material/{courseVideoId} API 에서는 유저가 이미 피드백을 했는지, 피드백이 가능한 상태인지 상태를 전달합니다.
  • 이때 수정된 summary의 경우 피드백이 불가하므로 available이 false입니다.
  • 이미 피드백을 한 퀴즈/요약본의 경우 available=false 이고, hasFeedback=true 입니다. (밑에 예시 퀴즈 114번)

{
  "status": 1,
  "total_quiz_count": 3,
  "quizzes": [
    {
      "id": 113,
      "type": 1,
      "question": "마지막 장면을 원하는 시간만큼 정지 화면으로 유지하고 싶을 때 어떤 기능을 사용해야 할까요?",
      "options": [
        "사진에서 격자 모양을 누르기",
        "사진을 캡처하기",
        "현재 프레임 저장 기능을 사용하기"
      ],
      "answer": "1",
      "submitted_at": null,
      "submitted_answer": null,
      "feedback_info": {
        "type": "quiz",
        "available": true,
        "has_feedback": false,
        "satisfactory": false
      },
      "is_submitted": false,
      "is_correct": false,
      "is_scrapped": false
    },
    {
      "id": 114,
      "type": 1,
      "question": "영상이 없는 경우에도 충분한 움직임을 가진 사진을 만들기 위해서는 어떤 기능을 사용해야 할까요?",
      "options": [
        "사진을 캡처하기",
        "사진에서 격자 모양을 누르기",
        "현재 프레임 저장 기능을 사용하기"
      ],
      "answer": "2",
      "submitted_at": null,
      "submitted_answer": null,
      "feedback_info": {
        "type": "quiz",
        "available": false,
        "has_feedback": true,
        "satisfactory": false
      },
      "is_submitted": false,
      "is_correct": false,
      "is_scrapped": false
    },
    {
      "id": 115,
      "type": 1,
      "question": "현재 프레임 저장 기능을 사용하면 어떤 것을 저장할 수 있을까요?",
      "options": [
        "원하는 시간만큼 정지 화면",
        "마지막 장면",
        "영상의 전체 프레임"
      ],
      "answer": "1",
      "submitted_at": null,
      "submitted_answer": null,
      "feedback_info": {
        "type": "quiz",
        "available": true,
        "has_feedback": false,
        "satisfactory": false
      },
      "is_submitted": false,
      "is_correct": false,
      "is_scrapped": false
    }
  ],
  "summary_brief": {
    "id": 35,
    "content": "<button id=\"00000\" class=\"timestamp\" style=\"color:#FA5B3E;font-size: 1.125rem;line-height: 1.75rem;text-decoration-line:none;display:inline-block;background-color:rgba(250, 91, 62, 0.2);border-radius:0.25rem;padding:0.125rem 0.25rem;\">0:00:00</button>\n### 스크립트 요약\n\n안녕하세요. 파이널컷무비입니다. 오늘은 구독자님의 질문에 대해 답변드리겠습니다. 영상이 없는 경우에는 사진의 움직임만으로도 충분합니다. 마지막 장면을 원하는 시간만큼 정지 화면으로 유지하고 싶다면, 사진에서 격자 모양을 누르고 제일 뒤에 있는 기능을 사용하면 됩니다. 마지막 화면을 캡처해서 붙이면 됩니다. 현재 프레임 저장 기능을 사용하면 원하는 프레임만 저장할 수 있습니다. 이 방식을 응용하면 됩니다. 이상으로 오늘은 여기까지입니다. 파이널컷 무비였습니다.\n \n ",
    "modified_at": "2023-11-19 17:21:20",
    "feedback_info": {
      "type": "summary",
      "available": true,
      "has_feedback": false,
      "satisfactory": false
    },
    "is_modified": false
  }
}

• 또한 다음과 같이 이미 피드백된 강의자료를 한번더 피드백하게되면 다음 메시지와 함께 에러가 뜨게됩니다.

    {
      "status_code": 400,
      "message": "이미 피드백된 강의자료입니다."
    }

• 수정된 요약본의 경우에는 피드백이 불가합니다.

{
  "status_code": 400,
  "message": "수정된 요약본은 사용자 피드백이 불가합니다."
}

To reviewers 🙏

• 작동이 잘 되는지 확인해주세요 (api 실행하실때는 authorization 헤더를 포함하셔야 합니다.)
• 전달 메시지 형태, 필드명 등 피드백해주시고 수정사항 말해주세요

[oikkoikk]

확인했습니다~