Remove originalResponse flag

contiamo · Oct 12, 2020 · e1896fa · e1896fa
1 parent 93c5a0c
commit e1896fa
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 67 deletions.
diff --git a/src/useGet.test.tsx b/src/useGet.test.tsx
@@ -164,6 +164,37 @@ describe("useGet hook", () => {
       expect(onResponse).toBeCalled();
       expect(body).toMatchObject({ oh: "my god 😍" });
     });
+
+    it("should return the original response, including headers", async () => {
+      nock("https://my-awesome-api.fake")
+        .get("/")
+        .reply(200, { oh: "my god 😍" }, { "X-custom-header": "custom value" });
+
+      const MyAwesomeComponent = () => {
+        const { loading, response } = useGet({
+          path: "/",
+        });
+
+        return loading ? (
+          <div data-testid="loading">Loading…</div>
+        ) : (
+          <>
+            <div data-testid="response">{response ? JSON.stringify(response) : null}</div>
+            <div data-testid="custom-header">{response?.headers.get("X-custom-header") || ""}</div>
+          </>
+        );
+      };
+
+      const { getByTestId } = render(
+        <RestfulProvider base="https://my-awesome-api.fake">
+          <MyAwesomeComponent />
+        </RestfulProvider>,
+      );
+
+      await waitForElement(() => getByTestId("response"));
+      expect(getByTestId("response")).not.toBeEmpty();
+      expect(getByTestId("custom-header")).toHaveTextContent("custom value");
+    });
   });
 
   describe("url composition", () =>
@@ -645,67 +676,6 @@ describe("useGet hook", () => {
     });
   });
 
-  describe("originalResponse", () => {
-    it("should return original response when flag is enabled", async () => {
-      nock("https://my-awesome-api.fake")
-        .get("/")
-        .reply(200, { oh: "my god 😍" }, { "X-custom-header": "custom value" });
-
-      const MyAwesomeComponent = () => {
-        const { loading, response } = useGet({
-          path: "/",
-          originalResponse: true,
-        });
-
-        return loading ? (
-          <div data-testid="loading">Loading…</div>
-        ) : (
-          <>
-            <div data-testid="response">{response ? JSON.stringify(response) : null}</div>
-            <div data-testid="header">{response?.headers.get("X-custom-header") || ""}</div>
-          </>
-        );
-      };
-
-      const { getByTestId } = render(
-        <RestfulProvider base="https://my-awesome-api.fake">
-          <MyAwesomeComponent />
-        </RestfulProvider>,
-      );
-
-      await waitForElement(() => getByTestId("response"));
-      expect(getByTestId("response")).not.toBeEmpty();
-      expect(getByTestId("header")).toHaveTextContent("custom value");
-    });
-
-    it("should not return original response when flag is disabled", async () => {
-      nock("https://my-awesome-api.fake")
-        .get("/")
-        .reply(200, { oh: "my god 😍" });
-
-      const MyAwesomeComponent = () => {
-        const { loading, response } = useGet({
-          path: "/",
-        });
-
-        return loading ? (
-          <div data-testid="loading">Loading…</div>
-        ) : (
-          <div data-testid="response">{response ? JSON.stringify(response) : null}</div>
-        );
-      };
-
-      const { getByTestId } = render(
-        <RestfulProvider base="https://my-awesome-api.fake">
-          <MyAwesomeComponent />
-        </RestfulProvider>,
-      );
-
-      await waitForElement(() => getByTestId("response"));
-      expect(getByTestId("response")).toBeEmpty();
-    });
-  });
-
   describe("actions", () => {
     it("should refetch", async () => {
       nock("https://my-awesome-api.fake")

diff --git a/src/useGet.tsx b/src/useGet.tsx
@@ -68,10 +68,6 @@ export interface UseGetProps<TData, TError, TQueryParams, TPathParams> {
       }
     | boolean
     | number;
-  /**
-   * Should the original response object be returned?
-   */
-  originalResponse?: boolean;
 }
 
 async function _fetchData<TData, TError, TQueryParams, TPathParams>(
@@ -147,7 +143,7 @@ async function _fetchData<TData, TError, TQueryParams, TPathParams>(
         loading: false,
         data: null,
         error,
-        response: props.originalResponse ? originalResponse : null,
+        response: originalResponse,
       });
 
       if (!props.localErrorOnly && context.onError) {
@@ -161,7 +157,7 @@ async function _fetchData<TData, TError, TQueryParams, TPathParams>(
       error: null,
       loading: false,
       data: resolve(data),
-      response: props.originalResponse ? originalResponse : null,
+      response: originalResponse,
     });
   } catch (e) {
     // avoid state updates when component has been unmounted