JavaScript (v3): S3 - Standardize PutObjectLegalHold example and flip ouput of unique name util.

Author: cpyle0819

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

@@ -5,7 +5,7 @@ import { v4 as uuidv4 } from "uuid";
 /**
  * @param {string} name
  */
-export const getUniqueName = (name) => `${uuidv4()}-${name.toLowerCase()}`;
+export const getUniqueName = (name) => `${name.toLowerCase()}-${uuidv4()}`;
 
 /**
  * @param {int} length

javascriptv3/example_code/s3/actions/put-object-legal-hold.js

@@ -1,41 +1,75 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-import { fileURLToPath } from "url";
-import { PutObjectLegalHoldCommand, S3Client } from "@aws-sdk/client-s3";
+import {
+  PutObjectLegalHoldCommand,
+  S3Client,
+  S3ServiceException,
+} from "@aws-sdk/client-s3";
 
 /**
- * @param {S3Client} client
- * @param {string} bucketName
- * @param {string} objectKey
+ * Apply a legal hold configuration to the specified object.
+ * @param {{ bucketName: string, objectKey: string, legalHoldStatus: "ON" | "OFF" }}
  */
-export const main = async (client, bucketName, objectKey) => {
+export const main = async ({ bucketName, objectKey, legalHoldStatus }) => {
+  if (!["OFF", "ON"].includes(legalHoldStatus.toUpperCase())) {
+    throw new Error(
+      "Invalid parameter. legalHoldStatus must be 'ON' or 'OFF'.",
+    );
+  }
+
+  const client = new S3Client({});
   const command = new PutObjectLegalHoldCommand({
     Bucket: bucketName,
     Key: objectKey,
     LegalHold: {
       // Set the status to 'ON' to place a legal hold on the object.
       // Set the status to 'OFF' to remove the legal hold.
-      Status: "ON",
+      Status: legalHoldStatus,
     },
-    // Optionally, you can provide additional parameters
-    // ChecksumAlgorithm: "ALGORITHM",
-    // ContentMD5: "MD5_HASH",
-    // ExpectedBucketOwner: "ACCOUNT_ID",
-    // RequestPayer: "requester",
-    // VersionId: "OBJECT_VERSION_ID",
   });
 
   try {
-    const response = await client.send(command);
+    await client.send(command);
     console.log(
-      `Object legal hold status: ${response.$metadata.httpStatusCode}`,
+      `Legal hold status set to "${legalHoldStatus}" for "${objectKey}" in "${bucketName}"`,
     );
-  } catch (err) {
-    console.error(err);
+  } catch (caught) {
+    if (
+      caught instanceof S3ServiceException &&
+      caught.name === "NoSuchBucket"
+    ) {
+      console.error(
+        `Error from S3 while modifying legal hold status for "${objectKey}" in "${bucketName}". The bucket doesn't exist.`,
+      );
+    } else if (caught instanceof S3ServiceException) {
+      console.error(
+        `Error from S3 while modifying legal hold status for "${objectKey}" in "${bucketName}". ${caught.name}: ${caught.message}`,
+      );
+    } else {
+      throw caught;
+    }
   }
 };
 
-// Invoke main function if this file was run directly.
+// Call function if run directly
+import { fileURLToPath } from "url";
+import { parseArgs } from "util";
+
 if (process.argv[1] === fileURLToPath(import.meta.url)) {
-  main(new S3Client(), "BUCKET_NAME", "OBJECT_KEY");
+  const options = {
+    bucketName: {
+      type: "string",
+      default: "amzn-s3-demo-bucket",
+    },
+    objectKey: {
+      type: "string",
+      default: "file.txt",
+    },
+    legalHoldStatus: {
+      type: "string",
+      default: "ON",
+    },
+  };
+  const { values } = parseArgs({ options });
+  main(values);
 }

javascriptv3/example_code/s3/tests/get-object-lock-configuration.integration.test.js

@@ -15,7 +15,7 @@ import { getUniqueName } from "@aws-doc-sdk-examples/lib/utils/util-string.js";
 import { legallyEmptyAndDeleteBuckets } from "../libs/s3Utils.js";
 
 const client = new S3Client({});
-const bucketName = getUniqueName("amzn-s3-demo-bucket");
+const bucketName = getUniqueName("code-example");
 
 describe("get-object-lock-configuration.js Integration Test", () => {
   afterAll(async () => {

javascriptv3/example_code/s3/tests/put-object-legal-hold.integration.test.js

@@ -13,8 +13,8 @@ import { main as putObjectLegalHold } from "../actions/put-object-legal-hold.js"
 import { legallyEmptyAndDeleteBuckets } from "../libs/s3Utils.js";
 
 const client = new S3Client({});
-const bucketName = getUniqueName("test-bucket");
-const objectKey = "test-object";
+const bucketName = getUniqueName("code-example");
+const objectKey = "file.txt";
 
 describe("put-object-legal-hold.js Integration Test", () => {
   afterAll(async () => {
@@ -34,13 +34,13 @@ describe("put-object-legal-hold.js Integration Test", () => {
       new PutObjectCommand({
         Bucket: bucketName,
         Key: objectKey,
-        Body: "test content",
+        Body: "content",
       }),
     );
 
     // Execute
     const spy = vi.spyOn(console, "error");
-    await putObjectLegalHold(client, bucketName, objectKey);
+    await putObjectLegalHold({ bucketName, objectKey, legalHoldStatus: "ON" });
     expect(spy).not.toHaveBeenCalled();
 
     // Verify

javascriptv3/example_code/s3/tests/put-object-retention.integration.test.js

@@ -13,7 +13,7 @@ import { getUniqueName } from "@aws-doc-sdk-examples/lib/utils/util-string.js";
 import { legallyEmptyAndDeleteBuckets } from "../libs/s3Utils.js";
 
 const client = new S3Client({});
-const bucketName = getUniqueName("test-bucket");
+const bucketName = getUniqueName("code-example");
 const objectKey = "test-object";
 
 describe("put-object-retention.js Integration Test", () => {