Module
x/mongoose/test/schema.select.test.js
MongoDB object modeling designed to work in an asynchronous environment.
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688'use strict';
/** * Test dependencies. */
const start = require('./common');
const assert = require('assert');const mongoose = start.mongoose;const Schema = mongoose.Schema;
describe('schema select option', function() { let db;
before(function() { db = start(); });
after(async function() { await db.close(); });
beforeEach(() => db.deleteModel(/.*/)); afterEach(() => require('./util').clearTestData(db)); afterEach(() => require('./util').stopRemainingOps(db));
it('excluding paths through schematype', function(done) { const schema = new Schema({ thin: Boolean, name: { type: String, select: false }, docs: [new Schema({ bool: Boolean, name: { type: String, select: false } })] });
const S = db.model('Test', schema); S.create({ thin: true, name: 'the excluded', docs: [{ bool: true, name: 'test' }] }, function(err, s) { assert.ifError(err); assert.equal(s.name, 'the excluded'); assert.equal(s.docs[0].name, 'test');
let pending = 5; const item = s;
function cb(err, s) { pending--;
if (Array.isArray(s)) { s = s[0]; } assert.strictEqual(null, err); assert.equal(s.isSelected('name'), false); assert.equal(s.isSelected('docs.name'), false); assert.strictEqual(undefined, s.name); // we need to make sure this executes absolutely last. if (pending === 1) { S.findOneAndRemove({ _id: item._id }, cb); } if (pending === 0) { done(); } }
S.findById(s).select('-thin -docs.bool').exec(cb); S.find({ _id: s._id }).select('thin docs.bool').exec(cb); S.findById(s, cb); S.findOneAndUpdate({ _id: s._id }, { name: 'changed' }, cb); }); });
it('including paths through schematype', function(done) { const schema = new Schema({ thin: Boolean, name: { type: String, select: true }, docs: [new Schema({ bool: Boolean, name: { type: String, select: true } })] });
const S = db.model('Test', schema); S.create({ thin: true, name: 'the included', docs: [{ bool: true, name: 'test' }] }, function(err, s) { assert.ifError(err); assert.equal(s.name, 'the included'); assert.equal(s.docs[0].name, 'test');
let pending = 4;
function cb(err, s) { pending--;
if (Array.isArray(s)) { s = s[0]; } assert.strictEqual(null, err); assert.strictEqual(true, s.isSelected('name')); assert.strictEqual(true, s.isSelected('docs.name')); assert.equal(s.name, 'the included');
if (pending === 0) { done(); } }
S.findById(s).select('-thin -docs.bool').exec(function(err, res) { cb(err, res); S.find({ _id: s._id }).select('thin docs.bool').exec(function(err, res) { cb(err, res); S.findOneAndUpdate({ _id: s._id }, { thin: false }, function(err, s) { cb(err, s); S.findOneAndRemove({ _id: s._id }, cb); }); }); }); }); });
describe('overriding schematype select options', function() { let selected, excluded, S, E;
before(function() { selected = new Schema({ thin: Boolean, name: { type: String, select: true }, docs: [new Schema({ name: { type: String, select: true }, bool: Boolean })] }); excluded = new Schema({ thin: Boolean, name: { type: String, select: false }, docs: [new Schema({ name: { type: String, select: false }, bool: Boolean })] });
S = db.model('Test1', selected); E = db.model('Test2', excluded); });
describe('works', function() { describe('for inclusions', function() { let s; beforeEach(function(done) { S.create({ thin: true, name: 'the included', docs: [{ name: 'test', bool: true }] }, function(err, s_) { assert.ifError(err); s = s_; assert.equal(s.name, 'the included'); assert.equal(s.docs[0].name, 'test'); done(); }); }); it('with find', function(done) { S.find({ _id: s._id }).select('thin name docs.bool docs.name').exec(function(err, s) { assert.ifError(err); assert.ok(s && s.length > 0, 'no document found'); s = s[0]; assert.strictEqual(true, s.isSelected('name')); assert.strictEqual(true, s.isSelected('thin')); assert.strictEqual(true, s.isSelected('docs.name')); assert.strictEqual(true, s.isSelected('docs.bool')); assert.equal(s.name, 'the included'); assert.equal(s.docs[0].name, 'test'); assert.ok(s.thin); assert.ok(s.docs[0].bool); done(); }); }); it('for findById', function(done) { S.findById(s).select('-name -docs.name').exec(function(err, s) { assert.strictEqual(null, err); assert.equal(s.isSelected('name'), false); assert.equal(s.isSelected('thin'), true); assert.equal(s.isSelected('docs.name'), false); assert.equal(s.isSelected('docs.bool'), true); assert.ok(s.isSelected('docs')); assert.strictEqual(undefined, s.name); assert.strictEqual(undefined, s.docs[0].name); assert.equal(s.thin, true); assert.equal(s.docs[0].bool, true); done(); }); }); it('with findOneAndUpdate', function(done) { S.findOneAndUpdate({ _id: s._id }, { name: 'changed' }, { new: true }).select('thin name docs.bool docs.name').exec(function(err, s) { assert.ifError(err); assert.strictEqual(true, s.isSelected('name')); assert.strictEqual(true, s.isSelected('thin')); assert.strictEqual(true, s.isSelected('docs.name')); assert.strictEqual(true, s.isSelected('docs.bool')); assert.equal(s.name, 'changed'); assert.equal(s.docs[0].name, 'test'); assert.ok(s.thin); assert.ok(s.docs[0].bool); done(); }); }); it('for findByIdAndUpdate', function(done) { S.findByIdAndUpdate(s, { thin: false }, { new: true }).select('-name -docs.name').exec(function(err, s) { assert.strictEqual(null, err); assert.equal(s.isSelected('name'), false); assert.equal(s.isSelected('thin'), true); assert.equal(s.isSelected('docs.name'), false); assert.equal(s.isSelected('docs.bool'), true); assert.strictEqual(undefined, s.name); assert.strictEqual(undefined, s.docs[0].name); assert.equal(s.thin, false); assert.equal(s.docs[0].bool, true); done(); }); }); });
describe('for exclusions', function() { let e; beforeEach(function(done) { E.create({ thin: true, name: 'the excluded', docs: [{ name: 'test', bool: true }] }, function(err, e_) { e = e_; assert.ifError(err); assert.equal(e.name, 'the excluded'); assert.equal(e.docs[0].name, 'test'); done(); }); }); it('with find', function(done) { E.find({ _id: e._id }).select('thin name docs.name docs.bool').exec(function(err, e) { e = e[0]; assert.strictEqual(null, err); assert.equal(e.isSelected('name'), true); assert.equal(e.isSelected('thin'), true); assert.equal(e.isSelected('docs.name'), true); assert.equal(e.isSelected('docs.bool'), true); assert.equal(e.name, 'the excluded'); assert.equal(e.docs[0].name, 'test'); assert.ok(e.thin); assert.ok(e.docs[0].bool); done(); }); }); it('with findById', function(done) { E.findById(e).select('-name -docs.name').exec(function(err, e) { assert.strictEqual(null, err); assert.equal(e.isSelected('name'), false); assert.equal(e.isSelected('thin'), true); assert.equal(e.isSelected('docs.name'), false); assert.equal(e.isSelected('docs.bool'), true); assert.strictEqual(undefined, e.name); assert.strictEqual(undefined, e.docs[0].name); assert.strictEqual(true, e.thin); assert.strictEqual(true, e.docs[0].bool); done(); }); }); it('with findOneAndUpdate', function(done) { E.findOneAndUpdate({ _id: e._id }, { name: 'changed' }, { new: true }).select('thin name docs.name docs.bool').exec(function(err, e) { assert.strictEqual(null, err); assert.equal(e.isSelected('name'), true); assert.equal(e.isSelected('thin'), true); assert.equal(e.isSelected('docs.name'), true); assert.equal(e.isSelected('docs.bool'), true); assert.equal(e.name, 'changed'); assert.equal(e.docs[0].name, 'test'); assert.ok(e.thin); assert.ok(e.docs[0].bool); done(); }); }); it('with findOneAndRemove', function(done) { E.findOneAndRemove({ _id: e._id }).select('-name -docs.name').exec(function(err, e) { assert.strictEqual(null, err); assert.equal(e.isSelected('name'), false); assert.equal(e.isSelected('thin'), true); assert.equal(e.isSelected('docs.name'), false); assert.equal(e.isSelected('docs.bool'), true); assert.strictEqual(undefined, e.name); assert.strictEqual(undefined, e.docs[0].name); assert.strictEqual(true, e.thin); assert.strictEqual(true, e.docs[0].bool); done(); }); }); }); }); });
describe('exclusion in root schema should override child schema', function() { it('works (gh-1333)', function(done) { const m = new mongoose.Mongoose(); const child = new Schema({ name1: { type: String, select: false }, name2: { type: String, select: true } }); const selected = new Schema({ docs: { type: [child], select: false } }); const M = m.model('Test', selected);
const query = M.findOne(); query._applyPaths(); assert.equal(Object.keys(query._fields).length, 1); assert.equal(query._fields['docs.name1'], undefined); assert.equal(query._fields['docs.name2'], undefined); assert.equal(query._fields.docs, 0); done(); });
it('with nested (gh-7945)', function() { const child = new Schema({ name1: { type: String, select: false }, name2: { type: String, select: true } }); const selected = new Schema({ parent: { docs: { type: [child], select: false } } }); const M = db.model('Test', selected);
const query = M.findOne(); query._applyPaths(); assert.equal(Object.keys(query._fields).length, 1); assert.equal(query._fields['parent.docs.name1'], undefined); assert.equal(query._fields['parent.docs.name2'], undefined); assert.equal(query._fields['parent.docs'], 0);
return M.create({ parent: { docs: [{ name1: 'foo', name2: 'bar' }] } }). then(() => query). then(doc => { assert.ok(!doc.parent.docs); }); }); });
it('should not project in discriminator key if projected in implicitly with .$ (gh-9361)', function() { const eventSchema = new Schema({ message: String }, { discriminatorKey: 'kind', _id: false });
const batchSchema = new Schema({ events: [eventSchema] }); batchSchema.path('events').discriminator('Clicked', new Schema({ element: String }, { _id: false })); batchSchema.path('events').discriminator('Purchased', new Schema({ product: String }, { _id: false }));
const MyModel = db.model('Test', batchSchema);
const query = MyModel.find({ 'events.message': 'foo' }).select({ 'events.$': 1 }); query._applyPaths();
assert.equal(Object.keys(query._fields).length, 1); assert.ok(query._fields['events.$']); });
describe('forcing inclusion of a deselected schema path', function() { it('works', function(done) { const excluded = new Schema({ thin: Boolean, name: { type: String, select: false }, docs: [new Schema({ name: { type: String, select: false }, bool: Boolean })] });
const M = db.model('Test', excluded); M.create({ thin: false, name: '1 meter', docs: [{ name: 'test', bool: false }] }, function(err, d) { assert.ifError(err);
M.findById(d) .select('+name +docs.name') .exec(function(err, doc) { assert.ifError(err); assert.equal(doc.thin, false); assert.equal(doc.name, '1 meter'); assert.equal(doc.docs[0].bool, false); assert.equal(doc.docs[0].name, 'test'); assert.equal(d.id, doc.id);
M.findById(d) .select('+name -thin +docs.name -docs.bool') .exec(function(err, doc) { assert.ifError(err); assert.equal(doc.thin, undefined); assert.equal(doc.name, '1 meter'); assert.equal(doc.docs[0].bool, undefined); assert.equal(doc.docs[0].name, 'test'); assert.equal(d.id, doc.id);
M.findById(d) .select('-thin +name -docs.bool +docs.name') .exec(function(err, doc) { assert.ifError(err); assert.equal(doc.thin, undefined); assert.equal(doc.name, '1 meter'); assert.equal(doc.docs[0].bool, undefined); assert.equal(doc.docs[0].name, 'test'); assert.equal(d.id, doc.id);
M.findById(d) .select('-thin -docs.bool') .exec(function(err, doc) { assert.ifError(err); assert.equal(doc.thin, undefined); assert.equal(doc.name, undefined); assert.equal(doc.docs[0].bool, undefined); assert.equal(doc.docs[0].name, undefined); assert.equal(d.id, doc.id); done(); }); }); }); }); }); });
it('works with query.slice (gh-1370)', function(done) { const M = db.model('Test', new Schema({ many: { type: [String], select: false } }));
M.create({ many: ['1', '2', '3', '4', '5'] }, function(err) { if (err) { return done(err); }
const query = M.findOne().select('+many').where('many').slice(2);
query.exec(function(err, doc) { if (err) { return done(err); } assert.equal(doc.many.length, 2); done(); }); }); });
it('ignores if path does not have select in schema (gh-6785)', async function() { const M = db.model('Test', new Schema({ a: String, b: String }));
await M.create({ a: 'foo', b: 'bar' });
const doc = await M.findOne().select('+a'); assert.equal(doc.a, 'foo'); assert.equal(doc.b, 'bar'); });
it('omits if not in schema (gh-7017)', async function() { const M = db.model('Test', new Schema({ a: { type: String, select: false }, b: { type: String, select: false } }), 'Test');
await db.$initialConnection; await db.collection('Test').insertOne({ a: 'foo', b: 'bar', c: 'baz' });
const q = M.find({}).select('+c'); const doc = await q.then(res => res[0]); assert.deepEqual(q._fields, { a: 0, b: 0 });
assert.strictEqual(doc.a, void 0); assert.strictEqual(doc.b, void 0); assert.equal(doc.toObject().c, 'baz'); }); });
it('conflicting schematype path selection should not error', function(done) { const schema = new Schema({ thin: Boolean, name: { type: String, select: true }, conflict: { type: String, select: false } });
const S = db.model('Test', schema); S.create({ thin: true, name: 'bing', conflict: 'crosby' }, function(err, s) { assert.strictEqual(null, err); assert.equal(s.name, 'bing'); assert.equal(s.conflict, 'crosby');
let pending = 2;
function cb(err, s) { if (!--pending) { done(); } if (Array.isArray(s)) { s = s[0]; } assert.ifError(err); assert.equal(s.name, 'bing'); assert.equal(s.conflict, undefined); }
S.findById(s).exec(cb); S.find({ _id: s._id }).exec(cb); }); });
it('selecting _id works with excluded schematype path', function(done) { const schema = new Schema({ name: { type: String, select: false } });
const M = db.model('Test', schema); M.find().select('_id').exec(function(err) { assert.ifError(err, err && err.stack); done(); }); });
it('selecting _id works with excluded schematype path on sub doc', function(done) { const schema = new Schema({ docs: [new Schema({ name: { type: String, select: false } })] });
const M = db.model('Test', schema); M.find().select('_id').exec(function(err) { assert.ifError(err, err && err.stack); done(); }); });
it('all inclusive/exclusive combos work', function(done) { const coll = 'Test';
const schema = new Schema({ name: { type: String }, age: Number }, { collection: coll }); const M = db.model('Test1', schema);
const schema1 = new Schema({ name: { type: String, select: false }, age: Number }, { collection: coll }); const S = db.model('Test2', schema1);
const schema2 = new Schema({ name: { type: String, select: true }, age: Number }, { collection: coll }); const T = db.model('Test3', schema2);
function useId(M, id, cb) { M.findOne().select('-_id name').exec(function(err, d) { // mongo special case for exclude _id + include path assert.ifError(err); assert.equal(d.id, undefined); assert.equal(d.name, 'ssd'); assert.equal(d.age, undefined); M.findOne().select('-_id -name').exec(function(err, d) { assert.ifError(err); assert.equal(d.id, undefined); assert.equal(d.name, undefined); assert.equal(d.age, 0); M.findOne().select('_id name').exec(function(err, d) { assert.ifError(err); assert.equal(d.id, id); assert.equal(d.name, 'ssd'); assert.equal(d.age, undefined); cb(); }); }); }); }
function nonId(M, id, cb) { M.findOne().select('age -name').exec(function(err, d) { assert.ok(err); assert.ok(!d); M.findOne().select('-age name').exec(function(err, d) { assert.ok(err); assert.ok(!d); M.findOne().select('-age -name').exec(function(err, d) { assert.ifError(err); assert.equal(d.id, id); assert.equal(d.name, undefined); assert.equal(d.age, undefined); M.findOne().select('age name').exec(function(err, d) { assert.ifError(err); assert.equal(d.id, id); assert.equal(d.name, 'ssd'); assert.equal(d.age, 0); cb(); }); }); }); }); }
M.create({ name: 'ssd', age: 0 }, function(err, d) { assert.ifError(err); const id = d.id; useId(M, id, function() { nonId(M, id, function() { useId(S, id, function() { nonId(S, id, function() { useId(T, id, function() { nonId(T, id, function() { done(); }); }); }); }); }); }); }); });
it('does not set defaults for nested objects (gh-4707)', function(done) { const userSchema = new Schema({ name: String, age: Number, profile: { email: String, flags: { type: String, default: 'bacon' } } });
const User = db.model('Test', userSchema);
const obj = { name: 'Val', age: 28, profile: { email: 'test@a.co', flags: 'abc' } }; User.create(obj). then(function(user) { return User.findById(user._id). select('name profile.email'); }). then(function(user) { assert.ok(!user.profile.flags); done(); }). catch(done); });
it('does not create nested objects if not included (gh-4669)', function(done) { const schema = new Schema({ field1: String, field2: String, field3: { f1: String, f2: { type: String, default: 'abc' } }, field4: { f1: String }, field5: String }, { minimize: false });
const M = db.model('Test', schema); const obj = { field1: 'a', field2: 'b', field3: { f1: 'c', f2: 'd' }, field4: { f1: 'e' }, field5: 'f' }; M.create(obj, function(error, doc) { assert.ifError(error); M.findOne({ _id: doc._id }, 'field1 field2', function(error, doc) { assert.ifError(error); assert.ok(!doc.toObject({ minimize: false }).field3); assert.ok(!doc.toObject({ minimize: false }).field4); done(); }); }); });
it('initializes nested defaults with selected objects (gh-2629)', function(done) { const NestedSchema = new mongoose.Schema({ nested: { name: { type: String, default: 'val' } } });
const Model = db.model('Test', NestedSchema);
const doc = new Model(); doc.nested.name = undefined; doc.save(function(error) { assert.ifError(error); Model.findOne({}, { nested: 1 }, function(error, doc) { assert.ifError(error); assert.equal(doc.nested.name, 'val'); done(); }); }); });});