Merge pull request #26 from icapps/bugfix/SIAP-144-roles-users

Bugfix/siap 144 roles users

docs/v1.yml

@@ -540,7 +540,6 @@ paths:
           description: "401 Unauthorized"
           schema:
             $ref: "#/definitions/ErrorResponse"
-  /meta/codes/{codeType}:
     post:
       tags:
       - "metaOptions"
@@ -635,8 +634,7 @@ definitions:
         hasAccess:
           type: boolean
         role:
-          type: string
-          enum: ["USER", "ADMIN"]
+          $ref: "#/definitions/UserRole"
         createdAt:
           type: string
         updatedAt:

src/lib/utils.ts

@@ -8,8 +8,15 @@ import { errors } from '../config/errors.config';
  * Check whether a user has the correct role level or higher
  */
 export function hasRole(user: User, role: Role): boolean {
-  const userRole = roles[Object.keys(roles).find(x => roles[x].code === user.role)];
-  return userRole.level >= role.level;
+  return user.role.level >= role.level;
+}
+
+
+/**
+ * Find a user role by code
+ */
+export function findRoleByCode(code: string): Role {
+  return roles[Object.keys(roles).find(x => roles[x].code === code)];
 }
 
 

src/models/user.model.ts

@@ -6,7 +6,7 @@ export interface User {
   password: string;
   hasAccess: boolean;
   registrationCompleted: boolean;
-  role: string; // Code of role
+  role: UserRole;
   refreshToken?: string;
   resetPwToken?: string;
   createdAt: string;
@@ -42,3 +42,10 @@ export interface PartialUserUpdate {
   resetPwToken?: string;
   refreshToken?: string;
 }
+
+export interface UserRole {
+  name: string;
+  code: string;
+  description?: string;
+  level: number;
+}

src/repositories/user.repository.ts

@@ -1,11 +1,13 @@
+import { getHashedPassword } from 'tree-house-authentication';
 import { db, selectAndCount, parseTotalCount } from '../lib/db';
 import { settings } from '../config/app.config';
 import { logger } from '../lib/logger';
 import { Filters } from '../models/filters.model';
+import { User, UserUpdate, UserCreate, PartialUserUpdate } from '../models/user.model';
+import { findRoleByCode } from '../lib/utils';
 import { applyPagination, applySorting, applySearch } from '../lib/filter';
 import { tableNames, defaultFilters } from '../constants';
-import { User, UserUpdate, UserCreate, PartialUserUpdate } from '../models/user.model';
-import { getHashedPassword } from 'tree-house-authentication';
+
 const defaultReturnValues = ['id', 'email', 'password', 'firstName', 'lastName',
   'hasAccess', 'registrationCompleted', 'role', 'refreshToken', 'resetPwToken', 'createdAt', 'updatedAt'];
 
@@ -21,7 +23,8 @@ export async function create(values: UserCreate): Promise<User> {
     .insert(valuesToInsert, defaultReturnValues);
 
   logger.debug(`Create new user: ${query.toString()}`);
-  return (await query)[0];
+  const data = (await query)[0];
+  return data ? Object.assign(data, { role: findRoleByCode(data.role) }) : undefined; // Add full role object
 }
 
 
@@ -34,7 +37,8 @@ export async function update(userId: string, values: UserUpdate | PartialUserUpd
     .where('id', userId);
 
   logger.debug(`Update existing user: ${query.toString()}`);
-  return (await query)[0];
+  const data = (await query)[0];
+  return data ? Object.assign(data, { role: findRoleByCode(data.role) }) : undefined; // Add full role object
 }
 
 
@@ -76,7 +80,7 @@ export async function findAll(options: Filters = {}): Promise<{ data: User[], to
   applySorting(query, allOptions, sortFields);
   logger.debug(`Get all users: ${query.toString()}`);
 
-  const data = await query;
+  const data = (await query).map(x => Object.assign(x, { role: findRoleByCode(x.role) })); // Add full role object
   return { data, totalCount: parseTotalCount(data) };
 }
 
@@ -91,7 +95,8 @@ export async function findById(id: string): Promise<User> {
     .first();
 
   logger.debug(`Get user by id: ${query.toString()}`);
-  return await query;
+  const data = await query;
+  return data ? Object.assign(data, { role: findRoleByCode(data.role) }) : undefined; // Add full role object
 }
 
 
@@ -105,7 +110,8 @@ export async function findByEmail(email: string): Promise<User | undefined> {
     .first();
 
   logger.debug(`Get user by email: ${query.toString()}`);
-  return await query;
+  const data = await query;
+  return data ? Object.assign(data, { role: findRoleByCode(data.role) }) : undefined; // Add full role object
 }
 
 

src/schemes/user.schema.ts

@@ -1,4 +1,7 @@
 import * as Joi from 'joi';
+import { roles } from '../config/roles.config';
+
+const availableRoles = Object.keys(roles).reduce((array, current) => [...array, roles[current].code], []); // Collection to array
 
 export const userSchema = {
   findAllUsers: {
@@ -24,7 +27,7 @@ export const userSchema = {
       firstName: Joi.string().required(),
       lastName: Joi.string().required(),
       hasAccess: Joi.boolean().required(),
-      role: Joi.string().required(),
+      role: Joi.string().required().allow(availableRoles),
       password: Joi.string(),
     }),
   },
@@ -37,7 +40,7 @@ export const userSchema = {
       firstName: Joi.string().required(),
       lastName: Joi.string().required(),
       hasAccess: Joi.boolean().required(),
-      role: Joi.string().required(),
+      role: Joi.string().required().allow(availableRoles),
     }),
   },
   updatePassword: {
@@ -57,7 +60,7 @@ export const userSchema = {
       firstName: Joi.string(),
       lastName: Joi.string(),
       hasAccess: Joi.boolean(),
-      role: Joi.string(),
+      role: Joi.string().allow(availableRoles),
     }),
   },
   remove: {

src/serializers/user.serializer.ts

@@ -13,4 +13,12 @@ export const userSerializer = new Serializer('users', {
     'createdAt',
     'updatedAt',
   ],
+  role: {
+    attributes: [
+      'name',
+      'code',
+      'description',
+      'level',
+    ],
+  },
 });

tests/_helpers/payload-schemes/user.schema.ts

@@ -3,16 +3,23 @@ import { roles } from '../../../src/config/roles.config';
 
 const roleNames = Object.keys(roles).reduce((acc, current: any) => [...acc, roles[current].code], []);
 
+export const userRoleSchema = Joi.object({
+  name: Joi.string().required(),
+  code: Joi.string().required().allow(roleNames),
+  description: Joi.string(),
+  level: Joi.number().required(),
+});
+
 export const userSchema = Joi.object({
   id: Joi.string().guid().required(),
   email: Joi.string().required(),
   firstName: Joi.string().required(),
   lastName: Joi.string().required(),
   hasAccess: Joi.boolean().required(),
   registrationCompleted: Joi.boolean().required(),
-  role: Joi.string().required().valid(roleNames),
-  createdAt: Joi.date().iso().raw(),
-  updatedAt: Joi.date().iso().raw(),
+  role: userRoleSchema,
+  createdAt: Joi.date().iso().raw().required(),
+  updatedAt: Joi.date().iso().raw().required(),
 });
 
 export const createUserSchema = Joi.object().keys({

tests/integration/user.route.test.ts

@@ -11,6 +11,7 @@ import { rolesSchema } from '../_helpers/payload-schemes/role.schema';
 import { getValidJwt, getAdminToken, getUserToken } from '../_helpers/mockdata/auth.data';
 import { roles } from '../../src/config/roles.config';
 import { errors } from '../../src/config/errors.config';
+import { findRoleByCode } from '../../src/lib/utils';
 import * as mailer from '../../src/lib/mailer';
 
 describe('/users', () => {
@@ -191,8 +192,9 @@ describe('/users', () => {
         firstName: user.firstName,
         lastName: user.lastName,
         hasAccess: user.hasAccess,
-        role: user.role,
+        role: findRoleByCode(user.role.code),
       });
+
       Joi.validate(body, userByIdSchema, (err, value) => {
         if (err) throw err;
         if (!value) throw new Error('no value to check schema');
@@ -395,7 +397,7 @@ describe('/users', () => {
         lastName: 'Unknown',
         password: expect.any(String),
         hasAccess: false,
-        role: roles.ADMIN.code,
+        role: findRoleByCode(roles.ADMIN.code),
       });
     });
 

tests/lib/utils.test.ts

@@ -9,23 +9,23 @@ describe('lib/utils', () => {
   describe('hasRole', () => {
     it('Should return true when the user has the correct role', () => {
       const user = <User>{
-        role: roles.ADMIN.code,
+        role: roles.ADMIN,
       };
       const hasRole = utils.hasRole(user, roles.ADMIN);
       expect(hasRole).toEqual(true);
     });
 
     it('Should return true when the user has a higher role than required', () => {
       const user = <User>{
-        role: roles.SUPERUSER.code,
+        role: roles.SUPERUSER,
       };
       const hasRole = utils.hasRole(user, roles.ADMIN);
       expect(hasRole).toEqual(true);
     });
 
     it('Should return false when the user has a lower role than required', () => {
       const user = <User>{
-        role: roles.USER.code,
+        role: roles.USER,
       };
       const hasRole = utils.hasRole(user, roles.ADMIN);
       expect(hasRole).toEqual(false);