Merge remote-tracking branch 'origin/main' into sqs-send-message-batch

# Conflicts:
#	dist/aws.js
#	dist/aws.js.map
#	dist/index.js
#	dist/index.js.map
#	dist/sqs.js
#	dist/sqs.js.map

.github/workflows/all.yml

@@ -20,14 +20,6 @@ jobs:
             - name: Install npm packages
               run: npm install
 
-            - name: Verify the build is up to date
-              run: |
-                npm run webpack -- --output-path="${RUNNER_TEMP}/dist"
-                if ! diff -r "${RUNNER_TEMP}/dist" dist > /dev/null; then
-                  echo "Build is out of date, please run 'npm run webpack' and commit the changes"
-                  exit 1
-                fi
-
             - name: Install Go
               uses: actions/setup-go@v4
               with:

.gitignore

@@ -1,3 +1,3 @@
 node_modules/
 /volume
-build/
+dist/

README.md

@@ -25,7 +25,7 @@ import { check } from 'k6'
 import exec from 'k6/execution'
 import http from 'k6/http'
 
-import { AWSConfig, S3Client } from 'https://jslib.k6.io/aws/0.12.0/s3.js'
+import { AWSConfig, S3Client } from 'https://jslib.k6.io/aws/0.12.3/s3.js'
 
 const awsConfig = new AWSConfig({
     region: __ENV.AWS_REGION,

examples/signature-presign.js

@@ -1,11 +1,7 @@
 import http from 'k6/http'
 import { check } from 'k6'
 
-import {
-    AWSConfig,
-    SignatureV4,
-    AMZ_CONTENT_SHA256_HEADER,
-} from '../dist/aws.js'
+import { AWSConfig, Endpoint, SignatureV4, AMZ_CONTENT_SHA256_HEADER } from '../dist/aws.js'
 
 const awsConfig = new AWSConfig({
     region: __ENV.AWS_REGION,
@@ -39,19 +35,16 @@ export default function () {
             method: 'GET',
 
             /**
-             * The network protocol we will use to make the request.
-             */
-            protocol: 'https',
-
-            /**
-             * The hostname of the service we will be making the request to.
+             * The endpoint of the service we will be making the request to.
+             *
+             * The endpoint is instantiated from a URL string, of the format: `{scheme}://{hostname}[:{port}]`
              */
-            hostname: 'test-jslib-aws.s3.us-east-1.amazonaws.com',
+            endpoint: new Endpoint('https://s3.us-east-1.amazonaws.com'),
 
             /**
              * The path of the request.
              */
-            path: '/bonjour.txt',
+            path: '/my-bucket/bonjour.txt',
 
             /**
              * The headers we will be sending in the request.
@@ -64,7 +57,8 @@ export default function () {
             headers: { [AMZ_CONTENT_SHA256_HEADER]: 'UNSIGNED-PAYLOAD' },
 
             /**
-             * Whether the URI should be escaped or not.
+             * Whether the path should be escaped or not (consult the AWS signature V4
+             * documentation for more details).
              */
             uriEscapePath: false,
 

examples/signature-sign.js

@@ -1,6 +1,6 @@
 import http from 'k6/http'
 
-import { AWSConfig, SignatureV4 } from '../dist/signature.js'
+import { AWSConfig, Endpoint, SignatureV4 } from '../dist/signature.js'
 
 const awsConfig = new AWSConfig({
     region: __ENV.AWS_REGION,
@@ -41,27 +41,33 @@ export default function () {
             method: 'GET',
 
             /**
-             * The network protocol we will use to make the request.
+             * The endpoint of the service we will be making the request to.
+             *
+             * The endpoint is instantiated from a URL string, of the format: `{scheme}://{hostname}[:{port}]`
              */
-            protocol: 'https',
+            endpoint: new Endpoint('https://s3.us-east-1.amazonaws.com'),
 
             /**
-             * The hostname of the service we will be making the request to.
+             * The path of the request.
              */
-            hostname: 'test-jslib-aws.s3.us-east-1.amazonaws.com',
+            path: '/my-bucket/bonjour.txt',
 
             /**
-             * The path of the request.
+             * The query parameters to include in the request.
              */
-            path: '/bonjour.txt',
+            query: {
+                abc: '123',
+                'easy as': ['do', 're', 'mi'],
+            },
 
             /**
              * The headers we will be sending in the request.
              */
             headers: {},
 
             /**
-             * Whether the URI should be escaped or not.
+             * Whether the path should be escaped or not (consult the
+             * AWS signature V4 documentation for more details).
              */
             uriEscapePath: false,
 

package.json

@@ -1,7 +1,7 @@
 {
     "name": "k6-jslib-aws",
     "repository": "https://github.com/grafana/k6-jslib-aws",
-    "version": "0.12.0",
+    "version": "0.12.3",
     "description": "Create a distribution file for the aws jslib",
     "main": "src/index.js",
     "devDependencies": {

src/internal/s3.ts

@@ -30,7 +30,7 @@ export class S3Client extends AWSClient {
             },
 
             // S3 requires the URI path to be escaped
-            uriEscapePath: true,
+            uriEscapePath: false,
 
             // Signing S3 requests requires the payload to be hashed
             // and the checksum to be included in the request headers.
@@ -109,7 +109,7 @@ export class S3Client extends AWSClient {
             {
                 method: method,
                 endpoint: this.endpoint,
-                path: `/${bucketName}/`,
+                path: encodeURI(`/${bucketName}/`),
                 query: {
                     'list-type': '2',
                     prefix: prefix || '',
@@ -176,13 +176,13 @@ export class S3Client extends AWSClient {
             {
                 method: method,
                 endpoint: this.endpoint,
-                path: `/${bucketName}/${objectKey}`,
+                path: encodeURI(`/${bucketName}/${objectKey}`),
                 headers: {},
             },
             {}
         )
 
-        const res = await http.asyncRequest(method, signedRequest.url, signedRequest.body || null, {
+        const res = await http.asyncRequest(method, signedRequest.url, null, {
             headers: signedRequest.headers,
         })
         this._handle_error('GetObject', res)
@@ -224,7 +224,7 @@ export class S3Client extends AWSClient {
             {
                 method: method,
                 endpoint: this.endpoint,
-                path: `/${bucketName}/${objectKey}`,
+                path: encodeURI(`/${bucketName}/${objectKey}`),
                 headers: {
                     Host: this.endpoint.host,
                     ...(params?.contentDisposition && {
@@ -263,7 +263,7 @@ export class S3Client extends AWSClient {
             {
                 method: method,
                 endpoint: this.endpoint,
-                path: `/${bucketName}/${objectKey}`,
+                path: encodeURI(`/${bucketName}/${objectKey}`),
                 headers: {},
             },
             {}
@@ -300,7 +300,7 @@ export class S3Client extends AWSClient {
             {
                 method: method,
                 endpoint: bucketEndpoint,
-                path: `/${destinationKey}`,
+                path: encodeURI(`/${destinationKey}`),
                 headers: {
                     'x-amz-copy-source': `${sourceBucket}/${sourceKey}`,
                 },
@@ -335,7 +335,7 @@ export class S3Client extends AWSClient {
             {
                 method: method,
                 endpoint: bucketEndpoint,
-                path: `/${objectKey}`,
+                path: encodeURI(`/${objectKey}`),
                 headers: {},
                 query: { uploads: '' },
             },
@@ -381,7 +381,7 @@ export class S3Client extends AWSClient {
             {
                 method: method,
                 endpoint: bucketEndpoint,
-                path: `/${objectKey}`,
+                path: encodeURI(`/${objectKey}`),
                 headers: {},
                 body: data,
                 query: {
@@ -432,7 +432,7 @@ export class S3Client extends AWSClient {
             {
                 method: method,
                 endpoint: bucketEndpoint,
-                path: `/${objectKey}`,
+                path: encodeURI(`/${objectKey}`),
                 headers: {},
                 body: body,
                 query: {
@@ -468,7 +468,7 @@ export class S3Client extends AWSClient {
             {
                 method: method,
                 endpoint: bucketEndpoint,
-                path: `/${objectKey}`,
+                path: encodeURI(`/${objectKey}`),
                 headers: {},
                 query: {
                     uploadId: `${uploadId}`,

src/internal/signature.ts

@@ -100,9 +100,8 @@ export class SignatureV4 {
         //   For HTTP/2 requests, you must include the :authority header instead of
         //   the host header. Different services might require other headers."
         if (!request.headers[constants.HOST_HEADER]) {
-          request.headers[constants.HOST_HEADER] = request.endpoint.hostname
-      }
-
+            request.headers[constants.HOST_HEADER] = request.endpoint.hostname
+        }
 
         // Filter out headers that will be generated and managed by the signing process.
         // If the user provide any of those as part of the HTTPRequest's headers, they
@@ -163,9 +162,11 @@ export class SignatureV4 {
         // If a request path was provided, add it to the URL
         let url = request.endpoint.href
         if (request.path) {
-            // Ensure there is a trailing slash at the end of the URL
-            // so that appending the path does not result in a malformed URL.
-            url = url.endsWith('/') ? url : url + '/'
+            // Ensure the URI and the request path are properly concatenated
+            // by adding a trailing slash to the URI if it's missing.
+            if (!url.endsWith('/') && !request.path.startsWith('/')) {
+                url += '/'
+            }
 
             // Append the path to the URL
             url += request.path
@@ -223,8 +224,8 @@ export class SignatureV4 {
         //   For HTTP/2 requests, you must include the :authority header instead of
         //   the host header. Different services might require other headers."
         if (!request.headers[constants.HOST_HEADER]) {
-          request.headers[constants.HOST_HEADER] = originalRequest.endpoint.hostname
-      }
+            request.headers[constants.HOST_HEADER] = originalRequest.endpoint.hostname
+        }
 
         // If the user provided a session token, include it in the signed url query string.
         if (this.credentials.sessionToken) {