monastery 1.35.0 → 1.36.2

package/lib/model-validate.js

@@ -3,7 +3,7 @@ let rules = require('./rules')
 
 module.exports = {
 
-  validate: function(data, opts, cb) {
+  validate: async function(data, opts, cb) {
     /**
      * Validates a model
      * @param {object} data
@@ -22,38 +22,44 @@ module.exports = {
      */
 
     // Optional cb and opts
-    if (util.isFunction(opts)) { cb = opts; opts = undefined }
+    if (util.isFunction(opts)) {
+      cb = opts; opts = undefined
+    }
     if (cb && !util.isFunction(cb)) {
       throw new Error(`The callback passed to ${this.name}.validate() is not a function`)
     }
-    data = util.deepCopy(data)
-    opts = opts || {}
-    opts.insert = !opts.update
-    opts.action = opts.update ? 'update' : 'insert'
-    opts.skipValidation = opts.skipValidation === true ? true : util.toArray(opts.skipValidation||[])
+    try {
+      data = util.deepCopy(data)
+      opts = opts || {}
+      opts.update = opts.update || opts.findOneAndUpdate
+      opts.insert = !opts.update
+      opts.skipValidation = opts.skipValidation === true ? true : util.toArray(opts.skipValidation||[])
+
+      // Get projection
+      if (opts.project) opts.projectionValidate = this._getProjectionFromProject(opts.project)
+      else opts.projectionValidate = this._getProjectionFromBlacklist(opts.update ? 'update' : 'insert', opts.blacklist)
 
-    // Get projection
-    if (opts.project) opts.projection = this._getProjectionFromProject(opts.project)
-    else opts.projection = this._getProjectionFromBlacklist(opts.action, opts.blacklist)
+      // Hook: beforeValidate
+      await util.runSeries(this.beforeValidate.map(f => f.bind(opts, data)))
 
-    // Run before hook, then recurse through the model's fields
-    return util.runSeries(this.beforeValidate.map(f => f.bind(opts, data))).then(() => {
-      return util.toArray(data).map(item => {
+      // Recurse and validate fields
+      let response = util.toArray(data).map(item => {
         let validated = this._validateFields(item, this.fields, item, opts, '')
         if (validated[0].length) throw validated[0]
         else return validated[1]
       })
 
-    // Success/error
-    }).then(data2 => {
-      let response = util.isArray(data)? data2 : data2[0]
+      // Single document?
+      response = util.isArray(data)? response : response[0]
+
+      // Success/error
       if (cb) cb(null, response)
       else return Promise.resolve(response)
 
-    }).catch(errs => {
-      if (cb) cb(errs)
-      else throw errs
-    })
+    } catch (e) {
+      if (cb) cb(e)
+      else throw e
+    }
   },
 
   _getMostSpecificKeyMatchingPath: function(object, path) {
@@ -126,7 +132,7 @@ module.exports = {
         }
 
         // Ignore blacklisted
-        if (this._pathBlacklisted(path3, opts.projection) && !schema.defaultOverride) return
+        if (this._pathBlacklisted(path3, opts.projectionValidate) && !schema.defaultOverride) return
         // Ignore insert only
         if (opts.update && schema.insertOnly) return
         // Ignore virtual fields
@@ -239,7 +245,7 @@ module.exports = {
     if (typeof value === 'undefined' && (!validateUndefined  || !rule.validateUndefined)) return
 
     // Ignore null (if nullObject is set on objects or arrays)
-    if (value === null && (field.isObject || field.isArray) && field.nullObject) return
+    if (value === null && (field.isObject || field.isArray) && field.nullObject && !rule.validateNull) return
 
     // Ignore null
     if (value === null && !(field.isObject || field.isArray) && !rule.validateNull) return

package/lib/model.js

@@ -72,7 +72,7 @@ let Model = module.exports = function(name, opts, manager) {
   this._setupFields(this.fields = Object.assign({}, this._timestampFields, this.fields))
   this.fieldsFlattened = this._getFieldsFlattened(this.fields, '') // test output?
 
-  // Extend model with monk collection actions
+  // Extend model with monk collection queries
   this._collection = manager.get? manager.get(name, { castIds: false }) : null
   if (!this._collection) {
     this.info('There is no mongodb connection, a lot of the monk/monastery methods will be unavailable')
@@ -83,8 +83,7 @@ let Model = module.exports = function(name, opts, manager) {
   }
 
   // Add model to manager
-  if (typeof this.manager[name] === 'undefined'
-      || typeof this.manager.model[name] !== 'undefined') {
+  if (typeof this.manager[name] === 'undefined' || typeof this.manager.model[name] !== 'undefined') {
     this.manager[name] = this
   } else {
     this.warn(`Your model name '${name}' is conflicting, you are only able to

package/lib/monk-monkey-patches.js

@@ -0,0 +1,73 @@
+let MongoClient = require('mongodb').MongoClient
+
+module.exports.open = function(uri, opts, fn) {
+  /*
+   * Monkey patch to remove db event listener warnings
+   * @todo remove when monk is removed
+   * @see https://www.mongodb.com/community/forums/t/node-44612-deprecationwarning-listening-to-events-on-
+       the-db-class-has-been-deprecated-and-will-be-removed-in-the-next-major-version/15849/4
+   */
+  var STATE = {
+    CLOSED: 'closed',
+    OPENING: 'opening',
+    OPEN: 'open'
+  }
+  MongoClient.connect(uri, opts, function (err, client) {
+    // this = Manager
+    if (err) {
+      this._state = STATE.CLOSED
+      this.emit('error-opening', err)
+    } else {
+      this._state = STATE.OPEN
+
+      this._client = client
+      this._db = client.db()
+
+      // set up events
+      var self = this
+      ;['authenticated', 'close', 'error', 'parseError', 'timeout'].forEach(function (eventName) {
+        self._client.on(eventName, function (e) {
+          self.emit(eventName, e)
+        })
+      })
+
+      this.emit('open', this._db)
+    }
+    if (fn) {
+      fn(err, this)
+    }
+  }.bind(this))
+}
+
+module.exports.findOneAndUpdate = function(query, update, opts, fn) {
+  /*
+   * Monkey patch to use returnDocument
+   * @todo remove when monk is removed
+   * @see https://github.com/Automattic/monk/blob/master/lib/collection.js#L265
+   */
+  // this = model
+  if (typeof opts === 'function') {
+    fn = opts
+    opts = {}
+  }
+  return this._dispatch(function findOneAndUpdate(args) {
+    var method = 'findOneAndUpdate'
+    if (typeof (args.options || {}).returnDocument === 'undefined') {
+      args.options.returnDocument = 'after'
+    }
+    if (args.options.replaceOne | args.options.replace) {
+      method = 'findOneAndReplace'
+    }
+    return args.col[method](args.query, args.update, args.options)
+      .then(function (doc) {
+        if (doc && typeof doc.value !== 'undefined') {
+          return doc.value
+        }
+        if (doc.ok && doc.lastErrorObject && doc.lastErrorObject.n === 0) {
+          return null
+        }
+        return doc
+      })
+  })({options: opts, query: query, update: update, callback: fn}, 'findOneAndUpdate')
+}
+

package/lib/util.js

@@ -140,14 +140,13 @@ module.exports = {
     return typeof value === 'undefined'
   },
 
-  omit: function(obj, keys) {
-    let target = {}
-    for (let i in obj) {
-      if (keys.indexOf(i) >= 0) continue
-      if (!Object.prototype.hasOwnProperty.call(obj, i)) continue
-      target[i] = obj[i]
+  omit: function(obj, fields) {
+    const shallowCopy = Object.assign({}, obj)
+    for (let i=0; i<fields.length; i+=1) {
+      const key = fields[i]
+      delete shallowCopy[key]
     }
-    return target
+    return shallowCopy
   },
 
   parseData: function(obj) {
@@ -228,21 +227,24 @@ module.exports = {
     }
   },
 
-  pluck: function(obj, keys) {
-    let target = {}
-    for (let prop in obj) {
-      let match
-      if (!Object.prototype.hasOwnProperty.call(obj, prop)) continue
-      for (let key of keys) {
-        if (this.isString(key) && key == prop) match = true
-        else if (this.isRegex(key) && prop.match(key)) match = true
+  pick: function(obj, keys) {
+    // Similiar to underscore.pick
+    // @param {string[] | regex[]} keys
+    if (!this.isObject(obj) && !this.isFunction(obj)) return {}
+    keys = this.toArray(keys)
+    let res = {}
+    for (let key of keys) {
+      if (this.isString(key) && obj.hasOwnProperty(key)) res[key] = obj[key]
+      if (this.isRegex(key)) {
+        for (let key2 in obj) {
+          if (obj.hasOwnProperty(key2) && key2.match(key)) res[key2] = obj[key2]
+        }
       }
-      if (match) target[prop] = obj[prop]
     }
-    return target
+    return res
   },
 
-  removeUndefined: (variable) => {
+  removeUndefined: function(variable) {
     // takes an array or object
     if (Array.isArray(variable)) {
       for (let i=variable.length; i--;) {

package/package.json

@@ -2,7 +2,7 @@
   "name": "monastery",
   "description": "⛪ A straight forward MongoDB ODM built around Monk",
   "author": "Ricky Boyce",
-  "version": "1.35.0",
+  "version": "1.36.2",
   "license": "MIT",
   "repository": "github:boycce/monastery",
   "homepage": "https://boycce.github.io/monastery/",

package/test/blacklisting.js

@@ -1,104 +1,25 @@
+let bird = require('./mock/blacklisting').bird
+let user = require('./mock/blacklisting').user
+let util = require('../lib/util')
+
 module.exports = function(monastery, opendb) {
 
   test('find blacklisting basic', async () => {
     // Setup
     let db = (await opendb(null)).db
-    let bird = db.model('bird', {
-      fields: {
-        name: { type: 'string' },
-      }
-    })
-    let user = db.model('user', {
-      fields: {
-        list: [{ type: 'number' }],
-        dog: { type: 'string' },
-        pet: { type: 'string' },
-        pets: [{
-          name: { type: 'string'},
-          age: { type: 'number'}
-        }],
-        animals: {
-          cat: { type: 'string' },
-          dog: { type: 'string' }
-        },
-        hiddenPets: [{
-          name: { type: 'string'}
-        }],
-        hiddenList: [{ type: 'number'}],
-        deep: {
-          deep2: {
-            deep3: {
-              deep4: { type: 'string' }
-            }
-          }
-        },
-        deeper: {
-          deeper2: {
-            deeper3: {
-              deeper4: { type: 'string' }
-            }
-          }
-        },
-        deepModel: {
-          myBird: { model: 'bird' }
-        },
-        hiddenDeepModel: {
-          myBird: { model: 'bird' }
-        }
-      },
-      findBL: [
-        'dog',
-        'animals.cat',
-        'pets.age',
-        'hiddenPets',
-        'hiddenList',
-        'deep.deep2.deep3',
-        'deeper',
-        'hiddenDeepModel'
-      ],
-    })
-    let bird1 = await bird.insert({ data: { name: 'ponyo' }})
-    let user1 = await user.insert({ data: {
-      list: [44, 54],
-      dog: 'Bruce',
-      pet: 'Freddy',
-      pets: [{ name: 'Pluto', age: 5 }, { name: 'Milo', age: 4 }],
-      animals: {
-        cat: 'Ginger',
-        dog: 'Max'
-      },
-      hiddenPets: [{
-        name: 'secretPet'
-      }],
-      hiddenList: [12, 23],
-      deep: {
-        deep2: {
-          deep3: {
-            deep4: 'hideme'
-          }
-        }
-      },
-      deeper: {
-        deeper2: {
-          deeper3: {
-            deeper4: 'hideme'
-          }
-        }
-      },
-      deepModel: {
-        myBird: bird1._id
-      },
-      hiddenDeepModel: {
-        myBird: bird1._id
-      }
-    }})
+    db.model('bird', bird.schema())
+    db.model('user', user.schema())
+
+    let bird1 = await db.bird.insert({ data: bird.mock() })
+    let user1 = await db.user.insert({ data: user.mock(bird1) })
 
     // initial blacklist
-    let find1 = await user.findOne({
+    let find1 = await db.user.findOne({
       query: user1._id
     })
     expect(find1).toEqual({
       _id: user1._id,
+      bird: bird1._id,
       list: [44, 54],
       pet: 'Freddy',
       pets: [{ name: 'Pluto' }, { name: 'Milo' }],
@@ -108,13 +29,14 @@ module.exports = function(monastery, opendb) {
     })
 
     // augmented blacklist
-    let find2 = await user.findOne({
+    let find2 = await db.user.findOne({
       query: user1._id,
       blacklist: ['pet', 'pet', 'deep', 'deepModel', '-dog', '-animals.cat']
     })
     let customBlacklist
     expect(find2).toEqual((customBlacklist = {
       _id: user1._id,
+      bird: bird1._id,
       dog: 'Bruce',
       list: [44, 54],
       pets: [{ name: 'Pluto' }, { name: 'Milo' }],
@@ -122,119 +44,84 @@ module.exports = function(monastery, opendb) {
     }))
 
     // blacklist string
-    let find3 = await user.findOne({
+    let find3 = await db.user.findOne({
       query: user1._id,
       blacklist: 'pet pet deep deepModel -dog -animals.cat'
     })
     expect(find3).toEqual(customBlacklist)
 
     // blacklist removal
-    let find4 = await user.findOne({ query: user1._id, blacklist: false })
+    let find4 = await db.user.findOne({ query: user1._id, blacklist: false })
     expect(find4).toEqual(user1)
 
     db.close()
   })
 
   test('find blacklisting population', async () => {
-    // inprogresss
     // Setup
-    let db = monastery('localhost/monastery', {
-      timestamps: false,
-      serverSelectionTimeoutMS: 2000,
-    })
-    let bird = db.model('bird', {
-      fields: {
-        color: { type: 'string', default: 'red' },
-        height: { type: 'number' },
-        name: { type: 'string' },
-        sub: {
-          color: { type: 'string', default: 'red' },
-        },
-        subs: [{
-          color: { type: 'string', default: 'red'},
-        }],
-        wing: {
-          size: { type: 'number' },
-          sizes: {
-            one: { type: 'number' },
-            two: { type: 'number' },
-          }
-        },
-      },
-      findBL: ['wing']
-    })
-    let user = db.model('user', {
+    let db = (await opendb(null)).db
+    db.model('bird', bird.schema())
+    db.model('user', {
       fields: {
         dog: { type: 'string' },
-        bird1: { model: 'bird' },
-        bird2: { model: 'bird' },
-        bird3: { model: 'bird' },
-        bird4: { model: 'bird' },
-        bird5: { model: 'bird' },
+        bird: { model: 'bird' },
       },
-      findBL: [
-        'bird1.name',                                 // bird1.name & bird1.wing blacklisted
-        '-bird2', 'bird2.name',                       // bird2.name blacklisted
-        'bird3.name', '-bird3', 'bird3.height',       // bird3.height blacklisted
-        '-bird4.wing.sizes.one', '-bird4.wing.size',  // ignored
-        // bird4.wing.sizes.two blacklisted (expand in future verion)
-        '-bird5.wing.sizes.one',                      // bird5.wing.sizes.one ignored, wing blacklisted
-        // bird5.wing.sizes.two, wing.size blacklisted (expand in future verion)
-      ]
     })
-    let bird1 = await bird.insert({
-      data: {
-        name: 'ponyo',
-        height: 40,
-        sub: {},
-        wing: { size: 1, sizes: { one: 1, two: 1 }}
-      }
-    })
-    let userData = {
+
+    let bird1 = await db.bird.insert({ data: bird.mock() })
+    let user1 = await db.user.insert({ data: {
       dog: 'Bruce',
-      bird1: bird1._id,
-      bird2: bird1._id,
-      bird3: bird1._id,
-      bird4: bird1._id,
-      bird5: bird1._id
+      bird: bird1._id,
+    }})
+
+    let bird1Base = {
+      _id: bird1._id,
+      color: 'red',
+      sub: { color: 'red' }
     }
-    let user1 = await user.insert({ data: userData })
-    let bird1Base = { _id: bird1._id, color: 'red', sub: { color: 'red' }}
 
-    // Test bird1
-    expect(await user.findOne({ query: user1._id, populate: ['bird1'] })).toEqual({
-      ...userData,
-      _id: user1._id,
-      bird1: { ...bird1Base, height: 40 },
+    // 'bird1.name',                                 // bird1.name & bird1.wing blacklisted
+    // '-bird2', 'bird2.name',                       // bird2.name blacklisted
+    // 'bird3.name', '-bird3', 'bird3.height',       // bird3.height blacklisted
+    // '-bird4.wing.sizes.one', '-bird4.wing.size',  // ignored
+    //        bird4.wing.sizes.two blacklisted (expand in future verion)
+    // '-bird5.wing.sizes.one',                      // bird5.wing.sizes.one ignored, wing blacklisted
+    //        bird5.wing.sizes.two, wing.size blacklisted (expand in future verion)
+
+    // test 1
+    db.user.findBL = ['bird.name']
+    expect(await db.user.findOne({ query: user1._id, populate: ['bird'] })).toEqual({
+      ...user1,
+      bird: { ...bird1Base, height: 12 },
     })
-    // Test bird2
-    expect(await user.findOne({ query: user1._id, populate: ['bird2'] })).toEqual({
-      ...userData,
-      _id: user1._id,
-      bird2: { ...bird1Base, height: 40, wing: { size: 1, sizes: { one: 1, two: 1 }} },
+    // test 2
+    db.user.findBL = ['-bird', 'bird.name']
+    expect(await db.user.findOne({ query: user1._id, populate: ['bird'] })).toEqual({
+      ...user1,
+      bird: { ...bird1Base, height: 12, wing: { size: 1, sizes: { one: 1, two: 1 }} },
     })
-    // Test bird3
-    expect(await user.findOne({ query: user1._id, populate: ['bird3'] })).toEqual({
-      ...userData,
-      _id: user1._id,
-      bird3: { ...bird1Base, name: 'ponyo', wing: { size: 1, sizes: { one: 1, two: 1 }} },
+    // test 3
+    db.user.findBL = ['bird.name', '-bird', 'bird.height']
+    expect(await db.user.findOne({ query: user1._id, populate: ['bird'] })).toEqual({
+      ...user1,
+      bird: { ...bird1Base, name: 'Ponyo', wing: { size: 1, sizes: { one: 1, two: 1 }} },
     })
-    // Test bird4
-    expect(await user.findOne({ query: user1._id, populate: ['bird4'] })).toEqual({
-      ...userData,
-      _id: user1._id,
-      bird4: { ...bird1Base, name: 'ponyo', height: 40 },
+    // test 4
+    db.user.findBL = ['-bird.wing.sizes.one', '-bird.wing.size']
+    expect(await db.user.findOne({ query: user1._id, populate: ['bird'] })).toEqual({
+      ...user1,
+      bird: { ...bird1Base, name: 'Ponyo', height: 12 },
     })
-    // Test bird5
-    expect(await user.findOne({ query: user1._id, populate: ['bird5'] })).toEqual({
-      ...userData,
-      _id: user1._id,
-      bird5: { ...bird1Base, name: 'ponyo', height: 40 },
+    // test 5
+    db.user.findBL = ['-bird.wing.sizes.one']
+    expect(await db.user.findOne({ query: user1._id, populate: ['bird'] })).toEqual({
+      ...user1,
+      bird: { ...bird1Base, name: 'Ponyo', height: 12 },
     })
     // blacklist removal
-    expect(await user.findOne({ query: user1._id, blacklist: false, populate: ['bird1'] })).toEqual({
+    expect(await db.user.findOne({ query: user1._id, blacklist: false, populate: ['bird'] })).toEqual({
       ...user1,
-      bird1: { ...bird1Base, height: 40, name: 'ponyo', wing: { size: 1, sizes: { one: 1, two: 1 }} },
+      bird: { ...bird1Base, height: 12, name: 'Ponyo', wing: { size: 1, sizes: { one: 1, two: 1 }} },
     })
 
     db.close()
@@ -583,4 +470,72 @@ module.exports = function(monastery, opendb) {
     db.close()
   })
 
+  test('findOneAndUpdate blacklisting general', async () => {
+    // todo: test all findOneAndUpdate options
+    // todo: test find & update hooks
+    let db = (await opendb(null)).db
+    db.model('bird', bird.schema())
+    db.model('user', user.schema())
+
+    let bird1 = await db.bird.insert({ data: bird.mock() })
+    let user1 = await db.user.insert({ data: user.mock(bird1) })
+
+    // augmented blacklist
+    let find2 = await db.user.findOneAndUpdate({
+      query: user1._id,
+      data: { dog: 'Bruce2', pet: 'Freddy2' }, // pet shouldn't update
+      blacklist: ['pet', 'deep', 'deepModel', '-dog', '-animals.cat'],
+    })
+    expect(find2).toEqual({
+      _id: user1._id,
+      bird: bird1._id,
+      dog: 'Bruce2',
+      list: [44, 54],
+      pets: [{ name: 'Pluto' }, { name: 'Milo' }],
+      animals: { dog: 'Max', cat: 'Ginger' },
+    })
+    expect(await db.user.findOne({ query: user1._id, project: ['pet'] })).toEqual({
+      _id: user1._id,
+      pet: 'Freddy',
+    })
+
+    db.close()
+  })
+
+  test('findOneAndUpdate blacklisting populate', async () => {
+    let db = (await opendb(null)).db
+    db.model('bird', bird.schema())
+    db.model('user', user.schema())
+
+    let bird1 = await db.bird.insert({ data: bird.mock() })
+    let user1 = await db.user.insert({ data: user.mock(bird1) })
+
+    // augmented blacklist
+    let find2 = await db.user.findOneAndUpdate({
+      query: user1._id,
+      data: { dog: 'Bruce2', pet: 'Freddy2' }, // pet shouldn't update
+      blacklist: [
+        'pet', 'deep', 'deepModel', '-dog', '-animals.cat',
+        'bird.name', '-bird', 'bird.height' // <- populated model
+      ],
+      populate: ['bird'],
+    })
+    expect(find2).toEqual({
+      _id: user1._id,
+      bird: {
+        ...util.omit(bird1, ['height']),
+      },
+      dog: 'Bruce2',
+      list: [44, 54],
+      pets: [{ name: 'Pluto' }, { name: 'Milo' }],
+      animals: { dog: 'Max', cat: 'Ginger' },
+    })
+    expect(await db.user.findOne({ query: user1._id, project: ['pet'] })).toEqual({
+      _id: user1._id,
+      pet: 'Freddy',
+    })
+
+    db.close()
+  })
+
 }