S3 Cleanup (#4475)

* move and rename s3 files

* refactor copy-object example, add tests, clean up metadata

* refactor create-bucket example, add tests, clean up metadata

* refactor delete-bucket-policy example, add tests, clean up metadata

* refactor put-bucket-website example, add tests, clean up metadata

* refactor delete-bucket-website example, add tests, clean up metadata

* refactor delete-bucket example, add tests, clean up metadata

* refactor put-object example, add tests, clean up metadata

* refactor delete-object example, add tests, clean up metadata

* refactor put-bucket-policy example, add tests, clean up metadata

* refactor put-bucket-cors example, add tests, clean up metadata

* refactor get-bucket-cors example, add tests, clean up metadata

* refactor get-bucket-policy example, add tests, clean up metadata

* refactor put-bucket-acl, add test, update metadata

* refactor list-objects, add test, update metadata

* refactor list-buckets, add test, update metadata

* refactor get-object, add test, update metadata

* refactor get-bucket-website, add test, update metadata

* refactor delete-objects, add test, update metadata

* start basic scenario

* add upload, list, copy, delete, and empty steps to s3 example

* add upload, list, copy, delete, and empty steps to s3 example

* finish basic scenario

* fix malformed snippets

* clean up some excerpt descriptions

* update multipart and create/list/delete scenarios

* update presigned url examples

* update README

* update list-objects to handle over 1000 objects

* add web-example and test out deprecating snippets

* add readme reference to new media items

* copy editing

Author: cpyle0819

.doc_gen/metadata/s3_metadata.yaml

@@ -83,21 +83,21 @@ JavaScript:
   property: javascript
   sdk:
     2:
-      long: "&JSBlong; V2"
-      short: "&JSB; V2"
+      long: "&JSBlong; (v2)"
+      short: "&JSB; (v2)"
       expanded:
-        long: "AWS SDK for JavaScript V2"
-        short: "SDK for JavaScript V2"
+        long: "AWS SDK for JavaScript (v2)"
+        short: "SDK for JavaScript (v2)"
       guide: "sdk-for-javascript/v2/developer-guide/welcome.html"
       api_ref:
         uid: "AWSJavaScriptSDK"
         name: "&guide-jsb-api;"
     3:
-      long: "&JSBlong; V3"
-      short: "&JSB; V3"
+      long: "&JSBlong; (v3)"
+      short: "&JSB; (v3)"
       expanded:
-        long: "AWS SDK for JavaScript V3"
-        short: "SDK for JavaScript V3"
+        long: "AWS SDK for JavaScript (v3)"
+        short: "SDK for JavaScript (v3)"
       guide: "sdk-for-javascript/v3/developer-guide/welcome.html"
       api_ref:
         uid: "AWSJavaScriptSDKV3"

.doc_gen/metadata/sdks.yaml

@@ -1,6 +1,6 @@
 ## Overview
 
-Shows how to use the {{sdk['long']}} to work with {{service['long']}}.
+Shows how to use the {{sdk['long']}} to work with {{service['long']}} ({{service['short']}}).
 
 <!--custom.overview.start-->
 {{ customs['overview'] -}}

.doc_gen/readmes/includes/overview.jinja2

@@ -11,7 +11,7 @@ node ./actions/<fileName>
 ```
 
 **Run a scenario**
-
+Most scenarios can be run with the following command:
 ```bash
 node ./scenarios/<fileName>
 ```

.doc_gen/readmes/includes/run_instructions.jinja2

@@ -66,6 +66,8 @@
     'movies.json',
     'speech_sample.mp3',
     'chat_sfn_state_machine.json',
+    'market_2.jpg',
+    'spheres_2.jpg',
 }
 
 # media file types

.github/pre_validate/pre_validate.py

@@ -38,6 +38,9 @@ import {
 } from "@aws-sdk/client-ec2";
 import { paginateGetParametersByPath, SSMClient } from "@aws-sdk/client-ssm";
 
+import { promptToSelect, promptToContinue } from "libs/utils/util-io.js";
+import { wrapText } from "libs/utils/util-string.js";
+
 const ec2Client = new EC2Client();
 const ssmClient = new SSMClient();
 
@@ -147,7 +150,7 @@ const getAmznLinux2AMIs = async () => {
   const options = imageDetails.map(
     (image) => `${image.ImageId} - ${image.Description}`
   );
-  const [selectedIndex] = await promptWithOptions(options);
+  const [selectedIndex] = await promptToSelect(options);
 
   return imageDetails[selectedIndex];
 };
@@ -178,7 +181,7 @@ const getCompatibleInstanceTypes = async (imageDetails) => {
     (type) => `${type.InstanceType} - Memory:${type.MemoryInfo.SizeInMiB}`
   );
 
-  const [selectedIndex] = await promptWithOptions(
+  const [selectedIndex] = await promptToSelect(
     instanceTypeList,
     "Select an instance type."
   );
@@ -331,48 +334,6 @@ const deleteTemporaryDirectory = () => {
   }
 };
 
-const wrapText = (text, char = "=") => {
-  const rule = char.repeat(80);
-  return `${rule}\n    ${text}\n${rule}\n`;
-};
-
-const promptToContinue = (prefix) => {
-  const rl = createInterface({
-    input: process.stdin,
-    output: process.stdout,
-  });
-
-  return new Promise((resolve) => {
-    rl.question(`\nPress enter to continue.\n`, () => {
-      rl.close();
-      resolve();
-    });
-  });
-};
-
-const promptWithOptions = (options, question = "") => {
-  const rl = createInterface({
-    input: process.stdin,
-    output: process.stdout,
-  });
-  const optionsList = options.map((opt, i) => `${i + 1}) ${opt}`).join("\n");
-
-  return new Promise((resolve) => {
-    rl.question(`${question}\n${optionsList}\n-> `, (answer) => {
-      rl.close();
-      const selected = parseInt(answer);
-      if (isNaN(selected) || selected < 1 || selected > options.length) {
-        console.log(
-          `Invalid option. Select a number between 1 and ${options.length}`
-        );
-        resolve(promptWithOptions(options));
-      } else {
-        resolve([selected - 1, options[selected - 1]]);
-      }
-    });
-  });
-};
-
 export const main = async () => {
   const keyPairName = "ec2-scenario-key-pair";
   const securityGroupName = "ec2-scenario-security-group";

javascriptv3/example_code/ec2/scenarios/basic.js

@@ -0,0 +1,11 @@
+import { describe, it, expect } from "vitest";
+
+import { promptToSelect } from '../utils/util-io.js'
+
+describe("promptToSelect", () => {
+  it("should resolve with autoSelected option if it's valid", async () => {
+    const [selected, option] = await promptToSelect(["foo", "bar"], "", 1);
+    expect(selected).toEqual(0);
+    expect(option).toEqual("foo");
+  });
+});

javascriptv3/example_code/libs/tests/util-io.unit.test.js

@@ -32,53 +32,59 @@ import { fileURLToPath } from "url";
 import { log } from "./util-log.js";
 import { promiseAll, splitMapTrim } from "../ext-ramda.js";
 
-const deleteFiles = compose(promiseAll, map(unlink));
+export const deleteFiles = compose(promiseAll, map(unlink));
 
-const dirnameFromMetaUrl = (metaUrl) => {
+// snippet-start:[javascript.v3.utils.dirnameFromMetaUrl]
+export const dirnameFromMetaUrl = (metaUrl) => {
   return fileURLToPath(new URL(".", metaUrl));
 };
+// snippet-end:[javascript.v3.utils.dirnameFromMetaUrl]
 
-const getDelimitedEntries = curry((delimiter, str) =>
+export const getDelimitedEntries = curry((delimiter, str) =>
   pipe(getTmp, defaultTo(""), splitMapTrim(delimiter))(str)
 );
 
-const getNewLineDelimitedEntries = getDelimitedEntries("\n");
+export const getNewLineDelimitedEntries = getDelimitedEntries("\n");
 
-const getTmp = tryCatch(
+export const getTmp = tryCatch(
   (name) => readFileSync(`./${name}.tmp`, { encoding: "utf-8" }),
   always(null)
 );
 
-const setTmp = (name, data) =>
+export const setTmp = (name, data) =>
   writeFileSync(`./${name}.tmp`, data, { encoding: "utf-8" });
 
-const handleZipWarning = (resolve) => (w) => {
+export const handleZipWarning = (resolve) => (w) => {
   log(w);
   resolve();
 };
 
-const handleZipEnd = (resolve, path) => async () => {
+export const handleZipEnd = (resolve, path) => async () => {
   log(`Zipped successfully.`);
   const buffer = await readFile(path);
   resolve(buffer);
 };
 
-const makeDir = ifElse(existsSync, identity, tap(mkdirSync));
+export const makeDir = ifElse(existsSync, identity, tap(mkdirSync));
 
-const readLines = pipe(readFileSync, invoker(0, "toString"), split("\n"));
+export const readLines = pipe(
+  readFileSync,
+  invoker(0, "toString"),
+  split("\n")
+);
 
-const readSubdirSync = pipe(
+export const readSubdirSync = pipe(
   readdirSync,
   filter(invoker(0, "isDirectory")),
   map(prop("name"))
 );
 
 /**
- * 
- * @param {string} inputPath 
+ *
+ * @param {string} inputPath
  * @returns {Promise<Buffer>}
  */
-const zip = (inputPath) =>
+export const zip = (inputPath) =>
   new Promise((resolve, reject) => {
     try {
       readdirSync(inputPath);
@@ -102,16 +108,3 @@ const zip = (inputPath) =>
     archive.directory(inputPath, false);
     archive.finalize();
   });
-
-export {
-  deleteFiles,
-  dirnameFromMetaUrl,
-  getTmp,
-  makeDir,
-  readLines,
-  readSubdirSync,
-  getDelimitedEntries,
-  getNewLineDelimitedEntries,
-  setTmp,
-  zip,
-};

javascriptv3/example_code/libs/utils/util-fs.js

@@ -0,0 +1,71 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { createInterface } from "readline";
+
+// snippet-start:[javascript.v3.utils.promptToSelect]
+export const promptToSelect = (options, question = "", autoSelect) => {
+  const rl = createInterface({
+    input: process.stdin,
+    output: process.stdout,
+  });
+  const selectionInvalid = (selected) =>
+    isNaN(selected) || selected < 1 || selected > options.length;
+  const optionsList = options.map((opt, i) => `${i + 1}) ${opt}`).join("\n");
+  const prompt = `${question}\n${optionsList}\n-> `;
+
+  return new Promise((resolve) => {
+    if (!selectionInvalid(autoSelect)) {
+      resolve([autoSelect - 1, options[autoSelect - 1]]);
+      return;
+    }
+
+    rl.question(prompt, (answer) => {
+      rl.close();
+      const selected = parseInt(answer);
+      if (selectionInvalid(selected)) {
+        console.log(
+          `Invalid option. Select a number between 1 and ${options.length}`
+        );
+        resolve(promptToSelect(options));
+      } else {
+        resolve([selected - 1, options[selected - 1]]);
+      }
+    });
+  });
+};
+// snippet-end:[javascript.v3.utils.promptToSelect]
+
+// snippet-start:[javascript.v3.utils.promptToContinue]
+export const promptToContinue = () => {
+  const rl = createInterface({
+    input: process.stdin,
+    output: process.stdout,
+  });
+
+  return new Promise((resolve) => {
+    rl.question(`\nPress enter to continue.\n`, () => {
+      rl.close();
+      resolve();
+    });
+  });
+};
+// snippet-end:[javascript.v3.utils.promptToContinue]
+
+// snippet-start:[javascript.v3.utils.promptForText]
+export const promptForText = (question) => {
+  const rl = createInterface({
+    input: process.stdin,
+    output: process.stdout,
+  });
+
+  return new Promise((resolve) => {
+    rl.question(`${question}\n-> `, (answer) => {
+      rl.close();
+      resolve(answer);
+    });
+  });
+};
+// snippet-end:[javascript.v3.utils.promptForText]

javascriptv3/example_code/libs/utils/util-io.js

@@ -6,35 +6,31 @@ import { pipe, adjust, join, split, toLower, map, toUpper } from "ramda";
 
 import { v4 as uuidv4 } from "uuid";
 
-const getUniqueName = (name) => `${uuidv4()}-${name.toLowerCase()}`;
+export const getUniqueName = (name) => `${uuidv4()}-${name.toLowerCase()}`;
 
-const postfix = (source, str) => {
+export const postfix = (source, str) => {
   if (typeof str !== "string") {
     throw new Error("Cannot postfix a non-string value.");
   }
 
   return `${source}${str}`;
 };
 
-const downcaseSplit = pipe(toLower, split("-"));
+export const downcaseSplit = pipe(toLower, split("-"));
 
-const capitalize = pipe(Array.from, adjust(0, toUpper), join(""));
+export const capitalize = pipe(Array.from, adjust(0, toUpper), join(""));
 
-const kebabCase = pipe(downcaseSplit, join("-"));
+export const kebabCase = pipe(downcaseSplit, join("-"));
 
-const pascalCase = pipe(downcaseSplit, map(capitalize), join(""));
+export const pascalCase = pipe(downcaseSplit, map(capitalize), join(""));
 
-const snakeCase = pipe(downcaseSplit, join("_"));
+export const snakeCase = pipe(downcaseSplit, join("_"));
 
-const titleCase = pipe(downcaseSplit, map(capitalize), join(" "));
+export const titleCase = pipe(downcaseSplit, map(capitalize), join(" "));
 
-export {
-  capitalize,
-  downcaseSplit,
-  getUniqueName,
-  kebabCase,
-  pascalCase,
-  postfix,
-  snakeCase,
-  titleCase
+// snippet-start:[javascript.v3.utils.wrapText]
+export const wrapText = (text, char = "=") => {
+  const rule = char.repeat(80);
+  return `${rule}\n    ${text}\n${rule}\n`;
 };
+// snippet-end:[javascript.v3.utils.wrapText]