feat: add parseSuccessResponseBody Option (#602)

Author: Uzlopak

README.md

@@ -346,6 +346,17 @@ const { data: app } = await requestWithAuth(
       Used for internal logging. Defaults to <a href="https://developer.mozilla.org/en-US/docs/Web/API/console"><code>console</code></a>.
     </td>
   </tr>
+  </tr>
+    <th align=left>
+      <code>options.request.parseSuccessResponseBody</code>
+    </th>
+    <td>
+      <code>boolean</code>
+    </td>
+    <td>
+      If set to <code>false</code> the returned `response` will be passed through from `fetch`. This is useful to stream response.body when downloading files from the GitHub API.
+    </td>
+  </tr>
 </table>
 
 All other options except `options.request.*` will be passed depending on the `method` and `url` options.

package-lock.json

@@ -24,7 +24,7 @@
   "dependencies": {
     "@octokit/endpoint": "^9.0.0",
     "@octokit/request-error": "^5.0.0",
-    "@octokit/types": "^11.0.0",
+    "@octokit/types": "^11.1.0",
     "is-plain-object": "^5.0.0",
     "universal-user-agent": "^6.0.0"
   },

package.json

@@ -11,6 +11,8 @@ export default function fetchWrapper(
     requestOptions.request && requestOptions.request.log
       ? requestOptions.request.log
       : console;
+  const parseSuccessResponseBody =
+    requestOptions.request?.parseSuccessResponseBody !== false;
 
   if (
     isPlainObject(requestOptions.body) ||
@@ -113,7 +115,9 @@ export default function fetchWrapper(
         throw error;
       }
 
-      return getResponseData(response);
+      return parseSuccessResponseBody
+        ? await getResponseData(response)
+        : response.body;
     })
     .then((data) => {
       return {

src/fetch-wrapper.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: {
+        parseSuccessResponseBody: 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);
+    });
+  });
 });