test: wrote tests for user service file

packages/hoppscotch-backend/src/auth/auth.service.ts

@@ -226,7 +226,7 @@ export class AuthService {
 
     /**
      * * Check to see if entry for Magic-Link is present in the Account table for user
-     * * If user was created with another provider findUserByEmail may return true
+     * * If user was created with another provider findUserById may return true
      */
     const profile = {
       provider: 'magic',

packages/hoppscotch-backend/src/user/user.service.spec.ts

@@ -0,0 +1,215 @@
+import { mockDeep, mockReset } from 'jest-mock-extended';
+import { PrismaService } from 'src/prisma/prisma.service';
+import { AuthUser } from 'src/types/AuthUser';
+import { User } from './user.model';
+import { UserService } from './user.service';
+
+const mockPrisma = mockDeep<PrismaService>();
+
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore
+const userService = new UserService(mockPrisma);
+
+const currentTime = new Date();
+
+const user: AuthUser = {
+  uid: '123344',
+  email: 'dwight@dundermifflin.com',
+  displayName: 'Dwight Schrute',
+  photoURL: 'https://en.wikipedia.org/wiki/Dwight_Schrute',
+  isAdmin: false,
+  refreshToken: 'hbfvdkhjbvkdvdfjvbnkhjb',
+  createdOn: currentTime,
+};
+
+const exampleSSOProfileData = {
+  id: '123rfedvd',
+  emails: [{ value: 'dwight@dundermifflin.com' }],
+  displayName: 'Dwight Schrute',
+  provider: 'google',
+  photos: 'https://en.wikipedia.org/wiki/Dwight_Schrute',
+};
+
+describe('findUserByEmail', () => {
+  test('should successfully return a valid user given a valid email', async () => {
+    mockPrisma.user.findUniqueOrThrow.mockResolvedValueOnce(user);
+
+    const result = await userService.findUserByEmail(
+      'dwight@dundermifflin.com',
+    );
+    expect(result).toEqualSome(user);
+  });
+
+  test('should return a null user given a invalid email', async () => {
+    mockPrisma.user.findUniqueOrThrow.mockRejectedValueOnce('NotFoundError');
+
+    const result = await userService.findUserByEmail('jim@dundermifflin.com');
+    expect(result).resolves.toBeNone;
+  });
+});
+
+describe('findUserById', () => {
+  test('should successfully return a valid user given a valid user uid', async () => {
+    mockPrisma.user.findUniqueOrThrow.mockResolvedValueOnce(user);
+
+    const result = await userService.findUserById('123344');
+    expect(result).toEqualSome(user);
+  });
+
+  test('should return a null user given a invalid user uid', async () => {
+    mockPrisma.user.findUniqueOrThrow.mockRejectedValueOnce('NotFoundError');
+
+    const result = await userService.findUserById('sdcvbdbr');
+    expect(result).resolves.toBeNone;
+  });
+});
+
+describe('createUserMagic', () => {
+  test('should successfully create user and account for magic-link given valid inputs', async () => {
+    mockPrisma.user.create.mockResolvedValueOnce(user);
+
+    const result = await userService.createUserMagic(
+      'dwight@dundermifflin.com',
+    );
+    expect(result).toEqual(user);
+  });
+});
+
+describe('createUserSSO', () => {
+  test('should successfully create user and account for SSO provider given valid inputs  ', async () => {
+    mockPrisma.user.create.mockResolvedValueOnce(user);
+
+    const result = await userService.createUserSSO(
+      'sdcsdcsdc',
+      'dscsdc',
+      exampleSSOProfileData,
+    );
+    expect(result).toEqual(user);
+  });
+
+  test('should successfully create user and account for SSO provider given no displayName  ', async () => {
+    mockPrisma.user.create.mockResolvedValueOnce({
+      ...user,
+      displayName: null,
+    });
+
+    const result = await userService.createUserSSO('sdcsdcsdc', 'dscsdc', {
+      ...exampleSSOProfileData,
+      displayName: null,
+    });
+
+    expect(result).toEqual({
+      ...user,
+      displayName: null,
+    });
+  });
+
+  test('should successfully create user and account for SSO provider given no photoURL  ', async () => {
+    mockPrisma.user.create.mockResolvedValueOnce({
+      ...user,
+      photoURL: null,
+    });
+
+    const result = await userService.createUserSSO('sdcsdcsdc', 'dscsdc', {
+      ...exampleSSOProfileData,
+      photoURL: null,
+    });
+
+    expect(result).toEqual({
+      ...user,
+      photoURL: null,
+    });
+  });
+});
+
+describe('createProviderAccount', () => {
+  test('should successfully create ProviderAccount for user given valid inputs ', async () => {
+    mockPrisma.account.create.mockResolvedValueOnce({
+      id: '123dcdc',
+      userId: user.uid,
+      provider: exampleSSOProfileData.provider,
+      providerAccountId: exampleSSOProfileData.id,
+      providerRefreshToken: 'dscsdc',
+      providerAccessToken: 'sdcsdcsdc',
+      providerScope: 'user.email',
+      loggedIn: currentTime,
+    });
+
+    const result = await userService.createProviderAccount(
+      user,
+      'sdcsdcsdc',
+      'dscsdc',
+      exampleSSOProfileData,
+    );
+    expect(result).toEqual({
+      id: '123dcdc',
+      userId: user.uid,
+      provider: exampleSSOProfileData.provider,
+      providerAccountId: exampleSSOProfileData.id,
+      providerRefreshToken: 'dscsdc',
+      providerAccessToken: 'sdcsdcsdc',
+      providerScope: 'user.email',
+      loggedIn: currentTime,
+    });
+  });
+
+  test('should successfully create ProviderAccount for user given no accessToken ', async () => {
+    mockPrisma.account.create.mockResolvedValueOnce({
+      id: '123dcdc',
+      userId: user.uid,
+      provider: exampleSSOProfileData.provider,
+      providerAccountId: exampleSSOProfileData.id,
+      providerRefreshToken: 'dscsdc',
+      providerAccessToken: null,
+      providerScope: 'user.email',
+      loggedIn: currentTime,
+    });
+
+    const result = await userService.createProviderAccount(
+      user,
+      'sdcsdcsdc',
+      'dscsdc',
+      exampleSSOProfileData,
+    );
+    expect(result).toEqual({
+      id: '123dcdc',
+      userId: user.uid,
+      provider: exampleSSOProfileData.provider,
+      providerAccountId: exampleSSOProfileData.id,
+      providerRefreshToken: 'dscsdc',
+      providerAccessToken: null,
+      providerScope: 'user.email',
+      loggedIn: currentTime,
+    });
+  });
+
+  test('should successfully create ProviderAccount for user given no refreshToken', async () => {
+    mockPrisma.account.create.mockResolvedValueOnce({
+      id: '123dcdc',
+      userId: user.uid,
+      provider: exampleSSOProfileData.provider,
+      providerAccountId: exampleSSOProfileData.id,
+      providerRefreshToken: null,
+      providerAccessToken: 'sdcsdcsdc',
+      providerScope: 'user.email',
+      loggedIn: currentTime,
+    });
+
+    const result = await userService.createProviderAccount(
+      user,
+      'sdcsdcsdc',
+      'dscsdc',
+      exampleSSOProfileData,
+    );
+    expect(result).toEqual({
+      id: '123dcdc',
+      userId: user.uid,
+      provider: exampleSSOProfileData.provider,
+      providerAccountId: exampleSSOProfileData.id,
+      providerRefreshToken: null,
+      providerAccessToken: 'sdcsdcsdc',
+      providerScope: 'user.email',
+      loggedIn: currentTime,
+    });
+  });
+});