monastery 1.34.0 → 1.36.1

package/lib/model-crud.js

@@ -6,33 +6,31 @@ module.exports = {
     /**
      * Inserts document(s) with monk after validating data & before hooks.
      * @param {object} opts
-     *     @param {object|array} <opts.data> - documents to insert
-     *     @param {array|string|false} <opts.blacklist> - augment schema.insertBL, `false` will remove all blacklisting
+     *     @param {object|array} opts.data - documents to insert
+     *     @param {array|string|false} <opts.blacklist> - augment schema.insertBL, `false` will remove blacklisting
+     *     @param {array|string} <opts.project> - return only these fields, ignores blacklisting
      *     @param {boolean} <opts.respond> - automatically call res.json/error (requires opts.req)
-     *     @param {array|string|false} validateUndefined - validates all 'required' undefined fields, true by
-     *         default, but false on update
      *     @param {array|string|true} <opts.skipValidation> - skip validation for this field name(s)
      *     @param {boolean} <opts.timestamps> - whether `createdAt` and `updatedAt` are automatically inserted
-     *     @param {any} <opts.any> - any mongodb option
+     *     @param {array|string|false} <opts.validateUndefined> - validates all 'required' undefined fields, true by
+     *         default, but false on update
+     *     @param {any} <any mongodb option>
      * @param {function} <cb> - execute cb(err, data) instead of responding
-     * @this model
      * @return promise
+     * @this model
      */
     if (cb && !util.isFunction(cb)) {
       throw new Error(`The callback passed to ${this.name}.insert() is not a function`)
     }
     try {
       opts = await this._queryObject(opts, 'insert')
-      let options = util.omit(opts, [
-        'data', 'insert', 'model', 'respond', 'validateUndefined', 'skipValidation', 'blacklist'
-      ])
 
       // Validate
-      let data = await this.validate(opts.data||{}, { ...opts })
+      let data = await this.validate(opts.data || {}, opts) // was { ...opts }
 
       // Insert
       await util.runSeries(this.beforeInsert.map(f => f.bind(opts, data)))
-      let response = await this._insert(data, options)
+      let response = await this._insert(data, util.omit(opts, this._queryOptions))
       await util.runSeries(this.afterInsert.map(f => f.bind(opts, response)))
 
       // Success/error
@@ -51,53 +49,41 @@ module.exports = {
     /**
      * Finds document(s) with monk, also auto populates
      * @param {object} opts
-     *     @param {object} <opts.query> - mongodb query object
-     *     @param {boolean} <opts.respond> - automatically call res.json/error (requires opts.req)
-     *     @param {array} <opts.populate> - population, see docs
      *     @param {array|string|false} <opts.blacklist> - augment schema.findBL, `false` will remove all blacklisting
+     *     @param {array} <opts.populate> - population, see docs
      *     @param {array|string} <opts.project> - return only these fields, ignores blacklisting
-     *     @param {any} <opts.any> - any mongodb option
+     *     @param {object} <opts.query> - mongodb query object
+     *     @param {boolean} <opts.respond> - automatically call res.json/error (requires opts.req)
+     *     @param {any} <any mongodb option>
      * @param {function} <cb> - execute cb(err, data) instead of responding
-     * @this model
      * @return promise
+     * @this model
      */
     if (cb && !util.isFunction(cb)) {
       throw new Error(`The callback passed to ${this.name}.find() is not a function`)
     }
     try {
-      opts = await this._queryObject(opts, 'find', one)
       let lookups = []
-      let options = util.omit(opts, ['blacklist', 'one', 'populate', 'project', 'query', 'respond'])
-      options.addFields = options.addFields || {}
+      opts = await this._queryObject(opts, 'find', one)
+
+      // Get projection
+      if (opts.project) opts.projection = this._getProjectionFromProject(opts.project)
+      else opts.projection = this._getProjectionFromBlacklist(opts.type, opts.blacklist)
 
-      // Using project (can be an inclusion/exclusion)
-      if (opts.project) {
-        if (util.isString(opts.project)) {
-          opts.project = opts.project.trim().split(/\s+/)
-        }
-        if (util.isArray(opts.project)) {
-          options.projection = opts.project.reduce((o, v) => {
-            o[v.replace(/^-/, '')] = v.match(/^-/)? 0 : 1
-            return o
-          }, {})
-        }
-      // Or blacklisting
-      } else {
-        options.projection = this._getBlacklistProjection('find', opts.blacklist)
-      }
       // Has text search?
       // if (opts.query.$text) {
-      //   options.projection.score = { $meta: 'textScore' }
-      //   options.sort = { score: { $meta: 'textScore' }}
+      //   opts.projection.score = { $meta: 'textScore' }
+      //   opts.sort = { score: { $meta: 'textScore' }}
       // }
+
       // Wanting to populate?
       if (!opts.populate) {
-        var response = await this[`_find${opts.one? 'One' : ''}`](opts.query, options)
+        var response = await this[`_find${opts.one? 'One' : ''}`](opts.query, util.omit(opts, this._queryOptions))
       } else {
         loop: for (let item of opts.populate) {
           let path = util.isObject(item)? item.as : item
           // Blacklisted?
-          if (!this._pathInProjection(path, options.projection, true)) continue loop
+          if (this._pathBlacklisted(path, opts.projection)) continue loop
           // Custom $lookup definition
           // https://thecodebarbarian.com/a-nodejs-perspective-on-mongodb-36-lookup-expr
           if (util.isObject(item)) {
@@ -118,7 +104,7 @@ module.exports = {
               continue
             }
             // Populate model (convert array into document & create lookup)
-            options.addFields[path] = { '$arrayElemAt': [ '$' + path, 0 ] }
+            (opts.addFields = opts.addFields || {})[path] = { '$arrayElemAt': [ '$' + path, 0 ] }
             lookups.push({ $lookup: {
               from: modelName,
               localField: path,
@@ -127,23 +113,26 @@ module.exports = {
             }})
           }
         }
-        // console.log(1, options.projection)
+        // console.log(1, opts.projection)
         // console.log(2, lookups)
         let aggregate = [
           { $match: opts.query },
-          { $sort: options.sort },
-          { $skip: options.skip },
-          ...(options.limit? [{ $limit: options.limit }] : []),
+          { $sort: opts.sort },
+          { $skip: opts.skip },
+          ...(opts.limit? [{ $limit: opts.limit }] : []),
           ...lookups,
-          ...util.isEmpty(options.addFields)? [] : [{ $addFields: options.addFields }],
-          { $project: options.projection }
+          ...(opts.addFields? [{ $addFields: opts.addFields }] : []),
+          ...(opts.projection? [{ $project: opts.projection }] : []),
         ]
         response = await this._aggregate(aggregate)
         this.info('aggregate', JSON.stringify(aggregate))
       }
 
+      // Returning one?
       if (opts.one && util.isArray(response)) response = response[0]
-      response = await this._processAfterFind(response, options.projection, opts)
+
+      // Process afterFind hooks
+      response = await this._processAfterFind(response, opts.projection, opts)
 
       // Success
       if (cb) cb(null, response)
@@ -161,59 +150,120 @@ module.exports = {
     return this.find(opts, cb, true)
   },
 
-  // findOneAndUpdate: function(opts, cb) {
-  //   return this._findOneAndUpdate(opts, cb)
-  // },
+  findOneAndUpdate: async function(opts, cb) {
+    /**
+     * Find and update document(s) with monk, also auto populates
+     * @param {object} opts
+     *     @param {array|string|false} <opts.blacklist> - augment findBL/updateBL, `false` will remove all blacklisting
+     *     @param {array} <opts.populate> - find population, see docs
+     *     @param {array|string} <opts.project> - return only these fields, ignores blacklisting
+     *     @param {object} <opts.query> - mongodb query object
+     *     @param {boolean} <opts.respond> - automatically call res.json/error (requires opts.req)
+     *     @param {any} <any mongodb option>
+     *
+     *     Update options:
+     *     @param {object|array} opts.data - mongodb document update object(s)
+     *     @param {array|string|true} <opts.skipValidation> - skip validation for this field name(s)
+     *     @param {boolean} <opts.timestamps> - whether `updatedAt` is automatically updated
+     *     @param {array|string|false} <opts.validateUndefined> - validates all 'required' undefined fields, true by
+     *         default, but false on update
+     * @param {function} <cb> - execute cb(err, data) instead of responding
+     * @return promise
+     * @this model
+     */
+
+    if (opts.populate) {
+      try {
+        // todo: add transaction flag
+        delete opts.multi
+        let update = await this.update(opts, null, 'findOneAndUpdate')
+        if (update) var response = await this.findOne(opts)
+        else response = update
+
+        // Success
+        if (cb) cb(null, response)
+        else if (opts.req && opts.respond) opts.req.res.json(response)
+        else return Promise.resolve(response)
+
+      } catch (e) {
+        if (cb) cb(e)
+        else if (opts && opts.req && opts.respond) opts.req.res.error(e)
+        else throw e
+      }
+    } else {
+      return this.update(opts, cb, 'findOneAndUpdate')
+    }
+  },
 
-  update: async function(opts, cb) {
+  update: async function(opts, cb, type='update') {
     /**
      * Updates document(s) with monk after validating data & before hooks.
      * @param {object} opts
+     *     @param {object|array} opts.data - mongodb document update object(s)
+     *     @param {array|string|false} <opts.blacklist> - augment schema.updateBL, `false` will remove blacklisting
+     *     @param {array|string} <opts.project> - return only these fields, ignores blacklisting
      *     @param {object} <opts.query> - mongodb query object
-     *     @param {object|array} <opts.data> - mongodb document update object(s)
      *     @param {boolean} <opts.respond> - automatically call res.json/error (requires opts.req)
-     *     @param {array|string|false} validateUndefined - validates all 'required' undefined fields, true by
-     *         default, but false on update
      *     @param {array|string|true} <opts.skipValidation> - skip validation for this field name(s)
      *     @param {boolean} <opts.timestamps> - whether `updatedAt` is automatically updated
-     *     @param {array|string|false} <opts.blacklist> - augment schema.updateBL, `false` will remove all blacklisting
-     *     @param {any} <opts.any> - any mongodb option
+     *     @param {array|string|false} <opts.validateUndefined> - validates all 'required' undefined fields, true by
+     *         default, but false on update
+     *     @param {any} <any mongodb option>
      * @param {function} <cb> - execute cb(err, data) instead of responding
-     * @this model
+     * @param {function} <type> - 'update', or 'findOneAndUpdate'
      * @return promise(data)
+     * @this model
      */
     if (cb && !util.isFunction(cb)) {
-      throw new Error(`The callback passed to ${this.name}.update() is not a function`)
+      throw new Error(`The callback passed to ${this.name}.${type}() is not a function`)
     }
     try {
-      opts = await this._queryObject(opts, 'update')
+      opts = await this._queryObject(opts, type)
       let data = opts.data
       let response = null
-      let operators = util.pluck(opts, [/^\$/])
-      let options = util.omit(opts, ['data', 'query', 'respond', 'validateUndefined', 'skipValidation', 'blacklist'])
+      let operators = util.pick(opts, [/^\$/])
 
       // Validate
-      if (util.isDefined(data)) data = await this.validate(opts.data, { ...opts })
+      if (util.isDefined(data)) {
+        data = await this.validate(opts.data, opts) // was {...opts}
+      }
       if (!util.isDefined(data) && util.isEmpty(operators)) {
-        throw new Error(`Please pass an update operator to ${this.name}.update(), e.g. data, $unset, etc`)
+        throw new Error(`Please pass an update operator to ${this.name}.${type}(), e.g. data, $unset, etc`)
       }
       if (util.isDefined(data) && (!data || util.isEmpty(data))) {
-        throw new Error(`No valid data passed to ${this.name}.update({ data: .. })`)
+        throw new Error(`No valid data passed to ${this.name}.${type}({ data: .. })`)
       }
+
       // Hook: beforeUpdate (has access to original, non-validated opts.data)
       await util.runSeries(this.beforeUpdate.map(f => f.bind(opts, data||{})))
+
       if (data && operators['$set']) {
-        this.warn(`'$set' fields take precedence over the data fields for \`${this.name}.update()\``)
+        this.warn(`'$set' fields take precedence over the data fields for \`${this.name}.${type}()\``)
       }
       if (data || operators['$set']) {
         operators['$set'] = { ...data, ...(operators['$set'] || {}) }
       }
+
+      // findOneAndUpdate, get 'find' projection
+      if (type == 'findOneAndUpdate') {
+        if (opts.project) opts.projection = this._getProjectionFromProject(opts.project)
+        else opts.projection = this._getProjectionFromBlacklist('find', opts.blacklist)
+        // Just peform a normal update if we need to populate a findOneAndUpdate
+        if (opts.populate) type = 'update'
+      }
+
       // Update
-      let update = await this._update(opts.query, operators, options)
-      if (update.n) response = Object.assign(Object.create({ _output: update }), operators['$set']||{})
+      let update = await this['_' + type](opts.query, operators, util.omit(opts, this._queryOptions))
+      if (type == 'findOneAndUpdate') response = update
+      else if (update.n) response = Object.assign(Object.create({ _output: update }), operators['$set']||{})
 
       // Hook: afterUpdate (doesn't have access to validated data)
-      if (update.n) await util.runSeries(this.afterUpdate.map(f => f.bind(opts, response)))
+      if (response) await util.runSeries(this.afterUpdate.map(f => f.bind(opts, response)))
+
+      // Hook: afterFind if findOneAndUpdate
+      if (response && type == 'findOneAndUpdate') {
+        response = await this._processAfterFind(response, opts.projection, opts)
+      }
 
       // Success
       if (cb) cb(null, response)
@@ -234,22 +284,21 @@ module.exports = {
      *     @param {object} <opts.query> - mongodb query object
      *     @param {boolean} <opts.respond> - automatically call res.json/error (requires opts.req)
      *     @param {boolean=true} <opts.multi> - set to false to limit the deletion to just one document
-     *     @param {any} <opts.any> - any mongodb option
+     *     @param {any} <any mongodb option>
      * @param {function} <cb> - execute cb(err, data) instead of responding
-     * @this model
      * @return promise
+     * @this model
      */
     if (cb && !util.isFunction(cb)) {
       throw new Error(`The callback passed to ${this.name}.remove() is not a function`)
     }
     try {
       opts = await this._queryObject(opts, 'remove')
-      let options = util.omit(opts, ['query', 'respond'])
       if (util.isEmpty(opts.query)) throw new Error('Please specify opts.query')
 
       // Remove
       await util.runSeries(this.beforeRemove.map(f => f.bind(opts)))
-      let response = await this._remove(opts.query, options)
+      let response = await this._remove(opts.query, util.omit(opts, this._queryOptions))
       await util.runSeries(this.afterRemove.map(f => f.bind(response)))
 
       // Success
@@ -264,13 +313,16 @@ module.exports = {
     }
   },
 
-  _getBlacklistProjection: function(type, customBlacklist) {
+  _getProjectionFromBlacklist: function(type, customBlacklist) {
     /**
      * Returns an exclusion projection
      *
+     * Path collisions are removed
+     * E.g. ['pets.dogs', 'pets.dogs.name', '-cat', 'pets.dogs.age'] = { 'pets.dog': 0 }
+     *
      * @param {string} type - find, insert, or update
-     * @param {array} customBlacklist - normally passed through options
-     * @return {array} exclusion projection {'pets.name': 0}
+     * @param {array|string|false} customBlacklist - normally passed through options
+     * @return {array|undefined} exclusion $project {'pets.name': 0}
      * @this model
      *
      * 1. collate deep-blacklists
@@ -281,16 +333,24 @@ module.exports = {
     let list = []
     let manager = this.manager
     let projection = {}
+    if (customBlacklist === false) return
+
+    // String?
+    if (typeof customBlacklist === 'string') {
+      customBlacklist = customBlacklist.trim().split(/\s+/)
+    }
 
     // Concat deep blacklists
-    util.forEach(this.fieldsFlattened, (schema, path) => {
-      if (!schema.model) return
-      let deepBL = manager.model[schema.model][`${type}BL`] || []
-      let pathWithoutArrays = path.replace(/\.0(\.|$)/, '$1')
-      list = list.concat(deepBL.map(o => {
-        return `${o.charAt(0) == '-'? '-' : ''}${pathWithoutArrays}.${o.replace(/^-/, '')}`
-      }))
-    })
+    if (type == 'find') {
+      util.forEach(this.fieldsFlattened, (schema, path) => {
+        if (!schema.model) return
+        let deepBL = manager.model[schema.model][`${type}BL`] || []
+        let pathWithoutArrays = path.replace(/\.0(\.|$)/, '$1')
+        list = list.concat(deepBL.map(o => {
+          return `${o.charAt(0) == '-'? '-' : ''}${pathWithoutArrays}.${o.replace(/^-/, '')}`
+        }))
+      })
+    }
 
     // Concat model, and custom blacklists
     list = list.concat([...this[`${type}BL`]]).concat(customBlacklist || [])
@@ -302,7 +362,8 @@ module.exports = {
 
       // Remove any child fields. E.g remove { user.token: 0 } = key2 if iterating { user: 0 } = key
       for (let key2 in projection) {
-        if (key2.match(new RegExp('^' + key.replace(/\./g, '\\.') + '(\\.|$)'))) { // test that scoped to the \.
+        // todo: need to write a test, testing that this is scoped to \.
+        if (key2.match(new RegExp('^' + key.replace(/\./g, '\\.') + '(\\.|$)'))) {
           delete projection[key2]
         }
       }
@@ -335,6 +396,28 @@ module.exports = {
       if (projection[key]) delete projection[key]
     }
 
+    return util.isEmpty(projection) ? undefined : projection
+  },
+
+  _getProjectionFromProject: function(customProject) {
+    /**
+     * Returns an in/exclusion projection
+     * todo: tests
+     *
+     * @param {object|array|string} customProject - normally passed through options
+     * @return {array|undefined} in/exclusion projection {'pets.name': 0}
+     * @this model
+     */
+    let projection
+    if (util.isString(customProject)) {
+      customProject = customProject.trim().split(/\s+/)
+    }
+    if (util.isArray(customProject)) {
+      projection = customProject.reduce((o, v) => {
+        o[v.replace(/^-/, '')] = v.match(/^-/)? 0 : 1
+        return o
+      }, {})
+    }
     return projection
   },
 
@@ -342,11 +425,12 @@ module.exports = {
     /**
      * Normalise options
      * @param {MongoId|string|object} opts
-     * @param {string} type - operation type
+     * @param {string} type - insert, update, find, remove, findOneAndUpdate
      * @param {boolean} one - return one document
-     * @this model
      * @return {Promise} opts
+     * @this model
      *
+     * Query parsing logic:
      * opts == string|MongodId - treated as an id
      * opts == undefined|null|false - throw error
      * opts.query == string|MongodID - treated as an id
@@ -370,7 +454,7 @@ module.exports = {
         throw new Error('Please pass an object or MongoId to options.query')
       }
       if (util.isId(opts.query._id)) opts.query._id = this.manager.id(opts.query._id)
-      if (isIdType(opts.query._id) || one) opts.one = true
+      if (isIdType(opts.query._id) || one || type == 'findOneAndUpdate') opts.one = true
       opts.query = util.removeUndefined(opts.query)
 
       // Query options
@@ -389,7 +473,8 @@ module.exports = {
     if (!util.isDefined(opts.data) && util.isDefined((opts.req||{}).body)) opts.data = opts.req.body
     if (util.isDefined(opts.data)) opts.data = await util.parseData(opts.data)
 
-    opts[type] = true
+    opts.type = type
+    opts[type] = true // still being included in the operation options..
     opts.model = this
     return opts
   },
@@ -400,11 +485,12 @@ module.exports = {
      * Recurses through fields that are models and populates missing default-fields and calls model.afterFind([fn,..])
      * Be sure to add any virtual fields to the schema that your populating on,
      * e.g. "nurses": [{ model: 'user' }]
+     *
      * @param {object|array|null} data
      * @param {object} projection - $project object
      * @param {object} afterFindContext - handy context object given to schema.afterFind
-     * @this model
      * @return Promise(data)
+     * @this model
      */
     // Recurse down from the parent model, ending with the parent model as the parent afterFind hook may
     // want to manipulate any populated models
@@ -422,8 +508,8 @@ module.exports = {
           if (!util.isDefined(schema.default) || path.match(/^\.?(createdAt|updatedAt)$/)) return
           let parentPath = item.fieldName? item.fieldName + '.' : ''
           let pathWithoutArrays = (parentPath + path).replace(/\.0(\.|$)/, '$1')
-          // Ignore default fields that are excluded in a blacklist/parent-blacklist
-          if (!this._pathInProjection(pathWithoutArrays, projection, true)) return
+          // Ignore default fields that are blacklisted
+          if (this._pathBlacklisted(pathWithoutArrays, projection)) return
           // console.log(pathWithoutArrays, path, projection)
           // Set value
           let value = util.isFunction(schema.default)? schema.default(this.manager) : schema.default
@@ -438,39 +524,34 @@ module.exports = {
     return util.runSeries(callbackSeries).then(() => data)
   },
 
-  _pathInProjection: function(path, projection, matchParentPaths) {
+  _pathBlacklisted: function(path, projection, matchDeepWhitelistedKeys=true) {
     /**
-     * Checks if the path is valid within a inclusion/exclusion projection
+     * Checks if the path is blacklisted within a inclusion/exclusion projection
      * @param {string} path - path without array brackets e.g. '.[]'
-     * @param {object} projection
-     * @param {boolean} matchParentPaths - match paths included in a key (inclusive only)
+     * @param {object} projection - inclusion/exclusion projection, not mixed
+     * @param {boolean} matchDeepWhitelistedKeys - match deep whitelisted keys containing path
+     *     E.g. pets.color == pets.color.age
      * @return {boolean}
      */
-    let inc
-    // console.log(path, projection)
     for (let key in projection) {
-      if (projection[key] && matchParentPaths) {
-        // Inclusion
-        // E.g. 'pets.color.age'.match(/^pets.color.age(.|$)/) = match
-        // E.g. 'pets.color.age'.match(/^pets.color(.|$)/) = match
-        // E.g. 'pets.color'.match(/^pets.color.age(.|$)/) = match
-        inc = true
-        if (key.match(new RegExp('^' + path.replace(/\./g, '\\.') + '(\\.|$)'))) return true
-        if (path.match(new RegExp('^' + key.replace(/\./g, '\\.') + '(\\.|$)'))) return true
-      } else if (projection[key]) {
-        // Inclusion (equal to key, or key included in path)
-        // E.g. 'pets.color.age'.match(/^pets.color.age(.|$)/) = match
-        // E.g. 'pets.color.age'.match(/^pets.color(.|$)/) = match
-        // E.g. 'pets.color'.match(/^pets.color.age(.|$)/) = no match
-        inc = true
-        if (path.match(new RegExp('^' + key.replace(/\./g, '\\.') + '(\\.|$)'))) return true
-      } else {
-        // Exclusion
-        // E.g. 'pets.color.age'.match(/^pets.color(.|$)/) = match
+      if (projection[key]) {
+        // Inclusion (whitelisted)
+        // E.g. pets.color.age == pets.color.age  (exact match)
+        // E.g. pets.color.age == pets.color      (path contains key)
+        var inclusion = true
         if (path.match(new RegExp('^' + key.replace(/\./g, '\\.') + '(\\.|$)'))) return false
+        if (matchDeepWhitelistedKeys) {
+          // E.g. pets.color   == pets.color.age  (key contains path)
+          if (key.match(new RegExp('^' + path.replace(/\./g, '\\.') + '\\.'))) return false
+        }
+      } else {
+        // Exclusion (blacklisted)
+        // E.g. pets.color.age == pets.color.age  (exact match)
+        // E.g. pets.color.age == pets.color      (path contains key)
+        if (path.match(new RegExp('^' + key.replace(/\./g, '\\.') + '(\\.|$)'))) return true
       }
     }
-    return inc? false : true
+    return inclusion? true : false
   },
 
   _recurseAndFindModels: function(fields, dataArr) {
@@ -550,4 +631,11 @@ module.exports = {
     }, this)
   },
 
+  _queryOptions: [
+    // todo: remove type properties
+    'blacklist', 'data', 'find', 'findOneAndUpdate', 'insert', 'model', 'one', 'populate', 'project',
+    'projectionValidate', 'query', 'remove', 'req', 'respond', 'skipValidation', 'type', 'update',
+    'validateUndefined',
+  ],
+
 }