Support virtual options.match

[Manjiz]

Do you want to request a feature or report a bug?

BUG

What is the current behavior?

Schema.prototype.virtual

options.options.match or options.match not working.

Workaround: add match to populate options.

If the current behavior is a bug, please provide the steps to reproduce.

const projectSchema = new Schema({
  group: { type: Schema.Types.ObjectId, ref: 'Group' }
})
mongoose.model('Project', projectSchema, 'Project')

const groupSchema = new Schema({
})
groupSchema.virtual('projects', {
  ref: 'Project',
  localField: '_id',
  foreignField: 'group',
  justOne: false,
  // @todo not working
  options: {
    match: {
      status: { $ne: '-1' }
    }
  }
})
const groupModel = mongoose.model('Group', groupSchema, 'Group')

groupModel.findOne().populate({ path: 'projects' })

What is the expected behavior?

Exclude some project in projects.

What are the versions of Node.js, Mongoose and MongoDB you are using? Note that "latest" is not a version.

NodeJS12.12.0 Mongoose5.9.7

[vkarpov15]

I'm unable to repro this issue, the below script demonstrates that match filters out projects whose status is equal to the string '-1':

'use strict';
  
const mongoose = require('mongoose');

mongoose.set('useFindAndModify', false);
mongoose.set('debug', true);

const { Schema } = mongoose;

run().catch(err => console.log(err));

async function run() {
  await mongoose.connect('mongodb://localhost:27017/test', {
    useNewUrlParser: true,
    useUnifiedTopology: true
  });

  await mongoose.connection.dropDatabase();

  const projectSchema = new Schema({
    group: { type: Schema.Types.ObjectId, ref: 'Group' },
    status: String
  });
  const Project = mongoose.model('Project', projectSchema, 'Project');

  const groupSchema = new Schema({})
  groupSchema.virtual('projects', {
    ref: 'Project',
    localField: '_id',
    foreignField: 'group',
    justOne: false,
    // @todo not working
    options: {
      match: {
        status: { $ne: '-1' }
      }
    }
  });
  const groupModel = mongoose.model('Group', groupSchema, 'Group');

  const g = await groupModel.create({});
  await Project.create({ status: 'foo', group: g });
  await Project.create({ status: '-1', group: g });

  const doc = await groupModel.findOne().populate({ path: 'projects' });
  console.log(doc.toObject({ virtuals: true }));
}

Output:

$ node gh-8749.js 
Mongoose: Group.insertOne({ _id: ObjectId("5e8c7e98be197c2ee66ba5f9"), __v: 0 }, { session: null })
Mongoose: Project.insertOne({ _id: ObjectId("5e8c7e98be197c2ee66ba5fa"), status: 'foo', group: ObjectId("5e8c7e98be197c2ee66ba5f9"), __v: 0 }, { session: null })
Mongoose: Project.insertOne({ _id: ObjectId("5e8c7e99be197c2ee66ba5fb"), status: '-1', group: ObjectId("5e8c7e98be197c2ee66ba5f9"), __v: 0 }, { session: null })
Mongoose: Group.findOne({}, { projection: {} })
Mongoose: Project.find({ status: { '$ne': '-1' }, group: { '$in': [ ObjectId("5e8c7e98be197c2ee66ba5f9") ] } }, { skip: undefined, limit: undefined, perDocumentLimit: undefined, match: { status: { '$ne': '-1' } }, projection: {} })
{ _id: 5e8c7e98be197c2ee66ba5f9,
  __v: 0,
  projects:
   [ { _id: 5e8c7e98be197c2ee66ba5fa,
       status: 'foo',
       group: 5e8c7e98be197c2ee66ba5f9,
       __v: 0,
       id: '5e8c7e98be197c2ee66ba5fa' } ],
  id: '5e8c7e98be197c2ee66ba5f9' }
^C

Please modify the above script to demonstrate the issue you're seeing.

[jonasbetareader]

I'm using typescript and getting a type unassignable error when trying to use options.match:

userSchema.virtual('bookCount', {
  ref: 'Book',
  localField: 'book',
  foreignField: '_id',
  options: {
    match: {
      listed: true,
    }
  },
  count: true
});

gives me:

Type '{ match: { listed: true; }; }' is not assignable to type 'QueryOptions'.
  Object literal may only specify known properties, and 'match' does not exist in type 'QueryOptions'.ts(2322)

If match should work in virtuals, is there something missing in the typescript declarations?

[vkarpov15]

Fixed by 5c0140c, I typo-ed the issue number in the commit message.