feat: Migrate S3 Client from AWS SDK v2 (deprecated) to v3

.eslintrc.json

@@ -28,4 +28,4 @@
     "globals": {
         "Parse": true
     }
-}
+}

.github/workflows/ci.yml

@@ -34,9 +34,6 @@ jobs:
           - name: Parse Server 7, Node.js 22
             NODE_VERSION: 22.4.1
             PARSE_SERVER_VERSION: 7
-          - name: Parse Server 6
-            NODE_VERSION: 18
-            PARSE_SERVER_VERSION: 6
       fail-fast: false
     name: ${{ matrix.name }}
     timeout-minutes: 15

CHANGELOG.md

@@ -177,4 +177,4 @@ ___
 
 
 
-\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

README.md

@@ -40,21 +40,24 @@ The official AWS S3 file storage adapter for Parse Server. See [Parse Server S3
 
 ### Parse Server
 
-| Version | End-of-Life   | Compatible |
-|---------|---------------|------------|
-| <=5     | December 2023 | ✅ Yes      |
-| 6       | December 2024 | ✅ Yes      |
-| 7       | December 2025 | ✅ Yes      |
+Parse Server S3 Adapter is compatible with the following versions of Parse Server.
+
+| Parse Server Version | End-of-Life   | Compatible |
+|----------------------|---------------|------------|
+| <=5                  | December 2023 | ❌ No       |
+| 6                    | December 2024 | ❌ No       |
+| <7.3.0               | December 2025 | ❌ No       |
+| >=7.3.0              | December 2025 | ✅ Yes      |
 
 ### Node.js
 
-This product is continuously tested with the most recent releases of Node.js to ensure compatibility. We follow the [Node.js Long Term Support plan](https://github.com/nodejs/Release) and only test against versions that are officially supported and have not reached their end-of-life date.
+Parse Server S3 Adapter is continuously tested with the most recent releases of Node.js to ensure compatibility. We follow the [Node.js Long Term Support plan](https://github.com/nodejs/Release) and only test against versions that are officially supported and have not reached their end-of-life date.
 
-| Version    | Latest Version | End-of-Life | Compatible |
-|------------|----------------|-------------|------------|
-| Node.js 18 | 18.20.4        | April 2025  | ✅ Yes      |
-| Node.js 20 | 20.15.1        | April 2026  | ✅ Yes      |
-| Node.js 22 | 22.4.1         | April 2027  | ✅ Yes      |
+| Node.js Version | End-of-Life | Compatible |
+|-----------------|-------------|------------|
+| 18              | April 2025  | ✅ Yes      |
+| 20              | April 2026  | ✅ Yes      |
+| 22              | April 2027  | ✅ Yes      |
 
 ## AWS Credentials
 
@@ -277,7 +280,6 @@ var S3Adapter = require("@parse/s3-files-adapter");
 var AWS = require("aws-sdk");
 
 //Configure Digital Ocean Spaces EndPoint
-const spacesEndpoint = new AWS.Endpoint(process.env.SPACES_ENDPOINT);
 var s3Options = {
   bucket: process.env.SPACES_BUCKET_NAME,
   baseUrl: process.env.SPACES_BASE_URL,
@@ -290,7 +292,7 @@ var s3Options = {
   s3overrides: {
     accessKeyId: process.env.SPACES_ACCESS_KEY,
     secretAccessKey: process.env.SPACES_SECRET_KEY,
-    endpoint: spacesEndpoint
+    endpoint: process.env.SPACES_ENDPOINT
   }
 };
 
@@ -306,4 +308,4 @@ var api = new ParseServer({
   allowClientClassCreation: false,
   filesAdapter: s3Adapter
 });
-```
+```

index.js

@@ -2,18 +2,27 @@
 //
 // Stores Parse files in AWS S3.
 
-const AWS = require('aws-sdk');
+const {
+  S3Client,
+  CreateBucketCommand,
+  PutObjectCommand,
+  DeleteObjectCommand,
+  GetObjectCommand,
+} = require('@aws-sdk/client-s3');
+const { getSignedUrl } = require('@aws-sdk/s3-request-presigner');
 const optionsFromArguments = require('./lib/optionsFromArguments');
 
 const awsCredentialsDeprecationNotice = function awsCredentialsDeprecationNotice() {
   // eslint-disable-next-line no-console
-  console.warn('Passing AWS credentials to this adapter is now DEPRECATED and will be removed in a future version',
-    'See: https://github.com/parse-server-modules/parse-server-s3-adapter#aws-credentials for details');
+  console.warn(
+    'Passing AWS credentials to this adapter is now DEPRECATED and will be removed in a future version',
+    'See: https://github.com/parse-server-modules/parse-server-s3-adapter#aws-credentials for details'
+  );
 };
 
-const serialize = (obj) => {
+const serialize = obj => {
   const str = [];
-  Object.keys(obj).forEach((key) => {
+  Object.keys(obj).forEach(key => {
     if (obj[key]) {
       str.push(`${encodeURIComponent(key)}=${encodeURIComponent(obj[key])}`);
     }
@@ -36,6 +45,15 @@ function buildDirectAccessUrl(baseUrl, baseUrlFileKey, presignedUrl, config, fil
   return directAccessUrl;
 }
 
+function responseToBuffer(response) {
+  return new Promise((resolve, reject) => {
+    const chunks = [];
+    response.Body.on('data', chunk => chunks.push(chunk));
+    response.Body.on('end', () => resolve(Buffer.concat(chunks)));
+    response.Body.on('error', reject);
+  });
+}
+
 class S3Adapter {
   // Creates an S3 session.
   // Providing AWS access, secret keys and bucket are mandatory
@@ -55,6 +73,7 @@ class S3Adapter {
     this._presignedUrlExpires = parseInt(options.presignedUrlExpires, 10);
     this._encryption = options.ServerSideEncryption;
     this._generateKey = options.generateKey;
+    this._endpoint = options.s3overrides?.endpoint;
     // Optional FilesAdaptor method
     this.validateFilename = options.validateFilename;
 
@@ -65,6 +84,16 @@ class S3Adapter {
       globalCacheControl: this._globalCacheControl,
     };
 
+    if (options.accessKey && options.secretKey) {
+      awsCredentialsDeprecationNotice();
+      s3Options.credentials = {
+        accessKeyId: options.accessKey,
+        secretAccessKey: options.secretKey,
+      };
+    } else if (options.credentials) {
+      s3Options.credentials = options.credentials;
+    }
+
     if (options.accessKey && options.secretKey) {
       awsCredentialsDeprecationNotice();
       s3Options.accessKeyId = options.accessKey;
@@ -73,29 +102,27 @@ class S3Adapter {
 
     Object.assign(s3Options, options.s3overrides);
 
-    this._s3Client = new AWS.S3(s3Options);
+    this._s3Client = new S3Client(s3Options);
     this._hasBucket = false;
   }
 
-  createBucket() {
-    let promise;
-    if (this._hasBucket) {
-      promise = Promise.resolve();
-    } else {
-      promise = new Promise((resolve) => {
-        this._s3Client.createBucket(() => {
-          this._hasBucket = true;
-          resolve();
-        });
-      });
+  async createBucket() {
+    if (this._hasBucket) { return; }
+
+    try {
+      await this._s3Client.send(new CreateBucketCommand({ Bucket: this._bucket }));
+      this._hasBucket = true;
+    } catch (error) {
+      if (error.name === 'BucketAlreadyOwnedByYou') { this._hasBucket = true; }
+      else { throw error; }
     }
-    return promise;
   }
 
   // For a given config object, filename, and data, store a file in S3
   // Returns a promise containing the S3 object creation response
-  createFile(filename, data, contentType, options = {}) {
+  async createFile(filename, data, contentType, options = {}) {
     const params = {
+      Bucket: this._bucket,
       Key: this._bucketPrefix + filename,
       Body: data,
     };
@@ -128,52 +155,51 @@ class S3Adapter {
       const serializedTags = serialize(options.tags);
       params.Tagging = serializedTags;
     }
-    return this.createBucket().then(() => new Promise((resolve, reject) => {
-      this._s3Client.upload(params, (err, response) => {
-        if (err !== null) {
-          return reject(err);
-        }
-        return resolve(response);
-      });
-    }));
+    await this.createBucket();
+    const command = new PutObjectCommand(params);
+    const response = await this._s3Client.send(command);
+    const endpoint = this._endpoint || `https://${this._bucket}.s3.${this._region}.amazonaws.com`;
+    const location = `${endpoint}/${params.Key}`;
+
+    return Object.assign(response || {}, { Location: location });
   }
 
-  deleteFile(filename) {
-    return this.createBucket().then(() => new Promise((resolve, reject) => {
-      const params = {
-        Key: this._bucketPrefix + filename,
-      };
-      this._s3Client.deleteObject(params, (err, data) => {
-        if (err !== null) {
-          return reject(err);
-        }
-        return resolve(data);
-      });
-    }));
+  async deleteFile(filename) {
+    const params = {
+      Bucket: this._bucket,
+      Key: this._bucketPrefix + filename,
+    };
+    await this.createBucket();
+    const command = new DeleteObjectCommand(params);
+    const response = await this._s3Client.send(command);
+    return response;
   }
 
   // Search for and return a file if found by filename
   // Returns a promise that succeeds with the buffer result from S3
-  getFileData(filename) {
-    const params = { Key: this._bucketPrefix + filename };
-    return this.createBucket().then(() => new Promise((resolve, reject) => {
-      this._s3Client.getObject(params, (err, data) => {
-        if (err !== null) {
-          return reject(err);
-        }
-        // Something happened here...
-        if (data && !data.Body) {
-          return reject(data);
-        }
-        return resolve(data.Body);
-      });
-    }));
+  async getFileData(filename) {
+    const params = {
+      Bucket: this._bucket,
+      Key: this._bucketPrefix + filename,
+    };
+    await this.createBucket();
+    const command = new GetObjectCommand(params);
+    const response = await this._s3Client.send(command);
+    if (response && !response.Body) { throw new Error(response); }
+
+    const buffer = await responseToBuffer(response);
+    return buffer;
+  }
+
+  // Exposed only for testing purposes
+  getFileSignedUrl(client, command, options) {
+    return getSignedUrl(client, command, options);
   }
 
   // Generates and returns the location of a file stored in S3 for the given request and filename
   // The location is the direct S3 link if the option is set,
   // otherwise we serve the file through parse-server
-  getFileLocation(config, filename) {
+  async getFileLocation(config, filename) {
     const fileName = filename.split('/').map(encodeURIComponent).join('/');
     if (!this._directAccess) {
       return `${config.mount}/files/${config.applicationId}/${fileName}`;
@@ -184,12 +210,11 @@ class S3Adapter {
     let presignedUrl = '';
     if (this._presignedUrl) {
       const params = { Bucket: this._bucket, Key: fileKey };
-      if (this._presignedUrlExpires) {
-        params.Expires = this._presignedUrlExpires;
-      }
-      // Always use the "getObject" operation, and we recommend that you protect the URL
-      // appropriately: https://docs.aws.amazon.com/AmazonS3/latest/dev/ShareObjectPreSignedURL.html
-      presignedUrl = this._s3Client.getSignedUrl('getObject', params);
+      const options = this._presignedUrlExpires ? { expiresIn: this._presignedUrlExpires } : {};
+
+      const command = new GetObjectCommand(params);
+      presignedUrl = await this.getFileSignedUrl(this._s3Client, command, options);
+
       if (!this._baseUrl) {
         return presignedUrl;
       }
@@ -203,30 +228,31 @@ class S3Adapter {
     return buildDirectAccessUrl(this._baseUrl, baseUrlFileKey, presignedUrl, config, filename);
   }
 
-  handleFileStream(filename, req, res) {
+  async handleFileStream(filename, req, res) {
     const params = {
+      Bucket: this._bucket,
       Key: this._bucketPrefix + filename,
       Range: req.get('Range'),
     };
-    return this.createBucket().then(() => new Promise((resolve, reject) => {
-      this._s3Client.getObject(params, (error, data) => {
-        if (error !== null) {
-          return reject(error);
-        }
-        if (data && !data.Body) {
-          return reject(data);
-        }
-        res.writeHead(206, {
-          'Accept-Ranges': data.AcceptRanges,
-          'Content-Length': data.ContentLength,
-          'Content-Range': data.ContentRange,
-          'Content-Type': data.ContentType,
-        });
-        res.write(data.Body);
-        res.end();
-        return resolve(data.Body);
-      });
-    }));
+
+    await this.createBucket();
+    const command = new GetObjectCommand(params);
+    const data = await this._s3Client.send(command);
+    if (data && !data.Body) { throw new Error('S3 object body is missing.'); }
+
+    res.writeHead(206, {
+      'Accept-Ranges': data.AcceptRanges,
+      'Content-Length': data.ContentLength,
+      'Content-Range': data.ContentRange,
+      'Content-Type': data.ContentType,
+    });
+    data.Body.on('data', chunk => res.write(chunk));
+    data.Body.on('end', () => res.end());
+    data.Body.on('error', e => {
+      res.status(404);
+      res.send(e.message);
+    });
+    return responseToBuffer(data);
   }
 }
 

lib/optionsFromArguments.js

@@ -42,12 +42,12 @@
     } else if (args.length === 2) {
       options.bucket = stringOrOptions;
       if (typeof args[1] !== 'object') {
-        throw new Error('Failed to configure S3Adapter. Arguments don\'t make sense');
+        throw new Error("Failed to configure S3Adapter. Arguments don't make sense");
       }
       otherOptions = args[1];
     } else if (args.length > 2) {
       if (typeof args[1] !== 'string' || typeof args[2] !== 'string') {
-        throw new Error('Failed to configure S3Adapter. Arguments don\'t make sense');
+        throw new Error("Failed to configure S3Adapter. Arguments don't make sense");
       }
       options.accessKey = args[0];
       options.secretKey = args[1];
@@ -57,6 +57,7 @@
 
     if (otherOptions) {
       options.bucketPrefix = otherOptions.bucketPrefix;
+      options.credentials = otherOptions.credentials;
       options.directAccess = otherOptions.directAccess;
       options.fileAcl = otherOptions.fileAcl;
       options.baseUrl = otherOptions.baseUrl;
@@ -80,7 +81,7 @@
       options.bucket = s3overrides.params.Bucket;
     }
   } else if (args.length > 2) {
-    throw new Error('Failed to configure S3Adapter. Arguments don\'t make sense');
+    throw new Error("Failed to configure S3Adapter. Arguments don't make sense");
   }
 
   options = fromOptionsDictionaryOrDefault(options, 's3overrides', s3overrides);