test: Added unit test for list use-cases

Author: OscarS05

api/src/application/use-cases/list/CheckProjectMembershipByListUseCase.js

@@ -6,11 +6,14 @@ class CheckProjectMembershipByListUseCase {
   }
 
   async execute(userId, listId) {
+    if (!userId) throw new Error('userId was not provided');
+    if (!listId) throw new Error('listId was not provided');
+
     const list = await this.listRepository.checkProjectMembershipByList(
       userId,
       listId,
     );
-    return new ListDto(list);
+    return list?.id ? new ListDto(list) : {};
   }
 }
 

api/src/application/use-cases/list/CreateListUseCase.js

@@ -7,9 +7,16 @@ class CreateListUseCase {
   }
 
   async execute(listData) {
+    if (!listData?.projectId) {
+      throw new Error('projectId was not provided');
+    }
+
     const listEntity = new ListEntity(listData);
 
     const createdList = await this.listRepository.create(listEntity);
+    if (!createdList?.id) {
+      throw new Error('Something went wrong creating the list');
+    }
 
     return new ListDto(createdList);
   }

api/src/application/use-cases/list/DeleteListUseCase.js

@@ -4,7 +4,18 @@ class DeleteListUseCase {
   }
 
   async execute(projectId, listId) {
-    return this.listRepository.delete(projectId, listId);
+    if (!projectId) throw new Error('projectId was not provided');
+    if (!listId) throw new Error('listId was not provided');
+
+    const result = await this.listRepository.delete(projectId, listId);
+
+    if (result === 0) {
+      throw new Error(
+        'Something went wrong deleting the list. Maybe the list does not exist',
+      );
+    }
+
+    return result;
   }
 }
 

api/src/application/use-cases/list/GetAllListsUseCase.js

@@ -6,8 +6,10 @@ class GetAllListsUseCase {
   }
 
   async execute(projectId) {
+    if (!projectId) throw new Error('projectId was not provided');
+
     const lists = await this.listRepository.findAll(projectId);
-    return lists.map((list) => new ListDto(list));
+    return lists?.length > 0 ? lists.map((list) => new ListDto(list)) : [];
   }
 }
 

api/src/application/use-cases/list/GetListUseCase.js

@@ -6,9 +6,12 @@ class GetListUseCase {
   }
 
   async execute(projectId, listId) {
+    if (!projectId) throw new Error('projectId was not provided');
+    if (!listId) throw new Error('listId was not provided');
+
     const list = await this.listRepository.findOneById(projectId, listId);
-    if (!list?.id) return {};
-    return new ListDto(list);
+
+    return list?.id ? new ListDto(list) : {};
   }
 }
 

api/src/application/use-cases/list/GetProjectByListUseCase.js

@@ -4,8 +4,11 @@ class GetProjectByListUseCase {
   }
 
   async execute(listId) {
+    if (!listId) throw new Error('listId was not provided');
+
     const listIWithItsProject =
       await this.listRepository.getProjectByList(listId);
+
     return listIWithItsProject?.id ? listIWithItsProject : {};
   }
 }

api/src/application/use-cases/list/UpdateListUseCase.js

@@ -7,11 +7,22 @@ class UpdateListUseCase {
   }
 
   async execute(listId, newName) {
+    if (!listId) throw new Error('listId was not provided');
+
     const listUpdateEntity = new ListName(newName).value;
 
-    const [[updatedList]] = await this.listRepository.update(listId, {
-      name: listUpdateEntity,
-    });
+    const [affectedRows, [updatedList]] = await this.listRepository.update(
+      listId,
+      {
+        name: listUpdateEntity,
+      },
+    );
+
+    if (affectedRows === 0) {
+      throw new Error(
+        'Something went wrong updating the list. Maybe the list does not exist',
+      );
+    }
 
     return new ListDto(updatedList);
   }

api/src/domain/value-objects/listName.js

@@ -8,7 +8,6 @@ class ListName {
     this.#value = value;
   }
 
-  // eslint-disable-next-line class-methods-use-this
   validate(value) {
     if (typeof value !== 'string' || value.trim() === '') {
       throw boom.badData('ListName must be a non-empty string.');

tests/unit/list/CheckProjectMembershipByListUseCase.test.js

@@ -0,0 +1,73 @@
+const CheckProjectMembershipByListUseCase = require('../../../api/src/application/use-cases/list/CheckProjectMembershipByListUseCase');
+const ListDto = require('../../../api/src/application/dtos/list.dto');
+const { createList, createUser } = require('../../fake-data/fake-entities');
+
+describe('CheckProjectMembershipByListUseCase', () => {
+  let userId;
+  let listId;
+  let dbResponse;
+  let mockListRepository;
+  let checkProjectMembershipByListUseCase;
+
+  beforeEach(() => {
+    userId = createUser().id;
+    listId = createList().id;
+    dbResponse = createList();
+
+    mockListRepository = {
+      checkProjectMembershipByList: jest.fn().mockResolvedValue(dbResponse),
+    };
+
+    checkProjectMembershipByListUseCase =
+      new CheckProjectMembershipByListUseCase({
+        listRepository: mockListRepository,
+      });
+  });
+
+  test('It should return a list with its project', async () => {
+    const result = await checkProjectMembershipByListUseCase.execute(
+      userId,
+      listId,
+    );
+
+    expect(
+      mockListRepository.checkProjectMembershipByList,
+    ).toHaveBeenCalledTimes(1);
+    expect(result).toMatchObject(new ListDto(dbResponse));
+  });
+
+  test('It should return an error because the userId was not provided', async () => {
+    await expect(
+      checkProjectMembershipByListUseCase.execute(null, listId),
+    ).rejects.toThrow(/was not provided/);
+    expect(
+      mockListRepository.checkProjectMembershipByList,
+    ).not.toHaveBeenCalled();
+  });
+
+  test('It should return an error because the listId was not provided', async () => {
+    await expect(
+      checkProjectMembershipByListUseCase.execute(userId, null),
+    ).rejects.toThrow(/was not provided/);
+    expect(
+      mockListRepository.checkProjectMembershipByList,
+    ).not.toHaveBeenCalled();
+  });
+
+  test('It should return an empty object because the operation db did not find anything', async () => {
+    mockListRepository.checkProjectMembershipByList.mockResolvedValue(0);
+
+    const result = await checkProjectMembershipByListUseCase.execute(
+      userId,
+      listId,
+    );
+    expect(
+      mockListRepository.checkProjectMembershipByList,
+    ).toHaveBeenCalledTimes(1);
+    expect(result).toEqual({});
+  });
+
+  afterEach(() => {
+    jest.clearAllMocks();
+  });
+});

tests/unit/list/CreateListUseCase.test.js

@@ -0,0 +1,79 @@
+jest.mock('uuid', () => ({
+  v4: jest.fn(),
+}));
+
+const { v4: uuidv4 } = require('uuid');
+
+const CreateListUseCase = require('../../../api/src/application/use-cases/list/CreateListUseCase');
+const ListDto = require('../../../api/src/application/dtos/list.dto');
+const { createList } = require('../../fake-data/fake-entities');
+
+describe('CreateListUseCase', () => {
+  let listData;
+  let dbResponse;
+  let mockListRepository;
+  let createListUseCase;
+
+  beforeEach(() => {
+    dbResponse = createList();
+    listData = dbResponse;
+    uuidv4.mockReturnValue(dbResponse.id);
+
+    mockListRepository = {
+      create: jest.fn().mockResolvedValue(dbResponse),
+    };
+
+    createListUseCase = new CreateListUseCase({
+      listRepository: mockListRepository,
+    });
+  });
+
+  test('It should return a successfully created list', async () => {
+    const result = await createListUseCase.execute(listData);
+
+    expect(uuidv4).toHaveBeenCalledTimes(1);
+    expect(mockListRepository.create).toHaveBeenCalledTimes(1);
+    expect(result).toMatchObject(new ListDto(dbResponse));
+  });
+
+  test('It should return an error because projectId was not provided', async () => {
+    listData.projectId = null;
+
+    await expect(createListUseCase.execute(listData)).rejects.toThrow(
+      /was not provided/,
+    );
+    expect(mockListRepository.create).not.toHaveBeenCalled();
+  });
+
+  test('It should return an error because the provided name is not valid', async () => {
+    listData.name = 123;
+
+    await expect(createListUseCase.execute(listData)).rejects.toThrow(
+      /must be a non-empty string/,
+    );
+    expect(mockListRepository.create).not.toHaveBeenCalled();
+  });
+
+  test('It should return an error because the provided name contains invalid characters', async () => {
+    listData.name =
+      'sssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssss';
+
+    await expect(createListUseCase.execute(listData)).rejects.toThrow(
+      /cannot exceed 80 characters/,
+    );
+    expect(mockListRepository.create).not.toHaveBeenCalled();
+  });
+
+  test('It should return an error because the operation db failed', async () => {
+    mockListRepository.create.mockResolvedValue({});
+
+    await expect(createListUseCase.execute(listData)).rejects.toThrow(
+      /Something went wrong/,
+    );
+    expect(mockListRepository.create).toHaveBeenCalledTimes(1);
+  });
+
+  afterEach(() => {
+    jest.clearAllMocks();
+  });
+});