feat: v5 (#563)

BREAKING CHANGE: Drop support for NodeJS v14, v16 BREAKING CHANGE: Remove previews support for the REST API BREAKING CHANGE: remove agent option from octokit.request() --------- Co-authored-by: Nick Floyd <[email protected]> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Gregor Martynus <[email protected]> Co-authored-by: Keegan Campbell <[email protected]>
octokit · Jul 10, 2023 · 0b4ad1e · 0b4ad1e
1 parent 2d2f69f
commit 0b4ad1e
Show file tree

Hide file tree

Showing 13 changed files with 8,239 additions and 18,684 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -13,9 +13,8 @@ jobs:
     strategy:
       matrix:
         node_version:
-          - 14
-          - 16
           - 18
+          - 20
     steps:
       - uses: actions/checkout@v3
       - name: Use Node.js ${{ matrix.node_version }}

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -24,23 +24,25 @@
   "author": "Gregor Martynus (https://github.com/gr2m)",
   "license": "MIT",
   "dependencies": {
-    "@octokit/auth-token": "^3.0.0",
-    "@octokit/graphql": "^5.0.0",
-    "@octokit/request": "^6.0.0",
-    "@octokit/request-error": "^3.0.0",
-    "@octokit/types": "^9.0.0",
+    "@octokit/auth-token": "^4.0.0",
+    "@octokit/graphql": "^7.0.0",
+    "@octokit/request": "^8.0.2",
+    "@octokit/request-error": "^5.0.0",
+    "@octokit/types": "^11.0.0",
     "before-after-hook": "^2.2.0",
     "universal-user-agent": "^6.0.0"
   },
   "devDependencies": {
-    "@octokit/auth": "^3.0.1",
+    "@octokit/auth-action": "^4.0.0",
+    "@octokit/auth-app": "^6.0.0",
+    "@octokit/auth-oauth-app": "^7.0.0",
     "@octokit/tsconfig": "^2.0.0",
     "@types/fetch-mock": "^7.3.1",
     "@types/jest": "^29.0.0",
     "@types/lolex": "^5.1.0",
     "@types/node": "^18.0.0",
     "esbuild": "^0.18.0",
-    "fetch-mock": "^9.0.0",
+    "fetch-mock": "npm:@gr2m/[email protected]",
     "glob": "^10.2.5",
     "http-proxy-agent": "^7.0.0",
     "jest": "^29.0.0",
@@ -103,6 +105,6 @@
     ]
   },
   "engines": {
-    "node": ">= 14"
+    "node": ">= 18"
   }
 }
diff --git a/scripts/build.mjs b/scripts/build.mjs
@@ -46,7 +46,7 @@ async function main() {
       outdir: "pkg/dist-node",
       bundle: true,
       platform: "node",
-      target: "node14",
+      target: "node18",
       format: "cjs",
       ...sharedOptions,
     }),

diff --git a/test/agent-ca/agent-ca-test.test.ts b/test/agent-ca/agent-ca-test.test.ts
@@ -5,7 +5,8 @@ import { resolve } from "path";
 const { Octokit } = require("../../src");
 const ca = readFileSync(resolve(__dirname, "./ca.crt"));
 
-describe("custom client certificate", () => {
+// TODO: rewrite tests to use fetch dispatchers
+describe.skip("custom client certificate", () => {
   let server: any;
   beforeAll((done) => {
     server = createServer(

diff --git a/test/agent-proxy/agent-proxy-test.test.ts b/test/agent-proxy/agent-proxy-test.test.ts
@@ -12,7 +12,8 @@ const { HttpProxyAgent } = require("http-proxy-agent");
 
 import { Octokit } from "../../src";
 
-describe("client proxy", () => {
+// TODO: rewrite tests to use fetch dispatchers
+describe.skip("client proxy", () => {
   let proxy: any;
   let proxyUrl: string;
 

diff --git a/test/auth.test.ts b/test/auth.test.ts
@@ -1,10 +1,8 @@
 import { getUserAgent } from "universal-user-agent";
 import fetchMock from "fetch-mock";
-import {
-  createAppAuth,
-  createActionAuth,
-  createOAuthAppAuth,
-} from "@octokit/auth";
+import { createAppAuth } from "@octokit/auth-app";
+import { createActionAuth } from "@octokit/auth-action";
+import { createOAuthAppAuth } from "@octokit/auth-oauth-app";
 import lolex, { type Clock } from "lolex";
 
 import { Octokit } from "../src";
@@ -163,7 +161,6 @@ describe("Authentication", () => {
     const CLIENT_ID = "0123";
     const CLIENT_SECRET = "0123secret";
     const CODE = "code123";
-    const STATE = "state123";
 
     const mock = fetchMock.sandbox().postOnce(
       "https://github.com/login/oauth/access_token",
@@ -177,7 +174,6 @@ describe("Authentication", () => {
           client_id: CLIENT_ID,
           client_secret: CLIENT_SECRET,
           code: CODE,
-          state: STATE,
         },
       },
     );
@@ -199,7 +195,6 @@ describe("Authentication", () => {
     await octokit.auth({
       type: "oauth-user",
       code: CODE,
-      state: STATE,
     });
 
     expect(mock.done()).toBe(true);
@@ -231,7 +226,7 @@ describe("Authentication", () => {
         { id: 123 },
         {
           headers: {
-            accept: "application/vnd.github.machine-man-preview+json",
+            accept: "application/vnd.github.v3+json",
             "user-agent": userAgent,
             authorization: `bearer ${BEARER}`,
           },
@@ -253,11 +248,7 @@ describe("Authentication", () => {
     await octokit.request("GET /repos/octocat/hello-world");
     await octokit.request("GET /repos/octocat/hello-world");
 
-    await octokit.request("GET /app", {
-      mediaType: {
-        previews: ["machine-man"],
-      },
-    });
+    await octokit.request("GET /app");
 
     expect(mock.done()).toBe(true);
   });

diff --git a/test/constructor.test.ts b/test/constructor.test.ts
@@ -4,7 +4,7 @@ import fetchMock from "fetch-mock";
 describe("Smoke test", () => {
   it("previews option", () => {
     const mock = fetchMock.sandbox().getOnce(
-      "https://api.github.com/",
+      "https://api.github.com/graphql",
       { ok: true },
       {
         headers: {
@@ -25,7 +25,7 @@ describe("Smoke test", () => {
       },
     });
 
-    return octokit.request("/");
+    return octokit.request("/graphql");
   });
 
   it("timeZone option", () => {

diff --git a/test/defaults.test.ts b/test/defaults.test.ts
@@ -1,6 +1,6 @@
 import fetchMock from "fetch-mock";
 import { getUserAgent } from "universal-user-agent";
-import { createActionAuth } from "@octokit/auth";
+import { createActionAuth } from "@octokit/auth-action";
 
 import { Octokit } from "../src";
 

diff --git a/test/graphql.test.ts b/test/graphql.test.ts
@@ -44,7 +44,7 @@ describe("octokit.graphql()", () => {
 
     const result = await octokit.graphql(query, { login: "octokit" });
 
-    expect(result).toStrictEqual(mockResult);
+    expect(JSON.stringify(result)).toStrictEqual(JSON.stringify(mockResult));
   });
 
   it("GitHub Enterprise Server usage (with option.baseUrl)", async () => {
@@ -84,7 +84,7 @@ describe("octokit.graphql()", () => {
 
     const result = await octokit.graphql(query, { login: "octokit" });
 
-    expect(result).toStrictEqual(mockResult);
+    expect(JSON.stringify(result)).toStrictEqual(JSON.stringify(mockResult));
   });
 
   it("custom headers: octokit.graphql({ query, headers })", async () => {
@@ -113,7 +113,7 @@ describe("octokit.graphql()", () => {
       },
     });
 
-    expect(result).toStrictEqual({ ok: true });
+    expect(JSON.stringify(result)).toStrictEqual(JSON.stringify({ ok: true }));
   });
 
   it("custom headers: octokit.graphql(query, { headers })", async () => {
@@ -145,6 +145,6 @@ describe("octokit.graphql()", () => {
       foo: "bar",
     });
 
-    expect(result).toStrictEqual({ ok: true });
+    expect(JSON.stringify(result)).toStrictEqual(JSON.stringify({ ok: true }));
   });
 });
diff --git a/test/hook.test.ts b/test/hook.test.ts
@@ -54,7 +54,7 @@ describe("octokit.hook", () => {
           "x-foo": "bar",
         },
         mediaType: {
-          previews: ["octicon"],
+          previews: [],
           format: "rad",
         },
         bar: "daz",
@@ -77,7 +77,7 @@ describe("octokit.hook", () => {
         "x-foo": "bar",
       },
       mediaType: {
-        previews: ["octicon"],
+        previews: [],
         format: "rad",
       },
     });
@@ -118,10 +118,12 @@ describe("octokit.hook", () => {
 
     const { data } = await octokit.request("/");
 
-    expect(data).toStrictEqual({
-      ok: true,
-      afterAddition: "works",
-    });
+    expect(JSON.stringify(data)).toStrictEqual(
+      JSON.stringify({
+        ok: true,
+        afterAddition: "works",
+      }),
+    );
   });
 
   it("octokit.hook.error('request')", async () => {
@@ -159,9 +161,11 @@ describe("octokit.hook", () => {
 
     const { data } = await octokit.request("/");
 
-    expect(data).toStrictEqual({
-      ok: true,
-    });
+    expect(JSON.stringify(data)).toStrictEqual(
+      JSON.stringify({
+        ok: true,
+      }),
+    );
   });
 
   it("octokit.hook.wrap('request')", async () => {
@@ -192,9 +196,11 @@ describe("octokit.hook", () => {
 
     const { data } = await octokit.request("/");
 
-    expect(data).toStrictEqual({
-      ok: true,
-    });
+    expect(JSON.stringify(data)).toStrictEqual(
+      JSON.stringify({
+        ok: true,
+      }),
+    );
   });
 
   it("octokit.hook()", async () => {

diff --git a/test/issues.test.ts b/test/issues.test.ts
@@ -26,6 +26,8 @@ describe("issues", () => {
     const response = await octokit.request("/");
 
     expect(response.status).toEqual(200);
-    expect(response.data).toStrictEqual({ ok: true });
+    expect(JSON.stringify(response.data)).toStrictEqual(
+      JSON.stringify({ ok: true }),
+    );
   });
 });
diff --git a/test/request.test.ts b/test/request.test.ts
@@ -98,40 +98,41 @@ describe("octokit.request()", () => {
     const mock = fetchMock
       .sandbox()
       .getOnce(
-        "https://api.github.com/",
+        "https://api.github.com/graphql",
         {},
         {
           headers: {
-            accept:
-              "application/vnd.github.foo-preview+json,application/vnd.github.bar-preview+json",
+            accept: "application/vnd.github.package-deletes-preview.json",
             "user-agent": userAgent,
           },
         },
       )
       .getOnce(
-        "https://api.github.com/",
+        "https://api.github.com/graphql",
         {},
         {
           headers: {
-            accept:
-              "application/vnd.github.foo-preview.raw,application/vnd.github.bar-preview.raw,application/vnd.github.baz-preview.raw",
+            accept: "application/vnd.github.v3.raw",
             "user-agent": userAgent,
           },
           overwriteRoutes: false,
         },
       );
 
     const octokit = new Octokit({
-      previews: ["foo", "bar-preview"],
       request: {
         fetch: mock,
       },
     });
 
-    await octokit.request("/");
-    await octokit.request("/", {
+    await octokit.request("/graphql", {
+      mediaType: {
+        previews: ["package-deletes"],
+        format: "json",
+      },
+    });
+    await octokit.request("/graphql", {
       mediaType: {
-        previews: ["bar", "baz-preview"],
         format: "raw",
       },
     });
@@ -178,6 +179,7 @@ describe("octokit.request()", () => {
       {
         owner: "epmatsw",
         repo: "example-repo",
+        // @ts-expect-error There is currently an issue with the types, null is an allowed value
         milestone: null,
         issue_number: 1,
       },