Feature/onboarding tasks

api/controllers/UserController.ts

@@ -96,6 +96,12 @@ export class UserController {
     return { error: null, user: userProfile };
   }
 
+  @Patch('/onboarding/collect')
+  async collectOnboarding(@AuthenticatedUser() user: UserModel): Promise<GetCurrentUserResponse> {
+    const userProfile = await this.userAccountService.collectOnboarding(user);
+    return { error: null, user: userProfile };
+  }
+
   @Patch()
   async patchCurrentUser(@Body() patchUserRequest: PatchUserRequest,
     @AuthenticatedUser() user: UserModel): Promise<PatchUserResponse> {

api/validators/UserControllerRequests.ts

@@ -47,6 +47,9 @@ export class UserPatches implements IUserPatches {
   @Allow()
   isAttendancePublic?: boolean;
 
+  @Allow()
+  onboardingSeen?: boolean;
+
   @Type(() => PasswordUpdate)
   @ValidateNested()
   @HasMatchingPasswords()

migrations/0046-add-onboarding-task.ts

@@ -0,0 +1,39 @@
+import { MigrationInterface, QueryRunner, TableColumn } from 'typeorm';
+
+const TABLE_NAME = 'Users';
+
+export class AddOnboardingTask1727933494169 implements MigrationInterface {
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.addColumns(TABLE_NAME, [
+      new TableColumn({
+        name: 'onboardingSeen',
+        type: 'boolean',
+        isNullable: true,
+        default: false,
+      }),
+      new TableColumn({
+        name: 'onboardingCollected',
+        type: 'boolean',
+        isNullable: true,
+        default: false,
+      }),
+    ]);
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.dropColumns(TABLE_NAME, [
+      new TableColumn({
+        name: 'onboardingSeen',
+        type: 'boolean',
+        isNullable: false,
+        default: false,
+      }),
+      new TableColumn({
+        name: 'onboardingRewarded',
+        type: 'boolean',
+        default: false,
+        isNullable: false,
+      }),
+    ]);
+  }
+}

models/UserModel.ts

@@ -65,6 +65,12 @@ export class UserModel extends BaseEntity {
   @Column('integer', { default: 0 })
   credits: number;
 
+  @Column('boolean', { default: false })
+  onboardingSeen: boolean;
+
+  @Column('boolean', { default: false })
+  onboardingCollected: boolean;
+
   @OneToMany((type) => ActivityModel, (activity) => activity.user, { cascade: true })
   activities: ActivityModel[];
 
@@ -154,10 +160,18 @@ export class UserModel extends BaseEntity {
       points: this.points,
       credits: this.credits,
       isAttendancePublic: this.isAttendancePublic,
+      onboardingSeen: this.onboardingSeen,
+      onboardingCollected: this.onboardingCollected,
     };
+    if (this.attendances) {
+      fullUserProfile.attendanceCount = this.attendances.length;
+    }
     if (this.userSocialMedia) {
       fullUserProfile.userSocialMedia = this.userSocialMedia.map((sm) => sm.getPublicSocialMedia());
     }
+    if (this.resumes) {
+      fullUserProfile.resumes = this.resumes.map((rm) => rm.getPublicResume());
+    }
     return fullUserProfile;
   }
 }

services/UserAccountService.ts

@@ -166,6 +166,24 @@ export default class UserAccountService {
     });
   }
 
+  public async collectOnboarding(user: UserModel): Promise<UserModel> {
+    const userProfile = await this.getFullUserProfile(user);
+    if (userProfile.attendanceCount < 5
+      || userProfile.resumes.length < 1
+      || userProfile.profilePicture == null
+      || userProfile.bio == null) {
+      throw new BadRequestError('Onboarding tasks not completed!');
+    }
+    if (userProfile.onboardingCollected) {
+      throw new BadRequestError('Onboarding reward already collected!');
+    }
+    return this.transactions.readWrite(async (txn) => {
+      const userRepository = Repositories.user(txn);
+      await userRepository.addPoints(user, 10);
+      return userRepository.upsertUser(user, { onboardingCollected: true });
+    });
+  }
+
   public async grantBonusPoints(emails: string[], description: string, points: number) {
     return this.transactions.readWrite(async (txn) => {
       const userRepository = Repositories.user(txn);
@@ -197,6 +215,7 @@ export default class UserAccountService {
       const userProfile = user.getFullUserProfile();
       userProfile.resumes = await Repositories.resume(txn).findAllByUser(user);
       userProfile.userSocialMedia = await Repositories.userSocialMedia(txn).getSocialMediaForUser(user);
+      userProfile.attendanceCount = (await Repositories.attendance(txn).getAttendancesForUser(user)).length;
       return userProfile;
     });
   }
@@ -269,7 +288,7 @@ export default class UserAccountService {
           .activity(txn)
           .logActivity(activity);
 
-        return updatedUser;
+        return updatedUser.getFullUserProfile();
       }));
 
       return updatedUsers;

tests/onboardingReward.test.ts

@@ -0,0 +1,87 @@
+import { EventModel } from '../models/EventModel';
+import { DatabaseConnection, UserFactory, PortalState, EventFactory, ResumeFactory } from './data';
+import { ControllerFactory } from './controllers';
+
+beforeAll(async () => {
+  await DatabaseConnection.connect();
+});
+
+beforeEach(async () => {
+  await DatabaseConnection.clear();
+});
+
+afterAll(async () => {
+  await DatabaseConnection.clear();
+  await DatabaseConnection.close();
+});
+
+describe('collect onboarding reward', () => {
+  test('can collect onboarding reward', async () => {
+    const conn = await DatabaseConnection.get();
+    const member = UserFactory.fake({
+      bio: 'this is a bio',
+      profilePicture: 'https://pfp.com',
+    });
+    const resume = ResumeFactory.fake({ user: member, isResumeVisible: true });
+
+    const events: EventModel[] = [];
+    for (let i = 0; i < 5; i += 1) {
+      events.push(EventFactory.fake({ pointValue: 10 }));
+    }
+
+    await new PortalState()
+      .createUsers(member)
+      .createEvents(events[0], events[1], events[2], events[3], events[4])
+      .attendEvents([member], events)
+      .createResumes(member, resume)
+      .write();
+
+    const userController = ControllerFactory.user(conn);
+    const response = await userController.collectOnboarding(member);
+    const userProfile = response.user;
+
+    expect(userProfile.onboardingCollected).toBe(true);
+    expect(userProfile.points).toBe(60);
+  });
+
+  test('conditions not fulfilled', async () => {
+    const conn = await DatabaseConnection.get();
+    const member = UserFactory.fake();
+
+    await new PortalState()
+      .createUsers(member)
+      .write();
+
+    const userController = ControllerFactory.user(conn);
+
+    await expect(userController.collectOnboarding(member))
+      .rejects.toThrow('Onboarding tasks not completed');
+  });
+
+  test('can collect onboarding reward', async () => {
+    const conn = await DatabaseConnection.get();
+    const member = UserFactory.fake({
+      bio: 'this is a bio',
+      profilePicture: 'https://pfp.com',
+      onboardingCollected: true,
+    });
+    const resume = ResumeFactory.fake({ user: member, isResumeVisible: true });
+
+    const events: EventModel[] = [];
+    for (let i = 0; i < 5; i += 1) {
+      events.push(EventFactory.fake({ pointValue: 10 }));
+    }
+
+    await new PortalState()
+      .createUsers(member)
+      .createEvents(events[0], events[1], events[2], events[3], events[4])
+      .attendEvents([member], events)
+      .createResumes(member, resume)
+      .write();
+
+    const userController = ControllerFactory.user(conn);
+
+    await expect(userController.collectOnboarding(member))
+      .rejects.toThrow('Onboarding reward already collected!');
+  });
+});

types/ApiRequests.ts

@@ -68,6 +68,7 @@ export interface UserPatches {
   graduationYear?: number;
   bio?: string;
   isAttendancePublic?: boolean;
+  onboardingSeen?: boolean;
   passwordChange?: PasswordUpdate;
 }
 

types/ApiResponses.ts

@@ -358,6 +358,9 @@ export interface PrivateProfile extends PublicProfile {
   state: string,
   credits: number,
   resumes?: PublicResume[],
+  attendanceCount?: number,
+  onboardingSeen: boolean,
+  onboardingCollected: boolean,
 }
 
 export interface PublicFeedback {