triggerStaticRegeneration.test.ts

import { triggerStaticRegeneration } from "../../src/lib/triggerStaticRegeneration";
import {
  mockSQSClient,
  mockSendMessageCommand
} from "../mocks/sqs/aws-sdk-sqs-client.mock";
import { jest } from "@jest/globals";

jest.mock("@aws-sdk/client-sqs", () =>
  require("../mocks/sqs/aws-sdk-sqs-client.mock")
);

describe("triggerStaticRegeneration()", () => {
  beforeEach(() => {
    mockSQSClient.mockReset();
  });

  const options = {
    basePath: "",
    request: {
      uri: "index.html",
      origin: {
        s3: {
          region: "us-west-2",
          domainName: `my-bucket.s3.us-west-2.amazonaws.com`
        }
      }
    } as AWSLambda.CloudFrontRequest,
    eTag: "123",
    lastModified: "1",
    queueName: "my-bucket.fifo",
    pagePath: "/",
    pageS3Path: "/static-pages/build-id/index.html"
  };

  class RequestThrottledException extends Error {
    code = "RequestThrottled";
  }

  it("should not throttle if no rate limit is thrown", async () => {
    mockSQSClient.mockImplementationOnce(() => ({ send: jest.fn() }));
    const staticRegeneratedResponse = await triggerStaticRegeneration(options);
    expect(staticRegeneratedResponse.throttle).toBe(false);
  });

  it("should throttle if a RequestThrottledException is thrown", async () => {
    mockSendMessageCommand.mockImplementationOnce(() => {
      throw new RequestThrottledException();
    });
    const staticRegeneratedResponse = await triggerStaticRegeneration(options);
    expect(staticRegeneratedResponse.throttle).toBe(true);
  });

  it("should rethrow an unknown error", async () => {
    mockSendMessageCommand.mockImplementationOnce(() => {
      throw new Error("Unknown error");
    });
    await expect(triggerStaticRegeneration(options)).rejects.toEqual(
      new Error("Unknown error")
    );
  });

  it("should reject when corrupt s3 name is passed", async () => {
    await expect(
      triggerStaticRegeneration({
        ...options,
        request: {
          ...options.request,
          origin: {
            ...options.request.origin,
            s3: undefined
          }
        } as AWSLambda.CloudFrontRequest
      })
    ).rejects.toEqual(new Error("Expected bucket name to be defined"));
  });

  it("should reject when no region is passed", async () => {
    await expect(
      triggerStaticRegeneration({
        ...options,
        request: {
          ...options.request,
          origin: {
            ...options.request.origin,
            s3: { ...options.request.origin?.s3, region: "" }
          }
        } as AWSLambda.CloudFrontRequest
      })
    ).rejects.toEqual(new Error("Expected region to be defined"));
  });

  it.each`
    lastModified                  | etag         | expected
    ${"2021-05-05T17:15:04.472Z"} | ${"tag"}     | ${"tag"}
    ${"2021-05-05T17:15:04.472Z"} | ${undefined} | ${"1620234904472"}
  `(
    "should throttle send correct parameters to the queue",
    async ({ lastModified, etag, expected }) => {
      mockSQSClient.mockImplementationOnce(() => ({ send: jest.fn() }));
      const staticRegeneratedResponse = await triggerStaticRegeneration({
        ...options,
        eTag: etag,
        lastModified: lastModified
      });
      expect(staticRegeneratedResponse.throttle).toBe(false);
      expect(mockSendMessageCommand).toHaveBeenCalledWith({
        QueueUrl: `https://sqs.us-west-2.amazonaws.com/my-bucket.fifo`,
        MessageBody: JSON.stringify({
          region: "us-west-2",
          bucketName: "my-bucket",
          pageS3Path: "/static-pages/build-id/index.html",
          cloudFrontEventRequest: options.request,
          basePath: "",
          pagePath: "/"
        }),
        MessageDeduplicationId: expected,
        MessageGroupId: "eacf331f0ffc35d4b482f1d15a887d3b" // md5 hash of "index.html"
      });
    }
  );
});