From e6f2ea0af9f9bdef008435ebe2e17610fa6e7d64 Mon Sep 17 00:00:00 2001
From: Terence Ho <>
Date: Thu, 13 Oct 2022 11:17:04 +0800
Subject: [PATCH] [resumes][refactor] Refactor routers from reviews -> comments

---
 .../resumes/comments/ResumeCommentsForm.tsx   | 31 ++++++++++---------
 .../resumes/comments/ResumeCommentsList.tsx   |  2 +-
 apps/portal/src/server/router/index.ts        |  8 ++---
 ...s-router.ts => resumes-comments-router.ts} |  2 +-
 ...ter.ts => resumes-comments-user-router.ts} |  6 ++--
 apps/portal/src/types/resume-comments.d.ts    |  6 ++--
 6 files changed, 29 insertions(+), 26 deletions(-)
 rename apps/portal/src/server/router/resumes/{resumes-reviews-router.ts => resumes-comments-router.ts} (95%)
 rename apps/portal/src/server/router/resumes/{resumes-reviews-user-router.ts => resumes-comments-user-router.ts} (89%)

diff --git a/apps/portal/src/components/resumes/comments/ResumeCommentsForm.tsx b/apps/portal/src/components/resumes/comments/ResumeCommentsForm.tsx
index 18e981ad..31bade2f 100644
--- a/apps/portal/src/components/resumes/comments/ResumeCommentsForm.tsx
+++ b/apps/portal/src/components/resumes/comments/ResumeCommentsForm.tsx
@@ -41,16 +41,19 @@ export default function ResumeCommentsForm({
   });
 
   const trpcContext = trpc.useContext();
-  const reviewCreateMutation = trpc.useMutation('resumes.reviews.user.create', {
-    onSuccess: () => {
-      // New review added, invalidate query to trigger refetch
-      trpcContext.invalidateQueries(['resumes.reviews.list']);
+  const commentCreateMutation = trpc.useMutation(
+    'resumes.comments.user.create',
+    {
+      onSuccess: () => {
+        // New Comment added, invalidate query to trigger refetch
+        trpcContext.invalidateQueries(['resumes.comments.list']);
+      },
     },
-  });
+  );
 
   // TODO: Give a feedback to the user if the action succeeds/fails
   const onSubmit: SubmitHandler<IFormInput> = async (data) => {
-    return await reviewCreateMutation.mutate(
+    return await commentCreateMutation.mutate(
       {
         resumeId,
         ...data,
@@ -89,7 +92,7 @@ export default function ResumeCommentsForm({
         <div className="mt-4 space-y-4">
           <TextArea
             {...(register('general'), {})}
-            disabled={reviewCreateMutation.isLoading}
+            disabled={commentCreateMutation.isLoading}
             label="General"
             placeholder="General comments about the resume"
             onChange={(value) => onValueChange('general', value)}
@@ -97,7 +100,7 @@ export default function ResumeCommentsForm({
 
           <TextArea
             {...(register('education'), {})}
-            disabled={reviewCreateMutation.isLoading}
+            disabled={commentCreateMutation.isLoading}
             label="Education"
             placeholder="Comments about the Education section"
             onChange={(value) => onValueChange('education', value)}
@@ -105,7 +108,7 @@ export default function ResumeCommentsForm({
 
           <TextArea
             {...(register('experience'), {})}
-            disabled={reviewCreateMutation.isLoading}
+            disabled={commentCreateMutation.isLoading}
             label="Experience"
             placeholder="Comments about the Experience section"
             onChange={(value) => onValueChange('experience', value)}
@@ -113,7 +116,7 @@ export default function ResumeCommentsForm({
 
           <TextArea
             {...(register('projects'), {})}
-            disabled={reviewCreateMutation.isLoading}
+            disabled={commentCreateMutation.isLoading}
             label="Projects"
             placeholder="Comments about the Projects section"
             onChange={(value) => onValueChange('projects', value)}
@@ -121,7 +124,7 @@ export default function ResumeCommentsForm({
 
           <TextArea
             {...(register('skills'), {})}
-            disabled={reviewCreateMutation.isLoading}
+            disabled={commentCreateMutation.isLoading}
             label="Skills"
             placeholder="Comments about the Skills section"
             onChange={(value) => onValueChange('skills', value)}
@@ -130,7 +133,7 @@ export default function ResumeCommentsForm({
 
         <div className="flex justify-end space-x-2 pt-4">
           <Button
-            disabled={reviewCreateMutation.isLoading}
+            disabled={commentCreateMutation.isLoading}
             label="Cancel"
             type="button"
             variant="tertiary"
@@ -138,8 +141,8 @@ export default function ResumeCommentsForm({
           />
 
           <Button
-            disabled={!isDirty || reviewCreateMutation.isLoading}
-            isLoading={reviewCreateMutation.isLoading}
+            disabled={!isDirty || commentCreateMutation.isLoading}
+            isLoading={commentCreateMutation.isLoading}
             label="Submit"
             type="submit"
             variant="primary"
diff --git a/apps/portal/src/components/resumes/comments/ResumeCommentsList.tsx b/apps/portal/src/components/resumes/comments/ResumeCommentsList.tsx
index 2bdf4f4f..cba1ed85 100644
--- a/apps/portal/src/components/resumes/comments/ResumeCommentsList.tsx
+++ b/apps/portal/src/components/resumes/comments/ResumeCommentsList.tsx
@@ -21,7 +21,7 @@ export default function ResumeCommentsList({
   const { data: sessionData } = useSession();
   const [tab, setTab] = useState(RESUME_COMMENTS_SECTIONS[0].value);
 
-  const commentsQuery = trpc.useQuery(['resumes.reviews.list', { resumeId }]);
+  const commentsQuery = trpc.useQuery(['resumes.comments.list', { resumeId }]);
   const renderButton = () => {
     if (sessionData === null) {
       return <ResumeSignInButton text="to join discussion" />;
diff --git a/apps/portal/src/server/router/index.ts b/apps/portal/src/server/router/index.ts
index f7d156a9..fcea8526 100644
--- a/apps/portal/src/server/router/index.ts
+++ b/apps/portal/src/server/router/index.ts
@@ -9,10 +9,10 @@ import { questionsAnswerCommentRouter } from './questions-answer-comment-router'
 import { questionsAnswerRouter } from './questions-answer-router';
 import { questionsQuestionCommentRouter } from './questions-question-comment-router';
 import { questionsQuestionRouter } from './questions-question-router';
+import { resumeCommentsRouter } from './resumes/resumes-comments-router';
+import { resumesCommentsUserRouter } from './resumes/resumes-comments-user-router';
 import { resumesRouter } from './resumes/resumes-resume-router';
 import { resumesResumeUserRouter } from './resumes/resumes-resume-user-router';
-import { resumeReviewsRouter } from './resumes/resumes-reviews-router';
-import { resumesReviewsUserRouter } from './resumes/resumes-reviews-user-router';
 import { resumesStarUserRouter } from './resumes/resumes-star-user-router';
 import { todosRouter } from './todos';
 import { todosUserRouter } from './todos-user-router';
@@ -29,8 +29,8 @@ export const appRouter = createRouter()
   .merge('resumes.resume.', resumesRouter)
   .merge('resumes.resume.user.', resumesResumeUserRouter)
   .merge('resumes.resume.', resumesStarUserRouter)
-  .merge('resumes.reviews.', resumeReviewsRouter)
-  .merge('resumes.reviews.user.', resumesReviewsUserRouter)
+  .merge('resumes.comments.', resumeCommentsRouter)
+  .merge('resumes.comments.user.', resumesCommentsUserRouter)
   .merge('questions.answers.comments.', questionsAnswerCommentRouter)
   .merge('questions.answers.', questionsAnswerRouter)
   .merge('questions.questions.comments.', questionsQuestionCommentRouter)
diff --git a/apps/portal/src/server/router/resumes/resumes-reviews-router.ts b/apps/portal/src/server/router/resumes/resumes-comments-router.ts
similarity index 95%
rename from apps/portal/src/server/router/resumes/resumes-reviews-router.ts
rename to apps/portal/src/server/router/resumes/resumes-comments-router.ts
index 04672cb2..fb9840ac 100644
--- a/apps/portal/src/server/router/resumes/resumes-reviews-router.ts
+++ b/apps/portal/src/server/router/resumes/resumes-comments-router.ts
@@ -4,7 +4,7 @@ import { createRouter } from '../context';
 
 import type { ResumeComment } from '~/types/resume-comments';
 
-export const resumeReviewsRouter = createRouter().query('list', {
+export const resumeCommentsRouter = createRouter().query('list', {
   input: z.object({
     resumeId: z.string(),
   }),
diff --git a/apps/portal/src/server/router/resumes/resumes-reviews-user-router.ts b/apps/portal/src/server/router/resumes/resumes-comments-user-router.ts
similarity index 89%
rename from apps/portal/src/server/router/resumes/resumes-reviews-user-router.ts
rename to apps/portal/src/server/router/resumes/resumes-comments-user-router.ts
index 069e5548..479c9390 100644
--- a/apps/portal/src/server/router/resumes/resumes-reviews-user-router.ts
+++ b/apps/portal/src/server/router/resumes/resumes-comments-user-router.ts
@@ -3,14 +3,14 @@ import { ResumesSection } from '@prisma/client';
 
 import { createProtectedRouter } from '../context';
 
-type IResumeCommentInput = Readonly<{
+type ResumeCommentInput = Readonly<{
   description: string;
   resumeId: string;
   section: ResumesSection;
   userId: string;
 }>;
 
-export const resumesReviewsUserRouter = createProtectedRouter().mutation(
+export const resumesCommentsUserRouter = createProtectedRouter().mutation(
   'create',
   {
     input: z.object({
@@ -27,7 +27,7 @@ export const resumesReviewsUserRouter = createProtectedRouter().mutation(
         input;
 
       // For each section, convert them into ResumesComment model if provided
-      const comments: Array<IResumeCommentInput> = [
+      const comments: Array<ResumeCommentInput> = [
         { description: education, section: ResumesSection.EDUCATION },
         { description: experience, section: ResumesSection.EXPERIENCE },
         { description: general, section: ResumesSection.GENERAL },
diff --git a/apps/portal/src/types/resume-comments.d.ts b/apps/portal/src/types/resume-comments.d.ts
index 5a6dfff8..c0e181fb 100644
--- a/apps/portal/src/types/resume-comments.d.ts
+++ b/apps/portal/src/types/resume-comments.d.ts
@@ -1,10 +1,10 @@
 import type { ResumesSection } from '@prisma/client';
 
 /**
- * Returned by `resumeReviewsRouter` (query for 'resumes.reviews.list') and received as prop by `Comment` in `CommentsList`
+ * Returned by `resumeCommentsRouter` (query for 'resumes.comments.list') and received as prop by `Comment` in `CommentsList`
  * frontend-friendly representation of the query
  */
-export type ResumeComment = {
+export type ResumeComment = Readonly<{
   createdAt: Date;
   description: string;
   hasVoted: boolean;
@@ -18,4 +18,4 @@ export type ResumeComment = {
     name: string?;
     userId: string;
   };
-};
+}>;