✨ #497 - feat: add api lib for destruction list co review

Author: svenvandescheur

frontend/src/fixtures/coReview.ts

@@ -0,0 +1,17 @@
+import { CoReview } from "../lib/api/coReview";
+import { destructionListFactory } from "./destructionList";
+import { createArrayFactory, createObjectFactory } from "./factory";
+import { beoordelaarFactory } from "./user";
+
+const FIXTURE_CO_REVIEW: CoReview = {
+  pk: 1,
+  destructionList: destructionListFactory().uuid,
+  author: beoordelaarFactory(),
+  listFeedback: "",
+  created: "2023-09-15T21:36:00.000000+01:00",
+};
+
+const coReviewFactory = createObjectFactory(FIXTURE_CO_REVIEW);
+const coReviewsFactory = createArrayFactory([FIXTURE_CO_REVIEW]);
+
+export { coReviewFactory, coReviewsFactory };

frontend/src/fixtures/response.ts

@@ -0,0 +1,35 @@
+import { createObjectFactory } from "./factory";
+
+const FIXTURE_RESPONSE: Response = {
+  headers: new Headers(),
+  ok: true,
+  redirected: false,
+  status: 200,
+  statusText: "OK",
+  type: "basic",
+  url: "",
+  clone: function (): Response {
+    throw new Error("Function not implemented.");
+  },
+  body: null,
+  bodyUsed: false,
+  arrayBuffer: function (): Promise<ArrayBuffer> {
+    throw new Error("Function not implemented.");
+  },
+  blob: function (): Promise<Blob> {
+    throw new Error("Function not implemented.");
+  },
+  formData: function (): Promise<FormData> {
+    throw new Error("Function not implemented.");
+  },
+  json: function (): Promise<unknown> {
+    throw new Error("Function not implemented.");
+  },
+  text: function (): Promise<string> {
+    throw new Error("Function not implemented.");
+  },
+};
+
+const responseFactory = createObjectFactory<Response>(FIXTURE_RESPONSE);
+
+export { responseFactory };

frontend/src/lib/api/coReview.test.ts

@@ -0,0 +1,48 @@
+import { expect } from "@storybook/test";
+
+import { coReviewFactory } from "../../fixtures/coReview";
+import { destructionListFactory } from "../../fixtures/destructionList";
+import {
+  addFetchMock,
+  getLastMockedRequest,
+  restoreNativeFetch,
+} from "../test";
+import { createCoReview, listCoReviews } from "./coReview";
+
+describe("coReview", () => {
+  afterEach(restoreNativeFetch);
+
+  test("listCoReviews() GETs co-reviews ", async () => {
+    addFetchMock(
+      "http://localhost:8000/api/v1/destruction-list-co-reviews/?",
+      "GET",
+      [coReviewFactory({ listFeedback: "gh-497" })],
+    );
+    const coReviews = await listCoReviews();
+    expect(coReviews.length).toBe(1);
+    expect(coReviews[0].listFeedback).toBe("gh-497");
+  });
+
+  test("createCoReview() POSTs co-review ", async () => {
+    addFetchMock(
+      "http://localhost:8000/api/v1/destruction-list-co-reviews/?",
+      "POST",
+      {},
+    );
+
+    const uuid = destructionListFactory().uuid;
+    await createCoReview({
+      destructionList: uuid,
+      listFeedback: "gh-497",
+    });
+
+    const requestInit = getLastMockedRequest(
+      "http://localhost:8000/api/v1/destruction-list-co-reviews/?",
+      "POST",
+    );
+
+    const data = JSON.parse(requestInit?.body as string);
+    expect(data.destructionList).toBe(uuid);
+    expect(data.listFeedback).toBe("gh-497");
+  });
+});

frontend/src/lib/api/coReview.ts

@@ -0,0 +1,50 @@
+import { User } from "./auth";
+import { DestructionList } from "./destructionLists";
+import { request } from "./request";
+
+export type CoReviewBase = {
+  destructionList: string;
+  listFeedback: string;
+};
+
+export type CoReview = CoReviewBase & {
+  pk: number;
+  author: User;
+  created: string;
+};
+
+/**
+ * Create a new co-review.
+ */
+export async function createCoReview(data: CoReviewBase) {
+  const response = await request(
+    "POST",
+    "/destruction-list-co-reviews/",
+    undefined,
+    {
+      ...data,
+    },
+  );
+  const promise: Promise<unknown> = response.json();
+  return promise;
+}
+
+/**
+ * List all the co-reviews that have been made for a destruction list.
+ */
+export async function listCoReviews(
+  params?:
+    | URLSearchParams
+    | {
+        destructionList__uuid?: DestructionList["uuid"];
+        ordering?: "-created" | "created";
+      },
+) {
+  const response = await request(
+    "GET",
+    "/destruction-list-co-reviews/",
+    params,
+  );
+  const promise: Promise<CoReview[]> = response.json();
+  return promise;
+}

frontend/src/lib/test/index.ts

@@ -0,0 +1 @@
+export * from "./mock";

frontend/src/lib/test/mock.ts

@@ -0,0 +1,88 @@
+import { responseFactory } from "../../fixtures/response";
+
+const SYMBOL_NATIVE_FETCH = Symbol();
+const SYMBOL_MOCKED_REQUESTS = Symbol();
+// @ts-expect-error - set native reference.
+window[SYMBOL_NATIVE_FETCH] = window.fetch;
+// @ts-expect-error - set mocked requests record.
+window[SYMBOL_MOCKED_REQUESTS] = {};
+
+/**
+ * Mock fetch() function.
+ * This is useful when using Jest tests, use storybook-addon-mock for stories
+ * (if available).
+ */
+export function addFetchMock(
+  mockUrl: string,
+  mockMethod: "DELETE" | "GET" | "PATCH" | "POST" | "PUT",
+  responseData: unknown = {},
+) {
+  window.fetch = async (...args) => {
+    const [url, requestInit] = args;
+    const method = requestInit?.method || "GET";
+
+    // Use mock if method and url match mock.
+    if (url === mockUrl && method === mockMethod) {
+      // Update window[SYMBOL_MOCKED_REQUESTS]
+      // @ts-expect-error - set mocked requests record.
+      window[SYMBOL_MOCKED_REQUESTS][url] = [
+        // @ts-expect-error - get mocked requests record.
+        ...(window[SYMBOL_MOCKED_REQUESTS][url] || []),
+        requestInit,
+      ];
+
+      // Return responseData
+      return responseFactory({ json: async () => responseData });
+    }
+
+    // We have mocks active (so testing environment) but are making live
+    // requests. This is probably unwanted.
+    // NOTE: Use e2e test to test actual integration.
+    console.warn(method, url, "unmocked!");
+
+    // @ts-expect-error - get native reference.
+    return window[SYMBOL_NATIVE_FETCH](...args);
+  };
+}
+
+/**
+ * Restores original fetch function.
+ */
+export function restoreNativeFetch() {
+  // @ts-expect-error - check native implementation
+  if (window[SYMBOL_NATIVE_FETCH]) {
+    // @ts-expect-error - set native implementation
+    window.fetch = window[SYMBOL_NATIVE_FETCH];
+  }
+}
+
+/**
+ * Returns calls to mocked URL.
+ * @param mockUrl
+ * @param mockMethod
+ */
+export function getMockedRequests(
+  mockUrl: string,
+  mockMethod: "DELETE" | "GET" | "PATCH" | "POST" | "PUT",
+): RequestInit[] {
+  const records: RequestInit[] =
+    // @ts-expect-error - get mocked requests records.
+    window[SYMBOL_MOCKED_REQUESTS][mockUrl] || [];
+
+  return records.filter(
+    (requestInit: RequestInit) => (requestInit.method || "GET") === mockMethod,
+  );
+}
+
+/**
+ * Returns last call to mocked URL.
+ * @param mockUrl
+ * @param mockMethod
+ */
+export function getLastMockedRequest(
+  mockUrl: string,
+  mockMethod: "DELETE" | "GET" | "PATCH" | "POST" | "PUT",
+): RequestInit | undefined {
+  const mockedRequests = getMockedRequests(mockUrl, mockMethod);
+  return mockedRequests[mockedRequests.length - 1];
+}