feat: sync people's bio and location (#94)

* fix: npm vulnerabilities

* feat: sync profile bio & location

* fix: pr review

* fix: review comment

* fix: review comment

Author: waltergalvao

apps/api/prisma/migrations/20260228005654_alter_table_git_profile_add_new_columns/migration.sql

@@ -0,0 +1,3 @@
+-- AlterTable
+ALTER TABLE "GitProfile" ADD COLUMN     "bio" TEXT,
+ADD COLUMN     "location" TEXT;

apps/api/prisma/schema.prisma

@@ -113,6 +113,8 @@ model GitProfile {
   handle               String
   name                 String
   avatar               String?
+  bio                  String?
+  location             String?
   workspaceMemberships WorkspaceMembership[]
 
   user   User? @relation(fields: [userId], references: [id])

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

@@ -78,15 +78,15 @@ const getLoginState = (redirectTo: string = "/") => {
 export const createOrSyncProfile = async (
   githubUser: Pick<
     GithubUser,
-    "node_id" | "login" | "name" | "email" | "avatar_url"
+    "node_id" | "login" | "name" | "email" | "avatar_url" | "bio" | "location"
   >
 ): Promise<
   GitProfile & {
     user: User;
     workspaceMemberships: WorkspaceMembership[];
   }
 > => {
-  const { login, name, email, avatar_url, node_id } = githubUser;
+  const { login, name, email, avatar_url, node_id, bio, location } = githubUser;
 
   const handle = login;
 
@@ -101,6 +101,8 @@ export const createOrSyncProfile = async (
       handle,
       name: name || handle,
       avatar: avatar_url,
+      bio: bio || null,
+      location: location || null,
       user: {
         upsert: {
           update: {
@@ -120,6 +122,8 @@ export const createOrSyncProfile = async (
       name: name || handle,
       gitUserId: node_id,
       handle,
+      bio: bio || null,
+      location: location || null,
       user: {
         create: {
           slug: createUserSlug(GitProvider.GITHUB, handle),

apps/api/src/app/gitProfile/services/git-profile.service.ts

@@ -0,0 +1,23 @@
+import { GitProfile } from "@prisma/client";
+import { getPrisma } from "../../../prisma";
+import { UpsertGitProfileInput } from "./git-profile.types";
+
+export const upsertGitProfile = async (
+  input: UpsertGitProfileInput
+): Promise<GitProfile> => {
+  const data = {
+    ...input,
+    avatar: input.avatar ?? undefined,
+  };
+
+  return getPrisma().gitProfile.upsert({
+    where: {
+      gitProvider_gitUserId: {
+        gitUserId: input.gitUserId,
+        gitProvider: input.gitProvider,
+      },
+    },
+    create: data,
+    update: data,
+  });
+};

apps/api/src/app/gitProfile/services/git-profile.types.ts

@@ -0,0 +1,11 @@
+import { GitProvider } from "@prisma/client";
+
+export interface UpsertGitProfileInput {
+  gitProvider: GitProvider;
+  gitUserId: string;
+  handle: string;
+  name: string;
+  avatar?: string | null;
+  bio?: string | null;
+  location?: string | null;
+}

apps/api/src/app/github/services/github-code-review.service.ts

@@ -24,13 +24,9 @@ import { ResourceNotFoundException } from "../../errors/exceptions/resource-not-
 import { SweetQueue, addJob } from "../../../bull-mq/queues";
 import { findWorkspaceByGitInstallationId } from "../../workspaces/services/workspace.service";
 import { parseISO } from "date-fns";
-
-interface Author {
-  id: string;
-  login: string;
-  name: string;
-  avatarUrl: string;
-}
+import { upsertGitProfile } from "../../gitProfile/services/git-profile.service";
+import { GitHubUser } from "./github-user.types";
+import { gitHubUserToGitProfileData } from "./github-user.service";
 
 interface ReviewData {
   gitProfileId: number;
@@ -46,7 +42,7 @@ type ReviewDataWithId = ReviewData & {
 interface ReviewRequestData {
   createdAt: Date;
   deletedAt: Date | null;
-  author: Author;
+  author: GitHubUser;
 }
 
 export const syncCodeReviews = async (
@@ -131,13 +127,16 @@ const fetchPullRequestReviews = async (
   const reviewEvents: ReviewDataWithId[] = [];
   const gitProfiles = new Map<string, GitProfile>();
 
-  const getGitProfileId = async (author: Author) => {
-    if (gitProfiles.has(author.id)) {
-      return gitProfiles.get(author.id)!.id;
+  const getGitProfileId = async (author: GitHubUser) => {
+    if (gitProfiles.has(author.nodeId)) {
+      return gitProfiles.get(author.nodeId)!.id;
     }
 
-    const gitProfile = await upsertGitProfile(author);
-    gitProfiles.set(author.id, gitProfile);
+    const gitProfile = await upsertGitProfile(
+      gitHubUserToGitProfileData(author)
+    );
+
+    gitProfiles.set(author.nodeId, gitProfile);
 
     return gitProfile.id;
   };
@@ -154,6 +153,8 @@ const fetchPullRequestReviews = async (
             login
             name
             avatarUrl
+            bio
+            location
           }
         }
       }
@@ -166,6 +167,8 @@ const fetchPullRequestReviews = async (
             login
             name
             avatarUrl
+            bio
+            location
           }
         }
       }
@@ -201,6 +204,8 @@ const fetchPullRequestReviews = async (
                     login
                     name
                     avatarUrl
+                    bio
+                    location
                   }
                 }
                 comments {
@@ -336,10 +341,12 @@ const getReviewRequests = (nodes: any[]): ReviewRequestData[] => {
         createdAt: new Date(node.createdAt),
         deletedAt: null,
         author: {
-          id: reviewerId,
+          nodeId: reviewerId,
           login: node.requestedReviewer.login,
           name: node.requestedReviewer.name,
           avatarUrl: node.requestedReviewer.avatarUrl,
+          bio: node.requestedReviewer.bio,
+          location: node.requestedReviewer.location,
         },
       });
     }
@@ -356,10 +363,12 @@ const getReviewRequests = (nodes: any[]): ReviewRequestData[] => {
         if (reviewRequest) {
           reviewRequest.deletedAt = new Date(node.createdAt);
           reviewRequest.author = {
-            id: reviewerId,
+            nodeId: reviewerId,
             login: node.requestedReviewer.login,
             name: node.requestedReviewer.name,
             avatarUrl: node.requestedReviewer.avatarUrl,
+            bio: node.requestedReviewer.bio,
+            location: node.requestedReviewer.location,
           };
         }
       }
@@ -376,7 +385,9 @@ const upsertCodeReviewRequests = async (
   logger.debug("upsertCodeReviewRequests", { pullRequest, reviewRequests });
 
   return parallel(10, reviewRequests, async (reviewRequest) => {
-    const gitProfile = await upsertGitProfile(reviewRequest.author);
+    const gitProfile = await upsertGitProfile(
+      gitHubUserToGitProfileData(reviewRequest.author)
+    );
 
     const data = {
       workspaceId: pullRequest.workspaceId,
@@ -481,25 +492,6 @@ const updatePullRequestTracking = async (
   });
 };
 
-const upsertGitProfile = async (author: Author) => {
-  return getPrisma().gitProfile.upsert({
-    where: {
-      gitProvider_gitUserId: {
-        gitProvider: GitProvider.GITHUB,
-        gitUserId: author.id,
-      },
-    },
-    update: {},
-    create: {
-      gitProvider: GitProvider.GITHUB,
-      gitUserId: author.id,
-      handle: author.login,
-      name: author.name ? author.name : author.login,
-      avatar: author.avatarUrl,
-    },
-  });
-};
-
 const findPullRequest = async (
   workspaceId: number,
   gitPullRequestId: string

apps/api/src/app/github/services/github-installation.service.ts

@@ -16,6 +16,8 @@ import { logger } from "../../../lib/logger";
 import { getInstallationOctoKit, octokit } from "../../../lib/octokit";
 import { addDays, endOfDay } from "date-fns";
 import { ResourceNotFoundException } from "../../errors/exceptions/resource-not-found.exception";
+import { upsertGitProfile } from "../../gitProfile/services/git-profile.service";
+import { gitHubUserToGitProfileData } from "./github-user.service";
 
 export const syncGitHubInstallation = async (
   gitInstallation: GitHubInstallation,
@@ -26,7 +28,15 @@ export const syncGitHubInstallation = async (
     gitUser,
   });
 
-  const gitProfile = await upsertGitProfile(gitUser);
+  const gitProfile = await upsertGitProfile(
+    gitHubUserToGitProfileData({
+      nodeId: gitUser.node_id,
+      avatarUrl: gitUser.avatar_url,
+      bio: undefined,
+      location: undefined,
+      ...gitUser,
+    })
+  );
   const workspace = await upsertWorkspace(gitInstallation, gitProfile);
   const installation = await upsertInstallation(gitInstallation, workspace.id);
 
@@ -155,28 +165,6 @@ const upsertWorkspace = async (
   });
 };
 
-const upsertGitProfile = async (gitUser: GitHubUser): Promise<GitProfile> => {
-  const gitUserId = gitUser.node_id.toString();
-
-  const data = {
-    gitUserId,
-    gitProvider: GitProvider.GITHUB,
-    handle: gitUser.login,
-    name: gitUser.name || gitUser.login,
-    avatar: gitUser.avatar_url,
-  };
-
-  const gitProfile = await getPrisma().gitProfile.upsert({
-    where: {
-      gitProvider_gitUserId: { gitUserId, gitProvider: GitProvider.GITHUB },
-    },
-    create: data,
-    update: data,
-  });
-
-  return gitProfile;
-};
-
 const connectUserToWorkspace = async (
   gitProfile: GitProfile,
   workspace: Workspace

apps/api/src/app/github/services/github-member.service.ts

@@ -1,26 +1,28 @@
-import { GitProfile, GitProvider } from "@prisma/client";
+import { GitProfile } from "@prisma/client";
 import {
   GITHUB_MAX_PAGE_LIMIT,
   getInstallationGraphQLOctoKit,
 } from "../../../lib/octokit";
 import { getPrisma } from "../../../prisma";
 import { parallel } from "radash";
 import { ResourceNotFoundException } from "../../errors/exceptions/resource-not-found.exception";
+import { upsertGitProfile } from "../../gitProfile/services/git-profile.service";
 import { logger } from "../../../lib/logger";
 import { findWorkspaceByGitInstallationId } from "../../workspaces/services/workspace.service";
+import { gitHubUserToGitProfileData } from "./github-user.service";
+import { GitHubUser } from "./github-user.types";
 
 type GitOrganizationMember = {
   id: string;
   login: string;
   role: string;
   name?: string;
   avatarUrl?: string;
+  bio?: string;
+  location?: string;
 };
 
-type MemberData = Omit<
-  GitProfile,
-  "id" | "userId" | "createdAt" | "updatedAt"
-> & {
+type MemberData = GitHubUser & {
   role: string;
 };
 
@@ -41,12 +43,8 @@ export const syncOrganizationMembers = async (
   );
 
   const membersData: MemberData[] = gitHubMembers.map((member) => ({
-    gitProvider: GitProvider.GITHUB,
-    gitUserId: member.id,
-    handle: member.login,
-    name: member.name || member.login,
-    avatar: member.avatarUrl || null,
-    role: member.role,
+    nodeId: member.id,
+    ...member,
   }));
 
   const workspaceGitProfiles = await upsertGitProfiles(
@@ -79,8 +77,7 @@ const fetchGitHubOrganizationMembers = async (
   gitInstallationId: number,
   organizationName: string
 ): Promise<GitOrganizationMember[]> => {
-  const fireGraphQLRequest =
-    await getInstallationGraphQLOctoKit(gitInstallationId);
+  const fireGraphQLRequest = getInstallationGraphQLOctoKit(gitInstallationId);
 
   const members: any[] = [];
   let hasNextPage = true;
@@ -101,6 +98,8 @@ const fetchGitHubOrganizationMembers = async (
                   login
                   name
                   avatarUrl
+                  bio
+                  location
                 }
                 edges {
                   role
@@ -150,16 +149,9 @@ const upsertGitProfiles = async (
   return parallel(10, membersData, async (memberData) => {
     const { role, ...member } = memberData;
 
-    const gitProfile = await getPrisma().gitProfile.upsert({
-      where: {
-        gitProvider_gitUserId: {
-          gitProvider: GitProvider.GITHUB,
-          gitUserId: member.gitUserId,
-        },
-      },
-      create: member,
-      update: member,
-    });
+    const gitProfile = await upsertGitProfile(
+      gitHubUserToGitProfileData(member)
+    );
 
     await getPrisma(workspaceId).workspaceMembership.upsert({
       where: {