monastery 3.0.13 → 3.0.15

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.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)
 
 ### [3.0.12](https://github.com/boycce/monastery/compare/3.0.11...3.0.12) (2024-05-01)

package/docs/manager/index.md

@@ -60,6 +60,7 @@ db.onError((err) => {
 - `manager.models()`: [see models](./models.html)
 - `manager.onError(Function)`: Catches connection errors
 - `manager.onOpen(Function)`: Triggers on successful connection
+- `manager.getSignedUrl(path, expires, bucket)`: You can sign AWS S3 paths using this image plugin helper
 
 ### Dates
 

package/lib/index.js

@@ -282,7 +282,7 @@ Manager.prototype.parseData = function(obj) {
 }
 
 Manager.prototype.model = Model
-Manager.prototype._getSignedUrl = imagePluginFile._getSignedUrl
+Manager.prototype.getSignedUrl = Manager.prototype._getSignedUrl = imagePluginFile.getSignedUrl
 
 inherits(Manager, EventEmitter)
 module.exports = Manager 

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)
@@ -267,7 +267,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 +298,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 +331,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 +591,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) {

package/package.json

@@ -2,7 +2,7 @@
   "name": "monastery",
   "description": "⛪ A simple, straightforward MongoDB ODM",
   "author": "Ricky Boyce",
-  "version": "3.0.13",
+  "version": "3.0.15",
   "license": "MIT",
   "repository": "github:boycce/monastery",
   "homepage": "https://boycce.github.io/monastery/",

package/plugins/images/index.js

@@ -31,7 +31,7 @@ let plugin = module.exports = {
     this.bucketDir = options.bucketDir || 'full' // depreciated > 1.36.2
     this.filesize = options.filesize
     this.formats = options.formats || ['bmp', 'gif', 'jpg', 'jpeg', 'png', 'tiff']
-    this.getSignedUrl = options.getSignedUrl
+    this.getSignedUrlOption = options.getSignedUrl
     this.manager = manager
     this.metadata = options.metadata ? util.deepCopy(options.metadata) : undefined,
     this.params = options.params ? util.deepCopy(options.params) : {},
@@ -41,17 +41,18 @@ let plugin = module.exports = {
       throw new Error('Monastery imagePlugin: awsRegion, awsBucket, awsAccessKeyId, or awsSecretAccessKey is not defined')
     }
     if (!options.awsRegion) {
-      throw new Error('Monastery imagePlugin: v3 requires awsRegion to be defined for signing urls, e.g. "ap-southeast-2"')
+      throw new Error('Monastery imagePlugin: v3 requires awsRegion to be defined for signing urls, e.g. \'ap-southeast-2\'')
     }
 
     // Create s3 'service' instance (defer require since it takes 120ms to load)
     // v2: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#constructor-property
     // v3: https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/s3/
     // v3 examples: https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/javascript_s3_code_examples.html
-    this.getS3Client = () => {
+    this.getS3Client = (useRegion) => {
       const { S3 } = require('@aws-sdk/client-s3')
-      return this._s3Client || (this._s3Client = new S3({
-        region: this.awsRegion,
+      const key  = useRegion ? '_s3ClientRegional' : '_s3Client'
+      return this[key] || (this[key] = new S3({
+        region: useRegion ? this.awsRegion : undefined,
         credentials: {
           accessKeyId: this.awsAccessKeyId,
           secretAccessKey: this.awsSecretAccessKey,
@@ -230,11 +231,11 @@ let plugin = module.exports = {
     for (let doc of util.toArray(data)) {
       for (let imageField of this.imageFields) {
         if (options.getSignedUrls
-            || (util.isDefined(imageField.getSignedUrl) ? imageField.getSignedUrl : plugin.getSignedUrl)) {
+            || (util.isDefined(imageField.getSignedUrl) ? imageField.getSignedUrl : plugin.getSignedUrlOption)) {
           let images = plugin._findImagesInData(doc, imageField, 0, '').filter(o => o.image)
           // todo: we could do this in parallel
           for (let image of images) {
-            image.image.signedUrl = await plugin._getSignedUrl(image.image.path, 3600, imageField.awsBucket)
+            image.image.signedUrl = await plugin.getSignedUrl(image.image.path, 3600, imageField.awsBucket)
           }
         }
       }
@@ -589,24 +590,24 @@ let plugin = module.exports = {
     return list
   },
 
-  _getSignedUrl: async (path, expires=3600, bucket) => {
+  getSignedUrl: async (path, expires=3600, bucket) => {
     /**
      * @param {string} path - aws file path
      * @param {number} <expires> - seconds
-     * @param {number} <bucket>
+     * @param {string} <bucket>
      * @return {promise} signedUrl
      * @see v2: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#getSignedUrl-property
      * @see v3: https://github.com/aws/aws-sdk-js-v3/blob/main/UPGRADING.md#s3-presigned-url
      */
     if (!plugin.getS3Client) {
       throw new Error(
-        'To use db._getSignedUrl(), the imagePlugin manager option must be defined, e.g. `monastery(..., { imagePlugin })`'
+        'To use db.getSignedUrl(), the imagePlugin manager option must be defined, e.g. `monastery(..., { imagePlugin })`'
       )
     }
     const { GetObjectCommand } = require('@aws-sdk/client-s3')
     const params = { Bucket: bucket || plugin.awsBucket, Key: path }
     const command = new GetObjectCommand(params)
-    let signedUrl = await getSignedUrl(plugin.getS3Client(), command, { expiresIn: expires })
+    let signedUrl = await getSignedUrl(plugin.getS3Client(true), command, { expiresIn: expires })
     // console.log(signedUrl)
     return signedUrl
   },

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/plugin-images.js

@@ -573,7 +573,7 @@ test('images option defaults', async () => {
   expect(imagePluginFile.awsAcl).toEqual('public-read')
   expect(imagePluginFile.filesize).toEqual(undefined)
   expect(imagePluginFile.formats).toEqual(['bmp', 'gif', 'jpg', 'jpeg', 'png', 'tiff'])
-  expect(imagePluginFile.getSignedUrl).toEqual(undefined)
+  expect(imagePluginFile.getSignedUrlOption).toEqual(undefined)
   expect(imagePluginFile.metadata).toEqual(undefined)
   expect(imagePluginFile.path).toEqual(expect.any(Function))
   expect(imagePluginFile.params).toEqual({})
@@ -722,7 +722,7 @@ test('images option getSignedUrls', async () => {
     timestamps: false, 
     imagePlugin: { 
       ...imagePluginFakeOpts,
-      awsRegion: 's3-ap-southeast-2',
+      awsRegion: 'ap-southeast-2',
       getSignedUrl: true,
     },
   })