monastery 1.36.2 → 1.36.3

package/changelog.md

@@ -2,6 +2,13 @@
 
 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.36.3](https://github.com/boycce/monastery/compare/1.36.2...1.36.3) (2022-05-27)
+
+
+### Bug Fixes
+
+* order maintained when mixing of formData/dotNotation with normal key values ([898fa90](https://github.com/boycce/monastery/commit/898fa90a25e81ae1d2413e32ca67173fdef733a9))
+
 ### [1.36.2](https://github.com/boycce/monastery/compare/1.36.1...1.36.2) (2022-05-26)
 
 

package/lib/util.js

@@ -163,8 +163,15 @@ module.exports = {
      * Mutates dot notation objects into a deep object
      * @param {object}
      */
+    let original = this.deepCopy(obj)
     for (let key in obj) {
-      if (key.indexOf('.') !== -1) recurse(key, obj[key], obj)
+      if (key.indexOf('.') !== -1) {
+        recurse(key, obj[key], obj)
+      } else {
+        // Ordinary values may of been updated by the bracket notation values, we are
+        // reassigning, trying to preserve the order of keys (not always guaranteed in for loops)
+        obj[key] = original[key]
+      }
     }
     return obj
     function recurse(str, val, obj) {
@@ -188,6 +195,7 @@ module.exports = {
   },
 
   parseFormData: function(obj) {
+    let original = this.deepCopy(obj)
     /**
      * Mutates FormData (bracket notation) objects into a deep object
      * @param {object}
@@ -203,6 +211,10 @@ module.exports = {
         }
         if (key.indexOf('[') !== -1) {
           setup(key)
+        } else {
+          // Ordinary values may of been updated by the bracket notation values, we are
+          // reassigning, trying to preserve the order of keys (not always guaranteed in for loops)
+          obj[key] = original[key]
         }
       }
       res(obj)

package/package.json

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

package/test/crud.js

@@ -309,6 +309,77 @@ module.exports = function(monastery, opendb) {
     db.close()
   })
 
+  test('update mixing formData', async() => {
+    // Mixing data
+    let db = (await opendb(null)).db
+    let consignment = db.model('consignment', {
+      fields: {
+        specialInstructions: [{
+          text: { type: 'string' },
+          createdAt: { type: 'date' },
+          updatedByName: { type: 'string' },
+          importance: { type: 'string' },
+        }],
+      },
+    })
+    let inserted = await consignment.insert({
+      data: {
+        specialInstructions: [{
+          text: 'filler',
+          createdAt: 1653601752472,
+          updatedByName: 'Paul',
+          importance: 'low'
+        }]
+      }
+    })
+    let specialInstructions = [
+      {
+        text: 'POD added by driver',
+        createdAt: 1653603212886,
+        updatedByName: 'Paul Driver 3',
+        importance: 'low'
+      }, {
+        text: 'filler',
+        createdAt: 1653601752472,
+        updatedByName: 'Paul',
+        importance: 'low'
+      }
+    ]
+    // Key order maintained (not always guaranteed)
+    await consignment.update({
+      query: inserted._id,
+      data: {
+        'specialInstructions[0][text]': 'filler',
+        'specialInstructions[0][createdAt]': 1653601752472,
+        'specialInstructions[0][updatedByName]': 'Paul',
+        'specialInstructions[0][importance]': 'low',
+        specialInstructions: specialInstructions.map(o => ({ ...o })),
+      }
+    })
+    await expect(consignment.findOne({ query: inserted._id })).resolves.toEqual({
+      _id: expect.any(Object),
+      specialInstructions: specialInstructions,
+    })
+
+    // Key order maintained (not always guaranteed)
+    await consignment.update({
+      query: inserted._id,
+      data: {
+        specialInstructions: specialInstructions.map(o => ({ ...o })),
+        'specialInstructions[0][text]': 'filler',
+        'specialInstructions[0][createdAt]': 1653601752472,
+        'specialInstructions[0][updatedByName]': 'Paul',
+        'specialInstructions[0][importance]': 'low',
+      }
+    })
+    await expect(consignment.findOne({ query: inserted._id })).resolves.toEqual({
+      _id: expect.any(Object),
+      specialInstructions: [specialInstructions[1], specialInstructions[1]],
+    })
+
+    db.close()
+  })
+
   test('insert with id casting', async () => {
     let db = (await opendb(null)).db
     db.model('company', { fields: {

package/test/validate.js

@@ -906,16 +906,18 @@ module.exports = function(monastery, opendb) {
         },
       },
     })
-
-    // Subdocument data (null/string)
-    await expect(user.validate({ location: null })).rejects.toEqual([{
+    let requiredError = [{
       'detail': 'This field is required.',
       'meta': {'detailLong': undefined, 'field': 'location', 'model': 'user', 'rule': 'required'},
       'status': '400',
       'title': 'location'
-    }])
+    }]
+    // required errors
+    await expect(user.validate({ location: null })).rejects.toEqual(requiredError)
+    await expect(user.validate({ location: '' })).rejects.toEqual(requiredError)
+    await expect(user.validate({ location: undefined })).rejects.toEqual(requiredError)
+    // required no error
     await expect(user.validate({ location: {} })).resolves.toEqual({ location: {} })
-
     db.close()
   })