How to use populate function inside a nested object

Question

In my user schema, there is a field as such.

courseTaken: [
    {
      course: {
        type: mongoose.Schema.Types.ObjectId,
        ref: "Course",
      },
      rating: {
        type: Number,
        min: 0,
        max: 5,
        default: 0,
        validate: {
          validator: function (v) {
            return Number.isInteger(v * 2);
          },
          message: "Rating can only be incremented by 0.5",
        },
      },
    },
  ], 

I was doing a route where the user getss the courses he has taken. To do this I was using populate. I was doing something like this:

exports.getClassroom = catchAsync(async (req, res, next) => {
  let t = await req.user.courseTaken.populate("course");
  const classroom = t.courseTaken;
  console.log(t);
  res.status(200).json({
    status: "success",
    classroom,
  });
  next();
});

But, I get the following error:

TypeError: req.user.courseTaken.populate is not a function
    at /Users/vedantamohapatra/msb-academy/api/controllers/userController.js:105:38
    at /Users/vedantamohapatra/msb-academy/api/utils/catchAsync.js:3:7
    at Layer.handle [as handle_request] (/Users/vedantamohapatra/msb-academy/api/node_modules/express/lib/router/layer.js:95:5)
    at next (/Users/vedantamohapatra/msb-academy/api/node_modules/express/lib/router/route.js:144:13)
    at /Users/vedantamohapatra/msb-academy/api/controllers/authController.js:95:3
    at process.processTicksAndRejections (node:internal/process/task_queues:95:5)

Answer 1

The reason for the error is that you are trying to call the populate method on an array, which is not a Mongoose model.

you can use the populate method on the Mongoose model for the User schema, and specify the path option to populate the courseTaken field.

You can try this code:

exports.getClassroom = catchAsync(async (req, res, next) => {
  const user = await User.findById(req.user._id).populate('courseTaken.course');
  const classroom = user.courseTaken;
  res.status(200).json({
    status: "success",
    classroom,
  });
  next();
});