fix: Change prune default to false to fix 404s (#219)

* Change prune default to false to fix 404s * Update NextjsBucketDeployment.ts * chore: self mutation Signed-off-by: github-actions <[email protected]> * Update NextjsStaticAssets.ts * Update NextjsBucketDeployment.ts --------- Signed-off-by: github-actions <[email protected]> Co-authored-by: github-actions <[email protected]>
jetbridge · Jul 15, 2024 · d06e715 · d06e715
1 parent 8e1e853
commit d06e715
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 6 deletions.
diff --git a/API.md b/API.md
diff --git a/src/NextjsBucketDeployment.ts b/src/NextjsBucketDeployment.ts
@@ -29,7 +29,10 @@ export interface NextjsBucketDeploymentProps {
    * Old objects are determined by listing objects
    * in bucket before creating new objects and finding the objects that aren't in
    * the new objects.
-   * @default true
+   *
+   * Note, if this is set to true then clients who have old HTML files (browser tabs opened before deployment)
+   * will reference JS, CSS files that do not exist in S3 reslting in 404s.
+   * @default false
    */
   readonly prune?: boolean | undefined;
   /**
@@ -143,7 +146,7 @@ export class NextjsBucketDeployment extends Construct {
       destinationBucketName: this.props.destinationBucket.bucketName,
       destinationKeyPrefix: this.props.destinationKeyPrefix,
       putConfig: this.props.putConfig,
-      prune: this.props.prune,
+      prune: this.props.prune ?? false,
       substitutionConfig: this.props.substitutionConfig,
       zip: this.props.zip,
     };

diff --git a/src/NextjsStaticAssets.ts b/src/NextjsStaticAssets.ts
@@ -127,7 +127,7 @@ export class NextjsStaticAssets extends Construct {
       // only put env vars that are placeholders in custom resource properties
       // to be replaced. other env vars were injected at build time.
       substitutionConfig: NextjsBucketDeployment.getSubstitutionConfig(this.buildEnvVars),
-      prune: this.props.prune === false ? false : true, // default to true
+      prune: this.props.prune, // defaults to false
       putConfig: {
         [allFiles]: {
           CacheControl: 'public, max-age=0, must-revalidate',

diff --git a/src/generated-structs/OptionalNextjsBucketDeploymentProps.ts b/src/generated-structs/OptionalNextjsBucketDeploymentProps.ts