[cleanup] feat: Delete user cleanup api (#45)

* [cleanup] feat: Delete user cleanup api

backend/src/routes/userRoutes.ts

@@ -52,8 +52,9 @@ router.post('/api/users', async (req, res) => {
   }
 });
 
-router.delete('/api/users/:id', authenticateToken, async (req, res) => {
-  const { id } = req.params;
+router.delete('/api/users/', authenticateToken, async (req, res) => {
+  // get id from decoded jwt token
+  const id = req.user.userId;
 
   try {
     await prisma.user.delete({ where: { id } });

backend/tests/service/users.spec.ts

@@ -13,7 +13,6 @@ const email = faker.internet.email();
 const password = faker.internet.password();
 
 let token: string;
-let createdID: string;
 
 describe('Unauthenticated Flows', () => {
   test('Should not be able to get the list of Users', async () => {
@@ -66,12 +65,20 @@ describe('Authenticated Flows', () => {
       });
     expect(response.status).toBe(200);
     expect(response.body.id).toBeDefined();
-    createdID = response.body.id;
   });
 
   test('Delete a User', async () => {
+    const newUserLogin = await request(BASE_URL).post('/api/login').send({
+      password,
+      username,
+    });
+    expect(newUserLogin.status).toBe(200);
+    expect(newUserLogin.body.token).toBeDefined();
+    // Set Token for future requests
+    token = newUserLogin.body.token;
+
     const response = await request(USERS_URL)
-      .delete(`/${createdID}`)
+      .delete('/')
       .set('Authorization', `Bearer ${token}`);
     expect(response.status).toBe(204);
   });

backend/tests/unit/users.spec.ts

@@ -144,19 +144,15 @@ describe('Delete User', () => {
       createdAt: new Date('2024-02-05T23:33:42.252Z'),
       updatedAt: new Date('2024-02-05T23:33:42.252Z'),
     });
-    const response = await request(app).delete(
-      '/api/users/gcf89a7e-b941-4f17-bbe0-4e0c8b2cd272'
-    );
+    const response = await request(app).delete('/api/users/');
     expect(response.status).toBe(204);
   });
 
   test('DELETE with error', async ({}) => {
     prisma.user.delete.mockImplementation(() => {
       throw new Error('Test error');
     });
-    const response = await request(app).delete(
-      '/api/users/gcf89a7e-b941-4f17-bbe0-4e0c8b2cd272'
-    );
+    const response = await request(app).delete('/api/users/');
     expect(response.status).toBe(500);
     expect(response.body).toStrictEqual({
       error: 'Oops, something went wrong',

frontend/src/api/apiService.ts

@@ -84,7 +84,11 @@ export const createUser = async ( user:
   return response;
 }
 
-export const deleteUser = async (id: string) => {
-  const response = await api.delete(`users/${id}`);
+export const deleteUser = async () => {
+  const response = await api.delete('users',  {
+    headers: {
+      "Content-Type": "application/json",
+    },
+  });
   return response;
 }

playwright/helpers/apiLogin.ts

@@ -0,0 +1,31 @@
+import { request, expect, APIResponse } from '@playwright/test';
+import getApiUrl from './getApiUrl';
+
+const apiLogin = async (options: {
+  username: string;
+  password: string;
+}): Promise<APIResponse> => {
+  if (!options.username || !options.password) {
+    throw new Error('Username and Password is required to login');
+  }
+
+  const context = await request.newContext({
+    baseURL: await getApiUrl(),
+  });
+
+  const loginResponse = await context.post('/api/login', {
+    headers: {
+      'Content-Type': 'application/json',
+    },
+    data: {
+      username: options.username,
+      password: options.password,
+    },
+  });
+
+  expect(loginResponse.ok()).toBeTruthy();
+  expect(loginResponse.status()).toBe(200);
+  return loginResponse;
+};
+
+export default apiLogin;

playwright/helpers/deleteUser.ts

@@ -0,0 +1,26 @@
+import { request, expect, APIResponse } from '@playwright/test';
+import getApiUrl from './getApiUrl';
+
+const deleteUser = async (token: string | null): Promise<APIResponse> => {
+  if (!token) {
+    throw new Error('Token is required to delete user');
+  }
+
+  const context = await request.newContext({
+    baseURL: await getApiUrl(),
+  });
+
+  const deleteResponse = await context.delete('/api/users', {
+    headers: {
+      Authorization: `Bearer ${token}`,
+      'Content-Type': 'application/json',
+    },
+  });
+
+  expect(deleteResponse.ok()).toBeTruthy();
+  expect(deleteResponse.status()).toBe(204);
+
+  return deleteResponse;
+};
+
+export default deleteUser;

playwright/helpers/getApiUrl.ts

@@ -0,0 +1,17 @@
+import playwrightConfig from '../playwright.config';
+
+const getApiUrl = async () => {
+  const baseURL = playwrightConfig.use?.baseURL;
+
+  const apiURL = baseURL?.includes('localhost')
+    ? 'http://localhost:5000'
+    : 'https://notes-app-full-stack-be.onrender.com';
+
+  if (!baseURL) {
+    throw new Error('Base URL is required to make API requests');
+  }
+
+  return apiURL;
+};
+
+export default getApiUrl;

playwright/pages/RegistrationPage.ts

@@ -22,6 +22,7 @@ class RegistrationPage {
   accountHeader = () =>
     this.page.getByRole('heading', { name: 'Register new account' });
   errorMessage = () => this.page.locator('.registration-form-error');
+  spinnerContainer = () => this.page.getByTestId('spinner-container');
 
   goto = async () => {
     await this.page.goto('/register');
@@ -56,6 +57,10 @@ class RegistrationPage {
       });
     }
   };
+
+  getLocalStorage = async () => {
+    return await this.page.evaluate(() => JSON.stringify(window.localStorage));
+  };
 }
 
 export default RegistrationPage;

playwright/tests/registration.spec.ts

@@ -1,11 +1,14 @@
-import { test, expect, Page } from '@playwright/test';
+import { test, expect, Page, APIResponse } from '@playwright/test';
 import { faker } from '@faker-js/faker';
 import { allure } from 'allure-playwright';
 import RegistrationPage from '../pages/RegistrationPage';
+import deleteUser from '../helpers/deleteUser';
+import apiLogin from '../helpers/apiLogin';
 
 let page: Page;
 let registrationPage: RegistrationPage;
 const timeout = 60 * 1000; // Render.com free tier may take 60 seconds to startup
+let token: string;
 
 const username = faker.internet.userName().toLowerCase();
 const email = faker.internet.email();
@@ -19,7 +22,7 @@ test.beforeAll(async ({ browser }) => {
   await registrationPage.goto();
 });
 
-test.describe('User Registration', async () => {
+test.describe('User Registration', { tag: ['@PRODUCTION'] }, async () => {
   test('Should be able to register new user', async () => {
     await expect(registrationPage.accountHeader()).toBeVisible();
 
@@ -30,7 +33,24 @@ test.describe('User Registration', async () => {
     });
 
     await expect(registrationPage.successMessage()).toBeVisible({ timeout });
+
+    await test.step('Should be able to login with newly registered user', async () => {
+      const loginResponse: APIResponse = await apiLogin({ username, password });
+
+      expect(loginResponse.ok()).toBeTruthy();
+
+      const json = await loginResponse.json();
+      token = json.token;
+
+      expect(json.token).toBeTruthy();
+    });
+
+    await test.step('Cleanup: Delete User', async () => {
+      const deleteUserResponse = await deleteUser(token);
+      expect(deleteUserResponse.ok()).toBeTruthy();
+    });
   });
+
   test('Should not be able to register with existing username', async () => {
     await registrationPage.goto();
 

playwright/tsconfig.json

@@ -12,7 +12,7 @@
       "strict": true,
       "skipLibCheck": true
     },
-    "include": ["src", "tests", "pages", "./.eslintrc.js", "./playwright.config.ts"],
+    "include": ["src", "tests", "pages", "helpers", "./.eslintrc.js", "./playwright.config.ts", "cleanup/Cleanup.ts"],
     "exclude": ["node_modules", "dist"],
     "overrides": [
       {