Merge pull request #72 from pawcoding/copilot/upgrade-to-vitest-v4

pawcoding · web-flow · commit 4ffa0ef6f239 · 2025-10-25T17:21:27.000+02:00
Upgrade to Vitest v4
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -46,7 +46,7 @@
     "@commitlint/cli": "20.1.0",
     "@commitlint/config-conventional": "20.0.0",
     "@types/node": "24.9.1",
-    "@vitest/coverage-v8": "3.2.4",
+    "@vitest/coverage-v8": "4.0.3",
     "astro": "5.15.1",
     "globals": "16.4.0",
     "husky": "9.1.7",
@@ -57,7 +57,7 @@
     "prettier-plugin-organize-imports": "4.3.0",
     "prettier-plugin-packagejson": "2.5.19",
     "typescript": "5.9.3",
-    "vitest": "3.2.4"
+    "vitest": "4.0.3"
   },
   "peerDependencies": {
     "astro": "^5.10.0"
diff --git a/test/loader/fetch-collection.e2e-spec.ts b/test/loader/fetch-collection.e2e-spec.ts
@@ -4,7 +4,6 @@ import {
 } from "astro/content/runtime";
 import { randomUUID } from "crypto";
 import {
-  afterEach,
   assert,
   beforeAll,
   beforeEach,
@@ -52,10 +51,6 @@ describe("fetchCollection", () => {
     superuserToken = token;
   });
 
-  afterEach(() => {
-    vi.resetAllMocks();
-  });
-
   test("should fetch entries without errors", async () => {
     await fetchCollection(options, chunkLoadedMock, superuserToken, undefined);
 
diff --git a/test/loader/live-collection-loader.spec.ts b/test/loader/live-collection-loader.spec.ts
@@ -1,5 +1,5 @@
 import { LiveCollectionError } from "astro/content/runtime";
-import { afterEach, beforeEach, describe, expect, test, vi } from "vitest";
+import { beforeEach, describe, expect, test, vi } from "vitest";
 import { liveCollectionLoader } from "../../src/loader/live-collection-loader";
 import { createLiveLoaderOptions } from "../_mocks/create-live-loader-options";
 import { createPocketbaseEntry } from "../_mocks/create-pocketbase-entry";
@@ -16,10 +16,6 @@ describe("liveCollectionLoader", async () => {
     plem.parseLiveEntry = vi.fn().mockImplementation((e) => e);
   });
 
-  afterEach(() => {
-    vi.resetAllMocks();
-  });
-
   test("should return live data collection with parsed entries", async () => {
     const entry = createPocketbaseEntry();
 
diff --git a/test/loader/live-entry-loader.spec.ts b/test/loader/live-entry-loader.spec.ts
@@ -1,5 +1,5 @@
 import { LiveCollectionError } from "astro/content/runtime";
-import { afterEach, beforeEach, describe, expect, test, vi } from "vitest";
+import { beforeEach, describe, expect, test, vi } from "vitest";
 import { liveEntryLoader } from "../../src/loader/live-entry-loader";
 import { createLiveLoaderOptions } from "../_mocks/create-live-loader-options";
 import { createPocketbaseEntry } from "../_mocks/create-pocketbase-entry";
@@ -16,10 +16,6 @@ describe("liveEntryLoader", async () => {
     plem.parseLiveEntry = vi.fn().mockImplementation((e) => e);
   });
 
-  afterEach(() => {
-    vi.resetAllMocks();
-  });
-
   test("should return parsed entry", async () => {
     const entry = createPocketbaseEntry();
     fem.fetchEntry = vi.fn().mockResolvedValue(entry);
diff --git a/test/loader/load-entries.spec.ts b/test/loader/load-entries.spec.ts
@@ -1,5 +1,5 @@
 import type { LoaderContext } from "astro/loaders";
-import { afterEach, beforeEach, describe, expect, test, vi } from "vitest";
+import { beforeEach, describe, expect, test, vi } from "vitest";
 import { loadEntries } from "../../src/loader/load-entries";
 import { createLoaderContext } from "../_mocks/create-loader-context";
 import { createLoaderOptions } from "../_mocks/create-loader-options";
@@ -18,10 +18,6 @@ describe("loadEntries", async () => {
     context = createLoaderContext();
   });
 
-  afterEach(() => {
-    vi.resetAllMocks();
-  });
-
   test("should call fetchCollection and parseEntry for each entry", async () => {
     const entry = createPocketbaseEntry();
 
diff --git a/test/loader/loader.spec.ts b/test/loader/loader.spec.ts
@@ -1,5 +1,5 @@
 import type { LoaderContext } from "astro/loaders";
-import { afterEach, beforeEach, describe, expect, test, vi } from "vitest";
+import { beforeEach, describe, expect, test, vi } from "vitest";
 import packageJson from "../../package.json";
 import { cleanupEntries } from "../../src/loader/cleanup-entries";
 import { handleRealtimeUpdates } from "../../src/loader/handle-realtime-updates";
@@ -29,10 +29,6 @@ describe("loader", async () => {
     );
   });
 
-  afterEach(() => {
-    vi.resetAllMocks();
-  });
-
   test('should not refresh if shouldRefresh returns "skip"', async () => {
     srm.shouldRefresh = vi.fn().mockReturnValue("skip");
 
diff --git a/test/loader/parse-entry.spec.ts b/test/loader/parse-entry.spec.ts
@@ -1,5 +1,5 @@
 import type { LoaderContext } from "astro/loaders";
-import { afterEach, beforeEach, describe, expect, test, vi } from "vitest";
+import { beforeEach, describe, expect, test, vi } from "vitest";
 import { parseEntry } from "../../src/loader/parse-entry";
 import type { PocketBaseEntry } from "../../src/types/pocketbase-entry.type";
 import { createLoaderContext } from "../_mocks/create-loader-context";
@@ -15,10 +15,6 @@ describe("parseEntry", () => {
     entry = createPocketbaseEntry();
   });
 
-  afterEach(() => {
-    vi.resetAllMocks();
-  });
-
   test("should use default ID if no custom ID field is provided", async () => {
     const options = createLoaderOptions();
 
diff --git a/test/schema/generate-schema.e2e-spec.ts b/test/schema/generate-schema.e2e-spec.ts
@@ -1,5 +1,5 @@
 import type { ZodObject, ZodSchema } from "astro/zod";
-import { afterEach, assert, beforeAll, describe, expect, it, vi } from "vitest";
+import { assert, beforeAll, describe, expect, it, vi } from "vitest";
 import type { PocketBaseLoaderOptions } from "../../src";
 import { generateSchema } from "../../src/schema/generate-schema";
 import { transformFileUrl } from "../../src/schema/transform-files";
@@ -29,10 +29,6 @@ describe("generateSchema", () => {
     token = superuserToken;
   });
 
-  afterEach(() => {
-    vi.resetAllMocks();
-  });
-
   describe("load and parse schema", () => {
     it("should return basic schema if no schema is available", async () => {
       const result = (await generateSchema(
diff --git a/test/schema/read-local-schema.spec.ts b/test/schema/read-local-schema.spec.ts
@@ -1,6 +1,6 @@
 import fs from "fs/promises";
 import path from "path";
-import { beforeEach, describe, expect, test, vi } from "vitest";
+import { describe, expect, test, vi } from "vitest";
 import { readLocalSchema } from "../../src/schema/read-local-schema";
 
 vi.mock("fs/promises");
@@ -21,10 +21,6 @@ describe("readLocalSchema", () => {
     }
   ];
 
-  beforeEach(() => {
-    vi.clearAllMocks();
-  });
-
   test("should return the schema for the specified collection", async () => {
     vi.spyOn(path, "join").mockReturnValue(localSchemaPath);
     vi.spyOn(fs, "readFile").mockResolvedValue(JSON.stringify(mockSchema));
diff --git a/test/utils/create-token-promise.spec.ts b/test/utils/create-token-promise.spec.ts
@@ -0,0 +1,51 @@
+import { beforeEach, describe, expect, it, vi } from "vitest";
+import { createTokenPromise } from "../../src/utils/create-token-promise";
+
+vi.mock("../../src/utils/get-superuser-token");
+
+describe("createTokenPromise", async () => {
+  const superuserToken = "superuser-token";
+
+  const gst = await import("../../src/utils/get-superuser-token");
+
+  beforeEach(() => {
+    gst.getSuperuserToken = vi.fn().mockResolvedValue(superuserToken);
+  });
+
+  it("should return impersonate token when provided", async () => {
+    const impersonateToken = "impersonate-token";
+
+    const token = await createTokenPromise({
+      superuserCredentials: { impersonateToken },
+      url: "doesnt-matter"
+    });
+
+    expect(token).toBe(impersonateToken);
+    expect(gst.getSuperuserToken).not.toHaveBeenCalled();
+  });
+
+  it("should return superuser token when email and password are provided", async () => {
+    const token = await createTokenPromise({
+      superuserCredentials: {
+        email: "doesnt-matter",
+        password: "doesnt-matter"
+      },
+      url: "doesnt-matter"
+    });
+
+    expect(token).toBe(superuserToken);
+    expect(gst.getSuperuserToken).toHaveBeenCalledWith("doesnt-matter", {
+      email: "doesnt-matter",
+      password: "doesnt-matter"
+    });
+  });
+
+  it("should return undefined when no credentials are provided", async () => {
+    const token = await createTokenPromise({
+      url: "doesnt-matter"
+    });
+
+    expect(token).toBeUndefined();
+    expect(gst.getSuperuserToken).not.toHaveBeenCalled();
+  });
+});
diff --git a/test/utils/get-superuser-token.e2e-spec.ts b/test/utils/get-superuser-token.e2e-spec.ts
@@ -1,4 +1,4 @@
-import { assert, beforeAll, describe, expect, it } from "vitest";
+import { assert, beforeAll, describe, expect, it, vi } from "vitest";
 import { getSuperuserToken } from "../../src/utils/get-superuser-token";
 import { checkE2eConnection } from "../_mocks/check-e2e-connection";
 import { createLoaderContext } from "../_mocks/create-loader-context";
@@ -16,6 +16,7 @@ describe("getSuperuserToken", () => {
       email: "invalid",
       password: "invalid"
     });
+
     expect(result).toBeUndefined();
   });
 
@@ -42,6 +43,37 @@ describe("getSuperuserToken", () => {
       options.url,
       options.superuserCredentials
     );
+
     expect(result).toBeDefined();
   });
+
+  it("should retry on rate limit error", async () => {
+    assert(options.superuserCredentials, "Superuser credentials are not set.");
+    assert(
+      !("impersonateToken" in options.superuserCredentials),
+      "Impersonate token should not be used in tests."
+    );
+
+    vi.useFakeTimers({
+      toFake: ["setTimeout"]
+    });
+    vi.spyOn(global, "fetch").mockResolvedValueOnce(
+      new Response(undefined, { status: 429 })
+    );
+
+    const promise = getSuperuserToken(
+      options.url,
+      options.superuserCredentials
+    );
+
+    // Fast-forward time to speed up retries
+    await vi.runAllTimersAsync();
+
+    const result = await promise;
+
+    expect(result).toBeDefined();
+    expect(global.fetch).toHaveBeenCalledTimes(2);
+
+    vi.useRealTimers();
+  });
 });
diff --git a/vitest.config.ts b/vitest.config.ts
@@ -1,4 +1,4 @@
-import { defineConfig } from "vite";
+import { defineConfig } from "vitest/config";
 
 export default defineConfig({
   test: {
@@ -7,6 +7,7 @@ export default defineConfig({
     coverage: {
       include: ["src/**/*.ts"],
       exclude: ["src/types/**/*.ts", "src/index.ts", "src/pocketbase-loader.ts"]
-    }
+    },
+    restoreMocks: true
   }
 });
