chore: replace jest with vite (#700)

* chore: replace jest with vite * also lint vite.config.js * remove artifact
octokit · Jun 29, 2024 · 08acbc4 · 08acbc4
1 parent 9ab60c9
commit 08acbc4
Show file tree

Hide file tree

Showing 10 changed files with 1,261 additions and 4,945 deletions.
diff --git a/cypress.json b/cypress.json
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -10,9 +10,9 @@
   "scripts": {
     "build": "node scripts/build.mjs && tsc -p tsconfig.json",
     "lint": "prettier --check '{src,test}/**/*' README.md package.json",
-    "lint:fix": "prettier --write '{src,test}/**/*' README.md package.json",
+    "lint:fix": "prettier --write '{src,test}/**/*' README.md package.json vite.config.js",
     "pretest": "npm run -s lint",
-    "test": "NODE_OPTIONS=\"$NODE_OPTIONS --experimental-vm-modules\" npx jest --coverage"
+    "test": "vitest run --coverage"
   },
   "repository": "github:octokit/request.js",
   "keywords": [
@@ -32,47 +32,15 @@
   "devDependencies": {
     "@octokit/auth-app": "^7.0.0",
     "@octokit/tsconfig": "^3.0.0",
-    "@sinonjs/fake-timers": "^11.2.2",
-    "@types/jest": "^29.0.0",
     "@types/node": "^20.0.0",
-    "@types/sinonjs__fake-timers": "^8.1.5",
+    "@vitest/coverage-v8": "^1.6.0",
     "esbuild": "^0.21.0",
     "fetch-mock": "^10.0.0",
     "glob": "^10.2.4",
-    "jest": "^29.0.0",
     "prettier": "3.3.2",
     "semantic-release-plugin-update-version-in-files": "^1.0.0",
-    "ts-jest": "^29.0.0",
-    "typescript": "^5.0.0"
-  },
-  "jest": {
-    "extensionsToTreatAsEsm": [
-      ".ts"
-    ],
-    "transform": {
-      "^.+\\.(ts|tsx)$": [
-        "ts-jest",
-        {
-          "tsconfig": "test/tsconfig.test.json",
-          "useESM": true
-        }
-      ]
-    },
-    "coverageThreshold": {
-      "global": {
-        "statements": 100,
-        "branches": 100,
-        "functions": 100,
-        "lines": 100
-      }
-    },
-    "modulePathIgnorePatterns": [
-      "<rootDir>/pkg"
-    ],
-    "testEnvironment": "node",
-    "moduleNameMapper": {
-      "^(.+)\\.jsx?$": "$1"
-    }
+    "typescript": "^5.0.0",
+    "vitest": "^1.6.0"
   },
   "release": {
     "branches": [

diff --git a/scripts/build.mjs b/scripts/build.mjs
@@ -54,7 +54,7 @@ async function main() {
   delete pkg.scripts;
   delete pkg.prettier;
   delete pkg.release;
-  delete pkg.jest;
+
   await writeFile(
     "pkg/package.json",
     JSON.stringify(

diff --git a/src/fetch-wrapper.ts b/src/fetch-wrapper.ts
@@ -185,14 +185,12 @@ function toErrorMessage(data: any) {
 
   let suffix: string;
 
-  // istanbul ignore else - just in case
   if ("documentation_url" in data) {
     suffix = ` - ${data.documentation_url}`;
   } else {
     suffix = "";
   }
 
-  // istanbul ignore else - just in case
   if ("message" in data) {
     if (Array.isArray(data.errors)) {
       return `${data.message}: ${data.errors.map(JSON.stringify).join(", ")}${suffix}`;
@@ -201,6 +199,5 @@ function toErrorMessage(data: any) {
     return `${data.message}${suffix}`;
   }
 
-  // istanbul ignore next - just in case
   return `Unknown error: ${JSON.stringify(data)}`;
 }
diff --git a/test/defaults.test.ts b/test/defaults.test.ts
@@ -1,5 +1,6 @@
 import fetchMock from "fetch-mock";
 
+import { describe, it, expect } from "vitest";
 import { request } from "../src/index.ts";
 
 describe("endpoint.defaults()", () => {

diff --git a/test/is-plain-object.test.ts b/test/is-plain-object.test.ts
@@ -1,3 +1,4 @@
+import { describe, it, expect } from "vitest";
 import { isPlainObject } from "../src/is-plain-object.ts";
 
 describe("isPlainObject", () => {

diff --git a/test/request.test.ts b/test/request.test.ts
@@ -2,18 +2,17 @@ import fs from "node:fs";
 import stream from "node:stream";
 import { ReadableStream } from "node:stream/web";
 
+import { describe, it, expect, vi } from "vitest";
 import { getUserAgent } from "universal-user-agent";
 import fetchMock from "fetch-mock";
 import { createAppAuth } from "@octokit/auth-app";
-import fakeTimers from "@sinonjs/fake-timers";
 import type {
   EndpointOptions,
   RequestInterface,
   ResponseHeaders,
 } from "@octokit/types";
 
 import { request } from "../src/index.ts";
-import { jest } from "@jest/globals";
 
 const userAgent = `octokit-request.js/0.0.0-development ${getUserAgent()}`;
 const __filename = new URL(import.meta.url);
@@ -73,7 +72,7 @@ describe("request()", () => {
   });
 
   it("README authentication example", async () => {
-    const clock = fakeTimers.install({
+    const clock = vi.useFakeTimers({
       now: 0,
       toFake: ["Date"],
     });
@@ -158,7 +157,7 @@ x//0u+zd/R/QRUzLOw4N72/Hu+UG6MNt5iDZFCtapRaKt6OvSBwy8w==
       title: "Hello from the engine room",
     });
     expect(mock.done()).toBe(true);
-    clock.reset();
+    vi.useRealTimers();
   });
 
   it("Request with body", () => {
@@ -808,7 +807,7 @@ x//0u+zd/R/QRUzLOw4N72/Hu+UG6MNt5iDZFCtapRaKt6OvSBwy8w==
       },
     })
       .then(() => {
-        fail("This should return error.");
+        throw new Error("This should return error.");
       })
       .catch((error) => {
         expect(error).toHaveProperty(
@@ -840,7 +839,7 @@ x//0u+zd/R/QRUzLOw4N72/Hu+UG6MNt5iDZFCtapRaKt6OvSBwy8w==
       },
     );
 
-    const warn = jest.fn();
+    const warn = vi.fn();
 
     return request("GET /teams/{team_id}", {
       headers: {
@@ -878,7 +877,7 @@ x//0u+zd/R/QRUzLOw4N72/Hu+UG6MNt5iDZFCtapRaKt6OvSBwy8w==
       },
     );
 
-    const warn = jest.fn();
+    const warn = vi.fn();
 
     return request("GET /teams/{team_id}", {
       headers: {
@@ -1121,4 +1120,52 @@ x//0u+zd/R/QRUzLOw4N72/Hu+UG6MNt5iDZFCtapRaKt6OvSBwy8w==
       },
     });
   });
+
+  it("invalid error responses should result in errors with a message field describing the error as an unknown error", function () {
+    const mock = fetchMock.sandbox().mock(
+      "https://request-errors-test.com/repos/gr2m/sandbox/branches/gr2m-patch-1/protection",
+      {
+        status: 400,
+        body: {},
+      },
+      {
+        method: "PUT",
+        headers: {
+          accept: "application/vnd.github.v3+json",
+          authorization: "token secret123",
+        },
+      },
+    );
+
+    return request("PUT /repos/{owner}/{repo}/branches/{branch}/protection", {
+      baseUrl: "https://request-errors-test.com",
+      headers: {
+        authorization: "token secret123",
+      },
+      owner: "gr2m",
+      repo: "sandbox",
+      branch: "gr2m-patch-1",
+      required_status_checks: { strict: true, contexts: ["wip"] },
+      enforce_admins: true,
+      required_pull_request_reviews: {
+        required_approving_review_count: 1,
+        dismiss_stale_reviews: true,
+        require_code_owner_reviews: true,
+        dismissal_restrictions: { users: [], teams: [] },
+      },
+      restrictions: { users: [], teams: [] },
+      request: {
+        fetch: mock,
+      },
+    })
+      .then(() => {
+        throw new Error("This should return error.");
+      })
+      .catch((error) => {
+        expect(error).toHaveProperty(
+          "message",
+          `Unknown error: ${JSON.stringify({})}`,
+        );
+      });
+  });
 });
diff --git a/test/tsconfig.test.json b/test/tsconfig.test.json
@@ -3,7 +3,8 @@
   "compilerOptions": {
     "emitDeclarationOnly": false,
     "noEmit": true,
-    "allowImportingTsExtensions": true
+    "allowImportingTsExtensions": true,
+    "types": ["vitest/globals"]
   },
   "include": ["src/**/*"]
 }
diff --git a/vite.config.js b/vite.config.js
@@ -0,0 +1,13 @@
+import { defineConfig } from "vite";
+
+export default defineConfig({
+  test: {
+    coverage: {
+      include: ["src/**/*.ts"],
+      reporter: ["html"],
+      thresholds: {
+        100: true,
+      },
+    },
+  },
+});