@tomei/sso 0.1.2 → 0.2.0

package/README.md

@@ -2,7 +2,7 @@
 
 ### How to use
 - run `npm i`
-- Make sure you set the `DATABASE_URL` and `SHADOW_DATABASE_URL` in your project `.env` file
+- Make sure you set the environment in .sampledotenv in your project `.env` file
 - run `npm run start:dev`
 
 ### How create a new migration
@@ -11,8 +11,13 @@
 - Create a database user 
 - Grant the above user privileges to alter sso tables and shadow database. The user should have access to the sso table and shadow database only. Use `create-sso-user.sql` as an example to create the user and grant privileges
 - Make changes to the `schema.prisma` file 
-- Run `npx prisma migrate dev --name <migration-name> --preview-feature --create-only` to create the migration. The migration will be created in the `migrations` folder. Review the migration and make changes if necessary.
+- Run `npx prisma migrate dev --name <migration-name> --preview-feature --create-only` to create the migration. The migration will be created in the `migrations` folder.
+- open the newly created migration. review the migration and make changes if necessary.
+
+notes:
+- if you create a new table, after migration has been created, change the default character set to `latin1` from `utf8mb4` and remove COLLATE phrase.please also add it to the `create-sso-user.sql` file for references
 
 ### How to run migration
 - run `npx prisma migrate deploy` to run the migration
+- run `npx prisma generate` to generate the prisma client
 

package/__tests__/unit/components/login-history/login-history.repository.spec.ts

@@ -0,0 +1,95 @@
+import { LoginHistory } from '@prisma/client';
+import { LoginHistoryRepository } from '../../../../src/components/login-history/login-history.repository';
+import { prismaMock } from '../../../../src/prisma-client/__mocks__/prisma';
+
+describe('login-history.repository', () => {
+  afterEach(() => {
+    jest.restoreAllMocks()
+  })
+  describe('findAll', () => {
+    it('should return list of login history', async () => {
+      const data = [{
+        userId: 1,
+        systemId: 1,
+        originIp: '1.1.1.1',
+        createdAt: new Date(),
+      }]
+      prismaMock.loginHistory.findMany.mockResolvedValueOnce(data as LoginHistory[]) 
+      const loginHistoryRepository = new LoginHistoryRepository()
+      expect(await loginHistoryRepository.findAll({})).toEqual(data)
+    })
+  })
+
+  describe('findOne', () => {
+    it('should return login history', async () => {
+      const data = {
+        userId: 1,
+        systemId: 1,
+        originIp: '1.1.1.1',
+        createdAt: new Date(),
+      }
+      prismaMock.loginHistory.findFirst.mockResolvedValueOnce(data as LoginHistory)
+      const loginHistoryRepository = new LoginHistoryRepository()
+      expect(await loginHistoryRepository.findOne({
+        where: {
+          userId_systemId: {
+            userId: data.userId,
+            systemId: data.systemId,
+          },
+        },
+      })).toEqual(data)
+    })
+  })
+
+  describe('create', () => {
+    it('should create login history', async () => {
+      const data = {
+        userId: 1,
+        systemId: 1,
+        originIp: '1.1.1.1',
+        createdAt: new Date(),
+      }
+      prismaMock.loginHistory.create.mockResolvedValueOnce(data as LoginHistory)
+      const loginHistoryRepository = new LoginHistoryRepository()
+      expect(await loginHistoryRepository.create({data})).toEqual(data)
+    })
+  })
+
+  describe('update', () => {
+    it('should update login history', async () => {
+      const data = {
+        userId: 1,
+        systemId: 1,
+        originIp: '1.1.1.1',
+        createdAt: new Date(),
+      }
+      prismaMock.loginHistory.update.mockResolvedValueOnce(data as LoginHistory)
+      const loginHistoryRepository = new LoginHistoryRepository()
+      expect(await loginHistoryRepository.update({
+        where: {
+          userId: data.userId
+      }, data: data
+      }, data)).toEqual(data)
+    })
+  })
+
+  describe('delete', () => {
+    it('should delete login history', async () => {
+      const data = {
+        userId: 1,
+        systemId: 1,
+        originIp: '1.1.1.1',
+        createdAt: new Date(),
+      }
+      prismaMock.loginHistory.delete.mockResolvedValueOnce(data as LoginHistory)
+      const loginHistoryRepository = new LoginHistoryRepository()
+      expect(await loginHistoryRepository.delete({
+        where: {
+          userId: data.userId
+        }
+      })).toEqual(data)
+    })
+  })
+
+})
+

package/__tests__/unit/components/login-user/login-user.spec.ts

@@ -0,0 +1,223 @@
+import { IUserSession } from '../../../../src/interfaces/user-session.interface';
+import { LoginHistoryRepository, SessionService, SystemAccessRepository, SystemRepository } from '../../../../src';
+import { LoginUser } from '../../../../src/components/login-user/login-user';
+import { UserRepository } from '../../../../src/components/login-user/user.repository';
+import { PasswordHashService } from '../../../../src/components/password-hash/password-hash.service';
+import { MailService } from '../../../../src/mail/mail.service';
+describe('login-user', () => {
+  const user = {
+    id: 755,
+    email: 'ezcash+florence@tomei.com.my',
+    password:
+      '$argon2id$v=19$m=4096,t=3,p=1$571ilUAi9n5g393m/NqKbQ$2bMnLtMCIVTjHWHGEDxI2wo+A3mrL3N5rTxDJ6ydPi8',
+    status: null,
+    defaultPasswordChanged: false,
+    firstLoginAt: new Date('2023-01-10T07:57:10.000Z'),
+    createdAt: new Date('2023-01-10T07:57:10.000Z'),
+    updatedAt: new Date('2023-01-10T08:58:15.000Z'),
+    groupCode: 'EZCFT',
+    staffs: [
+      {
+        id: 740,
+        staffId: 'EZC003',
+        fullName: 'EZC Florence',
+        preferredName: 'EZC Florence',
+        email: 'ezcash+florence@tomei.com.my',
+        staffTypeId: 1,
+        jobTitle: 'EZC Finance',
+        carPlate: '',
+        mobile: '60123456',
+        floor: null,
+        extension: null,
+        isCharge: false,
+        status: 'active',
+        userId: 755,
+        buildingId: 20,
+        departmentId: 110,
+        companyId: 70,
+        createdById: 74,
+        updatedById: 74,
+        createdAt: new Date('2023-01-10T07:57:10.000Z'),
+        updatedAt: new Date('2023-01-10T07:57:10.000Z'),
+        image: null,
+        idNo: '123123123',
+        fullAddress: 'Lorem Address',
+      },
+    ],
+    userSystemPrivileges: [
+      {
+        userId: 22,
+        privilegeId: 'ckymxuh8t000137t011w89zgk',
+        isInheritedYN: 'N',
+        isRevokedYN: 'N',
+        createdAt: new Date('2022-04-18T04:07:40.000Z'),
+        updatedAt: new Date('2022-04-18T04:07:40.000Z'),
+        systemPrivilege: {
+          privilegeId: 'ckymxuh8t000137t011w89zgk',
+          systemId: 11,
+          code: 'Own',
+          module: null,
+          description:
+            'Allows the user to only view consignments belonging to themselves',
+          createdAt: new Date('2022-01-20T12:16:26.000Z'),
+          updatedAt: new Date('2022-01-20T12:16:26.000Z'),
+        },
+      },
+    ],
+  };
+
+  const system = {
+    id: 175,
+    code: 'EZC',
+    name: 'EzCash',
+    description: 'Tomei Money Lending System',
+    accessUrl: 'https://app.ezcash.com.my:22443/staff/login',
+    googlePlayUrl: '',
+    appleStoreUrl: '',
+    apiKey: 'VqS9ks2Lwvqd7HrVUMMIP2q7zaEH689HCPaEaFUQLmiRoZnt',
+    logo: 'https://sso-api.tomei.com.my/upload/2023/01/10/FJ3DoHdRZKjf2bGkgA4E-BrowserIcon.png',
+    status: 'active',
+    visible: true,
+    createdAt: new Date('2023-01-09T00:45:57.000Z'),
+    updatedAt: new Date('2023-01-10T06:28:56.000Z'),
+    apiSecret:
+      '$argon2id$v=19$m=4096,t=3,p=1$lqxfk/ujftswf2jSEu156g$j2IShE/BZUUoH/1jrvt3GGRSy0rA8HilJvK17e6vdFY',
+    updatedById: 61,
+    createdById: 100,
+  };
+
+  const systemAccess = {
+    userId: 755,
+    systemId: 175,
+    updatedAt: new Date('2023-01-09T00:45:57.000'),
+  };
+
+  const session: IUserSession = {
+    systemLogins: [
+      {
+        id: '175',
+        code: 'EZC',
+        sessionId: 'ckymxuh8t000137t011w89zgk',
+        privileges: [
+          'Terminate',
+          'Download - Agreement',
+          'Disbursement - Confirmation',
+          'Invoice Payment Received',
+          'Download - Disbursement Receipt',
+          'Download - Stamping Receipt',
+          'Installment Payment Received',
+          'View Transaction History',
+          'Menu - Loans',
+          'Loan - Full Settlement',
+          'View Billing',
+          'Loan - Retrieve List',
+          'Loan - View Details',
+          'Loan - Retrieve Outstanding',
+          'Loan - View Mandate Details',
+          'Loan Document - Retrieve List',
+          'Loan Document - View',
+          'Loan Document - Download',
+          'Application - View Details',
+          'Simple Loan Schedule - Get Overdue Schedules',
+          'Simple Loan Schedule - Get Schedule Payment Details',
+          'Retrieve Media List',
+          'Retrieve Customer List',
+          'View Loan Activity',
+          'Activate Installment',
+          'Manual Payment Receipt',
+          'Customer Documents - View',
+        ],
+      },
+    ],
+  };
+
+  jest.mock('crypto', () => {
+    return {
+      randomUUID: jest.fn().mockReturnValue('ckymxuh8t000137t011w89zgk'),
+    };
+  });
+
+  jest
+    .spyOn(UserRepository.prototype, 'findOne')
+    .mockImplementation(async () => {
+      return user;
+    });
+
+  jest
+    .spyOn(PasswordHashService.prototype, 'verify')
+    .mockImplementation(async (password, hash) => {
+      if (password === 'Abcd@1234') {
+        return true;
+      } else {
+        return false;
+      }
+    });
+
+  jest
+    .spyOn(SystemRepository .prototype, 'findOne')
+    .mockImplementation(async () => {
+      return system;
+    });
+
+  jest
+    .spyOn(MailService.prototype, 'sendNewLoginAlertEmail')
+    .mockImplementation(async () => {});
+
+  jest
+    .spyOn(LoginUser.prototype, 'getPrivileges')
+    .mockImplementation(async () => {
+      return session.systemLogins[0].privileges;
+    });
+
+  jest
+    .spyOn(SystemAccessRepository.prototype, 'findOne')
+    .mockImplementation(async () => {
+      return systemAccess;
+    });
+
+  jest
+  .spyOn(LoginHistoryRepository.prototype, 'findAll')
+  .mockImplementation(async () => {
+      const data = [];
+      return data;
+  })
+
+  it('should return login-user service when instansiated', async () => {
+    const loginUser = await LoginUser.init();
+    expect(loginUser).toBeDefined();
+  });
+
+  it('should able to do login process when no session is already available', async () => {
+    const loginUser = await LoginUser.init('755');
+    const result = await loginUser.login(
+      'EZC',
+      'ezcash+florence@tomei.com.my',
+      'Abcd@1234',
+      '1.1.1.1',
+    );
+    expect(result).toEqual('ckymxuh8t000137t011w89zgk');
+  });
+
+  it('should able to do login process when session is already available', async () => {
+    jest
+      .spyOn(SessionService.prototype, 'retrieveUserSession')
+      .mockImplementationOnce(async (userId: string) => {
+        if (userId === '755') {
+          return session;
+        } else {
+          return {
+            systemLogins: [],
+          };
+        }
+      });
+
+    const loginUser = await LoginUser.init('755');
+    const result = await loginUser.login(
+      'EZC',
+      'ezcash+florence@tomei.com.my',
+      'Abcd@1234',
+      '1.1.1.1',
+    );
+    expect(result).toEqual('ckymxuh8t000137t011w89zgk');
+  });
+});

package/__tests__/unit/components/login-user/user.repository.spec.ts

@@ -0,0 +1,81 @@
+import { UserRepository } from '../../../../src/components/login-user/user.repository';
+import { prismaMock } from '../../../../src/prisma-client/__mocks__/prisma';
+
+describe('system-access.repository', () => {
+  const data = {
+    id: 1,
+    email: 'test@test.email.com',
+    password: '@H34f5yRE',
+    status: 'Active',
+    defaultPasswordChanged: false,
+    firstLoginAt: new Date(),
+    createdAt: new Date(),
+    updatedAt: new Date(),
+    groupCode: 'RDAS',
+  };
+
+  afterEach(() => {
+    jest.restoreAllMocks();
+  });
+  describe('findAll', () => {
+    it('should return list of user', async () => {
+      prismaMock.user.findMany.mockResolvedValueOnce([data]);
+      const userRepository = new UserRepository();
+      expect(await userRepository.findAll({})).toEqual([data]);
+    });
+  });
+
+  describe('findOne', () => {
+    it('should return user', async () => {
+      prismaMock.user.findFirst.mockResolvedValueOnce(data);
+      const userRepository = new UserRepository();
+      expect(
+        await userRepository.findOne({
+          where: {
+            id: data.id,
+          },
+        }),
+      ).toEqual(data);
+    });
+  });
+
+  describe('create', () => {
+    it('should create user', async () => {
+      prismaMock.user.create.mockResolvedValueOnce(data);
+      const userRepository = new UserRepository();
+      expect(await userRepository.create(data)).toEqual(data);
+    });
+  });
+
+  describe('update', () => {
+    it('should update user', async () => {
+      prismaMock.user.update.mockResolvedValueOnce(data);
+      const userRepository = new UserRepository();
+      expect(
+        await userRepository.update(
+          {
+            where: {
+              id: data.id,
+            },
+            data: data,
+          },
+          data,
+        ),
+      ).toEqual(data);
+    });
+  });
+
+  describe('delete', () => {
+    it('should delete user', async () => {
+      prismaMock.user.delete.mockResolvedValueOnce(data);
+      const userRepository = new UserRepository();
+      expect(
+        await userRepository.delete({
+          where: {
+            id: data.id,
+          },
+        }),
+      ).toEqual(data);
+    });
+  });
+});

package/__tests__/unit/components/password-hash/password-hash.service.spec.ts

@@ -0,0 +1,33 @@
+import { PasswordHashService } from "../../../../src/components/password-hash/password-hash.service";
+import * as argon2 from 'argon2';
+
+jest.mock('argon2', () => {
+    return {
+        hash: jest.fn((passowrd) => {
+            return `hash${passowrd}`;
+        }),
+        verify: jest.fn().mockResolvedValue(true)
+    }
+})
+
+describe('password-hash.service', () => {
+    const passwordHashService = new PasswordHashService();
+    afterEach(() => {
+        jest.clearAllMocks();
+    });
+
+    it('should return hash password', async () => {
+        const password = 'password';
+        const hash = await  passwordHashService.hashPassword(password);
+        expect(hash).toEqual('hashpassword');
+    })
+
+    it('should return true when verify password', async () => {
+        const password = 'password';
+        const hash = 'hashpassword10';
+        const result = await passwordHashService.verify(password, hash);
+        expect(result).toEqual(true);
+    });
+
+
+})

package/__tests__/unit/components/system/system.repository.spec.ts

@@ -0,0 +1,88 @@
+import { SystemRepository } from '../../../../src/components/system/system.repository';
+import { prismaMock } from '../../../../src/prisma-client/__mocks__/prisma';
+
+describe('system.repository', () => {
+  const data = {
+    id: 175,
+    code: 'EZC',
+    name: 'EzCash',
+    description: 'Tomei Money Lending System',
+    accessUrl: 'https://app.ezcash.com.my:22443/staff/login',
+    googlePlayUrl: '',
+    appleStoreUrl: '',
+    apiKey: 'f3fef257jt',
+    logo: 'https://sso-api.tomei.com.my/upload/2023/01/10/FJ3DoHdRZKjf2bGkgA4E-BrowserIcon.png',
+    status: 'active',
+    visible: true,
+    createdAt: new Date(),
+    updatedAt: new Date(),
+    apiSecret: '12345',
+    updatedById: 61,
+    createdById: 100,
+  };
+
+  afterEach(() => {
+    jest.restoreAllMocks();
+  });
+  describe('findAll', () => {
+    it('should return list of system', async () => {
+      prismaMock.system.findMany.mockResolvedValueOnce([data]);
+      const systemRepository = new SystemRepository();
+      expect(await systemRepository.findAll({})).toEqual([data]);
+    });
+  });
+
+  describe('findOne', () => {
+    it('should return system', async () => {
+      prismaMock.system.findFirst.mockResolvedValueOnce(data);
+      const systemRepository = new SystemRepository();
+      expect(
+        await systemRepository.findOne({
+          where: {
+            id: data.id,
+          },
+        }),
+      ).toEqual(data);
+    });
+  });
+
+  describe('create', () => {
+    it('should create system', async () => {
+      prismaMock.system.create.mockResolvedValueOnce(data);
+      const systemRepository = new SystemRepository();
+      expect(await systemRepository.create(data)).toEqual(data);
+    });
+  });
+
+  describe('update', () => {
+    it('should update system', async () => {
+      prismaMock.system.update.mockResolvedValueOnce(data);
+      const systemRepository = new SystemRepository();
+      expect(
+        await systemRepository.update(
+          {
+            where: {
+              id: data.id,
+            },
+            data: data,
+          },
+          data,
+        ),
+      ).toEqual(data);
+    });
+  });
+
+  describe('delete', () => {
+    it('should delete system', async () => {
+      prismaMock.system.delete.mockResolvedValueOnce(data);
+      const systemRepository = new SystemRepository();
+      expect(
+        await systemRepository.delete({
+          where: {
+            id: data.id,
+          },
+        }),
+      ).toEqual(data);
+    });
+  });
+});

package/__tests__/unit/components/system-access/system-access.repository.spec.ts

@@ -0,0 +1,78 @@
+import { SystemAccessRepository } from '../../../../src/components/system-access/system-access.repository';
+import { prismaMock } from '../../../../src/prisma-client/__mocks__/prisma';
+
+describe('system-access.repository', () => {
+  const data = {
+    userId: 1,
+    systemId: 175,
+    updatedAt: new Date(),
+  };
+
+  afterEach(() => {
+    jest.restoreAllMocks();
+  });
+  describe('findAll', () => {
+    it('should return list of system access', async () => {
+      prismaMock.systemAccess.findMany.mockResolvedValueOnce([data]);
+      const systemAccessRepository = new SystemAccessRepository();
+      expect(await systemAccessRepository.findAll({})).toEqual([data]);
+    });
+  });
+
+  describe('findOne', () => {
+    it('should return system access', async () => {
+      prismaMock.systemAccess.findFirst.mockResolvedValueOnce(data);
+      const systemAccessRepository = new SystemAccessRepository();
+      expect(
+        await systemAccessRepository.findOne({
+          where: {
+            userId: data.userId,
+            systemId: data.systemId,
+          },
+        }),
+      ).toEqual(data);
+    });
+  });
+
+  describe('create', () => {
+    it('should create system access', async () => {
+      prismaMock.systemAccess.create.mockResolvedValueOnce(data);
+      const systemAccessRepository = new SystemAccessRepository();
+      expect(await systemAccessRepository.create(data)).toEqual(data);
+    });
+  });
+
+  describe('update', () => {
+    it('should update system access', async () => {
+      prismaMock.systemAccess.update.mockResolvedValueOnce(data);
+      const systemAccessRepository = new SystemAccessRepository();
+      expect(
+        await systemAccessRepository.update(
+          {
+            where: {
+              userId: data.userId,
+              systemId: data.systemId,
+            },
+            data: data,
+          },
+          data,
+        ),
+      ).toEqual(data);
+    });
+  });
+
+  describe('delete', () => {
+    it('should delete system access', async () => {
+      prismaMock.systemAccess.delete.mockResolvedValueOnce(data);
+      const systemAccessRepository = new SystemAccessRepository();
+      expect(
+        await systemAccessRepository.delete({
+          where: {
+            userId: data.userId,
+            systemId: data.systemId,
+          },
+        }),
+      ).toEqual(data);
+    });
+  });
+});

package/__tests__/unit/redis-client/redis.service.spec.ts

@@ -0,0 +1,24 @@
+import { RedisService } from "../../../src/redis-client/redis.service"; 
+require('dotenv').config()
+// nneed to figure out how to mock redis
+describe('redis.service', () => {
+
+    afterEach(() => {
+        jest.restoreAllMocks()
+      })
+
+    it('should return redis service when instansiated', async () => {
+        const redisService = await RedisService.init();
+        expect(redisService).toBeDefined();
+    });
+
+    it('should able to write and read redis', async () => {
+        const data = {
+            test: 'test'
+        }
+        const redisService = await RedisService.init();        
+        await redisService.set("test", data, 60 * 60 * 24 * 1)
+        const result = await redisService.get("test");
+        expect(result).toEqual(JSON.stringify(data));
+    });
+});

package/__tests__/unit/session/session.service.spec.ts

@@ -0,0 +1,27 @@
+import { IUserSession } from '../../../src/interfaces/user-session.interface';
+import { SessionService } from '../../../src/session/session.service';
+require('dotenv').config()
+
+describe('session.service', () => {
+  it('should return session service when instansiated', async () => {
+    const sessionService = await SessionService.init();
+    expect(sessionService).toBeDefined();
+  });
+
+  it('should able to write session data', async () => {
+    const data: IUserSession = {
+      systemLogins: [
+        {
+          id: '1',
+          code: 'EZC',
+          sessionId: 'test1',
+          privileges: ['PRIVILEGE1', 'PRIVILEGE2'],
+        },
+      ],
+    };
+    const sessionService = await SessionService.init();
+    await sessionService.setUserSession("1", data)
+    const result = await sessionService.retrieveUserSession("1");
+    expect(result).toEqual(data);
+  });
+});

package/create-sso-user.sql

@@ -32,6 +32,7 @@ GRANT CREATE, ALTER, DROP, INSERT, UPDATE, DELETE, SELECT, REFERENCES on product
 GRANT CREATE, ALTER, DROP, INSERT, UPDATE, DELETE, SELECT, REFERENCES on production.sso_users  TO 'sso_user'@'localhost' WITH GRANT OPTION;
 GRANT CREATE, ALTER, DROP, INSERT, UPDATE, DELETE, SELECT, REFERENCES on production.sso_usersystemprivilege  TO 'sso_user'@'localhost' WITH GRANT OPTION;
 GRANT CREATE, ALTER, DROP, INSERT, UPDATE, DELETE, SELECT, REFERENCES on production.sso_usersystemrole  TO 'sso_user'@'localhost' WITH GRANT OPTION;
+GRANT CREATE, ALTER, DROP, INSERT, UPDATE, DELETE, SELECT, REFERENCES on production.sso_UserUserGroup  TO 'sso_user'@'localhost' WITH GRANT OPTION;
 GRANT CREATE, ALTER, DROP, INSERT, UPDATE, DELETE, SELECT, REFERENCES on production._prisma_migrations  TO 'sso_user'@'localhost' WITH GRANT OPTION;
 
 

package/dist/__tests__/unit/components/login-user/login-user.spec.d.ts

@@ -0,0 +1 @@
+export {};