Merge pull request #107 from 4lessandrodev/feat/delete-budget-box

test(application): added tests to delete budget box use case

Author: 4lessandrodev

src/modules/budget-box/application/use-cases/delete-budget-box/delete-budget-box.dto.ts

@@ -0,0 +1,6 @@
+export interface DeleteBudgetBoxDto {
+	userId: string;
+	budgetBoxId: string;
+}
+
+export default DeleteBudgetBoxDto;

src/modules/budget-box/application/use-cases/delete-budget-box/delete-budget-box.use-case.spec.ts

@@ -0,0 +1,98 @@
+
+import { IBudgetBoxRepository } from '@modules/budget-box/domain/interfaces/budget-box.repository.interface';
+import budgetBoxMockRepo from '@modules/budget-box/application/mocks/budget-box-repo.mock';
+import DeleteBudgetBoxUseCase from './delete-budget-box.use-case';
+import { BudgetBoxMock } from '@modules/budget-box/domain/tests/mock/budget-box.mock';
+import { CURRENCY } from '@config/env';
+
+describe('delete-budget-box.use-case', () => {
+
+	let repo: IBudgetBoxRepository;
+	const budgetBoxMock = new BudgetBoxMock();
+
+	beforeEach(() => {
+		repo = budgetBoxMockRepo;
+		jest.spyOn(repo, 'findOne').mockClear();
+	});
+
+	it('should execute delete-budget-box use case with success', async () => {
+
+		const aggregate = budgetBoxMock.domain({
+			balanceAvailable: {
+				currency: CURRENCY,
+				value: 0
+			}
+		}).getResult();
+
+		jest.spyOn(repo, 'findOne').mockResolvedValueOnce(aggregate);
+
+		const useCase = new DeleteBudgetBoxUseCase(repo);
+		const useCaseSpy = jest.spyOn(useCase, 'execute');
+
+		const dto = { userId: 'valid_id', budgetBoxId: 'valid_id' };
+
+		const result = await useCase.execute(dto);
+		
+		expect(aggregate.domainEvents).toHaveLength(1);
+
+		expect(result.isSuccess).toBeTruthy();
+		expect(useCaseSpy).toHaveBeenCalledWith(dto);
+	});
+
+	it('should fails if budget box does not exists', async () => {
+
+		jest.spyOn(repo, 'findOne').mockResolvedValueOnce(null);
+
+		const useCase = new DeleteBudgetBoxUseCase(repo);
+		const saveSpy = jest.spyOn(repo, 'save');
+
+		const dto = { userId: 'valid_id', budgetBoxId: 'valid_id' };
+
+		const result = await useCase.execute(dto);
+
+		expect(result.isFailure).toBeTruthy();
+		expect(result.error).toBe('Budget Box Does Not Exists');
+		expect(saveSpy).not.toHaveBeenCalled();
+	});
+
+	it('should fails if budget box has balance', async () => {
+
+		const aggregate = budgetBoxMock.domain({
+			balanceAvailable: {
+				currency: CURRENCY,
+				value: 1
+			}
+		}).getResult();
+
+		jest.spyOn(repo, 'findOne').mockResolvedValueOnce(aggregate);
+
+		const useCase = new DeleteBudgetBoxUseCase(repo);
+		const saveSpy = jest.spyOn(repo, 'save');
+
+		const dto = { userId: 'valid_id', budgetBoxId: 'valid_id' };
+
+		const result = await useCase.execute(dto);
+
+		expect(result.isFailure).toBeTruthy();
+		expect(result.error).toBe('The budget box must have a zero balance');
+		expect(saveSpy).not.toHaveBeenCalledWith(dto);
+	});
+
+	it('should fails if repository throws', async () => {
+
+		jest.spyOn(repo, 'findOne').mockImplementationOnce(async () => {
+			throw new Error("error");
+		});
+
+		const useCase = new DeleteBudgetBoxUseCase(repo);
+		const saveSpy = jest.spyOn(repo, 'save');
+
+		const dto = { userId: 'valid_id', budgetBoxId: 'valid_id' };
+
+		const result = await useCase.execute(dto);
+
+		expect(result.isFailure).toBeTruthy();
+		expect(result.error).toBe('Internal Server Error on Delete Budget BoxUse Case');
+		expect(saveSpy).not.toHaveBeenCalled();
+	});
+});

src/modules/budget-box/application/use-cases/delete-budget-box/delete-budget-box.use-case.ts

@@ -0,0 +1,41 @@
+import { IBudgetBoxRepository } from '@modules/budget-box/domain/interfaces/budget-box.repository.interface';
+import { Inject } from '@nestjs/common';
+import { IUseCase, Result } from 'types-ddd';
+import DeleteBudgetBoxDto from './delete-budget-box.dto';
+
+export class DeleteBudgetBoxUseCase implements IUseCase<DeleteBudgetBoxDto, Result<void, string>>{
+	constructor (
+		@Inject('BudgetBoxRepository')
+		private readonly budgetBoxRepo: IBudgetBoxRepository
+	) { }
+	
+	async execute ({ budgetBoxId: id, userId: ownerId }: DeleteBudgetBoxDto): Promise<Result<void, string>> {
+		try {
+
+			const budgetBoxOrNull = await this.budgetBoxRepo.findOne({ id, ownerId });
+
+			if (!budgetBoxOrNull) {
+				return Result.fail('Budget Box Does Not Exists', 'NOT_FOUND');
+			}
+
+			const budgetBox = budgetBoxOrNull;
+
+			const hasNotBalance = budgetBox.balanceAvailable.isEqualTo(0);
+
+			if (!hasNotBalance) {
+				return Result.fail('The budget box must have a zero balance', 'CONFLICT');
+			}
+
+			budgetBox.delete();
+
+			await this.budgetBoxRepo.delete({ id });
+
+			return Result.success();
+
+		} catch (error) {
+			return Result.fail('Internal Server Error on Delete Budget BoxUse Case', 'INTERNAL_SERVER_ERROR');
+		}
+	}
+}
+
+export default DeleteBudgetBoxUseCase;

src/modules/budget-box/domain/budget-box.aggregate.ts

@@ -7,7 +7,7 @@ import {
 	PercentageValueObject
 } from './percentage.value-object';
 import ReasonDescriptionValueObject from './reason-description.value-object';
-
+import BudgetBoxDeletedEvent from './events/budget-box-deleted.event';
 
 export interface BudgetAggregateProps extends BaseDomainEntity {
 	ownerId: DomainId;
@@ -115,6 +115,12 @@ export class BudgetBoxAggregate extends AggregateRoot<BudgetAggregateProps> {
 		return exists;
 	}
 
+	delete (): void {
+		this.props.deletedAt = new Date();
+		this.props.isDeleted = true;
+		this.addDomainEvent(new BudgetBoxDeletedEvent(this));
+	}
+
 	public static create (
 		props: BudgetAggregateProps
 	): Result<BudgetBoxAggregate> {

src/modules/budget-box/domain/events/budget-box-deleted.event.ts

@@ -0,0 +1,19 @@
+import { IDomainEvent, UniqueEntityID } from "types-ddd";
+import BudgetBoxAggregate from "../budget-box.aggregate";
+
+export class BudgetBoxDeletedEvent implements IDomainEvent {
+	public dateTimeOccurred: Date;
+	public budgetBox: BudgetBoxAggregate;
+	
+	constructor (budgetBox: BudgetBoxAggregate) {
+		this.budgetBox = budgetBox;
+		this.dateTimeOccurred = new Date();
+	}
+
+	getAggregateId (): UniqueEntityID {
+		return this.budgetBox.id.value;
+	}
+
+}
+
+export default BudgetBoxDeletedEvent;

src/modules/budget-box/domain/subscription/after-budget-box-deleted.subscription.ts

@@ -0,0 +1,22 @@
+import { DomainEvents, IHandle, Logger } from "types-ddd";
+import BudgetBoxDeletedEvent from "../events/budget-box-deleted.event";
+
+export class AfterBudgetBoxDeleted implements IHandle<BudgetBoxDeletedEvent>{
+	constructor () {
+		this.setupSubscriptions();	
+	}
+
+	setupSubscriptions (): void {
+		DomainEvents.register(
+			(event) => this.dispatch(Object.assign(event)),
+			BudgetBoxDeletedEvent.name
+		);
+	}
+
+	async dispatch (event: BudgetBoxDeletedEvent): Promise<void> {
+		Logger.info(`budget box deleted: ${event.budgetBox.id.uid}`);
+	}
+
+}
+
+export default AfterBudgetBoxDeleted;

src/modules/budget-box/infra/budget-box.module.ts

@@ -19,6 +19,8 @@ import ChangeBudgetBoxPercentageUseCase from "@modules/budget-box/application/us
 import ChangeBudgetBoxNameUseCase from "@modules/budget-box/application/use-cases/change-budget-box-name/change-budget-box-name.use-case";
 import CanAllocatePercentageToBudgetBoxDomainService from "@modules/budget-box/domain/services/can-allocate-percentage-to-budget-box.domain-service";
 import CanChangeBudgetBoxPercentageDomainService from "@modules/budget-box/domain/services/can-change-budget-box-percentage.domain-service";
+import AfterBudgetBoxDeleted from "@modules/budget-box/domain/subscription/after-budget-box-deleted.subscription";
+import DeleteBudgetBoxUseCase from "@modules/budget-box/application/use-cases/delete-budget-box/delete-budget-box.use-case";
 
 @Module({
 	imports: [
@@ -51,7 +53,9 @@ import CanChangeBudgetBoxPercentageDomainService from "@modules/budget-box/domai
 			useClass: BudgetBoxQueryService
 		},
 		CanAllocatePercentageToBudgetBoxDomainService,
-		CanChangeBudgetBoxPercentageDomainService
+		CanChangeBudgetBoxPercentageDomainService,
+		DeleteBudgetBoxUseCase,
+		AfterBudgetBoxDeleted
 	],
 	exports: []
 })

src/modules/budget-box/infra/budget-box.service.ts

@@ -19,6 +19,8 @@ import ChangeBudgetBoxNameUseCase from "@modules/budget-box/application/use-case
 import ChangeBudgetBoxNameDto from "@modules/budget-box/application/use-cases/change-budget-box-name/change-budget-box-name.dto";
 import CanAllocatePercentageToBudgetBoxDomainService from "@modules/budget-box/domain/services/can-allocate-percentage-to-budget-box.domain-service";
 import CanChangeBudgetBoxPercentageDomainService from "@modules/budget-box/domain/services/can-change-budget-box-percentage.domain-service";
+import DeleteBudgetBoxUseCase from "../application/use-cases/delete-budget-box/delete-budget-box.use-case";
+import DeleteBudgetBoxDto from "../application/use-cases/delete-budget-box/delete-budget-box.dto";
 
 @Injectable()
 export class BudgetBoxService {
@@ -51,7 +53,10 @@ export class BudgetBoxService {
 		private readonly canChangeBudgetBoxPercentageDomainService: CanChangeBudgetBoxPercentageDomainService,
 
 		@Inject(ChangeBudgetBoxNameUseCase)
-		private readonly changeBudgetBoxNameUseCase: ChangeBudgetBoxNameUseCase
+		private readonly changeBudgetBoxNameUseCase: ChangeBudgetBoxNameUseCase,
+
+		@Inject(DeleteBudgetBoxUseCase)
+		private readonly deleteBudgetBoxUseCase: DeleteBudgetBoxUseCase
 	) { }
 	async createBudgetBox (dto: CreateBudgetBoxDto): Promise<void>{
 
@@ -102,6 +107,11 @@ export class BudgetBoxService {
 		const result = await this.changeBudgetBoxNameUseCase.execute(dto);
 		CheckResultInterceptor(result);
 	}
+
+	async deleteBudgetBox (dto: DeleteBudgetBoxDto): Promise<void> {
+		const result = await this.deleteBudgetBoxUseCase.execute(dto);
+		CheckResultInterceptor(result);
+	}
 }
 
 export default BudgetBoxService;

src/modules/budget-box/infra/entities/budget-box.schema.ts

@@ -1,6 +1,7 @@
 import { IBudgetBox, ICurrency, IReason } from "@shared/index";
 import { Prop, Schema, SchemaFactory } from "@nestjs/mongoose";
 import { Document } from "mongoose";
+import { DomainEvents, DomainId } from "types-ddd";
 
 export type BudgetBoxDocument = BudgetBox & Document;
 
@@ -36,3 +37,9 @@ export class BudgetBox implements IBudgetBox {
 }
 
 export const BudgetBoxSchema = SchemaFactory.createForClass(BudgetBox);
+
+// calls domain events
+BudgetBoxSchema.post('remove', function (doc: IBudgetBox) {
+	const id = DomainId.create(doc.id);
+	DomainEvents.dispatchEventsForAggregate(id.value);
+});

src/modules/budget-box/infra/inputs/delete-budget-box.input.ts

@@ -0,0 +1,9 @@
+import { Field, InputType } from "@nestjs/graphql";
+
+@InputType()
+export class DeleteBudgetBoxInput {
+	@Field(() => String)
+	budgetBoxId!: string;
+}
+
+export default DeleteBudgetBoxInput;