Disregard K6_DISCARD_RESPONSE_BODIES (#114)

* Add baseRequestParams to AWSClient This allow us to ignore k6's discardResponseBodies in the context of jslib-aws. As it is mostly a utility library, users have been mostly about having the ability available. See #45 for details. Using the baseRequestParams we set the default responseType for children implementation, allowing us to effectively disregard the http discardResponseBodies option. We can still, locally override it where necessary, as in S3Client.getObject for instance. * Adopt AWSClient.baseRequestParams in AWS client classes * Update src/internal/client.ts Co-authored-by: Joan López de la Franca Beltran <[email protected]> --------- Co-authored-by: Joan López de la Franca Beltran <[email protected]>
grafana · Sep 6, 2024 · fbe41eb · fbe41eb
1 parent b312325
commit fbe41eb
Show file tree

Hide file tree

Showing 9 changed files with 39 additions and 1 deletion.
diff --git a/src/internal/client.ts b/src/internal/client.ts
@@ -1,4 +1,4 @@
-import { RefinedResponse, ResponseType } from 'k6/http'
+import { RefinedResponse, ResponseType, Params } from 'k6/http'
 
 import { AWSConfig } from './config'
 import { Endpoint } from './endpoint'
@@ -27,6 +27,22 @@ export class AWSClient {
     readonly awsConfig: AWSConfig
     readonly serviceName: string
 
+    // Because jslib-aws is mostly used as a way to setup or feed k6 tests, and
+    // we want the jslib-aws to be able to disregard k6's discardResponseBodies: meaning
+    // that for instance, even when setting discardResponseBodies to true in the k6 options, using
+    // s3.getObject still receives the underlying response body and returns data to the user.
+    //
+    // To achieve this, we set the responseType to 'text' in the baseRequestParams, as it
+    // will lead the http module to ignore the discardResponseBodies option.
+    //
+    // AWS Client classes can override this value if they want to receive the response body
+    // as a different type ('binary' for instance, e.g. S3Client.getObject).
+    //
+    // See #45: https://github.com/grafana/k6-jslib-aws/issues/45
+    readonly baseRequestParams: Params = {
+        responseType: 'text',
+    }
+
     private _endpoint?: Endpoint
 
     /**

diff --git a/src/internal/event-bridge.ts b/src/internal/event-bridge.ts
@@ -68,6 +68,7 @@ export class EventBridgeClient extends AWSClient {
         )
 
         const res = await http.asyncRequest(this.method, signedRequest.url, signedRequest.body, {
+            ...this.baseRequestParams,
             headers: signedRequest.headers,
         })
         this.handleError(res, EventBridgeOperation.PutEvents)

diff --git a/src/internal/kinesis.ts b/src/internal/kinesis.ts
@@ -278,6 +278,7 @@ export class KinesisClient extends AWSClient {
         )
 
         const res = await http.asyncRequest('POST', signedRequest.url, signedRequest.body, {
+            ...this.baseRequestParams,
             headers: signedRequest.headers,
         })
 

diff --git a/src/internal/kms.ts b/src/internal/kms.ts
@@ -67,6 +67,7 @@ export class KMSClient extends AWSClient {
         )
 
         const res = await http.asyncRequest(this.method, signedRequest.url, signedRequest.body, {
+            ...this.baseRequestParams,
             headers: signedRequest.headers,
         })
         this.handleError(res, KMSOperation.ListKeys)
@@ -112,6 +113,7 @@ export class KMSClient extends AWSClient {
         )
 
         const res = await http.asyncRequest(this.method, signedRequest.url, signedRequest.body, {
+            ...this.baseRequestParams,
             headers: signedRequest.headers,
         })
         this.handleError(res, KMSOperation.GenerateDataKey)

diff --git a/src/internal/lambda.ts b/src/internal/lambda.ts
@@ -79,6 +79,7 @@ export class LambdaClient extends AWSClient {
         )
 
         const res = await http.asyncRequest(this.method, signedRequest.url, signedRequest.body, {
+            ...this.baseRequestParams,
             headers: signedRequest.headers,
         })
         this.handleError(res)

diff --git a/src/internal/s3.ts b/src/internal/s3.ts
@@ -60,6 +60,7 @@ export class S3Client extends AWSClient {
         )
 
         const res = await http.asyncRequest(method, signedRequest.url, signedRequest.body || null, {
+            ...this.baseRequestParams,
             headers: signedRequest.headers,
         })
         this.handleError(res, 'ListBuckets')
@@ -119,6 +120,7 @@ export class S3Client extends AWSClient {
         )
 
         const res = await http.asyncRequest(method, signedRequest.url, signedRequest.body || null, {
+            ...this.baseRequestParams,
             headers: signedRequest.headers,
         })
         this.handleError(res, 'ListObjectsV2')
@@ -199,6 +201,7 @@ export class S3Client extends AWSClient {
         }
 
         const res = await http.asyncRequest(method, signedRequest.url, null, {
+            ...this.baseRequestParams,
             headers: signedRequest.headers,
             responseType: responseType as ResponseType,
         })
@@ -258,6 +261,7 @@ export class S3Client extends AWSClient {
         )
 
         const res = await http.asyncRequest(method, signedRequest.url, signedRequest.body, {
+            ...this.baseRequestParams,
             headers: signedRequest.headers,
         })
         this.handleError(res, 'PutObject')
@@ -287,6 +291,7 @@ export class S3Client extends AWSClient {
         )
 
         const res = await http.asyncRequest(method, signedRequest.url, signedRequest.body || null, {
+            ...this.baseRequestParams,
             headers: signedRequest.headers,
         })
         this.handleError(res, 'DeleteObject')
@@ -326,6 +331,7 @@ export class S3Client extends AWSClient {
         )
 
         const res = await http.asyncRequest(method, signedRequest.url, signedRequest.body || null, {
+            ...this.baseRequestParams,
             headers: signedRequest.headers,
         })
 
@@ -360,6 +366,7 @@ export class S3Client extends AWSClient {
         )
 
         const res = await http.asyncRequest(method, signedRequest.url, signedRequest.body || null, {
+            ...this.baseRequestParams,
             headers: signedRequest.headers,
         })
         this.handleError(res, 'CreateMultipartUpload')
@@ -410,6 +417,7 @@ export class S3Client extends AWSClient {
         )
 
         const res = await http.asyncRequest(method, signedRequest.url, signedRequest.body || null, {
+            ...this.baseRequestParams,
             headers: signedRequest.headers,
         })
         this.handleError(res, 'UploadPart')
@@ -460,6 +468,7 @@ export class S3Client extends AWSClient {
         )
 
         const res = await http.asyncRequest(method, signedRequest.url, signedRequest.body || null, {
+            ...this.baseRequestParams,
             headers: signedRequest.headers,
         })
         this.handleError(res, 'CompleteMultipartUpload')
@@ -494,6 +503,7 @@ export class S3Client extends AWSClient {
         )
 
         const res = await http.asyncRequest(method, signedRequest.url, signedRequest.body || null, {
+            ...this.baseRequestParams,
             headers: signedRequest.headers,
         })
         this.handleError(res, 'AbortMultipartUpload')

diff --git a/src/internal/secrets-manager.ts b/src/internal/secrets-manager.ts
@@ -68,6 +68,7 @@ export class SecretsManagerClient extends AWSClient {
         )
 
         const res = await http.asyncRequest(this.method, signedRequest.url, signedRequest.body, {
+            ...this.baseRequestParams,
             headers: signedRequest.headers,
         })
         this.handleError(res, SecretsManagerOperation.ListSecrets)
@@ -100,6 +101,7 @@ export class SecretsManagerClient extends AWSClient {
         )
 
         const res = await http.asyncRequest(this.method, signedRequest.url, signedRequest.body, {
+            ...this.baseRequestParams,
             headers: signedRequest.headers,
         })
 
@@ -160,6 +162,7 @@ export class SecretsManagerClient extends AWSClient {
         // headers['X-Amz-Target'] = `${this.serviceName}.CreateSecret`
 
         const res = await http.asyncRequest(this.method, signedRequest.url, signedRequest.body, {
+            ...this.baseRequestParams,
             headers: signedRequest.headers,
         })
         this.handleError(res, SecretsManagerOperation.CreateSecret)
@@ -200,6 +203,7 @@ export class SecretsManagerClient extends AWSClient {
         )
 
         const res = await http.asyncRequest(this.method, signedRequest.url, signedRequest.body, {
+            ...this.baseRequestParams,
             headers: signedRequest.headers,
         })
         this.handleError(res, SecretsManagerOperation.PutSecretValue)
@@ -249,6 +253,7 @@ export class SecretsManagerClient extends AWSClient {
         )
 
         const res = await http.asyncRequest(this.method, signedRequest.url, signedRequest.body, {
+            ...this.baseRequestParams,
             headers: signedRequest.headers,
         })
         this.handleError(res, SecretsManagerOperation.DeleteSecret)

diff --git a/src/internal/sqs.ts b/src/internal/sqs.ts
@@ -207,6 +207,7 @@ export class SQSClient extends AWSClient {
         )
 
         const res = await http.asyncRequest('POST', signedRequest.url, signedRequest.body, {
+            ...this.baseRequestParams,
             headers: signedRequest.headers,
         })
 

diff --git a/src/internal/ssm.ts b/src/internal/ssm.ts
@@ -71,6 +71,7 @@ export class SystemsManagerClient extends AWSClient {
         )
 
         const res = await http.asyncRequest(this.method, signedRequest.url, signedRequest.body, {
+            ...this.baseRequestParams,
             headers: signedRequest.headers,
         })
         this.handleError(res, SystemsManagerOperation.GetParameter)
-Original file line number
+Diff line change
@@ Expand Up / @@ -278,6 +278,7 @@ export class KinesisClient extends AWSClient { @@
             )
             const res = await http.asyncRequest('POST', signedRequest.url, signedRequest.body, {
+                ...this.baseRequestParams,
                 headers: signedRequest.headers,
             })
@@ Expand Down @@