Merge pull request #12 from GTBitsOfGood/davidgu/ListUnclaimedItemsQuery

Davidgu/list unclaimed items query

Author: shaply

.gitignore

@@ -39,3 +39,6 @@ yarn-error.log*
 # typescript
 *.tsbuildinfo
 next-env.d.ts
+
+# vscode
+.vscode/

package-lock.json

@@ -50,6 +50,7 @@
     "next-test-api-route-handler": "^4.0.14",
     "open-html": "^1.0.1",
     "postcss": "^8",
+    "prettier": "^3.4.2",
     "prisma": "^6.2.1",
     "tailwindcss": "^3.4.1",
     "ts-jest": "^29.2.5",

package.json

@@ -0,0 +1,53 @@
+import { testApiHandler } from "next-test-api-route-handler";
+import * as appHandler from "./route";
+import { expect, test } from "@jest/globals";
+// import { authMock } from "@/test/authMock";
+import { validateSession, invalidateSession } from "@/test/util/authMockUtils";
+import { fillDbMockWithManyUnclaimedItems } from "@/test/util/dbMockUtils";
+import { dbMock } from "@/test/dbMock";
+
+test("Should return 401 for invalid session", async () => {
+  await testApiHandler({
+    appHandler,
+    async test({ fetch }) {
+      invalidateSession();
+
+      const res = await fetch({ method: "GET" });
+      await expect(res.status).toBe(401);
+      const json = await res.json();
+      await expect(json).toEqual({ message: "Session required" });
+    },
+  });
+});
+
+test("Should return 200 for valid session", async () => {
+  await testApiHandler({
+    appHandler,
+    async test({ fetch }) {
+      validateSession("ADMIN");
+
+      const res = await fetch({ method: "GET" });
+      await expect(res.status).toBe(200);
+    },
+  });
+});
+
+test("Should give correct database queries", async () => {
+  await testApiHandler({
+    appHandler,
+    async test({ fetch }) {
+      await fillDbMockWithManyUnclaimedItems(3);
+      validateSession("ADMIN");
+
+      const res = await fetch({ method: "GET" });
+      await expect(res.status).toBe(200);
+
+      // Check that the response json was written correctly
+      const expectedRet = {
+        unclaimedItems: await dbMock.unclaimedItem.findMany(),
+      };
+      const json = await res.json();
+      await expect(json).toEqual(JSON.parse(JSON.stringify(expectedRet))); // Needed to stringify and parse because the expiration field would cause an error because Date != ISOstring
+    },
+  });
+});

src/app/api/unclaimedItems/route.test.ts

@@ -0,0 +1,37 @@
+// import { NextRequest } from 'next/server';
+import { auth } from "@/auth";
+import { authenticationError } from "@/util/responses";
+import { db } from "@/db";
+import { NextResponse } from "next/server";
+
+// Response for GET /api/unclaimedItems
+interface UnclaimedItemsResponse {
+  unclaimedItems: {
+    id: number;
+    name: string;
+    quantity: number;
+    expirationDate: Date | null;
+  }[];
+}
+
+/**
+ * Handles GET requests to retrieve unclaimed items from the unclaimedItem database.
+ * @returns 401 if the session is invalid
+ * @returns 500 if an unknown error occurs
+ * @returns 200 and a json response with the unclaimed items
+ */
+export async function GET() {
+  const session = await auth();
+  if (!session) return authenticationError("Session required");
+
+  if (!session?.user) {
+    return authenticationError("User not found");
+  }
+
+  // Get all unclaimed items
+  const unclaimedItems = await db.unclaimedItem.findMany();
+
+  return NextResponse.json({
+    unclaimedItems: unclaimedItems,
+  } as UnclaimedItemsResponse);
+}

src/app/api/unclaimedItems/route.ts

@@ -0,0 +1,33 @@
+import { authMock } from "@/test/authMock";
+import { UserType } from "@prisma/client";
+import { v4 as uuidv4 } from "uuid";
+
+// Helper util methods for testing
+
+/**
+ * Helper method for invalidating a session
+ */
+export async function invalidateSession() {
+  authMock.mockReturnValueOnce(null);
+}
+
+/**
+ * Helper method for validating a session
+ * @param user Optional, default is { id: "1234", type: "ADMIN" }
+ * @param expires Optional, default is a day from now
+ * @returns A session object with the user and expires fields
+ */
+export async function validateSession(
+  userType: UserType,
+  expires: Date = new Date(Date.now() + 86400000)
+) {
+  const createdSession = {
+    user: {
+      id: uuidv4(),
+      type: userType,
+    },
+    expires: expires.toISOString(),
+  };
+  authMock.mockReturnValueOnce(createdSession);
+  return createdSession;
+}

src/test/util/authMockUtils.ts

@@ -0,0 +1,36 @@
+import { dbMock } from "@/test/dbMock";
+import { UnclaimedItem } from "@prisma/client";
+
+// Helper util methods for testing
+
+/**
+ * Helper method for creating unclaimed items
+ * Defines the db.unclaimedItem.findMany mock
+ * @param num Number of items to create
+ * @returns Array of UnclaimedItems returned by db.unclaimedItem.findMany mock
+ */
+export async function fillDbMockWithManyUnclaimedItems(
+  num: number
+): Promise<UnclaimedItem[]> {
+  const items: UnclaimedItem[] = [];
+  const generatedIds = new Set<number>();
+
+  for (let i = 0; i < num; i++) {
+    let id: number;
+    do {
+      id = Math.floor(Math.random() * 1000000); // Generate a random integer ID
+    } while (generatedIds.has(id)); // Ensure the ID is unique
+
+    generatedIds.add(id);
+
+    items.push({
+      id: id,
+      name: `Test Item ${id}`,
+      quantity: Math.floor(Math.random() * 1000),
+      expirationDate: new Date(Date.now() + Math.floor(Math.random() * 10000)),
+    });
+  }
+
+  dbMock.unclaimedItem.findMany.mockResolvedValue(items);
+  return items;
+}