migrate latest aws sdk v2 parts to aws sdk v3

benzekrimaha · benzekrimaha · commit f24da7508881 · 2026-02-06T13:36:16.000+01:00
diff --git a/bin/ensureServiceUser b/bin/ensureServiceUser
@@ -8,7 +8,15 @@ const { errors } = require('arsenal');
 const { program } = require('commander');
 const werelogs = require('werelogs');
 const async = require('async');
-const { IAM } = require('aws-sdk');
+const {
+    IAMClient,
+    GetUserCommand,
+    CreateUserCommand,
+    GetUserPolicyCommand,
+    PutUserPolicyCommand,
+    ListAccessKeysCommand,
+    CreateAccessKeyCommand,
+} = require('@aws-sdk/client-iam');
 const { version } = require('../package.json');
 
 const systemPrefix = '/scality-internal/';
@@ -33,7 +41,7 @@ function generateUserPolicyDocument() {
 }
 
 function createIAMClient(opts) {
-    return new IAM({
+    return new IAMClient({
         endpoint: opts.iamEndpoint,
         region: 'us-east-1',
     });
@@ -98,22 +106,18 @@ class UserHandler extends BaseHandler {
     resourceType = 'user';
 
     async collect() {
-        return this.iamClient
-            .getUser({
-                UserName: this.serviceName,
-            })
-            .promise()
-            .then(res => res.User);
+        const res = await this.iamClient.send(new GetUserCommand({
+            UserName: this.serviceName,
+        }));
+        return res.User;
     }
 
     async create() {
-        return this.iamClient
-            .createUser({
-                UserName: this.serviceName,
-                Path: systemPrefix,
-            })
-            .promise()
-            .then(res => res.User);
+        const res = await this.iamClient.send(new CreateUserCommand({
+            UserName: this.serviceName,
+            Path: systemPrefix,
+        }));
+        return res.User;
     }
 
     conflicts(u) {
@@ -125,26 +129,22 @@ class UserPolicyHandler extends BaseHandler {
     resourceType = 'userPolicy';
 
     async collect() {
-        return this.iamClient
-            .getUserPolicy({
-                UserName: this.serviceName,
-                PolicyName: this.serviceName,
-            })
-            .promise()
-            .then(() => true);
+        await this.iamClient.send(new GetUserPolicyCommand({
+            UserName: this.serviceName,
+            PolicyName: this.serviceName,
+        }));
+        return true;
     }
 
     async create() {
         const doc = generateUserPolicyDocument();
 
-        return this.iamClient
-            .putUserPolicy({
-                UserName: this.serviceName,
-                PolicyName: this.serviceName,
-                PolicyDocument: JSON.stringify(doc),
-            })
-            .promise()
-            .then(() => true);
+        await this.iamClient.send(new PutUserPolicyCommand({
+            UserName: this.serviceName,
+            PolicyName: this.serviceName,
+            PolicyDocument: JSON.stringify(doc),
+        }));
+        return true;
     }
 
     conflicts() {
@@ -158,22 +158,18 @@ class AccessKeyHandler extends BaseHandler {
     async collect() {
         // if at least one key already exists, the script won't create a new key
         // and will display the list of existing keys
-        return this.iamClient
-            .listAccessKeys({
-                UserName: this.serviceName,
-                MaxItems: 100,
-            })
-            .promise()
-            .then(res => res.AccessKeyMetadata);
+        const res = await this.iamClient.send(new ListAccessKeysCommand({
+            UserName: this.serviceName,
+            MaxItems: 100,
+        }));
+        return res.AccessKeyMetadata;
     }
 
     async create() {
-        return this.iamClient
-            .createAccessKey({
-                UserName: this.serviceName,
-            })
-            .promise()
-            .then(res => res.AccessKey);
+        const res = await this.iamClient.send(new CreateAccessKeyCommand({
+            UserName: this.serviceName,
+        }));
+        return res.AccessKey;
     }
 
     conflicts() {
@@ -185,7 +181,7 @@ function collectResource(v, done) {
     v.collect()
         .then(res => done(null, res))
         .catch((err) => {
-            if (err.code === 'NoSuchEntity') {
+            if (err && (err.code === 'NoSuchEntity' || err.name === 'NoSuchEntity')) {
                 return done();
             }
 
diff --git a/docs/CLIENTS.rst b/docs/CLIENTS.rst
@@ -124,16 +124,25 @@ JavaScript
 
 .. code:: javascript
 
-    const AWS = require('aws-sdk');
-
-    const s3 = new AWS.S3({
-        accessKeyId: 'accessKey1',
-        secretAccessKey: 'verySecretKey1',
-        endpoint: 'localhost:8000',
-        sslEnabled: false,
-        s3ForcePathStyle: true,
+    const { S3Client, ListBucketsCommand } = require('@aws-sdk/client-s3');
+
+    const s3 = new S3Client({
+        region: 'us-east-1',
+        endpoint: 'http://localhost:8000',
+        forcePathStyle: true,
+        credentials: {
+            accessKeyId: 'accessKey1',
+            secretAccessKey: 'verySecretKey1',
+        },
     });
 
+    async function listBuckets() {
+        const result = await s3.send(new ListBucketsCommand({}));
+        console.log(result.Buckets);
+    }
+
+    listBuckets().catch(console.error);
+
 JAVA
 ~~~~
 
diff --git a/docs/GETTING_STARTED.rst b/docs/GETTING_STARTED.rst
@@ -247,10 +247,13 @@ if you are using the AWS SDK for JavaScript, instantiate your client like this:
 
 .. code:: js
 
-    const s3 = new aws.S3({
-       endpoint: 'http://127.0.0.1:8000',
-       s3ForcePathStyle: true,
-    });
+   const { S3Client } = require('@aws-sdk/client-s3');
+
+   const s3 = new S3Client({
+      endpoint: 'http://127.0.0.1:8000',
+      forcePathStyle: true,
+      region: 'us-east-1',
+   });
 
 Setting Your Own Access and Secret Key Pairs
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -379,47 +382,44 @@ SSL certificates.
 Test the Config
 ^^^^^^^^^^^^^^^
 
-If aws-sdk is not installed, run ``$> yarn install aws-sdk``. 
+If the AWS SDK for JavaScript v3 packages are not installed locally, run ``$> yarn add @aws-sdk/client-s3 @aws-sdk/node-http-handler``. 
 
 Paste the following script into a file named "test.js":
 
 .. code:: js
 
-    const AWS = require('aws-sdk');
-    const fs = require('fs');
-    const https = require('https');
-
-    const httpOptions = {
-        agent: new https.Agent({
-            // path on your host of the self-signed certificate
-            ca: fs.readFileSync('./ca.crt', 'ascii'),
-        }),
-    };
-
-    const s3 = new AWS.S3({
-        httpOptions,
-        accessKeyId: 'accessKey1',
-        secretAccessKey: 'verySecretKey1',
-        // The endpoint must be s3.scality.test, else SSL will not work
-        endpoint: 'https://s3.scality.test:8000',
-        sslEnabled: true,
-        // With this setup, you must use path-style bucket access
-        s3ForcePathStyle: true,
-    });
-
-    const bucket = 'cocoriko';
-
-    s3.createBucket({ Bucket: bucket }, err => {
-        if (err) {
-            return console.log('err createBucket', err);
-        }
-        return s3.deleteBucket({ Bucket: bucket }, err => {
-            if (err) {
-                return console.log('err deleteBucket', err);
-            }
-            return console.log('SSL is cool!');
-        });
-    });
+   const { S3Client, CreateBucketCommand, DeleteBucketCommand } = require('@aws-sdk/client-s3');
+   const { NodeHttpHandler } = require('@aws-sdk/node-http-handler');
+   const fs = require('fs');
+   const https = require('https');
+
+   const httpsAgent = new https.Agent({
+      // path on your host of the self-signed certificate
+      ca: fs.readFileSync('./ca.crt', 'ascii'),
+   });
+
+   const s3 = new S3Client({
+      requestHandler: new NodeHttpHandler({ httpsAgent }),
+      credentials: {
+         accessKeyId: 'accessKey1',
+         secretAccessKey: 'verySecretKey1',
+      },
+      endpoint: 'https://s3.scality.test:8000',
+      forcePathStyle: true,
+      region: 'us-east-1',
+   });
+
+   const bucket = 'cocoriko';
+
+   (async () => {
+      try {
+         await s3.send(new CreateBucketCommand({ Bucket: bucket }));
+         await s3.send(new DeleteBucketCommand({ Bucket: bucket }));
+         console.log('SSL is cool!');
+      } catch (err) {
+         console.error('error running sample', err);
+      }
+   })();
 
 Now run this script with:
 
diff --git a/package.json b/package.json
@@ -32,7 +32,6 @@
     "@smithy/node-http-handler": "^3.0.0",
     "arsenal": "git+https://github.com/scality/arsenal#8.3.1",
     "async": "2.6.4",
-    "aws-sdk": "^2.1692.0",
     "bucketclient": "scality/bucketclient#8.2.7",
     "bufferutil": "^4.0.8",
     "commander": "^12.1.0",
diff --git a/tests/functional/aws-node-sdk/test/rateLimit/tooling.js b/tests/functional/aws-node-sdk/test/rateLimit/tooling.js
@@ -1,42 +1,50 @@
 const nodeFetch = require('node-fetch');
-const AWS = require('aws-sdk');
+const { SignatureV4 } = require('@aws-sdk/signature-v4');
+const { HttpRequest } = require('@aws-sdk/protocol-http');
+const { Sha256 } = require('@aws-crypto/sha256-js');
 const xml2js = require('xml2js');
+const { URL } = require('url');
 const { getCredentials } = require('../support/credentials');
 
 const { config } = require('../../../../../lib/Config');
 
 const skipIfRateLimitDisabled = config.rateLimiting.enabled ? describe : describe.skip;
 
-async function sendRateLimitRequest(method, host, path, body = '') {
-    const service = 's3';
-    const endpoint = new AWS.Endpoint(host);
+function buildHttpRequest(method, host, path, body = '') {
+    const url = new URL(`http://${host}`);
+    return new HttpRequest({
+        method: method.toUpperCase(),
+        protocol: url.protocol,
+        hostname: url.hostname,
+        port: url.port ? Number(url.port) : undefined,
+        path,
+        headers: {
+            host,
+        },
+        body: body || undefined,
+    });
+}
 
-    const request = new AWS.HttpRequest(endpoint);
-    request.method = method.toUpperCase();
-    request.path = path;
-    request.body = body;
-    request.headers.Host = host;
-    request.headers['X-Amz-Date'] = new Date().toISOString().replace(/[:\-]|\.\d{3}/g, '');
-    const sha256hash = AWS.util.crypto.sha256(request.body || '', 'hex');
-    request.headers['X-Amz-Content-SHA256'] = sha256hash;
-    request.region = 'us-east-1';
+async function sendRateLimitRequest(method, host, path, body = '') {
+    const request = buildHttpRequest(method, host, path, body);
 
-    const signer = new AWS.Signers.V4(request, service);
     const credentials = getCredentials('lisa');
-    const awsCredentials = new AWS.Credentials(
-        credentials.accessKeyId,
-        credentials.secretAccessKey
-    );
-    signer.addAuthorization(awsCredentials, new Date());
+    const signer = new SignatureV4({
+        credentials,
+        region: 'us-east-1',
+        service: 's3',
+        sha256: Sha256,
+    });
+    const signedRequest = await signer.sign(request);
 
     const url = `http://${host}${path}`;
     const options = {
-        method: request.method,
-        headers: request.headers,
+        method: signedRequest.method,
+        headers: signedRequest.headers,
     };
 
-    if (method !== 'GET' && method !== 'DELETE') {
-        options.body = request.body;
+    if (signedRequest.body && method !== 'GET' && method !== 'DELETE') {
+        options.body = signedRequest.body;
     }
 
     const response = await nodeFetch(url, options);
diff --git a/tests/functional/aws-node-sdk/test/serverAccessLogs/testServerAccessLogFile.js b/tests/functional/aws-node-sdk/test/serverAccessLogs/testServerAccessLogFile.js
