Update jslib-aws SecretsManager's documentation to reflect async syntax

oleiade · oleiade · commit bfc4b2bbd15b · 2023-08-02T16:40:42.000+02:00
diff --git a/src/data/markdown/docs/20 jslib/01 jslib/01 aws/00 SecretsManagerClient.md b/src/data/markdown/docs/20 jslib/01 jslib/01 aws/00 SecretsManagerClient.md
@@ -7,9 +7,11 @@ excerpt: 'SecretsManagerClient allows interacting with AWS secrets stored in Sec
 
 <BlockingAwsBlockquote />
 
-SecretsManagerClient allows interacting with secrets stored in AWS's Secrets Manager. Namely, it allows the user to list, download, create, modify and delete secrets. Note that the SecretsManagerClient operations are blocking, and we recommend reserving their usage to the [`setup`](/using-k6/test-lifecycle/) and [`teardown`](/using-k6/test-lifecycle/) functions as much as possible.
+`SecretsManagerClient` interacts with the AWS Secrets Manager.
 
-SecretsManagerClient is included in both the dedicated jslib `secrets-manager.js` bundle, and the `aws.js` one, containing all the services clients.
+With it, the user can list secrets owned by the authenticated user, download secrets, create new secrets, update secrets, and delete secrets.
+
+`SecretsManagerClient` is included in both the dedicated jslib `secrets-manager.js` bundle, and the `aws.js` one, containing all the services clients.
 
 ### Methods
 
@@ -49,39 +51,39 @@ const secretsManager = new SecretsManagerClient(awsConfig);
 const testSecretName = 'jslib-test-secret';
 const testSecretValue = 'jslib-test-value';
 
-export function setup() {
+export async function setup() {
   // Let's make sure our test secret is created
-  const testSecret = secretsManager.createSecret(
+  const testSecret = await secretsManager.createSecret(
     testSecretName,
     testSecretValue,
     'this is a test secret, delete me.'
   );
 
   // List the secrets the AWS authentication configuration
   // gives us access to, and verify the creation was successful.
-  const secrets = secretsManager.listSecrets();
+  const secrets = await secretsManager.listSecrets();
   if (!secrets.filter((s) => s.name === testSecret.name).length == 0) {
     exec.test.abort('test secret not found');
   }
 }
 
-export default function () {
+export default async function () {
   // Knnowing that we know the secret exist, let's update its value
   const newTestSecretValue = 'new-test-value';
-  secretsManager.putSecretValue(testSecretName, newTestSecretValue);
+  await secretsManager.putSecretValue(testSecretName, newTestSecretValue);
 
   // Let's get its value and verify it was indeed updated
-  const updatedSecret = secretsManager.getSecret(testSecretName);
+  const updatedSecret = await secretsManager.getSecret(testSecretName);
   if (updatedSecret.secret !== newTestSecretValue) {
     exec.test.abort('unable to update test secret');
   }
 
   // Let's now use our secret in the context of our load test...
 }
 
-export function teardown() {
+export async function teardown() {
   // Finally, let's clean after ourselves and delete our test secret
-  secretsManager.deleteSecret(testSecretName, { noRecovery: true });
+  await secretsManager.deleteSecret(testSecretName, { noRecovery: true });
 }
 ```
 
diff --git a/src/data/markdown/docs/20 jslib/01 jslib/01 aws/SecretsManagerClient/00 createSecret(name, secretString, description, [versionID], [tags]).md b/src/data/markdown/docs/20 jslib/01 jslib/01 aws/SecretsManagerClient/00 createSecret(name, secretString, description, [versionID], [tags]).md
@@ -6,6 +6,8 @@ excerpt: 'SecretsManagerClient.createSecret creates a new secret'
 
 `SecretsManagerClient.createSecret` creates a secret in AWS' secrets manager.
 
+### Parameters
+
 | Parameter            | Type                     | Description                                                                                                                                           |
 | :------------------- | :----------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------- |
 | name                 | string                   | The friendly name of the secret. You can use forward slashes in the name to represent a path hierarchy.                                               |
@@ -14,6 +16,12 @@ excerpt: 'SecretsManagerClient.createSecret creates a new secret'
 | versionID (optional) | string                   | Optional unique version identifier for the created secret. If no versionID is provided, an auto-generated UUID will be used instead.                   |
 | tags (optional)      | Array<{"key": "value"},> | A list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string                                             |
 
+### Returns
+
+| Type     | Description                                                                                                                                            |
+| :------- | :----------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Promise<[Secret](/javascript-api/jslib/aws/secretsmanagerclient/secret)> | A Promise that fulfills with a [Secret](/javascript-api/jslib/aws/secretsmanagerclient/secret) object that contains the details of the created secret. |
+
 ### Example
 
 <CodeGroup labels={[]}>
@@ -31,16 +39,16 @@ const secretsManager = new SecretsManagerClient(awsConfig);
 const testSecretName = 'jslib-test-secret';
 const testSecretValue = 'jslib-test-value';
 
-export default function () {
+export default async function () {
   // Let's create our test secret.
-  const testSecret = secretsManager.createSecret(
+  const testSecret = await secretsManager.createSecret(
     testSecretName,
     testSecretValue,
     'this is a test secret, delete me.'
   );
 
   // Let's get its value and verify it was indeed created.
-  const createdSecret = secretsManager.getSecret(testSecretName);
+  const createdSecret = await secretsManager.getSecret(testSecretName);
   console.log(JSON.stringify(createdSecret));
 }
 ```
diff --git a/src/data/markdown/docs/20 jslib/01 jslib/01 aws/SecretsManagerClient/00 deleteSecret.md b/src/data/markdown/docs/20 jslib/01 jslib/01 aws/SecretsManagerClient/00 deleteSecret.md
@@ -6,11 +6,19 @@ excerpt: 'SecretsManagerClient.deleteSecret deletes a secret'
 
 `SecretsManagerClient.deleteSecret` deletes a secret from AWS' secrets manager.
 
+### Parameters
+
 | Parameter | Type                                      | Description                              |
 | :-------- | :---------------------------------------- | :--------------------------------------- |
 | secretID  | string                                    | The ARN or name of the secret to update. |
 | options   | { recoveryWindow: 30, noRecovery: false } | Use options to control the deletion behavior. recoveryWindow defines how long a secret will remain “soft-deleted”, in days, before being hard-deleted. noRecovery set to true would hard-delete the secret immediately. Note that both options are exclusive. |
 
+### Returns
+
+| Type            | Description                                                |
+| :-------------- | :--------------------------------------------------------- |
+| `Promise<void>` | A promise that will be resolved when the secret is deleted |
+
 ### Example
 
 <CodeGroup labels={[]}>
@@ -28,16 +36,16 @@ const secretsManager = new SecretsManagerClient(awsConfig);
 const testSecretName = 'jslib-test-secret';
 const testSecretValue = 'jslib-test-value';
 
-export default function () {
+export default async function () {
   // Let's make sure our test secret is created
-  const testSecret = secretsManager.createSecret(
+  const testSecret = await secretsManager.createSecret(
     testSecretName,
     testSecretValue,
     'this is a test secret, delete me.'
   );
 
   // Let's hard delete our test secret and verify it worked
-  secretsManager.deleteSecret(testSecretName, { noRecovery: true });
+  await secretsManager.deleteSecret(testSecretName, { noRecovery: true });
 }
 ```
 
diff --git a/src/data/markdown/docs/20 jslib/01 jslib/01 aws/SecretsManagerClient/00 getSecret(secretID).md b/src/data/markdown/docs/20 jslib/01 jslib/01 aws/SecretsManagerClient/00 getSecret(secretID).md
@@ -14,7 +14,7 @@ excerpt: 'SecretsManagerClient.getSecret(secretID) downloads a secret from AWS s
 
 | Type                                                            | Description                                                                                                      |
 | :-------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------- |
-| [Secret](/javascript-api/jslib/aws/secretsmanagerclient/secret) | A [Secret](/javascript-api/jslib/aws/secretsmanagerclient/secret) describing and holding the downloaded secret. |
+| Promise<[Secret](/javascript-api/jslib/aws/secretsmanagerclient/secret)> | A Promise that fulfills with a [Secret](/javascript-api/jslib/aws/secretsmanagerclient/secret) describing and holding the downloaded secret. |
 
 ### Example
 
@@ -34,16 +34,16 @@ const awsConfig = new AWSConfig({
 const secretsManager = new SecretsManagerClient(awsConfig);
 const testSecretName = 'jslib-test-secret';
 
-export default function () {
+export default async function () {
   // List the secrets the AWS authentication configuration
   // gives us access to.
-  const secrets = secretsManager.listSecrets();
+  const secrets = await secretsManager.listSecrets();
   if (secrets.filter((s) => s.name === testSecretName).length == 0) {
     exec.test.abort('test secret not found');
   }
 
   // Let's get our test secret's value and print it.
-  const secret = secretsManager.getSecret(testSecretName);
+  const secret = await secretsManager.getSecret(testSecretName);
   console.log(JSON.stringify(secret));
 }
 ```
diff --git a/src/data/markdown/docs/20 jslib/01 jslib/01 aws/SecretsManagerClient/00 listSecrets().md b/src/data/markdown/docs/20 jslib/01 jslib/01 aws/SecretsManagerClient/00 listSecrets().md
@@ -10,7 +10,7 @@ excerpt: 'SecretsManagerClient.listSecrets lists the secrets the authenticated u
 
 | Type                                                                   | Description                                                                          |
 | :--------------------------------------------------------------------- | :----------------------------------------------------------------------------------- |
-| Array<[Secret](/javascript-api/jslib/aws/secretsmanagerclient/secret)> | An array of [Secret](/javascript-api/jslib/aws/secretsmanagerclient/secret) objects. |
+| Promise<Array<[Secret](/javascript-api/jslib/aws/secretsmanagerclient/secret)>> | A Promise that fulfills with an array of [Secret](/javascript-api/jslib/aws/secretsmanagerclient/secret) objects. |
 
 ### Example
 
@@ -30,10 +30,10 @@ const awsConfig = new AWSConfig({
 const secretsManager = new SecretsManagerClient(awsConfig);
 const testSecretName = 'jslib-test-secret';
 
-export default function () {
+export default async function () {
   // List the secrets the AWS authentication configuration
   // gives us access to, and verify the test secret exists.
-  const secrets = secretsManager.listSecrets();
+  const secrets = await secretsManager.listSecrets();
   if (secrets.filter((s) => s.name === testSecretName).length == 0) {
     exec.test.abort('test secret not found');
   }
diff --git a/src/data/markdown/docs/20 jslib/01 jslib/01 aws/SecretsManagerClient/00 putSecretValue(secretID, secretString, [versionID]).md b/src/data/markdown/docs/20 jslib/01 jslib/01 aws/SecretsManagerClient/00 putSecretValue(secretID, secretString, [versionID]).md
@@ -13,6 +13,12 @@ excerpt: "SecretsManagerClient.putSecretValue updates an existing secret's value
 | versionID (optional) | string                   | Optional unique version identifier for the updated version of the secret. If no versionID is provided, an auto-generated UUID will be used instead.    |
 | tags (optional)      | Array<{"key": "value"},> | A list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string                                             |
 
+### Returns
+
+| Type | Description |
+| :--- | ----------- |
+| Promise<[Secret](/javascript-api/jslib/aws/secretsmanagerclient/secret)> | A Promise that fulfills with the updated [Secret](/javascript-api/jslib/aws/secretsmanagerclient/secret). |
+
 ### Example
 
 <CodeGroup labels={[]}>
@@ -32,20 +38,20 @@ const secretsManager = new SecretsManagerClient(awsConfig);
 const testSecretName = 'jslib-test-secret';
 const testSecretValue = 'jslib-test-value';
 
-export default function () {
+export default async function () {
   // Let's make sure our test secret is created
-  const testSecret = secretsManager.createSecret(
+  const testSecret = await secretsManager.createSecret(
     testSecretName,
     testSecretValue,
     'this is a test secret, delete me.'
   );
 
   // Now that we know the secret exist, let's update its value
   const newTestSecretValue = 'new-test-value';
-  const u = secretsManager.putSecretValue(testSecretName, newTestSecretValue);
+  const u = await secretsManager.putSecretValue(testSecretName, newTestSecretValue);
 
   // Let's get its value back and verify it was indeed updated
-  const updatedSecret = secretsManager.getSecret(testSecretName);
+  const updatedSecret = await secretsManager.getSecret(testSecretName);
   if (updatedSecret.secret !== newTestSecretValue) {
     exec.test.abort('unable to update test secret');
   }
diff --git a/src/data/markdown/docs/20 jslib/01 jslib/01 aws/SecretsManagerClient/99 Secret.md b/src/data/markdown/docs/20 jslib/01 jslib/01 aws/SecretsManagerClient/99 Secret.md
@@ -36,18 +36,18 @@ const awsConfig = new AWSConfig({
 const secretsManager = new SecretsManagerClient(awsConfig);
 const testSecretName = 'jslib-test-secret';
 
-export default function () {
+export default async function () {
   // List the secrets the AWS authentication configuration
   // gives us access to.
-  const secrets = secretsManager.listSecrets();
+  const secrets = await secretsManager.listSecrets();
 
   // If our test secret does not exist, abort the execution.
   if (secrets.filter((s) => s.name === testSecretName).length == 0) {
     exec.test.abort('test secret not found');
   }
 
   // Let's get it and print its content
-  const downloadedSecret = secretsManager.getSecret(testSecretName);
+  const downloadedSecret = await secretsManager.getSecret(testSecretName);
   console.log(downloadedSecret.secret);
 }
 ```
