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
grafana · May 21, 2024 · 9412750 · 9412750
2 parents 0acdab1 + 5073f0a
commit 9412750
Show file tree

Hide file tree

Showing 30 changed files with 72 additions and 56 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -1,32 +1,32 @@
 name: Release
 
 on:
-  push:
-    tags:
-      - v*
+    push:
+        tags:
+            - v*
 
 jobs:
-  checks:
-    runs-on: ubuntu-latest
-    if: startsWith(github.ref, 'refs/tags/v')
-    steps:
-      - name: Check out source code
-        uses: actions/checkout@v4
-      - name: Use Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: '18.x'
-      - name: Install dependencies
-        run: npm install
-      - name: Build & archive
-        run: |
-          set -x
-          VERSION="${GITHUB_REF##*/}"
-          npm run webpack && tar -zcf "k6-jslib-aws-${VERSION}.tar.gz" -C dist .
-      - name: Create release with assets
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: |
-          set -x
-          VERSION="${GITHUB_REF##*/}"
-          gh release create "${VERSION}" "k6-jslib-aws-${VERSION}.tar.gz" "dist/*" --target "${GITHUB_SHA}" --title "${VERSION}"
+    checks:
+        runs-on: ubuntu-latest
+        if: startsWith(github.ref, 'refs/tags/v')
+        steps:
+            - name: Check out source code
+              uses: actions/checkout@v4
+            - name: Use Node.js
+              uses: actions/setup-node@v4
+              with:
+                  node-version: '18.x'
+            - name: Install dependencies
+              run: npm install
+            - name: Build & archive
+              run: |
+                  set -x
+                  VERSION="${GITHUB_REF##*/}"
+                  npm run webpack && tar -zcf "k6-jslib-aws-${VERSION}.tar.gz" -C dist .
+            - name: Create release with assets
+              env:
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+              run: |
+                  set -x
+                  VERSION="${GITHUB_REF##*/}"
+                  gh release create "${VERSION}" "k6-jslib-aws-${VERSION}.tar.gz" dist/* --target "${GITHUB_SHA}" --title "${VERSION}"
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -10,7 +10,7 @@ If the jslib-aws does not support the service you need yet, the best way to get
 2. The project files should be formatted using the [Prettier](https://prettier.io/) tool. The project has a `.prettierrc.json` file containing the tool's configuration.
 3. The project uses webpack to produce build files. Because k6 does not have native support typescript, and its Javascript runtime does not support the `import` statement, the project uses webpack to produce a file containing all the code that k6 scripts can use. The project has a `webpack.config.js` file containing the tool's configuration. Each service is built into its dedicated file, and an overarching `aws.js` contains them for convenience.
 4. To allow easier testing, files in the `src` directory are organized in a public/private structure. Files at the root of the folder are the public files; they import the content of the internal (private) directory and explicitly export the symbols that should be made available to the user. The internal files are the ones that contain the actual implementation of the service. The internal files are not exported and are not meant to be used directly by the user.
-5. The project is tested in an end2end fashion using the [k6](https://k6.io/) tool. The tests live in the `tests` directory. The tests are written in Javascript and use the [k6 chai js](https://k6.io/docs/javascript-api/jslib/k6chaijs/) jslib to test the functionality of the library. The `npm test` command runs the test suites. The tests run in a docker container, and the `docker-compose.yml` file contains the configuration for the container. The docker-compose setup spins up a [localstack](https://https://github.com/localstack/localstack) setup, which emulates AWS locally, and the test script performs its assertions against it directly.
+5. The project is tested in an end2end fashion using the [k6](https://k6.io/) tool. The tests live in the `tests` directory. The tests are written in Javascript and use the [k6 chai js](https://grafana.com/docs/k6/latest/javascript-api/jslib/k6chaijs) jslib to test the functionality of the library. The `npm test` command runs the test suites. The tests run in a docker container, and the `docker-compose.yml` file contains the configuration for the container. The docker-compose setup spins up a [localstack](https://github.com/localstack/localstack) setup, which emulates AWS locally, and the test script performs its assertions against it directly.
 
 ### Conventions
 
@@ -26,7 +26,7 @@ If the jslib-aws does not support the service you need yet, the best way to get
 4. Most service operations require signing requests using the AWS V4 signature process. The `SignatureV4` construct exposed in the [`src/internal/signature.ts`](https://github.com/grafana/k6-jslib-aws/blob/main/src/internal/signature.ts#L9) file allows signing requests to AWS services easily. Checkout the existing service implementations for examples of how to use it: [in S3Client](https://github.com/grafana/k6-jslib-aws/blob/main/src/internal/s3.ts#L48), and [in SecretsManagerService](https://github.com/grafana/k6-jslib-aws/blob/main/src/internal/secrets-manager.ts#L63) for instance.
 5. Add a new [entry](https://webpack.js.org/concepts/entry-points/) in `webpack.config.js` to the service you created in Step 1.
 6. Tests verifying that the service class works as expected should be added in the `tests/internal` directory. The dedicated test file should follow the same naming convention as the service class file, except it should have the `.js` extension. For example, if the service class file is named `systems-manager.ts`, the test file should be called `systems-manager.js`.
-7. Test files should consists in a k6 script using the [k6 chai js](https://k6.io/docs/javascript-api/jslib/k6chaijs/) library, and exporting a single `{serviceName}TestSuite(data)` function. This function should consist of a set of `describe` statements containing the actual test assertions, as demonstrated in the [existing s3 test suite](https://github.com/grafana/k6-jslib-aws/blob/main/tests/internal/s3.js). The test suite should be imported and called in the [`tests/internal/index.js`](https://github.com/grafana/k6-jslib-aws/blob/main/tests/index.js) test script, which is the entry point for the test suite.
+7. Test files should consists in a k6 script using the [k6 chai js](https://grafana.com/docs/k6/latest/javascript-api/jslib/k6chaijs) library, and exporting a single `{serviceName}TestSuite(data)` function. This function should consist of a set of `describe` statements containing the actual test assertions, as demonstrated in the [existing s3 test suite](https://github.com/grafana/k6-jslib-aws/blob/main/tests/internal/s3.js). The test suite should be imported and called in the [`tests/internal/index.js`](https://github.com/grafana/k6-jslib-aws/blob/main/tests/index.js) test script, which is the entry point for the test suite.
 8. If the tests depend on a specific pre-existing state of the localstack setup, you can add a dedicated script in the `tests/internal/localstack_init` folder. Localstack will execute all the commands present in this script during its setup phase.
 9. The `npm test` command runs the test suite. This command will build the project and run the tests against the spun-up localstack docker container. The `docker-compose.yml` file contains the configuration for the container.
 10. Once the tests pass, the `src/index.ts` file should export the service class in the `src/index.ts` file so the user can use it.

diff --git a/README.md b/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.11.2/s3.js'
+import { AWSConfig, S3Client } from 'https://jslib.k6.io/aws/0.12.0/s3.js'
 
 const awsConfig = new AWSConfig({
     region: __ENV.AWS_REGION,

diff --git a/dist/aws.js b/dist/aws.js
diff --git a/dist/aws.js.map b/dist/aws.js.map
diff --git a/dist/event-bridge.js b/dist/event-bridge.js
diff --git a/dist/event-bridge.js.map b/dist/event-bridge.js.map
diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/dist/kinesis.js b/dist/kinesis.js
diff --git a/dist/kinesis.js.map b/dist/kinesis.js.map
diff --git a/dist/kms.js b/dist/kms.js
diff --git a/dist/kms.js.map b/dist/kms.js.map
diff --git a/dist/lambda.js b/dist/lambda.js
diff --git a/dist/lambda.js.map b/dist/lambda.js.map
diff --git a/dist/s3.js b/dist/s3.js
diff --git a/dist/s3.js.map b/dist/s3.js.map
diff --git a/dist/secrets-manager.js b/dist/secrets-manager.js
diff --git a/dist/secrets-manager.js.map b/dist/secrets-manager.js.map
diff --git a/dist/signature.js b/dist/signature.js
diff --git a/dist/signature.js.map b/dist/signature.js.map
diff --git a/dist/sqs.js b/dist/sqs.js
diff --git a/dist/sqs.js.map b/dist/sqs.js.map
diff --git a/dist/ssm.js b/dist/ssm.js
diff --git a/dist/ssm.js.map b/dist/ssm.js.map
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
     "name": "k6-jslib-aws",
     "repository": "https://github.com/grafana/k6-jslib-aws",
-    "version": "0.11.2",
+    "version": "0.12.0",
     "description": "Create a distribution file for the aws jslib",
     "main": "src/index.js",
     "devDependencies": {

diff --git a/src/index.ts b/src/index.ts
@@ -3,6 +3,7 @@ export { InvalidSignatureError } from './internal/signature'
 export { AWSConfig, InvalidAWSConfigError } from './internal/config'
 export { AMZ_CONTENT_SHA256_HEADER, UNSIGNED_PAYLOAD } from './internal/constants'
 export { KMSClient, KMSDataKey, KMSServiceError } from './internal/kms'
+export { Endpoint } from './internal/endpoint'
 export { SignatureV4 } from './internal/signature'
 export { S3Bucket, S3Client, S3Object, S3ServiceError } from './internal/s3'
 export {

diff --git a/src/internal/s3.ts b/src/internal/s3.ts
@@ -28,7 +28,12 @@ export class S3Client extends AWSClient {
                 secretAccessKey: this.awsConfig.secretAccessKey,
                 sessionToken: this.awsConfig.sessionToken,
             },
-            uriEscapePath: false,
+
+            // S3 requires the URI path to be escaped
+            uriEscapePath: true,
+
+            // Signing S3 requests requires the payload to be hashed
+            // and the checksum to be included in the request headers.
             applyChecksum: true,
         })
     }

diff --git a/src/internal/signature.ts b/src/internal/signature.ts
@@ -163,6 +163,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 + '/'
+
+            // Append the path to the URL
             url += request.path
         }
 
@@ -266,6 +271,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 + '/'
+
+            // Append the path to the URL
             url += request.path
         }