feat: add parseSuccessResponseBody Option

src/fetch-wrapper.ts

@@ -4,15 +4,19 @@ import type { EndpointInterface } from "@octokit/types";
 
 import getBuffer from "./get-buffer-response";
 
-export default function fetchWrapper(
-  requestOptions: ReturnType<EndpointInterface> & {
-    redirect?: "error" | "follow" | "manual";
-  },
-) {
+type RequestOptions = ReturnType<EndpointInterface> & {
+  redirect?: "error" | "follow" | "manual";
+  request?: {
+    parseResponse?: boolean;
+  };
+};
+
+export default function fetchWrapper(requestOptions: RequestOptions) {
   const log =
     requestOptions.request && requestOptions.request.log
       ? requestOptions.request.log
       : console;
+  const parseResponse = requestOptions.request?.parseResponse !== false
 
   if (
     isPlainObject(requestOptions.body) ||
@@ -93,14 +97,18 @@ export default function fetchWrapper(
             url,
             status,
             headers,
-            data: await getResponseData(response),
+            data: parseResponse
+              ? await getResponseData(response)
+              : response.body,
           },
           request: requestOptions,
         });
       }
 
       if (status >= 400) {
-        const data = await getResponseData(response);
+        const data = parseResponse
+          ? await getResponseData(response)
+          : response.body;
 
         const error = new RequestError(toErrorMessage(data), status, {
           response: {
@@ -115,7 +123,7 @@ export default function fetchWrapper(
         throw error;
       }
 
-      return getResponseData(response);
+      return parseResponse ? await getResponseData(response) : response.body;
     })
     .then((data) => {
       return {

test/request.test.ts

@@ -1,5 +1,5 @@
 import fs from "fs";
-import stream from "stream";
+import stream, { Stream } from "stream";
 
 import { getUserAgent } from "universal-user-agent";
 import fetchMock from "fetch-mock";
@@ -1021,4 +1021,35 @@ x//0u+zd/R/QRUzLOw4N72/Hu+UG6MNt5iDZFCtapRaKt6OvSBwy8w==
       expect(error.name).toEqual("AbortError");
     });
   });
+
+  it("request should pass the stream in the response", () => {
+    const mock = fetchMock.sandbox().get(
+      "https://api.github.com/repos/octokit-fixture-org/release-assets/tarball/main",
+      {
+        status: 200,
+        headers: {
+          "content-type": "application/x-gzip",
+        },
+        body: fs.createReadStream(__filename),
+      },
+      {
+        sendAsJson: false,
+      },
+    );
+
+    return request("GET /repos/{owner}/{repo}/tarball/{branch}", {
+      owner: "octokit-fixture-org",
+      repo: "release-assets",
+      branch: "main",
+      request: {
+        parseResponse: false,
+        fetch: mock,
+      },
+    }).then((response) => {
+      expect(response.status).toEqual(200);
+      expect(response.headers["content-type"]).toEqual("application/x-gzip");
+      expect(response.data).toBeInstanceOf(Stream);
+      expect(mock.done()).toBe(true);
+    });
+  });
 });