Davidgu/list unclaimed items query #12

shaply · 2025-01-24T05:09:43Z

Description

Create a GET route handler at /api/unclaimedItems that returns a list of all UnclaimedItem records.

Success Criteria

If the request does not have a valid session, then GET /api/unclaimedItems returns a 401 status code with JSON body {"message": "Session required"}
GET /api/unclaimedItems returns a 200 status code and all UnclaimedItem records as JSON objects (include id, name, quantity, and expirationDate as an ISO-8601 string)
The route handler is documented with a description of its function, parameters, and responses
There is a test file that covers the success criteria

Checklist

The ticket is mentioned above
The changes fulfill the success criteria of the ticket
The changes were self-reviewed
A review was requested

Created documentation and GET for api/unclaimedItems/route.ts Created authMockUtil and dbMockUtils tools for easier verification and db testing No idea what I did to authMock but it is working properly

netlify · 2025-01-24T05:10:00Z

✅ Deploy Preview for hope-for-haiti ready!

Name	Link
🔨 Latest commit	`ee3e32c`
🔍 Latest deploy log	https://app.netlify.com/sites/hope-for-haiti/deploys/67a26d9ad70e950008af1f4c
😎 Deploy Preview	https://deploy-preview-12--hope-for-haiti.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

kavinphan · 2025-02-01T00:07:58Z

src/test/authMock.ts

@@ -13,4 +13,4 @@ beforeEach(() => {
  mockReset(authMock);
 });

-export const authMock = auth as unknown as jest.Mock<() => Session | null>;
+export const authMock = auth as unknown as jest.Mock<() => Session | null>;


iirc prettier should add a newline? if you are using vs code, you can install the prettier extension and configure it to run on save.

kavinphan · 2025-02-01T00:08:18Z

src/app/api/unclaimedItems/route.ts

+ * Handles GET requests to retrieve unclaimed items from the unclaimedItem database.
+ *
+ * @returns {NextResponse} On success, returns a status of 200 and a JSON object containing an array of unclaimed items.
+ * @returns {NextResponse} On authentication error, returns a status of 401 and a JSON object containing an error message.
+ * @returns {NextResponse} On error, returns a status of 500 and a JSON object containing an error message.


nit: can you reformat to match the example

I changed it and I think it matches the example

kavinphan · 2025-02-01T00:08:37Z

src/app/api/unclaimedItems/route.ts

+ * @example
+ * // Example response:
+ * {
+ *   "unclaimedItems": [
+ *     {
+ *       "id": 1,
+ *       "name": "Banana",
+ *       "quantity": 10,
+ *       "expirationDate": "2025-01-22T14:45:43.241Z"
+ *     },
+ *     {
+ *       "id": 2,
+ *       "name": "Apple",
+ *       "quantity": 100,
+ *       "expirationDate": "2025-01-22T14:45:43.243Z"
+ *     }
+ *   ]
+ * }
+ */


let's replace this doc example with a typescript interface:

// at the top of the file somewhere interface Response { numberOfPatients: number; organizationType: OrganizationType; // ... } // handler function export async function GET(...): Promise<NextResponse<Response>> { // ... }

Created an interface

kavinphan · 2025-02-01T00:09:05Z

src/app/api/unclaimedItems/route.ts

+export async function GET() {
+    try {
+        const session = await auth();
+        if (!session) return authenticationError('Session required');


this could be more extensive (also lowkey this is my bad for giving a bad example 💀 it's updated now)

Added a if (!session?.user) return error

kavinphan · 2025-02-01T00:09:57Z

src/app/api/unclaimedItems/route.ts

+    } catch (err: unknown) {
+        if (err instanceof Error) {
+            console.error(err.message);
+        } else {
+            console.error('An unknown error occurred');
+        }
+        return internalError();
+    }


nextjs already returns a 500 and logs uncaught exceptions from route handlers

I got rid of the try catch statement

kavinphan · 2025-02-01T00:12:03Z

src/test/util/authMockUtils.ts

+   * @param expires Optional, default is ""
+   */
+  export async function validateSession(
+    user: { id: string, type: UserType } = { id: "1234", type: "ADMIN" },


nit: i think this session helper could be more useful if it:

didn't provide a default user value but instead..

accepted a default user type value

randomly generated a user ID and returned it (this is to prevent magic numbers from existing in tests)

Need to provide user type now, default expiration is now a day from current day, and randomly generates a user id. Returns the generated session.

kavinphan · 2025-02-01T00:13:25Z

src/util/responses.ts

@@ -27,3 +27,7 @@ export function internalError() {
 export function ok() {
  return NextResponse.json({ message: "OK" }, { status: 200 });
 }
+
+export function successResponse<T>(data: T) {
+  return NextResponse.json(data, { status: 200 });


i would prefer if you just used NextResponse.json() in the route handler as it defaults to status 200.

Deleted successResponse

kavinphan · 2025-02-01T00:18:26Z

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

+            dbMock.unclaimedItem.create({ data: { id: 1, name: "Test Item 1", quantity: 1, expirationDate: new Date() } });
+            const items: UnclaimedItem[] = await manyUnclaimedItems(3);


you might be confused on what the mock does. for every call to db in your route code, there should be the same call to dbMock in the test. e.g. if you only do db.unclaimedItem.findMany in the route, then you should only call dbMock once in your test which will be dbMock.unclaimedItem.findMany

I don't know if I did it correctly but I changed the test

kavinphan · 2025-02-04T03:01:25Z

src/app/api/unclaimedItems/route.ts

+  unclaimedItems:
+    | {
+        id: number;
+        name: string;
+        quantity: number;
+        expirationDate: Date | null;
+      }[]
+    | [];


nit: this is kinda wonky. why is this a union type with empty array?

There was an error earlier because when I pulled it in the tests it would be null and not an empty array, but I'm not getting the error anymore so I've changed it back to normal.

kavinphan · 2025-02-04T03:01:49Z

src/app/api/unclaimedItems/route.ts

+
+// Response for GET /api/unclaimedItems
+interface UnclaimedItemsResponse {
+  numberOfItems: number | 0;


nit: this can just be 0

kavinphan · 2025-02-04T03:02:25Z

src/app/api/unclaimedItems/route.ts

+  const unclaimedItems = await db.unclaimedItem.findMany();
+
+  return NextResponse.json({
+    numberOfItems: unclaimedItems?.length, // ?.length for when unclaimedItems is undefined


no need to return the number of items

shaply added 2 commits January 23, 2025 20:05

Created tests in api/unclaimedItems/route.test.ts

422449c

Created documentation and GET for api/unclaimedItems/route.ts Created authMockUtil and dbMockUtils tools for easier verification and db testing No idea what I did to authMock but it is working properly

Fixed build errors

b6a3bff

kavinphan requested changes Feb 1, 2025

View reviewed changes

Fixed/changed code according to review comments

7da5c28

kavinphan self-requested a review February 1, 2025 21:11

kavinphan requested changes Feb 4, 2025

View reviewed changes

Fixed return and interfaces

3d96e2b

kavinphan approved these changes Feb 4, 2025

View reviewed changes

Merge branch 'main' into davidgu/ListUnclaimedItemsQuery

ee3e32c

shaply merged commit dca05c0 into main Feb 4, 2025
5 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Davidgu/list unclaimed items query #12

Davidgu/list unclaimed items query #12

shaply commented Jan 24, 2025

netlify bot commented Jan 24, 2025 •

edited

Loading

kavinphan Feb 1, 2025

shaply Feb 1, 2025

kavinphan Feb 1, 2025

shaply Feb 1, 2025

kavinphan Feb 1, 2025

shaply Feb 1, 2025

kavinphan Feb 1, 2025

shaply Feb 1, 2025

kavinphan Feb 1, 2025

shaply Feb 1, 2025

kavinphan Feb 1, 2025

shaply Feb 1, 2025

kavinphan Feb 1, 2025

shaply Feb 1, 2025

kavinphan Feb 1, 2025

shaply Feb 1, 2025

kavinphan Feb 4, 2025

shaply Feb 4, 2025

kavinphan Feb 4, 2025

shaply Feb 4, 2025

shaply Feb 4, 2025

kavinphan Feb 4, 2025

shaply Feb 4, 2025

		dbMock.unclaimedItem.create({ data: { id: 1, name: "Test Item 1", quantity: 1, expirationDate: new Date() } });
		const items: UnclaimedItem[] = await manyUnclaimedItems(3);

Davidgu/list unclaimed items query #12

Davidgu/list unclaimed items query #12

Conversation

shaply commented Jan 24, 2025

Description

Success Criteria

Checklist

netlify bot commented Jan 24, 2025 • edited Loading

✅ Deploy Preview for hope-for-haiti ready!

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

netlify bot commented Jan 24, 2025 •

edited

Loading