fix: use json-with-bigint instead of built-in JSON methods in order to properly support int64's (#798)

* Refactor JSON response handling in fetch-wrapper

* Add text variable for JSON response parsing

Initialize text variable for JSON response handling.

* Update src/fetch-wrapper.ts

* Apply suggestions from code review

* switch to json-with-bigint

* Add test

* properly serialises request bodies that contain int64 (BigInt)

* remove test

* bump endpoints

Author: wolfy1339

package-lock.json

@@ -25,10 +25,11 @@
   "author": "Gregor Martynus (https://github.com/gr2m)",
   "license": "MIT",
   "dependencies": {
-    "@octokit/endpoint": "^11.0.2",
+    "@octokit/endpoint": "^11.0.3",
     "@octokit/request-error": "^7.0.2",
     "@octokit/types": "^16.0.0",
     "fast-content-type-parse": "^3.0.0",
+    "json-with-bigint": "^3.5.3",
     "universal-user-agent": "^7.0.2"
   },
   "devDependencies": {
@@ -38,9 +39,9 @@
     "@vitest/coverage-v8": "^4.0.0",
     "esbuild": "^0.27.0",
     "fetch-mock": "^12.0.0",
-    "tinyglobby": "^0.2.15",
     "prettier": "3.6.2",
     "semantic-release-plugin-update-version-in-files": "^2.0.0",
+    "tinyglobby": "^0.2.15",
     "typescript": "^5.0.0",
     "undici": "^7.0.0",
     "vitest": "^4.0.0"

package.json

@@ -1,4 +1,5 @@
 import { safeParse } from "fast-content-type-parse";
+import { JSONParse, JSONStringify } from "json-with-bigint";
 import { isPlainObject } from "./is-plain-object.js";
 import { RequestError } from "@octokit/request-error";
 import type { EndpointInterface, OctokitResponse } from "@octokit/types";
@@ -26,7 +27,7 @@ export default async function fetchWrapper(
 
   const body =
     isPlainObject(requestOptions.body) || Array.isArray(requestOptions.body)
-      ? JSON.stringify(requestOptions.body)
+      ? JSONStringify(requestOptions.body)
       : requestOptions.body;
 
   // Header values must be `string`
@@ -167,7 +168,7 @@ async function getResponseData(response: Response): Promise<any> {
     let text = "";
     try {
       text = await response.text();
-      return JSON.parse(text);
+      return JSONParse(text);
     } catch (err) {
       return text;
     }

src/fetch-wrapper.ts

@@ -14,6 +14,7 @@ import type {
 } from "@octokit/types";
 
 import { request } from "../src/index.ts";
+import { JSONStringify } from "json-with-bigint";
 
 const userAgent = `octokit-request.js/0.0.0-development ${getUserAgent()}`;
 const __filename = new URL(import.meta.url);
@@ -1328,4 +1329,41 @@ x//0u+zd/R/QRUzLOw4N72/Hu+UG6MNt5iDZFCtapRaKt6OvSBwy8w==
       ],
     });
   });
+
+  it("parses JSON response bodies that contain int64 (BigInt)", async () => {
+    expect.assertions(2);
+
+    const mock = fetchMock.createInstance();
+    mock.get("https://api.github.com/app/hook/deliveries", {
+      status: 200,
+      headers: {
+        "Content-Type": "application/json; charset=utf-8",
+      },
+      body: [
+        {
+          id: Number.MAX_SAFE_INTEGER + 9,
+          guid: "0b989ba4-242f-11e5-81e1-c7b6966d2516",
+          delivered_at: "2019-06-03T00:57:16Z",
+          redelivery: false,
+          duration: 0.27,
+          status: "OK",
+          status_code: 200,
+          event: "issues",
+          action: "opened",
+          installation_id: 123,
+          repository_id: 456,
+          throttled_at: "2019-06-03T00:57:16Z",
+        },
+      ],
+    });
+
+    const response = await request("GET /app/hook/deliveries", {
+      request: {
+        fetch: mock.fetchHandler,
+      },
+    });
+
+    expect(response.status).toEqual(200);
+    expect(response.data[0].id).toEqual(BigInt(Number.MAX_SAFE_INTEGER) + 9n);
+  });
 });