Setup ESLint rules for Playwright tests and fix related issues

Author: nodeexx

.eslintrc.cjs

@@ -101,5 +101,12 @@ module.exports = {
         'testing-library/prefer-screen-queries': 'off',
       },
     },
+    {
+      files: ['tests/playwright/**/*.{api-test,e2e-test}.{js,ts}'],
+      extends: ['plugin:playwright/recommended'],
+      rules: {
+        'playwright/expect-expect': 'off',
+      },
+    },
   ],
 };

package-lock.json

@@ -105,6 +105,7 @@
     "eslint": "8.53.0",
     "eslint-config-prettier": "9.0.0",
     "eslint-plugin-jest-dom": "5.1.0",
+    "eslint-plugin-playwright": "1.5.4",
     "eslint-plugin-simple-import-sort": "12.0.0",
     "eslint-plugin-svelte": "2.34.1",
     "eslint-plugin-testing-library": "6.1.0",

package.json

@@ -10,6 +10,10 @@ import {
 } from '../../common/lib/setup';
 
 setup('setup API', async ({ page, baseURL }) => {
+  if (!baseURL) {
+    throw new Error('Base URL is not set');
+  }
+
   seedDb();
   await saveVisitorRoleState(page);
 

tests/playwright/api/tests/index.api-setup.ts

@@ -8,10 +8,6 @@ test.describe('POST /profile?/sign-out', () => {
     page,
     baseURL,
   }) => {
-    if (!baseURL) {
-      throw new Error('Base URL is not set');
-    }
-
     const homePage = new HomePage(page);
     await homePage.doNavigateTo();
 
@@ -20,7 +16,7 @@ test.describe('POST /profile?/sign-out', () => {
     const response = await page.request.post('/profile?/sign-out', {
       headers: {
         // Needed to pass CSRF check
-        origin: baseURL,
+        origin: baseURL!,
       },
       form: {},
     });
@@ -35,15 +31,11 @@ test.describe('POST /profile?/sign-out', () => {
   });
 
   test('returns 401 if user is not logged in', async ({ page, baseURL }) => {
-    if (!baseURL) {
-      throw new Error('Base URL is not set');
-    }
-
     await page.context().clearCookies();
     const response = await page.request.post('/profile?/sign-out', {
       headers: {
         // Needed to pass CSRF check
-        origin: baseURL,
+        origin: baseURL!,
       },
       form: {},
     });

tests/playwright/api/tests/signed-in-user--before-sign-out/sign-out.api-test.ts

@@ -10,17 +10,13 @@ test.describe('POST /code-snippets/create?/create', () => {
     page,
     baseURL,
   }) => {
-    if (!baseURL) {
-      throw new Error('Base URL is not set');
-    }
-
     const homePage = new HomePage(page);
     await homePage.doNavigateTo();
 
     const response = await page.request.post('/code-snippets/create?/create', {
       headers: {
         // Needed to pass CSRF check
-        origin: baseURL,
+        origin: baseURL!,
       },
       multipart: {
         name: CODE_SNIPPET.name,

tests/playwright/api/tests/signed-in-user/code-snippets/create.api-test.ts

@@ -10,10 +10,6 @@ test.describe('POST /code-snippets/:id?/delete', () => {
     page,
     baseURL,
   }) => {
-    if (!baseURL) {
-      throw new Error('Base URL is not set');
-    }
-
     const homePage = new HomePage(page);
     await homePage.doNavigateTo();
 
@@ -22,7 +18,7 @@ test.describe('POST /code-snippets/:id?/delete', () => {
       {
         headers: {
           // Needed to pass CSRF check
-          origin: baseURL,
+          origin: baseURL!,
         },
         multipart: {},
       },

tests/playwright/api/tests/signed-in-user/code-snippets/delete.api-test.ts

@@ -10,10 +10,6 @@ test.describe('POST /code-snippets/:id/edit?/edit', () => {
     page,
     baseURL,
   }) => {
-    if (!baseURL) {
-      throw new Error('Base URL is not set');
-    }
-
     const homePage = new HomePage(page);
     await homePage.doNavigateTo();
 
@@ -22,7 +18,7 @@ test.describe('POST /code-snippets/:id/edit?/edit', () => {
       {
         headers: {
           // Needed to pass CSRF check
-          origin: baseURL,
+          origin: baseURL!,
         },
         multipart: {
           name: CODE_SNIPPET.newName,

tests/playwright/api/tests/signed-in-user/code-snippets/edit.api-test.ts

@@ -5,14 +5,10 @@ test.describe('POST /sign-in?/google-auth', () => {
     request,
     baseURL,
   }, testInfo) => {
-    if (!baseURL) {
-      throw new Error('Base URL is not set');
-    }
-
     const response = await request.post('/sign-in?/google-auth', {
       headers: {
         // Needed to pass CSRF check
-        origin: baseURL,
+        origin: baseURL!,
       },
       form: {},
     });

tests/playwright/api/tests/visitor/sign-in.api-test.ts

@@ -12,7 +12,7 @@ test.describe('Feature: Sign out', () => {
 
     await expect(
       homePage.componentNavigationBar.getSignInButton(),
-    ).not.toBeVisible();
+    ).toBeHidden();
     await expect(
       homePage.componentNavigationBar.getProfileButton(),
     ).toBeVisible();
@@ -29,6 +29,6 @@ test.describe('Feature: Sign out', () => {
     ).toBeVisible();
     await expect(
       homePage.componentNavigationBar.getProfileButton(),
-    ).not.toBeVisible();
+    ).toBeHidden();
   });
 });

tests/playwright/e2e/tests/signed-in-user--before-sign-out/sign-out.e2e-test.ts

@@ -14,7 +14,7 @@ test.describe('Feature: Sign in/Sign up via Google', () => {
       ).toBeVisible();
       await expect(
         homePage.componentNavigationBar.getProfileButton(),
-      ).not.toBeVisible();
+      ).toBeHidden();
 
       await homePage.componentNavigationBar.doClickSignInButton();