feat(api): support deleting organization

Author: Johan Book

services/api/src/core/organizations/application/contracts/commands/delete-current-organization.command.ts

@@ -0,0 +1 @@
+export class DeleteCurrentOrganizationCommand {}

services/api/src/core/organizations/application/handlers/command-handlers/delete-current-organization.handler.spec.ts

@@ -0,0 +1,26 @@
+import { TestSuite } from "src/test";
+
+import { DeleteCurrentOrganizationHandler } from "./delete-current-organization.handler";
+
+describe(DeleteCurrentOrganizationHandler.name, () => {
+  let commandHandler: DeleteCurrentOrganizationHandler;
+
+  let testSuite: TestSuite;
+
+  beforeEach(() => {
+    testSuite = new TestSuite();
+
+    commandHandler = new DeleteCurrentOrganizationHandler(
+      testSuite.currentOrganizationService,
+      testSuite.organizationService,
+    );
+  });
+
+  describe("can update organizations", () => {
+    it("should save changes to organization", async () => {
+      await commandHandler.execute();
+
+      expect(testSuite.organizations.delete).toHaveBeenCalled();
+    });
+  });
+});

services/api/src/core/organizations/application/handlers/command-handlers/delete-current-organization.handler.ts

@@ -0,0 +1,28 @@
+import { ForbiddenException } from "@nestjs/common";
+import { CommandHandler, ICommandHandler } from "@nestjs/cqrs";
+
+import { CurrentOrganizationService } from "src/core/organizations/domain/services/current-organization.service";
+import { OrganizationService } from "src/core/organizations/domain/services/organization.service";
+
+import { DeleteCurrentOrganizationCommand } from "../../contracts/commands/delete-current-organization.command";
+
+@CommandHandler(DeleteCurrentOrganizationCommand)
+export class DeleteCurrentOrganizationHandler
+  implements ICommandHandler<DeleteCurrentOrganizationCommand, void>
+{
+  constructor(
+    private readonly currentOrganizationService: CurrentOrganizationService,
+    private readonly organizationService: OrganizationService,
+  ) {}
+
+  async execute() {
+    const currentOrganization =
+      await this.currentOrganizationService.fetchCurrentOrganization();
+
+    if (currentOrganization.personal) {
+      throw new ForbiddenException("Cannot delete personal organization");
+    }
+
+    await this.organizationService.deleteOrganization(currentOrganization.id);
+  }
+}

services/api/src/core/organizations/application/handlers/command-handlers/switch-organization.handler.ts

@@ -1,4 +1,4 @@
-import { UnauthorizedException } from "@nestjs/common";
+import { ForbiddenException } from "@nestjs/common";
 import { CommandHandler, ICommandHandler } from "@nestjs/cqrs";
 
 import { CurrentOrganizationService } from "src/core/organizations/domain/services/current-organization.service";
@@ -27,7 +27,7 @@ export class SwitchOrganizationHandler
     );
 
     if (!hasAccess) {
-      throw new UnauthorizedException();
+      throw new ForbiddenException();
     }
 
     await this.currentOrganizationService.switchCurrentOrganization(

services/api/src/core/organizations/application/handlers/command-handlers/update-organization.handler.ts

@@ -20,6 +20,6 @@ export class UpdateOrganizationHandler
 
     currentOrganization.name = command.name;
 
-    this.organizationService.updateOrganization(currentOrganization);
+    await this.organizationService.updateOrganization(currentOrganization);
   }
 }

services/api/src/core/organizations/client/controllers/current-organization.controller.ts

@@ -15,6 +15,7 @@ import { RequiresOrganizationPermissions } from "src/core/authorization";
 
 import { AddMemberToOrganizationViaEmailCommand } from "../../application/contracts/commands/add-member-to-organization-via-email.command";
 import { AddMemberToOrganizationCommand } from "../../application/contracts/commands/add-member-to-organization.command";
+import { DeleteCurrentOrganizationCommand } from "../../application/contracts/commands/delete-current-organization.command";
 import { LeaveCurrentOrganizationCommand } from "../../application/contracts/commands/leave-current-organization.command";
 import { RemoveMemberFromCurrentOrganizationCommand } from "../../application/contracts/commands/remove-member-from-current-organization.command";
 import { UpdateMemberRoleCommand } from "../../application/contracts/commands/update-member-role.command";
@@ -40,6 +41,16 @@ export class CurrentOrganizationController {
     return await this.queryBus.execute(query);
   }
 
+  @Delete()
+  @RequiresOrganizationPermissions(
+    organizationPermissions.CurrentOrganization.Delete,
+  )
+  async deleteCurrentOrganization(
+    @Query() command: DeleteCurrentOrganizationCommand,
+  ): Promise<null> {
+    return await this.commandBus.execute(command);
+  }
+
   @Delete("/leave")
   async leaveCurrentOrganization(
     @Query() command: LeaveCurrentOrganizationCommand,

services/api/src/core/organizations/domain/events/organization-deleted.event.ts

@@ -0,0 +1,3 @@
+export class OrganizationDeletedEvent {
+  public readonly id!: number;
+}

services/api/src/core/organizations/domain/services/organization.service.ts

@@ -10,6 +10,7 @@ import { OrganizationMembership } from "../../infrastructure/entities/organizati
 import { Organization } from "../../infrastructure/entities/organization.entity";
 import { MemberAddedToOrganizationEvent } from "../events/member-added-to-organization.event";
 import { OrganizationCreatedEvent } from "../events/organization-created.event";
+import { OrganizationDeletedEvent } from "../events/organization-deleted.event";
 import { MembershipService } from "./membership.service";
 
 interface CreateOrganizationProps {
@@ -91,6 +92,20 @@ export class OrganizationService {
     return createdOrganization.id;
   }
 
+  async deleteOrganization(organizationId: number): Promise<void> {
+    const { affected } = await this.organizations.delete(organizationId);
+
+    if (affected === 0) {
+      return;
+    }
+
+    const event = map(OrganizationDeletedEvent, {
+      id: organizationId,
+    });
+
+    this.eventBus.publish(event);
+  }
+
   async checkIfPersonalOrganizationExists(profileId: number): Promise<boolean> {
     return await this.organizations.exist({
       where: {

services/api/src/core/organizations/organization.permissions.ts

@@ -2,6 +2,7 @@ import { OrganizationRole } from "src/core/authorization";
 
 export const organizationPermissions = {
   CurrentOrganization: {
+    Delete: [OrganizationRole.Admin],
     Read: [OrganizationRole.Admin, OrganizationRole.Member],
     Members: {
       Add: [OrganizationRole.Admin],

services/api/src/test/mocks/repository.mock.ts

@@ -15,6 +15,8 @@ class MockRepository<T extends ObjectLiteral> {
     }
 
     this.data.splice(index, 1);
+
+    return { affected: 1 };
   });
 
   exist = jest.fn((element: T) =>

services/api/src/test/test-suite.ts

@@ -35,13 +35,18 @@ export class TestSuite {
   constructor() {
     this.eventBus = createEventBusMock();
 
-    this.activeOrganizations = createMockRepository<ActiveOrganization>();
+    this.activeOrganizations = createMockRepository<ActiveOrganization>([
+      {
+        organizationId: "my-organization-id",
+        profileId: "my-profile-id",
+      } as unknown as ActiveOrganization,
+    ]);
     this.memberships = createMockRepository<OrganizationMembership>();
     this.organizations = createMockRepository<Organization>([
-      { id: "my-organization-id" } as any,
+      { id: "my-organization-id" } as unknown as Organization,
     ]);
     this.profiles = createMockRepository<Profile>([
-      { id: "my-profile-id" } as any,
+      { id: "my-profile-id" } as unknown as Profile,
     ]);
 
     const userIdService = createUserIdServiceMock();