Refactor preview distribution to additional distributions

dangreaves · Jan 16, 2024 · 831ed86 · 831ed86
1 parent 95550b4
commit 831ed86
Show file tree

Hide file tree

Showing 2 changed files with 58 additions and 58 deletions.
diff --git a/src/cdk/GatsbyDistribution.ts b/src/cdk/GatsbyDistribution.ts
@@ -10,23 +10,47 @@ import type { Executor } from "../types.js";
 
 import { SSR_ENGINE_FUNCTION_ID } from "../constants.js";
 
-import type { GatsbySiteProps } from "./GatsbySite.js";
-
 // Shim _dirname for ESM.
 import { fileURLToPath } from "url";
 const getFilename = () => fileURLToPath(import.meta.url);
 const getDirname = () => path.dirname(getFilename());
 const __dirname = getDirname();
 
-export type GatsbyDistributionProps = Pick<
-  GatsbySiteProps,
-  "distributionOptions" | "cacheBehaviorOptions"
+type EditableBehaviorOptions = Omit<
+  cloudfront.BehaviorOptions,
+  "origin" | "viewerProtocolPolicy" | "responseHeadersPolicy"
+> & { responseHeadersPolicyProps?: cloudfront.ResponseHeadersPolicyProps };
+
+type EditableDistributionOptions = Omit<
+  cloudfront.DistributionProps,
+  "defaultRootObject" | "errorResponses" | "defaultBehavior"
 > & {
-  bucket: s3.IBucket;
-  executors: Executor[];
+  additionalBehaviors?: Record<string, EditableBehaviorOptions>;
+  /**
+   * Disable the cache for this distribution.
+   * Cache-Control headers will be overridden in responses.
+   */
   disableCache?: boolean;
 };
 
+export interface GatsbyDistributionProps {
+  /** Bucket for static assets */
+  bucket: s3.IBucket;
+  /** Array of function executors */
+  executors: Executor[];
+  /** Custom cache behavior options */
+  cacheBehaviorOptions?: {
+    /** Cache behavior options for default route (including SSR engine) */
+    default?: EditableBehaviorOptions;
+    /** Cache behavior options for static assets (prefixed by /assets) */
+    assets?: EditableBehaviorOptions;
+    /** Cache behavior options for functions (not including SSR engine) */
+    functions?: EditableBehaviorOptions;
+  };
+  /** Custom CloudFront distribution options */
+  distributionOptions?: EditableDistributionOptions;
+}
+
 export class GatsbyDistribution extends Construct {
   readonly distribution: cloudfront.Distribution;
 
@@ -36,9 +60,8 @@ export class GatsbyDistribution extends Construct {
     {
       bucket,
       executors,
-      disableCache,
-      distributionOptions,
       cacheBehaviorOptions,
+      distributionOptions: { disableCache, ...distributionOptions } = {},
     }: GatsbyDistributionProps,
   ) {
     super(scope, id);

diff --git a/src/cdk/GatsbySite.ts b/src/cdk/GatsbySite.ts
@@ -7,11 +7,13 @@ import * as s3 from "aws-cdk-lib/aws-s3";
 import * as ec2 from "aws-cdk-lib/aws-ec2";
 import * as ecs from "aws-cdk-lib/aws-ecs";
 import * as lambda from "aws-cdk-lib/aws-lambda";
-import * as cloudfront from "aws-cdk-lib/aws-cloudfront";
 import * as s3deploy from "aws-cdk-lib/aws-s3-deployment";
 import * as ecsPatterns from "aws-cdk-lib/aws-ecs-patterns";
 
-import { GatsbyDistribution } from "./GatsbyDistribution.js";
+import {
+  GatsbyDistribution,
+  GatsbyDistributionProps,
+} from "./GatsbyDistribution.js";
 
 import type {
   Executor,
@@ -24,18 +26,6 @@ import type {
 
 import { SSR_ENGINE_FUNCTION_ID } from "../constants.js";
 
-type EditableBehaviorOptions = Omit<
-  cloudfront.BehaviorOptions,
-  "origin" | "viewerProtocolPolicy" | "responseHeadersPolicy"
-> & { responseHeadersPolicyProps?: cloudfront.ResponseHeadersPolicyProps };
-
-type EditableDistributionOptions = Omit<
-  cloudfront.DistributionProps,
-  "defaultRootObject" | "errorResponses" | "defaultBehavior"
-> & {
-  additionalBehaviors?: Record<string, EditableBehaviorOptions>;
-};
-
 export interface GatsbySiteProps {
   /** Path to Gatsby directory. */
   gatsbyDir: string;
@@ -47,26 +37,14 @@ export interface GatsbySiteProps {
   /** Resolve executor options for the given function. */
   resolveExecutorOptions?: (fn: IFunctionDefinition) => ExecutorOptions;
   /** Custom cache behavior options */
-  cacheBehaviorOptions?: {
-    /** Cache behavior options for default route (including SSR engine) */
-    default?: EditableBehaviorOptions;
-    /** Cache behavior options for static assets (prefixed by /assets) */
-    assets?: EditableBehaviorOptions;
-    /** Cache behavior options for functions (not including SSR engine) */
-    functions?: EditableBehaviorOptions;
-  };
+  cacheBehaviorOptions?: GatsbyDistributionProps["cacheBehaviorOptions"];
   /** Custom CloudFront distribution options */
-  distributionOptions?: EditableDistributionOptions;
-  /**
-   * Custom CloudFront distribution options for preview distribution.
-   *
-   * This additional distribution has all caching disabled, allowing you to "preview" your changes
-   * without clearing the CloudFront cache.
-   *
-   * @todo All requests to Gatsby from this distribution include an `X-Preview-Enabled = true` header
-   * which you can use in your application code to load drafts from your CMS.
-   */
-  previewDistributionOptions?: EditableDistributionOptions & { enabled: true };
+  distributionOptions?: GatsbyDistributionProps["distributionOptions"];
+  /** Options for additional CloudFront distributions */
+  additionalDistributionOptions?: Record<
+    string,
+    GatsbyDistributionProps["distributionOptions"]
+  >;
   /** VPC (Required for Fargate executors). */
   vpc?: ec2.IVpc;
   /**
@@ -91,7 +69,7 @@ const DEFAULT_EXECUTOR_OPTIONS: ExecutorOptions = {
 export class GatsbySite extends Construct {
   readonly bucket: s3.Bucket;
   readonly distribution: GatsbyDistribution;
-  readonly previewDistribution?: GatsbyDistribution;
+  readonly additionalDistributions: GatsbyDistribution[] = [];
 
   protected adapterDir: string;
 
@@ -107,7 +85,7 @@ export class GatsbySite extends Construct {
       cacheBehaviorOptions,
       resolveExecutorOptions,
       bucketDeploymentOptions,
-      previewDistributionOptions,
+      additionalDistributionOptions,
       ssrExecutorOptions = { target: "LAMBDA" },
     }: GatsbySiteProps,
   ) {
@@ -271,20 +249,19 @@ export class GatsbySite extends Construct {
       cacheBehaviorOptions,
     });
 
-    // Create preview distribution.
-    if (previewDistributionOptions?.enabled) {
-      this.previewDistribution = new GatsbyDistribution(
-        this,
-        "PreviewDistribution",
-        {
-          bucket,
-          executors,
-          disableCache: true,
-          cacheBehaviorOptions,
-          distributionOptions: previewDistributionOptions,
-        },
-      );
-    }
+    // Create additional distributions.
+    Object.entries(additionalDistributionOptions ?? {}).forEach(
+      ([key, distributionOptions]) => {
+        this.additionalDistributions.push(
+          new GatsbyDistribution(this, `Distribution-${key}`, {
+            bucket,
+            executors,
+            distributionOptions,
+            cacheBehaviorOptions,
+          }),
+        );
+      },
+    );
 
     // Create bucket deployments.
     this.createBucketDeployments(bucketDeploymentOptions);