monastery 1.36.0 → 1.36.3

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()
+  })
+
 }

package/test/crud.js

@@ -145,7 +145,7 @@ module.exports = function(monastery, opendb) {
     db2.close()
   })
 
-  test('update basics', async () => {
+  test('update general', async () => {
     let db = (await opendb(null)).db
     let user = db.model('user', {
       fields: {
@@ -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: {
@@ -335,7 +406,7 @@ module.exports = function(monastery, opendb) {
 
   test('find default field population', async () => {
     let db = (await opendb(null)).db
-    let user = db.model('user', {
+    db.model('user', {
       fields: {
         name: { type: 'string', default: 'Martin Luther' },
         addresses: [{ city: { type: 'string' }, country: { type: 'string', default: 'Germany' } }],
@@ -344,7 +415,7 @@ module.exports = function(monastery, opendb) {
         dogs: [{ model: 'dog' }], // virtual association
       }
     })
-    let dog = db.model('dog', {
+    db.model('dog', {
       fields: {
         name: { type: 'string', default: 'Scruff' },
         user: { model: 'user' }
@@ -352,35 +423,35 @@ module.exports = function(monastery, opendb) {
     })
 
     // Default field doesn't override null
-    let nulldoc1 = await dog.insert({ data: { name: null }})
-    let nullfind1 = await dog.findOne({ query: nulldoc1._id })
+    let nulldoc1 = await db.dog.insert({ data: { name: null }})
+    let nullfind1 = await db.dog.findOne({ query: nulldoc1._id })
     expect(nullfind1).toEqual({ _id: nulldoc1._id, name: null })
 
     // Default field doesn't override empty string
-    let nulldoc2 = await dog.insert({ data: { name: '' }})
-    let nullfind2 = await dog.findOne({ query: nulldoc2._id })
+    let nulldoc2 = await db.dog.insert({ data: { name: '' }})
+    let nullfind2 = await db.dog.findOne({ query: nulldoc2._id })
     expect(nullfind2).toEqual({ _id: nulldoc2._id, name: '' })
 
     // Default field overrides undefined
-    let nulldoc3 = await dog.insert({ data: { name: undefined }})
-    let nullfind3 = await dog.findOne({ query: nulldoc3._id })
+    let nulldoc3 = await db.dog.insert({ data: { name: undefined }})
+    let nullfind3 = await db.dog.findOne({ query: nulldoc3._id })
     expect(nullfind3).toEqual({ _id: nullfind3._id, name: 'Scruff' })
 
     // Default field population test
-    // Note that addresses.1.country shouldn't be overriden
+    // Note that addresses.1.country shouldn't be overridden
     // Insert documents (without defaults)
-    let inserted = await dog._insert({})
-    let inserted2 = await user._insert({
+    let dog1 = await db.dog._insert({})
+    let user1 = await db.user._insert({
       addresses: [
         { city: 'Frankfurt' },
         { city: 'Christchurch', country: 'New Zealand' }
       ],
-      pet: { dog: inserted._id }
+      pet: { dog: dog1._id }
     })
-    await dog._update(inserted._id, { $set: { user: inserted2._id }})
+    await db.dog._update(dog1._id, { $set: { user: user1._id }})
 
-    let find1 = await user.findOne({
-      query: inserted2._id,
+    let find1 = await db.user.findOne({
+      query: user1._id,
       populate: ['pet.dog', {
         from: 'dog',
         localField: '_id',
@@ -389,20 +460,20 @@ module.exports = function(monastery, opendb) {
       }]
     })
     expect(find1).toEqual({
-      _id: inserted2._id,
+      _id: user1._id,
       name: 'Martin Luther',
       addresses: [
         { city: 'Frankfurt', country: 'Germany' },
         { city: 'Christchurch', country: 'New Zealand' }
       ],
       address: { country: 'Germany' },
-      pet: { dog: { _id: inserted._id, name: 'Scruff', user: inserted2._id }},
-      dogs: [{ _id: inserted._id, name: 'Scruff', user: inserted2._id }]
+      pet: { dog: { _id: dog1._id, name: 'Scruff', user: user1._id }},
+      dogs: [{ _id: dog1._id, name: 'Scruff', user: user1._id }]
     })
 
     // Blacklisted default field population test
-    let find2 = await user.findOne({
-      query: inserted2._id,
+    let find2 = await db.user.findOne({
+      query: user1._id,
       populate: ['pet.dog', {
         from: 'dog',
         localField: '_id',
@@ -413,19 +484,19 @@ module.exports = function(monastery, opendb) {
       // ^ great test (address should cancel addresses if not stopping at the .)
     })
     expect(find2).toEqual({
-      _id: inserted2._id,
+      _id: user1._id,
       name: 'Martin Luther',
       addresses: [{ city: 'Frankfurt' }, { city: 'Christchurch' }],
-      pet: { dog: { _id: inserted._id, name: 'Scruff', user: inserted2._id }},
-      dogs: [{ _id: inserted._id, user: inserted2._id }]
+      pet: { dog: { _id: dog1._id, name: 'Scruff', user: user1._id }},
+      dogs: [{ _id: dog1._id, user: user1._id }]
     })
 
     db.close()
   })
 
-  test('findOneAndUpdate basics', async () => {
+  test('findOneAndUpdate general', async () => {
     // todo: test all findOneAndUpdate options
-
+    // todo: test find & update hooks
     let db = (await opendb(null)).db
     let dog = db.model('dog', {
       fields: {
@@ -478,7 +549,7 @@ module.exports = function(monastery, opendb) {
     db.close()
   })
 
-  test('remove basics', async () => {
+  test('remove general', async () => {
     let db = (await opendb(null)).db
     let user = db.model('userRemove', {
       fields: {