test: use vitest (#802)

* wip

* feat: roles

* ci: rename steps

* ci: do not fail fast

* ci: combine linting

* ci: combine linting

* ci: combine linting

* ci: test api

* wip

* wip

* chore: merge

* feat: ui for root key permission settings

* feat: new root keys

* feat: ui

* chore: merge

* test: use vitest

* chore(pr.yaml): update workflow file to use unit_test.yaml instead of test_packages.yaml
feat(unit_test.yaml): add unit test workflow for multiple paths using matrix strategy

* fix: tests

* fix: tests

* docs: explain how to run tests

* chore: drop strict mode

* lint: knip

* fix(test_api.yaml): change test command from 'pnpm test:e2e' to 'pnpm test:routes'

.github/actions/install/action.yaml

@@ -36,5 +36,4 @@ runs:
       shell: bash
       run: |
         pnpm install --recursive
-        npm i -g bun
         npm i -g wrangler

.github/workflows/deploy_api.yaml

@@ -12,7 +12,7 @@ env:
   PLANETSCALE_SERVICE_TOKEN: ${{ secrets.PLANETSCALE_SERVICE_TOKEN }}
 
 jobs:
-  test_api_worker:
+  test_routes:
      name: Unit Test API
      runs-on: ubuntu-latest
 
@@ -54,8 +54,8 @@ jobs:
          uses: ./.github/actions/install
 
 
-       - name: Test
-         run: bun test src/routes --coverage --timeout 10000 --rerun-each 3
+       - name: Test Routes
+         run: pnpm test:routes
          working-directory: apps/api
          env:
            UNKEY_ROOT_KEY: "not-empty" # this is not requried for these tests, but it is required for the env validation, I should fix this
@@ -104,15 +104,15 @@ jobs:
         uses: ./.github/actions/install
 
       - name: Test
-        run: bun test src/integration --timeout 10000 --rerun-each 10
+        run: pnpm test:e2e
         working-directory: apps/api
         env:
           UNKEY_BASE_URL: https://preview-api.unkey.dev
           UNKEY_ROOT_KEY: ${{ secrets.PREVIEW_ROOT_KEY }}
 
   canary:
       needs:
-        - test_api_worker
+        - test_routes
         - preview-tests
       environment: Canary
       runs-on: ubuntu-latest
@@ -138,15 +138,14 @@ jobs:
     name: End to End Test Canary
     runs-on: ubuntu-latest
 
-
     steps:
       - uses: actions/checkout@v3
 
       - name: Install
         uses: ./.github/actions/install
 
       - name: Test
-        run: bun test src/integration --timeout 10000 --rerun-each 10
+        run: pnpm test:e2e
         working-directory: apps/api
         env:
           UNKEY_BASE_URL: https://canary.unkey.dev

.github/workflows/pr.yaml

@@ -20,7 +20,7 @@ jobs:
 
   test_packages:
     name: Test Packages
-    uses: ./.github/workflows/test_packages.yaml
+    uses: ./.github/workflows/unit_test.yaml
 
   build_apps:
     name: Build Apps

.github/workflows/test_api.yaml

@@ -5,7 +5,7 @@ on:
 jobs:
 
   test_routes:
-    name: Routes
+    name: Test API Routes
     runs-on: ubuntu-latest
     services:
          mysql:
@@ -34,8 +34,6 @@ jobs:
       - name: Install
         uses: ./.github/actions/install
 
-      - name: Install bun
-        run:  npm i -g bun
 
       - name: Load Schema into MySQL
         run: pnpm drizzle-kit push:mysql
@@ -45,7 +43,7 @@ jobs:
 
 
       - name: Test
-        run: bun test src/routes --coverage --timeout 10000 --rerun-each 3
+        run: pnpm test:routes
         working-directory: apps/api
         env:
           DATABASE_HOST: localhost:8080

.github/workflows/unit_test.yaml

@@ -0,0 +1,34 @@
+name: Unit Tests
+on:
+  workflow_call:
+
+jobs:
+  test:
+    strategy:
+     fail-fast: false
+     matrix:
+        path:
+          - "./internal/billing"
+          - "./internal/hash"
+          - "./internal/hash"
+          - "./internal/keys"
+          - "./internal/rbac"
+          - "./pacakges/nextjs"
+          - "./packages/api"
+          - "./packages/hono"
+          - "./packages/nuxt"
+
+    name: Test ${{matrix.path}}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+
+      - name: Install
+        uses: ./.github/actions/install
+
+      - name: Build
+        run: pnpm turbo run build --filter=${{matrix.path}}
+
+      - name: Test
+        run: pnpm turbo run test --filter=${{matrix.path}}

.gitignore

@@ -18,4 +18,4 @@ dist
 .vscode
 .dev.vars
 .wrangler
-.vitest
+.vitest

apps/api/.gitignore

@@ -1 +1,2 @@
 .wrangler
+.vitest

apps/api/package.json

@@ -5,13 +5,17 @@
   "scripts": {
     "build": "tsc",
     "deploy": "pnpm build && wrangler deploy",
-    "dev": "pnpm build && wrangler dev"
+    "dev": "pnpm build && wrangler dev",
+    "test:unit": "vitest run -c vitest.unit.ts",
+    "test:routes": "vitest run -c vitest.routes.ts",
+    "test:e2e": "vitest run -c vitest.e2e.ts"
   },
   "devDependencies": {
     "@cloudflare/workers-types": "^4.20231121.0",
     "@unkey/tsconfig": "workspace:^",
-    "bun-types": "^1.0.15",
+    "@vitest/ui": "^1.2.0",
     "typescript": "^5.3.2",
+    "vitest": "^0.34.3",
     "wrangler": "^3.19.0"
   },
   "dependencies": {

apps/api/src/integration/create_verify_delete_key.test.ts

@@ -4,7 +4,9 @@ import type { V1ApisCreateApiRequest, V1ApisCreateApiResponse } from "@/routes/v
 import type { V1KeysCreateKeyRequest, V1KeysCreateKeyResponse } from "@/routes/v1_keys_createKey";
 import { V1KeysDeleteKeyRequest, V1KeysDeleteKeyResponse } from "@/routes/v1_keys_deleteKey";
 import { V1KeysVerifyKeyRequest, V1KeysVerifyKeyResponse } from "@/routes/v1_keys_verifyKey";
-import { expect, test } from "bun:test";
+import { afterAll, expect, test } from "vitest";
+
+const apiIds: string[] = [];
 
 const env = integrationTestEnv.parse(process.env);
 test("create, verify and delete a key", async () => {
@@ -21,6 +23,7 @@ test("create, verify and delete a key", async () => {
   });
   expect(createApiResponse.status).toEqual(200);
   expect(createApiResponse.body.apiId).toBeDefined();
+  apiIds.push(createApiResponse.body.apiId);
   expect(createApiResponse.headers).toHaveProperty("unkey-request-id");
 
   const key = await step<V1KeysCreateKeyRequest, V1KeysCreateKeyResponse>({
@@ -80,20 +83,20 @@ test("create, verify and delete a key", async () => {
   });
   expect(validAfterRevoke.status).toEqual(200);
   expect(validAfterRevoke.body.valid).toEqual(false);
+});
 
-  /**
-   * Tear down
-   */
-  const deleteApi = await step({
-    url: `${env.UNKEY_BASE_URL}/v1/apis.deleteApi`,
-    method: "POST",
-    headers: {
-      "Content-Type": "application/json",
-      Authorization: `Bearer ${env.UNKEY_ROOT_KEY}`,
-    },
-    body: {
-      apiId: createApiResponse.body.apiId,
-    },
-  });
-  expect(deleteApi.status).toEqual(200);
+afterAll(async () => {
+  for (const apiId of apiIds) {
+    await step({
+      url: `${env.UNKEY_BASE_URL}/v1/apis.deleteApi`,
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json",
+        Authorization: `Bearer ${env.UNKEY_ROOT_KEY}`,
+      },
+      body: {
+        apiId,
+      },
+    });
+  }
 });

apps/api/src/integration/list_keys.test.ts

@@ -5,7 +5,7 @@ import { V1ApisDeleteApiRequest, V1ApisDeleteApiResponse } from "@/routes/v1_api
 import type { V1ApisListKeysResponse } from "@/routes/v1_apis_listKeys";
 import type { V1KeysCreateKeyRequest, V1KeysCreateKeyResponse } from "@/routes/v1_keys_createKey";
 import { V1KeysDeleteKeyRequest } from "@/routes/v1_keys_deleteKey";
-import { expect, test } from "bun:test";
+import { expect, test } from "vitest";
 
 const env = integrationTestEnv.parse(process.env);
 test("create and list keys", async () => {
@@ -161,4 +161,4 @@ test("list keys does not return revoked keys", async () => {
     },
   });
   expect(deleteApi.status).toEqual(200);
-});
+}, 10_000);

apps/api/src/integration/remaining_is_consistent.test.ts

@@ -5,7 +5,7 @@ import type { V1ApisDeleteApiRequest, V1ApisDeleteApiResponse } from "@/routes/v
 import type { V1KeysCreateKeyRequest, V1KeysCreateKeyResponse } from "@/routes/v1_keys_createKey";
 import { V1KeysGetKeyResponse } from "@/routes/v1_keys_getKey";
 import type { V1KeysVerifyKeyRequest, V1KeysVerifyKeyResponse } from "@/routes/v1_keys_verifyKey";
-import { expect, test } from "bun:test";
+import { expect, test } from "vitest";
 
 const env = integrationTestEnv.parse(process.env);
 
@@ -59,7 +59,7 @@ test("remaining consistently counts down", async () => {
     });
 
     expect(valid.status).toEqual(200);
-    expect(valid.body.valid).toBeTrue();
+    expect(valid.body.valid).toBe(true);
     expect(valid.body.remaining).toEqual(i);
   }
 
@@ -76,7 +76,7 @@ test("remaining consistently counts down", async () => {
     },
   });
   expect(invalid.status).toEqual(200);
-  expect(invalid.body.valid).toBeFalse();
+  expect(invalid.body.valid).toBe(false);
   expect(invalid.body.remaining).toEqual(0);
 
   const key = await step<never, V1KeysGetKeyResponse>({