chore: Allow for soft deleting the person

apps/api/src/account/account.module.ts

@@ -1,13 +1,14 @@
 import { Module } from '@nestjs/common'
 import { PersonService } from '../person/person.service'
 import { PrismaService } from '../prisma/prisma.service'
 import { AccountController } from './account.controller'
 import { AccountService } from './account.service'
 import { AuthModule } from '../auth/auth.module'
+import { PersonModule } from '../person/person.module'
 
 @Module({
-  imports:[AuthModule],
+  imports: [AuthModule, PersonModule],
   controllers: [AccountController],
-  providers: [AccountService, PersonService, PrismaService],
+  providers: [AccountService, PrismaService],
 })
 export class AccountModule {}

apps/api/src/auth/auth.service.spec.ts

@@ -1,4 +1,4 @@
-import { Beneficiary, Person } from '@prisma/client'
+import { Beneficiary, Person, Prisma } from '@prisma/client'
 import { mockDeep } from 'jest-mock-extended'
 import { ConfigService } from '@nestjs/config'
 import { HttpService } from '@nestjs/axios'
@@ -448,7 +448,7 @@
         // Don't subscribe to marketing list
         newsletter: false,
       })
-      
+
       jest.spyOn(prismaMock.person, 'upsert').mockResolvedValue(person)
       jest.spyOn(admin.users, 'create').mockResolvedValue({ id: keycloakId })
       const marketingSpy = jest
@@ -463,7 +463,7 @@
   })
 
   describe('deleteUser', () => {
-    const corporatePerson: any = {
+    const corporatePerson: Awaited<ReturnType<PersonService['findOneByKeycloakId']>> = {
       id: 'e43348aa-be33-4c12-80bf-2adfbf8736cd',
       firstName: 'Admin',
       lastName: 'Dev',
@@ -483,6 +483,10 @@
       profileEnabled: false,
       beneficiaries: [],
       organizer: null,
+      deletedAt: null,
+      helpUsImprove: true,
+      company: null,
+      recurringDonations: [],
     }
 
     it('should delete user successfully', async () => {
@@ -493,19 +497,21 @@
         .mockResolvedValue(corporatePerson)
 
       const authenticateAdminSpy = jest
         .spyOn(service as any, 'authenticateAdmin')
         .mockResolvedValueOnce('')
 
       const adminDeleteSpy = jest.spyOn(admin.users, 'del').mockResolvedValueOnce()
-      const prismaDeleteSpy = jest.spyOn(prismaMock.person, 'delete').mockResolvedValueOnce(person)
+      const prismaDeleteSpy = jest
+        .spyOn(personService, 'softDelete')
+        .mockResolvedValueOnce(corporatePerson)
       const loggerLogSpy = jest.spyOn(Logger, 'log')
 
       await expect(service.deleteUser(keycloakId)).resolves.not.toThrow()
 
       expect(personSpy).toHaveBeenCalledOnce()
       expect(authenticateAdminSpy).toHaveBeenCalledTimes(1)
       expect(adminDeleteSpy).toHaveBeenCalledWith({ id: keycloakId })
-      expect(prismaDeleteSpy).toHaveBeenCalledWith({ where: { keycloakId } })
+      expect(prismaDeleteSpy).toHaveBeenCalledWith(corporatePerson.id)
       expect(loggerLogSpy).toHaveBeenCalledWith(
         `User with keycloak id ${keycloakId} was successfully deleted!`,
       )
@@ -519,7 +525,7 @@
         .mockResolvedValue(corporatePerson)
 
       const authenticateAdminSpy = jest
         .spyOn(service as any, 'authenticateAdmin')
         .mockResolvedValueOnce('')
 
       const adminDeleteSpy = jest
@@ -545,13 +551,13 @@
         .mockResolvedValue(corporatePerson)
 
       const authenticateAdminSpy = jest
         .spyOn(service as any, 'authenticateAdmin')
         .mockResolvedValueOnce('')
 
       const adminDeleteSpy = jest.spyOn(admin.users, 'del').mockResolvedValueOnce()
 
       const prismaDeleteSpy = jest
-        .spyOn(prismaMock.person, 'delete')
+        .spyOn(personService, 'softDelete')
         .mockRejectedValueOnce(new Error('Prisma Rejection!'))
 
       const loggerLogSpy = jest.spyOn(Logger, 'error')
@@ -561,7 +567,7 @@
       expect(personSpy).toHaveBeenCalledOnce()
       expect(authenticateAdminSpy).toHaveBeenCalledTimes(1)
       expect(adminDeleteSpy).toHaveBeenCalledWith({ id: keycloakId })
-      expect(prismaDeleteSpy).toHaveBeenCalledWith({ where: { keycloakId } })
+      expect(prismaDeleteSpy).toHaveBeenCalledWith(corporatePerson.id)
       expect(loggerLogSpy).toHaveBeenCalledWith(
         `Deleting user fails with reason: Prisma Rejection!`,
       )

apps/api/src/auth/auth.service.ts

@@ -494,16 +494,23 @@ export class AuthService {
   async deleteUser(keycloakId: string) {
     const user = await this.personService.findOneByKeycloakId(keycloakId)
 
+    if (!user) throw new NotFoundException('User not found')
     //Check and throw if user is a beneficiary, organizer or corporate profile
     if ((!!user && user.beneficiaries.length > 0) || user?.organizer || user?.companyId) {
       throw new InternalServerErrorException(
         'Cannot delete a beneficiary, organizer or corporate profile',
       )
     }
 
+    if (user.recurringDonations?.length) {
+      throw new ForbiddenException(
+        `Account cannot be deleted due to active recurring payments. Please cancel all recurring payments before deleting this account`,
+      )
+    }
+
     return this.authenticateAdmin()
       .then(() => this.admin.users.del({ id: keycloakId }))
-      .then(() => this.prismaService.person.delete({ where: { keycloakId } }))
+      .then(() => this.personService.softDelete(user.id))
       .then(() => Logger.log(`User with keycloak id ${keycloakId} was successfully deleted!`))
       .catch((err) => {
         const errorMessage = `Deleting user fails with reason: ${err.message ?? 'server error!'}`

apps/api/src/domain/generated/person/dto/create-person.dto.ts

@@ -3,6 +3,7 @@ export class CreatePersonDto {
   lastName: string
   email?: string
   phone?: string
+  deletedAt?: Date
   newsletter?: boolean
   helpUsImprove?: boolean
   address?: string

apps/api/src/domain/generated/person/dto/update-person.dto.ts

@@ -3,6 +3,7 @@ export class UpdatePersonDto {
   lastName?: string
   email?: string
   phone?: string
+  deletedAt?: Date
   newsletter?: boolean
   helpUsImprove?: boolean
   address?: string

apps/api/src/domain/generated/person/entities/person.entity.ts

@@ -28,6 +28,7 @@ export class Person {
   phone: string | null
   createdAt: Date
   updatedAt: Date | null
+  deletedAt: Date | null
   newsletter: boolean | null
   helpUsImprove: boolean | null
   address: string | null

apps/api/src/person/__mock__/personMock.ts

@@ -19,4 +19,5 @@ export const personMock: Person = {
   stripeCustomerId: null,
   profileEnabled: true,
   helpUsImprove: false,
+  deletedAt: null,
 }

apps/api/src/person/person.service.ts

@@ -125,6 +125,7 @@ export class PersonService {
         company: true,
         beneficiaries: { select: { id: true } },
         organizer: { select: { id: true } },
+        recurringDonations: { select: { id: true } },
       },
     })
   }
@@ -137,6 +138,23 @@ export class PersonService {
     return await this.prisma.person.delete({ where: { id } })
   }
 
+  async softDelete(id: string) {
+    return await this.prisma.person.update({
+      where: { id },
+      data: {
+        firstName: '',
+        lastName: '',
+        address: '',
+        email: '',
+        birthday: null,
+        personalNumber: '',
+        phone: '',
+        helpUsImprove: false,
+        profileEnabled: false,
+        deletedAt: new Date(),
+      },
+    })
+  }
   private async addToContactList(createPersonDto: CreatePersonDto) {
     const data = {
       contacts: [

db/seed/person/factory.ts

@@ -22,4 +22,5 @@ export const personFactory = Factory.define<Person>(() => ({
   updatedAt: faker.date.recent(),
   profileEnabled: true,
   helpUsImprove: false,
+  deletedAt: null,
 }))

migrations/20240902223329_add_deleted_at_field_to_person/migration.sql

@@ -0,0 +1,2 @@
+-- AlterTable
+ALTER TABLE "people" ADD COLUMN     "deleted_at" TIMESTAMPTZ(6);

podkrepi.dbml

@@ -15,6 +15,7 @@ Table people {
   phone String
   createdAt DateTime [default: `now()`, not null]
   updatedAt DateTime
+  deletedAt DateTime
   newsletter Boolean [default: false]
   helpUsImprove Boolean [default: false]
   address String
@@ -988,4 +989,6 @@ Ref: expense_files.uploaderId > people.id
 
 Ref: documents.ownerId > people.id
 
-Ref: campaign_applications.organizerId > organizers.id
+Ref: campaign_applications.organizerId > organizers.id
+
+Ref: campaign_application_files.campaignApplicationId > campaign_applications.id

schema.prisma

@@ -38,6 +38,7 @@ model Person {
   phone              String?             @db.VarChar(50)
   createdAt          DateTime            @default(now()) @map("created_at") @db.Timestamptz(6)
   updatedAt          DateTime?           @updatedAt @map("updated_at") @db.Timestamptz(6)
+  deletedAt          DateTime?           @map("deleted_at") @db.Timestamptz(6)
   // Receive marketing notifications
   newsletter         Boolean?            @default(false)
   helpUsImprove      Boolean?            @default(false) @map("help_us_improve")