monastery 1.28.5 → 1.30.2

package/plugins/images/index.js

@@ -54,8 +54,11 @@ let plugin = module.exports = {
     model.imageFields = plugin._findAndTransformImageFields(model.fields, '')
 
     if (model.imageFields.length) {
-      // Update image fields and whitelists with the new object schema
-      // model._setupFieldsAndWhitelists(model.fields)
+      // Todo?: Update image fields and whitelists with the new object schema
+      //   model._setupFieldsAndWhitelists(model.fields)
+      model.beforeValidate.push(function(data, n) {
+        plugin.keepImagePlacement(this, data).then(() => n(null, data)).catch(e => n(e))
+      })
       model.beforeUpdate.push(function(data, n) {
         plugin.removeImages(this, data).then(() => n(null, data)).catch(e => n(e))
       })
@@ -91,7 +94,9 @@ let plugin = module.exports = {
      * @param {object} options - monastery operation options {model, query, files, ..}
      * @param {object} data -
      * @param {boolean} test -
-     * @return promise
+     * @return promise(
+     *   {object} data - data object containing new S3 image-object
+     * ])
      * @this plugin
      */
     let { model, query, files } = options
@@ -167,7 +172,33 @@ let plugin = module.exports = {
     })
   },
 
-  removeImages: function(options, data, test) {
+  keepImagePlacement: async function(options, data) {
+    /**
+     * Hook before update/remove
+     * Since monastery removes undefined array items on validate, we need to convert any
+     * undefined array items to null where files are located to maintain image ordering
+     * Todo: maybe dont remove undefined array items in general
+     *
+     * E.g.
+     * req.body  = 'photos[0]' : undefined || non existing (set to null)
+     * req.files = 'photos[0]' : { ...binary }
+     *
+     * @param {object} options - monastery operation options {query, model, files, multi, ..}
+     * @return promise
+     * @this plugin
+     */
+    if (typeof options.files == 'undefined') return
+    // Check upload errors and find valid uploaded images
+    let files = await plugin._findValidImages(options.files || {}, options.model)
+    // Set undefined primative-array items to null where files are located
+    for (let filesArray of files) {
+      if (filesArray.inputPath.match(/\.[0-9]+$/)) {
+        util.setDeepValue(data, filesArray.inputPath, null, true, false, true)
+      }
+    }
+  },
+
+  removeImages: async function(options, data, test) {
     /**
      * Hook before update/remove
      * Removes images not found in data, this means you will need to pass the image objects to every update operation
@@ -179,108 +210,113 @@ let plugin = module.exports = {
      *
      * @ref https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#deleteObjects-property
      * @param {object} options - monastery operation options {query, model, files, multi, ..}
-     * @return promise
+     * @return promise([
+     *   {object} useCount - images that wont be removed, e.g. { lion1: 1 }
+     *   {array} unused - S3 image uris to be removed,  e.g. [{ Key: 'small/lion1.jpg' }, ..]
+     * ])
      * @this plugin
      */
     let pre
     let preExistingImages = []
     let useCount = {}
-    if (typeof options.files == 'undefined') return new Promise(res => res())
+    if (typeof options.files == 'undefined') return
 
     // Find all documents from the same query
-    return options.model._find(options.query, options)
-      .then(docs => {
-        // Find all pre-existing image objects in documents
-        for (let doc of util.toArray(docs)) { //x2
-          for (let imageField of options.model.imageFields) { //x5
-            let images = plugin._findImagesInData(doc, imageField, 0, '').filter(o => o.image)
-            for (let image of images) {
-              preExistingImages.push(image)
-              useCount[image.image.uid] = (useCount[image.image.uid] || 0) + 1
-            }
-          }
+    let docs = await options.model._find(options.query, options)
+
+    // Find all pre-existing image objects in documents
+    for (let doc of util.toArray(docs)) { //x2
+      for (let imageField of options.model.imageFields) { //x5
+        let images = plugin._findImagesInData(doc, imageField, 0, '').filter(o => o.image)
+        for (let image of images) {
+          preExistingImages.push(image)
+          useCount[image.image.uid] = (useCount[image.image.uid] || 0) + 1
         }
+      }
+    }
 
-        // console.log(1, useCount, preExistingImages)
+    // console.log(1, useCount, preExistingImages)
 
-        // Assign pre-existing images within undefined deep objects and missing array items to null
-        // ignore undefined root images
-        let dataFilled = util.deepCopy(data)
-        for (let key in dataFilled) {
-          for (let pre of preExistingImages) {
-            if (!pre.dataPath.match(new RegExp('^' + key + '(\\.|$)'))) continue
-            util.setDeepValue(dataFilled, pre.dataPath, null, true)
-          }
-        }
+    // Assign pre-existing images within undefined deep objects and missing array items to null,
+    // ignore undefined root images
+    let dataFilled = util.deepCopy(data)
+    for (let key in dataFilled) {
+      for (let pre of preExistingImages) {
+        if (!pre.dataPath.match(new RegExp('^' + key + '(\\.|$)'))) continue
+        util.setDeepValue(dataFilled, pre.dataPath, null, true)
+      }
+    }
+    // console.log(dataFilled)
 
-        // Loop all schema image fields
-        for (let imageField of options.model.imageFields) { //x5
-          let images = plugin._findImagesInData(dataFilled, imageField, 0, '')
-          if (!images.length) continue
-          // console.log(images)
+    // Check upload errors and find valid uploaded images
+    let files = await plugin._findValidImages(options.files || {}, options.model)
 
-          // Data contains null images that once had a pre-existing image
-          for (let image of images) {
-            if (image.image == null && (pre = preExistingImages.find(o => o.dataPath == image.dataPath))) {
-              useCount[pre.image.uid]--
-            }
-          }
+    // Loop all schema image fields
+    for (let imageField of options.model.imageFields) { //x5
+      let images = plugin._findImagesInData(dataFilled, imageField, 0, '')
+      if (!images.length) continue
+      // console.log(images)
 
-          // Data contains valid (pre-existing) image-objects? And are we overriding a pre-existing image?
-          for (let image of images) {
-            if (image.image != null) {
-              let pre = preExistingImages.find(o => o.dataPath == image.dataPath)
-              if (typeof useCount[image.image.uid] == 'undefined') {
-                throw `The passed image object for '${image.dataPath}' does not match any pre-existing
-                  images saved on this document.`
-              } else if (pre && pre.image.uid != image.image.uid) {
-                useCount[pre.image.uid]--
-                useCount[image.image.uid]++
-              } else if (!pre) {
-                useCount[image.image.uid]++
-              }
-            }
-          }
+      // Data contains null images that once had a pre-existing image
+      for (let image of images) {
+        if (image.image == null && (pre = preExistingImages.find(o => o.dataPath == image.dataPath))) {
+          useCount[pre.image.uid]--
         }
-        // Check upload errors and find valid uploaded images. If any file is overriding a
-        // pre-existing image, push to unused
-        return plugin._findValidImages(options.files || {}, options.model).then(files => {
+      }
+
+      // Loop images found in the data
+      for (let image of images) {
+        if (image.image != null) {
+          let preExistingImage = preExistingImages.find(o => o.dataPath == image.dataPath)
+          // valid image-object?
+          if (typeof useCount[image.image.uid] == 'undefined') {
+            throw `The passed image object for '${image.dataPath}' does not match any pre-existing
+              images saved on this document.`
+          // Different image from prexisting image
+          } else if (preExistingImage && preExistingImage.image.uid != image.image.uid) {
+            useCount[preExistingImage.image.uid]--
+            useCount[image.image.uid]++
+          // No pre-existing image found
+          } else if (!preExistingImage) {
+            useCount[image.image.uid]++
+          }
+          // Any file overriding this image?
           for (let filesArray of files) {
-            if ((pre = preExistingImages.find(o => o.dataPath == filesArray.inputPath))) {
-              useCount[pre.image.uid]--
+            if (image.dataPath == filesArray.inputPath) {
+              useCount[image.image.uid]--
             }
           }
-        })
-
-      }).then(() => {
-        // Retrieve all the unused files
-        let unused = []
-        // console.log(3, useCount)
-        for (let key in useCount) {
-          if (useCount[key] > 0) continue
-          let pre = preExistingImages.find(o => o.image.uid == key)
-          unused.push(
-            // original key can have a different extension
-            { Key: pre.image.path },
-            { Key: `small/${key}.jpg` },
-            { Key: `medium/${key}.jpg` },
-            { Key: `large/${key}.jpg` }
-          )
-          this.manager.info(
-            `Removing '${pre.image.filename}' from '${pre.image.bucket}/${pre.image.path}'`
-          )
         }
-        if (test) return Promise.resolve([useCount, unused])
-        // Delete any unused images from s3. If the image is on a different bucket
-        // the file doesnt get deleted, we only delete from plugin.awsBucket.
-        if (!unused.length) return
-        return new Promise((resolve, reject) => {
-          plugin.s3.deleteObjects({ Bucket: plugin.awsBucket, Delete: { Objects: unused }}, (err, data) => {
-            if (err) reject(err)
-            resolve()
-          })
-        })
+      }
+    }
+
+    // Retrieve all the unused files
+    // console.log(3, useCount)
+    let unused = []
+    for (let key in useCount) {
+      if (useCount[key] > 0) continue
+      let pre = preExistingImages.find(o => o.image.uid == key)
+      unused.push(
+        // original key can have a different extension
+        { Key: pre.image.path },
+        { Key: `small/${key}.jpg` },
+        { Key: `medium/${key}.jpg` },
+        { Key: `large/${key}.jpg` }
+      )
+      this.manager.info(
+        `Removing '${pre.image.filename}' from '${pre.image.bucket}/${pre.image.path}'`
+      )
+    }
+    if (test) return [useCount, unused]
+    // Delete any unused images from s3. If the image is on a different bucket
+    // the file doesnt get deleted, we only delete from plugin.awsBucket.
+    if (!unused.length) return
+    await new Promise((resolve, reject) => {
+      plugin.s3.deleteObjects({ Bucket: plugin.awsBucket, Delete: { Objects: unused }}, (err, data) => {
+        if (err) reject(err)
+        resolve()
       })
+    })
   },
 
   _addImageObjectsToData: function(path, data, image) {

package/test/model.js

@@ -116,10 +116,9 @@ module.exports = function(monastery, opendb) {
   })
 
   test('Model indexes', async () => {
-    // Need to test different types of indexes
+    // Setup: Need to test different types of indexes
     let db = (await opendb(null)).db
-
-    // Drop previously tested collections
+    // Setup: Drop previously tested collections
     if ((await db._db.listCollections().toArray()).find(o => o.name == 'userIndexRaw')) {
       await db._db.collection('userIndexRaw').drop()
     }
@@ -190,6 +189,96 @@ module.exports = function(monastery, opendb) {
     db.close()
   })
 
+  test('Model subdocument indexes', async () => {
+    // Setup: Need to test different types of indexes
+    let db = (await opendb(null)).db
+    // Setup: Drop previously tested collections
+    if ((await db._db.listCollections().toArray()).find(o => o.name == 'userIndexSubdoc')) {
+      await db._db.collection('userIndexSubdoc').drop()
+    }
+    // Run
+    let userModel = await db.model('userIndexSubdoc', {
+      fields: {}
+    })
+    await expect(userModel._setupIndexes(
+      {
+        animals: {
+          name: { type: 'string', index: 'unique' },
+        },
+        animals2: {
+          names: {
+            name: { type: 'string', index: 'unique' },
+          },
+        },
+        animals3: {
+          names: {
+            name: { type: 'string', index: 'text' },
+          },
+        },
+      }, {
+        dryRun: true
+      }
+    )).resolves.toEqual([{
+      'key': { 'animals.name': 1 },
+      'name': 'animals.name_1',
+      'unique': true,
+    }, {
+      'key': { 'animals2.names.name': 1 },
+      'name': 'animals2.names.name_1',
+      'unique': true,
+    }, {
+      'key': { 'animals3.names.name': 'text' },
+      'name': 'text',
+    }])
+
+    db.close()
+  })
+
+  test('Model array indexes', async () => {
+    // Setup: Need to test different types of indexes
+    let db = (await opendb(null)).db
+    // Setup: Drop previously tested collections
+    if ((await db._db.listCollections().toArray()).find(o => o.name == 'userIndexArray')) {
+      await db._db.collection('userIndexArray').drop()
+    }
+    // Run
+    let userModel = await db.model('userIndexArray', {
+      fields: {}
+    })
+    await expect(userModel._setupIndexes(
+      {
+        animals: [{
+          name: { type: 'string', index: 'unique' },
+        }],
+        animals2: [{ type: 'string', index: true }],
+        animals3: [[{ type: 'string', index: true }]],
+        animals4: [{
+          names: [{
+            name: { type: 'string', index: 'unique' },
+          }],
+        }],
+      }, {
+        dryRun: true
+      }
+    )).resolves.toEqual([{
+      'key': { 'animals.name': 1 },
+      'name': 'animals.name_1',
+      'unique': true,
+    }, {
+      'key': { 'animals2': 1 },
+      'name': 'animals2_1',
+    }, {
+      'key': { 'animals3.0': 1 },
+      'name': 'animals3.0_1',
+    }, {
+      'key': { 'animals4.names.name': 1 },
+      'name': 'animals4.names.name_1',
+      'unique': true,
+    }])
+
+    db.close()
+  })
+
   test('Model 2dsphere indexes', async () => {
     // Setup. The tested model needs to be unique as race condition issue arises when the same model
     // with text indexes are setup at the same time

package/test/plugin-images.js

@@ -1,3 +1,5 @@
+let util = require('../lib/util')
+
 module.exports = function(monastery, opendb) {
 
   // Data no images doesn't throw error
@@ -299,13 +301,8 @@ module.exports = function(monastery, opendb) {
 
         plugin.removeImages(options, req.body, true)
           .then(res => {
-            expect(res[0]).toEqual({ test1: 0, test2: -1, test3: 1, test4: 0 })
+            expect(res[0]).toEqual({ test1: 1, test2: 0, test3: 1, test4: 0 })
             expect(res[1]).toEqual([
-              { Key: 'dir/test1.png' },
-              { Key: 'small/test1.jpg' },
-              { Key: 'medium/test1.jpg' },
-              { Key: 'large/test1.jpg' },
-
               { Key: 'dir/test2.png' },
               { Key: 'small/test2.jpg' },
               { Key: 'medium/test2.jpg' },
@@ -560,4 +557,154 @@ module.exports = function(monastery, opendb) {
     })()
   })
 
+  test('images reorder', async () => {
+    let db = (await opendb(null, {
+      timestamps: false,
+      serverSelectionTimeoutMS: 2000,
+      imagePlugin: { awsBucket: 'fake', awsAccessKeyId: 'fake', awsSecretAccessKey: 'fake' }
+    })).db
+
+    let user = db.model('user', { fields: {
+      logos: [{ type: 'image' }],
+    }})
+
+    let image = {
+      bucket: 'test',
+      date: 1234,
+      filename: 'lion1.png',
+      filesize: 1234,
+      path: 'test/lion1.png',
+      uid: 'lion1'
+    }
+
+    let user1 = await db.user._insert({
+      logos: [image],
+    })
+
+    let plugin = db.imagePluginFile
+    let supertest = require('supertest')
+    let express = require('express')
+    let upload = require('express-fileupload')
+    let app = express()
+    app.use(upload())
+
+    // Reorder
+    app.post('/', async function(req, res) {
+      try {
+        req.body.logos = JSON.parse(req.body.logos)
+        let options = { files: req.files, model: user, query: { _id: user1._id } }
+        let response = await plugin.removeImages(options, req.body, true)
+        expect(response[0]).toEqual({ lion1: 1 })
+        expect(response[1]).toEqual([])
+        res.send()
+      } catch (e) {
+        console.log(e.message || e)
+        res.status(500).send()
+      }
+    })
+    await supertest(app)
+      .post('/')
+      .field('logos', JSON.stringify([ null, image ]))
+      .expect(200)
+
+    db.close()
+  })
+
+  test('images reorder and added image', async () => {
+    // latest (2022.02)
+    let db = (await opendb(null, {
+      timestamps: false,
+      serverSelectionTimeoutMS: 2000,
+      imagePlugin: { awsBucket: 'fake', awsAccessKeyId: 'fake', awsSecretAccessKey: 'fake' }
+    })).db
+
+    let user = db.model('user', { fields: {
+      photos: [{ type: 'image' }],
+    }})
+
+    let image = {
+      bucket: 'test',
+      date: 1234,
+      filename: 'lion1.png',
+      filesize: 1234,
+      path: 'test/lion1.png',
+      uid: 'lion1'
+    }
+
+    let user1 = await db.user._insert({
+      photos: [image],
+    })
+
+    let plugin = db.imagePluginFile
+    let supertest = require('supertest')
+    let express = require('express')
+    let upload = require('express-fileupload')
+    let app = express()
+    app.use(upload())
+
+    app.post('/', async function(req, res) {
+      try {
+        // Parse and validate data which is used before in update/insert
+        let options = { files: req.files, model: user, query: { _id: user1._id } }
+        let data = await util.parseData(req.body)
+        data = await user.validate(data, { ...options, update: true })
+
+        // Empty photo placeholder not removed in validate?
+        expect(data.photos[0]).toEqual(null)
+        expect(data.photos[1]).toEqual(image)
+
+        // Remove images
+        let response = await plugin.removeImages(options, data, true)
+        expect(response[0]).toEqual({ lion1: 1 }) // useCount
+        expect(response[1]).toEqual([]) // unused
+
+        // New file exists
+        let validFiles = await plugin._findValidImages(req.files, user)
+        expect(((validFiles||[])[0]||{}).inputPath).toEqual('photos.0') // Valid inputPath
+
+        // Add images
+        response = await plugin.addImages(options, data, true)
+        expect(response[0]).toEqual({
+          photos: [{
+            bucket: 'fake',
+            date: expect.any(Number),
+            filename: 'lion2.jpg',
+            filesize: expect.any(Number),
+            path: expect.any(String),
+            uid: expect.any(String)
+          }, {
+            bucket: 'test', // still the same image-object reference (nothing new)
+            date: expect.any(Number),
+            filename: 'lion1.png',
+            filesize: expect.any(Number),
+            path: expect.any(String),
+            uid: expect.any(String)
+          },],
+        })
+
+        res.send()
+      } catch (e) {
+        console.log(e.message || e)
+        res.status(500).send()
+      }
+    })
+
+    await supertest(app)
+      .post('/')
+      // Mock multipart/form-data syntax which is not supported by supertest (formdata sent with axios)
+      //  E.g.
+      //    req.body  = 'photos[1][bucket]' : '...'
+      //    req.files = 'photos[0]' : { ...binary }
+      .field('photos[1][bucket]', image.bucket)
+      .field('photos[1][date]', image.date)
+      .field('photos[1][filename]', image.filename)
+      .field('photos[1][filesize]', image.filesize)
+      .field('photos[1][path]', image.path)
+      .field('photos[1][uid]', image.uid)
+      .attach('photos[0]', `${__dirname}/assets/lion2.jpg`)
+      .expect(200)
+
+    db.close()
+  })
+
 }