:bug (fix-posthog): re-enable email identifier for analytics(#1279)

* :bug (fix-posthog): re-enable email identifier for analytics

* feat(user): add getProfile method and update userId handling in UserProvider

Author: victor-enogwe

packages/backend/src/user/controllers/user.controller.test.ts

@@ -28,6 +28,7 @@ describe("UserController", () => {
 
       expect(response.body).toEqual(
         expect.objectContaining({
+          userId: user._id.toString(),
           firstName: user.firstName,
           lastName: user.lastName,
           name: user.name,

packages/backend/src/user/services/user.service.test.ts

@@ -11,6 +11,7 @@ import {
   setupTestDb,
 } from "@backend/__tests__/helpers/mock.db.setup";
 import calendarService from "@backend/calendar/services/calendar.service";
+import { UserError } from "@backend/common/errors/user/user.errors";
 import { initSupertokens } from "@backend/common/middleware/supertokens.middleware";
 import mongoService from "@backend/common/services/mongo.service";
 import eventService from "@backend/event/services/event.service";
@@ -45,6 +46,35 @@ describe("UserService", () => {
     });
   });
 
+  describe("getProfile", () => {
+    it("returns the user profile for a valid user ID", async () => {
+      const user = await UserDriver.createUser();
+      const userId = user._id;
+
+      const profile = await userService.getProfile(userId);
+
+      expect(profile).toEqual(
+        expect.objectContaining({
+          userId: userId.toString(),
+          picture: user.google.picture,
+          firstName: user.firstName,
+          lastName: user.lastName,
+          name: user.name,
+          email: user.email,
+          locale: user.locale,
+        }),
+      );
+    });
+
+    it("throws UserNotFound error when user does not exist", async () => {
+      const nonExistentId = mongoService.objectId();
+
+      await expect(userService.getProfile(nonExistentId)).rejects.toThrow(
+        UserError.UserNotFound.description,
+      );
+    });
+  });
+
   describe("deleteCompassDataForUser", () => {
     it("removes all compass data and deletes the user", async () => {
       const user = await UserDriver.createUser();

packages/backend/src/user/services/user.service.ts

@@ -58,6 +58,7 @@ class UserService {
       {
         session,
         projection: {
+          userId: { $toString: "$_id" },
           picture: "$google.picture",
           firstName: 1,
           lastName: 1,
@@ -70,7 +71,7 @@ class UserService {
 
     if (!user) throw error(UserError.UserNotFound, "Failed to find user");
 
-    return { ...user, picture: Reflect.get(user, "picture") };
+    return user as unknown as UserProfile;
   };
 
   deleteCompassDataForUser = async (userId: string, gcalAccess = true) => {

packages/core/src/types/user.types.ts

@@ -1,4 +1,5 @@
 import SupertokensUserMetadata from "supertokens-node/recipe/usermetadata";
+import { WithCompassId } from "./event.types";
 
 export interface Schema_User {
   email: string;
@@ -27,8 +28,9 @@ export interface UserMetadata extends SupertokensUserMetadata.JSONObject {
 
 export interface UserProfile
   extends Pick<
-    Schema_User,
+    WithCompassId<Schema_User>,
     "firstName" | "lastName" | "name" | "email" | "locale"
   > {
   picture: string;
+  userId: string;
 }

packages/web/src/__tests__/__mocks__/server/mock.handlers.ts

@@ -52,6 +52,19 @@ export const globalHandlers = [
   rest.options(`${ENV_WEB.API_BASEURL}/event`, (_req, res, ctx) => {
     return res(ctx.json([]));
   }),
+  rest.get(`${ENV_WEB.API_BASEURL}/user/profile`, (_req, res, ctx) => {
+    return res(
+      ctx.status(Status.OK),
+      ctx.json({
+        userId: "test-user-123",
+        email: "[email protected]",
+        name: faker.person.fullName(),
+        firstName: faker.person.firstName(),
+        lastName: faker.person.lastName(),
+        photo: faker.image.avatar(),
+      }),
+    );
+  }),
   rest.get(`${ENV_WEB.API_BASEURL}/user/metadata`, (_req, res, ctx) => {
     return res(ctx.status(Status.OK), ctx.json({ skipOnboarding: false }));
   }),