monastery 3.0.14 → 3.0.16

package/changelog.md

@@ -2,6 +2,10 @@
 
 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.
 
+### [3.0.16](https://github.com/boycce/monastery/compare/3.0.15...3.0.16) (2024-05-02)
+
+### [3.0.15](https://github.com/boycce/monastery/compare/3.0.14...3.0.15) (2024-05-01)
+
 ### [3.0.14](https://github.com/boycce/monastery/compare/3.0.13...3.0.14) (2024-05-01)
 
 ### [3.0.13](https://github.com/boycce/monastery/compare/3.0.12...3.0.13) (2024-05-01)

package/docs/model/find.md

@@ -58,30 +58,27 @@ The value of the model reference should be an ID, e.g. `myBook = id`
 ```js
 {
   fields: {
-    myBook: {
-      model: 'book'
-    }
+    myBook: { model: 'book' },
+    myBooks: [{ model: 'books' }], // you can even populate arrays
   }
 }
 ```
 
-You are then able to easily populate returned results via a find operation.
+You are then able to easily populate the returned results in the find method:
 
 ```js
-user.find({ query: {...}, populate: ['myBook'] })
+user.find({ query: {...}, populate: ['myBook', 'myBooks', ...] })
 ```
 
-You can also populate within embedded document fields. Although at this time arrays are not supported,
-you would need to use the [example below](#populate-multiple-documents-into-virtual-fields).
+You can also populate within embedded document fields.
 ```js
 user.find({ query: {...}, populate: ['myBooks.book'] })
 ```
 
 ### Custom Populate Query
 
-If you would like more control you can either use Mongo's `aggregate` method via [`model._aggregate`](./...rawMethods), or simply pass a MongoDB lookup object to populate. When passing a lookup object, the
-populated field still needs to be defined in `definition.fields` if you want to call any related hooks,
-and prune any blacklisted fields. See the examples below,
+If you would like more control you can either use Mongo's `aggregate` method via [`model._aggregate`](./rawMethods), or simply pass a MongoDB lookup object to `populate`. When passing a lookup object, the
+populated field still needs to be defined in `definition.fields` if you want Monastery to process any related hooks, field blacklisting and default values. See the example belows,
 
 #### Populate a single document
 
@@ -93,37 +90,42 @@ user.find({
   populate: [{
     as: 'myBook',
     from: 'book',
+    foreignField: '_id',
     localField: 'myBook',
-    foreignField: '_id'
   }]
 })
 ```
 
 #### Populate multiple documents into virtual fields
 
-Below populates all books into `user.myBooks` with a `bookOwnerId` equal to the `user._id`. Since `myBooks`
-isn't stored on the user, you will need define it as virtual field
+Below populates all books into `user.myBooks` with a `bookOwnerId` equal to the `user._id`. Since `myBooks` isn't stored on the user, you will need define it as virtual field.
 
 ```js
-{
+db.model('user', {
   fields: {
-    myBooks: [{
-      model: 'book',
-      virtual: true
-    }],
+    name: { type: 'string' },
+    myBooks: [{ model: 'book', virtual: true }],
   },
-}
+})
+db.model('book', {
+  fields: {
+    bookTitle: { type: 'string' },
+    bookOwnerId: { model: 'user' },
+  },
+})
+
+// books and user inserted here...
 
 user.find({
   query: {...},
   populate: [{
     as: 'myBooks',
     from: 'book',
-    let: { id: '$_id' },
+    let: { userId: '$_id' },
     pipeline: [{
       $match: {
         $expr: {
-          $eq: ['$bookOwnerId', '$$id']
+          $eq: ['$bookOwnerId', '$$userId']
         }
       }
     }]

package/lib/model-crud.js

@@ -48,9 +48,9 @@ Model.prototype.insert = async function (opts) {
     let data = await this.validate(opts.data || {}, opts) // was { ...opts }
 
     // Insert
-    await util.runSeries(this.beforeInsert.map(f => f.bind(opts, data)), `${this.name}.beforeInsert`)
+    await util.runSeries.call(this, this.beforeInsert.map(f => f.bind(opts, data)), 'beforeInsert')
     let response = await this._insert(data, util.omit(opts, this._queryOptions))
-    await util.runSeries(this.afterInsert.map(f => f.bind(opts, response)), `${this.name}.afterInsert`)
+    await util.runSeries.call(this, this.afterInsert.map(f => f.bind(opts, response)), 'afterInsert')
 
     // Success/error
     if (opts.req && opts.respond) opts.req.res.json(response)
@@ -141,24 +141,40 @@ Model.prototype.find = async function (opts, _one) {
             )
             continue
           }
-          // Convert array into a document for non-array targets
-          if (!arrayTarget) {
+          if (arrayTarget) {
+            // Create lookup
+            lookups.push({ 
+              $lookup: {
+                as: path,
+                from: modelName,
+                let: { arraypath: '$' + path }, // host array path
+                pipeline: [
+                  // Populating an array doesn't return sorted in the original sort order
+                  { $sort: { _id: 1 } },
+                  { $match: { $expr: { $in: ['$_id', '$$arraypath'] } } },
+                ],
+              },
+            })
+          } else {
+            // Convert array into a document for non-array targets
             (opts.addFields = opts.addFields || {})[path] = { '$arrayElemAt': [ '$' + path, 0 ] }
+            // Create basic lookup
+            lookups.push({ 
+              $lookup: {
+                as: path,
+                from: modelName,
+                foreignField: '_id',
+                localField: path,
+              },
+            })
           }
-          // Create lookup
-          lookups.push({ $lookup: {
-            from: modelName,
-            localField: path,
-            foreignField: '_id',
-            as: path,
-          }})
         }
       }
       // console.log(1, opts.projection)
       // console.log(2, lookups)
       let aggregate = [
         { $match: opts.query },
-        ...(util.isDefined(opts.sort) ? [{ $sort: opts.sort }] : []),
+        { $sort: opts.sort },
         ...(util.isDefined(opts.skip) ? [{ $limit: opts.skip }] : []),
         ...(util.isDefined(opts.limit) ? [{ $limit: opts.limit }] : []),
         ...lookups,
@@ -267,7 +283,7 @@ Model.prototype.update = async function (opts, type='update') {
     }
 
     // Hook: beforeUpdate (has access to original, non-validated opts.data)
-    await util.runSeries(this.beforeUpdate.map(f => f.bind(opts, data||{})), `${this.name}.beforeUpdate`)
+    await util.runSeries.call(this, this.beforeUpdate.map(f => f.bind(opts, data||{})), 'beforeUpdate')
 
     if (data && operators['$set']) {
       this.info(`'$set' fields take precedence over the data fields for \`${this.name}.${type}()\``)
@@ -298,7 +314,7 @@ Model.prototype.update = async function (opts, type='update') {
 
     // Hook: afterUpdate (doesn't have access to validated data)
     if (response) {
-      await util.runSeries(this.afterUpdate.map(f => f.bind(opts, response)), `${this.name}.afterUpdate`)
+      await util.runSeries.call(this, this.afterUpdate.map(f => f.bind(opts, response)), 'afterUpdate')
     }
 
     // Hook: afterFind if findOneAndUpdate
@@ -331,9 +347,9 @@ Model.prototype.remove = async function (opts) {
     opts = await this._queryObject(opts, 'remove')
 
     // Remove
-    await util.runSeries(this.beforeRemove.map(f => f.bind(opts)), `${this.name}.beforeRemove`)
+    await util.runSeries.call(this, this.beforeRemove.map(f => f.bind(opts)), 'beforeRemove')
     let response = await this._remove(opts.query, util.omit(opts, this._queryOptions))
-    await util.runSeries(this.afterRemove.map(f => f.bind(response)), `${this.name}.afterRemove`)
+    await util.runSeries.call(this, this.afterRemove.map(f => f.bind(response)), 'afterRemove')
 
     // Success
     if (opts.req && opts.respond) opts.req.res.json(response)
@@ -591,7 +607,7 @@ Model.prototype._processAfterFind = function (data, projection={}, afterFindCont
       callbackSeries.push(fn.bind(afterFindContext, item.dataRef))
     }
   }
-  return util.runSeries(callbackSeries, 'afterFind').then(() => data)
+  return util.runSeries.call(this, callbackSeries, 'afterFind').then(() => data)
 }
 
 Model.prototype._recurseAndFindModels = function (parentPath, schemaFields, dataArr) {

package/lib/model-validate.js

@@ -30,7 +30,7 @@ Model.prototype.validate = async function (data, opts) {
 
   // Hook: beforeValidate
 
-  await util.runSeries(this.beforeValidate.map(f => f.bind(opts, data)), `${this.name}.beforeValidate`)
+  await util.runSeries.call(this, this.beforeValidate.map(f => f.bind(opts, data)), 'beforeValidate')
 
   // Recurse and validate fields
   let response = util.toArray(data).map(item => {

package/lib/util.js

@@ -309,23 +309,25 @@ module.exports = {
     return variable
   },
 
-  runSeries: function(tasks, info, cb) {
+  runSeries: function(tasks, hookName, cb) {
     /*
      * Runs functions in series and calls the cb when done
      * @param {function(err, result)[]} tasks - array of functions
-     * @param {object} <info> - data to pass to the error
+     * @param {string} <hookName> - e.g. 'afterFind'
      * @param {function(err, results[])} <cb>
      * @return promise
+     * @this Model
      * @source https://github.com/feross/run-series
      */
     let current = 0
     let results = []
     let isSync = true
+    let caller = hookName == 'afterFind' ? 'afterFind' : this.name + '.' + hookName
 
     return new Promise((res, rej) => {
-      function next(i, err, result) { // aka next(err, data)
+      const next = (i, err, result) => { // aka next(err, data)
         if (i !== current) {
-          console.error(`Monastery ${info} error: you cannot return a promise AND call next()`)
+          this.manager.error(`Monastery ${caller} error: you cannot return a promise AND call next()`)
           return
         }
         current++
@@ -333,16 +335,16 @@ module.exports = {
         if (!err && current < tasks.length) callTask(current)
         else done(err)
       }
-      function done(err) {
+      const done = (err) => {
         if (isSync) process.nextTick(() => end(err))
         else end(err)
       }
-      function end(err) {
+      const end = (err) => {
         if (cb) cb(err, results)
         if (err) rej(err)
         else res(results)
       }
-      function callTask(i) {
+      const callTask = (i) => {
         const next2 = next.bind(null, i)
         const res = tasks[i](next2)
         if (res instanceof Promise) {
@@ -400,6 +402,10 @@ module.exports = {
     return obj
   },
 
+  setTimeoutPromise: function(ms) {
+    return new Promise(res => setTimeout(res, ms))
+  },
+
   toArray: function(variable) {
     // converts a variable to an array, if not already so
     if (typeof variable === 'undefined') return []

package/package.json

@@ -2,7 +2,7 @@
   "name": "monastery",
   "description": "⛪ A simple, straightforward MongoDB ODM",
   "author": "Ricky Boyce",
-  "version": "3.0.14",
+  "version": "3.0.16",
   "license": "MIT",
   "repository": "github:boycce/monastery",
   "homepage": "https://boycce.github.io/monastery/",
@@ -36,8 +36,8 @@
     "@aws-sdk/lib-storage": "3.549.0",
     "@aws-sdk/s3-request-presigner": "3.549.0",
     "debug": "4.3.4",
-    "file-type": "^16.5.4",
-    "mongodb": "^5.9.2",
+    "file-type": "16.5.4",
+    "mongodb": "5.9.2",
     "nanoid": "3.2.0",
     "validator": "13.7.0"
   },

package/plugins/images/index.js

@@ -50,9 +50,10 @@ let plugin = module.exports = {
     // v3 examples: https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/javascript_s3_code_examples.html
     this.getS3Client = (useRegion) => {
       const { S3 } = require('@aws-sdk/client-s3')
-      const key  = useRegion ? '_s3ClientRegional' : '_s3Client'
+      const key  = '_s3Client'// useRegion ? '_s3ClientRegional' : '_s3Client'
       return this[key] || (this[key] = new S3({
-        region: useRegion ? this.awsRegion : undefined,
+        // ...(region: useRegion ? this.awsRegion : undefined,
+        region: this.awsRegion, // if region is missing it throws an error, but only in production...
         credentials: {
           accessKeyId: this.awsAccessKeyId,
           secretAccessKey: this.awsSecretAccessKey,

package/test/crud.js

@@ -859,7 +859,8 @@ test('hooks > async', async () => {
 })
 
 test('hooks > async and next conflict', async () => {
-  let user1 = db.model('user', {
+  const db2 = monastery('127.0.0.1/monastery', { timestamps: false })
+  let user1 = db2.model('user', {
     fields: { age: { type: 'number'} },
     afterFind: [
       async (data, next) => {
@@ -881,7 +882,7 @@ test('hooks > async and next conflict', async () => {
       },
     ],
   })
-  let user2 = db.model('user2', {
+  let user2 = db2.model('user2', {
     fields: { age: { type: 'number'} },
     afterFind: [
       async (data, next) => {
@@ -898,7 +899,7 @@ test('hooks > async and next conflict', async () => {
       },
     ],
   })
-  let user3 = db.model('user3', {
+  let user3 = db2.model('user3', {
     fields: { age: { type: 'number'} },
     afterFind: [
       async (data, next) => {
@@ -910,7 +911,7 @@ test('hooks > async and next conflict', async () => {
       },
     ],
   })
-  let user4 = db.model('user4', {
+  let user4 = db2.model('user4', {
     fields: { age: { type: 'number'} },
     afterFind: [
       async (data, next) => {
@@ -928,7 +929,7 @@ test('hooks > async and next conflict', async () => {
     ],
   })
 
-  let user5 = db.model('user5', {
+  let user5 = db2.model('user5', {
     fields: { age: { type: 'number'} },
     afterFind: [
       async (data, next) => {
@@ -949,7 +950,7 @@ test('hooks > async and next conflict', async () => {
   let user4Doc = await user4.insert({ data: { age: 0 } })
   let user5Doc = await user5.insert({ data: { age: 0 } })
 
-  const logSpy = jest.spyOn(console, 'error').mockImplementation(() => {})
+  const logSpy = jest.spyOn(db2, 'error').mockImplementation(() => {})
 
   // Only increment twice
   await expect(user1.find({ query: user1Doc._id })).resolves.toEqual({ _id: expect.any(Object), age: 2 })
@@ -967,4 +968,5 @@ test('hooks > async and next conflict', async () => {
   await expect(user5.find({ query: user5Doc._id })).rejects.toThrow('An async error occurred with Martin3')
   expect(logSpy).toHaveBeenCalledWith('Monastery afterFind error: you cannot return a promise AND call next()')
 
+  db2.close()
 })

package/test/populate.js

@@ -83,14 +83,18 @@ test('model populate', async () => {
 })
 
 test('model populate array', async () => {
-  let bird = db.model('bird', { fields: {
-    name: { type: 'string' },
-  }})
-  let user = db.model('user', { fields: {
-    birds: [{ model: 'bird' }],
-    animal: { birds: [{ model: 'bird' }] },
-    animals: [{ bird: { model: 'bird' }, num: { type: 'number' } }],
-  }})
+  let bird = db.model('bird_pop', { 
+    fields: {
+      name: { type: 'string' },
+    },
+  })
+  let user = db.model('user_pop', { 
+    fields: {
+      birds: [{ model: 'bird_pop' }],
+      animal: { birds: [{ model: 'bird_pop' }] },
+      animals: [{ bird: { model: 'bird_pop' }, num: { type: 'number' } }],
+    },
+  })
   let bird1 = await bird.insert({ data: { name: 'ponyo' }})
   let bird2 = await bird.insert({ data: { name: 'jack' }})
   let bird3 = await bird.insert({ data: { name: 'sophie' }})