monastery 1.32.0 → 1.32.3

package/changelog.md

@@ -2,6 +2,27 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [1.32.3](https://github.com/boycce/monastery/compare/1.32.2...1.32.3) (2022-03-07)
+
+
+### Bug Fixes
+
+* fileSize warning ([3824b23](https://github.com/boycce/monastery/commit/3824b23883fad508e081d2a2bce1c340ec2775dc))
+
+### [1.32.2](https://github.com/boycce/monastery/compare/1.32.1...1.32.2) (2022-03-04)
+
+
+### Bug Fixes
+
+* missing original non-validated this.data in beforeUpdate ([4b4002d](https://github.com/boycce/monastery/commit/4b4002d3d4d2609025cbb22cacecf948252be38b))
+
+### [1.32.1](https://github.com/boycce/monastery/compare/1.32.0...1.32.1) (2022-03-01)
+
+
+### Bug Fixes
+
+* processAfterFind bug ([3183b79](https://github.com/boycce/monastery/commit/3183b79fc288665000b63e0221fbe8acf6f482aa))
+
 ## [1.32.0](https://github.com/boycce/monastery/compare/1.31.7...1.32.0) (2022-02-28)
 
 
@@ -22,6 +43,7 @@ All notable changes to this project will be documented in this file. See [standa
 
 ### Bug Fixes
 
+* Fixed validateUndefined ([58daed1](https://github.com/boycce/monastery/commit/58daed1ca5317c061a4ddde280bf45b0a134ab30))
 * added partial unqiue index tests ([ff6f193](https://github.com/boycce/monastery/commit/ff6f1938e333407ee17895873d2b42fa5263d7e3))
 * scripts ([bc32680](https://github.com/boycce/monastery/commit/bc326809098ae24686158a0386fbbd6671d86c98))
 

package/docs/image-plugin.md

@@ -30,7 +30,7 @@ let user = db.model('user', { fields: {
     formats: ['bmp', 'gif', 'jpg', 'jpeg', 'png', 'tiff'],
     filename: 'avatar',
     filesize: 1000 * 1000 * 5, // max size in bytes
-    getSignedUrl: true, // get a s3 signed url by default after `find()`
+    getSignedUrl: true, // get a s3 signed url after every `find()` operation (can be overridden per request)
     params: {}, // upload params, https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#upload-property
   },
   logos: [{

package/lib/model-crud.js

@@ -28,11 +28,11 @@ module.exports = {
       ])
 
       // Validate
-      opts.data = await this.validate(opts.data||{}, { ...opts })
+      let data = await this.validate(opts.data||{}, { ...opts })
 
       // Insert
-      await util.runSeries(this.beforeInsert.map(f => f.bind(opts, opts.data)))
-      let response = await this._insert(opts.data, options)
+      await util.runSeries(this.beforeInsert.map(f => f.bind(opts, data)))
+      let response = await this._insert(data, options)
       await util.runSeries(this.afterInsert.map(f => f.bind(opts, response)))
 
       // Success/error
@@ -193,31 +193,32 @@ module.exports = {
     }
     try {
       opts = await this._queryObject(opts, 'update')
+      let data = opts.data
       let response = null
       let operators = util.pluck(opts, [/^\$/])
       let options = util.omit(opts, ['data', 'query', 'respond', 'validateUndefined', 'skipValidation', 'blacklist'])
 
       // Validate
-      if (util.isDefined(opts.data)) opts.data = await this.validate(opts.data, { ...opts })
-      if (!util.isDefined(opts.data) && util.isEmpty(operators)) {
+      if (util.isDefined(data)) data = await this.validate(opts.data, { ...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`)
       }
-      if (util.isDefined(opts.data) && (!opts.data || util.isEmpty(opts.data))) {
+      if (util.isDefined(data) && (!data || util.isEmpty(data))) {
         throw new Error(`No valid data passed to ${this.name}.update({ data: .. })`)
       }
-      // Hook: beforeUpdate
-      await util.runSeries(this.beforeUpdate.map(f => f.bind(opts, opts.data||{})))
-      if (opts.data && operators['$set']) {
+      // 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()\``)
       }
-      if (opts.data || operators['$set']) {
-        operators['$set'] = { ...opts.data, ...(operators['$set'] || {}) }
+      if (data || operators['$set']) {
+        operators['$set'] = { ...data, ...(operators['$set'] || {}) }
       }
       // Update
       let update = await this._update(opts.query, operators, options)
       if (update.n) response = Object.assign(Object.create({ _output: update }), operators['$set']||{})
 
-      // Hook: afterUpdate
+      // Hook: afterUpdate (doesn't have access to validated data)
       if (update.n) await util.runSeries(this.afterUpdate.map(f => f.bind(opts, response)))
 
       // Success
@@ -325,7 +326,7 @@ module.exports = {
     return opts
   },
 
-  _processAfterFind: function(data, projection, afterFindContext) {
+  _processAfterFind: function(data, projection={}, afterFindContext={}) {
     /**
      * Todo: Maybe make this method public?
      * Recurses through fields that are models and populates missing default-fields and calls model.afterFind([fn,..])

package/lib/model-validate.js

@@ -291,7 +291,7 @@ module.exports = {
 
   _ignoredRules: [ // todo: change name? i.e. 'specialFields'
     // Need to remove filesize and formats..
-    'default', 'defaultOverride', 'filename', 'filesize', 'formats', 'image', 'index', 'insertOnly',
+    'default', 'defaultOverride', 'filename', 'filesize', 'fileSize', 'formats', 'image', 'index', 'insertOnly',
     'model', 'nullObject', 'params', 'getSignedUrl', 'timestampField', 'type', 'virtual'
   ]
 

package/package.json

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

package/plugins/images/index.js

@@ -74,7 +74,7 @@ let plugin = module.exports = {
         plugin.addImages(this, data).then(() => n(null, data)).catch(e => n(e))
       })
       model.afterFind.push(function(data, n) {
-        plugin.getSignedUrls(this, data).then(() => n(null, data)).catch(e => n(e))
+        plugin.getSignedUrls.call(model, this, data).then(() => n(null, data)).catch(e => n(e))
       })
     }
   },
@@ -128,15 +128,15 @@ let plugin = module.exports = {
             let uid = nanoid.nanoid()
             let pathFilename = filesArr.imageField.filename ? '/' + filesArr.imageField.filename : ''
             let image = {
-              bucket: this.awsBucket,
-              date: this.manager.useMilliseconds? Date.now() : Math.floor(Date.now() / 1000),
+              bucket: plugin.awsBucket,
+              date: plugin.manager.useMilliseconds? Date.now() : Math.floor(Date.now() / 1000),
               filename: file.name,
               filesize: file.size,
               path: `${plugin.bucketDir}/${uid}${pathFilename}.${file.ext}`,
               // sizes: ['large', 'medium', 'small'],
               uid: uid,
             }
-            this.manager.info(
+            plugin.manager.info(
               `Uploading '${image.filename}' to '${image.bucket}/${image.path}'`
             )
             if (test) {
@@ -144,7 +144,7 @@ let plugin = module.exports = {
               resolve()
             } else {
               plugin.s3.upload({
-                Bucket: this.awsBucket,
+                Bucket: plugin.awsBucket,
                 Key: image.path,
                 Body: file.data,
                 // The IAM permission "s3:PutObjectACL" must be included in the appropriate policy
@@ -183,16 +183,23 @@ let plugin = module.exports = {
   },
 
   getSignedUrls: async function(options, data) {
+    /**
+     * Get signed urls for all image objects in data
+     * @param {object} options - monastery operation options {model, query, files, ..}
+     * @param {object} data
+     * @return promise(data)
+     * @this model
+     */
     // Not wanting signed urls for this operation?
     if (util.isDefined(options.getSignedUrls) && !options.getSignedUrls) return
 
     // Find all image objects in data
     for (let doc of util.toArray(data)) {
-      for (let imageField of options.model.imageFields) {
+      for (let imageField of this.imageFields) {
         if (options.getSignedUrls || imageField.getSignedUrl) {
           let images = plugin._findImagesInData(doc, imageField, 0, '').filter(o => o.image)
           for (let image of images) {
-            image.image.signedUrl = this._getSignedUrl(image.image.path)
+            image.image.signedUrl = plugin._getSignedUrl(image.image.path)
           }
         }
       }
@@ -330,7 +337,7 @@ let plugin = module.exports = {
         { Key: `medium/${key}.jpg` },
         { Key: `large/${key}.jpg` }
       )
-      this.manager.info(
+      plugin.manager.info(
         `Removing '${pre.image.filename}' from '${pre.image.bucket}/${pre.image.path}'`
       )
     }
@@ -448,12 +455,12 @@ let plugin = module.exports = {
       // Subdocument field
       if (util.isSubdocument(field)) {//schema.isObject
         // log(`Recurse 1: ${path2}`)
-        list = list.concat(this._findAndTransformImageFields(field, path2))
+        list = list.concat(plugin._findAndTransformImageFields(field, path2))
 
       // Array field
       } else if (util.isArray(field)) {//schema.isArray
         // log(`Recurse 2: ${path2}`)
-        list = list.concat(this._findAndTransformImageFields(field, path2))
+        list = list.concat(plugin._findAndTransformImageFields(field, path2))
 
       // Image field. Test for field.image as field.type may be 'any'
       } else if (field.type == 'image' || field.image) {
@@ -507,7 +514,7 @@ let plugin = module.exports = {
           if (`${dataPath}.${m}`.match(imageField.fullPathRegex)) {
             list.push({ imageField: imageField, dataPath: `${dataPath}.${m}`, image: target[m] })
           } else {
-            list.push(...this._findImagesInData(
+            list.push(...plugin._findImagesInData(
               target[m],
               imageField,
               imageFieldChunkIndex+i+1,

package/test/crud.js

@@ -3,6 +3,7 @@
 module.exports = function(monastery, opendb) {
 
   test('basic operator calls', async () => {
+    // Todo: take out and group query/id parsing tests
     let db = (await opendb(null)).db
     let user = db.model('user', {
       fields: {
@@ -53,20 +54,23 @@ module.exports = function(monastery, opendb) {
     let find6 = await user.find(inserted2[0]._id.toString())
     expect(find6).toEqual({ _id: inserted2[0]._id, name: 'Martin Luther1' })
 
-    // Missing parameters
-    await expect(user.find()).rejects.toThrow('Please pass an object or MongoId to options.query')
-    await expect(user.find(undefined)).rejects.toThrow('Please pass an object or MongoId to options.query')
-    await expect(user.find({})).rejects.toThrow('Please pass an object or MongoId to options.query')
-    await expect(user.find({ query: null })).rejects.toThrow('Please pass an object or MongoId to options.query')
-    await expect(user.find({ query: undefined })).rejects.toThrow('Please pass an object or MongoId to options.query')
-    await expect(user.find({ query: { _id: undefined }}))
-      .rejects.toThrow('Please pass an object or MongoId to options.query')
-    await expect(user.find(1)).rejects.toThrow('Please pass an object or MongoId to options.query')
-
-    // Bad MongoID
-    await expect(user.find({ query: '' })).resolves.toEqual(null)
-    await expect(user.find('bad-id')).resolves.toEqual(null)
+    // Bad ids
+    let badIdOrQuery = 'Please pass an object or MongoId to options.query'
+    await expect(user.find()).rejects.toThrow(badIdOrQuery)
+    await expect(user.find(1)).rejects.toThrow(badIdOrQuery)
+    await expect(user.find(null)).rejects.toThrow(badIdOrQuery)
+    await expect(user.find(undefined)).rejects.toThrow(badIdOrQuery)
+    await expect(user.find({})).rejects.toThrow(badIdOrQuery)
+    await expect(user.find({ query: null })).rejects.toThrow(badIdOrQuery)
+    await expect(user.find({ query: undefined })).rejects.toThrow(badIdOrQuery)
+    await expect(user.find({ query: { _id: undefined }})).rejects.toThrow(badIdOrQuery)
+
+    // Parseable
     await expect(user.find('')).resolves.toEqual(null)
+    await expect(user.find('invalid-id')).resolves.toEqual(null)
+    await expect(user.find({ query: '' })).resolves.toEqual(null)
+    await expect(user.find({ query: { _id: '' }})).resolves.toEqual(null)
+    await expect(user.find({ query: { _id: null }})).resolves.toEqual([]) // should throw error
 
     // FindOne (query id)
     let findOne = await user.findOne({ query: inserted._id })
@@ -516,6 +520,26 @@ module.exports = function(monastery, opendb) {
       last: 'Luther'
     })
 
+    // beforeUpdate/beforeInsert should have access to the original non-validated data
+    let user2 = db.model('user2', {
+      fields: {
+        first: { type: 'string' },
+      },
+      beforeInsert: [function (data, next) {
+        if (this.data.bad === true && !data.bad) next(new Error('error1'))
+        else next()
+      }],
+      beforeUpdate: [function (data, next) {
+        if (this.data.bad === true && !data.bad) next(new Error('error2'))
+        else next()
+      }],
+    })
+    let userDoc2 = await user2._insert({ first: 'M' })
+    await expect(user2.insert({ data: { first: 'M' } })).resolves.toMatchObject({ first: 'M' })
+    await expect(user2.insert({ data: { first: 'M', bad: true } })).rejects.toThrow('error1')
+    await expect(user2.update({ query: userDoc2._id, data: { first: 'M',  } })).resolves.toEqual({ first: 'M' })
+    await expect(user2.update({ query: userDoc2._id, data: { first: 'M', bad: true } })).rejects.toThrow('error2')
+
     db.close()
   })
 

package/test/plugin-images.js

@@ -161,7 +161,7 @@ module.exports = function(monastery, opendb) {
       let express = require('express')
       let upload = require('express-fileupload')
       let app = express()
-      app.use(upload({ limits: { fileSize: 1 * 1000 * 1000, files: 10 }}))
+      app.use(upload({ limits: { filesize: 1 * 1000 * 1000, files: 10 }}))
 
       app.post('/', function(req, res) {
         // Files exist
@@ -292,7 +292,7 @@ module.exports = function(monastery, opendb) {
       let express = require('express')
       let upload = require('express-fileupload')
       let app = express()
-      app.use(upload({ limits: { fileSize: 1 * 1000 * 1000, files: 10 }}))
+      app.use(upload({ limits: { filesize: 1 * 1000 * 1000, files: 10 }}))
 
       app.post('/', function(req, res) {
         req.body.logos = JSON.parse(req.body.logos)
@@ -368,7 +368,7 @@ module.exports = function(monastery, opendb) {
       let express = require('express')
       let upload = require('express-fileupload')
       let app = express()
-      app.use(upload({ limits: { fileSize: 1 * 1000 * 1000, files: 10 }}))
+      app.use(upload({ limits: { filesize: 1 * 1000 * 1000, files: 10 }}))
 
       app.post('/', function(req, res) {
         try {
@@ -417,7 +417,7 @@ module.exports = function(monastery, opendb) {
         imageSvgBad:  { type: 'image' },
         imageSvgGood: { type: 'image', formats: ['svg'] },
         imageSvgAny:  { type: 'image', formats: ['any'] },
-        imageSize1:   { type: 'image', fileSize: 1000 * 100 },
+        imageSize1:   { type: 'image', filesize: 1000 * 100 },
         imageSize2:   { type: 'image' },
       }})
 
@@ -426,7 +426,7 @@ module.exports = function(monastery, opendb) {
       let express = require('express')
       let upload = require('express-fileupload')
       let app = express()
-      app.use(upload({ limits: { fileSize: 1000 * 200, files: 10 }}))
+      app.use(upload({ limits: { filesize: 1000 * 200, files: 10 }}))
 
       app.post('/', async (req, res) => {
         let imageSvgBad = { imageSvgBad: req.files.imageSvgBad }
@@ -734,29 +734,27 @@ module.exports = function(monastery, opendb) {
       photos2: [image, image],
     })
 
-    // Find signed URL
+    // Find signed URL via query option
+    let imageWithSignedUrl = { ...image, signedUrl: expect.stringMatching(/^https/) }
     await expect(db.user.findOne({ query: userInserted._id, getSignedUrls: true })).resolves.toEqual({
       _id: expect.any(Object),
-      photos: [
-        { ...image, signedUrl: expect.stringMatching(/^https/) },
-        { ...image, signedUrl: expect.stringMatching(/^https/) },
-      ],
-      photos2: [
-        { ...image, signedUrl: expect.stringMatching(/^https/) },
-        { ...image, signedUrl: expect.stringMatching(/^https/) },
-      ]
+      photos: [imageWithSignedUrl, imageWithSignedUrl],
+      photos2: [imageWithSignedUrl, imageWithSignedUrl],
     })
-    // Find signed URL
+
+    // Find signed URL via schema option
     await expect(db.user.findOne({ query: userInserted._id })).resolves.toEqual({
       _id: expect.any(Object),
-      photos: [
-        { ...image },
-        { ...image },
-      ],
-      photos2: [
-        { ...image, signedUrl: expect.stringMatching(/^https/) },
-        { ...image, signedUrl: expect.stringMatching(/^https/) },
-      ]
+      photos: [image, image],
+      photos2: [imageWithSignedUrl, imageWithSignedUrl],
+    })
+
+    // Works with _processAfterFind
+    let rawUser = await db.user._findOne({ _id: userInserted._id })
+    await expect(db.user._processAfterFind(rawUser)).resolves.toEqual({
+      _id: expect.any(Object),
+      photos: [image, image],
+      photos2: [imageWithSignedUrl, imageWithSignedUrl],
     })
 
     db.close()