Fix average rating route (#506)

* fix avg rating

* fix featured review route for undefined

Author: js0mmer

api/src/controllers/reviews.ts

@@ -16,7 +16,7 @@ import {
 import { TRPCError } from '@trpc/server';
 import { db } from '../db';
 import { review, user, vote } from '../db/schema';
-import { and, count, desc, eq, sql } from 'drizzle-orm';
+import { and, avg, count, desc, eq, sql } from 'drizzle-orm';
 import { datesToStrings } from '../helpers/date';
 
 async function userWroteReview(userId: number | undefined, reviewId: number) {
@@ -208,33 +208,30 @@ const reviewsRouter = router({
     const featuredReviewCriteria = [desc(review.content), desc(voteSubQuery.score), desc(review.verified)];
 
     const field = input.type === 'course' ? review.courseId : review?.professorId;
-    const featuredReview = (
-      await db
-        .select()
-        .from(review)
-        .where(eq(field, input.id))
-        .leftJoin(voteSubQuery, eq(voteSubQuery.reviewId, review.id))
-        .orderBy(...featuredReviewCriteria)
-        .limit(1)
-    )[0];
+    const featuredReview = await db
+      .select()
+      .from(review)
+      .where(eq(field, input.id))
+      .leftJoin(voteSubQuery, eq(voteSubQuery.reviewId, review.id))
+      .orderBy(...featuredReviewCriteria)
+      .limit(1);
 
-    return datesToStrings(featuredReview.review) as FeaturedReviewData;
+    return featuredReview.length > 0 ? (datesToStrings(featuredReview[0].review) as FeaturedReviewData) : undefined;
   }),
 
   /**
    * Get avg ratings for a course's professors or a professor's courses
    */
-  scores: publicProcedure
+  avgRating: publicProcedure
     .input(z.object({ type: z.enum(['course', 'professor']), id: z.string() }))
     .query(async ({ input }) => {
       const field = input.type === 'course' ? review.courseId : review.professorId;
       const otherField = input.type === 'course' ? review.professorId : review.courseId;
 
       const results = await db
-        .select({ name: otherField, score: sql`COALESCE(SUM(${vote.vote}), 0)`.mapWith(Number) })
+        .select({ name: otherField, avgRating: avg(review.rating).mapWith(Number) })
         .from(review)
         .where(eq(field, input.id))
-        .leftJoin(vote, eq(vote.reviewId, review.id))
         .groupBy(otherField);
 
       return results;

site/src/component/SearchPopup/SearchPopup.tsx

@@ -109,11 +109,15 @@ const SearchPopupContent: FC<SearchPopupProps> = (props) => {
                   <div key={`search-popup-carousel-${i}`} className="search-popup-carousel search-popup-block">
                     <div>
                       <span className="search-popup-carousel-score">
-                        {score.score == -1 ? '?' : Number.isInteger(score.score) ? score.score : score.score.toFixed(2)}
+                        {score.avgRating == -1
+                          ? '?'
+                          : Number.isInteger(score.avgRating)
+                            ? score.avgRating
+                            : score.avgRating.toFixed(2)}
                       </span>
                       <span className="search-popup-carousel-max-score">/ 5.0</span>
                     </div>
-                    <Link to={`/${props.searchType == 'course' ? 'professor' : 'course'}/${score.key}`}>
+                    <Link to={`/${props.searchType == 'course' ? 'professor' : 'course'}/${score.id}`}>
                       {score.name}
                     </Link>
                   </div>

site/src/pages/SearchPage/CoursePopup.tsx

@@ -12,7 +12,7 @@ const CoursePopup: FC = () => {
 
   useEffect(() => {
     if (course) {
-      trpc.reviews.scores.query({ type: 'course', id: course.id }).then((res) => {
+      trpc.reviews.avgRating.query({ type: 'course', id: course.id }).then((res) => {
         const scores: ScoreData[] = [];
         // set of ucinetid professors with scores
         const scoredProfessors = new Set(res.map((v) => v.name));
@@ -21,19 +21,19 @@ const CoursePopup: FC = () => {
           if (course.instructors[entry.name]) {
             scores.push({
               name: course.instructors[entry.name].name,
-              score: entry.score,
-              key: entry.name,
+              avgRating: entry.avgRating,
+              id: entry.name,
             });
           }
         });
         // add unknown score
         Object.keys(course.instructors).forEach((ucinetid) => {
           if (!scoredProfessors.has(ucinetid)) {
-            scores.push({ name: course.instructors[ucinetid].name, score: -1, key: ucinetid });
+            scores.push({ name: course.instructors[ucinetid].name, avgRating: -1, id: ucinetid });
           }
         });
         // sort by highest score
-        scores.sort((a, b) => b.score - a.score);
+        scores.sort((a, b) => b.avgRating - a.avgRating);
         setScores(scores);
       });
     }

site/src/pages/SearchPage/ProfessorPopup.tsx

@@ -9,7 +9,7 @@ import { FeaturedReviewData } from '@peterportal/types';
 
 const ProfessorPopup: FC = () => {
   const professor = useAppSelector(selectProfessor);
-  const [featured, setFeatured] = useState<FeaturedReviewData>(null!);
+  const [featured, setFeatured] = useState<FeaturedReviewData | undefined>();
   const [scores, setScores] = useState<ScoreData[]>([]);
 
   useEffect(() => {
@@ -18,31 +18,22 @@ const ProfessorPopup: FC = () => {
         type: 'professor',
         id: professor.ucinetid,
       } as const;
-      trpc.reviews.scores.query(reviewParams).then((res: ScoreData[]) => {
+      trpc.reviews.avgRating.query(reviewParams).then((res) => {
+        const scores = res.map((course) => ({ name: course.name, avgRating: course.avgRating, id: course.name }));
         const scoredCourses = new Set(res.map((v) => v.name));
-        res.forEach((v) => (v.key = v.name));
         Object.keys(professor.courses).forEach((course) => {
           // remove spaces
           course = course.replace(/\s+/g, '');
           // add unknown score
           if (!scoredCourses.has(course)) {
-            res.push({ name: course, score: -1, key: course });
+            scores.push({ name: course, avgRating: -1, id: course });
           }
         });
         // sort by highest score
-        res.sort((a, b) => b.score - a.score);
-        setScores(res);
-      });
-      trpc.reviews.featured.query(reviewParams).then((res) => {
-        // if has a featured review
-        if (res) {
-          setFeatured(res);
-        }
-        // no reviews for this professor
-        else {
-          setFeatured(null!);
-        }
+        res.sort((a, b) => b.avgRating - a.avgRating);
+        setScores(scores);
       });
+      trpc.reviews.featured.query(reviewParams).then(setFeatured);
     }
   }, [professor]);
 

site/src/types/types.ts

@@ -9,8 +9,9 @@ import {
 
 export interface ScoreData {
   name: string;
-  score: number;
-  key?: string;
+  avgRating: number;
+  /** course id or ucinetid */
+  id: string;
 }
 
 export type SearchIndex = 'courses' | 'professors';