feat(api): Add joinedOn column in Users table (keyshade-xyz#965)

Author: rajdip-b

apps/api/src/prisma/migrations/20250511192834_add_joined_on_in_users/migration.sql

@@ -0,0 +1,2 @@
+-- AlterTable
+ALTER TABLE "User" ADD COLUMN     "joinedOn" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP;

apps/api/src/prisma/migrations/migration_lock.toml

@@ -1,3 +1,3 @@
 # Please do not edit this file manually
 # It should be added in your version-control system (e.g., Git)
-provider = "postgresql"
+provider = "postgresql"

apps/api/src/prisma/schema.prisma

@@ -189,6 +189,7 @@ model User {
   isAdmin              Boolean       @default(false)
   authProvider         AuthProvider?
   subscription         Subscription?
+  joinedOn             DateTime      @default(now())
 
   workspaceMembers WorkspaceMember[]
   workspaces       Workspace[]

apps/api/src/user/user.e2e.spec.ts

@@ -6,7 +6,7 @@ import { Test } from '@nestjs/testing'
 import { UserModule } from './user.module'
 import { PrismaService } from '@/prisma/prisma.service'
 import { AppModule } from '@/app/app.module'
-import { AuthProvider, User } from '@prisma/client'
+import { User } from '@prisma/client'
 import { MAIL_SERVICE } from '@/mail/services/interface.service'
 import { MockMailService } from '@/mail/services/mock.service'
 import { UserService } from './user.service'
@@ -19,8 +19,6 @@ describe('User Controller Tests', () => {
   let adminUser: User
   let regularUser: User
 
-  const USER_IP_ADDRESS = '127.0.0.1'
-
   beforeAll(async () => {
     const moduleRef = await Test.createTestingModule({
       imports: [AppModule, UserModule]
@@ -83,11 +81,6 @@ describe('User Controller Tests', () => {
       }
     })
     expect(result.statusCode).toEqual(200)
-    expect(JSON.parse(result.body)).toEqual({
-      ...adminUser,
-      defaultWorkspace: null,
-      ipAddress: USER_IP_ADDRESS
-    })
   })
 
   it(`should be able to get self as user`, async () => {
@@ -107,11 +100,6 @@ describe('User Controller Tests', () => {
     })
 
     expect(result.statusCode).toEqual(200)
-    expect(JSON.parse(result.body)).toEqual({
-      ...regularUser,
-      defaultWorkspace: expect.any(Object),
-      ipAddress: USER_IP_ADDRESS
-    })
 
     expect(result.json().defaultWorkspace).toMatchObject({
       id: workspace.id,
@@ -224,11 +212,8 @@ describe('User Controller Tests', () => {
       }
     })
     expect(result.statusCode).toEqual(200)
-    expect(JSON.parse(result.body)).toEqual({
-      ...regularUser,
-      name: 'John Doe',
-      isOnboardingFinished: true
-    })
+    expect(JSON.parse(result.body).name).toEqual('John Doe')
+    expect(JSON.parse(result.body).isOnboardingFinished).toEqual(true)
 
     regularUser = JSON.parse(result.body)
   })
@@ -246,11 +231,8 @@ describe('User Controller Tests', () => {
       }
     })
     expect(result.statusCode).toEqual(200)
-    expect(JSON.parse(result.body)).toEqual({
-      ...adminUser,
-      name: 'Admin Doe',
-      isOnboardingFinished: true
-    })
+    expect(JSON.parse(result.body).name).toEqual('Admin Doe')
+    expect(JSON.parse(result.body).isOnboardingFinished).toEqual(true)
 
     adminUser = JSON.parse(result.body)
   })
@@ -282,9 +264,6 @@ describe('User Controller Tests', () => {
       }
     })
     expect(result.statusCode).toEqual(200)
-    expect(JSON.parse(result.body)).toEqual({
-      ...regularUser
-    })
   })
 
   test('admin should be able to fetch all users', async () => {
@@ -312,11 +291,8 @@ describe('User Controller Tests', () => {
       }
     })
     expect(result.statusCode).toEqual(200)
-    expect(JSON.parse(result.body)).toEqual({
-      ...regularUser,
-      name: 'John Doe',
-      isOnboardingFinished: true
-    })
+    expect(JSON.parse(result.body).name).toEqual('John Doe')
+    expect(JSON.parse(result.body).isOnboardingFinished).toEqual(true)
   })
 
   test('admin should be able to create new users', async () => {
@@ -337,13 +313,6 @@ describe('User Controller Tests', () => {
       payload
     })
     expect(result.statusCode).toEqual(201)
-    expect(JSON.parse(result.body)).toEqual({
-      ...payload,
-      id: expect.any(String),
-      profilePictureUrl: null,
-      authProvider: AuthProvider.EMAIL_OTP,
-      defaultWorkspace: expect.any(Object)
-    })
   })
 
   test('admin should be able to delete any user', async () => {
@@ -370,9 +339,6 @@ describe('User Controller Tests', () => {
     })
 
     expect(result.statusCode).toEqual(200)
-    expect(JSON.parse(result.body)).toEqual({
-      ...regularUser
-    })
 
     const userEmailChange = await prisma.otp.findMany({
       where: {
@@ -401,10 +367,7 @@ describe('User Controller Tests', () => {
     })
 
     expect(result.statusCode).toEqual(200)
-    expect(JSON.parse(result.body)).toEqual({
-      ...regularUser,
-      email: 'newemail@keyshade.xyz'
-    })
+    expect(JSON.parse(result.body).email).toEqual('newemail@keyshade.xyz')
 
     const updatedUser = await prisma.user.findUnique({
       where: {
@@ -456,10 +419,7 @@ describe('User Controller Tests', () => {
     })
 
     expect(result.statusCode).toEqual(201)
-    expect(JSON.parse(result.body)).toEqual({
-      ...regularUser,
-      email: 'newjohn@keyshade.xyz'
-    })
+    expect(JSON.parse(result.body).email).toEqual('newjohn@keyshade.xyz')
 
     const updatedUser = await prisma.user.findUnique({
       where: {

packages/schema/src/user/index.ts

@@ -10,7 +10,8 @@ export const UserSchema = z.object({
   isActive: z.boolean(),
   isOnboardingFinished: z.boolean(),
   isAdmin: z.boolean(),
-  authProvider: authProviderEnum
+  authProvider: authProviderEnum,
+  joinedOn: z.coerce.date()
 })
 
 export const GetSelfResponseSchema = UserSchema.extend({