Merge branch 'main' into UpdateSearchBar

apps/web/package.json

@@ -25,6 +25,7 @@
     "@trpc/react-query": "11.0.0-rc.441",
     "@trpc/server": "11.0.0-rc.441",
     "dayjs": "^1.11.13",
+    "fuse.js": "^7.0.0",
     "geist": "^1.3.0",
     "lucide-react": "^0.436.0",
     "next": "^14.2.4",

apps/web/src/app/(pages)/(dashboard)/roles/page.tsx

@@ -21,6 +21,7 @@ export default function Roles({
   searchParams,
 }: {
   searchParams?: {
+    search?: string;
     cycle?: WorkTermType;
     term?: WorkEnvironmentType;
   };
@@ -59,19 +60,31 @@ export default function Roles({
         variant: "destructive",
       });
     }
-  }, [toast, mounted]);
+  }, [
+    toast,
+    mounted,
+    validationResult.success,
+    validationResult.error?.issues,
+  ]);
 
   const reviews = api.review.list.useQuery({
+    search: searchParams?.search,
     options: validationResult.success ? validationResult.data : {},
   });
 
   const [selectedReview, setSelectedReview] = useState<ReviewType | undefined>(
     reviews.data ? reviews.data[0] : undefined,
   );
 
+  useEffect(() => {
+    if (reviews.data) {
+      setSelectedReview(reviews.data[0]);
+    }
+  }, [reviews.data]);
+
   return (
     <>
-      <SearchFilter />
+      <SearchFilter search={searchParams?.search} />
       {reviews.data && (
         <div className="mb-8 grid h-[70dvh] w-4/5 grid-cols-5 gap-4 lg:w-3/4">
           <div className="col-span-2 gap-3 overflow-scroll pr-4">

apps/web/src/app/_components/search/search-filter.tsx

@@ -27,11 +27,20 @@ const formSchema = z.object({
 
 export type SearchFilterFormType = typeof formSchema;
 
-export default function SearchFilter() {
+interface SearchFilterProps {
+  search?: string;
+}
+
+/**
+ * Handles searching logic, updates the search param base on user search and passes the text to backend with fuzzy searching.
+ * @param param0 user input text that's passed to the fuzzy search
+ * @returns the search bar with the user inputted text
+ */
+export default function SearchFilter({ search }: SearchFilterProps) {
   const form = useForm<z.infer<typeof formSchema>>({
     resolver: zodResolver(formSchema),
     defaultValues: {
-      searchText: "",
+      searchText: search ?? "",
     },
   });
 

packages/api/package.json

@@ -13,6 +13,7 @@
   "scripts": {
     "build": "tsc",
     "dev": "tsc --watch",
+    "test": "vitest",
     "clean": "rm -rf .turbo dist node_modules",
     "format": "prettier --check . --ignore-path ../../.gitignore",
     "lint": "eslint",

packages/api/src/router/review.ts

@@ -1,4 +1,5 @@
 import type { TRPCRouterRecord } from "@trpc/server";
+import Fuse from "fuse.js";
 import { z } from "zod";
 
 import { and, desc, eq } from "@cooper/db";
@@ -10,6 +11,7 @@ export const reviewRouter = {
   list: publicProcedure
     .input(
       z.object({
+        search: z.string().optional(),
         options: z
           .object({
             cycle: z.enum(["SPRING", "FALL", "SUMMER"]).optional(),
@@ -18,18 +20,30 @@ export const reviewRouter = {
           .optional(),
       }),
     )
-    .query(({ ctx, input }) => {
+    .query(async ({ ctx, input }) => {
       const { options } = input;
 
       const conditions = [
         options?.cycle && eq(Review.workTerm, options.cycle),
         options?.term && eq(Review.workEnvironment, options.term),
       ].filter(Boolean);
 
-      return ctx.db.query.Review.findMany({
+      const reviews = await ctx.db.query.Review.findMany({
         orderBy: desc(Review.id),
         where: conditions.length > 0 ? and(...conditions) : undefined,
       });
+
+      if (!input.search) {
+        return reviews;
+      }
+
+      const fuseOptions = {
+        keys: ["reviewHeadline", "textReview", "location"],
+      };
+
+      const fuse = new Fuse(reviews, fuseOptions);
+
+      return fuse.search(input.search).map((result) => result.item);
     }),
 
   getByRole: publicProcedure

packages/api/tests/mocks/review.ts

@@ -0,0 +1,5 @@
+export const data = [
+  { id: "1", workTerm: "SPRING", workEnvironment: "REMOTE" },
+  { id: "2", workTerm: "FALL", workEnvironment: "INPERSON" },
+  { id: "3", workTerm: "SUMMER", workEnvironment: "HYBRID" },
+];

packages/api/tests/review.test.ts

@@ -0,0 +1,102 @@
+/* eslint-disable @typescript-eslint/no-unsafe-assignment */
+/* eslint-disable @typescript-eslint/unbound-method */
+import { beforeEach, describe, expect, test, vi } from "vitest";
+
+import type { Session } from "@cooper/auth";
+import type { ReviewType } from "@cooper/db/schema";
+import { and, eq } from "@cooper/db";
+import { db } from "@cooper/db/client";
+import { Review } from "@cooper/db/schema";
+
+import { appRouter } from "../src/root";
+import { createCallerFactory, createTRPCContext } from "../src/trpc";
+import { data } from "./mocks/review";
+
+vi.mock("@cooper/db/client", () => ({
+  db: {
+    query: {
+      Review: {
+        findMany: vi.fn(),
+      },
+    },
+  },
+}));
+
+vi.mock("@cooper/auth", () => ({
+  auth: vi.fn(),
+}));
+
+describe("Review Router", async () => {
+  beforeEach(() => {
+    vi.restoreAllMocks();
+    vi.mocked(db.query.Review.findMany).mockResolvedValue(data as ReviewType[]);
+  });
+
+  const session: Session = {
+    user: {
+      id: "1",
+    },
+    expires: "1",
+  };
+
+  const ctx = await createTRPCContext({
+    session,
+    headers: new Headers(),
+  });
+
+  const caller = createCallerFactory(appRouter)(ctx);
+
+  test("list endpoint returns all reviews", async () => {
+    const reviews = await caller.review.list({});
+
+    expect(reviews).toEqual(data);
+
+    expect(db.query.Review.findMany).toHaveBeenCalledWith({
+      orderBy: expect.anything(),
+      where: undefined,
+    });
+  });
+
+  test("list endpoint with cycle filter", async () => {
+    await caller.review.list({
+      options: {
+        cycle: "SPRING",
+      },
+    });
+
+    expect(db.query.Review.findMany).toHaveBeenCalledWith({
+      orderBy: expect.anything(),
+      where: and(eq(Review.workTerm, "SPRING")),
+    });
+  });
+
+  test("list endpoint with term filter", async () => {
+    await caller.review.list({
+      options: {
+        term: "REMOTE",
+      },
+    });
+
+    expect(db.query.Review.findMany).toHaveBeenCalledWith({
+      orderBy: expect.anything(),
+      where: and(eq(Review.workEnvironment, "REMOTE")),
+    });
+  });
+
+  test("list endpoint with cycle and term filter", async () => {
+    await caller.review.list({
+      options: {
+        cycle: "SPRING",
+        term: "REMOTE",
+      },
+    });
+
+    expect(db.query.Review.findMany).toHaveBeenCalledWith({
+      orderBy: expect.anything(),
+      where: and(
+        eq(Review.workTerm, "SPRING"),
+        eq(Review.workEnvironment, "REMOTE"),
+      ),
+    });
+  });
+});

packages/api/tsconfig.json

@@ -4,6 +4,6 @@
     "outDir": "dist",
     "tsBuildInfoFile": "node_modules/.cache/tsbuildinfo.json"
   },
-  "include": ["src"],
+  "include": ["src", "tests"],
   "exclude": ["node_modules"]
 }

turbo.json

@@ -60,6 +60,10 @@
     "start": {
       "cache": false,
       "interactive": true
+    },
+    "test": {
+      "cache": true,
+      "interactive": true
     }
   },
   "globalEnv": [