test(all): improve & greatly speed up tests (#215)

* chore(tests): refactor tests to use common cleanup

* chore(lint): fix lint errors

* test(all): improve & greatly speed up tests

Closes #212, #213, #214

* chore(ci): fix ci tests

* test(setup): fix Prisma error correctly, credits to @jellebuitenhuisis

Author: Andreas02-dev

.github/workflows/playwright.yml

@@ -29,7 +29,7 @@ jobs:
               run: |
                   cp .env.example .env
             - name: "🎭 Run Playwright tests"
-              run: npx playwright test
+              run: npm run test
             - name: "📤 Upload Artifacts"
               uses: actions/upload-artifact@v4
               if: always()

package.json

@@ -14,9 +14,9 @@
         "dev": "next dev --turbo",
         "lint": "next lint",
         "lint:fix": "npm run lint -- --fix",
-        "start": "node ./node_modules/next/dist/bin/next start",
+        "start": "next start",
         "typecheck": "tsc --noEmit",
-        "test": "playwright test"
+        "test": "npm run build && playwright test"
     },
     "prisma": {
         "seed": "node prisma/seed.js"

playwright.config.ts

@@ -15,8 +15,6 @@ export default defineConfig({
     /* Fail the build on CI if you accidentally left test.only in the source code. */
     forbidOnly: !!process.env["CI"],
     retries: 0,
-    /* Opt out of parallel tests */
-    workers: 1,
     /* Reporter to use. See https://playwright.dev/docs/test-reporters */
     reporter: [["list", { printSteps: true }], ["html"]],
     /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */

src/auth.ts

@@ -65,4 +65,10 @@ export const { auth, handlers, signIn, signOut } = NextAuth({
             allowDangerousEmailAccountLinking: true,
         }),
     ],
+    /**
+     * We trust our deployment provider to set the HOST header safely.
+     * If you don't trust your deployment provider to set the HOST header safely, you should set this to `false`.
+     * @see https://authjs.dev/reference/core#trusthost
+     */
+    trustHost: true,
 });

tests/helpers/db/index.ts

@@ -8,45 +8,45 @@ import { exec } from "child_process";
 import { promisify } from "util";
 
 export class DbHelper {
-    private client: PrismaDbClient | null = null;
-    private container: StartedPostgreSqlContainer | null = null;
-    private readonly execAsync = promisify(exec);
-    private readonly cwd = new URL("..", import.meta.url);
+    #client: PrismaDbClient | null = null;
+    #container: StartedPostgreSqlContainer | null = null;
+    readonly #execAsync = promisify(exec);
+    readonly #cwd = new URL("..", import.meta.url);
 
     static async create(): Promise<DbHelper> {
         const dbHelper = new DbHelper();
-        dbHelper.container = await new PostgreSqlContainer().start();
-        dbHelper.client = await dbHelper.setupDatabase();
+        dbHelper.#container = await new PostgreSqlContainer().start();
+        dbHelper.#client = await dbHelper.setupDatabase();
         return dbHelper;
     }
 
     getClient(): PrismaDbClient {
-        if (!this.client) {
+        if (!this.#client) {
             throw new Error("PrismaClient has not been initialized");
         }
-        return this.client;
+        return this.#client;
     }
 
     getContainer(): StartedPostgreSqlContainer {
-        if (!this.container) {
+        if (!this.#container) {
             throw new Error("Container has not been initialized");
         }
-        return this.container;
+        return this.#container;
     }
 
     async setupDatabase(): Promise<PrismaDbClient> {
-        await this.execAsync("npm run db:push", {
+        await this.#execAsync("npm run db:push", {
             env: {
                 ...process.env,
-                DATABASE_URL: this.container!.getConnectionUri(),
+                DATABASE_URL: this.#container!.getConnectionUri(),
             },
-            cwd: this.cwd,
+            cwd: this.#cwd,
             encoding: "utf-8",
         });
         return new PrismaDbClient({
             datasources: {
                 db: {
-                    url: this.container!.getConnectionUri(),
+                    url: this.#container!.getConnectionUri(),
                 },
             },
             log: [
@@ -65,4 +65,9 @@ export class DbHelper {
         await this.getClient().survey.deleteMany();
         await this.getClient().role.deleteMany();
     }
+
+    async stop() {
+        await this.getClient().$disconnect();
+        await this.getContainer().stop();
+    }
 }

tests/helpers/test-setup.ts

@@ -43,8 +43,8 @@ export class TestSetup {
             nextProcess,
             cleanup: async () => {
                 await page.close();
-                await dbHelper.getContainer().stop();
                 await killAllProcesses(nextProcess);
+                await dbHelper.stop();
             },
         };
     }
@@ -57,7 +57,7 @@ export class TestSetup {
             (res, rej) => {
                 const nextProcess = spawn(
                     "npm",
-                    ["run", "dev", "--", "--port", "0"],
+                    ["run", "start", "--", "--port", "0"],
                     {
                         cwd: this.cwd,
                         shell: true,