From 9745cbeb2fb42921fe3f46e880a6f617bbbd1790 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A1muel=20Fekete?= <feketesamu@gmail.com>
Date: Sat, 13 Jan 2024 11:41:38 +0100
Subject: [PATCH] user feedback & message to event_rating

---
 .../client/src/api/contexts/RatingContext.tsx |  4 ++
 .../src/api/contexts/RatingProvider.tsx       | 32 ++++++---
 .../client/src/api/hooks/eventQueryHooks.ts   |  2 +-
 packages/client/src/api/hooks/ratingHooks.ts  | 10 ++-
 .../client/src/pages/ratings/Rating.page.tsx  |  8 ++-
 .../ratings/components/CriterionRateForm.tsx  |  2 +-
 .../components/DesktopRatingProgressBar.tsx   |  8 ++-
 .../ratings/components/SubmitRatingModal.tsx  | 70 +++++++++++++++++++
 packages/common/src/lib/types/eventRatings.ts |  8 ++-
 .../functions/src/functions/ratings/submit.ts | 12 +++-
 packages/functions/src/functions/seed.ts      |  4 +-
 .../functions/src/typeorm/configOptions.ts    |  3 +-
 .../src/typeorm/entities/EventRating.ts       |  3 +
 .../1705141629515-message_to_rating.ts        | 14 ++++
 14 files changed, 155 insertions(+), 25 deletions(-)
 create mode 100644 packages/client/src/pages/ratings/components/SubmitRatingModal.tsx
 create mode 100644 packages/functions/src/typeorm/migrations/1705141629515-message_to_rating.ts

diff --git a/packages/client/src/api/contexts/RatingContext.tsx b/packages/client/src/api/contexts/RatingContext.tsx
index d8ace20..90bbc65 100644
--- a/packages/client/src/api/contexts/RatingContext.tsx
+++ b/packages/client/src/api/contexts/RatingContext.tsx
@@ -18,6 +18,8 @@ export type RatingContextType = {
   rateCriteria: (criterionId: number[]) => void
   nextCategory: () => void
   previousCategory: () => void
+  submitRating: (message?: string) => void
+  openSubmitModal: (onSuccessfulOpen: () => void) => void
 }
 
 export const RatingContext = createContext<RatingContextType>({
@@ -37,4 +39,6 @@ export const RatingContext = createContext<RatingContextType>({
   rateCriteria: () => {},
   nextCategory: () => {},
   previousCategory: () => {},
+  submitRating: () => {},
+  openSubmitModal: () => {},
 })
diff --git a/packages/client/src/api/contexts/RatingProvider.tsx b/packages/client/src/api/contexts/RatingProvider.tsx
index 35ee999..5b833b5 100644
--- a/packages/client/src/api/contexts/RatingProvider.tsx
+++ b/packages/client/src/api/contexts/RatingProvider.tsx
@@ -94,6 +94,15 @@ export const RatingProvider = ({ children }: PropsWithChildren) => {
     setRatedCriteria(newArray)
   }
 
+  const openSubmitModal = (onSuccessfulOpen: () => void) => {
+    if (category?.criteria.some((c) => !ratedCriteria.includes(generateCriterionId(c.id)))) {
+      setValidate(true)
+      toast({ title: 'Minden szempont kitöltése kötelező!', status: 'warning' })
+      return
+    }
+    onSuccessfulOpen()
+  }
+
   const nextCategory = () => {
     if (!data) {
       return
@@ -191,15 +200,18 @@ export const RatingProvider = ({ children }: PropsWithChildren) => {
     setStage(newStage)
   }
 
-  const submitRating = () => {
-    submitMutation.mutate(ratingId, {
-      onSuccess: () => {
-        reset()
-        toast({ title: 'Értékelés véglegesítve!', status: 'success' })
-        navigate(`${PATHS.EVENTS}/${data?.eventId}`)
-      },
-      onError: (e) => onError(e, toast),
-    })
+  const submitRating = (message?: string) => {
+    submitMutation.mutate(
+      { ratingId, message },
+      {
+        onSuccess: () => {
+          reset()
+          toast({ title: 'Értékelés véglegesítve!', status: 'success' })
+          navigate(`${PATHS.EVENTS}/${data?.eventId}`)
+        },
+        onError: (e) => onError(e, toast),
+      }
+    )
   }
 
   const reset = () => {
@@ -231,6 +243,8 @@ export const RatingProvider = ({ children }: PropsWithChildren) => {
         rateCriterion,
         nextCategory,
         previousCategory,
+        submitRating,
+        openSubmitModal,
       }}
     >
       {children}
diff --git a/packages/client/src/api/hooks/eventQueryHooks.ts b/packages/client/src/api/hooks/eventQueryHooks.ts
index dfaa379..f10ec5b 100644
--- a/packages/client/src/api/hooks/eventQueryHooks.ts
+++ b/packages/client/src/api/hooks/eventQueryHooks.ts
@@ -33,7 +33,7 @@ export const useFetchRateableEventsFromCache = () => {
       const res = await functionAxios.get<DbEvent[]>('cached/events/rateable')
       return res.data.sort((e1, e2) => -e1.startDate.localeCompare(e2.startDate))
     },
-    { retry: false }
+    { retry: false, enabled: false } // cache likely won't be used in the future
   )
 }
 
diff --git a/packages/client/src/api/hooks/ratingHooks.ts b/packages/client/src/api/hooks/ratingHooks.ts
index d254213..c891688 100644
--- a/packages/client/src/api/hooks/ratingHooks.ts
+++ b/packages/client/src/api/hooks/ratingHooks.ts
@@ -7,6 +7,7 @@ import {
   GetEventRating,
   PageTurn,
   PontozoError,
+  SubmitEventRating,
 } from '@pontozo/common'
 import { useMutation, useQuery } from '@tanstack/react-query'
 import { functionAxios } from '../../util/axiosConfig'
@@ -18,9 +19,14 @@ export const useStartRatingMutation = () => {
   )
 }
 
+type SubmitEventRatingMutation = SubmitEventRating & {
+  ratingId: number
+}
+
 export const useSubmitRatingMutation = () => {
-  return useMutation<unknown, PontozoError, number>(
-    async (ratingId: number) => (await functionAxios.post(`${FUNC_HOST}/ratings/${ratingId}/submit`)).data
+  return useMutation<unknown, PontozoError, SubmitEventRatingMutation>(
+    async (data: SubmitEventRatingMutation) =>
+      (await functionAxios.post<SubmitEventRating>(`${FUNC_HOST}/ratings/${data.ratingId}/submit`, { message: data.message })).data
   )
 }
 
diff --git a/packages/client/src/pages/ratings/Rating.page.tsx b/packages/client/src/pages/ratings/Rating.page.tsx
index ecf1853..dec427a 100644
--- a/packages/client/src/pages/ratings/Rating.page.tsx
+++ b/packages/client/src/pages/ratings/Rating.page.tsx
@@ -1,14 +1,15 @@
 import { Button, HStack, useMediaQuery } from '@chakra-ui/react'
+import { RatingStatus } from '@pontozo/common'
 import { createPortal } from 'react-dom'
 import { FaChevronLeft, FaChevronRight } from 'react-icons/fa'
 import { useParams } from 'react-router-dom'
 import { HelmetTitle } from 'src/components/commons/HelmetTitle'
-import { RatingStatus } from '../../../../common/src'
 import { useRatingContext } from '../../api/contexts/useRatingContext'
 import { LoadingSpinner } from '../../components/commons/LoadingSpinner'
 import { CategoryWithCriteriaList } from './components/CategoryWithCriteriaList'
 import { DesktopRatingProgressBar } from './components/DesktopRatingProgressBar'
 import { MobileRatingProgressBar } from './components/MobileRatingProgressBar'
+import { SubmitRatingModal } from './components/SubmitRatingModal'
 
 export const RatingPage = () => {
   const { ratingId } = useParams()
@@ -28,9 +29,10 @@ export const RatingPage = () => {
         <Button leftIcon={<FaChevronLeft />} onClick={() => previousCategory()}>
           {hasPrev ? 'Előző' : 'Vissza a versenyhez'}
         </Button>
-        {(eventRatingInfo?.status === RatingStatus.STARTED || hasNext) && (
+        {eventRatingInfo?.status === RatingStatus.STARTED && !hasNext && <SubmitRatingModal colorScheme="brand" />}
+        {hasNext && (
           <Button rightIcon={<FaChevronRight />} colorScheme="brand" onClick={() => nextCategory()}>
-            {hasNext ? 'Következő' : 'Véglegesítés'}
+            Következő
           </Button>
         )}
       </HStack>
diff --git a/packages/client/src/pages/ratings/components/CriterionRateForm.tsx b/packages/client/src/pages/ratings/components/CriterionRateForm.tsx
index 8dd2af3..e5aa5ff 100644
--- a/packages/client/src/pages/ratings/components/CriterionRateForm.tsx
+++ b/packages/client/src/pages/ratings/components/CriterionRateForm.tsx
@@ -46,7 +46,7 @@ export const CriterionRateForm = ({ criterion }: Props) => {
           {criterion.text1 && <Radio value="1">{criterion.text1}</Radio>}
           {criterion.text2 && <Radio value="2">{criterion.text2}</Radio>}
           {criterion.text3 && <Radio value="3">{criterion.text3}</Radio>}
-          {criterion.allowEmpty && <Radio value="-1">Nem tudom megítélni</Radio>}
+          {criterion.allowEmpty && <Radio value="-1">Nem tudom megítélni/nem releváns</Radio>}
         </Stack>
       </RadioGroup>
     </FormControl>
diff --git a/packages/client/src/pages/ratings/components/DesktopRatingProgressBar.tsx b/packages/client/src/pages/ratings/components/DesktopRatingProgressBar.tsx
index d6091a2..588d990 100644
--- a/packages/client/src/pages/ratings/components/DesktopRatingProgressBar.tsx
+++ b/packages/client/src/pages/ratings/components/DesktopRatingProgressBar.tsx
@@ -9,6 +9,7 @@ import { formatDateRange } from 'src/util/formatDateRange'
 import { PATHS } from 'src/util/paths'
 import './progressBar.css'
 import { ProgressBarItem } from './ProgressBarItem'
+import { SubmitRatingModal } from './SubmitRatingModal'
 
 export const DesktopRatingProgressBar = () => {
   const { eventRatingInfo, nextCategory, previousCategory, hasNext, hasPrev } = useRatingContext()
@@ -72,9 +73,10 @@ export const DesktopRatingProgressBar = () => {
           <Button color="brand.500" leftIcon={<FaChevronLeft />} onClick={() => previousCategory()} variant="ghost">
             {hasPrev ? 'Előző' : 'Vissza'}
           </Button>
-          {(eventRatingInfo.status === RatingStatus.STARTED || hasNext) && (
-            <Button color="brand.500" rightIcon={<FaChevronRight />} onClick={() => nextCategory()} variant="ghost">
-              {hasNext ? 'Következő' : 'Véglegesítés'}
+          {eventRatingInfo?.status === RatingStatus.STARTED && !hasNext && <SubmitRatingModal variant="ghost" color="brand.500" />}
+          {hasNext && (
+            <Button rightIcon={<FaChevronRight />} onClick={() => nextCategory()} variant="ghost">
+              Következő
             </Button>
           )}
         </HStack>
diff --git a/packages/client/src/pages/ratings/components/SubmitRatingModal.tsx b/packages/client/src/pages/ratings/components/SubmitRatingModal.tsx
new file mode 100644
index 0000000..267d434
--- /dev/null
+++ b/packages/client/src/pages/ratings/components/SubmitRatingModal.tsx
@@ -0,0 +1,70 @@
+import {
+  Button,
+  FormControl,
+  FormLabel,
+  Modal,
+  ModalBody,
+  ModalCloseButton,
+  ModalContent,
+  ModalFooter,
+  ModalHeader,
+  ModalOverlay,
+  Text,
+  Textarea,
+  useDisclosure,
+} from '@chakra-ui/react'
+import { useState } from 'react'
+import { FaChevronRight } from 'react-icons/fa'
+import { useRatingContext } from 'src/api/contexts/useRatingContext'
+
+type Props = {
+  variant?: string
+  color?: string
+  colorScheme?: string
+}
+
+export const SubmitRatingModal = ({ variant, color, colorScheme }: Props) => {
+  const { submitRating, openSubmitModal } = useRatingContext()
+  const [value, setValue] = useState('')
+  const { isOpen, onClose, onOpen } = useDisclosure()
+  return (
+    <>
+      <Button
+        color={color}
+        colorScheme={colorScheme}
+        rightIcon={<FaChevronRight />}
+        variant={variant}
+        onClick={() => openSubmitModal(onOpen)}
+      >
+        Véglegesítés
+      </Button>
+      <Modal isOpen={isOpen} onClose={onClose}>
+        <ModalOverlay />
+        <ModalContent>
+          <ModalHeader>Értékelés véglegesítése</ModalHeader>
+          <ModalCloseButton />
+          <ModalBody textAlign="justify">
+            <Text mb={5}>
+              Köszönjük, hogy értékelted a versenyt! Az értékélest a 'Küldés' gombbal tudod véglegesíteni, ezután már nem fogod tudni
+              szerkeszteni. Ha szeretnél még szöveges formában visszajelzést küldeni a szervezőknek, azt megteheted az alábbi
+              szövegdobozban.
+            </Text>
+            <FormControl>
+              <FormLabel>Szöveges visszajelzés (opcionális)</FormLabel>
+              <Textarea rows={8} value={value} onChange={(e) => setValue(e.target.value)} />
+            </FormControl>
+          </ModalBody>
+
+          <ModalFooter>
+            <Button mr={3} colorScheme="gray" onClick={onClose}>
+              Mégse
+            </Button>
+            <Button colorScheme="brand" mr={3} onClick={() => submitRating(value)}>
+              Küldés
+            </Button>
+          </ModalFooter>
+        </ModalContent>
+      </Modal>
+    </>
+  )
+}
diff --git a/packages/common/src/lib/types/eventRatings.ts b/packages/common/src/lib/types/eventRatings.ts
index 7d41adc..ff4a2db 100644
--- a/packages/common/src/lib/types/eventRatings.ts
+++ b/packages/common/src/lib/types/eventRatings.ts
@@ -1,4 +1,4 @@
-import { ArrayNotEmpty, ArrayUnique, IsEnum, IsInt, IsOptional, Min } from 'class-validator'
+import { ArrayNotEmpty, ArrayUnique, IsEnum, IsInt, IsOptional, IsString, Min } from 'class-validator'
 import { CategoryWithCriteria } from './categories'
 import { DbEvent, DbStage } from './dbEvents'
 
@@ -87,3 +87,9 @@ export type RatingStartedResponse = {
   id: number
   status: string
 }
+
+export class SubmitEventRating {
+  @IsOptional()
+  @IsString()
+  message?: string
+}
diff --git a/packages/functions/src/functions/ratings/submit.ts b/packages/functions/src/functions/ratings/submit.ts
index b351055..dbb0226 100644
--- a/packages/functions/src/functions/ratings/submit.ts
+++ b/packages/functions/src/functions/ratings/submit.ts
@@ -1,10 +1,11 @@
 import { app, HttpRequest, HttpResponseInit, InvocationContext } from '@azure/functions'
-import { isHigherRank, PontozoException, RatingStatus } from '@pontozo/common'
+import { isHigherRank, PontozoException, RatingStatus, SubmitEventRating } from '@pontozo/common'
+import { plainToClass } from 'class-transformer'
 import { getUserFromHeader } from '../../service/auth.service'
 import EventRating from '../../typeorm/entities/EventRating'
 import { getAppDataSource } from '../../typeorm/getConfig'
 import { handleException } from '../../util/handleException'
-import { validateId } from '../../util/validation'
+import { validateBody, validateId, validateWithWhitelist } from '../../util/validation'
 
 /**
  * Called when the users submits their rating of an event.
@@ -14,6 +15,10 @@ export const submitOne = async (req: HttpRequest, context: InvocationContext): P
   try {
     const id = validateId(req)
     const user = getUserFromHeader(req)
+    validateBody(req)
+    const dto = plainToClass(SubmitEventRating, await req.json())
+    await validateWithWhitelist(dto)
+
     const ads = await getAppDataSource(context)
     const eventRatingRepo = ads.getRepository(EventRating)
     const rating = await eventRatingRepo.findOne({
@@ -41,6 +46,9 @@ export const submitOne = async (req: HttpRequest, context: InvocationContext): P
       throw new PontozoException('Nem értékelted le a versenyt az összes szempont szerint!', 400)
     }
 
+    if (dto.message) {
+      rating.message = dto.message
+    }
     rating.status = RatingStatus.SUBMITTED
     rating.submittedAt = new Date()
     await eventRatingRepo.save(rating)
diff --git a/packages/functions/src/functions/seed.ts b/packages/functions/src/functions/seed.ts
index 7e234d5..341451d 100644
--- a/packages/functions/src/functions/seed.ts
+++ b/packages/functions/src/functions/seed.ts
@@ -169,7 +169,7 @@ const vk = [
     text3: 'Kiváló',
     nationalOnly: true,
     stageSpecific: false,
-    allowEmpty: false,
+    allowEmpty: true,
     competitorWeight: 1,
     organiserWeight: 1,
     roles: '["COMPETITOR", "COACH","ORGANISER", "JURY"]',
@@ -183,7 +183,7 @@ const vk = [
     text3: 'Kiváló',
     nationalOnly: true,
     stageSpecific: false,
-    allowEmpty: false,
+    allowEmpty: true,
     competitorWeight: 1,
     organiserWeight: 1,
     roles: '["COMPETITOR", "COACH","ORGANISER", "JURY"]',
diff --git a/packages/functions/src/typeorm/configOptions.ts b/packages/functions/src/typeorm/configOptions.ts
index b348254..887d609 100644
--- a/packages/functions/src/typeorm/configOptions.ts
+++ b/packages/functions/src/typeorm/configOptions.ts
@@ -15,6 +15,7 @@ import UserRoleAssignment from './entities/UserRoleAssignment'
 import { Init1694205775872 } from './migrations/1694205775872-init'
 import { AddRaterAge1695666298049 } from './migrations/1695666298049-add_rater_age'
 import { UniqueEventForUser1696272553417 } from './migrations/1696272553417-unique_event_for_user'
+import { MessageToRating1705141629515 } from './migrations/1705141629515-message_to_rating'
 
 export const DBConfig: SqlServerConnectionOptions = {
   type: 'mssql',
@@ -41,6 +42,6 @@ export const DBConfig: SqlServerConnectionOptions = {
     SeasonCriterionCount,
   ],
   subscribers: [],
-  migrations: [Init1694205775872, AddRaterAge1695666298049, UniqueEventForUser1696272553417],
+  migrations: [Init1694205775872, AddRaterAge1695666298049, UniqueEventForUser1696272553417, MessageToRating1705141629515],
   options: { encrypt: ENCRYPT },
 }
diff --git a/packages/functions/src/typeorm/entities/EventRating.ts b/packages/functions/src/typeorm/entities/EventRating.ts
index 570b0c4..8864cc6 100644
--- a/packages/functions/src/typeorm/entities/EventRating.ts
+++ b/packages/functions/src/typeorm/entities/EventRating.ts
@@ -38,6 +38,9 @@ class EventRating implements IEventRating {
   @Check("status in('STARTED', 'SUBMITTED')")
   status: RatingStatus
 
+  @Column({ nullable: true })
+  message?: string
+
   @Column()
   @Check("role in('COMPETITOR', 'COACH', 'ORGANISER', 'JURY')")
   role: RatingRole
diff --git a/packages/functions/src/typeorm/migrations/1705141629515-message_to_rating.ts b/packages/functions/src/typeorm/migrations/1705141629515-message_to_rating.ts
new file mode 100644
index 0000000..ea567bd
--- /dev/null
+++ b/packages/functions/src/typeorm/migrations/1705141629515-message_to_rating.ts
@@ -0,0 +1,14 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+
+export class MessageToRating1705141629515 implements MigrationInterface {
+    name = 'MessageToRating1705141629515'
+
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`ALTER TABLE "event_rating" ADD "message" nvarchar(255)`);
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`ALTER TABLE "event_rating" DROP COLUMN "message"`);
+    }
+
+}