add helpUsImprove field to the backend (#615)

* add helpUsImprove field to the backend

* add migration for the new helpUsImprove field

* reverted previous migration and added new one; modified personMock.ts

* add helpUsImprove in auth.service.ts

* add changes to tests on backend

apps/api/src/affiliate/affiliate.controller.spec.ts

@@ -17,16 +17,18 @@ import {
   Campaign,
   CampaignState,
   PaymentStatus,
-  Payments,
+  Payment,
   Prisma,
   Vault,
+  Person,
 } from '@prisma/client'
 import { KeycloakTokenParsed } from '../auth/keycloak'
 import { BadRequestException, ConflictException, ForbiddenException } from '@nestjs/common'
 import { AffiliateStatusUpdateDto } from './dto/affiliate-status-update.dto'
 import * as afCodeGenerator from './utils/affiliateCodeGenerator'
 import { CreateAffiliateDonationDto } from './dto/create-affiliate-donation.dto'
 import { mockPayment } from '../donations/__mocks__/paymentMock'
+import { personMock } from '../person/__mock__/personMock'
 
 type PersonWithPayload = Prisma.PersonGetPayload<{ include: { company: true } }>
 type AffiliateWithPayload = Prisma.AffiliateGetPayload<{
@@ -80,26 +82,7 @@ describe('AffiliateController', () => {
     newStatus: 'active',
   }
 
-  const mockIndividualProfile: PersonWithPayload = {
-    id: 'e43348aa-be33-4c12-80bf-2adfbf8736cd',
-    firstName: 'John',
-    lastName: 'Doe',
-    companyId: null,
-    keycloakId: '123',
-    email: 'test@podkrepi.bg',
-    emailConfirmed: false,
-    phone: null,
-    picture: null,
-    createdAt: new Date('2021-10-07T13:38:11.097Z'),
-    updatedAt: new Date('2021-10-07T13:38:11.097Z'),
-    newsletter: false,
-    address: null,
-    birthday: null,
-    personalNumber: null,
-    stripeCustomerId: null,
-    company: null,
-    profileEnabled: true,
-  }
+  const mockIndividualProfile: Person = personMock
 
   const vaultMock: Vault = {
     id: 'vault-id',
@@ -286,7 +269,7 @@ describe('AffiliateController', () => {
         extCustomerId: '',
         extPaymentIntentId: '123456',
         extPaymentMethodId: '1234',
-        billingEmail: 'test@podkrepi.bg',
+        billingEmail: personMock.email,
         currency: 'BGN',
         toEntity: new CreateAffiliateDonationDto().toEntity,
         metadata: {
@@ -314,7 +297,7 @@ describe('AffiliateController', () => {
       )
     })
     it('should cancel', async () => {
-      const cancelledDonationResponse: Payments = {
+      const cancelledDonationResponse: Payment = {
         ...mockGuaranteedPayment,
         status: PaymentStatus.cancelled,
       }
@@ -327,7 +310,7 @@ describe('AffiliateController', () => {
       ).toEqual(cancelledDonationResponse)
     })
     it('should throw error if donation status is succeeded', async () => {
-      const succeededDonationResponse: Payments = {
+      const succeededDonationResponse: Payment = {
         ...mockGuaranteedPayment,
         status: PaymentStatus.succeeded,
       }

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

@@ -24,6 +24,7 @@ import { SendGridNotificationsProvider } from '../notifications/providers/notifi
 import { NotificationsProviderInterface } from '../notifications/providers/notifications.interface.providers'
 import { MarketingNotificationsModule } from '../notifications/notifications.module'
 import { PersonService } from '../person/person.service'
+import { personMock } from '../person/__mock__/personMock'
 
 jest.mock('@keycloak/keycloak-admin-client')
 
@@ -32,28 +33,10 @@ describe('AuthService', () => {
   let config: ConfigService
   let admin: KeycloakAdminClient
   let keycloak: KeycloakConnect.Keycloak
-  let marketing: NotificationsProviderInterface<unknown>
+  let marketing: NotificationsProviderInterface
   let personService: PersonService
 
-  const person: Person = {
-    id: 'e43348aa-be33-4c12-80bf-2adfbf8736cd',
-    firstName: 'Admin',
-    lastName: 'Dev',
-    companyId: null,
-    keycloakId: '123',
-    email: 'test@podkrepi.bg',
-    emailConfirmed: false,
-    phone: null,
-    picture: null,
-    createdAt: new Date('2021-10-07T13:38:11.097Z'),
-    updatedAt: new Date('2021-10-07T13:38:11.097Z'),
-    newsletter: false,
-    address: null,
-    birthday: null,
-    personalNumber: null,
-    stripeCustomerId: null,
-    profileEnabled: false,
-  }
+  const person: Person = personMock
 
   beforeEach(async () => {
     const module: TestingModule = await Test.createTestingModule({
@@ -331,7 +314,8 @@ describe('AuthService', () => {
     //if no company has been created company.id is expected to be undefined
     const companyId = undefined
     const profileEnabled = true
-    const newsletter = true
+    const newsletter = personMock.newsletter
+    const helpUsImprove = personMock.helpUsImprove
 
     it('should call keycloak and prisma', async () => {
       const keycloakId = 'u123'
@@ -381,7 +365,16 @@ describe('AuthService', () => {
 
       // Check db creation
       expect(prismaSpy).toHaveBeenCalledWith({
-        create: { keycloakId, email, firstName, lastName, newsletter, companyId, profileEnabled },
+        create: {
+          keycloakId,
+          email,
+          firstName,
+          lastName,
+          newsletter,
+          companyId,
+          profileEnabled,
+          helpUsImprove,
+        },
         update: { keycloakId },
         where: { email },
       })
@@ -423,25 +416,7 @@ describe('AuthService', () => {
         // Add to marketing list
         newsletter: true,
       })
-      const person: Person = {
-        id: 'e43348aa-be33-4c12-80bf-2adfbf8736cd',
-        firstName,
-        lastName,
-        companyId: null,
-        keycloakId,
-        email,
-        emailConfirmed: false,
-        phone: null,
-        picture: null,
-        createdAt: new Date('2021-10-07T13:38:11.097Z'),
-        updatedAt: new Date('2021-10-07T13:38:11.097Z'),
-        newsletter: true,
-        address: null,
-        birthday: null,
-        personalNumber: null,
-        stripeCustomerId: null,
-        profileEnabled: true,
-      }
+
       jest.spyOn(prismaMock.person, 'upsert').mockResolvedValue(person)
       jest.spyOn(admin.users, 'create').mockResolvedValue({ id: keycloakId })
       const marketingSpy = jest
@@ -473,25 +448,7 @@ describe('AuthService', () => {
         // Don't subscribe to marketing list
         newsletter: false,
       })
-      const person: Person = {
-        id: 'e43348aa-be33-4c12-80bf-2adfbf8736cd',
-        firstName,
-        lastName,
-        companyId: null,
-        keycloakId,
-        email,
-        emailConfirmed: false,
-        phone: null,
-        picture: null,
-        createdAt: new Date('2021-10-07T13:38:11.097Z'),
-        updatedAt: new Date('2021-10-07T13:38:11.097Z'),
-        newsletter: false,
-        address: null,
-        birthday: null,
-        personalNumber: null,
-        stripeCustomerId: null,
-        profileEnabled: true,
-      }
+
       jest.spyOn(prismaMock.person, 'upsert').mockResolvedValue(person)
       jest.spyOn(admin.users, 'create').mockResolvedValue({ id: keycloakId })
       const marketingSpy = jest

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

@@ -293,6 +293,7 @@ export class AuthService {
         newsletter: registerDto.newsletter ? registerDto.newsletter : false,
         companyId: companyId,
         profileEnabled: companyId ? false : true,
+        helpUsImprove: registerDto.helpUsImprove ? registerDto.helpUsImprove : false,
       },
       // Store keycloakId to the person with same email
       update: { keycloakId },

apps/api/src/auth/dto/register.dto.ts

@@ -52,6 +52,12 @@ export class RegisterDto {
   @IsBoolean()
   public readonly newsletter?: boolean
 
+  @ApiProperty()
+  @Expose()
+  @IsOptional()
+  @IsBoolean()
+  public readonly helpUsImprove?: boolean
+
   @ValidateIf((o) => o.type === ProfileType.CORPORATE)
   @Expose()
   @IsString()

apps/api/src/campaign/campaign.controller.spec.ts

@@ -23,7 +23,7 @@ import { MarketingNotificationsService } from '../notifications/notifications.se
 import { EmailService } from '../email/email.service'
 import { TemplateService } from '../email/template.service'
 import { CampaignNewsService } from '../campaign-news/campaign-news.service'
-import { personMock } from '../person/__mock__/peronMock'
+import { personMock } from '../person/__mock__/personMock'
 
 describe('CampaignController', () => {
   let controller: CampaignController

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

@@ -4,6 +4,7 @@ export class CreatePersonDto {
   email?: string
   phone?: string
   newsletter?: boolean
+  helpUsImprove?: boolean
   address?: string
   birthday?: Date
   emailConfirmed?: boolean

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

@@ -4,6 +4,7 @@ export class UpdatePersonDto {
   email?: string
   phone?: string
   newsletter?: boolean
+  helpUsImprove?: boolean
   address?: string
   birthday?: Date
   emailConfirmed?: boolean

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

@@ -29,6 +29,7 @@ export class Person {
   createdAt: Date
   updatedAt: Date | null
   newsletter: boolean | null
+  helpUsImprove: boolean | null
   address: string | null
   birthday: Date | null
   emailConfirmed: boolean | null

apps/api/src/donations/__mocks__/paymentMock.ts

@@ -1,7 +1,7 @@
 import { Currency, DonationType, PaymentProvider, PaymentStatus } from '@prisma/client'
 import { PaymentWithDonation } from '../types/donation'
 import { DonationWithPerson } from '../types/donation'
-import { personMock } from '../../person/__mock__/peronMock'
+import { personMock } from '../../person/__mock__/personMock'
 
 export const mockDonation: DonationWithPerson = {
   id: '1234',

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

@@ -17,5 +17,6 @@ export const personMock: Person = {
   birthday: null,
   personalNumber: null,
   stripeCustomerId: null,
-  profileEnabled: false,
+  profileEnabled: true,
+  helpUsImprove: false,
 }

migrations/20240318124702_help_us_improve/migration.sql

@@ -0,0 +1,2 @@
+-- AlterTable
+ALTER TABLE "people" ADD COLUMN     "help_us_improve" BOOLEAN DEFAULT false;

podkrepi.dbml

@@ -16,6 +16,7 @@ Table people {
   createdAt DateTime [default: `now()`, not null]
   updatedAt DateTime
   newsletter Boolean [default: false]
+  helpUsImprove Boolean [default: false]
   address String
   birthday DateTime
   emailConfirmed Boolean [default: false]

schema.prisma

@@ -40,6 +40,7 @@ model Person {
   updatedAt          DateTime?           @updatedAt @map("updated_at") @db.Timestamptz(6)
   // Receive marketing notifications
   newsletter         Boolean?            @default(false)
+  helpUsImprove      Boolean?            @default(false) @map("help_us_improve")
   address            String?             @db.VarChar(100)
   birthday           DateTime?           @db.Timestamptz(6)
   emailConfirmed     Boolean?            @default(false) @map("email_confirmed")