💥 Upgrade to AWS JavaScript SDK V3 (#162)

Breaking Changes:

When upgrading to this version, you also need to migrate from version 2 of the AWS JavaScript SDK to version 3. Instead of passing an instance of the old `aws.S3`, use the new `S3Client` class from `@aws-sdk/client-s3`.

The minimum required version of Node.js has also been increased to 12.0.0, to align with the AWS JavaScript SDK.

Author: Takaitra

README.md

@@ -2,7 +2,13 @@
 
 Streaming multer storage engine for AWS S3.
 
-This project is mostly an integration piece for existing code samples from Multer's [storage engine documentation](https://github.com/expressjs/multer/blob/master/StorageEngine.md) with a call to `s3.upload` (see the [aws-sdk docs](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#upload-property)) as the substitution piece for file system.  Existing solutions I found required buffering the multipart uploads into the actual filesystem which is difficult to scale.
+This project is mostly an integration piece for existing code samples from Multer's [storage engine documentation](https://github.com/expressjs/multer/blob/master/StorageEngine.md) with a call to S3 as the substitution piece for file system.  Existing solutions I found required buffering the multipart uploads into the actual filesystem which is difficult to scale.
+
+## AWS SDK Versions
+
+3.x.x releases of multer-s3 use AWS JavaScript SDK v3. Specifically, it uses the Upload class from [@aws-sdk/lib-storage](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/modules/_aws_sdk_lib_storage.html) which in turn calls the modular [S3Client](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-s3/classes/s3client.html).
+
+2.x.x releases for multer-s3 use AWS JavaScript SDK v2 via a call to [s3.upload](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#upload-property).
 
 ## Installation
 
@@ -13,15 +19,16 @@ npm install --save multer-s3
 ## Usage
 
 ```javascript
-var aws = require('aws-sdk')
-var express = require('express')
-var multer = require('multer')
-var multerS3 = require('multer-s3')
+const { S3Client } = require('@aws-sdk/client-s3')
+const express = require('express')
+const multer = require('multer')
+const multerS3 = require('multer-s3')
 
-var app = express()
-var s3 = new aws.S3({ /* ... */ })
+const app = express()
 
-var upload = multer({
+const s3 = new S3Client()
+
+const upload = multer({
   storage: multerS3({
     s3: s3,
     bucket: 'some-bucket',

index.js

@@ -3,6 +3,8 @@ var stream = require('stream')
 var fileType = require('file-type')
 var htmlCommentRegex = require('html-comment-regex')
 var parallel = require('run-parallel')
+var Upload = require('@aws-sdk/lib-storage').Upload
+var util = require('util')
 
 function staticValue (value) {
   return function (req, file, cb) {
@@ -207,13 +209,16 @@ S3Storage.prototype._handleFile = function (req, file, cb) {
       params.ContentEncoding = opts.contentEncoding
     }
 
-    var upload = this.s3.upload(params)
+    var upload = new Upload({
+      client: this.s3,
+      params: params
+    })
 
     upload.on('httpUploadProgress', function (ev) {
       if (ev.total) currentSize = ev.total
     })
 
-    upload.send(function (err, result) {
+    util.callbackify(upload.done.bind(upload))(function (err, result) {
       if (err) return cb(err)
 
       cb(null, {

package.json

@@ -6,6 +6,9 @@
   "scripts": {
     "test": "standard && mocha test/basic.js"
   },
+  "engines": {
+    "node": ">= 12.0.0"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/badunk/multer-s3.git"
@@ -23,13 +26,12 @@
   },
   "homepage": "https://github.com/badunk/multer-s3#readme",
   "dependencies": {
+    "@aws-sdk/lib-storage": "^3.46.0",
     "file-type": "^3.3.0",
     "html-comment-regex": "^1.1.2",
     "run-parallel": "^1.1.6"
   },
   "devDependencies": {
-    "aws-sdk": "^2.2.32",
-    "concat-stream": "^1.5.1",
     "express": "^4.13.1",
     "form-data": "^1.0.0-rc3",
     "mocha": "^2.2.5",

test/util/mock-s3.js

@@ -1,24 +1,17 @@
 var events = require('events')
-var concat = require('concat-stream')
 
 function createMockS3 () {
-  function upload (opts) {
+  function send (opts, cb) {
     var ee = new events.EventEmitter()
-
-    ee.send = function send (cb) {
-      opts['Body'].pipe(concat(function (body) {
-        ee.emit('httpUploadProgress', { total: body.length })
-        cb(null, {
-          'Location': 'mock-location',
-          'ETag': 'mock-etag'
-        })
-      }))
-    }
-
-    return ee
+    var buffer = opts['input']['Body']
+    ee.emit('httpUploadProgress', { total: buffer.length })
+    return Promise.resolve({
+      Location: 'mock-location',
+      ETag: 'mock-etag'
+    })
   }
 
-  return { upload: upload }
+  return { send: send }
 }
 
 module.exports = createMockS3