feat: add profile completion calculation to boot (#3373)

Author: idoshamun

__tests__/boot.ts

@@ -88,6 +88,8 @@ import {
   ContentPreferenceOrganization,
   ContentPreferenceOrganizationStatus,
 } from '../src/entity/contentPreference/ContentPreferenceOrganization';
+import { UserExperienceWork } from '../src/entity/user/experiences/UserExperienceWork';
+import { UserExperienceEducation } from '../src/entity/user/experiences/UserExperienceEducation';
 
 let app: FastifyInstance;
 let con: DataSource;
@@ -160,6 +162,14 @@ const LOGGED_IN_BODY = {
     hasLocationSet: false,
     location: null,
     hideExperience: false,
+    profileCompletion: {
+      percentage: 20,
+      hasProfileImage: true,
+      hasHeadline: false,
+      hasExperienceLevel: false,
+      hasWork: false,
+      hasEducation: false,
+    },
   },
   marketingCta: null,
   feeds: [],
@@ -1734,6 +1744,7 @@ describe('funnel boot', () => {
         'hasLocationSet',
         'location',
         'readme',
+        'profileCompletion',
       ]),
     });
   });
@@ -1932,3 +1943,124 @@ describe('funnel boot', () => {
     });
   });
 });
+
+describe('boot profile completion', () => {
+  const BASE_PATH = '/boot';
+
+  it('should return profileCompletion with 0% for user with no profile data', async () => {
+    await con
+      .getRepository(User)
+      .update({ id: '1' }, { image: '', bio: null, experienceLevel: null });
+
+    mockLoggedIn();
+    const res = await request(app.server)
+      .get(BASE_PATH)
+      .set('User-Agent', TEST_UA)
+      .set('Cookie', 'ory_kratos_session=value;')
+      .expect(200);
+
+    expect(res.body.user.profileCompletion).toEqual({
+      percentage: 0,
+      hasProfileImage: false,
+      hasHeadline: false,
+      hasExperienceLevel: false,
+      hasWork: false,
+      hasEducation: false,
+    });
+  });
+
+  it('should return profileCompletion with 20% for user with only profile image', async () => {
+    await con.getRepository(User).update(
+      { id: '1' },
+      {
+        image: 'https://example.com/image.jpg',
+        bio: null,
+        experienceLevel: null,
+      },
+    );
+
+    mockLoggedIn();
+    const res = await request(app.server)
+      .get(BASE_PATH)
+      .set('User-Agent', TEST_UA)
+      .set('Cookie', 'ory_kratos_session=value;')
+      .expect(200);
+
+    expect(res.body.user.profileCompletion).toEqual({
+      percentage: 20,
+      hasProfileImage: true,
+      hasHeadline: false,
+      hasExperienceLevel: false,
+      hasWork: false,
+      hasEducation: false,
+    });
+  });
+
+  it('should return profileCompletion with 60% for user with image, bio, and experience level', async () => {
+    await con.getRepository(User).update(
+      { id: '1' },
+      {
+        image: 'https://example.com/image.jpg',
+        bio: 'Software engineer',
+        experienceLevel: 'MORE_THAN_4_YEARS',
+      },
+    );
+
+    mockLoggedIn();
+    const res = await request(app.server)
+      .get(BASE_PATH)
+      .set('User-Agent', TEST_UA)
+      .set('Cookie', 'ory_kratos_session=value;')
+      .expect(200);
+
+    expect(res.body.user.profileCompletion).toEqual({
+      percentage: 60,
+      hasProfileImage: true,
+      hasHeadline: true,
+      hasExperienceLevel: true,
+      hasWork: false,
+      hasEducation: false,
+    });
+  });
+
+  it('should return profileCompletion with 100% for user with complete profile', async () => {
+    await con.getRepository(User).update(
+      { id: '1' },
+      {
+        image: 'https://example.com/image.jpg',
+        bio: 'Software engineer',
+        experienceLevel: 'MORE_THAN_4_YEARS',
+      },
+    );
+
+    // Add work experience
+    await con.getRepository(UserExperienceWork).save({
+      userId: '1',
+      title: 'Software Engineer',
+      startedAt: new Date('2020-01-01'),
+    });
+
+    // Add education
+    await con.getRepository(UserExperienceEducation).save({
+      userId: '1',
+      title: 'Computer Science',
+      startedAt: new Date('2016-01-01'),
+    });
+
+    mockLoggedIn();
+    const res = await request(app.server)
+      .get(BASE_PATH)
+      .set('User-Agent', TEST_UA)
+      .set('Cookie', 'ory_kratos_session=value;')
+      .expect(200);
+
+    expect(res.body.user.profileCompletion).toEqual({
+      percentage: 100,
+      hasProfileImage: true,
+      hasHeadline: true,
+      hasExperienceLevel: true,
+      hasWork: true,
+      hasEducation: true,
+    });
+  });
+});

src/routes/boot.ts

@@ -23,6 +23,8 @@ import {
   SquadSource,
   User,
 } from '../entity';
+import { UserExperience } from '../entity/user/experiences/UserExperience';
+import { UserExperienceType } from '../entity/user/experiences/types';
 import { DatasetLocation } from '../entity/dataset/DatasetLocation';
 import {
   getPermissionsForMember,
@@ -45,6 +47,7 @@ import {
   StorageKey,
   StorageTopic,
 } from '../config';
+
 import {
   ONE_DAY_IN_SECONDS,
   base64,
@@ -148,6 +151,7 @@ export type LoggedInBoot = BaseBoot & {
     balance: GetBalanceResult;
     coresRole: CoresRole;
     location?: TLocation | null;
+    profileCompletion?: ProfileCompletion | null;
   };
   accessToken?: AccessToken;
   marketingCta: MarketingCta | null;
@@ -525,6 +529,80 @@ const getLocation = async (
   return location;
 };
 
+export type ProfileCompletion = {
+  percentage: number;
+  hasProfileImage: boolean;
+  hasHeadline: boolean;
+  hasExperienceLevel: boolean;
+  hasWork: boolean;
+  hasEducation: boolean;
+};
+
+type ProfileExperienceFlags = {
+  hasWork: boolean;
+  hasEducation: boolean;
+};
+
+const getProfileExperienceFlags = async (
+  con: DataSource | QueryRunner,
+  userId: string,
+): Promise<ProfileExperienceFlags> => {
+  const result = await con.manager
+    .createQueryBuilder(UserExperience, 'ue')
+    .select(`MAX(CASE WHEN ue.type = :workType THEN 1 ELSE 0 END)`, 'hasWork')
+    .addSelect(
+      `MAX(CASE WHEN ue.type = :educationType THEN 1 ELSE 0 END)`,
+      'hasEducation',
+    )
+    .where('ue.userId = :userId', { userId })
+    .andWhere('ue.type IN (:...types)', {
+      types: [UserExperienceType.Work, UserExperienceType.Education],
+    })
+    .setParameters({
+      workType: UserExperienceType.Work,
+      educationType: UserExperienceType.Education,
+    })
+    .getRawOne();
+
+  const hasWork = result?.hasWork == 1;
+  const hasEducation = result?.hasEducation == 1;
+
+  return { hasWork, hasEducation };
+};
+
+const calculateProfileCompletion = (
+  user: User | null,
+  experienceFlags: ProfileExperienceFlags | null,
+): ProfileCompletion | null => {
+  if (!user || !experienceFlags) {
+    return null;
+  }
+
+  // Calculate completion based on 5 items (each worth 20%)
+  const hasProfileImage = !!user.image && user.image !== '';
+  const hasHeadline = !!user.bio && user.bio.trim() !== '';
+  const hasExperienceLevel = !!user.experienceLevel;
+  const { hasWork, hasEducation } = experienceFlags;
+
+  const completedItems = [
+    hasProfileImage,
+    hasHeadline,
+    hasExperienceLevel,
+    hasWork,
+    hasEducation,
+  ].filter(Boolean).length;
+
+  const percentage = Math.round((completedItems / 5) * 100);
+  return {
+    percentage,
+    hasProfileImage,
+    hasHeadline,
+    hasExperienceLevel,
+    hasWork,
+    hasEducation,
+  };
+};
+
 const loggedInBoot = async ({
   con,
   req,
@@ -546,6 +624,7 @@ const loggedInBoot = async ({
     const geo = geoSection(req);
 
     const { log } = req;
+
     const [
       visit,
       roles,
@@ -559,6 +638,7 @@ const loggedInBoot = async ({
         feeds,
         unreadNotificationsCount,
         location,
+        experienceFlags,
       ],
       balance,
       clickbaitTries,
@@ -582,11 +662,15 @@ const loggedInBoot = async ({
           getFeeds({ con: queryRunner, userId }),
           getUnreadNotificationsCount(queryRunner, userId),
           getLocation(queryRunner, userId),
+          getProfileExperienceFlags(queryRunner, userId),
         ]);
       }),
       getBalanceBoot({ userId }),
       getClickbaitTries({ userId }),
     ]);
+
+    const profileCompletion = calculateProfileCompletion(user, experienceFlags);
+
     if (!user) {
       return handleNonExistentUser(con, req, res, middleware);
     }
@@ -641,6 +725,7 @@ const loggedInBoot = async ({
         clickbaitTries,
         hasLocationSet,
         location,
+        profileCompletion,
       },
       visit,
       alerts: {