enhanced function to reduce input parameter using types

Author: sadabnepal

readme.md

@@ -97,8 +97,8 @@ Sample Report
 
 ### GraphQL Topics to Explore
  - [x] basics of GraphQL (query, mutation)
- - [ ] advance topics (fragments, directive, unions, aliases)
- - [ ] parameterize query with arguments and variables
+ - [ ] advance topics (fragments, unions, aliases)
+ - [ ] filters using arguments, variables, directive
  - [ ] setting default variable
  - [ ] variables inside fragments
  - [ ] use of directive to build dynamic/reusable query

tests/data/faker.ts

@@ -1,16 +1,19 @@
 import { faker } from '@faker-js/faker';
-import { genderType, statusType } from '../types/faker';
+import { IUser, IUserOmittedID } from '../types/users';
 
-export const createUserData = {
+export const createUserData: IUserOmittedID = {
     name: faker.person.fullName(),
-    gender: 'male' as genderType,
+    gender: faker.person.sexType(),
     email: faker.internet.email(),
-    status: 'active' as statusType
+    status: 'active'
 };
 
-export const updateUserData = {
-    name: faker.person.fullName(),
-    gender: 'female' as genderType,
-    email: faker.internet.email(),
-    status: 'active' as statusType
+export const updateUserData = (userId: number): IUser => {
+    return {
+        id: userId,
+        name: faker.person.fullName(),
+        gender: faker.person.sexType(),
+        email: faker.internet.email(),
+        status: 'active'
+    }
 };

tests/payload/mutation.ts

@@ -1,11 +1,13 @@
-export const createUserPayload = (name: string, gender: 'male' | 'female', email: string, status: 'active' | 'inactive') => {
+import { IUser, IUserOmittedID } from "../types/users";
+
+export const createUserPayload = (data: IUserOmittedID) => {
     return `mutation {
         createUser(
             input: {
-                name: "${name}"
-                gender: "${gender}"
-                email: "${email}"
-                status: "${status}"
+                name: "${data.name}"
+                gender: "${data.gender}"
+                email: "${data.email}"
+                status: "${data.status}"
             }
         ) {
             user {
@@ -20,15 +22,15 @@ export const createUserPayload = (name: string, gender: 'male' | 'female', email
 };
 
 
-export const updateUserPayload = (id: number, name: string, gender: 'male' | 'female', email: string, status: 'active' | 'inactive') => {
+export const updateUserPayload = (data: IUser) => {
     return `mutation {
         updateUser(
             input: {
-                id: ${id}
-                name: "${name}"
-                gender: "${gender}"
-                email: "${email}"
-                status: "${status}"
+                id: ${data.id}
+                name: "${data.name}"
+                gender: "${data.gender}"
+                email: "${data.email}"
+                status: "${data.status}"
             }
         ) {
             user {
@@ -42,7 +44,7 @@ export const updateUserPayload = (id: number, name: string, gender: 'male' | 'fe
     }`;
 };
 
-export const deleteUserPayload = (id: string | number) => {
+export const deleteUserPayload = (id: number) => {
     return `mutation {
         deleteUser(
             input: {

tests/payload/queries.ts

@@ -11,7 +11,7 @@ export const queryAllUserPayload = `{
     }
 }`;
 
-export const queryUserByIdPayload = (id: string | number) => {
+export const queryUserByIdPayload = (id: number) => {
     return `query User {
         user(id: "${id}") {
             email

tests/specs/goRestTests.ts

@@ -10,6 +10,8 @@ config();
 
 const TOKEN = process.env.GO_RES_USER_TOKEN;
 
+const createRandomUser = createUserData;
+
 describe('go rest graphql tests', () => {
 
     let userId: number;
@@ -36,7 +38,7 @@ describe('go rest graphql tests', () => {
 
     it('should create user', async () => {
 
-        const response = await mutateGraphQl(TOKEN, createUserPayload(createUserData.name, createUserData.gender, createUserData.email, createUserData.status));
+        const response = await mutateGraphQl(TOKEN, createUserPayload(createRandomUser));
         expect(response.statusCode).equal(200);
 
         const responseData: IUserCreate = response.body.data;
@@ -48,10 +50,10 @@ describe('go rest graphql tests', () => {
 
         expect(responseData.createUser).not.to.be.null;
         expect(responseData.createUser.user.id).a('number').to.be.not.null;
-        expect(responseData.createUser.user.name).equal(createUserData.name);
-        expect(responseData.createUser.user.gender).equal(createUserData.gender);
-        expect(responseData.createUser.user.email).equal(createUserData.email);
-        expect(responseData.createUser.user.status).equal(createUserData.status);
+        expect(responseData.createUser.user.name).equal(createRandomUser.name);
+        expect(responseData.createUser.user.gender).equal(createRandomUser.gender);
+        expect(responseData.createUser.user.email).equal(createRandomUser.email);
+        expect(responseData.createUser.user.status).equal(createRandomUser.status);
     });
 
     it('should query user by id', async () => {
@@ -67,16 +69,17 @@ describe('go rest graphql tests', () => {
         console.log('----------------------------');
 
         expect(user.id).a('number');
-        expect(user.name).equal(createUserData.name);
-        expect(user.email).equal(createUserData.email);
-        expect(user.gender).equal(createUserData.gender);
-        expect(user.status).equal(createUserData.status);
-
+        expect(user.name).equal(createRandomUser.name);
+        expect(user.email).equal(createRandomUser.email);
+        expect(user.gender).equal(createRandomUser.gender);
+        expect(user.status).equal(createRandomUser.status);
     });
 
     it('should update user by id', async () => {
 
-        const response = await queryGraphQl(TOKEN, updateUserPayload(userId, updateUserData.name, updateUserData.gender, updateUserData.email, updateUserData.status));
+        const payload = updateUserData(userId);
+
+        const response = await queryGraphQl(TOKEN, updateUserPayload(payload));
         expect(response.statusCode).equal(200);
 
         expect(response.body.data).not.undefined;
@@ -89,10 +92,10 @@ describe('go rest graphql tests', () => {
 
         expect(responseData.updateUser).not.to.be.null;
         expect(responseData.updateUser.user.id).equal(userId);
-        expect(responseData.updateUser.user.name).equal(updateUserData.name);
-        expect(responseData.updateUser.user.gender).equal(updateUserData.gender);
-        expect(responseData.updateUser.user.email).equal(updateUserData.email);
-        expect(responseData.updateUser.user.status).equal(updateUserData.status);
+        expect(responseData.updateUser.user.name).equal(payload.name);
+        expect(responseData.updateUser.user.gender).equal(payload.gender);
+        expect(responseData.updateUser.user.email).equal(payload.email);
+        expect(responseData.updateUser.user.status).equal(payload.status);
 
     });
 
@@ -110,10 +113,6 @@ describe('go rest graphql tests', () => {
 
         expect(responseData.deleteUser).not.to.be.null;
         expect(responseData.deleteUser.user.id).equal(userId);
-        expect(responseData.deleteUser.user.name).equal(updateUserData.name);
-        expect(responseData.deleteUser.user.gender).equal(updateUserData.gender);
-        expect(responseData.deleteUser.user.email).equal(updateUserData.email);
-        expect(responseData.deleteUser.user.status).equal(updateUserData.status);
     });
 
     it('should query non existing user by id', async () => {

tests/types/faker.ts

@@ -1,9 +1,15 @@
+export type genderType = 'male' | 'female';
+
+export type statusType = 'active' | 'inactive';
+
+export interface IUserOmittedID extends Omit<IUser, 'id'> { }
+
 export interface IUser {
     id: number;
     name: string;
     email: string;
-    gender: string;
-    status: string;
+    gender: genderType;
+    status: statusType;
 }
 
 export interface IUsers {