JavaScript (v3): S3 - Standardize PutObjectLockConfiguration example.

Author: cpyle0819

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

@@ -16,6 +16,12 @@ describe("util-string", () => {
       const u2 = getUniqueName(value);
       expect(u1).not.toEqual(u2);
     });
+
+    it("should return undefined if a falsy value is passed in", () => {
+      expect(getUniqueName()).toBeUndefined();
+      expect(getUniqueName("")).toBeUndefined();
+      expect(getUniqueName(0)).toBeUndefined();
+    });
   });
 
   describe("postfix", () => {

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

@@ -1,7 +1,14 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
+import { fileURLToPath } from "url";
 
 export const getEnv = (/** @type {string} */ key) => process.env[key];
 export const setEnv = (/** @type {string} */ key, value) => {
   process.env[key] = value;
 };
+
+/**
+ * Check if the running file was run directly.
+ * @param {string | URL} fileUrl
+ */
+export const isMain = (fileUrl) => process.argv[1] === fileURLToPath(fileUrl);

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

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

javascriptv3/example_code/s3/actions/put-object-lock-configuration.js

@@ -1,39 +1,63 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-import { fileURLToPath } from "url";
 import {
   PutObjectLockConfigurationCommand,
   S3Client,
+  S3ServiceException,
 } from "@aws-sdk/client-s3";
 
 /**
- * @param {S3Client} client
- * @param {string} bucketName
+ * Enable S3 Object Lock for an Amazon S3 bucket.
+ * After you enable Object Lock on a bucket, you can't
+ * disable Object Lock or suspend versioning for that bucket.
+ * @param {{ bucketName: string, enabled: boolean }}
  */
-export const main = async (client, bucketName) => {
+export const main = async ({ bucketName }) => {
+  const client = new S3Client({});
   const command = new PutObjectLockConfigurationCommand({
     Bucket: bucketName,
     // The Object Lock configuration that you want to apply to the specified bucket.
     ObjectLockConfiguration: {
       ObjectLockEnabled: "Enabled",
     },
-    // Optionally, you can provide additional parameters
-    // ExpectedBucketOwner: "ACCOUNT_ID",
-    // RequestPayer: "requester",
-    // Token: "OPTIONAL_TOKEN",
   });
 
   try {
-    const response = await client.send(command);
-    console.log(
-      `Object Lock Configuration updated: ${response.$metadata.httpStatusCode}`,
-    );
-  } catch (err) {
-    console.error(err);
+    await client.send(command);
+    console.log(`Object Lock for "${bucketName}" enabled.`);
+  } catch (caught) {
+    if (
+      caught instanceof S3ServiceException &&
+      caught.name === "NoSuchBucket"
+    ) {
+      console.error(
+        `Error from S3 while modifying the object lock configuration for the bucket "${bucketName}". The bucket doesn't exist.`,
+      );
+    } else if (caught instanceof S3ServiceException) {
+      console.error(
+        `Error from S3 while modifying the object lock configuration for the bucket "${bucketName}". ${caught.name}: ${caught.message}`,
+      );
+    } else {
+      throw caught;
+    }
   }
 };
 
-// Invoke main function if this file was run directly.
-if (process.argv[1] === fileURLToPath(import.meta.url)) {
-  main(new S3Client(), "BUCKET_NAME");
+// Call function if run directly
+import { parseArgs } from "util";
+import { isMain } from "@aws-doc-sdk-examples/lib/utils/util-node.js";
+
+const loadArgs = () => {
+  const options = {
+    bucketName: {
+      type: "string",
+      default: process.env["S3_BUCKET_NAME"] ?? "",
+    },
+  };
+  return parseArgs({ options });
+};
+
+if (isMain(import.meta.url)) {
+  const { values } = loadArgs();
+  main(values);
 }

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

@@ -15,7 +15,9 @@ 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(
+  process.env["S3_BUCKET_NAME"] || "object-lock-integ",
+);
 
 describe("put-object-lock-configuration.js Integration Test", () => {
   afterAll(async () => {
@@ -38,7 +40,7 @@ describe("put-object-lock-configuration.js Integration Test", () => {
 
     // Execute
     const spy = vi.spyOn(console, "error");
-    await putObjectLockConfiguration(client, bucketName);
+    await putObjectLockConfiguration({ bucketName });
     expect(spy).not.toHaveBeenCalled();
 
     // Verify