JavaScript (v3): S3 - Standardize GetBucketWebsite example.

Author: cpyle0819

javascriptv3/example_code/s3/actions/get-bucket-website.js

@@ -1,31 +1,59 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import { fileURLToPath } from "url";
-
 // snippet-start:[s3.JavaScript.website.getBucketWebsiteV3]
-import { GetBucketWebsiteCommand, S3Client } from "@aws-sdk/client-s3";
-
-const client = new S3Client({});
+import {
+  GetBucketWebsiteCommand,
+  S3Client,
+  S3ServiceException,
+} from "@aws-sdk/client-s3";
 
-export const main = async () => {
-  const command = new GetBucketWebsiteCommand({
-    Bucket: "test-bucket",
-  });
+/**
+ * Log the website configuration for a bucket.
+ * @param {{ bucketName }}
+ */
+export const main = async ({ bucketName }) => {
+  const client = new S3Client({});
 
   try {
-    const { ErrorDocument, IndexDocument } = await client.send(command);
+    const response = await client.send(
+      new GetBucketWebsiteCommand({
+        Bucket: bucketName,
+      }),
+    );
     console.log(
-      `Your bucket is set up to host a website. It has an error document:`,
-      `${ErrorDocument.Key}, and an index document: ${IndexDocument.Suffix}.`,
+      `Your bucket is set up to host a website with the following configuration:\n${JSON.stringify(response, null, 2)}`,
     );
-  } catch (err) {
-    console.error(err);
+  } catch (caught) {
+    if (
+      caught instanceof S3ServiceException &&
+      caught.name === "NoSuchWebsiteConfiguration"
+    ) {
+      console.error(
+        `Error from S3 while getting website configuration for ${bucketName}. The bucket isn't configured as a website.`,
+      );
+    } else if (caught instanceof S3ServiceException) {
+      console.error(
+        `Error from S3 while getting website configuration for ${bucketName}.  ${caught.name}: ${caught.message}`,
+      );
+    } else {
+      throw caught;
+    }
   }
 };
 // snippet-end:[s3.JavaScript.website.getBucketWebsiteV3]
 
-// 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();
+  const options = {
+    bucketName: {
+      type: "string",
+      default: "amzn-s3-demo-bucket",
+    },
+  };
+  const { values } = parseArgs({ options });
+  main(values);
 }

javascriptv3/example_code/s3/tests/get-bucket-website.unit.test.js

@@ -1,6 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
+import { S3ServiceException } from "@aws-sdk/client-s3";
 import { describe, it, expect, vi } from "vitest";
 
 const send = vi.fn();
@@ -19,28 +20,56 @@ const { main } = await import("../actions/get-bucket-website.js");
 
 describe("get-bucket-website", () => {
   it("should log the response from the service", async () => {
-    send.mockResolvedValue({
+    const mockResponse = {
       IndexDocument: { Suffix: "foo" },
       ErrorDocument: { Key: "bar" },
-    });
+    };
+    send.mockResolvedValue(mockResponse);
+    const bucketName = "amzn-s3-demo-bucket";
 
     const spy = vi.spyOn(console, "log");
 
-    await main();
+    await main({ bucketName });
 
     expect(spy).toHaveBeenCalledWith(
-      "Your bucket is set up to host a website. It has an error document:",
-      "bar, and an index document: foo.",
+      `Your bucket is set up to host a website with the following configuration:\n${JSON.stringify(mockResponse, null, 2)}`,
     );
   });
 
-  it("should log errors", async () => {
-    send.mockRejectedValue("foo");
+  it("should log a relevant error when the bucket isn't configured as a website.", async () => {
+    const error = new S3ServiceException("Not such website configuration.");
+    error.name = "NoSuchWebsiteConfiguration";
+    const bucketName = "amzn-s3-demo-bucket";
+    send.mockRejectedValueOnce(error);
 
     const spy = vi.spyOn(console, "error");
 
-    await main();
+    await main({ bucketName });
 
-    expect(spy).toHaveBeenCalledWith("foo");
+    expect(spy).toHaveBeenCalledWith(
+      `Error from S3 while getting website configuration for ${bucketName}. The bucket isn't configured as a website.`,
+    );
+  });
+
+  it("should indicate a failure came from S3 when the error isn't generic", async () => {
+    const error = new S3ServiceException("Some S3 service exception.");
+    error.name = "ServiceException";
+    const bucketName = "amzn-s3-demo-bucket";
+    send.mockRejectedValueOnce(error);
+
+    const spy = vi.spyOn(console, "error");
+
+    await main({ bucketName });
+
+    expect(spy).toHaveBeenCalledWith(
+      `Error from S3 while getting website configuration for ${bucketName}.  ${error.name}: ${error.message}`,
+    );
+  });
+
+  it("should throw errors that are not S3 specific", async () => {
+    const bucketName = "amzn-s3-demo-bucket";
+    send.mockRejectedValueOnce(new Error());
+
+    await expect(() => main({ bucketName })).rejects.toBeTruthy();
   });
 });