Added test case to validate populate functionality

README.md

@@ -348,6 +348,7 @@ The `options` param can have the following (optional) fields:
 
 ```javascript
 const options = {
+  populate: 'manager', //populate manager
   sortBy: 'name:desc', // sort order
   limit: 5, // maximum results per page
   page: 2, // page number

src/controllers/user.controller.js

@@ -11,7 +11,7 @@ const createUser = catchAsync(async (req, res) => {
 
 const getUsers = catchAsync(async (req, res) => {
   const filter = pick(req.query, ['name', 'role']);
-  const options = pick(req.query, ['sortBy', 'limit', 'page']);
+  const options = pick(req.query, ['populate', 'sortBy', 'limit', 'page']);
   const result = await userService.queryUsers(filter, options);
   res.send(result);
 });

src/models/user.model.js

@@ -40,6 +40,10 @@ const userSchema = mongoose.Schema(
       enum: roles,
       default: 'user',
     },
+    manager: {
+      type: mongoose.SchemaTypes.ObjectId,
+      ref: 'User',
+    },
   },
   {
     timestamps: true,

src/services/user.service.js

@@ -19,6 +19,7 @@ const createUser = async (userBody) => {
  * Query for users
  * @param {Object} filter - Mongo filter
  * @param {Object} options - Query options
+ * @param {string} [options.populate] - Populate data fields. Hierarchy of fields should be separated by (.). Multiple sorting criteria should be separated by commas (,)
  * @param {string} [options.sortBy] - Sort option in the format: sortField:(desc|asc)
  * @param {number} [options.limit] - Maximum number of results per page (default = 10)
  * @param {number} [options.page] - Current page (default = 1)

src/validations/user.validation.js

@@ -14,6 +14,7 @@ const getUsers = {
   query: Joi.object().keys({
     name: Joi.string(),
     role: Joi.string(),
+    populate: Joi.string(),
     sortBy: Joi.string(),
     limit: Joi.number().integer(),
     page: Joi.number().integer(),

tests/integration/user.test.js

@@ -343,6 +343,24 @@ describe('User routes', () => {
     });
   });
 
+  test('should return the populated managers', async () => {
+    await insertUsers([admin]);
+    await insertUsers([
+      { ...userOne, manager: admin._id },
+      { ...userTwo, manager: admin._id },
+    ]);
+
+    const res = await request(app)
+      .get('/v1/users')
+      .set('Authorization', `Bearer ${adminAccessToken}`)
+      .query({ populate: 'manager' })
+      .send()
+      .expect(httpStatus.OK);
+
+    expect(res.body.results[1].manager.id).toBe(admin._id.toHexString());
+    expect(res.body.results[2].manager.id).toBe(admin._id.toHexString());
+  });
+
   describe('GET /v1/users/:userId', () => {
     test('should return 200 and the user object if data is ok', async () => {
       await insertUsers([userOne]);