Merge pull request #440 from getlift/empty-domain

Support empty strings in domains

Author: mnapoli

src/constructs/aws/ServerSideWebsite.ts

@@ -92,12 +92,6 @@ export class ServerSideWebsite extends AwsConstruct {
     ) {
         super(scope, id);
 
-        if (configuration.domain !== undefined && configuration.certificate === undefined) {
-            throw new ServerlessError(
-                `Invalid configuration in 'constructs.${id}.certificate': if a domain is configured, then a certificate ARN must be configured as well.`,
-                "LIFT_INVALID_CONSTRUCT_CONFIGURATION"
-            );
-        }
         if (configuration.errorPage !== undefined && !configuration.errorPage.endsWith(".html")) {
             throw new ServerlessError(
                 `Invalid configuration in 'constructs.${id}.errorPage': the custom error page must be a static HTML file. '${configuration.errorPage}' does not end with '.html'.`,
@@ -121,12 +115,24 @@ export class ServerSideWebsite extends AwsConstruct {
         const apiGatewayDomain = Fn.join(".", [Fn.ref(apiId), `execute-api.${this.provider.region}.amazonaws.com`]);
 
         // Cast the domains to an array
-        this.domains = configuration.domain !== undefined ? flatten([configuration.domain]) : undefined;
+        // if configuration.domain is an empty array or an empty string, ignore it
+        this.domains =
+            configuration.domain !== undefined && configuration.domain.length > 0
+                ? flatten([configuration.domain])
+                : undefined;
+        // if configuration.certificate is an empty string, ignore it
         const certificate =
-            configuration.certificate !== undefined
+            configuration.certificate !== undefined && configuration.certificate !== ""
                 ? acm.Certificate.fromCertificateArn(this, "Certificate", configuration.certificate)
                 : undefined;
 
+        if (this.domains !== undefined && certificate === undefined) {
+            throw new ServerlessError(
+                `Invalid configuration in 'constructs.${id}.certificate': if a domain is configured, then a certificate ARN must be configured as well.`,
+                "LIFT_INVALID_CONSTRUCT_CONFIGURATION"
+            );
+        }
+
         // Hide the stage in the URL in REST scenario
         const originPath = configuration.apiGateway === "rest" ? "/" + (provider.getStage() ?? "") : undefined;
 

test/unit/serverSideWebsite.test.ts

@@ -610,6 +610,71 @@ describe("server-side website", () => {
         });
     });
 
+    it("should treat empty string domain and certificate as unconfigured", async () => {
+        const { cfTemplate, computeLogicalId } = await runServerless({
+            command: "package",
+            config: Object.assign(baseConfig, {
+                constructs: {
+                    backend: {
+                        type: "server-side-website",
+                        domain: "",
+                        certificate: "",
+                    },
+                },
+            }),
+        });
+        const cfDistributionLogicalId = computeLogicalId("backend", "CDN");
+        // No Aliases or ViewerCertificate should be set
+        expect(cfTemplate.Resources[cfDistributionLogicalId]).not.toHaveProperty(
+            "Properties.DistributionConfig.Aliases"
+        );
+        expect(cfTemplate.Resources[cfDistributionLogicalId]).not.toHaveProperty(
+            "Properties.DistributionConfig.ViewerCertificate"
+        );
+    });
+
+    it("should treat empty string domain with valid certificate as unconfigured", async () => {
+        const { cfTemplate, computeLogicalId } = await runServerless({
+            command: "package",
+            config: Object.assign(baseConfig, {
+                constructs: {
+                    backend: {
+                        type: "server-side-website",
+                        domain: "",
+                        certificate:
+                            "arn:aws:acm:us-east-1:123456615250:certificate/0a28e63d-d3a9-4578-9f8b-14347bfe8123",
+                    },
+                },
+            }),
+        });
+        const cfDistributionLogicalId = computeLogicalId("backend", "CDN");
+        // No Aliases should be set (domain is empty)
+        expect(cfTemplate.Resources[cfDistributionLogicalId]).not.toHaveProperty(
+            "Properties.DistributionConfig.Aliases"
+        );
+    });
+
+    it("should treat empty array domain as unconfigured", async () => {
+        const { cfTemplate, computeLogicalId } = await runServerless({
+            command: "package",
+            config: Object.assign(baseConfig, {
+                constructs: {
+                    backend: {
+                        type: "server-side-website",
+                        domain: [],
+                        certificate:
+                            "arn:aws:acm:us-east-1:123456615250:certificate/0a28e63d-d3a9-4578-9f8b-14347bfe8123",
+                    },
+                },
+            }),
+        });
+        const cfDistributionLogicalId = computeLogicalId("backend", "CDN");
+        // No Aliases should be set (domain is empty array)
+        expect(cfTemplate.Resources[cfDistributionLogicalId]).not.toHaveProperty(
+            "Properties.DistributionConfig.Aliases"
+        );
+    });
+
     it("trims CloudFront function names to stay under the limit", async () => {
         const { cfTemplate, computeLogicalId } = await runServerless({
             command: "package",