monastery 2.2.6 → 2.2.8

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.
 
+### [2.2.8](https://github.com/boycce/monastery/compare/2.2.7...2.2.8) (2024-05-01)
+
+### [2.2.7](https://github.com/boycce/monastery/compare/2.2.6...2.2.7) (2024-05-01)
+
 ### [2.2.6](https://github.com/boycce/monastery/compare/2.2.5...2.2.6) (2024-04-30)
 
 ### [2.2.5](https://github.com/boycce/monastery/compare/2.2.4...2.2.5) (2024-04-30)

package/docs/image-plugin.md

@@ -12,7 +12,7 @@ To use the default image plugin shipped with monastery, you need to use the opti
     imagePlugin: {
       awsAcl: 'public-read', // default
       awsBucket: 'your-bucket-name',
-      awsRegion: undefined, // required when using getSignedUrl (e.g. 's3-ap-southeast-2')
+      awsRegion: undefined, // e.g. 'ap-southeast-2'
       awsAccessKeyId: 'your-key-here',
       awsSecretAccessKey: 'your-key-here',
       filesize: undefined, // default (max filesize in bytes)

package/docs/manager/index.md

@@ -54,6 +54,7 @@ monastery('localhost/mydb,192.168.1.1').then((db) => {
 - `manager.isId(String|ObjectId)`: Checks if the passed variable is a valid MongoDB ObjectId or ObjectId string
 - `manager.model()`: [see model](./model.html)
 - `manager.models()`: [see models](./models.html)
+- `manager.getSignedUrl(path, expires, bucket)`: You can sign AWS S3 paths using this image plugin helper
 
 ### Dates
 

package/lib/index.js

@@ -64,6 +64,8 @@ module.exports = function(uri, opts, fn) {
   }
 
   // Initiate any plugins
+
+manager.getSignedUrl = manager._getSignedUrl = manager.imagePluginFile.getSignedUrl
   if (manager.imagePlugin) {
     manager.imagePluginFile.setup(manager, util.isObject(manager.imagePlugin)? manager.imagePlugin : {})
   }

package/package.json

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

package/plugins/images/index.js

@@ -31,27 +31,28 @@ 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) : {},
     this.path = options.path || function (uid, basename, ext, file) { return `full/${uid}.${ext}` }
 
     if (!options.awsBucket || !options.awsAccessKeyId || !options.awsSecretAccessKey) {
-      manager.error('Monastery imagePlugin: awsBucket, awsAccessKeyId, or awsSecretAccessKey is not defined')
-      delete manager.imagePlugin
-      return
+      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\'')
     }
 
     // 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
-    manager._getSignedUrl = this._getSignedUrl
-    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,22 +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.awsRegion) {
-      throw 'Monastery requires config.awsRegion to be defined when using getSignedUrl\'s'
+    if (!plugin.getS3Client) {
+      throw new Error(
+        '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/plugin-images.js

@@ -1,4 +1,5 @@
 let util = require('../lib/util.js')
+const imagePluginFakeOpts = { awsBucket: 'fake', awsRegion: 'fake', awsAccessKeyId: 'fake', awsSecretAccessKey: 'fake' }
 
 module.exports = function(monastery, opendb) {
 
@@ -58,7 +59,7 @@ module.exports = function(monastery, opendb) {
     let db = (await opendb(null, {
       timestamps: false,
       serverSelectionTimeoutMS: 2000,
-      imagePlugin: { awsBucket: 'fake', awsAccessKeyId: 'fake', awsSecretAccessKey: 'fake' }
+      imagePlugin: imagePluginFakeOpts
     })).db
 
     let user = db.model('user', { fields: {
@@ -68,7 +69,7 @@ module.exports = function(monastery, opendb) {
     }})
 
     // Initialisation success
-    expect(db.imagePlugin).toEqual({ awsBucket: 'fake', awsAccessKeyId: 'fake', awsSecretAccessKey: 'fake' })
+    expect(db.imagePlugin).toEqual(imagePluginFakeOpts)
 
     let expected = {
       bucket: { type: 'string', isString: true },
@@ -96,7 +97,7 @@ module.exports = function(monastery, opendb) {
     let db = (await opendb(null, {
       timestamps: false,
       serverSelectionTimeoutMS: 2000,
-      imagePlugin: { awsBucket: 'fake', awsAccessKeyId: 'fake', awsSecretAccessKey: 'fake' }
+      imagePlugin: imagePluginFakeOpts
     })).db
     let plugin = db.imagePluginFile
     db.model('user', { fields: {
@@ -147,7 +148,7 @@ module.exports = function(monastery, opendb) {
     let db = (await opendb(null, {
       timestamps: false,
       serverSelectionTimeoutMS: 2000,
-      imagePlugin: { awsBucket: 'fake', awsAccessKeyId: 'fake', awsSecretAccessKey: 'fake' }
+      imagePlugin: imagePluginFakeOpts
     })).db
 
     let user = db.model('user', { fields: {
@@ -255,7 +256,7 @@ module.exports = function(monastery, opendb) {
     let db = (await opendb(null, {
       timestamps: false,
       serverSelectionTimeoutMS: 2000,
-      imagePlugin: { awsBucket: 'fake', awsAccessKeyId: 'fake', awsSecretAccessKey: 'fake' }
+      imagePlugin: imagePluginFakeOpts
     })).db
 
     let user = db.model('user', { fields: {
@@ -341,7 +342,7 @@ module.exports = function(monastery, opendb) {
     let db = (await opendb(null, {
       timestamps: false,
       serverSelectionTimeoutMS: 2000,
-      imagePlugin: { awsBucket: 'fake', awsAccessKeyId: 'fake', awsSecretAccessKey: 'fake' }
+      imagePlugin: imagePluginFakeOpts
     })).db
 
     let user = db.model('user', { fields: {
@@ -392,7 +393,7 @@ module.exports = function(monastery, opendb) {
     let db = (await opendb(null, {
       timestamps: false,
       serverSelectionTimeoutMS: 2000,
-      imagePlugin: { awsBucket: 'fake', awsAccessKeyId: 'fake', awsSecretAccessKey: 'fake' }
+      imagePlugin: imagePluginFakeOpts
     })).db
 
     db.model('user', { fields: {
@@ -470,7 +471,7 @@ module.exports = function(monastery, opendb) {
     let db = (await opendb(null, {
       timestamps: false,
       serverSelectionTimeoutMS: 2000,
-      imagePlugin: { awsBucket: 'fake', awsAccessKeyId: 'fake', awsSecretAccessKey: 'fake' }
+      imagePlugin: imagePluginFakeOpts
     })).db
 
     let user = db.model('user', { fields: {
@@ -524,7 +525,7 @@ module.exports = function(monastery, opendb) {
     let db = (await opendb(null, {
       timestamps: false,
       serverSelectionTimeoutMS: 2000,
-      imagePlugin: { awsBucket: 'fake', awsAccessKeyId: 'fake', awsSecretAccessKey: 'fake' }
+      imagePlugin: imagePluginFakeOpts
     })).db
 
     let user = db.model('user', { fields: {
@@ -621,11 +622,7 @@ module.exports = function(monastery, opendb) {
     let db = (await opendb(null, {
       timestamps: false,
       serverSelectionTimeoutMS: 2000,
-      imagePlugin: {
-        awsBucket: 'fake',
-        awsAccessKeyId: 'fake',
-        awsSecretAccessKey: 'fake',
-      }
+      imagePlugin: imagePluginFakeOpts
     })).db
 
     let user = db.model('user', {
@@ -645,7 +642,7 @@ module.exports = function(monastery, opendb) {
     expect(plugin.awsAcl).toEqual('public-read')
     expect(plugin.filesize).toEqual(undefined)
     expect(plugin.formats).toEqual(['bmp', 'gif', 'jpg', 'jpeg', 'png', 'tiff'])
-    expect(plugin.getSignedUrl).toEqual(undefined)
+    expect(plugin.getSignedUrlOption).toEqual(undefined)
     expect(plugin.metadata).toEqual(undefined)
     expect(plugin.path).toEqual(expect.any(Function))
     expect(plugin.params).toEqual({})
@@ -717,9 +714,7 @@ module.exports = function(monastery, opendb) {
       timestamps: false,
       serverSelectionTimeoutMS: 2000,
       imagePlugin: {
-        awsBucket: 'fake',
-        awsAccessKeyId: 'fake',
-        awsSecretAccessKey: 'fake',
+        ...imagePluginFakeOpts,
         formats: ['jpg', 'jpeg', 'png', 'ico'],
         filesize: 1000 * 270,
       }
@@ -800,10 +795,8 @@ module.exports = function(monastery, opendb) {
       timestamps: false,
       serverSelectionTimeoutMS: 2000,
       imagePlugin: {
-        awsBucket: 'fake',
-        awsAccessKeyId: 'fake',
-        awsSecretAccessKey: 'fake',
-        awsRegion: 's3-ap-southeast-2',
+        ...imagePluginFakeOpts,
+        awsRegion: 'ap-southeast-2',
         getSignedUrl: true,
       },
     })).db
@@ -861,10 +854,8 @@ module.exports = function(monastery, opendb) {
       timestamps: false,
       serverSelectionTimeoutMS: 2000,
       imagePlugin: {
+        ...imagePluginFakeOpts,
         awsAcl: 'private',
-        awsBucket: 'fake',
-        awsAccessKeyId: 'fake',
-        awsSecretAccessKey: 'fake',
         metadata: { small: '*x300' , medium: '*x800', large: '*x1200' },
         params: { ContentLanguage: 'DE'},
         path: (uid, basename, ext, file) => `images/${basename}`,
@@ -966,9 +957,7 @@ module.exports = function(monastery, opendb) {
       timestamps: false,
       serverSelectionTimeoutMS: 2000,
       imagePlugin: {
-        awsBucket: 'fake',
-        awsAccessKeyId: 'fake',
-        awsSecretAccessKey: 'fake',
+        ...imagePluginFakeOpts,
         bucketDir: 'old',
       }
     })).db